diff --git a/.changelog/26702.txt b/.changelog/26702.txt new file mode 100644 index 000000000000..09f93896ed39 --- /dev/null +++ b/.changelog/26702.txt @@ -0,0 +1,7 @@ +```release-note:bug +resource/aws_glue_catalog_table: Add `partition_keys.parameters` argument, fixing `Invalid address to set: []string{"partition_keys", "0", "parameters"}` errors +``` + +```release-note:bug +data-source/aws_glue_catalog_table: Add `partition_keys.parameters` attribute +``` \ No newline at end of file diff --git a/.changelog/33624.txt b/.changelog/33624.txt new file mode 100644 index 000000000000..c5bcbfe2633a --- /dev/null +++ b/.changelog/33624.txt @@ -0,0 +1,3 @@ +```release-note:bug +resource/aws_cognito_risk_configuration: Make `account_takeover_risk_configuration.notify_configuration` optional +``` diff --git a/.changelog/33796.txt b/.changelog/33796.txt new file mode 100644 index 000000000000..296f228998c3 --- /dev/null +++ b/.changelog/33796.txt @@ -0,0 +1,7 @@ +```release-note:enhancement +resource/aws_dlm_lifecycle_policy: Add `policy_details.schedule.cross_region_copy_rule.target_region` argument +``` + +```release-note:enhancement +resource/aws_dlm_lifecycle_policy: Make `policy_details.schedule.cross_region_copy_rule.target` optional +``` \ No newline at end of file diff --git a/.changelog/36628.txt b/.changelog/36628.txt new file mode 100644 index 000000000000..07a2f3e94cb2 --- /dev/null +++ b/.changelog/36628.txt @@ -0,0 +1,3 @@ +```release-note:enhancement +resource/aws_athena_database: Add `workgroup` argument +``` \ No newline at end of file diff --git a/.changelog/36874.txt b/.changelog/36874.txt new file mode 100644 index 000000000000..e96132e00d03 --- /dev/null +++ b/.changelog/36874.txt @@ -0,0 +1,3 @@ +```release-note:bug +resource/aws_securitylake_data_lake: Allow `meta_store_role_arn` to be updated in-place +``` diff --git a/.changelog/38336.txt b/.changelog/38336.txt new file mode 100644 index 000000000000..dbed8d77bea3 --- /dev/null +++ b/.changelog/38336.txt @@ -0,0 +1,3 @@ +```release-note:bug +resource/aws_spot_instance_request: Change `network_interface.network_card_index` to Computed +``` \ No newline at end of file diff --git a/.changelog/38527.txt b/.changelog/38527.txt new file mode 100644 index 000000000000..69122473bf3e --- /dev/null +++ b/.changelog/38527.txt @@ -0,0 +1,7 @@ +```release-note:enhancement +resource/aws_instance: Add `placement_group_id` argument +``` + +```release-note:enhancement +data-source/aws_instance: Add `placement_group_id` attribute +``` \ No newline at end of file diff --git a/.changelog/38717.txt b/.changelog/38717.txt new file mode 100644 index 000000000000..15d8c5106b10 --- /dev/null +++ b/.changelog/38717.txt @@ -0,0 +1,3 @@ +```release-note:enhancement +resource/aws_athena_workgroup: Add `configuration.identity_center_configuration` argument +``` \ No newline at end of file diff --git a/.changelog/40148.txt b/.changelog/40148.txt new file mode 100644 index 000000000000..a0cfb4235c7d --- /dev/null +++ b/.changelog/40148.txt @@ -0,0 +1,3 @@ +```release-note:bug +resource/aws_batch_compute_environment: Allow in-place updates of compute environments that have the `SPOT_PRICE_CAPACITY_OPTIMIZED` strategy +``` diff --git a/.changelog/41055.txt b/.changelog/41055.txt new file mode 100644 index 000000000000..c38c5a698e65 --- /dev/null +++ b/.changelog/41055.txt @@ -0,0 +1,15 @@ +```release-note:enhancement +resource/aws_dlm_lifecycle_policy: Add `default_policy` argument +``` + +```release-note:enhancement +resource/aws_dlm_lifecycle_policy: Add `copy_tags`, `create_interval`, `exclusions`, `extend_deletion`, `policy_language`, `resource_type` and `retain_interval` attributes to `policy_details` configuration block +``` + +```release-note:enhancement +resource/aws_dlm_lifecycle_policy: Add `policy_details.create_rule.scripts` argument +``` + +```release-note:enhancement +resource/aws_dlm_lifecycle_policy:Add `policy_details.schedule.archive_rule` argument +``` diff --git a/.changelog/41364.txt b/.changelog/41364.txt new file mode 100644 index 000000000000..08be138b02b7 --- /dev/null +++ b/.changelog/41364.txt @@ -0,0 +1,3 @@ +```release-note:new-resource +aws_s3_bucket_metadata_configuration +``` \ No newline at end of file diff --git a/.changelog/41702.txt b/.changelog/41702.txt new file mode 100644 index 000000000000..3d1c41f18f98 --- /dev/null +++ b/.changelog/41702.txt @@ -0,0 +1,3 @@ +```release-note:enhancement +resource/aws_cognito_resource_server: Allow `name` to be updated in-place +``` \ No newline at end of file diff --git a/.changelog/42188.txt b/.changelog/42188.txt new file mode 100644 index 000000000000..7d66b0f776f4 --- /dev/null +++ b/.changelog/42188.txt @@ -0,0 +1,11 @@ +```release-note:enhancement +resource/aws_network_interface: Add `attachment.network_card_index` argument +``` + +```release-note:enhancement +resource/aws_network_interface_attachment: Add `network_card_index` argument +``` + +```release-note:enhancement +data-source/aws_network_interface: Add `attachment.network_card_index` attribute +``` diff --git a/.changelog/42201.txt b/.changelog/42201.txt new file mode 100644 index 000000000000..6357f2bbd6ee --- /dev/null +++ b/.changelog/42201.txt @@ -0,0 +1,3 @@ +```release-note:new-resource +aws_bedrockagent_flow +``` diff --git a/.changelog/42382.txt b/.changelog/42382.txt new file mode 100644 index 000000000000..a2b8e0fc0319 --- /dev/null +++ b/.changelog/42382.txt @@ -0,0 +1,6 @@ +```release-note:new-resource +aws_timestreaminfluxdb_db_cluster +``` +```release-note:bug +resource/aws_timestreaminfluxdb_db_instance: Fix tag-only update errors +``` diff --git a/.changelog/42577.txt b/.changelog/42577.txt new file mode 100644 index 000000000000..39b90ffac942 --- /dev/null +++ b/.changelog/42577.txt @@ -0,0 +1,3 @@ +```release-note:new-data-source +aws_ecr_images +``` \ No newline at end of file diff --git a/.changelog/42591.txt b/.changelog/42591.txt new file mode 100644 index 000000000000..bd246de69f95 --- /dev/null +++ b/.changelog/42591.txt @@ -0,0 +1,7 @@ +```release-note:new-resource +aws_nat_gateway_eip_association +``` + +```release-note:enhancement +resource/aws_nat_gateway: Change `secondary_allocation_ids` to Optional and Computed +``` \ No newline at end of file diff --git a/.changelog/42595.txt b/.changelog/42595.txt new file mode 100644 index 000000000000..3662f5752e1a --- /dev/null +++ b/.changelog/42595.txt @@ -0,0 +1,3 @@ +```release-note:bug +resource/aws_ssm_parameter: Fix `version` not being updated when `description` changes +``` diff --git a/.changelog/42636.txt b/.changelog/42636.txt new file mode 100644 index 000000000000..e88f1ab8aaad --- /dev/null +++ b/.changelog/42636.txt @@ -0,0 +1,3 @@ +```release-note:enhancement +resource/aws_elasticache_global_replication_group: Change `engine` to Optional and Computed +``` \ No newline at end of file diff --git a/.changelog/42639.txt b/.changelog/42639.txt new file mode 100644 index 000000000000..de622e39fe21 --- /dev/null +++ b/.changelog/42639.txt @@ -0,0 +1,3 @@ +```release-note:enhancement +resource/aws_cognito_user_pool: Allow `name` to be updated in-place +``` diff --git a/.changelog/42740.txt b/.changelog/42740.txt new file mode 100644 index 000000000000..f402d54fdc46 --- /dev/null +++ b/.changelog/42740.txt @@ -0,0 +1,3 @@ +```release-note:bug +resource/aws_wafv2_web_acl: Fix performance of update when the WebACL has a large number of rules +``` diff --git a/.changelog/42877.txt b/.changelog/42877.txt new file mode 100644 index 000000000000..b5cdbd519f31 --- /dev/null +++ b/.changelog/42877.txt @@ -0,0 +1,3 @@ +```release-note:bug +resource/aws_ssm_parameter: Fix `Provider produced inconsistent final plan` errors when changing from using `value` to using `value_wo` +``` diff --git a/.changelog/42928.txt b/.changelog/42928.txt new file mode 100644 index 000000000000..fc783ed9357b --- /dev/null +++ b/.changelog/42928.txt @@ -0,0 +1,3 @@ +```release-note:enhancement +resource/aws_eks_cluster: Allow `remote_network_config` to be updated in-place, enabling support for EKS hybrid nodes on existing clusters +``` \ No newline at end of file diff --git a/.changelog/43125.txt b/.changelog/43125.txt new file mode 100644 index 000000000000..32fa415fc187 --- /dev/null +++ b/.changelog/43125.txt @@ -0,0 +1,7 @@ +```release-note:enhancement +resource/aws_dms_endpoint: Add `oracle_settings` configuration block for authentication method +``` + +```release-note:enhancement +resource/aws_dms_replication_instance: Add `dns_name_servers` attribute and `kerberos_authentication_settings` configuration block for Kerberos authentication settings +``` \ No newline at end of file diff --git a/.changelog/43150.txt b/.changelog/43150.txt new file mode 100644 index 000000000000..b7c3b1702155 --- /dev/null +++ b/.changelog/43150.txt @@ -0,0 +1,3 @@ +```release-note:enhancement +data-source/aws_bedrock_inference_profiles: Add `type` argument +``` \ No newline at end of file diff --git a/.changelog/43155.txt b/.changelog/43155.txt new file mode 100644 index 000000000000..87a408ce6966 --- /dev/null +++ b/.changelog/43155.txt @@ -0,0 +1,6 @@ +```release-note:enhancement +resource/aws_lb_listener_rule: Add resource identity support +``` +```release-note:enhancement +resource/aws_alb_listener_rule: Add resource identity support +``` diff --git a/.changelog/43158.txt b/.changelog/43158.txt new file mode 100644 index 000000000000..87d9b303bbb2 --- /dev/null +++ b/.changelog/43158.txt @@ -0,0 +1,3 @@ +```release-note:bug +resource/aws_instance: Recompute `ipv6_addresses` when `ipv6_address_count` is updated +``` diff --git a/.changelog/43161.txt b/.changelog/43161.txt new file mode 100644 index 000000000000..f64399020377 --- /dev/null +++ b/.changelog/43161.txt @@ -0,0 +1,6 @@ +```release-note:enhancement +resource/aws_lb_listener: Add resource identity support +``` +```release-note:enhancement +resource/aws_alb_listener: Add resource identity support +``` diff --git a/.changelog/43171.txt b/.changelog/43171.txt new file mode 100644 index 000000000000..ad1a9ee41d1d --- /dev/null +++ b/.changelog/43171.txt @@ -0,0 +1,6 @@ +```release-note:enhancement +resource/aws_lb_target_group: Add resource identity support +``` +```release-note:enhancement +resource/aws_alb_target_group: Add resource identity support +``` diff --git a/.changelog/43186.txt b/.changelog/43186.txt new file mode 100644 index 000000000000..71b7d1facc3a --- /dev/null +++ b/.changelog/43186.txt @@ -0,0 +1,3 @@ +```release-note:enhancement +resource/aws_lb_trust_store: Add resource identity support +``` diff --git a/.changelog/43200.txt b/.changelog/43200.txt new file mode 100644 index 000000000000..0fc5c13501e3 --- /dev/null +++ b/.changelog/43200.txt @@ -0,0 +1,3 @@ +```release-note:enhancement +resource/aws_globalaccelerator_accelerator: Add resource identity support +``` diff --git a/.changelog/43202.txt b/.changelog/43202.txt new file mode 100644 index 000000000000..52f9c301abe4 --- /dev/null +++ b/.changelog/43202.txt @@ -0,0 +1,3 @@ +```release-note:enhancement +resource/aws_sns_topic: Add resource identity support +``` diff --git a/.changelog/43207.txt b/.changelog/43207.txt new file mode 100644 index 000000000000..9045693f9a1a --- /dev/null +++ b/.changelog/43207.txt @@ -0,0 +1,3 @@ +```release-note:enhancement +resource/aws_acm_certificate: Support `options.export` argument to issue an exportable certificate +``` diff --git a/.changelog/43215.txt b/.changelog/43215.txt new file mode 100644 index 000000000000..04893e3a311d --- /dev/null +++ b/.changelog/43215.txt @@ -0,0 +1,3 @@ +```release-note:bug +resource/aws_api_gateway_resource: Recompute `path` when `path_part` is updated +``` diff --git a/.changelog/43240.txt b/.changelog/43240.txt new file mode 100644 index 000000000000..f96ffa2f919f --- /dev/null +++ b/.changelog/43240.txt @@ -0,0 +1,3 @@ +```release-note:enhancement +resource/aws_dynamodb_table: Add `replica.deletion_protection_enabled` argument +``` diff --git a/.changelog/43241.txt b/.changelog/43241.txt new file mode 100644 index 000000000000..1ba6a967d21e --- /dev/null +++ b/.changelog/43241.txt @@ -0,0 +1,3 @@ +```release-note:enhancement +resource/aws_ecs_service: Remove Terraform default for `availability_zone_rebalancing` and change the attribute to Optional and Computed. This allow ECS to default to `ENABLED` for new resources compatible with *AvailabilityZoneRebalancing* and maintain an existing service's `availability_zone_rebalancing` value during update when not configured. If an existing service never had an `availability_zone_rebalancing` value configured and is updated, ECS will treat this as `DISABLED` +``` \ No newline at end of file diff --git a/.changelog/43262.txt b/.changelog/43262.txt new file mode 100644 index 000000000000..102842ebc7cd --- /dev/null +++ b/.changelog/43262.txt @@ -0,0 +1,3 @@ +```release-note:bug +resource/aws_vpc_ipam_pool_cidr: Fix netmask_length not being saved and diffed correctly +``` diff --git a/.changelog/43337.txt b/.changelog/43337.txt new file mode 100644 index 000000000000..9b2ce0d52e41 --- /dev/null +++ b/.changelog/43337.txt @@ -0,0 +1,3 @@ +```release-note:bug +resource/aws_batch_compute_environment: Fix `inconsistent final plan` error when `compute_resource.launch_template.version` is unknown during an update +``` \ No newline at end of file diff --git a/.changelog/43355.txt b/.changelog/43355.txt new file mode 100644 index 000000000000..5836e598d5bf --- /dev/null +++ b/.changelog/43355.txt @@ -0,0 +1,3 @@ +```release-note:bug +resource/aws_bedrockagent_agent_action_group: Correctly set `parent_action_group_signature` on Read +``` diff --git a/.changelog/43358.txt b/.changelog/43358.txt new file mode 100644 index 000000000000..876e8ab6ac7b --- /dev/null +++ b/.changelog/43358.txt @@ -0,0 +1,3 @@ +```release-note:bug +resource/aws_lexv2models_slot: Fix error when `sub_slot_setting.slot_specification.value_elicitation_setting.prompt_specification.prompt_attempts_specification` and `value_elicitation_setting.prompt_specification.prompt_attempts_specification` have default values +``` \ No newline at end of file diff --git a/.changelog/43377.txt b/.changelog/43377.txt new file mode 100644 index 000000000000..4b08ab003cd5 --- /dev/null +++ b/.changelog/43377.txt @@ -0,0 +1,7 @@ +```release-note:enhancement +resource/aws_lakeformation_resource: Support `with_privileged_access` argument +``` + +```release-note:enhancement +data-source/aws_lakeformation_resource: Support `hybrid_access_enabled`, `with_federation` and `with_privileged_access` attributes +``` diff --git a/.changelog/43381.txt b/.changelog/43381.txt new file mode 100644 index 000000000000..aebb9bc6c8d2 --- /dev/null +++ b/.changelog/43381.txt @@ -0,0 +1,3 @@ +```release-note:enhancement +resource/aws_cloudwatch_log_metric_filter: Add `apply_on_transformed_logs` argument +``` \ No newline at end of file diff --git a/.changelog/43382.txt b/.changelog/43382.txt new file mode 100644 index 000000000000..44067d9f5cd2 --- /dev/null +++ b/.changelog/43382.txt @@ -0,0 +1,3 @@ +```release-note:bug +resource/aws_datazone_environment_blueprint_configuration: Fix `Inappropriate value for attribute "regional_parameters"` errors during planning. This fixes a regression introduced in [v6.0.0](https://github.com/hashicorp/terraform-provider-aws/blob/main/CHANGELOG.md#600-june-18-2025) +``` \ No newline at end of file diff --git a/.changelog/43391.txt b/.changelog/43391.txt new file mode 100644 index 000000000000..59e8d5c7a480 --- /dev/null +++ b/.changelog/43391.txt @@ -0,0 +1,7 @@ +```release-note:new-resource +aws_fsx_s3_access_point_attachment +``` + +```release-note:new-data-source +aws_s3_access_point +``` \ No newline at end of file diff --git a/.changelog/43396.txt b/.changelog/43396.txt new file mode 100644 index 000000000000..bd969dcf801a --- /dev/null +++ b/.changelog/43396.txt @@ -0,0 +1,7 @@ +```release-note:new-resource +aws_cognito_log_delivery_configuration +``` + +```release-note:note +resource/aws_cognito_log_delivery_configuration: Because we cannot easily test all this functionality, it is best effort and we ask for community help in testing +``` diff --git a/.changelog/43397.txt b/.changelog/43397.txt new file mode 100644 index 000000000000..6a6caa32b05f --- /dev/null +++ b/.changelog/43397.txt @@ -0,0 +1,3 @@ +```release-note:enhancement +resource/aws_wafv2_rule_group: Add `rules_json` argument +``` \ No newline at end of file diff --git a/.changelog/43400.txt b/.changelog/43400.txt new file mode 100644 index 000000000000..cc52c4fbac4f --- /dev/null +++ b/.changelog/43400.txt @@ -0,0 +1,3 @@ +```release-note:enhancement +resource/aws_datasync_location_object_storage: Make `agent_arns` optional +``` \ No newline at end of file diff --git a/.changelog/43405.txt b/.changelog/43405.txt new file mode 100644 index 000000000000..21bcb4f785e7 --- /dev/null +++ b/.changelog/43405.txt @@ -0,0 +1,3 @@ +```release-note:bug +resource/aws_ec2_transit_gateway_route_table_propagation: Don't mark `transit_gateway_attachment_id` as [ForceNew](https://developer.hashicorp.com/terraform/plugin/sdkv2/schemas/schema-behaviors#forcenew) if the value is known not to change +``` diff --git a/.changelog/43408.txt b/.changelog/43408.txt new file mode 100644 index 000000000000..851196e82ded --- /dev/null +++ b/.changelog/43408.txt @@ -0,0 +1,3 @@ +```release-note:new-resource +aws_workspacesweb_trust_store +``` \ No newline at end of file diff --git a/.changelog/43415.txt b/.changelog/43415.txt new file mode 100644 index 000000000000..ed252924530a --- /dev/null +++ b/.changelog/43415.txt @@ -0,0 +1,3 @@ +```release-note:enhancement +resource/aws_s3_bucket_public_access_block: Add `skip_destroy` argument +``` diff --git a/.changelog/43416.txt b/.changelog/43416.txt new file mode 100644 index 000000000000..ed003e81073a --- /dev/null +++ b/.changelog/43416.txt @@ -0,0 +1,3 @@ +```release-note:bug +resource/aws_lambda_function: Fix `waiting for Lambda Function (...) version publish: unexpected state '', wanted target 'Successful'` errors on Update. This fixes a regression introduced in [v6.2.0](https://github.com/hashicorp/terraform-provider-aws/blob/main/CHANGELOG.md#620-july--2-2025) +``` \ No newline at end of file diff --git a/.changelog/43423.txt b/.changelog/43423.txt new file mode 100644 index 000000000000..83f0589c9f8e --- /dev/null +++ b/.changelog/43423.txt @@ -0,0 +1,3 @@ +```release-note:enhancement +resource/aws_globalaccelerator_custom_routing_accelerator: Add resource identity support +``` diff --git a/.changelog/43430.txt b/.changelog/43430.txt new file mode 100644 index 000000000000..affa9c1c984b --- /dev/null +++ b/.changelog/43430.txt @@ -0,0 +1,15 @@ +```release-note:new-resource +aws_networkfirewall_firewall_transit_gateway_attachment_accepter +``` + +```release-note:enhancement +resource/aws_networkfirewall_firewall: Add `availability_zone_change_protection`, `availability_zone_mapping`, and `transit_gateway_id` arguments and `firewall_status.transit_gateway_attachment_sync_states` and `transit_gateway_owner_account_id` attributes +``` + +```release-note:enhancement +resource/aws_networkfirewall_firewall: Mark `subnet_mapping` and `vpc_id` as Optional +``` + +```release-note:enhancement +data-source/aws_networkfirewall_firewall: Add `availability_zone_change_protection`, `availability_zone_mapping`, `firewall_status.sync_states.attachment.status_message`, `firewall_status.transit_gateway_attachment_sync_states`, `transit_gateway_id`, and `transit_gateway_owner_account_id` attributes +``` diff --git a/.changelog/43434.txt b/.changelog/43434.txt new file mode 100644 index 000000000000..09250ed4214d --- /dev/null +++ b/.changelog/43434.txt @@ -0,0 +1,12 @@ +```release-note:enhancement +resource/aws_ecs_service: `deployment_controller.type` changes no longer force a replacement +``` +```release-note:enhancement +resource/aws_ecs_service: Add `deployment_configuration` argument +``` +```release-note:enhancement +resource/aws_ecs_service: Add `load_balancer.advanced_configuration` argument +``` +```release-note:enhancement +resource/aws_ecs_service: Add `service.client_alias.test_traffic_rules` argument +``` diff --git a/.changelog/43436.txt b/.changelog/43436.txt new file mode 100644 index 000000000000..38c85c310f1b --- /dev/null +++ b/.changelog/43436.txt @@ -0,0 +1,3 @@ +```release-note:enhancement +resource/aws_dx_gateway_association: Add `transit_gateway_attachment_id` attribute. This functionality requires the `ec2:DescribeTransitGatewayAttachments` IAM permission +``` diff --git a/.changelog/43440.txt b/.changelog/43440.txt new file mode 100644 index 000000000000..58bef1c4702c --- /dev/null +++ b/.changelog/43440.txt @@ -0,0 +1,11 @@ +```release-note:enhancement +resource/aws_dms_endpoint: Add `postgres_settings.authentication_method` and `postgres_settings.service_access_role_arn` arguments +``` + +```release-note:enhancement +data-source/aws_dms_endpoint: Add `postgres_settings.authentication_method` and `postgres_settings.service_access_role_arn` attributes +``` + +```release-note:enhancement +resource/aws_dms_endpoint: Add plan-time validation of `postgres_settings.database_mode`, `postgres_settings.map_long_varchar_as`, and `postgres_settings.plugin_name` arguments +``` \ No newline at end of file diff --git a/.changelog/43444.txt b/.changelog/43444.txt new file mode 100644 index 000000000000..82c91c88bf90 --- /dev/null +++ b/.changelog/43444.txt @@ -0,0 +1,3 @@ +```release-note:new-resource +aws_workspacesweb_portal +``` \ No newline at end of file diff --git a/.changelog/43449.txt b/.changelog/43449.txt new file mode 100644 index 000000000000..07f02dfcfac0 --- /dev/null +++ b/.changelog/43449.txt @@ -0,0 +1,7 @@ +```release-note:enhancement +resource/aws_codebuild_fleet: Add `instance_type` argument in `compute_configuration` block to support custom instance types +``` + +```release-note:enhancement +data-source/aws_codebuild_fleet: Add `instance_type` attribute in `compute_configuration` block +``` diff --git a/.changelog/43450.txt b/.changelog/43450.txt new file mode 100644 index 000000000000..f2871c027483 --- /dev/null +++ b/.changelog/43450.txt @@ -0,0 +1,6 @@ +```release-note:enhancement +resource/aws_glue_registry: Add resource identity support +``` +```release-note:enhancement +resource/aws_glue_schema: Add resource identity support +``` diff --git a/.changelog/43452.txt b/.changelog/43452.txt new file mode 100644 index 000000000000..6f7b15d8a32b --- /dev/null +++ b/.changelog/43452.txt @@ -0,0 +1,7 @@ +```release-note:enhancement +data-source/aws_verifiedpermissions_policy_store: Add `deletion_protection` attribute +``` + +```release-note:enhancement +resource/aws_verifiedpermissions_policy_store: Add `deletion_protection` argument +``` \ No newline at end of file diff --git a/.changelog/43453.txt b/.changelog/43453.txt new file mode 100644 index 000000000000..309b5aa06df5 --- /dev/null +++ b/.changelog/43453.txt @@ -0,0 +1,7 @@ +```release-note:enhancement +resource/aws_cloudwatch_event_bus: Add `log_config` argument +``` + +```release-note:enhancement +data-source/aws_cloudwatch_event_bus: Add `log_config` attribute +``` diff --git a/.changelog/43454.txt b/.changelog/43454.txt new file mode 100644 index 000000000000..633d9c04681b --- /dev/null +++ b/.changelog/43454.txt @@ -0,0 +1,3 @@ +```release-note:enhancement +resource/aws_batch_compute_environment: Add `compute_resources.ec2_configuration.image_kubernetes_version` argument +``` \ No newline at end of file diff --git a/.changelog/43471.txt b/.changelog/43471.txt new file mode 100644 index 000000000000..cbf78a7f719b --- /dev/null +++ b/.changelog/43471.txt @@ -0,0 +1,3 @@ +```release-note:bug +resource/aws_bedrockagent_flow: Remove `definition.connection` and `definition.node` list length limits +``` diff --git a/.changelog/43499.txt b/.changelog/43499.txt new file mode 100644 index 000000000000..edb4ebbc894c --- /dev/null +++ b/.changelog/43499.txt @@ -0,0 +1,3 @@ +```release-note:bug +resource/aws_dx_hosted_connection: Fix `DescribeHostedConnections failed for connection dxcon-xxxx doesn't exist` by pointing to the correct connection ID when doing the describe. +``` \ No newline at end of file diff --git a/.changelog/43501.txt b/.changelog/43501.txt new file mode 100644 index 000000000000..bbcfcb64bf6e --- /dev/null +++ b/.changelog/43501.txt @@ -0,0 +1,3 @@ +```release-note:enhancement +resource/aws_quicksight_account_subscription: Add import support. This resource can now be imported via the `aws_account_id` argument. +``` diff --git a/.changelog/43502.txt b/.changelog/43502.txt new file mode 100644 index 000000000000..7f56d741e23d --- /dev/null +++ b/.changelog/43502.txt @@ -0,0 +1,7 @@ +```release-note:bug +resource/aws_ecs_service: Improve stabilization logic to handle both new deployments and in-place updates correctly. This fixes a regression introduced in [v6.4.0](https://github.com/hashicorp/terraform-provider-aws/blob/main/CHANGELOG.md#640-july-17-2025) +``` + +```release-note:note +resource/aws_ecs_service: Acceptance tests cannot fully reproduce scenarios with deployments older than 3 months. Community feedback on this fix is appreciated, particularly for long-running ECS services with in-place updates +``` \ No newline at end of file diff --git a/.changelog/43503.txt b/.changelog/43503.txt new file mode 100644 index 000000000000..78a2eebad517 --- /dev/null +++ b/.changelog/43503.txt @@ -0,0 +1,12 @@ +```release-note:enhancement +resource/aws_iam_openid_connect_provider: Add resource identity support +``` +```release-note:enhancement +resource/aws_iam_policy: Add resource identity support +``` +```release-note:enhancement +resource/aws_iam_saml_provider: Add resource identity support +``` +```release-note:enhancement +resource/aws_iam_service_linked_role: Add resource identity support +``` diff --git a/.changelog/43506.txt b/.changelog/43506.txt new file mode 100644 index 000000000000..bd59867b9a38 --- /dev/null +++ b/.changelog/43506.txt @@ -0,0 +1,3 @@ +```release-note:enhancement +resource/aws_wafv2_web_acl: Add `statement.rate_based_statement.custom_key.asn` argument +``` diff --git a/.changelog/43516.txt b/.changelog/43516.txt new file mode 100644 index 000000000000..d592024b6a2d --- /dev/null +++ b/.changelog/43516.txt @@ -0,0 +1,3 @@ +```release-note:bug +provider: Prevent planned `forces replacement` on `region` for numerous resource types when upgrading from a pre-v6.0.0 provider version and `-refresh=false` is in effect +``` diff --git a/.changelog/43517.txt b/.changelog/43517.txt new file mode 100644 index 000000000000..cf9bd70faecc --- /dev/null +++ b/.changelog/43517.txt @@ -0,0 +1,3 @@ +```release-note:enhancement +feature/aws_bedrock_guardrail: Add `cross_region_config`, `content_policy_config.tier_config`, and `topic_policy_config.tier_config` arguments +``` diff --git a/.changelog/43523.txt b/.changelog/43523.txt new file mode 100644 index 000000000000..a17a88f6772e --- /dev/null +++ b/.changelog/43523.txt @@ -0,0 +1,3 @@ +```release-note:bug +resource/aws_appsync_api_cache: Fix "missing required field" error during update +``` diff --git a/.changelog/43525.txt b/.changelog/43525.txt new file mode 100644 index 000000000000..b095eae9eb87 --- /dev/null +++ b/.changelog/43525.txt @@ -0,0 +1,7 @@ +```release-note:enhancement +resource/aws_inspector2_enabler: Support `CODE_REPOSITORY` as a valid value for `resource_types` +``` + +```release-note:enhancement +resource/aws_inspector2_organization_configuration: Add `auto_enable.code_repository` argument +``` diff --git a/.changelog/43534.txt b/.changelog/43534.txt new file mode 100644 index 000000000000..de5d2d6e470e --- /dev/null +++ b/.changelog/43534.txt @@ -0,0 +1,3 @@ +```release-note:bug +resource/aws_timestreaminfluxdb_db_instance: Don't mark `network_type` as [ForceNew](https://developer.hashicorp.com/terraform/plugin/sdkv2/schemas/schema-behaviors#forcenew) if the value is not configured. This fixes a problem with `terraform apply -refresh=false` after upgrade from `v5.90.0` and below +``` \ No newline at end of file diff --git a/.changelog/43539.txt b/.changelog/43539.txt new file mode 100644 index 000000000000..36d07e6c254f --- /dev/null +++ b/.changelog/43539.txt @@ -0,0 +1,12 @@ +```release-note:enhancement +resource/aws_globalaccelerator_custom_routing_endpoint_group: Add resource identity support +``` +```release-note:enhancement +resource/aws_globalaccelerator_custom_routing_listener: Add resource identity support +``` +```release-note:enhancement +resource/aws_globalaccelerator_endpoint_group: Add resource identity support +``` +```release-note:enhancement +resource/aws_globalaccelerator_listener: Add resource identity support +``` diff --git a/.changelog/43540.txt b/.changelog/43540.txt new file mode 100644 index 000000000000..8df37994dc84 --- /dev/null +++ b/.changelog/43540.txt @@ -0,0 +1,21 @@ +```release-note:enhancement +resource/aws_imagebuilder_container_recipe: Add resource identity support +``` +```release-note:enhancement +resource/aws_imagebuilder_distribution_configuration: Add resource identity support +``` +```release-note:enhancement +resource/aws_imagebuilder_image: Add resource identity support +``` +```release-note:enhancement +resource/aws_imagebuilder_image_pipeline: Add resource identity support +``` +```release-note:enhancement +resource/aws_imagebuilder_image_recipe: Add resource identity support +``` +```release-note:enhancement +resource/aws_imagebuilder_infrastructure_configuration: Add resource identity support +``` +```release-note:enhancement +resource/aws_imagebuilder_workflow: Add resource identity support +``` diff --git a/.changelog/43542.txt b/.changelog/43542.txt new file mode 100644 index 000000000000..278735a5565f --- /dev/null +++ b/.changelog/43542.txt @@ -0,0 +1,11 @@ +```release-note:enhancement +resource/aws_inspector_assessment_target: Add resource identity support +``` + +```release-note:enhancement +resource/aws_inspector_assessment_template: Add resource identity support +``` + +```release-note:enhancement +resource/aws_inspector_resource_group: Add resource identity support +``` diff --git a/.changelog/43545.txt b/.changelog/43545.txt new file mode 100644 index 000000000000..793936ca0427 --- /dev/null +++ b/.changelog/43545.txt @@ -0,0 +1,3 @@ +```release-note:bug +resource/aws_servicequotas_service_quota: Add validation, during `create`, to check if new value is less than current value of quota +``` diff --git a/.changelog/43557.txt b/.changelog/43557.txt new file mode 100644 index 000000000000..5e4daca663af --- /dev/null +++ b/.changelog/43557.txt @@ -0,0 +1,3 @@ +```release-note:new-resource +aws_connect_phone_number_contact_flow_association +``` \ No newline at end of file diff --git a/.changelog/43558.txt b/.changelog/43558.txt new file mode 100644 index 000000000000..a414b048cac7 --- /dev/null +++ b/.changelog/43558.txt @@ -0,0 +1,3 @@ +```release-note:bug +resource/aws_ecs_service: Fix unspecified `test_listener_rule` incorrectly being set as empty string in `load_balancer.advanced_configuration` block +``` diff --git a/.changelog/43560.txt b/.changelog/43560.txt new file mode 100644 index 000000000000..1b24ec46efaa --- /dev/null +++ b/.changelog/43560.txt @@ -0,0 +1,7 @@ +```release-note:enhancement +resource/aws_ssm_patch_baseline: Add `available_security_updates_compliance_status` argument +``` + +```release-note:enhancement +data-source/aws_ssm_patch_baseline: Add `available_security_updates_compliance_status` argument +``` \ No newline at end of file diff --git a/.changelog/43561.txt b/.changelog/43561.txt new file mode 100644 index 000000000000..cb9014c63684 --- /dev/null +++ b/.changelog/43561.txt @@ -0,0 +1,3 @@ +```release-note:new-resource +aws_wafv2_web_acl_rule_group_association +``` \ No newline at end of file diff --git a/.changelog/43562.txt b/.changelog/43562.txt new file mode 100644 index 000000000000..08fd04a23e69 --- /dev/null +++ b/.changelog/43562.txt @@ -0,0 +1,3 @@ +```release-note:enhancement +resource/aws_ssm_service_setting: Support short format (with `/ssm/` prefix) for `setting_id` +``` diff --git a/.changelog/43565.txt b/.changelog/43565.txt new file mode 100644 index 000000000000..00e284eeed3b --- /dev/null +++ b/.changelog/43565.txt @@ -0,0 +1,7 @@ +```release-note:enhancement +resource/aws_ebs_volume: Add `volume_initialization_rate` argument +``` + +```release-note:enhancement +data-source/aws_ebs_volume: Add `volume_initialization_rate` attribute +``` diff --git a/.changelog/43576.txt b/.changelog/43576.txt new file mode 100644 index 000000000000..5f457fd57de3 --- /dev/null +++ b/.changelog/43576.txt @@ -0,0 +1,3 @@ +```release-note:bug +resource/aws_cloudwatch_log_delivery_destination: Fix update failure when tags are set +``` diff --git a/.changelog/43582.txt b/.changelog/43582.txt new file mode 100644 index 000000000000..33f1792350d2 --- /dev/null +++ b/.changelog/43582.txt @@ -0,0 +1,3 @@ +```release-note:enhancement +data-source/aws_ecs_service: Support `load_balancer` attribute +``` diff --git a/.changelog/43587.txt b/.changelog/43587.txt new file mode 100644 index 000000000000..897dc3123f1b --- /dev/null +++ b/.changelog/43587.txt @@ -0,0 +1,3 @@ +```release-note:new-resource +aws_quicksight_key_registration +``` \ No newline at end of file diff --git a/.changelog/43589.txt b/.changelog/43589.txt new file mode 100644 index 000000000000..f419b609b328 --- /dev/null +++ b/.changelog/43589.txt @@ -0,0 +1,7 @@ +```release-note:bug +resource/aws_s3_bucket: Accept `NoSuchTagSetError` responses from S3-compatible services +``` + +```release-note:bug +resource/aws_s3_object: Accept `NoSuchTagSetError` responses from S3-compatible services +``` diff --git a/.changelog/43595.txt b/.changelog/43595.txt new file mode 100644 index 000000000000..6057109a1fe5 --- /dev/null +++ b/.changelog/43595.txt @@ -0,0 +1,3 @@ +```release-note:bug +resource/aws_bedrockagent_flow: Fix `missing required field, CreateFlowInput.Definition.Nodes[0].Configuration[prompt].SourceConfiguration[resource].PromptArn` errors on Create +``` diff --git a/.changelog/43596.txt b/.changelog/43596.txt new file mode 100644 index 000000000000..043667824504 --- /dev/null +++ b/.changelog/43596.txt @@ -0,0 +1,3 @@ +```release-note:new-resource +aws_quicksight_ip_restriction +``` \ No newline at end of file diff --git a/.changelog/43597.txt b/.changelog/43597.txt new file mode 100644 index 000000000000..72970ed2001a --- /dev/null +++ b/.changelog/43597.txt @@ -0,0 +1,7 @@ +```release-note:enhancement +data-source/aws_wafv2_web_acl: Add `resource_arn` argument to enable finding web ACLs by resource ARN +``` + +```release-note:enhancement +data-source/aws_wafv2_web_acl: Add support for `CLOUDFRONT` `scope` web ACLs using `resource_arn` +``` diff --git a/.changelog/43605.txt b/.changelog/43605.txt new file mode 100644 index 000000000000..621d5fdad6f2 --- /dev/null +++ b/.changelog/43605.txt @@ -0,0 +1,3 @@ +```release-note:bug +resource/aws_fsx_lustre_file_system: Fix validation of SSD read cache size for file systems using the Intelligent-Tiering storage class +``` diff --git a/.changelog/43606.txt b/.changelog/43606.txt new file mode 100644 index 000000000000..9f3f95a7bec8 --- /dev/null +++ b/.changelog/43606.txt @@ -0,0 +1,3 @@ +```release-note:bug +resource/aws_servicequotas_service_quota: Fix error when updating a pending service quota request +``` \ No newline at end of file diff --git a/.changelog/43613.txt b/.changelog/43613.txt new file mode 100644 index 000000000000..7e7aa90d51ce --- /dev/null +++ b/.changelog/43613.txt @@ -0,0 +1,31 @@ +```release-note:new-resource +aws_quicksight_custom_permissions +``` + +```release-note:new-resource +aws_quicksight_role_custom_permission +``` + +```release-note:new-resource +aws_quicksight_user_custom_permission +``` + +```release-note:enhancement +resource/aws_quicksight_user: Change `user_name` to Optional and Computed +``` + +```release-note:enhancement +resource/aws_quicksight_user: Support `IAM_IDENTITY_CENTER` as a valid value for `identity_type` +``` + +```release-note:enhancement +resource/aws_quicksight_user: Support `RESTRICTED_AUTHOR` and `RESTRICTED_READER` as valid values for `user_role` +``` + +```release-note:enhancement +resource/aws_quicksight_user: Add plan-time validation of `iam_arn` +``` + +```release-note:enhancement +data-source/aws_quicksight_user: Add `custom_permissions_name` attribute +``` \ No newline at end of file diff --git a/.changelog/43614.txt b/.changelog/43614.txt new file mode 100644 index 000000000000..f978066041cd --- /dev/null +++ b/.changelog/43614.txt @@ -0,0 +1,3 @@ +```release-note:enhancement +resource/aws_cleanrooms_collaboration: Add `analytics_engine` argument +``` diff --git a/.changelog/43630.txt b/.changelog/43630.txt new file mode 100644 index 000000000000..7f8157a8ac96 --- /dev/null +++ b/.changelog/43630.txt @@ -0,0 +1,7 @@ +```release-note:enhancement +resource/aws_s3_access_point: Add `tags` argument and `tags_all` attribute. This functionality requires the `s3:ListTagsForResource`, `s3:TagResource`, and `s3:UntagResource` IAM permissions +``` + +```release-note:enhancement +data-source/aws_s3_access_point: Add `tags` attribute. This functionality requires the `s3:ListTagsForResource` IAM permission +``` \ No newline at end of file diff --git a/.changelog/43642.txt b/.changelog/43642.txt new file mode 100644 index 000000000000..1f3463d92979 --- /dev/null +++ b/.changelog/43642.txt @@ -0,0 +1,7 @@ +```release-note:enhancement +resource/aws_ecr_repository: Add `image_tag_mutability_exclusion_filter` argument +``` + +```release-note:enhancement +resource/aws_ecr_repository: Support `IMMUTABLE_WITH_EXCLUSION` and `MUTABLE_WITH_EXCLUSION` as valid values for `image_tag_mutability` +``` \ No newline at end of file diff --git a/.changelog/43647.txt b/.changelog/43647.txt new file mode 100644 index 000000000000..8979285fde84 --- /dev/null +++ b/.changelog/43647.txt @@ -0,0 +1,3 @@ +```release-note:enhancement +resource/aws_kinesis_firehose_delivery_stream: Add `iceberg_configuration.append_only` argument +``` diff --git a/.changelog/43654.txt b/.changelog/43654.txt new file mode 100644 index 000000000000..bd84ca1c52a8 --- /dev/null +++ b/.changelog/43654.txt @@ -0,0 +1,3 @@ +```release-note:bug +resource/aws_bedrockagent_flow: Prevent `created_at` becoming `null` on Update +``` diff --git a/.changelog/43659.txt b/.changelog/43659.txt new file mode 100644 index 000000000000..e57a56c9e81a --- /dev/null +++ b/.changelog/43659.txt @@ -0,0 +1,3 @@ +```release-note:bug +provider: Fix failure to detect resources deleted outside of Terraform as missing for numerous resource types +``` \ No newline at end of file diff --git a/.changelog/43661.txt b/.changelog/43661.txt new file mode 100644 index 000000000000..b06b5906836a --- /dev/null +++ b/.changelog/43661.txt @@ -0,0 +1,3 @@ +```release-note:bug +resource/aws_ec2_managed_prefix_list: Fix `PrefixListVersionMismatch: The prefix list has the incorrect version number` errors when updating entry description +``` \ No newline at end of file diff --git a/.changelog/43667.txt b/.changelog/43667.txt new file mode 100644 index 000000000000..3ed1f46ee9ac --- /dev/null +++ b/.changelog/43667.txt @@ -0,0 +1,3 @@ +```release-note:enhancement +resource/aws_docdb_cluster: Add `serverless_v2_scaling_configuration` argument in support of [Amazon DocumentDB serverless](https://docs.aws.amazon.com/documentdb/latest/developerguide/docdb-serverless.html) +``` diff --git a/.changelog/43672.txt b/.changelog/43672.txt new file mode 100644 index 000000000000..9e196e510a71 --- /dev/null +++ b/.changelog/43672.txt @@ -0,0 +1,3 @@ +```release-note:enhancement +resource/aws_lightsail_static_ip: Support resource import +``` diff --git a/.changelog/43673.txt b/.changelog/43673.txt new file mode 100644 index 000000000000..e74f3cbcc905 --- /dev/null +++ b/.changelog/43673.txt @@ -0,0 +1,3 @@ +```release-note:enhancement +resource/aws_inspector2_enabler: Support resource import +``` diff --git a/.changelog/43674.txt b/.changelog/43674.txt new file mode 100644 index 000000000000..e4bca455c146 --- /dev/null +++ b/.changelog/43674.txt @@ -0,0 +1,3 @@ +```release-note:enhancement +resource/aws_opensearch_domain_policy: Support resource import +``` diff --git a/.changelog/43675.txt b/.changelog/43675.txt new file mode 100644 index 000000000000..f0d443f5340b --- /dev/null +++ b/.changelog/43675.txt @@ -0,0 +1,3 @@ +```release-note:new-resource +aws_networkfirewall_vpc_endpoint_association +``` \ No newline at end of file diff --git a/.changelog/43676.txt b/.changelog/43676.txt new file mode 100644 index 000000000000..9a1ea0a54878 --- /dev/null +++ b/.changelog/43676.txt @@ -0,0 +1,3 @@ +```release-note:bug +ephemeral-resource/aws_lambda_invocation: Fix plan inconsistency issue due to improperly assigned payload values +``` diff --git a/.changelog/43677.txt b/.changelog/43677.txt new file mode 100644 index 000000000000..2ad6d986e2a0 --- /dev/null +++ b/.changelog/43677.txt @@ -0,0 +1,4 @@ +```release-note:enhancement +resource/aws_computeoptimizer_recommendation_preferences: Add `AuroraDBClusterStorage` as a valid `resource_type` +``` + diff --git a/.changelog/43693.txt b/.changelog/43693.txt new file mode 100644 index 000000000000..b3a2df3a11d9 --- /dev/null +++ b/.changelog/43693.txt @@ -0,0 +1,3 @@ +```release-note:bug +resource/aws_wafv2_regex_pattern_set: Remove maximum items limit on the `regular_expression` argument +``` \ No newline at end of file diff --git a/.changelog/43697.txt b/.changelog/43697.txt new file mode 100644 index 000000000000..bd31a7d1e318 --- /dev/null +++ b/.changelog/43697.txt @@ -0,0 +1,6 @@ +```release-note:enhancement +resource/aws_ivschat_room: Add resource identity support +``` +```release-note:enhancement +resource/aws_ivschat_logging_configuration: Add resource identity support +``` diff --git a/.changelog/43699.txt b/.changelog/43699.txt new file mode 100644 index 000000000000..cc05a5c90b00 --- /dev/null +++ b/.changelog/43699.txt @@ -0,0 +1,3 @@ +```release-note:enhancement +resource/aws_lb: Add `secondary_ips_auto_assigned_per_subnet` argument for Network Load Balancers +``` \ No newline at end of file diff --git a/.changelog/43702.txt b/.changelog/43702.txt new file mode 100644 index 000000000000..c7b51d0eb2c6 --- /dev/null +++ b/.changelog/43702.txt @@ -0,0 +1,3 @@ +```release-note:enhancement +resource/aws_bedrock_guardrail: Add `input_action`, `output_action`, `input_enabled`, and `output_enabled` attributes to `sensitive_information_policy_config.pii_entities_config` and `sensitive_information_policy_config.regexes_config` configuration blocks +``` diff --git a/.changelog/43704.txt b/.changelog/43704.txt new file mode 100644 index 000000000000..4d6cb1935fdd --- /dev/null +++ b/.changelog/43704.txt @@ -0,0 +1,9 @@ +```release-note:enhancement +resource/aws_ivs_channel: Add resource identity support +``` +```release-note:enhancement +resource/aws_ivs_playback_key_pair: Add resource identity support +``` +```release-note:enhancement +resource/aws_ivs_recording_configuration: Add resource identity support +``` diff --git a/.changelog/43707.txt b/.changelog/43707.txt new file mode 100644 index 000000000000..78331eb79bfe --- /dev/null +++ b/.changelog/43707.txt @@ -0,0 +1,3 @@ +```release-note:bug +resource/aws_s3tables_table_bucket: Fix crash on `maintenance_configuration` read failure +``` diff --git a/.changelog/43708.txt b/.changelog/43708.txt new file mode 100644 index 000000000000..a7ce91e1dbc1 --- /dev/null +++ b/.changelog/43708.txt @@ -0,0 +1,3 @@ +```release-note:bug +resource/aws_nat_gateway: Fix inconsistent final plan for `secondary_private_ip_addresses` +``` diff --git a/.changelog/43710.txt b/.changelog/43710.txt new file mode 100644 index 000000000000..156ed87fa3c3 --- /dev/null +++ b/.changelog/43710.txt @@ -0,0 +1,3 @@ +```release-note:enhancement +resource/aws_sqs_queue: Increase upper limit of `max_message_size` from 256 KiB to 1024 KiB +``` diff --git a/.changelog/43716.txt b/.changelog/43716.txt new file mode 100644 index 000000000000..6b6ad616d213 --- /dev/null +++ b/.changelog/43716.txt @@ -0,0 +1,3 @@ +```release-note:bug +resource/aws_kms_key: Restore pre-v6.3.0 retry delay behavior when waiting for continuous target state occurrences. This fixes certain tag update timeouts +``` \ No newline at end of file diff --git a/.changelog/43719.txt b/.changelog/43719.txt new file mode 100644 index 000000000000..6352f6cd5ae4 --- /dev/null +++ b/.changelog/43719.txt @@ -0,0 +1,3 @@ +```release-note:enhancement +resource/aws_cloudwatch_log_group: Add resource identity support +``` diff --git a/.changelog/43722.txt b/.changelog/43722.txt new file mode 100644 index 000000000000..6d54855089bf --- /dev/null +++ b/.changelog/43722.txt @@ -0,0 +1,7 @@ +```release-note:bug +resource/aws_instance: Prevent destruction of resource when `disable_api_termination` is `true` +``` + +```release-note:enhancement +resource/aws_instance: Adds `force_destroy` argument that allows destruction even when `disable_api_termination` and `disable_api_stop` are `true` +``` \ No newline at end of file diff --git a/.changelog/43729.txt b/.changelog/43729.txt new file mode 100644 index 000000000000..143f37af70d8 --- /dev/null +++ b/.changelog/43729.txt @@ -0,0 +1,3 @@ +```release-note:new-resource +aws_workspacesweb_identity_provider +``` \ No newline at end of file diff --git a/.changelog/43735.txt b/.changelog/43735.txt new file mode 100644 index 000000000000..f864e6a54db9 --- /dev/null +++ b/.changelog/43735.txt @@ -0,0 +1,3 @@ +```release-note:new-resource +aws_workspacesweb_browser_settings_association +``` \ No newline at end of file diff --git a/.changelog/43736.txt b/.changelog/43736.txt new file mode 100644 index 000000000000..55064e9fbfff --- /dev/null +++ b/.changelog/43736.txt @@ -0,0 +1,3 @@ +```release-note:enhancement +resource/aws_ssm_parameter: Add resource identity support +``` diff --git a/.changelog/43744.txt b/.changelog/43744.txt new file mode 100644 index 000000000000..59630af5cee2 --- /dev/null +++ b/.changelog/43744.txt @@ -0,0 +1,3 @@ +```release-note:enhancement +resource/aws_security_group: Add parameterized resource identity support +``` diff --git a/.changelog/43751.txt b/.changelog/43751.txt new file mode 100644 index 000000000000..225692d53df3 --- /dev/null +++ b/.changelog/43751.txt @@ -0,0 +1,3 @@ +```release-note:bug +resource/aws_sagemaker_image: Fix `image_name` regular expression validation +``` diff --git a/.changelog/43752.txt b/.changelog/43752.txt new file mode 100644 index 000000000000..3267860f0ee0 --- /dev/null +++ b/.changelog/43752.txt @@ -0,0 +1,7 @@ +```release-note:enhancement +resource/aws_eks_cluster: Add `deletion_protection` argument +``` + +```release-note:enhancement +data-source/aws_eks_cluster: Add `deletion_protection` attribute +``` \ No newline at end of file diff --git a/.changelog/43753.txt b/.changelog/43753.txt new file mode 100644 index 000000000000..ba7096ffde92 --- /dev/null +++ b/.changelog/43753.txt @@ -0,0 +1,7 @@ +```release-note:bug +resource/aws_lambda_function: Fix missing value for `reserved_concurrent_executions` attribute when a published version exists. This functionality requires the `lambda:GetFunctionConcurrency` IAM permission +``` + +```release-note:bug +data-source/aws_lambda_function: Fix missing value for `reserved_concurrent_executions` attribute when a published version exists. This functionality requires the `lambda:GetFunctionConcurrency` IAM permission +``` diff --git a/.changelog/43758.txt b/.changelog/43758.txt new file mode 100644 index 000000000000..1c84fc9372a6 --- /dev/null +++ b/.changelog/43758.txt @@ -0,0 +1,3 @@ +```release-note:enhancement +resource/aws_cloudwatch_event_rule: Add resource identity support +``` diff --git a/.changelog/43759.txt b/.changelog/43759.txt new file mode 100644 index 000000000000..74decbdf3aa0 --- /dev/null +++ b/.changelog/43759.txt @@ -0,0 +1,3 @@ +```release-note:enhancement +resource/aws_cloudwatch_metric_alarm: Add resource identity support +``` diff --git a/.changelog/43764.txt b/.changelog/43764.txt new file mode 100644 index 000000000000..e0627ad4ecf7 --- /dev/null +++ b/.changelog/43764.txt @@ -0,0 +1,3 @@ +```release-note:bug +resource/aws_s3tables_table: Fix `runtime error: invalid memory address or nil pointer dereference` panics when `GetTableMaintenanceConfiguration` returns an error +``` \ No newline at end of file diff --git a/.changelog/43773.txt b/.changelog/43773.txt new file mode 100644 index 000000000000..0179cb457aca --- /dev/null +++ b/.changelog/43773.txt @@ -0,0 +1,3 @@ +```release-note:new-resource +aws_workspacesweb_data_protection_settings_association +``` \ No newline at end of file diff --git a/.changelog/43774.txt b/.changelog/43774.txt new file mode 100644 index 000000000000..01e3edf0e656 --- /dev/null +++ b/.changelog/43774.txt @@ -0,0 +1,3 @@ +```release-note:new-resource +aws_workspacesweb_ip_access_settings_association +``` \ No newline at end of file diff --git a/.changelog/43775.txt b/.changelog/43775.txt new file mode 100644 index 000000000000..8c83f9156c77 --- /dev/null +++ b/.changelog/43775.txt @@ -0,0 +1,3 @@ +```release-note:new-resource +aws_workspacesweb_network_settings_association +``` \ No newline at end of file diff --git a/.changelog/43776.txt b/.changelog/43776.txt new file mode 100644 index 000000000000..423671d48fb3 --- /dev/null +++ b/.changelog/43776.txt @@ -0,0 +1,3 @@ +```release-note:new-resource +aws_workspacesweb_user_access_logging_settings_association +``` \ No newline at end of file diff --git a/.changelog/43777.txt b/.changelog/43777.txt new file mode 100644 index 000000000000..99d66e2a4bea --- /dev/null +++ b/.changelog/43777.txt @@ -0,0 +1,3 @@ +```release-note:new-resource +aws_workspacesweb_user_settings_association +``` \ No newline at end of file diff --git a/.changelog/43778.txt b/.changelog/43778.txt new file mode 100644 index 000000000000..60714b3ec13c --- /dev/null +++ b/.changelog/43778.txt @@ -0,0 +1,3 @@ +```release-note:new-resource +aws_workspacesweb_trust_store_association +``` \ No newline at end of file diff --git a/.changelog/43787.txt b/.changelog/43787.txt new file mode 100644 index 000000000000..164c750a17f2 --- /dev/null +++ b/.changelog/43787.txt @@ -0,0 +1,7 @@ +```release-note:new-resource +aws_appsync_api +``` + +```release-note:new-resource +aws_appsync_channel_namespace +``` \ No newline at end of file diff --git a/.changelog/43807.txt b/.changelog/43807.txt new file mode 100644 index 000000000000..a802df2e0e7b --- /dev/null +++ b/.changelog/43807.txt @@ -0,0 +1,3 @@ +```release-note:bug +resource/aws_sagemaker_user_profile: Fix incomplete regex for `user_profile_name` +``` \ No newline at end of file diff --git a/.changelog/43816.txt b/.changelog/43816.txt new file mode 100644 index 000000000000..16e4a0cb338e --- /dev/null +++ b/.changelog/43816.txt @@ -0,0 +1,3 @@ +```release-note:bug +resource/aws_ecs_service: Fix tagging failure after upgrading to v6 provider +``` diff --git a/.changelog/43817.txt b/.changelog/43817.txt new file mode 100644 index 000000000000..9919e55d102b --- /dev/null +++ b/.changelog/43817.txt @@ -0,0 +1,3 @@ +```release-note:new-resource +aws_cognito_managed_login_branding +``` \ No newline at end of file diff --git a/.changelog/43819.txt b/.changelog/43819.txt new file mode 100644 index 000000000000..3f4b36d858b4 --- /dev/null +++ b/.changelog/43819.txt @@ -0,0 +1,3 @@ +```release-note:bug +resource/aws_storagegateway_gateway: Handle `InvalidGatewayRequestException: The specified gateway is not connected` errors during Read by using the [`ListGateways` API](https://docs.aws.amazon.com/storagegateway/latest/APIReference/API_ListGateways.html) to return minimal information about a disconnected gateway. This functionality requires the `storagegateway:ListGateways` IAM permission +``` \ No newline at end of file diff --git a/.changelog/43821.txt b/.changelog/43821.txt new file mode 100644 index 000000000000..d7fd9cb0b265 --- /dev/null +++ b/.changelog/43821.txt @@ -0,0 +1,3 @@ +```release-note:enhancement +resource/aws_lambda_function: Add resource identity support +``` diff --git a/.changelog/43830.txt b/.changelog/43830.txt new file mode 100644 index 000000000000..558cf3fe21a1 --- /dev/null +++ b/.changelog/43830.txt @@ -0,0 +1,11 @@ +```release-note:enhancement +resource/aws_sns_topic_policy: Add resource identity support +``` + +```release-note:enhancement +resource/aws_sns_topic_data_protection_policy: Add resource identity support +``` + +```release-note:enhancement +resource/aws_sns_topic_subscription: Add resource identity support +``` diff --git a/.changelog/43833.txt b/.changelog/43833.txt new file mode 100644 index 000000000000..cf105056899a --- /dev/null +++ b/.changelog/43833.txt @@ -0,0 +1,3 @@ +```release-note:enhancement +resource/aws_subnet: Add resource identity support +``` diff --git a/.changelog/43852.txt b/.changelog/43852.txt new file mode 100644 index 000000000000..79bd8e40b7a6 --- /dev/null +++ b/.changelog/43852.txt @@ -0,0 +1,3 @@ +```release-note:bug +data-source/aws_networkfirewall_firewall_policy: Add missing schema definition for `firewall_policy.stateful_engine_options.flow_timeouts` +``` diff --git a/.changelog/43863.txt b/.changelog/43863.txt new file mode 100644 index 000000000000..d0b2f6d8fa5e --- /dev/null +++ b/.changelog/43863.txt @@ -0,0 +1,3 @@ +```release-note:new-resource +aws_workspacesweb_session_logger +``` \ No newline at end of file diff --git a/.changelog/43866.txt b/.changelog/43866.txt new file mode 100644 index 000000000000..9c4649a3dfab --- /dev/null +++ b/.changelog/43866.txt @@ -0,0 +1,3 @@ +```release-note:new-resource +aws_workspacesweb_session_logger_association +``` \ No newline at end of file diff --git a/.changelog/43871.txt b/.changelog/43871.txt new file mode 100644 index 000000000000..f3af9a55e871 --- /dev/null +++ b/.changelog/43871.txt @@ -0,0 +1,2 @@ +```release-note:bug +resource/aws_ecs_service: Fix refreshing `service_connect_configuration` when deleted outside of Terraform \ No newline at end of file diff --git a/.changelog/43872.txt b/.changelog/43872.txt new file mode 100644 index 000000000000..a586f8658f19 --- /dev/null +++ b/.changelog/43872.txt @@ -0,0 +1,9 @@ +```release-note:enhancement +resource/aws_secretsmanager_secret: Add resource identity support +``` +```release-note:enhancement +resource/aws_secretsmanager_secret_policy: Add resource identity support +``` +```release-note:enhancement +resource/aws_secretsmanager_secret_rotation: Add resource identity support +``` diff --git a/.changelog/43874.txt b/.changelog/43874.txt new file mode 100644 index 000000000000..c29524de50f7 --- /dev/null +++ b/.changelog/43874.txt @@ -0,0 +1,3 @@ +```release-note:enhancement +resource/aws_lightsail_static_ip_attachment: Support resource import +``` diff --git a/.changelog/43886.txt b/.changelog/43886.txt new file mode 100644 index 000000000000..36421993ebbf --- /dev/null +++ b/.changelog/43886.txt @@ -0,0 +1,11 @@ +```release-note:enhancement +resource/aws_ecr_repository_creation_template: Add `image_tag_mutability_exclusion_filter` configuration block +``` + +```release-note:enhancement +data-source/aws_ecr_repository_creation_template: Add `image_tag_mutability_exclusion_filter` attribute +``` + +```release-note:enhancement +data-source/aws_ecr_repository: Add `image_tag_mutability_exclusion_filter` attribute +``` diff --git a/.changelog/43910.txt b/.changelog/43910.txt new file mode 100644 index 000000000000..d8963d4b4c67 --- /dev/null +++ b/.changelog/43910.txt @@ -0,0 +1,3 @@ +```release-note:enhancement +resource/aws_route: Add resource identity support +``` diff --git a/.changelog/43914.txt b/.changelog/43914.txt new file mode 100644 index 000000000000..8038c6bcdf75 --- /dev/null +++ b/.changelog/43914.txt @@ -0,0 +1,3 @@ +```release-note:enhancement +resource/aws_dynamodb_contributor_insights: Add `mode` argument in support of [CloudWatch contributor insights modes](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/contributorinsights_HowItWorks.html#contributorinsights_HowItWorks.Modes) +``` diff --git a/.changelog/43916.txt b/.changelog/43916.txt new file mode 100644 index 000000000000..6730b51425a7 --- /dev/null +++ b/.changelog/43916.txt @@ -0,0 +1,3 @@ +```release-note:enhancement +resource/aws_iot_thing_principal_attachment: Add `thing_principal_type` argument +``` diff --git a/.changelog/43918.txt b/.changelog/43918.txt new file mode 100644 index 000000000000..33e769b8dbec --- /dev/null +++ b/.changelog/43918.txt @@ -0,0 +1,12 @@ +```release-note:enhancement +resource/aws_sqs_queue: Add resource identity support +``` +```release-note:enhancement +resource/aws_sqs_queue_policy: Add resource identity support +``` +```release-note:enhancement +resource/aws_sqs_queue_redrive_policy: Add resource identity support +``` +```release-note:enhancement +resource/aws_sqs_queue_redrive_allow_policy: Add resource identity support +``` diff --git a/.changelog/43919.txt b/.changelog/43919.txt new file mode 100644 index 000000000000..92546b610342 --- /dev/null +++ b/.changelog/43919.txt @@ -0,0 +1,3 @@ +```release-note:bug +resource/aws_rds_cluster: Fixes the behavior when enabling database_insights_mode="advanced" without changing performance insights retention window +``` diff --git a/.changelog/43921.txt b/.changelog/43921.txt new file mode 100644 index 000000000000..56f25ff5dbca --- /dev/null +++ b/.changelog/43921.txt @@ -0,0 +1,7 @@ +```release-note:enhancement +resource/aws_signer_signing_profile: Add `signing_parameters` argument +``` + +```release-note:enhancement +data-source/aws_signer_signing_profile: Add `signing_material` and `signing_parameters` attributes +``` diff --git a/.changelog/43922.txt b/.changelog/43922.txt new file mode 100644 index 000000000000..a832774e42a8 --- /dev/null +++ b/.changelog/43922.txt @@ -0,0 +1,3 @@ +```release-note:enhancement +resource/aws_s3tables_table_bucket: Add `force_destroy` argument +``` \ No newline at end of file diff --git a/.changelog/43925.txt b/.changelog/43925.txt new file mode 100644 index 000000000000..192e37d84e9a --- /dev/null +++ b/.changelog/43925.txt @@ -0,0 +1,3 @@ +```release-note:bug +resource/imagebuilder_lifecycle_policy: Fix `Provider produced inconsistent result after apply` error when `policy_detail.exclusion_rules.amis.is_public` is omitted +``` diff --git a/.changelog/43926.txt b/.changelog/43926.txt new file mode 100644 index 000000000000..d017e0830deb --- /dev/null +++ b/.changelog/43926.txt @@ -0,0 +1,3 @@ +```release-note:bug +resource/aws_cognito_user_pool: Fixed to accept an empty `email_mfa_configuration` block +``` diff --git a/.changelog/43942.txt b/.changelog/43942.txt new file mode 100644 index 000000000000..60bfebd60dbb --- /dev/null +++ b/.changelog/43942.txt @@ -0,0 +1,3 @@ +```release-note:bug +resource/aws_rds_cluster: Fixes the behavior when modifying `database_insights_mode` when using custom KMS key +``` diff --git a/.changelog/43946.txt b/.changelog/43946.txt new file mode 100644 index 000000000000..f2d93d1515f0 --- /dev/null +++ b/.changelog/43946.txt @@ -0,0 +1,3 @@ +```release-note:enhancement +resource/aws_mwaa_environment: Add `worker_replacement_strategy` argument +``` diff --git a/.changelog/43950.txt b/.changelog/43950.txt new file mode 100644 index 000000000000..7c0849a17095 --- /dev/null +++ b/.changelog/43950.txt @@ -0,0 +1,3 @@ +```release-note:enhancement +resource/aws_inspector2_filter: Support `code_repository_project_name`, `code_repository_provider_type`, `ecr_image_in_use_count`, and `ecr_image_last_in_use_at` in `filter_criteria` +``` diff --git a/.changelog/43953.txt b/.changelog/43953.txt new file mode 100644 index 000000000000..b96a67595c45 --- /dev/null +++ b/.changelog/43953.txt @@ -0,0 +1,15 @@ +```release-note:bug +resource/aws_instance: Adds `primary_network_interface` to allow importing resources with custom primary network interface. +``` + +```release-note:bug +resource/aws_spot_instance_request: Adds `primary_network_interface` to allow importing resources with custom primary network interface. +``` + +```release-note:note +resource/aws_instance: The `network_interface` block has been deprecated. Use `primary_network_interface` for the primary network interface and `aws_network_interface_attachment` resources for other network interfaces. +``` + +```release-note:note +resource/aws_spot_instance_request: The `network_interface` block has been deprecated. Use `primary_network_interface` for the primary network interface and `aws_network_interface_attachment` resources for other network interfaces. +``` diff --git a/.changelog/43954.txt b/.changelog/43954.txt new file mode 100644 index 000000000000..92cc8cb60a04 --- /dev/null +++ b/.changelog/43954.txt @@ -0,0 +1,3 @@ +```release-note:enhancement +resource/aws_lambda_permission: Add resource identity support +``` diff --git a/.changelog/43956.txt b/.changelog/43956.txt new file mode 100644 index 000000000000..d3254c1a25ae --- /dev/null +++ b/.changelog/43956.txt @@ -0,0 +1,3 @@ +```release-note:bug +resource/aws_servicecatalog_provisioned_product: Set `provisioning_parameters` and `provisioning_artifact_id` to the values from the last successful deployment when update fails +``` diff --git a/.changelog/43967.txt b/.changelog/43967.txt new file mode 100644 index 000000000000..478490d20dd5 --- /dev/null +++ b/.changelog/43967.txt @@ -0,0 +1,7 @@ +```release-note:enhancement +resource/aws_vpc_ipam: Add `metered_account` argument +``` + +```release-note:enhancement +data-source/aws_vpc_ipam: Add `metered_account` attribute +``` diff --git a/.changelog/43976.txt b/.changelog/43976.txt new file mode 100644 index 000000000000..99c74c0ece09 --- /dev/null +++ b/.changelog/43976.txt @@ -0,0 +1,27 @@ +```release-note:enhancement +resource/aws_s3_bucket_public_access_block: Add resource identity support +``` +```release-note:enhancement +resource/aws_s3_bucket_policy: Add resource identity support +``` +```release-note:enhancement +resource/aws_s3_bucket_ownership_controls: Add resource identity support +``` +```release-note:enhancement +resource/aws_s3_bucket_logging: Add resource identity support +``` +```release-note:enhancement +resource/aws_s3_bucket_server_side_encryption_configuration: Add resource identity support +``` +```release-note:enhancement +resource/aws_s3_bucket_versioning: Add resource identity support +``` +```release-note:enhancement +resource/aws_s3_bucket_notification: Add resource identity support +``` +```release-note:enhancement +resource/aws_s3_bucket_cors_configuration: Add resource identity support +``` +```release-note:enhancement +resource/aws_s3_bucket_website_configuration: Add resource identity support +``` diff --git a/.changelog/43981.txt b/.changelog/43981.txt new file mode 100644 index 000000000000..413d5bf9ca89 --- /dev/null +++ b/.changelog/43981.txt @@ -0,0 +1,3 @@ +```release-note:bug +resource/aws_imagebuilder_image_recipe: Increase upper limit of `block_device_mapping.ebs.iops` from `10000` to `100000` +``` diff --git a/.changelog/43984.txt b/.changelog/43984.txt new file mode 100644 index 000000000000..42e51ab16364 --- /dev/null +++ b/.changelog/43984.txt @@ -0,0 +1,3 @@ +```release-note:enhancement +resource/aws_cloudwatch_event_target: Add resource identity support +``` diff --git a/.changelog/43986.txt b/.changelog/43986.txt new file mode 100644 index 000000000000..f05b41ac48b4 --- /dev/null +++ b/.changelog/43986.txt @@ -0,0 +1,7 @@ +```release-note:enhancement +resource/aws_ecs_service: Add `sigint_rollback` argument +``` + +```release-note:enhancement +resource/aws_ecs_service: Change `deployment_configuration` to Optional and Computed +``` \ No newline at end of file diff --git a/.changelog/43988.txt b/.changelog/43988.txt new file mode 100644 index 000000000000..2ad4ab4b7171 --- /dev/null +++ b/.changelog/43988.txt @@ -0,0 +1,3 @@ +```release-note:enhancement +resource/aws_glue_job: Support `G.12X`, `G.16X`, `R.1X`, `R.2X`, `R.4X`, and `R.8X` as valid values for `worker_type` +``` \ No newline at end of file diff --git a/.changelog/43989.txt b/.changelog/43989.txt new file mode 100644 index 000000000000..06ec6652bcc9 --- /dev/null +++ b/.changelog/43989.txt @@ -0,0 +1,3 @@ +```release-note:enhancement +resource/aws_synthetics_canary: Add `vpc_config.ipv6_allowed_for_dual_stack` argument +``` diff --git a/.changelog/43990.txt b/.changelog/43990.txt new file mode 100644 index 000000000000..6f6611213fc0 --- /dev/null +++ b/.changelog/43990.txt @@ -0,0 +1,3 @@ +```release-note:enhancement +resource/aws_route_table: Add resource identity support +``` diff --git a/.changelog/44011.txt b/.changelog/44011.txt new file mode 100644 index 000000000000..1bc3a0cac0c2 --- /dev/null +++ b/.changelog/44011.txt @@ -0,0 +1,7 @@ +```release-note:enhancement +resource/aws_kms_external_key: Add `key_spec` argument +``` + +```release-note:enhancement +resource/aws_kms_external_key: Change `key_usage` to Optional and Computed +``` \ No newline at end of file diff --git a/.changelog/44025.txt b/.changelog/44025.txt new file mode 100644 index 000000000000..cd2b84ac492e --- /dev/null +++ b/.changelog/44025.txt @@ -0,0 +1,6 @@ +```release-note:enhancement +resource/aws_kms_key: Add resource identity support +``` +```release-note:enhancement +resource/aws_kms_alias: Add resource identity support +``` diff --git a/.changelog/44031.txt b/.changelog/44031.txt new file mode 100644 index 000000000000..6e93e8580bca --- /dev/null +++ b/.changelog/44031.txt @@ -0,0 +1,3 @@ +```release-note:enhancement +resource/aws_secretsmanager_secret_version: Add resource identity support +``` diff --git a/.changelog/44032.txt b/.changelog/44032.txt new file mode 100644 index 000000000000..2f7d29c88819 --- /dev/null +++ b/.changelog/44032.txt @@ -0,0 +1,3 @@ +```release-note:bug +resource/aws_wafv2_web_acl: Add missing flattening of `name` in `response_inspection.header` blocks for `AWSManagedRulesATPRuleSet` and `AWSManagedRulesACFPRuleSet` to avoid persistent plan diffs +``` diff --git a/.changelog/44041.txt b/.changelog/44041.txt new file mode 100644 index 000000000000..e8982db26e93 --- /dev/null +++ b/.changelog/44041.txt @@ -0,0 +1,9 @@ +```release-note:enhancement +resource/aws_ecr_repository: Add resource identity support +``` +```release-note:enhancement +resource/aws_ecr_repository_policy: Add resource identity support +``` +```release-note:enhancement +resource/aws_ecr_lifecycle_policy: Add resource identity support +``` diff --git a/.changelog/44042.txt b/.changelog/44042.txt new file mode 100644 index 000000000000..cbf0829c09e1 --- /dev/null +++ b/.changelog/44042.txt @@ -0,0 +1,3 @@ +```release-note:enhancement +resource/aws_datazone_domain: Add `domain_version` and `service_role` arguments to support V2 domains +``` diff --git a/.changelog/44043.txt b/.changelog/44043.txt new file mode 100644 index 000000000000..83d5cfffa5e0 --- /dev/null +++ b/.changelog/44043.txt @@ -0,0 +1,3 @@ +```release-note:enhancement +resource/aws_s3_bucket_acl: Add resource identity support +``` diff --git a/.changelog/44045.txt b/.changelog/44045.txt new file mode 100644 index 000000000000..245531c47e21 --- /dev/null +++ b/.changelog/44045.txt @@ -0,0 +1,7 @@ +```release-note:enhancement +data-source/aws_sesv2_email_identity: Add `verification_status` attribute +``` + +```release-note:enhancement +resource/aws_sesv2_email_identity: Add `verification_status` attribute +``` \ No newline at end of file diff --git a/.changelog/44048.txt b/.changelog/44048.txt new file mode 100644 index 000000000000..673c62d9964e --- /dev/null +++ b/.changelog/44048.txt @@ -0,0 +1,6 @@ +```release-note:enhancement +resource/aws_route53_resolver_rule: Add resource identity support +``` +```release-note:enhancement +resource/aws_route53_resolver_rule_association: Add resource identity support +``` diff --git a/.changelog/44050.txt b/.changelog/44050.txt new file mode 100644 index 000000000000..f1f2d37ab9b3 --- /dev/null +++ b/.changelog/44050.txt @@ -0,0 +1,3 @@ +```release-note:bug +resource/aws_db_instance: Fixes the behavior when modifying `database_insights_mode` when using custom KMS key +``` diff --git a/.changelog/44059.txt b/.changelog/44059.txt new file mode 100644 index 000000000000..70f81686af99 --- /dev/null +++ b/.changelog/44059.txt @@ -0,0 +1,11 @@ +```release-note:enhancement +resource/aws_ec2_client_vpn_endpoint: Add `endpoint_ip_address_type` and `traffic_ip_address_type` arguments to support IPv6 connectivity in Client VPN +``` + +```release-note:enhancement +resource/aws_ec2_client_vpn_endpoint: Make `client_cidr_block` optional +``` + +```release-note:enhancement +data-source/aws_ec2_client_vpn_endpoint: Add `endpoint_ip_address_type` and `traffic_ip_address_type` attributes +``` diff --git a/.changelog/44068.txt b/.changelog/44068.txt new file mode 100644 index 000000000000..19b51b700c36 --- /dev/null +++ b/.changelog/44068.txt @@ -0,0 +1,3 @@ +```release-note:enhancement +resource/aws_instance: Add resource identity support +``` diff --git a/.changelog/44072.txt b/.changelog/44072.txt new file mode 100644 index 000000000000..2155022ce2f2 --- /dev/null +++ b/.changelog/44072.txt @@ -0,0 +1,3 @@ +```release-note:bug +resource/aws_s3tables_table_policy: Remove plan-time validation of `name` and `namespace` +``` diff --git a/.changelog/44075.txt b/.changelog/44075.txt new file mode 100644 index 000000000000..b6a46af8e657 --- /dev/null +++ b/.changelog/44075.txt @@ -0,0 +1,18 @@ +```release-note:enhancement +resource/aws_ssm_association: Add resource identity support +``` +```release-note:enhancement +resource/aws_ssm_document: Add resource identity support +``` +```release-note:enhancement +resource/aws_ssm_maintenance_window: Add resource identity support +``` +```release-note:enhancement +resource/aws_ssm_maintenance_window_target: Add resource identity support +``` +```release-note:enhancement +resource/aws_ssm_maintenance_window_task: Add resource identity support +``` +```release-note:enhancement +resource/aws_ssm_patch_baseline: Add resource identity support +``` diff --git a/.changelog/44079.txt b/.changelog/44079.txt new file mode 100644 index 000000000000..a10b32f43dcf --- /dev/null +++ b/.changelog/44079.txt @@ -0,0 +1,7 @@ +```release-note:enhancement +resource/aws_efs_mount_target: Add `ip_address_type` and `ipv6_address` arguments to support IPv6 connectivity +``` + +```release-note:enhancement +data-source/aws_efs_mount_target: Add `ip_address_type` and `ipv6_address` attributes +``` diff --git a/.changelog/44080.txt b/.changelog/44080.txt new file mode 100644 index 000000000000..6c732e60a247 --- /dev/null +++ b/.changelog/44080.txt @@ -0,0 +1,7 @@ +```release-note:enhancement +resource/aws_lambda_function: Add `source_kms_key_arn` argument +``` + +```release-note:enhancement +data-source/aws_lambda_function: Add `source_kms_key_arn` attribute +``` diff --git a/.changelog/44090.txt b/.changelog/44090.txt new file mode 100644 index 000000000000..769521fdf32c --- /dev/null +++ b/.changelog/44090.txt @@ -0,0 +1,9 @@ +```release-note:note +resource/aws_s3_bucket_logging: The `target_grant.grantee.display_name` attribute is deprecated. AWS has [ended support for this attribute](https://docs.aws.amazon.com/AmazonS3/latest/API/API_Grantee.html). API responses began inconsistently returning it on July 15, 2025, and will stop returning it entirely on November 21, 2025. This attribute will be removed in a future major version. +``` +```release-note:note +resource/aws_s3_bucket_acl: The `access_control_policy.grant.grantee.display_name` attribute is deprecated. AWS has [ended support for this attribute](https://docs.aws.amazon.com/AmazonS3/latest/API/API_Grantee.html). API responses began inconsistently returning it on July 15, 2025, and will stop returning it entirely on November 21, 2025. This attribute will be removed in a future major version. +``` +```release-note:note +resource/aws_s3_bucket_acl: The `access_control_policy.owner.display_name` attribute is deprecated. AWS has [ended support for this attribute](https://docs.aws.amazon.com/AmazonS3/latest/API/API_Owner.html). API responses began inconsistently returning it on July 15, 2025, and will stop returning it entirely on November 21, 2025. This attribute will be removed in a future major version. +``` diff --git a/.changelog/44097.txt b/.changelog/44097.txt new file mode 100644 index 000000000000..c7c820c92e6c --- /dev/null +++ b/.changelog/44097.txt @@ -0,0 +1,7 @@ +```release-note:enhancement +resource/aws_launch_template: Add `placement.group_id` argument +``` + +```release-note:enhancement +data-source/aws_launch_template: Add `placement.group_id` attribute +``` diff --git a/.changelog/44105.txt b/.changelog/44105.txt new file mode 100644 index 000000000000..b6cd83abda53 --- /dev/null +++ b/.changelog/44105.txt @@ -0,0 +1,3 @@ +```release-note:enhancement +resource/aws_synthetics_canary: Add `run_config.ephemeral_storage` argument. +``` diff --git a/.changelog/44118.txt b/.changelog/44118.txt new file mode 100644 index 000000000000..f3923b9757cc --- /dev/null +++ b/.changelog/44118.txt @@ -0,0 +1,3 @@ +```release-note:enhancement +resource/aws_fsx_openzfs_volume: Remove maximum items limit on the `user_and_group_quotas` argument +``` \ No newline at end of file diff --git a/.changelog/44120.txt b/.changelog/44120.txt new file mode 100644 index 000000000000..4ad7fca1fd2c --- /dev/null +++ b/.changelog/44120.txt @@ -0,0 +1,3 @@ +```release-note:enhancement +resource/aws_fsx_openzfs_file_system: Remove maximum items limit on the `user_and_group_quotas` argument +``` \ No newline at end of file diff --git a/.changelog/44127.txt b/.changelog/44127.txt new file mode 100644 index 000000000000..18776ba9151e --- /dev/null +++ b/.changelog/44127.txt @@ -0,0 +1,3 @@ +```release-note:enhancement +provider: Support `ap-southeast-6` as a valid AWS Region +``` \ No newline at end of file diff --git a/.ci/.semgrep-service-name0.yml b/.ci/.semgrep-service-name0.yml index 505867179cd5..d99eadf90e22 100644 --- a/.ci/.semgrep-service-name0.yml +++ b/.ci/.semgrep-service-name0.yml @@ -1343,6 +1343,67 @@ rules: patterns: - pattern-regex: "(?i)AppSync" severity: WARNING + - id: arcregionswitch-in-func-name + languages: + - go + message: Do not use "ARCRegionSwitch" in func name inside arcregionswitch package + paths: + include: + - internal/service/arcregionswitch + exclude: + - internal/service/arcregionswitch/list_pages_gen.go + patterns: + - pattern: func $NAME( ... ) + - metavariable-pattern: + metavariable: $NAME + patterns: + - pattern-regex: "(?i)ARCRegionSwitch" + - focus-metavariable: $NAME + - pattern-not: func $NAME($T *testing.T) + severity: WARNING + - id: arcregionswitch-in-test-name + languages: + - go + message: Include "ARCRegionSwitch" in test name + paths: + include: + - internal/service/arcregionswitch/*_test.go + patterns: + - pattern: func $NAME( ... ) + - metavariable-pattern: + metavariable: $NAME + patterns: + - pattern-not-regex: "^TestAccARCRegionSwitch" + - pattern-regex: ^TestAcc.* + severity: WARNING + - id: arcregionswitch-in-const-name + languages: + - go + message: Do not use "ARCRegionSwitch" in const name inside arcregionswitch package + paths: + include: + - internal/service/arcregionswitch + patterns: + - pattern: const $NAME = ... + - metavariable-pattern: + metavariable: $NAME + patterns: + - pattern-regex: "(?i)ARCRegionSwitch" + severity: WARNING + - id: arcregionswitch-in-var-name + languages: + - go + message: Do not use "ARCRegionSwitch" in var name inside arcregionswitch package + paths: + include: + - internal/service/arcregionswitch + patterns: + - pattern: var $NAME = ... + - metavariable-pattern: + metavariable: $NAME + patterns: + - pattern-regex: "(?i)ARCRegionSwitch" + severity: WARNING - id: athena-in-func-name languages: - go @@ -1938,6 +1999,67 @@ rules: patterns: - pattern-regex: "(?i)BedrockAgent" severity: WARNING + - id: bedrockagentcore-in-func-name + languages: + - go + message: Do not use "BedrockAgentCore" in func name inside bedrockagentcore package + paths: + include: + - internal/service/bedrockagentcore + exclude: + - internal/service/bedrockagentcore/list_pages_gen.go + patterns: + - pattern: func $NAME( ... ) + - metavariable-pattern: + metavariable: $NAME + patterns: + - pattern-regex: "(?i)BedrockAgentCore" + - focus-metavariable: $NAME + - pattern-not: func $NAME($T *testing.T) + severity: WARNING + - id: bedrockagentcore-in-test-name + languages: + - go + message: Include "BedrockAgentCore" in test name + paths: + include: + - internal/service/bedrockagentcore/*_test.go + patterns: + - pattern: func $NAME( ... ) + - metavariable-pattern: + metavariable: $NAME + patterns: + - pattern-not-regex: "^TestAccBedrockAgentCore" + - pattern-regex: ^TestAcc.* + severity: WARNING + - id: bedrockagentcore-in-const-name + languages: + - go + message: Do not use "BedrockAgentCore" in const name inside bedrockagentcore package + paths: + include: + - internal/service/bedrockagentcore + patterns: + - pattern: const $NAME = ... + - metavariable-pattern: + metavariable: $NAME + patterns: + - pattern-regex: "(?i)BedrockAgentCore" + severity: WARNING + - id: bedrockagentcore-in-var-name + languages: + - go + message: Do not use "BedrockAgentCore" in var name inside bedrockagentcore package + paths: + include: + - internal/service/bedrockagentcore + patterns: + - pattern: var $NAME = ... + - metavariable-pattern: + metavariable: $NAME + patterns: + - pattern-regex: "(?i)BedrockAgentCore" + severity: WARNING - id: billing-in-func-name languages: - go @@ -4329,50 +4451,3 @@ rules: - pattern-not-regex: "^TestAccConfigService" - pattern-regex: ^TestAcc.* severity: WARNING - - id: configservice-in-const-name - languages: - - go - message: Do not use "ConfigService" in const name inside configservice package - paths: - include: - - internal/service/configservice - patterns: - - pattern: const $NAME = ... - - metavariable-pattern: - metavariable: $NAME - patterns: - - pattern-regex: "(?i)ConfigService" - severity: WARNING - - id: configservice-in-var-name - languages: - - go - message: Do not use "ConfigService" in var name inside configservice package - paths: - include: - - internal/service/configservice - patterns: - - pattern: var $NAME = ... - - metavariable-pattern: - metavariable: $NAME - patterns: - - pattern-regex: "(?i)ConfigService" - severity: WARNING - - id: connect-in-func-name - languages: - - go - message: Do not use "Connect" in func name inside connect package - paths: - include: - - internal/service/connect - exclude: - - internal/service/connect/list_pages_gen.go - patterns: - - pattern: func $NAME( ... ) - - metavariable-pattern: - metavariable: $NAME - patterns: - - pattern-regex: "(?i)Connect" - - pattern-not-regex: .*uickConnect.* - - focus-metavariable: $NAME - - pattern-not: func $NAME($T *testing.T) - severity: WARNING diff --git a/.ci/.semgrep-service-name1.yml b/.ci/.semgrep-service-name1.yml index 9667e2aac131..e9cfedc97e2e 100644 --- a/.ci/.semgrep-service-name1.yml +++ b/.ci/.semgrep-service-name1.yml @@ -1,5 +1,52 @@ # Generated by internal/generate/servicesemgrep/main.go; DO NOT EDIT. rules: + - id: configservice-in-const-name + languages: + - go + message: Do not use "ConfigService" in const name inside configservice package + paths: + include: + - internal/service/configservice + patterns: + - pattern: const $NAME = ... + - metavariable-pattern: + metavariable: $NAME + patterns: + - pattern-regex: "(?i)ConfigService" + severity: WARNING + - id: configservice-in-var-name + languages: + - go + message: Do not use "ConfigService" in var name inside configservice package + paths: + include: + - internal/service/configservice + patterns: + - pattern: var $NAME = ... + - metavariable-pattern: + metavariable: $NAME + patterns: + - pattern-regex: "(?i)ConfigService" + severity: WARNING + - id: connect-in-func-name + languages: + - go + message: Do not use "Connect" in func name inside connect package + paths: + include: + - internal/service/connect + exclude: + - internal/service/connect/list_pages_gen.go + patterns: + - pattern: func $NAME( ... ) + - metavariable-pattern: + metavariable: $NAME + patterns: + - pattern-regex: "(?i)Connect" + - pattern-not-regex: .*uickConnect.* + - focus-metavariable: $NAME + - pattern-not: func $NAME($T *testing.T) + severity: WARNING - id: connect-in-test-name languages: - go @@ -4380,3 +4427,21 @@ rules: patterns: - pattern-regex: "(?i)Invoicing" severity: WARNING + - id: iot-in-func-name + languages: + - go + message: Do not use "IoT" in func name inside iot package + paths: + include: + - internal/service/iot + exclude: + - internal/service/iot/list_pages_gen.go + patterns: + - pattern: func $NAME( ... ) + - metavariable-pattern: + metavariable: $NAME + patterns: + - pattern-regex: "(?i)IoT" + - focus-metavariable: $NAME + - pattern-not: func $NAME($T *testing.T) + severity: WARNING diff --git a/.ci/.semgrep-service-name2.yml b/.ci/.semgrep-service-name2.yml index 7b145a586f94..b6c3c421b5f8 100644 --- a/.ci/.semgrep-service-name2.yml +++ b/.ci/.semgrep-service-name2.yml @@ -1,23 +1,5 @@ # Generated by internal/generate/servicesemgrep/main.go; DO NOT EDIT. rules: - - id: iot-in-func-name - languages: - - go - message: Do not use "IoT" in func name inside iot package - paths: - include: - - internal/service/iot - exclude: - - internal/service/iot/list_pages_gen.go - patterns: - - pattern: func $NAME( ... ) - - metavariable-pattern: - metavariable: $NAME - patterns: - - pattern-regex: "(?i)IoT" - - focus-metavariable: $NAME - - pattern-not: func $NAME($T *testing.T) - severity: WARNING - id: iot-in-test-name languages: - go @@ -3021,6 +3003,67 @@ rules: patterns: - pattern-regex: "(?i)ObservabilityAccessManager" severity: WARNING + - id: odb-in-func-name + languages: + - go + message: Do not use "ODB" in func name inside odb package + paths: + include: + - internal/service/odb + exclude: + - internal/service/odb/list_pages_gen.go + patterns: + - pattern: func $NAME( ... ) + - metavariable-pattern: + metavariable: $NAME + patterns: + - pattern-regex: "(?i)ODB" + - focus-metavariable: $NAME + - pattern-not: func $NAME($T *testing.T) + severity: WARNING + - id: odb-in-test-name + languages: + - go + message: Include "ODB" in test name + paths: + include: + - internal/service/odb/*_test.go + patterns: + - pattern: func $NAME( ... ) + - metavariable-pattern: + metavariable: $NAME + patterns: + - pattern-not-regex: "^TestAccODB" + - pattern-regex: ^TestAcc.* + severity: WARNING + - id: odb-in-const-name + languages: + - go + message: Do not use "ODB" in const name inside odb package + paths: + include: + - internal/service/odb + patterns: + - pattern: const $NAME = ... + - metavariable-pattern: + metavariable: $NAME + patterns: + - pattern-regex: "(?i)ODB" + severity: WARNING + - id: odb-in-var-name + languages: + - go + message: Do not use "ODB" in var name inside odb package + paths: + include: + - internal/service/odb + patterns: + - pattern: var $NAME = ... + - metavariable-pattern: + metavariable: $NAME + patterns: + - pattern-regex: "(?i)ODB" + severity: WARNING - id: opensearch-in-func-name languages: - go @@ -4370,3 +4413,49 @@ rules: patterns: - pattern-regex: "(?i)RDS" severity: WARNING + - id: recyclebin-in-func-name + languages: + - go + message: Do not use "recyclebin" in func name inside rbin package + paths: + include: + - internal/service/rbin + exclude: + - internal/service/rbin/list_pages_gen.go + patterns: + - pattern: func $NAME( ... ) + - metavariable-pattern: + metavariable: $NAME + patterns: + - pattern-regex: "(?i)recyclebin" + - focus-metavariable: $NAME + - pattern-not: func $NAME($T *testing.T) + severity: WARNING + - id: recyclebin-in-const-name + languages: + - go + message: Do not use "recyclebin" in const name inside rbin package + paths: + include: + - internal/service/rbin + patterns: + - pattern: const $NAME = ... + - metavariable-pattern: + metavariable: $NAME + patterns: + - pattern-regex: "(?i)recyclebin" + severity: WARNING + - id: recyclebin-in-var-name + languages: + - go + message: Do not use "recyclebin" in var name inside rbin package + paths: + include: + - internal/service/rbin + patterns: + - pattern: var $NAME = ... + - metavariable-pattern: + metavariable: $NAME + patterns: + - pattern-regex: "(?i)recyclebin" + severity: WARNING diff --git a/.ci/.semgrep-service-name3.yml b/.ci/.semgrep-service-name3.yml index bdca7386db66..7f884d3d36ff 100644 --- a/.ci/.semgrep-service-name3.yml +++ b/.ci/.semgrep-service-name3.yml @@ -1,51 +1,5 @@ # Generated by internal/generate/servicesemgrep/main.go; DO NOT EDIT. rules: - - id: recyclebin-in-func-name - languages: - - go - message: Do not use "recyclebin" in func name inside rbin package - paths: - include: - - internal/service/rbin - exclude: - - internal/service/rbin/list_pages_gen.go - patterns: - - pattern: func $NAME( ... ) - - metavariable-pattern: - metavariable: $NAME - patterns: - - pattern-regex: "(?i)recyclebin" - - focus-metavariable: $NAME - - pattern-not: func $NAME($T *testing.T) - severity: WARNING - - id: recyclebin-in-const-name - languages: - - go - message: Do not use "recyclebin" in const name inside rbin package - paths: - include: - - internal/service/rbin - patterns: - - pattern: const $NAME = ... - - metavariable-pattern: - metavariable: $NAME - patterns: - - pattern-regex: "(?i)recyclebin" - severity: WARNING - - id: recyclebin-in-var-name - languages: - - go - message: Do not use "recyclebin" in var name inside rbin package - paths: - include: - - internal/service/rbin - patterns: - - pattern: var $NAME = ... - - metavariable-pattern: - metavariable: $NAME - patterns: - - pattern-regex: "(?i)recyclebin" - severity: WARNING - id: redshift-in-func-name languages: - go @@ -1404,6 +1358,67 @@ rules: patterns: - pattern-regex: "(?i)S3Tables" severity: WARNING + - id: s3vectors-in-func-name + languages: + - go + message: Do not use "S3Vectors" in func name inside s3vectors package + paths: + include: + - internal/service/s3vectors + exclude: + - internal/service/s3vectors/list_pages_gen.go + patterns: + - pattern: func $NAME( ... ) + - metavariable-pattern: + metavariable: $NAME + patterns: + - pattern-regex: "(?i)S3Vectors" + - focus-metavariable: $NAME + - pattern-not: func $NAME($T *testing.T) + severity: WARNING + - id: s3vectors-in-test-name + languages: + - go + message: Include "S3Vectors" in test name + paths: + include: + - internal/service/s3vectors/*_test.go + patterns: + - pattern: func $NAME( ... ) + - metavariable-pattern: + metavariable: $NAME + patterns: + - pattern-not-regex: "^TestAccS3Vectors" + - pattern-regex: ^TestAcc.* + severity: WARNING + - id: s3vectors-in-const-name + languages: + - go + message: Do not use "S3Vectors" in const name inside s3vectors package + paths: + include: + - internal/service/s3vectors + patterns: + - pattern: const $NAME = ... + - metavariable-pattern: + metavariable: $NAME + patterns: + - pattern-regex: "(?i)S3Vectors" + severity: WARNING + - id: s3vectors-in-var-name + languages: + - go + message: Do not use "S3Vectors" in var name inside s3vectors package + paths: + include: + - internal/service/s3vectors + patterns: + - pattern: var $NAME = ... + - metavariable-pattern: + metavariable: $NAME + patterns: + - pattern-regex: "(?i)S3Vectors" + severity: WARNING - id: sagemaker-in-func-name languages: - go @@ -4179,6 +4194,67 @@ rules: patterns: - pattern-regex: "(?i)WellArchitected" severity: WARNING + - id: workmail-in-func-name + languages: + - go + message: Do not use "WorkMail" in func name inside workmail package + paths: + include: + - internal/service/workmail + exclude: + - internal/service/workmail/list_pages_gen.go + patterns: + - pattern: func $NAME( ... ) + - metavariable-pattern: + metavariable: $NAME + patterns: + - pattern-regex: "(?i)WorkMail" + - focus-metavariable: $NAME + - pattern-not: func $NAME($T *testing.T) + severity: WARNING + - id: workmail-in-test-name + languages: + - go + message: Include "WorkMail" in test name + paths: + include: + - internal/service/workmail/*_test.go + patterns: + - pattern: func $NAME( ... ) + - metavariable-pattern: + metavariable: $NAME + patterns: + - pattern-not-regex: "^TestAccWorkMail" + - pattern-regex: ^TestAcc.* + severity: WARNING + - id: workmail-in-const-name + languages: + - go + message: Do not use "WorkMail" in const name inside workmail package + paths: + include: + - internal/service/workmail + patterns: + - pattern: const $NAME = ... + - metavariable-pattern: + metavariable: $NAME + patterns: + - pattern-regex: "(?i)WorkMail" + severity: WARNING + - id: workmail-in-var-name + languages: + - go + message: Do not use "WorkMail" in var name inside workmail package + paths: + include: + - internal/service/workmail + patterns: + - pattern: var $NAME = ... + - metavariable-pattern: + metavariable: $NAME + patterns: + - pattern-regex: "(?i)WorkMail" + severity: WARNING - id: workspaces-in-func-name languages: - go diff --git a/.ci/.semgrep.yml b/.ci/.semgrep.yml index 8efaa4b8f920..d24e4537c4ea 100644 --- a/.ci/.semgrep.yml +++ b/.ci/.semgrep.yml @@ -273,14 +273,6 @@ rules: }) ... if isResourceTimeoutError($ERR) { ... } - - pattern-not-inside: | - $ERR = tfresource.Retry(..., func() *retry.RetryError { - ... - _, $ERR2 = $CONN.$FUNC(...) - ... - }, ...) - ... - if isResourceTimeoutError($ERR) { ... } - patterns: - pattern: | if tfresource.TimedOut($ERR) { @@ -294,14 +286,6 @@ rules: }) ... if tfresource.TimedOut($ERR) { ... } - - pattern-not-inside: | - $ERR = tfresource.Retry(..., func() *retry.RetryError { - ... - _, $ERR2 = $CONN.$FUNC(...) - ... - }, ...) - ... - if tfresource.TimedOut($ERR) { ... } severity: WARNING - id: is-not-found-error diff --git a/.ci/.tflint.hcl b/.ci/.tflint.hcl index c745a469afd4..eb97244a8493 100644 --- a/.ci/.tflint.hcl +++ b/.ci/.tflint.hcl @@ -1,6 +1,6 @@ plugin "aws" { enabled = true - version = "0.39.0" + version = "0.41.0" source = "github.com/terraform-linters/tflint-ruleset-aws" } @@ -26,6 +26,27 @@ rule "aws_acm_certificate_lifecycle" { enabled = false } -rule "aws_accessanalyzer_analyzer_invalid_type" { +# Rule needs to be disabled due to enum value case inconsistencies +rule "aws_dms_s3_endpoint_invalid_compression_type" { + enabled = false +} + +# Rule needs to be disabled due to enum value case inconsistencies +rule "aws_dms_s3_endpoint_invalid_date_partition_sequence" { + enabled = false +} + +# Rule needs to be disabled due to enum value case inconsistencies +rule "aws_dms_s3_endpoint_invalid_encryption_mode" { + enabled = false +} + +# Avoids errant findings related to directory paths in generated configuration files +rule "aws_iam_saml_provider_invalid_saml_metadata_document" { + enabled = false +} + +# Rule needs to be disabled due to bad email regex in the linter rule +rule "aws_guardduty_member_invalid_email" { enabled = false } diff --git a/.ci/providerlint/go.mod b/.ci/providerlint/go.mod index 4207fcc9fcfe..328a1384f71e 100644 --- a/.ci/providerlint/go.mod +++ b/.ci/providerlint/go.mod @@ -1,12 +1,12 @@ module github.com/hashicorp/terraform-provider-aws/ci/providerlint -go 1.24.4 +go 1.24.6 require ( github.com/bflad/tfproviderlint v0.31.0 - github.com/hashicorp/aws-sdk-go-base/v2 v2.0.0-beta.65 + github.com/hashicorp/aws-sdk-go-base/v2 v2.0.0-beta.66 github.com/hashicorp/terraform-plugin-sdk/v2 v2.37.0 - golang.org/x/tools v0.34.0 + golang.org/x/tools v0.36.0 ) require ( @@ -48,17 +48,18 @@ require ( github.com/mitchellh/reflectwalk v1.0.2 // indirect github.com/oklog/run v1.1.0 // indirect github.com/rogpeppe/go-internal v1.13.1 // indirect - github.com/stretchr/testify v1.10.0 // indirect + github.com/stretchr/testify v1.11.1 // indirect github.com/vmihailenco/msgpack v4.0.4+incompatible // indirect github.com/vmihailenco/msgpack/v5 v5.4.1 // indirect github.com/vmihailenco/tagparser/v2 v2.0.0 // indirect github.com/zclconf/go-cty v1.16.2 // indirect - golang.org/x/crypto v0.39.0 // indirect - golang.org/x/mod v0.25.0 // indirect - golang.org/x/net v0.41.0 // indirect - golang.org/x/sync v0.15.0 // indirect - golang.org/x/sys v0.33.0 // indirect - golang.org/x/text v0.26.0 // indirect + go.opentelemetry.io/otel/sdk/metric v1.38.0 // indirect + golang.org/x/crypto v0.41.0 // indirect + golang.org/x/mod v0.27.0 // indirect + golang.org/x/net v0.43.0 // indirect + golang.org/x/sync v0.16.0 // indirect + golang.org/x/sys v0.35.0 // indirect + golang.org/x/text v0.28.0 // indirect google.golang.org/appengine v1.6.8 // indirect google.golang.org/genproto/googleapis/rpc v0.0.0-20250218202821-56aae31c358a // indirect google.golang.org/grpc v1.72.1 // indirect diff --git a/.ci/providerlint/go.sum b/.ci/providerlint/go.sum index 796e532032c5..4d6b5323a34d 100644 --- a/.ci/providerlint/go.sum +++ b/.ci/providerlint/go.sum @@ -34,8 +34,8 @@ github.com/go-git/go-billy/v5 v5.6.2 h1:6Q86EsPXMa7c3YZ3aLAQsMA0VlWmy43r6FHqa/UN github.com/go-git/go-billy/v5 v5.6.2/go.mod h1:rcFC2rAsp/erv7CMz9GczHcuD0D32fWzH+MJAU+jaUU= github.com/go-git/go-git/v5 v5.14.0 h1:/MD3lCrGjCen5WfEAzKg00MJJffKhC8gzS80ycmCi60= github.com/go-git/go-git/v5 v5.14.0/go.mod h1:Z5Xhoia5PcWA3NF8vRLURn9E5FRhSl7dGj9ItW3Wk5k= -github.com/go-logr/logr v1.4.2 h1:6pFjapn8bFcIbiKo3XT4j/BhANplGihG6tvd+8rYgrY= -github.com/go-logr/logr v1.4.2/go.mod h1:9T104GzyrTigFIr8wt5mBrctHMim0Nb2HLGrmQ40KvY= +github.com/go-logr/logr v1.4.3 h1:CjnDlHq8ikf6E492q6eKboGOC0T8CDaOvkHCIg8idEI= +github.com/go-logr/logr v1.4.3/go.mod h1:9T104GzyrTigFIr8wt5mBrctHMim0Nb2HLGrmQ40KvY= github.com/go-logr/stdr v1.2.2 h1:hSWxHoqTgW2S2qGc0LTAI563KZ5YKYRhT3MFKZMbjag= github.com/go-logr/stdr v1.2.2/go.mod h1:mMo/vtBO5dYbehREoey6XUKy/eSumjCCveDpRre4VKE= github.com/go-test/deep v1.0.3 h1:ZrJSEWsXzPOxaZnFteGEfooLba+ju3FYIbOrS+rQd68= @@ -53,8 +53,8 @@ github.com/google/go-cmp v0.7.0 h1:wk8382ETsv4JYUZwIsn6YpYiWiBsYLSJiTsyBybVuN8= github.com/google/go-cmp v0.7.0/go.mod h1:pXiqmnSA92OHEEa9HXL2W4E7lf9JzCmGVUdgjX3N/iU= github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0= github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo= -github.com/hashicorp/aws-sdk-go-base/v2 v2.0.0-beta.65 h1:81+kWbE1yErFBMjME0I5k3x3kojjKsWtPYHEAutoPow= -github.com/hashicorp/aws-sdk-go-base/v2 v2.0.0-beta.65/go.mod h1:WtMzv9T++tfWVea+qB2MXoaqxw33S8bpJslzUike2mQ= +github.com/hashicorp/aws-sdk-go-base/v2 v2.0.0-beta.66 h1:HA6blfR0h6kGnw4oJ92tZzghubreIkWbQJ4NVNqS688= +github.com/hashicorp/aws-sdk-go-base/v2 v2.0.0-beta.66/go.mod h1:7kTJVbY5+igob9Q5N6KO81EGEKDNI9FpjujB31uI/n0= github.com/hashicorp/errwrap v1.0.0/go.mod h1:YH+1FKiLXxHSkmPseP+kNlulaMuP3n2brvKWEqk/Jc4= github.com/hashicorp/errwrap v1.1.0 h1:OxrOeh75EUXMY8TBjag2fzXGZ40LB6IKw45YeGUDY2I= github.com/hashicorp/errwrap v1.1.0/go.mod h1:YH+1FKiLXxHSkmPseP+kNlulaMuP3n2brvKWEqk/Jc4= @@ -148,8 +148,8 @@ github.com/skeema/knownhosts v1.3.1 h1:X2osQ+RAjK76shCbvhHHHVl3ZlgDm8apHEHFqRjnB github.com/skeema/knownhosts v1.3.1/go.mod h1:r7KTdC8l4uxWRyK2TpQZ/1o5HaSzh06ePQNxPwTcfiY= github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= github.com/stretchr/testify v1.7.2/go.mod h1:R6va5+xMeoiuVRoj+gSkQ7d3FALtqAAGI1FQKckRals= -github.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA= -github.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY= +github.com/stretchr/testify v1.11.1 h1:7s2iGBzp5EwR7/aIZr8ao5+dra3wiQyKjjFuvgVKu7U= +github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U= github.com/vmihailenco/msgpack v3.3.3+incompatible/go.mod h1:fy3FlTQTDXWkZ7Bh6AcGMlsjHatGryHQYUTf1ShIgkk= github.com/vmihailenco/msgpack v4.0.4+incompatible h1:dSLoQfGFAo3F6OoNhwUmLwVgaUXK79GlxNBwueZn0xI= github.com/vmihailenco/msgpack v4.0.4+incompatible/go.mod h1:fy3FlTQTDXWkZ7Bh6AcGMlsjHatGryHQYUTf1ShIgkk= @@ -166,36 +166,36 @@ github.com/zclconf/go-cty-debug v0.0.0-20240509010212-0d6042c53940 h1:4r45xpDWB6 github.com/zclconf/go-cty-debug v0.0.0-20240509010212-0d6042c53940/go.mod h1:CmBdvvj3nqzfzJ6nTCIwDTPZ56aVGvDrmztiO5g3qrM= go.opentelemetry.io/auto/sdk v1.1.0 h1:cH53jehLUN6UFLY71z+NDOiNJqDdPRaXzTel0sJySYA= go.opentelemetry.io/auto/sdk v1.1.0/go.mod h1:3wSPjt5PWp2RhlCcmmOial7AvC4DQqZb7a7wCow3W8A= -go.opentelemetry.io/otel v1.36.0 h1:UumtzIklRBY6cI/lllNZlALOF5nNIzJVb16APdvgTXg= -go.opentelemetry.io/otel v1.36.0/go.mod h1:/TcFMXYjyRNh8khOAO9ybYkqaDBb/70aVwkNML4pP8E= -go.opentelemetry.io/otel/metric v1.36.0 h1:MoWPKVhQvJ+eeXWHFBOPoBOi20jh6Iq2CcCREuTYufE= -go.opentelemetry.io/otel/metric v1.36.0/go.mod h1:zC7Ks+yeyJt4xig9DEw9kuUFe5C3zLbVjV2PzT6qzbs= -go.opentelemetry.io/otel/sdk v1.34.0 h1:95zS4k/2GOy069d321O8jWgYsW3MzVV+KuSPKp7Wr1A= -go.opentelemetry.io/otel/sdk v1.34.0/go.mod h1:0e/pNiaMAqaykJGKbi+tSjWfNNHMTxoC9qANsCzbyxU= -go.opentelemetry.io/otel/sdk/metric v1.34.0 h1:5CeK9ujjbFVL5c1PhLuStg1wxA7vQv7ce1EK0Gyvahk= -go.opentelemetry.io/otel/sdk/metric v1.34.0/go.mod h1:jQ/r8Ze28zRKoNRdkjCZxfs6YvBTG1+YIqyFVFYec5w= -go.opentelemetry.io/otel/trace v1.36.0 h1:ahxWNuqZjpdiFAyrIoQ4GIiAIhxAunQR6MUoKrsNd4w= -go.opentelemetry.io/otel/trace v1.36.0/go.mod h1:gQ+OnDZzrybY4k4seLzPAWNwVBBVlF2szhehOBB/tGA= +go.opentelemetry.io/otel v1.38.0 h1:RkfdswUDRimDg0m2Az18RKOsnI8UDzppJAtj01/Ymk8= +go.opentelemetry.io/otel v1.38.0/go.mod h1:zcmtmQ1+YmQM9wrNsTGV/q/uyusom3P8RxwExxkZhjM= +go.opentelemetry.io/otel/metric v1.38.0 h1:Kl6lzIYGAh5M159u9NgiRkmoMKjvbsKtYRwgfrA6WpA= +go.opentelemetry.io/otel/metric v1.38.0/go.mod h1:kB5n/QoRM8YwmUahxvI3bO34eVtQf2i4utNVLr9gEmI= +go.opentelemetry.io/otel/sdk v1.38.0 h1:l48sr5YbNf2hpCUj/FoGhW9yDkl+Ma+LrVl8qaM5b+E= +go.opentelemetry.io/otel/sdk v1.38.0/go.mod h1:ghmNdGlVemJI3+ZB5iDEuk4bWA3GkTpW+DOoZMYBVVg= +go.opentelemetry.io/otel/sdk/metric v1.38.0 h1:aSH66iL0aZqo//xXzQLYozmWrXxyFkBJ6qT5wthqPoM= +go.opentelemetry.io/otel/sdk/metric v1.38.0/go.mod h1:dg9PBnW9XdQ1Hd6ZnRz689CbtrUp0wMMs9iPcgT9EZA= +go.opentelemetry.io/otel/trace v1.38.0 h1:Fxk5bKrDZJUH+AMyyIXGcFAPah0oRcT+LuNtJrmcNLE= +go.opentelemetry.io/otel/trace v1.38.0/go.mod h1:j1P9ivuFsTceSWe1oY+EeW3sc+Pp42sO++GHkg4wwhs= golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w= golang.org/x/crypto v0.0.0-20191011191535-87dc89f01550/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI= golang.org/x/crypto v0.0.0-20210921155107-089bfa567519/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc= -golang.org/x/crypto v0.39.0 h1:SHs+kF4LP+f+p14esP5jAoDpHU8Gu/v9lFRK6IT5imM= -golang.org/x/crypto v0.39.0/go.mod h1:L+Xg3Wf6HoL4Bn4238Z6ft6KfEpN0tJGo53AAPC632U= +golang.org/x/crypto v0.41.0 h1:WKYxWedPGCTVVl5+WHSSrOBT0O8lx32+zxmHxijgXp4= +golang.org/x/crypto v0.41.0/go.mod h1:pO5AFd7FA68rFak7rOAGVuygIISepHftHnr8dr6+sUc= golang.org/x/mod v0.1.1-0.20191105210325-c90efee705ee/go.mod h1:QqPTAvyqsEbceGzBzNggFXnrqF1CaUcvgkdR5Ot7KZg= golang.org/x/mod v0.6.0-dev.0.20220419223038-86c51ed26bb4/go.mod h1:jJ57K6gSWd91VN4djpZkiMVwK6gcyfeH4XE8wZrZaV4= -golang.org/x/mod v0.25.0 h1:n7a+ZbQKQA/Ysbyb0/6IbB1H/X41mKgbhfv7AfG/44w= -golang.org/x/mod v0.25.0/go.mod h1:IXM97Txy2VM4PJ3gI61r1YEk/gAj6zAHN3AdZt6S9Ww= +golang.org/x/mod v0.27.0 h1:kb+q2PyFnEADO2IEF935ehFUXlWiNjJWtRNgBLSfbxQ= +golang.org/x/mod v0.27.0/go.mod h1:rWI627Fq0DEoudcK+MBkNkCe0EetEaDSwJJkCcjpazc= golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg= golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg= golang.org/x/net v0.0.0-20220722155237-a158d28d115b/go.mod h1:XRhObCWvk6IyKnWLug+ECip1KBveYUHfp+8e9klMJ9c= -golang.org/x/net v0.41.0 h1:vBTly1HeNPEn3wtREYfy4GZ/NECgw2Cnl+nK6Nz3uvw= -golang.org/x/net v0.41.0/go.mod h1:B/K4NNqkfmg07DQYrbwvSluqCJOOXwUjeb/5lOisjbA= +golang.org/x/net v0.43.0 h1:lat02VYK2j4aLzMzecihNvTlJNQUq316m2Mr9rnM6YE= +golang.org/x/net v0.43.0/go.mod h1:vhO1fvI4dGsIjh73sWfUVjj3N7CA9WkKJNQm2svM6Jg= golang.org/x/sync v0.0.0-20180314180146-1d60e4601c6f/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= golang.org/x/sync v0.0.0-20220722155255-886fb9371eb4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= -golang.org/x/sync v0.15.0 h1:KWH3jNZsfyT6xfAfKiz6MRNmd46ByHDYaZ7KSkCtdW8= -golang.org/x/sync v0.15.0/go.mod h1:1dzgHSNfp02xaA81J2MS99Qcpr2w7fw1gpm99rleRqA= +golang.org/x/sync v0.16.0 h1:ycBJEhp9p4vXvUZNszeOq0kGTPghopOL8q0fq3vstxw= +golang.org/x/sync v0.16.0/go.mod h1:1dzgHSNfp02xaA81J2MS99Qcpr2w7fw1gpm99rleRqA= golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20200116001909-b77594299b42/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= @@ -208,22 +208,22 @@ golang.org/x/sys v0.0.0-20220503163025-988cb79eb6c6/go.mod h1:oPkhp1MJrh7nUepCBc golang.org/x/sys v0.0.0-20220520151302-bc2c85ada10a/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= -golang.org/x/sys v0.33.0 h1:q3i8TbbEz+JRD9ywIRlyRAQbM0qF7hu24q3teo2hbuw= -golang.org/x/sys v0.33.0/go.mod h1:BJP2sWEmIv4KK5OTEluFJCKSidICx8ciO85XgH3Ak8k= +golang.org/x/sys v0.35.0 h1:vz1N37gP5bs89s7He8XuIYXpyY0+QlsKmzipCbUtyxI= +golang.org/x/sys v0.35.0/go.mod h1:BJP2sWEmIv4KK5OTEluFJCKSidICx8ciO85XgH3Ak8k= golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo= golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8= golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ= golang.org/x/text v0.3.8/go.mod h1:E6s5w1FMmriuDzIBO73fBruAKo1PCIq6d2Q6DHfQ8WQ= -golang.org/x/text v0.26.0 h1:P42AVeLghgTYr4+xUnTRKDMqpar+PtX7KWuNQL21L8M= -golang.org/x/text v0.26.0/go.mod h1:QK15LZJUUQVJxhz7wXgxSy/CJaTFjd0G+YLonydOVQA= +golang.org/x/text v0.28.0 h1:rhazDwis8INMIwQ4tpjLDzUhx6RlXqZNPEM0huQojng= +golang.org/x/text v0.28.0/go.mod h1:U8nCwOR8jO/marOQ0QbDiOngZVEBB7MAiitBuMjXiNU= golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= golang.org/x/tools v0.0.0-20200214201135-548b770e2dfa/go.mod h1:TB2adYChydJhpapKDTa4BR/hXlZSLoq2Wpct/0txZ28= golang.org/x/tools v0.1.12/go.mod h1:hNGJHUnrk76NpqgfD5Aqm5Crs+Hm0VOH/i9J2+nxYbc= -golang.org/x/tools v0.34.0 h1:qIpSLOxeCYGg9TrcJokLBG4KFA6d795g0xkBkiESGlo= -golang.org/x/tools v0.34.0/go.mod h1:pAP9OwEaY1CAW3HOmg3hLZC5Z0CCmzjAF2UQMSqNARg= +golang.org/x/tools v0.36.0 h1:kWS0uv/zsvHEle1LbV5LE8QujrxB3wfQyxHfhOk0Qkg= +golang.org/x/tools v0.36.0/go.mod h1:WBDiHKJK8YgLHlcQPYQzNCkUxUypCaa5ZegCVutKm+s= golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= diff --git a/.ci/providerlint/passes/AWSAT001/testdata/go.mod b/.ci/providerlint/passes/AWSAT001/testdata/go.mod index b61a6ba5f31b..7b6c5e842e0e 100644 --- a/.ci/providerlint/passes/AWSAT001/testdata/go.mod +++ b/.ci/providerlint/passes/AWSAT001/testdata/go.mod @@ -1,6 +1,6 @@ module testdata -go 1.24.4 +go 1.24.6 require ( github.com/YakDriver/regexache v0.24.0 diff --git a/.ci/providerlint/passes/AWSAT002/testdata/go.mod b/.ci/providerlint/passes/AWSAT002/testdata/go.mod index 8d47f0077d0c..193682352e59 100644 --- a/.ci/providerlint/passes/AWSAT002/testdata/go.mod +++ b/.ci/providerlint/passes/AWSAT002/testdata/go.mod @@ -1,3 +1,3 @@ module testdata -go 1.24.4 +go 1.24.6 diff --git a/.ci/providerlint/passes/AWSAT003/testdata/go.mod b/.ci/providerlint/passes/AWSAT003/testdata/go.mod index 8d47f0077d0c..193682352e59 100644 --- a/.ci/providerlint/passes/AWSAT003/testdata/go.mod +++ b/.ci/providerlint/passes/AWSAT003/testdata/go.mod @@ -1,3 +1,3 @@ module testdata -go 1.24.4 +go 1.24.6 diff --git a/.ci/providerlint/passes/AWSAT004/testdata/go.mod b/.ci/providerlint/passes/AWSAT004/testdata/go.mod index b66742f56e76..8612d40d91c9 100644 --- a/.ci/providerlint/passes/AWSAT004/testdata/go.mod +++ b/.ci/providerlint/passes/AWSAT004/testdata/go.mod @@ -1,6 +1,6 @@ module testdata -go 1.24.4 +go 1.24.6 require github.com/hashicorp/terraform-plugin-sdk/v2 v2.36.1 diff --git a/.ci/providerlint/passes/AWSAT005/testdata/go.mod b/.ci/providerlint/passes/AWSAT005/testdata/go.mod index 8d47f0077d0c..193682352e59 100644 --- a/.ci/providerlint/passes/AWSAT005/testdata/go.mod +++ b/.ci/providerlint/passes/AWSAT005/testdata/go.mod @@ -1,3 +1,3 @@ module testdata -go 1.24.4 +go 1.24.6 diff --git a/.ci/providerlint/passes/AWSAT006/testdata/go.mod b/.ci/providerlint/passes/AWSAT006/testdata/go.mod index 8d47f0077d0c..193682352e59 100644 --- a/.ci/providerlint/passes/AWSAT006/testdata/go.mod +++ b/.ci/providerlint/passes/AWSAT006/testdata/go.mod @@ -1,3 +1,3 @@ module testdata -go 1.24.4 +go 1.24.6 diff --git a/.ci/providerlint/passes/AWSR001/testdata/go.mod b/.ci/providerlint/passes/AWSR001/testdata/go.mod index 8d47f0077d0c..193682352e59 100644 --- a/.ci/providerlint/passes/AWSR001/testdata/go.mod +++ b/.ci/providerlint/passes/AWSR001/testdata/go.mod @@ -1,3 +1,3 @@ module testdata -go 1.24.4 +go 1.24.6 diff --git a/.ci/providerlint/passes/AWSV001/testdata/go.mod b/.ci/providerlint/passes/AWSV001/testdata/go.mod index 6a3e2501bc68..6d0182fd68a9 100644 --- a/.ci/providerlint/passes/AWSV001/testdata/go.mod +++ b/.ci/providerlint/passes/AWSV001/testdata/go.mod @@ -1,6 +1,6 @@ module testdata -go 1.24.4 +go 1.24.6 require github.com/hashicorp/terraform-plugin-sdk/v2 v2.36.1 diff --git a/.ci/semgrep/errors/error-checks.yml b/.ci/semgrep/errors/error-checks.yml index 784970a08317..7ac00c741592 100644 --- a/.ci/semgrep/errors/error-checks.yml +++ b/.ci/semgrep/errors/error-checks.yml @@ -95,4 +95,11 @@ rules: if !d.IsNewResource() && tfresource.NotFound($ERR) { ... } return ... } + # e.g. internal/service/storagegateway/gateway.go + - pattern-not-inside: | + if !d.IsNewResource() && tfresource.NotFound($ERR) { ... } + if isGatewayNotConnectedErr(err) { + ... + } + if $ERR != nil { ... } severity: ERROR diff --git a/.ci/semgrep/smarterr/enforce.yml b/.ci/semgrep/smarterr/enforce.yml new file mode 100644 index 000000000000..9e3933fe32e0 --- /dev/null +++ b/.ci/semgrep/smarterr/enforce.yml @@ -0,0 +1,129 @@ +rules: + - id: go-no-sdkdiag-appendfromerr + languages: [go] + message: Use smerr.Append(ctx, diags, err) instead of sdkdiag.AppendFromErr. + severity: ERROR + pattern: sdkdiag.AppendFromErr($DIAGS, $ERR) + fix: smerr.Append(ctx, $DIAGS, $ERR) + paths: + include: + - internal/service/cloudwatch/ + + - id: go-no-sdkdiag-appenderrorf + languages: [go] + message: Use smerr.Append(ctx, diags, err, smerr.ID, ...) instead of sdkdiag.AppendErrorf. + severity: ERROR + patterns: + - pattern: sdkdiag.AppendErrorf($DIAGS, $FMT, $ID, $ERR) + - pattern: sdkdiag.AppendErrorf($DIAGS, $FMT, $ERR) + paths: + include: + - internal/service/cloudwatch/ + + - id: go-no-create-appenddiagerror + languages: [go] + message: Use smerr.Append(ctx, diags, err, smerr.ID, ...) instead of create.AppendDiagError. + severity: ERROR + pattern: create.AppendDiagError($DIAGS, ...) + paths: + include: + - internal/service/cloudwatch/ + + - id: go-no-diagnostics-adderror + languages: [go] + message: Use smerr.AddError(ctx, &response.Diagnostics, err, smerr.ID, ...) instead of Diagnostics.AddError. + severity: ERROR + patterns: + - pattern: $RESP.Diagnostics.AddError($MSG, $ERR) + - pattern: $RESP.Diagnostics.AddError(fmt.Sprintf($FMT, ...), $ERR) + - pattern: $RESP.Diagnostics.AddError($MSG, $ERR.Error()) + - pattern-not-inside: smerr.AddError(...) + paths: + include: + - internal/service/cloudwatch/ + + - id: go-no-create-adderror + languages: [go] + message: Use smerr.AddError(ctx, &response.Diagnostics, err, smerr.ID, ...) instead of create.AddError. + severity: ERROR + pattern: create.AddError(&$RESP.Diagnostics, ...) + paths: + include: + - internal/service/cloudwatch/ + + - id: go-no-direct-diag-adderror + languages: [go] + message: Use smerr.AddError instead of resp.Diagnostics.AddError (migrate to smarterr/smerr). + severity: ERROR + patterns: + - pattern: $RESP.Diagnostics.AddError($MSG, $ERR) + - pattern-not-inside: smerr.AddError(...) + paths: + include: + - internal/service/cloudwatch/ + + - id: go-no-direct-diag-appenderrorf + languages: [go] + message: Use smerr.Append or smerr.EnrichAppend instead of diag.AppendErrorf (migrate to smarterr/smerr). + severity: ERROR + pattern: diag.AppendErrorf(...) + paths: + include: + - internal/service/cloudwatch/ + + - id: go-no-direct-diag-appendfromerr + languages: [go] + message: Use smerr.Append or smerr.EnrichAppend instead of diag.AppendFromErr (migrate to smarterr/smerr). + severity: ERROR + pattern: diag.AppendFromErr(...) + paths: + include: + - internal/service/cloudwatch/ + + - id: go-no-direct-diag-append + languages: [go] + message: Use smerr.EnrichAppend instead of resp.Diagnostics.Append (migrate to smarterr/smerr). + severity: ERROR + patterns: + - pattern: $RESP.Diagnostics.Append(...) + - pattern-not-inside: smerr.EnrichAppend(...) + paths: + include: + - internal/service/cloudwatch/ + + - id: go-no-bare-return-err + languages: [go] + message: Return errors wrapped with smarterr.NewError (migrate to smarterr). + severity: ERROR + patterns: + - pattern: | + return nil, $ERR + - pattern-not-inside: | + return nil, smarterr.NewError(...) + paths: + include: + - internal/service/cloudwatch/ + + - id: go-no-bare-assertsinglevalueresult + languages: [go] + message: Wrap tfresource.AssertSingleValueResult with smarterr.Assert (migrate to smarterr). + severity: ERROR + patterns: + - pattern: | + return tfresource.AssertSingleValueResult(...) + - pattern-not-inside: smarterr.Assert(tfresource.AssertSingleValueResult(...)) + paths: + include: + - internal/service/cloudwatch/ + + - id: go-no-bare-empty-result-error + languages: [go] + message: Wrap tfresource.NewEmptyResultError with smarterr.NewError (migrate to smarterr). + severity: ERROR + patterns: + - pattern: | + return nil, tfresource.NewEmptyResultError(...) + - pattern-not-inside: smarterr.NewError(tfresource.NewEmptyResultError(...)) + paths: + include: + - internal/service/cloudwatch/ diff --git a/.ci/tools/go.mod b/.ci/tools/go.mod index c82566294412..dc3c3d14c947 100644 --- a/.ci/tools/go.mod +++ b/.ci/tools/go.mod @@ -1,18 +1,19 @@ module github.com/hashicorp/terraform-provider-aws/tools -go 1.24.4 +go 1.24.6 require ( github.com/YakDriver/tfproviderdocs v0.22.0 github.com/client9/misspell v0.3.4 - github.com/golangci/golangci-lint/v2 v2.2.1 + github.com/golangci/golangci-lint/v2 v2.4.0 github.com/hashicorp/copywrite v0.22.0 github.com/hashicorp/go-changelog v0.0.0-20250127101332-effe3832fb0b github.com/katbyte/terrafmt v0.5.5 github.com/pavius/impi v0.0.3 github.com/rhysd/actionlint v1.7.7 - github.com/terraform-linters/tflint v0.58.0 - mvdan.cc/gofumpt v0.8.0 + github.com/terraform-linters/tflint v0.58.1 + golang.org/x/tools v0.36.0 + mvdan.cc/gofumpt v0.9.0 ) require ( @@ -28,16 +29,17 @@ require ( cloud.google.com/go/storage v1.53.0 // indirect codeberg.org/chavacava/garif v0.2.0 // indirect dario.cat/mergo v1.0.1 // indirect - github.com/4meepo/tagalign v1.4.2 // indirect + dev.gaijin.team/go/exhaustruct/v4 v4.0.0 // indirect + dev.gaijin.team/go/golib v0.6.0 // indirect + github.com/4meepo/tagalign v1.4.3 // indirect github.com/Abirdcfly/dupword v0.1.6 // indirect github.com/AlecAivazis/survey/v2 v2.3.7 // indirect - github.com/AlwxSin/noinlineerr v1.0.3 // indirect + github.com/AlwxSin/noinlineerr v1.0.5 // indirect github.com/Antonboom/errname v1.1.0 // indirect github.com/Antonboom/nilnil v1.1.0 // indirect github.com/Antonboom/testifylint v1.6.1 // indirect github.com/BurntSushi/toml v1.5.0 // indirect github.com/Djarvur/go-err113 v0.0.0-20210108212216-aea10b59be24 // indirect - github.com/GaijinEntertainment/go-exhaustruct/v3 v3.3.1 // indirect github.com/GoogleCloudPlatform/opentelemetry-operations-go/detectors/gcp v1.27.0 // indirect github.com/GoogleCloudPlatform/opentelemetry-operations-go/exporter/metric v0.51.0 // indirect github.com/GoogleCloudPlatform/opentelemetry-operations-go/internal/resourcemapping v0.51.0 // indirect @@ -48,10 +50,11 @@ require ( github.com/OpenPeeDeeP/depguard/v2 v2.2.1 // indirect github.com/ProtonMail/go-crypto v1.1.3 // indirect github.com/agext/levenshtein v1.2.3 // indirect - github.com/alecthomas/chroma/v2 v2.18.0 // indirect + github.com/alecthomas/chroma/v2 v2.20.0 // indirect github.com/alecthomas/go-check-sumtype v0.3.1 // indirect github.com/alexkohler/nakedret/v2 v2.0.6 // indirect github.com/alexkohler/prealloc v1.0.0 // indirect + github.com/alfatraining/structtag v1.0.0 // indirect github.com/alingse/asasalint v0.0.11 // indirect github.com/alingse/nilnesserr v0.2.0 // indirect github.com/apparentlymart/go-cidr v1.1.0 // indirect @@ -71,7 +74,7 @@ require ( github.com/bmatcuk/doublestar v1.3.4 // indirect github.com/bmatcuk/doublestar/v4 v4.8.0 // indirect github.com/bombsimon/wsl/v4 v4.7.0 // indirect - github.com/bombsimon/wsl/v5 v5.0.0 // indirect + github.com/bombsimon/wsl/v5 v5.1.1 // indirect github.com/bradleyfalzon/ghinstallation/v2 v2.5.0 // indirect github.com/breml/bidichk v0.3.3 // indirect github.com/breml/errchkjson v0.4.1 // indirect @@ -95,7 +98,7 @@ require ( github.com/curioswitch/go-reassign v0.3.0 // indirect github.com/cyberphone/json-canonicalization v0.0.0-20220623050100-57a0ce2678a7 // indirect github.com/cyphar/filepath-securejoin v0.2.5 // indirect - github.com/daixiang0/gci v0.13.6 // indirect + github.com/daixiang0/gci v0.13.7 // indirect github.com/dave/dst v0.27.3 // indirect github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc // indirect github.com/denis-tingaikin/go-header v0.5.0 // indirect @@ -138,7 +141,7 @@ require ( github.com/go-toolsmith/astp v1.1.0 // indirect github.com/go-toolsmith/strparse v1.1.0 // indirect github.com/go-toolsmith/typep v1.1.0 // indirect - github.com/go-viper/mapstructure/v2 v2.3.0 // indirect + github.com/go-viper/mapstructure/v2 v2.4.0 // indirect github.com/go-xmlfmt/xmlfmt v1.1.3 // indirect github.com/gobwas/glob v0.2.3 // indirect github.com/gofrs/flock v0.12.1 // indirect @@ -173,7 +176,7 @@ require ( github.com/gostaticanalysis/nilerr v0.1.1 // indirect github.com/hashicorp/errwrap v1.1.0 // indirect github.com/hashicorp/go-cleanhttp v0.5.2 // indirect - github.com/hashicorp/go-getter v1.7.8 // indirect + github.com/hashicorp/go-getter v1.7.9 // indirect github.com/hashicorp/go-hclog v1.6.3 // indirect github.com/hashicorp/go-immutable-radix/v2 v2.1.0 // indirect github.com/hashicorp/go-multierror v1.1.1 // indirect @@ -184,7 +187,7 @@ require ( github.com/hashicorp/golang-lru/v2 v2.0.7 // indirect github.com/hashicorp/hc-install v0.4.0 // indirect github.com/hashicorp/hcl v1.0.0 // indirect - github.com/hashicorp/hcl/v2 v2.23.1-0.20250203194505-ba0759438da2 // indirect + github.com/hashicorp/hcl/v2 v2.24.0 // indirect github.com/hashicorp/logutils v1.0.0 // indirect github.com/hashicorp/terraform-exec v0.17.2 // indirect github.com/hashicorp/terraform-json v0.25.0 // indirect @@ -224,7 +227,7 @@ require ( github.com/lasiar/canonicalheader v1.1.2 // indirect github.com/ldez/exptostd v0.4.4 // indirect github.com/ldez/gomoddirectives v0.7.0 // indirect - github.com/ldez/grignotin v0.9.0 // indirect + github.com/ldez/grignotin v0.10.0 // indirect github.com/ldez/tagliatelle v0.7.1 // indirect github.com/ldez/usetesting v0.5.0 // indirect github.com/leonklingele/grouper v1.1.2 // indirect @@ -242,12 +245,11 @@ require ( github.com/mattn/go-runewidth v0.0.16 // indirect github.com/mattn/go-shellwords v1.0.12 // indirect github.com/mergestat/timediff v0.0.3 // indirect - github.com/mgechev/revive v1.10.0 // indirect + github.com/mgechev/revive v1.11.0 // indirect github.com/mgutz/ansi v0.0.0-20200706080929-d51e80ef957d // indirect github.com/mitchellh/cli v1.1.5 // indirect github.com/mitchellh/copystructure v1.2.0 // indirect github.com/mitchellh/go-homedir v1.1.0 // indirect - github.com/mitchellh/go-testing-interface v1.14.1 // indirect github.com/mitchellh/go-wordwrap v1.0.1 // indirect github.com/mitchellh/mapstructure v1.5.0 // indirect github.com/mitchellh/reflectwalk v1.0.2 // indirect @@ -257,7 +259,7 @@ require ( github.com/nakabonne/nestif v0.3.1 // indirect github.com/nishanths/exhaustive v0.12.0 // indirect github.com/nishanths/predeclared v0.2.2 // indirect - github.com/nunnatsa/ginkgolinter v0.19.1 // indirect + github.com/nunnatsa/ginkgolinter v0.20.0 // indirect github.com/oklog/run v1.0.0 // indirect github.com/oklog/ulid v1.3.1 // indirect github.com/opencontainers/go-digest v1.0.0 // indirect @@ -293,7 +295,7 @@ require ( github.com/sashamelentyev/usestdlibvars v1.29.0 // indirect github.com/sassoftware/relic v7.2.1+incompatible // indirect github.com/secure-systems-lab/go-securesystemslib v0.9.0 // indirect - github.com/securego/gosec/v2 v2.22.5 // indirect + github.com/securego/gosec/v2 v2.22.7 // indirect github.com/sergi/go-diff v1.3.2-0.20230802210424-5b0b94c5c0d3 // indirect github.com/shibumi/go-pathspec v1.3.0 // indirect github.com/shopspring/decimal v1.4.0 // indirect @@ -305,7 +307,7 @@ require ( github.com/sirupsen/logrus v1.9.3 // indirect github.com/sivchari/containedctx v1.0.3 // indirect github.com/skeema/knownhosts v1.3.0 // indirect - github.com/sonatard/noctx v0.3.4 // indirect + github.com/sonatard/noctx v0.4.0 // indirect github.com/sourcegraph/conc v0.3.0 // indirect github.com/sourcegraph/go-diff v0.7.0 // indirect github.com/sourcegraph/go-lsp v0.0.0-20200429204803-219e11d77f5d // indirect @@ -313,7 +315,7 @@ require ( github.com/spf13/afero v1.14.0 // indirect github.com/spf13/cast v1.8.0 // indirect github.com/spf13/cobra v1.9.1 // indirect - github.com/spf13/pflag v1.0.6 // indirect + github.com/spf13/pflag v1.0.7 // indirect github.com/spf13/viper v1.20.1 // indirect github.com/spiffe/go-spiffe/v2 v2.5.0 // indirect github.com/ssgreg/nlreturn/v2 v2.2.1 // indirect @@ -334,11 +336,11 @@ require ( github.com/tomarrell/wrapcheck/v2 v2.11.0 // indirect github.com/tommy-muehle/go-mnd/v2 v2.5.1 // indirect github.com/transparency-dev/merkle v0.0.2 // indirect - github.com/ulikunitz/xz v0.5.12 // indirect + github.com/ulikunitz/xz v0.5.14 // indirect github.com/ultraware/funlen v0.2.0 // indirect github.com/ultraware/whitespace v0.2.0 // indirect github.com/uudashr/gocognit v1.2.0 // indirect - github.com/uudashr/iface v1.4.0 // indirect + github.com/uudashr/iface v1.4.1 // indirect github.com/vmihailenco/msgpack/v5 v5.3.5 // indirect github.com/vmihailenco/tagparser/v2 v2.0.0 // indirect github.com/xanzy/ssh-agent v0.3.3 // indirect @@ -354,7 +356,7 @@ require ( github.com/zeebo/errs v1.4.0 // indirect gitlab.com/bosi/decorder v0.4.2 // indirect go-simpler.org/musttag v0.13.1 // indirect - go-simpler.org/sloglint v0.11.0 // indirect + go-simpler.org/sloglint v0.11.1 // indirect go.augendre.info/arangolint v0.2.0 // indirect go.augendre.info/fatcontext v0.8.0 // indirect go.mongodb.org/mongo-driver v1.14.0 // indirect @@ -370,19 +372,18 @@ require ( go.uber.org/automaxprocs v1.6.0 // indirect go.uber.org/multierr v1.11.0 // indirect go.uber.org/zap v1.27.0 // indirect - golang.org/x/crypto v0.39.0 // indirect + golang.org/x/crypto v0.41.0 // indirect golang.org/x/exp v0.0.0-20240909161429-701f63a606c0 // indirect - golang.org/x/exp/typeparams v0.0.0-20250210185358-939b2ce775ac // indirect - golang.org/x/mod v0.25.0 // indirect - golang.org/x/net v0.41.0 // indirect + golang.org/x/exp/typeparams v0.0.0-20250620022241-b7579e27df2b // indirect + golang.org/x/mod v0.27.0 // indirect + golang.org/x/net v0.43.0 // indirect golang.org/x/oauth2 v0.30.0 // indirect - golang.org/x/sync v0.15.0 // indirect - golang.org/x/sys v0.33.0 // indirect - golang.org/x/term v0.32.0 // indirect - golang.org/x/text v0.26.0 // indirect + golang.org/x/sync v0.16.0 // indirect + golang.org/x/sys v0.35.0 // indirect + golang.org/x/term v0.34.0 // indirect + golang.org/x/text v0.28.0 // indirect golang.org/x/time v0.12.0 // indirect - golang.org/x/tools v0.34.0 // indirect - google.golang.org/api v0.237.0 // indirect + google.golang.org/api v0.242.0 // indirect google.golang.org/genproto v0.0.0-20250505200425-f936aa4a68b2 // indirect google.golang.org/genproto/googleapis/api v0.0.0-20250603155806-513f23925822 // indirect google.golang.org/genproto/googleapis/rpc v0.0.0-20250603155806-513f23925822 // indirect diff --git a/.ci/tools/go.sum b/.ci/tools/go.sum index ca5d194eafc0..dc69ef68c495 100644 --- a/.ci/tools/go.sum +++ b/.ci/tools/go.sum @@ -624,21 +624,25 @@ codeberg.org/chavacava/garif v0.2.0 h1:F0tVjhYbuOCnvNcU3YSpO6b3Waw6Bimy4K0mM8y6M codeberg.org/chavacava/garif v0.2.0/go.mod h1:P2BPbVbT4QcvLZrORc2T29szK3xEOlnl0GiPTJmEqBQ= dario.cat/mergo v1.0.1 h1:Ra4+bf83h2ztPIQYNP99R6m+Y7KfnARDfID+a+vLl4s= dario.cat/mergo v1.0.1/go.mod h1:uNxQE+84aUszobStD9th8a29P2fMDhsBdgRYvZOxGmk= +dev.gaijin.team/go/exhaustruct/v4 v4.0.0 h1:873r7aNneqoBB3IaFIzhvt2RFYTuHgmMjoKfwODoI1Y= +dev.gaijin.team/go/exhaustruct/v4 v4.0.0/go.mod h1:aZ/k2o4Y05aMJtiux15x8iXaumE88YdiB0Ai4fXOzPI= +dev.gaijin.team/go/golib v0.6.0 h1:v6nnznFTs4bppib/NyU1PQxobwDHwCXXl15P7DV5Zgo= +dev.gaijin.team/go/golib v0.6.0/go.mod h1:uY1mShx8Z/aNHWDyAkZTkX+uCi5PdX7KsG1eDQa2AVE= dmitri.shuralyov.com/gpu/mtl v0.0.0-20190408044501-666a987793e9/go.mod h1:H6x//7gZCb22OMCxBHrMx7a5I7Hp++hsVxbQ4BYO7hU= filippo.io/edwards25519 v1.1.0 h1:FNf4tywRC1HmFuKW5xopWpigGjJKiJSV0Cqo0cJWDaA= filippo.io/edwards25519 v1.1.0/go.mod h1:BxyFTGdWcka3PhytdK4V28tE5sGfRvvvRV7EaN4VDT4= gioui.org v0.0.0-20210308172011-57750fc8a0a6/go.mod h1:RSH6KIUZ0p2xy5zHDxgAM4zumjgTw83q2ge/PI+yyw8= git.sr.ht/~sbinet/gg v0.3.1/go.mod h1:KGYtlADtqsqANL9ueOFkWymvzUvLMQllU5Ixo+8v3pc= -github.com/4meepo/tagalign v1.4.2 h1:0hcLHPGMjDyM1gHG58cS73aQF8J4TdVR96TZViorO9E= -github.com/4meepo/tagalign v1.4.2/go.mod h1:+p4aMyFM+ra7nb41CnFG6aSDXqRxU/w1VQqScKqDARI= +github.com/4meepo/tagalign v1.4.3 h1:Bnu7jGWwbfpAie2vyl63Zup5KuRv21olsPIha53BJr8= +github.com/4meepo/tagalign v1.4.3/go.mod h1:00WwRjiuSbrRJnSVeGWPLp2epS5Q/l4UEy0apLLS37c= github.com/Abirdcfly/dupword v0.1.6 h1:qeL6u0442RPRe3mcaLcbaCi2/Y/hOcdtw6DE9odjz9c= github.com/Abirdcfly/dupword v0.1.6/go.mod h1:s+BFMuL/I4YSiFv29snqyjwzDp4b65W2Kvy+PKzZ6cw= github.com/AdamKorcz/go-fuzz-headers-1 v0.0.0-20230919221257-8b5d3ce2d11d h1:zjqpY4C7H15HjRPEenkS4SAn3Jy2eRRjkjZbGR30TOg= github.com/AdamKorcz/go-fuzz-headers-1 v0.0.0-20230919221257-8b5d3ce2d11d/go.mod h1:XNqJ7hv2kY++g8XEHREpi+JqZo3+0l+CH2egBVN4yqM= github.com/AlecAivazis/survey/v2 v2.3.7 h1:6I/u8FvytdGsgonrYsVn2t8t4QiRnh6QSTqkkhIiSjQ= github.com/AlecAivazis/survey/v2 v2.3.7/go.mod h1:xUTIdE4KCOIjsBAE1JYsUPoCqYdZ1reCfTwbto0Fduo= -github.com/AlwxSin/noinlineerr v1.0.3 h1:9b5edChzzwX30BuBci13LHVZHF5q7hW9qtrs+wJdDog= -github.com/AlwxSin/noinlineerr v1.0.3/go.mod h1:+QgkkoYrMH7RHvcdxdlI7vYYEdgeoFOVjU9sUhw/rQc= +github.com/AlwxSin/noinlineerr v1.0.5 h1:RUjt63wk1AYWTXtVXbSqemlbVTb23JOSRiNsshj7TbY= +github.com/AlwxSin/noinlineerr v1.0.5/go.mod h1:+QgkkoYrMH7RHvcdxdlI7vYYEdgeoFOVjU9sUhw/rQc= github.com/Antonboom/errname v1.1.0 h1:A+ucvdpMwlo/myWrkHEUEBWc/xuXdud23S8tmTb/oAE= github.com/Antonboom/errname v1.1.0/go.mod h1:O1NMrzgUcVBGIfi3xlVuvX8Q/VP/73sseCaAppfjqZw= github.com/Antonboom/nilnil v1.1.0 h1:jGxJxjgYS3VUUtOTNk8Z1icwT5ESpLH/426fjmQG+ng= @@ -663,8 +667,6 @@ github.com/BurntSushi/toml v1.5.0/go.mod h1:ukJfTF/6rtPPRCnwkur4qwRxa8vTRFBF0uk2 github.com/BurntSushi/xgb v0.0.0-20160522181843-27f122750802/go.mod h1:IVnqGOEym/WlBOVXweHU+Q+/VP0lqqI8lqeDx9IjBqo= github.com/Djarvur/go-err113 v0.0.0-20210108212216-aea10b59be24 h1:sHglBQTwgx+rWPdisA5ynNEsoARbiCBOyGcJM4/OzsM= github.com/Djarvur/go-err113 v0.0.0-20210108212216-aea10b59be24/go.mod h1:4UJr5HIiMZrwgkSPdsjy2uOQExX/WEILpIrO9UPGuXs= -github.com/GaijinEntertainment/go-exhaustruct/v3 v3.3.1 h1:Sz1JIXEcSfhz7fUi7xHnhpIE0thVASYjvosApmHuD2k= -github.com/GaijinEntertainment/go-exhaustruct/v3 v3.3.1/go.mod h1:n/LSCXNuIYqVfBlVXyHfMQkZDdp1/mmxfSjADd3z1Zg= github.com/GoogleCloudPlatform/opentelemetry-operations-go/detectors/gcp v1.27.0 h1:ErKg/3iS1AKcTkf3yixlZ54f9U1rljCkQyEXWUnIUxc= github.com/GoogleCloudPlatform/opentelemetry-operations-go/detectors/gcp v1.27.0/go.mod h1:yAZHSGnqScoU556rBOVkwLze6WP5N+U11RHuWaGVxwY= github.com/GoogleCloudPlatform/opentelemetry-operations-go/exporter/metric v0.51.0 h1:fYE9p3esPxA/C0rQ0AHhP0drtPXDRhaWiwg1DPqO7IU= @@ -710,12 +712,12 @@ github.com/ajstarks/svgo v0.0.0-20211024235047-1546f124cd8b/go.mod h1:1KcenG0jGW github.com/alcortesm/tgz v0.0.0-20161220082320-9c5fe88206d7/go.mod h1:6zEj6s6u/ghQa61ZWa/C2Aw3RkjiTBOix7dkqa1VLIs= github.com/alecthomas/assert/v2 v2.11.0 h1:2Q9r3ki8+JYXvGsDyBXwH3LcJ+WK5D0gc5E8vS6K3D0= github.com/alecthomas/assert/v2 v2.11.0/go.mod h1:Bze95FyfUr7x34QZrjL+XP+0qgp/zg8yS+TtBj1WA3k= -github.com/alecthomas/chroma/v2 v2.18.0 h1:6h53Q4hW83SuF+jcsp7CVhLsMozzvQvO8HBbKQW+gn4= -github.com/alecthomas/chroma/v2 v2.18.0/go.mod h1:RVX6AvYm4VfYe/zsk7mjHueLDZor3aWCNE14TFlepBk= +github.com/alecthomas/chroma/v2 v2.20.0 h1:sfIHpxPyR07/Oylvmcai3X/exDlE8+FA820NTz+9sGw= +github.com/alecthomas/chroma/v2 v2.20.0/go.mod h1:e7tViK0xh/Nf4BYHl00ycY6rV7b8iXBksI9E359yNmA= github.com/alecthomas/go-check-sumtype v0.3.1 h1:u9aUvbGINJxLVXiFvHUlPEaD7VDULsrxJb4Aq31NLkU= github.com/alecthomas/go-check-sumtype v0.3.1/go.mod h1:A8TSiN3UPRw3laIgWEUOHHLPa6/r9MtoigdlP5h3K/E= -github.com/alecthomas/repr v0.4.0 h1:GhI2A8MACjfegCPVq9f1FLvIBS+DrQ2KQBFZP1iFzXc= -github.com/alecthomas/repr v0.4.0/go.mod h1:Fr0507jx4eOXV7AlPV6AVZLYrLIuIeSOWtW57eE/O/4= +github.com/alecthomas/repr v0.5.1 h1:E3G4t2QbHTSNpPKBgMTln5KLkZHLOcU7r37J4pXBuIg= +github.com/alecthomas/repr v0.5.1/go.mod h1:Fr0507jx4eOXV7AlPV6AVZLYrLIuIeSOWtW57eE/O/4= github.com/alecthomas/template v0.0.0-20160405071501-a0175ee3bccc/go.mod h1:LOuyumcjzFXgccqObfd/Ljyb9UuFJ6TxHnclSeseNhc= github.com/alecthomas/template v0.0.0-20190718012654-fb15b899a751/go.mod h1:LOuyumcjzFXgccqObfd/Ljyb9UuFJ6TxHnclSeseNhc= github.com/alecthomas/units v0.0.0-20151022065526-2efee857e7cf/go.mod h1:ybxpYRFXyAe+OPACYpWeL0wqObRcbAqCMya13uyzqw0= @@ -727,6 +729,8 @@ github.com/alexkohler/nakedret/v2 v2.0.6 h1:ME3Qef1/KIKr3kWX3nti3hhgNxw6aqN5pZmQ github.com/alexkohler/nakedret/v2 v2.0.6/go.mod h1:l3RKju/IzOMQHmsEvXwkqMDzHHvurNQfAgE1eVmT40Q= github.com/alexkohler/prealloc v1.0.0 h1:Hbq0/3fJPQhNkN0dR95AVrr6R7tou91y0uHG5pOcUuw= github.com/alexkohler/prealloc v1.0.0/go.mod h1:VetnK3dIgFBBKmg0YnD9F9x6Icjd+9cvfHR56wJVlKE= +github.com/alfatraining/structtag v1.0.0 h1:2qmcUqNcCoyVJ0up879K614L9PazjBSFruTB0GOFjCc= +github.com/alfatraining/structtag v1.0.0/go.mod h1:p3Xi5SwzTi+Ryj64DqjLWz7XurHxbGsq6y3ubePJPus= github.com/alingse/asasalint v0.0.11 h1:SFwnQXJ49Kx/1GghOFz1XGqHYKp21Kq1nHad/0WQRnw= github.com/alingse/asasalint v0.0.11/go.mod h1:nCaoMhw7a9kSJObvQyVzNTPBDbNpdocqrSP7t/cW5+I= github.com/alingse/nilnesserr v0.2.0 h1:raLem5KG7EFVb4UIDAXgrv3N2JIaffeKNtcEXkEWd/w= @@ -821,8 +825,8 @@ github.com/bmatcuk/doublestar/v4 v4.8.0 h1:DSXtrypQddoug1459viM9X9D3dp1Z7993fw36 github.com/bmatcuk/doublestar/v4 v4.8.0/go.mod h1:xBQ8jztBU6kakFMg+8WGxn0c6z1fTSPVIjEY1Wr7jzc= github.com/bombsimon/wsl/v4 v4.7.0 h1:1Ilm9JBPRczjyUs6hvOPKvd7VL1Q++PL8M0SXBDf+jQ= github.com/bombsimon/wsl/v4 v4.7.0/go.mod h1:uV/+6BkffuzSAVYD+yGyld1AChO7/EuLrCF/8xTiapg= -github.com/bombsimon/wsl/v5 v5.0.0 h1:pWxP6X11o/YeF9eBVGXvS7L0FLEbHWm2kJJJGH6SeDQ= -github.com/bombsimon/wsl/v5 v5.0.0/go.mod h1:Gp8lD04z27wm3FANIUPZycXp+8huVsn0oxc+n4qfV9I= +github.com/bombsimon/wsl/v5 v5.1.1 h1:cQg5KJf9FlctAH4cpL9vLKnziYknoCMCdqXl0wjl72Q= +github.com/bombsimon/wsl/v5 v5.1.1/go.mod h1:Gp8lD04z27wm3FANIUPZycXp+8huVsn0oxc+n4qfV9I= github.com/boombuler/barcode v1.0.0/go.mod h1:paBWMcWSl3LHKBqUq+rly7CNSldXjb2rDl3JlRe0mD8= github.com/boombuler/barcode v1.0.1/go.mod h1:paBWMcWSl3LHKBqUq+rly7CNSldXjb2rDl3JlRe0mD8= github.com/bradleyfalzon/ghinstallation/v2 v2.5.0 h1:yaYcGQ7yEIGbsJfW/9z7v1sLiZg/5rSNNXwmMct5XaE= @@ -914,8 +918,8 @@ github.com/cyberphone/json-canonicalization v0.0.0-20220623050100-57a0ce2678a7 h github.com/cyberphone/json-canonicalization v0.0.0-20220623050100-57a0ce2678a7/go.mod h1:uzvlm1mxhHkdfqitSA92i7Se+S9ksOn3a3qmv/kyOCw= github.com/cyphar/filepath-securejoin v0.2.5 h1:6iR5tXJ/e6tJZzzdMc1km3Sa7RRIVBKAK32O2s7AYfo= github.com/cyphar/filepath-securejoin v0.2.5/go.mod h1:aPGpWjXOXUn2NCNjFvBE6aRxGGx79pTxQpKOJNYHHl4= -github.com/daixiang0/gci v0.13.6 h1:RKuEOSkGpSadkGbvZ6hJ4ddItT3cVZ9Vn9Rybk6xjl8= -github.com/daixiang0/gci v0.13.6/go.mod h1:12etP2OniiIdP4q+kjUGrC/rUagga7ODbqsom5Eo5Yk= +github.com/daixiang0/gci v0.13.7 h1:+0bG5eK9vlI08J+J/NWGbWPTNiXPG4WhNLJOkSxWITQ= +github.com/daixiang0/gci v0.13.7/go.mod h1:812WVN6JLFY9S6Tv76twqmNqevN0pa3SX3nih0brVzQ= github.com/danieljoos/wincred v1.2.0 h1:ozqKHaLK0W/ii4KVbbvluM91W2H3Sh0BncbUNPS7jLE= github.com/danieljoos/wincred v1.2.0/go.mod h1:FzQLLMKBFdvu+osBrnFODiv32YGwCfx0SkRa/eYHgec= github.com/dave/dst v0.27.3 h1:P1HPoMza3cMEquVf9kKy8yXsFirry4zEnWOdYPOoIzY= @@ -1090,8 +1094,8 @@ github.com/go-toolsmith/strparse v1.1.0 h1:GAioeZUK9TGxnLS+qfdqNbA4z0SSm5zVNtCQi github.com/go-toolsmith/strparse v1.1.0/go.mod h1:7ksGy58fsaQkGQlY8WVoBFNyEPMGuJin1rfoPS4lBSQ= github.com/go-toolsmith/typep v1.1.0 h1:fIRYDyF+JywLfqzyhdiHzRop/GQDxxNhLGQ6gFUNHus= github.com/go-toolsmith/typep v1.1.0/go.mod h1:fVIw+7zjdsMxDA3ITWnH1yOiw1rnTQKCsF/sk2H/qig= -github.com/go-viper/mapstructure/v2 v2.3.0 h1:27XbWsHIqhbdR5TIC911OfYvgSaW93HM+dX7970Q7jk= -github.com/go-viper/mapstructure/v2 v2.3.0/go.mod h1:oJDH3BJKyqBA2TXFhDsKDGDTlndYOZ6rGS0BRZIxGhM= +github.com/go-viper/mapstructure/v2 v2.4.0 h1:EBsztssimR/CONLSZZ04E8qAkxNYq4Qp9LvH92wZUgs= +github.com/go-viper/mapstructure/v2 v2.4.0/go.mod h1:oJDH3BJKyqBA2TXFhDsKDGDTlndYOZ6rGS0BRZIxGhM= github.com/go-xmlfmt/xmlfmt v1.1.3 h1:t8Ey3Uy7jDSEisW2K3somuMKIpzktkWptA0iFCnRUWY= github.com/go-xmlfmt/xmlfmt v1.1.3/go.mod h1:aUCEOzzezBEjDBbFBoSiya/gduyIiWYRP6CnSFIV8AM= github.com/gobwas/glob v0.2.3 h1:A4xDbljILXROh+kObIiy5kIaPYD8e96x1tgBhUI5J+Y= @@ -1156,8 +1160,8 @@ github.com/golangci/go-printf-func-name v0.1.0 h1:dVokQP+NMTO7jwO4bwsRwLWeudOVUP github.com/golangci/go-printf-func-name v0.1.0/go.mod h1:wqhWFH5mUdJQhweRnldEywnR5021wTdZSNgwYceV14s= github.com/golangci/gofmt v0.0.0-20250106114630-d62b90e6713d h1:viFft9sS/dxoYY0aiOTsLKO2aZQAPT4nlQCsimGcSGE= github.com/golangci/gofmt v0.0.0-20250106114630-d62b90e6713d/go.mod h1:ivJ9QDg0XucIkmwhzCDsqcnxxlDStoTl89jDMIoNxKY= -github.com/golangci/golangci-lint/v2 v2.2.1 h1:01r5ueY3oq8gtqgA5TGtBcS+LYZ/dEzZ59/AN1NsT2E= -github.com/golangci/golangci-lint/v2 v2.2.1/go.mod h1:Wu5txvpvWB2r+vjSNS6zn3WuCiJ7HAerKNiH+sEqWZA= +github.com/golangci/golangci-lint/v2 v2.4.0 h1:qz6O6vr7kVzXJqyvHjHSz5fA3D+PM8v96QU5gxZCNWM= +github.com/golangci/golangci-lint/v2 v2.4.0/go.mod h1:Oq7vuAf6L1iNL34uHDcsIF6Mnc0amOPdsT3/GlpHD+I= github.com/golangci/golines v0.0.0-20250217134842-442fd0091d95 h1:AkK+w9FZBXlU/xUmBtSJN1+tAI4FIvy5WtnUnY8e4p8= github.com/golangci/golines v0.0.0-20250217134842-442fd0091d95/go.mod h1:k9mmcyWKSTMcPPvQUCfRWWQ9VHJ1U9Dc0R7kaXAgtnQ= github.com/golangci/misspell v0.7.0 h1:4GOHr/T1lTW0hhR4tgaaV1WS/lJ+ncvYCoFKmqJsj0c= @@ -1301,8 +1305,8 @@ github.com/hashicorp/go-cleanhttp v0.5.0/go.mod h1:JpRdi6/HCYpAwUzNwuwqhbovhLtng github.com/hashicorp/go-cleanhttp v0.5.1/go.mod h1:JpRdi6/HCYpAwUzNwuwqhbovhLtngrth3wmdIIUrZ80= github.com/hashicorp/go-cleanhttp v0.5.2 h1:035FKYIWjmULyFRBKPs8TBQoi0x6d9G4xc9neXJWAZQ= github.com/hashicorp/go-cleanhttp v0.5.2/go.mod h1:kO/YDlP8L1346E6Sodw+PrpBSV4/SoxCXGY6BqNFT48= -github.com/hashicorp/go-getter v1.7.8 h1:mshVHx1Fto0/MydBekWan5zUipGq7jO0novchgMmSiY= -github.com/hashicorp/go-getter v1.7.8/go.mod h1:2c6CboOEb9jG6YvmC9xdD+tyAFsrUaJPedwXDGr0TM4= +github.com/hashicorp/go-getter v1.7.9 h1:G9gcjrDixz7glqJ+ll5IWvggSBR+R0B54DSRt4qfdC4= +github.com/hashicorp/go-getter v1.7.9/go.mod h1:dyFCmT1AQkDfOIt9NH8pw9XBDqNrIKJT5ylbpi7zPNE= github.com/hashicorp/go-hclog v0.0.0-20180709165350-ff2cf002a8dd/go.mod h1:9bjs9uLqI8l75knNv3lV1kA55veR+WUPSiKIWcQHudI= github.com/hashicorp/go-hclog v0.8.0/go.mod h1:5CU+agLiy3J7N7QjHK5d05KxGsuXiQLrjA0H7acj2lQ= github.com/hashicorp/go-hclog v0.12.0/go.mod h1:whpDNt7SSdeAju8AWKIWsul05p54N/39EeqMAyrmvFQ= @@ -1353,8 +1357,8 @@ github.com/hashicorp/hc-install v0.4.0 h1:cZkRFr1WVa0Ty6x5fTvL1TuO1flul231rWkGH9 github.com/hashicorp/hc-install v0.4.0/go.mod h1:5d155H8EC5ewegao9A4PUTMNPZaq+TbOzkJJZ4vrXeI= github.com/hashicorp/hcl v1.0.0 h1:0Anlzjpi4vEasTeNFn2mLJgTSwt0+6sfsiTG8qcWGx4= github.com/hashicorp/hcl v1.0.0/go.mod h1:E5yfLk+7swimpb2L/Alb/PJmXilQ/rhwaUYs4T20WEQ= -github.com/hashicorp/hcl/v2 v2.23.1-0.20250203194505-ba0759438da2 h1:JP8y98OtHTujECs4s/HxlKc5yql/RlC99Dt1Iz4R+lM= -github.com/hashicorp/hcl/v2 v2.23.1-0.20250203194505-ba0759438da2/go.mod h1:k+HgkLpoWu9OS81sy4j1XKDXaWm/rLysG33v5ibdDnc= +github.com/hashicorp/hcl/v2 v2.24.0 h1:2QJdZ454DSsYGoaE6QheQZjtKZSUs9Nh2izTWiwQxvE= +github.com/hashicorp/hcl/v2 v2.24.0/go.mod h1:oGoO1FIQYfn/AgyOhlg9qLC6/nOJPX3qGbkZpYAcqfM= github.com/hashicorp/logutils v1.0.0 h1:dLEQVugN8vlakKOUE3ihGLTZJRB4j+M2cdTm/ORI65Y= github.com/hashicorp/logutils v1.0.0/go.mod h1:QIAnNjmIWmVIIkWDTG1z5v++HQmx9WQRO+LraFDTW64= github.com/hashicorp/mdns v1.0.4/go.mod h1:mtBihi+LeNXGtG8L9dX59gAEa12BDtBQSp4v/YAJqrc= @@ -1512,8 +1516,8 @@ github.com/ldez/exptostd v0.4.4 h1:58AtQjnLcT/tI5W/1KU7xE/O7zW9RAWB6c/ScQAnfus= github.com/ldez/exptostd v0.4.4/go.mod h1:QfdzPw6oHjFVdNV7ILoPu5sw3OZ3OG1JS0I5JN3J4Js= github.com/ldez/gomoddirectives v0.7.0 h1:EOx8Dd56BZYSez11LVgdj025lKwlP0/E5OLSl9HDwsY= github.com/ldez/gomoddirectives v0.7.0/go.mod h1:wR4v8MN9J8kcwvrkzrx6sC9xe9Cp68gWYCsda5xvyGc= -github.com/ldez/grignotin v0.9.0 h1:MgOEmjZIVNn6p5wPaGp/0OKWyvq42KnzAt/DAb8O4Ow= -github.com/ldez/grignotin v0.9.0/go.mod h1:uaVTr0SoZ1KBii33c47O1M8Jp3OP3YDwhZCmzT9GHEk= +github.com/ldez/grignotin v0.10.0 h1:NQPeh1E/Eza4F0exCeC1WkpnLvgUcQDT8MQ1vOLML0E= +github.com/ldez/grignotin v0.10.0/go.mod h1:oR4iCKUP9fwoeO6vCQeD7M5SMxCT6xdVas4vg0h1LaI= github.com/ldez/tagliatelle v0.7.1 h1:bTgKjjc2sQcsgPiT902+aadvMjCeMHrY7ly2XKFORIk= github.com/ldez/tagliatelle v0.7.1/go.mod h1:3zjxUpsNB2aEZScWiZTHrAXOl1x25t3cRmzfK1mlo2I= github.com/ldez/usetesting v0.5.0 h1:3/QtzZObBKLy1F4F8jLuKJiKBjjVFi1IavpoWbmqLwc= @@ -1571,8 +1575,8 @@ github.com/mattn/go-sqlite3 v1.14.14/go.mod h1:NyWgC/yNuGj7Q9rpYnZvas74GogHl5/Z4 github.com/matttproud/golang_protobuf_extensions v1.0.1/go.mod h1:D8He9yQNgCq6Z5Ld7szi9bcBfOoFv/3dc6xSMkL2PC0= github.com/mergestat/timediff v0.0.3 h1:ucCNh4/ZrTPjFZ081PccNbhx9spymCJkFxSzgVuPU+Y= github.com/mergestat/timediff v0.0.3/go.mod h1:yvMUaRu2oetc+9IbPLYBJviz6sA7xz8OXMDfhBl7YSI= -github.com/mgechev/revive v1.10.0 h1:x2oJsd7yrDp0mC6IgZqSKBTjSUC9Zk5Ob2WfBwZic2I= -github.com/mgechev/revive v1.10.0/go.mod h1:1MRO9zUV7Yukhqh/nGRKSaw6xC5XDzPWPja5GMPWoSE= +github.com/mgechev/revive v1.11.0 h1:b/gLLpBE427o+Xmd8G58gSA+KtBwxWinH/A565Awh0w= +github.com/mgechev/revive v1.11.0/go.mod h1:tI0oLF/2uj+InHCBLrrqfTKfjtFTBCFFfG05auyzgdw= github.com/mgutz/ansi v0.0.0-20170206155736-9520e82c474b/go.mod h1:01TrycV0kFyexm33Z7vhZRXopbI8J3TDReVlkTgMUxE= github.com/mgutz/ansi v0.0.0-20200706080929-d51e80ef957d h1:5PJl274Y63IEHC+7izoQE9x6ikvDFZS2mDVS3drnohI= github.com/mgutz/ansi v0.0.0-20200706080929-d51e80ef957d/go.mod h1:01TrycV0kFyexm33Z7vhZRXopbI8J3TDReVlkTgMUxE= @@ -1591,8 +1595,6 @@ github.com/mitchellh/go-homedir v1.1.0 h1:lukF9ziXFxDFPkA1vsr5zpc1XuPDn/wFntq5mG github.com/mitchellh/go-homedir v1.1.0/go.mod h1:SfyaCUpYCn1Vlf4IUYiD9fPX4A5wJrkLzIz1N1q0pr0= github.com/mitchellh/go-testing-interface v0.0.0-20171004221916-a61a99592b77/go.mod h1:kRemZodwjscx+RGhAo8eIhFbs2+BFgRtFPeD/KE+zxI= github.com/mitchellh/go-testing-interface v1.0.0/go.mod h1:kRemZodwjscx+RGhAo8eIhFbs2+BFgRtFPeD/KE+zxI= -github.com/mitchellh/go-testing-interface v1.14.1 h1:jrgshOhYAUVNMAJiKbEu7EqAwgJJ2JqpQmpLJOu07cU= -github.com/mitchellh/go-testing-interface v1.14.1/go.mod h1:gfgS7OtZj6MA4U1UrDRp04twqAjfvlZyCfX3sDjEym8= github.com/mitchellh/go-wordwrap v1.0.0/go.mod h1:ZXFpozHsX6DPmq2I0TCekCxypsnAUbP2oI0UX1GXzOo= github.com/mitchellh/go-wordwrap v1.0.1 h1:TLuKupo69TCn6TQSyGxwI1EblZZEsQ0vMlAFQflz0v0= github.com/mitchellh/go-wordwrap v1.0.1/go.mod h1:R62XHJLzvMFRBbcrT7m7WgmE1eOyTSsCt+hzestvNj0= @@ -1623,8 +1625,8 @@ github.com/nishanths/exhaustive v0.12.0/go.mod h1:mEZ95wPIZW+x8kC4TgC+9YCUgiST7e github.com/nishanths/predeclared v0.2.2 h1:V2EPdZPliZymNAn79T8RkNApBjMmVKh5XRpLm/w98Vk= github.com/nishanths/predeclared v0.2.2/go.mod h1:RROzoN6TnGQupbC+lqggsOlcgysk3LMK/HI84Mp280c= github.com/npillmayer/nestext v0.1.3/go.mod h1:h2lrijH8jpicr25dFY+oAJLyzlya6jhnuG+zWp9L0Uk= -github.com/nunnatsa/ginkgolinter v0.19.1 h1:mjwbOlDQxZi9Cal+KfbEJTCz327OLNfwNvoZ70NJ+c4= -github.com/nunnatsa/ginkgolinter v0.19.1/go.mod h1:jkQ3naZDmxaZMXPWaS9rblH+i+GWXQCaS/JFIWcOH2s= +github.com/nunnatsa/ginkgolinter v0.20.0 h1:OmWLkAFO2HUTYcU6mprnKud1Ey5pVdiVNYGO5HVicx8= +github.com/nunnatsa/ginkgolinter v0.20.0/go.mod h1:dCIuFlTPfQerXgGUju3VygfAFPdC5aE1mdacCDKDJcQ= github.com/oklog/run v1.0.0 h1:Ru7dDtJNOyC66gQ5dQmaCa0qIsAUFY3sFpK1Xk8igrw= github.com/oklog/run v1.0.0/go.mod h1:dlhp/R75TPv97u0XWUtDeV/lRKWPKSdTuV0TZvrmrQA= github.com/oklog/ulid v1.3.1 h1:EGfNDEx6MqHz8B3uNV6QAib1UR2Lm97sHi3ocA6ESJ4= @@ -1766,8 +1768,8 @@ github.com/sassoftware/relic/v7 v7.6.2/go.mod h1:kjmP0IBVkJZ6gXeAu35/KCEfca//+PK github.com/sean-/seed v0.0.0-20170313163322-e2103e2c3529/go.mod h1:DxrIzT+xaE7yg65j358z/aeFdxmN0P9QXhEzd20vsDc= github.com/secure-systems-lab/go-securesystemslib v0.9.0 h1:rf1HIbL64nUpEIZnjLZ3mcNEL9NBPB0iuVjyxvq3LZc= github.com/secure-systems-lab/go-securesystemslib v0.9.0/go.mod h1:DVHKMcZ+V4/woA/peqr+L0joiRXbPpQ042GgJckkFgw= -github.com/securego/gosec/v2 v2.22.5 h1:ySws9uwOeE42DsG54v2moaJfh7r08Ev7SAYJuoMDfRA= -github.com/securego/gosec/v2 v2.22.5/go.mod h1:AWfgrFsVewk5LKobsPWlygCHt8K91boVPyL6GUZG5NY= +github.com/securego/gosec/v2 v2.22.7 h1:8/9P+oTYI4yIpAzccQKVsg1/90Po+JzGtAhqoHImDeM= +github.com/securego/gosec/v2 v2.22.7/go.mod h1:510TFNDMrIPytokyHQAVLvPeDr41Yihn2ak8P+XQfNE= github.com/sergi/go-diff v1.1.0/go.mod h1:STckp+ISIX8hZLjrqAeVduY0gWCT9IjLuqbuNXdaHfM= github.com/sergi/go-diff v1.3.2-0.20230802210424-5b0b94c5c0d3 h1:n661drycOFuPLCN3Uc8sB6B/s6Z4t2xvBgU1htSHuq8= github.com/sergi/go-diff v1.3.2-0.20230802210424-5b0b94c5c0d3/go.mod h1:A0bzQcvG0E7Rwjx0REVgAGH58e96+X0MeOfepqsbeW4= @@ -1807,8 +1809,8 @@ github.com/sivchari/containedctx v1.0.3 h1:x+etemjbsh2fB5ewm5FeLNi5bUjK0V8n0RB+W github.com/sivchari/containedctx v1.0.3/go.mod h1:c1RDvCbnJLtH4lLcYD/GqwiBSSf4F5Qk0xld2rBqzJ4= github.com/skeema/knownhosts v1.3.0 h1:AM+y0rI04VksttfwjkSTNQorvGqmwATnvnAHpSgc0LY= github.com/skeema/knownhosts v1.3.0/go.mod h1:sPINvnADmT/qYH1kfv+ePMmOBTH6Tbl7b5LvTDjFK7M= -github.com/sonatard/noctx v0.3.4 h1:ZeiM4rEeFTFSie/G5/HD9lHiMpQg/L4fnilaNmFQ2/A= -github.com/sonatard/noctx v0.3.4/go.mod h1:64XdbzFb18XL4LporKXp8poqZtPKbCrqQ402CV+kJas= +github.com/sonatard/noctx v0.4.0 h1:7MC/5Gg4SQ4lhLYR6mvOP6mQVSxCrdyiExo7atBs27o= +github.com/sonatard/noctx v0.4.0/go.mod h1:64XdbzFb18XL4LporKXp8poqZtPKbCrqQ402CV+kJas= github.com/sourcegraph/conc v0.3.0 h1:OQTbbt6P72L20UqAkXXuLOj79LfEanQ+YQFNpLA9ySo= github.com/sourcegraph/conc v0.3.0/go.mod h1:Sdozi7LEKbFPqYX2/J+iBAM6HpqSLTASQIKqDmF7Mt0= github.com/sourcegraph/go-diff v0.7.0 h1:9uLlrd5T46OXs5qpp8L/MTltk0zikUGi0sNNyCpA8G0= @@ -1829,8 +1831,9 @@ github.com/spf13/cast v1.8.0/go.mod h1:ancEpBxwJDODSW/UG4rDrAqiKolqNNh2DX3mk86cA github.com/spf13/cobra v1.9.1 h1:CXSaggrXdbHK9CF+8ywj8Amf7PBRmPCOJugH954Nnlo= github.com/spf13/cobra v1.9.1/go.mod h1:nDyEzZ8ogv936Cinf6g1RU9MRY64Ir93oCnqb9wxYW0= github.com/spf13/pflag v1.0.5/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg= -github.com/spf13/pflag v1.0.6 h1:jFzHGLGAlb3ruxLB8MhbI6A8+AQX/2eW4qeyNZXNp2o= github.com/spf13/pflag v1.0.6/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg= +github.com/spf13/pflag v1.0.7 h1:vN6T9TfwStFPFM5XzjsvmzZkLuaLX+HS+0SeFLRgU6M= +github.com/spf13/pflag v1.0.7/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg= github.com/spf13/viper v1.20.1 h1:ZMi+z/lvLyPSCoNtFCpqjy0S4kPbirhpTMwl8BkW9X4= github.com/spf13/viper v1.20.1/go.mod h1:P9Mdzt1zoHIG8m2eZQinpiBjo6kCmZSKBClNNqjJvu4= github.com/spiffe/go-spiffe/v2 v2.5.0 h1:N2I01KCUkv1FAjZXJMwh95KK1ZIQLYbPfhaxw8WS0hE= @@ -1867,8 +1870,8 @@ github.com/tenntenn/modver v1.0.1 h1:2klLppGhDgzJrScMpkj9Ujy3rXPUspSjAcev9tSEBgA github.com/tenntenn/modver v1.0.1/go.mod h1:bePIyQPb7UeioSRkw3Q0XeMhYZSMx9B8ePqg6SAMGH0= github.com/tenntenn/text/transform v0.0.0-20200319021203-7eef512accb3 h1:f+jULpRQGxTSkNYKJ51yaw6ChIqO+Je8UqsTKN/cDag= github.com/tenntenn/text/transform v0.0.0-20200319021203-7eef512accb3/go.mod h1:ON8b8w4BN/kE1EOhwT0o+d62W65a6aPw1nouo9LMgyY= -github.com/terraform-linters/tflint v0.58.0 h1:DIHtMHolcNNrnR2vFKAlrSWzppvXAWJ8S5kSb488kmg= -github.com/terraform-linters/tflint v0.58.0/go.mod h1:cdKZeERrzEA791ZvIjj0Q4f+KX0AhaYh/hCgm1vNcyE= +github.com/terraform-linters/tflint v0.58.1 h1:GUgfonXrRvM2qKCQ4TDqQTssdeMQm/RlnjyuQ7wDj8k= +github.com/terraform-linters/tflint v0.58.1/go.mod h1:W0Cizbz8cxKxjgQV/SsqTJxlGXN7JnAUZ6nvmMbhylI= github.com/terraform-linters/tflint-plugin-sdk v0.22.0 h1:holOVJW0hjf0wkjtnYyPWRooQNp8ETUcKE86rdYkH5U= github.com/terraform-linters/tflint-plugin-sdk v0.22.0/go.mod h1:Cag3YJjBpHdQzI/limZR+Cj7WYPLTIE61xsCdIXoeUI= github.com/terraform-linters/tflint-ruleset-terraform v0.12.0 h1:158C56w1lJ4DSezzz54ISbkrgmQKBEy8iHSBFwxsBVs= @@ -1902,16 +1905,16 @@ github.com/tommy-muehle/go-mnd/v2 v2.5.1/go.mod h1:WsUAkMJMYww6l/ufffCD3m+P7LEvr github.com/transparency-dev/merkle v0.0.2 h1:Q9nBoQcZcgPamMkGn7ghV8XiTZ/kRxn1yCG81+twTK4= github.com/transparency-dev/merkle v0.0.2/go.mod h1:pqSy+OXefQ1EDUVmAJ8MUhHB9TXGuzVAT58PqBoHz1A= github.com/ulikunitz/xz v0.5.10/go.mod h1:nbz6k7qbPmH4IRqmfOplQw/tblSgqTqBwxkY0oWt/14= -github.com/ulikunitz/xz v0.5.12 h1:37Nm15o69RwBkXM0J6A5OlE67RZTfzUxTj8fB3dfcsc= -github.com/ulikunitz/xz v0.5.12/go.mod h1:nbz6k7qbPmH4IRqmfOplQw/tblSgqTqBwxkY0oWt/14= +github.com/ulikunitz/xz v0.5.14 h1:uv/0Bq533iFdnMHZdRBTOlaNMdb1+ZxXIlHDZHIHcvg= +github.com/ulikunitz/xz v0.5.14/go.mod h1:nbz6k7qbPmH4IRqmfOplQw/tblSgqTqBwxkY0oWt/14= github.com/ultraware/funlen v0.2.0 h1:gCHmCn+d2/1SemTdYMiKLAHFYxTYz7z9VIDRaTGyLkI= github.com/ultraware/funlen v0.2.0/go.mod h1:ZE0q4TsJ8T1SQcjmkhN/w+MceuatI6pBFSxxyteHIJA= github.com/ultraware/whitespace v0.2.0 h1:TYowo2m9Nfj1baEQBjuHzvMRbp19i+RCcRYrSWoFa+g= github.com/ultraware/whitespace v0.2.0/go.mod h1:XcP1RLD81eV4BW8UhQlpaR+SDc2givTvyI8a586WjW8= github.com/uudashr/gocognit v1.2.0 h1:3BU9aMr1xbhPlvJLSydKwdLN3tEUUrzPSSM8S4hDYRA= github.com/uudashr/gocognit v1.2.0/go.mod h1:k/DdKPI6XBZO1q7HgoV2juESI2/Ofj9AcHPZhBBdrTU= -github.com/uudashr/iface v1.4.0 h1:ImZ+1oEJPXvjap7nK0md7gA9RRH7PMp4vliaLkJ2+cg= -github.com/uudashr/iface v1.4.0/go.mod h1:i/H4cfRMPe0izticV8Yz0g6/zcsh5xXlvthrdh1kqcY= +github.com/uudashr/iface v1.4.1 h1:J16Xl1wyNX9ofhpHmQ9h9gk5rnv2A6lX/2+APLTo0zU= +github.com/uudashr/iface v1.4.1/go.mod h1:pbeBPlbuU2qkNDn0mmfrxP2X+wjPMIQAy+r1MBXSXtg= github.com/vmihailenco/msgpack/v4 v4.3.12/go.mod h1:gborTTJjAo/GWTqqRjrLCn9pgNN+NXzzngzBKDPIqw4= github.com/vmihailenco/msgpack/v5 v5.3.5 h1:5gO0H1iULLWGhs2H5tbAHIZTV8/cYafcFOr9znI5mJU= github.com/vmihailenco/msgpack/v5 v5.3.5/go.mod h1:7xyJ9e+0+9SaZT0Wt1RGleJXzli6Q/V5KbhBonMG9jc= @@ -1968,8 +1971,8 @@ go-simpler.org/assert v0.9.0 h1:PfpmcSvL7yAnWyChSjOz6Sp6m9j5lyK8Ok9pEL31YkQ= go-simpler.org/assert v0.9.0/go.mod h1:74Eqh5eI6vCK6Y5l3PI8ZYFXG4Sa+tkr70OIPJAUr28= go-simpler.org/musttag v0.13.1 h1:lw2sJyu7S1X8lc8zWUAdH42y+afdcCnHhWpnkWvd6vU= go-simpler.org/musttag v0.13.1/go.mod h1:8r450ehpMLQgvpb6sg+hV5Ur47eH6olp/3yEanfG97k= -go-simpler.org/sloglint v0.11.0 h1:JlR1X4jkbeaffiyjLtymeqmGDKBDO1ikC6rjiuFAOco= -go-simpler.org/sloglint v0.11.0/go.mod h1:CFDO8R1i77dlciGfPEPvYke2ZMx4eyGiEIWkyeW2Pvw= +go-simpler.org/sloglint v0.11.1 h1:xRbPepLT/MHPTCA6TS/wNfZrDzkGvCCqUv4Bdwc3H7s= +go-simpler.org/sloglint v0.11.1/go.mod h1:2PowwiCOK8mjiF+0KGifVOT8ZsCNiFzvfyJeJOIt8MQ= go.augendre.info/arangolint v0.2.0 h1:2NP/XudpPmfBhQKX4rMk+zDYIj//qbt4hfZmSSTcpj8= go.augendre.info/arangolint v0.2.0/go.mod h1:Vx4KSJwu48tkE+8uxuf0cbBnAPgnt8O1KWiT7bljq7w= go.augendre.info/fatcontext v0.8.0 h1:2dfk6CQbDGeu1YocF59Za5Pia7ULeAM6friJ3LP7lmk= @@ -2048,8 +2051,8 @@ golang.org/x/crypto v0.14.0/go.mod h1:MVFd36DqK4CsrnJYDkBA3VC4m2GkXAM0PvzMCn4JQf golang.org/x/crypto v0.19.0/go.mod h1:Iy9bg/ha4yyC70EfRS8jz+B6ybOBKMaSxLj6P6oBDfU= golang.org/x/crypto v0.23.0/go.mod h1:CKFgDieR+mRhux2Lsu27y0fO304Db0wZe70UKqHu0v8= golang.org/x/crypto v0.32.0/go.mod h1:ZnnJkOaASj8g0AjIduWNlq2NRxL0PlBrbKVyZ6V/Ugc= -golang.org/x/crypto v0.39.0 h1:SHs+kF4LP+f+p14esP5jAoDpHU8Gu/v9lFRK6IT5imM= -golang.org/x/crypto v0.39.0/go.mod h1:L+Xg3Wf6HoL4Bn4238Z6ft6KfEpN0tJGo53AAPC632U= +golang.org/x/crypto v0.41.0 h1:WKYxWedPGCTVVl5+WHSSrOBT0O8lx32+zxmHxijgXp4= +golang.org/x/crypto v0.41.0/go.mod h1:pO5AFd7FA68rFak7rOAGVuygIISepHftHnr8dr6+sUc= golang.org/x/exp v0.0.0-20180321215751-8460e604b9de/go.mod h1:CJ0aWSM057203Lf6IL+f9T1iT9GByDxfZKAQTCR3kQA= golang.org/x/exp v0.0.0-20180807140117-3d87b88a115f/go.mod h1:CJ0aWSM057203Lf6IL+f9T1iT9GByDxfZKAQTCR3kQA= golang.org/x/exp v0.0.0-20190121172915-509febef88a4/go.mod h1:CJ0aWSM057203Lf6IL+f9T1iT9GByDxfZKAQTCR3kQA= @@ -2069,8 +2072,8 @@ golang.org/x/exp v0.0.0-20240909161429-701f63a606c0 h1:e66Fs6Z+fZTbFBAxKfP3PALWB golang.org/x/exp v0.0.0-20240909161429-701f63a606c0/go.mod h1:2TbTHSBQa924w8M6Xs1QcRcFwyucIwBGpK1p2f1YFFY= golang.org/x/exp/typeparams v0.0.0-20220428152302-39d4317da171/go.mod h1:AbB0pIl9nAr9wVwH+Z2ZpaocVmF5I4GyWCDIsVjR0bk= golang.org/x/exp/typeparams v0.0.0-20230203172020-98cc5a0785f9/go.mod h1:AbB0pIl9nAr9wVwH+Z2ZpaocVmF5I4GyWCDIsVjR0bk= -golang.org/x/exp/typeparams v0.0.0-20250210185358-939b2ce775ac h1:TSSpLIG4v+p0rPv1pNOQtl1I8knsO4S9trOxNMOLVP4= -golang.org/x/exp/typeparams v0.0.0-20250210185358-939b2ce775ac/go.mod h1:AbB0pIl9nAr9wVwH+Z2ZpaocVmF5I4GyWCDIsVjR0bk= +golang.org/x/exp/typeparams v0.0.0-20250620022241-b7579e27df2b h1:KdrhdYPDUvJTvrDK9gdjfFd6JTk8vA1WJoldYSi0kHo= +golang.org/x/exp/typeparams v0.0.0-20250620022241-b7579e27df2b/go.mod h1:LKZHyeOpPuZcMgxeHjJp4p5yvxrCX1xDvH10zYHhjjQ= golang.org/x/image v0.0.0-20180708004352-c73c2afc3b81/go.mod h1:ux5Hcp/YLpHSI86hEcLt0YII63i6oz57MZXIpbrjZUs= golang.org/x/image v0.0.0-20190227222117-0694c2d4d067/go.mod h1:kZ7UVZpmo3dzQBMxlp+ypCbDeSB+sBbTgSJuh5dn5js= golang.org/x/image v0.0.0-20190802002840-cff245a6509b/go.mod h1:FeLwcggjj3mMvU+oOTbSwawSJRM1uh48EjtB4UJZlP0= @@ -2118,8 +2121,8 @@ golang.org/x/mod v0.12.0/go.mod h1:iBbtSCu2XBx23ZKBPSOrRkjjQPZFPuis4dIYUhu/chs= golang.org/x/mod v0.13.0/go.mod h1:hTbmBsO62+eylJbnUtE2MGJUyE7QWk4xUqPFrRgJ+7c= golang.org/x/mod v0.15.0/go.mod h1:hTbmBsO62+eylJbnUtE2MGJUyE7QWk4xUqPFrRgJ+7c= golang.org/x/mod v0.17.0/go.mod h1:hTbmBsO62+eylJbnUtE2MGJUyE7QWk4xUqPFrRgJ+7c= -golang.org/x/mod v0.25.0 h1:n7a+ZbQKQA/Ysbyb0/6IbB1H/X41mKgbhfv7AfG/44w= -golang.org/x/mod v0.25.0/go.mod h1:IXM97Txy2VM4PJ3gI61r1YEk/gAj6zAHN3AdZt6S9Ww= +golang.org/x/mod v0.27.0 h1:kb+q2PyFnEADO2IEF935ehFUXlWiNjJWtRNgBLSfbxQ= +golang.org/x/mod v0.27.0/go.mod h1:rWI627Fq0DEoudcK+MBkNkCe0EetEaDSwJJkCcjpazc= golang.org/x/net v0.0.0-20180724234803-3673e40ba225/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4= golang.org/x/net v0.0.0-20180826012351-8a410e7b638d/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4= golang.org/x/net v0.0.0-20181114220301-adae6a3d119a/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4= @@ -2189,8 +2192,8 @@ golang.org/x/net v0.16.0/go.mod h1:NxSsAGuq816PNPmqtQdLE42eU2Fs7NoRIZrHJAlaCOE= golang.org/x/net v0.21.0/go.mod h1:bIjVDfnllIU7BJ2DNgfnXvpSvtn8VRwhlsaeUTyUS44= golang.org/x/net v0.25.0/go.mod h1:JkAGAh7GEvH74S6FOH42FLoXpXbE/aqXSrIQjXgsiwM= golang.org/x/net v0.34.0/go.mod h1:di0qlW3YNM5oh6GqDGQr92MyTozJPmybPK4Ev/Gm31k= -golang.org/x/net v0.41.0 h1:vBTly1HeNPEn3wtREYfy4GZ/NECgw2Cnl+nK6Nz3uvw= -golang.org/x/net v0.41.0/go.mod h1:B/K4NNqkfmg07DQYrbwvSluqCJOOXwUjeb/5lOisjbA= +golang.org/x/net v0.43.0 h1:lat02VYK2j4aLzMzecihNvTlJNQUq316m2Mr9rnM6YE= +golang.org/x/net v0.43.0/go.mod h1:vhO1fvI4dGsIjh73sWfUVjj3N7CA9WkKJNQm2svM6Jg= golang.org/x/oauth2 v0.0.0-20180821212333-d2e6202438be/go.mod h1:N/0e6XlmueqKjAGxoOufVs8QHGRruUQn6yWY3a++T0U= golang.org/x/oauth2 v0.0.0-20190226205417-e64efc72b421/go.mod h1:gOpvHmFTYa4IltrdGE7lF6nIHvwfUNPOp7c8zoXwtLw= golang.org/x/oauth2 v0.0.0-20190604053449-0f29369cfe45/go.mod h1:gOpvHmFTYa4IltrdGE7lF6nIHvwfUNPOp7c8zoXwtLw= @@ -2244,8 +2247,8 @@ golang.org/x/sync v0.4.0/go.mod h1:FU7BRWz2tNW+3quACPkgCx/L+uEAv1htQ0V83Z9Rj+Y= golang.org/x/sync v0.6.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk= golang.org/x/sync v0.7.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk= golang.org/x/sync v0.10.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk= -golang.org/x/sync v0.15.0 h1:KWH3jNZsfyT6xfAfKiz6MRNmd46ByHDYaZ7KSkCtdW8= -golang.org/x/sync v0.15.0/go.mod h1:1dzgHSNfp02xaA81J2MS99Qcpr2w7fw1gpm99rleRqA= +golang.org/x/sync v0.16.0 h1:ycBJEhp9p4vXvUZNszeOq0kGTPghopOL8q0fq3vstxw= +golang.org/x/sync v0.16.0/go.mod h1:1dzgHSNfp02xaA81J2MS99Qcpr2w7fw1gpm99rleRqA= golang.org/x/sys v0.0.0-20180823144017-11551d06cbcc/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= golang.org/x/sys v0.0.0-20180830151530-49385e6e1522/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= golang.org/x/sys v0.0.0-20180905080454-ebe1bf3edb33/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= @@ -2357,8 +2360,8 @@ golang.org/x/sys v0.13.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.17.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= golang.org/x/sys v0.20.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= golang.org/x/sys v0.29.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= -golang.org/x/sys v0.33.0 h1:q3i8TbbEz+JRD9ywIRlyRAQbM0qF7hu24q3teo2hbuw= -golang.org/x/sys v0.33.0/go.mod h1:BJP2sWEmIv4KK5OTEluFJCKSidICx8ciO85XgH3Ak8k= +golang.org/x/sys v0.35.0 h1:vz1N37gP5bs89s7He8XuIYXpyY0+QlsKmzipCbUtyxI= +golang.org/x/sys v0.35.0/go.mod h1:BJP2sWEmIv4KK5OTEluFJCKSidICx8ciO85XgH3Ak8k= golang.org/x/telemetry v0.0.0-20240228155512-f48c80bd79b2/go.mod h1:TeRTkGYfJXctD9OcfyVLyj2J3IxLnKwHJR8f4D8a3YE= golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo= golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8= @@ -2374,8 +2377,8 @@ golang.org/x/term v0.13.0/go.mod h1:LTmsnFJwVN6bCy1rVCoS+qHT1HhALEFxKncY3WNNh4U= golang.org/x/term v0.17.0/go.mod h1:lLRBjIVuehSbZlaOtGMbcMncT+aqLLLmKrsjNrUguwk= golang.org/x/term v0.20.0/go.mod h1:8UkIAJTvZgivsXaD6/pH6U9ecQzZ45awqEOzuCvwpFY= golang.org/x/term v0.28.0/go.mod h1:Sw/lC2IAUZ92udQNf3WodGtn4k/XoLyZoh8v/8uiwek= -golang.org/x/term v0.32.0 h1:DR4lr0TjUs3epypdhTOkMmuF5CDFJ/8pOnbzMZPQ7bg= -golang.org/x/term v0.32.0/go.mod h1:uZG1FhGx848Sqfsq4/DlJr3xGGsYMu/L5GW4abiaEPQ= +golang.org/x/term v0.34.0 h1:O/2T7POpk0ZZ7MAzMeWFSg6S5IpWd/RXDlM9hgM3DR4= +golang.org/x/term v0.34.0/go.mod h1:5jC53AEywhIVebHgPVeg0mj8OD3VO9OzclacVrqpaAw= golang.org/x/text v0.0.0-20170915032832-14c0d48ead0c/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= golang.org/x/text v0.3.1-0.20180807135948-17ff2d5776d2/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= @@ -2397,8 +2400,8 @@ golang.org/x/text v0.13.0/go.mod h1:TvPlkZtksWOMsz7fbANvkp4WM8x/WCo/om8BMLbz+aE= golang.org/x/text v0.14.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU= golang.org/x/text v0.15.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU= golang.org/x/text v0.21.0/go.mod h1:4IBbMaMmOPCJ8SecivzSH54+73PCFmPWxNTLm+vZkEQ= -golang.org/x/text v0.26.0 h1:P42AVeLghgTYr4+xUnTRKDMqpar+PtX7KWuNQL21L8M= -golang.org/x/text v0.26.0/go.mod h1:QK15LZJUUQVJxhz7wXgxSy/CJaTFjd0G+YLonydOVQA= +golang.org/x/text v0.28.0 h1:rhazDwis8INMIwQ4tpjLDzUhx6RlXqZNPEM0huQojng= +golang.org/x/text v0.28.0/go.mod h1:U8nCwOR8jO/marOQ0QbDiOngZVEBB7MAiitBuMjXiNU= golang.org/x/time v0.0.0-20181108054448-85acf8d2951c/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ= golang.org/x/time v0.0.0-20190308202827-9d24e82272b4/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ= golang.org/x/time v0.0.0-20191024005414-555d28b269f0/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ= @@ -2482,8 +2485,12 @@ golang.org/x/tools v0.7.0/go.mod h1:4pg6aUX35JBAogB10C9AtvVL+qowtN4pT3CGSQex14s= golang.org/x/tools v0.13.0/go.mod h1:HvlwmtVNQAhOuCjW7xxvovg8wbNq7LwfXh/k7wXUl58= golang.org/x/tools v0.14.0/go.mod h1:uYBEerGOWcJyEORxN+Ek8+TT266gXkNlHdJBwexUsBg= golang.org/x/tools v0.21.1-0.20240508182429-e35e4ccd0d2d/go.mod h1:aiJjzUbINMkxbQROHiO6hDPo2LHcIPhhQsa9DLh0yGk= -golang.org/x/tools v0.34.0 h1:qIpSLOxeCYGg9TrcJokLBG4KFA6d795g0xkBkiESGlo= -golang.org/x/tools v0.34.0/go.mod h1:pAP9OwEaY1CAW3HOmg3hLZC5Z0CCmzjAF2UQMSqNARg= +golang.org/x/tools v0.36.0 h1:kWS0uv/zsvHEle1LbV5LE8QujrxB3wfQyxHfhOk0Qkg= +golang.org/x/tools v0.36.0/go.mod h1:WBDiHKJK8YgLHlcQPYQzNCkUxUypCaa5ZegCVutKm+s= +golang.org/x/tools/go/expect v0.1.1-deprecated h1:jpBZDwmgPhXsKZC6WhL20P4b/wmnpsEAGHaNy0n/rJM= +golang.org/x/tools/go/expect v0.1.1-deprecated/go.mod h1:eihoPOH+FgIqa3FpoTwguz/bVUSGBlGQU67vpBeOrBY= +golang.org/x/tools/go/packages/packagestest v0.1.1-deprecated h1:1h2MnaIAIXISqTFKdENegdpAgUXz6NrPEsbIeWaBRvM= +golang.org/x/tools/go/packages/packagestest v0.1.1-deprecated/go.mod h1:RVAQXBGNv1ib0J382/DPCRS/BPnsGebyM1Gj5VSDpG8= golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= @@ -2557,8 +2564,8 @@ google.golang.org/api v0.108.0/go.mod h1:2Ts0XTHNVWxypznxWOYUeI4g3WdP9Pk2Qk58+a/ google.golang.org/api v0.110.0/go.mod h1:7FC4Vvx1Mooxh8C5HWjzZHcavuS2f6pmJpZx60ca7iI= google.golang.org/api v0.111.0/go.mod h1:qtFHvU9mhgTJegR31csQ+rwxyUTHOKFqCKWp1J0fdw0= google.golang.org/api v0.114.0/go.mod h1:ifYI2ZsFK6/uGddGfAD5BMxlnkBqCmqHSDUVi45N5Yg= -google.golang.org/api v0.237.0 h1:MP7XVsGZesOsx3Q8WVa4sUdbrsTvDSOERd3Vh4xj/wc= -google.golang.org/api v0.237.0/go.mod h1:cOVEm2TpdAGHL2z+UwyS+kmlGr3bVWQQ6sYEqkKje50= +google.golang.org/api v0.242.0 h1:7Lnb1nfnpvbkCiZek6IXKdJ0MFuAZNAJKQfA1ws62xg= +google.golang.org/api v0.242.0/go.mod h1:cOVEm2TpdAGHL2z+UwyS+kmlGr3bVWQQ6sYEqkKje50= google.golang.org/appengine v1.1.0/go.mod h1:EbEs0AVv82hx2wNQdGPgUI5lhzA/G0D9YwlJXL52JkM= google.golang.org/appengine v1.4.0/go.mod h1:xpcJRLb0r/rnEns0DIKYYv+WjYCduHsrkT7/EB5XEv4= google.golang.org/appengine v1.5.0/go.mod h1:xpcJRLb0r/rnEns0DIKYYv+WjYCduHsrkT7/EB5XEv4= @@ -2843,8 +2850,8 @@ modernc.org/strutil v1.1.3/go.mod h1:MEHNA7PdEnEwLvspRMtWTNnp2nnyvMfkimT1NKNAGbw modernc.org/tcl v1.13.1/go.mod h1:XOLfOwzhkljL4itZkK6T72ckMgvj0BDsnKNdZVUOecw= modernc.org/token v1.0.0/go.mod h1:UGzOrNV1mAFSEB63lOFHIpNRUVMvYTc6yu1SMY/XTDM= modernc.org/z v1.5.1/go.mod h1:eWFB510QWW5Th9YGZT81s+LwvaAs3Q2yr4sP0rmLkv8= -mvdan.cc/gofumpt v0.8.0 h1:nZUCeC2ViFaerTcYKstMmfysj6uhQrA2vJe+2vwGU6k= -mvdan.cc/gofumpt v0.8.0/go.mod h1:vEYnSzyGPmjvFkqJWtXkh79UwPWP9/HMxQdGEXZHjpg= +mvdan.cc/gofumpt v0.9.0 h1:W0wNHMSvDBDIyZsm3nnGbVfgp5AknzBrGJnfLCy501w= +mvdan.cc/gofumpt v0.9.0/go.mod h1:3xYtNemnKiXaTh6R4VtlqDATFwBbdXI8lJvH/4qk7mw= mvdan.cc/unparam v0.0.0-20250301125049-0df0534333a4 h1:WjUu4yQoT5BHT1w8Zu56SP8367OuBV5jvo+4Ulppyf8= mvdan.cc/unparam v0.0.0-20250301125049-0df0534333a4/go.mod h1:rthT7OuvRbaGcd5ginj6dA2oLE7YNlta9qhBNNdCaLE= rsc.io/binaryregexp v0.2.0/go.mod h1:qTv7/COck+e2FymRvadv62gMdZztPaShugOCi3I+8D8= diff --git a/.ci/tools/main.go b/.ci/tools/main.go index f4e7bc1660a4..9028fa1a3d36 100644 --- a/.ci/tools/main.go +++ b/.ci/tools/main.go @@ -13,5 +13,6 @@ import ( _ "github.com/pavius/impi/cmd/impi" _ "github.com/rhysd/actionlint/cmd/actionlint" _ "github.com/terraform-linters/tflint" + _ "golang.org/x/tools/cmd/stringer" _ "mvdan.cc/gofumpt" ) diff --git a/.github/ISSUE_TEMPLATE/00_bug_report.yml b/.github/ISSUE_TEMPLATE/00_bug_report.yml index 01705d1426ff..882d6ba8be4e 100644 --- a/.github/ISSUE_TEMPLATE/00_bug_report.yml +++ b/.github/ISSUE_TEMPLATE/00_bug_report.yml @@ -1,164 +1,167 @@ -name: Report a Bug -description: Choose this option to let us know about an unexpected error, a crash, or otherwise incorrect behavior. -labels: - - bug +name: "Report a Bug" +description: "Choose this option to let us know about an unexpected error, a crash, or otherwise incorrect behavior." +title: "[Bug]: " +labels: ["bug"] body: - type: markdown attributes: value: | - ## Thank you for raising a bug report! + # Thank you for raising a bug report! - Before submitting a bug report, we ask that you first [search existing issues and pull requests](https://github.com/hashicorp/terraform-provider-aws/issues?q=label%3Abug) to see if someone else may have experienced the same issue or may have already submitted a fix for it. This helps to keep all relevant information in one place, including any potential workarounds. - - ### A Note on Terraform Core Issues + Before submitting a bug report, we ask that you first search existing issues to see if someone else may have experienced the same issue. This helps to keep all relevant information in one place, including any potential workarounds. We also ask that you consider whether your issue may be related to Terraform Core. If you are running into one of the following scenarios, we recommend [opening an issue](https://github.com/hashicorp/terraform/issues/new/choose) in the Terraform Core repository instead: - * [Configuration Language](https://developer.hashicorp.com/terraform/language) or resource ordering issues - * [State](https://developer.hashicorp.com/terraform/language/state) and [State Backend](https://developer.hashicorp.com/terraform/language/backend) issues - * [Provisioner](https://developer.hashicorp.com/terraform/language/resources/provisioners/syntax) issues + * [Configuration Language](https://www.terraform.io/docs/configuration/index.html) or resource ordering issues + * [State](https://www.terraform.io/docs/state/index.html) and [State Backend](https://www.terraform.io/docs/backends/index.html) issues + * [Provisioner](https://www.terraform.io/docs/provisioners/index.html) issues * [Registry](https://registry.terraform.io/) issues - * Issues that span resources across multiple providers + * Spans resources across multiple providers - - type: textarea + - type: markdown + attributes: + value: | + # Terraform and AWS Provider Versions + + Please run `terraform -v` to show the Terraform Core and provider version(s). If you are not running the latest version of either the provider or Terraform Core, please consider upgrading, as your issue may have already been fixed. + + [Terraform documentation on provider versioning](https://www.terraform.io/docs/configuration/providers.html#provider-versions) + + - type: input id: tf_version attributes: - label: Terraform and AWS Provider Version - description: | - Please run `terraform --version` to collect the Terraform and AWS Provider versions and paste the result below. If multiple versions have been tested, feel free to add that additional information here as well. - placeholder: | - ...output of `terraform --version`... - render: console + label: Terraform Core Version + description: The semantic version of Terraform Core used when experiencing the bug. If multiple versions have been tested, a comma separated list. + placeholder: "X.Y.Z" + validations: + required: true + + - type: input + id: aws_version + attributes: + label: AWS Provider Version + description: The semantic version of the AWS Provider used when experiencing the bug. If multiple versions have been tested, a comma separated list. + placeholder: "X.Y.Z" validations: required: true + - type: markdown + attributes: + value: | + # Description + + In the next few fields, please provide any useful information you can around what resources are affected, what you expected to happen, and what actually happened. There is also a field to optionally provide a small snippet of any relevant error or panic output. + + Note that there is a section later in the form to provide more complete Terraform configuration and logging information. These fields should instead be thought of as the place to briefly describe the bug. + - type: textarea - id: affected_resource + id: affected attributes: - label: Affected Resource(s) or Data Source(s) - description: | - If applicable, please list the affected resource(s) and/or data source(s). - placeholder: | - * `aws_example_resource` - * `aws_example_data_source` + label: Affected Resource(s) + description: Please list the affected resource(s) and/or data source(s). + placeholder: "* aws_xxx" validations: required: false - type: textarea - id: expected_behavior + id: expected attributes: label: Expected Behavior - description: | - Use this section to describe what behavior should have happened that isn't currently. Note that there is a section later in the template for providing a sample configuration, so a short description is all that's necessary here. + description: What should have happened? validations: required: true - type: textarea - id: actual_behavior + id: actual attributes: label: Actual Behavior - description: | - Use this section to describe how the the provider is currently behaving and how it differs from the behavior outlined in the Expected Behavior section. + description: What actually happened? validations: required: true - type: textarea id: log_snippet attributes: - label: Relevant Error/Panic Output + label: Relevant Error/Panic Output Snippet description: | - If applicable, provide a snippet of output logging that contains the error or panic. Note that there is a section later in the template for providing more complete debug output, so a small snippet is all that's necessary here. - - For convenience, we pre-populate this section with a [code fence](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks) to help with formatting in the resulting issue. Placing the log output between the sets of backticks (\```) will result in a well-formatted issue. - value: | - ```console - - ``` + If applicable, provide a relevant snippet from the error or panic output. This will be rendered as `shell`, so there is no need to add a [code fence](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks). + render: shell validations: required: false - type: markdown attributes: value: | - ## Providing Configurations and Logging + # Configuration and Logging - When providing a reproduction configuration and/or debug logging, please paste, upload, or link to a file or [public Gist](https://docs.github.com/en/get-started/writing-on-github/editing-and-sharing-content-with-gists/creating-gists) containing the relevant information. Files under 25MB may be [attached directly](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/attaching-files) in the relevant field. Files larger than this should be uploaded to a file hosting service and a link shared. For your security you can also encrypt the files using our [GPG public key](https://keybase.io/hashicorp). + Here, we ask that you provide the Terraform configuration and, when possible, the debug logs. For configurations or logs of more than just a few lines, it's preferred to either share a Gist link or zip the files and upload them. - Configurations should be applyable with minimal modifications, and should not rely on external modules. This helps maintainers and contributors efficiently reproduce issues and implement acceptance tests to prevent future regressions. + Terraform configurations or debug logs under 25MB may be [attached directly in the field](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/attaching-files). Files larger than this should be uploaded to a file hosting service and a link shared. - > [!WARNING] - > Bug reports without a functional and standalone sample configuration may be closed without further investigation. + For your security you can also encrypt the files using our [GPG public key](https://keybase.io/hashicorp). + + **Note:** These form fields do not automatically render, so you will need to use [code fence(s)](https://help.github.com/articles/basic-writing-and-formatting-syntax/#quoting-code) to achieve proper formatting. - type: textarea id: tf_config attributes: - label: Sample Terraform Configuration + label: Terraform Configuration Files description: | - Please provide a sample Terraform configuration that can be used to reproduce the issue. - - For convenience, we pre-populate this section such that configurations pasted between the backticks (\```) will be contained within a disclosure triangle and have syntax highlighting as appropriate for HCL in the resulting issue. Where appropriate, feel free to delete this. - value: | -
- Click to expand configuration + Please paste, upload, or link to a file or Gist containing all Terraform configurations required to reproduce the bug. See note above for additional information on file size restrictions and encrypting. - ```hcl - - ``` -
+ Bug reports without a functional reproduction may be closed without investigation. validations: required: true - type: textarea - id: reproduction_steps + id: repro attributes: label: Steps to Reproduce - description: | - Please list the steps necessary to reproduce the issue. - placeholder: | - 1. Apply the configuration - 2. Make a change - 3. etc. + description: Please list the steps required to reproduce the issue. validations: required: true - type: textarea - id: extended_logs + id: debug_logs attributes: - label: Debug Logging + label: Debug Output description: | - If possible, please provide log output captured while reproducing the issue with [debug logging enabled](https://developer.hashicorp.com/terraform/internals/debugging). If a panic is produced, that information should be included. + If possible, please paste, upload, or link to a file or Gist containing debug logs. See note above for additional information on file size restrictions and encrypting. - For convenience, we pre-populate this section such that logs pasted between the backticks (\```) will be contained within a disclosure triangle and have syntax highlighting associated with console output in the resulting issue. - value: | -
- Click to expand log output - - ```console + To obtain the debug output, see the [Terraform documentation on debugging](https://www.terraform.io/docs/internals/debugging.html). + validations: + required: false - ``` -
+ - type: textarea + id: panic_logs + attributes: + label: Panic Output + description: If Terraform produced a panic, please paste, upload, or link to a file or Gist containing the output of the `crash.log`. validations: required: false + - type: markdown + attributes: + value: | + # Additional Information + + For the final two fields, optionally provide any additional context that might help the community or maintainers to investigate the bug. This might be additional references that you found when troubleshooting, similar bug reports, or specifics about your environment that might be unique. + - type: textarea - id: genai_llm attributes: - label: GenAI / LLM Assisted Development - description: | - If you used a generative AI / LLM tool to assist in the development of your config, please let us know which tool you used here. - value: n/a + label: Important Factoids + description: Are there anything atypical about your configuration or environment that we should know about? validations: required: false - type: textarea + id: references attributes: - label: Important Facts and References + label: References description: | - If there is any additional information that might be relevant, provide those details here. This might include information such as, but not limited to: + Where possible, please supply links to vendor documentation, other GitHub issues (open or closed) or pull requests that give additional context. - * Any atypical situations that might apply (airgapped environments, specific [AWS partitions](https://docs.aws.amazon.com/whitepapers/latest/aws-fault-isolation-boundaries/partitions.html), etc.) - * [References to other GitHub issues](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#referencing-issues-and-pull-requests) - * Links to external references such as AWS or other vendor documentation, third party articles, etc. + [Information about referencing Github Issues](https://help.github.com/articles/basic-writing-and-formatting-syntax/#referencing-issues-and-pull-requests) validations: required: false @@ -167,13 +170,9 @@ body: attributes: label: Would you like to implement a fix? description: | - Indicate to the maintainers and community as to whether you plan to implement a fix for this (you can update this later if you change your mind). This helps prevent duplication of effort, as many of our contributors look for recently filed issues as a source for their next contribution. - - If this would be your first contribution, refer to the [contributor guide](https://hashicorp.github.io/terraform-provider-aws/) for tips on getting started. + If you plan to implement a fix for this, check this box to let the maintainers and community know (you can update this later if you change your mind). If this would be your first contribution, refer to the [contribution guide](https://hashicorp.github.io/terraform-provider-aws/) for tips on getting started. options: - "No" - "Yes" - multiple: false - default: 0 validations: required: false diff --git a/.github/ISSUE_TEMPLATE/01_documentation.yml b/.github/ISSUE_TEMPLATE/01_documentation.yml index e485640818e1..c07e67fe0232 100644 --- a/.github/ISSUE_TEMPLATE/01_documentation.yml +++ b/.github/ISSUE_TEMPLATE/01_documentation.yml @@ -1,23 +1,22 @@ -name: Report a Documentation Error -description: Choose this option if you've found an error in the provider documentation or contributor guides. -labels: - - documentation +name: "Report a Documentation Error" +description: "Choose this option if you've found an error in the provider documentation or contribution guides." +title: "[Docs]: " +labels: ["documentation"] body: - type: markdown attributes: value: | - ## Thank you for raising a documentation issue! + # Thank you for raising a documentation issue! - This form is meant to alert the maintainers to issues with the provider documentation found on the [Terraform Registry](https://registry.terraform.io/providers/hashicorp/aws/latest) (such as resource and data source documentation, guides, and examples), or the [contributors guide](https://hashicorp.github.io/terraform-provider-aws/). + This form is meant to alert the maintainers to an issue with the provider documentation found on the [Terraform Registry](https://registry.terraform.io/providers/hashicorp/aws/latest) (such as resource and data source documentation, guides and examples), as well as the [contribution guide](https://hashicorp.github.io/terraform-provider-aws/). - We ask that you first [search existing issues and pull requests](https://github.com/hashicorp/terraform-provider-aws/issues?q=label%3Adocumentation) to see if someone else may have already noticed the same issue or has already submitted a fix for it. + Documentation edits are generally a bit less involved, so are often a great entrypoint if you've ever been interested in [contributing](https://hashicorp.github.io/terraform-provider-aws/documentation-changes/)! - - type: textarea + - type: input id: registry_link attributes: - label: Documentation Link(s) - description: | - Please link to the affected page(s) on the Terraform Registry or contributors guide. + label: Documentation Link + description: Please provide a link to the affected page on the Terraform Registry or contribution guide. validations: required: true @@ -25,8 +24,7 @@ body: id: description attributes: label: Description - description: | - Please leave a brief description of the documentation issue(s), including what the documentation currently says and, if possible, what it should say. + description: Please leave a brief description of the documentation issue. validations: required: true @@ -35,7 +33,7 @@ body: attributes: label: References description: | - Where possible, please supply links to AWS documentation and/or other GitHub issues or pull requests that give additional context. + Where possible, please supply links to vendor documentation, other GitHub issues (open or closed) or pull requests that give additional context. [Information about referencing Github Issues](https://help.github.com/articles/basic-writing-and-formatting-syntax/#referencing-issues-and-pull-requests) validations: @@ -46,13 +44,9 @@ body: attributes: label: Would you like to implement a fix? description: | - Indicate to the maintainers and community as to whether you plan to implement a fix for this (you can update this later if you change your mind). This helps prevent duplication of effort, as many of our contributors look for recently filed issues as a source for their next contribution. - - Documentation edits are generally a bit less involved, so are often a great entrypoint if you've ever been interested in contributing. If this would be your first contribution, refer to the [contributor guide](https://hashicorp.github.io/terraform-provider-aws/documentation-changes/) for tips on getting started. + If you plan to implement a fix for this, check this box to let the maintainers and community know (you can update this later if you change your mind). If this would be your first contribution, refer to the [contribution guide](https://hashicorp.github.io/terraform-provider-aws/) for tips on getting started. options: - "No" - "Yes" - multiple: false - default: 0 validations: required: false diff --git a/.github/ISSUE_TEMPLATE/02_enhancement.yml b/.github/ISSUE_TEMPLATE/02_enhancement.yml index d62b0d5fd087..b3c54c397866 100644 --- a/.github/ISSUE_TEMPLATE/02_enhancement.yml +++ b/.github/ISSUE_TEMPLATE/02_enhancement.yml @@ -1,38 +1,30 @@ -name: Request an Enhancement -description: Choose this option when you would like to request an enhancement to an existing resource or data source (such as the addition of new arguments), or to the provider itself. -labels: - - enhancement +name: "Request an Enhancement" +description: "Choose this option when you would like to request an enhancement to an existing resource, data source, or the provider itself." +title: "[Enhancement]: " +labels: ["enhancement"] body: - type: markdown attributes: value: | - ## Thank you for opening an enhancement request! + # Thank you for opening an enhancement request! This form is intended as a way to request additional functionality for existing resources, data sources, or the provider itself. This may include requests such as adding additional arguments or attributes enabled by upstream API changes, additional validation for arguments, etc. - Before submitting an enhancement request, we ask that you first [search existing issues and pull requests](https://github.com/hashicorp/terraform-provider-aws/issues?q=label%3Aenhancement) to see if someone else has made a similar request or has already worked on adding the feature. This helps to keep all relevant discussions in one place. - - > [!NOTE] - > If the absense of the requested feature is causing unexpected behavior in the provider, the [Report a Bug](https://github.com/hashicorp/terraform-provider-aws/issues/new?template=00_bug_report.yml) form should be used. For entirely new resources, data sources, or services, please use the [Request Net New Functionality](https://github.com/hashicorp/terraform-provider-aws/issues/new?template=03_new_functionality.yml) form. + If the absense of the requested feature is causing unexpected behavior in the provider, the "Report a Bug" form should be used. For entirely new resources, data sources, or services, please use the Request a "New Resource, Data Source, or AWS Service" form. - type: textarea id: description attributes: label: Description - description: | - Please provide a brief description of the requested change. + description: Please leave a brief description of the requested change. validations: required: true - type: textarea - id: affected_resource + id: affected attributes: - label: Affected Resource(s) or Data Source(s) - description: | - Where applicable, please list the resource(s) and/or data source(s) that you're requesting to be enhanced. - placeholder: | - * `aws_example_resource` - * `aws_example_data_source` + label: Affected Resource(s) and/or Data Source(s) + placeholder: "* aws_xxx_yyy" validations: required: false @@ -43,11 +35,8 @@ body: description: | If this request was implemented, what might the Terraform configuration look like? A best guess is helpful, even if you're unsure of exactly what the end result will look like. This helps maintainers and the community better understand how you (someone who is in need of this feature) envisions it. - For convenience, we pre-populate this section with a [code fence](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks) to help with formatting in the resulting issue. Configurations pasted between the backticks (\```) will have the appropriate syntax highlighting for HCL. Where appropriate, feel free to delete this. - value: | - ```hcl - - ``` + **Note:** This field will render in HCL, so there is no need to add a [code fence](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks). + render: terraform validations: required: false @@ -56,7 +45,7 @@ body: attributes: label: References description: | - Where possible, please supply links to the [AWS Go SDK v2](https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service) documentation demonstrating that the SDK supports the requested feature. Other links, such as those to the AWS API or CLI documentation, or other GitHub issues or pull requests that give additional context are also helpful. + Where possible, please supply links to vendor documentation, other GitHub issues (open or closed) or pull requests that give additional context. [Information about referencing Github Issues](https://help.github.com/articles/basic-writing-and-formatting-syntax/#referencing-issues-and-pull-requests) validations: @@ -65,15 +54,11 @@ body: - type: dropdown id: will_contribute attributes: - label: Would you like to implement the enhancement? + label: Would you like to implement a fix? description: | - Indicate to the maintainers and community as to whether you plan to implement the enhancement yourself (you can update this later if you change your mind). This helps prevent duplication of effort, as many of our contributors look for recently filed issues as a source for their next contribution. - - If this would be your first contribution, refer to the [contributor guide](https://hashicorp.github.io/terraform-provider-aws/) for tips on getting started. + If you plan to implement a fix for this, check this box to let the maintainers and community know (you can update this later if you change your mind). If this would be your first contribution, refer to the [contribution guide](https://hashicorp.github.io/terraform-provider-aws/) for tips on getting started. options: - "No" - "Yes" - multiple: false - default: 0 validations: required: false diff --git a/.github/ISSUE_TEMPLATE/03_new_functionality.yml b/.github/ISSUE_TEMPLATE/03_new_functionality.yml deleted file mode 100644 index 7578a071206f..000000000000 --- a/.github/ISSUE_TEMPLATE/03_new_functionality.yml +++ /dev/null @@ -1,77 +0,0 @@ -name: Request Net New Functionality -description: Choose this option to request an entirely new resource, data source, ephemeral resource/data source, function, or AWS service be added to the provider. -body: - - type: markdown - attributes: - value: | - ## Thank you for opening a request! - - This form is intended to be used when requesting an entirely new resource, data source, ephemeral resource/data source, function, or service be added to the provider. If you're looking for a change to be made to an existing resource or data source, please use the [Request an Enhancement](https://github.com/hashicorp/terraform-provider-aws/issues/new?template=02_enhancement.yml) form instead. If something isn't working as expected, the [Report a Bug](https://github.com/hashicorp/terraform-provider-aws/issues/new?template=00_bug_report.yml) form should be used. - - Before submitting a request, we ask that you first [search existing issues and pull requests](https://github.com/hashicorp/terraform-provider-aws/issues?q=label%3Anew-resource%2Cnew-data-source%2Cnew-function%2Cnew-ephemeral-resource%2Cnew-service%20) to see if someone else has made a similar request or has already worked on adding the feature. This helps to keep all relevant discussions in one place. - - - type: textarea - id: resources - attributes: - label: What new functionality are you requesting? - description: | - Please provide the name of the new functionality that you're requesting. For the sake of consistency, we ask that you use the following conventions: - - * Resource, Data Source (including ephemeral): `aws__`, e.g. `aws_lambda_function` - * Function: A clear, underscore-separated descriptor, e.g. `arn_parse` - * Service: The name of the service itself will suffice - placeholder: | - * `aws_xxx_yyy` - validations: - required: true - - - type: textarea - id: description - attributes: - label: Description - description: | - Please provide a brief description of what the new functionality will accomplish. For example, what upstream resource(s) could be managed by introducing these changes? - validations: - required: true - - - type: textarea - id: tf_config - attributes: - label: Potential Terraform Configuration - description: | - If this request was implemented, what might the Terraform configuration look like? A best guess is helpful, even if you're unsure of exactly what the end result will look like. This helps maintainers and the community better understand how you (someone who is in need of this feature) envisions it. - - For convenience, we pre-populate this section with a [code fence](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks) to help with formatting in the resulting issue. Configurations pasted between the backticks (\```) will have the appropriate syntax highlighting for HCL. Where appropriate, feel free to delete this. - value: | - ```hcl - - ``` - validations: - required: false - - - type: textarea - id: references - attributes: - label: References - description: | - Where possible, please supply links to the [AWS Go SDK v2](https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/service) documentation demonstrating that the SDK supports the requested feature. Other links, such as those to the AWS API or CLI documentation, or other GitHub issues or pull requests that give additional context are also helpful. - - [Information about referencing Github Issues](https://help.github.com/articles/basic-writing-and-formatting-syntax/#referencing-issues-and-pull-requests) - validations: - required: false - - - type: dropdown - id: will_contribute - attributes: - label: Would you like to implement the enhancement? - description: | - Indicate to the maintainers and community as to whether you plan to implement the new functionality yourself (you can update this later if you change your mind). This helps prevent duplication of effort, as many of our contributors look for recently filed issues as a source for their next contribution. - - If this would be your first contribution, refer to the [contributor guide](https://hashicorp.github.io/terraform-provider-aws/) for tips on getting started. - options: - - "No" - - "Yes" - multiple: false - default: 0 - validations: - required: false diff --git a/.github/ISSUE_TEMPLATE/03_new_resource.yml b/.github/ISSUE_TEMPLATE/03_new_resource.yml new file mode 100644 index 000000000000..44dfd3244e25 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/03_new_resource.yml @@ -0,0 +1,73 @@ +name: "Request a New Resource, Data Source, or AWS Service" +description: "Choose this option to request an entirely new resource, data source, or AWS service be added to the provider." +title: "[New]: " +body: + - type: markdown + attributes: + value: | + # Thank you for opening a request! + + This form is intended to be used when requesting an entirely new resource, data source, or service be added to the provider. If you're looking for a change to be made to an existing resource or data source, consider submitting either the "Request an Enhancement" or Report a Bug" forms instead. + + When possible, it's helpful to check the [AWS Go SDK](https://pkg.go.dev/github.com/aws/aws-sdk-go/service) or [AWS Go SDK v2](https://pkg.go.dev/github.com/aws/aws-sdk-go-v2#section-directories) to determine whether functionality exists to enable the requested feature. It is **not** required that you do this. Any references found when searching can be added to the "References" field below to give maintainers or the community a head start. + + Please update the title to match what you're requesting, e.g.: + + - `[New Resource]:` - for new resource requests + - `[New Data Source]:` - for new data source requests + - `[New Service]:` - for new AWS services + + - type: textarea + id: description + attributes: + label: Description + description: Please leave a brief description of what you're requesting. + validations: + required: true + + - type: textarea + id: resources + attributes: + label: Requested Resource(s) and/or Data Source(s) + description: | + Please list any new resource(s) and/or data source(s). The naming format is `aws__`, e.g., `aws_lambda_function`. + + A best guess is helpful, even if you're unsure of exactly what the end result will look like. This helps maintainers and the community better understand how you (someone who is in need of this request) envisions it. + placeholder: "* aws_xxx_yyy" + validations: + required: true + + - type: textarea + id: tf_config + attributes: + label: Potential Terraform Configuration + description: | + If this request was implemented, what might the Terraform configuration look like? Similar to above, a best guess is helpful, even if you're unsure of exactly what the end result will look like. + + **Note:** This field will render in HCL, so there is no need to add a [code fence](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks). + render: terraform + validations: + required: false + + - type: textarea + id: references + attributes: + label: References + description: | + Where possible, please supply links to vendor documentation, other GitHub issues (open or closed) or pull requests that give additional context. + + [Information about referencing Github Issues](https://help.github.com/articles/basic-writing-and-formatting-syntax/#referencing-issues-and-pull-requests) + validations: + required: false + + - type: dropdown + id: will_contribute + attributes: + label: Would you like to implement a fix? + description: | + If you plan to implement a fix for this, check this box to let the maintainers and community know (you can update this later if you change your mind). If this would be your first contribution, refer to the [contribution guide](https://hashicorp.github.io/terraform-provider-aws/) for tips on getting started. + options: + - "No" + - "Yes" + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/04_repository.yml b/.github/ISSUE_TEMPLATE/04_repository.yml index baf0c2c50716..5952b267804b 100644 --- a/.github/ISSUE_TEMPLATE/04_repository.yml +++ b/.github/ISSUE_TEMPLATE/04_repository.yml @@ -1,23 +1,20 @@ -name: Repository/Meta -description: Choose this option when reporting an issue that has to do with the repository itself, e.g. GitHub Actions workflows, labels, local development tools, etc. -labels: - - repository +name: "Repository/Meta" +description: Choose this option when the issue has to do with the repository itself, including GitHub Actions, labels, workflows, etc. +title: "[Repo]: " +labels: ["repository"] body: - type: markdown attributes: value: | - ## Thank you for opening an issue! + # Thank you for opening an issue! - This form is for issues pertaining to the repository itself. This might include issues or changes related to GitHub Actions, labels, local development tools, procedures for maintaining the provider, etc. For issues with the contribution documentation, please use the [Report a Documentation Error](https://github.com/hashicorp/terraform-provider-aws/issues/new?template=01_documentation.yml) form instead. - - Before submission, we ask that you first [search existing issues and pull requests](https://github.com/hashicorp/terraform-provider-aws/issues?q=label%3Arepository) to see if someone else has made a similar report or has alreaady worked on a relevant change. This helps to keep all relevant discussions in one place. + This form is for issues pertaining to the repository itself. This might include changes to GitHub Actions, labels, procedures, etc. For issues with the contribution documentation, please use the "Report a Documentation Error" form. - type: textarea id: description attributes: label: Description - description: | - Please provide a brief description of the issue or proposed change. + description: Please leave a brief description of the issue or proposed change. validations: required: true @@ -26,7 +23,7 @@ body: attributes: label: References description: | - Where possible, please supply links to documentation and/or other GitHub issues or pull requests that give additional context. + Where possible, please supply links to vendor documentation, other GitHub issues (open or closed) or pull requests that give additional context. [Information about referencing Github Issues](https://help.github.com/articles/basic-writing-and-formatting-syntax/#referencing-issues-and-pull-requests) validations: @@ -35,15 +32,11 @@ body: - type: dropdown id: will_contribute attributes: - label: Would you like to implement the change? + label: Would you like to implement a fix? description: | - Indicate to the maintainers and community as to whether you plan to implement the change or fix for this (you can update this later if you change your mind). This helps prevent duplication of effort, as many of our contributors look for recently filed issues as a source for their next contribution. - - If this would be your first contribution, refer to the [contributor guide](https://hashicorp.github.io/terraform-provider-aws/) for tips on getting started. + If you plan to implement a fix for this, check this box to let the maintainers and community know (you can update this later if you change your mind). If this would be your first contribution, refer to the [contribution guide](https://hashicorp.github.io/terraform-provider-aws/) for tips on getting started. options: - "No" - "Yes" - multiple: false - default: 0 validations: required: false diff --git a/.github/ISSUE_TEMPLATE/05_beta_feedback.yml b/.github/ISSUE_TEMPLATE/05_beta_feedback.yml deleted file mode 100644 index fb136969e155..000000000000 --- a/.github/ISSUE_TEMPLATE/05_beta_feedback.yml +++ /dev/null @@ -1,171 +0,0 @@ -name: Beta Release Feedback -description: Choose this option to provide feedback or report issues related to beta versions of the provider -labels: - - beta-feedback -body: - - type: markdown - attributes: - value: | - ## Thank you for providing feedback on our beta release! - - Before submission, we ask that you first [search existing issues](https://github.com/hashicorp/terraform-provider-aws/issues?q=is%3Aissue%20state%3Aopen%20label%3Abeta-feedback) to see if someone else may have experienced the same issue or provided similar feedback. This helps to keep all relevant information in one place, including any potential workarounds. - - ### A Note on Terraform Core Issues - - We ask that you consider whether an issues may be related to Terraform Core. If you're experiencing issues similar to the following examples, we recommend [opening an issue](https://github.com/hashicorp/terraform/issues/new/choose) in the Terraform Core repository instead: - - * [Configuration Language](https://developer.hashicorp.com/terraform/language) or resource ordering issues - * [State](https://developer.hashicorp.com/terraform/language/state) and [State Backend](https://developer.hashicorp.com/terraform/language/backend) issues - * [Provisioner](https://developer.hashicorp.com/terraform/language/resources/provisioners/syntax) issues - * [Registry](https://registry.terraform.io/) issues - * Issues that span resources across multiple providers - - - type: textarea - id: tf_version - attributes: - label: Terraform and AWS Provider Version - description: | - Please run `terraform --version` to collect the Terraform and AWS Provider versions and paste the result below. If multiple versions have been tested, feel free to add that additional information here as well. - placeholder: | - ...output of `terraform --version`... - render: console - validations: - required: true - - - type: textarea - id: affected_resource - attributes: - label: Affected Resource(s) or Data Source(s) - description: | - If applicable, please list the affected resource(s) and/or data source(s). - placeholder: | - * `aws_example_resource` - * `aws_example_data_source` - validations: - required: false - - - type: textarea - id: expected_behavior - attributes: - label: Expected Behavior - description: | - When reporting an issue with a beta release, use this section to describe what behavior should have happened that isn't currently. Note that there is a section later in the template for providing a sample configuration, so a short description is all that's necessary here. - - When providing more general feedback, use this section to describe that feedback. - validations: - required: true - - - type: textarea - id: actual_behavior - attributes: - label: Actual Behavior - description: | - If the current behavior differs from the behavior outlined in the Expected Behavior section, use this section to provide those details. - - When providing more general feedback, where this section may not be relevent, feel free to enter "n/a" to satisfy this being a required field. - validations: - required: true - - - type: textarea - id: log_snippet - attributes: - label: Relevant Error/Panic Output - description: | - If applicable, provide a snippet of output logging that contains the error or panic. Note that there is a section later in the template for providing more complete debug output, so a small snippet is all that's necessary here. - - For convenience, we pre-populate this section with a [code fence](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks) to help with formatting in the resulting issue. Placing the log output between the sets of backticks (\```) will result in a well-formatted issue. - value: | - ```console - - ``` - validations: - required: false - - - type: markdown - attributes: - value: | - ## Providing Configurations and Logging - - When providing a reproduction configuration and/or debug logging, please paste, upload, or link to a file or [public Gist](https://docs.github.com/en/get-started/writing-on-github/editing-and-sharing-content-with-gists/creating-gists) containing the relevant information. Files under 25MB may be [attached directly](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/attaching-files) in the relevant field. Files larger than this should be uploaded to a file hosting service and a link shared. For your security you can also encrypt the files using our [GPG public key](https://keybase.io/hashicorp). - - Configurations should be applyable with minimal modifications, and should not rely on external modules. This helps maintainers and contributors efficiently reproduce issues and implement acceptance tests to prevent future regressions. - - > [!WARNING] - > Bug reports without a functional and standalone sample configuration may be closed without further investigation. - - - type: textarea - id: tf_config - attributes: - label: Sample Terraform Configuration - description: | - Please provide a sample Terraform configuration that can be used to reproduce the issue. - - For convenience, we pre-populate this section such that configurations pasted between the backticks (\```) will be contained within a disclosure triangle in the resulting issue. Where appropriate, feel free to delete this. - - When providing more general feedback, where this section may not be relevent, feel free to clear out the pre-populated text and enter "n/a" to satisfy this being a required field. - value: | -
- Click to expand configuration - - ```hcl - - ``` -
- validations: - required: true - - - type: textarea - id: reproduction_steps - attributes: - label: Steps to Reproduce - description: | - If applicable, please list the steps to reproduce the issue. - placeholder: | - 1. Apply the configuration - 2. Make a change - 3. etc. - validations: - required: false - - - type: textarea - id: extended_logs - attributes: - label: Debug Logging - description: | - Where possible and applicable, please provide log output captured while reproducing the issue with [debug logging enabled](https://developer.hashicorp.com/terraform/internals/debugging). If a panic is produced, that information should be included. - - For convenience, we pre-populate this section such that logs pasted between the backticks (\```) will be contained within a disclosure triangle in the resulting issue. - - When providing more general feedback, where this section may not be relevent, feel free to clear out the pre-populated text and enter "n/a" to satisfy this being a required field. - value: | -
- Click to expand log output - - ```console - - ``` -
- validations: - required: false - - - type: textarea - id: genai_llm - attributes: - label: GenAI / LLM Assisted Development - description: | - If you used a generative AI / LLM tool to assist in the development of your config, please let us know which tool you used here. - value: n/a - validations: - required: false - - - type: textarea - attributes: - label: Important Facts and References - description: | - If there is any additional information that might be relevant, provide those details here. This might include information such as, but not limited to: - - * Any atypical situations that might apply (airgapped environments, specific [AWS partitions](https://docs.aws.amazon.com/whitepapers/latest/aws-fault-isolation-boundaries/partitions.html), etc.) - * [References to other GitHub issues](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#referencing-issues-and-pull-requests) - * Links to external references such as AWS or other vendor documentation, third party articles, etc. - validations: - required: false diff --git a/.github/ISSUE_TEMPLATE/05_other.yml b/.github/ISSUE_TEMPLATE/05_other.yml new file mode 100644 index 000000000000..8eafc99eb11e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/05_other.yml @@ -0,0 +1,48 @@ +name: "Other" +description: "Choose this option if your issue does not fit the description of the others." +body: + - type: markdown + attributes: + value: | + # Thank you for raising an issue! + + This form is meant as a catch-all for issues that do not fit into one of the other existing forms: + + * Report a Bug + * Report a Documentation Error + * Request an Enhancement + * Request a New Resource, Data Source, or AWS Service + * Repository/Meta + + By nature this form is less rigid, so providing a bit of additional information, context, or reference material is very much appreciated. + + - type: textarea + id: description + attributes: + label: Description + description: Please leave a detailed description of the issue. + validations: + required: true + + - type: textarea + id: references + attributes: + label: References + description: | + Where possible, please supply links to vendor documentation, other GitHub issues (open or closed) or pull requests that give additional context. + + [Information about referencing Github Issues](https://help.github.com/articles/basic-writing-and-formatting-syntax/#referencing-issues-and-pull-requests) + validations: + required: false + + - type: dropdown + id: will_contribute + attributes: + label: Would you like to implement a fix? + description: | + If you plan to implement a fix for this, check this box to let the maintainers and community know (you can update this later if you change your mind). If this would be your first contribution, refer to the [contribution guide](https://hashicorp.github.io/terraform-provider-aws/) for tips on getting started. + options: + - "No" + - "Yes" + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/06_other.yml b/.github/ISSUE_TEMPLATE/06_other.yml deleted file mode 100644 index ff014f211297..000000000000 --- a/.github/ISSUE_TEMPLATE/06_other.yml +++ /dev/null @@ -1,47 +0,0 @@ -name: Other -description: Choose this option if your issue does not fit any of the other forms. -body: - - type: markdown - attributes: - value: | - ## Thank you for raising an issue! - - This form is meant as a catch-all for issues that do not fit into one of the other existing forms. By nature this form is much more freeform, so providing a bit of additional information, context, or reference material is very much appreciated. - - Before submission, we ask that you first [search existing issues and pull requests](https://github.com/hashicorp/terraform-provider-aws/issues?q=is%3Aissue%20is%3Apr%20) to see if someone else may have already noticed whatever it is you're reporting, or has already worked on a relevant change. - - - type: textarea - id: description - attributes: - label: Description - description: | - Please provide a brief description of what you're looking to report to the maintainers. - validations: - required: true - - - type: textarea - id: references - attributes: - label: Important Facts and References - description: | - Where possible, please supply links to documentation and/or other GitHub issues or pull requests that give additional context. Any other helpful or relevant information may also be provided in this field. - - [Information about referencing Github Issues](https://help.github.com/articles/basic-writing-and-formatting-syntax/#referencing-issues-and-pull-requests) - validations: - required: false - - - type: dropdown - id: will_contribute - attributes: - label: Would you like to implement a relevant change? - description: | - Indicate to the maintainers and community as to whether you plan to implement a change related to this (you can update this later if you change your mind). This helps prevent duplication of effort, as many of our contributors look for recently filed issues as a source for their next contribution. - - If this would be your first contribution, refer to the [contributor guide](https://hashicorp.github.io/terraform-provider-aws/) for tips on getting started. - options: - - "No" - - "Yes" - multiple: false - default: 0 - validations: - required: false diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index eea4817d0ec4..5487b0d90d32 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,17 +1,6 @@ - - - -## Rollback Plan - -If a change needs to be reverted, we will publish an updated version of the library. - -## Changes to Security Controls - -Are there any changes to security controls (access controls, encryption, logging) in this pull request? If so, explain. - ### Description + + + + + + + MIICfjCCAeegAwIBAgIBADANBgkqhkiG9w0BAQ0FADBbMQswCQYDVQQGEwJ1czELMAkGA1UECAwCQ0ExEjAQBgNVBAoMCVRlcnJhZm9ybTErMCkGA1UEAwwidGVycmFmb3JtLWRldi1lZC5teS5zYWxlc2ZvcmNlLmNvbTAgFw0yMDA4MjkxNDQ4MzlaGA8yMDcwMDgxNzE0NDgzOVowWzELMAkGA1UEBhMCdXMxCzAJBgNVBAgMAkNBMRIwEAYDVQQKDAlUZXJyYWZvcm0xKzApBgNVBAMMInRlcnJhZm9ybS1kZXYtZWQubXkuc2FsZXNmb3JjZS5jb20wgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAOxUTzEKdivVjfZ/BERGpX/ZWQsBKHut17dQTKW/3jox1N9EJ3ULj9qEDen6zQ74Ce8hSEkrG7MP9mcP1oEhQZSca5tTAop1GejJG+bfF4v6cXM9pqHlllrYrmXMfESiahqhBhE8VvoGJkvp393TcB1lX+WxO8Q74demTrQn5tgvAgMBAAGjUDBOMB0GA1UdDgQWBBREKZt4Av70WKQE4aLD2tvbSLnBlzAfBgNVHSMEGDAWgBREKZt4Av70WKQE4aLD2tvbSLnBlzAMBgNVHRMEBTADAQH/MA0GCSqGSIb3DQEBDQUAA4GBACxeC29WMGqeOlQF4JWwsYwIC82SUaZvMDqjAm9ieIrAZRH6J6Cu40c/rvsUGUjQ9logKX15RAyI7Rn0jBUgopRkNL71HyyM7ug4qN5An05VmKQWIbVfxkNVB2Ipb/ICMc5UE38G4y4VbANZFvbFbkVq6OAP2GGNl22o/XSnhFY8 + + + + urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified + + + + diff --git a/internal/service/workspacesweb/trust_store.go b/internal/service/workspacesweb/trust_store.go new file mode 100644 index 000000000000..c26449c7af76 --- /dev/null +++ b/internal/service/workspacesweb/trust_store.go @@ -0,0 +1,432 @@ +// Copyright (c) HashiCorp, Inc. +// SPDX-License-Identifier: MPL-2.0 + +package workspacesweb + +import ( + "context" + "encoding/base64" + "fmt" + "strings" + "time" + + "github.com/aws/aws-sdk-go-v2/aws" + "github.com/aws/aws-sdk-go-v2/service/workspacesweb" + awstypes "github.com/aws/aws-sdk-go-v2/service/workspacesweb/types" + "github.com/hashicorp/terraform-plugin-framework-validators/setvalidator" + "github.com/hashicorp/terraform-plugin-framework/diag" + "github.com/hashicorp/terraform-plugin-framework/path" + "github.com/hashicorp/terraform-plugin-framework/resource" + "github.com/hashicorp/terraform-plugin-framework/resource/schema" + "github.com/hashicorp/terraform-plugin-framework/resource/schema/listplanmodifier" + "github.com/hashicorp/terraform-plugin-framework/resource/schema/planmodifier" + "github.com/hashicorp/terraform-plugin-framework/resource/schema/setplanmodifier" + "github.com/hashicorp/terraform-plugin-framework/resource/schema/stringplanmodifier" + "github.com/hashicorp/terraform-plugin-framework/schema/validator" + "github.com/hashicorp/terraform-plugin-framework/tfsdk" + "github.com/hashicorp/terraform-plugin-framework/types" + sdkid "github.com/hashicorp/terraform-plugin-sdk/v2/helper/id" + "github.com/hashicorp/terraform-plugin-sdk/v2/helper/retry" + "github.com/hashicorp/terraform-provider-aws/internal/errs" + "github.com/hashicorp/terraform-provider-aws/internal/errs/fwdiag" + "github.com/hashicorp/terraform-provider-aws/internal/framework" + fwflex "github.com/hashicorp/terraform-provider-aws/internal/framework/flex" + fwtypes "github.com/hashicorp/terraform-provider-aws/internal/framework/types" + tftags "github.com/hashicorp/terraform-provider-aws/internal/tags" + "github.com/hashicorp/terraform-provider-aws/internal/tfresource" + "github.com/hashicorp/terraform-provider-aws/names" +) + +// @FrameworkResource("aws_workspacesweb_trust_store", name="Trust Store") +// @Tags(identifierAttribute="trust_store_arn") +// @Testing(tagsTest=true) +// @Testing(generator=false) +// @Testing(existsType="github.com/aws/aws-sdk-go-v2/service/workspacesweb/types;types.TrustStore") +// @Testing(importStateIdAttribute="trust_store_arn") +// @Testing(importIgnore="certificate_list") +func newTrustStoreResource(_ context.Context) (resource.ResourceWithConfigure, error) { + return &trustStoreResource{}, nil +} + +type trustStoreResource struct { + framework.ResourceWithModel[trustStoreResourceModel] +} + +func (r *trustStoreResource) Schema(ctx context.Context, request resource.SchemaRequest, response *resource.SchemaResponse) { + response.Schema = schema.Schema{ + Attributes: map[string]schema.Attribute{ + "associated_portal_arns": schema.ListAttribute{ + CustomType: fwtypes.ListOfStringType, + ElementType: types.StringType, + Computed: true, + PlanModifiers: []planmodifier.List{ + listplanmodifier.UseStateForUnknown(), + }, + }, + names.AttrTags: tftags.TagsAttribute(), + names.AttrTagsAll: tftags.TagsAttributeComputedOnly(), + "trust_store_arn": schema.StringAttribute{ + Computed: true, + PlanModifiers: []planmodifier.String{ + stringplanmodifier.UseStateForUnknown(), + }, + }, + }, + Blocks: map[string]schema.Block{ + names.AttrCertificate: schema.SetNestedBlock{ + CustomType: fwtypes.NewSetNestedObjectTypeOf[certificateModel](ctx), + Validators: []validator.Set{ + setvalidator.SizeAtLeast(0), + }, + PlanModifiers: []planmodifier.Set{ + setplanmodifier.UseStateForUnknown(), + }, + NestedObject: schema.NestedBlockObject{ + Attributes: map[string]schema.Attribute{ + "body": schema.StringAttribute{ + Required: true, + }, + names.AttrIssuer: schema.StringAttribute{ + Computed: true, + }, + "not_valid_after": schema.StringAttribute{ + Computed: true, + }, + "not_valid_before": schema.StringAttribute{ + Computed: true, + }, + "subject": schema.StringAttribute{ + Computed: true, + }, + "thumbprint": schema.StringAttribute{ + Computed: true, + }, + }, + }, + }, + }, + } +} + +func (r *trustStoreResource) Create(ctx context.Context, request resource.CreateRequest, response *resource.CreateResponse) { + var data trustStoreResourceModel + response.Diagnostics.Append(request.Plan.Get(ctx, &data)...) + if response.Diagnostics.HasError() { + return + } + + conn := r.Meta().WorkSpacesWebClient(ctx) + + input := workspacesweb.CreateTrustStoreInput{ + ClientToken: aws.String(sdkid.UniqueId()), + Tags: getTagsIn(ctx), + } + + // Convert string certificates to byte slices + for _, certificate := range data.Certificates.Elements() { + var cert certificateModel + response.Diagnostics.Append(tfsdk.ValueAs(ctx, certificate, &cert)...) + if response.Diagnostics.HasError() { + return + } + + formattedCert := strings.ReplaceAll(strings.Trim(cert.Body.ValueString(), "\""), `\n`, "\n") + input.CertificateList = append(input.CertificateList, []byte(formattedCert)) + } + + output, err := conn.CreateTrustStore(ctx, &input) + + if err != nil { + response.Diagnostics.AddError("creating WorkSpacesWeb Trust Store", err.Error()) + return + } + + data.TrustStoreARN = fwflex.StringToFramework(ctx, output.TrustStoreArn) + + // Get the trust store details to populate other fields + trustStore, err := findTrustStoreByARN(ctx, conn, data.TrustStoreARN.ValueString()) + if err != nil { + response.Diagnostics.AddError(fmt.Sprintf("reading WorkSpacesWeb Trust Store (%s)", data.TrustStoreARN.ValueString()), err.Error()) + return + } + + response.Diagnostics.Append(fwflex.Flatten(ctx, trustStore, &data)...) + if response.Diagnostics.HasError() { + return + } + + // Populate certificate details + certificates, err := listTrustStoreCertificates(ctx, conn, data.TrustStoreARN.ValueString()) + if err != nil { + response.Diagnostics.AddError(fmt.Sprintf("listing WorkSpacesWeb Trust Store Certificates (%s)", data.TrustStoreARN.ValueString()), err.Error()) + return + } + + var diags diag.Diagnostics + data.Certificates, diags = fwtypes.NewSetNestedObjectValueOfValueSlice(ctx, certificates) + response.Diagnostics.Append(diags...) + if response.Diagnostics.HasError() { + return + } + + response.Diagnostics.Append(response.State.Set(ctx, data)...) +} + +func (r *trustStoreResource) Read(ctx context.Context, request resource.ReadRequest, response *resource.ReadResponse) { + var data trustStoreResourceModel + response.Diagnostics.Append(request.State.Get(ctx, &data)...) + if response.Diagnostics.HasError() { + return + } + + conn := r.Meta().WorkSpacesWebClient(ctx) + + output, err := findTrustStoreByARN(ctx, conn, data.TrustStoreARN.ValueString()) + if tfresource.NotFound(err) { + response.Diagnostics.Append(fwdiag.NewResourceNotFoundWarningDiagnostic(err)) + response.State.RemoveResource(ctx) + return + } + + if err != nil { + response.Diagnostics.AddError(fmt.Sprintf("reading WorkSpacesWeb Trust Store (%s)", data.TrustStoreARN.ValueString()), err.Error()) + return + } + + response.Diagnostics.Append(fwflex.Flatten(ctx, output, &data)...) + if response.Diagnostics.HasError() { + return + } + + // Populate certificate details by merging existing state with computed values + certificates, err := listTrustStoreCertificates(ctx, conn, data.TrustStoreARN.ValueString()) + if err != nil { + response.Diagnostics.AddError(fmt.Sprintf("listing WorkSpacesWeb Trust Store Certificates (%s)", data.TrustStoreARN.ValueString()), err.Error()) + return + } + + var diags diag.Diagnostics + data.Certificates, diags = fwtypes.NewSetNestedObjectValueOfValueSlice(ctx, certificates) + response.Diagnostics.Append(diags...) + if response.Diagnostics.HasError() { + return + } + + response.Diagnostics.Append(response.State.Set(ctx, &data)...) +} + +func (r *trustStoreResource) Update(ctx context.Context, request resource.UpdateRequest, response *resource.UpdateResponse) { + var new, old trustStoreResourceModel + response.Diagnostics.Append(request.Plan.Get(ctx, &new)...) + if response.Diagnostics.HasError() { + return + } + response.Diagnostics.Append(request.State.Get(ctx, &old)...) + if response.Diagnostics.HasError() { + return + } + + conn := r.Meta().WorkSpacesWebClient(ctx) + + if !new.Certificates.Equal(old.Certificates) { + input := workspacesweb.UpdateTrustStoreInput{ + ClientToken: aws.String(sdkid.UniqueId()), + TrustStoreArn: new.TrustStoreARN.ValueStringPointer(), + } + + // Handle certificate additions and deletions + oldCerts := make(map[string]string) // cert content -> thumbprint + for _, certificate := range old.Certificates.Elements() { + var cert certificateModel + response.Diagnostics.Append(tfsdk.ValueAs(ctx, certificate, &cert)...) + if response.Diagnostics.HasError() { + return + } + + oldCerts[base64.StdEncoding.EncodeToString([]byte(cert.Body.ValueString()))] = cert.Thumbprint.ValueString() + } + + newCertContents := make(map[string]bool) + for _, certificate := range new.Certificates.Elements() { + var cert certificateModel + response.Diagnostics.Append(tfsdk.ValueAs(ctx, certificate, &cert)...) + if response.Diagnostics.HasError() { + return + } + + formattedCert := strings.ReplaceAll(strings.Trim(cert.Body.ValueString(), "\""), `\n`, "\n") + newCertContents[base64.StdEncoding.EncodeToString([]byte(formattedCert))] = true + } + + // Find certificates to add + for _, certificate := range new.Certificates.Elements() { + var cert certificateModel + response.Diagnostics.Append(tfsdk.ValueAs(ctx, certificate, &cert)...) + if response.Diagnostics.HasError() { + return + } + + formattedCert := strings.ReplaceAll(strings.Trim(cert.Body.String(), "\""), `\n`, "\n") + certEncoded := base64.StdEncoding.EncodeToString([]byte(formattedCert)) + if _, exists := oldCerts[certEncoded]; !exists { + input.CertificatesToAdd = append(input.CertificatesToAdd, []byte(formattedCert)) + } + } + + // Find certificates to delete (by thumbprint) + for certEncoded, thumbprint := range oldCerts { + if !newCertContents[certEncoded] { + input.CertificatesToDelete = append(input.CertificatesToDelete, thumbprint) + } + } + + _, err := conn.UpdateTrustStore(ctx, &input) + + if err != nil { + response.Diagnostics.AddError(fmt.Sprintf("updating WorkSpacesWeb Trust Store (%s)", new.TrustStoreARN.ValueString()), err.Error()) + return + } + } + + // Read the updated state to get computed values + updatedTrustStore, err := findTrustStoreByARN(ctx, conn, new.TrustStoreARN.ValueString()) + if err != nil { + response.Diagnostics.AddError(fmt.Sprintf("reading WorkSpacesWeb Trust Store (%s) after update", new.TrustStoreARN.ValueString()), err.Error()) + return + } + + response.Diagnostics.Append(fwflex.Flatten(ctx, updatedTrustStore, &new)...) + if response.Diagnostics.HasError() { + return + } + + // Populate certificate details by merging planned data with computed values + certificates, err := listTrustStoreCertificates(ctx, conn, new.TrustStoreARN.ValueString()) + if err != nil { + response.Diagnostics.AddError(fmt.Sprintf("listing WorkSpacesWeb Trust Store Certificates (%s) after update", new.TrustStoreARN.ValueString()), err.Error()) + return + } + + var diags diag.Diagnostics + new.Certificates, diags = fwtypes.NewSetNestedObjectValueOfValueSlice(ctx, certificates) + response.Diagnostics.Append(diags...) + if response.Diagnostics.HasError() { + return + } + + response.Diagnostics.Append(response.State.Set(ctx, &new)...) +} + +func (r *trustStoreResource) Delete(ctx context.Context, request resource.DeleteRequest, response *resource.DeleteResponse) { + var data trustStoreResourceModel + response.Diagnostics.Append(request.State.Get(ctx, &data)...) + if response.Diagnostics.HasError() { + return + } + + conn := r.Meta().WorkSpacesWebClient(ctx) + + input := workspacesweb.DeleteTrustStoreInput{ + TrustStoreArn: data.TrustStoreARN.ValueStringPointer(), + } + _, err := conn.DeleteTrustStore(ctx, &input) + + if errs.IsA[*awstypes.ResourceNotFoundException](err) { + return + } + + if err != nil { + response.Diagnostics.AddError(fmt.Sprintf("deleting WorkSpacesWeb Trust Store (%s)", data.TrustStoreARN.ValueString()), err.Error()) + return + } +} + +func (r *trustStoreResource) ImportState(ctx context.Context, request resource.ImportStateRequest, response *resource.ImportStateResponse) { + resource.ImportStatePassthroughID(ctx, path.Root("trust_store_arn"), request, response) +} + +func findTrustStoreByARN(ctx context.Context, conn *workspacesweb.Client, arn string) (*awstypes.TrustStore, error) { + input := workspacesweb.GetTrustStoreInput{ + TrustStoreArn: aws.String(arn), + } + output, err := conn.GetTrustStore(ctx, &input) + + if errs.IsA[*awstypes.ResourceNotFoundException](err) { + return nil, &retry.NotFoundError{ + LastError: err, + LastRequest: input, + } + } + + if err != nil { + return nil, err + } + + if output == nil || output.TrustStore == nil { + return nil, tfresource.NewEmptyResultError(input) + } + + return output.TrustStore, nil +} + +func listTrustStoreCertificates(ctx context.Context, conn *workspacesweb.Client, arn string) ([]certificateModel, error) { + input := workspacesweb.ListTrustStoreCertificatesInput{ + TrustStoreArn: aws.String(arn), + } + + var certificates []certificateModel + pages := workspacesweb.NewListTrustStoreCertificatesPaginator(conn, &input) + for pages.HasMorePages() { + output, err := pages.NextPage(ctx) + + if err != nil { + return nil, err + } + + for _, certSummary := range output.CertificateList { + // Get detailed certificate information + input := workspacesweb.GetTrustStoreCertificateInput{ + Thumbprint: certSummary.Thumbprint, + TrustStoreArn: aws.String(arn), + } + + output, err := conn.GetTrustStoreCertificate(ctx, &input) + + if err != nil { + return nil, err + } + + if output.Certificate != nil { + cert := certificateModel{ + Body: types.StringValue(string(output.Certificate.Body)), + Issuer: types.StringPointerValue(output.Certificate.Issuer), + NotValidAfter: types.StringValue(aws.ToTime(output.Certificate.NotValidAfter).Format(time.RFC3339)), + NotValidBefore: types.StringValue(aws.ToTime(output.Certificate.NotValidBefore).Format(time.RFC3339)), + Subject: types.StringPointerValue(output.Certificate.Subject), + Thumbprint: types.StringPointerValue(output.Certificate.Thumbprint), + } + certificates = append(certificates, cert) + } + } + } + + return certificates, nil +} + +type trustStoreResourceModel struct { + framework.WithRegionModel + AssociatedPortalARNs fwtypes.ListOfString `tfsdk:"associated_portal_arns"` + Certificates fwtypes.SetNestedObjectValueOf[certificateModel] `tfsdk:"certificate"` + Tags tftags.Map `tfsdk:"tags"` + TagsAll tftags.Map `tfsdk:"tags_all"` + TrustStoreARN types.String `tfsdk:"trust_store_arn"` +} + +type certificateModel struct { + Body types.String `tfsdk:"body"` + Issuer types.String `tfsdk:"issuer"` + NotValidAfter types.String `tfsdk:"not_valid_after"` + NotValidBefore types.String `tfsdk:"not_valid_before"` + Subject types.String `tfsdk:"subject"` + Thumbprint types.String `tfsdk:"thumbprint"` +} diff --git a/internal/service/workspacesweb/trust_store_association.go b/internal/service/workspacesweb/trust_store_association.go new file mode 100644 index 000000000000..fda6773b7890 --- /dev/null +++ b/internal/service/workspacesweb/trust_store_association.go @@ -0,0 +1,164 @@ +// Copyright (c) HashiCorp, Inc. +// SPDX-License-Identifier: MPL-2.0 + +package workspacesweb + +import ( + "context" + "fmt" + "slices" + + "github.com/aws/aws-sdk-go-v2/service/workspacesweb" + awstypes "github.com/aws/aws-sdk-go-v2/service/workspacesweb/types" + "github.com/hashicorp/terraform-plugin-framework/path" + "github.com/hashicorp/terraform-plugin-framework/resource" + "github.com/hashicorp/terraform-plugin-framework/resource/schema" + "github.com/hashicorp/terraform-plugin-framework/resource/schema/planmodifier" + "github.com/hashicorp/terraform-plugin-framework/resource/schema/stringplanmodifier" + "github.com/hashicorp/terraform-provider-aws/internal/errs" + "github.com/hashicorp/terraform-provider-aws/internal/errs/fwdiag" + intflex "github.com/hashicorp/terraform-provider-aws/internal/flex" + "github.com/hashicorp/terraform-provider-aws/internal/framework" + fwtypes "github.com/hashicorp/terraform-provider-aws/internal/framework/types" + tfretry "github.com/hashicorp/terraform-provider-aws/internal/retry" +) + +// @FrameworkResource("aws_workspacesweb_trust_store_association", name="Trust Store Association") +// @Testing(tagsTest=false) +// @Testing(existsType="github.com/aws/aws-sdk-go-v2/service/workspacesweb/types;types.TrustStore") +// @Testing(importStateIdAttribute="trust_store_arn,portal_arn") +func newTrustStoreAssociationResource(_ context.Context) (resource.ResourceWithConfigure, error) { + return &trustStoreAssociationResource{}, nil +} + +type trustStoreAssociationResource struct { + framework.ResourceWithModel[trustStoreAssociationResourceModel] + framework.WithNoUpdate +} + +func (r *trustStoreAssociationResource) Schema(ctx context.Context, request resource.SchemaRequest, response *resource.SchemaResponse) { + response.Schema = schema.Schema{ + Attributes: map[string]schema.Attribute{ + "portal_arn": schema.StringAttribute{ + CustomType: fwtypes.ARNType, + Required: true, + PlanModifiers: []planmodifier.String{ + stringplanmodifier.RequiresReplace(), + }, + }, + "trust_store_arn": schema.StringAttribute{ + CustomType: fwtypes.ARNType, + Required: true, + PlanModifiers: []planmodifier.String{ + stringplanmodifier.RequiresReplace(), + }, + }, + }, + } +} + +func (r *trustStoreAssociationResource) Create(ctx context.Context, request resource.CreateRequest, response *resource.CreateResponse) { + var data trustStoreAssociationResourceModel + response.Diagnostics.Append(request.Plan.Get(ctx, &data)...) + if response.Diagnostics.HasError() { + return + } + + conn := r.Meta().WorkSpacesWebClient(ctx) + + input := workspacesweb.AssociateTrustStoreInput{ + TrustStoreArn: data.TrustStoreARN.ValueStringPointer(), + PortalArn: data.PortalARN.ValueStringPointer(), + } + + _, err := conn.AssociateTrustStore(ctx, &input) + + if err != nil { + response.Diagnostics.AddError("creating WorkSpacesWeb Trust Store Association", err.Error()) + return + } + + response.Diagnostics.Append(response.State.Set(ctx, data)...) +} + +func (r *trustStoreAssociationResource) Read(ctx context.Context, request resource.ReadRequest, response *resource.ReadResponse) { + var data trustStoreAssociationResourceModel + response.Diagnostics.Append(request.State.Get(ctx, &data)...) + if response.Diagnostics.HasError() { + return + } + + conn := r.Meta().WorkSpacesWebClient(ctx) + + // Check if the association exists by getting the trust store and checking associated portals + output, err := findTrustStoreByARN(ctx, conn, data.TrustStoreARN.ValueString()) + if tfretry.NotFound(err) { + response.Diagnostics.Append(fwdiag.NewResourceNotFoundWarningDiagnostic(err)) + response.State.RemoveResource(ctx) + return + } + + if err != nil { + response.Diagnostics.AddError(fmt.Sprintf("reading WorkSpacesWeb Trust Store Association (%s)", data.TrustStoreARN.ValueString()), err.Error()) + return + } + + // Check if the portal is in the associated portals list + if !slices.Contains(output.AssociatedPortalArns, data.PortalARN.ValueString()) { + response.Diagnostics.Append(fwdiag.NewResourceNotFoundWarningDiagnostic(fmt.Errorf("association not found"))) + response.State.RemoveResource(ctx) + return + } + + response.Diagnostics.Append(response.State.Set(ctx, &data)...) +} + +func (r *trustStoreAssociationResource) Delete(ctx context.Context, request resource.DeleteRequest, response *resource.DeleteResponse) { + var data trustStoreAssociationResourceModel + response.Diagnostics.Append(request.State.Get(ctx, &data)...) + if response.Diagnostics.HasError() { + return + } + + conn := r.Meta().WorkSpacesWebClient(ctx) + + input := workspacesweb.DisassociateTrustStoreInput{ + PortalArn: data.PortalARN.ValueStringPointer(), + } + + _, err := conn.DisassociateTrustStore(ctx, &input) + + if errs.IsA[*awstypes.ResourceNotFoundException](err) { + return + } + + if err != nil { + response.Diagnostics.AddError(fmt.Sprintf("deleting WorkSpacesWeb Trust Store Association (%s)", data.TrustStoreARN.ValueString()), err.Error()) + return + } +} + +func (r *trustStoreAssociationResource) ImportState(ctx context.Context, request resource.ImportStateRequest, response *resource.ImportStateResponse) { + const ( + trustStoreAssociationIDParts = 2 + ) + parts, err := intflex.ExpandResourceId(request.ID, trustStoreAssociationIDParts, true) + if err != nil { + response.Diagnostics.AddError( + "Unexpected Import Identifier", + fmt.Sprintf("Expected import identifier with format: trust_store_arn,portal_arn. Got: %q", request.ID), + ) + return + } + trustStoreARN := parts[0] + portalARN := parts[1] + + response.Diagnostics.Append(response.State.SetAttribute(ctx, path.Root("trust_store_arn"), trustStoreARN)...) + response.Diagnostics.Append(response.State.SetAttribute(ctx, path.Root("portal_arn"), portalARN)...) +} + +type trustStoreAssociationResourceModel struct { + framework.WithRegionModel + PortalARN fwtypes.ARN `tfsdk:"portal_arn"` + TrustStoreARN fwtypes.ARN `tfsdk:"trust_store_arn"` +} diff --git a/internal/service/workspacesweb/trust_store_association_test.go b/internal/service/workspacesweb/trust_store_association_test.go new file mode 100644 index 000000000000..3e7d63309863 --- /dev/null +++ b/internal/service/workspacesweb/trust_store_association_test.go @@ -0,0 +1,231 @@ +// Copyright (c) HashiCorp, Inc. +// SPDX-License-Identifier: MPL-2.0 + +package workspacesweb_test + +import ( + "context" + "fmt" + "slices" + "testing" + + awstypes "github.com/aws/aws-sdk-go-v2/service/workspacesweb/types" + "github.com/hashicorp/terraform-plugin-testing/helper/resource" + "github.com/hashicorp/terraform-plugin-testing/terraform" + "github.com/hashicorp/terraform-provider-aws/internal/acctest" + "github.com/hashicorp/terraform-provider-aws/internal/conns" + tfworkspacesweb "github.com/hashicorp/terraform-provider-aws/internal/service/workspacesweb" + "github.com/hashicorp/terraform-provider-aws/internal/tfresource" + "github.com/hashicorp/terraform-provider-aws/names" +) + +func TestAccWorkSpacesWebTrustStoreAssociation_basic(t *testing.T) { + ctx := acctest.Context(t) + var trustStore awstypes.TrustStore + resourceName := "aws_workspacesweb_trust_store_association.test" + trustStoreResourceName := "aws_workspacesweb_trust_store.test" + portalResourceName := "aws_workspacesweb_portal.test" + + resource.ParallelTest(t, resource.TestCase{ + PreCheck: func() { + acctest.PreCheck(ctx, t) + acctest.PreCheckPartitionHasService(t, names.WorkSpacesWebEndpointID) + testAccPreCheck(ctx, t) + }, + ErrorCheck: acctest.ErrorCheck(t, names.WorkSpacesWebServiceID), + ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories, + CheckDestroy: testAccCheckTrustStoreAssociationDestroy(ctx), + Steps: []resource.TestStep{ + { + Config: testAccTrustStoreAssociationConfig_basic(), + Check: resource.ComposeAggregateTestCheckFunc( + testAccCheckTrustStoreAssociationExists(ctx, resourceName, &trustStore), + resource.TestCheckResourceAttrPair(resourceName, "trust_store_arn", trustStoreResourceName, "trust_store_arn"), + resource.TestCheckResourceAttrPair(resourceName, "portal_arn", portalResourceName, "portal_arn"), + ), + }, + { + ResourceName: resourceName, + ImportState: true, + ImportStateVerify: true, + ImportStateIdFunc: testAccTrustStoreAssociationImportStateIdFunc(resourceName), + ImportStateVerifyIdentifierAttribute: "trust_store_arn", + }, + { + ResourceName: resourceName, + RefreshState: true, + }, + { + Config: testAccTrustStoreAssociationConfig_basic(), + Check: resource.ComposeAggregateTestCheckFunc( + //The following checks are for the TrustStore Resource and the PortalResource (and not for the association resource). + resource.TestCheckResourceAttr(trustStoreResourceName, "associated_portal_arns.#", "1"), + resource.TestCheckResourceAttrPair(trustStoreResourceName, "associated_portal_arns.0", portalResourceName, "portal_arn"), + resource.TestCheckResourceAttrPair(portalResourceName, "trust_store_arn", trustStoreResourceName, "trust_store_arn"), + ), + }, + }, + }) +} + +func TestAccWorkSpacesWebTrustStoreAssociation_disappears(t *testing.T) { + ctx := acctest.Context(t) + var trustStore awstypes.TrustStore + resourceName := "aws_workspacesweb_trust_store_association.test" + + resource.ParallelTest(t, resource.TestCase{ + PreCheck: func() { + acctest.PreCheck(ctx, t) + acctest.PreCheckPartitionHasService(t, names.WorkSpacesWebEndpointID) + testAccPreCheck(ctx, t) + }, + ErrorCheck: acctest.ErrorCheck(t, names.WorkSpacesWebServiceID), + ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories, + CheckDestroy: testAccCheckTrustStoreAssociationDestroy(ctx), + Steps: []resource.TestStep{ + { + Config: testAccTrustStoreAssociationConfig_basic(), + Check: resource.ComposeAggregateTestCheckFunc( + testAccCheckTrustStoreAssociationExists(ctx, resourceName, &trustStore), + acctest.CheckFrameworkResourceDisappears(ctx, acctest.Provider, tfworkspacesweb.ResourceTrustStoreAssociation, resourceName), + ), + ExpectNonEmptyPlan: true, + }, + }, + }) +} + +func testAccCheckTrustStoreAssociationDestroy(ctx context.Context) resource.TestCheckFunc { + return func(s *terraform.State) error { + conn := acctest.Provider.Meta().(*conns.AWSClient).WorkSpacesWebClient(ctx) + + for _, rs := range s.RootModule().Resources { + if rs.Type != "aws_workspacesweb_trust_store_association" { + continue + } + + trustStore, err := tfworkspacesweb.FindTrustStoreByARN(ctx, conn, rs.Primary.Attributes["trust_store_arn"]) + + if tfresource.NotFound(err) { + continue + } + + if err != nil { + return err + } + + // Check if the portal is still associated + portalARN := rs.Primary.Attributes["portal_arn"] + if slices.Contains(trustStore.AssociatedPortalArns, portalARN) { + return fmt.Errorf("WorkSpaces Web Trust Store Association %s still exists", rs.Primary.Attributes["trust_store_arn"]) + } + } + + return nil + } +} + +func testAccCheckTrustStoreAssociationExists(ctx context.Context, n string, v *awstypes.TrustStore) resource.TestCheckFunc { + return func(s *terraform.State) error { + rs, ok := s.RootModule().Resources[n] + if !ok { + return fmt.Errorf("Not found: %s", n) + } + + conn := acctest.Provider.Meta().(*conns.AWSClient).WorkSpacesWebClient(ctx) + + output, err := tfworkspacesweb.FindTrustStoreByARN(ctx, conn, rs.Primary.Attributes["trust_store_arn"]) + + if err != nil { + return err + } + + // Check if the portal is associated + portalARN := rs.Primary.Attributes["portal_arn"] + if !slices.Contains(output.AssociatedPortalArns, portalARN) { + return fmt.Errorf("Association not found") + } + + *v = *output + + return nil + } +} + +func testAccTrustStoreAssociationImportStateIdFunc(resourceName string) resource.ImportStateIdFunc { + return func(s *terraform.State) (string, error) { + rs, ok := s.RootModule().Resources[resourceName] + if !ok { + return "", fmt.Errorf("Not found: %s", resourceName) + } + + return fmt.Sprintf("%s,%s", rs.Primary.Attributes["trust_store_arn"], rs.Primary.Attributes["portal_arn"]), nil + } +} + +func testAccTrustStoreAssociationConfig_acmBase() string { + return ` +data "aws_partition" "current" {} + +resource "aws_acmpca_certificate_authority" "test" { + type = "ROOT" + + certificate_authority_configuration { + key_algorithm = "RSA_2048" + signing_algorithm = "SHA256WITHRSA" + + subject { + common_name = "example.com" + } + } + permanent_deletion_time_in_days = 7 +} + +resource "aws_acmpca_certificate" "test1" { + certificate_authority_arn = aws_acmpca_certificate_authority.test.arn + certificate_signing_request = aws_acmpca_certificate_authority.test.certificate_signing_request + signing_algorithm = "SHA256WITHRSA" + + template_arn = "arn:${data.aws_partition.current.partition}:acm-pca:::template/RootCACertificate/V1" + + validity { + type = "YEARS" + value = 1 + } +} + +resource "aws_acmpca_certificate" "test2" { + certificate_authority_arn = aws_acmpca_certificate_authority.test.arn + certificate_signing_request = aws_acmpca_certificate_authority.test.certificate_signing_request + signing_algorithm = "SHA256WITHRSA" + + template_arn = "arn:${data.aws_partition.current.partition}:acm-pca:::template/RootCACertificate/V1" + + validity { + type = "YEARS" + value = 1 + } +} +` +} + +func testAccTrustStoreAssociationConfig_basic() string { + return acctest.ConfigCompose( + testAccTrustStoreAssociationConfig_acmBase(), + ` +resource "aws_workspacesweb_portal" "test" { + display_name = "test" +} + +resource "aws_workspacesweb_trust_store" "test" { + certificate { + body = aws_acmpca_certificate.test1.certificate + } +} + +resource "aws_workspacesweb_trust_store_association" "test" { + trust_store_arn = aws_workspacesweb_trust_store.test.trust_store_arn + portal_arn = aws_workspacesweb_portal.test.portal_arn +} +`) +} diff --git a/internal/service/workspacesweb/trust_store_tags_gen_test.go b/internal/service/workspacesweb/trust_store_tags_gen_test.go new file mode 100644 index 000000000000..dd06651003cf --- /dev/null +++ b/internal/service/workspacesweb/trust_store_tags_gen_test.go @@ -0,0 +1,2330 @@ +// Code generated by internal/generate/tagstests/main.go; DO NOT EDIT. + +package workspacesweb_test + +import ( + "testing" + + "github.com/aws/aws-sdk-go-v2/service/workspacesweb/types" + "github.com/hashicorp/terraform-plugin-testing/config" + "github.com/hashicorp/terraform-plugin-testing/helper/resource" + "github.com/hashicorp/terraform-plugin-testing/knownvalue" + "github.com/hashicorp/terraform-plugin-testing/plancheck" + "github.com/hashicorp/terraform-plugin-testing/statecheck" + "github.com/hashicorp/terraform-plugin-testing/tfjsonpath" + "github.com/hashicorp/terraform-provider-aws/internal/acctest" + "github.com/hashicorp/terraform-provider-aws/names" +) + +func TestAccWorkSpacesWebTrustStore_tags(t *testing.T) { + ctx := acctest.Context(t) + + var v types.TrustStore + resourceName := "aws_workspacesweb_trust_store.test" + + acctest.ParallelTest(ctx, t, resource.TestCase{ + PreCheck: func() { acctest.PreCheck(ctx, t) }, + ErrorCheck: acctest.ErrorCheck(t, names.WorkSpacesWebServiceID), + CheckDestroy: testAccCheckTrustStoreDestroy(ctx), + ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories, + Steps: []resource.TestStep{ + { + ConfigDirectory: config.StaticDirectory("testdata/TrustStore/tags/"), + ConfigVariables: config.Variables{ + acctest.CtResourceTags: config.MapVariable(map[string]config.Variable{ + acctest.CtKey1: config.StringVariable(acctest.CtValue1), + }), + }, + Check: resource.ComposeAggregateTestCheckFunc( + testAccCheckTrustStoreExists(ctx, resourceName, &v), + ), + ConfigStateChecks: []statecheck.StateCheck{ + statecheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTags), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtKey1: knownvalue.StringExact(acctest.CtValue1), + })), + statecheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTagsAll), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtKey1: knownvalue.StringExact(acctest.CtValue1), + })), + }, + ConfigPlanChecks: resource.ConfigPlanChecks{ + PreApply: []plancheck.PlanCheck{ + plancheck.ExpectResourceAction(resourceName, plancheck.ResourceActionCreate), + plancheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTags), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtKey1: knownvalue.StringExact(acctest.CtValue1), + })), + plancheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTagsAll), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtKey1: knownvalue.StringExact(acctest.CtValue1), + })), + }, + }, + }, + { + ConfigDirectory: config.StaticDirectory("testdata/TrustStore/tags/"), + ConfigVariables: config.Variables{ + acctest.CtResourceTags: config.MapVariable(map[string]config.Variable{ + acctest.CtKey1: config.StringVariable(acctest.CtValue1), + }), + }, + ResourceName: resourceName, + ImportState: true, + ImportStateIdFunc: acctest.AttrImportStateIdFunc(resourceName, "trust_store_arn"), + ImportStateVerify: true, + ImportStateVerifyIdentifierAttribute: "trust_store_arn", + ImportStateVerifyIgnore: []string{ + "certificate_list", + }, + }, + { + ConfigDirectory: config.StaticDirectory("testdata/TrustStore/tags/"), + ConfigVariables: config.Variables{ + acctest.CtResourceTags: config.MapVariable(map[string]config.Variable{ + acctest.CtKey1: config.StringVariable(acctest.CtValue1Updated), + acctest.CtKey2: config.StringVariable(acctest.CtValue2), + }), + }, + Check: resource.ComposeAggregateTestCheckFunc( + testAccCheckTrustStoreExists(ctx, resourceName, &v), + ), + ConfigStateChecks: []statecheck.StateCheck{ + statecheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTags), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtKey1: knownvalue.StringExact(acctest.CtValue1Updated), + acctest.CtKey2: knownvalue.StringExact(acctest.CtValue2), + })), + statecheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTagsAll), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtKey1: knownvalue.StringExact(acctest.CtValue1Updated), + acctest.CtKey2: knownvalue.StringExact(acctest.CtValue2), + })), + }, + ConfigPlanChecks: resource.ConfigPlanChecks{ + PreApply: []plancheck.PlanCheck{ + plancheck.ExpectResourceAction(resourceName, plancheck.ResourceActionUpdate), + plancheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTags), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtKey1: knownvalue.StringExact(acctest.CtValue1Updated), + acctest.CtKey2: knownvalue.StringExact(acctest.CtValue2), + })), + plancheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTagsAll), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtKey1: knownvalue.StringExact(acctest.CtValue1Updated), + acctest.CtKey2: knownvalue.StringExact(acctest.CtValue2), + })), + }, + }, + }, + { + ConfigDirectory: config.StaticDirectory("testdata/TrustStore/tags/"), + ConfigVariables: config.Variables{ + acctest.CtResourceTags: config.MapVariable(map[string]config.Variable{ + acctest.CtKey1: config.StringVariable(acctest.CtValue1Updated), + acctest.CtKey2: config.StringVariable(acctest.CtValue2), + }), + }, + ResourceName: resourceName, + ImportState: true, + ImportStateIdFunc: acctest.AttrImportStateIdFunc(resourceName, "trust_store_arn"), + ImportStateVerify: true, + ImportStateVerifyIdentifierAttribute: "trust_store_arn", + ImportStateVerifyIgnore: []string{ + "certificate_list", + }, + }, + { + ConfigDirectory: config.StaticDirectory("testdata/TrustStore/tags/"), + ConfigVariables: config.Variables{ + acctest.CtResourceTags: config.MapVariable(map[string]config.Variable{ + acctest.CtKey2: config.StringVariable(acctest.CtValue2), + }), + }, + Check: resource.ComposeAggregateTestCheckFunc( + testAccCheckTrustStoreExists(ctx, resourceName, &v), + ), + ConfigStateChecks: []statecheck.StateCheck{ + statecheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTags), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtKey2: knownvalue.StringExact(acctest.CtValue2), + })), + statecheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTagsAll), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtKey2: knownvalue.StringExact(acctest.CtValue2), + })), + }, + ConfigPlanChecks: resource.ConfigPlanChecks{ + PreApply: []plancheck.PlanCheck{ + plancheck.ExpectResourceAction(resourceName, plancheck.ResourceActionUpdate), + plancheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTags), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtKey2: knownvalue.StringExact(acctest.CtValue2), + })), + plancheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTagsAll), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtKey2: knownvalue.StringExact(acctest.CtValue2), + })), + }, + }, + }, + { + ConfigDirectory: config.StaticDirectory("testdata/TrustStore/tags/"), + ConfigVariables: config.Variables{ + acctest.CtResourceTags: config.MapVariable(map[string]config.Variable{ + acctest.CtKey2: config.StringVariable(acctest.CtValue2), + }), + }, + ResourceName: resourceName, + ImportState: true, + ImportStateIdFunc: acctest.AttrImportStateIdFunc(resourceName, "trust_store_arn"), + ImportStateVerify: true, + ImportStateVerifyIdentifierAttribute: "trust_store_arn", + ImportStateVerifyIgnore: []string{ + "certificate_list", + }, + }, + { + ConfigDirectory: config.StaticDirectory("testdata/TrustStore/tags/"), + ConfigVariables: config.Variables{ + acctest.CtResourceTags: nil, + }, + Check: resource.ComposeAggregateTestCheckFunc( + testAccCheckTrustStoreExists(ctx, resourceName, &v), + ), + ConfigStateChecks: []statecheck.StateCheck{ + statecheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTags), knownvalue.Null()), + statecheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTagsAll), knownvalue.MapExact(map[string]knownvalue.Check{})), + }, + ConfigPlanChecks: resource.ConfigPlanChecks{ + PreApply: []plancheck.PlanCheck{ + plancheck.ExpectResourceAction(resourceName, plancheck.ResourceActionUpdate), + plancheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTags), knownvalue.Null()), + plancheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTagsAll), knownvalue.MapExact(map[string]knownvalue.Check{})), + }, + }, + }, + { + ConfigDirectory: config.StaticDirectory("testdata/TrustStore/tags/"), + ConfigVariables: config.Variables{ + acctest.CtResourceTags: nil, + }, + ResourceName: resourceName, + ImportState: true, + ImportStateIdFunc: acctest.AttrImportStateIdFunc(resourceName, "trust_store_arn"), + ImportStateVerify: true, + ImportStateVerifyIdentifierAttribute: "trust_store_arn", + ImportStateVerifyIgnore: []string{ + "certificate_list", + }, + }, + }, + }) +} + +func TestAccWorkSpacesWebTrustStore_tags_null(t *testing.T) { + ctx := acctest.Context(t) + + var v types.TrustStore + resourceName := "aws_workspacesweb_trust_store.test" + + acctest.ParallelTest(ctx, t, resource.TestCase{ + PreCheck: func() { acctest.PreCheck(ctx, t) }, + ErrorCheck: acctest.ErrorCheck(t, names.WorkSpacesWebServiceID), + CheckDestroy: testAccCheckTrustStoreDestroy(ctx), + ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories, + Steps: []resource.TestStep{ + { + ConfigDirectory: config.StaticDirectory("testdata/TrustStore/tags/"), + ConfigVariables: config.Variables{ + acctest.CtResourceTags: config.MapVariable(map[string]config.Variable{ + acctest.CtKey1: nil, + }), + }, + Check: resource.ComposeAggregateTestCheckFunc( + testAccCheckTrustStoreExists(ctx, resourceName, &v), + ), + ConfigStateChecks: []statecheck.StateCheck{ + statecheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTags), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtKey1: knownvalue.Null(), + })), + statecheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTagsAll), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtKey1: knownvalue.StringExact(""), + })), + }, + ConfigPlanChecks: resource.ConfigPlanChecks{ + PreApply: []plancheck.PlanCheck{ + plancheck.ExpectResourceAction(resourceName, plancheck.ResourceActionCreate), + plancheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTags), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtKey1: knownvalue.Null(), + })), + plancheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTagsAll), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtKey1: knownvalue.StringExact(""), + })), + }, + }, + }, + { + ConfigDirectory: config.StaticDirectory("testdata/TrustStore/tags/"), + ConfigVariables: config.Variables{ + acctest.CtResourceTags: config.MapVariable(map[string]config.Variable{ + acctest.CtKey1: nil, + }), + }, + ResourceName: resourceName, + ImportState: true, + ImportStateIdFunc: acctest.AttrImportStateIdFunc(resourceName, "trust_store_arn"), + ImportStateVerify: true, + ImportStateVerifyIdentifierAttribute: "trust_store_arn", + ImportStateVerifyIgnore: []string{ + acctest.CtTagsKey1, // The canonical value returned by the AWS API is "" + "certificate_list", + }, + }, + }, + }) +} + +func TestAccWorkSpacesWebTrustStore_tags_EmptyMap(t *testing.T) { + ctx := acctest.Context(t) + + var v types.TrustStore + resourceName := "aws_workspacesweb_trust_store.test" + + acctest.ParallelTest(ctx, t, resource.TestCase{ + PreCheck: func() { acctest.PreCheck(ctx, t) }, + ErrorCheck: acctest.ErrorCheck(t, names.WorkSpacesWebServiceID), + CheckDestroy: testAccCheckTrustStoreDestroy(ctx), + ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories, + Steps: []resource.TestStep{ + { + ConfigDirectory: config.StaticDirectory("testdata/TrustStore/tags/"), + ConfigVariables: config.Variables{ + acctest.CtResourceTags: config.MapVariable(map[string]config.Variable{}), + }, + Check: resource.ComposeAggregateTestCheckFunc( + testAccCheckTrustStoreExists(ctx, resourceName, &v), + ), + ConfigStateChecks: []statecheck.StateCheck{ + statecheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTags), knownvalue.MapExact(map[string]knownvalue.Check{})), + statecheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTagsAll), knownvalue.MapExact(map[string]knownvalue.Check{})), + }, + ConfigPlanChecks: resource.ConfigPlanChecks{ + PreApply: []plancheck.PlanCheck{ + plancheck.ExpectResourceAction(resourceName, plancheck.ResourceActionCreate), + plancheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTags), knownvalue.MapExact(map[string]knownvalue.Check{})), + plancheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTagsAll), knownvalue.MapExact(map[string]knownvalue.Check{})), + }, + }, + }, + { + ConfigDirectory: config.StaticDirectory("testdata/TrustStore/tags/"), + ConfigVariables: config.Variables{ + acctest.CtResourceTags: config.MapVariable(map[string]config.Variable{}), + }, + ResourceName: resourceName, + ImportState: true, + ImportStateIdFunc: acctest.AttrImportStateIdFunc(resourceName, "trust_store_arn"), + ImportStateVerify: true, + ImportStateVerifyIdentifierAttribute: "trust_store_arn", + ImportStateVerifyIgnore: []string{ + acctest.CtTagsKey1, // The canonical value returned by the AWS API is "" + "certificate_list", + }, + }, + }, + }) +} + +func TestAccWorkSpacesWebTrustStore_tags_AddOnUpdate(t *testing.T) { + ctx := acctest.Context(t) + + var v types.TrustStore + resourceName := "aws_workspacesweb_trust_store.test" + + acctest.ParallelTest(ctx, t, resource.TestCase{ + PreCheck: func() { acctest.PreCheck(ctx, t) }, + ErrorCheck: acctest.ErrorCheck(t, names.WorkSpacesWebServiceID), + CheckDestroy: testAccCheckTrustStoreDestroy(ctx), + ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories, + Steps: []resource.TestStep{ + { + ConfigDirectory: config.StaticDirectory("testdata/TrustStore/tags/"), + ConfigVariables: config.Variables{ + acctest.CtResourceTags: nil, + }, + Check: resource.ComposeAggregateTestCheckFunc( + testAccCheckTrustStoreExists(ctx, resourceName, &v), + ), + ConfigStateChecks: []statecheck.StateCheck{ + statecheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTags), knownvalue.Null()), + statecheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTagsAll), knownvalue.MapExact(map[string]knownvalue.Check{})), + }, + ConfigPlanChecks: resource.ConfigPlanChecks{ + PreApply: []plancheck.PlanCheck{ + plancheck.ExpectResourceAction(resourceName, plancheck.ResourceActionCreate), + plancheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTags), knownvalue.Null()), + plancheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTagsAll), knownvalue.MapExact(map[string]knownvalue.Check{})), + }, + }, + }, + { + ConfigDirectory: config.StaticDirectory("testdata/TrustStore/tags/"), + ConfigVariables: config.Variables{ + acctest.CtResourceTags: config.MapVariable(map[string]config.Variable{ + acctest.CtKey1: config.StringVariable(acctest.CtValue1), + }), + }, + Check: resource.ComposeAggregateTestCheckFunc( + testAccCheckTrustStoreExists(ctx, resourceName, &v), + ), + ConfigStateChecks: []statecheck.StateCheck{ + statecheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTags), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtKey1: knownvalue.StringExact(acctest.CtValue1), + })), + statecheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTagsAll), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtKey1: knownvalue.StringExact(acctest.CtValue1), + })), + }, + ConfigPlanChecks: resource.ConfigPlanChecks{ + PreApply: []plancheck.PlanCheck{ + plancheck.ExpectResourceAction(resourceName, plancheck.ResourceActionUpdate), + plancheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTags), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtKey1: knownvalue.StringExact(acctest.CtValue1), + })), + plancheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTagsAll), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtKey1: knownvalue.StringExact(acctest.CtValue1), + })), + }, + }, + }, + { + ConfigDirectory: config.StaticDirectory("testdata/TrustStore/tags/"), + ConfigVariables: config.Variables{ + acctest.CtResourceTags: config.MapVariable(map[string]config.Variable{ + acctest.CtKey1: config.StringVariable(acctest.CtValue1), + }), + }, + ResourceName: resourceName, + ImportState: true, + ImportStateIdFunc: acctest.AttrImportStateIdFunc(resourceName, "trust_store_arn"), + ImportStateVerify: true, + ImportStateVerifyIdentifierAttribute: "trust_store_arn", + ImportStateVerifyIgnore: []string{ + "certificate_list", + }, + }, + }, + }) +} + +func TestAccWorkSpacesWebTrustStore_tags_EmptyTag_OnCreate(t *testing.T) { + ctx := acctest.Context(t) + + var v types.TrustStore + resourceName := "aws_workspacesweb_trust_store.test" + + acctest.ParallelTest(ctx, t, resource.TestCase{ + PreCheck: func() { acctest.PreCheck(ctx, t) }, + ErrorCheck: acctest.ErrorCheck(t, names.WorkSpacesWebServiceID), + CheckDestroy: testAccCheckTrustStoreDestroy(ctx), + ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories, + Steps: []resource.TestStep{ + { + ConfigDirectory: config.StaticDirectory("testdata/TrustStore/tags/"), + ConfigVariables: config.Variables{ + acctest.CtResourceTags: config.MapVariable(map[string]config.Variable{ + acctest.CtKey1: config.StringVariable(""), + }), + }, + Check: resource.ComposeAggregateTestCheckFunc( + testAccCheckTrustStoreExists(ctx, resourceName, &v), + ), + ConfigStateChecks: []statecheck.StateCheck{ + statecheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTags), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtKey1: knownvalue.StringExact(""), + })), + statecheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTagsAll), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtKey1: knownvalue.StringExact(""), + })), + }, + ConfigPlanChecks: resource.ConfigPlanChecks{ + PreApply: []plancheck.PlanCheck{ + plancheck.ExpectResourceAction(resourceName, plancheck.ResourceActionCreate), + plancheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTags), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtKey1: knownvalue.StringExact(""), + })), + plancheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTagsAll), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtKey1: knownvalue.StringExact(""), + })), + }, + }, + }, + { + ConfigDirectory: config.StaticDirectory("testdata/TrustStore/tags/"), + ConfigVariables: config.Variables{ + acctest.CtResourceTags: config.MapVariable(map[string]config.Variable{ + acctest.CtKey1: config.StringVariable(""), + }), + }, + ResourceName: resourceName, + ImportState: true, + ImportStateIdFunc: acctest.AttrImportStateIdFunc(resourceName, "trust_store_arn"), + ImportStateVerify: true, + ImportStateVerifyIdentifierAttribute: "trust_store_arn", + ImportStateVerifyIgnore: []string{ + "certificate_list", + }, + }, + { + ConfigDirectory: config.StaticDirectory("testdata/TrustStore/tags/"), + ConfigVariables: config.Variables{ + acctest.CtResourceTags: nil, + }, + Check: resource.ComposeAggregateTestCheckFunc( + testAccCheckTrustStoreExists(ctx, resourceName, &v), + ), + ConfigStateChecks: []statecheck.StateCheck{ + statecheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTags), knownvalue.Null()), + statecheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTagsAll), knownvalue.MapExact(map[string]knownvalue.Check{})), + }, + ConfigPlanChecks: resource.ConfigPlanChecks{ + PreApply: []plancheck.PlanCheck{ + plancheck.ExpectResourceAction(resourceName, plancheck.ResourceActionUpdate), + plancheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTags), knownvalue.Null()), + plancheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTagsAll), knownvalue.MapExact(map[string]knownvalue.Check{})), + }, + }, + }, + { + ConfigDirectory: config.StaticDirectory("testdata/TrustStore/tags/"), + ConfigVariables: config.Variables{ + acctest.CtResourceTags: nil, + }, + ResourceName: resourceName, + ImportState: true, + ImportStateIdFunc: acctest.AttrImportStateIdFunc(resourceName, "trust_store_arn"), + ImportStateVerify: true, + ImportStateVerifyIdentifierAttribute: "trust_store_arn", + ImportStateVerifyIgnore: []string{ + "certificate_list", + }, + }, + }, + }) +} + +func TestAccWorkSpacesWebTrustStore_tags_EmptyTag_OnUpdate_Add(t *testing.T) { + ctx := acctest.Context(t) + + var v types.TrustStore + resourceName := "aws_workspacesweb_trust_store.test" + + acctest.ParallelTest(ctx, t, resource.TestCase{ + PreCheck: func() { acctest.PreCheck(ctx, t) }, + ErrorCheck: acctest.ErrorCheck(t, names.WorkSpacesWebServiceID), + CheckDestroy: testAccCheckTrustStoreDestroy(ctx), + ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories, + Steps: []resource.TestStep{ + { + ConfigDirectory: config.StaticDirectory("testdata/TrustStore/tags/"), + ConfigVariables: config.Variables{ + acctest.CtResourceTags: config.MapVariable(map[string]config.Variable{ + acctest.CtKey1: config.StringVariable(acctest.CtValue1), + }), + }, + Check: resource.ComposeAggregateTestCheckFunc( + testAccCheckTrustStoreExists(ctx, resourceName, &v), + ), + ConfigStateChecks: []statecheck.StateCheck{ + statecheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTags), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtKey1: knownvalue.StringExact(acctest.CtValue1), + })), + statecheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTagsAll), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtKey1: knownvalue.StringExact(acctest.CtValue1), + })), + }, + ConfigPlanChecks: resource.ConfigPlanChecks{ + PreApply: []plancheck.PlanCheck{ + plancheck.ExpectResourceAction(resourceName, plancheck.ResourceActionCreate), + plancheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTags), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtKey1: knownvalue.StringExact(acctest.CtValue1), + })), + plancheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTagsAll), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtKey1: knownvalue.StringExact(acctest.CtValue1), + })), + }, + }, + }, + { + ConfigDirectory: config.StaticDirectory("testdata/TrustStore/tags/"), + ConfigVariables: config.Variables{ + acctest.CtResourceTags: config.MapVariable(map[string]config.Variable{ + acctest.CtKey1: config.StringVariable(acctest.CtValue1), + acctest.CtKey2: config.StringVariable(""), + }), + }, + Check: resource.ComposeAggregateTestCheckFunc( + testAccCheckTrustStoreExists(ctx, resourceName, &v), + ), + ConfigStateChecks: []statecheck.StateCheck{ + statecheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTags), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtKey1: knownvalue.StringExact(acctest.CtValue1), + acctest.CtKey2: knownvalue.StringExact(""), + })), + statecheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTagsAll), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtKey1: knownvalue.StringExact(acctest.CtValue1), + acctest.CtKey2: knownvalue.StringExact(""), + })), + }, + ConfigPlanChecks: resource.ConfigPlanChecks{ + PreApply: []plancheck.PlanCheck{ + plancheck.ExpectResourceAction(resourceName, plancheck.ResourceActionUpdate), + plancheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTags), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtKey1: knownvalue.StringExact(acctest.CtValue1), + acctest.CtKey2: knownvalue.StringExact(""), + })), + plancheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTagsAll), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtKey1: knownvalue.StringExact(acctest.CtValue1), + acctest.CtKey2: knownvalue.StringExact(""), + })), + }, + }, + }, + { + ConfigDirectory: config.StaticDirectory("testdata/TrustStore/tags/"), + ConfigVariables: config.Variables{ + acctest.CtResourceTags: config.MapVariable(map[string]config.Variable{ + acctest.CtKey1: config.StringVariable(acctest.CtValue1), + acctest.CtKey2: config.StringVariable(""), + }), + }, + ResourceName: resourceName, + ImportState: true, + ImportStateIdFunc: acctest.AttrImportStateIdFunc(resourceName, "trust_store_arn"), + ImportStateVerify: true, + ImportStateVerifyIdentifierAttribute: "trust_store_arn", + ImportStateVerifyIgnore: []string{ + "certificate_list", + }, + }, + { + ConfigDirectory: config.StaticDirectory("testdata/TrustStore/tags/"), + ConfigVariables: config.Variables{ + acctest.CtResourceTags: config.MapVariable(map[string]config.Variable{ + acctest.CtKey1: config.StringVariable(acctest.CtValue1), + }), + }, + Check: resource.ComposeAggregateTestCheckFunc( + testAccCheckTrustStoreExists(ctx, resourceName, &v), + ), + ConfigStateChecks: []statecheck.StateCheck{ + statecheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTags), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtKey1: knownvalue.StringExact(acctest.CtValue1), + })), + statecheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTagsAll), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtKey1: knownvalue.StringExact(acctest.CtValue1), + })), + }, + ConfigPlanChecks: resource.ConfigPlanChecks{ + PreApply: []plancheck.PlanCheck{ + plancheck.ExpectResourceAction(resourceName, plancheck.ResourceActionUpdate), + plancheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTags), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtKey1: knownvalue.StringExact(acctest.CtValue1), + })), + plancheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTagsAll), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtKey1: knownvalue.StringExact(acctest.CtValue1), + })), + }, + }, + }, + { + ConfigDirectory: config.StaticDirectory("testdata/TrustStore/tags/"), + ConfigVariables: config.Variables{ + acctest.CtResourceTags: config.MapVariable(map[string]config.Variable{ + acctest.CtKey1: config.StringVariable(acctest.CtValue1), + }), + }, + ResourceName: resourceName, + ImportState: true, + ImportStateIdFunc: acctest.AttrImportStateIdFunc(resourceName, "trust_store_arn"), + ImportStateVerify: true, + ImportStateVerifyIdentifierAttribute: "trust_store_arn", + ImportStateVerifyIgnore: []string{ + "certificate_list", + }, + }, + }, + }) +} + +func TestAccWorkSpacesWebTrustStore_tags_EmptyTag_OnUpdate_Replace(t *testing.T) { + ctx := acctest.Context(t) + + var v types.TrustStore + resourceName := "aws_workspacesweb_trust_store.test" + + acctest.ParallelTest(ctx, t, resource.TestCase{ + PreCheck: func() { acctest.PreCheck(ctx, t) }, + ErrorCheck: acctest.ErrorCheck(t, names.WorkSpacesWebServiceID), + CheckDestroy: testAccCheckTrustStoreDestroy(ctx), + ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories, + Steps: []resource.TestStep{ + { + ConfigDirectory: config.StaticDirectory("testdata/TrustStore/tags/"), + ConfigVariables: config.Variables{ + acctest.CtResourceTags: config.MapVariable(map[string]config.Variable{ + acctest.CtKey1: config.StringVariable(acctest.CtValue1), + }), + }, + Check: resource.ComposeAggregateTestCheckFunc( + testAccCheckTrustStoreExists(ctx, resourceName, &v), + ), + ConfigStateChecks: []statecheck.StateCheck{ + statecheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTags), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtKey1: knownvalue.StringExact(acctest.CtValue1), + })), + statecheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTagsAll), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtKey1: knownvalue.StringExact(acctest.CtValue1), + })), + }, + ConfigPlanChecks: resource.ConfigPlanChecks{ + PreApply: []plancheck.PlanCheck{ + plancheck.ExpectResourceAction(resourceName, plancheck.ResourceActionCreate), + plancheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTags), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtKey1: knownvalue.StringExact(acctest.CtValue1), + })), + plancheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTagsAll), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtKey1: knownvalue.StringExact(acctest.CtValue1), + })), + }, + }, + }, + { + ConfigDirectory: config.StaticDirectory("testdata/TrustStore/tags/"), + ConfigVariables: config.Variables{ + acctest.CtResourceTags: config.MapVariable(map[string]config.Variable{ + acctest.CtKey1: config.StringVariable(""), + }), + }, + Check: resource.ComposeAggregateTestCheckFunc( + testAccCheckTrustStoreExists(ctx, resourceName, &v), + ), + ConfigStateChecks: []statecheck.StateCheck{ + statecheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTags), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtKey1: knownvalue.StringExact(""), + })), + statecheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTagsAll), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtKey1: knownvalue.StringExact(""), + })), + }, + ConfigPlanChecks: resource.ConfigPlanChecks{ + PreApply: []plancheck.PlanCheck{ + plancheck.ExpectResourceAction(resourceName, plancheck.ResourceActionUpdate), + plancheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTags), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtKey1: knownvalue.StringExact(""), + })), + plancheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTagsAll), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtKey1: knownvalue.StringExact(""), + })), + }, + }, + }, + { + ConfigDirectory: config.StaticDirectory("testdata/TrustStore/tags/"), + ConfigVariables: config.Variables{ + acctest.CtResourceTags: config.MapVariable(map[string]config.Variable{ + acctest.CtKey1: config.StringVariable(""), + }), + }, + ResourceName: resourceName, + ImportState: true, + ImportStateIdFunc: acctest.AttrImportStateIdFunc(resourceName, "trust_store_arn"), + ImportStateVerify: true, + ImportStateVerifyIdentifierAttribute: "trust_store_arn", + ImportStateVerifyIgnore: []string{ + "certificate_list", + }, + }, + }, + }) +} + +func TestAccWorkSpacesWebTrustStore_tags_DefaultTags_providerOnly(t *testing.T) { + ctx := acctest.Context(t) + + var v types.TrustStore + resourceName := "aws_workspacesweb_trust_store.test" + + acctest.ParallelTest(ctx, t, resource.TestCase{ + PreCheck: func() { acctest.PreCheck(ctx, t) }, + ErrorCheck: acctest.ErrorCheck(t, names.WorkSpacesWebServiceID), + CheckDestroy: testAccCheckTrustStoreDestroy(ctx), + Steps: []resource.TestStep{ + { + ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories, + ConfigDirectory: config.StaticDirectory("testdata/TrustStore/tags_defaults/"), + ConfigVariables: config.Variables{ + acctest.CtProviderTags: config.MapVariable(map[string]config.Variable{ + acctest.CtKey1: config.StringVariable(acctest.CtValue1), + }), + acctest.CtResourceTags: nil, + }, + Check: resource.ComposeAggregateTestCheckFunc( + testAccCheckTrustStoreExists(ctx, resourceName, &v), + ), + ConfigStateChecks: []statecheck.StateCheck{ + statecheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTags), knownvalue.Null()), + statecheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTagsAll), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtKey1: knownvalue.StringExact(acctest.CtValue1), + })), + }, + ConfigPlanChecks: resource.ConfigPlanChecks{ + PreApply: []plancheck.PlanCheck{ + plancheck.ExpectResourceAction(resourceName, plancheck.ResourceActionCreate), + plancheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTags), knownvalue.Null()), + plancheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTagsAll), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtKey1: knownvalue.StringExact(acctest.CtValue1), + })), + }, + }, + }, + { + ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories, + ConfigDirectory: config.StaticDirectory("testdata/TrustStore/tags_defaults/"), + ConfigVariables: config.Variables{ + acctest.CtProviderTags: config.MapVariable(map[string]config.Variable{ + acctest.CtKey1: config.StringVariable(acctest.CtValue1), + }), + acctest.CtResourceTags: nil, + }, + ResourceName: resourceName, + ImportState: true, + ImportStateIdFunc: acctest.AttrImportStateIdFunc(resourceName, "trust_store_arn"), + ImportStateVerify: true, + ImportStateVerifyIdentifierAttribute: "trust_store_arn", + ImportStateVerifyIgnore: []string{ + "certificate_list", + }, + }, + { + ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories, + ConfigDirectory: config.StaticDirectory("testdata/TrustStore/tags_defaults/"), + ConfigVariables: config.Variables{ + acctest.CtProviderTags: config.MapVariable(map[string]config.Variable{ + acctest.CtKey1: config.StringVariable(acctest.CtValue1Updated), + acctest.CtKey2: config.StringVariable(acctest.CtValue2), + }), + acctest.CtResourceTags: nil, + }, + Check: resource.ComposeAggregateTestCheckFunc( + testAccCheckTrustStoreExists(ctx, resourceName, &v), + ), + ConfigStateChecks: []statecheck.StateCheck{ + statecheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTags), knownvalue.Null()), + statecheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTagsAll), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtKey1: knownvalue.StringExact(acctest.CtValue1Updated), + acctest.CtKey2: knownvalue.StringExact(acctest.CtValue2), + })), + }, + ConfigPlanChecks: resource.ConfigPlanChecks{ + PreApply: []plancheck.PlanCheck{ + plancheck.ExpectResourceAction(resourceName, plancheck.ResourceActionUpdate), + plancheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTags), knownvalue.Null()), + plancheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTagsAll), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtKey1: knownvalue.StringExact(acctest.CtValue1Updated), + acctest.CtKey2: knownvalue.StringExact(acctest.CtValue2), + })), + }, + }, + }, + { + ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories, + ConfigDirectory: config.StaticDirectory("testdata/TrustStore/tags_defaults/"), + ConfigVariables: config.Variables{ + acctest.CtProviderTags: config.MapVariable(map[string]config.Variable{ + acctest.CtKey1: config.StringVariable(acctest.CtValue1Updated), + acctest.CtKey2: config.StringVariable(acctest.CtValue2), + }), + acctest.CtResourceTags: nil, + }, + ResourceName: resourceName, + ImportState: true, + ImportStateIdFunc: acctest.AttrImportStateIdFunc(resourceName, "trust_store_arn"), + ImportStateVerify: true, + ImportStateVerifyIdentifierAttribute: "trust_store_arn", + ImportStateVerifyIgnore: []string{ + "certificate_list", + }, + }, + { + ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories, + ConfigDirectory: config.StaticDirectory("testdata/TrustStore/tags_defaults/"), + ConfigVariables: config.Variables{ + acctest.CtProviderTags: config.MapVariable(map[string]config.Variable{ + acctest.CtKey2: config.StringVariable(acctest.CtValue2), + }), + acctest.CtResourceTags: nil, + }, + Check: resource.ComposeAggregateTestCheckFunc( + testAccCheckTrustStoreExists(ctx, resourceName, &v), + ), + ConfigStateChecks: []statecheck.StateCheck{ + statecheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTags), knownvalue.Null()), + statecheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTagsAll), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtKey2: knownvalue.StringExact(acctest.CtValue2), + })), + }, + ConfigPlanChecks: resource.ConfigPlanChecks{ + PreApply: []plancheck.PlanCheck{ + plancheck.ExpectResourceAction(resourceName, plancheck.ResourceActionUpdate), + plancheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTags), knownvalue.Null()), + plancheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTagsAll), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtKey2: knownvalue.StringExact(acctest.CtValue2), + })), + }, + }, + }, + { + ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories, + ConfigDirectory: config.StaticDirectory("testdata/TrustStore/tags_defaults/"), + ConfigVariables: config.Variables{ + acctest.CtProviderTags: config.MapVariable(map[string]config.Variable{ + acctest.CtKey2: config.StringVariable(acctest.CtValue2), + }), + acctest.CtResourceTags: nil, + }, + ResourceName: resourceName, + ImportState: true, + ImportStateIdFunc: acctest.AttrImportStateIdFunc(resourceName, "trust_store_arn"), + ImportStateVerify: true, + ImportStateVerifyIdentifierAttribute: "trust_store_arn", + ImportStateVerifyIgnore: []string{ + "certificate_list", + }, + }, + { + ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories, + ConfigDirectory: config.StaticDirectory("testdata/TrustStore/tags/"), + ConfigVariables: config.Variables{ + acctest.CtResourceTags: nil, + }, + Check: resource.ComposeAggregateTestCheckFunc( + testAccCheckTrustStoreExists(ctx, resourceName, &v), + ), + ConfigStateChecks: []statecheck.StateCheck{ + statecheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTags), knownvalue.Null()), + statecheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTagsAll), knownvalue.MapExact(map[string]knownvalue.Check{})), + }, + ConfigPlanChecks: resource.ConfigPlanChecks{ + PreApply: []plancheck.PlanCheck{ + plancheck.ExpectResourceAction(resourceName, plancheck.ResourceActionUpdate), + plancheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTags), knownvalue.Null()), + plancheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTagsAll), knownvalue.MapExact(map[string]knownvalue.Check{})), + }, + }, + }, + { + ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories, + ConfigDirectory: config.StaticDirectory("testdata/TrustStore/tags/"), + ConfigVariables: config.Variables{ + acctest.CtResourceTags: nil, + }, + ResourceName: resourceName, + ImportState: true, + ImportStateIdFunc: acctest.AttrImportStateIdFunc(resourceName, "trust_store_arn"), + ImportStateVerify: true, + ImportStateVerifyIdentifierAttribute: "trust_store_arn", + ImportStateVerifyIgnore: []string{ + "certificate_list", + }, + }, + }, + }) +} + +func TestAccWorkSpacesWebTrustStore_tags_DefaultTags_nonOverlapping(t *testing.T) { + ctx := acctest.Context(t) + + var v types.TrustStore + resourceName := "aws_workspacesweb_trust_store.test" + + acctest.ParallelTest(ctx, t, resource.TestCase{ + PreCheck: func() { acctest.PreCheck(ctx, t) }, + ErrorCheck: acctest.ErrorCheck(t, names.WorkSpacesWebServiceID), + CheckDestroy: testAccCheckTrustStoreDestroy(ctx), + Steps: []resource.TestStep{ + { + ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories, + ConfigDirectory: config.StaticDirectory("testdata/TrustStore/tags_defaults/"), + ConfigVariables: config.Variables{ + acctest.CtProviderTags: config.MapVariable(map[string]config.Variable{ + acctest.CtProviderKey1: config.StringVariable(acctest.CtProviderValue1), + }), + acctest.CtResourceTags: config.MapVariable(map[string]config.Variable{ + acctest.CtResourceKey1: config.StringVariable(acctest.CtResourceValue1), + }), + }, + Check: resource.ComposeAggregateTestCheckFunc( + testAccCheckTrustStoreExists(ctx, resourceName, &v), + ), + ConfigStateChecks: []statecheck.StateCheck{ + statecheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTags), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtResourceKey1: knownvalue.StringExact(acctest.CtResourceValue1), + })), + statecheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTagsAll), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtProviderKey1: knownvalue.StringExact(acctest.CtProviderValue1), + acctest.CtResourceKey1: knownvalue.StringExact(acctest.CtResourceValue1), + })), + }, + ConfigPlanChecks: resource.ConfigPlanChecks{ + PreApply: []plancheck.PlanCheck{ + plancheck.ExpectResourceAction(resourceName, plancheck.ResourceActionCreate), + plancheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTags), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtResourceKey1: knownvalue.StringExact(acctest.CtResourceValue1), + })), + plancheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTagsAll), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtProviderKey1: knownvalue.StringExact(acctest.CtProviderValue1), + acctest.CtResourceKey1: knownvalue.StringExact(acctest.CtResourceValue1), + })), + }, + }, + }, + { + ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories, + ConfigDirectory: config.StaticDirectory("testdata/TrustStore/tags_defaults/"), + ConfigVariables: config.Variables{ + acctest.CtProviderTags: config.MapVariable(map[string]config.Variable{ + acctest.CtProviderKey1: config.StringVariable(acctest.CtProviderValue1), + }), + acctest.CtResourceTags: config.MapVariable(map[string]config.Variable{ + acctest.CtResourceKey1: config.StringVariable(acctest.CtResourceValue1), + }), + }, + ResourceName: resourceName, + ImportState: true, + ImportStateIdFunc: acctest.AttrImportStateIdFunc(resourceName, "trust_store_arn"), + ImportStateVerify: true, + ImportStateVerifyIdentifierAttribute: "trust_store_arn", + ImportStateVerifyIgnore: []string{ + "certificate_list", + }, + }, + { + ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories, + ConfigDirectory: config.StaticDirectory("testdata/TrustStore/tags_defaults/"), + ConfigVariables: config.Variables{ + acctest.CtProviderTags: config.MapVariable(map[string]config.Variable{ + acctest.CtProviderKey1: config.StringVariable(acctest.CtProviderValue1Updated), + }), + acctest.CtResourceTags: config.MapVariable(map[string]config.Variable{ + acctest.CtResourceKey1: config.StringVariable(acctest.CtResourceValue1Updated), + acctest.CtResourceKey2: config.StringVariable(acctest.CtResourceValue2), + }), + }, + Check: resource.ComposeAggregateTestCheckFunc( + testAccCheckTrustStoreExists(ctx, resourceName, &v), + ), + ConfigStateChecks: []statecheck.StateCheck{ + statecheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTags), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtResourceKey1: knownvalue.StringExact(acctest.CtResourceValue1Updated), + acctest.CtResourceKey2: knownvalue.StringExact(acctest.CtResourceValue2), + })), + statecheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTagsAll), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtProviderKey1: knownvalue.StringExact(acctest.CtProviderValue1Updated), + acctest.CtResourceKey1: knownvalue.StringExact(acctest.CtResourceValue1Updated), + acctest.CtResourceKey2: knownvalue.StringExact(acctest.CtResourceValue2), + })), + }, + ConfigPlanChecks: resource.ConfigPlanChecks{ + PreApply: []plancheck.PlanCheck{ + plancheck.ExpectResourceAction(resourceName, plancheck.ResourceActionUpdate), + plancheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTags), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtResourceKey1: knownvalue.StringExact(acctest.CtResourceValue1Updated), + acctest.CtResourceKey2: knownvalue.StringExact(acctest.CtResourceValue2), + })), + plancheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTagsAll), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtProviderKey1: knownvalue.StringExact(acctest.CtProviderValue1Updated), + acctest.CtResourceKey1: knownvalue.StringExact(acctest.CtResourceValue1Updated), + acctest.CtResourceKey2: knownvalue.StringExact(acctest.CtResourceValue2), + })), + }, + }, + }, + { + ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories, + ConfigDirectory: config.StaticDirectory("testdata/TrustStore/tags_defaults/"), + ConfigVariables: config.Variables{ + acctest.CtProviderTags: config.MapVariable(map[string]config.Variable{ + acctest.CtProviderKey1: config.StringVariable(acctest.CtProviderValue1Updated), + }), + acctest.CtResourceTags: config.MapVariable(map[string]config.Variable{ + acctest.CtResourceKey1: config.StringVariable(acctest.CtResourceValue1Updated), + acctest.CtResourceKey2: config.StringVariable(acctest.CtResourceValue2), + }), + }, + ResourceName: resourceName, + ImportState: true, + ImportStateIdFunc: acctest.AttrImportStateIdFunc(resourceName, "trust_store_arn"), + ImportStateVerify: true, + ImportStateVerifyIdentifierAttribute: "trust_store_arn", + ImportStateVerifyIgnore: []string{ + "certificate_list", + }, + }, + { + ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories, + ConfigDirectory: config.StaticDirectory("testdata/TrustStore/tags/"), + ConfigVariables: config.Variables{ + acctest.CtResourceTags: nil, + }, + Check: resource.ComposeAggregateTestCheckFunc( + testAccCheckTrustStoreExists(ctx, resourceName, &v), + ), + ConfigStateChecks: []statecheck.StateCheck{ + statecheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTags), knownvalue.Null()), + statecheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTagsAll), knownvalue.MapExact(map[string]knownvalue.Check{})), + }, + ConfigPlanChecks: resource.ConfigPlanChecks{ + PreApply: []plancheck.PlanCheck{ + plancheck.ExpectResourceAction(resourceName, plancheck.ResourceActionUpdate), + plancheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTags), knownvalue.Null()), + plancheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTagsAll), knownvalue.MapExact(map[string]knownvalue.Check{})), + }, + }, + }, + { + ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories, + ConfigDirectory: config.StaticDirectory("testdata/TrustStore/tags/"), + ConfigVariables: config.Variables{ + acctest.CtResourceTags: nil, + }, + ResourceName: resourceName, + ImportState: true, + ImportStateIdFunc: acctest.AttrImportStateIdFunc(resourceName, "trust_store_arn"), + ImportStateVerify: true, + ImportStateVerifyIdentifierAttribute: "trust_store_arn", + ImportStateVerifyIgnore: []string{ + "certificate_list", + }, + }, + }, + }) +} + +func TestAccWorkSpacesWebTrustStore_tags_DefaultTags_overlapping(t *testing.T) { + ctx := acctest.Context(t) + + var v types.TrustStore + resourceName := "aws_workspacesweb_trust_store.test" + + acctest.ParallelTest(ctx, t, resource.TestCase{ + PreCheck: func() { acctest.PreCheck(ctx, t) }, + ErrorCheck: acctest.ErrorCheck(t, names.WorkSpacesWebServiceID), + CheckDestroy: testAccCheckTrustStoreDestroy(ctx), + Steps: []resource.TestStep{ + { + ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories, + ConfigDirectory: config.StaticDirectory("testdata/TrustStore/tags_defaults/"), + ConfigVariables: config.Variables{ + acctest.CtProviderTags: config.MapVariable(map[string]config.Variable{ + acctest.CtOverlapKey1: config.StringVariable(acctest.CtProviderValue1), + }), + acctest.CtResourceTags: config.MapVariable(map[string]config.Variable{ + acctest.CtOverlapKey1: config.StringVariable(acctest.CtResourceValue1), + }), + }, + Check: resource.ComposeAggregateTestCheckFunc( + testAccCheckTrustStoreExists(ctx, resourceName, &v), + ), + ConfigStateChecks: []statecheck.StateCheck{ + statecheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTags), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtOverlapKey1: knownvalue.StringExact(acctest.CtResourceValue1), + })), + statecheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTagsAll), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtOverlapKey1: knownvalue.StringExact(acctest.CtResourceValue1), + })), + }, + ConfigPlanChecks: resource.ConfigPlanChecks{ + PreApply: []plancheck.PlanCheck{ + plancheck.ExpectResourceAction(resourceName, plancheck.ResourceActionCreate), + plancheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTags), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtOverlapKey1: knownvalue.StringExact(acctest.CtResourceValue1), + })), + plancheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTagsAll), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtOverlapKey1: knownvalue.StringExact(acctest.CtResourceValue1), + })), + }, + }, + }, + { + ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories, + ConfigDirectory: config.StaticDirectory("testdata/TrustStore/tags_defaults/"), + ConfigVariables: config.Variables{ + acctest.CtProviderTags: config.MapVariable(map[string]config.Variable{ + acctest.CtOverlapKey1: config.StringVariable(acctest.CtProviderValue1), + }), + acctest.CtResourceTags: config.MapVariable(map[string]config.Variable{ + acctest.CtOverlapKey1: config.StringVariable(acctest.CtResourceValue1), + }), + }, + ResourceName: resourceName, + ImportState: true, + ImportStateIdFunc: acctest.AttrImportStateIdFunc(resourceName, "trust_store_arn"), + ImportStateVerify: true, + ImportStateVerifyIdentifierAttribute: "trust_store_arn", + ImportStateVerifyIgnore: []string{ + "certificate_list", + }, + }, + { + ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories, + ConfigDirectory: config.StaticDirectory("testdata/TrustStore/tags_defaults/"), + ConfigVariables: config.Variables{ + acctest.CtProviderTags: config.MapVariable(map[string]config.Variable{ + acctest.CtOverlapKey1: config.StringVariable(acctest.CtProviderValue1), + acctest.CtOverlapKey2: config.StringVariable("providervalue2"), + }), + acctest.CtResourceTags: config.MapVariable(map[string]config.Variable{ + acctest.CtOverlapKey1: config.StringVariable(acctest.CtResourceValue1), + acctest.CtOverlapKey2: config.StringVariable(acctest.CtResourceValue2), + }), + }, + Check: resource.ComposeAggregateTestCheckFunc( + testAccCheckTrustStoreExists(ctx, resourceName, &v), + ), + ConfigStateChecks: []statecheck.StateCheck{ + statecheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTags), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtOverlapKey1: knownvalue.StringExact(acctest.CtResourceValue1), + acctest.CtOverlapKey2: knownvalue.StringExact(acctest.CtResourceValue2), + })), + statecheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTagsAll), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtOverlapKey1: knownvalue.StringExact(acctest.CtResourceValue1), + acctest.CtOverlapKey2: knownvalue.StringExact(acctest.CtResourceValue2), + })), + }, + ConfigPlanChecks: resource.ConfigPlanChecks{ + PreApply: []plancheck.PlanCheck{ + plancheck.ExpectResourceAction(resourceName, plancheck.ResourceActionUpdate), + plancheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTags), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtOverlapKey1: knownvalue.StringExact(acctest.CtResourceValue1), + acctest.CtOverlapKey2: knownvalue.StringExact(acctest.CtResourceValue2), + })), + plancheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTagsAll), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtOverlapKey1: knownvalue.StringExact(acctest.CtResourceValue1), + acctest.CtOverlapKey2: knownvalue.StringExact(acctest.CtResourceValue2), + })), + }, + }, + }, + { + ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories, + ConfigDirectory: config.StaticDirectory("testdata/TrustStore/tags_defaults/"), + ConfigVariables: config.Variables{ + acctest.CtProviderTags: config.MapVariable(map[string]config.Variable{ + acctest.CtOverlapKey1: config.StringVariable(acctest.CtProviderValue1), + acctest.CtOverlapKey2: config.StringVariable("providervalue2"), + }), + acctest.CtResourceTags: config.MapVariable(map[string]config.Variable{ + acctest.CtOverlapKey1: config.StringVariable(acctest.CtResourceValue1), + acctest.CtOverlapKey2: config.StringVariable(acctest.CtResourceValue2), + }), + }, + ResourceName: resourceName, + ImportState: true, + ImportStateIdFunc: acctest.AttrImportStateIdFunc(resourceName, "trust_store_arn"), + ImportStateVerify: true, + ImportStateVerifyIdentifierAttribute: "trust_store_arn", + ImportStateVerifyIgnore: []string{ + "certificate_list", + }, + }, + { + ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories, + ConfigDirectory: config.StaticDirectory("testdata/TrustStore/tags_defaults/"), + ConfigVariables: config.Variables{ + acctest.CtProviderTags: config.MapVariable(map[string]config.Variable{ + acctest.CtOverlapKey1: config.StringVariable(acctest.CtProviderValue1), + }), + acctest.CtResourceTags: config.MapVariable(map[string]config.Variable{ + acctest.CtOverlapKey1: config.StringVariable(acctest.CtResourceValue2), + }), + }, + Check: resource.ComposeAggregateTestCheckFunc( + testAccCheckTrustStoreExists(ctx, resourceName, &v), + ), + ConfigStateChecks: []statecheck.StateCheck{ + statecheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTags), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtOverlapKey1: knownvalue.StringExact(acctest.CtResourceValue2), + })), + statecheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTagsAll), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtOverlapKey1: knownvalue.StringExact(acctest.CtResourceValue2), + })), + }, + ConfigPlanChecks: resource.ConfigPlanChecks{ + PreApply: []plancheck.PlanCheck{ + plancheck.ExpectResourceAction(resourceName, plancheck.ResourceActionUpdate), + plancheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTags), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtOverlapKey1: knownvalue.StringExact(acctest.CtResourceValue2), + })), + plancheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTagsAll), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtOverlapKey1: knownvalue.StringExact(acctest.CtResourceValue2), + })), + }, + }, + }, + { + ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories, + ConfigDirectory: config.StaticDirectory("testdata/TrustStore/tags_defaults/"), + ConfigVariables: config.Variables{ + acctest.CtProviderTags: config.MapVariable(map[string]config.Variable{ + acctest.CtOverlapKey1: config.StringVariable(acctest.CtProviderValue1), + }), + acctest.CtResourceTags: config.MapVariable(map[string]config.Variable{ + acctest.CtOverlapKey1: config.StringVariable(acctest.CtResourceValue2), + }), + }, + ResourceName: resourceName, + ImportState: true, + ImportStateIdFunc: acctest.AttrImportStateIdFunc(resourceName, "trust_store_arn"), + ImportStateVerify: true, + ImportStateVerifyIdentifierAttribute: "trust_store_arn", + ImportStateVerifyIgnore: []string{ + "certificate_list", + }, + }, + }, + }) +} + +func TestAccWorkSpacesWebTrustStore_tags_DefaultTags_updateToProviderOnly(t *testing.T) { + ctx := acctest.Context(t) + + var v types.TrustStore + resourceName := "aws_workspacesweb_trust_store.test" + + acctest.ParallelTest(ctx, t, resource.TestCase{ + PreCheck: func() { acctest.PreCheck(ctx, t) }, + ErrorCheck: acctest.ErrorCheck(t, names.WorkSpacesWebServiceID), + CheckDestroy: testAccCheckTrustStoreDestroy(ctx), + Steps: []resource.TestStep{ + { + ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories, + ConfigDirectory: config.StaticDirectory("testdata/TrustStore/tags/"), + ConfigVariables: config.Variables{ + acctest.CtResourceTags: config.MapVariable(map[string]config.Variable{ + acctest.CtKey1: config.StringVariable(acctest.CtValue1), + }), + }, + Check: resource.ComposeAggregateTestCheckFunc( + testAccCheckTrustStoreExists(ctx, resourceName, &v), + ), + ConfigStateChecks: []statecheck.StateCheck{ + statecheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTags), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtKey1: knownvalue.StringExact(acctest.CtValue1), + })), + statecheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTagsAll), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtKey1: knownvalue.StringExact(acctest.CtValue1), + })), + }, + ConfigPlanChecks: resource.ConfigPlanChecks{ + PreApply: []plancheck.PlanCheck{ + plancheck.ExpectResourceAction(resourceName, plancheck.ResourceActionCreate), + plancheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTags), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtKey1: knownvalue.StringExact(acctest.CtValue1), + })), + plancheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTagsAll), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtKey1: knownvalue.StringExact(acctest.CtValue1), + })), + }, + }, + }, + { + ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories, + ConfigDirectory: config.StaticDirectory("testdata/TrustStore/tags_defaults/"), + ConfigVariables: config.Variables{ + acctest.CtProviderTags: config.MapVariable(map[string]config.Variable{ + acctest.CtKey1: config.StringVariable(acctest.CtValue1), + }), + acctest.CtResourceTags: nil, + }, + Check: resource.ComposeAggregateTestCheckFunc( + testAccCheckTrustStoreExists(ctx, resourceName, &v), + ), + ConfigStateChecks: []statecheck.StateCheck{ + statecheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTags), knownvalue.Null()), + statecheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTagsAll), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtKey1: knownvalue.StringExact(acctest.CtValue1), + })), + }, + ConfigPlanChecks: resource.ConfigPlanChecks{ + PreApply: []plancheck.PlanCheck{ + plancheck.ExpectResourceAction(resourceName, plancheck.ResourceActionUpdate), + plancheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTags), knownvalue.Null()), + plancheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTagsAll), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtKey1: knownvalue.StringExact(acctest.CtValue1), + })), + }, + }, + }, + { + ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories, + ConfigDirectory: config.StaticDirectory("testdata/TrustStore/tags_defaults/"), + ConfigVariables: config.Variables{ + acctest.CtProviderTags: config.MapVariable(map[string]config.Variable{ + acctest.CtKey1: config.StringVariable(acctest.CtValue1), + }), + acctest.CtResourceTags: nil, + }, + ResourceName: resourceName, + ImportState: true, + ImportStateIdFunc: acctest.AttrImportStateIdFunc(resourceName, "trust_store_arn"), + ImportStateVerify: true, + ImportStateVerifyIdentifierAttribute: "trust_store_arn", + ImportStateVerifyIgnore: []string{ + "certificate_list", + }, + }, + }, + }) +} + +func TestAccWorkSpacesWebTrustStore_tags_DefaultTags_updateToResourceOnly(t *testing.T) { + ctx := acctest.Context(t) + + var v types.TrustStore + resourceName := "aws_workspacesweb_trust_store.test" + + acctest.ParallelTest(ctx, t, resource.TestCase{ + PreCheck: func() { acctest.PreCheck(ctx, t) }, + ErrorCheck: acctest.ErrorCheck(t, names.WorkSpacesWebServiceID), + CheckDestroy: testAccCheckTrustStoreDestroy(ctx), + Steps: []resource.TestStep{ + { + ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories, + ConfigDirectory: config.StaticDirectory("testdata/TrustStore/tags_defaults/"), + ConfigVariables: config.Variables{ + acctest.CtProviderTags: config.MapVariable(map[string]config.Variable{ + acctest.CtKey1: config.StringVariable(acctest.CtValue1), + }), + acctest.CtResourceTags: nil, + }, + Check: resource.ComposeAggregateTestCheckFunc( + testAccCheckTrustStoreExists(ctx, resourceName, &v), + ), + ConfigStateChecks: []statecheck.StateCheck{ + statecheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTags), knownvalue.Null()), + statecheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTagsAll), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtKey1: knownvalue.StringExact(acctest.CtValue1), + })), + }, + ConfigPlanChecks: resource.ConfigPlanChecks{ + PreApply: []plancheck.PlanCheck{ + plancheck.ExpectResourceAction(resourceName, plancheck.ResourceActionCreate), + plancheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTags), knownvalue.Null()), + plancheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTagsAll), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtKey1: knownvalue.StringExact(acctest.CtValue1), + })), + }, + }, + }, + { + ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories, + ConfigDirectory: config.StaticDirectory("testdata/TrustStore/tags/"), + ConfigVariables: config.Variables{ + acctest.CtResourceTags: config.MapVariable(map[string]config.Variable{ + acctest.CtKey1: config.StringVariable(acctest.CtValue1), + }), + }, + Check: resource.ComposeAggregateTestCheckFunc( + testAccCheckTrustStoreExists(ctx, resourceName, &v), + ), + ConfigStateChecks: []statecheck.StateCheck{ + statecheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTags), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtKey1: knownvalue.StringExact(acctest.CtValue1), + })), + statecheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTagsAll), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtKey1: knownvalue.StringExact(acctest.CtValue1), + })), + }, + ConfigPlanChecks: resource.ConfigPlanChecks{ + PreApply: []plancheck.PlanCheck{ + plancheck.ExpectResourceAction(resourceName, plancheck.ResourceActionNoop), + plancheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTags), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtKey1: knownvalue.StringExact(acctest.CtValue1), + })), + plancheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTagsAll), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtKey1: knownvalue.StringExact(acctest.CtValue1), + })), + }, + }, + }, + { + ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories, + ConfigDirectory: config.StaticDirectory("testdata/TrustStore/tags/"), + ConfigVariables: config.Variables{ + acctest.CtResourceTags: config.MapVariable(map[string]config.Variable{ + acctest.CtKey1: config.StringVariable(acctest.CtValue1), + }), + }, + ResourceName: resourceName, + ImportState: true, + ImportStateIdFunc: acctest.AttrImportStateIdFunc(resourceName, "trust_store_arn"), + ImportStateVerify: true, + ImportStateVerifyIdentifierAttribute: "trust_store_arn", + ImportStateVerifyIgnore: []string{ + "certificate_list", + }, + }, + }, + }) +} + +func TestAccWorkSpacesWebTrustStore_tags_DefaultTags_emptyResourceTag(t *testing.T) { + ctx := acctest.Context(t) + + var v types.TrustStore + resourceName := "aws_workspacesweb_trust_store.test" + + acctest.ParallelTest(ctx, t, resource.TestCase{ + PreCheck: func() { acctest.PreCheck(ctx, t) }, + ErrorCheck: acctest.ErrorCheck(t, names.WorkSpacesWebServiceID), + CheckDestroy: testAccCheckTrustStoreDestroy(ctx), + Steps: []resource.TestStep{ + { + ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories, + ConfigDirectory: config.StaticDirectory("testdata/TrustStore/tags_defaults/"), + ConfigVariables: config.Variables{ + acctest.CtProviderTags: config.MapVariable(map[string]config.Variable{ + acctest.CtKey1: config.StringVariable(acctest.CtValue1), + }), + acctest.CtResourceTags: config.MapVariable(map[string]config.Variable{ + acctest.CtKey1: config.StringVariable(""), + }), + }, + Check: resource.ComposeAggregateTestCheckFunc( + testAccCheckTrustStoreExists(ctx, resourceName, &v), + ), + ConfigStateChecks: []statecheck.StateCheck{ + statecheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTags), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtKey1: knownvalue.StringExact(""), + })), + statecheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTagsAll), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtKey1: knownvalue.StringExact(""), + })), + }, + ConfigPlanChecks: resource.ConfigPlanChecks{ + PreApply: []plancheck.PlanCheck{ + plancheck.ExpectResourceAction(resourceName, plancheck.ResourceActionCreate), + plancheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTags), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtKey1: knownvalue.StringExact(""), + })), + plancheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTagsAll), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtKey1: knownvalue.StringExact(""), + })), + }, + }, + }, + { + ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories, + ConfigDirectory: config.StaticDirectory("testdata/TrustStore/tags_defaults/"), + ConfigVariables: config.Variables{ + acctest.CtProviderTags: config.MapVariable(map[string]config.Variable{ + acctest.CtKey1: config.StringVariable(acctest.CtValue1), + }), + acctest.CtResourceTags: config.MapVariable(map[string]config.Variable{ + acctest.CtKey1: config.StringVariable(""), + }), + }, + ResourceName: resourceName, + ImportState: true, + ImportStateIdFunc: acctest.AttrImportStateIdFunc(resourceName, "trust_store_arn"), + ImportStateVerify: true, + ImportStateVerifyIdentifierAttribute: "trust_store_arn", + ImportStateVerifyIgnore: []string{ + "certificate_list", + }, + }, + }, + }) +} + +func TestAccWorkSpacesWebTrustStore_tags_DefaultTags_emptyProviderOnlyTag(t *testing.T) { + ctx := acctest.Context(t) + + var v types.TrustStore + resourceName := "aws_workspacesweb_trust_store.test" + + acctest.ParallelTest(ctx, t, resource.TestCase{ + PreCheck: func() { acctest.PreCheck(ctx, t) }, + ErrorCheck: acctest.ErrorCheck(t, names.WorkSpacesWebServiceID), + CheckDestroy: testAccCheckTrustStoreDestroy(ctx), + Steps: []resource.TestStep{ + { + ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories, + ConfigDirectory: config.StaticDirectory("testdata/TrustStore/tags_defaults/"), + ConfigVariables: config.Variables{ + acctest.CtProviderTags: config.MapVariable(map[string]config.Variable{ + acctest.CtKey1: config.StringVariable(""), + }), + acctest.CtResourceTags: nil, + }, + Check: resource.ComposeAggregateTestCheckFunc( + testAccCheckTrustStoreExists(ctx, resourceName, &v), + ), + ConfigStateChecks: []statecheck.StateCheck{ + statecheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTags), knownvalue.Null()), + statecheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTagsAll), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtKey1: knownvalue.StringExact(""), + })), + }, + ConfigPlanChecks: resource.ConfigPlanChecks{ + PreApply: []plancheck.PlanCheck{ + plancheck.ExpectResourceAction(resourceName, plancheck.ResourceActionCreate), + plancheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTags), knownvalue.Null()), + plancheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTagsAll), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtKey1: knownvalue.StringExact(""), + })), + }, + }, + }, + { + ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories, + ConfigDirectory: config.StaticDirectory("testdata/TrustStore/tags_defaults/"), + ConfigVariables: config.Variables{ + acctest.CtProviderTags: config.MapVariable(map[string]config.Variable{ + acctest.CtKey1: config.StringVariable(""), + }), + acctest.CtResourceTags: nil, + }, + ResourceName: resourceName, + ImportState: true, + ImportStateIdFunc: acctest.AttrImportStateIdFunc(resourceName, "trust_store_arn"), + ImportStateVerify: true, + ImportStateVerifyIdentifierAttribute: "trust_store_arn", + ImportStateVerifyIgnore: []string{ + "certificate_list", + }, + }, + }, + }) +} + +func TestAccWorkSpacesWebTrustStore_tags_DefaultTags_nullOverlappingResourceTag(t *testing.T) { + ctx := acctest.Context(t) + + var v types.TrustStore + resourceName := "aws_workspacesweb_trust_store.test" + + acctest.ParallelTest(ctx, t, resource.TestCase{ + PreCheck: func() { acctest.PreCheck(ctx, t) }, + ErrorCheck: acctest.ErrorCheck(t, names.WorkSpacesWebServiceID), + CheckDestroy: testAccCheckTrustStoreDestroy(ctx), + Steps: []resource.TestStep{ + { + ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories, + ConfigDirectory: config.StaticDirectory("testdata/TrustStore/tags_defaults/"), + ConfigVariables: config.Variables{ + acctest.CtProviderTags: config.MapVariable(map[string]config.Variable{ + acctest.CtKey1: config.StringVariable(acctest.CtProviderValue1), + }), + acctest.CtResourceTags: config.MapVariable(map[string]config.Variable{ + acctest.CtKey1: nil, + }), + }, + Check: resource.ComposeAggregateTestCheckFunc( + testAccCheckTrustStoreExists(ctx, resourceName, &v), + ), + ConfigStateChecks: []statecheck.StateCheck{ + statecheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTags), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtKey1: knownvalue.Null(), + })), + statecheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTagsAll), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtKey1: knownvalue.StringExact(""), + })), + }, + ConfigPlanChecks: resource.ConfigPlanChecks{ + PreApply: []plancheck.PlanCheck{ + plancheck.ExpectResourceAction(resourceName, plancheck.ResourceActionCreate), + plancheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTags), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtKey1: knownvalue.Null(), + })), + plancheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTagsAll), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtKey1: knownvalue.StringExact(""), + })), + }, + }, + }, + { + ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories, + ConfigDirectory: config.StaticDirectory("testdata/TrustStore/tags_defaults/"), + ConfigVariables: config.Variables{ + acctest.CtProviderTags: config.MapVariable(map[string]config.Variable{ + acctest.CtKey1: config.StringVariable(acctest.CtProviderValue1), + }), + acctest.CtResourceTags: config.MapVariable(map[string]config.Variable{ + acctest.CtKey1: nil, + }), + }, + ResourceName: resourceName, + ImportState: true, + ImportStateIdFunc: acctest.AttrImportStateIdFunc(resourceName, "trust_store_arn"), + ImportStateVerify: true, + ImportStateVerifyIdentifierAttribute: "trust_store_arn", + ImportStateVerifyIgnore: []string{ + acctest.CtTagsKey1, // The canonical value returned by the AWS API is "" + "certificate_list", + }, + }, + }, + }) +} + +func TestAccWorkSpacesWebTrustStore_tags_DefaultTags_nullNonOverlappingResourceTag(t *testing.T) { + ctx := acctest.Context(t) + + var v types.TrustStore + resourceName := "aws_workspacesweb_trust_store.test" + + acctest.ParallelTest(ctx, t, resource.TestCase{ + PreCheck: func() { acctest.PreCheck(ctx, t) }, + ErrorCheck: acctest.ErrorCheck(t, names.WorkSpacesWebServiceID), + CheckDestroy: testAccCheckTrustStoreDestroy(ctx), + Steps: []resource.TestStep{ + { + ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories, + ConfigDirectory: config.StaticDirectory("testdata/TrustStore/tags_defaults/"), + ConfigVariables: config.Variables{ + acctest.CtProviderTags: config.MapVariable(map[string]config.Variable{ + acctest.CtProviderKey1: config.StringVariable(acctest.CtProviderValue1), + }), + acctest.CtResourceTags: config.MapVariable(map[string]config.Variable{ + acctest.CtResourceKey1: nil, + }), + }, + Check: resource.ComposeAggregateTestCheckFunc( + testAccCheckTrustStoreExists(ctx, resourceName, &v), + ), + ConfigStateChecks: []statecheck.StateCheck{ + statecheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTags), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtResourceKey1: knownvalue.Null(), + })), + statecheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTagsAll), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtResourceKey1: knownvalue.StringExact(""), + acctest.CtProviderKey1: knownvalue.StringExact(acctest.CtProviderValue1), + })), + }, + ConfigPlanChecks: resource.ConfigPlanChecks{ + PreApply: []plancheck.PlanCheck{ + plancheck.ExpectResourceAction(resourceName, plancheck.ResourceActionCreate), + plancheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTags), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtResourceKey1: knownvalue.Null(), + })), + plancheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTagsAll), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtResourceKey1: knownvalue.StringExact(""), + acctest.CtProviderKey1: knownvalue.StringExact(acctest.CtProviderValue1), + })), + }, + }, + }, + { + ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories, + ConfigDirectory: config.StaticDirectory("testdata/TrustStore/tags_defaults/"), + ConfigVariables: config.Variables{ + acctest.CtProviderTags: config.MapVariable(map[string]config.Variable{ + acctest.CtProviderKey1: config.StringVariable(acctest.CtProviderValue1), + }), + acctest.CtResourceTags: config.MapVariable(map[string]config.Variable{ + acctest.CtResourceKey1: nil, + }), + }, + ResourceName: resourceName, + ImportState: true, + ImportStateIdFunc: acctest.AttrImportStateIdFunc(resourceName, "trust_store_arn"), + ImportStateVerify: true, + ImportStateVerifyIdentifierAttribute: "trust_store_arn", + ImportStateVerifyIgnore: []string{ + "tags.resourcekey1", // The canonical value returned by the AWS API is "" + "certificate_list", + }, + }, + }, + }) +} + +func TestAccWorkSpacesWebTrustStore_tags_ComputedTag_OnCreate(t *testing.T) { + ctx := acctest.Context(t) + + var v types.TrustStore + resourceName := "aws_workspacesweb_trust_store.test" + + acctest.ParallelTest(ctx, t, resource.TestCase{ + PreCheck: func() { acctest.PreCheck(ctx, t) }, + ErrorCheck: acctest.ErrorCheck(t, names.WorkSpacesWebServiceID), + CheckDestroy: testAccCheckTrustStoreDestroy(ctx), + Steps: []resource.TestStep{ + { + ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories, + ConfigDirectory: config.StaticDirectory("testdata/TrustStore/tagsComputed1/"), + ConfigVariables: config.Variables{ + "unknownTagKey": config.StringVariable("computedkey1"), + }, + Check: resource.ComposeAggregateTestCheckFunc( + testAccCheckTrustStoreExists(ctx, resourceName, &v), + resource.TestCheckResourceAttrPair(resourceName, "tags.computedkey1", "null_resource.test", names.AttrID), + ), + ConfigStateChecks: []statecheck.StateCheck{ + statecheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTags), knownvalue.MapSizeExact(1)), + statecheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTagsAll), knownvalue.MapSizeExact(1)), + }, + ConfigPlanChecks: resource.ConfigPlanChecks{ + PreApply: []plancheck.PlanCheck{ + plancheck.ExpectResourceAction(resourceName, plancheck.ResourceActionCreate), + plancheck.ExpectUnknownValue(resourceName, tfjsonpath.New(names.AttrTags).AtMapKey("computedkey1")), + plancheck.ExpectUnknownValue(resourceName, tfjsonpath.New(names.AttrTagsAll)), + }, + PostApplyPreRefresh: []plancheck.PlanCheck{ + plancheck.ExpectResourceAction(resourceName, plancheck.ResourceActionNoop), + }, + PostApplyPostRefresh: []plancheck.PlanCheck{ + plancheck.ExpectResourceAction(resourceName, plancheck.ResourceActionNoop), + }, + }, + }, + { + ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories, + ConfigDirectory: config.StaticDirectory("testdata/TrustStore/tagsComputed1/"), + ConfigVariables: config.Variables{ + "unknownTagKey": config.StringVariable("computedkey1"), + }, + ResourceName: resourceName, + ImportState: true, + ImportStateIdFunc: acctest.AttrImportStateIdFunc(resourceName, "trust_store_arn"), + ImportStateVerify: true, + ImportStateVerifyIdentifierAttribute: "trust_store_arn", + ImportStateVerifyIgnore: []string{ + "certificate_list", + }, + }, + }, + }) +} + +func TestAccWorkSpacesWebTrustStore_tags_ComputedTag_OnUpdate_Add(t *testing.T) { + ctx := acctest.Context(t) + + var v types.TrustStore + resourceName := "aws_workspacesweb_trust_store.test" + + acctest.ParallelTest(ctx, t, resource.TestCase{ + PreCheck: func() { acctest.PreCheck(ctx, t) }, + ErrorCheck: acctest.ErrorCheck(t, names.WorkSpacesWebServiceID), + CheckDestroy: testAccCheckTrustStoreDestroy(ctx), + Steps: []resource.TestStep{ + { + ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories, + ConfigDirectory: config.StaticDirectory("testdata/TrustStore/tags/"), + ConfigVariables: config.Variables{ + acctest.CtResourceTags: config.MapVariable(map[string]config.Variable{ + acctest.CtKey1: config.StringVariable(acctest.CtValue1), + }), + }, + Check: resource.ComposeAggregateTestCheckFunc( + testAccCheckTrustStoreExists(ctx, resourceName, &v), + ), + ConfigStateChecks: []statecheck.StateCheck{ + statecheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTags), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtKey1: knownvalue.StringExact(acctest.CtValue1), + })), + statecheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTagsAll), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtKey1: knownvalue.StringExact(acctest.CtValue1), + })), + }, + ConfigPlanChecks: resource.ConfigPlanChecks{ + PreApply: []plancheck.PlanCheck{ + plancheck.ExpectResourceAction(resourceName, plancheck.ResourceActionCreate), + plancheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTags), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtKey1: knownvalue.StringExact(acctest.CtValue1), + })), + plancheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTagsAll), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtKey1: knownvalue.StringExact(acctest.CtValue1), + })), + }, + }, + }, + { + ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories, + ConfigDirectory: config.StaticDirectory("testdata/TrustStore/tagsComputed2/"), + ConfigVariables: config.Variables{ + "unknownTagKey": config.StringVariable("computedkey1"), + "knownTagKey": config.StringVariable(acctest.CtKey1), + "knownTagValue": config.StringVariable(acctest.CtValue1), + }, + Check: resource.ComposeAggregateTestCheckFunc( + testAccCheckTrustStoreExists(ctx, resourceName, &v), + resource.TestCheckResourceAttrPair(resourceName, "tags.computedkey1", "null_resource.test", names.AttrID), + ), + ConfigStateChecks: []statecheck.StateCheck{ + statecheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTags), knownvalue.MapSizeExact(2)), + statecheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTags), knownvalue.MapPartial(map[string]knownvalue.Check{ + acctest.CtKey1: knownvalue.StringExact(acctest.CtValue1), + })), + statecheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTagsAll), knownvalue.MapSizeExact(2)), + statecheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTagsAll), knownvalue.MapPartial(map[string]knownvalue.Check{ + acctest.CtKey1: knownvalue.StringExact(acctest.CtValue1), + })), + }, + ConfigPlanChecks: resource.ConfigPlanChecks{ + PreApply: []plancheck.PlanCheck{ + plancheck.ExpectResourceAction(resourceName, plancheck.ResourceActionUpdate), + plancheck.ExpectUnknownValue(resourceName, tfjsonpath.New(names.AttrTags).AtMapKey("computedkey1")), + plancheck.ExpectUnknownValue(resourceName, tfjsonpath.New(names.AttrTagsAll)), + }, + PostApplyPreRefresh: []plancheck.PlanCheck{ + plancheck.ExpectResourceAction(resourceName, plancheck.ResourceActionNoop), + }, + PostApplyPostRefresh: []plancheck.PlanCheck{ + plancheck.ExpectResourceAction(resourceName, plancheck.ResourceActionNoop), + }, + }, + }, + { + ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories, + ConfigDirectory: config.StaticDirectory("testdata/TrustStore/tagsComputed2/"), + ConfigVariables: config.Variables{ + "unknownTagKey": config.StringVariable("computedkey1"), + "knownTagKey": config.StringVariable(acctest.CtKey1), + "knownTagValue": config.StringVariable(acctest.CtValue1), + }, + ResourceName: resourceName, + ImportState: true, + ImportStateIdFunc: acctest.AttrImportStateIdFunc(resourceName, "trust_store_arn"), + ImportStateVerify: true, + ImportStateVerifyIdentifierAttribute: "trust_store_arn", + ImportStateVerifyIgnore: []string{ + "certificate_list", + }, + }, + }, + }) +} + +func TestAccWorkSpacesWebTrustStore_tags_ComputedTag_OnUpdate_Replace(t *testing.T) { + ctx := acctest.Context(t) + + var v types.TrustStore + resourceName := "aws_workspacesweb_trust_store.test" + + acctest.ParallelTest(ctx, t, resource.TestCase{ + PreCheck: func() { acctest.PreCheck(ctx, t) }, + ErrorCheck: acctest.ErrorCheck(t, names.WorkSpacesWebServiceID), + CheckDestroy: testAccCheckTrustStoreDestroy(ctx), + Steps: []resource.TestStep{ + { + ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories, + ConfigDirectory: config.StaticDirectory("testdata/TrustStore/tags/"), + ConfigVariables: config.Variables{ + acctest.CtResourceTags: config.MapVariable(map[string]config.Variable{ + acctest.CtKey1: config.StringVariable(acctest.CtValue1), + }), + }, + Check: resource.ComposeAggregateTestCheckFunc( + testAccCheckTrustStoreExists(ctx, resourceName, &v), + ), + ConfigStateChecks: []statecheck.StateCheck{ + statecheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTags), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtKey1: knownvalue.StringExact(acctest.CtValue1), + })), + statecheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTagsAll), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtKey1: knownvalue.StringExact(acctest.CtValue1), + })), + }, + ConfigPlanChecks: resource.ConfigPlanChecks{ + PreApply: []plancheck.PlanCheck{ + plancheck.ExpectResourceAction(resourceName, plancheck.ResourceActionCreate), + plancheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTags), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtKey1: knownvalue.StringExact(acctest.CtValue1), + })), + plancheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTagsAll), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtKey1: knownvalue.StringExact(acctest.CtValue1), + })), + }, + }, + }, + { + ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories, + ConfigDirectory: config.StaticDirectory("testdata/TrustStore/tagsComputed1/"), + ConfigVariables: config.Variables{ + "unknownTagKey": config.StringVariable(acctest.CtKey1), + }, + Check: resource.ComposeAggregateTestCheckFunc( + testAccCheckTrustStoreExists(ctx, resourceName, &v), + resource.TestCheckResourceAttrPair(resourceName, acctest.CtTagsKey1, "null_resource.test", names.AttrID), + ), + ConfigStateChecks: []statecheck.StateCheck{ + statecheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTags), knownvalue.MapSizeExact(1)), + statecheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTagsAll), knownvalue.MapSizeExact(1)), + }, + ConfigPlanChecks: resource.ConfigPlanChecks{ + PreApply: []plancheck.PlanCheck{ + plancheck.ExpectResourceAction(resourceName, plancheck.ResourceActionUpdate), + plancheck.ExpectUnknownValue(resourceName, tfjsonpath.New(names.AttrTags).AtMapKey(acctest.CtKey1)), + plancheck.ExpectUnknownValue(resourceName, tfjsonpath.New(names.AttrTagsAll)), + }, + PostApplyPreRefresh: []plancheck.PlanCheck{ + plancheck.ExpectResourceAction(resourceName, plancheck.ResourceActionNoop), + }, + PostApplyPostRefresh: []plancheck.PlanCheck{ + plancheck.ExpectResourceAction(resourceName, plancheck.ResourceActionNoop), + }, + }, + }, + { + ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories, + ConfigDirectory: config.StaticDirectory("testdata/TrustStore/tagsComputed1/"), + ConfigVariables: config.Variables{ + "unknownTagKey": config.StringVariable(acctest.CtKey1), + }, + ResourceName: resourceName, + ImportState: true, + ImportStateIdFunc: acctest.AttrImportStateIdFunc(resourceName, "trust_store_arn"), + ImportStateVerify: true, + ImportStateVerifyIdentifierAttribute: "trust_store_arn", + ImportStateVerifyIgnore: []string{ + "certificate_list", + }, + }, + }, + }) +} + +func TestAccWorkSpacesWebTrustStore_tags_IgnoreTags_Overlap_DefaultTag(t *testing.T) { + ctx := acctest.Context(t) + + var v types.TrustStore + resourceName := "aws_workspacesweb_trust_store.test" + + acctest.ParallelTest(ctx, t, resource.TestCase{ + PreCheck: func() { acctest.PreCheck(ctx, t) }, + ErrorCheck: acctest.ErrorCheck(t, names.WorkSpacesWebServiceID), + CheckDestroy: testAccCheckTrustStoreDestroy(ctx), + Steps: []resource.TestStep{ + // 1: Create + { + ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories, + ConfigDirectory: config.StaticDirectory("testdata/TrustStore/tags_ignore/"), + ConfigVariables: config.Variables{ + acctest.CtProviderTags: config.MapVariable(map[string]config.Variable{ + acctest.CtProviderKey1: config.StringVariable(acctest.CtProviderValue1), + }), + acctest.CtResourceTags: config.MapVariable(map[string]config.Variable{ + acctest.CtResourceKey1: config.StringVariable(acctest.CtResourceValue1), + }), + "ignore_tag_keys": config.SetVariable( + config.StringVariable(acctest.CtProviderKey1), + ), + }, + Check: resource.ComposeAggregateTestCheckFunc( + testAccCheckTrustStoreExists(ctx, resourceName, &v), + ), + ConfigStateChecks: []statecheck.StateCheck{ + statecheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTags), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtResourceKey1: knownvalue.StringExact(acctest.CtResourceValue1), + })), + statecheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTagsAll), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtResourceKey1: knownvalue.StringExact(acctest.CtResourceValue1), + })), + expectFullResourceTags(ctx, resourceName, knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtProviderKey1: knownvalue.StringExact(acctest.CtProviderValue1), // TODO: Should not be set + acctest.CtResourceKey1: knownvalue.StringExact(acctest.CtResourceValue1), + })), + }, + ConfigPlanChecks: resource.ConfigPlanChecks{ + PreApply: []plancheck.PlanCheck{ + plancheck.ExpectResourceAction(resourceName, plancheck.ResourceActionCreate), + plancheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTags), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtResourceKey1: knownvalue.StringExact(acctest.CtResourceValue1), + })), + plancheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTagsAll), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtResourceKey1: knownvalue.StringExact(acctest.CtResourceValue1), + })), + }, + PostApplyPreRefresh: []plancheck.PlanCheck{ + plancheck.ExpectEmptyPlan(), + }, + PostApplyPostRefresh: []plancheck.PlanCheck{ + plancheck.ExpectEmptyPlan(), + }, + }, + }, + // 2: Update ignored tag only + { + ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories, + ConfigDirectory: config.StaticDirectory("testdata/TrustStore/tags_ignore/"), + ConfigVariables: config.Variables{ + acctest.CtProviderTags: config.MapVariable(map[string]config.Variable{ + acctest.CtProviderKey1: config.StringVariable(acctest.CtProviderValue1Updated), + }), + acctest.CtResourceTags: config.MapVariable(map[string]config.Variable{ + acctest.CtResourceKey1: config.StringVariable(acctest.CtResourceValue1), + }), + "ignore_tag_keys": config.SetVariable( + config.StringVariable(acctest.CtProviderKey1), + ), + }, + Check: resource.ComposeAggregateTestCheckFunc( + testAccCheckTrustStoreExists(ctx, resourceName, &v), + ), + ConfigStateChecks: []statecheck.StateCheck{ + statecheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTags), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtResourceKey1: knownvalue.StringExact(acctest.CtResourceValue1), + })), + statecheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTagsAll), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtResourceKey1: knownvalue.StringExact(acctest.CtResourceValue1), + })), + expectFullResourceTags(ctx, resourceName, knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtProviderKey1: knownvalue.StringExact(acctest.CtProviderValue1), // TODO: Should not be set + acctest.CtResourceKey1: knownvalue.StringExact(acctest.CtResourceValue1), + })), + }, + ConfigPlanChecks: resource.ConfigPlanChecks{ + PreApply: []plancheck.PlanCheck{ + plancheck.ExpectResourceAction(resourceName, plancheck.ResourceActionNoop), + plancheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTags), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtResourceKey1: knownvalue.StringExact(acctest.CtResourceValue1), + })), + plancheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTagsAll), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtResourceKey1: knownvalue.StringExact(acctest.CtResourceValue1), + })), + }, + PostApplyPreRefresh: []plancheck.PlanCheck{ + plancheck.ExpectEmptyPlan(), + }, + PostApplyPostRefresh: []plancheck.PlanCheck{ + plancheck.ExpectEmptyPlan(), + }, + }, + }, + // 3: Update both tags + { + ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories, + ConfigDirectory: config.StaticDirectory("testdata/TrustStore/tags_ignore/"), + ConfigVariables: config.Variables{ + acctest.CtProviderTags: config.MapVariable(map[string]config.Variable{ + acctest.CtProviderKey1: config.StringVariable(acctest.CtProviderValue1Again), + }), + acctest.CtResourceTags: config.MapVariable(map[string]config.Variable{ + acctest.CtResourceKey1: config.StringVariable(acctest.CtResourceValue1Updated), + }), + "ignore_tag_keys": config.SetVariable( + config.StringVariable(acctest.CtProviderKey1), + ), + }, + Check: resource.ComposeAggregateTestCheckFunc( + testAccCheckTrustStoreExists(ctx, resourceName, &v), + ), + ConfigStateChecks: []statecheck.StateCheck{ + statecheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTags), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtResourceKey1: knownvalue.StringExact(acctest.CtResourceValue1Updated), + })), + statecheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTagsAll), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtResourceKey1: knownvalue.StringExact(acctest.CtResourceValue1Updated), + })), + expectFullResourceTags(ctx, resourceName, knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtProviderKey1: knownvalue.StringExact(acctest.CtProviderValue1), // TODO: Should not be set + acctest.CtResourceKey1: knownvalue.StringExact(acctest.CtResourceValue1Updated), + })), + }, + ConfigPlanChecks: resource.ConfigPlanChecks{ + PreApply: []plancheck.PlanCheck{ + plancheck.ExpectResourceAction(resourceName, plancheck.ResourceActionUpdate), + plancheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTags), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtResourceKey1: knownvalue.StringExact(acctest.CtResourceValue1Updated), + })), + plancheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTagsAll), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtResourceKey1: knownvalue.StringExact(acctest.CtResourceValue1Updated), + })), + }, + PostApplyPreRefresh: []plancheck.PlanCheck{ + plancheck.ExpectEmptyPlan(), + }, + PostApplyPostRefresh: []plancheck.PlanCheck{ + plancheck.ExpectEmptyPlan(), + }, + }, + }, + }, + }) +} + +func TestAccWorkSpacesWebTrustStore_tags_IgnoreTags_Overlap_ResourceTag(t *testing.T) { + ctx := acctest.Context(t) + + var v types.TrustStore + resourceName := "aws_workspacesweb_trust_store.test" + + acctest.ParallelTest(ctx, t, resource.TestCase{ + PreCheck: func() { acctest.PreCheck(ctx, t) }, + ErrorCheck: acctest.ErrorCheck(t, names.WorkSpacesWebServiceID), + CheckDestroy: testAccCheckTrustStoreDestroy(ctx), + Steps: []resource.TestStep{ + // 1: Create + { + ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories, + ConfigDirectory: config.StaticDirectory("testdata/TrustStore/tags_ignore/"), + ConfigVariables: config.Variables{ + acctest.CtResourceTags: config.MapVariable(map[string]config.Variable{ + acctest.CtResourceKey1: config.StringVariable(acctest.CtResourceValue1), + acctest.CtResourceKey2: config.StringVariable(acctest.CtResourceValue2), + }), + "ignore_tag_keys": config.SetVariable( + config.StringVariable(acctest.CtResourceKey1), + ), + }, + Check: resource.ComposeAggregateTestCheckFunc( + testAccCheckTrustStoreExists(ctx, resourceName, &v), + ), + ConfigStateChecks: []statecheck.StateCheck{ + statecheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTags), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtResourceKey1: knownvalue.StringExact(acctest.CtResourceValue1), + acctest.CtResourceKey2: knownvalue.StringExact(acctest.CtResourceValue2), + })), + statecheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTagsAll), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtResourceKey2: knownvalue.StringExact(acctest.CtResourceValue2), + })), + expectFullResourceTags(ctx, resourceName, knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtResourceKey1: knownvalue.StringExact(acctest.CtResourceValue1), // TODO: Should not be set + acctest.CtResourceKey2: knownvalue.StringExact(acctest.CtResourceValue2), + })), + }, + ConfigPlanChecks: resource.ConfigPlanChecks{ + PreApply: []plancheck.PlanCheck{ + plancheck.ExpectResourceAction(resourceName, plancheck.ResourceActionCreate), + plancheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTags), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtResourceKey1: knownvalue.StringExact(acctest.CtResourceValue1), + acctest.CtResourceKey2: knownvalue.StringExact(acctest.CtResourceValue2), + })), + plancheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTagsAll), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtResourceKey2: knownvalue.StringExact(acctest.CtResourceValue2), + })), + }, + PostApplyPreRefresh: []plancheck.PlanCheck{ + plancheck.ExpectEmptyPlan(), + }, + PostApplyPostRefresh: []plancheck.PlanCheck{ + plancheck.ExpectResourceAction(resourceName, plancheck.ResourceActionUpdate), // TODO: Should be NoOp + plancheck.ExpectResourceAction(resourceName, plancheck.ResourceActionUpdate), + plancheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTags), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtResourceKey1: knownvalue.StringExact(acctest.CtResourceValue1), + acctest.CtResourceKey2: knownvalue.StringExact(acctest.CtResourceValue2), + })), + plancheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTagsAll), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtResourceKey2: knownvalue.StringExact(acctest.CtResourceValue2), + })), + }, + }, + ExpectNonEmptyPlan: true, + }, + // 2: Update ignored tag + { + ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories, + ConfigDirectory: config.StaticDirectory("testdata/TrustStore/tags_ignore/"), + ConfigVariables: config.Variables{ + acctest.CtResourceTags: config.MapVariable(map[string]config.Variable{ + acctest.CtResourceKey1: config.StringVariable(acctest.CtResourceValue1Updated), + acctest.CtResourceKey2: config.StringVariable(acctest.CtResourceValue2), + }), + "ignore_tag_keys": config.SetVariable( + config.StringVariable(acctest.CtResourceKey1), + ), + }, + Check: resource.ComposeAggregateTestCheckFunc( + testAccCheckTrustStoreExists(ctx, resourceName, &v), + ), + ConfigStateChecks: []statecheck.StateCheck{ + statecheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTags), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtResourceKey1: knownvalue.StringExact(acctest.CtResourceValue1Updated), + acctest.CtResourceKey2: knownvalue.StringExact(acctest.CtResourceValue2), + })), + statecheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTagsAll), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtResourceKey2: knownvalue.StringExact(acctest.CtResourceValue2), + })), + expectFullResourceTags(ctx, resourceName, knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtResourceKey1: knownvalue.StringExact(acctest.CtResourceValue1), // TODO: Should not be set + acctest.CtResourceKey2: knownvalue.StringExact(acctest.CtResourceValue2), + })), + }, + ConfigPlanChecks: resource.ConfigPlanChecks{ + PreApply: []plancheck.PlanCheck{ + plancheck.ExpectResourceAction(resourceName, plancheck.ResourceActionUpdate), + plancheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTags), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtResourceKey1: knownvalue.StringExact(acctest.CtResourceValue1Updated), + acctest.CtResourceKey2: knownvalue.StringExact(acctest.CtResourceValue2), + })), + plancheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTagsAll), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtResourceKey2: knownvalue.StringExact(acctest.CtResourceValue2), + })), + }, + PostApplyPreRefresh: []plancheck.PlanCheck{ + plancheck.ExpectEmptyPlan(), + }, + PostApplyPostRefresh: []plancheck.PlanCheck{ + plancheck.ExpectResourceAction(resourceName, plancheck.ResourceActionUpdate), // TODO: Should be NoOp + plancheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTags), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtResourceKey1: knownvalue.StringExact(acctest.CtResourceValue1Updated), + acctest.CtResourceKey2: knownvalue.StringExact(acctest.CtResourceValue2), + })), + plancheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTagsAll), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtResourceKey2: knownvalue.StringExact(acctest.CtResourceValue2), + })), + }, + }, + ExpectNonEmptyPlan: true, + }, + // 3: Update both tags + { + ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories, + ConfigDirectory: config.StaticDirectory("testdata/TrustStore/tags_ignore/"), + ConfigVariables: config.Variables{ + acctest.CtResourceTags: config.MapVariable(map[string]config.Variable{ + acctest.CtResourceKey1: config.StringVariable(acctest.CtResourceValue1Again), + acctest.CtResourceKey2: config.StringVariable(acctest.CtResourceValue2Updated), + }), + "ignore_tag_keys": config.SetVariable( + config.StringVariable(acctest.CtResourceKey1), + ), + }, + Check: resource.ComposeAggregateTestCheckFunc( + testAccCheckTrustStoreExists(ctx, resourceName, &v), + ), + ConfigStateChecks: []statecheck.StateCheck{ + statecheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTags), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtResourceKey1: knownvalue.StringExact(acctest.CtResourceValue1Again), + acctest.CtResourceKey2: knownvalue.StringExact(acctest.CtResourceValue2Updated), + })), + statecheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTagsAll), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtResourceKey2: knownvalue.StringExact(acctest.CtResourceValue2Updated), + })), + expectFullResourceTags(ctx, resourceName, knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtResourceKey1: knownvalue.StringExact(acctest.CtResourceValue1), // TODO: Should not be set + acctest.CtResourceKey2: knownvalue.StringExact(acctest.CtResourceValue2Updated), + })), + }, + ConfigPlanChecks: resource.ConfigPlanChecks{ + PreApply: []plancheck.PlanCheck{ + plancheck.ExpectResourceAction(resourceName, plancheck.ResourceActionUpdate), + plancheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTags), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtResourceKey1: knownvalue.StringExact(acctest.CtResourceValue1Again), + acctest.CtResourceKey2: knownvalue.StringExact(acctest.CtResourceValue2Updated), + })), + plancheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTagsAll), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtResourceKey2: knownvalue.StringExact(acctest.CtResourceValue2Updated), + })), + }, + PostApplyPreRefresh: []plancheck.PlanCheck{ + plancheck.ExpectEmptyPlan(), + }, + PostApplyPostRefresh: []plancheck.PlanCheck{ + plancheck.ExpectResourceAction(resourceName, plancheck.ResourceActionUpdate), // TODO: Should be NoOp + plancheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTags), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtResourceKey1: knownvalue.StringExact(acctest.CtResourceValue1Again), + acctest.CtResourceKey2: knownvalue.StringExact(acctest.CtResourceValue2Updated), + })), + plancheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrTagsAll), knownvalue.MapExact(map[string]knownvalue.Check{ + acctest.CtResourceKey2: knownvalue.StringExact(acctest.CtResourceValue2Updated), + })), + }, + }, + ExpectNonEmptyPlan: true, + }, + }, + }) +} diff --git a/internal/service/workspacesweb/trust_store_test.go b/internal/service/workspacesweb/trust_store_test.go new file mode 100644 index 000000000000..4b4bae7e7434 --- /dev/null +++ b/internal/service/workspacesweb/trust_store_test.go @@ -0,0 +1,359 @@ +// Copyright (c) HashiCorp, Inc. +// SPDX-License-Identifier: MPL-2.0 + +package workspacesweb_test + +import ( + "context" + "fmt" + "testing" + + "github.com/YakDriver/regexache" + awstypes "github.com/aws/aws-sdk-go-v2/service/workspacesweb/types" + "github.com/hashicorp/terraform-plugin-testing/helper/resource" + "github.com/hashicorp/terraform-plugin-testing/terraform" + "github.com/hashicorp/terraform-provider-aws/internal/acctest" + "github.com/hashicorp/terraform-provider-aws/internal/conns" + tfworkspacesweb "github.com/hashicorp/terraform-provider-aws/internal/service/workspacesweb" + "github.com/hashicorp/terraform-provider-aws/internal/tfresource" + "github.com/hashicorp/terraform-provider-aws/names" +) + +func TestAccWorkSpacesWebTrustStore_basic(t *testing.T) { + ctx := acctest.Context(t) + var trustStore awstypes.TrustStore + resourceName := "aws_workspacesweb_trust_store.test" + + resource.ParallelTest(t, resource.TestCase{ + PreCheck: func() { + acctest.PreCheck(ctx, t) + acctest.PreCheckPartitionHasService(t, names.WorkSpacesWebEndpointID) + testAccPreCheck(ctx, t) + }, + ErrorCheck: acctest.ErrorCheck(t, names.WorkSpacesWebServiceID), + ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories, + CheckDestroy: testAccCheckTrustStoreDestroy(ctx), + Steps: []resource.TestStep{ + { + Config: testAccTrustStoreConfig_basic(), + Check: resource.ComposeAggregateTestCheckFunc( + testAccCheckTrustStoreExists(ctx, resourceName, &trustStore), + resource.TestCheckResourceAttr(resourceName, "certificate.#", "1"), + acctest.MatchResourceAttrRegionalARN(ctx, resourceName, "trust_store_arn", "workspaces-web", regexache.MustCompile(`trustStore/.+$`)), + resource.TestCheckResourceAttrPair(resourceName, "certificate.0.body", "aws_acmpca_certificate.test1", names.AttrCertificate), + resource.TestCheckResourceAttrSet(resourceName, "certificate.0.issuer"), + resource.TestCheckResourceAttrSet(resourceName, "certificate.0.not_valid_after"), + resource.TestCheckResourceAttrSet(resourceName, "certificate.0.not_valid_before"), + resource.TestCheckResourceAttrSet(resourceName, "certificate.0.subject"), + resource.TestCheckResourceAttrSet(resourceName, "certificate.0.thumbprint"), + ), + }, + { + ResourceName: resourceName, + ImportState: true, + ImportStateVerify: true, + ImportStateIdFunc: acctest.AttrImportStateIdFunc(resourceName, "trust_store_arn"), + ImportStateVerifyIdentifierAttribute: "trust_store_arn", + }, + }, + }) +} + +func TestAccWorkSpacesWebTrustStore_multipleCerts(t *testing.T) { + ctx := acctest.Context(t) + var trustStore awstypes.TrustStore + resourceName := "aws_workspacesweb_trust_store.test" + + resource.ParallelTest(t, resource.TestCase{ + PreCheck: func() { + acctest.PreCheck(ctx, t) + acctest.PreCheckPartitionHasService(t, names.WorkSpacesWebEndpointID) + testAccPreCheck(ctx, t) + }, + ErrorCheck: acctest.ErrorCheck(t, names.WorkSpacesWebServiceID), + ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories, + CheckDestroy: testAccCheckTrustStoreDestroy(ctx), + Steps: []resource.TestStep{ + { + Config: testAccTrustStoreConfig_multipleCerts(), + Check: resource.ComposeAggregateTestCheckFunc( + testAccCheckTrustStoreExists(ctx, resourceName, &trustStore), + resource.TestCheckResourceAttr(resourceName, "certificate.#", "2"), + acctest.MatchResourceAttrRegionalARN(ctx, resourceName, "trust_store_arn", "workspaces-web", regexache.MustCompile(`trustStore/.+$`)), + resource.TestCheckTypeSetElemAttrPair(resourceName, "certificate.*.body", "aws_acmpca_certificate.test1", names.AttrCertificate), + resource.TestCheckResourceAttrSet(resourceName, "certificate.0.issuer"), + resource.TestCheckResourceAttrSet(resourceName, "certificate.0.not_valid_after"), + resource.TestCheckResourceAttrSet(resourceName, "certificate.0.not_valid_before"), + resource.TestCheckResourceAttrSet(resourceName, "certificate.0.subject"), + resource.TestCheckResourceAttrSet(resourceName, "certificate.0.thumbprint"), + resource.TestCheckTypeSetElemAttrPair(resourceName, "certificate.*.body", "aws_acmpca_certificate.test2", names.AttrCertificate), + resource.TestCheckResourceAttrSet(resourceName, "certificate.1.issuer"), + resource.TestCheckResourceAttrSet(resourceName, "certificate.1.not_valid_after"), + resource.TestCheckResourceAttrSet(resourceName, "certificate.1.not_valid_before"), + resource.TestCheckResourceAttrSet(resourceName, "certificate.1.subject"), + resource.TestCheckResourceAttrSet(resourceName, "certificate.1.thumbprint"), + ), + }, + { + ResourceName: resourceName, + ImportState: true, + ImportStateVerify: true, + ImportStateIdFunc: acctest.AttrImportStateIdFunc(resourceName, "trust_store_arn"), + ImportStateVerifyIdentifierAttribute: "trust_store_arn", + }, + }, + }) +} + +func TestAccWorkSpacesWebTrustStore_disappears(t *testing.T) { + ctx := acctest.Context(t) + var trustStore awstypes.TrustStore + resourceName := "aws_workspacesweb_trust_store.test" + + resource.ParallelTest(t, resource.TestCase{ + PreCheck: func() { + acctest.PreCheck(ctx, t) + acctest.PreCheckPartitionHasService(t, names.WorkSpacesWebEndpointID) + testAccPreCheck(ctx, t) + }, + ErrorCheck: acctest.ErrorCheck(t, names.WorkSpacesWebServiceID), + ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories, + CheckDestroy: testAccCheckTrustStoreDestroy(ctx), + Steps: []resource.TestStep{ + { + Config: testAccTrustStoreConfig_basic(), + Check: resource.ComposeAggregateTestCheckFunc( + testAccCheckTrustStoreExists(ctx, resourceName, &trustStore), + acctest.CheckFrameworkResourceDisappears(ctx, acctest.Provider, tfworkspacesweb.ResourceTrustStore, resourceName), + ), + ExpectNonEmptyPlan: true, + }, + }, + }) +} + +func TestAccWorkSpacesWebTrustStore_update(t *testing.T) { + ctx := acctest.Context(t) + var trustStore awstypes.TrustStore + resourceName := "aws_workspacesweb_trust_store.test" + + resource.ParallelTest(t, resource.TestCase{ + PreCheck: func() { + acctest.PreCheck(ctx, t) + acctest.PreCheckPartitionHasService(t, names.WorkSpacesWebEndpointID) + testAccPreCheck(ctx, t) + }, + ErrorCheck: acctest.ErrorCheck(t, names.WorkSpacesWebServiceID), + ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories, + CheckDestroy: testAccCheckTrustStoreDestroy(ctx), + Steps: []resource.TestStep{ + { + Config: testAccTrustStoreConfig_basic(), + Check: resource.ComposeAggregateTestCheckFunc( + testAccCheckTrustStoreExists(ctx, resourceName, &trustStore), + resource.TestCheckResourceAttr(resourceName, "certificate.#", "1"), + acctest.MatchResourceAttrRegionalARN(ctx, resourceName, "trust_store_arn", "workspaces-web", regexache.MustCompile(`trustStore/.+$`)), + resource.TestCheckResourceAttrPair(resourceName, "certificate.0.body", "aws_acmpca_certificate.test1", names.AttrCertificate), + resource.TestCheckResourceAttrSet(resourceName, "certificate.0.issuer"), + resource.TestCheckResourceAttrSet(resourceName, "certificate.0.not_valid_after"), + resource.TestCheckResourceAttrSet(resourceName, "certificate.0.not_valid_before"), + resource.TestCheckResourceAttrSet(resourceName, "certificate.0.subject"), + resource.TestCheckResourceAttrSet(resourceName, "certificate.0.thumbprint"), + ), + }, + { + ResourceName: resourceName, + ImportState: true, + ImportStateVerify: true, + ImportStateIdFunc: acctest.AttrImportStateIdFunc(resourceName, "trust_store_arn"), + ImportStateVerifyIdentifierAttribute: "trust_store_arn", + }, + { + Config: testAccTrustStoreConfig_updatedAdd(), + Check: resource.ComposeAggregateTestCheckFunc( + testAccCheckTrustStoreExists(ctx, resourceName, &trustStore), + resource.TestCheckResourceAttr(resourceName, "certificate.#", "2"), + acctest.MatchResourceAttrRegionalARN(ctx, resourceName, "trust_store_arn", "workspaces-web", regexache.MustCompile(`trustStore/.+$`)), + resource.TestCheckTypeSetElemAttrPair(resourceName, "certificate.*.body", "aws_acmpca_certificate.test1", names.AttrCertificate), + resource.TestCheckResourceAttrSet(resourceName, "certificate.0.issuer"), + resource.TestCheckResourceAttrSet(resourceName, "certificate.0.not_valid_after"), + resource.TestCheckResourceAttrSet(resourceName, "certificate.0.not_valid_before"), + resource.TestCheckResourceAttrSet(resourceName, "certificate.0.subject"), + resource.TestCheckResourceAttrSet(resourceName, "certificate.0.thumbprint"), + resource.TestCheckTypeSetElemAttrPair(resourceName, "certificate.*.body", "aws_acmpca_certificate.test2", names.AttrCertificate), + resource.TestCheckResourceAttrSet(resourceName, "certificate.1.issuer"), + resource.TestCheckResourceAttrSet(resourceName, "certificate.1.not_valid_after"), + resource.TestCheckResourceAttrSet(resourceName, "certificate.1.not_valid_before"), + resource.TestCheckResourceAttrSet(resourceName, "certificate.1.subject"), + resource.TestCheckResourceAttrSet(resourceName, "certificate.1.thumbprint"), + ), + }, + { + ResourceName: resourceName, + ImportState: true, + ImportStateVerify: true, + ImportStateIdFunc: acctest.AttrImportStateIdFunc(resourceName, "trust_store_arn"), + ImportStateVerifyIdentifierAttribute: "trust_store_arn", + }, + { + Config: testAccTrustStoreConfig_updatedRemove(), + Check: resource.ComposeAggregateTestCheckFunc( + testAccCheckTrustStoreExists(ctx, resourceName, &trustStore), + resource.TestCheckResourceAttr(resourceName, "certificate.#", "1"), + acctest.MatchResourceAttrRegionalARN(ctx, resourceName, "trust_store_arn", "workspaces-web", regexache.MustCompile(`trustStore/.+$`)), + resource.TestCheckResourceAttrPair(resourceName, "certificate.0.body", "aws_acmpca_certificate.test2", names.AttrCertificate), + resource.TestCheckResourceAttrSet(resourceName, "certificate.0.issuer"), + resource.TestCheckResourceAttrSet(resourceName, "certificate.0.not_valid_after"), + resource.TestCheckResourceAttrSet(resourceName, "certificate.0.not_valid_before"), + resource.TestCheckResourceAttrSet(resourceName, "certificate.0.subject"), + resource.TestCheckResourceAttrSet(resourceName, "certificate.0.thumbprint"), + ), + }, + }, + }) +} + +func testAccCheckTrustStoreDestroy(ctx context.Context) resource.TestCheckFunc { + return func(s *terraform.State) error { + conn := acctest.Provider.Meta().(*conns.AWSClient).WorkSpacesWebClient(ctx) + + for _, rs := range s.RootModule().Resources { + if rs.Type != "aws_workspacesweb_trust_store" { + continue + } + + _, err := tfworkspacesweb.FindTrustStoreByARN(ctx, conn, rs.Primary.Attributes["trust_store_arn"]) + + if tfresource.NotFound(err) { + continue + } + + if err != nil { + return err + } + + return fmt.Errorf("WorkSpaces Web Trust Store %s still exists", rs.Primary.Attributes["trust_store_arn"]) + } + + return nil + } +} + +func testAccCheckTrustStoreExists(ctx context.Context, n string, v *awstypes.TrustStore) resource.TestCheckFunc { + return func(s *terraform.State) error { + rs, ok := s.RootModule().Resources[n] + if !ok { + return fmt.Errorf("Not found: %s", n) + } + conn := acctest.Provider.Meta().(*conns.AWSClient).WorkSpacesWebClient(ctx) + + output, err := tfworkspacesweb.FindTrustStoreByARN(ctx, conn, rs.Primary.Attributes["trust_store_arn"]) + + if err != nil { + return err + } + + *v = *output + + return nil + } +} +func testAccTrustStoreConfig_acmBase() string { + return (` + +data "aws_partition" "current" {} + +resource "aws_acmpca_certificate_authority" "test" { + type = "ROOT" + + certificate_authority_configuration { + key_algorithm = "RSA_2048" + signing_algorithm = "SHA256WITHRSA" + + subject { + common_name = "example.com" + } + } +} + +resource "aws_acmpca_certificate" "test1" { + certificate_authority_arn = aws_acmpca_certificate_authority.test.arn + certificate_signing_request = aws_acmpca_certificate_authority.test.certificate_signing_request + signing_algorithm = "SHA256WITHRSA" + + template_arn = "arn:${data.aws_partition.current.partition}:acm-pca:::template/RootCACertificate/V1" + + validity { + type = "YEARS" + value = 1 + } +} + +resource "aws_acmpca_certificate" "test2" { + certificate_authority_arn = aws_acmpca_certificate_authority.test.arn + certificate_signing_request = aws_acmpca_certificate_authority.test.certificate_signing_request + signing_algorithm = "SHA256WITHRSA" + + template_arn = "arn:${data.aws_partition.current.partition}:acm-pca:::template/RootCACertificate/V1" + + validity { + type = "YEARS" + value = 1 + } +} +`) +} + +func testAccTrustStoreConfig_basic() string { + return acctest.ConfigCompose( + testAccTrustStoreConfig_acmBase(), + ` +resource "aws_workspacesweb_trust_store" "test" { + certificate { + body = aws_acmpca_certificate.test1.certificate + } +} +`) +} + +func testAccTrustStoreConfig_multipleCerts() string { + return acctest.ConfigCompose( + testAccTrustStoreConfig_acmBase(), + ` +resource "aws_workspacesweb_trust_store" "test" { + certificate { + body = aws_acmpca_certificate.test1.certificate + } + certificate { + body = aws_acmpca_certificate.test2.certificate + } +} +`) +} + +func testAccTrustStoreConfig_updatedAdd() string { + return acctest.ConfigCompose( + testAccTrustStoreConfig_acmBase(), + ` +resource "aws_workspacesweb_trust_store" "test" { + certificate { + body = aws_acmpca_certificate.test1.certificate + } + certificate { + body = aws_acmpca_certificate.test2.certificate + } +} +`) +} + +func testAccTrustStoreConfig_updatedRemove() string { + return acctest.ConfigCompose( + testAccTrustStoreConfig_acmBase(), + ` +resource "aws_workspacesweb_trust_store" "test" { + certificate { + body = aws_acmpca_certificate.test2.certificate + } +} +`) +} diff --git a/internal/service/workspacesweb/user_access_logging_settings_association.go b/internal/service/workspacesweb/user_access_logging_settings_association.go new file mode 100644 index 000000000000..ac37bbe162e5 --- /dev/null +++ b/internal/service/workspacesweb/user_access_logging_settings_association.go @@ -0,0 +1,164 @@ +// Copyright (c) HashiCorp, Inc. +// SPDX-License-Identifier: MPL-2.0 + +package workspacesweb + +import ( + "context" + "fmt" + "slices" + + "github.com/aws/aws-sdk-go-v2/service/workspacesweb" + awstypes "github.com/aws/aws-sdk-go-v2/service/workspacesweb/types" + "github.com/hashicorp/terraform-plugin-framework/path" + "github.com/hashicorp/terraform-plugin-framework/resource" + "github.com/hashicorp/terraform-plugin-framework/resource/schema" + "github.com/hashicorp/terraform-plugin-framework/resource/schema/planmodifier" + "github.com/hashicorp/terraform-plugin-framework/resource/schema/stringplanmodifier" + "github.com/hashicorp/terraform-provider-aws/internal/errs" + "github.com/hashicorp/terraform-provider-aws/internal/errs/fwdiag" + intflex "github.com/hashicorp/terraform-provider-aws/internal/flex" + "github.com/hashicorp/terraform-provider-aws/internal/framework" + fwtypes "github.com/hashicorp/terraform-provider-aws/internal/framework/types" + tfretry "github.com/hashicorp/terraform-provider-aws/internal/retry" +) + +// @FrameworkResource("aws_workspacesweb_user_access_logging_settings_association", name="User Access Logging Settings Association") +// @Testing(tagsTest=false) +// @Testing(existsType="github.com/aws/aws-sdk-go-v2/service/workspacesweb/types;types.UserAccessLoggingSettings") +// @Testing(importStateIdAttribute="user_access_logging_settings_arn,portal_arn") +func newUserAccessLoggingSettingsAssociationResource(_ context.Context) (resource.ResourceWithConfigure, error) { + return &userAccessLoggingSettingsAssociationResource{}, nil +} + +type userAccessLoggingSettingsAssociationResource struct { + framework.ResourceWithModel[userAccessLoggingSettingsAssociationResourceModel] + framework.WithNoUpdate +} + +func (r *userAccessLoggingSettingsAssociationResource) Schema(ctx context.Context, request resource.SchemaRequest, response *resource.SchemaResponse) { + response.Schema = schema.Schema{ + Attributes: map[string]schema.Attribute{ + "portal_arn": schema.StringAttribute{ + CustomType: fwtypes.ARNType, + Required: true, + PlanModifiers: []planmodifier.String{ + stringplanmodifier.RequiresReplace(), + }, + }, + "user_access_logging_settings_arn": schema.StringAttribute{ + CustomType: fwtypes.ARNType, + Required: true, + PlanModifiers: []planmodifier.String{ + stringplanmodifier.RequiresReplace(), + }, + }, + }, + } +} + +func (r *userAccessLoggingSettingsAssociationResource) Create(ctx context.Context, request resource.CreateRequest, response *resource.CreateResponse) { + var data userAccessLoggingSettingsAssociationResourceModel + response.Diagnostics.Append(request.Plan.Get(ctx, &data)...) + if response.Diagnostics.HasError() { + return + } + + conn := r.Meta().WorkSpacesWebClient(ctx) + + input := workspacesweb.AssociateUserAccessLoggingSettingsInput{ + UserAccessLoggingSettingsArn: data.UserAccessLoggingSettingsARN.ValueStringPointer(), + PortalArn: data.PortalARN.ValueStringPointer(), + } + + _, err := conn.AssociateUserAccessLoggingSettings(ctx, &input) + + if err != nil { + response.Diagnostics.AddError("creating WorkSpacesWeb User Access Logging Settings Association", err.Error()) + return + } + + response.Diagnostics.Append(response.State.Set(ctx, data)...) +} + +func (r *userAccessLoggingSettingsAssociationResource) Read(ctx context.Context, request resource.ReadRequest, response *resource.ReadResponse) { + var data userAccessLoggingSettingsAssociationResourceModel + response.Diagnostics.Append(request.State.Get(ctx, &data)...) + if response.Diagnostics.HasError() { + return + } + + conn := r.Meta().WorkSpacesWebClient(ctx) + + // Check if the association exists by getting the user access logging settings and checking associated portals + output, err := findUserAccessLoggingSettingsByARN(ctx, conn, data.UserAccessLoggingSettingsARN.ValueString()) + if tfretry.NotFound(err) { + response.Diagnostics.Append(fwdiag.NewResourceNotFoundWarningDiagnostic(err)) + response.State.RemoveResource(ctx) + return + } + + if err != nil { + response.Diagnostics.AddError(fmt.Sprintf("reading WorkSpacesWeb User Access Logging Settings Association (%s)", data.UserAccessLoggingSettingsARN.ValueString()), err.Error()) + return + } + + // Check if the portal is in the associated portals list + if !slices.Contains(output.AssociatedPortalArns, data.PortalARN.ValueString()) { + response.Diagnostics.Append(fwdiag.NewResourceNotFoundWarningDiagnostic(fmt.Errorf("association not found"))) + response.State.RemoveResource(ctx) + return + } + + response.Diagnostics.Append(response.State.Set(ctx, &data)...) +} + +func (r *userAccessLoggingSettingsAssociationResource) Delete(ctx context.Context, request resource.DeleteRequest, response *resource.DeleteResponse) { + var data userAccessLoggingSettingsAssociationResourceModel + response.Diagnostics.Append(request.State.Get(ctx, &data)...) + if response.Diagnostics.HasError() { + return + } + + conn := r.Meta().WorkSpacesWebClient(ctx) + + input := workspacesweb.DisassociateUserAccessLoggingSettingsInput{ + PortalArn: data.PortalARN.ValueStringPointer(), + } + + _, err := conn.DisassociateUserAccessLoggingSettings(ctx, &input) + + if errs.IsA[*awstypes.ResourceNotFoundException](err) { + return + } + + if err != nil { + response.Diagnostics.AddError(fmt.Sprintf("deleting WorkSpacesWeb User Access Logging Settings Association (%s)", data.UserAccessLoggingSettingsARN.ValueString()), err.Error()) + return + } +} + +func (r *userAccessLoggingSettingsAssociationResource) ImportState(ctx context.Context, request resource.ImportStateRequest, response *resource.ImportStateResponse) { + const ( + userAccessLoggingSettingsAssociationIDParts = 2 + ) + parts, err := intflex.ExpandResourceId(request.ID, userAccessLoggingSettingsAssociationIDParts, true) + if err != nil { + response.Diagnostics.AddError( + "Unexpected Import Identifier", + fmt.Sprintf("Expected import identifier with format: user_access_logging_settings_arn,portal_arn. Got: %q", request.ID), + ) + return + } + userAccessLoggingSettingsARN := parts[0] + portalARN := parts[1] + + response.Diagnostics.Append(response.State.SetAttribute(ctx, path.Root("user_access_logging_settings_arn"), userAccessLoggingSettingsARN)...) + response.Diagnostics.Append(response.State.SetAttribute(ctx, path.Root("portal_arn"), portalARN)...) +} + +type userAccessLoggingSettingsAssociationResourceModel struct { + framework.WithRegionModel + PortalARN fwtypes.ARN `tfsdk:"portal_arn"` + UserAccessLoggingSettingsARN fwtypes.ARN `tfsdk:"user_access_logging_settings_arn"` +} diff --git a/internal/service/workspacesweb/user_access_logging_settings_association_test.go b/internal/service/workspacesweb/user_access_logging_settings_association_test.go new file mode 100644 index 000000000000..8fd7d7ad9c30 --- /dev/null +++ b/internal/service/workspacesweb/user_access_logging_settings_association_test.go @@ -0,0 +1,189 @@ +// Copyright (c) HashiCorp, Inc. +// SPDX-License-Identifier: MPL-2.0 + +package workspacesweb_test + +import ( + "context" + "fmt" + "slices" + "testing" + + awstypes "github.com/aws/aws-sdk-go-v2/service/workspacesweb/types" + sdkacctest "github.com/hashicorp/terraform-plugin-testing/helper/acctest" + "github.com/hashicorp/terraform-plugin-testing/helper/resource" + "github.com/hashicorp/terraform-plugin-testing/terraform" + "github.com/hashicorp/terraform-provider-aws/internal/acctest" + "github.com/hashicorp/terraform-provider-aws/internal/conns" + tfworkspacesweb "github.com/hashicorp/terraform-provider-aws/internal/service/workspacesweb" + "github.com/hashicorp/terraform-provider-aws/internal/tfresource" + "github.com/hashicorp/terraform-provider-aws/names" +) + +func TestAccWorkSpacesWebUserAccessLoggingSettingsAssociation_basic(t *testing.T) { + ctx := acctest.Context(t) + var userAccessLoggingSettings awstypes.UserAccessLoggingSettings + resourceName := "aws_workspacesweb_user_access_logging_settings_association.test" + userAccessLoggingSettingsResourceName := "aws_workspacesweb_user_access_logging_settings.test" + portalResourceName := "aws_workspacesweb_portal.test" + rName := sdkacctest.RandomWithPrefix(acctest.ResourcePrefix) + + resource.ParallelTest(t, resource.TestCase{ + PreCheck: func() { + acctest.PreCheck(ctx, t) + acctest.PreCheckPartitionHasService(t, names.WorkSpacesWebEndpointID) + testAccPreCheck(ctx, t) + }, + ErrorCheck: acctest.ErrorCheck(t, names.WorkSpacesWebServiceID), + ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories, + CheckDestroy: testAccCheckUserAccessLoggingSettingsAssociationDestroy(ctx), + Steps: []resource.TestStep{ + { + Config: testAccUserAccessLoggingSettingsAssociationConfig_basic(rName), + Check: resource.ComposeAggregateTestCheckFunc( + testAccCheckUserAccessLoggingSettingsAssociationExists(ctx, resourceName, &userAccessLoggingSettings), + resource.TestCheckResourceAttrPair(resourceName, "user_access_logging_settings_arn", userAccessLoggingSettingsResourceName, "user_access_logging_settings_arn"), + resource.TestCheckResourceAttrPair(resourceName, "portal_arn", portalResourceName, "portal_arn"), + ), + }, + { + ResourceName: resourceName, + ImportState: true, + ImportStateVerify: true, + ImportStateIdFunc: testAccUserAccessLoggingSettingsAssociationImportStateIdFunc(resourceName), + ImportStateVerifyIdentifierAttribute: "user_access_logging_settings_arn", + }, + { + ResourceName: resourceName, + RefreshState: true, + }, + { + Config: testAccUserAccessLoggingSettingsAssociationConfig_basic(rName), + Check: resource.ComposeAggregateTestCheckFunc( + //The following checks are for the UserAccessLoggingSettings Resource and the PortalResource (and not for the association resource). + resource.TestCheckResourceAttr(userAccessLoggingSettingsResourceName, "associated_portal_arns.#", "1"), + resource.TestCheckResourceAttrPair(userAccessLoggingSettingsResourceName, "associated_portal_arns.0", portalResourceName, "portal_arn"), + resource.TestCheckResourceAttrPair(portalResourceName, "user_access_logging_settings_arn", userAccessLoggingSettingsResourceName, "user_access_logging_settings_arn"), + ), + }, + }, + }) +} + +func TestAccWorkSpacesWebUserAccessLoggingSettingsAssociation_disappears(t *testing.T) { + ctx := acctest.Context(t) + var userAccessLoggingSettings awstypes.UserAccessLoggingSettings + resourceName := "aws_workspacesweb_user_access_logging_settings_association.test" + rName := sdkacctest.RandomWithPrefix(acctest.ResourcePrefix) + + resource.ParallelTest(t, resource.TestCase{ + PreCheck: func() { + acctest.PreCheck(ctx, t) + acctest.PreCheckPartitionHasService(t, names.WorkSpacesWebEndpointID) + testAccPreCheck(ctx, t) + }, + ErrorCheck: acctest.ErrorCheck(t, names.WorkSpacesWebServiceID), + ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories, + CheckDestroy: testAccCheckUserAccessLoggingSettingsAssociationDestroy(ctx), + Steps: []resource.TestStep{ + { + Config: testAccUserAccessLoggingSettingsAssociationConfig_basic(rName), + Check: resource.ComposeAggregateTestCheckFunc( + testAccCheckUserAccessLoggingSettingsAssociationExists(ctx, resourceName, &userAccessLoggingSettings), + acctest.CheckFrameworkResourceDisappears(ctx, acctest.Provider, tfworkspacesweb.ResourceUserAccessLoggingSettingsAssociation, resourceName), + ), + ExpectNonEmptyPlan: true, + }, + }, + }) +} + +func testAccCheckUserAccessLoggingSettingsAssociationDestroy(ctx context.Context) resource.TestCheckFunc { + return func(s *terraform.State) error { + conn := acctest.Provider.Meta().(*conns.AWSClient).WorkSpacesWebClient(ctx) + + for _, rs := range s.RootModule().Resources { + if rs.Type != "aws_workspacesweb_user_access_logging_settings_association" { + continue + } + + userAccessLoggingSettings, err := tfworkspacesweb.FindUserAccessLoggingSettingsByARN(ctx, conn, rs.Primary.Attributes["user_access_logging_settings_arn"]) + + if tfresource.NotFound(err) { + continue + } + + if err != nil { + return err + } + + // Check if the portal is still associated + portalARN := rs.Primary.Attributes["portal_arn"] + if slices.Contains(userAccessLoggingSettings.AssociatedPortalArns, portalARN) { + return fmt.Errorf("WorkSpaces Web User Access Logging Settings Association %s still exists", rs.Primary.Attributes["user_access_logging_settings_arn"]) + } + } + + return nil + } +} + +func testAccCheckUserAccessLoggingSettingsAssociationExists(ctx context.Context, n string, v *awstypes.UserAccessLoggingSettings) resource.TestCheckFunc { + return func(s *terraform.State) error { + rs, ok := s.RootModule().Resources[n] + if !ok { + return fmt.Errorf("Not found: %s", n) + } + + conn := acctest.Provider.Meta().(*conns.AWSClient).WorkSpacesWebClient(ctx) + + output, err := tfworkspacesweb.FindUserAccessLoggingSettingsByARN(ctx, conn, rs.Primary.Attributes["user_access_logging_settings_arn"]) + + if err != nil { + return err + } + + // Check if the portal is associated + portalARN := rs.Primary.Attributes["portal_arn"] + if !slices.Contains(output.AssociatedPortalArns, portalARN) { + return fmt.Errorf("Association not found") + } + + *v = *output + + return nil + } +} + +func testAccUserAccessLoggingSettingsAssociationImportStateIdFunc(resourceName string) resource.ImportStateIdFunc { + return func(s *terraform.State) (string, error) { + rs, ok := s.RootModule().Resources[resourceName] + if !ok { + return "", fmt.Errorf("Not found: %s", resourceName) + } + + return fmt.Sprintf("%s,%s", rs.Primary.Attributes["user_access_logging_settings_arn"], rs.Primary.Attributes["portal_arn"]), nil + } +} + +func testAccUserAccessLoggingSettingsAssociationConfig_basic(rName string) string { + return fmt.Sprintf(` +resource "aws_workspacesweb_portal" "test" { + display_name = "test" +} + +resource "aws_kinesis_stream" "test" { + name = "amazon-workspaces-web-%[1]s" + shard_count = 1 +} + +resource "aws_workspacesweb_user_access_logging_settings" "test" { + kinesis_stream_arn = aws_kinesis_stream.test.arn +} + +resource "aws_workspacesweb_user_access_logging_settings_association" "test" { + user_access_logging_settings_arn = aws_workspacesweb_user_access_logging_settings.test.user_access_logging_settings_arn + portal_arn = aws_workspacesweb_portal.test.portal_arn +} +`, rName) +} diff --git a/internal/service/workspacesweb/user_access_logging_settings_tags_gen_test.go b/internal/service/workspacesweb/user_access_logging_settings_tags_gen_test.go index d52ffbf79da6..6da331c4d75c 100644 --- a/internal/service/workspacesweb/user_access_logging_settings_tags_gen_test.go +++ b/internal/service/workspacesweb/user_access_logging_settings_tags_gen_test.go @@ -7,7 +7,6 @@ import ( "github.com/aws/aws-sdk-go-v2/service/workspacesweb/types" "github.com/hashicorp/terraform-plugin-testing/config" - sdkacctest "github.com/hashicorp/terraform-plugin-testing/helper/acctest" "github.com/hashicorp/terraform-plugin-testing/helper/resource" "github.com/hashicorp/terraform-plugin-testing/knownvalue" "github.com/hashicorp/terraform-plugin-testing/plancheck" @@ -19,11 +18,12 @@ import ( func TestAccWorkSpacesWebUserAccessLoggingSettings_tags(t *testing.T) { ctx := acctest.Context(t) + var v types.UserAccessLoggingSettings resourceName := "aws_workspacesweb_user_access_logging_settings.test" - rName := sdkacctest.RandomWithPrefix(acctest.ResourcePrefix) + rName := acctest.RandomWithPrefix(t, acctest.ResourcePrefix) - resource.ParallelTest(t, resource.TestCase{ + acctest.ParallelTest(ctx, t, resource.TestCase{ PreCheck: func() { acctest.PreCheck(ctx, t) }, ErrorCheck: acctest.ErrorCheck(t, names.WorkSpacesWebServiceID), CheckDestroy: testAccCheckUserAccessLoggingSettingsDestroy(ctx), @@ -209,11 +209,12 @@ func TestAccWorkSpacesWebUserAccessLoggingSettings_tags(t *testing.T) { func TestAccWorkSpacesWebUserAccessLoggingSettings_tags_null(t *testing.T) { ctx := acctest.Context(t) + var v types.UserAccessLoggingSettings resourceName := "aws_workspacesweb_user_access_logging_settings.test" - rName := sdkacctest.RandomWithPrefix(acctest.ResourcePrefix) + rName := acctest.RandomWithPrefix(t, acctest.ResourcePrefix) - resource.ParallelTest(t, resource.TestCase{ + acctest.ParallelTest(ctx, t, resource.TestCase{ PreCheck: func() { acctest.PreCheck(ctx, t) }, ErrorCheck: acctest.ErrorCheck(t, names.WorkSpacesWebServiceID), CheckDestroy: testAccCheckUserAccessLoggingSettingsDestroy(ctx), @@ -273,11 +274,12 @@ func TestAccWorkSpacesWebUserAccessLoggingSettings_tags_null(t *testing.T) { func TestAccWorkSpacesWebUserAccessLoggingSettings_tags_EmptyMap(t *testing.T) { ctx := acctest.Context(t) + var v types.UserAccessLoggingSettings resourceName := "aws_workspacesweb_user_access_logging_settings.test" - rName := sdkacctest.RandomWithPrefix(acctest.ResourcePrefix) + rName := acctest.RandomWithPrefix(t, acctest.ResourcePrefix) - resource.ParallelTest(t, resource.TestCase{ + acctest.ParallelTest(ctx, t, resource.TestCase{ PreCheck: func() { acctest.PreCheck(ctx, t) }, ErrorCheck: acctest.ErrorCheck(t, names.WorkSpacesWebServiceID), CheckDestroy: testAccCheckUserAccessLoggingSettingsDestroy(ctx), @@ -325,11 +327,12 @@ func TestAccWorkSpacesWebUserAccessLoggingSettings_tags_EmptyMap(t *testing.T) { func TestAccWorkSpacesWebUserAccessLoggingSettings_tags_AddOnUpdate(t *testing.T) { ctx := acctest.Context(t) + var v types.UserAccessLoggingSettings resourceName := "aws_workspacesweb_user_access_logging_settings.test" - rName := sdkacctest.RandomWithPrefix(acctest.ResourcePrefix) + rName := acctest.RandomWithPrefix(t, acctest.ResourcePrefix) - resource.ParallelTest(t, resource.TestCase{ + acctest.ParallelTest(ctx, t, resource.TestCase{ PreCheck: func() { acctest.PreCheck(ctx, t) }, ErrorCheck: acctest.ErrorCheck(t, names.WorkSpacesWebServiceID), CheckDestroy: testAccCheckUserAccessLoggingSettingsDestroy(ctx), @@ -407,11 +410,12 @@ func TestAccWorkSpacesWebUserAccessLoggingSettings_tags_AddOnUpdate(t *testing.T func TestAccWorkSpacesWebUserAccessLoggingSettings_tags_EmptyTag_OnCreate(t *testing.T) { ctx := acctest.Context(t) + var v types.UserAccessLoggingSettings resourceName := "aws_workspacesweb_user_access_logging_settings.test" - rName := sdkacctest.RandomWithPrefix(acctest.ResourcePrefix) + rName := acctest.RandomWithPrefix(t, acctest.ResourcePrefix) - resource.ParallelTest(t, resource.TestCase{ + acctest.ParallelTest(ctx, t, resource.TestCase{ PreCheck: func() { acctest.PreCheck(ctx, t) }, ErrorCheck: acctest.ErrorCheck(t, names.WorkSpacesWebServiceID), CheckDestroy: testAccCheckUserAccessLoggingSettingsDestroy(ctx), @@ -501,11 +505,12 @@ func TestAccWorkSpacesWebUserAccessLoggingSettings_tags_EmptyTag_OnCreate(t *tes func TestAccWorkSpacesWebUserAccessLoggingSettings_tags_EmptyTag_OnUpdate_Add(t *testing.T) { ctx := acctest.Context(t) + var v types.UserAccessLoggingSettings resourceName := "aws_workspacesweb_user_access_logging_settings.test" - rName := sdkacctest.RandomWithPrefix(acctest.ResourcePrefix) + rName := acctest.RandomWithPrefix(t, acctest.ResourcePrefix) - resource.ParallelTest(t, resource.TestCase{ + acctest.ParallelTest(ctx, t, resource.TestCase{ PreCheck: func() { acctest.PreCheck(ctx, t) }, ErrorCheck: acctest.ErrorCheck(t, names.WorkSpacesWebServiceID), CheckDestroy: testAccCheckUserAccessLoggingSettingsDestroy(ctx), @@ -644,11 +649,12 @@ func TestAccWorkSpacesWebUserAccessLoggingSettings_tags_EmptyTag_OnUpdate_Add(t func TestAccWorkSpacesWebUserAccessLoggingSettings_tags_EmptyTag_OnUpdate_Replace(t *testing.T) { ctx := acctest.Context(t) + var v types.UserAccessLoggingSettings resourceName := "aws_workspacesweb_user_access_logging_settings.test" - rName := sdkacctest.RandomWithPrefix(acctest.ResourcePrefix) + rName := acctest.RandomWithPrefix(t, acctest.ResourcePrefix) - resource.ParallelTest(t, resource.TestCase{ + acctest.ParallelTest(ctx, t, resource.TestCase{ PreCheck: func() { acctest.PreCheck(ctx, t) }, ErrorCheck: acctest.ErrorCheck(t, names.WorkSpacesWebServiceID), CheckDestroy: testAccCheckUserAccessLoggingSettingsDestroy(ctx), @@ -736,11 +742,12 @@ func TestAccWorkSpacesWebUserAccessLoggingSettings_tags_EmptyTag_OnUpdate_Replac func TestAccWorkSpacesWebUserAccessLoggingSettings_tags_DefaultTags_providerOnly(t *testing.T) { ctx := acctest.Context(t) + var v types.UserAccessLoggingSettings resourceName := "aws_workspacesweb_user_access_logging_settings.test" - rName := sdkacctest.RandomWithPrefix(acctest.ResourcePrefix) + rName := acctest.RandomWithPrefix(t, acctest.ResourcePrefix) - resource.ParallelTest(t, resource.TestCase{ + acctest.ParallelTest(ctx, t, resource.TestCase{ PreCheck: func() { acctest.PreCheck(ctx, t) }, ErrorCheck: acctest.ErrorCheck(t, names.WorkSpacesWebServiceID), CheckDestroy: testAccCheckUserAccessLoggingSettingsDestroy(ctx), @@ -925,11 +932,12 @@ func TestAccWorkSpacesWebUserAccessLoggingSettings_tags_DefaultTags_providerOnly func TestAccWorkSpacesWebUserAccessLoggingSettings_tags_DefaultTags_nonOverlapping(t *testing.T) { ctx := acctest.Context(t) + var v types.UserAccessLoggingSettings resourceName := "aws_workspacesweb_user_access_logging_settings.test" - rName := sdkacctest.RandomWithPrefix(acctest.ResourcePrefix) + rName := acctest.RandomWithPrefix(t, acctest.ResourcePrefix) - resource.ParallelTest(t, resource.TestCase{ + acctest.ParallelTest(ctx, t, resource.TestCase{ PreCheck: func() { acctest.PreCheck(ctx, t) }, ErrorCheck: acctest.ErrorCheck(t, names.WorkSpacesWebServiceID), CheckDestroy: testAccCheckUserAccessLoggingSettingsDestroy(ctx), @@ -1091,11 +1099,12 @@ func TestAccWorkSpacesWebUserAccessLoggingSettings_tags_DefaultTags_nonOverlappi func TestAccWorkSpacesWebUserAccessLoggingSettings_tags_DefaultTags_overlapping(t *testing.T) { ctx := acctest.Context(t) + var v types.UserAccessLoggingSettings resourceName := "aws_workspacesweb_user_access_logging_settings.test" - rName := sdkacctest.RandomWithPrefix(acctest.ResourcePrefix) + rName := acctest.RandomWithPrefix(t, acctest.ResourcePrefix) - resource.ParallelTest(t, resource.TestCase{ + acctest.ParallelTest(ctx, t, resource.TestCase{ PreCheck: func() { acctest.PreCheck(ctx, t) }, ErrorCheck: acctest.ErrorCheck(t, names.WorkSpacesWebServiceID), CheckDestroy: testAccCheckUserAccessLoggingSettingsDestroy(ctx), @@ -1273,11 +1282,12 @@ func TestAccWorkSpacesWebUserAccessLoggingSettings_tags_DefaultTags_overlapping( func TestAccWorkSpacesWebUserAccessLoggingSettings_tags_DefaultTags_updateToProviderOnly(t *testing.T) { ctx := acctest.Context(t) + var v types.UserAccessLoggingSettings resourceName := "aws_workspacesweb_user_access_logging_settings.test" - rName := sdkacctest.RandomWithPrefix(acctest.ResourcePrefix) + rName := acctest.RandomWithPrefix(t, acctest.ResourcePrefix) - resource.ParallelTest(t, resource.TestCase{ + acctest.ParallelTest(ctx, t, resource.TestCase{ PreCheck: func() { acctest.PreCheck(ctx, t) }, ErrorCheck: acctest.ErrorCheck(t, names.WorkSpacesWebServiceID), CheckDestroy: testAccCheckUserAccessLoggingSettingsDestroy(ctx), @@ -1365,11 +1375,12 @@ func TestAccWorkSpacesWebUserAccessLoggingSettings_tags_DefaultTags_updateToProv func TestAccWorkSpacesWebUserAccessLoggingSettings_tags_DefaultTags_updateToResourceOnly(t *testing.T) { ctx := acctest.Context(t) + var v types.UserAccessLoggingSettings resourceName := "aws_workspacesweb_user_access_logging_settings.test" - rName := sdkacctest.RandomWithPrefix(acctest.ResourcePrefix) + rName := acctest.RandomWithPrefix(t, acctest.ResourcePrefix) - resource.ParallelTest(t, resource.TestCase{ + acctest.ParallelTest(ctx, t, resource.TestCase{ PreCheck: func() { acctest.PreCheck(ctx, t) }, ErrorCheck: acctest.ErrorCheck(t, names.WorkSpacesWebServiceID), CheckDestroy: testAccCheckUserAccessLoggingSettingsDestroy(ctx), @@ -1456,11 +1467,12 @@ func TestAccWorkSpacesWebUserAccessLoggingSettings_tags_DefaultTags_updateToReso func TestAccWorkSpacesWebUserAccessLoggingSettings_tags_DefaultTags_emptyResourceTag(t *testing.T) { ctx := acctest.Context(t) + var v types.UserAccessLoggingSettings resourceName := "aws_workspacesweb_user_access_logging_settings.test" - rName := sdkacctest.RandomWithPrefix(acctest.ResourcePrefix) + rName := acctest.RandomWithPrefix(t, acctest.ResourcePrefix) - resource.ParallelTest(t, resource.TestCase{ + acctest.ParallelTest(ctx, t, resource.TestCase{ PreCheck: func() { acctest.PreCheck(ctx, t) }, ErrorCheck: acctest.ErrorCheck(t, names.WorkSpacesWebServiceID), CheckDestroy: testAccCheckUserAccessLoggingSettingsDestroy(ctx), @@ -1524,11 +1536,12 @@ func TestAccWorkSpacesWebUserAccessLoggingSettings_tags_DefaultTags_emptyResourc func TestAccWorkSpacesWebUserAccessLoggingSettings_tags_DefaultTags_emptyProviderOnlyTag(t *testing.T) { ctx := acctest.Context(t) + var v types.UserAccessLoggingSettings resourceName := "aws_workspacesweb_user_access_logging_settings.test" - rName := sdkacctest.RandomWithPrefix(acctest.ResourcePrefix) + rName := acctest.RandomWithPrefix(t, acctest.ResourcePrefix) - resource.ParallelTest(t, resource.TestCase{ + acctest.ParallelTest(ctx, t, resource.TestCase{ PreCheck: func() { acctest.PreCheck(ctx, t) }, ErrorCheck: acctest.ErrorCheck(t, names.WorkSpacesWebServiceID), CheckDestroy: testAccCheckUserAccessLoggingSettingsDestroy(ctx), @@ -1584,11 +1597,12 @@ func TestAccWorkSpacesWebUserAccessLoggingSettings_tags_DefaultTags_emptyProvide func TestAccWorkSpacesWebUserAccessLoggingSettings_tags_DefaultTags_nullOverlappingResourceTag(t *testing.T) { ctx := acctest.Context(t) + var v types.UserAccessLoggingSettings resourceName := "aws_workspacesweb_user_access_logging_settings.test" - rName := sdkacctest.RandomWithPrefix(acctest.ResourcePrefix) + rName := acctest.RandomWithPrefix(t, acctest.ResourcePrefix) - resource.ParallelTest(t, resource.TestCase{ + acctest.ParallelTest(ctx, t, resource.TestCase{ PreCheck: func() { acctest.PreCheck(ctx, t) }, ErrorCheck: acctest.ErrorCheck(t, names.WorkSpacesWebServiceID), CheckDestroy: testAccCheckUserAccessLoggingSettingsDestroy(ctx), @@ -1655,11 +1669,12 @@ func TestAccWorkSpacesWebUserAccessLoggingSettings_tags_DefaultTags_nullOverlapp func TestAccWorkSpacesWebUserAccessLoggingSettings_tags_DefaultTags_nullNonOverlappingResourceTag(t *testing.T) { ctx := acctest.Context(t) + var v types.UserAccessLoggingSettings resourceName := "aws_workspacesweb_user_access_logging_settings.test" - rName := sdkacctest.RandomWithPrefix(acctest.ResourcePrefix) + rName := acctest.RandomWithPrefix(t, acctest.ResourcePrefix) - resource.ParallelTest(t, resource.TestCase{ + acctest.ParallelTest(ctx, t, resource.TestCase{ PreCheck: func() { acctest.PreCheck(ctx, t) }, ErrorCheck: acctest.ErrorCheck(t, names.WorkSpacesWebServiceID), CheckDestroy: testAccCheckUserAccessLoggingSettingsDestroy(ctx), @@ -1728,11 +1743,12 @@ func TestAccWorkSpacesWebUserAccessLoggingSettings_tags_DefaultTags_nullNonOverl func TestAccWorkSpacesWebUserAccessLoggingSettings_tags_ComputedTag_OnCreate(t *testing.T) { ctx := acctest.Context(t) + var v types.UserAccessLoggingSettings resourceName := "aws_workspacesweb_user_access_logging_settings.test" - rName := sdkacctest.RandomWithPrefix(acctest.ResourcePrefix) + rName := acctest.RandomWithPrefix(t, acctest.ResourcePrefix) - resource.ParallelTest(t, resource.TestCase{ + acctest.ParallelTest(ctx, t, resource.TestCase{ PreCheck: func() { acctest.PreCheck(ctx, t) }, ErrorCheck: acctest.ErrorCheck(t, names.WorkSpacesWebServiceID), CheckDestroy: testAccCheckUserAccessLoggingSettingsDestroy(ctx), @@ -1785,11 +1801,12 @@ func TestAccWorkSpacesWebUserAccessLoggingSettings_tags_ComputedTag_OnCreate(t * func TestAccWorkSpacesWebUserAccessLoggingSettings_tags_ComputedTag_OnUpdate_Add(t *testing.T) { ctx := acctest.Context(t) + var v types.UserAccessLoggingSettings resourceName := "aws_workspacesweb_user_access_logging_settings.test" - rName := sdkacctest.RandomWithPrefix(acctest.ResourcePrefix) + rName := acctest.RandomWithPrefix(t, acctest.ResourcePrefix) - resource.ParallelTest(t, resource.TestCase{ + acctest.ParallelTest(ctx, t, resource.TestCase{ PreCheck: func() { acctest.PreCheck(ctx, t) }, ErrorCheck: acctest.ErrorCheck(t, names.WorkSpacesWebServiceID), CheckDestroy: testAccCheckUserAccessLoggingSettingsDestroy(ctx), @@ -1884,11 +1901,12 @@ func TestAccWorkSpacesWebUserAccessLoggingSettings_tags_ComputedTag_OnUpdate_Add func TestAccWorkSpacesWebUserAccessLoggingSettings_tags_ComputedTag_OnUpdate_Replace(t *testing.T) { ctx := acctest.Context(t) + var v types.UserAccessLoggingSettings resourceName := "aws_workspacesweb_user_access_logging_settings.test" - rName := sdkacctest.RandomWithPrefix(acctest.ResourcePrefix) + rName := acctest.RandomWithPrefix(t, acctest.ResourcePrefix) - resource.ParallelTest(t, resource.TestCase{ + acctest.ParallelTest(ctx, t, resource.TestCase{ PreCheck: func() { acctest.PreCheck(ctx, t) }, ErrorCheck: acctest.ErrorCheck(t, names.WorkSpacesWebServiceID), CheckDestroy: testAccCheckUserAccessLoggingSettingsDestroy(ctx), @@ -1973,11 +1991,12 @@ func TestAccWorkSpacesWebUserAccessLoggingSettings_tags_ComputedTag_OnUpdate_Rep func TestAccWorkSpacesWebUserAccessLoggingSettings_tags_IgnoreTags_Overlap_DefaultTag(t *testing.T) { ctx := acctest.Context(t) + var v types.UserAccessLoggingSettings resourceName := "aws_workspacesweb_user_access_logging_settings.test" - rName := sdkacctest.RandomWithPrefix(acctest.ResourcePrefix) + rName := acctest.RandomWithPrefix(t, acctest.ResourcePrefix) - resource.ParallelTest(t, resource.TestCase{ + acctest.ParallelTest(ctx, t, resource.TestCase{ PreCheck: func() { acctest.PreCheck(ctx, t) }, ErrorCheck: acctest.ErrorCheck(t, names.WorkSpacesWebServiceID), CheckDestroy: testAccCheckUserAccessLoggingSettingsDestroy(ctx), @@ -2135,11 +2154,12 @@ func TestAccWorkSpacesWebUserAccessLoggingSettings_tags_IgnoreTags_Overlap_Defau func TestAccWorkSpacesWebUserAccessLoggingSettings_tags_IgnoreTags_Overlap_ResourceTag(t *testing.T) { ctx := acctest.Context(t) + var v types.UserAccessLoggingSettings resourceName := "aws_workspacesweb_user_access_logging_settings.test" - rName := sdkacctest.RandomWithPrefix(acctest.ResourcePrefix) + rName := acctest.RandomWithPrefix(t, acctest.ResourcePrefix) - resource.ParallelTest(t, resource.TestCase{ + acctest.ParallelTest(ctx, t, resource.TestCase{ PreCheck: func() { acctest.PreCheck(ctx, t) }, ErrorCheck: acctest.ErrorCheck(t, names.WorkSpacesWebServiceID), CheckDestroy: testAccCheckUserAccessLoggingSettingsDestroy(ctx), diff --git a/internal/service/workspacesweb/user_settings_association.go b/internal/service/workspacesweb/user_settings_association.go new file mode 100644 index 000000000000..80676655ffe7 --- /dev/null +++ b/internal/service/workspacesweb/user_settings_association.go @@ -0,0 +1,164 @@ +// Copyright (c) HashiCorp, Inc. +// SPDX-License-Identifier: MPL-2.0 + +package workspacesweb + +import ( + "context" + "fmt" + "slices" + + "github.com/aws/aws-sdk-go-v2/service/workspacesweb" + awstypes "github.com/aws/aws-sdk-go-v2/service/workspacesweb/types" + "github.com/hashicorp/terraform-plugin-framework/path" + "github.com/hashicorp/terraform-plugin-framework/resource" + "github.com/hashicorp/terraform-plugin-framework/resource/schema" + "github.com/hashicorp/terraform-plugin-framework/resource/schema/planmodifier" + "github.com/hashicorp/terraform-plugin-framework/resource/schema/stringplanmodifier" + "github.com/hashicorp/terraform-provider-aws/internal/errs" + "github.com/hashicorp/terraform-provider-aws/internal/errs/fwdiag" + intflex "github.com/hashicorp/terraform-provider-aws/internal/flex" + "github.com/hashicorp/terraform-provider-aws/internal/framework" + fwtypes "github.com/hashicorp/terraform-provider-aws/internal/framework/types" + tfretry "github.com/hashicorp/terraform-provider-aws/internal/retry" +) + +// @FrameworkResource("aws_workspacesweb_user_settings_association", name="User Settings Association") +// @Testing(tagsTest=false) +// @Testing(existsType="github.com/aws/aws-sdk-go-v2/service/workspacesweb/types;types.UserSettings") +// @Testing(importStateIdAttribute="user_settings_arn,portal_arn") +func newUserSettingsAssociationResource(_ context.Context) (resource.ResourceWithConfigure, error) { + return &userSettingsAssociationResource{}, nil +} + +type userSettingsAssociationResource struct { + framework.ResourceWithModel[userSettingsAssociationResourceModel] + framework.WithNoUpdate +} + +func (r *userSettingsAssociationResource) Schema(ctx context.Context, request resource.SchemaRequest, response *resource.SchemaResponse) { + response.Schema = schema.Schema{ + Attributes: map[string]schema.Attribute{ + "portal_arn": schema.StringAttribute{ + CustomType: fwtypes.ARNType, + Required: true, + PlanModifiers: []planmodifier.String{ + stringplanmodifier.RequiresReplace(), + }, + }, + "user_settings_arn": schema.StringAttribute{ + CustomType: fwtypes.ARNType, + Required: true, + PlanModifiers: []planmodifier.String{ + stringplanmodifier.RequiresReplace(), + }, + }, + }, + } +} + +func (r *userSettingsAssociationResource) Create(ctx context.Context, request resource.CreateRequest, response *resource.CreateResponse) { + var data userSettingsAssociationResourceModel + response.Diagnostics.Append(request.Plan.Get(ctx, &data)...) + if response.Diagnostics.HasError() { + return + } + + conn := r.Meta().WorkSpacesWebClient(ctx) + + input := workspacesweb.AssociateUserSettingsInput{ + UserSettingsArn: data.UserSettingsARN.ValueStringPointer(), + PortalArn: data.PortalARN.ValueStringPointer(), + } + + _, err := conn.AssociateUserSettings(ctx, &input) + + if err != nil { + response.Diagnostics.AddError("creating WorkSpacesWeb User Settings Association", err.Error()) + return + } + + response.Diagnostics.Append(response.State.Set(ctx, data)...) +} + +func (r *userSettingsAssociationResource) Read(ctx context.Context, request resource.ReadRequest, response *resource.ReadResponse) { + var data userSettingsAssociationResourceModel + response.Diagnostics.Append(request.State.Get(ctx, &data)...) + if response.Diagnostics.HasError() { + return + } + + conn := r.Meta().WorkSpacesWebClient(ctx) + + // Check if the association exists by getting the user settings and checking associated portals + output, err := findUserSettingsByARN(ctx, conn, data.UserSettingsARN.ValueString()) + if tfretry.NotFound(err) { + response.Diagnostics.Append(fwdiag.NewResourceNotFoundWarningDiagnostic(err)) + response.State.RemoveResource(ctx) + return + } + + if err != nil { + response.Diagnostics.AddError(fmt.Sprintf("reading WorkSpacesWeb User Settings Association (%s)", data.UserSettingsARN.ValueString()), err.Error()) + return + } + + // Check if the portal is in the associated portals list + if !slices.Contains(output.AssociatedPortalArns, data.PortalARN.ValueString()) { + response.Diagnostics.Append(fwdiag.NewResourceNotFoundWarningDiagnostic(fmt.Errorf("association not found"))) + response.State.RemoveResource(ctx) + return + } + + response.Diagnostics.Append(response.State.Set(ctx, &data)...) +} + +func (r *userSettingsAssociationResource) Delete(ctx context.Context, request resource.DeleteRequest, response *resource.DeleteResponse) { + var data userSettingsAssociationResourceModel + response.Diagnostics.Append(request.State.Get(ctx, &data)...) + if response.Diagnostics.HasError() { + return + } + + conn := r.Meta().WorkSpacesWebClient(ctx) + + input := workspacesweb.DisassociateUserSettingsInput{ + PortalArn: data.PortalARN.ValueStringPointer(), + } + + _, err := conn.DisassociateUserSettings(ctx, &input) + + if errs.IsA[*awstypes.ResourceNotFoundException](err) { + return + } + + if err != nil { + response.Diagnostics.AddError(fmt.Sprintf("deleting WorkSpacesWeb User Settings Association (%s)", data.UserSettingsARN.ValueString()), err.Error()) + return + } +} + +func (r *userSettingsAssociationResource) ImportState(ctx context.Context, request resource.ImportStateRequest, response *resource.ImportStateResponse) { + const ( + userSettingsAssociationIDParts = 2 + ) + parts, err := intflex.ExpandResourceId(request.ID, userSettingsAssociationIDParts, true) + if err != nil { + response.Diagnostics.AddError( + "Unexpected Import Identifier", + fmt.Sprintf("Expected import identifier with format: user_settings_arn,portal_arn. Got: %q", request.ID), + ) + return + } + userSettingsARN := parts[0] + portalARN := parts[1] + + response.Diagnostics.Append(response.State.SetAttribute(ctx, path.Root("user_settings_arn"), userSettingsARN)...) + response.Diagnostics.Append(response.State.SetAttribute(ctx, path.Root("portal_arn"), portalARN)...) +} + +type userSettingsAssociationResourceModel struct { + framework.WithRegionModel + PortalARN fwtypes.ARN `tfsdk:"portal_arn"` + UserSettingsARN fwtypes.ARN `tfsdk:"user_settings_arn"` +} diff --git a/internal/service/workspacesweb/user_settings_association_test.go b/internal/service/workspacesweb/user_settings_association_test.go new file mode 100644 index 000000000000..075e0a8de316 --- /dev/null +++ b/internal/service/workspacesweb/user_settings_association_test.go @@ -0,0 +1,185 @@ +// Copyright (c) HashiCorp, Inc. +// SPDX-License-Identifier: MPL-2.0 + +package workspacesweb_test + +import ( + "context" + "fmt" + "slices" + "testing" + + awstypes "github.com/aws/aws-sdk-go-v2/service/workspacesweb/types" + "github.com/hashicorp/terraform-plugin-testing/helper/resource" + "github.com/hashicorp/terraform-plugin-testing/terraform" + "github.com/hashicorp/terraform-provider-aws/internal/acctest" + "github.com/hashicorp/terraform-provider-aws/internal/conns" + tfworkspacesweb "github.com/hashicorp/terraform-provider-aws/internal/service/workspacesweb" + "github.com/hashicorp/terraform-provider-aws/internal/tfresource" + "github.com/hashicorp/terraform-provider-aws/names" +) + +func TestAccWorkSpacesWebUserSettingsAssociation_basic(t *testing.T) { + ctx := acctest.Context(t) + var userSettings awstypes.UserSettings + resourceName := "aws_workspacesweb_user_settings_association.test" + userSettingsResourceName := "aws_workspacesweb_user_settings.test" + portalResourceName := "aws_workspacesweb_portal.test" + + resource.ParallelTest(t, resource.TestCase{ + PreCheck: func() { + acctest.PreCheck(ctx, t) + acctest.PreCheckPartitionHasService(t, names.WorkSpacesWebEndpointID) + testAccPreCheck(ctx, t) + }, + ErrorCheck: acctest.ErrorCheck(t, names.WorkSpacesWebServiceID), + ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories, + CheckDestroy: testAccCheckUserSettingsAssociationDestroy(ctx), + Steps: []resource.TestStep{ + { + Config: testAccUserSettingsAssociationConfig_basic(), + Check: resource.ComposeAggregateTestCheckFunc( + testAccCheckUserSettingsAssociationExists(ctx, resourceName, &userSettings), + resource.TestCheckResourceAttrPair(resourceName, "user_settings_arn", userSettingsResourceName, "user_settings_arn"), + resource.TestCheckResourceAttrPair(resourceName, "portal_arn", portalResourceName, "portal_arn"), + ), + }, + { + ResourceName: resourceName, + ImportState: true, + ImportStateVerify: true, + ImportStateIdFunc: testAccUserSettingsAssociationImportStateIdFunc(resourceName), + ImportStateVerifyIdentifierAttribute: "user_settings_arn", + }, + { + ResourceName: resourceName, + RefreshState: true, + }, + { + Config: testAccUserSettingsAssociationConfig_basic(), + Check: resource.ComposeAggregateTestCheckFunc( + //The following checks are for the UserSettings Resource and the PortalResource (and not for the association resource). + resource.TestCheckResourceAttr(userSettingsResourceName, "associated_portal_arns.#", "1"), + resource.TestCheckResourceAttrPair(userSettingsResourceName, "associated_portal_arns.0", portalResourceName, "portal_arn"), + resource.TestCheckResourceAttrPair(portalResourceName, "user_settings_arn", userSettingsResourceName, "user_settings_arn"), + ), + }, + }, + }) +} + +func TestAccWorkSpacesWebUserSettingsAssociation_disappears(t *testing.T) { + ctx := acctest.Context(t) + var userSettings awstypes.UserSettings + resourceName := "aws_workspacesweb_user_settings_association.test" + + resource.ParallelTest(t, resource.TestCase{ + PreCheck: func() { + acctest.PreCheck(ctx, t) + acctest.PreCheckPartitionHasService(t, names.WorkSpacesWebEndpointID) + testAccPreCheck(ctx, t) + }, + ErrorCheck: acctest.ErrorCheck(t, names.WorkSpacesWebServiceID), + ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories, + CheckDestroy: testAccCheckUserSettingsAssociationDestroy(ctx), + Steps: []resource.TestStep{ + { + Config: testAccUserSettingsAssociationConfig_basic(), + Check: resource.ComposeAggregateTestCheckFunc( + testAccCheckUserSettingsAssociationExists(ctx, resourceName, &userSettings), + acctest.CheckFrameworkResourceDisappears(ctx, acctest.Provider, tfworkspacesweb.ResourceUserSettingsAssociation, resourceName), + ), + ExpectNonEmptyPlan: true, + }, + }, + }) +} + +func testAccCheckUserSettingsAssociationDestroy(ctx context.Context) resource.TestCheckFunc { + return func(s *terraform.State) error { + conn := acctest.Provider.Meta().(*conns.AWSClient).WorkSpacesWebClient(ctx) + + for _, rs := range s.RootModule().Resources { + if rs.Type != "aws_workspacesweb_user_settings_association" { + continue + } + + userSettings, err := tfworkspacesweb.FindUserSettingsByARN(ctx, conn, rs.Primary.Attributes["user_settings_arn"]) + + if tfresource.NotFound(err) { + continue + } + + if err != nil { + return err + } + + // Check if the portal is still associated + portalARN := rs.Primary.Attributes["portal_arn"] + if slices.Contains(userSettings.AssociatedPortalArns, portalARN) { + return fmt.Errorf("WorkSpaces Web User Settings Association %s still exists", rs.Primary.Attributes["user_settings_arn"]) + } + } + + return nil + } +} + +func testAccCheckUserSettingsAssociationExists(ctx context.Context, n string, v *awstypes.UserSettings) resource.TestCheckFunc { + return func(s *terraform.State) error { + rs, ok := s.RootModule().Resources[n] + if !ok { + return fmt.Errorf("Not found: %s", n) + } + + conn := acctest.Provider.Meta().(*conns.AWSClient).WorkSpacesWebClient(ctx) + + output, err := tfworkspacesweb.FindUserSettingsByARN(ctx, conn, rs.Primary.Attributes["user_settings_arn"]) + + if err != nil { + return err + } + + // Check if the portal is associated + portalARN := rs.Primary.Attributes["portal_arn"] + if !slices.Contains(output.AssociatedPortalArns, portalARN) { + return fmt.Errorf("Association not found") + } + + *v = *output + + return nil + } +} + +func testAccUserSettingsAssociationImportStateIdFunc(resourceName string) resource.ImportStateIdFunc { + return func(s *terraform.State) (string, error) { + rs, ok := s.RootModule().Resources[resourceName] + if !ok { + return "", fmt.Errorf("Not found: %s", resourceName) + } + + return fmt.Sprintf("%s,%s", rs.Primary.Attributes["user_settings_arn"], rs.Primary.Attributes["portal_arn"]), nil + } +} + +func testAccUserSettingsAssociationConfig_basic() string { + return ` +resource "aws_workspacesweb_portal" "test" { + display_name = "test" +} + +resource "aws_workspacesweb_user_settings" "test" { + copy_allowed = "Enabled" + download_allowed = "Enabled" + paste_allowed = "Enabled" + print_allowed = "Enabled" + upload_allowed = "Enabled" +} + +resource "aws_workspacesweb_user_settings_association" "test" { + user_settings_arn = aws_workspacesweb_user_settings.test.user_settings_arn + portal_arn = aws_workspacesweb_portal.test.portal_arn +} +` +} diff --git a/internal/service/workspacesweb/user_settings_tags_gen_test.go b/internal/service/workspacesweb/user_settings_tags_gen_test.go index e9d57e3e9dd2..1510985e51a6 100644 --- a/internal/service/workspacesweb/user_settings_tags_gen_test.go +++ b/internal/service/workspacesweb/user_settings_tags_gen_test.go @@ -18,10 +18,11 @@ import ( func TestAccWorkSpacesWebUserSettings_tags(t *testing.T) { ctx := acctest.Context(t) + var v types.UserSettings resourceName := "aws_workspacesweb_user_settings.test" - resource.ParallelTest(t, resource.TestCase{ + acctest.ParallelTest(ctx, t, resource.TestCase{ PreCheck: func() { acctest.PreCheck(ctx, t) }, ErrorCheck: acctest.ErrorCheck(t, names.WorkSpacesWebServiceID), CheckDestroy: testAccCheckUserSettingsDestroy(ctx), @@ -199,10 +200,11 @@ func TestAccWorkSpacesWebUserSettings_tags(t *testing.T) { func TestAccWorkSpacesWebUserSettings_tags_null(t *testing.T) { ctx := acctest.Context(t) + var v types.UserSettings resourceName := "aws_workspacesweb_user_settings.test" - resource.ParallelTest(t, resource.TestCase{ + acctest.ParallelTest(ctx, t, resource.TestCase{ PreCheck: func() { acctest.PreCheck(ctx, t) }, ErrorCheck: acctest.ErrorCheck(t, names.WorkSpacesWebServiceID), CheckDestroy: testAccCheckUserSettingsDestroy(ctx), @@ -260,10 +262,11 @@ func TestAccWorkSpacesWebUserSettings_tags_null(t *testing.T) { func TestAccWorkSpacesWebUserSettings_tags_EmptyMap(t *testing.T) { ctx := acctest.Context(t) + var v types.UserSettings resourceName := "aws_workspacesweb_user_settings.test" - resource.ParallelTest(t, resource.TestCase{ + acctest.ParallelTest(ctx, t, resource.TestCase{ PreCheck: func() { acctest.PreCheck(ctx, t) }, ErrorCheck: acctest.ErrorCheck(t, names.WorkSpacesWebServiceID), CheckDestroy: testAccCheckUserSettingsDestroy(ctx), @@ -309,10 +312,11 @@ func TestAccWorkSpacesWebUserSettings_tags_EmptyMap(t *testing.T) { func TestAccWorkSpacesWebUserSettings_tags_AddOnUpdate(t *testing.T) { ctx := acctest.Context(t) + var v types.UserSettings resourceName := "aws_workspacesweb_user_settings.test" - resource.ParallelTest(t, resource.TestCase{ + acctest.ParallelTest(ctx, t, resource.TestCase{ PreCheck: func() { acctest.PreCheck(ctx, t) }, ErrorCheck: acctest.ErrorCheck(t, names.WorkSpacesWebServiceID), CheckDestroy: testAccCheckUserSettingsDestroy(ctx), @@ -387,10 +391,11 @@ func TestAccWorkSpacesWebUserSettings_tags_AddOnUpdate(t *testing.T) { func TestAccWorkSpacesWebUserSettings_tags_EmptyTag_OnCreate(t *testing.T) { ctx := acctest.Context(t) + var v types.UserSettings resourceName := "aws_workspacesweb_user_settings.test" - resource.ParallelTest(t, resource.TestCase{ + acctest.ParallelTest(ctx, t, resource.TestCase{ PreCheck: func() { acctest.PreCheck(ctx, t) }, ErrorCheck: acctest.ErrorCheck(t, names.WorkSpacesWebServiceID), CheckDestroy: testAccCheckUserSettingsDestroy(ctx), @@ -476,10 +481,11 @@ func TestAccWorkSpacesWebUserSettings_tags_EmptyTag_OnCreate(t *testing.T) { func TestAccWorkSpacesWebUserSettings_tags_EmptyTag_OnUpdate_Add(t *testing.T) { ctx := acctest.Context(t) + var v types.UserSettings resourceName := "aws_workspacesweb_user_settings.test" - resource.ParallelTest(t, resource.TestCase{ + acctest.ParallelTest(ctx, t, resource.TestCase{ PreCheck: func() { acctest.PreCheck(ctx, t) }, ErrorCheck: acctest.ErrorCheck(t, names.WorkSpacesWebServiceID), CheckDestroy: testAccCheckUserSettingsDestroy(ctx), @@ -613,10 +619,11 @@ func TestAccWorkSpacesWebUserSettings_tags_EmptyTag_OnUpdate_Add(t *testing.T) { func TestAccWorkSpacesWebUserSettings_tags_EmptyTag_OnUpdate_Replace(t *testing.T) { ctx := acctest.Context(t) + var v types.UserSettings resourceName := "aws_workspacesweb_user_settings.test" - resource.ParallelTest(t, resource.TestCase{ + acctest.ParallelTest(ctx, t, resource.TestCase{ PreCheck: func() { acctest.PreCheck(ctx, t) }, ErrorCheck: acctest.ErrorCheck(t, names.WorkSpacesWebServiceID), CheckDestroy: testAccCheckUserSettingsDestroy(ctx), @@ -701,10 +708,11 @@ func TestAccWorkSpacesWebUserSettings_tags_EmptyTag_OnUpdate_Replace(t *testing. func TestAccWorkSpacesWebUserSettings_tags_DefaultTags_providerOnly(t *testing.T) { ctx := acctest.Context(t) + var v types.UserSettings resourceName := "aws_workspacesweb_user_settings.test" - resource.ParallelTest(t, resource.TestCase{ + acctest.ParallelTest(ctx, t, resource.TestCase{ PreCheck: func() { acctest.PreCheck(ctx, t) }, ErrorCheck: acctest.ErrorCheck(t, names.WorkSpacesWebServiceID), CheckDestroy: testAccCheckUserSettingsDestroy(ctx), @@ -881,10 +889,11 @@ func TestAccWorkSpacesWebUserSettings_tags_DefaultTags_providerOnly(t *testing.T func TestAccWorkSpacesWebUserSettings_tags_DefaultTags_nonOverlapping(t *testing.T) { ctx := acctest.Context(t) + var v types.UserSettings resourceName := "aws_workspacesweb_user_settings.test" - resource.ParallelTest(t, resource.TestCase{ + acctest.ParallelTest(ctx, t, resource.TestCase{ PreCheck: func() { acctest.PreCheck(ctx, t) }, ErrorCheck: acctest.ErrorCheck(t, names.WorkSpacesWebServiceID), CheckDestroy: testAccCheckUserSettingsDestroy(ctx), @@ -1040,10 +1049,11 @@ func TestAccWorkSpacesWebUserSettings_tags_DefaultTags_nonOverlapping(t *testing func TestAccWorkSpacesWebUserSettings_tags_DefaultTags_overlapping(t *testing.T) { ctx := acctest.Context(t) + var v types.UserSettings resourceName := "aws_workspacesweb_user_settings.test" - resource.ParallelTest(t, resource.TestCase{ + acctest.ParallelTest(ctx, t, resource.TestCase{ PreCheck: func() { acctest.PreCheck(ctx, t) }, ErrorCheck: acctest.ErrorCheck(t, names.WorkSpacesWebServiceID), CheckDestroy: testAccCheckUserSettingsDestroy(ctx), @@ -1215,10 +1225,11 @@ func TestAccWorkSpacesWebUserSettings_tags_DefaultTags_overlapping(t *testing.T) func TestAccWorkSpacesWebUserSettings_tags_DefaultTags_updateToProviderOnly(t *testing.T) { ctx := acctest.Context(t) + var v types.UserSettings resourceName := "aws_workspacesweb_user_settings.test" - resource.ParallelTest(t, resource.TestCase{ + acctest.ParallelTest(ctx, t, resource.TestCase{ PreCheck: func() { acctest.PreCheck(ctx, t) }, ErrorCheck: acctest.ErrorCheck(t, names.WorkSpacesWebServiceID), CheckDestroy: testAccCheckUserSettingsDestroy(ctx), @@ -1303,10 +1314,11 @@ func TestAccWorkSpacesWebUserSettings_tags_DefaultTags_updateToProviderOnly(t *t func TestAccWorkSpacesWebUserSettings_tags_DefaultTags_updateToResourceOnly(t *testing.T) { ctx := acctest.Context(t) + var v types.UserSettings resourceName := "aws_workspacesweb_user_settings.test" - resource.ParallelTest(t, resource.TestCase{ + acctest.ParallelTest(ctx, t, resource.TestCase{ PreCheck: func() { acctest.PreCheck(ctx, t) }, ErrorCheck: acctest.ErrorCheck(t, names.WorkSpacesWebServiceID), CheckDestroy: testAccCheckUserSettingsDestroy(ctx), @@ -1390,10 +1402,11 @@ func TestAccWorkSpacesWebUserSettings_tags_DefaultTags_updateToResourceOnly(t *t func TestAccWorkSpacesWebUserSettings_tags_DefaultTags_emptyResourceTag(t *testing.T) { ctx := acctest.Context(t) + var v types.UserSettings resourceName := "aws_workspacesweb_user_settings.test" - resource.ParallelTest(t, resource.TestCase{ + acctest.ParallelTest(ctx, t, resource.TestCase{ PreCheck: func() { acctest.PreCheck(ctx, t) }, ErrorCheck: acctest.ErrorCheck(t, names.WorkSpacesWebServiceID), CheckDestroy: testAccCheckUserSettingsDestroy(ctx), @@ -1455,10 +1468,11 @@ func TestAccWorkSpacesWebUserSettings_tags_DefaultTags_emptyResourceTag(t *testi func TestAccWorkSpacesWebUserSettings_tags_DefaultTags_emptyProviderOnlyTag(t *testing.T) { ctx := acctest.Context(t) + var v types.UserSettings resourceName := "aws_workspacesweb_user_settings.test" - resource.ParallelTest(t, resource.TestCase{ + acctest.ParallelTest(ctx, t, resource.TestCase{ PreCheck: func() { acctest.PreCheck(ctx, t) }, ErrorCheck: acctest.ErrorCheck(t, names.WorkSpacesWebServiceID), CheckDestroy: testAccCheckUserSettingsDestroy(ctx), @@ -1512,10 +1526,11 @@ func TestAccWorkSpacesWebUserSettings_tags_DefaultTags_emptyProviderOnlyTag(t *t func TestAccWorkSpacesWebUserSettings_tags_DefaultTags_nullOverlappingResourceTag(t *testing.T) { ctx := acctest.Context(t) + var v types.UserSettings resourceName := "aws_workspacesweb_user_settings.test" - resource.ParallelTest(t, resource.TestCase{ + acctest.ParallelTest(ctx, t, resource.TestCase{ PreCheck: func() { acctest.PreCheck(ctx, t) }, ErrorCheck: acctest.ErrorCheck(t, names.WorkSpacesWebServiceID), CheckDestroy: testAccCheckUserSettingsDestroy(ctx), @@ -1580,10 +1595,11 @@ func TestAccWorkSpacesWebUserSettings_tags_DefaultTags_nullOverlappingResourceTa func TestAccWorkSpacesWebUserSettings_tags_DefaultTags_nullNonOverlappingResourceTag(t *testing.T) { ctx := acctest.Context(t) + var v types.UserSettings resourceName := "aws_workspacesweb_user_settings.test" - resource.ParallelTest(t, resource.TestCase{ + acctest.ParallelTest(ctx, t, resource.TestCase{ PreCheck: func() { acctest.PreCheck(ctx, t) }, ErrorCheck: acctest.ErrorCheck(t, names.WorkSpacesWebServiceID), CheckDestroy: testAccCheckUserSettingsDestroy(ctx), @@ -1650,10 +1666,11 @@ func TestAccWorkSpacesWebUserSettings_tags_DefaultTags_nullNonOverlappingResourc func TestAccWorkSpacesWebUserSettings_tags_ComputedTag_OnCreate(t *testing.T) { ctx := acctest.Context(t) + var v types.UserSettings resourceName := "aws_workspacesweb_user_settings.test" - resource.ParallelTest(t, resource.TestCase{ + acctest.ParallelTest(ctx, t, resource.TestCase{ PreCheck: func() { acctest.PreCheck(ctx, t) }, ErrorCheck: acctest.ErrorCheck(t, names.WorkSpacesWebServiceID), CheckDestroy: testAccCheckUserSettingsDestroy(ctx), @@ -1704,10 +1721,11 @@ func TestAccWorkSpacesWebUserSettings_tags_ComputedTag_OnCreate(t *testing.T) { func TestAccWorkSpacesWebUserSettings_tags_ComputedTag_OnUpdate_Add(t *testing.T) { ctx := acctest.Context(t) + var v types.UserSettings resourceName := "aws_workspacesweb_user_settings.test" - resource.ParallelTest(t, resource.TestCase{ + acctest.ParallelTest(ctx, t, resource.TestCase{ PreCheck: func() { acctest.PreCheck(ctx, t) }, ErrorCheck: acctest.ErrorCheck(t, names.WorkSpacesWebServiceID), CheckDestroy: testAccCheckUserSettingsDestroy(ctx), @@ -1799,10 +1817,11 @@ func TestAccWorkSpacesWebUserSettings_tags_ComputedTag_OnUpdate_Add(t *testing.T func TestAccWorkSpacesWebUserSettings_tags_ComputedTag_OnUpdate_Replace(t *testing.T) { ctx := acctest.Context(t) + var v types.UserSettings resourceName := "aws_workspacesweb_user_settings.test" - resource.ParallelTest(t, resource.TestCase{ + acctest.ParallelTest(ctx, t, resource.TestCase{ PreCheck: func() { acctest.PreCheck(ctx, t) }, ErrorCheck: acctest.ErrorCheck(t, names.WorkSpacesWebServiceID), CheckDestroy: testAccCheckUserSettingsDestroy(ctx), @@ -1884,10 +1903,11 @@ func TestAccWorkSpacesWebUserSettings_tags_ComputedTag_OnUpdate_Replace(t *testi func TestAccWorkSpacesWebUserSettings_tags_IgnoreTags_Overlap_DefaultTag(t *testing.T) { ctx := acctest.Context(t) + var v types.UserSettings resourceName := "aws_workspacesweb_user_settings.test" - resource.ParallelTest(t, resource.TestCase{ + acctest.ParallelTest(ctx, t, resource.TestCase{ PreCheck: func() { acctest.PreCheck(ctx, t) }, ErrorCheck: acctest.ErrorCheck(t, names.WorkSpacesWebServiceID), CheckDestroy: testAccCheckUserSettingsDestroy(ctx), @@ -2042,10 +2062,11 @@ func TestAccWorkSpacesWebUserSettings_tags_IgnoreTags_Overlap_DefaultTag(t *test func TestAccWorkSpacesWebUserSettings_tags_IgnoreTags_Overlap_ResourceTag(t *testing.T) { ctx := acctest.Context(t) + var v types.UserSettings resourceName := "aws_workspacesweb_user_settings.test" - resource.ParallelTest(t, resource.TestCase{ + acctest.ParallelTest(ctx, t, resource.TestCase{ PreCheck: func() { acctest.PreCheck(ctx, t) }, ErrorCheck: acctest.ErrorCheck(t, names.WorkSpacesWebServiceID), CheckDestroy: testAccCheckUserSettingsDestroy(ctx), diff --git a/internal/service/xray/encryption_config_identity_gen_test.go b/internal/service/xray/encryption_config_identity_gen_test.go index ffb581300be3..2c0b2ad6fd4c 100644 --- a/internal/service/xray/encryption_config_identity_gen_test.go +++ b/internal/service/xray/encryption_config_identity_gen_test.go @@ -16,6 +16,7 @@ import ( "github.com/hashicorp/terraform-plugin-testing/tfversion" "github.com/hashicorp/terraform-provider-aws/internal/acctest" tfknownvalue "github.com/hashicorp/terraform-provider-aws/internal/acctest/knownvalue" + tfstatecheck "github.com/hashicorp/terraform-provider-aws/internal/acctest/statecheck" "github.com/hashicorp/terraform-provider-aws/names" ) @@ -37,7 +38,7 @@ func testAccXRayEncryptionConfig_Identity_Basic(t *testing.T) { var v awstypes.EncryptionConfig resourceName := "aws_xray_encryption_config.test" - resource.Test(t, resource.TestCase{ + acctest.Test(ctx, t, resource.TestCase{ TerraformVersionChecks: []tfversion.TerraformVersionCheck{ tfversion.SkipBelow(tfversion.Version1_12_0), }, @@ -111,7 +112,7 @@ func testAccXRayEncryptionConfig_Identity_RegionOverride(t *testing.T) { resourceName := "aws_xray_encryption_config.test" - resource.Test(t, resource.TestCase{ + acctest.Test(ctx, t, resource.TestCase{ TerraformVersionChecks: []tfversion.TerraformVersionCheck{ tfversion.SkipBelow(tfversion.Version1_12_0), }, @@ -215,3 +216,76 @@ func testAccXRayEncryptionConfig_Identity_RegionOverride(t *testing.T) { }, }) } + +func testAccXRayEncryptionConfig_Identity_ExistingResource(t *testing.T) { + ctx := acctest.Context(t) + + var v awstypes.EncryptionConfig + resourceName := "aws_xray_encryption_config.test" + + acctest.Test(ctx, t, resource.TestCase{ + TerraformVersionChecks: []tfversion.TerraformVersionCheck{ + tfversion.SkipBelow(tfversion.Version1_12_0), + }, + PreCheck: func() { acctest.PreCheck(ctx, t) }, + ErrorCheck: acctest.ErrorCheck(t, names.XRayServiceID), + CheckDestroy: acctest.CheckDestroyNoop, + Steps: []resource.TestStep{ + // Step 1: Create pre-Identity + { + ConfigDirectory: config.StaticDirectory("testdata/EncryptionConfig/basic_v5.100.0/"), + ConfigVariables: config.Variables{}, + Check: resource.ComposeAggregateTestCheckFunc( + testAccCheckEncryptionConfigExists(ctx, resourceName, &v), + ), + ConfigStateChecks: []statecheck.StateCheck{ + tfstatecheck.ExpectNoIdentity(resourceName), + }, + }, + + // Step 2: v6.0 Identity error + { + ConfigDirectory: config.StaticDirectory("testdata/EncryptionConfig/basic_v6.0.0/"), + ConfigVariables: config.Variables{}, + Check: resource.ComposeAggregateTestCheckFunc( + testAccCheckEncryptionConfigExists(ctx, resourceName, &v), + ), + ConfigPlanChecks: resource.ConfigPlanChecks{ + PreApply: []plancheck.PlanCheck{ + plancheck.ExpectResourceAction(resourceName, plancheck.ResourceActionNoop), + }, + PostApplyPostRefresh: []plancheck.PlanCheck{ + plancheck.ExpectResourceAction(resourceName, plancheck.ResourceActionNoop), + }, + }, + ConfigStateChecks: []statecheck.StateCheck{ + statecheck.ExpectIdentity(resourceName, map[string]knownvalue.Check{ + names.AttrAccountID: knownvalue.Null(), + names.AttrRegion: knownvalue.Null(), + }), + }, + }, + + // Step 3: Current version + { + ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories, + ConfigDirectory: config.StaticDirectory("testdata/EncryptionConfig/basic/"), + ConfigVariables: config.Variables{}, + ConfigPlanChecks: resource.ConfigPlanChecks{ + PreApply: []plancheck.PlanCheck{ + plancheck.ExpectResourceAction(resourceName, plancheck.ResourceActionNoop), + }, + PostApplyPostRefresh: []plancheck.PlanCheck{ + plancheck.ExpectResourceAction(resourceName, plancheck.ResourceActionNoop), + }, + }, + ConfigStateChecks: []statecheck.StateCheck{ + statecheck.ExpectIdentity(resourceName, map[string]knownvalue.Check{ + names.AttrAccountID: tfknownvalue.AccountID(), + names.AttrRegion: knownvalue.StringExact(acctest.Region()), + }), + }, + }, + }, + }) +} diff --git a/internal/service/xray/encryption_config_test.go b/internal/service/xray/encryption_config_test.go index 73ea9afc7374..9e43eeb5d3b1 100644 --- a/internal/service/xray/encryption_config_test.go +++ b/internal/service/xray/encryption_config_test.go @@ -11,14 +11,8 @@ import ( "github.com/aws/aws-sdk-go-v2/service/xray/types" sdkacctest "github.com/hashicorp/terraform-plugin-testing/helper/acctest" "github.com/hashicorp/terraform-plugin-testing/helper/resource" - "github.com/hashicorp/terraform-plugin-testing/knownvalue" - "github.com/hashicorp/terraform-plugin-testing/plancheck" - "github.com/hashicorp/terraform-plugin-testing/statecheck" "github.com/hashicorp/terraform-plugin-testing/terraform" - "github.com/hashicorp/terraform-plugin-testing/tfversion" "github.com/hashicorp/terraform-provider-aws/internal/acctest" - tfknownvalue "github.com/hashicorp/terraform-provider-aws/internal/acctest/knownvalue" - tfstatecheck "github.com/hashicorp/terraform-provider-aws/internal/acctest/statecheck" "github.com/hashicorp/terraform-provider-aws/internal/conns" tfxray "github.com/hashicorp/terraform-provider-aws/internal/service/xray" "github.com/hashicorp/terraform-provider-aws/names" @@ -104,75 +98,6 @@ func testAccCheckEncryptionConfigExists(ctx context.Context, n string, v *types. } } -func testAccXRayEncryptionConfig_Identity_ExistingResource(t *testing.T) { - ctx := acctest.Context(t) - resourceName := "aws_xray_encryption_config.test" - - resource.Test(t, resource.TestCase{ - TerraformVersionChecks: []tfversion.TerraformVersionCheck{ - tfversion.SkipBelow(tfversion.Version1_12_0), - }, - PreCheck: func() { acctest.PreCheck(ctx, t) }, - ErrorCheck: acctest.ErrorCheck(t, names.XRayServiceID), - CheckDestroy: acctest.CheckDestroyNoop, - Steps: []resource.TestStep{ - { - ExternalProviders: map[string]resource.ExternalProvider{ - "aws": { - Source: "hashicorp/aws", - VersionConstraint: "5.100.0", - }, - }, - Config: testAccEncryptionConfigConfig_basic(), - ConfigStateChecks: []statecheck.StateCheck{ - tfstatecheck.ExpectNoIdentity(resourceName), - }, - }, - { - ExternalProviders: map[string]resource.ExternalProvider{ - "aws": { - Source: "hashicorp/aws", - VersionConstraint: "6.0.0", - }, - }, - Config: testAccEncryptionConfigConfig_basic(), - ConfigPlanChecks: resource.ConfigPlanChecks{ - PreApply: []plancheck.PlanCheck{ - plancheck.ExpectResourceAction(resourceName, plancheck.ResourceActionNoop), - }, - PostApplyPostRefresh: []plancheck.PlanCheck{ - plancheck.ExpectResourceAction(resourceName, plancheck.ResourceActionNoop), - }, - }, - ConfigStateChecks: []statecheck.StateCheck{ - statecheck.ExpectIdentity(resourceName, map[string]knownvalue.Check{ - names.AttrAccountID: knownvalue.Null(), - names.AttrRegion: knownvalue.Null(), - }), - }, - }, - { - ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories, - Config: testAccEncryptionConfigConfig_basic(), - ConfigPlanChecks: resource.ConfigPlanChecks{ - PreApply: []plancheck.PlanCheck{ - plancheck.ExpectResourceAction(resourceName, plancheck.ResourceActionNoop), - }, - PostApplyPostRefresh: []plancheck.PlanCheck{ - plancheck.ExpectResourceAction(resourceName, plancheck.ResourceActionNoop), - }, - }, - ConfigStateChecks: []statecheck.StateCheck{ - statecheck.ExpectIdentity(resourceName, map[string]knownvalue.Check{ - names.AttrAccountID: tfknownvalue.AccountID(), - names.AttrRegion: knownvalue.StringExact(acctest.Region()), - }), - }, - }, - }, - }) -} - func testAccEncryptionConfigConfig_basic() string { return ` resource "aws_xray_encryption_config" "test" { diff --git a/internal/service/xray/group_identity_gen_test.go b/internal/service/xray/group_identity_gen_test.go index ca551a6fa087..78e717e930c3 100644 --- a/internal/service/xray/group_identity_gen_test.go +++ b/internal/service/xray/group_identity_gen_test.go @@ -16,6 +16,7 @@ import ( "github.com/hashicorp/terraform-plugin-testing/tfjsonpath" "github.com/hashicorp/terraform-plugin-testing/tfversion" "github.com/hashicorp/terraform-provider-aws/internal/acctest" + tfstatecheck "github.com/hashicorp/terraform-provider-aws/internal/acctest/statecheck" "github.com/hashicorp/terraform-provider-aws/names" ) @@ -26,7 +27,7 @@ func TestAccXRayGroup_Identity_Basic(t *testing.T) { resourceName := "aws_xray_group.test" rName := sdkacctest.RandomWithPrefix(acctest.ResourcePrefix) - resource.ParallelTest(t, resource.TestCase{ + acctest.ParallelTest(ctx, t, resource.TestCase{ TerraformVersionChecks: []tfversion.TerraformVersionCheck{ tfversion.SkipBelow(tfversion.Version1_12_0), }, @@ -47,6 +48,9 @@ func TestAccXRayGroup_Identity_Basic(t *testing.T) { ConfigStateChecks: []statecheck.StateCheck{ statecheck.CompareValuePairs(resourceName, tfjsonpath.New(names.AttrID), resourceName, tfjsonpath.New(names.AttrARN), compare.ValuesSame()), statecheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrRegion), knownvalue.StringExact(acctest.Region())), + statecheck.ExpectIdentity(resourceName, map[string]knownvalue.Check{ + names.AttrARN: knownvalue.NotNull(), + }), statecheck.ExpectIdentityValueMatchesState(resourceName, tfjsonpath.New(names.AttrARN)), }, }, @@ -108,7 +112,7 @@ func TestAccXRayGroup_Identity_RegionOverride(t *testing.T) { resourceName := "aws_xray_group.test" rName := sdkacctest.RandomWithPrefix(acctest.ResourcePrefix) - resource.ParallelTest(t, resource.TestCase{ + acctest.ParallelTest(ctx, t, resource.TestCase{ TerraformVersionChecks: []tfversion.TerraformVersionCheck{ tfversion.SkipBelow(tfversion.Version1_12_0), }, @@ -127,6 +131,9 @@ func TestAccXRayGroup_Identity_RegionOverride(t *testing.T) { ConfigStateChecks: []statecheck.StateCheck{ statecheck.CompareValuePairs(resourceName, tfjsonpath.New(names.AttrID), resourceName, tfjsonpath.New(names.AttrARN), compare.ValuesSame()), statecheck.ExpectKnownValue(resourceName, tfjsonpath.New(names.AttrRegion), knownvalue.StringExact(acctest.AlternateRegion())), + statecheck.ExpectIdentity(resourceName, map[string]knownvalue.Check{ + names.AttrARN: knownvalue.NotNull(), + }), statecheck.ExpectIdentityValueMatchesState(resourceName, tfjsonpath.New(names.AttrARN)), }, }, @@ -218,3 +225,82 @@ func TestAccXRayGroup_Identity_RegionOverride(t *testing.T) { }, }) } + +func TestAccXRayGroup_Identity_ExistingResource(t *testing.T) { + ctx := acctest.Context(t) + + var v types.Group + resourceName := "aws_xray_group.test" + rName := sdkacctest.RandomWithPrefix(acctest.ResourcePrefix) + + acctest.ParallelTest(ctx, t, resource.TestCase{ + TerraformVersionChecks: []tfversion.TerraformVersionCheck{ + tfversion.SkipBelow(tfversion.Version1_12_0), + }, + PreCheck: func() { acctest.PreCheck(ctx, t) }, + ErrorCheck: acctest.ErrorCheck(t, names.XRayServiceID), + CheckDestroy: testAccCheckGroupDestroy(ctx), + Steps: []resource.TestStep{ + // Step 1: Create pre-Identity + { + ConfigDirectory: config.StaticDirectory("testdata/Group/basic_v5.100.0/"), + ConfigVariables: config.Variables{ + acctest.CtRName: config.StringVariable(rName), + }, + Check: resource.ComposeAggregateTestCheckFunc( + testAccCheckGroupExists(ctx, resourceName, &v), + ), + ConfigStateChecks: []statecheck.StateCheck{ + tfstatecheck.ExpectNoIdentity(resourceName), + }, + }, + + // Step 2: v6.0 Identity error + { + ConfigDirectory: config.StaticDirectory("testdata/Group/basic_v6.0.0/"), + ConfigVariables: config.Variables{ + acctest.CtRName: config.StringVariable(rName), + }, + Check: resource.ComposeAggregateTestCheckFunc( + testAccCheckGroupExists(ctx, resourceName, &v), + ), + ConfigPlanChecks: resource.ConfigPlanChecks{ + PreApply: []plancheck.PlanCheck{ + plancheck.ExpectResourceAction(resourceName, plancheck.ResourceActionNoop), + }, + PostApplyPostRefresh: []plancheck.PlanCheck{ + plancheck.ExpectResourceAction(resourceName, plancheck.ResourceActionNoop), + }, + }, + ConfigStateChecks: []statecheck.StateCheck{ + statecheck.ExpectIdentity(resourceName, map[string]knownvalue.Check{ + names.AttrARN: knownvalue.Null(), + }), + }, + }, + + // Step 3: Current version + { + ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories, + ConfigDirectory: config.StaticDirectory("testdata/Group/basic/"), + ConfigVariables: config.Variables{ + acctest.CtRName: config.StringVariable(rName), + }, + ConfigPlanChecks: resource.ConfigPlanChecks{ + PreApply: []plancheck.PlanCheck{ + plancheck.ExpectResourceAction(resourceName, plancheck.ResourceActionNoop), + }, + PostApplyPostRefresh: []plancheck.PlanCheck{ + plancheck.ExpectResourceAction(resourceName, plancheck.ResourceActionNoop), + }, + }, + ConfigStateChecks: []statecheck.StateCheck{ + statecheck.ExpectIdentity(resourceName, map[string]knownvalue.Check{ + names.AttrARN: knownvalue.NotNull(), + }), + statecheck.ExpectIdentityValueMatchesState(resourceName, tfjsonpath.New(names.AttrARN)), + }, + }, + }, + }) +} diff --git a/internal/service/xray/group_tags_gen_test.go b/internal/service/xray/group_tags_gen_test.go index f8ccf209a26e..0f83c3d5785a 100644 --- a/internal/service/xray/group_tags_gen_test.go +++ b/internal/service/xray/group_tags_gen_test.go @@ -7,7 +7,6 @@ import ( "github.com/aws/aws-sdk-go-v2/service/xray/types" "github.com/hashicorp/terraform-plugin-testing/config" - sdkacctest "github.com/hashicorp/terraform-plugin-testing/helper/acctest" "github.com/hashicorp/terraform-plugin-testing/helper/resource" "github.com/hashicorp/terraform-plugin-testing/knownvalue" "github.com/hashicorp/terraform-plugin-testing/plancheck" @@ -19,11 +18,12 @@ import ( func TestAccXRayGroup_tags(t *testing.T) { ctx := acctest.Context(t) + var v types.Group resourceName := "aws_xray_group.test" - rName := sdkacctest.RandomWithPrefix(acctest.ResourcePrefix) + rName := acctest.RandomWithPrefix(t, acctest.ResourcePrefix) - resource.ParallelTest(t, resource.TestCase{ + acctest.ParallelTest(ctx, t, resource.TestCase{ PreCheck: func() { acctest.PreCheck(ctx, t) }, ErrorCheck: acctest.ErrorCheck(t, names.XRayServiceID), CheckDestroy: testAccCheckGroupDestroy(ctx), @@ -201,11 +201,12 @@ func TestAccXRayGroup_tags(t *testing.T) { func TestAccXRayGroup_tags_null(t *testing.T) { ctx := acctest.Context(t) + var v types.Group resourceName := "aws_xray_group.test" - rName := sdkacctest.RandomWithPrefix(acctest.ResourcePrefix) + rName := acctest.RandomWithPrefix(t, acctest.ResourcePrefix) - resource.ParallelTest(t, resource.TestCase{ + acctest.ParallelTest(ctx, t, resource.TestCase{ PreCheck: func() { acctest.PreCheck(ctx, t) }, ErrorCheck: acctest.ErrorCheck(t, names.XRayServiceID), CheckDestroy: testAccCheckGroupDestroy(ctx), @@ -268,11 +269,12 @@ func TestAccXRayGroup_tags_null(t *testing.T) { func TestAccXRayGroup_tags_EmptyMap(t *testing.T) { ctx := acctest.Context(t) + var v types.Group resourceName := "aws_xray_group.test" - rName := sdkacctest.RandomWithPrefix(acctest.ResourcePrefix) + rName := acctest.RandomWithPrefix(t, acctest.ResourcePrefix) - resource.ParallelTest(t, resource.TestCase{ + acctest.ParallelTest(ctx, t, resource.TestCase{ PreCheck: func() { acctest.PreCheck(ctx, t) }, ErrorCheck: acctest.ErrorCheck(t, names.XRayServiceID), CheckDestroy: testAccCheckGroupDestroy(ctx), @@ -331,11 +333,12 @@ func TestAccXRayGroup_tags_EmptyMap(t *testing.T) { func TestAccXRayGroup_tags_AddOnUpdate(t *testing.T) { ctx := acctest.Context(t) + var v types.Group resourceName := "aws_xray_group.test" - rName := sdkacctest.RandomWithPrefix(acctest.ResourcePrefix) + rName := acctest.RandomWithPrefix(t, acctest.ResourcePrefix) - resource.ParallelTest(t, resource.TestCase{ + acctest.ParallelTest(ctx, t, resource.TestCase{ PreCheck: func() { acctest.PreCheck(ctx, t) }, ErrorCheck: acctest.ErrorCheck(t, names.XRayServiceID), CheckDestroy: testAccCheckGroupDestroy(ctx), @@ -412,11 +415,12 @@ func TestAccXRayGroup_tags_AddOnUpdate(t *testing.T) { func TestAccXRayGroup_tags_EmptyTag_OnCreate(t *testing.T) { ctx := acctest.Context(t) + var v types.Group resourceName := "aws_xray_group.test" - rName := sdkacctest.RandomWithPrefix(acctest.ResourcePrefix) + rName := acctest.RandomWithPrefix(t, acctest.ResourcePrefix) - resource.ParallelTest(t, resource.TestCase{ + acctest.ParallelTest(ctx, t, resource.TestCase{ PreCheck: func() { acctest.PreCheck(ctx, t) }, ErrorCheck: acctest.ErrorCheck(t, names.XRayServiceID), CheckDestroy: testAccCheckGroupDestroy(ctx), @@ -501,11 +505,12 @@ func TestAccXRayGroup_tags_EmptyTag_OnCreate(t *testing.T) { func TestAccXRayGroup_tags_EmptyTag_OnUpdate_Add(t *testing.T) { ctx := acctest.Context(t) + var v types.Group resourceName := "aws_xray_group.test" - rName := sdkacctest.RandomWithPrefix(acctest.ResourcePrefix) + rName := acctest.RandomWithPrefix(t, acctest.ResourcePrefix) - resource.ParallelTest(t, resource.TestCase{ + acctest.ParallelTest(ctx, t, resource.TestCase{ PreCheck: func() { acctest.PreCheck(ctx, t) }, ErrorCheck: acctest.ErrorCheck(t, names.XRayServiceID), CheckDestroy: testAccCheckGroupDestroy(ctx), @@ -638,11 +643,12 @@ func TestAccXRayGroup_tags_EmptyTag_OnUpdate_Add(t *testing.T) { func TestAccXRayGroup_tags_EmptyTag_OnUpdate_Replace(t *testing.T) { ctx := acctest.Context(t) + var v types.Group resourceName := "aws_xray_group.test" - rName := sdkacctest.RandomWithPrefix(acctest.ResourcePrefix) + rName := acctest.RandomWithPrefix(t, acctest.ResourcePrefix) - resource.ParallelTest(t, resource.TestCase{ + acctest.ParallelTest(ctx, t, resource.TestCase{ PreCheck: func() { acctest.PreCheck(ctx, t) }, ErrorCheck: acctest.ErrorCheck(t, names.XRayServiceID), CheckDestroy: testAccCheckGroupDestroy(ctx), @@ -727,11 +733,12 @@ func TestAccXRayGroup_tags_EmptyTag_OnUpdate_Replace(t *testing.T) { func TestAccXRayGroup_tags_DefaultTags_providerOnly(t *testing.T) { ctx := acctest.Context(t) + var v types.Group resourceName := "aws_xray_group.test" - rName := sdkacctest.RandomWithPrefix(acctest.ResourcePrefix) + rName := acctest.RandomWithPrefix(t, acctest.ResourcePrefix) - resource.ParallelTest(t, resource.TestCase{ + acctest.ParallelTest(ctx, t, resource.TestCase{ PreCheck: func() { acctest.PreCheck(ctx, t) }, ErrorCheck: acctest.ErrorCheck(t, names.XRayServiceID), CheckDestroy: testAccCheckGroupDestroy(ctx), @@ -908,11 +915,12 @@ func TestAccXRayGroup_tags_DefaultTags_providerOnly(t *testing.T) { func TestAccXRayGroup_tags_DefaultTags_nonOverlapping(t *testing.T) { ctx := acctest.Context(t) + var v types.Group resourceName := "aws_xray_group.test" - rName := sdkacctest.RandomWithPrefix(acctest.ResourcePrefix) + rName := acctest.RandomWithPrefix(t, acctest.ResourcePrefix) - resource.ParallelTest(t, resource.TestCase{ + acctest.ParallelTest(ctx, t, resource.TestCase{ PreCheck: func() { acctest.PreCheck(ctx, t) }, ErrorCheck: acctest.ErrorCheck(t, names.XRayServiceID), CheckDestroy: testAccCheckGroupDestroy(ctx), @@ -1068,11 +1076,12 @@ func TestAccXRayGroup_tags_DefaultTags_nonOverlapping(t *testing.T) { func TestAccXRayGroup_tags_DefaultTags_overlapping(t *testing.T) { ctx := acctest.Context(t) + var v types.Group resourceName := "aws_xray_group.test" - rName := sdkacctest.RandomWithPrefix(acctest.ResourcePrefix) + rName := acctest.RandomWithPrefix(t, acctest.ResourcePrefix) - resource.ParallelTest(t, resource.TestCase{ + acctest.ParallelTest(ctx, t, resource.TestCase{ PreCheck: func() { acctest.PreCheck(ctx, t) }, ErrorCheck: acctest.ErrorCheck(t, names.XRayServiceID), CheckDestroy: testAccCheckGroupDestroy(ctx), @@ -1244,11 +1253,12 @@ func TestAccXRayGroup_tags_DefaultTags_overlapping(t *testing.T) { func TestAccXRayGroup_tags_DefaultTags_updateToProviderOnly(t *testing.T) { ctx := acctest.Context(t) + var v types.Group resourceName := "aws_xray_group.test" - rName := sdkacctest.RandomWithPrefix(acctest.ResourcePrefix) + rName := acctest.RandomWithPrefix(t, acctest.ResourcePrefix) - resource.ParallelTest(t, resource.TestCase{ + acctest.ParallelTest(ctx, t, resource.TestCase{ PreCheck: func() { acctest.PreCheck(ctx, t) }, ErrorCheck: acctest.ErrorCheck(t, names.XRayServiceID), CheckDestroy: testAccCheckGroupDestroy(ctx), @@ -1334,11 +1344,12 @@ func TestAccXRayGroup_tags_DefaultTags_updateToProviderOnly(t *testing.T) { func TestAccXRayGroup_tags_DefaultTags_updateToResourceOnly(t *testing.T) { ctx := acctest.Context(t) + var v types.Group resourceName := "aws_xray_group.test" - rName := sdkacctest.RandomWithPrefix(acctest.ResourcePrefix) + rName := acctest.RandomWithPrefix(t, acctest.ResourcePrefix) - resource.ParallelTest(t, resource.TestCase{ + acctest.ParallelTest(ctx, t, resource.TestCase{ PreCheck: func() { acctest.PreCheck(ctx, t) }, ErrorCheck: acctest.ErrorCheck(t, names.XRayServiceID), CheckDestroy: testAccCheckGroupDestroy(ctx), @@ -1423,11 +1434,12 @@ func TestAccXRayGroup_tags_DefaultTags_updateToResourceOnly(t *testing.T) { func TestAccXRayGroup_tags_DefaultTags_emptyResourceTag(t *testing.T) { ctx := acctest.Context(t) + var v types.Group resourceName := "aws_xray_group.test" - rName := sdkacctest.RandomWithPrefix(acctest.ResourcePrefix) + rName := acctest.RandomWithPrefix(t, acctest.ResourcePrefix) - resource.ParallelTest(t, resource.TestCase{ + acctest.ParallelTest(ctx, t, resource.TestCase{ PreCheck: func() { acctest.PreCheck(ctx, t) }, ErrorCheck: acctest.ErrorCheck(t, names.XRayServiceID), CheckDestroy: testAccCheckGroupDestroy(ctx), @@ -1488,11 +1500,12 @@ func TestAccXRayGroup_tags_DefaultTags_emptyResourceTag(t *testing.T) { func TestAccXRayGroup_tags_DefaultTags_emptyProviderOnlyTag(t *testing.T) { ctx := acctest.Context(t) + var v types.Group resourceName := "aws_xray_group.test" - rName := sdkacctest.RandomWithPrefix(acctest.ResourcePrefix) + rName := acctest.RandomWithPrefix(t, acctest.ResourcePrefix) - resource.ParallelTest(t, resource.TestCase{ + acctest.ParallelTest(ctx, t, resource.TestCase{ PreCheck: func() { acctest.PreCheck(ctx, t) }, ErrorCheck: acctest.ErrorCheck(t, names.XRayServiceID), CheckDestroy: testAccCheckGroupDestroy(ctx), @@ -1545,11 +1558,12 @@ func TestAccXRayGroup_tags_DefaultTags_emptyProviderOnlyTag(t *testing.T) { func TestAccXRayGroup_tags_DefaultTags_nullOverlappingResourceTag(t *testing.T) { ctx := acctest.Context(t) + var v types.Group resourceName := "aws_xray_group.test" - rName := sdkacctest.RandomWithPrefix(acctest.ResourcePrefix) + rName := acctest.RandomWithPrefix(t, acctest.ResourcePrefix) - resource.ParallelTest(t, resource.TestCase{ + acctest.ParallelTest(ctx, t, resource.TestCase{ PreCheck: func() { acctest.PreCheck(ctx, t) }, ErrorCheck: acctest.ErrorCheck(t, names.XRayServiceID), CheckDestroy: testAccCheckGroupDestroy(ctx), @@ -1607,11 +1621,12 @@ func TestAccXRayGroup_tags_DefaultTags_nullOverlappingResourceTag(t *testing.T) func TestAccXRayGroup_tags_DefaultTags_nullNonOverlappingResourceTag(t *testing.T) { ctx := acctest.Context(t) + var v types.Group resourceName := "aws_xray_group.test" - rName := sdkacctest.RandomWithPrefix(acctest.ResourcePrefix) + rName := acctest.RandomWithPrefix(t, acctest.ResourcePrefix) - resource.ParallelTest(t, resource.TestCase{ + acctest.ParallelTest(ctx, t, resource.TestCase{ PreCheck: func() { acctest.PreCheck(ctx, t) }, ErrorCheck: acctest.ErrorCheck(t, names.XRayServiceID), CheckDestroy: testAccCheckGroupDestroy(ctx), @@ -1669,11 +1684,12 @@ func TestAccXRayGroup_tags_DefaultTags_nullNonOverlappingResourceTag(t *testing. func TestAccXRayGroup_tags_ComputedTag_OnCreate(t *testing.T) { ctx := acctest.Context(t) + var v types.Group resourceName := "aws_xray_group.test" - rName := sdkacctest.RandomWithPrefix(acctest.ResourcePrefix) + rName := acctest.RandomWithPrefix(t, acctest.ResourcePrefix) - resource.ParallelTest(t, resource.TestCase{ + acctest.ParallelTest(ctx, t, resource.TestCase{ PreCheck: func() { acctest.PreCheck(ctx, t) }, ErrorCheck: acctest.ErrorCheck(t, names.XRayServiceID), CheckDestroy: testAccCheckGroupDestroy(ctx), @@ -1724,11 +1740,12 @@ func TestAccXRayGroup_tags_ComputedTag_OnCreate(t *testing.T) { func TestAccXRayGroup_tags_ComputedTag_OnUpdate_Add(t *testing.T) { ctx := acctest.Context(t) + var v types.Group resourceName := "aws_xray_group.test" - rName := sdkacctest.RandomWithPrefix(acctest.ResourcePrefix) + rName := acctest.RandomWithPrefix(t, acctest.ResourcePrefix) - resource.ParallelTest(t, resource.TestCase{ + acctest.ParallelTest(ctx, t, resource.TestCase{ PreCheck: func() { acctest.PreCheck(ctx, t) }, ErrorCheck: acctest.ErrorCheck(t, names.XRayServiceID), CheckDestroy: testAccCheckGroupDestroy(ctx), @@ -1821,11 +1838,12 @@ func TestAccXRayGroup_tags_ComputedTag_OnUpdate_Add(t *testing.T) { func TestAccXRayGroup_tags_ComputedTag_OnUpdate_Replace(t *testing.T) { ctx := acctest.Context(t) + var v types.Group resourceName := "aws_xray_group.test" - rName := sdkacctest.RandomWithPrefix(acctest.ResourcePrefix) + rName := acctest.RandomWithPrefix(t, acctest.ResourcePrefix) - resource.ParallelTest(t, resource.TestCase{ + acctest.ParallelTest(ctx, t, resource.TestCase{ PreCheck: func() { acctest.PreCheck(ctx, t) }, ErrorCheck: acctest.ErrorCheck(t, names.XRayServiceID), CheckDestroy: testAccCheckGroupDestroy(ctx), @@ -1908,11 +1926,12 @@ func TestAccXRayGroup_tags_ComputedTag_OnUpdate_Replace(t *testing.T) { func TestAccXRayGroup_tags_IgnoreTags_Overlap_DefaultTag(t *testing.T) { ctx := acctest.Context(t) + var v types.Group resourceName := "aws_xray_group.test" - rName := sdkacctest.RandomWithPrefix(acctest.ResourcePrefix) + rName := acctest.RandomWithPrefix(t, acctest.ResourcePrefix) - resource.ParallelTest(t, resource.TestCase{ + acctest.ParallelTest(ctx, t, resource.TestCase{ PreCheck: func() { acctest.PreCheck(ctx, t) }, ErrorCheck: acctest.ErrorCheck(t, names.XRayServiceID), CheckDestroy: testAccCheckGroupDestroy(ctx), @@ -2070,11 +2089,12 @@ func TestAccXRayGroup_tags_IgnoreTags_Overlap_DefaultTag(t *testing.T) { func TestAccXRayGroup_tags_IgnoreTags_Overlap_ResourceTag(t *testing.T) { ctx := acctest.Context(t) + var v types.Group resourceName := "aws_xray_group.test" - rName := sdkacctest.RandomWithPrefix(acctest.ResourcePrefix) + rName := acctest.RandomWithPrefix(t, acctest.ResourcePrefix) - resource.ParallelTest(t, resource.TestCase{ + acctest.ParallelTest(ctx, t, resource.TestCase{ PreCheck: func() { acctest.PreCheck(ctx, t) }, ErrorCheck: acctest.ErrorCheck(t, names.XRayServiceID), CheckDestroy: testAccCheckGroupDestroy(ctx), diff --git a/internal/service/xray/group_test.go b/internal/service/xray/group_test.go index cdf25f295097..ef72943c9292 100644 --- a/internal/service/xray/group_test.go +++ b/internal/service/xray/group_test.go @@ -12,14 +12,8 @@ import ( "github.com/aws/aws-sdk-go-v2/service/xray/types" sdkacctest "github.com/hashicorp/terraform-plugin-testing/helper/acctest" "github.com/hashicorp/terraform-plugin-testing/helper/resource" - "github.com/hashicorp/terraform-plugin-testing/knownvalue" - "github.com/hashicorp/terraform-plugin-testing/plancheck" - "github.com/hashicorp/terraform-plugin-testing/statecheck" "github.com/hashicorp/terraform-plugin-testing/terraform" - "github.com/hashicorp/terraform-plugin-testing/tfversion" "github.com/hashicorp/terraform-provider-aws/internal/acctest" - tfknownvalue "github.com/hashicorp/terraform-provider-aws/internal/acctest/knownvalue" - tfstatecheck "github.com/hashicorp/terraform-provider-aws/internal/acctest/statecheck" "github.com/hashicorp/terraform-provider-aws/internal/conns" tfxray "github.com/hashicorp/terraform-provider-aws/internal/service/xray" "github.com/hashicorp/terraform-provider-aws/internal/tfresource" @@ -134,84 +128,6 @@ func TestAccXRayGroup_disappears(t *testing.T) { }) } -func TestAccXRayGroup_Identity_ExistingResource(t *testing.T) { - ctx := acctest.Context(t) - var v types.Group - resourceName := "aws_xray_group.test" - rName := sdkacctest.RandomWithPrefix(acctest.ResourcePrefix) - - resource.ParallelTest(t, resource.TestCase{ - TerraformVersionChecks: []tfversion.TerraformVersionCheck{ - tfversion.SkipBelow(tfversion.Version1_12_0), - }, - PreCheck: func() { acctest.PreCheck(ctx, t) }, - ErrorCheck: acctest.ErrorCheck(t, names.XRayServiceID), - CheckDestroy: testAccCheckGroupDestroy(ctx), - Steps: []resource.TestStep{ - { - ExternalProviders: map[string]resource.ExternalProvider{ - "aws": { - Source: "hashicorp/aws", - VersionConstraint: "5.100.0", - }, - }, - Config: testAccGroupConfig_basic(rName, "responsetime > 5"), - Check: resource.ComposeAggregateTestCheckFunc( - testAccCheckGroupExists(ctx, resourceName, &v), - ), - ConfigStateChecks: []statecheck.StateCheck{ - tfstatecheck.ExpectNoIdentity(resourceName), - }, - }, - { - ExternalProviders: map[string]resource.ExternalProvider{ - "aws": { - Source: "hashicorp/aws", - VersionConstraint: "6.0.0", - }, - }, - Config: testAccGroupConfig_basic(rName, "responsetime > 5"), - Check: resource.ComposeAggregateTestCheckFunc( - testAccCheckGroupExists(ctx, resourceName, &v), - ), - ConfigPlanChecks: resource.ConfigPlanChecks{ - PreApply: []plancheck.PlanCheck{ - plancheck.ExpectResourceAction(resourceName, plancheck.ResourceActionNoop), - }, - PostApplyPostRefresh: []plancheck.PlanCheck{ - plancheck.ExpectResourceAction(resourceName, plancheck.ResourceActionNoop), - }, - }, - ConfigStateChecks: []statecheck.StateCheck{ - statecheck.ExpectIdentity(resourceName, map[string]knownvalue.Check{ - names.AttrARN: knownvalue.Null(), - }), - }, - }, - { - ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories, - Config: testAccGroupConfig_basic(rName, "responsetime > 5"), - Check: resource.ComposeAggregateTestCheckFunc( - testAccCheckGroupExists(ctx, resourceName, &v), - ), - ConfigPlanChecks: resource.ConfigPlanChecks{ - PreApply: []plancheck.PlanCheck{ - plancheck.ExpectResourceAction(resourceName, plancheck.ResourceActionNoop), - }, - PostApplyPostRefresh: []plancheck.PlanCheck{ - plancheck.ExpectResourceAction(resourceName, plancheck.ResourceActionNoop), - }, - }, - ConfigStateChecks: []statecheck.StateCheck{ - statecheck.ExpectIdentity(resourceName, map[string]knownvalue.Check{ - names.AttrARN: tfknownvalue.RegionalARNRegexp("xray", regexache.MustCompile(`group/.+`)), - }), - }, - }, - }, - }) -} - func testAccCheckGroupExists(ctx context.Context, n string, v *types.Group) resource.TestCheckFunc { return func(s *terraform.State) error { rs, ok := s.RootModule().Resources[n] diff --git a/internal/service/xray/sampling_rule_tags_gen_test.go b/internal/service/xray/sampling_rule_tags_gen_test.go index 6bcaea61bff8..beee9b442d84 100644 --- a/internal/service/xray/sampling_rule_tags_gen_test.go +++ b/internal/service/xray/sampling_rule_tags_gen_test.go @@ -7,7 +7,6 @@ import ( "github.com/aws/aws-sdk-go-v2/service/xray/types" "github.com/hashicorp/terraform-plugin-testing/config" - sdkacctest "github.com/hashicorp/terraform-plugin-testing/helper/acctest" "github.com/hashicorp/terraform-plugin-testing/helper/resource" "github.com/hashicorp/terraform-plugin-testing/knownvalue" "github.com/hashicorp/terraform-plugin-testing/plancheck" @@ -19,11 +18,12 @@ import ( func TestAccXRaySamplingRule_tags(t *testing.T) { ctx := acctest.Context(t) + var v types.SamplingRule resourceName := "aws_xray_sampling_rule.test" - rName := sdkacctest.RandomWithPrefix(acctest.ResourcePrefix) + rName := acctest.RandomWithPrefix(t, acctest.ResourcePrefix) - resource.ParallelTest(t, resource.TestCase{ + acctest.ParallelTest(ctx, t, resource.TestCase{ PreCheck: func() { acctest.PreCheck(ctx, t) }, ErrorCheck: acctest.ErrorCheck(t, names.XRayServiceID), CheckDestroy: testAccCheckSamplingRuleDestroy(ctx), @@ -201,11 +201,12 @@ func TestAccXRaySamplingRule_tags(t *testing.T) { func TestAccXRaySamplingRule_tags_null(t *testing.T) { ctx := acctest.Context(t) + var v types.SamplingRule resourceName := "aws_xray_sampling_rule.test" - rName := sdkacctest.RandomWithPrefix(acctest.ResourcePrefix) + rName := acctest.RandomWithPrefix(t, acctest.ResourcePrefix) - resource.ParallelTest(t, resource.TestCase{ + acctest.ParallelTest(ctx, t, resource.TestCase{ PreCheck: func() { acctest.PreCheck(ctx, t) }, ErrorCheck: acctest.ErrorCheck(t, names.XRayServiceID), CheckDestroy: testAccCheckSamplingRuleDestroy(ctx), @@ -268,11 +269,12 @@ func TestAccXRaySamplingRule_tags_null(t *testing.T) { func TestAccXRaySamplingRule_tags_EmptyMap(t *testing.T) { ctx := acctest.Context(t) + var v types.SamplingRule resourceName := "aws_xray_sampling_rule.test" - rName := sdkacctest.RandomWithPrefix(acctest.ResourcePrefix) + rName := acctest.RandomWithPrefix(t, acctest.ResourcePrefix) - resource.ParallelTest(t, resource.TestCase{ + acctest.ParallelTest(ctx, t, resource.TestCase{ PreCheck: func() { acctest.PreCheck(ctx, t) }, ErrorCheck: acctest.ErrorCheck(t, names.XRayServiceID), CheckDestroy: testAccCheckSamplingRuleDestroy(ctx), @@ -331,11 +333,12 @@ func TestAccXRaySamplingRule_tags_EmptyMap(t *testing.T) { func TestAccXRaySamplingRule_tags_AddOnUpdate(t *testing.T) { ctx := acctest.Context(t) + var v types.SamplingRule resourceName := "aws_xray_sampling_rule.test" - rName := sdkacctest.RandomWithPrefix(acctest.ResourcePrefix) + rName := acctest.RandomWithPrefix(t, acctest.ResourcePrefix) - resource.ParallelTest(t, resource.TestCase{ + acctest.ParallelTest(ctx, t, resource.TestCase{ PreCheck: func() { acctest.PreCheck(ctx, t) }, ErrorCheck: acctest.ErrorCheck(t, names.XRayServiceID), CheckDestroy: testAccCheckSamplingRuleDestroy(ctx), @@ -412,11 +415,12 @@ func TestAccXRaySamplingRule_tags_AddOnUpdate(t *testing.T) { func TestAccXRaySamplingRule_tags_EmptyTag_OnCreate(t *testing.T) { ctx := acctest.Context(t) + var v types.SamplingRule resourceName := "aws_xray_sampling_rule.test" - rName := sdkacctest.RandomWithPrefix(acctest.ResourcePrefix) + rName := acctest.RandomWithPrefix(t, acctest.ResourcePrefix) - resource.ParallelTest(t, resource.TestCase{ + acctest.ParallelTest(ctx, t, resource.TestCase{ PreCheck: func() { acctest.PreCheck(ctx, t) }, ErrorCheck: acctest.ErrorCheck(t, names.XRayServiceID), CheckDestroy: testAccCheckSamplingRuleDestroy(ctx), @@ -501,11 +505,12 @@ func TestAccXRaySamplingRule_tags_EmptyTag_OnCreate(t *testing.T) { func TestAccXRaySamplingRule_tags_EmptyTag_OnUpdate_Add(t *testing.T) { ctx := acctest.Context(t) + var v types.SamplingRule resourceName := "aws_xray_sampling_rule.test" - rName := sdkacctest.RandomWithPrefix(acctest.ResourcePrefix) + rName := acctest.RandomWithPrefix(t, acctest.ResourcePrefix) - resource.ParallelTest(t, resource.TestCase{ + acctest.ParallelTest(ctx, t, resource.TestCase{ PreCheck: func() { acctest.PreCheck(ctx, t) }, ErrorCheck: acctest.ErrorCheck(t, names.XRayServiceID), CheckDestroy: testAccCheckSamplingRuleDestroy(ctx), @@ -638,11 +643,12 @@ func TestAccXRaySamplingRule_tags_EmptyTag_OnUpdate_Add(t *testing.T) { func TestAccXRaySamplingRule_tags_EmptyTag_OnUpdate_Replace(t *testing.T) { ctx := acctest.Context(t) + var v types.SamplingRule resourceName := "aws_xray_sampling_rule.test" - rName := sdkacctest.RandomWithPrefix(acctest.ResourcePrefix) + rName := acctest.RandomWithPrefix(t, acctest.ResourcePrefix) - resource.ParallelTest(t, resource.TestCase{ + acctest.ParallelTest(ctx, t, resource.TestCase{ PreCheck: func() { acctest.PreCheck(ctx, t) }, ErrorCheck: acctest.ErrorCheck(t, names.XRayServiceID), CheckDestroy: testAccCheckSamplingRuleDestroy(ctx), @@ -727,11 +733,12 @@ func TestAccXRaySamplingRule_tags_EmptyTag_OnUpdate_Replace(t *testing.T) { func TestAccXRaySamplingRule_tags_DefaultTags_providerOnly(t *testing.T) { ctx := acctest.Context(t) + var v types.SamplingRule resourceName := "aws_xray_sampling_rule.test" - rName := sdkacctest.RandomWithPrefix(acctest.ResourcePrefix) + rName := acctest.RandomWithPrefix(t, acctest.ResourcePrefix) - resource.ParallelTest(t, resource.TestCase{ + acctest.ParallelTest(ctx, t, resource.TestCase{ PreCheck: func() { acctest.PreCheck(ctx, t) }, ErrorCheck: acctest.ErrorCheck(t, names.XRayServiceID), CheckDestroy: testAccCheckSamplingRuleDestroy(ctx), @@ -908,11 +915,12 @@ func TestAccXRaySamplingRule_tags_DefaultTags_providerOnly(t *testing.T) { func TestAccXRaySamplingRule_tags_DefaultTags_nonOverlapping(t *testing.T) { ctx := acctest.Context(t) + var v types.SamplingRule resourceName := "aws_xray_sampling_rule.test" - rName := sdkacctest.RandomWithPrefix(acctest.ResourcePrefix) + rName := acctest.RandomWithPrefix(t, acctest.ResourcePrefix) - resource.ParallelTest(t, resource.TestCase{ + acctest.ParallelTest(ctx, t, resource.TestCase{ PreCheck: func() { acctest.PreCheck(ctx, t) }, ErrorCheck: acctest.ErrorCheck(t, names.XRayServiceID), CheckDestroy: testAccCheckSamplingRuleDestroy(ctx), @@ -1068,11 +1076,12 @@ func TestAccXRaySamplingRule_tags_DefaultTags_nonOverlapping(t *testing.T) { func TestAccXRaySamplingRule_tags_DefaultTags_overlapping(t *testing.T) { ctx := acctest.Context(t) + var v types.SamplingRule resourceName := "aws_xray_sampling_rule.test" - rName := sdkacctest.RandomWithPrefix(acctest.ResourcePrefix) + rName := acctest.RandomWithPrefix(t, acctest.ResourcePrefix) - resource.ParallelTest(t, resource.TestCase{ + acctest.ParallelTest(ctx, t, resource.TestCase{ PreCheck: func() { acctest.PreCheck(ctx, t) }, ErrorCheck: acctest.ErrorCheck(t, names.XRayServiceID), CheckDestroy: testAccCheckSamplingRuleDestroy(ctx), @@ -1244,11 +1253,12 @@ func TestAccXRaySamplingRule_tags_DefaultTags_overlapping(t *testing.T) { func TestAccXRaySamplingRule_tags_DefaultTags_updateToProviderOnly(t *testing.T) { ctx := acctest.Context(t) + var v types.SamplingRule resourceName := "aws_xray_sampling_rule.test" - rName := sdkacctest.RandomWithPrefix(acctest.ResourcePrefix) + rName := acctest.RandomWithPrefix(t, acctest.ResourcePrefix) - resource.ParallelTest(t, resource.TestCase{ + acctest.ParallelTest(ctx, t, resource.TestCase{ PreCheck: func() { acctest.PreCheck(ctx, t) }, ErrorCheck: acctest.ErrorCheck(t, names.XRayServiceID), CheckDestroy: testAccCheckSamplingRuleDestroy(ctx), @@ -1334,11 +1344,12 @@ func TestAccXRaySamplingRule_tags_DefaultTags_updateToProviderOnly(t *testing.T) func TestAccXRaySamplingRule_tags_DefaultTags_updateToResourceOnly(t *testing.T) { ctx := acctest.Context(t) + var v types.SamplingRule resourceName := "aws_xray_sampling_rule.test" - rName := sdkacctest.RandomWithPrefix(acctest.ResourcePrefix) + rName := acctest.RandomWithPrefix(t, acctest.ResourcePrefix) - resource.ParallelTest(t, resource.TestCase{ + acctest.ParallelTest(ctx, t, resource.TestCase{ PreCheck: func() { acctest.PreCheck(ctx, t) }, ErrorCheck: acctest.ErrorCheck(t, names.XRayServiceID), CheckDestroy: testAccCheckSamplingRuleDestroy(ctx), @@ -1423,11 +1434,12 @@ func TestAccXRaySamplingRule_tags_DefaultTags_updateToResourceOnly(t *testing.T) func TestAccXRaySamplingRule_tags_DefaultTags_emptyResourceTag(t *testing.T) { ctx := acctest.Context(t) + var v types.SamplingRule resourceName := "aws_xray_sampling_rule.test" - rName := sdkacctest.RandomWithPrefix(acctest.ResourcePrefix) + rName := acctest.RandomWithPrefix(t, acctest.ResourcePrefix) - resource.ParallelTest(t, resource.TestCase{ + acctest.ParallelTest(ctx, t, resource.TestCase{ PreCheck: func() { acctest.PreCheck(ctx, t) }, ErrorCheck: acctest.ErrorCheck(t, names.XRayServiceID), CheckDestroy: testAccCheckSamplingRuleDestroy(ctx), @@ -1488,11 +1500,12 @@ func TestAccXRaySamplingRule_tags_DefaultTags_emptyResourceTag(t *testing.T) { func TestAccXRaySamplingRule_tags_DefaultTags_emptyProviderOnlyTag(t *testing.T) { ctx := acctest.Context(t) + var v types.SamplingRule resourceName := "aws_xray_sampling_rule.test" - rName := sdkacctest.RandomWithPrefix(acctest.ResourcePrefix) + rName := acctest.RandomWithPrefix(t, acctest.ResourcePrefix) - resource.ParallelTest(t, resource.TestCase{ + acctest.ParallelTest(ctx, t, resource.TestCase{ PreCheck: func() { acctest.PreCheck(ctx, t) }, ErrorCheck: acctest.ErrorCheck(t, names.XRayServiceID), CheckDestroy: testAccCheckSamplingRuleDestroy(ctx), @@ -1545,11 +1558,12 @@ func TestAccXRaySamplingRule_tags_DefaultTags_emptyProviderOnlyTag(t *testing.T) func TestAccXRaySamplingRule_tags_DefaultTags_nullOverlappingResourceTag(t *testing.T) { ctx := acctest.Context(t) + var v types.SamplingRule resourceName := "aws_xray_sampling_rule.test" - rName := sdkacctest.RandomWithPrefix(acctest.ResourcePrefix) + rName := acctest.RandomWithPrefix(t, acctest.ResourcePrefix) - resource.ParallelTest(t, resource.TestCase{ + acctest.ParallelTest(ctx, t, resource.TestCase{ PreCheck: func() { acctest.PreCheck(ctx, t) }, ErrorCheck: acctest.ErrorCheck(t, names.XRayServiceID), CheckDestroy: testAccCheckSamplingRuleDestroy(ctx), @@ -1607,11 +1621,12 @@ func TestAccXRaySamplingRule_tags_DefaultTags_nullOverlappingResourceTag(t *test func TestAccXRaySamplingRule_tags_DefaultTags_nullNonOverlappingResourceTag(t *testing.T) { ctx := acctest.Context(t) + var v types.SamplingRule resourceName := "aws_xray_sampling_rule.test" - rName := sdkacctest.RandomWithPrefix(acctest.ResourcePrefix) + rName := acctest.RandomWithPrefix(t, acctest.ResourcePrefix) - resource.ParallelTest(t, resource.TestCase{ + acctest.ParallelTest(ctx, t, resource.TestCase{ PreCheck: func() { acctest.PreCheck(ctx, t) }, ErrorCheck: acctest.ErrorCheck(t, names.XRayServiceID), CheckDestroy: testAccCheckSamplingRuleDestroy(ctx), @@ -1669,11 +1684,12 @@ func TestAccXRaySamplingRule_tags_DefaultTags_nullNonOverlappingResourceTag(t *t func TestAccXRaySamplingRule_tags_ComputedTag_OnCreate(t *testing.T) { ctx := acctest.Context(t) + var v types.SamplingRule resourceName := "aws_xray_sampling_rule.test" - rName := sdkacctest.RandomWithPrefix(acctest.ResourcePrefix) + rName := acctest.RandomWithPrefix(t, acctest.ResourcePrefix) - resource.ParallelTest(t, resource.TestCase{ + acctest.ParallelTest(ctx, t, resource.TestCase{ PreCheck: func() { acctest.PreCheck(ctx, t) }, ErrorCheck: acctest.ErrorCheck(t, names.XRayServiceID), CheckDestroy: testAccCheckSamplingRuleDestroy(ctx), @@ -1724,11 +1740,12 @@ func TestAccXRaySamplingRule_tags_ComputedTag_OnCreate(t *testing.T) { func TestAccXRaySamplingRule_tags_ComputedTag_OnUpdate_Add(t *testing.T) { ctx := acctest.Context(t) + var v types.SamplingRule resourceName := "aws_xray_sampling_rule.test" - rName := sdkacctest.RandomWithPrefix(acctest.ResourcePrefix) + rName := acctest.RandomWithPrefix(t, acctest.ResourcePrefix) - resource.ParallelTest(t, resource.TestCase{ + acctest.ParallelTest(ctx, t, resource.TestCase{ PreCheck: func() { acctest.PreCheck(ctx, t) }, ErrorCheck: acctest.ErrorCheck(t, names.XRayServiceID), CheckDestroy: testAccCheckSamplingRuleDestroy(ctx), @@ -1821,11 +1838,12 @@ func TestAccXRaySamplingRule_tags_ComputedTag_OnUpdate_Add(t *testing.T) { func TestAccXRaySamplingRule_tags_ComputedTag_OnUpdate_Replace(t *testing.T) { ctx := acctest.Context(t) + var v types.SamplingRule resourceName := "aws_xray_sampling_rule.test" - rName := sdkacctest.RandomWithPrefix(acctest.ResourcePrefix) + rName := acctest.RandomWithPrefix(t, acctest.ResourcePrefix) - resource.ParallelTest(t, resource.TestCase{ + acctest.ParallelTest(ctx, t, resource.TestCase{ PreCheck: func() { acctest.PreCheck(ctx, t) }, ErrorCheck: acctest.ErrorCheck(t, names.XRayServiceID), CheckDestroy: testAccCheckSamplingRuleDestroy(ctx), @@ -1908,11 +1926,12 @@ func TestAccXRaySamplingRule_tags_ComputedTag_OnUpdate_Replace(t *testing.T) { func TestAccXRaySamplingRule_tags_IgnoreTags_Overlap_DefaultTag(t *testing.T) { ctx := acctest.Context(t) + var v types.SamplingRule resourceName := "aws_xray_sampling_rule.test" - rName := sdkacctest.RandomWithPrefix(acctest.ResourcePrefix) + rName := acctest.RandomWithPrefix(t, acctest.ResourcePrefix) - resource.ParallelTest(t, resource.TestCase{ + acctest.ParallelTest(ctx, t, resource.TestCase{ PreCheck: func() { acctest.PreCheck(ctx, t) }, ErrorCheck: acctest.ErrorCheck(t, names.XRayServiceID), CheckDestroy: testAccCheckSamplingRuleDestroy(ctx), @@ -2070,11 +2089,12 @@ func TestAccXRaySamplingRule_tags_IgnoreTags_Overlap_DefaultTag(t *testing.T) { func TestAccXRaySamplingRule_tags_IgnoreTags_Overlap_ResourceTag(t *testing.T) { ctx := acctest.Context(t) + var v types.SamplingRule resourceName := "aws_xray_sampling_rule.test" - rName := sdkacctest.RandomWithPrefix(acctest.ResourcePrefix) + rName := acctest.RandomWithPrefix(t, acctest.ResourcePrefix) - resource.ParallelTest(t, resource.TestCase{ + acctest.ParallelTest(ctx, t, resource.TestCase{ PreCheck: func() { acctest.PreCheck(ctx, t) }, ErrorCheck: acctest.ErrorCheck(t, names.XRayServiceID), CheckDestroy: testAccCheckSamplingRuleDestroy(ctx), diff --git a/internal/service/xray/service_endpoint_resolver_gen.go b/internal/service/xray/service_endpoint_resolver_gen.go index 5af164b38b69..d4a8fa69db91 100644 --- a/internal/service/xray/service_endpoint_resolver_gen.go +++ b/internal/service/xray/service_endpoint_resolver_gen.go @@ -62,7 +62,7 @@ func (r resolverV2) ResolveEndpoint(ctx context.Context, params xray.EndpointPar }) params.UseFIPS = aws.Bool(false) } else { - err = fmt.Errorf("looking up xray endpoint %q: %s", hostname, err) + err = fmt.Errorf("looking up xray endpoint %q: %w", hostname, err) return } } else { diff --git a/internal/service/xray/service_endpoints_gen_test.go b/internal/service/xray/service_endpoints_gen_test.go index 59ba212a4d31..a2cb72fc6955 100644 --- a/internal/service/xray/service_endpoints_gen_test.go +++ b/internal/service/xray/service_endpoints_gen_test.go @@ -521,7 +521,7 @@ func retrieveRegionMiddleware(region *string) middleware.SerializeMiddleware { ) } -var errCancelOperation = fmt.Errorf("Test: Canceling request") +var errCancelOperation = errors.New("Test: Canceling request") func addCancelRequestMiddleware() func(*middleware.Stack) error { return func(stack *middleware.Stack) error { diff --git a/internal/service/xray/service_package_gen.go b/internal/service/xray/service_package_gen.go index 9988c8415649..9f0ffb3cad60 100644 --- a/internal/service/xray/service_package_gen.go +++ b/internal/service/xray/service_package_gen.go @@ -7,7 +7,6 @@ import ( "unique" "github.com/aws/aws-sdk-go-v2/aws" - "github.com/aws/aws-sdk-go-v2/aws/retry" "github.com/aws/aws-sdk-go-v2/service/xray" "github.com/hashicorp/terraform-plugin-log/tflog" "github.com/hashicorp/terraform-provider-aws/internal/conns" @@ -102,7 +101,7 @@ func (p *servicePackage) NewClient(ctx context.Context, config map[string]any) ( func(o *xray.Options) { if inContext, ok := conns.FromContext(ctx); ok && inContext.VCREnabled() { tflog.Info(ctx, "overriding retry behavior to immediately return VCR errors") - o.Retryer = conns.AddIsErrorRetryables(cfg.Retryer().(aws.RetryerV2), retry.IsErrorRetryableFunc(vcr.InteractionNotFoundRetryableFunc)) + o.Retryer = conns.AddIsErrorRetryables(cfg.Retryer().(aws.RetryerV2), vcr.InteractionNotFoundRetryableFunc) } }, withExtraOptions(ctx, p, config), diff --git a/internal/service/xray/tags_gen.go b/internal/service/xray/tags_gen.go index e1effcc979c1..8c3c8d31fb65 100644 --- a/internal/service/xray/tags_gen.go +++ b/internal/service/xray/tags_gen.go @@ -3,8 +3,8 @@ package xray import ( "context" - "fmt" + "github.com/YakDriver/smarterr" "github.com/aws/aws-sdk-go-v2/aws" "github.com/aws/aws-sdk-go-v2/service/xray" awstypes "github.com/aws/aws-sdk-go-v2/service/xray/types" @@ -31,7 +31,7 @@ func listTags(ctx context.Context, conn *xray.Client, identifier string, optFns page, err := pages.NextPage(ctx, optFns...) if err != nil { - return tftags.New(ctx, nil), err + return tftags.New(ctx, nil), smarterr.NewError(err) } output = append(output, page.Tags...) @@ -46,7 +46,7 @@ func (p *servicePackage) ListTags(ctx context.Context, meta any, identifier stri tags, err := listTags(ctx, meta.(*conns.AWSClient).XRayClient(ctx), identifier) if err != nil { - return err + return smarterr.NewError(err) } if inContext, ok := tftags.FromContext(ctx); ok { @@ -124,7 +124,7 @@ func updateTags(ctx context.Context, conn *xray.Client, identifier string, oldTa _, err := conn.UntagResource(ctx, &input, optFns...) if err != nil { - return fmt.Errorf("untagging resource (%s): %w", identifier, err) + return smarterr.NewError(err) } } @@ -139,7 +139,7 @@ func updateTags(ctx context.Context, conn *xray.Client, identifier string, oldTa _, err := conn.TagResource(ctx, &input, optFns...) if err != nil { - return fmt.Errorf("tagging resource (%s): %w", identifier, err) + return smarterr.NewError(err) } } diff --git a/internal/service/xray/testdata/EncryptionConfig/basic_v5.100.0/main_gen.tf b/internal/service/xray/testdata/EncryptionConfig/basic_v5.100.0/main_gen.tf new file mode 100644 index 000000000000..0c690ca844b0 --- /dev/null +++ b/internal/service/xray/testdata/EncryptionConfig/basic_v5.100.0/main_gen.tf @@ -0,0 +1,17 @@ +# Copyright (c) HashiCorp, Inc. +# SPDX-License-Identifier: MPL-2.0 + +resource "aws_xray_encryption_config" "test" { + type = "NONE" +} + +terraform { + required_providers { + aws = { + source = "hashicorp/aws" + version = "5.100.0" + } + } +} + +provider "aws" {} diff --git a/internal/service/xray/testdata/EncryptionConfig/basic_v6.0.0/main_gen.tf b/internal/service/xray/testdata/EncryptionConfig/basic_v6.0.0/main_gen.tf new file mode 100644 index 000000000000..6b10f571f947 --- /dev/null +++ b/internal/service/xray/testdata/EncryptionConfig/basic_v6.0.0/main_gen.tf @@ -0,0 +1,17 @@ +# Copyright (c) HashiCorp, Inc. +# SPDX-License-Identifier: MPL-2.0 + +resource "aws_xray_encryption_config" "test" { + type = "NONE" +} + +terraform { + required_providers { + aws = { + source = "hashicorp/aws" + version = "6.0.0" + } + } +} + +provider "aws" {} diff --git a/internal/service/xray/testdata/Group/basic_v5.100.0/main_gen.tf b/internal/service/xray/testdata/Group/basic_v5.100.0/main_gen.tf new file mode 100644 index 000000000000..2e2b51da5a62 --- /dev/null +++ b/internal/service/xray/testdata/Group/basic_v5.100.0/main_gen.tf @@ -0,0 +1,23 @@ +# Copyright (c) HashiCorp, Inc. +# SPDX-License-Identifier: MPL-2.0 + +resource "aws_xray_group" "test" { + group_name = var.rName + filter_expression = "responsetime > 5" +} + +variable "rName" { + description = "Name for resource" + type = string + nullable = false +} +terraform { + required_providers { + aws = { + source = "hashicorp/aws" + version = "5.100.0" + } + } +} + +provider "aws" {} diff --git a/internal/service/xray/testdata/Group/basic_v6.0.0/main_gen.tf b/internal/service/xray/testdata/Group/basic_v6.0.0/main_gen.tf new file mode 100644 index 000000000000..fcc8df2c6414 --- /dev/null +++ b/internal/service/xray/testdata/Group/basic_v6.0.0/main_gen.tf @@ -0,0 +1,23 @@ +# Copyright (c) HashiCorp, Inc. +# SPDX-License-Identifier: MPL-2.0 + +resource "aws_xray_group" "test" { + group_name = var.rName + filter_expression = "responsetime > 5" +} + +variable "rName" { + description = "Name for resource" + type = string + nullable = false +} +terraform { + required_providers { + aws = { + source = "hashicorp/aws" + version = "6.0.0" + } + } +} + +provider "aws" {} diff --git a/internal/slices/iter.go b/internal/slices/iter.go new file mode 100644 index 000000000000..f0a987de277f --- /dev/null +++ b/internal/slices/iter.go @@ -0,0 +1,31 @@ +// Copyright (c) HashiCorp, Inc. +// SPDX-License-Identifier: MPL-2.0 + +package slices + +import ( + "iter" +) + +// AppliedToEach returns an iterator that yields the slice elements transformed by the function `f`. +func AppliedToEach[S ~[]E, E any, T any](s S, f func(E) T) iter.Seq[T] { + return func(yield func(T) bool) { + for _, v := range s { + if !yield(f(v)) { + return + } + } + } +} + +// BackwardValues returns an iterator that yields the slice elements in reverse order. +// It is a values-only equivalent of `slices.Backward`. +func BackwardValues[Slice ~[]E, E any](s Slice) iter.Seq[E] { + return func(yield func(E) bool) { + for i := len(s) - 1; i >= 0; i-- { + if !yield(s[i]) { + return + } + } + } +} diff --git a/internal/slices/iter_test.go b/internal/slices/iter_test.go new file mode 100644 index 000000000000..f8c5ea0263df --- /dev/null +++ b/internal/slices/iter_test.go @@ -0,0 +1,73 @@ +// Copyright (c) HashiCorp, Inc. +// SPDX-License-Identifier: MPL-2.0 + +package slices + +import ( + "slices" + "strings" + "testing" + + "github.com/google/go-cmp/cmp" +) + +func TestAppliedToEach(t *testing.T) { + t.Parallel() + + type testCase struct { + input []string + expected []string + } + tests := map[string]testCase{ + "three elements": { + input: []string{"one", "two", "3"}, + expected: []string{"ONE", "TWO", "3"}, + }, + "one element": { + input: []string{"abcdEFGH"}, + expected: []string{"ABCDEFGH"}, + }, + "zero elements": { + input: []string{}, + expected: nil, + }, + } + + for name, test := range tests { + t.Run(name, func(t *testing.T) { + t.Parallel() + + iter := AppliedToEach(test.input, strings.ToUpper) + + got := slices.Collect(iter) + + if diff := cmp.Diff(got, test.expected); diff != "" { + t.Errorf("unexpected diff (+wanted, -got): %s", diff) + } + }) + } +} + +// Copied and adapted from stdlib slices package +func TestBackwardValues(t *testing.T) { + t.Parallel() + + for size := range 10 { + var s []int + for i := range size { + s = append(s, i) + } + ev := size - 1 + cnt := 0 + for v := range BackwardValues(s) { + if v != ev { + t.Errorf("at iteration %d got %d want %d", cnt, v, ev) + } + ev-- + cnt++ + } + if cnt != size { + t.Errorf("read %d values expected %d", cnt, size) + } + } +} diff --git a/internal/slices/slices.go b/internal/slices/slices.go index fb8880d9fb77..04e51a447128 100644 --- a/internal/slices/slices.go +++ b/internal/slices/slices.go @@ -69,6 +69,10 @@ type Predicate[T any] func(T) bool // Filter returns a new slice containing all values that return `true` for the filter function `f`. func Filter[S ~[]E, E any](s S, f Predicate[E]) S { + if len(s) == 0 { + return nil + } + v := S(make([]E, 0, len(s))) for _, e := range s { diff --git a/internal/slices/slices_test.go b/internal/slices/slices_test.go index 0537d29f2cfd..c53a3fbc9d13 100644 --- a/internal/slices/slices_test.go +++ b/internal/slices/slices_test.go @@ -171,7 +171,7 @@ func TestFilter(t *testing.T) { }, "zero elements": { input: []string{}, - expected: []string{}, + expected: nil, }, } diff --git a/internal/smerr/smarterr.go b/internal/smerr/smarterr.go new file mode 100644 index 000000000000..98b80f1c295b --- /dev/null +++ b/internal/smerr/smarterr.go @@ -0,0 +1,46 @@ +// Copyright (c) HashiCorp, Inc. +// SPDX-License-Identifier: MPL-2.0 + +package smerr + +import ( + "context" + + "github.com/YakDriver/smarterr" + fwdiag "github.com/hashicorp/terraform-plugin-framework/diag" + sdkdiag "github.com/hashicorp/terraform-plugin-sdk/v2/diag" + "github.com/hashicorp/terraform-provider-aws/internal/conns" + "github.com/hashicorp/terraform-provider-aws/names" +) + +const ( + ID = smarterr.ID +) + +// This is smarterr wrapping to inject private context into keyvals for the SDK and Framework diagnostics. + +// Append enriches smarterr.Append with resource and service context if available. +func Append(ctx context.Context, diags sdkdiag.Diagnostics, err error, keyvals ...any) sdkdiag.Diagnostics { + return smarterr.Append(ctx, diags, err, injectContext(ctx, keyvals...)...) +} + +// AddError enriches smarterr.AddError with resource and service context if available. +func AddError(ctx context.Context, diags *fwdiag.Diagnostics, err error, keyvals ...any) { + smarterr.AddError(ctx, diags, err, injectContext(ctx, keyvals...)...) +} + +// EnrichAppend enriches smarterr.EnrichAppend with resource and service context if available. +func EnrichAppend(ctx context.Context, existing *fwdiag.Diagnostics, incoming fwdiag.Diagnostics, keyvals ...any) { + smarterr.EnrichAppend(ctx, existing, incoming, injectContext(ctx, keyvals...)...) +} + +func injectContext(ctx context.Context, keyvals ...any) []any { + if inctx, ok := conns.FromContext(ctx); ok { + srv := inctx.ServicePackageName() + if v, err := names.HumanFriendly(srv); err == nil { + srv = v + } + keyvals = append(keyvals, smarterr.ResourceName, inctx.ResourceName(), smarterr.ServiceName, srv) + } + return keyvals +} diff --git a/internal/smithy/README.md b/internal/smithy/README.md new file mode 100644 index 000000000000..20d5bf99f0ee --- /dev/null +++ b/internal/smithy/README.md @@ -0,0 +1,3 @@ +# Smithy Helpers + +[Smithy](https://smithy.io/) helpers. diff --git a/internal/smithy/json.go b/internal/smithy/json.go new file mode 100644 index 000000000000..71d5ef4f90e5 --- /dev/null +++ b/internal/smithy/json.go @@ -0,0 +1,40 @@ +// Copyright (c) HashiCorp, Inc. +// SPDX-License-Identifier: MPL-2.0 + +package smithy + +import ( + "strings" + + smithydocument "github.com/aws/smithy-go/document" + tfjson "github.com/hashicorp/terraform-provider-aws/internal/json" +) + +// DocumentFromJSONString converts a JSON string to a [Smithy document](https://smithy.io/2.0/spec/simple-types.html#document). +func DocumentFromJSONString[T any](s string, f func(any) T) (T, error) { + var v any + + err := tfjson.DecodeFromString(s, &v) + if err != nil { + var zero T + return zero, err + } + + return f(v), nil +} + +// DocumentToJSONString converts a [Smithy document](https://smithy.io/2.0/spec/simple-types.html#document) to a JSON string. +func DocumentToJSONString(document smithydocument.Marshaler) (string, error) { + bytes, err := document.MarshalSmithyDocument() + if err != nil { + return "", err + } + + return strings.TrimSpace(string(bytes)), nil +} + +// JSONStringer interface is used to marshal and unmarshal JSON interface objects. +type JSONStringer interface { + smithydocument.Marshaler + smithydocument.Unmarshaler +} diff --git a/internal/smithy/json_test.go b/internal/smithy/json_test.go new file mode 100644 index 000000000000..479d0719e09b --- /dev/null +++ b/internal/smithy/json_test.go @@ -0,0 +1,67 @@ +// Copyright (c) HashiCorp, Inc. +// SPDX-License-Identifier: MPL-2.0 + +package smithy_test + +import ( + "testing" + + "github.com/aws/aws-sdk-go-v2/service/cognitoidentityprovider/document" + "github.com/google/go-cmp/cmp" + tfsmithy "github.com/hashicorp/terraform-provider-aws/internal/smithy" +) + +func TestDocumentToFromJSONString(t *testing.T) { + t.Parallel() + + testCases := []struct { + testName string + input string + wantOutput string + wantInputErr bool + wantOutputErr bool + }{ + { + testName: "empty string", + input: ``, + wantOutput: `null`, + }, + { + testName: "empty JSON", + input: `{}`, + wantOutput: `{}`, + }, + { + testName: "valid JSON", + input: `{"Field1": 42}`, + wantOutput: `{"Field1":42}`, + }, + { + testName: "invalid JSON", + input: `{"Field1"=42}`, + wantInputErr: true, + }, + } + + for _, testCase := range testCases { + t.Run(testCase.testName, func(t *testing.T) { + t.Parallel() + + json, err := tfsmithy.DocumentFromJSONString(testCase.input, document.NewLazyDocument) + if got, want := err != nil, testCase.wantInputErr; !cmp.Equal(got, want) { + t.Errorf("DocumentFromJSONString(%s) err %t (%v), want %t", testCase.input, got, err, want) + } + if err == nil { + output, err := tfsmithy.DocumentToJSONString(json) + if got, want := err != nil, testCase.wantOutputErr; !cmp.Equal(got, want) { + t.Errorf("DocumentToJSONString err %t (%v), want %t", got, err, want) + } + if err == nil { + if diff := cmp.Diff(output, testCase.wantOutput); diff != "" { + t.Errorf("unexpected diff (+wanted, -got): %s", diff) + } + } + } + }) + } +} diff --git a/internal/sweep/awsv2/skip.go b/internal/sweep/awsv2/skip.go index 4bb052f30c2c..c4fbcfa1a509 100644 --- a/internal/sweep/awsv2/skip.go +++ b/internal/sweep/awsv2/skip.go @@ -45,6 +45,10 @@ func SkipSweepError(err error) bool { if tfawserr.ErrMessageContains(err, "HttpConnectionTimeoutException", "Failed to connect to") { return true } + // Example (amp): InternalServerErrorException: Internal server error + if tfawserr.ErrMessageContains(err, "InternalServerErrorException", "Internal server error") { + return true + } // Example (GovCloud): InvalidAction: DescribeDBProxies is not available in this region if tfawserr.ErrMessageContains(err, "InvalidAction", "is not available") { return true @@ -90,6 +94,10 @@ func SkipSweepError(err error) bool { if tfawserr.ErrMessageContains(err, "InvalidParameterValueException", "Access Denied to API Version") { return true } + // Example (GovCloud): InvalidParameterException: The DATA_PROTECTION_POLICY policy type is not supported in this region + if tfawserr.ErrMessageContains(err, "InvalidParameterException", "DATA_PROTECTION_POLICY policy type is not supported in this region") { + return true + } // Example (GovCloud): The AppStream 2.0 user pool feature is not supported in the us-gov-west-1 AWS Region if tfawserr.ErrMessageContains(err, "InvalidParameterValueException", "feature is not supported") { return true @@ -98,6 +106,10 @@ func SkipSweepError(err error) bool { if tfawserr.ErrMessageContains(err, "InvalidParameterValueException", "This API operation is currently unavailable") { return true } + // Example (GovCloud): InvalidSignatureException: Credential should be scoped to a valid region + if tfawserr.ErrMessageContains(err, "InvalidSignatureException", "Credential should be scoped to a valid region") { + return true + } // For example from us-west-2 Route53 zone if tfawserr.ErrMessageContains(err, "KeySigningKeyInParentDSRecord", "Due to DNS lookup failure") { return true @@ -110,6 +122,10 @@ func SkipSweepError(err error) bool { if tfawserr.ErrMessageContains(err, "ResourceNotFoundException", "The subscription does not exist") { return true } + // Example (GovCloud): SignatureDoesNotMatch: Credential should be scoped to a valid region + if tfawserr.ErrMessageContains(err, "SignatureDoesNotMatch", "Credential should be scoped to a valid region") { + return true + } // For example from us-gov-east-1 IoT domain configuration if tfawserr.ErrMessageContains(err, "UnauthorizedException", "API is not available in") { return true @@ -130,6 +146,10 @@ func SkipSweepError(err error) bool { if tfawserr.ErrMessageContains(err, "UnsupportedOperation", "The functionality you requested is not available in this region") { return true } + // Example (fsx): UnsupportedOperation: This operation is unsupported. + if tfawserr.ErrMessageContains(err, "UnsupportedOperation", "This operation is unsupported") { + return true + } // For example from us-west-1 EMR studio if tfawserr.ErrMessageContains(err, "ValidationException", "Account is not whitelisted to use this feature") { return true diff --git a/internal/sweep/service_packages_gen_test.go b/internal/sweep/service_packages_gen_test.go index a063d088e82d..b65cd9455036 100644 --- a/internal/sweep/service_packages_gen_test.go +++ b/internal/sweep/service_packages_gen_test.go @@ -26,6 +26,7 @@ import ( "github.com/hashicorp/terraform-provider-aws/internal/service/apprunner" "github.com/hashicorp/terraform-provider-aws/internal/service/appstream" "github.com/hashicorp/terraform-provider-aws/internal/service/appsync" + "github.com/hashicorp/terraform-provider-aws/internal/service/arcregionswitch" "github.com/hashicorp/terraform-provider-aws/internal/service/athena" "github.com/hashicorp/terraform-provider-aws/internal/service/auditmanager" "github.com/hashicorp/terraform-provider-aws/internal/service/autoscaling" @@ -35,6 +36,7 @@ import ( "github.com/hashicorp/terraform-provider-aws/internal/service/bcmdataexports" "github.com/hashicorp/terraform-provider-aws/internal/service/bedrock" "github.com/hashicorp/terraform-provider-aws/internal/service/bedrockagent" + "github.com/hashicorp/terraform-provider-aws/internal/service/bedrockagentcore" "github.com/hashicorp/terraform-provider-aws/internal/service/billing" "github.com/hashicorp/terraform-provider-aws/internal/service/budgets" "github.com/hashicorp/terraform-provider-aws/internal/service/ce" @@ -175,6 +177,7 @@ import ( "github.com/hashicorp/terraform-provider-aws/internal/service/notifications" "github.com/hashicorp/terraform-provider-aws/internal/service/notificationscontacts" "github.com/hashicorp/terraform-provider-aws/internal/service/oam" + "github.com/hashicorp/terraform-provider-aws/internal/service/odb" "github.com/hashicorp/terraform-provider-aws/internal/service/opensearch" "github.com/hashicorp/terraform-provider-aws/internal/service/opensearchserverless" "github.com/hashicorp/terraform-provider-aws/internal/service/organizations" @@ -214,6 +217,7 @@ import ( "github.com/hashicorp/terraform-provider-aws/internal/service/s3control" "github.com/hashicorp/terraform-provider-aws/internal/service/s3outposts" "github.com/hashicorp/terraform-provider-aws/internal/service/s3tables" + "github.com/hashicorp/terraform-provider-aws/internal/service/s3vectors" "github.com/hashicorp/terraform-provider-aws/internal/service/sagemaker" "github.com/hashicorp/terraform-provider-aws/internal/service/scheduler" "github.com/hashicorp/terraform-provider-aws/internal/service/schemas" @@ -255,6 +259,7 @@ import ( "github.com/hashicorp/terraform-provider-aws/internal/service/wafregional" "github.com/hashicorp/terraform-provider-aws/internal/service/wafv2" "github.com/hashicorp/terraform-provider-aws/internal/service/wellarchitected" + "github.com/hashicorp/terraform-provider-aws/internal/service/workmail" "github.com/hashicorp/terraform-provider-aws/internal/service/workspaces" "github.com/hashicorp/terraform-provider-aws/internal/service/workspacesweb" "github.com/hashicorp/terraform-provider-aws/internal/service/xray" @@ -281,6 +286,7 @@ func servicePackages(ctx context.Context) []conns.ServicePackage { apprunner.ServicePackage(ctx), appstream.ServicePackage(ctx), appsync.ServicePackage(ctx), + arcregionswitch.ServicePackage(ctx), athena.ServicePackage(ctx), auditmanager.ServicePackage(ctx), autoscaling.ServicePackage(ctx), @@ -290,6 +296,7 @@ func servicePackages(ctx context.Context) []conns.ServicePackage { bcmdataexports.ServicePackage(ctx), bedrock.ServicePackage(ctx), bedrockagent.ServicePackage(ctx), + bedrockagentcore.ServicePackage(ctx), billing.ServicePackage(ctx), budgets.ServicePackage(ctx), ce.ServicePackage(ctx), @@ -430,6 +437,7 @@ func servicePackages(ctx context.Context) []conns.ServicePackage { notifications.ServicePackage(ctx), notificationscontacts.ServicePackage(ctx), oam.ServicePackage(ctx), + odb.ServicePackage(ctx), opensearch.ServicePackage(ctx), opensearchserverless.ServicePackage(ctx), organizations.ServicePackage(ctx), @@ -469,6 +477,7 @@ func servicePackages(ctx context.Context) []conns.ServicePackage { s3control.ServicePackage(ctx), s3outposts.ServicePackage(ctx), s3tables.ServicePackage(ctx), + s3vectors.ServicePackage(ctx), sagemaker.ServicePackage(ctx), scheduler.ServicePackage(ctx), schemas.ServicePackage(ctx), @@ -510,6 +519,7 @@ func servicePackages(ctx context.Context) []conns.ServicePackage { wafregional.ServicePackage(ctx), wafv2.ServicePackage(ctx), wellarchitected.ServicePackage(ctx), + workmail.ServicePackage(ctx), workspaces.ServicePackage(ctx), workspacesweb.ServicePackage(ctx), xray.ServicePackage(ctx), diff --git a/internal/tags/key_value_tags.go b/internal/tags/key_value_tags.go index 566b4ab6e82e..9c92be4db62d 100644 --- a/internal/tags/key_value_tags.go +++ b/internal/tags/key_value_tags.go @@ -15,8 +15,6 @@ import ( "github.com/hashicorp/go-cty/cty" fwdiag "github.com/hashicorp/terraform-plugin-framework/diag" - "github.com/hashicorp/terraform-plugin-framework/path" - "github.com/hashicorp/terraform-plugin-framework/resource" "github.com/hashicorp/terraform-plugin-framework/types" "github.com/hashicorp/terraform-provider-aws/internal/create" "github.com/hashicorp/terraform-provider-aws/internal/framework/flex" @@ -887,13 +885,10 @@ func (tags KeyValueTags) ResolveDuplicates(ctx context.Context, defaultConfig *D } // ResolveDuplicatesFramework resolves differences between incoming tags, defaultTags, and ignoreConfig -func (tags KeyValueTags) ResolveDuplicatesFramework(ctx context.Context, defaultConfig *DefaultConfig, ignoreConfig *IgnoreConfig, resp *resource.ReadResponse, diags *fwdiag.Diagnostics) KeyValueTags { +func (tags KeyValueTags) ResolveDuplicatesFramework(ctx context.Context, defaultConfig *DefaultConfig, ignoreConfig *IgnoreConfig, tagsAll Map, diags *fwdiag.Diagnostics) KeyValueTags { // remove default config. t := tags.RemoveDefaultConfig(defaultConfig) - var tagsAll Map - diags.Append(resp.State.GetAttribute(ctx, path.Root("tags"), &tagsAll)...) - if diags.HasError() { return KeyValueTags{} } diff --git a/internal/tfresource/errors.go b/internal/tfresource/errors.go index f40eaf738fe7..bac461c584aa 100644 --- a/internal/tfresource/errors.go +++ b/internal/tfresource/errors.go @@ -4,6 +4,8 @@ package tfresource import ( + "errors" + "github.com/hashicorp/terraform-provider-aws/internal/retry" ) @@ -33,3 +35,49 @@ var TimedOut = retry.TimedOut // which handles both Plugin SDK V2 and internal error types. For net-new usage, // prefer calling retry.SetLastError directly. var SetLastError = retry.SetLastError + +// From github.com/hashicorp/terraform-plugin-sdk/v2/helper/retry: + +// RetryError forces client code to choose whether or not a given error is retryable. +type RetryError struct { + err error + isRetryable bool +} + +func (e *RetryError) Error() string { + return e.err.Error() +} + +func (e *RetryError) Unwrap() error { + return e.err +} + +// RetryableError is a helper to create a RetryError that's retryable from a +// given error. To prevent logic errors, will return an error when passed a +// nil error. +func RetryableError(err error) *RetryError { + if err == nil { + return &RetryError{ + err: errors.New("empty retryable error received. " + + "This is a bug with the Terraform AWS Provider and should be " + + "reported as a GitHub issue in the provider repository."), + isRetryable: false, + } + } + return &RetryError{err: err, isRetryable: true} +} + +// NonRetryableError is a helper to create a RetryError that's _not_ retryable +// from a given error. To prevent logic errors, will return an error when +// passed a nil error. +func NonRetryableError(err error) *RetryError { + if err == nil { + return &RetryError{ + err: errors.New("empty non-retryable error received. " + + "This is a bug with the Terraform AWS Provider and should be " + + "reported as a GitHub issue in the provider repository."), + isRetryable: false, + } + } + return &RetryError{err: err, isRetryable: false} +} diff --git a/internal/tfresource/retry.go b/internal/tfresource/retry.go index 6af38c365c0c..0f1a9c80c28e 100644 --- a/internal/tfresource/retry.go +++ b/internal/tfresource/retry.go @@ -7,7 +7,6 @@ import ( "context" "fmt" "math/rand" - "sync" "time" "github.com/hashicorp/aws-sdk-go-base/v2/tfawserr" @@ -27,88 +26,13 @@ type Retryable func(error) (bool, error) // RetryWhen retries the function `f` when the error it returns satisfies `retryable`. // `f` is retried until `timeout` expires. -func RetryWhen(ctx context.Context, timeout time.Duration, f func() (any, error), retryable Retryable) (any, error) { - var output any - - err := Retry(ctx, timeout, func() *sdkretry.RetryError { - var err error - var again bool - - output, err = f() - again, err = retryable(err) - - if again { - return sdkretry.RetryableError(err) - } - - if err != nil { - return sdkretry.NonRetryableError(err) - } - - return nil - }) - - if TimedOut(err) { - output, err = f() - } - - if err != nil { - return nil, err - } - - return output, nil -} - -// RetryGWhen is the generic version of RetryWhen which obviates the need for a type -// assertion after the call. It retries the function `f` when the error it returns -// satisfies `retryable`. `f` is retried until `timeout` expires. -func RetryGWhen[T any](ctx context.Context, timeout time.Duration, f func() (T, error), retryable Retryable) (T, error) { - var output T - - err := Retry(ctx, timeout, func() *sdkretry.RetryError { - var err error - var again bool - - output, err = f() - again, err = retryable(err) - - if again { - return sdkretry.RetryableError(err) - } - - if err != nil { - return sdkretry.NonRetryableError(err) - } - - return nil - }) - - if TimedOut(err) { - output, err = f() - } - - if err != nil { - var zero T - return zero, err - } - - return output, nil +func RetryWhen[T any](ctx context.Context, timeout time.Duration, f func(context.Context) (T, error), retryable Retryable) (T, error) { + return retryWhen(ctx, timeout, f, retryable) } // RetryWhenAWSErrCodeEquals retries the specified function when it returns one of the specified AWS error codes. -func RetryWhenAWSErrCodeEquals(ctx context.Context, timeout time.Duration, f func() (any, error), codes ...string) (any, error) { // nosemgrep:ci.aws-in-func-name - return RetryWhen(ctx, timeout, f, func(err error) (bool, error) { - if tfawserr.ErrCodeEquals(err, codes...) { - return true, err - } - - return false, err - }) -} - -// RetryGWhenAWSErrCodeEquals retries the specified function when it returns one of the specified AWS error codes. -func RetryGWhenAWSErrCodeEquals[T any](ctx context.Context, timeout time.Duration, f func() (T, error), codes ...string) (T, error) { // nosemgrep:ci.aws-in-func-name - return RetryGWhen(ctx, timeout, f, func(err error) (bool, error) { +func RetryWhenAWSErrCodeEquals[T any](ctx context.Context, timeout time.Duration, f func(context.Context) (T, error), codes ...string) (T, error) { // nosemgrep:ci.aws-in-func-name + return retryWhen(ctx, timeout, f, func(err error) (bool, error) { if tfawserr.ErrCodeEquals(err, codes...) { return true, err } @@ -118,8 +42,8 @@ func RetryGWhenAWSErrCodeEquals[T any](ctx context.Context, timeout time.Duratio } // RetryWhenAWSErrCodeContains retries the specified function when it returns an AWS error containing the specified code. -func RetryWhenAWSErrCodeContains(ctx context.Context, timeout time.Duration, f func() (any, error), code string) (any, error) { // nosemgrep:ci.aws-in-func-name - return RetryWhen(ctx, timeout, f, func(err error) (bool, error) { +func RetryWhenAWSErrCodeContains[T any](ctx context.Context, timeout time.Duration, f func(context.Context) (T, error), code string) (T, error) { // nosemgrep:ci.aws-in-func-name + return retryWhen(ctx, timeout, f, func(err error) (bool, error) { if tfawserr.ErrCodeContains(err, code) { return true, err } @@ -129,8 +53,8 @@ func RetryWhenAWSErrCodeContains(ctx context.Context, timeout time.Duration, f f } // RetryWhenAWSErrMessageContains retries the specified function when it returns an AWS error containing the specified message. -func RetryWhenAWSErrMessageContains(ctx context.Context, timeout time.Duration, f func() (any, error), code, message string) (any, error) { // nosemgrep:ci.aws-in-func-name - return RetryWhen(ctx, timeout, f, func(err error) (bool, error) { +func RetryWhenAWSErrMessageContains[T any](ctx context.Context, timeout time.Duration, f func(context.Context) (T, error), code, message string) (T, error) { // nosemgrep:ci.aws-in-func-name + return retryWhen(ctx, timeout, f, func(err error) (bool, error) { if tfawserr.ErrMessageContains(err, code, message) { return true, err } @@ -139,19 +63,9 @@ func RetryWhenAWSErrMessageContains(ctx context.Context, timeout time.Duration, }) } -func RetryWhenIsA[T error](ctx context.Context, timeout time.Duration, f func() (any, error)) (any, error) { - return RetryWhen(ctx, timeout, f, func(err error) (bool, error) { - if errs.IsA[T](err) { - return true, err - } - - return false, err - }) -} - -func RetryWhenIsOneOf2[T1, T2 error](ctx context.Context, timeout time.Duration, f func() (any, error)) (any, error) { - return RetryWhen(ctx, timeout, f, func(err error) (bool, error) { - if errs.IsA[T1](err) || errs.IsA[T2](err) { +func RetryWhenIsA[T any, E error](ctx context.Context, timeout time.Duration, f func(context.Context) (T, error)) (T, error) { + return retryWhen(ctx, timeout, f, func(err error) (bool, error) { + if errs.IsA[E](err) { return true, err } @@ -159,9 +73,9 @@ func RetryWhenIsOneOf2[T1, T2 error](ctx context.Context, timeout time.Duration, }) } -func RetryWhenIsOneOf3[T1, T2, T3 error](ctx context.Context, timeout time.Duration, f func() (any, error)) (any, error) { - return RetryWhen(ctx, timeout, f, func(err error) (bool, error) { - if errs.IsA[T1](err) || errs.IsA[T2](err) || errs.IsA[T3](err) { +func RetryWhenIsOneOf2[T any, E1, E2 error](ctx context.Context, timeout time.Duration, f func(context.Context) (T, error)) (T, error) { + return retryWhen(ctx, timeout, f, func(err error) (bool, error) { + if errs.IsA[E1](err) || errs.IsA[E2](err) { return true, err } @@ -169,9 +83,9 @@ func RetryWhenIsOneOf3[T1, T2, T3 error](ctx context.Context, timeout time.Durat }) } -func RetryWhenIsOneOf4[T1, T2, T3, T4 error](ctx context.Context, timeout time.Duration, f func() (any, error)) (any, error) { - return RetryWhen(ctx, timeout, f, func(err error) (bool, error) { - if errs.IsA[T1](err) || errs.IsA[T2](err) || errs.IsA[T3](err) || errs.IsA[T4](err) { +func RetryWhenIsOneOf3[T any, E1, E2, E3 error](ctx context.Context, timeout time.Duration, f func(context.Context) (T, error)) (T, error) { + return retryWhen(ctx, timeout, f, func(err error) (bool, error) { + if errs.IsA[E1](err) || errs.IsA[E2](err) || errs.IsA[E3](err) { return true, err } @@ -179,9 +93,9 @@ func RetryWhenIsOneOf4[T1, T2, T3, T4 error](ctx context.Context, timeout time.D }) } -func RetryWhenIsAErrorMessageContains[T errs.ErrorWithErrorMessage](ctx context.Context, timeout time.Duration, f func() (any, error), needle string) (any, error) { - return RetryWhen(ctx, timeout, f, func(err error) (bool, error) { - if errs.IsAErrorMessageContains[T](err, needle) { +func RetryWhenIsOneOf4[T any, E1, E2, E3, E4 error](ctx context.Context, timeout time.Duration, f func(context.Context) (T, error)) (T, error) { + return retryWhen(ctx, timeout, f, func(err error) (bool, error) { + if errs.IsA[E1](err) || errs.IsA[E2](err) || errs.IsA[E3](err) || errs.IsA[E4](err) { return true, err } @@ -189,8 +103,8 @@ func RetryWhenIsAErrorMessageContains[T errs.ErrorWithErrorMessage](ctx context. }) } -func RetryGWhenIsAErrorMessageContains[T any, E errs.ErrorWithErrorMessage](ctx context.Context, timeout time.Duration, f func() (T, error), needle string) (T, error) { - return RetryGWhen(ctx, timeout, f, func(err error) (bool, error) { +func RetryWhenIsAErrorMessageContains[T any, E errs.ErrorWithErrorMessage](ctx context.Context, timeout time.Duration, f func(context.Context) (T, error), needle string) (T, error) { + return retryWhen(ctx, timeout, f, func(err error) (bool, error) { if errs.IsAErrorMessageContains[E](err, needle) { return true, err } @@ -216,51 +130,24 @@ func RetryUntilEqual[T comparable](ctx context.Context, timeout time.Duration, t } // RetryUntilNotFound retries the specified function until it returns a retry.NotFoundError. -func RetryUntilNotFound(ctx context.Context, timeout time.Duration, f func() (any, error)) (any, error) { - return RetryWhen(ctx, timeout, f, func(err error) (bool, error) { - if NotFound(err) { - return false, nil - } - - if err != nil { - return false, err - } - - return true, ErrFoundResource - }) +func RetryUntilNotFound(ctx context.Context, timeout time.Duration, f func(context.Context) (any, error)) (any, error) { + return retry.Op(f).UntilNotFound()(ctx, timeout) } // RetryWhenNotFound retries the specified function when it returns a retry.NotFoundError. -func RetryWhenNotFound(ctx context.Context, timeout time.Duration, f func() (any, error)) (any, error) { - return RetryWhen(ctx, timeout, f, func(err error) (bool, error) { - if NotFound(err) { - return true, err - } - - return false, err - }) -} - -// RetryGWhenNotFound retries the specified function when it returns a retry.NotFoundError. -func RetryGWhenNotFound[T any](ctx context.Context, timeout time.Duration, f func() (T, error)) (T, error) { - return RetryGWhen(ctx, timeout, f, func(err error) (bool, error) { - if NotFound(err) { - return true, err - } - - return false, err - }) +func RetryWhenNotFound[T any](ctx context.Context, timeout time.Duration, f func(context.Context) (T, error)) (T, error) { + return retry.Op(f).UntilFoundN(1)(ctx, timeout) } // RetryWhenNewResourceNotFound retries the specified function when it returns a retry.NotFoundError and `isNewResource` is true. -func RetryWhenNewResourceNotFound(ctx context.Context, timeout time.Duration, f func() (any, error), isNewResource bool) (any, error) { - return RetryWhen(ctx, timeout, f, func(err error) (bool, error) { +func RetryWhenNewResourceNotFound[T any](ctx context.Context, timeout time.Duration, f func(context.Context) (T, error), isNewResource bool) (T, error) { + return retry.Op(f).If(func(_ T, err error) (bool, error) { if isNewResource && NotFound(err) { return true, err } return false, err - }) + })(ctx, timeout) } type Options struct { @@ -335,58 +222,36 @@ func WithContinuousTargetOccurence(continuousTargetOccurence int) OptionsFunc { // Retry allows configuration of StateChangeConf's various time arguments. // This is especially useful for AWS services that are prone to throttling, such as Route53, where // the default durations cause problems. -func Retry(ctx context.Context, timeout time.Duration, f sdkretry.RetryFunc, optFns ...OptionsFunc) error { - // These are used to pull the error out of the function; need a mutex to - // avoid a data race. - var resultErr error - var resultErrMu sync.Mutex - - options := Options{} +func Retry(ctx context.Context, timeout time.Duration, f func(context.Context) *RetryError, optFns ...OptionsFunc) error { + options := Options{ + MinPollInterval: 500 * time.Millisecond, //nolint:mnd // 500ms is the Plugin SDKv2 default + } for _, fn := range optFns { fn(&options) } - c := &sdkretry.StateChangeConf{ - Pending: []string{"retryableerror"}, - Target: []string{"success"}, - Timeout: timeout, - MinTimeout: 500 * time.Millisecond, - Refresh: func() (any, string, error) { - rerr := f() - - resultErrMu.Lock() - defer resultErrMu.Unlock() - - if rerr == nil { - resultErr = nil - return 42, "success", nil - } - - resultErr = rerr.Err - - if rerr.Retryable { - return 42, "retryableerror", nil + _, err := retryWhen(ctx, timeout, + func(ctx context.Context) (any, error) { + return nil, f(ctx) + }, + func(err error) (bool, error) { + if err, ok := errs.As[*RetryError](err); ok { + if err != nil { + return err.isRetryable, err.err + } + return false, nil } - return nil, "quit", rerr.Err + return false, err }, - } + backoff.WithDelay(backoff.SDKv2HelperRetryCompatibleDelay(options.Delay, options.PollInterval, options.MinPollInterval)), + ) - options.Apply(c) - - _, waitErr := c.WaitForStateContext(ctx) - - // Need to acquire the lock here to be able to avoid race using resultErr as - // the return value - resultErrMu.Lock() - defer resultErrMu.Unlock() + return err +} - // resultErr may be nil because the wait timed out and resultErr was never - // set; this is still an error - if resultErr == nil { - return waitErr - } - // resultErr takes precedence over waitErr if both are set because it is - // more likely to be useful - return resultErr +func retryWhen[T any](ctx context.Context, timeout time.Duration, f func(context.Context) (T, error), retryable Retryable, opts ...backoff.Option) (T, error) { + return retry.Op(f).If(func(_ T, err error) (bool, error) { + return retryable(err) + })(ctx, timeout, opts...) } diff --git a/internal/tfresource/retry_test.go b/internal/tfresource/retry_test.go index 5693153a5e6b..dd2acc25f527 100644 --- a/internal/tfresource/retry_test.go +++ b/internal/tfresource/retry_test.go @@ -11,7 +11,8 @@ import ( "testing" "time" - "github.com/hashicorp/terraform-plugin-sdk/v2/helper/retry" + sdkretry "github.com/hashicorp/terraform-plugin-sdk/v2/helper/retry" + "github.com/hashicorp/terraform-provider-aws/internal/retry" "github.com/hashicorp/terraform-provider-aws/internal/tfresource" ) @@ -22,18 +23,18 @@ func TestRetryWhenAWSErrCodeEquals(t *testing.T) { // nosemgrep:ci.aws-in-func-n ctx := t.Context() testCases := []struct { Name string - F func() (any, error) + F func(context.Context) (any, error) ExpectError bool }{ { Name: "no error", - F: func() (any, error) { + F: func(context.Context) (any, error) { return nil, nil }, }, { Name: "non-retryable other error", - F: func() (any, error) { + F: func(context.Context) (any, error) { return nil, errors.New("TestCode") }, ExpectError: true, @@ -60,18 +61,18 @@ func TestRetryWhenAWSErrMessageContains(t *testing.T) { // nosemgrep:ci.aws-in-f ctx := t.Context() testCases := []struct { Name string - F func() (any, error) + F func(context.Context) (any, error) ExpectError bool }{ { Name: "no error", - F: func() (any, error) { + F: func(context.Context) (any, error) { return nil, nil }, }, { Name: "non-retryable other error", - F: func() (any, error) { + F: func(context.Context) (any, error) { return nil, errors.New("TestCode") }, ExpectError: true, @@ -99,33 +100,33 @@ func TestRetryWhenNewResourceNotFound(t *testing.T) { var retryCount int32 testCases := []struct { Name string - F func() (any, error) + F func(context.Context) (any, error) NewResource bool ExpectError bool }{ { Name: "no error", - F: func() (any, error) { + F: func(context.Context) (any, error) { return nil, nil }, }, { Name: "no error new resource", - F: func() (any, error) { + F: func(context.Context) (any, error) { return nil, nil }, NewResource: true, }, { Name: "non-retryable other error", - F: func() (any, error) { + F: func(context.Context) (any, error) { return nil, errors.New("TestCode") }, ExpectError: true, }, { Name: "non-retryable other error new resource", - F: func() (any, error) { + F: func(context.Context) (any, error) { return nil, errors.New("TestCode") }, NewResource: true, @@ -133,14 +134,14 @@ func TestRetryWhenNewResourceNotFound(t *testing.T) { }, { Name: "retryable NotFoundError not new resource", - F: func() (any, error) { + F: func(context.Context) (any, error) { return nil, &retry.NotFoundError{} }, ExpectError: true, }, { Name: "retryable NotFoundError new resource timeout", - F: func() (any, error) { + F: func(context.Context) (any, error) { return nil, &retry.NotFoundError{} }, NewResource: true, @@ -148,7 +149,7 @@ func TestRetryWhenNewResourceNotFound(t *testing.T) { }, { Name: "retryable NotFoundError success new resource", - F: func() (any, error) { + F: func(context.Context) (any, error) { if atomic.CompareAndSwapInt32(&retryCount, 0, 1) { return nil, &retry.NotFoundError{} } @@ -182,32 +183,32 @@ func TestRetryWhenNotFound(t *testing.T) { var retryCount int32 testCases := []struct { Name string - F func() (any, error) + F func(context.Context) (any, error) ExpectError bool }{ { Name: "no error", - F: func() (any, error) { + F: func(ctx context.Context) (any, error) { return nil, nil }, }, { Name: "non-retryable other error", - F: func() (any, error) { + F: func(ctx context.Context) (any, error) { return nil, errors.New("TestCode") }, ExpectError: true, }, { Name: "retryable NotFoundError timeout", - F: func() (any, error) { + F: func(ctx context.Context) (any, error) { return nil, &retry.NotFoundError{} }, ExpectError: true, }, { Name: "retryable NotFoundError success", - F: func() (any, error) { + F: func(ctx context.Context) (any, error) { if atomic.CompareAndSwapInt32(&retryCount, 0, 1) { return nil, &retry.NotFoundError{} } @@ -299,32 +300,32 @@ func TestRetryUntilNotFound(t *testing.T) { var retryCount int32 testCases := []struct { Name string - F func() (any, error) + F func(context.Context) (any, error) ExpectError bool }{ { Name: "no error", - F: func() (any, error) { + F: func(context.Context) (any, error) { return nil, nil }, ExpectError: true, }, { Name: "other error", - F: func() (any, error) { + F: func(context.Context) (any, error) { return nil, errors.New("TestCode") }, ExpectError: true, }, { Name: "NotFoundError", - F: func() (any, error) { + F: func(context.Context) (any, error) { return nil, &retry.NotFoundError{} }, }, { Name: "retryable NotFoundError", - F: func() (any, error) { + F: func(context.Context) (any, error) { if atomic.CompareAndSwapInt32(&retryCount, 0, 1) { return nil, nil } @@ -349,13 +350,61 @@ func TestRetryUntilNotFound(t *testing.T) { } } -func TestRetryContext_error(t *testing.T) { +func TestRetryContext_nil(t *testing.T) { + t.Parallel() + + ctx := t.Context() + var expected error + f := func(context.Context) *tfresource.RetryError { + return nil + } + + errCh := make(chan error) + go func() { + errCh <- tfresource.Retry(ctx, 1*time.Second, f) + }() + + select { + case err := <-errCh: + if err != expected { //nolint:errorlint // We are actually comparing equality + t.Fatalf("bad: %#v", err) + } + case <-time.After(5 * time.Second): + t.Fatal("timeout") + } +} + +func TestRetryContext_nonRetryableError(t *testing.T) { + t.Parallel() + + ctx := t.Context() + expected := fmt.Errorf("nope") + f := func(context.Context) *tfresource.RetryError { + return tfresource.NonRetryableError(expected) + } + + errCh := make(chan error) + go func() { + errCh <- tfresource.Retry(ctx, 1*time.Second, f) + }() + + select { + case err := <-errCh: + if err != expected { //nolint:errorlint // We are actually comparing equality + t.Fatalf("bad: %#v", err) + } + case <-time.After(5 * time.Second): + t.Fatal("timeout") + } +} + +func TestRetryContext_retryableError(t *testing.T) { t.Parallel() ctx := t.Context() expected := fmt.Errorf("nope") - f := func() *retry.RetryError { - return retry.NonRetryableError(expected) + f := func(context.Context) *tfresource.RetryError { + return tfresource.RetryableError(expected) } errCh := make(chan error) @@ -430,7 +479,7 @@ func TestOptionsApply(t *testing.T) { t.Run(name, func(t *testing.T) { t.Parallel() - conf := retry.StateChangeConf{} + conf := sdkretry.StateChangeConf{} testCase.options.Apply(&conf) diff --git a/internal/types/service_package.go b/internal/types/service_package.go index 59910edac05d..2b1603fbf3d0 100644 --- a/internal/types/service_package.go +++ b/internal/types/service_package.go @@ -100,12 +100,13 @@ type Identity struct { IsSingleton bool // Singleton IsARN bool // ARN IsGlobalARNFormat bool // ARN - IdentityAttribute string // ARN, Single-Parameter + IdentityAttribute string // ARN IDAttrShadowsAttr string Attributes []IdentityAttribute IdentityDuplicateAttrs []string IsSingleParameter bool IsMutable bool + IsSetOnUpdate bool } func (i Identity) HasInherentRegion() bool { @@ -123,21 +124,15 @@ func (i Identity) HasInherentRegion() bool { func RegionalParameterizedIdentity(attributes []IdentityAttribute, opts ...IdentityOptsFunc) Identity { baseAttributes := []IdentityAttribute{ - { - Name: "account_id", - Required: false, - }, - { - Name: "region", - Required: false, - }, + StringIdentityAttribute("account_id", false), + StringIdentityAttribute("region", false), } baseAttributes = slices.Grow(baseAttributes, len(attributes)) identity := Identity{ Attributes: append(baseAttributes, attributes...), } if len(attributes) == 1 { - identity.IDAttrShadowsAttr = attributes[0].Name + identity.IDAttrShadowsAttr = attributes[0].Name() } for _, opt := range opts { @@ -148,14 +143,38 @@ func RegionalParameterizedIdentity(attributes []IdentityAttribute, opts ...Ident } type IdentityAttribute struct { - Name string - Required bool + name string + required bool + resourceAttributeName string +} + +func (ia IdentityAttribute) Name() string { + return ia.name +} + +func (ia IdentityAttribute) Required() bool { + return ia.required +} + +func (ia IdentityAttribute) ResourceAttributeName() string { + if ia.resourceAttributeName == "" { + return ia.name + } + return ia.resourceAttributeName } func StringIdentityAttribute(name string, required bool) IdentityAttribute { return IdentityAttribute{ - Name: name, - Required: required, + name: name, + required: required, + } +} + +func StringIdentityAttributeWithMappedName(name string, required bool, resourceAttributeName string) IdentityAttribute { + return IdentityAttribute{ + name: name, + required: required, + resourceAttributeName: resourceAttributeName, } } @@ -182,10 +201,7 @@ func arnIdentity(isGlobalResource bool, name string, opts []IdentityOptsFunc) Id IsGlobalARNFormat: isGlobalResource, IdentityAttribute: name, Attributes: []IdentityAttribute{ - { - Name: name, - Required: true, - }, + StringIdentityAttribute(name, true), }, } @@ -204,30 +220,36 @@ func RegionalResourceWithGlobalARNFormatNamed(name string, opts ...IdentityOptsF identity := RegionalARNIdentityNamed(name, opts...) identity.IsGlobalARNFormat = true - identity.Attributes = slices.Insert(identity.Attributes, 0, IdentityAttribute{ - Name: "region", - Required: false, - }) + identity.Attributes = slices.Insert(identity.Attributes, 0, + StringIdentityAttribute("region", false), + ) return identity } func RegionalSingleParameterIdentity(name string, opts ...IdentityOptsFunc) Identity { identity := Identity{ - IdentityAttribute: name, Attributes: []IdentityAttribute{ - { - Name: "account_id", - Required: false, - }, - { - Name: "region", - Required: false, - }, - { - Name: name, - Required: true, - }, + StringIdentityAttribute("account_id", false), + StringIdentityAttribute("region", false), + StringIdentityAttribute(name, true), + }, + IsSingleParameter: true, + } + + for _, opt := range opts { + opt(&identity) + } + + return identity +} + +func RegionalSingleParameterIdentityWithMappedName(name string, resourceAttributeName string, opts ...IdentityOptsFunc) Identity { + identity := Identity{ + Attributes: []IdentityAttribute{ + StringIdentityAttribute("account_id", false), + StringIdentityAttribute("region", false), + StringIdentityAttributeWithMappedName(name, true, resourceAttributeName), }, IsSingleParameter: true, } @@ -241,17 +263,27 @@ func RegionalSingleParameterIdentity(name string, opts ...IdentityOptsFunc) Iden func GlobalSingleParameterIdentity(name string, opts ...IdentityOptsFunc) Identity { identity := Identity{ - IsGlobalResource: true, - IdentityAttribute: name, + IsGlobalResource: true, Attributes: []IdentityAttribute{ - { - Name: "account_id", - Required: false, - }, - { - Name: name, - Required: true, - }, + StringIdentityAttribute("account_id", false), + StringIdentityAttribute(name, true), + }, + IsSingleParameter: true, + } + + for _, opt := range opts { + opt(&identity) + } + + return identity +} + +func GlobalSingleParameterIdentityWithMappedName(name string, resourceAttributeName string, opts ...IdentityOptsFunc) Identity { + identity := Identity{ + IsGlobalResource: true, + Attributes: []IdentityAttribute{ + StringIdentityAttribute("account_id", false), + StringIdentityAttributeWithMappedName(name, true, resourceAttributeName), }, IsSingleParameter: true, } @@ -265,10 +297,7 @@ func GlobalSingleParameterIdentity(name string, opts ...IdentityOptsFunc) Identi func GlobalParameterizedIdentity(attributes []IdentityAttribute, opts ...IdentityOptsFunc) Identity { baseAttributes := []IdentityAttribute{ - { - Name: "account_id", - Required: false, - }, + StringIdentityAttribute("account_id", false), } baseAttributes = slices.Grow(baseAttributes, len(attributes)) identity := Identity{ @@ -276,7 +305,7 @@ func GlobalParameterizedIdentity(attributes []IdentityAttribute, opts ...Identit Attributes: append(baseAttributes, attributes...), } if len(attributes) == 1 { - identity.IDAttrShadowsAttr = attributes[0].Name + identity.IDAttrShadowsAttr = attributes[0].Name() } for _, opt := range opts { @@ -291,10 +320,7 @@ func GlobalSingletonIdentity(opts ...IdentityOptsFunc) Identity { IsGlobalResource: true, IsSingleton: true, Attributes: []IdentityAttribute{ - { - Name: "account_id", - Required: false, - }, + StringIdentityAttribute("account_id", false), }, } @@ -310,14 +336,8 @@ func RegionalSingletonIdentity(opts ...IdentityOptsFunc) Identity { IsGlobalResource: false, IsSingleton: true, Attributes: []IdentityAttribute{ - { - Name: "account_id", - Required: false, - }, - { - Name: "region", - Required: false, - }, + StringIdentityAttribute("account_id", false), + StringIdentityAttribute("region", false), }, } @@ -336,10 +356,12 @@ func WithIdentityDuplicateAttrs(attrs ...string) IdentityOptsFunc { } } -// WithV6_0SDKv2Fix is for use ONLY for resource types affected by the v6.0 SDKv2 existing resource issue -func WithV6_0SDKv2Fix() IdentityOptsFunc { +// WithMutableIdentity is for use for resource types that normally have a mutable identity +// If Identity must be mutable to fix potential errors, use WithIdentityFix() +func WithMutableIdentity() IdentityOptsFunc { return func(opts *Identity) { opts.IsMutable = true + opts.IsSetOnUpdate = true } } @@ -350,6 +372,13 @@ func WithIdentityFix() IdentityOptsFunc { } } +// WithV6_0SDKv2Fix is for use ONLY for resource types affected by the v6.0 SDKv2 existing resource issue +func WithV6_0SDKv2Fix() IdentityOptsFunc { + return func(opts *Identity) { + opts.IsMutable = true + } +} + type ImportIDParser interface { Parse(id string) (string, map[string]string, error) } @@ -371,5 +400,6 @@ type SDKv2ImportID interface { type SDKv2Import struct { WrappedImport bool + CustomImport bool ImportID SDKv2ImportID // Multi-Parameter } diff --git a/internal/vcr/retry.go b/internal/vcr/retry.go index f52f336df8d9..ece73000fd9c 100644 --- a/internal/vcr/retry.go +++ b/internal/vcr/retry.go @@ -8,14 +8,15 @@ import ( "strings" "github.com/aws/aws-sdk-go-v2/aws" + "github.com/aws/aws-sdk-go-v2/aws/retry" "github.com/hashicorp/terraform-provider-aws/internal/errs" ) // InteractionNotFoundRetryableFunc is a retryable function to augment retry behavior for AWS service clients // when VCR testing is enabled -var InteractionNotFoundRetryableFunc = func(err error) aws.Ternary { +var InteractionNotFoundRetryableFunc = retry.IsErrorRetryableFunc(func(err error) aws.Ternary { if errs.IsA[*url.Error](err) && strings.Contains(err.Error(), "requested interaction not found") { return aws.FalseTernary } return aws.UnknownTernary // Delegate to configured Retryer. -} +}) diff --git a/internal/verify/verify.go b/internal/verify/verify.go index 2b1d69fa3a09..8f1b7ed5b632 100644 --- a/internal/verify/verify.go +++ b/internal/verify/verify.go @@ -4,7 +4,7 @@ package verify import ( - "gopkg.in/yaml.v3" + tfyaml "github.com/hashicorp/terraform-provider-aws/internal/yaml" ) const UUIDRegexPattern = `[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[ab89][0-9a-f]{3}-[0-9a-f]{12}` @@ -13,15 +13,15 @@ const UUIDRegexPattern = `[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[ab89][0-9a-f // the YAML parser. Returns either a parsing // error or original YAML string. func checkYAMLString(yamlString any) (string, error) { - var y any - if yamlString == nil || yamlString.(string) == "" { return "", nil } + var y any + s := yamlString.(string) - err := yaml.Unmarshal([]byte(s), &y) + err := tfyaml.DecodeFromString(s, &y) return s, err } diff --git a/internal/yaml/decode.go b/internal/yaml/decode.go index bc9082bd898b..d65abb678cc9 100644 --- a/internal/yaml/decode.go +++ b/internal/yaml/decode.go @@ -8,7 +8,7 @@ import ( "io" "strings" - "gopkg.in/yaml.v3" + yaml "github.com/goccy/go-yaml" ) // DecodeFromBytes decodes (unmarshals) the given byte slice, containing valid YAML, into `to`. diff --git a/mkdocs.yml b/mkdocs.yml index b2f6648238c7..3cde35fc4e52 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -32,13 +32,20 @@ nav: - How We Prioritize: prioritization.md - Developer Reference: - Acceptance Test Environment Variables: acc-test-environment-variables.md + - AI Agents: ai-agents.md + - AI Agent Guides: + - ARN-Based Resource Identity: ai-agent-guides/arn-based-resource-identity.md + - Parameterized Resource Identity: ai-agent-guides/parameterized-resource-identity.md + - Smarterr: ai-agent-guides/smarterr.md - AWS SDK Go Base: aws-sdk-go-base.md - Core Services: core-services.md - Data Handling and Conversion: data-handling-and-conversion.md - Debugging: debugging.md - Dependency Updates: dependency-updates.md - Design Decision Log: design-decision-log.md + - Enhanced Region Support: enhanced-region-support.md - Error Handling: error-handling.md + - Go-VCR: go-vcr.md - ID Attributes: id-attributes.md - Makefile Cheat Sheet: makefile-cheat-sheet.md - Naming Standards: naming.md diff --git a/names/consts_gen.go b/names/consts_gen.go index aa6170eb2602..065cdebdd073 100644 --- a/names/consts_gen.go +++ b/names/consts_gen.go @@ -7,6 +7,7 @@ const ( AMP = "amp" APIGateway = "apigateway" APIGatewayV2 = "apigatewayv2" + ARCRegionSwitch = "arcregionswitch" AccessAnalyzer = "accessanalyzer" Account = "account" Amplify = "amplify" @@ -30,6 +31,7 @@ const ( Batch = "batch" Bedrock = "bedrock" BedrockAgent = "bedrockagent" + BedrockAgentCore = "bedrockagentcore" Billing = "billing" Budgets = "budgets" CE = "ce" @@ -168,6 +170,7 @@ const ( NetworkMonitor = "networkmonitor" Notifications = "notifications" NotificationsContacts = "notificationscontacts" + ODB = "odb" ObservabilityAccessManager = "oam" OpenSearch = "opensearch" OpenSearchIngestion = "osis" @@ -208,6 +211,7 @@ const ( S3Control = "s3control" S3Outposts = "s3outposts" S3Tables = "s3tables" + S3Vectors = "s3vectors" SES = "ses" SESV2 = "sesv2" SFN = "sfn" @@ -249,6 +253,7 @@ const ( WAFRegional = "wafregional" WAFV2 = "wafv2" WellArchitected = "wellarchitected" + WorkMail = "workmail" WorkSpaces = "workspaces" WorkSpacesWeb = "workspacesweb" XRay = "xray" @@ -262,6 +267,7 @@ const ( AMPServiceID = "amp" APIGatewayServiceID = "API Gateway" APIGatewayV2ServiceID = "ApiGatewayV2" + ARCRegionSwitchServiceID = "ARC Region Switch" AccessAnalyzerServiceID = "AccessAnalyzer" AccountServiceID = "Account" AmplifyServiceID = "Amplify" @@ -285,6 +291,7 @@ const ( BatchServiceID = "Batch" BedrockServiceID = "Bedrock" BedrockAgentServiceID = "Bedrock Agent" + BedrockAgentCoreServiceID = "Bedrock AgentCore Control" BillingServiceID = "Billing" BudgetsServiceID = "Budgets" CEServiceID = "Cost Explorer" @@ -423,6 +430,7 @@ const ( NetworkMonitorServiceID = "NetworkMonitor" NotificationsServiceID = "notifications" NotificationsContactsServiceID = "notificationscontacts" + ODBServiceID = "ODB" ObservabilityAccessManagerServiceID = "OAM" OpenSearchServiceID = "OpenSearch" OpenSearchIngestionServiceID = "OSIS" @@ -463,6 +471,7 @@ const ( S3ControlServiceID = "S3 Control" S3OutpostsServiceID = "S3Outposts" S3TablesServiceID = "S3Tables" + S3VectorsServiceID = "S3Vectors" SESServiceID = "SES" SESV2ServiceID = "SESv2" SFNServiceID = "SFN" @@ -504,6 +513,7 @@ const ( WAFRegionalServiceID = "WAF Regional" WAFV2ServiceID = "WAFV2" WellArchitectedServiceID = "WellArchitected" + WorkMailServiceID = "WorkMail" WorkSpacesServiceID = "WorkSpaces" WorkSpacesWebServiceID = "WorkSpaces Web" XRayServiceID = "XRay" diff --git a/names/data/names_data.hcl b/names/data/names_data.hcl index d104ebbb58cd..9ec22f8d3924 100644 --- a/names/data/names_data.hcl +++ b/names/data/names_data.hcl @@ -648,6 +648,38 @@ service "appsync" { brand = "AWS" } +service "arcregionswitch" { + cli_v2_command { + aws_cli_v2_command = "arc-region-switch" + aws_cli_v2_command_no_dashes = "arcregionswitch" + } + + sdk { + id = "ARC Region Switch" + arn_namespace = "arcregionswitch" + } + + names { + provider_name_upper = "ARCRegionSwitch" + human_friendly = "Application Resilience Controller Region Switch" + } + + endpoint_info { + endpoint_api_call = "ListPlans" + endpoint_region_overrides = { + "aws" = "us-east-1" + } + } + + resource_prefix { + correct = "aws_arcregionswitch_" + } + + provider_package_correct = "arcregionswitch" + doc_prefix = ["arcregionswitch_"] + brand = "AWS" +} + service "athena" { sdk { id = "Athena" @@ -875,6 +907,39 @@ service "bedrockagent" { brand = "Amazon" } +service "bedrockagentcore" { + cli_v2_command { + aws_cli_v2_command = "bedrock-agentcore-control" + aws_cli_v2_command_no_dashes = "bedrockagentcorecontrol" + } + + go_packages { + v2_package = "bedrockagentcorecontrol" + } + + sdk { + id = "Bedrock AgentCore Control" + arn_namespace = "bedrock-agentcore" + } + + names { + provider_name_upper = "BedrockAgentCore" + human_friendly = "Bedrock AgentCore" + } + + endpoint_info { + endpoint_api_call = "ListAgentRuntimes" + } + + resource_prefix { + correct = "aws_bedrockagentcore_" + } + + provider_package_correct = "bedrockagentcore" + doc_prefix = ["bedrockagentcore_"] + brand = "Amazon" +} + service "bcmdataexports" { sdk { id = "BCM Data Exports" @@ -2068,13 +2133,21 @@ service "cognitoidp" { } resource_prefix { - actual = "aws_cognito_(identity_provider|resource|user|risk)" + actual = "aws_cognito_(identity_provider|log|managed_login_branding|managed_user|resource|risk|user)" correct = "aws_cognitoidp_" } provider_package_correct = "cognitoidp" - doc_prefix = ["cognito_identity_provider", "cognito_managed_user", "cognito_resource_", "cognito_user", "cognito_risk"] - brand = "AWS" + doc_prefix = [ + "cognito_identity_provider", + "cognito_log", + "cognito_managed_login_branding", + "cognito_managed_user", + "cognito_resource_", + "cognito_risk", + "cognito_user" + ] + brand = "AWS" } service "cognitosync" { @@ -5997,6 +6070,29 @@ service "oam" { brand = "AWS" } +service "odb" { + sdk { + id = "ODB" + arn_namespace = "odb" + } + + names { + provider_name_upper = "ODB" + human_friendly = "Oracle Database@AWS" + } + + endpoint_info { + endpoint_api_call = "ListCloudExadataInfrastructures" + } + + resource_prefix { + correct = "aws_odb_" + } + + doc_prefix = ["odb_"] + brand = "AWS" +} + service "opensearch" { go_packages { v1_package = "opensearchservice" @@ -7341,6 +7437,29 @@ service "s3tables" { brand = "Amazon" } +service "s3vectors" { + sdk { + id = "S3Vectors" + arn_namespace = "s3vectors" + } + + names { + provider_name_upper = "S3Vectors" + human_friendly = "S3 Vectors" + } + + endpoint_info { + endpoint_api_call = "ListVectorBuckets" + } + + resource_prefix { + correct = "aws_s3vectors_" + } + + doc_prefix = ["s3vectors_"] + brand = "Amazon" +} + service "glacier" { sdk { id = "Glacier" @@ -8855,6 +8974,11 @@ service "workmail" { human_friendly = "WorkMail" } + endpoint_info { + endpoint_api_call = "ListResources" + endpoint_api_params = "OrganizationId: aws.String(\"m-12345678901234567890123456789012\")" + } + resource_prefix { correct = "aws_workmail_" } @@ -8862,7 +8986,6 @@ service "workmail" { provider_package_correct = "workmail" doc_prefix = ["workmail_"] brand = "Amazon" - not_implemented = true } service "workmailmessageflow" { diff --git a/skaff/datasource/datasource.gtpl b/skaff/datasource/datasource.gtpl index 9087bea14d6b..f8521721d68e 100644 --- a/skaff/datasource/datasource.gtpl +++ b/skaff/datasource/datasource.gtpl @@ -57,6 +57,7 @@ import ( "github.com/hashicorp/terraform-provider-aws/internal/conns" "github.com/hashicorp/terraform-provider-aws/internal/create" "github.com/hashicorp/terraform-provider-aws/internal/flex" + "github.com/hashicorp/terraform-provider-aws/internal/smerr" {{- if .IncludeTags }} tftags "github.com/hashicorp/terraform-provider-aws/internal/tags" {{- end }} @@ -111,7 +112,7 @@ func DataSource{{ .DataSource }}() *schema.Resource { // https://pkg.go.dev/github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema#Schema {{- end }} Schema: map[string]*schema.Schema{ - "arn": { {{- if .IncludeComments }} // TIP: Many, but not all, data sources have an `arn` attribute.{{- end }} + names.AttrARN: { {{- if .IncludeComments }} // TIP: Many, but not all, data sources have an `arn` attribute.{{- end }} Type: schema.TypeString, Computed: true, }, @@ -138,7 +139,7 @@ func DataSource{{ .DataSource }}() *schema.Resource { }, }, {{- if .IncludeTags }} - "tags": tftags.TagsSchemaComputed(), {{- if .IncludeComments }} // TIP: Many, but not all, data sources have `tags` attributes.{{- end }} + names.AttrTags: tftags.TagsSchemaComputed(), {{- if .IncludeComments }} // TIP: Many, but not all, data sources have `tags` attributes.{{- end }} {{- end }} }, } @@ -174,11 +175,12 @@ func dataSource{{ .DataSource }}Read(ctx context.Context, d *schema.ResourceData // elements. However, a data source will have perhaps one or a few arguments // that are key to finding the relevant information, such as 'name' below. {{- end }} - name := d.Get("name").(string) + name := d.Get(names.AttrName).(string) out, err := find{{ .DataSource }}ByName(ctx, conn, name) if err != nil { - return create.AppendDiagError(diags, names.{{ .Service }}, create.ErrActionReading, DSName{{ .DataSource }}, name, err) + smerr.Append(ctx, diags, err, smerr.ID, name) + return diags } {{ if .IncludeComments }} // TIP: -- 3. Set the ID @@ -196,7 +198,7 @@ func dataSource{{ .DataSource }}Read(ctx context.Context, d *schema.ResourceData // // For simple data types (i.e., schema.TypeString, schema.TypeBool, // schema.TypeInt, and schema.TypeFloat), a simple Set call (e.g., - // d.Set("arn", out.Arn) is sufficient. No error or nil checking is + // d.Set(names.AttrARN, out.Arn) is sufficient. No error or nil checking is // necessary. // // However, there are some situations where more handling is needed. @@ -206,27 +208,30 @@ func dataSource{{ .DataSource }}Read(ctx context.Context, d *schema.ResourceData // is equivalent to what is already set. In that case, you may check if // it is equivalent before setting the different JSON. {{- end }} - d.Set("arn", out.ARN) - d.Set("name", out.Name) + d.Set(names.AttrARN, out.ARN) + d.Set(names.AttrName, out.Name) {{ if .IncludeComments }} // TIP: Setting a complex type. // For more information, see: // https://hashicorp.github.io/terraform-provider-aws/data-handling-and-conversion/ {{- end }} if err := d.Set("complex_argument", flattenComplexArguments(out.ComplexArguments)); err != nil { - return create.AppendDiagError(diags, names.{{ .Service }}, create.ErrActionSetting, DSName{{ .DataSource }}, d.Id(), err) + smerr.Append(ctx, diags, err, smerr.ID, d.Id()) + return diags } {{ if .IncludeComments }} // TIP: Setting a JSON string to avoid errorneous diffs. {{- end }} p, err := verify.SecondJSONUnlessEquivalent(d.Get("policy").(string), aws.ToString(out.Policy)) if err != nil { - return create.AppendDiagError(diags, names.{{ .Service }}, create.ErrActionSetting, DSName{{ .DataSource }}, d.Id(), err) + smerr.Append(ctx, diags, err, smerr.ID, d.Id()) + return diags } p, err = structure.NormalizeJsonString(p) if err != nil { - return create.AppendDiagError(diags, names.{{ .Service }}, create.ErrActionReading, DSName{{ .DataSource }}, d.Id(), err) + smerr.Append(ctx, diags, err, smerr.ID, d.Id()) + return diags } d.Set("policy", p) @@ -241,8 +246,9 @@ func dataSource{{ .DataSource }}Read(ctx context.Context, d *schema.ResourceData {{- if .IncludeTags }} ignoreTagsConfig := meta.(*conns.AWSClient).IgnoreTagsConfig(ctx) - if err := d.Set("tags", KeyValueTags(out.Tags).IgnoreAWS().IgnoreConfig(ignoreTagsConfig).Map()); err != nil { - return create.AppendDiagError(diags, names.{{ .Service }}, create.ErrActionSetting, DSName{{ .DataSource }}, d.Id(), err) + if err := d.Set(names.AttrTags, KeyValueTags(out.Tags).IgnoreAWS().IgnoreConfig(ignoreTagsConfig).Map()); err != nil { + smerr.Append(ctx, diags, err, smerr.ID, d.Id()) + return diags } {{- end }} {{ if .IncludeComments }} diff --git a/skaff/datasource/datasourcefw.gtpl b/skaff/datasource/datasourcefw.gtpl index 9ff7327d24d0..24241624d53c 100644 --- a/skaff/datasource/datasourcefw.gtpl +++ b/skaff/datasource/datasourcefw.gtpl @@ -44,10 +44,10 @@ import ( "github.com/hashicorp/terraform-plugin-framework/datasource" "github.com/hashicorp/terraform-plugin-framework/datasource/schema" "github.com/hashicorp/terraform-plugin-framework/types" - "github.com/hashicorp/terraform-provider-aws/internal/create" "github.com/hashicorp/terraform-provider-aws/internal/framework" "github.com/hashicorp/terraform-provider-aws/internal/framework/flex" fwtypes "github.com/hashicorp/terraform-provider-aws/internal/framework/types" + "github.com/hashicorp/terraform-provider-aws/internal/smerr" {{- if .IncludeTags }} tftags "github.com/hashicorp/terraform-provider-aws/internal/tags" {{- end }} @@ -174,7 +174,7 @@ func (d *dataSource{{ .DataSource }}) Read(ctx context.Context, req datasource.R // TIP: -- 2. Fetch the config {{- end }} var data dataSource{{ .DataSource }}Model - resp.Diagnostics.Append(req.Config.Get(ctx, &data)...) + smerr.EnrichAppend(ctx, &resp.Diagnostics, req.Config.Get(ctx, &data)) if resp.Diagnostics.HasError() { return } @@ -183,10 +183,7 @@ func (d *dataSource{{ .DataSource }}) Read(ctx context.Context, req datasource.R {{- end }} out, err := find{{ .DataSource }}ByName(ctx, conn, data.Name.ValueString()) if err != nil { - resp.Diagnostics.AddError( - create.ProblemStandardMessage(names.{{ .Service }}, create.ErrActionReading, DSName{{ .DataSource }}, data.Name.String(), err), - err.Error(), - ) + smerr.AddError(ctx, &resp.Diagnostics, err, smerr.ID, data.Name.String()) return } @@ -194,7 +191,7 @@ func (d *dataSource{{ .DataSource }}) Read(ctx context.Context, req datasource.R // TIP: -- 4. Set the ID, arguments, and attributes // Using a field name prefix allows mapping fields such as `{{ .DataSource }}Id` to `ID` {{- end }} - resp.Diagnostics.Append(flex.Flatten(ctx, out, &data, flex.WithFieldNamePrefix("{{ .DataSource }}"))...) + smerr.EnrichAppend(ctx, &resp.Diagnostics, flex.Flatten(ctx, out, &data, flex.WithFieldNamePrefix("{{ .DataSource }}")), smerr.ID, data.Name.String()) if resp.Diagnostics.HasError() { return } @@ -211,7 +208,7 @@ func (d *dataSource{{ .DataSource }}) Read(ctx context.Context, req datasource.R {{ if .IncludeComments -}} // TIP: -- 6. Set the state {{- end }} - resp.Diagnostics.Append(resp.State.Set(ctx, &data)...) + smerr.EnrichAppend(ctx, &resp.Diagnostics, resp.State.Set(ctx, &data), smerr.ID, data.Name.String()) } {{ if .IncludeComments }} diff --git a/skaff/go.mod b/skaff/go.mod index 1ed49c886bb1..177af3cf65ef 100644 --- a/skaff/go.mod +++ b/skaff/go.mod @@ -1,11 +1,11 @@ module github.com/hashicorp/terraform-provider-aws/skaff -go 1.24.4 +go 1.24.6 require ( github.com/YakDriver/regexache v0.24.0 github.com/hashicorp/terraform-provider-aws v1.60.1-0.20220322001452-8f7a597d0c24 - github.com/spf13/cobra v1.9.1 + github.com/spf13/cobra v1.10.1 ) require ( @@ -13,16 +13,16 @@ require ( github.com/apparentlymart/go-textseg/v15 v15.0.0 // indirect github.com/google/go-cmp v0.7.0 // indirect github.com/google/uuid v1.6.0 // indirect - github.com/hashicorp/aws-sdk-go-base/v2 v2.0.0-beta.65 // indirect + github.com/hashicorp/aws-sdk-go-base/v2 v2.0.0-beta.66 // indirect github.com/hashicorp/hcl/v2 v2.23.0 // indirect github.com/inconshreveable/mousetrap v1.1.0 // indirect github.com/mitchellh/go-wordwrap v1.0.1 // indirect - github.com/spf13/pflag v1.0.6 // indirect + github.com/spf13/pflag v1.0.9 // indirect github.com/zclconf/go-cty v1.16.3 // indirect - golang.org/x/mod v0.25.0 // indirect + golang.org/x/mod v0.27.0 // indirect golang.org/x/sync v0.16.0 // indirect - golang.org/x/text v0.27.0 // indirect - golang.org/x/tools v0.34.0 // indirect + golang.org/x/text v0.28.0 // indirect + golang.org/x/tools v0.36.0 // indirect ) replace github.com/hashicorp/terraform-provider-aws => ../ diff --git a/skaff/go.sum b/skaff/go.sum index 2b68792ef7fd..1ded58cb7896 100644 --- a/skaff/go.sum +++ b/skaff/go.sum @@ -13,8 +13,8 @@ github.com/google/go-cmp v0.7.0 h1:wk8382ETsv4JYUZwIsn6YpYiWiBsYLSJiTsyBybVuN8= github.com/google/go-cmp v0.7.0/go.mod h1:pXiqmnSA92OHEEa9HXL2W4E7lf9JzCmGVUdgjX3N/iU= github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0= github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo= -github.com/hashicorp/aws-sdk-go-base/v2 v2.0.0-beta.65 h1:81+kWbE1yErFBMjME0I5k3x3kojjKsWtPYHEAutoPow= -github.com/hashicorp/aws-sdk-go-base/v2 v2.0.0-beta.65/go.mod h1:WtMzv9T++tfWVea+qB2MXoaqxw33S8bpJslzUike2mQ= +github.com/hashicorp/aws-sdk-go-base/v2 v2.0.0-beta.66 h1:HA6blfR0h6kGnw4oJ92tZzghubreIkWbQJ4NVNqS688= +github.com/hashicorp/aws-sdk-go-base/v2 v2.0.0-beta.66/go.mod h1:7kTJVbY5+igob9Q5N6KO81EGEKDNI9FpjujB31uI/n0= github.com/hashicorp/hcl/v2 v2.23.0 h1:Fphj1/gCylPxHutVSEOf2fBOh1VE4AuLV7+kbJf3qos= github.com/hashicorp/hcl/v2 v2.23.0/go.mod h1:62ZYHrXgPoX8xBnzl8QzbWq4dyDsDtfCRgIq1rbJEvA= github.com/inconshreveable/mousetrap v1.1.0 h1:wN+x4NVGpMsO7ErUn/mUI3vEoE6Jt13X2s0bqwp9tc8= @@ -22,21 +22,21 @@ github.com/inconshreveable/mousetrap v1.1.0/go.mod h1:vpF70FUmC8bwa3OWnCshd2FqLf github.com/mitchellh/go-wordwrap v1.0.1 h1:TLuKupo69TCn6TQSyGxwI1EblZZEsQ0vMlAFQflz0v0= github.com/mitchellh/go-wordwrap v1.0.1/go.mod h1:R62XHJLzvMFRBbcrT7m7WgmE1eOyTSsCt+hzestvNj0= github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM= -github.com/spf13/cobra v1.9.1 h1:CXSaggrXdbHK9CF+8ywj8Amf7PBRmPCOJugH954Nnlo= -github.com/spf13/cobra v1.9.1/go.mod h1:nDyEzZ8ogv936Cinf6g1RU9MRY64Ir93oCnqb9wxYW0= -github.com/spf13/pflag v1.0.6 h1:jFzHGLGAlb3ruxLB8MhbI6A8+AQX/2eW4qeyNZXNp2o= -github.com/spf13/pflag v1.0.6/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg= +github.com/spf13/cobra v1.10.1 h1:lJeBwCfmrnXthfAupyUTzJ/J4Nc1RsHC/mSRU2dll/s= +github.com/spf13/cobra v1.10.1/go.mod h1:7SmJGaTHFVBY0jW4NXGluQoLvhqFQM+6XSKD+P4XaB0= +github.com/spf13/pflag v1.0.9 h1:9exaQaMOCwffKiiiYk6/BndUBv+iRViNW+4lEMi0PvY= +github.com/spf13/pflag v1.0.9/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg= github.com/zclconf/go-cty v1.16.3 h1:osr++gw2T61A8KVYHoQiFbFd1Lh3JOCXc/jFLJXKTxk= github.com/zclconf/go-cty v1.16.3/go.mod h1:VvMs5i0vgZdhYawQNq5kePSpLAoz8u1xvZgrPIxfnZE= github.com/zclconf/go-cty-debug v0.0.0-20240509010212-0d6042c53940 h1:4r45xpDWB6ZMSMNJFMOjqrGHynW3DIBuR2H9j0ug+Mo= github.com/zclconf/go-cty-debug v0.0.0-20240509010212-0d6042c53940/go.mod h1:CmBdvvj3nqzfzJ6nTCIwDTPZ56aVGvDrmztiO5g3qrM= -golang.org/x/mod v0.25.0 h1:n7a+ZbQKQA/Ysbyb0/6IbB1H/X41mKgbhfv7AfG/44w= -golang.org/x/mod v0.25.0/go.mod h1:IXM97Txy2VM4PJ3gI61r1YEk/gAj6zAHN3AdZt6S9Ww= +golang.org/x/mod v0.27.0 h1:kb+q2PyFnEADO2IEF935ehFUXlWiNjJWtRNgBLSfbxQ= +golang.org/x/mod v0.27.0/go.mod h1:rWI627Fq0DEoudcK+MBkNkCe0EetEaDSwJJkCcjpazc= golang.org/x/sync v0.16.0 h1:ycBJEhp9p4vXvUZNszeOq0kGTPghopOL8q0fq3vstxw= golang.org/x/sync v0.16.0/go.mod h1:1dzgHSNfp02xaA81J2MS99Qcpr2w7fw1gpm99rleRqA= -golang.org/x/text v0.27.0 h1:4fGWRpyh641NLlecmyl4LOe6yDdfaYNrGb2zdfo4JV4= -golang.org/x/text v0.27.0/go.mod h1:1D28KMCvyooCX9hBiosv5Tz/+YLxj0j7XhWjpSUF7CU= -golang.org/x/tools v0.34.0 h1:qIpSLOxeCYGg9TrcJokLBG4KFA6d795g0xkBkiESGlo= -golang.org/x/tools v0.34.0/go.mod h1:pAP9OwEaY1CAW3HOmg3hLZC5Z0CCmzjAF2UQMSqNARg= +golang.org/x/text v0.28.0 h1:rhazDwis8INMIwQ4tpjLDzUhx6RlXqZNPEM0huQojng= +golang.org/x/text v0.28.0/go.mod h1:U8nCwOR8jO/marOQ0QbDiOngZVEBB7MAiitBuMjXiNU= +golang.org/x/tools v0.36.0 h1:kWS0uv/zsvHEle1LbV5LE8QujrxB3wfQyxHfhOk0Qkg= +golang.org/x/tools v0.36.0/go.mod h1:WBDiHKJK8YgLHlcQPYQzNCkUxUypCaa5ZegCVutKm+s= gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= diff --git a/skaff/resource/resource.gtpl b/skaff/resource/resource.gtpl index 72e1564afc2a..607ec583428b 100644 --- a/skaff/resource/resource.gtpl +++ b/skaff/resource/resource.gtpl @@ -55,9 +55,10 @@ import ( "github.com/hashicorp/terraform-plugin-sdk/v2/helper/structure" "github.com/hashicorp/terraform-plugin-sdk/v2/helper/validation" "github.com/hashicorp/terraform-provider-aws/internal/conns" - "github.com/hashicorp/terraform-provider-aws/internal/create" "github.com/hashicorp/terraform-provider-aws/internal/errs" "github.com/hashicorp/terraform-provider-aws/internal/flex" + "github.com/YakDriver/smarterr" + "github.com/hashicorp/terraform-provider-aws/internal/smerr" {{- if .IncludeTags }} tftags "github.com/hashicorp/terraform-provider-aws/internal/tags" {{- end }} @@ -164,7 +165,7 @@ func Resource{{ .Resource }}() *schema.Resource { // https://pkg.go.dev/github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema#Schema {{- end }} Schema: map[string]*schema.Schema{ - "arn": { {{- if .IncludeComments }} // TIP: Many, but not all, resources have an `arn` attribute.{{- end }} + names.AttrARN: { {{- if .IncludeComments }} // TIP: Many, but not all, resources have an `arn` attribute.{{- end }} Type: schema.TypeString, Computed: true, }, @@ -231,8 +232,8 @@ func resource{{ .Resource }}Create(ctx context.Context, d *schema.ResourceData, // TIP: Mandatory or fields that will always be present can be set when // you create the Input structure. (Replace these with real fields.) {{- end }} - {{ .Resource }}Name: aws.String(d.Get("name").(string)), - {{ .Resource }}Type: aws.String(d.Get("type").(string)), + {{ .Resource }}Name: aws.String(d.Get(names.AttrName).(string)), + {{ .Resource }}Type: aws.String(d.Get(names.AttrType).(string)), {{ if .IncludeComments }} // TIP: Not all resources support tags and tags don't always make sense. If // your resource doesn't need tags, you can remove the tags lines here and @@ -268,11 +269,11 @@ func resource{{ .Resource }}Create(ctx context.Context, d *schema.ResourceData, // TIP: Since d.SetId() has not been called yet, you cannot use d.Id() // in error messages at this point. {{- end }} - return create.AppendDiagError(diags, names.{{ .Service }}, create.ErrActionCreating, ResName{{ .Resource }}, d.Get("name").(string), err) + return smerr.Append(ctx, diags, err, smerr.ID, d.Get(names.AttrName).(string)) } if out == nil || out.{{ .Resource }} == nil { - return create.AppendDiagError(diags, names.{{ .Service }}, create.ErrActionCreating, ResName{{ .Resource }}, d.Get("name").(string), errors.New("empty output")) + return smerr.Append(ctx, diags, errors.New("empty output"), smerr.ID, d.Get(names.AttrName).(string)) } {{ if .IncludeComments }} // TIP: -- 4. Set the minimum arguments and/or attributes for the Read function to @@ -283,7 +284,7 @@ func resource{{ .Resource }}Create(ctx context.Context, d *schema.ResourceData, // TIP: -- 5. Use a waiter to wait for create to complete {{- end }} if _, err := wait{{ .Resource }}Created(ctx, conn, d.Id(), d.Timeout(schema.TimeoutCreate)); err != nil { - return create.AppendDiagError(diags, names.{{ .Service }}, create.ErrActionWaitingForCreation, ResName{{ .Resource }}, d.Id(), err) + return smerr.Append(ctx, diags, err, smerr.ID, d.Id()) } {{ if .IncludeComments }} // TIP: -- 6. Call the Read function in the Create return @@ -325,14 +326,14 @@ func resource{{ .Resource }}Read(ctx context.Context, d *schema.ResourceData, me } if err != nil { - return create.AppendDiagError(diags, names.{{ .Service }}, create.ErrActionReading, ResName{{ .Resource }}, d.Id(), err) + return smerr.Append(ctx, diags, err, smerr.ID, d.Id()) } {{ if .IncludeComments }} // TIP: -- 4. Set the arguments and attributes // // For simple data types (i.e., schema.TypeString, schema.TypeBool, // schema.TypeInt, and schema.TypeFloat), a simple Set call (e.g., - // d.Set("arn", out.Arn) is sufficient. No error or nil checking is + // d.Set(names.AttrARN, out.Arn) is sufficient. No error or nil checking is // necessary. // // However, there are some situations where more handling is needed. @@ -342,8 +343,8 @@ func resource{{ .Resource }}Read(ctx context.Context, d *schema.ResourceData, me // is equivalent to what is already set. In that case, you may check if // it is equivalent before setting the different JSON. {{- end }} - d.Set("arn", out.Arn) - d.Set("name", out.Name) + d.Set(names.AttrARN, out.Arn) + d.Set(names.AttrName, out.Name) {{ if .IncludeComments }} // TIP: Setting a complex type. // For more information, see: @@ -352,19 +353,19 @@ func resource{{ .Resource }}Read(ctx context.Context, d *schema.ResourceData, me // https://hashicorp.github.io/terraform-provider-aws/data-handling-and-conversion/#root-typeset-of-resource-and-aws-list-of-structure {{- end }} if err := d.Set("complex_argument", flattenComplexArguments(out.ComplexArguments)); err != nil { - return create.AppendDiagError(diags, names.{{ .Service }}, create.ErrActionSetting, ResName{{ .Resource }}, d.Id(), err) + return smerr.Append(ctx, diags, err, smerr.ID, d.Id()) } {{ if .IncludeComments }} // TIP: Setting a JSON string to avoid errorneous diffs. {{- end }} p, err := verify.SecondJSONUnlessEquivalent(d.Get("policy").(string), aws.ToString(out.Policy)) if err != nil { - return create.AppendDiagError(diags, names.{{ .Service }}, create.ErrActionSetting, ResName{{ .Resource }}, d.Id(), err) + return smerr.Append(ctx, diags, err, smerr.ID, d.Id()) } p, err = structure.NormalizeJsonString(p) if err != nil { - return create.AppendDiagError(diags, names.{{ .Service }}, create.ErrActionSetting, ResName{{ .Resource }}, d.Id(), err) + return smerr.Append(ctx, diags, err, smerr.ID, d.Id()) } d.Set("policy", p) @@ -435,13 +436,13 @@ func resource{{ .Resource }}Update(ctx context.Context, d *schema.ResourceData, log.Printf("[DEBUG] Updating {{ .Service }} {{ .Resource }} (%s): %#v", d.Id(), in) out, err := conn.Update{{ .Resource }}(ctx, in) if err != nil { - return create.AppendDiagError(diags, names.{{ .Service }}, create.ErrActionUpdating, ResName{{ .Resource }}, d.Id(), err) + return smerr.Append(ctx, diags, err, smerr.ID, d.Id()) } {{ if .IncludeComments }} // TIP: -- 4. Use a waiter to wait for update to complete {{- end }} if _, err := wait{{ .Resource }}Updated(ctx, conn, aws.ToString(out.OperationId), d.Timeout(schema.TimeoutUpdate)); err != nil { - return create.AppendDiagError(diags, names.{{ .Service }}, create.ErrActionWaitingForUpdate, ResName{{ .Resource }}, d.Id(), err) + return smerr.Append(ctx, diags, err, smerr.ID, d.Id()) } {{ if .IncludeComments }} // TIP: -- 5. Call the Read function in the Update return @@ -491,13 +492,13 @@ func resource{{ .Resource }}Delete(ctx context.Context, d *schema.ResourceData, return diags } if err != nil { - return create.AppendDiagError(diags, names.{{ .Service }}, create.ErrActionDeleting, ResName{{ .Resource }}, d.Id(), err) + return smerr.Append(ctx, diags, err, smerr.ID, d.Id()) } {{ if .IncludeComments }} // TIP: -- 4. Use a waiter to wait for delete to complete {{- end }} if _, err := wait{{ .Resource }}Deleted(ctx, conn, d.Id(), d.Timeout(schema.TimeoutDelete)); err != nil { - return create.AppendDiagError(diags, names.{{ .Service }}, create.ErrActionWaitingForDeletion, ResName{{ .Resource }}, d.Id(), err) + return smerr.Append(ctx, diags, err, smerr.ID, d.Id()) } {{ if .IncludeComments }} // TIP: -- 5. Return diags @@ -543,10 +544,10 @@ func wait{{ .Resource }}Created(ctx context.Context, conn *{{ .ServiceLower }}.C outputRaw, err := stateConf.WaitForStateContext(ctx) if out, ok := outputRaw.(*{{ .ServiceLower }}.{{ .Resource }}); ok { - return out, err + return out, smarterr.NewError(err) } - return nil, err + return nil, smarterr.NewError(err) } {{ if .IncludeComments }} // TIP: It is easier to determine whether a resource is updated for some @@ -566,10 +567,10 @@ func wait{{ .Resource }}Updated(ctx context.Context, conn *{{ .ServiceLower }}.C outputRaw, err := stateConf.WaitForStateContext(ctx) if out, ok := outputRaw.(*{{ .ServiceLower }}.{{ .Resource }}); ok { - return out, err + return out, smarterr.NewError(err) } - return nil, err + return nil, smarterr.NewError(err) } {{ if .IncludeComments }} // TIP: A deleted waiter is almost like a backwards created waiter. There may @@ -585,10 +586,10 @@ func wait{{ .Resource }}Deleted(ctx context.Context, conn *{{ .ServiceLower }}.C outputRaw, err := stateConf.WaitForStateContext(ctx) if out, ok := outputRaw.(*{{ .ServiceLower }}.{{ .Resource }}); ok { - return out, err + return out, smarterr.NewError(err) } - return nil, err + return nil, smarterr.NewError(err) } {{ if .IncludeComments }} // TIP: ==== STATUS ==== @@ -607,7 +608,7 @@ func status{{ .Resource }}(ctx context.Context, conn *{{ .ServiceLower }}.Client } if err != nil { - return nil, "", err + return nil, "", smarterr.NewError(err) } return out, aws.ToString(out.Status), nil @@ -627,17 +628,17 @@ func find{{ .Resource }}ByID(ctx context.Context, conn *{{ .ServiceLower }}.Clie out, err := conn.Get{{ .Resource }}(ctx, in) if errs.IsA[*types.ResourceNotFoundException](err){ - return nil, &retry.NotFoundError{ + return nil, smarterr.NewError(&retry.NotFoundError{ LastError: err, LastRequest: in, - } + }) } if err != nil { - return nil, err + return nil, smarterr.NewError(err) } if out == nil || out.{{ .Resource }} == nil { - return nil, tfresource.NewEmptyResultError(in) + return nil, smarterr.NewError(tfresource.NewEmptyResultError(in)) } return out.{{ .Resource }}, nil diff --git a/skaff/resource/resourcefw.gtpl b/skaff/resource/resourcefw.gtpl index 23f658a21721..a2f534395ac3 100644 --- a/skaff/resource/resourcefw.gtpl +++ b/skaff/resource/resourcefw.gtpl @@ -60,6 +60,8 @@ import ( "github.com/hashicorp/terraform-provider-aws/internal/framework" "github.com/hashicorp/terraform-provider-aws/internal/framework/flex" fwtypes "github.com/hashicorp/terraform-provider-aws/internal/framework/types" + "github.com/hashicorp/terraform-provider-aws/internal/smerr" + "github.com/YakDriver/smarterr" "github.com/hashicorp/terraform-provider-aws/internal/sweep" sweepfw "github.com/hashicorp/terraform-provider-aws/internal/sweep/framework" {{- if .IncludeTags }} @@ -262,7 +264,7 @@ func (r *resource{{ .Resource }}) Create(ctx context.Context, req resource.Creat // TIP: -- 2. Fetch the plan {{- end }} var plan resource{{ .Resource }}Model - resp.Diagnostics.Append(req.Plan.Get(ctx, &plan)...) + smerr.EnrichAppend(ctx, &resp.Diagnostics, req.Plan.Get(ctx, &plan)) if resp.Diagnostics.HasError() { return } @@ -274,7 +276,7 @@ func (r *resource{{ .Resource }}) Create(ctx context.Context, req resource.Creat {{ if .IncludeComments -}} // TIP: Using a field name prefix allows mapping fields such as `ID` to `{{ .Resource }}Id` {{- end }} - resp.Diagnostics.Append(flex.Expand(ctx, plan, &input, flex.WithFieldNamePrefix("{{ .Resource }}"))...) + smerr.EnrichAppend(ctx, &resp.Diagnostics, flex.Expand(ctx, plan, &input, flex.WithFieldNamePrefix("{{ .Resource }}"))) if resp.Diagnostics.HasError() { return } @@ -291,24 +293,18 @@ func (r *resource{{ .Resource }}) Create(ctx context.Context, req resource.Creat // TIP: Since ID has not been set yet, you cannot use plan.ID.String() // in error messages at this point. {{- end }} - resp.Diagnostics.AddError( - create.ProblemStandardMessage(names.{{ .Service }}, create.ErrActionCreating, ResName{{ .Resource }}, plan.Name.String(), err), - err.Error(), - ) + smerr.AddError(ctx, &resp.Diagnostics, err, smerr.ID, plan.Name.String()) return } if out == nil || out.{{ .Resource }} == nil { - resp.Diagnostics.AddError( - create.ProblemStandardMessage(names.{{ .Service }}, create.ErrActionCreating, ResName{{ .Resource }}, plan.Name.String(), nil), - errors.New("empty output").Error(), - ) + smerr.AddError(ctx, &resp.Diagnostics, errors.New("empty output"), smerr.ID, plan.Name.String()) return } {{ if .IncludeComments -}} // TIP: -- 5. Using the output from the create function, set attributes {{- end }} - resp.Diagnostics.Append(flex.Flatten(ctx, out, &plan)...) + smerr.EnrichAppend(ctx, &resp.Diagnostics, flex.Flatten(ctx, out, &plan)) if resp.Diagnostics.HasError() { return } @@ -319,16 +315,13 @@ func (r *resource{{ .Resource }}) Create(ctx context.Context, req resource.Creat createTimeout := r.CreateTimeout(ctx, plan.Timeouts) _, err = wait{{ .Resource }}Created(ctx, conn, plan.ID.ValueString(), createTimeout) if err != nil { - resp.Diagnostics.AddError( - create.ProblemStandardMessage(names.{{ .Service }}, create.ErrActionWaitingForCreation, ResName{{ .Resource }}, plan.Name.String(), err), - err.Error(), - ) + smerr.AddError(ctx, &resp.Diagnostics, err, smerr.ID, plan.Name.String()) return } {{ if .IncludeComments }} // TIP: -- 7. Save the request plan to response state {{- end }} - resp.Diagnostics.Append(resp.State.Set(ctx, plan)...) + smerr.EnrichAppend(ctx, &resp.Diagnostics, resp.State.Set(ctx, plan)) } func (r *resource{{ .Resource }}) Read(ctx context.Context, req resource.ReadRequest, resp *resource.ReadResponse) { @@ -353,7 +346,7 @@ func (r *resource{{ .Resource }}) Read(ctx context.Context, req resource.ReadReq // TIP: -- 2. Fetch the state {{- end }} var state resource{{ .Resource }}Model - resp.Diagnostics.Append(req.State.Get(ctx, &state)...) + smerr.EnrichAppend(ctx, &resp.Diagnostics, req.State.Get(ctx, &state)) if resp.Diagnostics.HasError() { return } @@ -371,23 +364,20 @@ func (r *resource{{ .Resource }}) Read(ctx context.Context, req resource.ReadReq return } if err != nil { - resp.Diagnostics.AddError( - create.ProblemStandardMessage(names.{{ .Service }}, create.ErrActionReading, ResName{{ .Resource }}, state.ID.String(), err), - err.Error(), - ) + smerr.AddError(ctx, &resp.Diagnostics, err, smerr.ID, state.ID.String()) return } {{ if .IncludeComments }} // TIP: -- 5. Set the arguments and attributes {{- end }} - resp.Diagnostics.Append(flex.Flatten(ctx, out, &state)...) + smerr.EnrichAppend(ctx, &resp.Diagnostics, flex.Flatten(ctx, out, &state)) if resp.Diagnostics.HasError() { return } {{ if .IncludeComments }} // TIP: -- 6. Set the state {{- end }} - resp.Diagnostics.Append(resp.State.Set(ctx, &state)...) + smerr.EnrichAppend(ctx, &resp.Diagnostics, resp.State.Set(ctx, &state)) } func (r *resource{{ .Resource }}) Update(ctx context.Context, req resource.UpdateRequest, resp *resource.UpdateResponse) { @@ -422,8 +412,8 @@ func (r *resource{{ .Resource }}) Update(ctx context.Context, req resource.Updat // TIP: -- 2. Fetch the plan {{- end }} var plan, state resource{{ .Resource }}Model - resp.Diagnostics.Append(req.Plan.Get(ctx, &plan)...) - resp.Diagnostics.Append(req.State.Get(ctx, &state)...) + smerr.EnrichAppend(ctx, &resp.Diagnostics, req.Plan.Get(ctx, &plan)) + smerr.EnrichAppend(ctx, &resp.Diagnostics, req.State.Get(ctx, &state)) if resp.Diagnostics.HasError() { return } @@ -431,14 +421,14 @@ func (r *resource{{ .Resource }}) Update(ctx context.Context, req resource.Updat // TIP: -- 3. Get the difference between the plan and state, if any {{- end }} diff, d := flex.Diff(ctx, plan, state) - resp.Diagnostics.Append(d...) + smerr.EnrichAppend(ctx, &resp.Diagnostics, d) if resp.Diagnostics.HasError() { return } if diff.HasChanges() { var input {{ .SDKPackage }}.Update{{ .Resource }}Input - resp.Diagnostics.Append(flex.Expand(ctx, plan, &input, flex.WithFieldNamePrefix("Test"))...) + smerr.EnrichAppend(ctx, &resp.Diagnostics, flex.Expand(ctx, plan, &input, flex.WithFieldNamePrefix("Test"))) if resp.Diagnostics.HasError() { return } @@ -447,23 +437,17 @@ func (r *resource{{ .Resource }}) Update(ctx context.Context, req resource.Updat {{- end }} out, err := conn.Update{{ .Resource }}(ctx, &input) if err != nil { - resp.Diagnostics.AddError( - create.ProblemStandardMessage(names.{{ .Service }}, create.ErrActionUpdating, ResName{{ .Resource }}, plan.ID.String(), err), - err.Error(), - ) + smerr.AddError(ctx, &resp.Diagnostics, err, smerr.ID, plan.ID.String()) return } if out == nil || out.{{ .Resource }} == nil { - resp.Diagnostics.AddError( - create.ProblemStandardMessage(names.{{ .Service }}, create.ErrActionUpdating, ResName{{ .Resource }}, plan.ID.String(), nil), - errors.New("empty output").Error(), - ) + smerr.AddError(ctx, &resp.Diagnostics, errors.New("empty output"), smerr.ID, plan.ID.String()) return } {{ if .IncludeComments }} // TIP: Using the output from the update function, re-set any computed attributes {{- end }} - resp.Diagnostics.Append(flex.Flatten(ctx, out, &plan)...) + smerr.EnrichAppend(ctx, &resp.Diagnostics, flex.Flatten(ctx, out, &plan)) if resp.Diagnostics.HasError() { return } @@ -475,17 +459,14 @@ func (r *resource{{ .Resource }}) Update(ctx context.Context, req resource.Updat updateTimeout := r.UpdateTimeout(ctx, plan.Timeouts) _, err := wait{{ .Resource }}Updated(ctx, conn, plan.ID.ValueString(), updateTimeout) if err != nil { - resp.Diagnostics.AddError( - create.ProblemStandardMessage(names.{{ .Service }}, create.ErrActionWaitingForUpdate, ResName{{ .Resource }}, plan.ID.String(), err), - err.Error(), - ) + smerr.AddError(ctx, &resp.Diagnostics, err, smerr.ID, plan.ID.String()) return } {{ if .IncludeComments -}} // TIP: -- 6. Save the request plan to response state {{- end }} - resp.Diagnostics.Append(resp.State.Set(ctx, &plan)...) + smerr.EnrichAppend(ctx, &resp.Diagnostics, resp.State.Set(ctx, &plan)) } func (r *resource{{ .Resource }}) Delete(ctx context.Context, req resource.DeleteRequest, resp *resource.DeleteResponse) { @@ -515,7 +496,7 @@ func (r *resource{{ .Resource }}) Delete(ctx context.Context, req resource.Delet // TIP: -- 2. Fetch the state {{- end }} var state resource{{ .Resource }}Model - resp.Diagnostics.Append(req.State.Get(ctx, &state)...) + smerr.EnrichAppend(ctx, &resp.Diagnostics, req.State.Get(ctx, &state)) if resp.Diagnostics.HasError() { return } @@ -538,10 +519,7 @@ func (r *resource{{ .Resource }}) Delete(ctx context.Context, req resource.Delet return } - resp.Diagnostics.AddError( - create.ProblemStandardMessage(names.{{ .Service }}, create.ErrActionDeleting, ResName{{ .Resource }}, state.ID.String(), err), - err.Error(), - ) + smerr.AddError(ctx, &resp.Diagnostics, err, smerr.ID, state.ID.String()) return } {{ if .IncludeComments }} @@ -550,10 +528,7 @@ func (r *resource{{ .Resource }}) Delete(ctx context.Context, req resource.Delet deleteTimeout := r.DeleteTimeout(ctx, state.Timeouts) _, err = wait{{ .Resource }}Deleted(ctx, conn, state.ID.ValueString(), deleteTimeout) if err != nil { - resp.Diagnostics.AddError( - create.ProblemStandardMessage(names.{{ .Service }}, create.ErrActionWaitingForDeletion, ResName{{ .Resource }}, state.ID.String(), err), - err.Error(), - ) + smerr.AddError(ctx, &resp.Diagnostics, err, smerr.ID, state.ID.String()) return } } @@ -609,10 +584,10 @@ func wait{{ .Resource }}Created(ctx context.Context, conn *{{ .ServiceLower }}.C outputRaw, err := stateConf.WaitForStateContext(ctx) if out, ok := outputRaw.(*{{ .ServiceLower }}.{{ .Resource }}); ok { - return out, err + return out, smarterr.NewError(err) } - return nil, err + return nil, smarterr.NewError(err) } {{ if .IncludeComments }} // TIP: It is easier to determine whether a resource is updated for some @@ -632,10 +607,10 @@ func wait{{ .Resource }}Updated(ctx context.Context, conn *{{ .ServiceLower }}.C outputRaw, err := stateConf.WaitForStateContext(ctx) if out, ok := outputRaw.(*{{ .ServiceLower }}.{{ .Resource }}); ok { - return out, err + return out, smarterr.NewError(err) } - return nil, err + return nil, smarterr.NewError(err) } {{ if .IncludeComments }} // TIP: A deleted waiter is almost like a backwards created waiter. There may @@ -651,10 +626,10 @@ func wait{{ .Resource }}Deleted(ctx context.Context, conn *{{ .ServiceLower }}.C outputRaw, err := stateConf.WaitForStateContext(ctx) if out, ok := outputRaw.(*{{ .ServiceLower }}.{{ .Resource }}); ok { - return out, err + return out, smarterr.NewError(err) } - return nil, err + return nil, smarterr.NewError(err) } {{ if .IncludeComments }} // TIP: ==== STATUS ==== @@ -673,7 +648,7 @@ func status{{ .Resource }}(ctx context.Context, conn *{{ .ServiceLower }}.Client } if err != nil { - return nil, "", err + return nil, "", smarterr.NewError(err) } return out, aws.ToString(out.Status), nil @@ -694,17 +669,17 @@ func find{{ .Resource }}ByID(ctx context.Context, conn *{{ .ServiceLower }}.Clie out, err := conn.Get{{ .Resource }}(ctx, &input) if err != nil { if errs.IsA[*awstypes.ResourceNotFoundException](err) { - return nil, &retry.NotFoundError{ + return nil, smarterr.NewError(&retry.NotFoundError{ LastError: err, LastRequest: &input, - } + }) } - return nil, err + return nil, smarterr.NewError(err) } if out == nil || out.{{ .Resource }} == nil { - return nil, tfresource.NewEmptyResultError(&input) + return nil, smarterr.NewError(tfresource.NewEmptyResultError(&input)) } return out.{{ .Resource }}, nil @@ -771,7 +746,7 @@ func sweep{{ .Resource }}s(ctx context.Context, client *conns.AWSClient) ([]swee for pages.HasMorePages() { page, err := pages.NextPage(ctx) if err != nil { - return nil, err + return nil, smarterr.NewError(err) } for _, v := range page.{{ .Resource }}s { diff --git a/tools/literally/go.mod b/tools/literally/go.mod index eb4d30b0ac73..579cff1f29e1 100644 --- a/tools/literally/go.mod +++ b/tools/literally/go.mod @@ -1,3 +1,3 @@ module github.com/hashicorp/terraform-provider-aws/tools/literally -go 1.24.4 +go 1.24.6 diff --git a/tools/tfsdk2fw/go.mod b/tools/tfsdk2fw/go.mod index c64060213254..6bcc734459e4 100644 --- a/tools/tfsdk2fw/go.mod +++ b/tools/tfsdk2fw/go.mod @@ -1,11 +1,10 @@ module github.com/hashicorp/terraform-provider-aws/tools/tfsdk2fw -go 1.24.4 +go 1.24.6 require ( github.com/hashicorp/terraform-plugin-sdk/v2 v2.37.0 github.com/hashicorp/terraform-provider-aws v1.60.1-0.20220322001452-8f7a597d0c24 - golang.org/x/exp v0.0.0-20250506013437-ce4c2cf36ca6 ) require ( @@ -15,290 +14,297 @@ require ( github.com/ProtonMail/go-crypto v1.3.0 // indirect github.com/YakDriver/go-version v0.1.0 // indirect github.com/YakDriver/regexache v0.24.0 // indirect - github.com/agext/levenshtein v1.2.2 // indirect + github.com/YakDriver/smarterr v0.6.0 // indirect + github.com/agext/levenshtein v1.2.3 // indirect github.com/apparentlymart/go-textseg/v15 v15.0.0 // indirect github.com/armon/go-radix v1.0.0 // indirect - github.com/aws/aws-sdk-go-v2 v1.36.5 // indirect - github.com/aws/aws-sdk-go-v2/aws/protocol/eventstream v1.6.11 // indirect - github.com/aws/aws-sdk-go-v2/config v1.29.17 // indirect - github.com/aws/aws-sdk-go-v2/credentials v1.17.70 // indirect - github.com/aws/aws-sdk-go-v2/feature/ec2/imds v1.16.32 // indirect - github.com/aws/aws-sdk-go-v2/feature/s3/manager v1.17.83 // indirect - github.com/aws/aws-sdk-go-v2/internal/configsources v1.3.36 // indirect - github.com/aws/aws-sdk-go-v2/internal/endpoints/v2 v2.6.36 // indirect + github.com/aws/aws-sdk-go-v2 v1.38.3 // indirect + github.com/aws/aws-sdk-go-v2/aws/protocol/eventstream v1.7.1 // indirect + github.com/aws/aws-sdk-go-v2/config v1.31.6 // indirect + github.com/aws/aws-sdk-go-v2/credentials v1.18.10 // indirect + github.com/aws/aws-sdk-go-v2/feature/ec2/imds v1.18.6 // indirect + github.com/aws/aws-sdk-go-v2/feature/s3/manager v1.19.4 // indirect + github.com/aws/aws-sdk-go-v2/internal/configsources v1.4.6 // indirect + github.com/aws/aws-sdk-go-v2/internal/endpoints/v2 v2.7.6 // indirect github.com/aws/aws-sdk-go-v2/internal/ini v1.8.3 // indirect - github.com/aws/aws-sdk-go-v2/internal/v4a v1.3.36 // indirect - github.com/aws/aws-sdk-go-v2/service/accessanalyzer v1.40.0 // indirect - github.com/aws/aws-sdk-go-v2/service/account v1.24.2 // indirect - github.com/aws/aws-sdk-go-v2/service/acm v1.33.0 // indirect - github.com/aws/aws-sdk-go-v2/service/acmpca v1.40.5 // indirect - github.com/aws/aws-sdk-go-v2/service/amp v1.34.3 // indirect - github.com/aws/aws-sdk-go-v2/service/amplify v1.33.3 // indirect - github.com/aws/aws-sdk-go-v2/service/apigateway v1.31.4 // indirect - github.com/aws/aws-sdk-go-v2/service/apigatewayv2 v1.28.4 // indirect - github.com/aws/aws-sdk-go-v2/service/appconfig v1.38.3 // indirect - github.com/aws/aws-sdk-go-v2/service/appfabric v1.12.4 // indirect - github.com/aws/aws-sdk-go-v2/service/appflow v1.46.4 // indirect - github.com/aws/aws-sdk-go-v2/service/appintegrations v1.31.4 // indirect - github.com/aws/aws-sdk-go-v2/service/applicationautoscaling v1.36.4 // indirect - github.com/aws/aws-sdk-go-v2/service/applicationinsights v1.30.6 // indirect - github.com/aws/aws-sdk-go-v2/service/applicationsignals v1.11.3 // indirect - github.com/aws/aws-sdk-go-v2/service/appmesh v1.30.4 // indirect - github.com/aws/aws-sdk-go-v2/service/apprunner v1.34.2 // indirect - github.com/aws/aws-sdk-go-v2/service/appstream v1.45.5 // indirect - github.com/aws/aws-sdk-go-v2/service/appsync v1.47.3 // indirect - github.com/aws/aws-sdk-go-v2/service/athena v1.51.3 // indirect - github.com/aws/aws-sdk-go-v2/service/auditmanager v1.39.2 // indirect - github.com/aws/aws-sdk-go-v2/service/autoscaling v1.54.0 // indirect - github.com/aws/aws-sdk-go-v2/service/autoscalingplans v1.25.4 // indirect - github.com/aws/aws-sdk-go-v2/service/backup v1.43.1 // indirect - github.com/aws/aws-sdk-go-v2/service/batch v1.53.0 // indirect - github.com/aws/aws-sdk-go-v2/service/bcmdataexports v1.8.4 // indirect - github.com/aws/aws-sdk-go-v2/service/bedrock v1.38.0 // indirect - github.com/aws/aws-sdk-go-v2/service/bedrockagent v1.44.2 // indirect - github.com/aws/aws-sdk-go-v2/service/billing v1.2.4 // indirect - github.com/aws/aws-sdk-go-v2/service/budgets v1.31.2 // indirect - github.com/aws/aws-sdk-go-v2/service/chatbot v1.10.4 // indirect - github.com/aws/aws-sdk-go-v2/service/chime v1.36.4 // indirect - github.com/aws/aws-sdk-go-v2/service/chimesdkmediapipelines v1.22.4 // indirect - github.com/aws/aws-sdk-go-v2/service/chimesdkvoice v1.22.2 // indirect - github.com/aws/aws-sdk-go-v2/service/cleanrooms v1.25.2 // indirect - github.com/aws/aws-sdk-go-v2/service/cloud9 v1.29.4 // indirect - github.com/aws/aws-sdk-go-v2/service/cloudcontrol v1.24.6 // indirect - github.com/aws/aws-sdk-go-v2/service/cloudformation v1.61.0 // indirect - github.com/aws/aws-sdk-go-v2/service/cloudfront v1.46.3 // indirect - github.com/aws/aws-sdk-go-v2/service/cloudfrontkeyvaluestore v1.9.4 // indirect - github.com/aws/aws-sdk-go-v2/service/cloudhsmv2 v1.30.5 // indirect - github.com/aws/aws-sdk-go-v2/service/cloudsearch v1.27.4 // indirect - github.com/aws/aws-sdk-go-v2/service/cloudtrail v1.49.3 // indirect - github.com/aws/aws-sdk-go-v2/service/cloudwatch v1.45.3 // indirect - github.com/aws/aws-sdk-go-v2/service/cloudwatchlogs v1.51.0 // indirect - github.com/aws/aws-sdk-go-v2/service/codeartifact v1.34.4 // indirect - github.com/aws/aws-sdk-go-v2/service/codebuild v1.61.2 // indirect - github.com/aws/aws-sdk-go-v2/service/codecatalyst v1.17.21 // indirect - github.com/aws/aws-sdk-go-v2/service/codecommit v1.28.4 // indirect - github.com/aws/aws-sdk-go-v2/service/codeconnections v1.6.4 // indirect - github.com/aws/aws-sdk-go-v2/service/codedeploy v1.30.6 // indirect - github.com/aws/aws-sdk-go-v2/service/codeguruprofiler v1.25.4 // indirect - github.com/aws/aws-sdk-go-v2/service/codegurureviewer v1.30.4 // indirect - github.com/aws/aws-sdk-go-v2/service/codepipeline v1.42.2 // indirect - github.com/aws/aws-sdk-go-v2/service/codestarconnections v1.30.4 // indirect - github.com/aws/aws-sdk-go-v2/service/codestarnotifications v1.27.4 // indirect - github.com/aws/aws-sdk-go-v2/service/cognitoidentity v1.29.6 // indirect - github.com/aws/aws-sdk-go-v2/service/cognitoidentityprovider v1.53.2 // indirect - github.com/aws/aws-sdk-go-v2/service/comprehend v1.36.6 // indirect - github.com/aws/aws-sdk-go-v2/service/computeoptimizer v1.43.2 // indirect - github.com/aws/aws-sdk-go-v2/service/configservice v1.53.0 // indirect - github.com/aws/aws-sdk-go-v2/service/connect v1.131.0 // indirect - github.com/aws/aws-sdk-go-v2/service/connectcases v1.26.0 // indirect - github.com/aws/aws-sdk-go-v2/service/controltower v1.22.3 // indirect - github.com/aws/aws-sdk-go-v2/service/costandusagereportservice v1.29.4 // indirect - github.com/aws/aws-sdk-go-v2/service/costexplorer v1.51.2 // indirect - github.com/aws/aws-sdk-go-v2/service/costoptimizationhub v1.16.2 // indirect - github.com/aws/aws-sdk-go-v2/service/customerprofiles v1.47.0 // indirect - github.com/aws/aws-sdk-go-v2/service/databasemigrationservice v1.53.0 // indirect - github.com/aws/aws-sdk-go-v2/service/databrew v1.34.4 // indirect - github.com/aws/aws-sdk-go-v2/service/dataexchange v1.35.2 // indirect - github.com/aws/aws-sdk-go-v2/service/datapipeline v1.26.4 // indirect - github.com/aws/aws-sdk-go-v2/service/datasync v1.49.3 // indirect - github.com/aws/aws-sdk-go-v2/service/datazone v1.31.0 // indirect - github.com/aws/aws-sdk-go-v2/service/dax v1.24.4 // indirect - github.com/aws/aws-sdk-go-v2/service/detective v1.33.2 // indirect - github.com/aws/aws-sdk-go-v2/service/devicefarm v1.31.2 // indirect - github.com/aws/aws-sdk-go-v2/service/devopsguru v1.35.4 // indirect - github.com/aws/aws-sdk-go-v2/service/directconnect v1.32.5 // indirect - github.com/aws/aws-sdk-go-v2/service/directoryservice v1.31.7 // indirect - github.com/aws/aws-sdk-go-v2/service/dlm v1.30.7 // indirect - github.com/aws/aws-sdk-go-v2/service/docdb v1.41.6 // indirect - github.com/aws/aws-sdk-go-v2/service/docdbelastic v1.15.4 // indirect - github.com/aws/aws-sdk-go-v2/service/drs v1.31.4 // indirect - github.com/aws/aws-sdk-go-v2/service/dsql v1.5.2 // indirect - github.com/aws/aws-sdk-go-v2/service/dynamodb v1.44.0 // indirect - github.com/aws/aws-sdk-go-v2/service/ec2 v1.231.0 // indirect - github.com/aws/aws-sdk-go-v2/service/ecr v1.45.1 // indirect - github.com/aws/aws-sdk-go-v2/service/ecrpublic v1.33.2 // indirect - github.com/aws/aws-sdk-go-v2/service/ecs v1.58.1 // indirect - github.com/aws/aws-sdk-go-v2/service/efs v1.36.2 // indirect - github.com/aws/aws-sdk-go-v2/service/eks v1.66.1 // indirect - github.com/aws/aws-sdk-go-v2/service/elasticache v1.46.3 // indirect - github.com/aws/aws-sdk-go-v2/service/elasticbeanstalk v1.29.5 // indirect - github.com/aws/aws-sdk-go-v2/service/elasticloadbalancing v1.29.6 // indirect - github.com/aws/aws-sdk-go-v2/service/elasticloadbalancingv2 v1.46.0 // indirect - github.com/aws/aws-sdk-go-v2/service/elasticsearchservice v1.33.6 // indirect - github.com/aws/aws-sdk-go-v2/service/elastictranscoder v1.28.4 // indirect - github.com/aws/aws-sdk-go-v2/service/emr v1.49.3 // indirect - github.com/aws/aws-sdk-go-v2/service/emrcontainers v1.35.4 // indirect - github.com/aws/aws-sdk-go-v2/service/emrserverless v1.32.0 // indirect - github.com/aws/aws-sdk-go-v2/service/eventbridge v1.40.0 // indirect - github.com/aws/aws-sdk-go-v2/service/evidently v1.24.4 // indirect - github.com/aws/aws-sdk-go-v2/service/evs v1.0.2 // indirect - github.com/aws/aws-sdk-go-v2/service/finspace v1.29.4 // indirect - github.com/aws/aws-sdk-go-v2/service/firehose v1.37.7 // indirect - github.com/aws/aws-sdk-go-v2/service/fis v1.33.4 // indirect - github.com/aws/aws-sdk-go-v2/service/fms v1.40.5 // indirect - github.com/aws/aws-sdk-go-v2/service/fsx v1.55.0 // indirect - github.com/aws/aws-sdk-go-v2/service/gamelift v1.42.1 // indirect - github.com/aws/aws-sdk-go-v2/service/glacier v1.27.5 // indirect - github.com/aws/aws-sdk-go-v2/service/globalaccelerator v1.30.4 // indirect - github.com/aws/aws-sdk-go-v2/service/glue v1.117.0 // indirect - github.com/aws/aws-sdk-go-v2/service/grafana v1.27.4 // indirect - github.com/aws/aws-sdk-go-v2/service/greengrass v1.28.4 // indirect - github.com/aws/aws-sdk-go-v2/service/groundstation v1.33.2 // indirect - github.com/aws/aws-sdk-go-v2/service/guardduty v1.56.0 // indirect - github.com/aws/aws-sdk-go-v2/service/healthlake v1.30.5 // indirect - github.com/aws/aws-sdk-go-v2/service/iam v1.43.0 // indirect - github.com/aws/aws-sdk-go-v2/service/identitystore v1.28.6 // indirect - github.com/aws/aws-sdk-go-v2/service/imagebuilder v1.42.3 // indirect - github.com/aws/aws-sdk-go-v2/service/inspector v1.26.4 // indirect - github.com/aws/aws-sdk-go-v2/service/inspector2 v1.38.1 // indirect - github.com/aws/aws-sdk-go-v2/service/internal/accept-encoding v1.12.4 // indirect - github.com/aws/aws-sdk-go-v2/service/internal/checksum v1.7.4 // indirect - github.com/aws/aws-sdk-go-v2/service/internal/endpoint-discovery v1.10.17 // indirect - github.com/aws/aws-sdk-go-v2/service/internal/presigned-url v1.12.17 // indirect - github.com/aws/aws-sdk-go-v2/service/internal/s3shared v1.18.17 // indirect - github.com/aws/aws-sdk-go-v2/service/internetmonitor v1.21.5 // indirect - github.com/aws/aws-sdk-go-v2/service/invoicing v1.2.2 // indirect - github.com/aws/aws-sdk-go-v2/service/iot v1.64.4 // indirect - github.com/aws/aws-sdk-go-v2/service/ivs v1.43.4 // indirect - github.com/aws/aws-sdk-go-v2/service/ivschat v1.17.4 // indirect - github.com/aws/aws-sdk-go-v2/service/kafka v1.39.5 // indirect - github.com/aws/aws-sdk-go-v2/service/kafkaconnect v1.23.5 // indirect - github.com/aws/aws-sdk-go-v2/service/kendra v1.56.4 // indirect - github.com/aws/aws-sdk-go-v2/service/keyspaces v1.19.0 // indirect - github.com/aws/aws-sdk-go-v2/service/kinesis v1.35.3 // indirect - github.com/aws/aws-sdk-go-v2/service/kinesisanalytics v1.26.7 // indirect - github.com/aws/aws-sdk-go-v2/service/kinesisanalyticsv2 v1.32.7 // indirect - github.com/aws/aws-sdk-go-v2/service/kinesisvideo v1.28.4 // indirect - github.com/aws/aws-sdk-go-v2/service/kms v1.41.2 // indirect - github.com/aws/aws-sdk-go-v2/service/lakeformation v1.41.8 // indirect - github.com/aws/aws-sdk-go-v2/service/lambda v1.72.0 // indirect - github.com/aws/aws-sdk-go-v2/service/launchwizard v1.9.4 // indirect - github.com/aws/aws-sdk-go-v2/service/lexmodelbuildingservice v1.29.4 // indirect - github.com/aws/aws-sdk-go-v2/service/lexmodelsv2 v1.52.1 // indirect - github.com/aws/aws-sdk-go-v2/service/licensemanager v1.32.0 // indirect - github.com/aws/aws-sdk-go-v2/service/lightsail v1.43.4 // indirect - github.com/aws/aws-sdk-go-v2/service/location v1.44.4 // indirect - github.com/aws/aws-sdk-go-v2/service/lookoutmetrics v1.32.4 // indirect - github.com/aws/aws-sdk-go-v2/service/m2 v1.21.2 // indirect - github.com/aws/aws-sdk-go-v2/service/macie2 v1.45.4 // indirect - github.com/aws/aws-sdk-go-v2/service/mediaconnect v1.40.2 // indirect - github.com/aws/aws-sdk-go-v2/service/mediaconvert v1.75.0 // indirect - github.com/aws/aws-sdk-go-v2/service/medialive v1.76.2 // indirect - github.com/aws/aws-sdk-go-v2/service/mediapackage v1.35.4 // indirect - github.com/aws/aws-sdk-go-v2/service/mediapackagev2 v1.24.0 // indirect - github.com/aws/aws-sdk-go-v2/service/mediapackagevod v1.35.4 // indirect - github.com/aws/aws-sdk-go-v2/service/mediastore v1.25.4 // indirect - github.com/aws/aws-sdk-go-v2/service/memorydb v1.27.2 // indirect - github.com/aws/aws-sdk-go-v2/service/mgn v1.33.4 // indirect - github.com/aws/aws-sdk-go-v2/service/mq v1.29.2 // indirect - github.com/aws/aws-sdk-go-v2/service/mwaa v1.35.3 // indirect - github.com/aws/aws-sdk-go-v2/service/neptune v1.37.3 // indirect - github.com/aws/aws-sdk-go-v2/service/neptunegraph v1.17.5 // indirect - github.com/aws/aws-sdk-go-v2/service/networkfirewall v1.51.0 // indirect - github.com/aws/aws-sdk-go-v2/service/networkmanager v1.35.1 // indirect - github.com/aws/aws-sdk-go-v2/service/networkmonitor v1.8.4 // indirect - github.com/aws/aws-sdk-go-v2/service/notifications v1.2.5 // indirect - github.com/aws/aws-sdk-go-v2/service/notificationscontacts v1.1.4 // indirect - github.com/aws/aws-sdk-go-v2/service/oam v1.18.3 // indirect - github.com/aws/aws-sdk-go-v2/service/opensearch v1.46.6 // indirect - github.com/aws/aws-sdk-go-v2/service/opensearchserverless v1.19.6 // indirect - github.com/aws/aws-sdk-go-v2/service/organizations v1.39.0 // indirect - github.com/aws/aws-sdk-go-v2/service/osis v1.15.5 // indirect - github.com/aws/aws-sdk-go-v2/service/outposts v1.51.0 // indirect - github.com/aws/aws-sdk-go-v2/service/paymentcryptography v1.19.0 // indirect - github.com/aws/aws-sdk-go-v2/service/pcaconnectorad v1.11.3 // indirect - github.com/aws/aws-sdk-go-v2/service/pcs v1.6.2 // indirect - github.com/aws/aws-sdk-go-v2/service/pinpoint v1.35.4 // indirect - github.com/aws/aws-sdk-go-v2/service/pinpointsmsvoicev2 v1.20.3 // indirect - github.com/aws/aws-sdk-go-v2/service/pipes v1.19.5 // indirect - github.com/aws/aws-sdk-go-v2/service/polly v1.48.4 // indirect - github.com/aws/aws-sdk-go-v2/service/pricing v1.34.5 // indirect - github.com/aws/aws-sdk-go-v2/service/qbusiness v1.28.0 // indirect - github.com/aws/aws-sdk-go-v2/service/qldb v1.26.4 // indirect - github.com/aws/aws-sdk-go-v2/service/quicksight v1.87.0 // indirect - github.com/aws/aws-sdk-go-v2/service/ram v1.30.6 // indirect - github.com/aws/aws-sdk-go-v2/service/rbin v1.22.6 // indirect - github.com/aws/aws-sdk-go-v2/service/rds v1.99.1 // indirect - github.com/aws/aws-sdk-go-v2/service/redshift v1.54.6 // indirect - github.com/aws/aws-sdk-go-v2/service/redshiftdata v1.33.3 // indirect - github.com/aws/aws-sdk-go-v2/service/redshiftserverless v1.27.4 // indirect - github.com/aws/aws-sdk-go-v2/service/rekognition v1.47.2 // indirect - github.com/aws/aws-sdk-go-v2/service/resiliencehub v1.30.4 // indirect - github.com/aws/aws-sdk-go-v2/service/resourceexplorer2 v1.17.6 // indirect - github.com/aws/aws-sdk-go-v2/service/resourcegroups v1.29.3 // indirect - github.com/aws/aws-sdk-go-v2/service/resourcegroupstaggingapi v1.26.6 // indirect - github.com/aws/aws-sdk-go-v2/service/rolesanywhere v1.17.5 // indirect - github.com/aws/aws-sdk-go-v2/service/route53 v1.53.0 // indirect - github.com/aws/aws-sdk-go-v2/service/route53domains v1.29.4 // indirect - github.com/aws/aws-sdk-go-v2/service/route53profiles v1.5.9 // indirect - github.com/aws/aws-sdk-go-v2/service/route53recoverycontrolconfig v1.27.3 // indirect - github.com/aws/aws-sdk-go-v2/service/route53recoveryreadiness v1.22.4 // indirect - github.com/aws/aws-sdk-go-v2/service/route53resolver v1.36.0 // indirect - github.com/aws/aws-sdk-go-v2/service/rum v1.24.4 // indirect - github.com/aws/aws-sdk-go-v2/service/s3 v1.83.0 // indirect - github.com/aws/aws-sdk-go-v2/service/s3control v1.60.0 // indirect - github.com/aws/aws-sdk-go-v2/service/s3outposts v1.29.4 // indirect - github.com/aws/aws-sdk-go-v2/service/s3tables v1.5.0 // indirect - github.com/aws/aws-sdk-go-v2/service/sagemaker v1.200.1 // indirect - github.com/aws/aws-sdk-go-v2/service/scheduler v1.13.10 // indirect - github.com/aws/aws-sdk-go-v2/service/schemas v1.29.5 // indirect - github.com/aws/aws-sdk-go-v2/service/secretsmanager v1.35.7 // indirect - github.com/aws/aws-sdk-go-v2/service/securityhub v1.58.0 // indirect - github.com/aws/aws-sdk-go-v2/service/securitylake v1.20.5 // indirect - github.com/aws/aws-sdk-go-v2/service/serverlessapplicationrepository v1.25.4 // indirect - github.com/aws/aws-sdk-go-v2/service/servicecatalog v1.34.2 // indirect - github.com/aws/aws-sdk-go-v2/service/servicecatalogappregistry v1.31.4 // indirect - github.com/aws/aws-sdk-go-v2/service/servicediscovery v1.35.7 // indirect - github.com/aws/aws-sdk-go-v2/service/servicequotas v1.28.3 // indirect - github.com/aws/aws-sdk-go-v2/service/ses v1.30.5 // indirect - github.com/aws/aws-sdk-go-v2/service/sesv2 v1.46.0 // indirect - github.com/aws/aws-sdk-go-v2/service/sfn v1.35.7 // indirect - github.com/aws/aws-sdk-go-v2/service/shield v1.30.4 // indirect - github.com/aws/aws-sdk-go-v2/service/signer v1.27.4 // indirect - github.com/aws/aws-sdk-go-v2/service/sns v1.34.7 // indirect - github.com/aws/aws-sdk-go-v2/service/sqs v1.38.8 // indirect - github.com/aws/aws-sdk-go-v2/service/ssm v1.60.0 // indirect - github.com/aws/aws-sdk-go-v2/service/ssmcontacts v1.27.4 // indirect - github.com/aws/aws-sdk-go-v2/service/ssmincidents v1.35.4 // indirect - github.com/aws/aws-sdk-go-v2/service/ssmquicksetup v1.4.4 // indirect - github.com/aws/aws-sdk-go-v2/service/ssmsap v1.20.4 // indirect - github.com/aws/aws-sdk-go-v2/service/sso v1.25.5 // indirect - github.com/aws/aws-sdk-go-v2/service/ssoadmin v1.31.2 // indirect - github.com/aws/aws-sdk-go-v2/service/ssooidc v1.30.3 // indirect - github.com/aws/aws-sdk-go-v2/service/storagegateway v1.38.0 // indirect - github.com/aws/aws-sdk-go-v2/service/sts v1.34.0 // indirect - github.com/aws/aws-sdk-go-v2/service/swf v1.28.6 // indirect - github.com/aws/aws-sdk-go-v2/service/synthetics v1.35.3 // indirect - github.com/aws/aws-sdk-go-v2/service/taxsettings v1.12.2 // indirect - github.com/aws/aws-sdk-go-v2/service/timestreaminfluxdb v1.10.5 // indirect - github.com/aws/aws-sdk-go-v2/service/timestreamquery v1.31.2 // indirect - github.com/aws/aws-sdk-go-v2/service/timestreamwrite v1.31.2 // indirect - github.com/aws/aws-sdk-go-v2/service/transcribe v1.47.0 // indirect - github.com/aws/aws-sdk-go-v2/service/transfer v1.61.0 // indirect - github.com/aws/aws-sdk-go-v2/service/verifiedpermissions v1.24.2 // indirect - github.com/aws/aws-sdk-go-v2/service/vpclattice v1.14.4 // indirect - github.com/aws/aws-sdk-go-v2/service/waf v1.26.4 // indirect - github.com/aws/aws-sdk-go-v2/service/wafregional v1.26.4 // indirect - github.com/aws/aws-sdk-go-v2/service/wafv2 v1.63.1 // indirect - github.com/aws/aws-sdk-go-v2/service/wellarchitected v1.35.4 // indirect - github.com/aws/aws-sdk-go-v2/service/workspaces v1.58.0 // indirect - github.com/aws/aws-sdk-go-v2/service/workspacesweb v1.27.4 // indirect - github.com/aws/aws-sdk-go-v2/service/xray v1.31.7 // indirect - github.com/aws/smithy-go v1.22.4 // indirect - github.com/beevik/etree v1.5.1 // indirect + github.com/aws/aws-sdk-go-v2/internal/v4a v1.4.6 // indirect + github.com/aws/aws-sdk-go-v2/service/accessanalyzer v1.44.2 // indirect + github.com/aws/aws-sdk-go-v2/service/account v1.28.2 // indirect + github.com/aws/aws-sdk-go-v2/service/acm v1.37.2 // indirect + github.com/aws/aws-sdk-go-v2/service/acmpca v1.44.1 // indirect + github.com/aws/aws-sdk-go-v2/service/amp v1.39.2 // indirect + github.com/aws/aws-sdk-go-v2/service/amplify v1.37.1 // indirect + github.com/aws/aws-sdk-go-v2/service/apigateway v1.35.2 // indirect + github.com/aws/aws-sdk-go-v2/service/apigatewayv2 v1.32.2 // indirect + github.com/aws/aws-sdk-go-v2/service/appconfig v1.42.2 // indirect + github.com/aws/aws-sdk-go-v2/service/appfabric v1.16.2 // indirect + github.com/aws/aws-sdk-go-v2/service/appflow v1.50.2 // indirect + github.com/aws/aws-sdk-go-v2/service/appintegrations v1.36.2 // indirect + github.com/aws/aws-sdk-go-v2/service/applicationautoscaling v1.40.1 // indirect + github.com/aws/aws-sdk-go-v2/service/applicationinsights v1.34.1 // indirect + github.com/aws/aws-sdk-go-v2/service/applicationsignals v1.15.4 // indirect + github.com/aws/aws-sdk-go-v2/service/appmesh v1.34.2 // indirect + github.com/aws/aws-sdk-go-v2/service/apprunner v1.38.3 // indirect + github.com/aws/aws-sdk-go-v2/service/appstream v1.49.2 // indirect + github.com/aws/aws-sdk-go-v2/service/appsync v1.51.2 // indirect + github.com/aws/aws-sdk-go-v2/service/arcregionswitch v1.2.4 // indirect + github.com/aws/aws-sdk-go-v2/service/athena v1.55.2 // indirect + github.com/aws/aws-sdk-go-v2/service/auditmanager v1.45.2 // indirect + github.com/aws/aws-sdk-go-v2/service/autoscaling v1.58.2 // indirect + github.com/aws/aws-sdk-go-v2/service/autoscalingplans v1.29.1 // indirect + github.com/aws/aws-sdk-go-v2/service/backup v1.47.2 // indirect + github.com/aws/aws-sdk-go-v2/service/batch v1.57.5 // indirect + github.com/aws/aws-sdk-go-v2/service/bcmdataexports v1.11.4 // indirect + github.com/aws/aws-sdk-go-v2/service/bedrock v1.45.2 // indirect + github.com/aws/aws-sdk-go-v2/service/bedrockagent v1.50.2 // indirect + github.com/aws/aws-sdk-go-v2/service/bedrockagentcorecontrol v1.4.2 // indirect + github.com/aws/aws-sdk-go-v2/service/billing v1.7.3 // indirect + github.com/aws/aws-sdk-go-v2/service/budgets v1.37.3 // indirect + github.com/aws/aws-sdk-go-v2/service/chatbot v1.14.2 // indirect + github.com/aws/aws-sdk-go-v2/service/chime v1.40.1 // indirect + github.com/aws/aws-sdk-go-v2/service/chimesdkmediapipelines v1.26.2 // indirect + github.com/aws/aws-sdk-go-v2/service/chimesdkvoice v1.26.1 // indirect + github.com/aws/aws-sdk-go-v2/service/cleanrooms v1.31.2 // indirect + github.com/aws/aws-sdk-go-v2/service/cloud9 v1.33.1 // indirect + github.com/aws/aws-sdk-go-v2/service/cloudcontrol v1.28.2 // indirect + github.com/aws/aws-sdk-go-v2/service/cloudformation v1.65.2 // indirect + github.com/aws/aws-sdk-go-v2/service/cloudfront v1.53.2 // indirect + github.com/aws/aws-sdk-go-v2/service/cloudfrontkeyvaluestore v1.12.4 // indirect + github.com/aws/aws-sdk-go-v2/service/cloudhsmv2 v1.34.1 // indirect + github.com/aws/aws-sdk-go-v2/service/cloudsearch v1.31.2 // indirect + github.com/aws/aws-sdk-go-v2/service/cloudtrail v1.53.2 // indirect + github.com/aws/aws-sdk-go-v2/service/cloudwatch v1.49.2 // indirect + github.com/aws/aws-sdk-go-v2/service/cloudwatchlogs v1.57.2 // indirect + github.com/aws/aws-sdk-go-v2/service/codeartifact v1.38.2 // indirect + github.com/aws/aws-sdk-go-v2/service/codebuild v1.67.1 // indirect + github.com/aws/aws-sdk-go-v2/service/codecatalyst v1.20.4 // indirect + github.com/aws/aws-sdk-go-v2/service/codecommit v1.32.2 // indirect + github.com/aws/aws-sdk-go-v2/service/codeconnections v1.10.1 // indirect + github.com/aws/aws-sdk-go-v2/service/codedeploy v1.34.1 // indirect + github.com/aws/aws-sdk-go-v2/service/codeguruprofiler v1.29.1 // indirect + github.com/aws/aws-sdk-go-v2/service/codegurureviewer v1.34.1 // indirect + github.com/aws/aws-sdk-go-v2/service/codepipeline v1.46.2 // indirect + github.com/aws/aws-sdk-go-v2/service/codestarconnections v1.34.2 // indirect + github.com/aws/aws-sdk-go-v2/service/codestarnotifications v1.31.2 // indirect + github.com/aws/aws-sdk-go-v2/service/cognitoidentity v1.33.2 // indirect + github.com/aws/aws-sdk-go-v2/service/cognitoidentityprovider v1.57.3 // indirect + github.com/aws/aws-sdk-go-v2/service/comprehend v1.40.2 // indirect + github.com/aws/aws-sdk-go-v2/service/computeoptimizer v1.47.1 // indirect + github.com/aws/aws-sdk-go-v2/service/configservice v1.57.2 // indirect + github.com/aws/aws-sdk-go-v2/service/connect v1.138.1 // indirect + github.com/aws/aws-sdk-go-v2/service/connectcases v1.30.2 // indirect + github.com/aws/aws-sdk-go-v2/service/controltower v1.26.2 // indirect + github.com/aws/aws-sdk-go-v2/service/costandusagereportservice v1.33.2 // indirect + github.com/aws/aws-sdk-go-v2/service/costexplorer v1.55.3 // indirect + github.com/aws/aws-sdk-go-v2/service/costoptimizationhub v1.20.2 // indirect + github.com/aws/aws-sdk-go-v2/service/customerprofiles v1.52.2 // indirect + github.com/aws/aws-sdk-go-v2/service/databasemigrationservice v1.57.2 // indirect + github.com/aws/aws-sdk-go-v2/service/databrew v1.38.1 // indirect + github.com/aws/aws-sdk-go-v2/service/dataexchange v1.39.2 // indirect + github.com/aws/aws-sdk-go-v2/service/datapipeline v1.30.1 // indirect + github.com/aws/aws-sdk-go-v2/service/datasync v1.54.2 // indirect + github.com/aws/aws-sdk-go-v2/service/datazone v1.39.2 // indirect + github.com/aws/aws-sdk-go-v2/service/dax v1.28.2 // indirect + github.com/aws/aws-sdk-go-v2/service/detective v1.37.3 // indirect + github.com/aws/aws-sdk-go-v2/service/devicefarm v1.35.2 // indirect + github.com/aws/aws-sdk-go-v2/service/devopsguru v1.39.2 // indirect + github.com/aws/aws-sdk-go-v2/service/directconnect v1.37.2 // indirect + github.com/aws/aws-sdk-go-v2/service/directoryservice v1.37.1 // indirect + github.com/aws/aws-sdk-go-v2/service/dlm v1.34.2 // indirect + github.com/aws/aws-sdk-go-v2/service/docdb v1.46.2 // indirect + github.com/aws/aws-sdk-go-v2/service/docdbelastic v1.19.2 // indirect + github.com/aws/aws-sdk-go-v2/service/drs v1.35.2 // indirect + github.com/aws/aws-sdk-go-v2/service/dsql v1.9.4 // indirect + github.com/aws/aws-sdk-go-v2/service/dynamodb v1.50.1 // indirect + github.com/aws/aws-sdk-go-v2/service/ec2 v1.250.0 // indirect + github.com/aws/aws-sdk-go-v2/service/ecr v1.50.1 // indirect + github.com/aws/aws-sdk-go-v2/service/ecrpublic v1.37.2 // indirect + github.com/aws/aws-sdk-go-v2/service/ecs v1.63.4 // indirect + github.com/aws/aws-sdk-go-v2/service/efs v1.40.3 // indirect + github.com/aws/aws-sdk-go-v2/service/eks v1.73.1 // indirect + github.com/aws/aws-sdk-go-v2/service/elasticache v1.50.1 // indirect + github.com/aws/aws-sdk-go-v2/service/elasticbeanstalk v1.33.3 // indirect + github.com/aws/aws-sdk-go-v2/service/elasticloadbalancing v1.33.2 // indirect + github.com/aws/aws-sdk-go-v2/service/elasticloadbalancingv2 v1.50.2 // indirect + github.com/aws/aws-sdk-go-v2/service/elasticsearchservice v1.37.2 // indirect + github.com/aws/aws-sdk-go-v2/service/elastictranscoder v1.32.2 // indirect + github.com/aws/aws-sdk-go-v2/service/emr v1.54.1 // indirect + github.com/aws/aws-sdk-go-v2/service/emrcontainers v1.39.2 // indirect + github.com/aws/aws-sdk-go-v2/service/emrserverless v1.36.2 // indirect + github.com/aws/aws-sdk-go-v2/service/eventbridge v1.45.1 // indirect + github.com/aws/aws-sdk-go-v2/service/evidently v1.28.1 // indirect + github.com/aws/aws-sdk-go-v2/service/evs v1.4.2 // indirect + github.com/aws/aws-sdk-go-v2/service/finspace v1.33.2 // indirect + github.com/aws/aws-sdk-go-v2/service/firehose v1.41.2 // indirect + github.com/aws/aws-sdk-go-v2/service/fis v1.37.1 // indirect + github.com/aws/aws-sdk-go-v2/service/fms v1.44.1 // indirect + github.com/aws/aws-sdk-go-v2/service/fsx v1.61.2 // indirect + github.com/aws/aws-sdk-go-v2/service/gamelift v1.46.2 // indirect + github.com/aws/aws-sdk-go-v2/service/glacier v1.31.2 // indirect + github.com/aws/aws-sdk-go-v2/service/globalaccelerator v1.34.2 // indirect + github.com/aws/aws-sdk-go-v2/service/glue v1.128.1 // indirect + github.com/aws/aws-sdk-go-v2/service/grafana v1.31.2 // indirect + github.com/aws/aws-sdk-go-v2/service/greengrass v1.32.2 // indirect + github.com/aws/aws-sdk-go-v2/service/groundstation v1.37.2 // indirect + github.com/aws/aws-sdk-go-v2/service/guardduty v1.63.2 // indirect + github.com/aws/aws-sdk-go-v2/service/healthlake v1.35.1 // indirect + github.com/aws/aws-sdk-go-v2/service/iam v1.47.3 // indirect + github.com/aws/aws-sdk-go-v2/service/identitystore v1.32.2 // indirect + github.com/aws/aws-sdk-go-v2/service/imagebuilder v1.46.2 // indirect + github.com/aws/aws-sdk-go-v2/service/inspector v1.30.1 // indirect + github.com/aws/aws-sdk-go-v2/service/inspector2 v1.44.2 // indirect + github.com/aws/aws-sdk-go-v2/service/internal/accept-encoding v1.13.1 // indirect + github.com/aws/aws-sdk-go-v2/service/internal/checksum v1.8.6 // indirect + github.com/aws/aws-sdk-go-v2/service/internal/endpoint-discovery v1.11.6 // indirect + github.com/aws/aws-sdk-go-v2/service/internal/presigned-url v1.13.6 // indirect + github.com/aws/aws-sdk-go-v2/service/internal/s3shared v1.19.6 // indirect + github.com/aws/aws-sdk-go-v2/service/internetmonitor v1.25.1 // indirect + github.com/aws/aws-sdk-go-v2/service/invoicing v1.6.4 // indirect + github.com/aws/aws-sdk-go-v2/service/iot v1.69.1 // indirect + github.com/aws/aws-sdk-go-v2/service/ivs v1.47.2 // indirect + github.com/aws/aws-sdk-go-v2/service/ivschat v1.21.1 // indirect + github.com/aws/aws-sdk-go-v2/service/kafka v1.43.2 // indirect + github.com/aws/aws-sdk-go-v2/service/kafkaconnect v1.27.1 // indirect + github.com/aws/aws-sdk-go-v2/service/kendra v1.60.2 // indirect + github.com/aws/aws-sdk-go-v2/service/keyspaces v1.23.2 // indirect + github.com/aws/aws-sdk-go-v2/service/kinesis v1.40.1 // indirect + github.com/aws/aws-sdk-go-v2/service/kinesisanalytics v1.30.2 // indirect + github.com/aws/aws-sdk-go-v2/service/kinesisanalyticsv2 v1.36.3 // indirect + github.com/aws/aws-sdk-go-v2/service/kinesisvideo v1.32.1 // indirect + github.com/aws/aws-sdk-go-v2/service/kms v1.45.1 // indirect + github.com/aws/aws-sdk-go-v2/service/lakeformation v1.45.1 // indirect + github.com/aws/aws-sdk-go-v2/service/lambda v1.77.2 // indirect + github.com/aws/aws-sdk-go-v2/service/launchwizard v1.13.2 // indirect + github.com/aws/aws-sdk-go-v2/service/lexmodelbuildingservice v1.33.1 // indirect + github.com/aws/aws-sdk-go-v2/service/lexmodelsv2 v1.56.2 // indirect + github.com/aws/aws-sdk-go-v2/service/licensemanager v1.36.2 // indirect + github.com/aws/aws-sdk-go-v2/service/lightsail v1.48.2 // indirect + github.com/aws/aws-sdk-go-v2/service/location v1.49.2 // indirect + github.com/aws/aws-sdk-go-v2/service/lookoutmetrics v1.36.2 // indirect + github.com/aws/aws-sdk-go-v2/service/m2 v1.25.2 // indirect + github.com/aws/aws-sdk-go-v2/service/macie2 v1.49.2 // indirect + github.com/aws/aws-sdk-go-v2/service/mediaconnect v1.44.2 // indirect + github.com/aws/aws-sdk-go-v2/service/mediaconvert v1.82.2 // indirect + github.com/aws/aws-sdk-go-v2/service/medialive v1.81.2 // indirect + github.com/aws/aws-sdk-go-v2/service/mediapackage v1.39.2 // indirect + github.com/aws/aws-sdk-go-v2/service/mediapackagev2 v1.30.2 // indirect + github.com/aws/aws-sdk-go-v2/service/mediapackagevod v1.39.2 // indirect + github.com/aws/aws-sdk-go-v2/service/mediastore v1.29.2 // indirect + github.com/aws/aws-sdk-go-v2/service/memorydb v1.31.2 // indirect + github.com/aws/aws-sdk-go-v2/service/mgn v1.37.1 // indirect + github.com/aws/aws-sdk-go-v2/service/mq v1.33.2 // indirect + github.com/aws/aws-sdk-go-v2/service/mwaa v1.39.2 // indirect + github.com/aws/aws-sdk-go-v2/service/neptune v1.42.0 // indirect + github.com/aws/aws-sdk-go-v2/service/neptunegraph v1.21.1 // indirect + github.com/aws/aws-sdk-go-v2/service/networkfirewall v1.55.1 // indirect + github.com/aws/aws-sdk-go-v2/service/networkmanager v1.39.3 // indirect + github.com/aws/aws-sdk-go-v2/service/networkmonitor v1.12.2 // indirect + github.com/aws/aws-sdk-go-v2/service/notifications v1.7.0 // indirect + github.com/aws/aws-sdk-go-v2/service/notificationscontacts v1.5.4 // indirect + github.com/aws/aws-sdk-go-v2/service/oam v1.22.1 // indirect + github.com/aws/aws-sdk-go-v2/service/odb v1.4.2 // indirect + github.com/aws/aws-sdk-go-v2/service/opensearch v1.52.1 // indirect + github.com/aws/aws-sdk-go-v2/service/opensearchserverless v1.25.2 // indirect + github.com/aws/aws-sdk-go-v2/service/organizations v1.44.2 // indirect + github.com/aws/aws-sdk-go-v2/service/osis v1.19.1 // indirect + github.com/aws/aws-sdk-go-v2/service/outposts v1.56.2 // indirect + github.com/aws/aws-sdk-go-v2/service/paymentcryptography v1.23.2 // indirect + github.com/aws/aws-sdk-go-v2/service/pcaconnectorad v1.15.2 // indirect + github.com/aws/aws-sdk-go-v2/service/pcs v1.12.1 // indirect + github.com/aws/aws-sdk-go-v2/service/pinpoint v1.39.2 // indirect + github.com/aws/aws-sdk-go-v2/service/pinpointsmsvoicev2 v1.25.1 // indirect + github.com/aws/aws-sdk-go-v2/service/pipes v1.23.1 // indirect + github.com/aws/aws-sdk-go-v2/service/polly v1.53.2 // indirect + github.com/aws/aws-sdk-go-v2/service/pricing v1.39.2 // indirect + github.com/aws/aws-sdk-go-v2/service/qbusiness v1.33.2 // indirect + github.com/aws/aws-sdk-go-v2/service/qldb v1.30.2 // indirect + github.com/aws/aws-sdk-go-v2/service/quicksight v1.93.2 // indirect + github.com/aws/aws-sdk-go-v2/service/ram v1.34.2 // indirect + github.com/aws/aws-sdk-go-v2/service/rbin v1.26.2 // indirect + github.com/aws/aws-sdk-go-v2/service/rds v1.104.1 // indirect + github.com/aws/aws-sdk-go-v2/service/redshift v1.58.1 // indirect + github.com/aws/aws-sdk-go-v2/service/redshiftdata v1.37.2 // indirect + github.com/aws/aws-sdk-go-v2/service/redshiftserverless v1.31.2 // indirect + github.com/aws/aws-sdk-go-v2/service/rekognition v1.51.1 // indirect + github.com/aws/aws-sdk-go-v2/service/resiliencehub v1.34.2 // indirect + github.com/aws/aws-sdk-go-v2/service/resourceexplorer2 v1.21.2 // indirect + github.com/aws/aws-sdk-go-v2/service/resourcegroups v1.33.3 // indirect + github.com/aws/aws-sdk-go-v2/service/resourcegroupstaggingapi v1.30.2 // indirect + github.com/aws/aws-sdk-go-v2/service/rolesanywhere v1.21.2 // indirect + github.com/aws/aws-sdk-go-v2/service/route53 v1.57.2 // indirect + github.com/aws/aws-sdk-go-v2/service/route53domains v1.33.1 // indirect + github.com/aws/aws-sdk-go-v2/service/route53profiles v1.9.2 // indirect + github.com/aws/aws-sdk-go-v2/service/route53recoverycontrolconfig v1.31.3 // indirect + github.com/aws/aws-sdk-go-v2/service/route53recoveryreadiness v1.26.2 // indirect + github.com/aws/aws-sdk-go-v2/service/route53resolver v1.40.2 // indirect + github.com/aws/aws-sdk-go-v2/service/rum v1.28.3 // indirect + github.com/aws/aws-sdk-go-v2/service/s3 v1.87.3 // indirect + github.com/aws/aws-sdk-go-v2/service/s3control v1.65.4 // indirect + github.com/aws/aws-sdk-go-v2/service/s3outposts v1.33.2 // indirect + github.com/aws/aws-sdk-go-v2/service/s3tables v1.10.1 // indirect + github.com/aws/aws-sdk-go-v2/service/s3vectors v1.4.4 // indirect + github.com/aws/aws-sdk-go-v2/service/sagemaker v1.213.1 // indirect + github.com/aws/aws-sdk-go-v2/service/scheduler v1.17.1 // indirect + github.com/aws/aws-sdk-go-v2/service/schemas v1.33.1 // indirect + github.com/aws/aws-sdk-go-v2/service/secretsmanager v1.39.2 // indirect + github.com/aws/aws-sdk-go-v2/service/securityhub v1.63.2 // indirect + github.com/aws/aws-sdk-go-v2/service/securitylake v1.24.2 // indirect + github.com/aws/aws-sdk-go-v2/service/serverlessapplicationrepository v1.29.2 // indirect + github.com/aws/aws-sdk-go-v2/service/servicecatalog v1.38.2 // indirect + github.com/aws/aws-sdk-go-v2/service/servicecatalogappregistry v1.35.2 // indirect + github.com/aws/aws-sdk-go-v2/service/servicediscovery v1.39.5 // indirect + github.com/aws/aws-sdk-go-v2/service/servicequotas v1.32.1 // indirect + github.com/aws/aws-sdk-go-v2/service/ses v1.34.1 // indirect + github.com/aws/aws-sdk-go-v2/service/sesv2 v1.53.1 // indirect + github.com/aws/aws-sdk-go-v2/service/sfn v1.39.2 // indirect + github.com/aws/aws-sdk-go-v2/service/shield v1.34.2 // indirect + github.com/aws/aws-sdk-go-v2/service/signer v1.31.2 // indirect + github.com/aws/aws-sdk-go-v2/service/sns v1.38.1 // indirect + github.com/aws/aws-sdk-go-v2/service/sqs v1.42.3 // indirect + github.com/aws/aws-sdk-go-v2/service/ssm v1.64.2 // indirect + github.com/aws/aws-sdk-go-v2/service/ssmcontacts v1.30.4 // indirect + github.com/aws/aws-sdk-go-v2/service/ssmincidents v1.39.1 // indirect + github.com/aws/aws-sdk-go-v2/service/ssmquicksetup v1.8.2 // indirect + github.com/aws/aws-sdk-go-v2/service/ssmsap v1.25.1 // indirect + github.com/aws/aws-sdk-go-v2/service/sso v1.29.1 // indirect + github.com/aws/aws-sdk-go-v2/service/ssoadmin v1.35.2 // indirect + github.com/aws/aws-sdk-go-v2/service/ssooidc v1.34.2 // indirect + github.com/aws/aws-sdk-go-v2/service/storagegateway v1.42.2 // indirect + github.com/aws/aws-sdk-go-v2/service/sts v1.38.2 // indirect + github.com/aws/aws-sdk-go-v2/service/swf v1.32.1 // indirect + github.com/aws/aws-sdk-go-v2/service/synthetics v1.40.2 // indirect + github.com/aws/aws-sdk-go-v2/service/taxsettings v1.16.2 // indirect + github.com/aws/aws-sdk-go-v2/service/timestreaminfluxdb v1.16.2 // indirect + github.com/aws/aws-sdk-go-v2/service/timestreamquery v1.35.1 // indirect + github.com/aws/aws-sdk-go-v2/service/timestreamwrite v1.35.1 // indirect + github.com/aws/aws-sdk-go-v2/service/transcribe v1.52.2 // indirect + github.com/aws/aws-sdk-go-v2/service/transfer v1.65.2 // indirect + github.com/aws/aws-sdk-go-v2/service/verifiedpermissions v1.28.3 // indirect + github.com/aws/aws-sdk-go-v2/service/vpclattice v1.18.1 // indirect + github.com/aws/aws-sdk-go-v2/service/waf v1.30.1 // indirect + github.com/aws/aws-sdk-go-v2/service/wafregional v1.30.2 // indirect + github.com/aws/aws-sdk-go-v2/service/wafv2 v1.67.2 // indirect + github.com/aws/aws-sdk-go-v2/service/wellarchitected v1.39.2 // indirect + github.com/aws/aws-sdk-go-v2/service/workmail v1.36.0 // indirect + github.com/aws/aws-sdk-go-v2/service/workspaces v1.63.2 // indirect + github.com/aws/aws-sdk-go-v2/service/workspacesweb v1.32.2 // indirect + github.com/aws/aws-sdk-go-v2/service/xray v1.36.0 // indirect + github.com/aws/smithy-go v1.23.0 // indirect + github.com/beevik/etree v1.6.0 // indirect github.com/bgentry/speakeasy v0.1.0 // indirect - github.com/cedar-policy/cedar-go v0.1.0 // indirect + github.com/cedar-policy/cedar-go v1.2.6 // indirect github.com/cloudflare/circl v1.6.1 // indirect github.com/davecgh/go-spew v1.1.1 // indirect github.com/fatih/color v1.18.0 // indirect github.com/gertd/go-pluralize v0.2.1 // indirect - github.com/go-logr/logr v1.4.2 // indirect + github.com/go-logr/logr v1.4.3 // indirect github.com/go-logr/stdr v1.2.2 // indirect + github.com/goccy/go-yaml v1.18.0 // indirect github.com/golang/protobuf v1.5.4 // indirect github.com/google/go-cmp v0.7.0 // indirect github.com/google/uuid v1.6.0 // indirect github.com/hashicorp/aws-cloudformation-resource-schema-sdk-go v0.23.0 // indirect - github.com/hashicorp/aws-sdk-go-base/v2 v2.0.0-beta.65 // indirect + github.com/hashicorp/aws-sdk-go-base/v2 v2.0.0-beta.66 // indirect github.com/hashicorp/awspolicyequivalence v1.7.0 // indirect github.com/hashicorp/cli v1.1.7 // indirect github.com/hashicorp/errwrap v1.1.0 // indirect @@ -315,16 +321,15 @@ require ( github.com/hashicorp/hcl/v2 v2.23.0 // indirect github.com/hashicorp/logutils v1.0.0 // indirect github.com/hashicorp/terraform-exec v0.23.0 // indirect - github.com/hashicorp/terraform-json v0.25.0 // indirect - github.com/hashicorp/terraform-plugin-framework v1.15.0 // indirect + github.com/hashicorp/terraform-json v0.26.0 // indirect + github.com/hashicorp/terraform-plugin-framework v1.15.1 // indirect github.com/hashicorp/terraform-plugin-framework-jsontypes v0.2.0 // indirect github.com/hashicorp/terraform-plugin-framework-timeouts v0.5.0 // indirect github.com/hashicorp/terraform-plugin-framework-timetypes v0.5.0 // indirect github.com/hashicorp/terraform-plugin-framework-validators v0.18.0 // indirect github.com/hashicorp/terraform-plugin-go v0.28.0 // indirect github.com/hashicorp/terraform-plugin-log v0.9.0 // indirect - github.com/hashicorp/terraform-plugin-mux v0.20.0 // indirect - github.com/hashicorp/terraform-plugin-testing v1.13.2 // indirect + github.com/hashicorp/terraform-plugin-testing v1.13.3 // indirect github.com/hashicorp/terraform-registry-address v0.2.5 // indirect github.com/hashicorp/terraform-svchost v0.1.1 // indirect github.com/hashicorp/yamux v0.1.1 // indirect @@ -337,7 +342,7 @@ require ( github.com/mitchellh/copystructure v1.2.0 // indirect github.com/mitchellh/go-homedir v1.1.0 // indirect github.com/mitchellh/go-testing-interface v1.14.1 // indirect - github.com/mitchellh/go-wordwrap v1.0.0 // indirect + github.com/mitchellh/go-wordwrap v1.0.1 // indirect github.com/mitchellh/mapstructure v1.5.0 // indirect github.com/mitchellh/reflectwalk v1.0.2 // indirect github.com/oklog/run v1.0.0 // indirect @@ -353,23 +358,23 @@ require ( github.com/xeipuuv/gojsonschema v1.2.0 // indirect github.com/zclconf/go-cty v1.16.3 // indirect go.opentelemetry.io/auto/sdk v1.1.0 // indirect - go.opentelemetry.io/contrib/instrumentation/github.com/aws/aws-sdk-go-v2/otelaws v0.61.0 // indirect - go.opentelemetry.io/otel v1.36.0 // indirect - go.opentelemetry.io/otel/metric v1.36.0 // indirect - go.opentelemetry.io/otel/trace v1.36.0 // indirect - golang.org/x/crypto v0.39.0 // indirect - golang.org/x/mod v0.25.0 // indirect - golang.org/x/net v0.41.0 // indirect + go.opentelemetry.io/contrib/instrumentation/github.com/aws/aws-sdk-go-v2/otelaws v0.63.0 // indirect + go.opentelemetry.io/otel v1.38.0 // indirect + go.opentelemetry.io/otel/metric v1.38.0 // indirect + go.opentelemetry.io/otel/trace v1.38.0 // indirect + golang.org/x/crypto v0.41.0 // indirect + golang.org/x/exp v0.0.0-20240222234643-814bf88cf225 // indirect + golang.org/x/mod v0.27.0 // indirect + golang.org/x/net v0.43.0 // indirect golang.org/x/sync v0.16.0 // indirect - golang.org/x/sys v0.33.0 // indirect - golang.org/x/text v0.27.0 // indirect - golang.org/x/tools v0.34.0 // indirect + golang.org/x/sys v0.35.0 // indirect + golang.org/x/text v0.28.0 // indirect + golang.org/x/tools v0.36.0 // indirect google.golang.org/appengine v1.6.8 // indirect - google.golang.org/genproto/googleapis/rpc v0.0.0-20250218202821-56aae31c358a // indirect + google.golang.org/genproto/googleapis/rpc v0.0.0-20250505200425-f936aa4a68b2 // indirect google.golang.org/grpc v1.72.1 // indirect google.golang.org/protobuf v1.36.6 // indirect - gopkg.in/dnaeon/go-vcr.v4 v4.0.4 // indirect - gopkg.in/yaml.v3 v3.0.1 // indirect + gopkg.in/dnaeon/go-vcr.v4 v4.0.5 // indirect ) replace github.com/hashicorp/terraform-provider-aws => ../.. diff --git a/tools/tfsdk2fw/go.sum b/tools/tfsdk2fw/go.sum index 6be13a63a5e7..4505b8414514 100644 --- a/tools/tfsdk2fw/go.sum +++ b/tools/tfsdk2fw/go.sum @@ -14,557 +14,569 @@ github.com/YakDriver/go-version v0.1.0 h1:/x+Xg2+l89Mjtxl0VRf2+ue8cnHkw6jfYv49j6 github.com/YakDriver/go-version v0.1.0/go.mod h1:LXwFAp1E3KBhS7FHO/FE8r3XCmvKizs/VXXXFWfoSYY= github.com/YakDriver/regexache v0.24.0 h1:zUKaixelkswzdqsqPc2sveiV//Mi/msJn0teG8zBDiA= github.com/YakDriver/regexache v0.24.0/go.mod h1:awcd8uBj614F3ScW06JqlfSGqq2/7vdJHy+RiKzVC+g= -github.com/agext/levenshtein v1.2.2 h1:0S/Yg6LYmFJ5stwQeRp6EeOcCbj7xiqQSdNelsXvaqE= -github.com/agext/levenshtein v1.2.2/go.mod h1:JEDfjyjHDjOF/1e4FlBE/PkbqA9OfWu2ki2W0IB5558= +github.com/YakDriver/smarterr v0.6.0 h1:BFJ09GTAVcGfyzMUk7/yiS0rBEPXTzUxpP67bbyVLoo= +github.com/YakDriver/smarterr v0.6.0/go.mod h1:Sg1LUzBronueGfhn2yalB2iVMXl24TIGam/mS5cZh5c= +github.com/agext/levenshtein v1.2.3 h1:YB2fHEn0UJagG8T1rrWknE3ZQzWM06O8AMAatNn7lmo= +github.com/agext/levenshtein v1.2.3/go.mod h1:JEDfjyjHDjOF/1e4FlBE/PkbqA9OfWu2ki2W0IB5558= github.com/apparentlymart/go-textseg/v12 v12.0.0/go.mod h1:S/4uRK2UtaQttw1GenVJEynmyUenKwP++x/+DdGV/Ec= github.com/apparentlymart/go-textseg/v15 v15.0.0 h1:uYvfpb3DyLSCGWnctWKGj857c6ew1u1fNQOlOtuGxQY= github.com/apparentlymart/go-textseg/v15 v15.0.0/go.mod h1:K8XmNZdhEBkdlyDdvbmmsvpAG721bKi0joRfFdHIWJ4= github.com/armon/go-radix v1.0.0 h1:F4z6KzEeeQIMeLFa97iZU6vupzoecKdU5TX24SNppXI= github.com/armon/go-radix v1.0.0/go.mod h1:ufUuZ+zHj4x4TnLV4JWEpy2hxWSpsRywHrMgIH9cCH8= -github.com/aws/aws-sdk-go-v2 v1.36.5 h1:0OF9RiEMEdDdZEMqF9MRjevyxAQcf6gY+E7vwBILFj0= -github.com/aws/aws-sdk-go-v2 v1.36.5/go.mod h1:EYrzvCCN9CMUTa5+6lf6MM4tq3Zjp8UhSGR/cBsjai0= -github.com/aws/aws-sdk-go-v2/aws/protocol/eventstream v1.6.11 h1:12SpdwU8Djs+YGklkinSSlcrPyj3H4VifVsKf78KbwA= -github.com/aws/aws-sdk-go-v2/aws/protocol/eventstream v1.6.11/go.mod h1:dd+Lkp6YmMryke+qxW/VnKyhMBDTYP41Q2Bb+6gNZgY= -github.com/aws/aws-sdk-go-v2/config v1.29.17 h1:jSuiQ5jEe4SAMH6lLRMY9OVC+TqJLP5655pBGjmnjr0= -github.com/aws/aws-sdk-go-v2/config v1.29.17/go.mod h1:9P4wwACpbeXs9Pm9w1QTh6BwWwJjwYvJ1iCt5QbCXh8= -github.com/aws/aws-sdk-go-v2/credentials v1.17.70 h1:ONnH5CM16RTXRkS8Z1qg7/s2eDOhHhaXVd72mmyv4/0= -github.com/aws/aws-sdk-go-v2/credentials v1.17.70/go.mod h1:M+lWhhmomVGgtuPOhO85u4pEa3SmssPTdcYpP/5J/xc= -github.com/aws/aws-sdk-go-v2/feature/ec2/imds v1.16.32 h1:KAXP9JSHO1vKGCr5f4O6WmlVKLFFXgWYAGoJosorxzU= -github.com/aws/aws-sdk-go-v2/feature/ec2/imds v1.16.32/go.mod h1:h4Sg6FQdexC1yYG9RDnOvLbW1a/P986++/Y/a+GyEM8= -github.com/aws/aws-sdk-go-v2/feature/s3/manager v1.17.83 h1:08otkOELsIi0toRRGMytlJhOctcN8xfKfKFR2NXz3kE= -github.com/aws/aws-sdk-go-v2/feature/s3/manager v1.17.83/go.mod h1:dGsGb2wI8JDWeMAhjVPP+z+dqvYjL6k6o+EujcRNk5c= -github.com/aws/aws-sdk-go-v2/internal/configsources v1.3.36 h1:SsytQyTMHMDPspp+spo7XwXTP44aJZZAC7fBV2C5+5s= -github.com/aws/aws-sdk-go-v2/internal/configsources v1.3.36/go.mod h1:Q1lnJArKRXkenyog6+Y+zr7WDpk4e6XlR6gs20bbeNo= -github.com/aws/aws-sdk-go-v2/internal/endpoints/v2 v2.6.36 h1:i2vNHQiXUvKhs3quBR6aqlgJaiaexz/aNvdCktW/kAM= -github.com/aws/aws-sdk-go-v2/internal/endpoints/v2 v2.6.36/go.mod h1:UdyGa7Q91id/sdyHPwth+043HhmP6yP9MBHgbZM0xo8= +github.com/aws/aws-sdk-go-v2 v1.38.3 h1:B6cV4oxnMs45fql4yRH+/Po/YU+597zgWqvDpYMturk= +github.com/aws/aws-sdk-go-v2 v1.38.3/go.mod h1:sDioUELIUO9Znk23YVmIk86/9DOpkbyyVb1i/gUNFXY= +github.com/aws/aws-sdk-go-v2/aws/protocol/eventstream v1.7.1 h1:i8p8P4diljCr60PpJp6qZXNlgX4m2yQFpYk+9ZT+J4E= +github.com/aws/aws-sdk-go-v2/aws/protocol/eventstream v1.7.1/go.mod h1:ddqbooRZYNoJ2dsTwOty16rM+/Aqmk/GOXrK8cg7V00= +github.com/aws/aws-sdk-go-v2/config v1.31.6 h1:a1t8fXY4GT4xjyJExz4knbuoxSCacB5hT/WgtfPyLjo= +github.com/aws/aws-sdk-go-v2/config v1.31.6/go.mod h1:5ByscNi7R+ztvOGzeUaIu49vkMk2soq5NaH5PYe33MQ= +github.com/aws/aws-sdk-go-v2/credentials v1.18.10 h1:xdJnXCouCx8Y0NncgoptztUocIYLKeQxrCgN6x9sdhg= +github.com/aws/aws-sdk-go-v2/credentials v1.18.10/go.mod h1:7tQk08ntj914F/5i9jC4+2HQTAuJirq7m1vZVIhEkWs= +github.com/aws/aws-sdk-go-v2/feature/ec2/imds v1.18.6 h1:wbjnrrMnKew78/juW7I2BtKQwa1qlf6EjQgS69uYY14= +github.com/aws/aws-sdk-go-v2/feature/ec2/imds v1.18.6/go.mod h1:AtiqqNrDioJXuUgz3+3T0mBWN7Hro2n9wll2zRUc0ww= +github.com/aws/aws-sdk-go-v2/feature/s3/manager v1.19.4 h1:BTl+TXrpnrpPWb/J3527GsJ/lMkn7z3GO12j6OlsbRg= +github.com/aws/aws-sdk-go-v2/feature/s3/manager v1.19.4/go.mod h1:cG2tenc/fscpChiZE29a2crG9uo2t6nQGflFllFL8M8= +github.com/aws/aws-sdk-go-v2/internal/configsources v1.4.6 h1:uF68eJA6+S9iVr9WgX1NaRGyQ/6MdIyc4JNUo6TN1FA= +github.com/aws/aws-sdk-go-v2/internal/configsources v1.4.6/go.mod h1:qlPeVZCGPiobx8wb1ft0GHT5l+dc6ldnwInDFaMvC7Y= +github.com/aws/aws-sdk-go-v2/internal/endpoints/v2 v2.7.6 h1:pa1DEC6JoI0zduhZePp3zmhWvk/xxm4NB8Hy/Tlsgos= +github.com/aws/aws-sdk-go-v2/internal/endpoints/v2 v2.7.6/go.mod h1:gxEjPebnhWGJoaDdtDkA0JX46VRg1wcTHYe63OfX5pE= github.com/aws/aws-sdk-go-v2/internal/ini v1.8.3 h1:bIqFDwgGXXN1Kpp99pDOdKMTTb5d2KyU5X/BZxjOkRo= github.com/aws/aws-sdk-go-v2/internal/ini v1.8.3/go.mod h1:H5O/EsxDWyU+LP/V8i5sm8cxoZgc2fdNR9bxlOFrQTo= -github.com/aws/aws-sdk-go-v2/internal/v4a v1.3.36 h1:GMYy2EOWfzdP3wfVAGXBNKY5vK4K8vMET4sYOYltmqs= -github.com/aws/aws-sdk-go-v2/internal/v4a v1.3.36/go.mod h1:gDhdAV6wL3PmPqBhiPbnlS447GoWs8HTTOYef9/9Inw= -github.com/aws/aws-sdk-go-v2/service/accessanalyzer v1.40.0 h1:xYryxpwtCZxukhjSd0O26zT3CbGDlzoYFBWqY0DoK3A= -github.com/aws/aws-sdk-go-v2/service/accessanalyzer v1.40.0/go.mod h1:mwjv8LM1RN5WJNOPTKspM0AnCxFoTjMopGI19k0Hb4k= -github.com/aws/aws-sdk-go-v2/service/account v1.24.2 h1:1ItkqDExKIDsS8NoIBq7OxQOJnQNOVjC25CYa9RzOos= -github.com/aws/aws-sdk-go-v2/service/account v1.24.2/go.mod h1:NShtay87juyMTb3c6bHN6Bai5dUFmTX7NzURY4/Jyb0= -github.com/aws/aws-sdk-go-v2/service/acm v1.33.0 h1:Z3MHBWR1KiviwaAiG7MTPB6T5gLYRPhUECuKLgltCwA= -github.com/aws/aws-sdk-go-v2/service/acm v1.33.0/go.mod h1:t3jPqKBnySV3qsU40cj1TWleOYx5vyz1xBeZiplAVcs= -github.com/aws/aws-sdk-go-v2/service/acmpca v1.40.5 h1:wO4AWPJlnLRbLgQnrVKG/HTy9qDCxFVMjPFkqr2IKRA= -github.com/aws/aws-sdk-go-v2/service/acmpca v1.40.5/go.mod h1:Jhu06Hov5+oM1+zkhDGCZBp8yoVCSiFHSnkSC0KIzDs= -github.com/aws/aws-sdk-go-v2/service/amp v1.34.3 h1:xH65YCH77WzkxqdzDl6PfX2TaYK/8YiZwy6UqNkFkv4= -github.com/aws/aws-sdk-go-v2/service/amp v1.34.3/go.mod h1:SulhOciRP/ZvQQdU9cNuE9OAfnD7+itzfKPiyBx0I1I= -github.com/aws/aws-sdk-go-v2/service/amplify v1.33.3 h1:6rZkMM5S/fSnIP02Q/paqszlyp/kKNhl+hHV9WuuH7I= -github.com/aws/aws-sdk-go-v2/service/amplify v1.33.3/go.mod h1:Ir47WZbig8znnUdUx5YPxwjt92xXZSQKu2+Y+NjGzBM= -github.com/aws/aws-sdk-go-v2/service/apigateway v1.31.4 h1:XFKyI5HLJwV0HBKuUTIE19yaKHOvgZK/sDSj3HmE8dM= -github.com/aws/aws-sdk-go-v2/service/apigateway v1.31.4/go.mod h1:b7jjY+ZgE+CzV8iX9d2ose6aPKkpA7a7RIi9mHEFlqM= -github.com/aws/aws-sdk-go-v2/service/apigatewayv2 v1.28.4 h1:H4WoC79VAg7e5PrK6ta1ua7aNg5bj6JKrWRL45hAawA= -github.com/aws/aws-sdk-go-v2/service/apigatewayv2 v1.28.4/go.mod h1:NomAJQ/SaEj3KlzfxI4V8y3CJNv1Mr2ynTv7lbYePp0= -github.com/aws/aws-sdk-go-v2/service/appconfig v1.38.3 h1:tjAPEEHH7V7YX7fxdklhs9Vg9K8aXBosKutnRPrhYKY= -github.com/aws/aws-sdk-go-v2/service/appconfig v1.38.3/go.mod h1:NiWNkf2XdzzN6fWWwB6RtHqmT9SoFCXQJU9zg7tS5TE= -github.com/aws/aws-sdk-go-v2/service/appfabric v1.12.4 h1:NOpFPNcu8Ao3Sqk+zJ6R92Zv7MUQ4xed5aqrauFlOBs= -github.com/aws/aws-sdk-go-v2/service/appfabric v1.12.4/go.mod h1:wRubXIGmzEbl2uPpPX/BZ6Tm/BxCtkXhUirkj0Q1F+A= -github.com/aws/aws-sdk-go-v2/service/appflow v1.46.4 h1:7B2B/QGEXHG4ayH9CgmVd7z+pHQtNGHfVx0T0TyHBCs= -github.com/aws/aws-sdk-go-v2/service/appflow v1.46.4/go.mod h1:EmHkVIWbPmvl3mvSOo/TF0DjSGFZ8+Db7aKiqhM8XIc= -github.com/aws/aws-sdk-go-v2/service/appintegrations v1.31.4 h1:AWrTD+eNmKOU1J7KV8TS3w+B9ZYdl7eVBOegEeVGlyY= -github.com/aws/aws-sdk-go-v2/service/appintegrations v1.31.4/go.mod h1:lrw4VUA85885klz/SHqwyu0A2V70w9kOH3LZdEuskj8= -github.com/aws/aws-sdk-go-v2/service/applicationautoscaling v1.36.4 h1:JetyQYju/+q33qzbNAiuHVIX4zB/AX9nM65qD+eLKM8= -github.com/aws/aws-sdk-go-v2/service/applicationautoscaling v1.36.4/go.mod h1:T38DTrOzItEr+LJap6BHKrWN8wBrLP44+n/JY0wC2xI= -github.com/aws/aws-sdk-go-v2/service/applicationinsights v1.30.6 h1:wOKS3lH9adXnOPg4VJ0AQ56tmmcTO40WTgkHk1F9kJE= -github.com/aws/aws-sdk-go-v2/service/applicationinsights v1.30.6/go.mod h1:FEqLE3bBOwq2nE4NtVKUljFYcLTc6tVjYAOvDtWXKb4= -github.com/aws/aws-sdk-go-v2/service/applicationsignals v1.11.3 h1:qV6rPSVsIReOn1DTrvC0wi7rlG/IbQmEJQ//0DijU5A= -github.com/aws/aws-sdk-go-v2/service/applicationsignals v1.11.3/go.mod h1:EGKmN5VSpsjvJad12akh86dbFu/YoRa0qFiWzcPnXIk= -github.com/aws/aws-sdk-go-v2/service/appmesh v1.30.4 h1:1TT/4BO285m66cH5vOExvqvvaW/EpP4VngGw7xEvaGc= -github.com/aws/aws-sdk-go-v2/service/appmesh v1.30.4/go.mod h1:jFygkUlz2jEVPPQAq4OSqTTKjt20qx9N/5eR/gnyD7k= -github.com/aws/aws-sdk-go-v2/service/apprunner v1.34.2 h1:ZEkJkUCPdXrL3JOTpa3DuB879AtP5tNF/8i8415A8fY= -github.com/aws/aws-sdk-go-v2/service/apprunner v1.34.2/go.mod h1:p4kYzg6Gb1uqNc7m9/qB4aDycggCAv9mfFXX15S805U= -github.com/aws/aws-sdk-go-v2/service/appstream v1.45.5 h1:BuHTCRVfEACQ9YDVYHLiqEW7LWypFdcPAH07icAmgo0= -github.com/aws/aws-sdk-go-v2/service/appstream v1.45.5/go.mod h1:Kdkrr6TbMceLxOiRDJ6L1hdbv1/GuzGENPxylMzffcw= -github.com/aws/aws-sdk-go-v2/service/appsync v1.47.3 h1:Jc3/7ZWo4pjNhKp0B0WD4Av5QOMaJj6Xqzg0y0l6deA= -github.com/aws/aws-sdk-go-v2/service/appsync v1.47.3/go.mod h1:id62qP6jzhg3NWQ5zfBf12omt9Rm3yEcwI1rtj7+wbE= -github.com/aws/aws-sdk-go-v2/service/athena v1.51.3 h1:4X2/0GQiQBlAE9sGGKnouUI3yjtf9A/uTo7VPjD9/6c= -github.com/aws/aws-sdk-go-v2/service/athena v1.51.3/go.mod h1:q8KLas6BtgGYm695nQxAjFJvqRoj8Qcpig1291KQWok= -github.com/aws/aws-sdk-go-v2/service/auditmanager v1.39.2 h1:Pye3If+Jpe58EwCzH+CJZnqGK39w7nSAdBl+BNVv6qs= -github.com/aws/aws-sdk-go-v2/service/auditmanager v1.39.2/go.mod h1:zfdQum9cKCPEWF8g8CXfJgFZXJ/+QbvhXvesWOm9WnE= -github.com/aws/aws-sdk-go-v2/service/autoscaling v1.54.0 h1:0BmpSm5x2rpB9D2K2OAoOc1cZTUJpw1OiQj86ZT8RTg= -github.com/aws/aws-sdk-go-v2/service/autoscaling v1.54.0/go.mod h1:6U/Xm5bBkZGCTxH3NE9+hPKEpCFCothGn/gwytsr1Mk= -github.com/aws/aws-sdk-go-v2/service/autoscalingplans v1.25.4 h1:V//LfMnazbS3Zh1O7rWL3v92yQW0kBpIXlkKGEV1Fmw= -github.com/aws/aws-sdk-go-v2/service/autoscalingplans v1.25.4/go.mod h1:jUiTKxG/so4swtdvfxlKgdEESCAZ1RDWIfyn3DrUVMk= -github.com/aws/aws-sdk-go-v2/service/backup v1.43.1 h1:IWL4JnLGXSFE094fHbveF/Lm+zYgBdoD0zBelyKRKII= -github.com/aws/aws-sdk-go-v2/service/backup v1.43.1/go.mod h1:qDBAiArrJPrmcHvpgCQ4lhM5zV/sf0Iou7nP7Zm2mc8= -github.com/aws/aws-sdk-go-v2/service/batch v1.53.0 h1:uf+Mr9I0l5Eo3aTaunHTJsfTnewLvzqGRPG4DrYabv8= -github.com/aws/aws-sdk-go-v2/service/batch v1.53.0/go.mod h1:3kzOFBSr7kWjiPQFZPqanUTxFwdMiA5UFe/O4NN7fsI= -github.com/aws/aws-sdk-go-v2/service/bcmdataexports v1.8.4 h1:BjeegkJ3Ha6VlzhQdqxViNIUkJNi6seZwHp5pqpYHaI= -github.com/aws/aws-sdk-go-v2/service/bcmdataexports v1.8.4/go.mod h1:0Rs3YH1xh3qTgiy0VP+UR6GibZUVATPAtvr3n58b3d4= -github.com/aws/aws-sdk-go-v2/service/bedrock v1.38.0 h1:wBlJMfquOKOMdSzZezhtzoTuVXc8kkkteymE/bBEXcg= -github.com/aws/aws-sdk-go-v2/service/bedrock v1.38.0/go.mod h1:1GlpVDmL9pBaVwNfgPXR3zuJhhXtNOZoiBa16pNbINY= -github.com/aws/aws-sdk-go-v2/service/bedrockagent v1.44.2 h1:gedxMyluRPy1ENN1dlOM7rK8Jek1wUvpA9z1Cz2s9N4= -github.com/aws/aws-sdk-go-v2/service/bedrockagent v1.44.2/go.mod h1:8zZaELHNLx6LNNfMrzCtVVsOFFKP1905FKmsSFuhArM= -github.com/aws/aws-sdk-go-v2/service/billing v1.2.4 h1:QqtOYdXXtghWbPemcCf7x8y/CWlN950/1eRd13EpKuE= -github.com/aws/aws-sdk-go-v2/service/billing v1.2.4/go.mod h1:mP5IsfmMZhkwpGdQm2DKsU5elbGTizrO3vK98LG0vWc= -github.com/aws/aws-sdk-go-v2/service/budgets v1.31.2 h1:ZdjYaUVxxQeWZ5BoU82dF7BpUhNfmha11ya8K9AiPoc= -github.com/aws/aws-sdk-go-v2/service/budgets v1.31.2/go.mod h1:LnxG/U78Q4uws9jS+a9sTwV8OVTWzfsXuBIaAfwksyM= -github.com/aws/aws-sdk-go-v2/service/chatbot v1.10.4 h1:bq7jZuszo3+COUXlDbeiOnWXfRZGzJcNAZzpjEguBow= -github.com/aws/aws-sdk-go-v2/service/chatbot v1.10.4/go.mod h1:IDmqb/P9NQISRL+1vrUskvUaTOo7SaEyULTLp5QZbhc= -github.com/aws/aws-sdk-go-v2/service/chime v1.36.4 h1:RvqaquFRY71C0col7ydmbqmJsqBFpybWRsklPwOcIA0= -github.com/aws/aws-sdk-go-v2/service/chime v1.36.4/go.mod h1:BqpFNKJNnpT9huL8gCdIQpzeZi2+FK/Y5DoyQkDl+C0= -github.com/aws/aws-sdk-go-v2/service/chimesdkmediapipelines v1.22.4 h1:AXoWCQp+YYKsAX1FcUm5WOXhC9KNodEhjB2xuRc/i2E= -github.com/aws/aws-sdk-go-v2/service/chimesdkmediapipelines v1.22.4/go.mod h1:VK80ksSTmSe1wU33aY0E47R2A2I6v7Zyi4sgn94d9F4= -github.com/aws/aws-sdk-go-v2/service/chimesdkvoice v1.22.2 h1:FvJ0+3o1j/k8OejpUK/19BhyuoKlWS67n/hqzyhINfU= -github.com/aws/aws-sdk-go-v2/service/chimesdkvoice v1.22.2/go.mod h1:SXGQ5hmMJzWRJt1Mu3s6x15eldRft+xErnAL6CDBC0U= -github.com/aws/aws-sdk-go-v2/service/cleanrooms v1.25.2 h1:TN80R+dUKMq7xgqgbclW/uBPdgo4zoGJ4uVdzNBgwQo= -github.com/aws/aws-sdk-go-v2/service/cleanrooms v1.25.2/go.mod h1:81twhtDcStPNYEh9XCp89TyaTjq+4ciPUgSWEoVxpgM= -github.com/aws/aws-sdk-go-v2/service/cloud9 v1.29.4 h1:bIyRLJ+QVAE1GPI+9XBGpP1rRKKbHL4oUMOVw/EdUBs= -github.com/aws/aws-sdk-go-v2/service/cloud9 v1.29.4/go.mod h1:gdFyMvML9BinbLiHs795bR9rKRHTKxNsOCLfbDFIzB4= -github.com/aws/aws-sdk-go-v2/service/cloudcontrol v1.24.6 h1:ZTDJc/sruFHYXaTr4aNwuHEykFtjqT9hcFFDQceSlAs= -github.com/aws/aws-sdk-go-v2/service/cloudcontrol v1.24.6/go.mod h1:QarpKg2UqElY6gtj2Z3CFbJqP8Wmq//w0LwudfpY69w= -github.com/aws/aws-sdk-go-v2/service/cloudformation v1.61.0 h1:1nVq2bvAANTPAfipKBOtbP1ebqTpJrOsxNqwb6ybCG8= -github.com/aws/aws-sdk-go-v2/service/cloudformation v1.61.0/go.mod h1:xU79X14UC0F8sEJCRTWwINzlQ4jacpEFpRESLHRHfoY= -github.com/aws/aws-sdk-go-v2/service/cloudfront v1.46.3 h1:ULVZL6Ro+vqmXFVFgZ5Q92pqWnhJfwOnWlNtibQPnIs= -github.com/aws/aws-sdk-go-v2/service/cloudfront v1.46.3/go.mod h1:vudWcTOLhQf4lzRH0qHUszJh8Gpo+Lp6dqH/HgVR9Xg= -github.com/aws/aws-sdk-go-v2/service/cloudfrontkeyvaluestore v1.9.4 h1:b/akD5kwvx/NPXgYMPnaaZ7HWlgrDLg9NatQ2Tc8wVk= -github.com/aws/aws-sdk-go-v2/service/cloudfrontkeyvaluestore v1.9.4/go.mod h1:nAAHqFZISt7zseVgaPzYwMY4bbet/rTn/TFMYa3s6sU= -github.com/aws/aws-sdk-go-v2/service/cloudhsmv2 v1.30.5 h1:P5+wUNAOc2bjxIiQ+ZMVz/Mv5jirnh4nPI9VCLgvJUQ= -github.com/aws/aws-sdk-go-v2/service/cloudhsmv2 v1.30.5/go.mod h1:4MW0k8bmDdC8VHJf5Vxhp5zLXnvkDRERvfiEvXZDnoM= -github.com/aws/aws-sdk-go-v2/service/cloudsearch v1.27.4 h1:kJ2Sa4VsJoaPg1vQCFL91N/ZjMzzbEyo7CG6bgzCkbI= -github.com/aws/aws-sdk-go-v2/service/cloudsearch v1.27.4/go.mod h1:kbxooYiqH9It+k1z+iLiTKlompLUQmEgZY5sv9txU8Q= -github.com/aws/aws-sdk-go-v2/service/cloudtrail v1.49.3 h1:wSQwBOXa1EV81WiVWLZ8fCrJ7wlwcfqSexEiv9OjPrA= -github.com/aws/aws-sdk-go-v2/service/cloudtrail v1.49.3/go.mod h1:5N4LfimBXTCtqKr0tZKfcte5UswFb7SJZV+LiQUZsGk= -github.com/aws/aws-sdk-go-v2/service/cloudwatch v1.45.3 h1:Nn3qce+OHZuMj/edx4its32uxedAmquCDxtZkrdeiD4= -github.com/aws/aws-sdk-go-v2/service/cloudwatch v1.45.3/go.mod h1:aqsLGsPs+rJfwDBwWHLcIV8F7AFcikFTPLwUD4RwORQ= -github.com/aws/aws-sdk-go-v2/service/cloudwatchlogs v1.51.0 h1:e5cbPZYTIY2nUEFieZUfVdINOiCTvChOMPfdLnmiLzs= -github.com/aws/aws-sdk-go-v2/service/cloudwatchlogs v1.51.0/go.mod h1:UseIHRfrm7PqeZo6fcTb6FUCXzCnh1KJbQbmOfxArGM= -github.com/aws/aws-sdk-go-v2/service/codeartifact v1.34.4 h1:8E5noXcMI3cNsX1hcx/ORW6mtla6usxz4BcW1q+zheE= -github.com/aws/aws-sdk-go-v2/service/codeartifact v1.34.4/go.mod h1:8bXExDA212G0tJkUYMcxcFhsqcM+jSBtsmOugZe2j7o= -github.com/aws/aws-sdk-go-v2/service/codebuild v1.61.2 h1:efAyxbfGzzswonfsjj3porKv6Q1H98SOHdlZ6hF2NI4= -github.com/aws/aws-sdk-go-v2/service/codebuild v1.61.2/go.mod h1:THLcsyok0+f2SaN7/QZ7tlzNseoF1YB7PJuGc3yd3EQ= -github.com/aws/aws-sdk-go-v2/service/codecatalyst v1.17.21 h1:0jz43AWY1USrCZwMzxHOIfmoXy7M2ZJRaqCr56x/Rvc= -github.com/aws/aws-sdk-go-v2/service/codecatalyst v1.17.21/go.mod h1:ic53zDsOvg3DF95EpLCTeR4hf6Oxt6Dz6P9WQ3cvUvw= -github.com/aws/aws-sdk-go-v2/service/codecommit v1.28.4 h1:DyOb/MZoTswNwFhg55VR1rvLkn1S55T7q+P8EuR+A7M= -github.com/aws/aws-sdk-go-v2/service/codecommit v1.28.4/go.mod h1:PB41jkDc903DUreLzzJBB/rabkQqriNqPtv1L9vAIOI= -github.com/aws/aws-sdk-go-v2/service/codeconnections v1.6.4 h1:j1FZyc3Oj7W3dWgmO4cbtOOkCaixavGotkPnoZqrixQ= -github.com/aws/aws-sdk-go-v2/service/codeconnections v1.6.4/go.mod h1:b3xHt4pnrpRyj1i75f8gU3vUy4UKLCbatXjcNZdbB38= -github.com/aws/aws-sdk-go-v2/service/codedeploy v1.30.6 h1:A74AkCwB8DsBeJ9DVLtLif2nGuTiHGdZMOeo2yKsyB0= -github.com/aws/aws-sdk-go-v2/service/codedeploy v1.30.6/go.mod h1:wjqakZxOg31qrJsrwpkvUoELRhfSNToa8SA1u7PdSxU= -github.com/aws/aws-sdk-go-v2/service/codeguruprofiler v1.25.4 h1:gWXiqaKkd6fRF1qOs5DL0ME1cRep4KNAAGGc5J5Lw3Y= -github.com/aws/aws-sdk-go-v2/service/codeguruprofiler v1.25.4/go.mod h1:wp/JLha/UGGGklH6qYjzIrQWGM+ewdlrXlwCmi0JbOM= -github.com/aws/aws-sdk-go-v2/service/codegurureviewer v1.30.4 h1:BJqh9+QCaB74sJmi4KpCqrrqV/exeG+gA6hvLRchH6E= -github.com/aws/aws-sdk-go-v2/service/codegurureviewer v1.30.4/go.mod h1:iINMrnaDsPf5UwOXacV+xFBgXphzT2yvdSMBzbOlk4g= -github.com/aws/aws-sdk-go-v2/service/codepipeline v1.42.2 h1:IYZ2Prn/aHOGB9GRj7hS7GVHMtRTb/4wiDI5mf326GE= -github.com/aws/aws-sdk-go-v2/service/codepipeline v1.42.2/go.mod h1:RgaoO5gg3Pp1se22UalAX6oTusJgdlKwMOfMo/lObgw= -github.com/aws/aws-sdk-go-v2/service/codestarconnections v1.30.4 h1:wIFcc7VQQpPS15fXRM8WvTUmrYNP6vIjFSxTszDWPyo= -github.com/aws/aws-sdk-go-v2/service/codestarconnections v1.30.4/go.mod h1:vMiaujmCGuRMMx7k9LVHfr9M+4++LwDpVciiF362wDo= -github.com/aws/aws-sdk-go-v2/service/codestarnotifications v1.27.4 h1:E5SxPPUfnZYDoT765IjNVzhDHmLVvaQdhH/7kRm+ZJY= -github.com/aws/aws-sdk-go-v2/service/codestarnotifications v1.27.4/go.mod h1:7gyIYjHXPAOX3NERsiwOs4uPEtppi3C+PKgwSvrt9AY= -github.com/aws/aws-sdk-go-v2/service/cognitoidentity v1.29.6 h1:qAzPMhagtK5hAs9WWnnrWXkpYfVXBbrcrEO/al4wP7I= -github.com/aws/aws-sdk-go-v2/service/cognitoidentity v1.29.6/go.mod h1:Isbgk/cOSGoFwswAzibnEWm5lXXLOCWOTAxyKmMAOHk= -github.com/aws/aws-sdk-go-v2/service/cognitoidentityprovider v1.53.2 h1:3f3FZdZgMBMouhPizBI3i6EnpdyL3ttjObmvr+1kfzg= -github.com/aws/aws-sdk-go-v2/service/cognitoidentityprovider v1.53.2/go.mod h1:rwpoEr5M4DCNNxmXX75Ql5+KOW01DEvOE0KPo3iiNEs= -github.com/aws/aws-sdk-go-v2/service/comprehend v1.36.6 h1:rSAMOE0HndTsLBPnuh4YLm205D8+3W/7lwc9q6llhvE= -github.com/aws/aws-sdk-go-v2/service/comprehend v1.36.6/go.mod h1:0bQ8f9sR/AaJBBBnHO0lc7mREP8uqWGSXY6uY7GR37s= -github.com/aws/aws-sdk-go-v2/service/computeoptimizer v1.43.2 h1:eIHLQrO/u2P76oWA2m++l2sOTRNRrKRFKK189YO5XYY= -github.com/aws/aws-sdk-go-v2/service/computeoptimizer v1.43.2/go.mod h1:harX8fH+HCyhgvgzLgVjXomS2ZuQ9W7Mgcr11DXM41w= -github.com/aws/aws-sdk-go-v2/service/configservice v1.53.0 h1:lu97by/q8YJxGjEujMunX5Gel2tf2MfDkb7Rz26Lw1g= -github.com/aws/aws-sdk-go-v2/service/configservice v1.53.0/go.mod h1:BYXP4Mzkc+ki7WFebTIMvzP+2CPFqULpy5KlCPlVOO0= -github.com/aws/aws-sdk-go-v2/service/connect v1.131.0 h1:jNR9bUgK/ZLA5ymyoaGU/7XREyIz99Lx7PS6jMVFW9w= -github.com/aws/aws-sdk-go-v2/service/connect v1.131.0/go.mod h1:xU6tkVMTXQlkRdff/a3rB6RS/goEJjq7QJbQj2/tZO4= -github.com/aws/aws-sdk-go-v2/service/connectcases v1.26.0 h1:zd0G03x3Gsztv7g3P5OtuTVq8VrTCSidAzEsXy61/Ac= -github.com/aws/aws-sdk-go-v2/service/connectcases v1.26.0/go.mod h1:NjwcRfAn4H/Dbt+F6AHYpvpGSfj8ViI30SpL4L3danA= -github.com/aws/aws-sdk-go-v2/service/controltower v1.22.3 h1:C8FcMAc7DIsTGqvoNfhKtf8kCGCRGf+UFr/U/J8WcjQ= -github.com/aws/aws-sdk-go-v2/service/controltower v1.22.3/go.mod h1:maGRVPBBQenlVQo3oooIQ9rwJcrIjyqCKKZIGzxjhTk= -github.com/aws/aws-sdk-go-v2/service/costandusagereportservice v1.29.4 h1:G96u5BhFFCwr1o0jmn/9pG4uqWFs1jbMX78BzEwSh2c= -github.com/aws/aws-sdk-go-v2/service/costandusagereportservice v1.29.4/go.mod h1:mWXTvKnKJ30G5ZxiEBAaN2jFgzX69Jwwr0lDmx4/6js= -github.com/aws/aws-sdk-go-v2/service/costexplorer v1.51.2 h1:7zSsOpcOaTximKcYWlpbhgKSn22fzx3ZkkankTEBHpQ= -github.com/aws/aws-sdk-go-v2/service/costexplorer v1.51.2/go.mod h1:xbfTJfT0GwWB6ONGltxdQixqzk/5fD/J/KEeQjUUNI8= -github.com/aws/aws-sdk-go-v2/service/costoptimizationhub v1.16.2 h1:yJ9bmAq8pTTETtUjQpONk3hzFLFy4qnsGu8IzPJYW4s= -github.com/aws/aws-sdk-go-v2/service/costoptimizationhub v1.16.2/go.mod h1:2e/HlfOil/pDjSsn/P0VcpYxKX3rycKiR8FSVzsOfao= -github.com/aws/aws-sdk-go-v2/service/customerprofiles v1.47.0 h1:bJKZVmfIHuaI7h0w7Ra5FKtQaKLaarBlJZVfcaMYNh8= -github.com/aws/aws-sdk-go-v2/service/customerprofiles v1.47.0/go.mod h1:rm68C2eQGFimGGUdirf25ehBACurSxVmirlX2NsgMpQ= -github.com/aws/aws-sdk-go-v2/service/databasemigrationservice v1.53.0 h1:KPukzgWZnmdc4fZYFkA46orMsQJoeNeEh5wbSnrYCdE= -github.com/aws/aws-sdk-go-v2/service/databasemigrationservice v1.53.0/go.mod h1:YDWzt7f6AHa4WfyJDv3GcIiyY3969MfsuSX9ANUbZ+k= -github.com/aws/aws-sdk-go-v2/service/databrew v1.34.4 h1:4M8XfsTE92AisaKwV75xtfCVT3Xza3ImIqlZsvzxZ0w= -github.com/aws/aws-sdk-go-v2/service/databrew v1.34.4/go.mod h1:b2Cv3mZxp7bNPEzOQFsSCcPJivdNiHn8HmCA7rau1r8= -github.com/aws/aws-sdk-go-v2/service/dataexchange v1.35.2 h1:/0cE4Ng/7zrNuM7yL3ADTwqDjN8CcPClsDxW6s4Fxy4= -github.com/aws/aws-sdk-go-v2/service/dataexchange v1.35.2/go.mod h1:3KVz8qwswG8F7iJvqk1hijdyF296sqxxYBMYX3vqygk= -github.com/aws/aws-sdk-go-v2/service/datapipeline v1.26.4 h1:qW7fLEpklI16GTkOQOC4IeztsCK38gXAsOLo2On2jD0= -github.com/aws/aws-sdk-go-v2/service/datapipeline v1.26.4/go.mod h1:aLoUy+KtchN6tAwb7YJnPcsb2YEoultUKsx1s/QEz60= -github.com/aws/aws-sdk-go-v2/service/datasync v1.49.3 h1:yWMkk9hwUjpDVsS4h0713JK1gKzubaxmqcQk/9r40t8= -github.com/aws/aws-sdk-go-v2/service/datasync v1.49.3/go.mod h1:gTqSe98/eTBLBSli2OIVCCtZ2wJ2oNrDqK16A2LGWiM= -github.com/aws/aws-sdk-go-v2/service/datazone v1.31.0 h1:AFzCK9/krkZ1i7AZtreEf9uiU8lJ55wTQoXFFgst//8= -github.com/aws/aws-sdk-go-v2/service/datazone v1.31.0/go.mod h1:XBH6CAk0DGML9jXbQM8GQkBE+ER1wRXrm0GxQe783xU= -github.com/aws/aws-sdk-go-v2/service/dax v1.24.4 h1:lyH0fXwrV4nIytmoiz0rzrJSFv84ZJ8MdK83U/LUT/Q= -github.com/aws/aws-sdk-go-v2/service/dax v1.24.4/go.mod h1:D91Ak1sYOquLMDM2EPuBRL+2gQxEnzMhG+/s5iUInMw= -github.com/aws/aws-sdk-go-v2/service/detective v1.33.2 h1:ePaT5c+InRjskQmJYTXwvMmb3VxcKh9MjZ5PVwoBduo= -github.com/aws/aws-sdk-go-v2/service/detective v1.33.2/go.mod h1:RE7vENK3CjJmUV40rQQsgkB7DNHJ1hZraBS99K7A/QQ= -github.com/aws/aws-sdk-go-v2/service/devicefarm v1.31.2 h1:6KlUuNr0DmhQQm/g/q3a6swX6WalRpVve8Op2Fdpy30= -github.com/aws/aws-sdk-go-v2/service/devicefarm v1.31.2/go.mod h1:+HTd3s8wIGd5b5jSikh9Qd/J1kNfY6IqioLkwZisfvc= -github.com/aws/aws-sdk-go-v2/service/devopsguru v1.35.4 h1:e7qpCMdibnlsI0jO5UfGTRfg+0G+HBANsMVtAjc8Pro= -github.com/aws/aws-sdk-go-v2/service/devopsguru v1.35.4/go.mod h1:nIALOeX1Xmspm6NhjzznpGmbyBg5gV0hxYcFcSCIUEQ= -github.com/aws/aws-sdk-go-v2/service/directconnect v1.32.5 h1:8H+ZzO2Yez+PbYRzheZoxWmv03k+qKq71Ruhlx9khxE= -github.com/aws/aws-sdk-go-v2/service/directconnect v1.32.5/go.mod h1:DD3baYN1tN5iIxcPKVAlgnDh2ZkUcbzM/lH/j0l+lxI= -github.com/aws/aws-sdk-go-v2/service/directoryservice v1.31.7 h1:JV01vGZhXnOGI5mjrSaYs8toau+lPgXp6UlQNm+inFY= -github.com/aws/aws-sdk-go-v2/service/directoryservice v1.31.7/go.mod h1:mAPyxqoegn/QPFB2Zy65DiQ2y8MlTtzKvFvlz2rwaQk= -github.com/aws/aws-sdk-go-v2/service/dlm v1.30.7 h1:O2pUnDku0CyRC4kZxa88YCMf395tbCujoOCS423vlXw= -github.com/aws/aws-sdk-go-v2/service/dlm v1.30.7/go.mod h1:dQK5yb0IyYZOJ8paqSQu6csZtYTIIxmAgI4Y4rtL9C4= -github.com/aws/aws-sdk-go-v2/service/docdb v1.41.6 h1:3psRq1ftvPT02Gtnt2YjSa/hXWM0JuEy3uZu8hatWPA= -github.com/aws/aws-sdk-go-v2/service/docdb v1.41.6/go.mod h1:HKdINsFfdzTWR38qWzfMbMJmsXC8tvbdSis/kG1+lCM= -github.com/aws/aws-sdk-go-v2/service/docdbelastic v1.15.4 h1:ne+OVLZVBibPXOb4Hm9o3iZp3UB5oA175aCrOzVTtHk= -github.com/aws/aws-sdk-go-v2/service/docdbelastic v1.15.4/go.mod h1:gXnmPUfd/xGEIZ8WsMswLiSAyYkQ6gMC9Uj7zVguwbQ= -github.com/aws/aws-sdk-go-v2/service/drs v1.31.4 h1:/mnR2UVVHcGIrHf70g5nb3RyoUHuj9MAVUYH9JvThcA= -github.com/aws/aws-sdk-go-v2/service/drs v1.31.4/go.mod h1:yvvJJgvXZDPuf3g8F/0IloipIsnnsamkCyVQdxGR6Og= -github.com/aws/aws-sdk-go-v2/service/dsql v1.5.2 h1:FCT/XJTmF+Rs9dpz8raISrEui75jLrF1hwYj2S5T7cw= -github.com/aws/aws-sdk-go-v2/service/dsql v1.5.2/go.mod h1:MFliW2mb4JEqLROEGWnf9o8mEpNjiyieKyOaUqa2ji0= -github.com/aws/aws-sdk-go-v2/service/dynamodb v1.44.0 h1:A99gjqZDbdhjtjJVZrmVzVKO2+p3MSg35bDWtbMQVxw= -github.com/aws/aws-sdk-go-v2/service/dynamodb v1.44.0/go.mod h1:mWB0GE1bqcVSvpW7OtFA0sKuHk52+IqtnsYU2jUfYAs= -github.com/aws/aws-sdk-go-v2/service/ec2 v1.231.0 h1:uhIwvt6crp2kQenKojfDShGw39WEIrtPRfYZ3FAFlJk= -github.com/aws/aws-sdk-go-v2/service/ec2 v1.231.0/go.mod h1:35jGWx7ECvCwTsApqicFYzZ7JFEnBc6oHUuOQ3xIS54= -github.com/aws/aws-sdk-go-v2/service/ecr v1.45.1 h1:Bwzh202Aq7/MYnAjXA9VawCf6u+hjwMdoYmZ4HYsdf8= -github.com/aws/aws-sdk-go-v2/service/ecr v1.45.1/go.mod h1:xZzWl9AXYa6zsLLH41HBFW8KRKJRIzlGmvSM0mVMIX4= -github.com/aws/aws-sdk-go-v2/service/ecrpublic v1.33.2 h1:XJ/AEFYj9VFPJdF+VFi4SUPEDfz1akHwxxm07JfZJcs= -github.com/aws/aws-sdk-go-v2/service/ecrpublic v1.33.2/go.mod h1:JUBHdhvKbbKmhaHjLsKJAWnQL80T6nURmhB/LEprV+4= -github.com/aws/aws-sdk-go-v2/service/ecs v1.58.1 h1:DTwVT1pmRYac0va8mb4A97bumBXZJeAov776TlsYqHw= -github.com/aws/aws-sdk-go-v2/service/ecs v1.58.1/go.mod h1:kq9VTFKJ68jqeYu1uVx6bR7VgWdQ0Kic/BstllTJJuU= -github.com/aws/aws-sdk-go-v2/service/efs v1.36.2 h1:u559lskjn8+5WRnLU+Aq0VCZLjgw+JXYHiwSfOpweBw= -github.com/aws/aws-sdk-go-v2/service/efs v1.36.2/go.mod h1:e6UrCp+V52p83QPNWC05I2N3vkg15XTfbQ0n4IvYDYQ= -github.com/aws/aws-sdk-go-v2/service/eks v1.66.1 h1:sD1y3G4WXw1GjK95L5dBXPFXNWl/O8GMradUojUYqCg= -github.com/aws/aws-sdk-go-v2/service/eks v1.66.1/go.mod h1:Qj90srO2HigGG5x8Ro6RxixxqiSjZjF91WTEVpnsjAs= -github.com/aws/aws-sdk-go-v2/service/elasticache v1.46.3 h1:K1KtI95Fkz+2PT0OtVRsZyUzb4zHFMWOXNPkXy7LYDY= -github.com/aws/aws-sdk-go-v2/service/elasticache v1.46.3/go.mod h1:kI+JDflKNLqdxVmdg2I8A3dmsCcJzAXXz5vKcHsyz9Y= -github.com/aws/aws-sdk-go-v2/service/elasticbeanstalk v1.29.5 h1:pMxyQ4h0JhnKOQoTRW6OyzKtsHKGzO3qTikBH7q5dr4= -github.com/aws/aws-sdk-go-v2/service/elasticbeanstalk v1.29.5/go.mod h1:BfDv/2Xok2pEg9VbiT7WkBIO3WFnAnuUcncn9QkOJko= -github.com/aws/aws-sdk-go-v2/service/elasticloadbalancing v1.29.6 h1:9grU/+HRwLXJV8XUjEPThJj/H+0oHkeNBFpSSfZekeg= -github.com/aws/aws-sdk-go-v2/service/elasticloadbalancing v1.29.6/go.mod h1:N4fs285CsnBHlAkzBpQapefR/noggTyF09fWs72EzB4= -github.com/aws/aws-sdk-go-v2/service/elasticloadbalancingv2 v1.46.0 h1:3nrkDeiPreARHMoqvS+umxTKcDVkqnRPlz01/kVgG7U= -github.com/aws/aws-sdk-go-v2/service/elasticloadbalancingv2 v1.46.0/go.mod h1:E+At5Cto6ntT+qaNs3RpJKsx1GaFaNB3zzNUFhHL8DE= -github.com/aws/aws-sdk-go-v2/service/elasticsearchservice v1.33.6 h1:uMMgBQYKsZn0kunyKsyUZyeIlBjt0tq8JmuSRhPF3k8= -github.com/aws/aws-sdk-go-v2/service/elasticsearchservice v1.33.6/go.mod h1:amHnCXfYgnnuX+DZsN/hSBbhKWA8ftDQN0QVVelGGoU= -github.com/aws/aws-sdk-go-v2/service/elastictranscoder v1.28.4 h1:0ScNqYCd3DPv6xfaKQkcCB06mWKI1eXQ5HbE4zeBo7M= -github.com/aws/aws-sdk-go-v2/service/elastictranscoder v1.28.4/go.mod h1:EqJAUs2nA9PHOBjrMpv+XmjbEdPx3COUMnEKzsc0PGU= -github.com/aws/aws-sdk-go-v2/service/emr v1.49.3 h1:bojA/Hy1JbiG84qjo0dKjzCSrlkGkqoZKivoSA3ZYyI= -github.com/aws/aws-sdk-go-v2/service/emr v1.49.3/go.mod h1:3Fb28r8m3+76JD3SGbN080pY53Zf8S+kraglAVRIucc= -github.com/aws/aws-sdk-go-v2/service/emrcontainers v1.35.4 h1:4DSQddd2X8DtQ7XkfoxgTQm9Ziqg7OMqTqYexZJiQsE= -github.com/aws/aws-sdk-go-v2/service/emrcontainers v1.35.4/go.mod h1:1wo3Ol0hdgtW5tnkHDSywVk1uGZgFz3GIczlHWigLSE= -github.com/aws/aws-sdk-go-v2/service/emrserverless v1.32.0 h1:lMEEo2u0vS4+xid38JaKIyjxIh8OCkDNtyt4wHqZ4Os= -github.com/aws/aws-sdk-go-v2/service/emrserverless v1.32.0/go.mod h1:DLlEeTpje5Jl1KXggBTphYGdTn+4VUgSOfPZOdQKwOg= -github.com/aws/aws-sdk-go-v2/service/eventbridge v1.40.0 h1:S2zUrIgbvBdHCWP5I5P3Wz8+YfDyp7rpCfGXBwmO3a8= -github.com/aws/aws-sdk-go-v2/service/eventbridge v1.40.0/go.mod h1:sIrUII6Z+hAVAgcpmsc2e9HvEr++m/v8aBPT7s4ZYUk= -github.com/aws/aws-sdk-go-v2/service/evidently v1.24.4 h1:LFq0twtI4iH7NoI8zqgom4RttSS//mKasAt4vbMbX3E= -github.com/aws/aws-sdk-go-v2/service/evidently v1.24.4/go.mod h1:xs4SqVz98n8Bxjt/NCG2G2Jm/qx8gx+i0euCyIaRZJA= -github.com/aws/aws-sdk-go-v2/service/evs v1.0.2 h1:jwSECr6+TScYZgbaVmL5WSMnjifRg8V0CGv+R/IU4I4= -github.com/aws/aws-sdk-go-v2/service/evs v1.0.2/go.mod h1:0a8Lc552uwJTFIRrlvqlR6dqvxlN6hk4GMYZRek0Se4= -github.com/aws/aws-sdk-go-v2/service/finspace v1.29.4 h1:MPXrTPT6nLbddVOivR+cZg3yC/qDZlf5Eta36oQGmzM= -github.com/aws/aws-sdk-go-v2/service/finspace v1.29.4/go.mod h1:hekaZTEQbeaS+WHd4BzQtu+nJS/E73xZocexPrPrArQ= -github.com/aws/aws-sdk-go-v2/service/firehose v1.37.7 h1:rDNxf0CQboBMqzm6WmhGL58pYpKMjU6Qs3/BfY3Em4Y= -github.com/aws/aws-sdk-go-v2/service/firehose v1.37.7/go.mod h1:E1yDRkUMwlVGmDYcu5UJuwfznGNuVW29sjr2xxM2Y0w= -github.com/aws/aws-sdk-go-v2/service/fis v1.33.4 h1:qHebHke5kT9KPhmKfqxWc3a9paffgRhbegNoORoxfCE= -github.com/aws/aws-sdk-go-v2/service/fis v1.33.4/go.mod h1:xwRN5ORzqRIf5IYIkcyAuEhKhVf4Cts5jd7j/fA8+LE= -github.com/aws/aws-sdk-go-v2/service/fms v1.40.5 h1:2hNJGW372nqz7HzMutbocRpZ3MARYm5kq2tvCFs6OHI= -github.com/aws/aws-sdk-go-v2/service/fms v1.40.5/go.mod h1:93wTShRibgZb1ELz8Pf81L3An0WHKHf9wRJ+6s2OLv0= -github.com/aws/aws-sdk-go-v2/service/fsx v1.55.0 h1:ZyAs2DqX6ksKM5dihLzrFseTygwaZWholin+VmN6Ob4= -github.com/aws/aws-sdk-go-v2/service/fsx v1.55.0/go.mod h1:yKSq9iW5hHBEpyYKpmH7bGVTBpE9Ki4xrfAWV99wXpE= -github.com/aws/aws-sdk-go-v2/service/gamelift v1.42.1 h1:a3b1XXHAg61yVO5oKuMN73LxUipPnY5FaV/+kAqvZn0= -github.com/aws/aws-sdk-go-v2/service/gamelift v1.42.1/go.mod h1:dnPoxIqQYnMMkAW1HYNKCF2Sc17CDR2sm+/L8o5FNe8= -github.com/aws/aws-sdk-go-v2/service/glacier v1.27.5 h1:Rp3lC3bHz78NMV6BlffdC/WlpNL/k060yi5FUGBj5po= -github.com/aws/aws-sdk-go-v2/service/glacier v1.27.5/go.mod h1:hSMtaqxpqY3qBEIStQISXDfbBQTcYLNjYn4OSVWKvdc= -github.com/aws/aws-sdk-go-v2/service/globalaccelerator v1.30.4 h1:idE6j2x7GKSosHJs8cUx8A6KUq3uBrHgjDlWX349fuM= -github.com/aws/aws-sdk-go-v2/service/globalaccelerator v1.30.4/go.mod h1:j/G2N1igocPCVsL7+KhmWI7Y9fiAaUtRdirSReCxDSA= -github.com/aws/aws-sdk-go-v2/service/glue v1.117.0 h1:Tl20k1TsdD8Ot+tfOgUt49EE9FyGla1e2LhuJe2Gkgk= -github.com/aws/aws-sdk-go-v2/service/glue v1.117.0/go.mod h1:AiOhaEmhCSVONWJ9Ul47qOzNNEBXG8saKz1K7vKbRg4= -github.com/aws/aws-sdk-go-v2/service/grafana v1.27.4 h1:XixrfgFR4zUxe2lqvQSp7VneDSjh1jVNdU2ebIWSydg= -github.com/aws/aws-sdk-go-v2/service/grafana v1.27.4/go.mod h1:2tlr8LcYq7dHoKzd0McU0r5Q408BwnpvPFyDIW6g6Cc= -github.com/aws/aws-sdk-go-v2/service/greengrass v1.28.4 h1:O0ymzTHd7bbwTjN4lJksKRM+g/WYOzGe2C0dCai1T+Y= -github.com/aws/aws-sdk-go-v2/service/greengrass v1.28.4/go.mod h1:33wl2N0a4HTF8TcfOpgbr057ZmSmdQM1odJnMXBEDn0= -github.com/aws/aws-sdk-go-v2/service/groundstation v1.33.2 h1:ISdFgeehbUcSmHuKnSXIiXbTCbktq3gQOmOJFKXTIuI= -github.com/aws/aws-sdk-go-v2/service/groundstation v1.33.2/go.mod h1:Yy51sCEGRTCe+WCXyGCtwPlr7cJq8gkV3pCr61IlxFo= -github.com/aws/aws-sdk-go-v2/service/guardduty v1.56.0 h1:9sDfWWFOLWf4iXJRmgA2KM44VqzKzBcYE/3lRxdfBac= -github.com/aws/aws-sdk-go-v2/service/guardduty v1.56.0/go.mod h1:NCwAyLptBGarEwV6HMo52eD4wIqiT+szUlI4WhfEeWM= -github.com/aws/aws-sdk-go-v2/service/healthlake v1.30.5 h1:wXVaLzbLWize/Cbpcz8bt3Z7JptSNjTiT3aLXacB3qA= -github.com/aws/aws-sdk-go-v2/service/healthlake v1.30.5/go.mod h1:KPnC/Zx3SFrNdp6MqngyzCuua9FwdR3gB37IZB19esU= -github.com/aws/aws-sdk-go-v2/service/iam v1.43.0 h1:/ZZo3N8iU/PLsRSCjjlT/J+n4N8kqfTO7BwW1GE+G50= -github.com/aws/aws-sdk-go-v2/service/iam v1.43.0/go.mod h1:QRtwvoAGc59uxv4vQHPKr75SLzhYCRSoETxAA98r6O4= -github.com/aws/aws-sdk-go-v2/service/identitystore v1.28.6 h1:kFlM9ljR/NV9tRbwLpenIdFjDAYFB23pLpcWpCDfkuc= -github.com/aws/aws-sdk-go-v2/service/identitystore v1.28.6/go.mod h1:z1GkhlOp50BHMgSkGFxwKR28G+ZvjykzUScuWhCdVco= -github.com/aws/aws-sdk-go-v2/service/imagebuilder v1.42.3 h1:TLul/XG5yo9fbIMtxEXHwKtjohZjTNVYwWNJR3CRVE0= -github.com/aws/aws-sdk-go-v2/service/imagebuilder v1.42.3/go.mod h1:PKGWYhnhQ3tDhM8W/1R7QUBmM9c7SEshBEewE7XPFPc= -github.com/aws/aws-sdk-go-v2/service/inspector v1.26.4 h1:HmmfKgLW6dj9ZF6LQjnyPr8JfgO5RKViUJZyr+3DyAs= -github.com/aws/aws-sdk-go-v2/service/inspector v1.26.4/go.mod h1:axRC0whrHPEaTEcJCL1FalY9KwwOhmKKdeLzLjqkTyc= -github.com/aws/aws-sdk-go-v2/service/inspector2 v1.38.1 h1:c1ggLklQ1C5Aoj99g/4/CCdB6D0oIPaETNYwY4z8/i4= -github.com/aws/aws-sdk-go-v2/service/inspector2 v1.38.1/go.mod h1:6usonUxMtrrQ1OuxxJeBR2tR1PZcwjc2/e//xK2rmtQ= -github.com/aws/aws-sdk-go-v2/service/internal/accept-encoding v1.12.4 h1:CXV68E2dNqhuynZJPB80bhPQwAKqBWVer887figW6Jc= -github.com/aws/aws-sdk-go-v2/service/internal/accept-encoding v1.12.4/go.mod h1:/xFi9KtvBXP97ppCz1TAEvU1Uf66qvid89rbem3wCzQ= -github.com/aws/aws-sdk-go-v2/service/internal/checksum v1.7.4 h1:nAP2GYbfh8dd2zGZqFRSMlq+/F6cMPBUuCsGAMkN074= -github.com/aws/aws-sdk-go-v2/service/internal/checksum v1.7.4/go.mod h1:LT10DsiGjLWh4GbjInf9LQejkYEhBgBCjLG5+lvk4EE= -github.com/aws/aws-sdk-go-v2/service/internal/endpoint-discovery v1.10.17 h1:x187MqiHwBGjMGAed8Y8K1VGuCtFvQvXb24r+bwmSdo= -github.com/aws/aws-sdk-go-v2/service/internal/endpoint-discovery v1.10.17/go.mod h1:mC9qMbA6e1pwEq6X3zDGtZRXMG2YaElJkbJlMVHLs5I= -github.com/aws/aws-sdk-go-v2/service/internal/presigned-url v1.12.17 h1:t0E6FzREdtCsiLIoLCWsYliNsRBgyGD/MCK571qk4MI= -github.com/aws/aws-sdk-go-v2/service/internal/presigned-url v1.12.17/go.mod h1:ygpklyoaypuyDvOM5ujWGrYWpAK3h7ugnmKCU/76Ys4= -github.com/aws/aws-sdk-go-v2/service/internal/s3shared v1.18.17 h1:qcLWgdhq45sDM9na4cvXax9dyLitn8EYBRl8Ak4XtG4= -github.com/aws/aws-sdk-go-v2/service/internal/s3shared v1.18.17/go.mod h1:M+jkjBFZ2J6DJrjMv2+vkBbuht6kxJYtJiwoVgX4p4U= -github.com/aws/aws-sdk-go-v2/service/internetmonitor v1.21.5 h1:/OevpXjFTKC13DuhlMoJmlVx246loRn4RehOXcaokYs= -github.com/aws/aws-sdk-go-v2/service/internetmonitor v1.21.5/go.mod h1:hzvUC8l6AJ26Yz6eYiKPClQkSEbukvkNDMMNNhCcM7M= -github.com/aws/aws-sdk-go-v2/service/invoicing v1.2.2 h1:l9h02nlsL71Z3AsiNYe3ok0sKf5FxYalBivi8dmroFo= -github.com/aws/aws-sdk-go-v2/service/invoicing v1.2.2/go.mod h1:qgx493y1oppVNw2khxgCCfmDRCH7xFaLzeHQPPIQcV4= -github.com/aws/aws-sdk-go-v2/service/iot v1.64.4 h1:PCIpXKj5E5SCsIICVb50mU8Ma7B+Yowd872E2x2GEKM= -github.com/aws/aws-sdk-go-v2/service/iot v1.64.4/go.mod h1:zoWywk4n+izQigMVgYQFCnASbAJ8uHv6RHKLrjAsocg= -github.com/aws/aws-sdk-go-v2/service/ivs v1.43.4 h1:o8i4lXojYxWkf1JO/4ZI42A+BqLQcVE7/R/PeSd6//Y= -github.com/aws/aws-sdk-go-v2/service/ivs v1.43.4/go.mod h1:eqKP1qnqzTTjRcIO6DK9HRiIwvbL67xAUZ3IGbQ0WOI= -github.com/aws/aws-sdk-go-v2/service/ivschat v1.17.4 h1:btA/5nMzQ5W9uYvXVfZoo+1MfIsnt8rHxfdeqqb/Hp4= -github.com/aws/aws-sdk-go-v2/service/ivschat v1.17.4/go.mod h1:wVqsjIZzpNfhcxzSEQ5Ex3MZTK6pK41Bnube0cQbklw= -github.com/aws/aws-sdk-go-v2/service/kafka v1.39.5 h1:N92rM/5cDDxhjRLQsiVuV+osgvjgxjlPWDfifwWZl+0= -github.com/aws/aws-sdk-go-v2/service/kafka v1.39.5/go.mod h1:O0aQB4mb7phy2B60/oRkEN2EeUdbWDOHhrnar8ZP1Dk= -github.com/aws/aws-sdk-go-v2/service/kafkaconnect v1.23.5 h1:6aVQyYo8DwhQknoluvQn3myUthiSvX7h0nf7r2nrxQU= -github.com/aws/aws-sdk-go-v2/service/kafkaconnect v1.23.5/go.mod h1:DIDIP4kbwO2APBMn4aH89FjL3JNeeDoOG37W15Tkk2o= -github.com/aws/aws-sdk-go-v2/service/kendra v1.56.4 h1:GmvdHpYX8gUIIrhVoZ3CVyES0M06FAoMAmwWSroWwDk= -github.com/aws/aws-sdk-go-v2/service/kendra v1.56.4/go.mod h1:UyEw38rFv1ab5iGITliJ76ercQ2W+uH6xGofzM/fWn8= -github.com/aws/aws-sdk-go-v2/service/keyspaces v1.19.0 h1:dUlvwCH/2NcG6vE87uBYtedvSqr38hvOMq2V7oNrGek= -github.com/aws/aws-sdk-go-v2/service/keyspaces v1.19.0/go.mod h1:6ToAMADrPoGAV7YNsJh8QHv/V9Rok9uPTvJmw0nxpj4= -github.com/aws/aws-sdk-go-v2/service/kinesis v1.35.3 h1:aAi9YBNpYMEX52Z9qy1YP2t3RhDqMcP67Ep/C4q5RiQ= -github.com/aws/aws-sdk-go-v2/service/kinesis v1.35.3/go.mod h1:DH0TzTbBG82HKNpBQlplRNSS4bGz0dsbJvxdK9f6rUY= -github.com/aws/aws-sdk-go-v2/service/kinesisanalytics v1.26.7 h1:2Yes4BbKaGPHb/bCdaWoDEC9YdAM51fuP5NC7Z3dNYU= -github.com/aws/aws-sdk-go-v2/service/kinesisanalytics v1.26.7/go.mod h1:eWKL85+D5+OcrfqvRpLF2x71btGZWur944vnaPmWE6E= -github.com/aws/aws-sdk-go-v2/service/kinesisanalyticsv2 v1.32.7 h1:Vt7/srA/qRWlIck03nC/kDGOITQZ5eJ2BlnXNEiPzeU= -github.com/aws/aws-sdk-go-v2/service/kinesisanalyticsv2 v1.32.7/go.mod h1:1FRspsThsK9y/KCnN6lF2ooSPFNw8TwGZf/3xpT3wEo= -github.com/aws/aws-sdk-go-v2/service/kinesisvideo v1.28.4 h1:dA0yAAnFje99NZqcHc0O/8rduXOe7e5R+qM798lq3s8= -github.com/aws/aws-sdk-go-v2/service/kinesisvideo v1.28.4/go.mod h1:CsOqYUjyz2UVrZ22fiKl+WdCRiXsO7kufv3P816Qo0I= -github.com/aws/aws-sdk-go-v2/service/kms v1.41.2 h1:zJeUxFP7+XP52u23vrp4zMcVhShTWbNO8dHV6xCSvFo= -github.com/aws/aws-sdk-go-v2/service/kms v1.41.2/go.mod h1:Pqd9k4TuespkireN206cK2QBsaBTL6X+VPAez5Qcijk= -github.com/aws/aws-sdk-go-v2/service/lakeformation v1.41.8 h1:WvMhnaMOJU9Q1xVmXDT6TT5V+0CyniFUIVS87XfvzFE= -github.com/aws/aws-sdk-go-v2/service/lakeformation v1.41.8/go.mod h1:NBaw/nPw3v62yWrxUOGkifYKkIeYoocc3O8lgrnvgxU= -github.com/aws/aws-sdk-go-v2/service/lambda v1.72.0 h1:2LerDz2Lz22IDfdpR/RpSZIFoBoAh1tdHUaiUzG2z0k= -github.com/aws/aws-sdk-go-v2/service/lambda v1.72.0/go.mod h1:vahA7MiX/fQE9J5o1PKbgn8KoXz7ogSFLAQQLdLUvM8= -github.com/aws/aws-sdk-go-v2/service/launchwizard v1.9.4 h1:zAxrTUh8ffwiunWoichOWc9tVVSzRpmU/dR6plwIiyE= -github.com/aws/aws-sdk-go-v2/service/launchwizard v1.9.4/go.mod h1:Q1KBC3ILbT5cYEAeWT8SSI4vrnNOqAK1mx5ru0Yk1V4= -github.com/aws/aws-sdk-go-v2/service/lexmodelbuildingservice v1.29.4 h1:emmwvPyyB36dp+c6hPHvn5vR+y/C85VUBKSqS+RhpFI= -github.com/aws/aws-sdk-go-v2/service/lexmodelbuildingservice v1.29.4/go.mod h1:y9wPFtue7AFgaZQUefO0j/l2SB7wtkFMlXmcdc/oG5I= -github.com/aws/aws-sdk-go-v2/service/lexmodelsv2 v1.52.1 h1:aLBLIBBVLoKXLjNy5EKh8kFndvawsoxvswsnKg4tXU0= -github.com/aws/aws-sdk-go-v2/service/lexmodelsv2 v1.52.1/go.mod h1:VGLvL1In57M4vlxHoro5WDGwlpzAMyix0XdwffuYOsI= -github.com/aws/aws-sdk-go-v2/service/licensemanager v1.32.0 h1:fyHzYkcQrD9+5gpLSQU5nkaZAIu1ZlsHzZ7MgMpzhic= -github.com/aws/aws-sdk-go-v2/service/licensemanager v1.32.0/go.mod h1:wgEK7i9V/WGv79dhmZOad0Sc3FcJhwgOJ2ihebLuVJY= -github.com/aws/aws-sdk-go-v2/service/lightsail v1.43.4 h1:0WHz7LVS1JHOMaJJ2uc7vvMERopVfNQE1Dil2yu6Wqw= -github.com/aws/aws-sdk-go-v2/service/lightsail v1.43.4/go.mod h1:2VS/H/N3xtI0VxFja/1Aqy1FscPkVyju4Uq9J08L6Ms= -github.com/aws/aws-sdk-go-v2/service/location v1.44.4 h1:oQhdGB0sDiV6DbHz2syreSdDE3IgpxyEYEexs8Fnjhg= -github.com/aws/aws-sdk-go-v2/service/location v1.44.4/go.mod h1:pkmmKXWZEw624lzTiL+3TzQsihEoqQGZpaYbWDjwvGU= -github.com/aws/aws-sdk-go-v2/service/lookoutmetrics v1.32.4 h1:C1BGDdGUvilwtTl0fymQ80x3a/ksZ9HrcDZe5ciHwgM= -github.com/aws/aws-sdk-go-v2/service/lookoutmetrics v1.32.4/go.mod h1:PNQsvph/5J9OZz4ns0mUL1myh+3suq6Maq4J/CewM4w= -github.com/aws/aws-sdk-go-v2/service/m2 v1.21.2 h1:xvYDXyQSCk3G7XTHJ/D+OobIcVxgo1ZABl0mrD16jGc= -github.com/aws/aws-sdk-go-v2/service/m2 v1.21.2/go.mod h1:6Ra+8YlUJvmrgRbiVrgvbB7UGa/8AlX6T9BgIqpDfbA= -github.com/aws/aws-sdk-go-v2/service/macie2 v1.45.4 h1:dUUeyfbXzT+0CIEa2cQT5BYLduPVOjLXbroYF/3DNyk= -github.com/aws/aws-sdk-go-v2/service/macie2 v1.45.4/go.mod h1:pUFG4pQ5NL+jDRwLRwiTCMMavh/+swy3be4NVQjyfx0= -github.com/aws/aws-sdk-go-v2/service/mediaconnect v1.40.2 h1:G6QfYIjydoQi5BRw3zkUP35aURuPgiMWsqda/vMSxxw= -github.com/aws/aws-sdk-go-v2/service/mediaconnect v1.40.2/go.mod h1:+JCqmRgWpEB6Gmkfb1UUyKQpkbuMo7KOCyZq3vg/xz4= -github.com/aws/aws-sdk-go-v2/service/mediaconvert v1.75.0 h1:Yw9/tZ1m3rqmcibR1h1TVKF3LKUXdGU1NMXrGzdnrCw= -github.com/aws/aws-sdk-go-v2/service/mediaconvert v1.75.0/go.mod h1:3DstUf6Py/5v01y1jf73ma6c3r+GbkFqyN2n1RTavRo= -github.com/aws/aws-sdk-go-v2/service/medialive v1.76.2 h1:rjwsjFC6SCrOFYbCCY8ULp5fHluwilZrzYVg2LPgeW8= -github.com/aws/aws-sdk-go-v2/service/medialive v1.76.2/go.mod h1:jExKUuHSh/WksIx3Vs3miOAOMpbF8rnvRNgtI+wH/4I= -github.com/aws/aws-sdk-go-v2/service/mediapackage v1.35.4 h1:ohFzCGSbvw7EX9XM8Oxtl9E0Ph2Rasmmuc+Xx8uf6Uo= -github.com/aws/aws-sdk-go-v2/service/mediapackage v1.35.4/go.mod h1:OenjZ9DGOXCsBuowIPErRHTsbGZC5jGBok+4V8teBko= -github.com/aws/aws-sdk-go-v2/service/mediapackagev2 v1.24.0 h1:hGCDJYqDm/XmIjLD0Pe7kcxUSLQZi6/lc6FD6AiVCrY= -github.com/aws/aws-sdk-go-v2/service/mediapackagev2 v1.24.0/go.mod h1:bO3GFTVx6m9gCIErec24aNup05CFQkTaXXl50BUJTDk= -github.com/aws/aws-sdk-go-v2/service/mediapackagevod v1.35.4 h1:JUfHo+paK88NAMjDmHQI5KhVybkduH/hAHbLrzz8guQ= -github.com/aws/aws-sdk-go-v2/service/mediapackagevod v1.35.4/go.mod h1:XW38yIsZNImizG/0v6CdP74lh6GvnZcaFQ9iwusvwMM= -github.com/aws/aws-sdk-go-v2/service/mediastore v1.25.4 h1:Z3sHyG46Hs1ZNUzQ9Z+psJoclcVB/iM6H7TLuOQ4HIA= -github.com/aws/aws-sdk-go-v2/service/mediastore v1.25.4/go.mod h1:kI9Qf+K599ZwzZzVwOqZJRk0gg9cFDots4NFzvfS148= -github.com/aws/aws-sdk-go-v2/service/memorydb v1.27.2 h1:IfwyIeg5ihdo0rgYPd5GLL7HoSleK+D+VKTQ90Ydvb4= -github.com/aws/aws-sdk-go-v2/service/memorydb v1.27.2/go.mod h1:/R8wCXLpL1wyd22zFfGoWei+JayKQGEGSWJ+FDNngu4= -github.com/aws/aws-sdk-go-v2/service/mgn v1.33.4 h1:A6g03tFkhPDXjiofvTxuvW2HH7DkwsdHuLEkGURj2uE= -github.com/aws/aws-sdk-go-v2/service/mgn v1.33.4/go.mod h1:gWtkzOxwXESKQGqsqICO3LIBA6PuOo/ZU4mMrMhxzo8= -github.com/aws/aws-sdk-go-v2/service/mq v1.29.2 h1:XhJW/ppQrd2J4T+TCxrv6sZWrSyRlZNYNq586EmSbg0= -github.com/aws/aws-sdk-go-v2/service/mq v1.29.2/go.mod h1:ESMOqV079mlqNnqaxin+UNKvPkn9e9Qew83YQMe+RDY= -github.com/aws/aws-sdk-go-v2/service/mwaa v1.35.3 h1:VcyYhv+EqCW3OwixgYpmNff6eJpSAjXtSjE0WLUogSY= -github.com/aws/aws-sdk-go-v2/service/mwaa v1.35.3/go.mod h1:QeKi1Tch8DJpKfsCNKvuXganHLH3XUt3sn22cfVSd2U= -github.com/aws/aws-sdk-go-v2/service/neptune v1.37.3 h1:T+EQnNg3h2IJbfg9M9OAZEiHO+xhVtpnV1IqtrGVFwI= -github.com/aws/aws-sdk-go-v2/service/neptune v1.37.3/go.mod h1://k6uK6wMNDdiPAjtlT4G+ln/yrRwiZCYRseUuaCpmM= -github.com/aws/aws-sdk-go-v2/service/neptunegraph v1.17.5 h1:4hLlfw7lQ0LfRqgDQTiuJ5l1z56mis4j0ncQjWipa/k= -github.com/aws/aws-sdk-go-v2/service/neptunegraph v1.17.5/go.mod h1:Ex4YrWM8XMVoK4nCZdWLjPA4KwrrVJnE/G8wIiVwRog= -github.com/aws/aws-sdk-go-v2/service/networkfirewall v1.51.0 h1:CCNcctA+JRLbaOjsKSmMpkMhqh7yM9NSkUzGx4m6etM= -github.com/aws/aws-sdk-go-v2/service/networkfirewall v1.51.0/go.mod h1:Sdex/kw/DteUGYsSK3f4UtMBsHi9TBdxtVsJZaCg00k= -github.com/aws/aws-sdk-go-v2/service/networkmanager v1.35.1 h1:+WRM1yPx0OttOwWCg+fC0gIiRaYR3cAMqilFWGfKiJ8= -github.com/aws/aws-sdk-go-v2/service/networkmanager v1.35.1/go.mod h1:3yDKzKKBJPHeKau2EYAD/iFOd1E5XHXEjYOdShdhsgU= -github.com/aws/aws-sdk-go-v2/service/networkmonitor v1.8.4 h1:9I8hXa5RVl48APWv3xzQyj/VbU+V5TOaVj1tRhNbwzw= -github.com/aws/aws-sdk-go-v2/service/networkmonitor v1.8.4/go.mod h1:p2OtzahA9dYaLJB4zf/VMXWdfJhD5N6wHW6QcxUeF0k= -github.com/aws/aws-sdk-go-v2/service/notifications v1.2.5 h1:rSFeBvrGfRA4wAZYh8KaOJ/k0/JCvJr3l07n9tXSiGU= -github.com/aws/aws-sdk-go-v2/service/notifications v1.2.5/go.mod h1:tJBKodWS4tqyFCfsac9WE5Hm43e/IYDZbB2lax/QyGY= -github.com/aws/aws-sdk-go-v2/service/notificationscontacts v1.1.4 h1:8tAWBBRvHcnEucipGelVreFAqisi3Chhc1/ywio7/7U= -github.com/aws/aws-sdk-go-v2/service/notificationscontacts v1.1.4/go.mod h1:ZlMouvvOjPxSEcn08KswFDPzkDNA1339mJhvJHEq8Og= -github.com/aws/aws-sdk-go-v2/service/oam v1.18.3 h1:teOWtElLARLOhpYWwupjLbY9j5I/yZ/H1I8jg41An78= -github.com/aws/aws-sdk-go-v2/service/oam v1.18.3/go.mod h1:wGhpdyftHX6/1U4egowHkYdypwBMjpb+KjAAprv6z20= -github.com/aws/aws-sdk-go-v2/service/opensearch v1.46.6 h1:Od+ZuCqT6U0kJ1mjQSmo7FMJ90r1AcgJ/qYRoXG6wQo= -github.com/aws/aws-sdk-go-v2/service/opensearch v1.46.6/go.mod h1:0vIvvobMH8MY/GsR1hdcZPISLp16YwQ18D+cMG/3YEc= -github.com/aws/aws-sdk-go-v2/service/opensearchserverless v1.19.6 h1:bF3ZAHXA0INerCsCw+izReGUn8ZgYl61K77Y/X6xSU8= -github.com/aws/aws-sdk-go-v2/service/opensearchserverless v1.19.6/go.mod h1:FJYhjKoTlazvHMw/o+6UOPgejUyTtri14Z3GKzOCHDk= -github.com/aws/aws-sdk-go-v2/service/organizations v1.39.0 h1:8dPwqXepW7uF1+20KEXZMkVKxHsCUUt6Fc0Zypx9tPg= -github.com/aws/aws-sdk-go-v2/service/organizations v1.39.0/go.mod h1:5MRPiBYQXFmgqmnXbhAVtKk9SebdLGFRmaa8gz1K4cM= -github.com/aws/aws-sdk-go-v2/service/osis v1.15.5 h1:GKITYwhEre2s69oYPdtOKXca7TWf+nJVzIasQCqi+LA= -github.com/aws/aws-sdk-go-v2/service/osis v1.15.5/go.mod h1:Z4CSw4zWtSRQf2YUTFFm8DzccAwxYPZCoCRhgLMH9lE= -github.com/aws/aws-sdk-go-v2/service/outposts v1.51.0 h1:HLhXiT+SOlYunW0KlOUSS2jVy2OUQEdo54umLSf1Bmk= -github.com/aws/aws-sdk-go-v2/service/outposts v1.51.0/go.mod h1:XiGs3zv9ejL2VLM77wccs1qBnsmyAFnWs5Fs6iptvWY= -github.com/aws/aws-sdk-go-v2/service/paymentcryptography v1.19.0 h1:Lwws0exTQXDwOtnvHQgDTA4xOv6Fh3o9SfU0hTCa/gQ= -github.com/aws/aws-sdk-go-v2/service/paymentcryptography v1.19.0/go.mod h1:T1vNF1UfLFdQhuJmDLWlGNG2lo/OzX9xjjUSNnHW1OE= -github.com/aws/aws-sdk-go-v2/service/pcaconnectorad v1.11.3 h1:Kcd4PcPvUaNIffZP1O0Kr4Ki2n6WJJOGKgIUbZxMaDU= -github.com/aws/aws-sdk-go-v2/service/pcaconnectorad v1.11.3/go.mod h1:zkxvVWdC/LpE3YfN6hmdVXA+2NwIzHs5sItf6Obv73o= -github.com/aws/aws-sdk-go-v2/service/pcs v1.6.2 h1:b1iBwCTqJRqpy8FMv/0d049PLwCa3Jk8+UVAh7qIF+0= -github.com/aws/aws-sdk-go-v2/service/pcs v1.6.2/go.mod h1:C3xBB9K56xxpHoxjN3i60zbcwcjpNpJilYIGC87LWGc= -github.com/aws/aws-sdk-go-v2/service/pinpoint v1.35.4 h1:gvptUhrWhuZQBPFXei0IKyZHkNjcTUOh1BGL695Eens= -github.com/aws/aws-sdk-go-v2/service/pinpoint v1.35.4/go.mod h1:wXJlxfvejDIFeYJIlZv0djXvLAKY8a81OBH+mNrQcEw= -github.com/aws/aws-sdk-go-v2/service/pinpointsmsvoicev2 v1.20.3 h1:DpqKXU5uVGg+UBGTj6enBcTI41KO/z+fwmCR76rKml4= -github.com/aws/aws-sdk-go-v2/service/pinpointsmsvoicev2 v1.20.3/go.mod h1:klV/eNAO1c5q00dtuTEuLZZkQZgkO/NnkRG7dKRI76U= -github.com/aws/aws-sdk-go-v2/service/pipes v1.19.5 h1:KQnsuly2Ch7DJ9htsCdksI/tqFi7pQ0q69W5G+USmyY= -github.com/aws/aws-sdk-go-v2/service/pipes v1.19.5/go.mod h1:rBlgG8h2mfLBNrY7Z0gz9AYjbFqoqHpMVKUUH5YbBpA= -github.com/aws/aws-sdk-go-v2/service/polly v1.48.4 h1:HIqVbJqUkRNkDB/FfCvvck4GkYz/9X80pz0wt3/aR28= -github.com/aws/aws-sdk-go-v2/service/polly v1.48.4/go.mod h1:Yzmq1/XqHdnsMPyAlIoxnWGlpmkpAwZ4HmoEcBg3nAk= -github.com/aws/aws-sdk-go-v2/service/pricing v1.34.5 h1:VPKHJpSkYojMxD/nN//88/yVauw2lab1q3P6+J0dfvs= -github.com/aws/aws-sdk-go-v2/service/pricing v1.34.5/go.mod h1:21H9QmAqGSjeskZ7iZkuQ9GNuCOR3j2gt2FBct6wMyg= -github.com/aws/aws-sdk-go-v2/service/qbusiness v1.28.0 h1:3QtHatGoArrO2x3IMaKxYYj/tUQht/n18gezryaR7No= -github.com/aws/aws-sdk-go-v2/service/qbusiness v1.28.0/go.mod h1:FqAEEpHUKMoLeaFEJlsVYz0LmTyGzFW1QYH+DbK2WiA= -github.com/aws/aws-sdk-go-v2/service/qldb v1.26.4 h1:wA14NpU1FWcexAceWHCFPEkCtel9IbTrajBNIlxlgc8= -github.com/aws/aws-sdk-go-v2/service/qldb v1.26.4/go.mod h1:x5TT9jzcs+eoh14Xg2kCOix2jn/Je9cLiKUT5JPQnPc= -github.com/aws/aws-sdk-go-v2/service/quicksight v1.87.0 h1:tprZwg0iv7F48Ou6AKJqlmVrifP6wz6DYjNyvBFz5aI= -github.com/aws/aws-sdk-go-v2/service/quicksight v1.87.0/go.mod h1:2qi3N8xyA+QSqxlkwy9+tglelPujRpN0g74BUDqOuFI= -github.com/aws/aws-sdk-go-v2/service/ram v1.30.6 h1:0a/uXcdUNFS1CancSPzVRwl03Ut3lrDSyOJHwvTLmmU= -github.com/aws/aws-sdk-go-v2/service/ram v1.30.6/go.mod h1:qmavcnsJquTI5vYHDnKNNxbcy0C/c0PQZgLysBQwLEE= -github.com/aws/aws-sdk-go-v2/service/rbin v1.22.6 h1:7tsUhpKIsnK31UTnLER6u5bpYIkeIxCscQvzou6f240= -github.com/aws/aws-sdk-go-v2/service/rbin v1.22.6/go.mod h1:wIGDZidVXHKiPsFtKSKBpmDWt7vEZMcI4onWsQSrX0U= -github.com/aws/aws-sdk-go-v2/service/rds v1.99.1 h1:eiDDf+cf2fAxOF5XaGLlrdCZPsnr5BTcPW55UK92sY4= -github.com/aws/aws-sdk-go-v2/service/rds v1.99.1/go.mod h1:Xe+NMlf/DY/XTXSevASAjGRika9Qt2LnuCDLtos03ms= -github.com/aws/aws-sdk-go-v2/service/redshift v1.54.6 h1:5u13KKciWFrXs3pkiG45cZfjAxCxHHCbhTm/Dg3GRas= -github.com/aws/aws-sdk-go-v2/service/redshift v1.54.6/go.mod h1:CFY4v8m7Nd96aVuFyNU+ujY+1Uim7JrJnAd0jkLf2Zg= -github.com/aws/aws-sdk-go-v2/service/redshiftdata v1.33.3 h1:q3xxlF1/eZjmkfUxn4y2GTaYJTfbXBOIdbVLpfnJHcM= -github.com/aws/aws-sdk-go-v2/service/redshiftdata v1.33.3/go.mod h1:rOBWa0PxH6/EjgXOWWzPK38yYhBPfcnyKdkNdZYhBEk= -github.com/aws/aws-sdk-go-v2/service/redshiftserverless v1.27.4 h1:KIx8wB5F1QjXZ+RPuemTKLHMZgoVojeN9zOhfC+17F0= -github.com/aws/aws-sdk-go-v2/service/redshiftserverless v1.27.4/go.mod h1:mO00EfrGvLQ9TE+tQb6Y2CToVq//1jQHbQN4LD12zDw= -github.com/aws/aws-sdk-go-v2/service/rekognition v1.47.2 h1:jhI8d308+/rJ0/x/LIfBWC1KU3pcNxx3mc66HVbUddY= -github.com/aws/aws-sdk-go-v2/service/rekognition v1.47.2/go.mod h1:P1V4mtg5tYOQl0nGcDh4hP2KyIVowqz6YgLcehtAkQo= -github.com/aws/aws-sdk-go-v2/service/resiliencehub v1.30.4 h1:4r+dMPXSz/8/V1ZV7TXb9sT71z7iAcc0Y4wmJVjPLgc= -github.com/aws/aws-sdk-go-v2/service/resiliencehub v1.30.4/go.mod h1:E2eHCs6AP0Cbd/ybgu5o6GQzTPDDcZsyxufzbQOp2bY= -github.com/aws/aws-sdk-go-v2/service/resourceexplorer2 v1.17.6 h1:WYnJp7XLZv6vJ2Axgcn47DumaXgPSkWxKp+8hL5g5ZI= -github.com/aws/aws-sdk-go-v2/service/resourceexplorer2 v1.17.6/go.mod h1:rMeCGU1Fk8JtLMf9kWQxtaUaRDEGOJkGNedJuayjFTo= -github.com/aws/aws-sdk-go-v2/service/resourcegroups v1.29.3 h1:ydDDSNE36VbioP+xbfab1nYP5SDTOR5V8ZcUvZBImr4= -github.com/aws/aws-sdk-go-v2/service/resourcegroups v1.29.3/go.mod h1:pXO3jDiaYQ49dzcDP/Mtz1VoTLEtqjnuINWeJXv+ktk= -github.com/aws/aws-sdk-go-v2/service/resourcegroupstaggingapi v1.26.6 h1:PwbxovpcJvb25k019bkibvJfCpCmIANOFrXZIFPmRzk= -github.com/aws/aws-sdk-go-v2/service/resourcegroupstaggingapi v1.26.6/go.mod h1:Z4xLt5mXspLKjBV92i165wAJ/3T6TIv4n7RtIS8pWV0= -github.com/aws/aws-sdk-go-v2/service/rolesanywhere v1.17.5 h1:fYXMgp0V6C5ndZosonHNh8J/xs1aBMfz5qANMlphHV4= -github.com/aws/aws-sdk-go-v2/service/rolesanywhere v1.17.5/go.mod h1:fGrCQme6bxmDiu+Ppun1qOWmoNSIMbIy5UKFIOaTF8o= -github.com/aws/aws-sdk-go-v2/service/route53 v1.53.0 h1:UglIEyurCqfzZkjNdYAuXUGFu/FNWMKP5eorzggvXe8= -github.com/aws/aws-sdk-go-v2/service/route53 v1.53.0/go.mod h1:wi1naoiPnCQG3cyjsivwPON1ZmQt/EJGxFqXzubBTAw= -github.com/aws/aws-sdk-go-v2/service/route53domains v1.29.4 h1:8qeQjFNXdLd8+4YNVspNHjUrc0wmfrUievd+fOde838= -github.com/aws/aws-sdk-go-v2/service/route53domains v1.29.4/go.mod h1:/dfYzVaLi84gzj8D7RXrF7KIgOBJ4Zk7jp7gQVltBTg= -github.com/aws/aws-sdk-go-v2/service/route53profiles v1.5.9 h1:zDOaPWYn4k8yY8pRQUmJQUACPzRNu8ChPMvCA96XWlg= -github.com/aws/aws-sdk-go-v2/service/route53profiles v1.5.9/go.mod h1:f/B7apleFy+Nxs6wY0pzA9UbIx0ldX30ZMvy1SO7tAU= -github.com/aws/aws-sdk-go-v2/service/route53recoverycontrolconfig v1.27.3 h1:W7llNxOpVt0M0ToRkGXUs5UjMkntd6+DDesE5A4YXt8= -github.com/aws/aws-sdk-go-v2/service/route53recoverycontrolconfig v1.27.3/go.mod h1:yXZ+EM/v38MqqCHl2fTS7Ftv7vLuwxkR4SG6qAkKCdQ= -github.com/aws/aws-sdk-go-v2/service/route53recoveryreadiness v1.22.4 h1:mLYxsH/6tzncWzXTMt0SRp3BradtNrlM1va9Qa2AfQw= -github.com/aws/aws-sdk-go-v2/service/route53recoveryreadiness v1.22.4/go.mod h1:9GWWA+r8JCyTMm3X3xUBJxU7o/+v4SMlksksVyMEmkc= -github.com/aws/aws-sdk-go-v2/service/route53resolver v1.36.0 h1:gkR6ADqZBV4RzK+FZVI818Rula1i85/G3JlGnn6FDY0= -github.com/aws/aws-sdk-go-v2/service/route53resolver v1.36.0/go.mod h1:lQW5vqGKTvNpIJ0DVG7dVyJ02OZnSlcLFHgZUpZhEw8= -github.com/aws/aws-sdk-go-v2/service/rum v1.24.4 h1:PF+oU9cTdUFQ3nW+A2qarZQF5txhjRgu8xUotk6y2BA= -github.com/aws/aws-sdk-go-v2/service/rum v1.24.4/go.mod h1:0E3Cb8i2piw7fqp157xGd9tKYbc6r+V2UW7sKzNbw/k= -github.com/aws/aws-sdk-go-v2/service/s3 v1.83.0 h1:5Y75q0RPQoAbieyOuGLhjV9P3txvYgXv2lg0UwJOfmE= -github.com/aws/aws-sdk-go-v2/service/s3 v1.83.0/go.mod h1:kUklwasNoCn5YpyAqC/97r6dzTA1SRKJfKq16SXeoDU= -github.com/aws/aws-sdk-go-v2/service/s3control v1.60.0 h1:uVNDtWESoQ5Mm+O6FERGOaxLxcmUJ/gj5/2zmdznTsQ= -github.com/aws/aws-sdk-go-v2/service/s3control v1.60.0/go.mod h1:uZDSKJgJ3w3MOjtuvrYMTI7APdGNycg7srBGzaclI+s= -github.com/aws/aws-sdk-go-v2/service/s3outposts v1.29.4 h1:oZjDliGfblCLGHBlw1CTTHaVYB6MkD+ss5AxhqoX1K0= -github.com/aws/aws-sdk-go-v2/service/s3outposts v1.29.4/go.mod h1:E2HKzJfiZE7AfaaPKwKyuHsFCT6CMQx+xA+RBfvNMKY= -github.com/aws/aws-sdk-go-v2/service/s3tables v1.5.0 h1:Y4Jkb371eWF3VDKppy2OBFJqBm+wEXsmkHu9NB5Xvo8= -github.com/aws/aws-sdk-go-v2/service/s3tables v1.5.0/go.mod h1:fTauvBZjNMRnXoEDSo+FFAW0BuLiWpilnB7dz8lnqhY= -github.com/aws/aws-sdk-go-v2/service/sagemaker v1.200.1 h1:EdANB2MVaCwY/YPKyqsdBgHo8DgsGb+Zp6qo/6zfHOw= -github.com/aws/aws-sdk-go-v2/service/sagemaker v1.200.1/go.mod h1:uRG58IrTnRkk83JKfW9BgMpU1MKuHtcwdiBfQyC7agw= -github.com/aws/aws-sdk-go-v2/service/scheduler v1.13.10 h1:rehUqeN8NgQew7PvE/6XeaVyeDXj9fVhM2FMt/PNOM0= -github.com/aws/aws-sdk-go-v2/service/scheduler v1.13.10/go.mod h1:6g2NPTPm0cx1YV1zYJbWXz80wn+xyX0JSBixqRSC99o= -github.com/aws/aws-sdk-go-v2/service/schemas v1.29.5 h1:gCVa2/ufz9Wus7Tw3flUsqwUMyk8oEuTPDcYX9xWuVk= -github.com/aws/aws-sdk-go-v2/service/schemas v1.29.5/go.mod h1:tQVkDFNskR9bKFWpMUtgOMNM1hpL3oAuPRzESx/z73U= -github.com/aws/aws-sdk-go-v2/service/secretsmanager v1.35.7 h1:d+mnMa4JbJlooSbYQfrJpit/YINaB30JEVgrhtjZneA= -github.com/aws/aws-sdk-go-v2/service/secretsmanager v1.35.7/go.mod h1:1X1NotbcGHH7PCQJ98PsExSxsJj/VWzz8MfFz43+02M= -github.com/aws/aws-sdk-go-v2/service/securityhub v1.58.0 h1:5phjeFKLN8b67+CztpBzG9mUOPrsMVryJ9OToMOL21E= -github.com/aws/aws-sdk-go-v2/service/securityhub v1.58.0/go.mod h1:umtmPOd8goFeECUPe2Y1wigFIVrjwLR6GP5+eWmnUBw= -github.com/aws/aws-sdk-go-v2/service/securitylake v1.20.5 h1:Cqeb3ccjhi5YEOlqYP3BLtEcYM+SiZeKgPs2z6FLlvM= -github.com/aws/aws-sdk-go-v2/service/securitylake v1.20.5/go.mod h1:3TwtWEaAiv848bYEEiH9Yg79y5bXKyEDytGh7KUOeS0= -github.com/aws/aws-sdk-go-v2/service/serverlessapplicationrepository v1.25.4 h1:7eJSfME7No7WvRNFJI5o9fkBOOugNLXFqfn6AHHHguo= -github.com/aws/aws-sdk-go-v2/service/serverlessapplicationrepository v1.25.4/go.mod h1:9noDAe04msoEwCStlekEqsxzSj44udPquS2Zen4XS0k= -github.com/aws/aws-sdk-go-v2/service/servicecatalog v1.34.2 h1:24S4nRk43CjgWiOlzHDv42q+PyFBZh35q4hgT7d5+6E= -github.com/aws/aws-sdk-go-v2/service/servicecatalog v1.34.2/go.mod h1:O1PtvWmaeH2OMbGOpP0M717VrEtEm3L8s4t5Ehi844I= -github.com/aws/aws-sdk-go-v2/service/servicecatalogappregistry v1.31.4 h1:5LV110/+dsFA3aut0evkDAMxqYOEziZrmQnWo3+2vBQ= -github.com/aws/aws-sdk-go-v2/service/servicecatalogappregistry v1.31.4/go.mod h1:X4EuhIl3vZvJ8fIRTHOvFGblAeUnnZ9bsS5Awlyr1cU= -github.com/aws/aws-sdk-go-v2/service/servicediscovery v1.35.7 h1:1eaP4/444jrv04HhJdwTHtgnyxWgxwdLjSYBGq+oMB4= -github.com/aws/aws-sdk-go-v2/service/servicediscovery v1.35.7/go.mod h1:czoZQabc2chvmV/ak4oGSNR9CbcUw2bef3tatmwtoIA= -github.com/aws/aws-sdk-go-v2/service/servicequotas v1.28.3 h1:FDzX6WOfsz45IVvbP5O987/hdzjciDPek+AO9BOfDXk= -github.com/aws/aws-sdk-go-v2/service/servicequotas v1.28.3/go.mod h1:y10lwaaUXvDg/W5tn2WN5WQEMw/2T4tg7AW5jISZVw0= -github.com/aws/aws-sdk-go-v2/service/ses v1.30.5 h1:MGqdFy1jSw9rBN5qxLpeFGtwLTev1LIbNX7v3mVPZ2U= -github.com/aws/aws-sdk-go-v2/service/ses v1.30.5/go.mod h1:Zftob00wu8O9xWSN1pdczm1U+E6yXk9znf+4lkt+3aQ= -github.com/aws/aws-sdk-go-v2/service/sesv2 v1.46.0 h1:uNAn3m1yFv+7j+tbsAh36kG8JvZlUgZbzdQPSC6W0m4= -github.com/aws/aws-sdk-go-v2/service/sesv2 v1.46.0/go.mod h1:dy6XqJdtxnu7f9sQVHFMnH1OSlAS62R5feiHQ8WsI4s= -github.com/aws/aws-sdk-go-v2/service/sfn v1.35.7 h1:W5ZFACjUxkIjjtMGG21GhJ3uJfV7ejEsOkJTQHMHrEY= -github.com/aws/aws-sdk-go-v2/service/sfn v1.35.7/go.mod h1:x82j2Ux2Qr9Qzdb47peCIIa8agq7z3k0Zf4TWHEAxjo= -github.com/aws/aws-sdk-go-v2/service/shield v1.30.4 h1:B0NxDxP+NI18kFZiMwUUKVSWEcBwviWjTl4KMfWa3X8= -github.com/aws/aws-sdk-go-v2/service/shield v1.30.4/go.mod h1:07i7GZpF9rdMNRPkfUa3ymRq63Liej297OCz6wiWmiM= -github.com/aws/aws-sdk-go-v2/service/signer v1.27.4 h1:nU51n8zv3mLn9wxZ0cxkToQRsrnqNLg5xJ0j//GF58c= -github.com/aws/aws-sdk-go-v2/service/signer v1.27.4/go.mod h1:6bQTKM4Ryk9vKxVd4fc7uNAw2TI+hfY+lMhkmmEmnWw= -github.com/aws/aws-sdk-go-v2/service/sns v1.34.7 h1:OBuZE9Wt8h2imuRktu+WfjiTGrnYdCIJg8IX92aalHE= -github.com/aws/aws-sdk-go-v2/service/sns v1.34.7/go.mod h1:4WYoZAhHt+dWYpoOQUgkUKfuQbE6Gg/hW4oXE0pKS9U= -github.com/aws/aws-sdk-go-v2/service/sqs v1.38.8 h1:80dpSqWMwx2dAm30Ib7J6ucz1ZHfiv5OCRwN/EnCOXQ= -github.com/aws/aws-sdk-go-v2/service/sqs v1.38.8/go.mod h1:IzNt/udsXlETCdvBOL0nmyMe2t9cGmXmZgsdoZGYYhI= -github.com/aws/aws-sdk-go-v2/service/ssm v1.60.0 h1:YuMspnzt8uHda7a6A/29WCbjMJygyiyTvq480lnsScQ= -github.com/aws/aws-sdk-go-v2/service/ssm v1.60.0/go.mod h1:IyVabkWrs8SNdOEZLyFFcW9bUltV4G6OQS0s6H20PHg= -github.com/aws/aws-sdk-go-v2/service/ssmcontacts v1.27.4 h1:HhwkyHRVIhGsBnezpwwH2wyrZQKooN9mYuW15/yM8rY= -github.com/aws/aws-sdk-go-v2/service/ssmcontacts v1.27.4/go.mod h1:bVvmYEJmT2xWBx269zEAWlQxJfkcfqyvB1JFjSRrzFc= -github.com/aws/aws-sdk-go-v2/service/ssmincidents v1.35.4 h1:u8qJueBRnlcWupt1Z6zXFDcHa4eGCV9REex7r9sQnhM= -github.com/aws/aws-sdk-go-v2/service/ssmincidents v1.35.4/go.mod h1:TwlNzbOPcE2NBuNLgZ1B6VfYJ0JG8WkEwOhKidrskW0= -github.com/aws/aws-sdk-go-v2/service/ssmquicksetup v1.4.4 h1:WcyN7tIJrpezkcj7c0WzlbjhOo6ojDa8QL5+jXvSZ24= -github.com/aws/aws-sdk-go-v2/service/ssmquicksetup v1.4.4/go.mod h1:kuwVH10c0+zEubkw7doHtNK6y5hsf6smmsRFBmK13Lo= -github.com/aws/aws-sdk-go-v2/service/ssmsap v1.20.4 h1:bzHaYrE7qNBohcfbhlXrBnV0/hk2J4fPysDxYwLCKok= -github.com/aws/aws-sdk-go-v2/service/ssmsap v1.20.4/go.mod h1:Z4RGgCEebqIsIhj6KJzTCJR7PmWwO9luAYplvGghIH0= -github.com/aws/aws-sdk-go-v2/service/sso v1.25.5 h1:AIRJ3lfb2w/1/8wOOSqYb9fUKGwQbtysJ2H1MofRUPg= -github.com/aws/aws-sdk-go-v2/service/sso v1.25.5/go.mod h1:b7SiVprpU+iGazDUqvRSLf5XmCdn+JtT1on7uNL6Ipc= -github.com/aws/aws-sdk-go-v2/service/ssoadmin v1.31.2 h1:3dryJFNlYa+kgSlHLAcFpQQOeE8g+h2XX3NoiLeB8Yw= -github.com/aws/aws-sdk-go-v2/service/ssoadmin v1.31.2/go.mod h1:EZSMWhfY55eXlAhKcQmkHMrRqwhOXWOiFcW9jrehv00= -github.com/aws/aws-sdk-go-v2/service/ssooidc v1.30.3 h1:BpOxT3yhLwSJ77qIY3DoHAQjZsc4HEGfMCE4NGy3uFg= -github.com/aws/aws-sdk-go-v2/service/ssooidc v1.30.3/go.mod h1:vq/GQR1gOFLquZMSrxUK/cpvKCNVYibNyJ1m7JrU88E= -github.com/aws/aws-sdk-go-v2/service/storagegateway v1.38.0 h1:VJuHn5d3gzArmJetVkngTKs0RxY6WhlWXt6RkYDPblA= -github.com/aws/aws-sdk-go-v2/service/storagegateway v1.38.0/go.mod h1:qtpDf/mpKyH0BYUVwct88hqiA9/znvnlxpoYcEZ0+Hw= -github.com/aws/aws-sdk-go-v2/service/sts v1.34.0 h1:NFOJ/NXEGV4Rq//71Hs1jC/NvPs1ezajK+yQmkwnPV0= -github.com/aws/aws-sdk-go-v2/service/sts v1.34.0/go.mod h1:7ph2tGpfQvwzgistp2+zga9f+bCjlQJPkPUmMgDSD7w= -github.com/aws/aws-sdk-go-v2/service/swf v1.28.6 h1:tKh4RXgqwnIV5+2LW53y0LAA/+sWUJSsSBUZqEQC7/I= -github.com/aws/aws-sdk-go-v2/service/swf v1.28.6/go.mod h1:uIxNj0mirk5vpL/vW1Ko/UwyxOigm+BAVgsM+l2psOA= -github.com/aws/aws-sdk-go-v2/service/synthetics v1.35.3 h1:CuUOM3i9r2U/kpqJDQj8p3Hi0if2N44gl5+qPXImpTM= -github.com/aws/aws-sdk-go-v2/service/synthetics v1.35.3/go.mod h1:xo1aJ/YLmmEMwVU9aOvN4E7jOKgoAAr+6VDAJv+MNl0= -github.com/aws/aws-sdk-go-v2/service/taxsettings v1.12.2 h1:WZPhlC3G/mYx99l/QHl95U/Ue+al6UfPFdTbhbbiRUs= -github.com/aws/aws-sdk-go-v2/service/taxsettings v1.12.2/go.mod h1:A77L7LITMEWcVhGBNUyJ0RZLNVdhTIkhfUSQiS85XZM= -github.com/aws/aws-sdk-go-v2/service/timestreaminfluxdb v1.10.5 h1:xmm2T4HJOkJL1SJwNh6xMEm6ocjE1Yh9YZTChHu98DY= -github.com/aws/aws-sdk-go-v2/service/timestreaminfluxdb v1.10.5/go.mod h1:L4tT63t++iYucM3oLQ5aUQcbvgunzP/xg+ztYfOd1EI= -github.com/aws/aws-sdk-go-v2/service/timestreamquery v1.31.2 h1:CjrXUjlaUS5MjPH6KMpZiFd3VNKDsgxQRSviE4TqWWc= -github.com/aws/aws-sdk-go-v2/service/timestreamquery v1.31.2/go.mod h1:HyCb70yWplefVU5tLdVevHVv1fK6XS11cltC8KX0B0s= -github.com/aws/aws-sdk-go-v2/service/timestreamwrite v1.31.2 h1:HF3f6gSaqLSvqsUVIV0yIPucA9LInGi0V1hK3zUAgxI= -github.com/aws/aws-sdk-go-v2/service/timestreamwrite v1.31.2/go.mod h1:IZWUn9UPCdqPKM+72yj4HxXMXpOCpP7vqW8dctO5Jlo= -github.com/aws/aws-sdk-go-v2/service/transcribe v1.47.0 h1:ASsg4ST0Lgr08AY5nT93g5/BrxJuezA7jI0XKiVK0y0= -github.com/aws/aws-sdk-go-v2/service/transcribe v1.47.0/go.mod h1:ezb4DgeVVNn4S7Wy8eRQ8sy+QHRtzbW7SAKHxZy4ndY= -github.com/aws/aws-sdk-go-v2/service/transfer v1.61.0 h1:5OkUYsglfPicnhv2WAgAzh4gR32iPiNZ2dPMtuzXCDE= -github.com/aws/aws-sdk-go-v2/service/transfer v1.61.0/go.mod h1:9RJji4Q+u/gu2Te56e+CUpUM2UTCt3sMxzLMXYSJ5Ok= -github.com/aws/aws-sdk-go-v2/service/verifiedpermissions v1.24.2 h1:d43lKGSX+AWhq5a8vpVuJNekcR5MtmB2JU22eaZZDRM= -github.com/aws/aws-sdk-go-v2/service/verifiedpermissions v1.24.2/go.mod h1:4Q5Mgk7BLvRrhwElOeMUlnx3K92I7b8HRNOhyTuousM= -github.com/aws/aws-sdk-go-v2/service/vpclattice v1.14.4 h1:01e650ADK6nHoSN4J/sFlblCXSiFITGHrkGPK+xG+Yw= -github.com/aws/aws-sdk-go-v2/service/vpclattice v1.14.4/go.mod h1:2gAi7UItKOn/1ccFbqRU+6ZtPo9b3ldnDRe9XqYtdYw= -github.com/aws/aws-sdk-go-v2/service/waf v1.26.4 h1:Fgu+w2R0151xwueAlfPYVaXlqWBi2TUUwfsUJrs++34= -github.com/aws/aws-sdk-go-v2/service/waf v1.26.4/go.mod h1:pSLiROd8QQ8WK5uEOOccapEjDwp1AOC5Ywt4d5D3I3w= -github.com/aws/aws-sdk-go-v2/service/wafregional v1.26.4 h1:+J6iG0+kp1vj5g5KhQHbZDHUidbwFK8LTUlI4t5tIL0= -github.com/aws/aws-sdk-go-v2/service/wafregional v1.26.4/go.mod h1:k6xElMGoSjEbhEpFJ/g+oP8f0/Eprf43xDr0kNG9Dug= -github.com/aws/aws-sdk-go-v2/service/wafv2 v1.63.1 h1:FqB3NmVKnZ/2oS9uv1AWunzCusEqSp9USs9BGx4EwSw= -github.com/aws/aws-sdk-go-v2/service/wafv2 v1.63.1/go.mod h1:zclPwcQ0Ju4OLYCUtaIp+BA5K5KdxjeBLpKd1HsMVqM= -github.com/aws/aws-sdk-go-v2/service/wellarchitected v1.35.4 h1:1oNo99IUfAPoMV/g1apd+J5QuYAunU788Wn4FmvzYt0= -github.com/aws/aws-sdk-go-v2/service/wellarchitected v1.35.4/go.mod h1:dkxQxiW/xGedseew2TBbkzEHQ6UHx1Op4ZiSv8dbuNg= -github.com/aws/aws-sdk-go-v2/service/workspaces v1.58.0 h1:NknK5ksEdnfMdPkhPedhoOQzb5bhd4/5ZNaYJTJRfaM= -github.com/aws/aws-sdk-go-v2/service/workspaces v1.58.0/go.mod h1:zzXFHVKbJU2FcSWXP2so1X/Ght2lrOrXUPt9M/kFOtI= -github.com/aws/aws-sdk-go-v2/service/workspacesweb v1.27.4 h1:XomoEUvUlwFKpmJ6qejWT+Gflkhe0WmSU3x5JGhGFYw= -github.com/aws/aws-sdk-go-v2/service/workspacesweb v1.27.4/go.mod h1:O46IBclbuIwlp3plLPOF+HHBDJdIDBqMycf6GPrISuE= -github.com/aws/aws-sdk-go-v2/service/xray v1.31.7 h1:zJL4lRhsNpSYggXij+GBfDmEVT809ElOkhElTKoxeTw= -github.com/aws/aws-sdk-go-v2/service/xray v1.31.7/go.mod h1:GJrs2NbUJi1iUwUjMC+OwC7H24YmDwyJVRUKzVIgA0c= -github.com/aws/smithy-go v1.22.4 h1:uqXzVZNuNexwc/xrh6Tb56u89WDlJY6HS+KC0S4QSjw= -github.com/aws/smithy-go v1.22.4/go.mod h1:t1ufH5HMublsJYulve2RKmHDC15xu1f26kHCp/HgceI= -github.com/beevik/etree v1.5.1 h1:TC3zyxYp+81wAmbsi8SWUpZCurbxa6S8RITYRSkNRwo= -github.com/beevik/etree v1.5.1/go.mod h1:gPNJNaBGVZ9AwsidazFZyygnd+0pAU38N4D+WemwKNs= +github.com/aws/aws-sdk-go-v2/internal/v4a v1.4.6 h1:R0tNFJqfjHL3900cqhXuwQ+1K4G0xc9Yf8EDbFXCKEw= +github.com/aws/aws-sdk-go-v2/internal/v4a v1.4.6/go.mod h1:y/7sDdu+aJvPtGXr4xYosdpq9a6T9Z0jkXfugmti0rI= +github.com/aws/aws-sdk-go-v2/service/accessanalyzer v1.44.2 h1:CV594KI3G5YUW6gMyY3FZSJn43wg0RdnpbU1sec/6ww= +github.com/aws/aws-sdk-go-v2/service/accessanalyzer v1.44.2/go.mod h1:WAcHFG0G2iM8i56FwE5IciRhCgvEByRsm4PBOWKE39k= +github.com/aws/aws-sdk-go-v2/service/account v1.28.2 h1:2M9jLruQ9NEmJ8OJfJPT3m595C/g8Bwi3+UqMHwNQak= +github.com/aws/aws-sdk-go-v2/service/account v1.28.2/go.mod h1:+wm3rOFQq9upDxz3DLkA+qo8qF6fEXNDdJc+FCmFKGg= +github.com/aws/aws-sdk-go-v2/service/acm v1.37.2 h1:xHL377Sv01f+x0+vOTgxCAldxjY24Li5qmYPJ1ky6Xk= +github.com/aws/aws-sdk-go-v2/service/acm v1.37.2/go.mod h1:O0RIJKU/HcON/0R940lIHsfGNTix0AVrefYOPcKKZrM= +github.com/aws/aws-sdk-go-v2/service/acmpca v1.44.1 h1:57Zj23al3/5z0+EL/bTXg60JCesEuCQFOFsaYT4Q/Ug= +github.com/aws/aws-sdk-go-v2/service/acmpca v1.44.1/go.mod h1:8hG5y8K/+UAo2EuqP+zNKjTsMRpIAueEoZ+lOXfu5dM= +github.com/aws/aws-sdk-go-v2/service/amp v1.39.2 h1:IDias597FmaTXyZjz0PpcQqZu4M3PvUoU9pEy3ZKy0w= +github.com/aws/aws-sdk-go-v2/service/amp v1.39.2/go.mod h1:Y7h/Fwzhh3K06Pq7E0KQeG3Ig1gu3Co7n6vRu0HQ3Lw= +github.com/aws/aws-sdk-go-v2/service/amplify v1.37.1 h1:7XHZ8P8to6LYUiwgopfJQZ5gKVttC7fbhqKLDZrLG0Q= +github.com/aws/aws-sdk-go-v2/service/amplify v1.37.1/go.mod h1:w78lilq00niyoQpilDNnEd/twrrBIJsd7yWMHqy0Q+M= +github.com/aws/aws-sdk-go-v2/service/apigateway v1.35.2 h1:v9Y2bqzpf+ZlzVhzzbT2lXYUyUQJY4oYOISeiTzsXBE= +github.com/aws/aws-sdk-go-v2/service/apigateway v1.35.2/go.mod h1:GrF7L3G4zf6kSlEPe0g5U0+NM6aD3sbYTXxtZ2WpbhY= +github.com/aws/aws-sdk-go-v2/service/apigatewayv2 v1.32.2 h1:iFj4I9K3+rSYzscyL325U3M1gK+trwKivF5mS9qOV0o= +github.com/aws/aws-sdk-go-v2/service/apigatewayv2 v1.32.2/go.mod h1:0EtzxxLlK3I1QAKBhXQvUgqu//VUtOgVSS0Fxgc2Cv8= +github.com/aws/aws-sdk-go-v2/service/appconfig v1.42.2 h1:oF8852TUzZ7SlOTFYwhdVwRa0QCNcO12C10ITVPmzDw= +github.com/aws/aws-sdk-go-v2/service/appconfig v1.42.2/go.mod h1:FMfpZdFkhXRanuAck3GM43SV2g2yE8ZN3hEudANx6I8= +github.com/aws/aws-sdk-go-v2/service/appfabric v1.16.2 h1:05ZgmHa5476oKwB5eUNvTjRpUxEAdsVC2wd8W8E0rUk= +github.com/aws/aws-sdk-go-v2/service/appfabric v1.16.2/go.mod h1:931/c29HkZHHXxYob7A/cKbhAkDfc7aGd8ItlZtJRmM= +github.com/aws/aws-sdk-go-v2/service/appflow v1.50.2 h1:MQ3CevjMr46z5Y7E0jwdx1thdZcZBaft8jiME2aiv1I= +github.com/aws/aws-sdk-go-v2/service/appflow v1.50.2/go.mod h1:i6xYGmbdCd1f0O1yO/GEWYjaFZSTpCG9pLuwEVMt3dw= +github.com/aws/aws-sdk-go-v2/service/appintegrations v1.36.2 h1:OnzDoF1r5KAIk/zetG694RGns8Ij5o4+Grh6JFgqwUQ= +github.com/aws/aws-sdk-go-v2/service/appintegrations v1.36.2/go.mod h1:uFYfmSyXgRqjRTRZ9BAXBxWc+HycCNVPD4OFzP0Pj/U= +github.com/aws/aws-sdk-go-v2/service/applicationautoscaling v1.40.1 h1:7taUYNlFqizsaiMdHHRThw4zeTJiwlwf6LuYSncdJqQ= +github.com/aws/aws-sdk-go-v2/service/applicationautoscaling v1.40.1/go.mod h1:GCi363sGAGpwZJMN9yt0HaC1INLyXlzmitpKhDasbrg= +github.com/aws/aws-sdk-go-v2/service/applicationinsights v1.34.1 h1:lt87uXXt4dCn8EunxEHTdlYfa5AGXm0ETNxgvopugNI= +github.com/aws/aws-sdk-go-v2/service/applicationinsights v1.34.1/go.mod h1:TVdPBUM3rvV3atXHnVlYTZ0+vOnzfqNfyE975szB6rg= +github.com/aws/aws-sdk-go-v2/service/applicationsignals v1.15.4 h1:WzyX5AmWzePDlfPQ9s3sQTgR7fwTQF9w4gBud2k7zD4= +github.com/aws/aws-sdk-go-v2/service/applicationsignals v1.15.4/go.mod h1:yFXpleMg5Ey8HCT2hm3hy/J7DZdlJp1Oh3TU6RSmwMA= +github.com/aws/aws-sdk-go-v2/service/appmesh v1.34.2 h1:HCKeoGJiSrorgMr2fmMSpmb9WPxVSwCEmlmE4uObfLs= +github.com/aws/aws-sdk-go-v2/service/appmesh v1.34.2/go.mod h1:PtSWKYmJuvDvtg6fye2Oz3p6ZMYhQWVbyVwUsE1RGHE= +github.com/aws/aws-sdk-go-v2/service/apprunner v1.38.3 h1:h6HKdn8kmz/bpDAM8eIX/Nu0oSoewQH4l1hiRukqYoE= +github.com/aws/aws-sdk-go-v2/service/apprunner v1.38.3/go.mod h1:17A21aZwtJWcU346UqC5h5iynSNesczxeYQn5TX39lU= +github.com/aws/aws-sdk-go-v2/service/appstream v1.49.2 h1:E7Ls4IRBhbxRzJXaoAqvMAz55EYO2Clag59H8jEzx34= +github.com/aws/aws-sdk-go-v2/service/appstream v1.49.2/go.mod h1:lTjohIjckNGEHnsUrALyTBmrDsonnvaWrUHo+ZtbrHQ= +github.com/aws/aws-sdk-go-v2/service/appsync v1.51.2 h1:CpbqcESjyHtywmjH0Hp31oJSh2tU2uy7mHmyozdL+wQ= +github.com/aws/aws-sdk-go-v2/service/appsync v1.51.2/go.mod h1:7+42mxrcInVf1P8f1R23exdfb34LkH/wVIOJ3ClXWms= +github.com/aws/aws-sdk-go-v2/service/arcregionswitch v1.2.4 h1:Vprtu6GlnfiCP4p7T+DTurEgAGzugvxCSDNOca0gQLY= +github.com/aws/aws-sdk-go-v2/service/arcregionswitch v1.2.4/go.mod h1:FxTxmxbtxbY6xAH1tlD6i/WuqDLVVPPhFsT5YnCoA3c= +github.com/aws/aws-sdk-go-v2/service/athena v1.55.2 h1:JTbSWkhg9TtWN4rWidba9KZVtDsdNvzlrlEhtkJ2n8U= +github.com/aws/aws-sdk-go-v2/service/athena v1.55.2/go.mod h1:SqfRGad1YJst/x6I1nbPS3t9dtmATSwaVU/sxPfo8ts= +github.com/aws/aws-sdk-go-v2/service/auditmanager v1.45.2 h1:maCuWKUKkugR2KylwT900bvkgofYkdcrbziqPPlmwQ0= +github.com/aws/aws-sdk-go-v2/service/auditmanager v1.45.2/go.mod h1:nsfi1OxIVy+jpXQXDfbiXgut3dts8ikR5OsPYwRNhPo= +github.com/aws/aws-sdk-go-v2/service/autoscaling v1.58.2 h1:z6A7RKbrhDiVp5wlV/MgZ03uOv//yLM228nY9Clw2Ds= +github.com/aws/aws-sdk-go-v2/service/autoscaling v1.58.2/go.mod h1:ailCQb+KhHZcMFd/VstivWtcNizcI5lpHxzbk6FI2dM= +github.com/aws/aws-sdk-go-v2/service/autoscalingplans v1.29.1 h1:aR1HH39NRyDjQUBkwiA+TiIxTzvLHG8/N4yQwBp4OYk= +github.com/aws/aws-sdk-go-v2/service/autoscalingplans v1.29.1/go.mod h1:UL218OezrxqSUmkdB4PbsZfXEeOEa0kxgWeChXQDu2I= +github.com/aws/aws-sdk-go-v2/service/backup v1.47.2 h1:Y7QdrFoRbyermqhYVv8SNpLLpd8h8ZS60+Ag9fQTJ2g= +github.com/aws/aws-sdk-go-v2/service/backup v1.47.2/go.mod h1:np/dL9XAcYePqgiJTfl7TqLBEdpNIdngm86uz9vaV/g= +github.com/aws/aws-sdk-go-v2/service/batch v1.57.5 h1:iVVSvFSxyiY+4X3ZzJMeyLBSX6hOhZ+u0dXajlr6fpw= +github.com/aws/aws-sdk-go-v2/service/batch v1.57.5/go.mod h1:/kuiqEICHKG1fj+arz94+JfIfUy+DuHPsZNaKV015oM= +github.com/aws/aws-sdk-go-v2/service/bcmdataexports v1.11.4 h1:rCsX5uQG+TR71GJISV8vvAaWFk3S2MVW5zeYRiLAU7I= +github.com/aws/aws-sdk-go-v2/service/bcmdataexports v1.11.4/go.mod h1:NL8MY5NFgNvl0mgFNb5IdM6noZK+TX4LfmF2CfIdPW4= +github.com/aws/aws-sdk-go-v2/service/bedrock v1.45.2 h1:VTb93pnTP2UadIETvk4zv0BXOw0/qxPEDB1t6rLGDDE= +github.com/aws/aws-sdk-go-v2/service/bedrock v1.45.2/go.mod h1:Z6UKMB49N1t02yf2NDYytv7XD3+p71nj00brl5wxBOE= +github.com/aws/aws-sdk-go-v2/service/bedrockagent v1.50.2 h1:FjYY1QPhbQcortMB7yp0t1eLFk0m0muZZR6DohjcZtw= +github.com/aws/aws-sdk-go-v2/service/bedrockagent v1.50.2/go.mod h1:ZsEdFufjlCVl1G5Wd6NRYr9ARgEhXtdvlcJzxgcFDLw= +github.com/aws/aws-sdk-go-v2/service/bedrockagentcorecontrol v1.4.2 h1:IUMR1nAxcQC3jZoUdLtuPjQArrBilvgaC1dIGx/+nnA= +github.com/aws/aws-sdk-go-v2/service/bedrockagentcorecontrol v1.4.2/go.mod h1:n8frkmYZSCGdKGcK7hH9yyBPinwWKVrEMQbZoMENFo8= +github.com/aws/aws-sdk-go-v2/service/billing v1.7.3 h1:7AeVkpSsE1wOaopMkjHRC3AGjT4bxPbwgclqpSkoQ0Y= +github.com/aws/aws-sdk-go-v2/service/billing v1.7.3/go.mod h1:y0rAFOF713pJRGh6zOwi343ahkdL04Ibuna64FZ0/xg= +github.com/aws/aws-sdk-go-v2/service/budgets v1.37.3 h1:EMOY7Ex+ZHL0NQ0h/O19AH5HeWjVis6WH2NUSf9a60g= +github.com/aws/aws-sdk-go-v2/service/budgets v1.37.3/go.mod h1:/vsWgFIdCFpdyFLRLMsjEJkxzWra/C5oQ/hQSi46iqw= +github.com/aws/aws-sdk-go-v2/service/chatbot v1.14.2 h1:Wi/pLk1uhY65DpSst7EAvxorPZLxD7bZcrPRNl7DdZA= +github.com/aws/aws-sdk-go-v2/service/chatbot v1.14.2/go.mod h1:rx6dqsDi9Ty8NlUnx2Jvs07na6XUVyu1sTszM4DcqNI= +github.com/aws/aws-sdk-go-v2/service/chime v1.40.1 h1:yAd8AQKAspLHfsOYHDipEgx34ocbH085BO4s039gPBg= +github.com/aws/aws-sdk-go-v2/service/chime v1.40.1/go.mod h1:0BKNnUBOVTsOH3svKuVHbc5Or1eMOW7PM5IvStfJ1wg= +github.com/aws/aws-sdk-go-v2/service/chimesdkmediapipelines v1.26.2 h1:kx06nIs4bnHaGVTRvkiw5pCNfPkRCctjM4P1YXdVh/I= +github.com/aws/aws-sdk-go-v2/service/chimesdkmediapipelines v1.26.2/go.mod h1:jqJrPA64O8ZI7pqR0sWSNj73NdRhf0AxCvVUfrv4BAo= +github.com/aws/aws-sdk-go-v2/service/chimesdkvoice v1.26.1 h1:O9bLIMtriAFtiU4qnppOXhqNNWuMHXYbX2pLcV8uzkY= +github.com/aws/aws-sdk-go-v2/service/chimesdkvoice v1.26.1/go.mod h1:QcftJ3U92WQXE1ZJ7ODgTCJhcuVblb9czGv4no9GTC4= +github.com/aws/aws-sdk-go-v2/service/cleanrooms v1.31.2 h1:V2QpAhHq/SUAAN0KN0NLrPy1vwP8l7OSJGcwaKVd8oY= +github.com/aws/aws-sdk-go-v2/service/cleanrooms v1.31.2/go.mod h1:rG+in10QL0Dn0HZNc8PxujO69CxAEW0F9kT0DbX7iAM= +github.com/aws/aws-sdk-go-v2/service/cloud9 v1.33.1 h1:q1IAmb2fLTce5Cg2oBsJgLaH2AEwdIXF03RdHAwUue4= +github.com/aws/aws-sdk-go-v2/service/cloud9 v1.33.1/go.mod h1:899wT6Y0uc6QS5wN4M/ZRKZguJm1cIQwKRgfoY1cIyA= +github.com/aws/aws-sdk-go-v2/service/cloudcontrol v1.28.2 h1:GNReIUhfyDIMLS33j+Ibfv9OMxzSfbLDBV70qdjVlsQ= +github.com/aws/aws-sdk-go-v2/service/cloudcontrol v1.28.2/go.mod h1:EM5v3k1+zWN6gWwlOVMDqAK59ZkpeifaUX4COuRTMwY= +github.com/aws/aws-sdk-go-v2/service/cloudformation v1.65.2 h1:ACR184wcab0r+cS43gE8cwXCp3AtzsCZKTylzSuJW/k= +github.com/aws/aws-sdk-go-v2/service/cloudformation v1.65.2/go.mod h1:wkKFqGoZf9Asi1eKuWbz7SEx0RtCq4+drWwHKzizP9o= +github.com/aws/aws-sdk-go-v2/service/cloudfront v1.53.2 h1:8/tG0guchEzDCVPDXJLcDcf6Vc0MltrMFi08FCYCIaE= +github.com/aws/aws-sdk-go-v2/service/cloudfront v1.53.2/go.mod h1:OaiKA9p7K0oTLbULuaXxRdCYv3WBZxRX1t5BWJRluAM= +github.com/aws/aws-sdk-go-v2/service/cloudfrontkeyvaluestore v1.12.4 h1:FvHZbV/K0iN+5PRdkNdezw4hMNfucmOqHWtCVWaMCSQ= +github.com/aws/aws-sdk-go-v2/service/cloudfrontkeyvaluestore v1.12.4/go.mod h1:W8PEQOFJDTfEczBnyVJjMyhjgug9eTm8wP9MPLZW4qw= +github.com/aws/aws-sdk-go-v2/service/cloudhsmv2 v1.34.1 h1:mHPzi3CzNp6m0j0f24KWjKnVqc7EKkYDYD0m0eXq1+8= +github.com/aws/aws-sdk-go-v2/service/cloudhsmv2 v1.34.1/go.mod h1:QjQFCvDfno6ijpmZXllvODuBF04Z8W9ImaNR1QYX/tM= +github.com/aws/aws-sdk-go-v2/service/cloudsearch v1.31.2 h1:SYs99QpWcvrw8zC3x/PFdx3okZYlUuj1HwOH2HrZXws= +github.com/aws/aws-sdk-go-v2/service/cloudsearch v1.31.2/go.mod h1:FJ7xQXe2+iO/4IJ8JxVWzish+5G8CAbXu8mqc/ckwaI= +github.com/aws/aws-sdk-go-v2/service/cloudtrail v1.53.2 h1:dlGpx2aVrU8Kjksdo0H9JqC0DrDOctTsLsbOivy722s= +github.com/aws/aws-sdk-go-v2/service/cloudtrail v1.53.2/go.mod h1:jl4HqKy8wA2nlM/K0X4evl9CIPtXBlBIk5CJFKQqGms= +github.com/aws/aws-sdk-go-v2/service/cloudwatch v1.49.2 h1:hhZnSp7al9i6Jfnb51j6AvbEITN+nlrYCZX7eEwcf7Y= +github.com/aws/aws-sdk-go-v2/service/cloudwatch v1.49.2/go.mod h1:+AW8Vf+OhePdK+WiRFDyzh6Le8QS4D6/Y6wKEC6NVlk= +github.com/aws/aws-sdk-go-v2/service/cloudwatchlogs v1.57.2 h1:TSNLZXt7ipIV+Q+GZAQ8dUxYUDsMX2/Atrn/YuPF3zI= +github.com/aws/aws-sdk-go-v2/service/cloudwatchlogs v1.57.2/go.mod h1:mSt0uBAxUj2dnagbjc7p+Jh68SSwgDTNzMKUjchDiOY= +github.com/aws/aws-sdk-go-v2/service/codeartifact v1.38.2 h1:jTeAsAK227buQb1s0renmkSTvvOt9cgBAvjQmNhzTu8= +github.com/aws/aws-sdk-go-v2/service/codeartifact v1.38.2/go.mod h1:ruPxVenlBiKrw3hONr5JxZENV7OwBwF84RBCvKb1Bxo= +github.com/aws/aws-sdk-go-v2/service/codebuild v1.67.1 h1:kutNNMJBe6o87IHwFi+YypZYaH0Gbb+8eTh8Bo9lhH0= +github.com/aws/aws-sdk-go-v2/service/codebuild v1.67.1/go.mod h1:y4SeLNsf29MIhrKr7oTFFf1OpqKR4zKGbFKPNDsYMNg= +github.com/aws/aws-sdk-go-v2/service/codecatalyst v1.20.4 h1:C9AXP3x1utSMcOiSx7VbFBCpxqQzPDV00PMT5X+fGXQ= +github.com/aws/aws-sdk-go-v2/service/codecatalyst v1.20.4/go.mod h1:vr65FBqfx+0udgx4Dip0DQALYV6ndcso34XfhFvJ2lA= +github.com/aws/aws-sdk-go-v2/service/codecommit v1.32.2 h1:qIySgaSYDLcInLpY0e7HPCi+AVeD/LTsl9EL1b692oA= +github.com/aws/aws-sdk-go-v2/service/codecommit v1.32.2/go.mod h1:SobWM1535Mn1WuThoIVLiLa/C1rRbxbbq5PZW2QFCIM= +github.com/aws/aws-sdk-go-v2/service/codeconnections v1.10.1 h1:fFozrfL+uhK/JEGAE75l1x4ansAeyJmGzxC80xnGLmo= +github.com/aws/aws-sdk-go-v2/service/codeconnections v1.10.1/go.mod h1:7Ao3ErgFt2gq2cWvJO/Ux/1u+mgOpb7MaftYrQCEhuk= +github.com/aws/aws-sdk-go-v2/service/codedeploy v1.34.1 h1:bozxV8Rv6dfjSt/SuNKYsE0d5iHeO8m0u7M2eY8sZF0= +github.com/aws/aws-sdk-go-v2/service/codedeploy v1.34.1/go.mod h1:YtP8V4xhxkufrrcteKY90M4eO0YZWHxhw68/Gw5PEj8= +github.com/aws/aws-sdk-go-v2/service/codeguruprofiler v1.29.1 h1:0+EYI0dBogeiEsM1vZWrgq7QUYAl1js4dQbU7FYy+Zk= +github.com/aws/aws-sdk-go-v2/service/codeguruprofiler v1.29.1/go.mod h1:JgObDvt+EyaCm37wh1lv9SoD+NQPOt/sDidb3YZ6pVg= +github.com/aws/aws-sdk-go-v2/service/codegurureviewer v1.34.1 h1:1jCd6GsgICkA6kjvOYf7C6U5pv9SU7x6m1WalSd1zIQ= +github.com/aws/aws-sdk-go-v2/service/codegurureviewer v1.34.1/go.mod h1:2Dl95oWOgqJa0XkVre+vXYAK5m3N7QIeisNcihygrOk= +github.com/aws/aws-sdk-go-v2/service/codepipeline v1.46.2 h1:lH74n0qEyTZUFG9xBW/H17iv2tZVQ0W1cG0+YUz6P9M= +github.com/aws/aws-sdk-go-v2/service/codepipeline v1.46.2/go.mod h1:v6mzAapGAEbeC9Y8e3LjWIdzkEUiYDzm7YTwV2zJH0I= +github.com/aws/aws-sdk-go-v2/service/codestarconnections v1.34.2 h1:taAVT41mG1omZFnvPeWZshpon8j2YXZeFCbW7htFlbY= +github.com/aws/aws-sdk-go-v2/service/codestarconnections v1.34.2/go.mod h1:WUXurX89fWSPjdvGheDDGA/Gqcg0Y0RS8AvLJFZNNd0= +github.com/aws/aws-sdk-go-v2/service/codestarnotifications v1.31.2 h1:aUE6o0KtiLFRircxk15GQ9JZQ1rKG+/D5t585I9FR2Y= +github.com/aws/aws-sdk-go-v2/service/codestarnotifications v1.31.2/go.mod h1:DYaze+lOmq/2/TEyp0nORtSkksROWg3IpGpEdvkGFd8= +github.com/aws/aws-sdk-go-v2/service/cognitoidentity v1.33.2 h1:MPtnvXrLc2dp2+VOdLXHYY35+oIeG8o6XzEU3jRJazI= +github.com/aws/aws-sdk-go-v2/service/cognitoidentity v1.33.2/go.mod h1:OfHi9BqiUZJCyM59Jm9nEyhfXOpbZzRLbxzQDdOI6GI= +github.com/aws/aws-sdk-go-v2/service/cognitoidentityprovider v1.57.3 h1:GE/RDCrvBzhdIzvkpB6why7pYsgsjD3f1TLRZmBC5nQ= +github.com/aws/aws-sdk-go-v2/service/cognitoidentityprovider v1.57.3/go.mod h1:7SB0BLKGT8jicCgQ5E5tsJqT6FXrFAl6JviiyvOuEdU= +github.com/aws/aws-sdk-go-v2/service/comprehend v1.40.2 h1:CWPyAmLgdIvIU7dIZTZmlZQuFwTYBV6yK8uu6XzNwTY= +github.com/aws/aws-sdk-go-v2/service/comprehend v1.40.2/go.mod h1:VY0HshV36OPINFcJCJaZUFoDN+CqZNzDfqdAGpE2INk= +github.com/aws/aws-sdk-go-v2/service/computeoptimizer v1.47.1 h1:1PTeBL08xILU8pvssFWwxdpSUzJQO9LKN/GgNYlGCC4= +github.com/aws/aws-sdk-go-v2/service/computeoptimizer v1.47.1/go.mod h1:8c5GqYpVU2ADZR+aEOJn9nmjWwgTKCFohk1oi+WgmNQ= +github.com/aws/aws-sdk-go-v2/service/configservice v1.57.2 h1:jCtBGfam7lP2flT4WCj8X3RniE0pm9s0uZMdZvLMN/k= +github.com/aws/aws-sdk-go-v2/service/configservice v1.57.2/go.mod h1:/v3Qj03P/7nEDopkALYKzCMnE5+lJezs6VHAKPKxjvU= +github.com/aws/aws-sdk-go-v2/service/connect v1.138.1 h1:MXbzuguyuvs56c27ujkl3ugliN2scXue5aB8AY+PoWE= +github.com/aws/aws-sdk-go-v2/service/connect v1.138.1/go.mod h1:4/tShL3DwnJoVT+4G/VAdWSMGO/Mv764IjetEQWvlYE= +github.com/aws/aws-sdk-go-v2/service/connectcases v1.30.2 h1:+exlRXOAMPfZZW8vdoCq0Pc3UV6jwoiYXanw8Hdeb/w= +github.com/aws/aws-sdk-go-v2/service/connectcases v1.30.2/go.mod h1:LhPYKJKYcxqNoEb+qSaf59JsuN1hohUVKy1MN752Dv0= +github.com/aws/aws-sdk-go-v2/service/controltower v1.26.2 h1:olXHUzlyyzaXoL6t9caN+FzGSzUtiXkkFcF1uVz7reA= +github.com/aws/aws-sdk-go-v2/service/controltower v1.26.2/go.mod h1:ojCzzbtA/EzWHw3DMo6JFrGyWVNtppBHhNicFVWCVzE= +github.com/aws/aws-sdk-go-v2/service/costandusagereportservice v1.33.2 h1:2d0q0nu8LC5aeas0ZmsgjZHCiAfZZXTB9Y1iF9dpm0w= +github.com/aws/aws-sdk-go-v2/service/costandusagereportservice v1.33.2/go.mod h1:mvpFNLX9pwMKCZtwEipfMUbAdZs9RmHcpkUp+J58eXU= +github.com/aws/aws-sdk-go-v2/service/costexplorer v1.55.3 h1:wIxOLILQ3fjaY/A6PWfmQYaJGcmimUt6C1VJObyVL7U= +github.com/aws/aws-sdk-go-v2/service/costexplorer v1.55.3/go.mod h1:BbguYlNx01GCK33JAkLy/Z+fwmaA8rXW2JRxqE2L7XQ= +github.com/aws/aws-sdk-go-v2/service/costoptimizationhub v1.20.2 h1:TrVHD8csYxtmPTUPwvRVQ/cfhKhahLeW+7AjTv1IdIc= +github.com/aws/aws-sdk-go-v2/service/costoptimizationhub v1.20.2/go.mod h1:rdHbpIynh5Ngf1hCmUaLPoi+O+ed/RKQ6Yozd8aPj+E= +github.com/aws/aws-sdk-go-v2/service/customerprofiles v1.52.2 h1:cCBFpiH77NXmdb0DzRiQV22UhpsiKOMC4uwowKvotrI= +github.com/aws/aws-sdk-go-v2/service/customerprofiles v1.52.2/go.mod h1:YgrwD4/4TQ1Gy2flGX6luIU8H66p4MXWoUXecuVSzmg= +github.com/aws/aws-sdk-go-v2/service/databasemigrationservice v1.57.2 h1:jF2Rb+OqznTzCyv5RR9JC89Q5ZhnHA2Z2ZfTqp/2/GM= +github.com/aws/aws-sdk-go-v2/service/databasemigrationservice v1.57.2/go.mod h1:axHRiqofRmrdwwsnQh2+R3NK1AS+qQm4L1xCiKyvIMo= +github.com/aws/aws-sdk-go-v2/service/databrew v1.38.1 h1:4tp86h4YU1Dd5yR0k4IQTe66AgRF8UVUYRppR7NyDkU= +github.com/aws/aws-sdk-go-v2/service/databrew v1.38.1/go.mod h1:6HOQsxLM/j43bmDvLTHH1vyQ905dEfscli+ABJ29AZE= +github.com/aws/aws-sdk-go-v2/service/dataexchange v1.39.2 h1:4eY0vLqcYE6Ua1ewZ8tiNLctuirVzN0RE1RX7+URTbk= +github.com/aws/aws-sdk-go-v2/service/dataexchange v1.39.2/go.mod h1:Cdjpp4CX0cD1wAoUHf+1yPw0Ve1lsUDtSOnhyiUZ5Po= +github.com/aws/aws-sdk-go-v2/service/datapipeline v1.30.1 h1:Gg/y/1+rHrf2kxrBWZY5KE3zrSgT+if4oqR4b3LYTE4= +github.com/aws/aws-sdk-go-v2/service/datapipeline v1.30.1/go.mod h1:dwLDJ+47AzvPn5I9ASJEjhg8PZT/bGad5/jMUOAdkFs= +github.com/aws/aws-sdk-go-v2/service/datasync v1.54.2 h1:lbUeqY5fSPLhyVCYuWR6wqYGBrVvSE6pOr6Bm0+HeUA= +github.com/aws/aws-sdk-go-v2/service/datasync v1.54.2/go.mod h1:uSbSm54E6/rjYAPtTVy/wJFyIqTIadEW3y0xq8/0uIA= +github.com/aws/aws-sdk-go-v2/service/datazone v1.39.2 h1:qO8LCWDgtAIhKG9CiROlgY51gxtTGFzjUtyOYSi49Yg= +github.com/aws/aws-sdk-go-v2/service/datazone v1.39.2/go.mod h1:8KGSh6YVyd17gbXThGwBgu7CcsxkBK1o9wi925hbWiE= +github.com/aws/aws-sdk-go-v2/service/dax v1.28.2 h1:Un4IIQHVY2csGJT68qw71WnviCnT/cMMZjtkjJ0xwQI= +github.com/aws/aws-sdk-go-v2/service/dax v1.28.2/go.mod h1:CkMUKAX5Qn4E1WAdYAPL0eWLhAMfCRljL+bbW6gT9YI= +github.com/aws/aws-sdk-go-v2/service/detective v1.37.3 h1:AP8E9/Byu5p60nFHqm/Q9tcHTmXffbvFKrTFQI2jC4I= +github.com/aws/aws-sdk-go-v2/service/detective v1.37.3/go.mod h1:meju7FTUGY5mWz/xpVFL83Nz5yhsYrJpHMJ0wJzBE9o= +github.com/aws/aws-sdk-go-v2/service/devicefarm v1.35.2 h1:koFhxvKiLr01UL5lrxqIHRb8CBCpz3WC1Bvc/oi9B4o= +github.com/aws/aws-sdk-go-v2/service/devicefarm v1.35.2/go.mod h1:WbbD8452uRsRQkKwTi2sY9KkbEAJ3QvI97hRIAyT/sI= +github.com/aws/aws-sdk-go-v2/service/devopsguru v1.39.2 h1:FsuCfy5PiQ4gKLrFoMRHPnnF9xCv+H8ECjlMDODPGR8= +github.com/aws/aws-sdk-go-v2/service/devopsguru v1.39.2/go.mod h1:Bcp61bIcLwGbpYm+EkqQUo38CCVtjjtyV/PDuzjbi8w= +github.com/aws/aws-sdk-go-v2/service/directconnect v1.37.2 h1:MjLoBgzV+I7IpdGHRYKmHZ+CZ+rn0l2xSjvIOjiw6Lg= +github.com/aws/aws-sdk-go-v2/service/directconnect v1.37.2/go.mod h1:rE+Tqmv9tBMJDPE7ZNIOlsKAFINOvVvBlVdUZJY4avU= +github.com/aws/aws-sdk-go-v2/service/directoryservice v1.37.1 h1:QKdx/YMHM5m7eY4a+opHqh5U84n63kjeFMmNyIEvdtc= +github.com/aws/aws-sdk-go-v2/service/directoryservice v1.37.1/go.mod h1:oQFvh/8djxr5mA0/5fljC3oWpPhNxlrsOaQIG6tqoHI= +github.com/aws/aws-sdk-go-v2/service/dlm v1.34.2 h1:NMbMvXmeB5y4w3yN5N+6wYMj1/dIbagOqaiwvCwQ2MU= +github.com/aws/aws-sdk-go-v2/service/dlm v1.34.2/go.mod h1:L/IJNaSxg0Z+VlSe2rQGQa4UBFhINjRzAFezwd59y2Y= +github.com/aws/aws-sdk-go-v2/service/docdb v1.46.2 h1:gIn/FS7vqlEV0KsOpipfOhVXif+nMyr+mYD5gnsLHTM= +github.com/aws/aws-sdk-go-v2/service/docdb v1.46.2/go.mod h1:fAXculuOmpN8xecbrSSODxOX/cEa5PYj7LJY46USG7U= +github.com/aws/aws-sdk-go-v2/service/docdbelastic v1.19.2 h1:/Nzns4U6fqGUJYICI/plyXklmvAzj5usZFzwMTYMk4I= +github.com/aws/aws-sdk-go-v2/service/docdbelastic v1.19.2/go.mod h1:u1p4pWbdxs4SvRp/QdmqPWjU1dFNIiacpDSUqTBZ9BI= +github.com/aws/aws-sdk-go-v2/service/drs v1.35.2 h1:4xcfn1eO+8H21xB5L51T+m8PxKbLV10SFlGaImgUWrQ= +github.com/aws/aws-sdk-go-v2/service/drs v1.35.2/go.mod h1:W6hq6uHkmhLRhKSttnhck2vedhar8x/gdJhCGdhc0HY= +github.com/aws/aws-sdk-go-v2/service/dsql v1.9.4 h1:uCgCv9sLsyXj0+JRC9u9b/u4LZGibdHnft1PJqdsSTY= +github.com/aws/aws-sdk-go-v2/service/dsql v1.9.4/go.mod h1:EEkX+o+T3MSk2NpuuijcvT/1To5rRtH5wjztMvaPD8o= +github.com/aws/aws-sdk-go-v2/service/dynamodb v1.50.1 h1:MXUnj1TKjwQvotPPHFMfynlUljcpl5UccMrkiauKdWI= +github.com/aws/aws-sdk-go-v2/service/dynamodb v1.50.1/go.mod h1:fe3UQAYwylCQRlGnihsqU/tTQkrc2nrW/IhWYwlW9vg= +github.com/aws/aws-sdk-go-v2/service/ec2 v1.250.0 h1:aosVpDecA17GN0AmQRq/Ui3fEt5iQ3Y2QUCIyza6e7s= +github.com/aws/aws-sdk-go-v2/service/ec2 v1.250.0/go.mod h1:SmMqzfS4HVsOD58lwLZ79oxF58f8zVe5YdK3o+/o1Ck= +github.com/aws/aws-sdk-go-v2/service/ecr v1.50.1 h1:lcwFjRx3C/hBxJzoWkD6DIG2jeB+mzLmFVBFVOadxxE= +github.com/aws/aws-sdk-go-v2/service/ecr v1.50.1/go.mod h1:qt9OL5kXqWoSub4QAkOF74mS3M2zOTNxMODqgwEUjt8= +github.com/aws/aws-sdk-go-v2/service/ecrpublic v1.37.2 h1:EfatDVSMFxaS5TiR0C0zssQU1Nm+rGx3VbUGIH1y274= +github.com/aws/aws-sdk-go-v2/service/ecrpublic v1.37.2/go.mod h1:oRy1IEgzXtOkEk4B/J7HZbXUC258drDLtkmc++lN7IA= +github.com/aws/aws-sdk-go-v2/service/ecs v1.63.4 h1:X6XL3qIpS7u/rVfuqt18ra9ySaiZKp3nA4pqgIODScw= +github.com/aws/aws-sdk-go-v2/service/ecs v1.63.4/go.mod h1:Cr5XpL/mBhaOKU1/kyVlQ/Zxs6d9RPcMRyI1DRXmFms= +github.com/aws/aws-sdk-go-v2/service/efs v1.40.3 h1:xzZVMU2lDWKq9yENGNGXujl/x3GBdd40VtTorzAhp60= +github.com/aws/aws-sdk-go-v2/service/efs v1.40.3/go.mod h1:hvE2jEAz+1qmX4MbQ6MvsE0rC3hV5lILFdtooRxA2fQ= +github.com/aws/aws-sdk-go-v2/service/eks v1.73.1 h1:Txq5jxY/ao+2Vx/kX9+65WTqkzCnxSlXnwIj+Cr/fng= +github.com/aws/aws-sdk-go-v2/service/eks v1.73.1/go.mod h1:+hYFg3laewH0YCfJRv+o5R3bradDKmFIm/uaiaD1U7U= +github.com/aws/aws-sdk-go-v2/service/elasticache v1.50.1 h1:K3Z12SXq/J12p2BkjHyQZaTJ9E6KxiSSE2Qj4p9kORU= +github.com/aws/aws-sdk-go-v2/service/elasticache v1.50.1/go.mod h1:gLYkZU7UpseQKBHxNk7O75xlxgyGV92/LCWf/BPdblc= +github.com/aws/aws-sdk-go-v2/service/elasticbeanstalk v1.33.3 h1:GVkv1bzSKANCnsuPUxe+8nl/vdXSWQ31epMEJNBZHKQ= +github.com/aws/aws-sdk-go-v2/service/elasticbeanstalk v1.33.3/go.mod h1:PEzNIYaubtnKFF35zeEmJttqTlxU2yha7GgMpzaopV0= +github.com/aws/aws-sdk-go-v2/service/elasticloadbalancing v1.33.2 h1:L71eE74x591WhKIfNvjc+qE6WcON6bb1KiDwymf0dVk= +github.com/aws/aws-sdk-go-v2/service/elasticloadbalancing v1.33.2/go.mod h1:RpnUpPKuFd5ViTyiAlru/sygnOJ4tw7elKm7lyQerfk= +github.com/aws/aws-sdk-go-v2/service/elasticloadbalancingv2 v1.50.2 h1:5NXAi1QdV3DT6nyASf94+E3i1jZ6zuFPb0lM0yDSMvw= +github.com/aws/aws-sdk-go-v2/service/elasticloadbalancingv2 v1.50.2/go.mod h1:Gk3uvYKSpiM998WXOreKOsk6PHkkIMp1xGgYFDlZLAA= +github.com/aws/aws-sdk-go-v2/service/elasticsearchservice v1.37.2 h1:44GYa+nsnE2S5WukRh7w6ldTixoQbaJyi891QVNL/vs= +github.com/aws/aws-sdk-go-v2/service/elasticsearchservice v1.37.2/go.mod h1:EFLVu5kj1U7pC6K6Lth3UOWgqcqHg86DUeX/38s7FXk= +github.com/aws/aws-sdk-go-v2/service/elastictranscoder v1.32.2 h1:1EvYH0LUt00Uop6MzSZfarFDLnGWGPgdFk+68aMeJLs= +github.com/aws/aws-sdk-go-v2/service/elastictranscoder v1.32.2/go.mod h1:1+FoECQK1k2EfVz0uWFnfQ8d90ZmOcu1BJV9wY4qR1U= +github.com/aws/aws-sdk-go-v2/service/emr v1.54.1 h1:tgJcX1AysVmunCvPjXYP1Ddcio2kATXoOqkX5v7LWHA= +github.com/aws/aws-sdk-go-v2/service/emr v1.54.1/go.mod h1:YPjTMPJ6p8plhbUw+HbJ/JbOcoXCPZaTywSksbhSYCo= +github.com/aws/aws-sdk-go-v2/service/emrcontainers v1.39.2 h1:26yws1a1IPK65hVSP0/y4f3HNZMZ60VsmoFBhXTBXts= +github.com/aws/aws-sdk-go-v2/service/emrcontainers v1.39.2/go.mod h1:CAepPdiAWHUg8PaCPQbQ1I5NbsbRjF7S8rX0N+dBt3Y= +github.com/aws/aws-sdk-go-v2/service/emrserverless v1.36.2 h1:EPozHVLMR+Z0+vu3kBj6La5tAmYlN3X6MTinwMvabKs= +github.com/aws/aws-sdk-go-v2/service/emrserverless v1.36.2/go.mod h1:W2mEuCVgphPWH+TVQ6FkvyMqPbseclEXl0Ttdzw6Epc= +github.com/aws/aws-sdk-go-v2/service/eventbridge v1.45.1 h1:Qe+A73TDCVscF7zc8StTI8rukwBHjXNks+49Xv2xqE4= +github.com/aws/aws-sdk-go-v2/service/eventbridge v1.45.1/go.mod h1:sA4f8EFW5uDGL1yvDu8UE11pQFOUmlxtcDD/k1so+OQ= +github.com/aws/aws-sdk-go-v2/service/evidently v1.28.1 h1:it/HO4u5vJhqpq1IZ5vvgGn8PuQQTxru3IQZJwqtrM0= +github.com/aws/aws-sdk-go-v2/service/evidently v1.28.1/go.mod h1:WrsfRXLObQz3ve2KBsZ3C0Ia6uI6q4fr+GXo5nkBtJY= +github.com/aws/aws-sdk-go-v2/service/evs v1.4.2 h1:DlmNO9d+4ZMsHWEcE4mCHytUH0Fig7nivHZmavucu4E= +github.com/aws/aws-sdk-go-v2/service/evs v1.4.2/go.mod h1:/1ytJKXbiDq3p7Zp3Tl2nbu/ijvAQSEOY00O5v8lf/M= +github.com/aws/aws-sdk-go-v2/service/finspace v1.33.2 h1:qnmpywrmsu9o7XmYLDuHp+tnswTD9s4H8GuNT2eTlS8= +github.com/aws/aws-sdk-go-v2/service/finspace v1.33.2/go.mod h1:A7eFWF1KozvlmYu+Dw805VjVkFBmCw8dm8dEGcOwleo= +github.com/aws/aws-sdk-go-v2/service/firehose v1.41.2 h1:QLPNIWblJw5wiTYaGi89yMcd5jP8Q0Nu33RIzhQJUNY= +github.com/aws/aws-sdk-go-v2/service/firehose v1.41.2/go.mod h1:DXMRebcjxi94pF9v4X0wV3hJ696+hLqlNeKJoDv0tQo= +github.com/aws/aws-sdk-go-v2/service/fis v1.37.1 h1:OXyZxLC0vVu8OAUTfuUvm859whB5PDQTg3410UkX9pg= +github.com/aws/aws-sdk-go-v2/service/fis v1.37.1/go.mod h1:x+CiN7zrqZA5y43Dma1ahWUNli54qPs2Q6ixNXaPHoM= +github.com/aws/aws-sdk-go-v2/service/fms v1.44.1 h1:HiFdvkhoMBP8VAoM15SBH+k2K9RdcyLrjVMGLuKxsNw= +github.com/aws/aws-sdk-go-v2/service/fms v1.44.1/go.mod h1:6mmQzuHkCJIqSMbkqTzUL9wcvXn34kYlkgpvDqFNYnM= +github.com/aws/aws-sdk-go-v2/service/fsx v1.61.2 h1:ujnyoDVn5S/f/H7bRtrc8Um9hMg5K7sQL8ma20qLah4= +github.com/aws/aws-sdk-go-v2/service/fsx v1.61.2/go.mod h1:S9CXyIjFuiaDY8q61cEITsws9mCUnDbzPzFfQkLibZE= +github.com/aws/aws-sdk-go-v2/service/gamelift v1.46.2 h1:YyoyDpgVa8MC9tev/IKD6WtM+6E7liVh1NalZW2OfDk= +github.com/aws/aws-sdk-go-v2/service/gamelift v1.46.2/go.mod h1:qt7in+OKWRwgxnhnO5nsF+sf2PnnVP5zNaxNN6pBNj8= +github.com/aws/aws-sdk-go-v2/service/glacier v1.31.2 h1:VokGAUPuUxPCAZBX6G8Hdg4XOPoN37juPPm4FxlWJ/w= +github.com/aws/aws-sdk-go-v2/service/glacier v1.31.2/go.mod h1:udU+JbWDpFtpSuxT7rhVvi8SRX+ENKfgdUocZPsLjqk= +github.com/aws/aws-sdk-go-v2/service/globalaccelerator v1.34.2 h1:6C++uHi8NtBt48AemvtwVyLx+3rKEFG1dr10uaosNpM= +github.com/aws/aws-sdk-go-v2/service/globalaccelerator v1.34.2/go.mod h1:4Bxo37nCAKiivZGbiyYUJDlgjyJy4puvdd3uCZ2iD6g= +github.com/aws/aws-sdk-go-v2/service/glue v1.128.1 h1:BrhnjxI07q7PFQNWPpmp7GawYCIRClHbSU920YmPJkc= +github.com/aws/aws-sdk-go-v2/service/glue v1.128.1/go.mod h1:a+xiPF/o+H8kQrsYI7hgBuZRPCiDenH2OKT/TJYwpHo= +github.com/aws/aws-sdk-go-v2/service/grafana v1.31.2 h1:rZODhEVhB2iqwtqtxABx1r9QfGj1PgPpTTm+3Rftnlk= +github.com/aws/aws-sdk-go-v2/service/grafana v1.31.2/go.mod h1:s8VuZ0xEokt5DxeqcQObWOhCmmZ0/9jCCpCF8MzoQ/I= +github.com/aws/aws-sdk-go-v2/service/greengrass v1.32.2 h1:VEeScKJn6CH3rH9IP8yMc2JmauyJsLYQkQBULpbC2vE= +github.com/aws/aws-sdk-go-v2/service/greengrass v1.32.2/go.mod h1:iXva/vNMQB6FX7ooA7rahCAn7TlyQPVW+DTkix4E0kE= +github.com/aws/aws-sdk-go-v2/service/groundstation v1.37.2 h1:x4EqAoItA797CzLaIwBjFxBdiqVppAJoJYh0+jiOlu8= +github.com/aws/aws-sdk-go-v2/service/groundstation v1.37.2/go.mod h1:+XX2J867OOegjDEhNJgAEcxcjfYHN3Lgt/UoCL/AF9Y= +github.com/aws/aws-sdk-go-v2/service/guardduty v1.63.2 h1:I8pteGdTARKWNd5K8n5MjR4RnKdmV2lxfp3GWF1/Y+4= +github.com/aws/aws-sdk-go-v2/service/guardduty v1.63.2/go.mod h1:HssjGKML+1CKdk/rpboJ1GDnqPdIRbKcaHn+rWb8WnI= +github.com/aws/aws-sdk-go-v2/service/healthlake v1.35.1 h1:Q947iRDzikQFezOGSDtrwUc3MC6NhTs9hHBNamUoIOA= +github.com/aws/aws-sdk-go-v2/service/healthlake v1.35.1/go.mod h1:DmDO9bdGxMg218F+zRYKyjjtqogS22LKF/E83fXDAmw= +github.com/aws/aws-sdk-go-v2/service/iam v1.47.3 h1:BDkM6KWoryEstnb0fTg5Ip+WsxAph/aCNqwws/sS5yE= +github.com/aws/aws-sdk-go-v2/service/iam v1.47.3/go.mod h1:5q4IwllQ9vIoq7bk8dPvPbT3LQCky+4NgV7vKwAbaEs= +github.com/aws/aws-sdk-go-v2/service/identitystore v1.32.2 h1:TumDpDVz1B05Z4zq4cU9pxSdiYyBM9tMPmm1bkwluYk= +github.com/aws/aws-sdk-go-v2/service/identitystore v1.32.2/go.mod h1:gvxXKQnGA9qkvntBjBC0BaUJ8uLIZcgI+6fJ3006FlY= +github.com/aws/aws-sdk-go-v2/service/imagebuilder v1.46.2 h1:PmnYKJ6qiRPgakjMenA+sIUTm6xuDNRT4ZF+7s77Hgs= +github.com/aws/aws-sdk-go-v2/service/imagebuilder v1.46.2/go.mod h1:ju9p+EywpL7/cMYeEHUiTeIDoHbmG3N8yRbMPdstUxU= +github.com/aws/aws-sdk-go-v2/service/inspector v1.30.1 h1:d68gzCkt0Uji+drJwToTJ9IFENXCpvJtTtXsqSOBS7k= +github.com/aws/aws-sdk-go-v2/service/inspector v1.30.1/go.mod h1:jFh/bgVYvfNYzEr1RKbBFCDXKGOOP2jrxNPbpuaqUlY= +github.com/aws/aws-sdk-go-v2/service/inspector2 v1.44.2 h1:wy488TfMl9y6ZBWQQCNKHlq8rGaJJRIgV56ndmcjnO0= +github.com/aws/aws-sdk-go-v2/service/inspector2 v1.44.2/go.mod h1:yo1LMGikHlvanNXHarw81zC9IBRLO95W9z4oV/82SJ8= +github.com/aws/aws-sdk-go-v2/service/internal/accept-encoding v1.13.1 h1:oegbebPEMA/1Jny7kvwejowCaHz1FWZAQ94WXFNCyTM= +github.com/aws/aws-sdk-go-v2/service/internal/accept-encoding v1.13.1/go.mod h1:kemo5Myr9ac0U9JfSjMo9yHLtw+pECEHsFtJ9tqCEI8= +github.com/aws/aws-sdk-go-v2/service/internal/checksum v1.8.6 h1:hncKj/4gR+TPauZgTAsxOxNcvBayhUlYZ6LO/BYiQ30= +github.com/aws/aws-sdk-go-v2/service/internal/checksum v1.8.6/go.mod h1:OiIh45tp6HdJDDJGnja0mw8ihQGz3VGrUflLqSL0SmM= +github.com/aws/aws-sdk-go-v2/service/internal/endpoint-discovery v1.11.6 h1:34ojKW9OV123FZ6Q8Nua3Uwy6yVTcshZ+gLE4gpMDEs= +github.com/aws/aws-sdk-go-v2/service/internal/endpoint-discovery v1.11.6/go.mod h1:sXXWh1G9LKKkNbuR0f0ZPd/IvDXlMGiag40opt4XEgY= +github.com/aws/aws-sdk-go-v2/service/internal/presigned-url v1.13.6 h1:LHS1YAIJXJ4K9zS+1d/xa9JAA9sL2QyXIQCQFQW/X08= +github.com/aws/aws-sdk-go-v2/service/internal/presigned-url v1.13.6/go.mod h1:c9PCiTEuh0wQID5/KqA32J+HAgZxN9tOGXKCiYJjTZI= +github.com/aws/aws-sdk-go-v2/service/internal/s3shared v1.19.6 h1:nEXUSAwyUfLTgnc9cxlDWy637qsq4UWwp3sNAfl0Z3Y= +github.com/aws/aws-sdk-go-v2/service/internal/s3shared v1.19.6/go.mod h1:HGzIULx4Ge3Do2V0FaiYKcyKzOqwrhUZgCI77NisswQ= +github.com/aws/aws-sdk-go-v2/service/internetmonitor v1.25.1 h1:ZeXNdfj9Gb/u/kEwEdT5mTYPjVdOQu94ged888vVoc0= +github.com/aws/aws-sdk-go-v2/service/internetmonitor v1.25.1/go.mod h1:656tpQ686itYBqEl1EbgA0OZog+8JhP5wghNgi9JvXw= +github.com/aws/aws-sdk-go-v2/service/invoicing v1.6.4 h1:UMTSLrtSCr3nahIbpnQk2aLngcunD0s0aL4L6c5LRUI= +github.com/aws/aws-sdk-go-v2/service/invoicing v1.6.4/go.mod h1:e0NxgLPA2BWdm89QVOx7i+nwsDbSuUyaIEQqxkmLjDQ= +github.com/aws/aws-sdk-go-v2/service/iot v1.69.1 h1:5I9hhdiPnIZOlyAA6PIysCHmmfFKgCLvpJah6xWf6VQ= +github.com/aws/aws-sdk-go-v2/service/iot v1.69.1/go.mod h1:MNfd0gEcP5VIG2NRWG1GbcbqAq8hjVUfGGfpohXxVoE= +github.com/aws/aws-sdk-go-v2/service/ivs v1.47.2 h1:rQjtFoJmPESHtgPiF6igtieWdLvM2oq5Gh4qlmbXyjc= +github.com/aws/aws-sdk-go-v2/service/ivs v1.47.2/go.mod h1:482D8kaN4J+zrBmYpBwucmIbQjAntr4ze0Qi2vh4f4Q= +github.com/aws/aws-sdk-go-v2/service/ivschat v1.21.1 h1:/VgocLhOilNd62aeqqcI+S7F673U4o0rFVrVJlJmwiw= +github.com/aws/aws-sdk-go-v2/service/ivschat v1.21.1/go.mod h1:smGbv/1Ll9KBL5AJKnOEJQi9VT18PLvOOXKfbrno56I= +github.com/aws/aws-sdk-go-v2/service/kafka v1.43.2 h1:pAud0XuQySFoniVUZ5FOFs7eBes3KyPKfiXWADa25iE= +github.com/aws/aws-sdk-go-v2/service/kafka v1.43.2/go.mod h1:Rd/liQoGexiuBzTo73W4GIHPKWgt2qC/hhViblXym7E= +github.com/aws/aws-sdk-go-v2/service/kafkaconnect v1.27.1 h1:PUM+0xm5gZG7BEtWKzh7jK2W7raCsD54cMuAE+79fr8= +github.com/aws/aws-sdk-go-v2/service/kafkaconnect v1.27.1/go.mod h1:tpU5kDjKiOH0qdFWZ+UT8xp0Cg0gfTCDEOty0SCiG/k= +github.com/aws/aws-sdk-go-v2/service/kendra v1.60.2 h1:ObuofAivu0GlwoTxyXu7KNVGUx2JtQ9y2bRcqBCsP7o= +github.com/aws/aws-sdk-go-v2/service/kendra v1.60.2/go.mod h1:76irOFfBcTfyT/uS7O3qV8cRpDq1Qe+qVQmZGQjusrc= +github.com/aws/aws-sdk-go-v2/service/keyspaces v1.23.2 h1:1M335ZGLSdN80gNSSwEdUZm/Pt3/gB8c22jvK6OJyS8= +github.com/aws/aws-sdk-go-v2/service/keyspaces v1.23.2/go.mod h1:pQdmmQt22CjVhGe8HHtU/tTCKwx98smrYmMM2C8iosQ= +github.com/aws/aws-sdk-go-v2/service/kinesis v1.40.1 h1:9QC0AF6gakV1TZuGp3NEUNl/6gXt3rfIifnxd+dWwbw= +github.com/aws/aws-sdk-go-v2/service/kinesis v1.40.1/go.mod h1:UpSQbmXxFiDGDrvqsTgEm3YijDf9cg/Ti+s2W0SeFEU= +github.com/aws/aws-sdk-go-v2/service/kinesisanalytics v1.30.2 h1:8ZbNqijMVzZZofOW/6Xh7wc7CXun5FE5MXjtgNAG0Lg= +github.com/aws/aws-sdk-go-v2/service/kinesisanalytics v1.30.2/go.mod h1:pmAbP9pq5R2jqEh//Me43nsNQYsYok8GjpqYz7QcolA= +github.com/aws/aws-sdk-go-v2/service/kinesisanalyticsv2 v1.36.3 h1:QZeo3/lt9h1Ds/svP26ZRrbNcqMKDct1d2rAh0dqAjo= +github.com/aws/aws-sdk-go-v2/service/kinesisanalyticsv2 v1.36.3/go.mod h1:EnvBk5Fi0pAy4F1utrmERPPLcuGyTp9X2ydePEGm6as= +github.com/aws/aws-sdk-go-v2/service/kinesisvideo v1.32.1 h1:0CfC8/6m9HhcAKSkN79iiLjj766k5bnGPls7Gpshekg= +github.com/aws/aws-sdk-go-v2/service/kinesisvideo v1.32.1/go.mod h1:TN5seLoay67ikVXd4gI6EU2vdn2Ke8EdzlDWi5N59ZQ= +github.com/aws/aws-sdk-go-v2/service/kms v1.45.1 h1:NhkI4kfcZYmcIM34a+q9drh3aMG1BthkyziOr7sRTv4= +github.com/aws/aws-sdk-go-v2/service/kms v1.45.1/go.mod h1:elyXIFqx79eHvd0cRAzYDYHajeoJEygkBjJto4HJddc= +github.com/aws/aws-sdk-go-v2/service/lakeformation v1.45.1 h1:BRYyXi9Li2KlXWfkNvPYm00nnYPFgXfcPLEdA+SLXdk= +github.com/aws/aws-sdk-go-v2/service/lakeformation v1.45.1/go.mod h1:p06/vzxmF/yX9uei/CtO4tDFQ3lSyvEBw/F0s7S8QJE= +github.com/aws/aws-sdk-go-v2/service/lambda v1.77.2 h1:fJVIBLHXWxaCUsESJgY3y/R5DNy7JAJ+DgeT91dDiyU= +github.com/aws/aws-sdk-go-v2/service/lambda v1.77.2/go.mod h1:Sbu0Y/aqwGRAskM+Hw44L1nop2I6FK5IADcMCfa5wE0= +github.com/aws/aws-sdk-go-v2/service/launchwizard v1.13.2 h1:1IBwOlg/WTe8hIKpWUvnf/hf4F5dQxsL2kXkCkklbiQ= +github.com/aws/aws-sdk-go-v2/service/launchwizard v1.13.2/go.mod h1:Z2kxQSCAmdY0pPrpfVrEJptPEvWNI3QUmtJ0GsRlrUY= +github.com/aws/aws-sdk-go-v2/service/lexmodelbuildingservice v1.33.1 h1:rn2FTVBpfdNDRn7PAjuRLSJ4uCyI+e2Z4KJJtBtEz8s= +github.com/aws/aws-sdk-go-v2/service/lexmodelbuildingservice v1.33.1/go.mod h1:YqfkR+PBSQJLzQvHABm7aOYQr7eAjfE3sovr2sZ8ye4= +github.com/aws/aws-sdk-go-v2/service/lexmodelsv2 v1.56.2 h1:g6UGKTATXpxBTTHKr3M08DLRBzq84FQZyOGgj3wxrNw= +github.com/aws/aws-sdk-go-v2/service/lexmodelsv2 v1.56.2/go.mod h1:AfplfLn7h73O2+N/Avmmxl0iTXK4taXo8UrIQ1MNYlI= +github.com/aws/aws-sdk-go-v2/service/licensemanager v1.36.2 h1:q/4QZ+EjbF2CJPZbsD1XFES7YOPAt/YHvk0zPWtMmWQ= +github.com/aws/aws-sdk-go-v2/service/licensemanager v1.36.2/go.mod h1:gQ1fiatpNaGerkhbbXs2h3N+antINpIuC3+n0qbPxlc= +github.com/aws/aws-sdk-go-v2/service/lightsail v1.48.2 h1:bbcKDYr5ivT4ghbcNmKPmLpH/42dn0CqZgE6c7SziQU= +github.com/aws/aws-sdk-go-v2/service/lightsail v1.48.2/go.mod h1:yYrzhBVvgD0aekhyjDij7gw1JVFHetfPUfxyyr0X3e8= +github.com/aws/aws-sdk-go-v2/service/location v1.49.2 h1:WpsAwA0aNp+x4dZSrKziIf8lx6/pD86URzA+DLOgpzs= +github.com/aws/aws-sdk-go-v2/service/location v1.49.2/go.mod h1:hV93DXgH2VEoY1err3EtxFY08ekWVsT31ZPGPVViN8c= +github.com/aws/aws-sdk-go-v2/service/lookoutmetrics v1.36.2 h1:wTj8xWtSCzyDfLg4LlClw23eMELksHZ32MhyWDpSkOM= +github.com/aws/aws-sdk-go-v2/service/lookoutmetrics v1.36.2/go.mod h1:XCoN+Erp+a2o/doaItiAgkTmXlT7K7dnTjf/mwNtOGw= +github.com/aws/aws-sdk-go-v2/service/m2 v1.25.2 h1:D/3runLJe4DYuCboq+OukD+Vf/zdXreQCE7/rANMYto= +github.com/aws/aws-sdk-go-v2/service/m2 v1.25.2/go.mod h1:ug8PGGYq9+/ExH8veHXUaHsN9Jj8SVd1LEe8rI4ofjA= +github.com/aws/aws-sdk-go-v2/service/macie2 v1.49.2 h1:SSTVebeUdhbix4G+EIdpDs0BPaquk1/k0dlMCpM5RG0= +github.com/aws/aws-sdk-go-v2/service/macie2 v1.49.2/go.mod h1:eJs7j5kobel1UXlczSHjSvZvWTFDlDy8xsCrd4zU6ms= +github.com/aws/aws-sdk-go-v2/service/mediaconnect v1.44.2 h1:ga+0OEEZC1ykB32a/+R0QabZHB15R21AKhjjtwpmoy8= +github.com/aws/aws-sdk-go-v2/service/mediaconnect v1.44.2/go.mod h1:NHwOWoVYH68SFtRglQST43ddIsHNogUxyENfpxodKWM= +github.com/aws/aws-sdk-go-v2/service/mediaconvert v1.82.2 h1:y7sJwmKba7eR+NC+QYEBXer4WsXFMnWAdc+tGF5WSXY= +github.com/aws/aws-sdk-go-v2/service/mediaconvert v1.82.2/go.mod h1:98+WyOT4VtVfTD/Gr2aDHR9dzZxNHcdYCLLbYi+ghFQ= +github.com/aws/aws-sdk-go-v2/service/medialive v1.81.2 h1:nDDUfwtvJhIm+iua3Slds0XFTmmahIulH1hITQAuGsM= +github.com/aws/aws-sdk-go-v2/service/medialive v1.81.2/go.mod h1:GsHZRIBtRirgUfeHdH0qUlFm16uFXU2iaEqQ6p3CUfw= +github.com/aws/aws-sdk-go-v2/service/mediapackage v1.39.2 h1:ul7XXORFXSPYEVCDwB0urPAheVO09CsyioVswBMoixo= +github.com/aws/aws-sdk-go-v2/service/mediapackage v1.39.2/go.mod h1:2nGnFjoxAMuAwZami5DUGySCoJbM02FDti68RN14fa4= +github.com/aws/aws-sdk-go-v2/service/mediapackagev2 v1.30.2 h1:adPpqiu26kt1mN9zjwLfRhHmNMYachXR1GPwQH0PjDc= +github.com/aws/aws-sdk-go-v2/service/mediapackagev2 v1.30.2/go.mod h1:BvI+coqicHOWc/jODnTLjOxGZkc3ZzzbgAZxvZyd+hs= +github.com/aws/aws-sdk-go-v2/service/mediapackagevod v1.39.2 h1:qTV1eMZUu1KgyPbiilVxV4mW5D+BNWux187jhnB7o+Q= +github.com/aws/aws-sdk-go-v2/service/mediapackagevod v1.39.2/go.mod h1:IZtKkqbU0jBvGkSqW7YpinF6iNtE9cVB42hjuJZlPPg= +github.com/aws/aws-sdk-go-v2/service/mediastore v1.29.2 h1:QinCfaJL3wHwNSlL4yaAIEBb9e4waAmck0gVuVlZVfg= +github.com/aws/aws-sdk-go-v2/service/mediastore v1.29.2/go.mod h1:lXXe0GYwXcEoB1XVqHSq6a+n3CQ2uO7FOx7UVt1gtVE= +github.com/aws/aws-sdk-go-v2/service/memorydb v1.31.2 h1:AbXfA2+h39tChp7mnfFx+nW3kZoXuz11mFkFvV0Bc4U= +github.com/aws/aws-sdk-go-v2/service/memorydb v1.31.2/go.mod h1:dvpVmhK6Tq5Z+yWFDNFJl3C3JU35JgYhw6RX+Evj5xI= +github.com/aws/aws-sdk-go-v2/service/mgn v1.37.1 h1:tgAwtExWmZwFS3uXnq13gYJZPWOhSnD8DiPG9DyCCEk= +github.com/aws/aws-sdk-go-v2/service/mgn v1.37.1/go.mod h1:x6cENwxLQupiiL1RSa3V5KWA5/U/k5LYb7W5VAU2aVU= +github.com/aws/aws-sdk-go-v2/service/mq v1.33.2 h1:tzFcfDSjBXVTtbZUGtFBLBh7u9Hx9vLJwmS3a3G8XLg= +github.com/aws/aws-sdk-go-v2/service/mq v1.33.2/go.mod h1:/cY5DP3yOf7chKkiHdKrwv1sN0sYu1YoTff2pmLbnbs= +github.com/aws/aws-sdk-go-v2/service/mwaa v1.39.2 h1:hCfXnZGSHBPuw7PnBEGgUJJFh83M4fZDKMjNd3NOyDM= +github.com/aws/aws-sdk-go-v2/service/mwaa v1.39.2/go.mod h1:buzZot1R2yAsQ9eVoQagpZ595yizch+xdSP6BStUxSQ= +github.com/aws/aws-sdk-go-v2/service/neptune v1.42.0 h1:YAM5JqLr2+ZwbHoQWeASolqSy+36eIj/H5LLLr979T0= +github.com/aws/aws-sdk-go-v2/service/neptune v1.42.0/go.mod h1:4Gq2StBipHbnBpL75SlNXYSsmgoALkjWT1i5Omx/NyE= +github.com/aws/aws-sdk-go-v2/service/neptunegraph v1.21.1 h1:7EFqHTCnPVj/FICjur3tR194fwQ+rLVVbTTi31/iA9Q= +github.com/aws/aws-sdk-go-v2/service/neptunegraph v1.21.1/go.mod h1:+S+f7gxu7d5AtL/wOOr+QcFv5Eov7qXudPfLqPKG+S0= +github.com/aws/aws-sdk-go-v2/service/networkfirewall v1.55.1 h1:0v9wUjQibqrzx6rLzFkozCHwzGclwGwKQFlZk1YWX+g= +github.com/aws/aws-sdk-go-v2/service/networkfirewall v1.55.1/go.mod h1:rV+KqkVMi93lnXpXSJiSvVt2dOs6HFKcJck1NNIK490= +github.com/aws/aws-sdk-go-v2/service/networkmanager v1.39.3 h1:gY4PvsoPWzIOtm6CFTe2ObPjpYUpt0jyJ/oumeuE/6k= +github.com/aws/aws-sdk-go-v2/service/networkmanager v1.39.3/go.mod h1:TVPzh8RtsPMdRA421VtCuJEP1v5vaZSArkobw7MXlww= +github.com/aws/aws-sdk-go-v2/service/networkmonitor v1.12.2 h1:dQ9dCkC619cNuiXJI2RklFea/eIc30RD/XhE5RCLznE= +github.com/aws/aws-sdk-go-v2/service/networkmonitor v1.12.2/go.mod h1:cs/wqWocUbgUnGwU/Ea9YJ19CZkPn7kk4qnbi0uTWsM= +github.com/aws/aws-sdk-go-v2/service/notifications v1.7.0 h1:EBk+1ZduoUbA0GtnTAV8j0VUvQu0rVGXViUrK1G07Q0= +github.com/aws/aws-sdk-go-v2/service/notifications v1.7.0/go.mod h1:5kDrVxrEbhjDZqlXYTbEe30HNTKR7cF7Yc4S/IK8KcI= +github.com/aws/aws-sdk-go-v2/service/notificationscontacts v1.5.4 h1:PzrU9JiVo+exAVnUpGiMR85U9SvWk6ZgFaRNUGnpINM= +github.com/aws/aws-sdk-go-v2/service/notificationscontacts v1.5.4/go.mod h1:/xFLJqrrgsCQz3CFhuPXD5o6OP+sjXFaIp3fvycjWOU= +github.com/aws/aws-sdk-go-v2/service/oam v1.22.1 h1:cGcxO6BjTAKdb8a6wezZEUwHh9FQyTMkDEH7NW9XnwI= +github.com/aws/aws-sdk-go-v2/service/oam v1.22.1/go.mod h1:7FL0wpgqB1DXHmD5sh0Shnq70Ib6Yb3ayh0OHeJO9a4= +github.com/aws/aws-sdk-go-v2/service/odb v1.4.2 h1:Y2MMKh4c3YH+8CIxf/BPHy8iTspNT5396ClX2/nfRnU= +github.com/aws/aws-sdk-go-v2/service/odb v1.4.2/go.mod h1:/GY3y8SPSgLGazlItn1aGikoiRNXFORs3FXUk/1Y16g= +github.com/aws/aws-sdk-go-v2/service/opensearch v1.52.1 h1:9OnoPv+06kee2cfSwcbJqJtm2w8MDIoaYGGQKgkW7Pc= +github.com/aws/aws-sdk-go-v2/service/opensearch v1.52.1/go.mod h1:VdD2OqHk82qsJmNHOBWoqBoPKMk5wsQGRwW9B4Ln3qE= +github.com/aws/aws-sdk-go-v2/service/opensearchserverless v1.25.2 h1:Bz1SUFF1McsL8kbGpDZcTAYAzkeeGJrVI78eUX+2sj0= +github.com/aws/aws-sdk-go-v2/service/opensearchserverless v1.25.2/go.mod h1:l0f3Rb75Vy0zJf6hXNKDR+oYFojuWTUJXKhmYfQLd8c= +github.com/aws/aws-sdk-go-v2/service/organizations v1.44.2 h1:yPEB/4Wixi9oLQ4OOGR8CRFzvdi4S/fv5FRJcHG31mM= +github.com/aws/aws-sdk-go-v2/service/organizations v1.44.2/go.mod h1:xRPBK7o9nutMfPwVm7zg7+YCDrO06cs9J4P7btwa/iA= +github.com/aws/aws-sdk-go-v2/service/osis v1.19.1 h1:aoo3ElrrS5UxII33Bsk7v37AM7Xt2qDUewoQNmOhrLg= +github.com/aws/aws-sdk-go-v2/service/osis v1.19.1/go.mod h1:+fJKGQAI1FZEWgr9Ak2L4NalE/+muYwZTm5ODdwz44U= +github.com/aws/aws-sdk-go-v2/service/outposts v1.56.2 h1:VwNFKyLlOtvXBPLja/Q8hs1o5vtLn+y9L5VjCwGh8rQ= +github.com/aws/aws-sdk-go-v2/service/outposts v1.56.2/go.mod h1:m6oPE9UnVlxKJl3Z05N23MHUCy25Cu5zzU62QQqZRvE= +github.com/aws/aws-sdk-go-v2/service/paymentcryptography v1.23.2 h1:FS7YSZwM+gtZjC4csLH260o5ou1/HGs1s2ODEojhOiY= +github.com/aws/aws-sdk-go-v2/service/paymentcryptography v1.23.2/go.mod h1:8j3CgvUAWVP5ugpdLtdj7gtilRNgQV5cd2pzToN06qg= +github.com/aws/aws-sdk-go-v2/service/pcaconnectorad v1.15.2 h1:xGUYI7u/Z3XkFhwx5AXq6PcxzYagcEEZJIbhAIhPBxw= +github.com/aws/aws-sdk-go-v2/service/pcaconnectorad v1.15.2/go.mod h1:dt6dIEsrU9x4xAhlqL+aKa5aHL1ld3Cx+PyIvB6iM8w= +github.com/aws/aws-sdk-go-v2/service/pcs v1.12.1 h1:fqq56R6CEKiBOGKV9AmCG1vEiS3UDvkawNLu8yJRPPg= +github.com/aws/aws-sdk-go-v2/service/pcs v1.12.1/go.mod h1:XPQAXDqJoSDJS919hZDgE8M64Dr3nvzwSWIHqopdAm8= +github.com/aws/aws-sdk-go-v2/service/pinpoint v1.39.2 h1:52j59BkbBW0Zp1IvEmv4IcQQ3TX/5G+OLUk8ix8p7EE= +github.com/aws/aws-sdk-go-v2/service/pinpoint v1.39.2/go.mod h1:lxI1V2S0N3rKdpp/1AkgrEfr/W6r0LtfdTw/I0/iT7c= +github.com/aws/aws-sdk-go-v2/service/pinpointsmsvoicev2 v1.25.1 h1:5OVK43kiMcc6tgBgPKGNDFbiV5nsBt1BrDBrdXjNpAc= +github.com/aws/aws-sdk-go-v2/service/pinpointsmsvoicev2 v1.25.1/go.mod h1:8Do0eDYyHDDmYHf/1v9s1sd9bg9547DMFchoGbSf8Ac= +github.com/aws/aws-sdk-go-v2/service/pipes v1.23.1 h1:g25jup/yyGqWNQXaimGX9diCyU8KZGrQ/vWuTF5K4SM= +github.com/aws/aws-sdk-go-v2/service/pipes v1.23.1/go.mod h1:4+J6Maz7tbtuYgxjTvY66Jm1wOx+i5vkf1Fpk1hteoU= +github.com/aws/aws-sdk-go-v2/service/polly v1.53.2 h1:vcDKXb9+Auy9uibi3HsRY5/7Z1acUVbuXPxsTB+FTJk= +github.com/aws/aws-sdk-go-v2/service/polly v1.53.2/go.mod h1:06OhbqDrb/XS2Rp8wgoEFHeQsEvlqzSFuVLPsUMuwO4= +github.com/aws/aws-sdk-go-v2/service/pricing v1.39.2 h1:l/q4Z68sGq+AQGrDee1F04m1tkpP/oVRwCvfvN7BaQ4= +github.com/aws/aws-sdk-go-v2/service/pricing v1.39.2/go.mod h1:DYAtIMM3N9hDsLKFMuKIccnZPi55L2apMc66gz+sQ20= +github.com/aws/aws-sdk-go-v2/service/qbusiness v1.33.2 h1:cXKN86BdjoUR9XrBya5HW8jq63cdxexBRJ64oSk8IFs= +github.com/aws/aws-sdk-go-v2/service/qbusiness v1.33.2/go.mod h1:LFBZAkaRRGLIM6YomKelbPRNCmUS5+wXTc2GjUTbRbA= +github.com/aws/aws-sdk-go-v2/service/qldb v1.30.2 h1:qKleFvZS3Y8Y/bsUSJWHdqDSB4wZJUEG6q6NraQVadI= +github.com/aws/aws-sdk-go-v2/service/qldb v1.30.2/go.mod h1:GiVcvrCpT8x1LxX13KTzX3Nif5tws2W5un64kTEaAqU= +github.com/aws/aws-sdk-go-v2/service/quicksight v1.93.2 h1:q7LFCxCZ1XIgx+UYy8XbZITtR5uMg53zpXT3uICkYm4= +github.com/aws/aws-sdk-go-v2/service/quicksight v1.93.2/go.mod h1:Zrl3fkheKPAb+9H6EI1Hfc26xi5zmK2lDp8Bsf4I2DA= +github.com/aws/aws-sdk-go-v2/service/ram v1.34.2 h1:F21WHJ9CjB++7Rh8JpO+o8LlaayPXJI1pc2AAUqcZ1w= +github.com/aws/aws-sdk-go-v2/service/ram v1.34.2/go.mod h1:llK4kgNHccy++lfEj5HEq9scvxs50MPr1dMgqfsGE2E= +github.com/aws/aws-sdk-go-v2/service/rbin v1.26.2 h1:/d7f3wxyDfFvUxA6UBZLx/9af3lLoRjvpmmDOMuysyI= +github.com/aws/aws-sdk-go-v2/service/rbin v1.26.2/go.mod h1:f7j6IlDieTG503IXtH55Aj0iK1rTwSqKGUXyMQ83xyc= +github.com/aws/aws-sdk-go-v2/service/rds v1.104.1 h1:SWL25hSnSjpSyzhsImgS+JFfDsi2SJNpXcYbPX/mjyQ= +github.com/aws/aws-sdk-go-v2/service/rds v1.104.1/go.mod h1:BepvfU+5/iWo7uyVZg/2TdDJEPMUQtWTZ3HPy/WaZb4= +github.com/aws/aws-sdk-go-v2/service/redshift v1.58.1 h1:fvtiUHref8X8JucCCwman1gLSF2C4YqE0xGQOML7iSQ= +github.com/aws/aws-sdk-go-v2/service/redshift v1.58.1/go.mod h1:yiTu0iOctBFs+D6jjfA1Hnb0ct91hJNq7cQ7FhMZws8= +github.com/aws/aws-sdk-go-v2/service/redshiftdata v1.37.2 h1:jkkeGlMA3SrApz4dCY1rmpF2RTVGNr5ohw52A2681zA= +github.com/aws/aws-sdk-go-v2/service/redshiftdata v1.37.2/go.mod h1:7/cQR6Hqe/mAj+lsOAPuUBlZ5V5v3F6rPNW2IrWaLu4= +github.com/aws/aws-sdk-go-v2/service/redshiftserverless v1.31.2 h1:Ig4dTUqFpsvLr3FCdRaBM/yVtHyg7Ugtehs8N3PTWVk= +github.com/aws/aws-sdk-go-v2/service/redshiftserverless v1.31.2/go.mod h1:ogXm22LnayzeC/nvpho3YX/mrr7KY22lumhgqucSPXM= +github.com/aws/aws-sdk-go-v2/service/rekognition v1.51.1 h1:hZ2BntETXyoPXIMme1FGT4QjcRr0NB32z6Ji9fgDLzY= +github.com/aws/aws-sdk-go-v2/service/rekognition v1.51.1/go.mod h1:dQrBnn+QeI3ADcOP4zTYZ3hd42jQRtbyuemw7sRZwAo= +github.com/aws/aws-sdk-go-v2/service/resiliencehub v1.34.2 h1:yza40nSD/2vIUMWwmU+AKAVHP6X9oJ6csAccBL2FUfw= +github.com/aws/aws-sdk-go-v2/service/resiliencehub v1.34.2/go.mod h1:MHC40pfiv6PEuuQqTwSF5+6Y4hXIv+3+6BhrOX/zkxQ= +github.com/aws/aws-sdk-go-v2/service/resourceexplorer2 v1.21.2 h1:zP3ba3QkN/JEosnOgLy/Koyw/bqsaHP/JgcOZnkQ/UU= +github.com/aws/aws-sdk-go-v2/service/resourceexplorer2 v1.21.2/go.mod h1:u9pEQ10QG3INXYmR129OszMPJadPmgAAoBsqv1uxZ2s= +github.com/aws/aws-sdk-go-v2/service/resourcegroups v1.33.3 h1:lv1mu3NdIa5sqkSWGq2Pe/OnRFyLlwfWNxa37Az64nY= +github.com/aws/aws-sdk-go-v2/service/resourcegroups v1.33.3/go.mod h1:LUYthJpStiOnz5Qz5mmxZlu2V1h0F5Q7qQXMjUK8ojs= +github.com/aws/aws-sdk-go-v2/service/resourcegroupstaggingapi v1.30.2 h1:mjf0THDU1HniXbvfDrDaEpVezBsIwVi+Z3lQIHVaOv4= +github.com/aws/aws-sdk-go-v2/service/resourcegroupstaggingapi v1.30.2/go.mod h1:/Zc94W6KxN90khSJzZo61yvFoucxU5WTiDAGEGuc4Ao= +github.com/aws/aws-sdk-go-v2/service/rolesanywhere v1.21.2 h1:51kPAIcfOld54qX1GuttcFRIeCrfkB5AwGkb1hyQseI= +github.com/aws/aws-sdk-go-v2/service/rolesanywhere v1.21.2/go.mod h1:kL7oUvOOOifWJy/uPUR2tQbobhYlHi3/FKA7L0C2SiE= +github.com/aws/aws-sdk-go-v2/service/route53 v1.57.2 h1:S3UZycqIGdXUDZkHQ/dTo99mFaHATfCJEVcYrnT24o4= +github.com/aws/aws-sdk-go-v2/service/route53 v1.57.2/go.mod h1:j4q6vBiAJvH9oxFyFtZoV739zxVMsSn26XNFvFlorfU= +github.com/aws/aws-sdk-go-v2/service/route53domains v1.33.1 h1:ECXmK3bbh1DLmJEkyS1tXU0k5iOj+TIUrXJI4zgpkSM= +github.com/aws/aws-sdk-go-v2/service/route53domains v1.33.1/go.mod h1:JwpIh8KZpaZJWFjB0KmkElCK7398QzFGUDvjqxU0OmQ= +github.com/aws/aws-sdk-go-v2/service/route53profiles v1.9.2 h1:iJzNq8Mkkewq1wx0GWEiy8+g0XWrmz4VDcr8dV09Qmc= +github.com/aws/aws-sdk-go-v2/service/route53profiles v1.9.2/go.mod h1:N7gREZYdoi6fWnvRNtDk3xHpGPv5Tjys1OJ1kEHLaoc= +github.com/aws/aws-sdk-go-v2/service/route53recoverycontrolconfig v1.31.3 h1:HTVhZvnV0pzNuvwgboEwHYl8Yu86gL6tyUtPuBYfgDs= +github.com/aws/aws-sdk-go-v2/service/route53recoverycontrolconfig v1.31.3/go.mod h1:/nTiifZpzvw2LGcsnuwvy7711doQnZ5CbcXRE4roslE= +github.com/aws/aws-sdk-go-v2/service/route53recoveryreadiness v1.26.2 h1:kHk1vf01L6EZWJfb/tl9FCiUtivpZbuch8zjpfOFZh8= +github.com/aws/aws-sdk-go-v2/service/route53recoveryreadiness v1.26.2/go.mod h1:HssqCIVrwkn6lr7FhucjcbqEjm3Yn+cLYNw1NTlacdI= +github.com/aws/aws-sdk-go-v2/service/route53resolver v1.40.2 h1:Smb99KzDEt6X9c97P0TbG+PyjSaQJqzmddHPC9rFUdc= +github.com/aws/aws-sdk-go-v2/service/route53resolver v1.40.2/go.mod h1:OFYibvEVgaCMWorP+oKyPkfRDlILKV7fgTBT/CEl3QA= +github.com/aws/aws-sdk-go-v2/service/rum v1.28.3 h1:34ZOJ68Vne67uqRvgLSr06t+FXAAVH0U9SsTBfJdYl8= +github.com/aws/aws-sdk-go-v2/service/rum v1.28.3/go.mod h1:WoU5gqlz7e1qkiJN46U/NBvacoW1x7n8yvq45arml6o= +github.com/aws/aws-sdk-go-v2/service/s3 v1.87.3 h1:ETkfWcXP2KNPLecaDa++5bsQhCRa5M5sLUJa5DWYIIg= +github.com/aws/aws-sdk-go-v2/service/s3 v1.87.3/go.mod h1:+/3ZTqoYb3Ur7DObD00tarKMLMuKg8iqz5CHEanqTnw= +github.com/aws/aws-sdk-go-v2/service/s3control v1.65.4 h1:yLhv1ES05hpdIlE09NjNHl/EjQ1ctW9NUjacLJ5nODw= +github.com/aws/aws-sdk-go-v2/service/s3control v1.65.4/go.mod h1:1maUsrcjcvs5cFYpufGazZ32ttRROeIEBCCsAhyLD6o= +github.com/aws/aws-sdk-go-v2/service/s3outposts v1.33.2 h1:QyuMVRu+fUSd0CEjr3DIo9UoYLaWYfuzu90trof4SE4= +github.com/aws/aws-sdk-go-v2/service/s3outposts v1.33.2/go.mod h1:h+GeDG0DcW8qMLHjKIOtaXBOexdNEUGWQ089z0S6EXk= +github.com/aws/aws-sdk-go-v2/service/s3tables v1.10.1 h1:S/XTt495b8Gq/LG8Qk6n+nX2EyDJM/XtIbxb/tqG01g= +github.com/aws/aws-sdk-go-v2/service/s3tables v1.10.1/go.mod h1:KdvVQdbQpmJPR7Sc5Dhl6BDoeDdIzbNNjVW1ngESq+A= +github.com/aws/aws-sdk-go-v2/service/s3vectors v1.4.4 h1:+voCWwzv0hjPAYlPgFK5O/1Jbih2Kmis2GdGRm/ez4U= +github.com/aws/aws-sdk-go-v2/service/s3vectors v1.4.4/go.mod h1:BSxggpM5AIOTMl1ViayZKQW/3i08ticdyCClQohrdNk= +github.com/aws/aws-sdk-go-v2/service/sagemaker v1.213.1 h1:8wwJGiYXEG5hSGbtQnwcsdGnspIkS9TNwRf6vf1JVxM= +github.com/aws/aws-sdk-go-v2/service/sagemaker v1.213.1/go.mod h1:Ae028fYUbRG3E4ufQ2Kbia4VtG9C9enwh6pYCsHxonI= +github.com/aws/aws-sdk-go-v2/service/scheduler v1.17.1 h1:ogjtKXvsyTDbARaUOJyzrAGzffSpPUo4wq04pift9g0= +github.com/aws/aws-sdk-go-v2/service/scheduler v1.17.1/go.mod h1:ByEOJKwZ6GhUoex+J2CAsw3axuWo/Xe0F7qOLAeNwH8= +github.com/aws/aws-sdk-go-v2/service/schemas v1.33.1 h1:kHBF/4k2+qSE7NducknUvqy4fNkuomJwc1Uu1frUIhs= +github.com/aws/aws-sdk-go-v2/service/schemas v1.33.1/go.mod h1:N1eQPcS1CxWvbkbCJtfWTQE3dFFhaTlB6PC7+Jy302E= +github.com/aws/aws-sdk-go-v2/service/secretsmanager v1.39.2 h1:QMayWWWmfWyQwP4nZf3qdIVS39Pm65Yi5waYj1euCzo= +github.com/aws/aws-sdk-go-v2/service/secretsmanager v1.39.2/go.mod h1:4eAXC8WdO1rRt01ZKKq57z8oTzzLkkIo5IReQ+b8hEU= +github.com/aws/aws-sdk-go-v2/service/securityhub v1.63.2 h1:xyW+W8UGFmBegLgY3jcejDpMJpCjzCHDHZq6X1AgO0k= +github.com/aws/aws-sdk-go-v2/service/securityhub v1.63.2/go.mod h1:iGwIZwjxYYEwbnE7NUCDBGAvrkmWu2DMpxSXoYATaCc= +github.com/aws/aws-sdk-go-v2/service/securitylake v1.24.2 h1:baOZEoq1yQ/vl6bViVbEPZm0h/fFSDlL4gEw/eZMQko= +github.com/aws/aws-sdk-go-v2/service/securitylake v1.24.2/go.mod h1:0a8Af6RGkrvYCKq/Dum5S0JiRFTUgkDUpcctCsSII14= +github.com/aws/aws-sdk-go-v2/service/serverlessapplicationrepository v1.29.2 h1:oa5geySYdx/JbI4tOIHbrP4z9QeS5yapYtE4fmNih9M= +github.com/aws/aws-sdk-go-v2/service/serverlessapplicationrepository v1.29.2/go.mod h1:c2JTS2Gy7fUCSfZK0GXO/tewBmHrmIE77XYAP6+PpYs= +github.com/aws/aws-sdk-go-v2/service/servicecatalog v1.38.2 h1:wH/MVo9VvzJXMnHtawrU85309lqMAS4FNCOM23krd38= +github.com/aws/aws-sdk-go-v2/service/servicecatalog v1.38.2/go.mod h1:CdNdrQ5Eibe5gmd/CQ8aK2rJkEtcUtKjzZCDbR2YQxc= +github.com/aws/aws-sdk-go-v2/service/servicecatalogappregistry v1.35.2 h1:suwi0IZD2FAPqC2eaKE35sNJAFHXOJisRCZqiv9QMaI= +github.com/aws/aws-sdk-go-v2/service/servicecatalogappregistry v1.35.2/go.mod h1:j2WeUxVTdQIny/YxZ+ATXI+1O4VH1ue5ZDtOhfkj+bI= +github.com/aws/aws-sdk-go-v2/service/servicediscovery v1.39.5 h1:soJTg6MJHziT5Xj7b3OMuJ92HQLOIqvPzXZAWyXnnFY= +github.com/aws/aws-sdk-go-v2/service/servicediscovery v1.39.5/go.mod h1:z8hJkk3PNhYVmL6/CNb8QTeq63hHNJvlipF7BUQ2wl0= +github.com/aws/aws-sdk-go-v2/service/servicequotas v1.32.1 h1:FZyx6GVtwgU/VgQciAlDfAWTWd4SdrYti2yerujac1g= +github.com/aws/aws-sdk-go-v2/service/servicequotas v1.32.1/go.mod h1:tscyLnH7Ds1Ja+07MAxBIbtb+EN3SWL1EsdJPgHieCY= +github.com/aws/aws-sdk-go-v2/service/ses v1.34.1 h1:/sqmiyIhJl3sUelbSnIJiPeMLwRVL8RrWeU10hosiLk= +github.com/aws/aws-sdk-go-v2/service/ses v1.34.1/go.mod h1:L0ntuXDlMduVQ0dbor+A42SYwR15ddAqC7J81L3EyiU= +github.com/aws/aws-sdk-go-v2/service/sesv2 v1.53.1 h1:4UnpjeaUfSEQ7D0YldaG8C8LtEYA28Y/TTbET9BfP2c= +github.com/aws/aws-sdk-go-v2/service/sesv2 v1.53.1/go.mod h1:aob2hoCCLs9/E/Iwl6ClQvLXSQA7LhLD/e8/m3Gn4WA= +github.com/aws/aws-sdk-go-v2/service/sfn v1.39.2 h1:DFD1m7vwn3fYSYY20fgn5YUOMew2PteGaOoWr22PAZg= +github.com/aws/aws-sdk-go-v2/service/sfn v1.39.2/go.mod h1:Ji1ckIimHIgoJJ4xqw+KYHgeiyx/ZIjVjiXOFDCCwvw= +github.com/aws/aws-sdk-go-v2/service/shield v1.34.2 h1:daAMTHVfwUaAOdyBlGNtl09xqkjB9k3X3/BgEVpmJD4= +github.com/aws/aws-sdk-go-v2/service/shield v1.34.2/go.mod h1:TWtjIQVEyCP4M8JXZ/ePx3Zw2XHe1fC2arN6p44C2PI= +github.com/aws/aws-sdk-go-v2/service/signer v1.31.2 h1:m21C+93vtoz3ukgvKrZw/6sGyYKcLRkZCM1j4S3WLNQ= +github.com/aws/aws-sdk-go-v2/service/signer v1.31.2/go.mod h1:OzsMS5vSfvCCOfkGg5T4tADnGr+rtvT+E0prVrWdW4M= +github.com/aws/aws-sdk-go-v2/service/sns v1.38.1 h1:6AqFh9gI+BEOlKRXaYryGMCwygwaTlISVUs6qEMosaU= +github.com/aws/aws-sdk-go-v2/service/sns v1.38.1/go.mod h1:wZGK3CJNllAOeJ/xrnyTHotaXEvtC27KOLMMKGBeT+4= +github.com/aws/aws-sdk-go-v2/service/sqs v1.42.3 h1:0dWg1Tkz3FnEo48DgAh7CT22hYyMShly8WMd3sGx0xI= +github.com/aws/aws-sdk-go-v2/service/sqs v1.42.3/go.mod h1:hpOo4IGPfGPlHRcf2nizYAzKfz8GzbQ8tTDIUR4H4GQ= +github.com/aws/aws-sdk-go-v2/service/ssm v1.64.2 h1:6P4W42RUTZixRG6TgfRB8KlsqNzHtvBhs6sTbkVPZvk= +github.com/aws/aws-sdk-go-v2/service/ssm v1.64.2/go.mod h1:wtxdacy3oO5sHO03uOtk8HMGfgo1gBHKwuJdYM220i0= +github.com/aws/aws-sdk-go-v2/service/ssmcontacts v1.30.4 h1:uZu3+0UGmyvyAszwqxd1w14BJ6B7dC2R7KmpgpcIAt8= +github.com/aws/aws-sdk-go-v2/service/ssmcontacts v1.30.4/go.mod h1:AcrjFcoh1wLWYQqE+EUcTvHwjJLaSchTU/FcYKfW7BQ= +github.com/aws/aws-sdk-go-v2/service/ssmincidents v1.39.1 h1:DsH7AjU8npCm/XCi7qovfX1YXp1QoUe5CNS0F9lmJhI= +github.com/aws/aws-sdk-go-v2/service/ssmincidents v1.39.1/go.mod h1:DGicTMbnUELJ2LucW+maP/9NeVVU+JapfAkHZiT4jgE= +github.com/aws/aws-sdk-go-v2/service/ssmquicksetup v1.8.2 h1:IG0mSK5U5tQW3bg3JV4oSL6yYz7phBkyrO7lyQRT3c4= +github.com/aws/aws-sdk-go-v2/service/ssmquicksetup v1.8.2/go.mod h1:lpRVgTQzyPBScHFoWF3Kwjoz2vgmwa2soYnIfRsF5go= +github.com/aws/aws-sdk-go-v2/service/ssmsap v1.25.1 h1:Llm6eb9B6ZtAMQNuT4Sgb9sEnE9MKxBrHCdjyUSTFLU= +github.com/aws/aws-sdk-go-v2/service/ssmsap v1.25.1/go.mod h1:zTqrzk3TCJkjP5ldAYZpUhXWiczImO7zMAl1NeCI9xs= +github.com/aws/aws-sdk-go-v2/service/sso v1.29.1 h1:8OLZnVJPvjnrxEwHFg9hVUof/P4sibH+Ea4KKuqAGSg= +github.com/aws/aws-sdk-go-v2/service/sso v1.29.1/go.mod h1:27M3BpVi0C02UiQh1w9nsBEit6pLhlaH3NHna6WUbDE= +github.com/aws/aws-sdk-go-v2/service/ssoadmin v1.35.2 h1:pyyb8LLmAHx8VrmuKUY1uED5YEnuRLzen/OT5eA7hXo= +github.com/aws/aws-sdk-go-v2/service/ssoadmin v1.35.2/go.mod h1:9Z/1JSEe3knSXqJJ1jV5aE6zoIRjx+r6zEfea2uAyrE= +github.com/aws/aws-sdk-go-v2/service/ssooidc v1.34.2 h1:gKWSTnqudpo8dAxqBqZnDoDWCiEh/40FziUjr/mo6uA= +github.com/aws/aws-sdk-go-v2/service/ssooidc v1.34.2/go.mod h1:x7+rkNmRoEN1U13A6JE2fXne9EWyJy54o3n6d4mGaXQ= +github.com/aws/aws-sdk-go-v2/service/storagegateway v1.42.2 h1:qcFIg8bd4/3pMAZyXxAKBhhcA80RN41BseuVNHAsx/0= +github.com/aws/aws-sdk-go-v2/service/storagegateway v1.42.2/go.mod h1:gpReX9eEM8p3Gi2Dm/t9MCJNrSavNxdtPVBO5ID1Vrw= +github.com/aws/aws-sdk-go-v2/service/sts v1.38.2 h1:YZPjhyaGzhDQEvsffDEcpycq49nl7fiGcfJTIo8BszI= +github.com/aws/aws-sdk-go-v2/service/sts v1.38.2/go.mod h1:2dIN8qhQfv37BdUYGgEC8Q3tteM3zFxTI1MLO2O3J3c= +github.com/aws/aws-sdk-go-v2/service/swf v1.32.1 h1:6otLgBZi+sTyvITTL+EBPsVlFkb4ERjhmkj1fMUkIpc= +github.com/aws/aws-sdk-go-v2/service/swf v1.32.1/go.mod h1:xjlXiD9EH43JC5vsH5NbMsFGeMZlRpls7OtsaZtl0Yo= +github.com/aws/aws-sdk-go-v2/service/synthetics v1.40.2 h1:OcSQGKZKXqIx+XZcqtkNNepsuN2/aVLiqrqbNxtgJEY= +github.com/aws/aws-sdk-go-v2/service/synthetics v1.40.2/go.mod h1:mY/D6ARZ4fCYBlJpJnAXBeqMn3+Hl5mjr6EGBzVK4E8= +github.com/aws/aws-sdk-go-v2/service/taxsettings v1.16.2 h1:ZMC54cWTeean7YW6zcQB4pFi9pGgziRvtUQbgfiJjzw= +github.com/aws/aws-sdk-go-v2/service/taxsettings v1.16.2/go.mod h1:SHygAmKFOQ3n/HVh/jZ2SV3p/T4Cx9/MDIxAOZcvJnk= +github.com/aws/aws-sdk-go-v2/service/timestreaminfluxdb v1.16.2 h1:ckbblL+tBFcD0a5OHadeP+8nje1x1NqvjvunvCpuDUQ= +github.com/aws/aws-sdk-go-v2/service/timestreaminfluxdb v1.16.2/go.mod h1:NusGIyyw/Ml03C8jaf4FHub6ZFGl5IaN54zI/iZ/3ho= +github.com/aws/aws-sdk-go-v2/service/timestreamquery v1.35.1 h1:m7mVu4/mwg0G2pKJ4W68bBRvm6+/LiZAlah1XyK1qsQ= +github.com/aws/aws-sdk-go-v2/service/timestreamquery v1.35.1/go.mod h1:jdVmwsQ8r3JFTVeeZWIBLcZ/qV+OoUToWU0Mn9tuThA= +github.com/aws/aws-sdk-go-v2/service/timestreamwrite v1.35.1 h1:vXCCnaKvQ6StrwVu2VR4dLS56iG+mUw5t7y0SoIdERk= +github.com/aws/aws-sdk-go-v2/service/timestreamwrite v1.35.1/go.mod h1:ff44LnOrAky3P+BxilUkmLU3377cJsyyxFS/+qqMK18= +github.com/aws/aws-sdk-go-v2/service/transcribe v1.52.2 h1:3d0rfdZK9tqSpv1uEal2MyF7kFhCV1lU7PXDxliQYjo= +github.com/aws/aws-sdk-go-v2/service/transcribe v1.52.2/go.mod h1:gmY3w3v81216hqqABbBwuA76VlIufDxUepGdrwyGEm0= +github.com/aws/aws-sdk-go-v2/service/transfer v1.65.2 h1:ZxESRTr6uhTjoCq5Ir13duz0GuU+iDQQKWdiqCWATE0= +github.com/aws/aws-sdk-go-v2/service/transfer v1.65.2/go.mod h1:Sb0I32Nr9cdnsHRvNLm1a32S09l5E4sU7Z2FJEuXMrA= +github.com/aws/aws-sdk-go-v2/service/verifiedpermissions v1.28.3 h1:YHkBeqmOTk9JaOXj5aBmv5osRkyR+GNGagoEM98bk90= +github.com/aws/aws-sdk-go-v2/service/verifiedpermissions v1.28.3/go.mod h1:gwoKhKL/bJb8KQfclDrJQrWYG1iRBU/3joSnCfQ5b70= +github.com/aws/aws-sdk-go-v2/service/vpclattice v1.18.1 h1:ueH6Bqa3puxCxJZ7VNp8TnAmaBRcZxor5BoQMJ22RbM= +github.com/aws/aws-sdk-go-v2/service/vpclattice v1.18.1/go.mod h1:hB8cjaYZYBPvqnGuuqmUCW4VOmK++aoItn0AJJQ9euM= +github.com/aws/aws-sdk-go-v2/service/waf v1.30.1 h1:vVyc5/p3q0566oUS79ImDNmnAc1CPcr3bG9njSCTG1Q= +github.com/aws/aws-sdk-go-v2/service/waf v1.30.1/go.mod h1:HUh23PKbDr6cNfjEP3nNW2VERZsXrpWSyBorSwUXYQw= +github.com/aws/aws-sdk-go-v2/service/wafregional v1.30.2 h1:jy4ECSfJbGk5ypLIbxhXJT4JZK1QmkyPO7U88cpadG4= +github.com/aws/aws-sdk-go-v2/service/wafregional v1.30.2/go.mod h1:7LQxO2vewIZKimr1IYFmYxi0h6QLZoJ5u1Vp2QXgYpo= +github.com/aws/aws-sdk-go-v2/service/wafv2 v1.67.2 h1:2DlTie50vaR48vl7qfhwO4/Wcyp0EZfJvAafVERdj5w= +github.com/aws/aws-sdk-go-v2/service/wafv2 v1.67.2/go.mod h1:AJoCa1C5NTIPrb+ipa37XCLmzJx8+yR0oR0RthAX3i0= +github.com/aws/aws-sdk-go-v2/service/wellarchitected v1.39.2 h1:giFfWGLth/IiJZ3LgvG/hy6T8J4vbaB+X5K4MN0CX8I= +github.com/aws/aws-sdk-go-v2/service/wellarchitected v1.39.2/go.mod h1:o/TFtOOoVM7yZX2qHtHd1i0UBGI49Wt0lTzauYbKEJc= +github.com/aws/aws-sdk-go-v2/service/workmail v1.36.0 h1:n+zawjC5CTE4MJg+uBm8gJt1tEVoMX6zyZZpGV7DR2M= +github.com/aws/aws-sdk-go-v2/service/workmail v1.36.0/go.mod h1:6CKjfL6oQH63mt1VFvewFsu4ySbRsCJ5UvPc/idWWvI= +github.com/aws/aws-sdk-go-v2/service/workspaces v1.63.2 h1:b9rCSKtYt9bzjTKhvM9HJlSOkX9nrbvOM+Bx2OrLmD0= +github.com/aws/aws-sdk-go-v2/service/workspaces v1.63.2/go.mod h1:cyuDqMRRIARXm/gndad2OF+XeXotAL349N6/hZympDY= +github.com/aws/aws-sdk-go-v2/service/workspacesweb v1.32.2 h1:pEI+JZb/82WZpqO0dTxipiZeBCl6UhCYUkDDsFcxs5Q= +github.com/aws/aws-sdk-go-v2/service/workspacesweb v1.32.2/go.mod h1:L53nfLqk4M1G+rZek3o4rOzimvntauPKkGrWWjQ1F/Y= +github.com/aws/aws-sdk-go-v2/service/xray v1.36.0 h1:/bIf4FBZdnYsciaXBoTgRMgUwVkU0AZNF9R6e1FejqU= +github.com/aws/aws-sdk-go-v2/service/xray v1.36.0/go.mod h1:k0r/zDiz2HVcFUqlTVy6g2rpRT0zkoQPsSP7vsravIg= +github.com/aws/smithy-go v1.23.0 h1:8n6I3gXzWJB2DxBDnfxgBaSX6oe0d/t10qGz7OKqMCE= +github.com/aws/smithy-go v1.23.0/go.mod h1:t1ufH5HMublsJYulve2RKmHDC15xu1f26kHCp/HgceI= +github.com/beevik/etree v1.6.0 h1:u8Kwy8pp9D9XeITj2Z0XtA5qqZEmtJtuXZRQi+j03eE= +github.com/beevik/etree v1.6.0/go.mod h1:bh4zJxiIr62SOf9pRzN7UUYaEDa9HEKafK25+sLc0Gc= github.com/bgentry/speakeasy v0.1.0 h1:ByYyxL9InA1OWqxJqqp2A5pYHUrCiAL6K3J+LKSsQkY= github.com/bgentry/speakeasy v0.1.0/go.mod h1:+zsyZBPWlz7T6j88CTgSN5bM796AkVf0kBD4zp0CCIs= github.com/boombuler/barcode v1.0.1-0.20190219062509-6c824513bacc h1:biVzkmvwrH8WK8raXaxBx6fRVTlJILwEwQGL1I/ByEI= github.com/boombuler/barcode v1.0.1-0.20190219062509-6c824513bacc/go.mod h1:paBWMcWSl3LHKBqUq+rly7CNSldXjb2rDl3JlRe0mD8= github.com/bufbuild/protocompile v0.4.0 h1:LbFKd2XowZvQ/kajzguUp2DC9UEIQhIq77fZZlaQsNA= github.com/bufbuild/protocompile v0.4.0/go.mod h1:3v93+mbWn/v3xzN+31nwkJfrEpAUwp+BagBSZWx+TP8= -github.com/cedar-policy/cedar-go v0.1.0 h1:2tZwWn8tNO/896YAM7OQmH3vn98EeHEA3g9anwdVZvA= -github.com/cedar-policy/cedar-go v0.1.0/go.mod h1:pEgiK479O5dJfzXnTguOMm+bCplzy5rEEFPGdZKPWz4= +github.com/cedar-policy/cedar-go v1.2.6 h1:q6f1sRxhoBG7lnK/fH6oBG33ruf2yIpcfcPXNExANa0= +github.com/cedar-policy/cedar-go v1.2.6/go.mod h1:h5+3CVW1oI5LXVskJG+my9TFCYI5yjh/+Ul3EJie6MI= github.com/cloudflare/circl v1.6.1 h1:zqIqSPIndyBh1bjLVVDHMPpVKqp8Su/V+6MeDzzQBQ0= github.com/cloudflare/circl v1.6.1/go.mod h1:uddAzsPgqdMAYatqJ0lsjX1oECcQLIlRpzZh3pJrofs= github.com/cyphar/filepath-securejoin v0.4.1 h1:JyxxyPEaktOD+GAnqIqTf9A8tHyAG22rowi7HkoSU1s= @@ -590,12 +602,14 @@ github.com/go-git/go-billy/v5 v5.6.2/go.mod h1:rcFC2rAsp/erv7CMz9GczHcuD0D32fWzH github.com/go-git/go-git/v5 v5.14.0 h1:/MD3lCrGjCen5WfEAzKg00MJJffKhC8gzS80ycmCi60= github.com/go-git/go-git/v5 v5.14.0/go.mod h1:Z5Xhoia5PcWA3NF8vRLURn9E5FRhSl7dGj9ItW3Wk5k= github.com/go-logr/logr v1.2.2/go.mod h1:jdQByPbusPIv2/zmleS9BjJVeZ6kBagPoEUsqbVz/1A= -github.com/go-logr/logr v1.4.2 h1:6pFjapn8bFcIbiKo3XT4j/BhANplGihG6tvd+8rYgrY= -github.com/go-logr/logr v1.4.2/go.mod h1:9T104GzyrTigFIr8wt5mBrctHMim0Nb2HLGrmQ40KvY= +github.com/go-logr/logr v1.4.3 h1:CjnDlHq8ikf6E492q6eKboGOC0T8CDaOvkHCIg8idEI= +github.com/go-logr/logr v1.4.3/go.mod h1:9T104GzyrTigFIr8wt5mBrctHMim0Nb2HLGrmQ40KvY= github.com/go-logr/stdr v1.2.2 h1:hSWxHoqTgW2S2qGc0LTAI563KZ5YKYRhT3MFKZMbjag= github.com/go-logr/stdr v1.2.2/go.mod h1:mMo/vtBO5dYbehREoey6XUKy/eSumjCCveDpRre4VKE= github.com/go-test/deep v1.0.3 h1:ZrJSEWsXzPOxaZnFteGEfooLba+ju3FYIbOrS+rQd68= github.com/go-test/deep v1.0.3/go.mod h1:wGDj63lr65AM2AQyKZd/NYHGb0R+1RLqB8NKt3aSFNA= +github.com/goccy/go-yaml v1.18.0 h1:8W7wMFS12Pcas7KU+VVkaiCng+kG8QiFeFwzFb+rwuw= +github.com/goccy/go-yaml v1.18.0/go.mod h1:XBurs7gK8ATbW4ZPGKgcbrY1Br56PdM69F7LkFRi1kA= github.com/golang/groupcache v0.0.0-20241129210726-2c02b8208cf8 h1:f+oWsMOmNPc8JmEHVZIycC7hBoQxHH9pNKQORJNozsQ= github.com/golang/groupcache v0.0.0-20241129210726-2c02b8208cf8/go.mod h1:wcDNUvekVysuuOpQKo3191zZyTpiI6se1N1ULghS0sw= github.com/golang/protobuf v1.1.0/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U= @@ -612,8 +626,8 @@ github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0= github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo= github.com/hashicorp/aws-cloudformation-resource-schema-sdk-go v0.23.0 h1:l16/Vrl0+x+HjHJWEjcKPwHYoxN9EC78gAFXKlH6m84= github.com/hashicorp/aws-cloudformation-resource-schema-sdk-go v0.23.0/go.mod h1:HAmscHyzSOfB1Dr16KLc177KNbn83wscnZC+N7WyaM8= -github.com/hashicorp/aws-sdk-go-base/v2 v2.0.0-beta.65 h1:81+kWbE1yErFBMjME0I5k3x3kojjKsWtPYHEAutoPow= -github.com/hashicorp/aws-sdk-go-base/v2 v2.0.0-beta.65/go.mod h1:WtMzv9T++tfWVea+qB2MXoaqxw33S8bpJslzUike2mQ= +github.com/hashicorp/aws-sdk-go-base/v2 v2.0.0-beta.66 h1:HA6blfR0h6kGnw4oJ92tZzghubreIkWbQJ4NVNqS688= +github.com/hashicorp/aws-sdk-go-base/v2 v2.0.0-beta.66/go.mod h1:7kTJVbY5+igob9Q5N6KO81EGEKDNI9FpjujB31uI/n0= github.com/hashicorp/awspolicyequivalence v1.7.0 h1:HxwPEw2/31BqQa73PinGciTfG2uJ/ATelvDG8X1gScU= github.com/hashicorp/awspolicyequivalence v1.7.0/go.mod h1:+oCTxQEYt+GcRalqrqTCBcJf100SQYiWQ4aENNYxYe0= github.com/hashicorp/cli v1.1.7 h1:/fZJ+hNdwfTSfsxMBa9WWMlfjUZbX8/LnUxgAd7lCVU= @@ -650,10 +664,10 @@ github.com/hashicorp/logutils v1.0.0 h1:dLEQVugN8vlakKOUE3ihGLTZJRB4j+M2cdTm/ORI github.com/hashicorp/logutils v1.0.0/go.mod h1:QIAnNjmIWmVIIkWDTG1z5v++HQmx9WQRO+LraFDTW64= github.com/hashicorp/terraform-exec v0.23.0 h1:MUiBM1s0CNlRFsCLJuM5wXZrzA3MnPYEsiXmzATMW/I= github.com/hashicorp/terraform-exec v0.23.0/go.mod h1:mA+qnx1R8eePycfwKkCRk3Wy65mwInvlpAeOwmA7vlY= -github.com/hashicorp/terraform-json v0.25.0 h1:rmNqc/CIfcWawGiwXmRuiXJKEiJu1ntGoxseG1hLhoQ= -github.com/hashicorp/terraform-json v0.25.0/go.mod h1:sMKS8fiRDX4rVlR6EJUMudg1WcanxCMoWwTLkgZP/vc= -github.com/hashicorp/terraform-plugin-framework v1.15.0 h1:LQ2rsOfmDLxcn5EeIwdXFtr03FVsNktbbBci8cOKdb4= -github.com/hashicorp/terraform-plugin-framework v1.15.0/go.mod h1:hxrNI/GY32KPISpWqlCoTLM9JZsGH3CyYlir09bD/fI= +github.com/hashicorp/terraform-json v0.26.0 h1:+BnJavhRH+oyNWPnfzrfQwVWCZBFMvjdiH2Vi38Udz4= +github.com/hashicorp/terraform-json v0.26.0/go.mod h1:eyWCeC3nrZamyrKLFnrvwpc3LQPIJsx8hWHQ/nu2/v4= +github.com/hashicorp/terraform-plugin-framework v1.15.1 h1:2mKDkwb8rlx/tvJTlIcpw0ykcmvdWv+4gY3SIgk8Pq8= +github.com/hashicorp/terraform-plugin-framework v1.15.1/go.mod h1:hxrNI/GY32KPISpWqlCoTLM9JZsGH3CyYlir09bD/fI= github.com/hashicorp/terraform-plugin-framework-jsontypes v0.2.0 h1:SJXL5FfJJm17554Kpt9jFXngdM6fXbnUnZ6iT2IeiYA= github.com/hashicorp/terraform-plugin-framework-jsontypes v0.2.0/go.mod h1:p0phD0IYhsu9bR4+6OetVvvH59I6LwjXGnTVEr8ox6E= github.com/hashicorp/terraform-plugin-framework-timeouts v0.5.0 h1:I/N0g/eLZ1ZkLZXUQ0oRSXa8YG/EF0CEuQP1wXdrzKw= @@ -668,8 +682,8 @@ github.com/hashicorp/terraform-plugin-mux v0.20.0 h1:3QpBnI9uCuL0Yy2Rq/kR9cOdmOF github.com/hashicorp/terraform-plugin-mux v0.20.0/go.mod h1:wSIZwJjSYk86NOTX3fKUlThMT4EAV1XpBHz9SAvjQr4= github.com/hashicorp/terraform-plugin-sdk/v2 v2.37.0 h1:NFPMacTrY/IdcIcnUB+7hsore1ZaRWU9cnB6jFoBnIM= github.com/hashicorp/terraform-plugin-sdk/v2 v2.37.0/go.mod h1:QYmYnLfsosrxjCnGY1p9c7Zj6n9thnEE+7RObeYs3fA= -github.com/hashicorp/terraform-plugin-testing v1.13.2 h1:mSotG4Odl020vRjIenA3rggwo6Kg6XCKIwtRhYgp+/M= -github.com/hashicorp/terraform-plugin-testing v1.13.2/go.mod h1:WHQ9FDdiLoneey2/QHpGM/6SAYf4A7AZazVg7230pLE= +github.com/hashicorp/terraform-plugin-testing v1.13.3 h1:QLi/khB8Z0a5L54AfPrHukFpnwsGL8cwwswj4RZduCo= +github.com/hashicorp/terraform-plugin-testing v1.13.3/go.mod h1:WHQ9FDdiLoneey2/QHpGM/6SAYf4A7AZazVg7230pLE= github.com/hashicorp/terraform-registry-address v0.2.5 h1:2GTftHqmUhVOeuu9CW3kwDkRe4pcBDq0uuK5VJngU1M= github.com/hashicorp/terraform-registry-address v0.2.5/go.mod h1:PpzXWINwB5kuVS5CA7m1+eO2f1jKb5ZDIxrOPfpnGkg= github.com/hashicorp/terraform-svchost v0.1.1 h1:EZZimZ1GxdqFRinZ1tpJwVxxt49xc/S52uzrw4x0jKQ= @@ -715,8 +729,8 @@ github.com/mitchellh/go-homedir v1.1.0 h1:lukF9ziXFxDFPkA1vsr5zpc1XuPDn/wFntq5mG github.com/mitchellh/go-homedir v1.1.0/go.mod h1:SfyaCUpYCn1Vlf4IUYiD9fPX4A5wJrkLzIz1N1q0pr0= github.com/mitchellh/go-testing-interface v1.14.1 h1:jrgshOhYAUVNMAJiKbEu7EqAwgJJ2JqpQmpLJOu07cU= github.com/mitchellh/go-testing-interface v1.14.1/go.mod h1:gfgS7OtZj6MA4U1UrDRp04twqAjfvlZyCfX3sDjEym8= -github.com/mitchellh/go-wordwrap v1.0.0 h1:6GlHJ/LTGMrIJbwgdqdl2eEH8o+Exx/0m8ir9Gns0u4= -github.com/mitchellh/go-wordwrap v1.0.0/go.mod h1:ZXFpozHsX6DPmq2I0TCekCxypsnAUbP2oI0UX1GXzOo= +github.com/mitchellh/go-wordwrap v1.0.1 h1:TLuKupo69TCn6TQSyGxwI1EblZZEsQ0vMlAFQflz0v0= +github.com/mitchellh/go-wordwrap v1.0.1/go.mod h1:R62XHJLzvMFRBbcrT7m7WgmE1eOyTSsCt+hzestvNj0= github.com/mitchellh/mapstructure v1.5.0 h1:jeMsZIYE/09sWLaz43PL7Gy6RuMjD2eJVyuac5Z2hdY= github.com/mitchellh/mapstructure v1.5.0/go.mod h1:bFUtVrKA4DC2yAKiSyO/QUcy7e+RRV2QTWOzhPopBRo= github.com/mitchellh/reflectwalk v1.0.0/go.mod h1:mSTlrgnPZtwu0c4WaC2kGObEpuNDbx0jmZXqmk4esnw= @@ -751,8 +765,8 @@ github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UV github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4= github.com/stretchr/testify v1.5.1/go.mod h1:5W2xD1RspED5o8YsWQXVCued0rvSQ+mT+I5cxcmMvtA= github.com/stretchr/testify v1.7.2/go.mod h1:R6va5+xMeoiuVRoj+gSkQ7d3FALtqAAGI1FQKckRals= -github.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA= -github.com/stretchr/testify v1.10.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY= +github.com/stretchr/testify v1.11.1 h1:7s2iGBzp5EwR7/aIZr8ao5+dra3wiQyKjjFuvgVKu7U= +github.com/stretchr/testify v1.11.1/go.mod h1:wZwfW3scLgRK+23gO65QZefKpKQRnfz6sD981Nm4B6U= github.com/vmihailenco/msgpack v3.3.3+incompatible/go.mod h1:fy3FlTQTDXWkZ7Bh6AcGMlsjHatGryHQYUTf1ShIgkk= github.com/vmihailenco/msgpack v4.0.4+incompatible h1:dSLoQfGFAo3F6OoNhwUmLwVgaUXK79GlxNBwueZn0xI= github.com/vmihailenco/msgpack v4.0.4+incompatible/go.mod h1:fy3FlTQTDXWkZ7Bh6AcGMlsjHatGryHQYUTf1ShIgkk= @@ -775,35 +789,35 @@ github.com/zclconf/go-cty-debug v0.0.0-20240509010212-0d6042c53940 h1:4r45xpDWB6 github.com/zclconf/go-cty-debug v0.0.0-20240509010212-0d6042c53940/go.mod h1:CmBdvvj3nqzfzJ6nTCIwDTPZ56aVGvDrmztiO5g3qrM= go.opentelemetry.io/auto/sdk v1.1.0 h1:cH53jehLUN6UFLY71z+NDOiNJqDdPRaXzTel0sJySYA= go.opentelemetry.io/auto/sdk v1.1.0/go.mod h1:3wSPjt5PWp2RhlCcmmOial7AvC4DQqZb7a7wCow3W8A= -go.opentelemetry.io/contrib/instrumentation/github.com/aws/aws-sdk-go-v2/otelaws v0.61.0 h1:lR4WnQLBC9XyTwKrz0327rq2QnIdJNpaVIGuW2yMvME= -go.opentelemetry.io/contrib/instrumentation/github.com/aws/aws-sdk-go-v2/otelaws v0.61.0/go.mod h1:UK49mXgwqIWFUDH8ibqTswbhy4fuwjEjj4VKMC7krUQ= -go.opentelemetry.io/otel v1.36.0 h1:UumtzIklRBY6cI/lllNZlALOF5nNIzJVb16APdvgTXg= -go.opentelemetry.io/otel v1.36.0/go.mod h1:/TcFMXYjyRNh8khOAO9ybYkqaDBb/70aVwkNML4pP8E= -go.opentelemetry.io/otel/metric v1.36.0 h1:MoWPKVhQvJ+eeXWHFBOPoBOi20jh6Iq2CcCREuTYufE= -go.opentelemetry.io/otel/metric v1.36.0/go.mod h1:zC7Ks+yeyJt4xig9DEw9kuUFe5C3zLbVjV2PzT6qzbs= -go.opentelemetry.io/otel/sdk v1.34.0 h1:95zS4k/2GOy069d321O8jWgYsW3MzVV+KuSPKp7Wr1A= -go.opentelemetry.io/otel/sdk v1.34.0/go.mod h1:0e/pNiaMAqaykJGKbi+tSjWfNNHMTxoC9qANsCzbyxU= +go.opentelemetry.io/contrib/instrumentation/github.com/aws/aws-sdk-go-v2/otelaws v0.63.0 h1:0W0GZvzQe514c3igO063tR0cFVStoABt1agKqlYToL8= +go.opentelemetry.io/contrib/instrumentation/github.com/aws/aws-sdk-go-v2/otelaws v0.63.0/go.mod h1:wIvTiRUU7Pbfqas/5JVjGZcftBeSAGSYVMOHWzWG0qE= +go.opentelemetry.io/otel v1.38.0 h1:RkfdswUDRimDg0m2Az18RKOsnI8UDzppJAtj01/Ymk8= +go.opentelemetry.io/otel v1.38.0/go.mod h1:zcmtmQ1+YmQM9wrNsTGV/q/uyusom3P8RxwExxkZhjM= +go.opentelemetry.io/otel/metric v1.38.0 h1:Kl6lzIYGAh5M159u9NgiRkmoMKjvbsKtYRwgfrA6WpA= +go.opentelemetry.io/otel/metric v1.38.0/go.mod h1:kB5n/QoRM8YwmUahxvI3bO34eVtQf2i4utNVLr9gEmI= +go.opentelemetry.io/otel/sdk v1.38.0 h1:l48sr5YbNf2hpCUj/FoGhW9yDkl+Ma+LrVl8qaM5b+E= +go.opentelemetry.io/otel/sdk v1.38.0/go.mod h1:ghmNdGlVemJI3+ZB5iDEuk4bWA3GkTpW+DOoZMYBVVg= go.opentelemetry.io/otel/sdk/metric v1.34.0 h1:5CeK9ujjbFVL5c1PhLuStg1wxA7vQv7ce1EK0Gyvahk= go.opentelemetry.io/otel/sdk/metric v1.34.0/go.mod h1:jQ/r8Ze28zRKoNRdkjCZxfs6YvBTG1+YIqyFVFYec5w= -go.opentelemetry.io/otel/trace v1.36.0 h1:ahxWNuqZjpdiFAyrIoQ4GIiAIhxAunQR6MUoKrsNd4w= -go.opentelemetry.io/otel/trace v1.36.0/go.mod h1:gQ+OnDZzrybY4k4seLzPAWNwVBBVlF2szhehOBB/tGA= +go.opentelemetry.io/otel/trace v1.38.0 h1:Fxk5bKrDZJUH+AMyyIXGcFAPah0oRcT+LuNtJrmcNLE= +go.opentelemetry.io/otel/trace v1.38.0/go.mod h1:j1P9ivuFsTceSWe1oY+EeW3sc+Pp42sO++GHkg4wwhs= golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w= golang.org/x/crypto v0.0.0-20210921155107-089bfa567519/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc= golang.org/x/crypto v0.3.0/go.mod h1:hebNnKkNXi2UzZN1eVRvBB7co0a+JxK6XbPiWVs/3J4= -golang.org/x/crypto v0.39.0 h1:SHs+kF4LP+f+p14esP5jAoDpHU8Gu/v9lFRK6IT5imM= -golang.org/x/crypto v0.39.0/go.mod h1:L+Xg3Wf6HoL4Bn4238Z6ft6KfEpN0tJGo53AAPC632U= -golang.org/x/exp v0.0.0-20250506013437-ce4c2cf36ca6 h1:y5zboxd6LQAqYIhHnB48p0ByQ/GnQx2BE33L8BOHQkI= -golang.org/x/exp v0.0.0-20250506013437-ce4c2cf36ca6/go.mod h1:U6Lno4MTRCDY+Ba7aCcauB9T60gsv5s4ralQzP72ZoQ= +golang.org/x/crypto v0.41.0 h1:WKYxWedPGCTVVl5+WHSSrOBT0O8lx32+zxmHxijgXp4= +golang.org/x/crypto v0.41.0/go.mod h1:pO5AFd7FA68rFak7rOAGVuygIISepHftHnr8dr6+sUc= +golang.org/x/exp v0.0.0-20240222234643-814bf88cf225 h1:LfspQV/FYTatPTr/3HzIcmiUFH7PGP+OQ6mgDYo3yuQ= +golang.org/x/exp v0.0.0-20240222234643-814bf88cf225/go.mod h1:CxmFvTBINI24O/j8iY7H1xHzx2i4OsyguNBmN/uPtqc= golang.org/x/mod v0.6.0-dev.0.20220419223038-86c51ed26bb4/go.mod h1:jJ57K6gSWd91VN4djpZkiMVwK6gcyfeH4XE8wZrZaV4= -golang.org/x/mod v0.25.0 h1:n7a+ZbQKQA/Ysbyb0/6IbB1H/X41mKgbhfv7AfG/44w= -golang.org/x/mod v0.25.0/go.mod h1:IXM97Txy2VM4PJ3gI61r1YEk/gAj6zAHN3AdZt6S9Ww= +golang.org/x/mod v0.27.0 h1:kb+q2PyFnEADO2IEF935ehFUXlWiNjJWtRNgBLSfbxQ= +golang.org/x/mod v0.27.0/go.mod h1:rWI627Fq0DEoudcK+MBkNkCe0EetEaDSwJJkCcjpazc= golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg= golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg= golang.org/x/net v0.0.0-20220722155237-a158d28d115b/go.mod h1:XRhObCWvk6IyKnWLug+ECip1KBveYUHfp+8e9klMJ9c= golang.org/x/net v0.2.0/go.mod h1:KqCZLdyyvdV855qA2rE3GC2aiw5xGR5TEjj8smXukLY= -golang.org/x/net v0.41.0 h1:vBTly1HeNPEn3wtREYfy4GZ/NECgw2Cnl+nK6Nz3uvw= -golang.org/x/net v0.41.0/go.mod h1:B/K4NNqkfmg07DQYrbwvSluqCJOOXwUjeb/5lOisjbA= +golang.org/x/net v0.43.0 h1:lat02VYK2j4aLzMzecihNvTlJNQUq316m2Mr9rnM6YE= +golang.org/x/net v0.43.0/go.mod h1:vhO1fvI4dGsIjh73sWfUVjj3N7CA9WkKJNQm2svM6Jg= golang.org/x/sync v0.0.0-20180314180146-1d60e4601c6f/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= golang.org/x/sync v0.0.0-20220722155255-886fb9371eb4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= @@ -821,32 +835,32 @@ golang.org/x/sys v0.0.0-20220520151302-bc2c85ada10a/go.mod h1:oPkhp1MJrh7nUepCBc golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.2.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= -golang.org/x/sys v0.33.0 h1:q3i8TbbEz+JRD9ywIRlyRAQbM0qF7hu24q3teo2hbuw= -golang.org/x/sys v0.33.0/go.mod h1:BJP2sWEmIv4KK5OTEluFJCKSidICx8ciO85XgH3Ak8k= +golang.org/x/sys v0.35.0 h1:vz1N37gP5bs89s7He8XuIYXpyY0+QlsKmzipCbUtyxI= +golang.org/x/sys v0.35.0/go.mod h1:BJP2sWEmIv4KK5OTEluFJCKSidICx8ciO85XgH3Ak8k= golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo= golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8= golang.org/x/term v0.2.0/go.mod h1:TVmDHMZPmdnySmBfhjOoOdhjzdE1h4u1VwSiw2l1Nuc= -golang.org/x/term v0.32.0 h1:DR4lr0TjUs3epypdhTOkMmuF5CDFJ/8pOnbzMZPQ7bg= -golang.org/x/term v0.32.0/go.mod h1:uZG1FhGx848Sqfsq4/DlJr3xGGsYMu/L5GW4abiaEPQ= +golang.org/x/term v0.34.0 h1:O/2T7POpk0ZZ7MAzMeWFSg6S5IpWd/RXDlM9hgM3DR4= +golang.org/x/term v0.34.0/go.mod h1:5jC53AEywhIVebHgPVeg0mj8OD3VO9OzclacVrqpaAw= golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ= golang.org/x/text v0.3.8/go.mod h1:E6s5w1FMmriuDzIBO73fBruAKo1PCIq6d2Q6DHfQ8WQ= golang.org/x/text v0.4.0/go.mod h1:mrYo+phRRbMaCq/xk9113O4dZlRixOauAjOtrjsXDZ8= -golang.org/x/text v0.27.0 h1:4fGWRpyh641NLlecmyl4LOe6yDdfaYNrGb2zdfo4JV4= -golang.org/x/text v0.27.0/go.mod h1:1D28KMCvyooCX9hBiosv5Tz/+YLxj0j7XhWjpSUF7CU= +golang.org/x/text v0.28.0 h1:rhazDwis8INMIwQ4tpjLDzUhx6RlXqZNPEM0huQojng= +golang.org/x/text v0.28.0/go.mod h1:U8nCwOR8jO/marOQ0QbDiOngZVEBB7MAiitBuMjXiNU= golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= golang.org/x/tools v0.1.12/go.mod h1:hNGJHUnrk76NpqgfD5Aqm5Crs+Hm0VOH/i9J2+nxYbc= -golang.org/x/tools v0.34.0 h1:qIpSLOxeCYGg9TrcJokLBG4KFA6d795g0xkBkiESGlo= -golang.org/x/tools v0.34.0/go.mod h1:pAP9OwEaY1CAW3HOmg3hLZC5Z0CCmzjAF2UQMSqNARg= +golang.org/x/tools v0.36.0 h1:kWS0uv/zsvHEle1LbV5LE8QujrxB3wfQyxHfhOk0Qkg= +golang.org/x/tools v0.36.0/go.mod h1:WBDiHKJK8YgLHlcQPYQzNCkUxUypCaa5ZegCVutKm+s= golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= google.golang.org/appengine v1.1.0/go.mod h1:EbEs0AVv82hx2wNQdGPgUI5lhzA/G0D9YwlJXL52JkM= google.golang.org/appengine v1.6.8 h1:IhEN5q69dyKagZPYMSdIjS2HqprW324FRQZJcGqPAsM= google.golang.org/appengine v1.6.8/go.mod h1:1jJ3jBArFh5pcgW8gCtRJnepW8FzD1V44FJffLiz/Ds= -google.golang.org/genproto/googleapis/rpc v0.0.0-20250218202821-56aae31c358a h1:51aaUVRocpvUOSQKM6Q7VuoaktNIaMCLuhZB6DKksq4= -google.golang.org/genproto/googleapis/rpc v0.0.0-20250218202821-56aae31c358a/go.mod h1:uRxBH1mhmO8PGhU89cMcHaXKZqO+OfakD8QQO0oYwlQ= +google.golang.org/genproto/googleapis/rpc v0.0.0-20250505200425-f936aa4a68b2 h1:IqsN8hx+lWLqlN+Sc3DoMy/watjofWiU8sRFgQ8fhKM= +google.golang.org/genproto/googleapis/rpc v0.0.0-20250505200425-f936aa4a68b2/go.mod h1:qQ0YXyHHx3XkvlzUtpXDkS29lDSafHMZBAZDc03LQ3A= google.golang.org/grpc v1.72.1 h1:HR03wO6eyZ7lknl75XlxABNVLLFc2PAb6mHlYh756mA= google.golang.org/grpc v1.72.1/go.mod h1:wH5Aktxcg25y1I3w7H69nHfXdOG3UiadoBtjh3izSDM= google.golang.org/protobuf v1.26.0-rc.1/go.mod h1:jlhhOSvTdKEhbULTjvd4ARK9grFBp09yW+WbY/TyQbw= @@ -857,8 +871,8 @@ gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8 gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c h1:Hei/4ADfdWqJk1ZMxUNpqntNwaWcugrBjAiHlqqRiVk= gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c/go.mod h1:JHkPIbrfpd72SG/EVd6muEfDQjcINNoR0C8j2r3qZ4Q= -gopkg.in/dnaeon/go-vcr.v4 v4.0.4 h1:UNc8d1Ya2otEOU3DoUgnSLp0tXvBNE0FuFe86Nnzcbw= -gopkg.in/dnaeon/go-vcr.v4 v4.0.4/go.mod h1:65yxh9goQVrudqofKtHA4JNFWd6XZRkWfKN4YpMx7KI= +gopkg.in/dnaeon/go-vcr.v4 v4.0.5 h1:I0hpTIvD5rII+8LgYGrHMA2d4SQPoL6u7ZvJakWKsiA= +gopkg.in/dnaeon/go-vcr.v4 v4.0.5/go.mod h1:dRos81TkW9C1WJt6tTaE+uV2Lo8qJT3AG2b35+CB/nQ= gopkg.in/warnings.v0 v0.1.2 h1:wFXVbFY8DY5/xOe1ECiWdKCzZlxgshcYVNkBHstARME= gopkg.in/warnings.v0 v0.1.2/go.mod h1:jksf8JmL6Qr/oQM2OXTHunEvvTAsrWBLb6OOjuVWRNI= gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= diff --git a/tools/tfsdk2fw/main.go b/tools/tfsdk2fw/main.go index cbfa767b83bd..f0201c4df04a 100644 --- a/tools/tfsdk2fw/main.go +++ b/tools/tfsdk2fw/main.go @@ -11,13 +11,13 @@ import ( "io" "os" "path" + "slices" "strings" "github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema" "github.com/hashicorp/terraform-provider-aws/internal/generate/common" - "github.com/hashicorp/terraform-provider-aws/internal/provider" + "github.com/hashicorp/terraform-provider-aws/internal/provider/sdkv2" "github.com/hashicorp/terraform-provider-aws/tools/tfsdk2fw/naming" - "golang.org/x/exp/slices" ) var ( @@ -57,7 +57,7 @@ func main() { PackageName: packageName, } - p, err := provider.New(context.Background()) + p, err := sdkv2.NewProvider(context.Background()) if err != nil { g.Fatalf(err.Error()) diff --git a/version/VERSION b/version/VERSION new file mode 100644 index 000000000000..d4e6cb42939b --- /dev/null +++ b/version/VERSION @@ -0,0 +1 @@ +6.12.0 diff --git a/website/allowed-subcategories.txt b/website/allowed-subcategories.txt index 45c4b8b75701..d0fef3789c3b 100644 --- a/website/allowed-subcategories.txt +++ b/website/allowed-subcategories.txt @@ -17,6 +17,7 @@ AppStream 2.0 AppSync Application Auto Scaling Application Migration (Mgn) +Application Resilience Controller Region Switch Application Signals Athena Audit Manager @@ -26,6 +27,7 @@ BCM Data Exports Backup Batch Bedrock +Bedrock AgentCore Bedrock Agents Billing CE (Cost Explorer) @@ -174,6 +176,7 @@ Network Manager OpenSearch OpenSearch Ingestion OpenSearch Serverless +Oracle Database@AWS Organizations Outposts Outposts (EC2) @@ -207,6 +210,7 @@ S3 (Simple Storage) S3 Control S3 Glacier S3 Tables +S3 Vectors S3 on Outposts SES (Simple Email) SESv2 (Simple Email V2) @@ -255,6 +259,7 @@ WAF Classic Regional Wavelength Web Services Budgets Well-Architected Tool +WorkMail WorkSpaces WorkSpaces Web X-Ray diff --git a/website/docs/cdktf/python/d/acm_certificate.html.markdown b/website/docs/cdktf/python/d/acm_certificate.html.markdown index 4d97d9a3e29b..d245f61563aa 100644 --- a/website/docs/cdktf/python/d/acm_certificate.html.markdown +++ b/website/docs/cdktf/python/d/acm_certificate.html.markdown @@ -46,6 +46,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `domain` - (Optional) Domain of the certificate to look up. If set and no certificate is found with this name, an error will be returned. * `key_types` - (Optional) List of key algorithms to filter certificates. By default, ACM does not return all certificate types when searching. See the [ACM API Reference](https://docs.aws.amazon.com/acm/latest/APIReference/API_CertificateDetail.html#ACM-Type-CertificateDetail-KeyAlgorithm) for supported key algorithms. * `statuses` - (Optional) List of statuses on which to filter the returned list. Valid values are `PENDING_VALIDATION`, `ISSUED`, @@ -66,4 +67,4 @@ This data source exports the following attributes in addition to the arguments a * `certificate_chain` - Certificates forming the requested ACM-issued certificate's chain of trust. The chain consists of the certificate of the issuing CA and the intermediate certificates of any other subordinate CAs. * `tags` - Mapping of tags for the resource. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/acmpca_certificate.html.markdown b/website/docs/cdktf/python/d/acmpca_certificate.html.markdown index 69f186493741..28c58ce9d609 100644 --- a/website/docs/cdktf/python/d/acmpca_certificate.html.markdown +++ b/website/docs/cdktf/python/d/acmpca_certificate.html.markdown @@ -36,6 +36,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `arn` - (Required) ARN of the certificate issued by the private certificate authority. * `certificate_authority_arn` - (Required) ARN of the certificate authority. @@ -46,4 +47,4 @@ This data source exports the following attributes in addition to the arguments a * `certificate` - PEM-encoded certificate value. * `certificate_chain` - PEM-encoded certificate chain that includes any intermediate certificates and chains up to root CA. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/acmpca_certificate_authority.html.markdown b/website/docs/cdktf/python/d/acmpca_certificate_authority.html.markdown index 90c4e80173cf..52ce1566c0d3 100644 --- a/website/docs/cdktf/python/d/acmpca_certificate_authority.html.markdown +++ b/website/docs/cdktf/python/d/acmpca_certificate_authority.html.markdown @@ -35,6 +35,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `arn` - (Required) ARN of the certificate authority. ## Attribute Reference @@ -62,4 +63,4 @@ This data source exports the following attributes in addition to the arguments a * `tags` - Key-value map of user-defined tags that are attached to the certificate authority. * `type` - Type of the certificate authority. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/ami.html.markdown b/website/docs/cdktf/python/d/ami.html.markdown index d49748ec9386..3105d186b747 100644 --- a/website/docs/cdktf/python/d/ami.html.markdown +++ b/website/docs/cdktf/python/d/ami.html.markdown @@ -50,6 +50,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `owners` - (Optional) List of AMI owners to limit search. Valid values: an AWS account ID, `self` (the current account), or an AWS owner alias (e.g., `amazon`, `aws-marketplace`, `microsoft`). * `most_recent` - (Optional) If more than one result is returned, use the most recent AMI. @@ -59,6 +60,10 @@ recent AMI. * `filter` - (Optional) One or more name/value pairs to filter off of. There are several valid keys, for a full reference, check out [describe-images in the AWS CLI reference][1]. +* `allow_unsafe_filter` - (Optional) If true, allow unsafe filter values. With unsafe +filters and `most_recent` set to `true`, a third party may introduce a new image which +will be returned by this data source. Consider filtering by owner or image ID rather +than setting this argument. * `name_regex` - (Optional) Regex string to apply to the AMI list returned by AWS. This allows more advanced filtering not supported from the AWS API. This filtering is done locally on what AWS returns, and could have a performance @@ -146,4 +151,4 @@ interpolation. [1]: http://docs.aws.amazon.com/cli/latest/reference/ec2/describe-images.html - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/ami_ids.html.markdown b/website/docs/cdktf/python/d/ami_ids.html.markdown index 3cdf905490ad..1153b8a7b4db 100644 --- a/website/docs/cdktf/python/d/ami_ids.html.markdown +++ b/website/docs/cdktf/python/d/ami_ids.html.markdown @@ -40,6 +40,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `owners` - (Required) List of AMI owners to limit search. At least 1 value must be specified. Valid values: an AWS account ID, `self` (the current account), or an AWS owner alias (e.g., `amazon`, `aws-marketplace`, `microsoft`). * `executable_users` - (Optional) Limit search to users with *explicit* launch permission on the image. Valid items are the numeric account ID or `self`. @@ -70,4 +71,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/api_gateway_api_key.html.markdown b/website/docs/cdktf/python/d/api_gateway_api_key.html.markdown index 1ec46d6e7993..4595cf61d7ab 100644 --- a/website/docs/cdktf/python/d/api_gateway_api_key.html.markdown +++ b/website/docs/cdktf/python/d/api_gateway_api_key.html.markdown @@ -36,6 +36,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `id` - (Required) ID of the API Key to look up. ## Attribute Reference @@ -52,4 +53,4 @@ This data source exports the following attributes in addition to the arguments a * `enabled` - Whether the API Key is enabled. * `tags` - Map of tags for the resource. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/api_gateway_api_keys.html.markdown b/website/docs/cdktf/python/d/api_gateway_api_keys.html.markdown index d4cca4112f5a..0b216a2bebd3 100644 --- a/website/docs/cdktf/python/d/api_gateway_api_keys.html.markdown +++ b/website/docs/cdktf/python/d/api_gateway_api_keys.html.markdown @@ -33,6 +33,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `customer_id` - (Optional) Amazon Web Services Marketplace customer identifier, when integrating with the Amazon Web Services SaaS Marketplace. * `include_values` - (Optional) Set this value to `true` if you wish the result contains the key value. Defaults to `false`. @@ -55,4 +56,4 @@ This data source exports the following attributes in addition to the arguments a * `enabled` - Whether the API Key is enabled. * `tags` - Map of tags for the resource. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/api_gateway_authorizer.html.markdown b/website/docs/cdktf/python/d/api_gateway_authorizer.html.markdown index 9533c9036ce6..a89c56f30822 100644 --- a/website/docs/cdktf/python/d/api_gateway_authorizer.html.markdown +++ b/website/docs/cdktf/python/d/api_gateway_authorizer.html.markdown @@ -37,6 +37,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `authorizer_id` - (Required) Authorizer identifier. * `rest_api_id` - (Required) ID of the associated REST API. @@ -54,4 +55,4 @@ This data source exports the following attributes in addition to the arguments a * `provider_arns` - List of the Amazon Cognito user pool ARNs. * `type` - Type of the authorizer. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/api_gateway_authorizers.html.markdown b/website/docs/cdktf/python/d/api_gateway_authorizers.html.markdown index fe40d4bbe9ec..2a99cb2ccf2c 100644 --- a/website/docs/cdktf/python/d/api_gateway_authorizers.html.markdown +++ b/website/docs/cdktf/python/d/api_gateway_authorizers.html.markdown @@ -35,6 +35,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `rest_api_id` - (Required) ID of the associated REST API. ## Attribute Reference @@ -43,4 +44,4 @@ This data source exports the following attributes in addition to the arguments a * `ids` - List of Authorizer identifiers. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/api_gateway_domain_name.html.markdown b/website/docs/cdktf/python/d/api_gateway_domain_name.html.markdown index 462169536045..7270023a18ba 100644 --- a/website/docs/cdktf/python/d/api_gateway_domain_name.html.markdown +++ b/website/docs/cdktf/python/d/api_gateway_domain_name.html.markdown @@ -35,6 +35,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `domain_name` - (Required) Fully-qualified domain name to look up. If no domain name is found, an error will be returned. * `domain_name_id` - (Optional) The identifier for the domain name resource. Supported only for private custom domain names. @@ -59,4 +60,4 @@ This data source exports the following attributes in addition to the arguments a * `security_policy` - Security policy for the domain name. * `tags` - Key-value map of tags for the resource. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/api_gateway_export.html.markdown b/website/docs/cdktf/python/d/api_gateway_export.html.markdown index 57bdda1f2a87..000cf9af3577 100644 --- a/website/docs/cdktf/python/d/api_gateway_export.html.markdown +++ b/website/docs/cdktf/python/d/api_gateway_export.html.markdown @@ -35,6 +35,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `export_type` - (Required) Type of export. Acceptable values are `oas30` for OpenAPI 3.0.x and `swagger` for Swagger/OpenAPI 2.0. * `rest_api_id` - (Required) Identifier of the associated REST API. * `stage_name` - (Required) Name of the Stage that will be exported. @@ -50,4 +51,4 @@ This data source exports the following attributes in addition to the arguments a * `content_type` - Content-type header value in the HTTP response. * `content_disposition` - Content-disposition header value in the HTTP response. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/api_gateway_resource.html.markdown b/website/docs/cdktf/python/d/api_gateway_resource.html.markdown index d5745edec126..dabd42012a32 100644 --- a/website/docs/cdktf/python/d/api_gateway_resource.html.markdown +++ b/website/docs/cdktf/python/d/api_gateway_resource.html.markdown @@ -41,6 +41,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `rest_api_id` - (Required) REST API id that owns the resource. If no REST API is found, an error will be returned. * `path` - (Required) Full path of the resource. If no path is found, an error will be returned. @@ -52,4 +53,4 @@ This data source exports the following attributes in addition to the arguments a * `parent_id` - Set to the ID of the parent Resource. * `path_part` - Set to the path relative to the parent Resource. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/api_gateway_rest_api.html.markdown b/website/docs/cdktf/python/d/api_gateway_rest_api.html.markdown index 32867fe87df0..bfc51f13e5b7 100644 --- a/website/docs/cdktf/python/d/api_gateway_rest_api.html.markdown +++ b/website/docs/cdktf/python/d/api_gateway_rest_api.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `name` - (Required) Name of the REST API to look up. If no REST API is found with this name, an error will be returned. If multiple REST APIs are found with this name, an error will be returned. ## Attribute Reference @@ -59,4 +60,4 @@ This data source exports the following attributes in addition to the arguments a * `root_resource_id` - Set to the ID of the API Gateway Resource on the found REST API where the route matches '/'. * `tags` - Key-value map of resource tags. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/api_gateway_sdk.html.markdown b/website/docs/cdktf/python/d/api_gateway_sdk.html.markdown index 6b481e133338..6cf8522f2946 100644 --- a/website/docs/cdktf/python/d/api_gateway_sdk.html.markdown +++ b/website/docs/cdktf/python/d/api_gateway_sdk.html.markdown @@ -41,6 +41,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `rest_api_id` - (Required) Identifier of the associated REST API. * `stage_name` - (Required) Name of the Stage that will be exported. * `sdk_type` - (Required) Language for the generated SDK. Currently `java`, `javascript`, `android`, `objectivec` (for iOS), `swift` (for iOS), and `ruby` are supported. @@ -55,4 +56,4 @@ This data source exports the following attributes in addition to the arguments a * `content_type` - Content-type header value in the HTTP response. * `content_disposition` - Content-disposition header value in the HTTP response. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/api_gateway_vpc_link.html.markdown b/website/docs/cdktf/python/d/api_gateway_vpc_link.html.markdown index 91cd9156813d..ef64927717fd 100644 --- a/website/docs/cdktf/python/d/api_gateway_vpc_link.html.markdown +++ b/website/docs/cdktf/python/d/api_gateway_vpc_link.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `name` - (Required) Name of the API Gateway VPC Link to look up. If no API Gateway VPC Link is found with this name, an error will be returned. If multiple API Gateway VPC Links are found with this name, an error will be returned. @@ -52,4 +53,4 @@ This data source exports the following attributes in addition to the arguments a * `target_arns` - List of network load balancer arns in the VPC targeted by the VPC link. Currently AWS only supports 1 target. * `tags` - Key-value map of resource tags - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/apigatewayv2_api.html.markdown b/website/docs/cdktf/python/d/apigatewayv2_api.html.markdown index 4fec2be37fc9..0a5da12720f3 100644 --- a/website/docs/cdktf/python/d/apigatewayv2_api.html.markdown +++ b/website/docs/cdktf/python/d/apigatewayv2_api.html.markdown @@ -35,6 +35,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `api_id` - (Required) API identifier. ## Attribute Reference @@ -67,4 +68,4 @@ The `cors_configuration` object supports the following: * `expose_headers` - Set of exposed HTTP headers. * `max_age` - Number of seconds that the browser should cache preflight request results. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/apigatewayv2_apis.html.markdown b/website/docs/cdktf/python/d/apigatewayv2_apis.html.markdown index 6ffa2696d63a..ab49c87638d0 100644 --- a/website/docs/cdktf/python/d/apigatewayv2_apis.html.markdown +++ b/website/docs/cdktf/python/d/apigatewayv2_apis.html.markdown @@ -35,6 +35,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `name` - (Optional) API name. * `protocol_type` - (Optional) API protocol. * `tags` - (Optional) Map of tags, each pair of which must exactly match @@ -46,4 +47,4 @@ This data source exports the following attributes in addition to the arguments a * `ids` - Set of API identifiers. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/apigatewayv2_export.html.markdown b/website/docs/cdktf/python/d/apigatewayv2_export.html.markdown index eb4709cc818b..0c25ff0dc8ef 100644 --- a/website/docs/cdktf/python/d/apigatewayv2_export.html.markdown +++ b/website/docs/cdktf/python/d/apigatewayv2_export.html.markdown @@ -37,6 +37,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `api_id` - (Required) API identifier. * `specification` - (Required) Version of the API specification to use. `OAS30`, for OpenAPI 3.0, is the only supported value. * `output_type` - (Required) Output type of the exported definition file. Valid values are `JSON` and `YAML`. @@ -51,4 +52,4 @@ This data source exports the following attributes in addition to the arguments a * `id` - API identifier. * `body` - ID of the API. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/apigatewayv2_vpc_link.html.markdown b/website/docs/cdktf/python/d/apigatewayv2_vpc_link.html.markdown index a101b129378e..80609c057922 100644 --- a/website/docs/cdktf/python/d/apigatewayv2_vpc_link.html.markdown +++ b/website/docs/cdktf/python/d/apigatewayv2_vpc_link.html.markdown @@ -35,8 +35,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `vpc_link_id` - (Required) VPC Link ID ## Attribute Reference @@ -50,4 +51,4 @@ This data source exports the following attributes in addition to the arguments a * `subnet_ids` - List of subnets attached to the VPC Link. * `tags` - VPC Link Tags. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/appconfig_configuration_profile.html.markdown b/website/docs/cdktf/python/d/appconfig_configuration_profile.html.markdown index 5cf70fdd6dca..4e74020caa67 100644 --- a/website/docs/cdktf/python/d/appconfig_configuration_profile.html.markdown +++ b/website/docs/cdktf/python/d/appconfig_configuration_profile.html.markdown @@ -36,8 +36,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `application_id` - (Required) ID of the AppConfig application to which this configuration profile belongs. * `configuration_profile_id` - (Required) ID of the Configuration Profile. @@ -56,4 +57,4 @@ This data source exports the following attributes in addition to the arguments a * `content` - Either the JSON Schema content or the ARN of an AWS Lambda function. * `type` - Type of validator. Valid values: JSON_SCHEMA and LAMBDA. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/appconfig_configuration_profiles.html.markdown b/website/docs/cdktf/python/d/appconfig_configuration_profiles.html.markdown index 30fbdc41107a..29d0fc755814 100644 --- a/website/docs/cdktf/python/d/appconfig_configuration_profiles.html.markdown +++ b/website/docs/cdktf/python/d/appconfig_configuration_profiles.html.markdown @@ -51,8 +51,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `application_id` - (Required) ID of the AppConfig Application. ## Attribute Reference @@ -61,4 +62,4 @@ This data source exports the following attributes in addition to the arguments a * `configuration_profile_ids` - Set of Configuration Profile IDs associated with the AppConfig Application. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/appconfig_environment.html.markdown b/website/docs/cdktf/python/d/appconfig_environment.html.markdown index 62eaa46a3d84..a766e5cd264b 100644 --- a/website/docs/cdktf/python/d/appconfig_environment.html.markdown +++ b/website/docs/cdktf/python/d/appconfig_environment.html.markdown @@ -36,8 +36,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `application_id` - (Required) ID of the AppConfig Application to which this Environment belongs. * `environment_id` - (Required) ID of the AppConfig Environment. @@ -55,4 +56,4 @@ This data source exports the following attributes in addition to the arguments a or `ROLLED_BACK`. * `tags` - Map of tags for the resource. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/appconfig_environments.html.markdown b/website/docs/cdktf/python/d/appconfig_environments.html.markdown index 152b434181f5..9490f3f19578 100644 --- a/website/docs/cdktf/python/d/appconfig_environments.html.markdown +++ b/website/docs/cdktf/python/d/appconfig_environments.html.markdown @@ -36,8 +36,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `application_id` - (Required) ID of the AppConfig Application. ## Attribute Reference @@ -46,4 +47,4 @@ This data source exports the following attributes in addition to the arguments a * `environment_ids` - Set of Environment IDs associated with this AppConfig Application. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/appintegrations_event_integration.html.markdown b/website/docs/cdktf/python/d/appintegrations_event_integration.html.markdown index de794bb54bc4..dee67f94d5ef 100644 --- a/website/docs/cdktf/python/d/appintegrations_event_integration.html.markdown +++ b/website/docs/cdktf/python/d/appintegrations_event_integration.html.markdown @@ -35,6 +35,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `name` - (Required) The AppIntegrations Event Integration name. ## Attribute Reference @@ -54,4 +55,4 @@ This data source exports the following attributes in addition to the arguments a * `source` - The source of the events. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/appmesh_gateway_route.html.markdown b/website/docs/cdktf/python/d/appmesh_gateway_route.html.markdown index c139ab4c6185..a3259f523f7c 100644 --- a/website/docs/cdktf/python/d/appmesh_gateway_route.html.markdown +++ b/website/docs/cdktf/python/d/appmesh_gateway_route.html.markdown @@ -37,6 +37,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `name` - (Required) Name of the gateway route. * `mesh_name` - (Required) Name of the service mesh in which the virtual gateway exists. * `virtual_gateway_name` - (Required) Name of the virtual gateway in which the route exists. @@ -53,4 +54,4 @@ This data source exports the following attributes in addition to the arguments a * `spec` - Gateway route specification. See the [`aws_appmesh_gateway_route`](/docs/providers/aws/r/appmesh_gateway_route.html#spec) resource for details. * `tags` - Map of tags. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/appmesh_mesh.html.markdown b/website/docs/cdktf/python/d/appmesh_mesh.html.markdown index 8e352d30ac90..33c96b56a431 100644 --- a/website/docs/cdktf/python/d/appmesh_mesh.html.markdown +++ b/website/docs/cdktf/python/d/appmesh_mesh.html.markdown @@ -55,6 +55,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `name` - (Required) Name of the service mesh. * `mesh_owner` - (Optional) AWS account ID of the service mesh's owner. @@ -69,4 +70,4 @@ This data source exports the following attributes in addition to the arguments a * `spec` - Service mesh specification. See the [`aws_appmesh_mesh`](/docs/providers/aws/r/appmesh_mesh.html#spec) resource for details. * `tags` - Map of tags. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/appmesh_route.html.markdown b/website/docs/cdktf/python/d/appmesh_route.html.markdown index b0452ff35a1a..b5a112a7f846 100644 --- a/website/docs/cdktf/python/d/appmesh_route.html.markdown +++ b/website/docs/cdktf/python/d/appmesh_route.html.markdown @@ -37,6 +37,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `name` - (Required) Name of the route. * `mesh_name` - (Required) Name of the service mesh in which the virtual router exists. * `virtual_router_name` - (Required) Name of the virtual router in which the route exists. @@ -53,4 +54,4 @@ This data source exports the following attributes in addition to the arguments a * `spec` - Route specification. See the [`aws_appmesh_route`](/docs/providers/aws/r/appmesh_route.html#spec) resource for details. * `tags` - Map of tags. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/appmesh_virtual_gateway.html.markdown b/website/docs/cdktf/python/d/appmesh_virtual_gateway.html.markdown index 6b44d2fcb718..1c8055b2b01a 100644 --- a/website/docs/cdktf/python/d/appmesh_virtual_gateway.html.markdown +++ b/website/docs/cdktf/python/d/appmesh_virtual_gateway.html.markdown @@ -59,6 +59,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `name` - (Required) Name of the virtual gateway. * `mesh_name` - (Required) Name of the service mesh in which the virtual gateway exists. * `mesh_owner` - (Optional) AWS account ID of the service mesh's owner. @@ -74,4 +75,4 @@ This data source exports the following attributes in addition to the arguments a * `spec` - Virtual gateway specification. See the [`aws_appmesh_virtual_gateway`](/docs/providers/aws/r/appmesh_virtual_gateway.html#spec) resource for details. * `tags` - Map of tags. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/appmesh_virtual_node.html.markdown b/website/docs/cdktf/python/d/appmesh_virtual_node.html.markdown index 3177f5d002a8..6af4be539112 100644 --- a/website/docs/cdktf/python/d/appmesh_virtual_node.html.markdown +++ b/website/docs/cdktf/python/d/appmesh_virtual_node.html.markdown @@ -36,6 +36,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `name` - (Required) Name of the virtual node. * `mesh_name` - (Required) Name of the service mesh in which the virtual node exists. * `mesh_owner` - (Optional) AWS account ID of the service mesh's owner. @@ -51,4 +52,4 @@ This data source exports the following attributes in addition to the arguments a * `spec` - Virtual node specification. See the [`aws_appmesh_virtual_node`](/docs/providers/aws/r/appmesh_virtual_node.html#spec) resource for details. * `tags` - Map of tags. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/appmesh_virtual_router.html.markdown b/website/docs/cdktf/python/d/appmesh_virtual_router.html.markdown index 0223585bddfa..7e9b2dbc6dc3 100644 --- a/website/docs/cdktf/python/d/appmesh_virtual_router.html.markdown +++ b/website/docs/cdktf/python/d/appmesh_virtual_router.html.markdown @@ -36,6 +36,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `name` - (Required) Name of the virtual router. * `mesh_name` - (Required) Name of the mesh in which the virtual router exists @@ -50,4 +51,4 @@ This data source exports the following attributes in addition to the arguments a * `spec` - Virtual routers specification. See the [`aws_appmesh_virtual_router`](/docs/providers/aws/r/appmesh_virtual_router.html#spec) resource for details. * `tags` - Map of tags. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/appmesh_virtual_service.html.markdown b/website/docs/cdktf/python/d/appmesh_virtual_service.html.markdown index 1ed72698a796..7639e496aa75 100644 --- a/website/docs/cdktf/python/d/appmesh_virtual_service.html.markdown +++ b/website/docs/cdktf/python/d/appmesh_virtual_service.html.markdown @@ -57,6 +57,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `name` - (Required) Name of the virtual service. * `mesh_name` - (Required) Name of the service mesh in which the virtual service exists. * `mesh_owner` - (Optional) AWS account ID of the service mesh's owner. @@ -72,4 +73,4 @@ This data source exports the following attributes in addition to the arguments a * `spec` - Virtual service specification. See the [`aws_appmesh_virtual_service`](/docs/providers/aws/r/appmesh_virtual_service.html#spec) resource for details. * `tags` - Map of tags. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/apprunner_hosted_zone_id.html.markdown b/website/docs/cdktf/python/d/apprunner_hosted_zone_id.html.markdown index 76c1881bd852..eb4022e7f2a1 100644 --- a/website/docs/cdktf/python/d/apprunner_hosted_zone_id.html.markdown +++ b/website/docs/cdktf/python/d/apprunner_hosted_zone_id.html.markdown @@ -45,13 +45,12 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: -* `region` - (Optional) Name of the region whose AWS App Runner service HostedZoneId is desired. - Defaults to the region from the AWS provider configuration. +* `region` - (Optional) Name of the Region whose AWS App Runner service HostedZoneId is desired. Defaults to the Region set in the [provider configuration](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#aws-configuration-reference). ## Attribute Reference This data source exports the following attributes in addition to the arguments above: -* `id` - ID of the AWS App Runner service HostedZoneId in the selected region. +* `id` - ID of the AWS App Runner service HostedZoneId in the selected Region. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/appstream_image.html.markdown b/website/docs/cdktf/python/d/appstream_image.html.markdown index 0f3471dcca6d..86a798c37d8c 100644 --- a/website/docs/cdktf/python/d/appstream_image.html.markdown +++ b/website/docs/cdktf/python/d/appstream_image.html.markdown @@ -37,6 +37,7 @@ class MyConvertedCode(TerraformStack): The following arguments are optional: +* `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). * `name` - Name of the image being searched for. Cannot be used with name_regex or arn. * `name_regex` - Regular expression name of the image being searched for. Cannot be used with arn or name. * `arn` - Arn of the image being searched for. Cannot be used with name_regex or name. @@ -85,4 +86,4 @@ This data source exports the following attributes in addition to the arguments a * `state` - Current state of image. Image starts in PENDING state which changes to AVAILABLE if creation passes and FAILED if it fails. Values will be from: PENDING | AVAILABLE | FAILED | COPYING | DELETING | CREATING | IMPORTING. * `visibility` - Visibility type enum indicating whether the image is PUBLIC, PRIVATE, or SHARED. Valid values include: PUBLIC | PRIVATE | SHARED. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/arn.html.markdown b/website/docs/cdktf/python/d/arn.html.markdown index de267f836b83..921ec6f0f1c1 100644 --- a/website/docs/cdktf/python/d/arn.html.markdown +++ b/website/docs/cdktf/python/d/arn.html.markdown @@ -42,15 +42,11 @@ This data source supports the following arguments: This data source exports the following attributes in addition to the arguments above: * `partition` - Partition that the resource is in. - * `service` - The [service namespace](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces) that identifies the AWS product. - * `region` - Region the resource resides in. -Note that the ARNs for some resources do not require a region, so this component might be omitted. - +Note that the ARNs for some resources do not include a Region, so this component might be omitted. * `account` - The [ID](https://docs.aws.amazon.com/general/latest/gr/acct-identifiers.html) of the AWS account that owns the resource, without the hyphens. - * `resource` - Content of this part of the ARN varies by service. It often includes an indicator of the type of resource—for example, an IAM user or Amazon RDS database —followed by a slash (/) or a colon (:), followed by the resource name itself. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/athena_named_query.html.markdown b/website/docs/cdktf/python/d/athena_named_query.html.markdown index c5e634651b45..ab074b0a1f91 100644 --- a/website/docs/cdktf/python/d/athena_named_query.html.markdown +++ b/website/docs/cdktf/python/d/athena_named_query.html.markdown @@ -35,6 +35,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `name` - (Required) The plain language name for the query. Maximum length of 128. * `workgroup` - (Optional) The workgroup to which the query belongs. Defaults to `primary`. @@ -47,4 +48,4 @@ This data source exports the following attributes in addition to the arguments a * `id` - The unique ID of the query. * `query` - Text of the query itself. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/auditmanager_control.html.markdown b/website/docs/cdktf/python/d/auditmanager_control.html.markdown index b8c65e837ace..0ed7a0cff834 100644 --- a/website/docs/cdktf/python/d/auditmanager_control.html.markdown +++ b/website/docs/cdktf/python/d/auditmanager_control.html.markdown @@ -82,6 +82,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `name` - (Required) Name of the control. * `type` - (Required) Type of control. Valid values are `Custom` and `Standard`. @@ -91,4 +92,4 @@ This data source exports the following attributes in addition to the arguments a See the [`aws_auditmanager_control` resource](/docs/providers/aws/r/auditmanager_control.html) for details on the returned attributes - they are identical. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/auditmanager_framework.html.markdown b/website/docs/cdktf/python/d/auditmanager_framework.html.markdown index 1cb240f14f0e..4aeb002f4e03 100644 --- a/website/docs/cdktf/python/d/auditmanager_framework.html.markdown +++ b/website/docs/cdktf/python/d/auditmanager_framework.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `name` - (Required) Name of the framework. * `type` - (Required) Type of framework. Valid values are `Custom` and `Standard`. @@ -47,4 +48,4 @@ This data source exports the following attributes in addition to the arguments a See the [`aws_auditmanager_framework` resource](/docs/providers/aws/r/auditmanager_framework.html) for details on the returned attributes - they are identical. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/autoscaling_group.html.markdown b/website/docs/cdktf/python/d/autoscaling_group.html.markdown index 019116b19f84..ef3ceceb5edf 100644 --- a/website/docs/cdktf/python/d/autoscaling_group.html.markdown +++ b/website/docs/cdktf/python/d/autoscaling_group.html.markdown @@ -35,6 +35,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `name` - Specify the exact name of the desired autoscaling group. ## Attribute Reference @@ -149,4 +150,4 @@ This data source exports the following attributes in addition to the arguments a ~> **NOTE:** Some values are not always set and may not be available for interpolation. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/autoscaling_groups.html.markdown b/website/docs/cdktf/python/d/autoscaling_groups.html.markdown index fbfaae0dd0ea..1cb28fb1b968 100644 --- a/website/docs/cdktf/python/d/autoscaling_groups.html.markdown +++ b/website/docs/cdktf/python/d/autoscaling_groups.html.markdown @@ -50,6 +50,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `names` - (Optional) List of autoscaling group names * `filter` - (Optional) Filter used to scope the list e.g., by tags. See [related docs](http://docs.aws.amazon.com/AutoScaling/latest/APIReference/API_Filter.html). * `name` - (Required) Name of the DescribeAutoScalingGroup filter. The recommended values are: `tag-key`, `tag-value`, and `tag:` @@ -63,4 +64,4 @@ This data source exports the following attributes in addition to the arguments a * `id` - AWS Region. * `names` - List of the Autoscaling Groups in the current region. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/availability_zone.html.markdown b/website/docs/cdktf/python/d/availability_zone.html.markdown index 08c475080149..40d3ac6256d8 100644 --- a/website/docs/cdktf/python/d/availability_zone.html.markdown +++ b/website/docs/cdktf/python/d/availability_zone.html.markdown @@ -11,10 +11,10 @@ description: |- # Data Source: aws_availability_zone `aws_availability_zone` provides details about a specific availability zone (AZ) -in the current region. +in the current Region. This can be used both to validate an availability zone given in a variable -and to split the AZ name into its component parts of an AWS region and an +and to split the AZ name into its component parts of an AWS Region and an AZ identifier letter. The latter may be useful e.g., for implementing a consistent subnet numbering scheme across several regions by mapping both the region and the subnet letter to network numbers. @@ -89,6 +89,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `all_availability_zones` - (Optional) Set to `true` to include all Availability Zones and Local Zones regardless of your opt in status. * `filter` - (Optional) Configuration block(s) for filtering. Detailed below. * `name` - (Optional) Full name of the availability zone to select. @@ -110,7 +111,8 @@ The `filter` configuration block supports the following arguments: This data source exports the following attributes in addition to the arguments above: -* `group_name` - For Availability Zones, this is the same value as the Region name. For Local Zones, the name of the associated group, for example `us-west-2-lax-1`. +* `group_long_name` - The long name of the Availability Zone group, Local Zone group, or Wavelength Zone group. +* `group_name` - The name of the zone group. For example: `us-east-1-zg-1`, `us-west-2-lax-1`, or `us-east-1-wl1-bos-wlz-1`. * `name_suffix` - Part of the AZ name that appears after the region name, uniquely identifying the AZ within its region. For Availability Zones this is usually a single letter, for example `a` for the `us-west-2a` zone. For Local and Wavelength Zones this is a longer string, for example `wl1-sfo-wlz-1` for the `us-west-2-wl1-sfo-wlz-1` zone. @@ -118,7 +120,6 @@ For Local and Wavelength Zones this is a longer string, for example `wl1-sfo-wlz * `opt_in_status` - For Availability Zones, this always has the value of `opt-in-not-required`. For Local Zones, this is the opt in status. The possible values are `opted-in` and `not-opted-in`. * `parent_zone_id` - ID of the zone that handles some of the Local Zone or Wavelength Zone control plane operations, such as API calls. * `parent_zone_name` - Name of the zone that handles some of the Local Zone or Wavelength Zone control plane operations, such as API calls. -* `region` - Region where the selected availability zone resides. This is always the region selected on the provider, since this data source searches only within that region. * `zone_type` - Type of zone. Values are `availability-zone`, `local-zone`, and `wavelength-zone`. ## Timeouts @@ -127,4 +128,4 @@ For Local and Wavelength Zones this is a longer string, for example `wl1-sfo-wlz - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/availability_zones.html.markdown b/website/docs/cdktf/python/d/availability_zones.html.markdown index 3f2a04d100b8..2fefe275d7db 100644 --- a/website/docs/cdktf/python/d/availability_zones.html.markdown +++ b/website/docs/cdktf/python/d/availability_zones.html.markdown @@ -102,6 +102,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `all_availability_zones` - (Optional) Set to `true` to include all Availability Zones and Local Zones regardless of your opt in status. * `filter` - (Optional) Configuration block(s) for filtering. Detailed below. * `exclude_names` - (Optional) List of Availability Zone names to exclude. @@ -135,4 +136,4 @@ Note that the indexes of Availability Zone names and IDs correspond. - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/backup_framework.html.markdown b/website/docs/cdktf/python/d/backup_framework.html.markdown index 6d0f6da4b82c..1e46f6a316f0 100644 --- a/website/docs/cdktf/python/d/backup_framework.html.markdown +++ b/website/docs/cdktf/python/d/backup_framework.html.markdown @@ -35,6 +35,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `name` - (Required) Backup framework name. ## Attribute Reference @@ -73,4 +74,4 @@ This data source exports the following attributes in addition to the arguments a * `compliance_resource_types` - Describes whether the control scope includes one or more types of resources, such as EFS or RDS. * `tags` - Tag key-value pair applied to those AWS resources that you want to trigger an evaluation for a rule. A maximum of one key-value pair can be provided. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/backup_plan.html.markdown b/website/docs/cdktf/python/d/backup_plan.html.markdown index c8ba0f45f644..963262a3089f 100644 --- a/website/docs/cdktf/python/d/backup_plan.html.markdown +++ b/website/docs/cdktf/python/d/backup_plan.html.markdown @@ -35,6 +35,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `plan_id` - (Required) Backup plan ID. ## Attribute Reference @@ -47,4 +48,4 @@ This data source exports the following attributes in addition to the arguments a * `tags` - Metadata that you can assign to help organize the plans you create. * `version` - Unique, randomly generated, Unicode, UTF-8 encoded string that serves as the version ID of the backup plan. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/backup_report_plan.html.markdown b/website/docs/cdktf/python/d/backup_report_plan.html.markdown index f94ad8d0fafe..634c0da0724a 100644 --- a/website/docs/cdktf/python/d/backup_report_plan.html.markdown +++ b/website/docs/cdktf/python/d/backup_report_plan.html.markdown @@ -35,6 +35,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `name` - (Required) Backup report plan name. ## Attribute Reference @@ -69,4 +70,4 @@ This data source exports the following attributes in addition to the arguments a * `regions` - (Optional) Specifies the list of regions a report covers. * `report_template` - Identifies the report template for the report. Reports are built using a report template. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/backup_selection.html.markdown b/website/docs/cdktf/python/d/backup_selection.html.markdown index e8dc29df77ba..e8398e1d0ffd 100644 --- a/website/docs/cdktf/python/d/backup_selection.html.markdown +++ b/website/docs/cdktf/python/d/backup_selection.html.markdown @@ -36,6 +36,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `plan_id` - (Required) Backup plan ID associated with the selection of resources. * `selection_id` - (Required) Backup selection ID. @@ -47,4 +48,4 @@ This data source exports the following attributes in addition to the arguments a * `iam_role_arn` - ARN of the IAM role that AWS Backup uses to authenticate when restoring and backing up the target resource. See the [AWS Backup Developer Guide](https://docs.aws.amazon.com/aws-backup/latest/devguide/access-control.html#managed-policies) for additional information about using AWS managed policies or creating custom policies attached to the IAM role. * `resources` - An array of strings that either contain Amazon Resource Names (ARNs) or match patterns of resources to assign to a backup plan.. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/backup_vault.html.markdown b/website/docs/cdktf/python/d/backup_vault.html.markdown index 391b779cde1d..632a621e68a6 100644 --- a/website/docs/cdktf/python/d/backup_vault.html.markdown +++ b/website/docs/cdktf/python/d/backup_vault.html.markdown @@ -35,6 +35,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `name` - (Required) Name of the backup vault. ## Attribute Reference @@ -46,4 +47,4 @@ This data source exports the following attributes in addition to the arguments a * `recovery_points` - Number of recovery points that are stored in a backup vault. * `tags` - Metadata that you can assign to help organize the resources that you create. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/batch_compute_environment.html.markdown b/website/docs/cdktf/python/d/batch_compute_environment.html.markdown index b29fc6e59a30..10c3b7992117 100644 --- a/website/docs/cdktf/python/d/batch_compute_environment.html.markdown +++ b/website/docs/cdktf/python/d/batch_compute_environment.html.markdown @@ -36,6 +36,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `name` - (Required) Name of the Batch Compute Environment ## Attribute Reference @@ -52,4 +53,4 @@ This data source exports the following attributes in addition to the arguments a * `update_policy` - Specifies the infrastructure update policy for the compute environment. * `tags` - Key-value map of resource tags - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/batch_job_definition.html.markdown b/website/docs/cdktf/python/d/batch_job_definition.html.markdown index 29baa92d89a4..9ca6f2ae7298 100644 --- a/website/docs/cdktf/python/d/batch_job_definition.html.markdown +++ b/website/docs/cdktf/python/d/batch_job_definition.html.markdown @@ -57,6 +57,7 @@ class MyConvertedCode(TerraformStack): The following arguments are optional: +* `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). * `arn` - ARN of the Job Definition. Do not begin the description with "An", "The", "Defines", "Indicates", or "Specifies," as these are verbose. In other words, "Indicates the amount of storage," can be rewritten as "Amount of storage," without losing any information. * `revision` - The revision of the job definition. * `name` - The name of the job definition to register. It can be up to 128 letters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_). @@ -299,4 +300,4 @@ This data source exports the following attributes in addition to the arguments a * `attempt_duration_seconds` - The job timeout time (in seconds) that's measured from the job attempt's startedAt timestamp. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/batch_job_queue.html.markdown b/website/docs/cdktf/python/d/batch_job_queue.html.markdown index 046bd6a12a10..11738df69f56 100644 --- a/website/docs/cdktf/python/d/batch_job_queue.html.markdown +++ b/website/docs/cdktf/python/d/batch_job_queue.html.markdown @@ -36,6 +36,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `name` - (Required) Name of the job queue. ## Attribute Reference @@ -61,4 +62,4 @@ This data source exports the following attributes in addition to the arguments a * `job_state_time_limit_action.#.reason` - The reason to log for the action being taken. * `job_state_time_limit_action.#.state` - The state of the job needed to trigger the action. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/batch_scheduling_policy.html.markdown b/website/docs/cdktf/python/d/batch_scheduling_policy.html.markdown index c1d02ec8b0ca..30df78d5dc1a 100644 --- a/website/docs/cdktf/python/d/batch_scheduling_policy.html.markdown +++ b/website/docs/cdktf/python/d/batch_scheduling_policy.html.markdown @@ -35,6 +35,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `arn` - (Required) ARN of the scheduling policy. ## Attribute Reference @@ -56,4 +57,4 @@ A `share_distribution` block supports the following arguments: * `share_identifier` - Fair share identifier or fair share identifier prefix. For more information, see [ShareAttributes](https://docs.aws.amazon.com/batch/latest/APIReference/API_ShareAttributes.html). * `weight_factor` - Weight factor for the fair share identifier. For more information, see [ShareAttributes](https://docs.aws.amazon.com/batch/latest/APIReference/API_ShareAttributes.html). - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/bedrock_custom_model.html.markdown b/website/docs/cdktf/python/d/bedrock_custom_model.html.markdown index c5bbfaa3db2c..e412eea68fe2 100644 --- a/website/docs/cdktf/python/d/bedrock_custom_model.html.markdown +++ b/website/docs/cdktf/python/d/bedrock_custom_model.html.markdown @@ -35,7 +35,8 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: -* `model_id` – (Required) Name or ARN of the custom model. +* `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). +* `model_id` - (Required) Name or ARN of the custom model. ## Attribute Reference @@ -62,5 +63,5 @@ This data source exports the following attributes in addition to the arguments a * `s3_uri` - The S3 URI where the validation data is stored.. * `validation_metrics` - The loss metric for each validator that you provided. * `validation_loss` - The validation loss associated with the validator. - - \ No newline at end of file + + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/bedrock_custom_models.html.markdown b/website/docs/cdktf/python/d/bedrock_custom_models.html.markdown index ebdfd103305d..331cb2e16e44 100644 --- a/website/docs/cdktf/python/d/bedrock_custom_models.html.markdown +++ b/website/docs/cdktf/python/d/bedrock_custom_models.html.markdown @@ -31,7 +31,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -This data source does not support any arguments. +This data source supports the following arguments: + +* `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). ## Attribute Reference @@ -42,4 +44,4 @@ This data source exports the following attributes in addition to the arguments a * `model_arn` - The ARN of the custom model. * `model_name` - The name of the custom model. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/bedrock_foundation_model.html.markdown b/website/docs/cdktf/python/d/bedrock_foundation_model.html.markdown index c0ee5b339158..72abbfc425f0 100644 --- a/website/docs/cdktf/python/d/bedrock_foundation_model.html.markdown +++ b/website/docs/cdktf/python/d/bedrock_foundation_model.html.markdown @@ -42,7 +42,8 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: -* `model_id` – (Required) Model identifier. +* `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). +* `model_id` - (Required) Model identifier. ## Attribute Reference @@ -57,4 +58,4 @@ This data source exports the following attributes in addition to the arguments a * `provider_name` - Model provider name. * `response_streaming_supported` - Indicates whether the model supports streaming. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/bedrock_foundation_models.html.markdown b/website/docs/cdktf/python/d/bedrock_foundation_models.html.markdown index fb06370d932e..d42b01054cfc 100644 --- a/website/docs/cdktf/python/d/bedrock_foundation_models.html.markdown +++ b/website/docs/cdktf/python/d/bedrock_foundation_models.html.markdown @@ -54,6 +54,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `by_customization_type` - (Optional) Customization type to filter on. Valid values are `FINE_TUNING`. * `by_inference_type` - (Optional) Inference type to filter on. Valid values are `ON_DEMAND` and `PROVISIONED`. * `by_output_modality` - (Optional) Output modality to filter on. Valid values are `TEXT`, `IMAGE`, and `EMBEDDING`. @@ -78,4 +79,4 @@ This data source exports the following attributes in addition to the arguments a * `provider_name` - Model provider name. * `response_streaming_supported` - Indicates whether the model supports streaming. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/bedrock_inference_profile.html.markdown b/website/docs/cdktf/python/d/bedrock_inference_profile.html.markdown index 0c1de139dfd5..d5c062821443 100644 --- a/website/docs/cdktf/python/d/bedrock_inference_profile.html.markdown +++ b/website/docs/cdktf/python/d/bedrock_inference_profile.html.markdown @@ -44,7 +44,8 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: -- `inference_profile_id` – (Required) Inference Profile identifier. +* `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). +* `inference_profile_id` - (Required) Inference Profile identifier. ## Attribute Reference @@ -63,4 +64,4 @@ This data source exports the following attributes in addition to the arguments a - `model_arn` - The Amazon Resource Name (ARN) of the model. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/bedrock_inference_profiles.html.markdown b/website/docs/cdktf/python/d/bedrock_inference_profiles.html.markdown index 2db16342b2b3..8786db121766 100644 --- a/website/docs/cdktf/python/d/bedrock_inference_profiles.html.markdown +++ b/website/docs/cdktf/python/d/bedrock_inference_profiles.html.markdown @@ -10,7 +10,7 @@ description: |- # Data Source: aws_bedrock_inference_profiles -Terraform data source for managing AWS Bedrock AWS Bedrock Inference Profiles. +Terraform data source for managing AWS Bedrock Inference Profiles. ## Example Usage @@ -31,9 +31,31 @@ class MyConvertedCode(TerraformStack): DataAwsBedrockInferenceProfiles(self, "test") ``` +### Filter by Type + +```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_bedrock_inference_profiles import DataAwsBedrockInferenceProfiles +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + DataAwsBedrockInferenceProfiles(self, "test", + type="APPLICATION" + ) +``` + ## Argument Reference -This data source does not support any arguments. +This data source supports the following arguments: + +* `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). +* `type` - (Optional) Filters for inference profiles that match the type you specify. Valid values are: `SYSTEM_DEFINED`, `APPLICATION`. ## Attribute Reference @@ -43,18 +65,18 @@ This data source exports the following attributes in addition to the arguments a ### `inference_profile_summaries` -- `created_at` - The time at which the inference profile was created. -- `description` - The description of the inference profile. -- `inference_profile_arn` - The Amazon Resource Name (ARN) of the inference profile. -- `inference_profile_id` - The unique identifier of the inference profile. -- `inference_profile_name` - The name of the inference profile. -- `models` - A list of information about each model in the inference profile. See [`models`](#models). -- `status` - The status of the inference profile. `ACTIVE` means that the inference profile is available to use. -- `type` - The type of the inference profile. `SYSTEM_DEFINED` means that the inference profile is defined by Amazon Bedrock. -- `updated_at` - The time at which the inference profile was last updated. +- `created_at` - Time at which the inference profile was created. +- `description` - Description of the inference profile. +- `inference_profile_arn` - Amazon Resource Name (ARN) of the inference profile. +- `inference_profile_id` - Unique identifier of the inference profile. +- `inference_profile_name` - Name of the inference profile. +- `models` - List of information about each model in the inference profile. See [`models` Block](#models). +- `status` - Status of the inference profile. `ACTIVE` means that the inference profile is available to use. +- `type` - Type of the inference profile. `SYSTEM_DEFINED` means that the inference profile is defined by Amazon Bedrock. `APPLICATION` means the inference profile was created by a user. +- `updated_at` - Time at which the inference profile was last updated. ### `models` -- `model_arn` - The Amazon Resource Name (ARN) of the model. +- `model_arn` - Amazon Resource Name (ARN) of the model. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/bedrockagent_agent_versions.html.markdown b/website/docs/cdktf/python/d/bedrockagent_agent_versions.html.markdown index b18bacda40af..4f812534b44b 100644 --- a/website/docs/cdktf/python/d/bedrockagent_agent_versions.html.markdown +++ b/website/docs/cdktf/python/d/bedrockagent_agent_versions.html.markdown @@ -37,6 +37,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `agent_id` - (Required) Unique identifier of the agent. ## Attribute Reference @@ -60,4 +61,4 @@ This data source exports the following attributes in addition to the arguments a * `guardrail_identifier` - Unique identifier of the guardrail. * `guardrail_version` - Version of the guardrail. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/chatbot_slack_workspace.html.markdown b/website/docs/cdktf/python/d/chatbot_slack_workspace.html.markdown index 1c45c0e64fba..54698636d056 100644 --- a/website/docs/cdktf/python/d/chatbot_slack_workspace.html.markdown +++ b/website/docs/cdktf/python/d/chatbot_slack_workspace.html.markdown @@ -35,8 +35,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `slack_team_name` - (Required) Slack workspace name configured with AWS Chatbot. ## Attribute Reference @@ -45,4 +46,4 @@ This data source exports the following attributes in addition to the arguments a * `slack_team_id` - ID of the Slack Workspace assigned by AWS Chatbot. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/cloudcontrolapi_resource.html.markdown b/website/docs/cdktf/python/d/cloudcontrolapi_resource.html.markdown index 9efdbdf423ec..847efda6085c 100644 --- a/website/docs/cdktf/python/d/cloudcontrolapi_resource.html.markdown +++ b/website/docs/cdktf/python/d/cloudcontrolapi_resource.html.markdown @@ -41,6 +41,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `role_arn` - (Optional) ARN of the IAM Role to assume for operations. * `type_version_id` - (Optional) Identifier of the CloudFormation resource type version. @@ -50,4 +51,4 @@ This data source exports the following attributes in addition to the arguments a * `properties` - JSON string matching the CloudFormation resource type schema with current configuration. Underlying attributes can be referenced via the [`jsondecode()` function](https://www.terraform.io/docs/language/functions/jsondecode.html), for example, `jsondecode(data.aws_cloudcontrolapi_resource.example.properties)["example"]`. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/cloudformation_export.html.markdown b/website/docs/cdktf/python/d/cloudformation_export.html.markdown index 9f7c99d57d82..3b91cdf1b156 100644 --- a/website/docs/cdktf/python/d/cloudformation_export.html.markdown +++ b/website/docs/cdktf/python/d/cloudformation_export.html.markdown @@ -44,6 +44,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `name` - (Required) Name of the export as it appears in the console or from [list-exports](http://docs.aws.amazon.com/cli/latest/reference/cloudformation/list-exports.html) ## Attribute Reference @@ -53,4 +54,4 @@ This data source exports the following attributes in addition to the arguments a * `value` - Value from Cloudformation export identified by the export name found from [list-exports](http://docs.aws.amazon.com/cli/latest/reference/cloudformation/list-exports.html) * `exporting_stack_id` - ARN of stack that contains the exported output name and value. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/cloudformation_stack.html.markdown b/website/docs/cdktf/python/d/cloudformation_stack.html.markdown index 7ffa92489081..fc792d43b9d3 100644 --- a/website/docs/cdktf/python/d/cloudformation_stack.html.markdown +++ b/website/docs/cdktf/python/d/cloudformation_stack.html.markdown @@ -46,6 +46,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `name` - (Required) Name of the stack ## Attribute Reference @@ -63,4 +64,4 @@ This data source exports the following attributes in addition to the arguments a * `iam_role_arn` - ARN of the IAM role used to create the stack. * `timeout_in_minutes` - Amount of time that can pass before the stack status becomes `CREATE_FAILED` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/cloudformation_type.html.markdown b/website/docs/cdktf/python/d/cloudformation_type.html.markdown index 5be942bb266c..8f3fe4fcdf1a 100644 --- a/website/docs/cdktf/python/d/cloudformation_type.html.markdown +++ b/website/docs/cdktf/python/d/cloudformation_type.html.markdown @@ -36,6 +36,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `arn` - (Optional) ARN of the CloudFormation Type. For example, `arn:aws:cloudformation:us-west-2::type/resource/AWS-EC2-VPC`. * `type` - (Optional) CloudFormation Registry Type. For example, `RESOURCE`. * `type_name` - (Optional) CloudFormation Type name. For example, `AWS::EC2::VPC`. @@ -59,4 +60,4 @@ This data source exports the following attributes in addition to the arguments a * `source_url` - URL of the source code for the CloudFormation Type. * `visibility` - Scope of the CloudFormation Type. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/cloudfront_distribution.html.markdown b/website/docs/cdktf/python/d/cloudfront_distribution.html.markdown index 9b10fd6933b9..ddcfa75cd81a 100644 --- a/website/docs/cdktf/python/d/cloudfront_distribution.html.markdown +++ b/website/docs/cdktf/python/d/cloudfront_distribution.html.markdown @@ -45,6 +45,8 @@ This data source exports the following attributes in addition to the arguments a * `aliases` - List that contains information about CNAMEs (alternate domain names), if any, for this distribution. +* `anycast_ip_list_id` - ID of the Anycast static IP list that is associated with the distribution, if any. + * `arn` - ARN (Amazon Resource Name) for the distribution. For example: arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5, where 123456789012 is your AWS account ID. * `status` - Current status of the distribution. `Deployed` if the @@ -67,4 +69,4 @@ This data source exports the following attributes in addition to the arguments a alias for the zone ID `Z2FDTNDATAQYW2`. * `web_acl_id` AWS WAF web ACL associated with this distribution. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/cloudfront_log_delivery_canonical_user_id.html.markdown b/website/docs/cdktf/python/d/cloudfront_log_delivery_canonical_user_id.html.markdown index 7650a408cf40..8de6c073784f 100644 --- a/website/docs/cdktf/python/d/cloudfront_log_delivery_canonical_user_id.html.markdown +++ b/website/docs/cdktf/python/d/cloudfront_log_delivery_canonical_user_id.html.markdown @@ -72,12 +72,12 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: -* `region` - (Optional) Region you'd like the zone for. By default, fetches the current region. +* `region` - (Optional) Name of the Region whose canonical user ID is desired. Defaults to the Region set in the [provider configuration](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#aws-configuration-reference). ## Attribute Reference This data source exports the following attributes in addition to the arguments above: -* `id` - Canonical user ID for the AWS `awslogsdelivery` account in the region. +* `id` - Canonical user ID for the AWS `awslogsdelivery` account in the Region. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/cloudhsm_v2_cluster.html.markdown b/website/docs/cdktf/python/d/cloudhsm_v2_cluster.html.markdown index bc8899f9dd13..f9cc2876c035 100644 --- a/website/docs/cdktf/python/d/cloudhsm_v2_cluster.html.markdown +++ b/website/docs/cdktf/python/d/cloudhsm_v2_cluster.html.markdown @@ -35,6 +35,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `cluster_id` - (Required) ID of Cloud HSM v2 cluster. * `cluster_state` - (Optional) State of the cluster to be found. @@ -53,4 +54,4 @@ This data source exports the following attributes in addition to the arguments a * `cluster_certificates.0.manufacturer_hardware_certificate` - The HSM hardware certificate issued (signed) by the hardware manufacturer. The number of available cluster certificates may vary depending on state of the cluster. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/cloudtrail_service_account.html.markdown b/website/docs/cdktf/python/d/cloudtrail_service_account.html.markdown index 5f19e9343f6b..9601904ece1e 100644 --- a/website/docs/cdktf/python/d/cloudtrail_service_account.html.markdown +++ b/website/docs/cdktf/python/d/cloudtrail_service_account.html.markdown @@ -13,7 +13,7 @@ description: |- Use this data source to get the Account ID of the [AWS CloudTrail Service Account](http://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-supported-regions.html) in a given region for the purpose of allowing CloudTrail to store trail data in S3. -~> **Note:** AWS documentation [states that](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/create-s3-bucket-policy-for-cloudtrail.html#troubleshooting-s3-bucket-policy) a [service principal name](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html#principal-services) should be used instead of an AWS account ID in any relevant IAM policy. +~> **Warning:** This data source is deprecated. The AWS documentation [states that](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/create-s3-bucket-policy-for-cloudtrail.html#troubleshooting-s3-bucket-policy) a [service principal name](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html#principal-services) should be used instead of an AWS account ID in any relevant IAM policy. ## Example Usage @@ -73,14 +73,13 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: -* `region` - (Optional) Name of the region whose AWS CloudTrail account ID is desired. -Defaults to the region from the AWS provider configuration. +* `region` - (Optional) Name of the Region whose AWS CloudTrail account ID is desired. Defaults to the Region set in the [provider configuration](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#aws-configuration-reference). ## Attribute Reference This data source exports the following attributes in addition to the arguments above: -* `id` - ID of the AWS CloudTrail service account in the selected region. -* `arn` - ARN of the AWS CloudTrail service account in the selected region. +* `id` - ID of the AWS CloudTrail service account in the selected Region. +* `arn` - ARN of the AWS CloudTrail service account in the selected Region. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/cloudwatch_contributor_managed_insight_rules.html.markdown b/website/docs/cdktf/python/d/cloudwatch_contributor_managed_insight_rules.html.markdown index 0029e9c6231a..7aee9eded9cf 100644 --- a/website/docs/cdktf/python/d/cloudwatch_contributor_managed_insight_rules.html.markdown +++ b/website/docs/cdktf/python/d/cloudwatch_contributor_managed_insight_rules.html.markdown @@ -37,6 +37,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `resource_arn` - (Required) ARN of an Amazon Web Services resource that has managed Contributor Insights rules. ## Attribute Reference @@ -56,4 +57,4 @@ This data source exports the following attributes in addition to the arguments a * `rule_name` - Name of the Contributor Insights rule that contains data for the specified Amazon Web Services resource. * `state` - Indicates whether the rule is enabled or disabled. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/cloudwatch_event_bus.html.markdown b/website/docs/cdktf/python/d/cloudwatch_event_bus.html.markdown index 5304d2801461..5306eb852123 100644 --- a/website/docs/cdktf/python/d/cloudwatch_event_bus.html.markdown +++ b/website/docs/cdktf/python/d/cloudwatch_event_bus.html.markdown @@ -37,6 +37,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `name` - (Required) Name of the event bus. ## Attribute Reference @@ -49,5 +50,8 @@ This data source exports the following attributes in addition to the arguments a * `description` - Event bus description. * `id` - Name of the event bus. * `kms_key_identifier` - Identifier of the AWS KMS customer managed key for EventBridge to use to encrypt events on this event bus, if one has been specified. +* `log_config` - Block for logging configuration settings for the event bus. + * `include_detail` - Whether EventBridge include detailed event information in the records it generates. + * `level` - Level of logging detail to include. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/cloudwatch_event_buses.html.markdown b/website/docs/cdktf/python/d/cloudwatch_event_buses.html.markdown index 7143ab5bc1a7..2de054d3d49c 100644 --- a/website/docs/cdktf/python/d/cloudwatch_event_buses.html.markdown +++ b/website/docs/cdktf/python/d/cloudwatch_event_buses.html.markdown @@ -37,6 +37,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `name_prefix` - (Optional) Specifying this limits the results to only those event buses with names that start with the specified prefix. ## Attribute Reference @@ -54,4 +55,4 @@ This data source exports the following attributes in addition to the arguments a * `name` - The name of the event bus. * `policy` - The permissions policy of the event bus, describing which other AWS accounts can write events to this event bus. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/cloudwatch_event_connection.html.markdown b/website/docs/cdktf/python/d/cloudwatch_event_connection.html.markdown index a7ddb72dde5f..d3763c2b0498 100644 --- a/website/docs/cdktf/python/d/cloudwatch_event_connection.html.markdown +++ b/website/docs/cdktf/python/d/cloudwatch_event_connection.html.markdown @@ -37,6 +37,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `name` - Name of the connection. ## Attribute Reference @@ -48,4 +49,4 @@ This data source exports the following attributes in addition to the arguments a * `kms_key_identifier` - (Optional) Identifier of the AWS KMS customer managed key for EventBridge to use to encrypt the connection, if one has been specified. * `secret_arn` - ARN of the secret created from the authorization parameters specified for the connection. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/cloudwatch_event_source.html.markdown b/website/docs/cdktf/python/d/cloudwatch_event_source.html.markdown index 5491a8adfff9..03b9e93c4204 100644 --- a/website/docs/cdktf/python/d/cloudwatch_event_source.html.markdown +++ b/website/docs/cdktf/python/d/cloudwatch_event_source.html.markdown @@ -37,6 +37,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `name_prefix` - (Optional) Specifying this limits the results to only those partner event sources with names that start with the specified prefix ## Attribute Reference @@ -48,4 +49,4 @@ This data source exports the following attributes in addition to the arguments a * `name` - Name of the event source * `state` - State of the event source (`ACTIVE` or `PENDING`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/cloudwatch_log_group.html.markdown b/website/docs/cdktf/python/d/cloudwatch_log_group.html.markdown index 2b3ed983e6a9..0925f6568e95 100644 --- a/website/docs/cdktf/python/d/cloudwatch_log_group.html.markdown +++ b/website/docs/cdktf/python/d/cloudwatch_log_group.html.markdown @@ -35,6 +35,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `name` - (Required) Name of the Cloudwatch log group ## Attribute Reference @@ -48,4 +49,4 @@ This data source exports the following attributes in addition to the arguments a * `retention_in_days` - Number of days log events retained in the specified log group. * `tags` - Map of tags to assign to the resource. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/cloudwatch_log_groups.html.markdown b/website/docs/cdktf/python/d/cloudwatch_log_groups.html.markdown index 3a207f8f8b43..bac5ffe36747 100644 --- a/website/docs/cdktf/python/d/cloudwatch_log_groups.html.markdown +++ b/website/docs/cdktf/python/d/cloudwatch_log_groups.html.markdown @@ -35,6 +35,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `log_group_name_prefix` - (Optional) Group prefix of the Cloudwatch log groups to list ## Attribute Reference @@ -44,4 +45,4 @@ This data source exports the following attributes in addition to the arguments a * `arns` - Set of ARNs of the Cloudwatch log groups * `log_group_names` - Set of names of the Cloudwatch log groups - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/codeartifact_authorization_token.html.markdown b/website/docs/cdktf/python/d/codeartifact_authorization_token.html.markdown index b77f8c417aca..7aa2eb4cd4e9 100644 --- a/website/docs/cdktf/python/d/codeartifact_authorization_token.html.markdown +++ b/website/docs/cdktf/python/d/codeartifact_authorization_token.html.markdown @@ -35,6 +35,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `domain` - (Required) Name of the domain that is in scope for the generated authorization token. * `domain_owner` - (Optional) Account number of the AWS account that owns the domain. * `duration_seconds` - (Optional) Time, in seconds, that the generated authorization token is valid. Valid values are `0` and between `900` and `43200`. @@ -46,4 +47,4 @@ This data source exports the following attributes in addition to the arguments a * `authorization_token` - Temporary authorization token. * `expiration` - Time in UTC RFC3339 format when the authorization token expires. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/codeartifact_repository_endpoint.html.markdown b/website/docs/cdktf/python/d/codeartifact_repository_endpoint.html.markdown index f049101bea47..469d854c2498 100644 --- a/website/docs/cdktf/python/d/codeartifact_repository_endpoint.html.markdown +++ b/website/docs/cdktf/python/d/codeartifact_repository_endpoint.html.markdown @@ -37,6 +37,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `domain` - (Required) Name of the domain that contains the repository. * `repository` - (Required) Name of the repository. * `format` - (Required) Which endpoint of a repository to return. A repository has one endpoint for each package format: `npm`, `pypi`, `maven`, and `nuget`. @@ -48,4 +49,4 @@ This data source exports the following attributes in addition to the arguments a * `repository_endpoint` - URL of the returned endpoint. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/codebuild_fleet.html.markdown b/website/docs/cdktf/python/d/codebuild_fleet.html.markdown index 29f20a2c89e9..0705a2fbc26f 100644 --- a/website/docs/cdktf/python/d/codebuild_fleet.html.markdown +++ b/website/docs/cdktf/python/d/codebuild_fleet.html.markdown @@ -71,8 +71,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `name` - (Required) Fleet name. ## Attribute Reference @@ -83,6 +84,7 @@ This data source exports the following attributes in addition to the arguments a * `base_capacity` - Number of machines allocated to the fleet. * `compute_configuration` - Compute configuration of the compute fleet. * `disk` - Amount of disk space of the instance type included in the fleet. + * `instance_type` - EC2 instance type in the fleet. * `machine_type` - Machine type of the instance type included in the fleet. * `memory` - Amount of memory of the instance type included in the fleet. * `vcpu` - Number of vCPUs of the instance type included in the fleet. @@ -111,4 +113,4 @@ This data source exports the following attributes in addition to the arguments a * `subnets` - A list of one or more subnet IDs in your Amazon VPC. * `vpc_id` - The ID of the Amazon VPC. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/codecatalyst_dev_environment.html.markdown b/website/docs/cdktf/python/d/codecatalyst_dev_environment.html.markdown index 517ac7f95c1b..9fce466052a7 100644 --- a/website/docs/cdktf/python/d/codecatalyst_dev_environment.html.markdown +++ b/website/docs/cdktf/python/d/codecatalyst_dev_environment.html.markdown @@ -36,8 +36,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `env_id` - - (Required) The system-generated unique ID of the Dev Environment for which you want to view information. To retrieve a list of Dev Environment IDs, use [ListDevEnvironments](https://docs.aws.amazon.com/codecatalyst/latest/APIReference/API_ListDevEnvironments.html). * `project_name` - (Required) The name of the project in the space. * `space_name` - (Required) The name of the space. @@ -57,4 +58,4 @@ This data source exports the following attributes in addition to the arguments a * `status` - The current status of the Dev Environment. From: PENDING | RUNNING | STARTING | STOPPING | STOPPED | FAILED | DELETING | DELETED. * `status_reason` - The reason for the status. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/codecommit_approval_rule_template.html.markdown b/website/docs/cdktf/python/d/codecommit_approval_rule_template.html.markdown index f67ddf275f92..0b337b1dfa85 100644 --- a/website/docs/cdktf/python/d/codecommit_approval_rule_template.html.markdown +++ b/website/docs/cdktf/python/d/codecommit_approval_rule_template.html.markdown @@ -35,6 +35,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `name` - (Required) Name for the approval rule template. This needs to be less than 100 characters. ## Attribute Reference @@ -49,4 +50,4 @@ This data source exports the following attributes in addition to the arguments a * `last_modified_user` - ARN of the user who made the most recent changes to the approval rule template. * `rule_content_sha256` - SHA-256 hash signature for the content of the approval rule template. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/codecommit_repository.html.markdown b/website/docs/cdktf/python/d/codecommit_repository.html.markdown index 0d0b4357592f..5afa0ccb371d 100644 --- a/website/docs/cdktf/python/d/codecommit_repository.html.markdown +++ b/website/docs/cdktf/python/d/codecommit_repository.html.markdown @@ -35,6 +35,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `repository_name` - (Required) Name for the repository. This needs to be less than 100 characters. ## Attribute Reference @@ -47,4 +48,4 @@ This data source exports the following attributes in addition to the arguments a * `clone_url_http` - URL to use for cloning the repository over HTTPS. * `clone_url_ssh` - URL to use for cloning the repository over SSH. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/codeguruprofiler_profiling_group.html.markdown b/website/docs/cdktf/python/d/codeguruprofiler_profiling_group.html.markdown index f7265efe2f9a..5095d9d964c5 100644 --- a/website/docs/cdktf/python/d/codeguruprofiler_profiling_group.html.markdown +++ b/website/docs/cdktf/python/d/codeguruprofiler_profiling_group.html.markdown @@ -35,8 +35,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `name` - (Required) The name of the profiling group. ## Attribute Reference @@ -51,4 +52,4 @@ This data source exports the following attributes in addition to the arguments a * `tags` - Mapping of Key-Value tags for the resource. * `updated_at` - Timestamp when Profiling Group was updated. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/codestarconnections_connection.html.markdown b/website/docs/cdktf/python/d/codestarconnections_connection.html.markdown index 7d3dced7e970..6bf7a4bec8b5 100644 --- a/website/docs/cdktf/python/d/codestarconnections_connection.html.markdown +++ b/website/docs/cdktf/python/d/codestarconnections_connection.html.markdown @@ -56,6 +56,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `arn` - (Optional) CodeStar Connection ARN. * `name` - (Optional) CodeStar Connection name. @@ -72,4 +73,4 @@ This data source exports the following attributes in addition to the arguments a * `provider_type` - Name of the external provider where your third-party code repository is configured. Possible values are `Bitbucket`, `GitHub` and `GitLab`. For connections to GitHub Enterprise Server or GitLab Self-Managed instances, you must create an [aws_codestarconnections_host](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/codestarconnections_host) resource and use `host_arn` instead. * `tags` - Map of key-value resource tags to associate with the resource. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/cognito_identity_pool.html.markdown b/website/docs/cdktf/python/d/cognito_identity_pool.html.markdown index 47eedab81150..573126d56da4 100644 --- a/website/docs/cdktf/python/d/cognito_identity_pool.html.markdown +++ b/website/docs/cdktf/python/d/cognito_identity_pool.html.markdown @@ -37,6 +37,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `identity_pool_name` - (Required) The Cognito Identity Pool name. ## Attribute Reference @@ -54,4 +55,4 @@ This data source exports the following attributes in addition to the arguments a * `supported_login_providers` - Key-Value pairs mapping provider names to provider app IDs. * `tags` - A map of tags to assigned to the Identity Pool. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/cognito_user_group.html.markdown b/website/docs/cdktf/python/d/cognito_user_group.html.markdown index 17c25a0ae809..7d31da1ca785 100644 --- a/website/docs/cdktf/python/d/cognito_user_group.html.markdown +++ b/website/docs/cdktf/python/d/cognito_user_group.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `name` - (Required) Name of the user group. * `user_pool_id` - (Required) User pool the client belongs to. @@ -50,4 +51,4 @@ This data source exports the following attributes in addition to the arguments a * `precedence` - Precedence of the user group. * `role_arn` - ARN of the IAM role to be associated with the user group. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/cognito_user_groups.html.markdown b/website/docs/cdktf/python/d/cognito_user_groups.html.markdown index a94daf53a634..5f98f1ae4f58 100644 --- a/website/docs/cdktf/python/d/cognito_user_groups.html.markdown +++ b/website/docs/cdktf/python/d/cognito_user_groups.html.markdown @@ -37,6 +37,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `user_pool_id` - (Required) User pool the client belongs to. ## Attribute Reference @@ -53,4 +54,4 @@ This data source exports the following attributes in addition to the arguments a * `precedence` - Precedence of the user group. * `role_arn` - ARN of the IAM role to be associated with the user group. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/cognito_user_pool.html.markdown b/website/docs/cdktf/python/d/cognito_user_pool.html.markdown index f127fd764739..c600dd8fa194 100644 --- a/website/docs/cdktf/python/d/cognito_user_pool.html.markdown +++ b/website/docs/cdktf/python/d/cognito_user_pool.html.markdown @@ -37,6 +37,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `user_pool_id` - (Required) The cognito pool ID ## Attribute Reference @@ -141,4 +142,4 @@ This data source exports the following attributes in addition to the arguments a * `custom_auth_mode` - Mode of threat protection operation in custom authentication. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/cognito_user_pool_client.html.markdown b/website/docs/cdktf/python/d/cognito_user_pool_client.html.markdown index 9d5296f6acfe..260700beb278 100644 --- a/website/docs/cdktf/python/d/cognito_user_pool_client.html.markdown +++ b/website/docs/cdktf/python/d/cognito_user_pool_client.html.markdown @@ -36,6 +36,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `client_id` - (Required) Client Id of the user pool. * `user_pool_id` - (Required) User pool the client belongs to. @@ -87,4 +88,4 @@ Valid values for the following arguments are: `seconds`, `minutes`, `hours` or ` * `id_token` - (Optional) Time unit in for the value in `id_token_validity`, defaults to `hours`. * `refresh_token` - (Optional) Time unit in for the value in `refresh_token_validity`, defaults to `days`. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/cognito_user_pool_clients.html.markdown b/website/docs/cdktf/python/d/cognito_user_pool_clients.html.markdown index 6e564fa35f88..d5b7d596c7a1 100644 --- a/website/docs/cdktf/python/d/cognito_user_pool_clients.html.markdown +++ b/website/docs/cdktf/python/d/cognito_user_pool_clients.html.markdown @@ -35,6 +35,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `user_pool_id` - (Required) Cognito user pool ID. ## Attribute Reference @@ -44,4 +45,4 @@ This data source exports the following attributes in addition to the arguments a * `client_ids` - List of Cognito user pool client IDs. * `client_names` - List of Cognito user pool client names. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/cognito_user_pool_signing_certificate.html.markdown b/website/docs/cdktf/python/d/cognito_user_pool_signing_certificate.html.markdown index c7882d874fe7..cf65b50c2ae6 100644 --- a/website/docs/cdktf/python/d/cognito_user_pool_signing_certificate.html.markdown +++ b/website/docs/cdktf/python/d/cognito_user_pool_signing_certificate.html.markdown @@ -35,6 +35,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `user_pool_id` - (Required) Cognito user pool ID. ## Attribute Reference @@ -43,4 +44,4 @@ This data source exports the following attributes in addition to the arguments a * `certificate` - Certificate string - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/cognito_user_pools.html.markdown b/website/docs/cdktf/python/d/cognito_user_pools.html.markdown index d76072146b83..318758241722 100644 --- a/website/docs/cdktf/python/d/cognito_user_pools.html.markdown +++ b/website/docs/cdktf/python/d/cognito_user_pools.html.markdown @@ -48,6 +48,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `name` - (Required) Name of the cognito user pools. Name is not a unique attribute for cognito user pool, so multiple pools might be returned with given name. If the pool name is expected to be unique, you can reference the pool id via ```tolist(data.aws_cognito_user_pools.selected.ids)[0]``` ## Attribute Reference @@ -57,4 +58,4 @@ This data source exports the following attributes in addition to the arguments a * `ids` - Set of cognito user pool ids. * `arns` - Set of cognito user pool Amazon Resource Names (ARNs). - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/connect_bot_association.html.markdown b/website/docs/cdktf/python/d/connect_bot_association.html.markdown index 9d972df8a749..aacc524a00b4 100644 --- a/website/docs/cdktf/python/d/connect_bot_association.html.markdown +++ b/website/docs/cdktf/python/d/connect_bot_association.html.markdown @@ -40,6 +40,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `instance_id` - (Required) Identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance. * `lex_bot` - (Required) Configuration information of an Amazon Lex (V1) bot. Detailed below. @@ -54,4 +55,4 @@ The `lex_bot` configuration block supports the following: This data source exports no additional attributes. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/connect_contact_flow.html.markdown b/website/docs/cdktf/python/d/connect_contact_flow.html.markdown index dd7d84d4cfa2..3dcb29b45b3d 100644 --- a/website/docs/cdktf/python/d/connect_contact_flow.html.markdown +++ b/website/docs/cdktf/python/d/connect_contact_flow.html.markdown @@ -58,6 +58,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `contact_flow_id` - (Optional) Returns information on a specific Contact Flow by contact flow id * `instance_id` - (Required) Reference to the hosting Amazon Connect Instance * `name` - (Optional) Returns information on a specific Contact Flow by name @@ -74,4 +75,4 @@ This data source exports the following attributes in addition to the arguments a * `tags` - Tags to assign to the Contact Flow. * `type` - Type of Contact Flow. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/connect_contact_flow_module.html.markdown b/website/docs/cdktf/python/d/connect_contact_flow_module.html.markdown index cd58db216458..3f30468e4787 100644 --- a/website/docs/cdktf/python/d/connect_contact_flow_module.html.markdown +++ b/website/docs/cdktf/python/d/connect_contact_flow_module.html.markdown @@ -58,6 +58,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `contact_flow_module_id` - (Optional) Returns information on a specific Contact Flow Module by contact flow module id * `instance_id` - (Required) Reference to the hosting Amazon Connect Instance * `name` - (Optional) Returns information on a specific Contact Flow Module by name @@ -75,4 +76,4 @@ This data source exports the following attributes in addition to the arguments a * `state` - Type of Contact Flow Module Module. Values are either `ACTIVE` or `ARCHIVED`. * `status` - Status of the Contact Flow Module Module. Values are either `PUBLISHED` or `SAVED`. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/connect_hours_of_operation.html.markdown b/website/docs/cdktf/python/d/connect_hours_of_operation.html.markdown index 2f67a06a5483..4c5d47945b58 100644 --- a/website/docs/cdktf/python/d/connect_hours_of_operation.html.markdown +++ b/website/docs/cdktf/python/d/connect_hours_of_operation.html.markdown @@ -58,6 +58,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `hours_of_operation_id` - (Optional) Returns information on a specific Hours of Operation by hours of operation id * `instance_id` - (Required) Reference to the hosting Amazon Connect Instance * `name` - (Optional) Returns information on a specific Hours of Operation by name @@ -93,4 +94,4 @@ A `start_time` block supports the following arguments: * `hours` - Hour of opening. * `minutes` - Minute of opening. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/connect_instance.html.markdown b/website/docs/cdktf/python/d/connect_instance.html.markdown index 0637c8e95746..50358a0a19f5 100644 --- a/website/docs/cdktf/python/d/connect_instance.html.markdown +++ b/website/docs/cdktf/python/d/connect_instance.html.markdown @@ -56,6 +56,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `instance_id` - (Optional) Returns information on a specific connect instance by id * `instance_alias` - (Optional) Returns information on a specific connect instance by alias @@ -80,4 +81,4 @@ This data source exports the following attributes in addition to the arguments a * `service_role` - Service role of the instance. * `tags` - A map of tags to assigned to the instance. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/connect_instance_storage_config.html.markdown b/website/docs/cdktf/python/d/connect_instance_storage_config.html.markdown index 2645ca26e979..2f4570084fcd 100644 --- a/website/docs/cdktf/python/d/connect_instance_storage_config.html.markdown +++ b/website/docs/cdktf/python/d/connect_instance_storage_config.html.markdown @@ -37,6 +37,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `association_id` - (Required) The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID. * `instance_id` - (Required) Reference to the hosting Amazon Connect Instance * `resource_type` - (Required) A valid resource type. Valid Values: `AGENT_EVENTS` | `ATTACHMENTS` | `CALL_RECORDINGS` | `CHAT_TRANSCRIPTS` | `CONTACT_EVALUATIONS` | `CONTACT_TRACE_RECORDS` | `MEDIA_STREAMS` | `REAL_TIME_CONTACT_ANALYSIS_SEGMENTS` | `SCHEDULED_REPORTS` | `SCREEN_RECORDINGS`. @@ -93,4 +94,4 @@ The `encryption_config` configuration block supports the following arguments: * `encryption_type` - The type of encryption. Valid Values: `KMS`. * `key_id` - The full ARN of the encryption key. Be sure to provide the full ARN of the encryption key, not just the ID. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/connect_lambda_function_association.html.markdown b/website/docs/cdktf/python/d/connect_lambda_function_association.html.markdown index 415572fc186a..6b73feb3396c 100644 --- a/website/docs/cdktf/python/d/connect_lambda_function_association.html.markdown +++ b/website/docs/cdktf/python/d/connect_lambda_function_association.html.markdown @@ -36,6 +36,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `function_arn` - (Required) ARN of the Lambda Function, omitting any version or alias qualifier. * `instance_id` - (Required) Identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance. @@ -45,4 +46,4 @@ This data source exports the following attributes in addition to the arguments a * `id` - AWS Region. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/connect_prompt.html.markdown b/website/docs/cdktf/python/d/connect_prompt.html.markdown index 75da3f06f63e..a09dbce7717c 100644 --- a/website/docs/cdktf/python/d/connect_prompt.html.markdown +++ b/website/docs/cdktf/python/d/connect_prompt.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `instance_id` - (Required) Reference to the hosting Amazon Connect Instance * `name` - (Required) Returns information on a specific Prompt by name @@ -48,4 +49,4 @@ This data source exports the following attributes in addition to the arguments a * `arn` - ARN of the Prompt. * `prompt_id` - Identifier for the prompt. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/connect_queue.html.markdown b/website/docs/cdktf/python/d/connect_queue.html.markdown index 5e8bb605f45a..a9e2bafb27bd 100644 --- a/website/docs/cdktf/python/d/connect_queue.html.markdown +++ b/website/docs/cdktf/python/d/connect_queue.html.markdown @@ -58,6 +58,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `queue_id` - (Optional) Returns information on a specific Queue by Queue id * `instance_id` - (Required) Reference to the hosting Amazon Connect Instance * `name` - (Optional) Returns information on a specific Queue by name @@ -84,4 +85,4 @@ A `outbound_caller_config` block supports the following arguments: * `outbound_caller_id_number_id` - Specifies the caller ID number. * `outbound_flow_id` - Outbound whisper flow to be used during an outbound call. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/connect_quick_connect.html.markdown b/website/docs/cdktf/python/d/connect_quick_connect.html.markdown index acbcff288dc0..b7b27546adc8 100644 --- a/website/docs/cdktf/python/d/connect_quick_connect.html.markdown +++ b/website/docs/cdktf/python/d/connect_quick_connect.html.markdown @@ -58,6 +58,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `quick_connect_id` - (Optional) Returns information on a specific Quick Connect by Quick Connect id * `instance_id` - (Required) Reference to the hosting Amazon Connect Instance * `name` - (Optional) Returns information on a specific Quick Connect by name @@ -96,4 +97,4 @@ A `user_config` block contains the following arguments: * `contact_flow_id` - Identifier of the contact flow. * `user_id` - Identifier for the user. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/connect_routing_profile.html.markdown b/website/docs/cdktf/python/d/connect_routing_profile.html.markdown index 6efa21a7c211..70208f9777c8 100644 --- a/website/docs/cdktf/python/d/connect_routing_profile.html.markdown +++ b/website/docs/cdktf/python/d/connect_routing_profile.html.markdown @@ -58,6 +58,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `instance_id` - Reference to the hosting Amazon Connect Instance * `name` - (Optional) Returns information on a specific Routing Profile by name * `routing_profile_id` - (Optional) Returns information on a specific Routing Profile by Routing Profile id @@ -90,4 +91,4 @@ A `queue_configs` block supports the following attributes: * `queue_id` - Identifier for the queue. * `queue_name` - Name for the queue. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/connect_security_profile.html.markdown b/website/docs/cdktf/python/d/connect_security_profile.html.markdown index 47376efbe19d..5a4296760a4e 100644 --- a/website/docs/cdktf/python/d/connect_security_profile.html.markdown +++ b/website/docs/cdktf/python/d/connect_security_profile.html.markdown @@ -58,6 +58,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `security_profile_id` - (Optional) Returns information on a specific Security Profile by Security Profile id * `instance_id` - (Required) Reference to the hosting Amazon Connect Instance * `name` - (Optional) Returns information on a specific Security Profile by name @@ -75,4 +76,4 @@ This data source exports the following attributes in addition to the arguments a * `permissions` - List of permissions assigned to the security profile. * `tags` - Map of tags to assign to the Security Profile. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/connect_user.html.markdown b/website/docs/cdktf/python/d/connect_user.html.markdown index f2806ffa25e7..94c9cc4c98f1 100644 --- a/website/docs/cdktf/python/d/connect_user.html.markdown +++ b/website/docs/cdktf/python/d/connect_user.html.markdown @@ -58,6 +58,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `instance_id` - (Required) Reference to the hosting Amazon Connect Instance * `name` - (Optional) Returns information on a specific User by name * `user_id` - (Optional) Returns information on a specific User by User id @@ -97,4 +98,4 @@ A `phone_config` block supports the following attributes: * `desk_phone_number` - The phone number for the user's desk phone. * `phone_type` - The phone type. Valid values are `DESK_PHONE` and `SOFT_PHONE`. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/connect_user_hierarchy_group.html.markdown b/website/docs/cdktf/python/d/connect_user_hierarchy_group.html.markdown index ede287c5127e..2d3676127202 100644 --- a/website/docs/cdktf/python/d/connect_user_hierarchy_group.html.markdown +++ b/website/docs/cdktf/python/d/connect_user_hierarchy_group.html.markdown @@ -58,6 +58,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `hierarchy_group_id` - (Optional) Returns information on a specific hierarchy group by hierarchy group id * `instance_id` - (Required) Reference to the hosting Amazon Connect Instance * `name` - (Optional) Returns information on a specific hierarchy group by name @@ -88,4 +89,4 @@ A level block supports the following attributes: * `id` - The identifier of the hierarchy group. * `name` - Name of the hierarchy group. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/connect_user_hierarchy_structure.html.markdown b/website/docs/cdktf/python/d/connect_user_hierarchy_structure.html.markdown index e8430e35a774..e5556e903fa7 100644 --- a/website/docs/cdktf/python/d/connect_user_hierarchy_structure.html.markdown +++ b/website/docs/cdktf/python/d/connect_user_hierarchy_structure.html.markdown @@ -35,6 +35,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `instance_id` - (Required) Reference to the hosting Amazon Connect Instance ## Attribute Reference @@ -57,4 +58,4 @@ Each level block supports the following attributes: * `id` - The identifier of the hierarchy level. * `name` - Name of the user hierarchy level. Must not be more than 50 characters. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/connect_vocabulary.html.markdown b/website/docs/cdktf/python/d/connect_vocabulary.html.markdown index 03a4f9839d9d..72d10c9da4a6 100644 --- a/website/docs/cdktf/python/d/connect_vocabulary.html.markdown +++ b/website/docs/cdktf/python/d/connect_vocabulary.html.markdown @@ -58,6 +58,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `instance_id` - (Required) Reference to the hosting Amazon Connect Instance * `name` - (Optional) Returns information on a specific Vocabulary by name * `vocabulary_id` - (Optional) Returns information on a specific Vocabulary by Vocabulary id @@ -79,4 +80,4 @@ separated by a colon (`:`). * `tags` - A map of tags to assign to the Vocabulary. * `vocabulary_id` - The identifier of the custom vocabulary. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/controltower_controls.html.markdown b/website/docs/cdktf/python/d/controltower_controls.html.markdown index 84dce0b2065b..48b7f8de8a23 100644 --- a/website/docs/cdktf/python/d/controltower_controls.html.markdown +++ b/website/docs/cdktf/python/d/controltower_controls.html.markdown @@ -45,8 +45,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `target_identifier` - (Required) The ARN of the organizational unit. ## Attribute Reference @@ -55,4 +56,4 @@ This data source exports the following attributes in addition to the arguments a * `enabled_controls` - List of all the ARNs for the controls applied to the `target_identifier`. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/customer_gateway.html.markdown b/website/docs/cdktf/python/d/customer_gateway.html.markdown index 6eedc46eaffe..656c59aa737d 100644 --- a/website/docs/cdktf/python/d/customer_gateway.html.markdown +++ b/website/docs/cdktf/python/d/customer_gateway.html.markdown @@ -51,6 +51,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `id` - (Optional) ID of the gateway. * `filter` - (Optional) One or more [name-value pairs][dcg-filters] to filter by. @@ -75,4 +76,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/datapipeline_pipeline.html.markdown b/website/docs/cdktf/python/d/datapipeline_pipeline.html.markdown index 1efdc31bcef7..817e304811de 100644 --- a/website/docs/cdktf/python/d/datapipeline_pipeline.html.markdown +++ b/website/docs/cdktf/python/d/datapipeline_pipeline.html.markdown @@ -35,6 +35,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `pipeline_id` - (Required) ID of the pipeline. ## Attribute Reference @@ -45,4 +46,4 @@ This data source exports the following attributes in addition to the arguments a * `description` - Description of Pipeline. * `tags` - Map of tags assigned to the resource. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/datapipeline_pipeline_definition.html.markdown b/website/docs/cdktf/python/d/datapipeline_pipeline_definition.html.markdown index 50270a6054ff..55b321d5b18e 100644 --- a/website/docs/cdktf/python/d/datapipeline_pipeline_definition.html.markdown +++ b/website/docs/cdktf/python/d/datapipeline_pipeline_definition.html.markdown @@ -35,6 +35,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `pipeline_id` - (Required) ID of the pipeline. ## Attribute Reference @@ -72,4 +73,4 @@ This data source exports the following attributes in addition to the arguments a * `ref_value` - Field value, expressed as the identifier of another object * `string_value` - Field value, expressed as a String. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/datazone_domain.html.markdown b/website/docs/cdktf/python/d/datazone_domain.html.markdown index ca7e8ff8572b..17dedc5a1976 100644 --- a/website/docs/cdktf/python/d/datazone_domain.html.markdown +++ b/website/docs/cdktf/python/d/datazone_domain.html.markdown @@ -37,6 +37,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `name` - (Optional) Name of the Domain. One of `name` or `id` is required. * `id` - (Optional) ID of the Domain. One of `name` or `id` is required @@ -53,4 +54,4 @@ This data source exports the following attributes in addition to the arguments a * `portal_url` - URL of the Domain. * `status` - Status of the Domain. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/datazone_environment_blueprint.html.markdown b/website/docs/cdktf/python/d/datazone_environment_blueprint.html.markdown index ba51fc0a7562..9edb4a1503bd 100644 --- a/website/docs/cdktf/python/d/datazone_environment_blueprint.html.markdown +++ b/website/docs/cdktf/python/d/datazone_environment_blueprint.html.markdown @@ -45,8 +45,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `domain_id` - (Required) ID of the domain. * `name` - (Required) Name of the blueprint. * `managed` (Required) Whether the blueprint is managed by Amazon DataZone. @@ -59,4 +60,4 @@ This data source exports the following attributes in addition to the arguments a * `description` - Description of the blueprint * `blueprint_provider` - Provider of the blueprint - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/db_cluster_snapshot.html.markdown b/website/docs/cdktf/python/d/db_cluster_snapshot.html.markdown index 50050c3a42c2..2dd2b1093d3f 100644 --- a/website/docs/cdktf/python/d/db_cluster_snapshot.html.markdown +++ b/website/docs/cdktf/python/d/db_cluster_snapshot.html.markdown @@ -59,6 +59,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `most_recent` - (Optional) If more than one result is returned, use the most recent Snapshot. * `db_cluster_identifier` - (Optional) Returns the list of snapshots created by the specific db_cluster * `db_cluster_snapshot_identifier` - (Optional) Returns information on a specific snapshot_id. @@ -94,4 +95,4 @@ This data source exports the following attributes in addition to the arguments a * `vpc_id` - VPC ID associated with the DB cluster snapshot. * `tags` - Map of tags for the resource. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/db_event_categories.html.markdown b/website/docs/cdktf/python/d/db_event_categories.html.markdown index 642c28e6d4d5..0baff8224604 100644 --- a/website/docs/cdktf/python/d/db_event_categories.html.markdown +++ b/website/docs/cdktf/python/d/db_event_categories.html.markdown @@ -62,6 +62,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `source_type` - (Optional) Type of source that will be generating the events. Valid options are db-instance, db-security-group, db-parameter-group, db-snapshot, db-cluster or db-cluster-snapshot. ## Attribute Reference @@ -71,4 +72,4 @@ This data source exports the following attributes in addition to the arguments a * `event_categories` - List of the event categories. * `id` - Region of the event categories. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/db_instance.html.markdown b/website/docs/cdktf/python/d/db_instance.html.markdown index 65b3a2c2468a..7021b9789c91 100644 --- a/website/docs/cdktf/python/d/db_instance.html.markdown +++ b/website/docs/cdktf/python/d/db_instance.html.markdown @@ -35,6 +35,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `db_instance_identifier` - (Optional) Name of the RDS instance. * `tags` - (Optional) Map of tags, each pair of which must exactly match a pair on the desired instance. @@ -94,4 +95,4 @@ The `master_user_secret` configuration block supports the following attributes: * `secret_arn` - The Amazon Resource Name (ARN) of the secret. * `secret_status` - The status of the secret. Valid Values: `creating` | `active` | `rotating` | `impaired`. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/db_instances.html.markdown b/website/docs/cdktf/python/d/db_instances.html.markdown index b67d3f817381..616b33c80d3c 100644 --- a/website/docs/cdktf/python/d/db_instances.html.markdown +++ b/website/docs/cdktf/python/d/db_instances.html.markdown @@ -62,6 +62,7 @@ class MyConvertedCode(TerraformStack): The following arguments are optional: +* `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). * `filter` - (Optional) Configuration block(s) used to filter instances with AWS supported attributes, such as `engine`, `db-cluster-id` or `db-instance-id` for example. Detailed below. * `tags` - (Optional) Map of tags, each pair of which must exactly match a pair on the desired instances. @@ -79,4 +80,4 @@ This data source exports the following attributes in addition to the arguments a * `instance_arns` - ARNs of the matched RDS instances. * `instance_identifiers` - Identifiers of the matched RDS instances. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/db_parameter_group.html.markdown b/website/docs/cdktf/python/d/db_parameter_group.html.markdown new file mode 100644 index 000000000000..14cd4c4ea5ef --- /dev/null +++ b/website/docs/cdktf/python/d/db_parameter_group.html.markdown @@ -0,0 +1,49 @@ +--- +subcategory: "RDS (Relational Database)" +layout: "aws" +page_title: "AWS: aws_db_parameter_group" +description: |- + Information about a database parameter group. +--- + + + +# Data Source: aws_db_parameter_group + +Information about a database parameter group. + +## 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_db_parameter_group import DataAwsDbParameterGroup +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + DataAwsDbParameterGroup(self, "test", + name="default.postgres15" + ) +``` + +## Argument Reference + +This data source supports the following arguments: + +* `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). +* `name` - (Required) DB parameter group name. + +## Attribute Reference + +This data source exports the following attributes in addition to the arguments above: + +* `arn` - ARN of the parameter group. +* `family` - Family of the parameter group. +* `description` - Description of the parameter group. + + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/db_proxy.html.markdown b/website/docs/cdktf/python/d/db_proxy.html.markdown index 5232e08bd783..7d225219b526 100644 --- a/website/docs/cdktf/python/d/db_proxy.html.markdown +++ b/website/docs/cdktf/python/d/db_proxy.html.markdown @@ -35,6 +35,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `name` - (Required) Name of the DB proxy. ## Attribute Reference @@ -53,4 +54,4 @@ This data source exports the following attributes in addition to the arguments a * `vpc_security_group_ids` - Provides a list of VPC security groups that the proxy belongs to. * `vpc_subnet_ids` - EC2 subnet IDs for the proxy. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/db_snapshot.html.markdown b/website/docs/cdktf/python/d/db_snapshot.html.markdown index a6442da6e040..177d134b443f 100644 --- a/website/docs/cdktf/python/d/db_snapshot.html.markdown +++ b/website/docs/cdktf/python/d/db_snapshot.html.markdown @@ -60,6 +60,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `most_recent` - (Optional) If more than one result is returned, use the most recent Snapshot. * `db_instance_identifier` - (Optional) Returns the list of snapshots created by the specific db_instance @@ -100,4 +101,4 @@ This data source exports the following attributes in addition to the arguments a * `snapshot_create_time` - Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC). Changes for the copy when the snapshot is copied. * `original_snapshot_create_time` - Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC). Doesn't change when the snapshot is copied. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/db_subnet_group.html.markdown b/website/docs/cdktf/python/d/db_subnet_group.html.markdown index 6cb2610c3768..81d0ab6b7d6f 100644 --- a/website/docs/cdktf/python/d/db_subnet_group.html.markdown +++ b/website/docs/cdktf/python/d/db_subnet_group.html.markdown @@ -35,6 +35,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `name` - (Required) Name of the RDS database subnet group. ## Attribute Reference @@ -48,4 +49,4 @@ This data source exports the following attributes in addition to the arguments a * `supported_network_types` - The network type of the DB subnet group. * `vpc_id` - Provides the VPC ID of the DB subnet group. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/devopsguru_notification_channel.html.markdown b/website/docs/cdktf/python/d/devopsguru_notification_channel.html.markdown index a747d78babed..3a283b6f19cf 100644 --- a/website/docs/cdktf/python/d/devopsguru_notification_channel.html.markdown +++ b/website/docs/cdktf/python/d/devopsguru_notification_channel.html.markdown @@ -35,8 +35,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `id` - (Required) Unique identifier for the notification channel. ## Attribute Reference @@ -55,4 +56,4 @@ This data source exports the following attributes in addition to the arguments a * `message_types` - Events to receive notifications for. * `severities` - Severity levels to receive notifications for. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/devopsguru_resource_collection.html.markdown b/website/docs/cdktf/python/d/devopsguru_resource_collection.html.markdown index 3a899b7c6128..0384f5bc6937 100644 --- a/website/docs/cdktf/python/d/devopsguru_resource_collection.html.markdown +++ b/website/docs/cdktf/python/d/devopsguru_resource_collection.html.markdown @@ -35,8 +35,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `type` - (Required) Type of AWS resource collection to create. Valid values are `AWS_CLOUD_FORMATION`, `AWS_SERVICE`, and `AWS_TAGS`. ## Attribute Reference @@ -56,4 +57,4 @@ This data source exports the following attributes in addition to the arguments a * `app_boundary_key` - An AWS tag key that is used to identify the AWS resources that DevOps Guru analyzes. * `tag_values` - Array of tag values. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/directory_service_directory.html.markdown b/website/docs/cdktf/python/d/directory_service_directory.html.markdown index 01091cef20e7..70994172f82e 100644 --- a/website/docs/cdktf/python/d/directory_service_directory.html.markdown +++ b/website/docs/cdktf/python/d/directory_service_directory.html.markdown @@ -35,6 +35,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `directory_id` - (Required) ID of the directory. ## Attribute Reference @@ -53,7 +54,7 @@ This data source exports the following attributes in addition to the arguments a * `access_url` - Access URL for the directory/connector, such as http://alias.awsapps.com. * `dns_ip_addresses` - List of IP addresses of the DNS servers for the directory/connector. * `security_group_id` - ID of the security group created by the directory/connector. -* `tags` – A map of tags assigned to the directory/connector. +* `tags` - A map of tags assigned to the directory/connector. `vpc_settings` (for `SimpleAD` and `MicrosoftAD`) is also exported with the following attributes: @@ -78,4 +79,4 @@ This data source exports the following attributes in addition to the arguments a * `radius_timeout` - Amount of time, in seconds, to wait for the RADIUS server to respond. * `use_same_username` - Not currently used. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/dms_certificate.html.markdown b/website/docs/cdktf/python/d/dms_certificate.html.markdown index b9910fbb24b5..3818714f7f6d 100644 --- a/website/docs/cdktf/python/d/dms_certificate.html.markdown +++ b/website/docs/cdktf/python/d/dms_certificate.html.markdown @@ -35,8 +35,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `certificate_id` - (Required) A customer-assigned name for the certificate. Identifiers must begin with a letter and must contain only ASCII letters, digits, and hyphens. They can't end with a hyphen or contain two consecutive hyphens. ## Attribute Reference @@ -53,4 +54,4 @@ This data source exports the following attributes in addition to the arguments a * `valid_from_date` - The beginning date that the certificate is valid. * `valid_to_date` - The final date that the certificate is valid. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/dms_endpoint.html.markdown b/website/docs/cdktf/python/d/dms_endpoint.html.markdown index e0d1e4fbca9f..5b27fd406a03 100644 --- a/website/docs/cdktf/python/d/dms_endpoint.html.markdown +++ b/website/docs/cdktf/python/d/dms_endpoint.html.markdown @@ -37,6 +37,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `endpoint_id` - (Required) Database endpoint identifier. Identifiers must contain from 1 to 255 alphanumeric characters or hyphens, begin with a letter, contain only ASCII letters, digits, and hyphens, not end with a hyphen, and not contain two consecutive hyphens. ## Attribute Reference @@ -45,4 +46,4 @@ This data source exports the following attributes in addition to the arguments a See the [`aws_dms_endpoint` resource](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/dms_endpoint) for details on the returned attributes - they are identical. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/dms_replication_instance.html.markdown b/website/docs/cdktf/python/d/dms_replication_instance.html.markdown index 40763b59b882..335a698f89bf 100644 --- a/website/docs/cdktf/python/d/dms_replication_instance.html.markdown +++ b/website/docs/cdktf/python/d/dms_replication_instance.html.markdown @@ -33,8 +33,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `replication_instance_id` - (Required) The replication instance identifier. ## Attribute Reference @@ -57,4 +58,4 @@ This data source exports the following attributes in addition to the arguments a * `replication_subnet_group_id` - A subnet group to associate with the replication instance. * `vpc_security_group_ids` - A set of VPC security group IDs that are used with the replication instance. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/dms_replication_subnet_group.html.markdown b/website/docs/cdktf/python/d/dms_replication_subnet_group.html.markdown index f7c15bafeff8..0666c4254a6a 100644 --- a/website/docs/cdktf/python/d/dms_replication_subnet_group.html.markdown +++ b/website/docs/cdktf/python/d/dms_replication_subnet_group.html.markdown @@ -35,8 +35,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `replication_subnet_group_id` - (Required) Name for the replication subnet group. This value is stored as a lowercase string. It must contain no more than 255 alphanumeric characters, periods, spaces, underscores, or hyphens and cannot be `default`. ## Attribute Reference @@ -47,4 +48,4 @@ This data source exports the following attributes in addition to the arguments a * `subnet_ids` - List of at least 2 EC2 subnet IDs for the subnet group. The subnets must cover at least 2 availability zones. * `vpc_id` - The ID of the VPC the subnet group is in. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/dms_replication_task.html.markdown b/website/docs/cdktf/python/d/dms_replication_task.html.markdown index 17f81c79e58a..17db0d8cbdea 100644 --- a/website/docs/cdktf/python/d/dms_replication_task.html.markdown +++ b/website/docs/cdktf/python/d/dms_replication_task.html.markdown @@ -35,15 +35,11 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `replication_task_id` - (Required) The replication task identifier. - - Must contain from 1 to 255 alphanumeric characters or hyphens. - - First character must be a letter. - - Cannot end with a hyphen. - - Cannot contain two consecutive hyphens. - ## Attribute Reference This data source exports the following attributes in addition to the arguments above: @@ -60,4 +56,4 @@ This data source exports the following attributes in addition to the arguments a * `target_endpoint_arn` - The Amazon Resource Name (ARN) string that uniquely identifies the target endpoint. * `replication_task_arn` - The Amazon Resource Name (ARN) for the replication task. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/docdb_engine_version.html.markdown b/website/docs/cdktf/python/d/docdb_engine_version.html.markdown index 30a9a2322c12..4f6b754fe57b 100644 --- a/website/docs/cdktf/python/d/docdb_engine_version.html.markdown +++ b/website/docs/cdktf/python/d/docdb_engine_version.html.markdown @@ -35,6 +35,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `engine` - (Optional) DB engine. (Default: `docdb`) * `parameter_group_family` - (Optional) Name of a specific DB parameter group family. An example parameter group family is `docdb3.6`. * `preferred_versions` - (Optional) Ordered list of preferred engine versions. The first match in this list will be returned. If no preferred matches are found and the original search returned more than one result, an error is returned. If both the `version` and `preferred_versions` arguments are not configured, the data source will return the default version for the engine. @@ -50,4 +51,4 @@ This data source exports the following attributes in addition to the arguments a * `valid_upgrade_targets` - A set of engine versions that this database engine version can be upgraded to. * `version_description` - Description of the database engine version. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/docdb_orderable_db_instance.html.markdown b/website/docs/cdktf/python/d/docdb_orderable_db_instance.html.markdown index e5e0b6c88573..d3e2f4e2f791 100644 --- a/website/docs/cdktf/python/d/docdb_orderable_db_instance.html.markdown +++ b/website/docs/cdktf/python/d/docdb_orderable_db_instance.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `engine` - (Optional) DB engine. Default: `docdb` * `engine_version` - (Optional) Version of the DB engine. * `instance_class` - (Optional) DB instance class. Examples of classes are `db.r5.12xlarge`, `db.r5.24xlarge`, `db.r5.2xlarge`, `db.r5.4xlarge`, `db.r5.large`, `db.r5.xlarge`, and `db.t3.medium`. (Conflicts with `preferred_instance_classes`.) @@ -51,4 +52,4 @@ This data source exports the following attributes in addition to the arguments a * `availability_zones` - Availability zones where the instance is available. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/dx_connection.html.markdown b/website/docs/cdktf/python/d/dx_connection.html.markdown index d976630ca88c..d64d96df1b3a 100644 --- a/website/docs/cdktf/python/d/dx_connection.html.markdown +++ b/website/docs/cdktf/python/d/dx_connection.html.markdown @@ -35,6 +35,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `name` - (Required) Name of the connection to retrieve. ## Attribute Reference @@ -53,4 +54,4 @@ This data source exports the following attributes in addition to the arguments a * `tags` - Map of tags for the resource. * `vlan_id` - The VLAN ID. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/dx_location.html.markdown b/website/docs/cdktf/python/d/dx_location.html.markdown index d210ee0d89aa..301d6981f3e7 100644 --- a/website/docs/cdktf/python/d/dx_location.html.markdown +++ b/website/docs/cdktf/python/d/dx_location.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `location_code` - (Required) Code for the location to retrieve. ## Attribute Reference @@ -49,4 +50,4 @@ This data source exports the following attributes in addition to the arguments a * `available_providers` - Names of the service providers for the location. * `location_name` - Name of the location. This includes the name of the colocation partner and the physical site of the building. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/dx_locations.html.markdown b/website/docs/cdktf/python/d/dx_locations.html.markdown index 546cb6f52353..0875ea1e944b 100644 --- a/website/docs/cdktf/python/d/dx_locations.html.markdown +++ b/website/docs/cdktf/python/d/dx_locations.html.markdown @@ -34,7 +34,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -This data source does not support any arguments. +This data source supports the following arguments: + +* `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). ## Attribute Reference @@ -42,4 +44,4 @@ This data source exports the following attributes in addition to the arguments a * `location_codes` - Code for the locations. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/dx_router_configuration.html.markdown b/website/docs/cdktf/python/d/dx_router_configuration.html.markdown index a07de6d8eee7..47d9b95ebc85 100644 --- a/website/docs/cdktf/python/d/dx_router_configuration.html.markdown +++ b/website/docs/cdktf/python/d/dx_router_configuration.html.markdown @@ -36,8 +36,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -This resource supports the following arguments: +This data source supports the following arguments: +* `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). * `virtual_interface_id` - (Required) ID of the Direct Connect Virtual Interface * `router_type_identifier` - (Required) ID of the Router Type. For example: `CiscoSystemsInc-2900SeriesRouters-IOS124` @@ -74,4 +75,4 @@ A `router` block supports the following attributes: * `xslt_template_name` - Router XSLT Template Name * `xslt_template_name_for_mac` - Router XSLT Template Name for MacSec - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/dynamodb_table.html.markdown b/website/docs/cdktf/python/d/dynamodb_table.html.markdown index 4f19bda5bd87..26198cb64540 100644 --- a/website/docs/cdktf/python/d/dynamodb_table.html.markdown +++ b/website/docs/cdktf/python/d/dynamodb_table.html.markdown @@ -35,6 +35,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `name` - (Required) Name of the DynamoDB table. ## Attribute Reference @@ -44,4 +45,4 @@ This data source exports the following attributes in addition to the arguments a See the [DynamoDB Table Resource](/docs/providers/aws/r/dynamodb_table.html) for details on the returned attributes - they are identical. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/dynamodb_table_item.html.markdown b/website/docs/cdktf/python/d/dynamodb_table_item.html.markdown index 42cc09349a0d..8a9b9f4f69d6 100644 --- a/website/docs/cdktf/python/d/dynamodb_table_item.html.markdown +++ b/website/docs/cdktf/python/d/dynamodb_table_item.html.markdown @@ -49,6 +49,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `expression_attribute_name` - (Optional) - One or more substitution tokens for attribute names in an expression. Use the `#` character in an expression to dereference an attribute name. * `projection_expression` - (Optional) A string that identifies one or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas. If no attribute names are specified, then all attributes are returned. If any of the requested attributes are not found, they do not appear in the result. @@ -59,4 +60,4 @@ This data source exports the following attributes in addition to the arguments a * `item` - JSON representation of a map of attribute names to [AttributeValue](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_AttributeValue.html) objects, as specified by ProjectionExpression. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/dynamodb_tables.html.markdown b/website/docs/cdktf/python/d/dynamodb_tables.html.markdown index effd3eb3257d..1539a3a5c33a 100644 --- a/website/docs/cdktf/python/d/dynamodb_tables.html.markdown +++ b/website/docs/cdktf/python/d/dynamodb_tables.html.markdown @@ -24,7 +24,7 @@ from cdktf import TerraformOutput, TerraformStack # Provider bindings are generated by running `cdktf get`. # See https://cdk.tf/provider-generation for more details. # -from imports.aws. import DataAwsDynamodbTables +from imports.aws.data_aws_dynamodb_tables import DataAwsDynamodbTables class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) @@ -36,7 +36,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -This data source does not support any arguments. +This data source supports the following arguments: + +* `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). ## Attribute Reference @@ -44,4 +46,4 @@ This data source exports the following attributes in addition to the arguments a * `names` - A list of all the DynamoDB table names found. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/ebs_default_kms_key.html.markdown b/website/docs/cdktf/python/d/ebs_default_kms_key.html.markdown index 98c9f2c2b984..bd191c2b7054 100644 --- a/website/docs/cdktf/python/d/ebs_default_kms_key.html.markdown +++ b/website/docs/cdktf/python/d/ebs_default_kms_key.html.markdown @@ -37,7 +37,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -This data source does not support any arguments. +This data source supports the following arguments: + +* `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). ## Attribute Reference @@ -52,4 +54,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/ebs_encryption_by_default.html.markdown b/website/docs/cdktf/python/d/ebs_encryption_by_default.html.markdown index 9036e7e382b4..5493827dfbbb 100644 --- a/website/docs/cdktf/python/d/ebs_encryption_by_default.html.markdown +++ b/website/docs/cdktf/python/d/ebs_encryption_by_default.html.markdown @@ -31,7 +31,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -This data source does not support any arguments. +This data source supports the following arguments: + +* `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). ## Attribute Reference @@ -46,4 +48,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/ebs_snapshot.html.markdown b/website/docs/cdktf/python/d/ebs_snapshot.html.markdown index 43986c13734c..5ecbb9b3545c 100644 --- a/website/docs/cdktf/python/d/ebs_snapshot.html.markdown +++ b/website/docs/cdktf/python/d/ebs_snapshot.html.markdown @@ -44,17 +44,12 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `most_recent` - (Optional) If more than one result is returned, use the most recent snapshot. - * `owners` - (Optional) Returns the snapshots owned by the specified owner id. Multiple owners can be specified. - * `snapshot_ids` - (Optional) Returns information on a specific snapshot_id. - * `restorable_by_user_ids` - (Optional) One or more AWS accounts IDs that can create volumes from the snapshot. - -* `filter` - (Optional) One or more name/value pairs to filter off of. There are -several valid keys, for a full reference, check out -[describe-snapshots in the AWS CLI reference][1]. +* `filter` - (Optional) One or more name/value pairs to filter off of. There are several valid keys, for a full reference, check out [describe-snapshots in the AWS CLI reference][1]. ## Attribute Reference @@ -85,4 +80,4 @@ This data source exports the following attributes in addition to the arguments a [1]: http://docs.aws.amazon.com/cli/latest/reference/ec2/describe-snapshots.html - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/ebs_snapshot_ids.html.markdown b/website/docs/cdktf/python/d/ebs_snapshot_ids.html.markdown index 5033fa6d9c20..cb68c081e20b 100644 --- a/website/docs/cdktf/python/d/ebs_snapshot_ids.html.markdown +++ b/website/docs/cdktf/python/d/ebs_snapshot_ids.html.markdown @@ -44,13 +44,10 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `owners` - (Optional) Returns the snapshots owned by the specified owner id. Multiple owners can be specified. - * `restorable_by_user_ids` - (Optional) One or more AWS accounts IDs that can create volumes from the snapshot. - -* `filter` - (Optional) One or more name/value pairs to filter off of. There are -several valid keys, for a full reference, check out -[describe-volumes in the AWS CLI reference][1]. +* `filter` - (Optional) One or more name/value pairs to filter off of. There are several valid keys, for a full reference, check out [describe-volumes in the AWS CLI reference][1]. ## Attribute Reference @@ -67,4 +64,4 @@ This data source exports the following attributes in addition to the arguments a [1]: http://docs.aws.amazon.com/cli/latest/reference/ec2/describe-snapshots.html - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/ebs_volume.html.markdown b/website/docs/cdktf/python/d/ebs_volume.html.markdown index c4d330cd9cab..0016f04830ea 100644 --- a/website/docs/cdktf/python/d/ebs_volume.html.markdown +++ b/website/docs/cdktf/python/d/ebs_volume.html.markdown @@ -44,6 +44,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `filter` - (Optional) One or more name/value pairs to filter off of. There are several valid keys, for a full reference, check out [describe-volumes in the AWS CLI reference][1]. @@ -69,6 +70,7 @@ This data source exports the following attributes in addition to the arguments a * `throughput` - Throughput that the volume supports, in MiB/s. * `volume_id` - Volume ID (e.g., vol-59fcb34e). * `volume_type` - Type of EBS volume. +* `volume_initialization_rate` - EBS provisioned rate for volume initialization, in MiB/s, at which to download the snapshot blocks from Amazon S3 to the volume. ## Timeouts @@ -78,4 +80,4 @@ This data source exports the following attributes in addition to the arguments a [1]: http://docs.aws.amazon.com/cli/latest/reference/ec2/describe-volumes.html - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/ebs_volumes.html.markdown b/website/docs/cdktf/python/d/ebs_volumes.html.markdown index ede054265ab1..1d138ed52023 100644 --- a/website/docs/cdktf/python/d/ebs_volumes.html.markdown +++ b/website/docs/cdktf/python/d/ebs_volumes.html.markdown @@ -61,6 +61,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `filter` - (Optional) Custom filter block as described below. * `tags` - (Optional) Map of tags, each pair of which must exactly match a pair on the desired volumes. @@ -110,4 +111,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/ec2_capacity_block_offering.html.markdown b/website/docs/cdktf/python/d/ec2_capacity_block_offering.html.markdown index 608a074a61d8..290b8f8c421c 100644 --- a/website/docs/cdktf/python/d/ec2_capacity_block_offering.html.markdown +++ b/website/docs/cdktf/python/d/ec2_capacity_block_offering.html.markdown @@ -37,8 +37,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -This resource supports the following arguments: +This data source supports the following arguments: +* `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). * `capacity_duration_hours` - (Required) The amount of time of the Capacity Block reservation in hours. * `end_date_range` - (Optional) The date and time at which the Capacity Block Reservation expires. When a Capacity Reservation expires, the reserved capacity is released and you can no longer launch instances into it. Valid values: [RFC3339 time string](https://tools.ietf.org/html/rfc3339#section-5.8) (`YYYY-MM-DDTHH:MM:SSZ`) * `instance_count` - (Required) The number of instances for which to reserve capacity. @@ -55,4 +56,4 @@ This resource exports the following attributes in addition to the arguments abov * `upfront_fee` - The total price to be paid up front. * `tenancy` - Indicates the tenancy of the Capacity Reservation. Specify either `default` or `dedicated`. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/ec2_client_vpn_endpoint.html.markdown b/website/docs/cdktf/python/d/ec2_client_vpn_endpoint.html.markdown index 04a0c3b9ec11..f6ecee46fa93 100644 --- a/website/docs/cdktf/python/d/ec2_client_vpn_endpoint.html.markdown +++ b/website/docs/cdktf/python/d/ec2_client_vpn_endpoint.html.markdown @@ -60,6 +60,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `client_vpn_endpoint_id` - (Optional) ID of the Client VPN endpoint. * `filter` - (Optional) One or more configuration blocks containing name-values filters. Detailed below. * `tags` - (Optional) Map of tags, each pair of which must exactly match a pair on the desired endpoint. @@ -87,12 +88,14 @@ This data source exports the following attributes in addition to the arguments a * `description` - Brief description of the endpoint. * `dns_name` - DNS name to be used by clients when connecting to the Client VPN endpoint. * `dns_servers` - Information about the DNS servers to be used for DNS resolution. +* `endpoint_ip_address_type` - IP address type for the Client VPN endpoint. * `security_group_ids` - IDs of the security groups for the target network associated with the Client VPN endpoint. * `self_service_portal` - Whether the self-service portal for the Client VPN endpoint is enabled. * `self_service_portal_url` - The URL of the self-service portal. * `server_certificate_arn` - The ARN of the server certificate. * `session_timeout_hours` - The maximum VPN session duration time in hours. * `split_tunnel` - Whether split-tunnel is enabled in the AWS Client VPN endpoint. +* `traffic_ip_address_type` - IP address type for traffic within the Client VPN tunnel. * `transport_protocol` - Transport protocol used by the Client VPN endpoint. * `vpc_id` - ID of the VPC associated with the Client VPN endpoint. * `vpn_port` - Port number for the Client VPN endpoint. @@ -103,4 +106,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/ec2_coip_pool.html.markdown b/website/docs/cdktf/python/d/ec2_coip_pool.html.markdown index 80ace3bd5591..d3d4e908a973 100644 --- a/website/docs/cdktf/python/d/ec2_coip_pool.html.markdown +++ b/website/docs/cdktf/python/d/ec2_coip_pool.html.markdown @@ -44,6 +44,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `local_gateway_route_table_id` - (Optional) Local Gateway Route Table Id assigned to desired COIP Pool * `pool_id` - (Optional) ID of the specific COIP Pool to retrieve. * `tags` - (Optional) Mapping of tags, each pair of which must exactly match @@ -75,4 +76,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/ec2_coip_pools.html.markdown b/website/docs/cdktf/python/d/ec2_coip_pools.html.markdown index 0fece79482d8..24d8e4480b6f 100644 --- a/website/docs/cdktf/python/d/ec2_coip_pools.html.markdown +++ b/website/docs/cdktf/python/d/ec2_coip_pools.html.markdown @@ -40,6 +40,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `tags` - (Optional) Mapping of tags, each pair of which must exactly match a pair on the desired aws_ec2_coip_pools. * `filter` - (Optional) Custom filter block as described below. @@ -65,4 +66,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/ec2_host.html.markdown b/website/docs/cdktf/python/d/ec2_host.html.markdown index 6f2640c9baf6..395a18f97e11 100644 --- a/website/docs/cdktf/python/d/ec2_host.html.markdown +++ b/website/docs/cdktf/python/d/ec2_host.html.markdown @@ -65,6 +65,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `filter` - (Optional) Configuration block. Detailed below. * `host_id` - (Optional) ID of the Dedicated Host. @@ -104,4 +105,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/ec2_instance_type.html.markdown b/website/docs/cdktf/python/d/ec2_instance_type.html.markdown index d7da6fc96794..a84fef3d3753 100644 --- a/website/docs/cdktf/python/d/ec2_instance_type.html.markdown +++ b/website/docs/cdktf/python/d/ec2_instance_type.html.markdown @@ -36,6 +36,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `instance_type` - (Required) Instance ## Attribute Reference @@ -142,4 +143,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/ec2_instance_type_offering.html.markdown b/website/docs/cdktf/python/d/ec2_instance_type_offering.html.markdown index ce0b0bc648af..eec452fe94a2 100644 --- a/website/docs/cdktf/python/d/ec2_instance_type_offering.html.markdown +++ b/website/docs/cdktf/python/d/ec2_instance_type_offering.html.markdown @@ -40,6 +40,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `filter` - (Optional) One or more configuration blocks containing name-values filters. See the [EC2 API Reference](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstanceTypeOfferings.html) for supported filters. Detailed below. * `location_type` - (Optional) Location type. Defaults to `region`. Valid values: `availability-zone`, `availability-zone-id`, and `region`. * `preferred_instance_types` - (Optional) Ordered list of preferred EC2 Instance Types. The first match in this list will be returned. If no preferred matches are found and the original search returned more than one result, an error is returned. @@ -62,4 +63,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/ec2_instance_type_offerings.html.markdown b/website/docs/cdktf/python/d/ec2_instance_type_offerings.html.markdown index 448552b802f2..0a2f3f0b7a12 100644 --- a/website/docs/cdktf/python/d/ec2_instance_type_offerings.html.markdown +++ b/website/docs/cdktf/python/d/ec2_instance_type_offerings.html.markdown @@ -43,6 +43,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `filter` - (Optional) One or more configuration blocks containing name-values filters. See the [EC2 API Reference](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstanceTypeOfferings.html) for supported filters. Detailed below. * `location_type` - (Optional) Location type. Defaults to `region`. Valid values: `availability-zone`, `availability-zone-id`, and `region`. @@ -68,4 +69,4 @@ Note that the indexes of Instance Type Offering instance types, locations and lo - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/ec2_instance_types.html.markdown b/website/docs/cdktf/python/d/ec2_instance_types.html.markdown index edb324c158f0..8d17ba582d1e 100644 --- a/website/docs/cdktf/python/d/ec2_instance_types.html.markdown +++ b/website/docs/cdktf/python/d/ec2_instance_types.html.markdown @@ -48,6 +48,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `filter` - (Optional) One or more configuration blocks containing name-values filters. See the [EC2 API Reference](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstanceTypes.html) for supported filters. Detailed below. ### filter Argument Reference @@ -68,4 +69,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/ec2_local_gateway.html.markdown b/website/docs/cdktf/python/d/ec2_local_gateway.html.markdown index 3e8ffeb6dfb5..1ad490e4c226 100644 --- a/website/docs/cdktf/python/d/ec2_local_gateway.html.markdown +++ b/website/docs/cdktf/python/d/ec2_local_gateway.html.markdown @@ -40,6 +40,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `filter` - (Optional) Custom filter block as described below. * `id` - (Optional) Id of the specific Local Gateway to retrieve. * `state` - (Optional) Current state of the desired Local Gateway. @@ -79,4 +80,4 @@ The following attributes are additionally exported: - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/ec2_local_gateway_route_table.html.markdown b/website/docs/cdktf/python/d/ec2_local_gateway_route_table.html.markdown index 177c8a5ce023..fe9e72a72eba 100644 --- a/website/docs/cdktf/python/d/ec2_local_gateway_route_table.html.markdown +++ b/website/docs/cdktf/python/d/ec2_local_gateway_route_table.html.markdown @@ -43,6 +43,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `local_gateway_route_table_id` - (Optional) Local Gateway Route Table Id assigned to desired local gateway route table * `local_gateway_id` - (Optional) ID of the specific local gateway route table to retrieve. * `outpost_arn` - (Optional) ARN of the Outpost the local gateway route table is associated with. @@ -73,4 +74,4 @@ This data source exports no additional attributes. - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/ec2_local_gateway_route_tables.html.markdown b/website/docs/cdktf/python/d/ec2_local_gateway_route_tables.html.markdown index 94bde1d043e5..6aa1092b7a2a 100644 --- a/website/docs/cdktf/python/d/ec2_local_gateway_route_tables.html.markdown +++ b/website/docs/cdktf/python/d/ec2_local_gateway_route_tables.html.markdown @@ -40,6 +40,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `tags` - (Optional) Mapping of tags, each pair of which must exactly match a pair on the desired local gateway route table. * `filter` - (Optional) Custom filter block as described below. @@ -66,4 +67,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/ec2_local_gateway_virtual_interface.html.markdown b/website/docs/cdktf/python/d/ec2_local_gateway_virtual_interface.html.markdown index 3f756b150d16..ed3b960b89c1 100644 --- a/website/docs/cdktf/python/d/ec2_local_gateway_virtual_interface.html.markdown +++ b/website/docs/cdktf/python/d/ec2_local_gateway_virtual_interface.html.markdown @@ -42,6 +42,7 @@ class MyConvertedCode(TerraformStack): The following arguments are optional: +* `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). * `filter` - (Optional) One or more configuration blocks containing name-values filters. See the [EC2 API Reference](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeLocalGatewayVirtualInterfaces.html) for supported filters. Detailed below. * `id` - (Optional) Identifier of EC2 Local Gateway Virtual Interface. * `tags` - (Optional) Key-value map of resource tags, each pair of which must exactly match a pair on the desired local gateway route table. @@ -70,4 +71,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/ec2_local_gateway_virtual_interface_group.html.markdown b/website/docs/cdktf/python/d/ec2_local_gateway_virtual_interface_group.html.markdown index 7567f1faa1ed..d3dc17de1012 100644 --- a/website/docs/cdktf/python/d/ec2_local_gateway_virtual_interface_group.html.markdown +++ b/website/docs/cdktf/python/d/ec2_local_gateway_virtual_interface_group.html.markdown @@ -35,6 +35,7 @@ class MyConvertedCode(TerraformStack): The following arguments are optional: +* `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). * `filter` - (Optional) One or more configuration blocks containing name-values filters. See the [EC2 API Reference](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeLocalGatewayVirtualInterfaceGroups.html) for supported filters. Detailed below. * `id` - (Optional) Identifier of EC2 Local Gateway Virtual Interface Group. * `local_gateway_id` - (Optional) Identifier of EC2 Local Gateway. @@ -59,4 +60,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/ec2_local_gateway_virtual_interface_groups.html.markdown b/website/docs/cdktf/python/d/ec2_local_gateway_virtual_interface_groups.html.markdown index 530a7e604957..bcdfdac2934c 100644 --- a/website/docs/cdktf/python/d/ec2_local_gateway_virtual_interface_groups.html.markdown +++ b/website/docs/cdktf/python/d/ec2_local_gateway_virtual_interface_groups.html.markdown @@ -33,6 +33,7 @@ class MyConvertedCode(TerraformStack): The following arguments are optional: +* `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). * `filter` - (Optional) One or more configuration blocks containing name-values filters. See the [EC2 API Reference](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeLocalGatewayVirtualInterfaceGroups.html) for supported filters. Detailed below. * `tags` - (Optional) Key-value map of resource tags, each pair of which must exactly match a pair on the desired local gateway route table. @@ -57,4 +58,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/ec2_local_gateways.html.markdown b/website/docs/cdktf/python/d/ec2_local_gateways.html.markdown index 9664639b8ab2..9fe859af9061 100644 --- a/website/docs/cdktf/python/d/ec2_local_gateways.html.markdown +++ b/website/docs/cdktf/python/d/ec2_local_gateways.html.markdown @@ -44,6 +44,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `tags` - (Optional) Mapping of tags, each pair of which must exactly match a pair on the desired local_gateways. * `filter` - (Optional) Custom filter block as described below. @@ -70,4 +71,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/ec2_managed_prefix_list.html.markdown b/website/docs/cdktf/python/d/ec2_managed_prefix_list.html.markdown index aeb57e5256e0..2f877f3f411a 100644 --- a/website/docs/cdktf/python/d/ec2_managed_prefix_list.html.markdown +++ b/website/docs/cdktf/python/d/ec2_managed_prefix_list.html.markdown @@ -32,7 +32,7 @@ class MyConvertedCode(TerraformStack): super().__init__(scope, name) current = DataAwsRegion(self, "current") DataAwsEc2ManagedPrefixList(self, "example", - name="com.amazonaws.${" + current.name + "}.dynamodb" + name="com.amazonaws.${" + current.region + "}.dynamodb" ) ``` @@ -63,6 +63,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `id` - (Optional) ID of the prefix list to select. * `name` - (Optional) Name of the prefix list to select. * `filter` - (Optional) Configuration block(s) for filtering. Detailed below. @@ -97,4 +98,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/ec2_managed_prefix_lists.html.markdown b/website/docs/cdktf/python/d/ec2_managed_prefix_lists.html.markdown index 71f26a213a8a..e10274ce9a7d 100644 --- a/website/docs/cdktf/python/d/ec2_managed_prefix_lists.html.markdown +++ b/website/docs/cdktf/python/d/ec2_managed_prefix_lists.html.markdown @@ -53,6 +53,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `filter` - (Optional) Custom filter block as described below. * `tags` - (Optional) Map of tags, each pair of which must exactly match a pair on the desired . @@ -78,4 +79,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/ec2_network_insights_analysis.html.markdown b/website/docs/cdktf/python/d/ec2_network_insights_analysis.html.markdown index 0a10774fba4a..5ab8e87dc573 100644 --- a/website/docs/cdktf/python/d/ec2_network_insights_analysis.html.markdown +++ b/website/docs/cdktf/python/d/ec2_network_insights_analysis.html.markdown @@ -35,6 +35,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `network_insights_analysis_id` - (Optional) ID of the Network Insights Analysis to select. * `filter` - (Optional) Configuration block(s) for filtering. Detailed below. @@ -66,4 +67,4 @@ This data source exports the following attributes in addition to the arguments a * `status_message` - Message to provide more context when the `status` is `failed`. * `warning_message` - Warning message. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/ec2_network_insights_path.html.markdown b/website/docs/cdktf/python/d/ec2_network_insights_path.html.markdown index d83ee592bc3c..e93d27373f25 100644 --- a/website/docs/cdktf/python/d/ec2_network_insights_path.html.markdown +++ b/website/docs/cdktf/python/d/ec2_network_insights_path.html.markdown @@ -35,6 +35,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `network_insights_path_id` - (Optional) ID of the Network Insights Path to select. * `filter` - (Optional) Configuration block(s) for filtering. Detailed below. @@ -66,4 +67,4 @@ This data source exports the following attributes in addition to the arguments a * `source_ip` - IP address of the AWS resource that is the source of the path. * `tags` - Map of tags assigned to the resource. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/ec2_public_ipv4_pool.html.markdown b/website/docs/cdktf/python/d/ec2_public_ipv4_pool.html.markdown index 9955fbfc571f..463a1eea97c1 100644 --- a/website/docs/cdktf/python/d/ec2_public_ipv4_pool.html.markdown +++ b/website/docs/cdktf/python/d/ec2_public_ipv4_pool.html.markdown @@ -35,8 +35,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `pool_id` - (Required) AWS resource IDs of a public IPv4 pool (as a string) for which this data source will fetch detailed information. ## Attribute Reference @@ -54,4 +55,4 @@ This data source exports the following attributes in addition to the arguments a * `total_address_count` - Total number of addresses in the pool. * `total_available_address_count` - Total number of available addresses in the pool. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/ec2_public_ipv4_pools.html.markdown b/website/docs/cdktf/python/d/ec2_public_ipv4_pools.html.markdown index 60be6e207ed2..36925dabf97e 100644 --- a/website/docs/cdktf/python/d/ec2_public_ipv4_pools.html.markdown +++ b/website/docs/cdktf/python/d/ec2_public_ipv4_pools.html.markdown @@ -58,6 +58,7 @@ class MyConvertedCode(TerraformStack): The following arguments are optional: +* `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). * `filter` - (Optional) Custom filter block as described below. * `tags` - (Optional) Map of tags, each pair of which must exactly match a pair on the desired pools. @@ -73,4 +74,4 @@ This data source exports the following attributes in addition to the arguments a * `pool_ids` - List of all the pool IDs found. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/ec2_serial_console_access.html.markdown b/website/docs/cdktf/python/d/ec2_serial_console_access.html.markdown index 6a3149a6b512..eb162a0848e7 100644 --- a/website/docs/cdktf/python/d/ec2_serial_console_access.html.markdown +++ b/website/docs/cdktf/python/d/ec2_serial_console_access.html.markdown @@ -31,7 +31,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -This data source does not support any arguments. +This data source supports the following arguments: + +* `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). ## Attribute Reference @@ -46,4 +48,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/ec2_spot_price.html.markdown b/website/docs/cdktf/python/d/ec2_spot_price.html.markdown index 89ef4f79ea72..5bef03fabe25 100644 --- a/website/docs/cdktf/python/d/ec2_spot_price.html.markdown +++ b/website/docs/cdktf/python/d/ec2_spot_price.html.markdown @@ -41,6 +41,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `instance_type` - (Optional) Type of instance for which to query Spot Price information. * `availability_zone` - (Optional) Availability zone in which to query Spot price information. * `filter` - (Optional) One or more configuration blocks containing name-values filters. See the [EC2 API Reference](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeSpotPriceHistory.html) for supported filters. Detailed below. @@ -64,4 +65,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/ec2_transit_gateway.html.markdown b/website/docs/cdktf/python/d/ec2_transit_gateway.html.markdown index 48178a22df76..5195ce00d3af 100644 --- a/website/docs/cdktf/python/d/ec2_transit_gateway.html.markdown +++ b/website/docs/cdktf/python/d/ec2_transit_gateway.html.markdown @@ -60,6 +60,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `filter` - (Optional) One or more configuration blocks containing name-values filters. Detailed below. * `id` - (Optional) Identifier of the EC2 Transit Gateway. @@ -95,4 +96,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/ec2_transit_gateway_attachment.html.markdown b/website/docs/cdktf/python/d/ec2_transit_gateway_attachment.html.markdown index 5a9e128467b1..ca7737f62109 100644 --- a/website/docs/cdktf/python/d/ec2_transit_gateway_attachment.html.markdown +++ b/website/docs/cdktf/python/d/ec2_transit_gateway_attachment.html.markdown @@ -42,6 +42,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `filter` - (Optional) One or more configuration blocks containing name-values filters. Detailed below. * `transit_gateway_attachment_id` - (Optional) ID of the attachment. @@ -65,4 +66,4 @@ This data source exports the following attributes in addition to the arguments a * `transit_gateway_id` - ID of the transit gateway. * `transit_gateway_owner_id` - The ID of the AWS account that owns the transit gateway. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/ec2_transit_gateway_attachments.html.markdown b/website/docs/cdktf/python/d/ec2_transit_gateway_attachments.html.markdown index 1014453f5a6f..069df2885063 100644 --- a/website/docs/cdktf/python/d/ec2_transit_gateway_attachments.html.markdown +++ b/website/docs/cdktf/python/d/ec2_transit_gateway_attachments.html.markdown @@ -56,6 +56,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `filter` - (Optional) One or more configuration blocks containing name-values filters. Detailed below. ### filter Argument Reference @@ -78,4 +79,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/ec2_transit_gateway_connect.html.markdown b/website/docs/cdktf/python/d/ec2_transit_gateway_connect.html.markdown index cf9e568ac543..0bc551a41c11 100644 --- a/website/docs/cdktf/python/d/ec2_transit_gateway_connect.html.markdown +++ b/website/docs/cdktf/python/d/ec2_transit_gateway_connect.html.markdown @@ -60,6 +60,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `filter` - (Optional) One or more configuration blocks containing name-values filters. Detailed below. * `transit_gateway_connect_id` - (Optional) Identifier of the EC2 Transit Gateway Connect. @@ -83,4 +84,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/ec2_transit_gateway_connect_peer.html.markdown b/website/docs/cdktf/python/d/ec2_transit_gateway_connect_peer.html.markdown index 2c95ac61597b..4f9182054c04 100644 --- a/website/docs/cdktf/python/d/ec2_transit_gateway_connect_peer.html.markdown +++ b/website/docs/cdktf/python/d/ec2_transit_gateway_connect_peer.html.markdown @@ -60,6 +60,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `filter` - (Optional) One or more configuration blocks containing name-values filters. Detailed below. * `transit_gateway_connect_peer_id` - (Optional) Identifier of the EC2 Transit Gateway Connect Peer. @@ -88,4 +89,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/ec2_transit_gateway_dx_gateway_attachment.html.markdown b/website/docs/cdktf/python/d/ec2_transit_gateway_dx_gateway_attachment.html.markdown index 720af43238ee..c80088133022 100644 --- a/website/docs/cdktf/python/d/ec2_transit_gateway_dx_gateway_attachment.html.markdown +++ b/website/docs/cdktf/python/d/ec2_transit_gateway_dx_gateway_attachment.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `transit_gateway_id` - (Optional) Identifier of the EC2 Transit Gateway. * `dx_gateway_id` - (Optional) Identifier of the Direct Connect Gateway. * `filter` - (Optional) Configuration block(s) for filtering. Detailed below. @@ -64,4 +65,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/ec2_transit_gateway_multicast_domain.html.markdown b/website/docs/cdktf/python/d/ec2_transit_gateway_multicast_domain.html.markdown index 2908d70de501..aec82a294168 100644 --- a/website/docs/cdktf/python/d/ec2_transit_gateway_multicast_domain.html.markdown +++ b/website/docs/cdktf/python/d/ec2_transit_gateway_multicast_domain.html.markdown @@ -60,6 +60,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `filter` - (Optional) One or more configuration blocks containing name-values filters. Detailed below. * `transit_gateway_multicast_domain_id` - (Optional) Identifier of the EC2 Transit Gateway Multicast Domain. @@ -100,4 +101,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/ec2_transit_gateway_peering_attachment.html.markdown b/website/docs/cdktf/python/d/ec2_transit_gateway_peering_attachment.html.markdown index abfecd2ef391..ddee860cf08e 100644 --- a/website/docs/cdktf/python/d/ec2_transit_gateway_peering_attachment.html.markdown +++ b/website/docs/cdktf/python/d/ec2_transit_gateway_peering_attachment.html.markdown @@ -60,6 +60,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `filter` - (Optional) One or more configuration blocks containing name-values filters. Detailed below. * `id` - (Optional) Identifier of the EC2 Transit Gateway Peering Attachment. * `tags` - (Optional) Mapping of tags, each pair of which must exactly match @@ -89,4 +90,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/ec2_transit_gateway_peering_attachments.html.markdown b/website/docs/cdktf/python/d/ec2_transit_gateway_peering_attachments.html.markdown index d3e6ad97a070..fc74b2c4967a 100644 --- a/website/docs/cdktf/python/d/ec2_transit_gateway_peering_attachments.html.markdown +++ b/website/docs/cdktf/python/d/ec2_transit_gateway_peering_attachments.html.markdown @@ -69,6 +69,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `filter` - (Optional) One or more configuration blocks containing name-values filters. Detailed below. ### filter Argument Reference @@ -91,4 +92,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/ec2_transit_gateway_route_table.html.markdown b/website/docs/cdktf/python/d/ec2_transit_gateway_route_table.html.markdown index ae8c4d40df6b..1dc908d3d152 100644 --- a/website/docs/cdktf/python/d/ec2_transit_gateway_route_table.html.markdown +++ b/website/docs/cdktf/python/d/ec2_transit_gateway_route_table.html.markdown @@ -63,6 +63,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `filter` - (Optional) One or more configuration blocks containing name-values filters. Detailed below. * `id` - (Optional) Identifier of the EC2 Transit Gateway Route Table. @@ -88,4 +89,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/ec2_transit_gateway_route_table_associations.html.markdown b/website/docs/cdktf/python/d/ec2_transit_gateway_route_table_associations.html.markdown index d1dc9a49aa42..023b4679d974 100644 --- a/website/docs/cdktf/python/d/ec2_transit_gateway_route_table_associations.html.markdown +++ b/website/docs/cdktf/python/d/ec2_transit_gateway_route_table_associations.html.markdown @@ -41,6 +41,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `filter` - (Optional) Custom filter block as described below. More complex filters can be expressed using one or more `filter` sub-blocks, @@ -59,4 +60,4 @@ This data source exports the following attributes in addition to the arguments a * `id` - AWS Region. * `ids` - Set of Transit Gateway Route Table Association identifiers. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/ec2_transit_gateway_route_table_propagations.html.markdown b/website/docs/cdktf/python/d/ec2_transit_gateway_route_table_propagations.html.markdown index 9ef4c5a4bfe7..cd29a4720a8d 100644 --- a/website/docs/cdktf/python/d/ec2_transit_gateway_route_table_propagations.html.markdown +++ b/website/docs/cdktf/python/d/ec2_transit_gateway_route_table_propagations.html.markdown @@ -37,6 +37,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `transit_gateway_route_table_id` - (Required) Identifier of EC2 Transit Gateway Route Table. * `filter` - (Optional) Custom filter block as described below. @@ -56,4 +57,4 @@ This data source exports the following attributes in addition to the arguments a * `id` - AWS Region. * `ids` - Set of Transit Gateway Route Table Association identifiers. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/ec2_transit_gateway_route_table_routes.html.markdown b/website/docs/cdktf/python/d/ec2_transit_gateway_route_table_routes.html.markdown index daee72259f27..ef9533e731df 100644 --- a/website/docs/cdktf/python/d/ec2_transit_gateway_route_table_routes.html.markdown +++ b/website/docs/cdktf/python/d/ec2_transit_gateway_route_table_routes.html.markdown @@ -255,6 +255,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `filter` - (Required) Custom filter block as described below. * `transit_gateway_route_table_id` - (Required) Identifier of EC2 Transit Gateway Route Table. @@ -280,4 +281,4 @@ This data source exports the following attributes in addition to the arguments a * `transit_gateway_route_table_announcement_id` - The id of the transit gateway route table announcement, most of the time it is an empty string. * `type` - The type of the route, can be `propagated` or `static`. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/ec2_transit_gateway_route_tables.html.markdown b/website/docs/cdktf/python/d/ec2_transit_gateway_route_tables.html.markdown index 0d9a033c7c7d..af48d9190640 100644 --- a/website/docs/cdktf/python/d/ec2_transit_gateway_route_tables.html.markdown +++ b/website/docs/cdktf/python/d/ec2_transit_gateway_route_tables.html.markdown @@ -40,8 +40,8 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `filter` - (Optional) Custom filter block as described below. - * `tags` - (Optional) Mapping of tags, each pair of which must exactly match a pair on the desired transit gateway route table. @@ -50,7 +50,6 @@ which take the following arguments: * `name` - (Required) Name of the field to filter by, as defined by [the underlying AWS API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeTransitGatewayRouteTables.html). - * `values` - (Required) Set of values that are accepted for the given field. A Transit Gateway Route Table will be selected if any one of the given values matches. @@ -67,4 +66,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/ec2_transit_gateway_vpc_attachment.html.markdown b/website/docs/cdktf/python/d/ec2_transit_gateway_vpc_attachment.html.markdown index 015eb40f28ca..735d4497888b 100644 --- a/website/docs/cdktf/python/d/ec2_transit_gateway_vpc_attachment.html.markdown +++ b/website/docs/cdktf/python/d/ec2_transit_gateway_vpc_attachment.html.markdown @@ -60,6 +60,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `filter` - (Optional) One or more configuration blocks containing name-values filters. Detailed below. * `id` - (Optional) Identifier of the EC2 Transit Gateway VPC Attachment. @@ -90,4 +91,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/ec2_transit_gateway_vpc_attachments.html.markdown b/website/docs/cdktf/python/d/ec2_transit_gateway_vpc_attachments.html.markdown index 528ac2f1c814..d16430112a16 100644 --- a/website/docs/cdktf/python/d/ec2_transit_gateway_vpc_attachments.html.markdown +++ b/website/docs/cdktf/python/d/ec2_transit_gateway_vpc_attachments.html.markdown @@ -52,6 +52,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `filter` - (Optional) One or more configuration blocks containing name-values filters. Detailed below. ### filter Argument Reference @@ -74,4 +75,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/ec2_transit_gateway_vpn_attachment.html.markdown b/website/docs/cdktf/python/d/ec2_transit_gateway_vpn_attachment.html.markdown index b7a6809e5e41..9d77f1adef18 100644 --- a/website/docs/cdktf/python/d/ec2_transit_gateway_vpn_attachment.html.markdown +++ b/website/docs/cdktf/python/d/ec2_transit_gateway_vpn_attachment.html.markdown @@ -63,6 +63,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `transit_gateway_id` - (Optional) Identifier of the EC2 Transit Gateway. * `vpn_connection_id` - (Optional) Identifier of the EC2 VPN Connection. * `filter` - (Optional) Configuration block(s) for filtering. Detailed below. @@ -88,4 +89,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/ecr_authorization_token.html.markdown b/website/docs/cdktf/python/d/ecr_authorization_token.html.markdown index 5da56c713aef..81a80048b5e3 100644 --- a/website/docs/cdktf/python/d/ecr_authorization_token.html.markdown +++ b/website/docs/cdktf/python/d/ecr_authorization_token.html.markdown @@ -33,6 +33,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `registry_id` - (Optional) AWS account ID of the ECR Repository. If not specified the default account is assumed. ## Attribute Reference @@ -46,4 +47,4 @@ This data source exports the following attributes in addition to the arguments a * `proxy_endpoint` - Registry URL to use in the docker login command. * `user_name` - User name decoded from the authorization token. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/ecr_image.html.markdown b/website/docs/cdktf/python/d/ecr_image.html.markdown index 797a82a90d89..5274900df8c5 100644 --- a/website/docs/cdktf/python/d/ecr_image.html.markdown +++ b/website/docs/cdktf/python/d/ecr_image.html.markdown @@ -36,6 +36,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `registry_id` - (Optional) ID of the Registry where the repository resides. * `repository_name` - (Required) Name of the ECR Repository. * `image_digest` - (Optional) Sha256 digest of the image manifest. At least one of `image_digest`, `image_tag`, or `most_recent` must be specified. @@ -52,4 +53,4 @@ This data source exports the following attributes in addition to the arguments a * `image_tags` - List of tags associated with this image. * `image_uri` - The URI for the specific image version specified by `image_tag` or `image_digest`. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/ecr_images.html.markdown b/website/docs/cdktf/python/d/ecr_images.html.markdown new file mode 100644 index 000000000000..2060120d64e2 --- /dev/null +++ b/website/docs/cdktf/python/d/ecr_images.html.markdown @@ -0,0 +1,56 @@ +--- +subcategory: "ECR (Elastic Container Registry)" +layout: "aws" +page_title: "AWS: aws_ecr_images" +description: |- + Provides a list of images for a specified ECR Repository +--- + + + +# Data Source: aws_ecr_images + +The ECR Images data source allows the list of images in a specified repository to be retrieved. + +## 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 TerraformOutput, TerraformStack +# +# Provider bindings are generated by running `cdktf get`. +# See https://cdk.tf/provider-generation for more details. +# +from imports.aws.data_aws_ecr_images import DataAwsEcrImages +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + example = DataAwsEcrImages(self, "example", + repository_name="my-repository" + ) + TerraformOutput(self, "image_digests", + value="${[ for img in ${" + example.image_ids + "} : img.image_digest if img.image_digest != null]}" + ) + TerraformOutput(self, "image_tags", + value="${[ for img in ${" + example.image_ids + "} : img.image_tag if img.image_tag != null]}" + ) +``` + +## Argument Reference + +This data source supports the following arguments: + +* `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). +* `registry_id` - (Optional) ID of the Registry where the repository resides. +* `repository_name` - (Required) Name of the ECR Repository. + +## Attribute Reference + +This data source exports the following attributes in addition to the arguments above: + +* `image_ids` - List of image objects containing image digest and tags. Each object has the following attributes: + * `image_digest` - The sha256 digest of the image manifest. + * `image_tag` - The tag associated with the image. + + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/ecr_pull_through_cache_rule.html.markdown b/website/docs/cdktf/python/d/ecr_pull_through_cache_rule.html.markdown index 40800a5803d4..159f970d671f 100644 --- a/website/docs/cdktf/python/d/ecr_pull_through_cache_rule.html.markdown +++ b/website/docs/cdktf/python/d/ecr_pull_through_cache_rule.html.markdown @@ -35,7 +35,8 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: -- `ecr_repository_prefix` - (Required) The repository name prefix to use when caching images from the source registry. +* `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). +* `ecr_repository_prefix` - (Required) The repository name prefix to use when caching images from the source registry. ## Attribute Reference @@ -48,4 +49,4 @@ This data source exports the following attributes in addition to the arguments a - `upstream_registry_url` - The registry URL of the upstream registry to use as the source. - `upstream_repository_prefix` - The upstream repository prefix associated with the pull through cache rule. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/ecr_repositories.html.markdown b/website/docs/cdktf/python/d/ecr_repositories.html.markdown index cbad8f5d9f6f..fbe0f4f6f1bf 100644 --- a/website/docs/cdktf/python/d/ecr_repositories.html.markdown +++ b/website/docs/cdktf/python/d/ecr_repositories.html.markdown @@ -33,7 +33,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -This data source does not support any arguments. +This data source supports the following arguments: + +* `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). ## Attribute Reference @@ -42,4 +44,4 @@ This data source exports the following attributes in addition to the arguments a * `id` - AWS Region. * `names` - A list if AWS Elastic Container Registries for the region. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/ecr_repository.html.markdown b/website/docs/cdktf/python/d/ecr_repository.html.markdown index 87c3da944fc0..48718261bc63 100644 --- a/website/docs/cdktf/python/d/ecr_repository.html.markdown +++ b/website/docs/cdktf/python/d/ecr_repository.html.markdown @@ -35,6 +35,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `name` - (Required) Name of the ECR Repository. * `registry_id` - (Optional) Registry ID where the repository was created. @@ -46,6 +47,7 @@ This data source exports the following attributes in addition to the arguments a * `encryption_configuration` - Encryption configuration for the repository. See [Encryption Configuration](#encryption-configuration) below. * `image_scanning_configuration` - Configuration block that defines image scanning configuration for the repository. See [Image Scanning Configuration](#image-scanning-configuration) below. * `image_tag_mutability` - The tag mutability setting for the repository. +* `image_tag_mutability_exclusion_filter` - Block that defines filters to specify which image tags can override the default tag mutability setting. * `most_recent_image_tags` - List of image tags associated with the most recently pushed image in the repository. * `repository_url` - URL of the repository (in the form `aws_account_id.dkr.ecr.region.amazonaws.com/repositoryName`). * `tags` - Map of tags assigned to the resource. @@ -55,8 +57,13 @@ This data source exports the following attributes in addition to the arguments a * `encryption_type` - Encryption type to use for the repository, either `AES256` or `KMS`. * `kms_key` - If `encryption_type` is `KMS`, the ARN of the KMS key used. +### Image Tag Mutability Exclusion Filter + +* `filter` - The filter pattern to use for excluding image tags from the mutability setting. +* `filter_type` - The type of filter to use. + ### Image Scanning Configuration * `scan_on_push` - Whether images are scanned after being pushed to the repository. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/ecr_repository_creation_template.html.markdown b/website/docs/cdktf/python/d/ecr_repository_creation_template.html.markdown index 3704d0314a58..de2126b4f1b8 100644 --- a/website/docs/cdktf/python/d/ecr_repository_creation_template.html.markdown +++ b/website/docs/cdktf/python/d/ecr_repository_creation_template.html.markdown @@ -35,6 +35,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `prefix` - (Required) The repository name prefix that the template matches against. ## Attribute Reference @@ -46,6 +47,7 @@ This data source exports the following attributes in addition to the arguments a * `description` - The description for this template. * `encryption_configuration` - Encryption configuration for any created repositories. See [Encryption Configuration](#encryption-configuration) below. * `image_tag_mutability` - The tag mutability setting for any created repositories. +* `image_tag_mutability_exclusion_filter` - Block that defines filters to specify which image tags can override the default tag mutability setting. * `lifecycle_policy` - The lifecycle policy document to apply to any created repositories. * `registry_id` - The registry ID the repository creation template applies to. * `repository_policy` - The registry policy document to apply to any created repositories. @@ -56,4 +58,9 @@ This data source exports the following attributes in addition to the arguments a * `encryption_type` - Encryption type to use for any created repositories, either `AES256` or `KMS`. * `kms_key` - If `encryption_type` is `KMS`, the ARN of the KMS key used. - \ No newline at end of file +### Image Tag Mutability Exclusion Filter + +* `filter` - The filter pattern to use for excluding image tags from the mutability setting. +* `filter_type` - The type of filter to use. + + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/ecrpublic_authorization_token.html.markdown b/website/docs/cdktf/python/d/ecrpublic_authorization_token.html.markdown index 5b319c881e95..1b2efef1ea4c 100644 --- a/website/docs/cdktf/python/d/ecrpublic_authorization_token.html.markdown +++ b/website/docs/cdktf/python/d/ecrpublic_authorization_token.html.markdown @@ -33,7 +33,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -This data source does not support any arguments. +This data source supports the following arguments: + +* `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). ## Attribute Reference @@ -45,4 +47,4 @@ This data source exports the following attributes in addition to the arguments a * `password` - Password decoded from the authorization token. * `user_name` - User name decoded from the authorization token. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/ecs_cluster.html.markdown b/website/docs/cdktf/python/d/ecs_cluster.html.markdown index 1d2bd71b2535..ecdcdccba62f 100644 --- a/website/docs/cdktf/python/d/ecs_cluster.html.markdown +++ b/website/docs/cdktf/python/d/ecs_cluster.html.markdown @@ -36,6 +36,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `cluster_name` - (Required) Name of the ECS Cluster ## Attribute Reference @@ -51,4 +52,4 @@ This data source exports the following attributes in addition to the arguments a * `setting` - Settings associated with the ECS Cluster * `tags` - Key-value map of resource tags - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/ecs_clusters.html.markdown b/website/docs/cdktf/python/d/ecs_clusters.html.markdown index a1266cedb562..770d9806b6d0 100644 --- a/website/docs/cdktf/python/d/ecs_clusters.html.markdown +++ b/website/docs/cdktf/python/d/ecs_clusters.html.markdown @@ -33,7 +33,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -This data source does not support any arguments. +This data source supports the following arguments: + +* `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). ## Attribute Reference @@ -41,4 +43,4 @@ This data source exports the following attributes in addition to the arguments a * `cluster_arns` - List of ECS cluster ARNs associated with the account. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/ecs_container_definition.html.markdown b/website/docs/cdktf/python/d/ecs_container_definition.html.markdown index 43547e91c2a1..8f7ae3133c57 100644 --- a/website/docs/cdktf/python/d/ecs_container_definition.html.markdown +++ b/website/docs/cdktf/python/d/ecs_container_definition.html.markdown @@ -37,6 +37,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `task_definition` - (Required) ARN of the task definition which contains the container * `container_name` - (Required) Name of the container definition @@ -53,4 +54,4 @@ This data source exports the following attributes in addition to the arguments a * `disable_networking` - Indicator if networking is disabled * `docker_labels` - Set docker labels - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/ecs_service.html.markdown b/website/docs/cdktf/python/d/ecs_service.html.markdown index dd44856b6225..02dd2c656a42 100644 --- a/website/docs/cdktf/python/d/ecs_service.html.markdown +++ b/website/docs/cdktf/python/d/ecs_service.html.markdown @@ -37,6 +37,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `service_name` - (Required) Name of the ECS Service * `cluster_arn` - (Required) ARN of the ECS Cluster @@ -47,8 +48,28 @@ This data source exports the following attributes in addition to the arguments a * `arn` - ARN of the ECS Service * `desired_count` - Number of tasks for the ECS Service * `launch_type` - Launch type for the ECS Service +* `load_balancer` - Load balancers for the ECS Service. See [`load_balancer` Block](#load_balancer-block) for details. * `scheduling_strategy` - Scheduling strategy for the ECS Service * `task_definition` - Family for the latest ACTIVE revision or full ARN of the task definition. * `tags` - Resource tags. - \ No newline at end of file +### `load_balancer` Block + +The `load_balancer` block exports the following attributes: + +* `advanced_configuration` - Settings for Blue/Green deployment. See [`advanced_configuration` Block](#advanced_configuration-block) for details. +* `container_name` - Name of the container to associate with the load balancer. +* `container_port` - Port on the container to associate with the load balancer. +* `elb_name` - Name of the load balancer. +* `target_group_arn` - ARN of the target group to associate with the load balancer. + +### `advanced_configuration` Block + +The `advanced_configuration` block exports the following attributes: + +* `alternate_target_group_arn` - ARN of the alternate target group to use for Blue/Green deployments. +* `production_listener_rule` - ARN of the listener rule that routes production traffic. +* `role_arn` - ARN of the IAM role that allows ECS to manage the target groups. +* `test_listener_rule` - ARN of the listener rule that routes test traffic. + + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/ecs_task_definition.html.markdown b/website/docs/cdktf/python/d/ecs_task_definition.html.markdown index a39fd5705fe6..302b6355ba7f 100644 --- a/website/docs/cdktf/python/d/ecs_task_definition.html.markdown +++ b/website/docs/cdktf/python/d/ecs_task_definition.html.markdown @@ -56,6 +56,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `task_definition` - (Required) Family for the latest ACTIVE revision, family and revision (family:revision) for a specific revision in the family, the ARN of the task definition to access to. ## Attribute Reference @@ -71,7 +72,6 @@ This data source exports the following attributes in addition to the arguments a * `execution_role_arn` - ARN of the task execution role that the Amazon ECS container agent and the Docker daemon can assume. * `family` - A unique name for your task definition. The following arguments are optional: -* `inference_accelerator` - Configuration block(s) with Inference Accelerators settings. [Detailed below.](#inference_accelerator) * `ipc_mode` - IPC resource namespace to be used for the containers in the task The valid values are `host`, `task`, and `none`. * `memory` - Amount (in MiB) of memory used by the task. If the `requires_compatibilities` is `FARGATE` this field is required. * `network_mode` - Docker networking mode to use for the containers in the task. Valid values are `none`, `bridge`, `awsvpc`, and `host`. @@ -89,11 +89,6 @@ The following arguments are optional: * `size_in_gib` - The total amount, in GiB, of ephemeral storage to set for the task. The minimum supported value is `21` GiB and the maximum supported value is `200` GiB. -### inference_accelerator - -* `device_name` - Elastic Inference accelerator device name. The deviceName must also be referenced in a container definition as a ResourceRequirement. -* `device_type` - Elastic Inference accelerator type to use. - ### placement_constraints * `expression` - Cluster Query Language expression to apply to the constraint. For more information, see [Cluster Query Language in the Amazon EC2 Container Service Developer Guide](http://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html). @@ -158,4 +153,4 @@ For more information, see [Specifying an FSX Windows File Server volume in your * `credentials_parameter` - The authorization credential option to use. The authorization credential options can be provided using either the Amazon Resource Name (ARN) of an AWS Secrets Manager secret or AWS Systems Manager Parameter Store parameter. The ARNs refer to the stored credentials. * `domain` - A fully qualified domain name hosted by an AWS Directory Service Managed Microsoft AD (Active Directory) or self-hosted AD on Amazon EC2. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/ecs_task_execution.html.markdown b/website/docs/cdktf/python/d/ecs_task_execution.html.markdown index a16a126a95f8..4eb1030a9456 100644 --- a/website/docs/cdktf/python/d/ecs_task_execution.html.markdown +++ b/website/docs/cdktf/python/d/ecs_task_execution.html.markdown @@ -52,6 +52,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `capacity_provider_strategy` - (Optional) Set of capacity provider strategies to use for the cluster. See below. * `client_token` - (Optional) An identifier that you provide to ensure the idempotency of the request. It must be unique and is case sensitive. Up to 64 characters are allowed. The valid characters are characters in the range of 33-126, inclusive. For more information, see [Ensuring idempotency](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/ECS_Idempotency.html). * `desired_count` - (Optional) Number of instantiations of the specified task to place on your cluster. You can specify up to 10 tasks for each call. @@ -88,7 +89,6 @@ For more information, see the [Task Networking](https://docs.aws.amazon.com/Amaz * `container_overrides` - (Optional) One or more container overrides that are sent to a task. See below. * `cpu` - (Optional) The CPU override for the task. * `execution_role_arn` - (Optional) Amazon Resource Name (ARN) of the task execution role override for the task. -* `inference_accelerator_overrides` - (Optional) **DEPRECATED** Elastic Inference accelerator override for the task. See below. * `memory` - (Optional) The memory override for the task. * `task_role_arn` - (Optional) Amazon Resource Name (ARN) of the role that containers in this task can assume. @@ -109,13 +109,8 @@ For more information, see the [Task Networking](https://docs.aws.amazon.com/Amaz ### resource_requirements -* `type` - (Required) The type of resource to assign to a container. Valid values are `GPU` or `InferenceAccelerator`. -* `value` - (Required) The value for the specified resource type. If the `GPU` type is used, the value is the number of physical GPUs the Amazon ECS container agent reserves for the container. The number of GPUs that's reserved for all containers in a task can't exceed the number of available GPUs on the container instance that the task is launched on. If the `InferenceAccelerator` type is used, the value matches the `deviceName` for an InferenceAccelerator specified in a task definition. - -### inference_accelerator_overrides - -* `device_name` - (Optional) The Elastic Inference accelerator device name to override for the task. This parameter must match a deviceName specified in the task definition. -* `device_type` - (Optional) The Elastic Inference accelerator type to use. +* `type` - (Required) The type of resource to assign to a container. Valid values are `GPU`. +* `value` - (Required) The value for the specified resource type. If the `GPU` type is used, the value is the number of physical GPUs the Amazon ECS container agent reserves for the container. The number of GPUs that's reserved for all containers in a task can't exceed the number of available GPUs on the container instance that the task is launched on. ### placement_constraints @@ -136,4 +131,4 @@ This data source exports the following attributes in addition to the arguments a * `task_arns` - A list of the provisioned task ARNs. * `id` - The unique identifier, which is a comma-delimited string joining the `cluster` and `task_definition` attributes. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/efs_access_point.html.markdown b/website/docs/cdktf/python/d/efs_access_point.html.markdown index 92dff5dc0876..f3efcd2c1ef3 100644 --- a/website/docs/cdktf/python/d/efs_access_point.html.markdown +++ b/website/docs/cdktf/python/d/efs_access_point.html.markdown @@ -35,6 +35,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `access_point_id` - (Required) ID that identifies the file system. ## Attribute Reference @@ -57,4 +58,4 @@ This data source exports the following attributes in addition to the arguments a * `path` - Path exposed as the root directory * `tags` - Key-value mapping of resource tags. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/efs_access_points.html.markdown b/website/docs/cdktf/python/d/efs_access_points.html.markdown index a42b558cf217..2e7a5d7d4f0e 100644 --- a/website/docs/cdktf/python/d/efs_access_points.html.markdown +++ b/website/docs/cdktf/python/d/efs_access_points.html.markdown @@ -35,6 +35,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `file_system_id` - (Required) EFS File System identifier. ## Attribute Reference @@ -45,4 +46,4 @@ This data source exports the following attributes in addition to the arguments a * `id` - EFS File System identifier. * `ids` - Set of identifiers. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/efs_file_system.html.markdown b/website/docs/cdktf/python/d/efs_file_system.html.markdown index 30fd124e15d0..941a4de770be 100644 --- a/website/docs/cdktf/python/d/efs_file_system.html.markdown +++ b/website/docs/cdktf/python/d/efs_file_system.html.markdown @@ -46,6 +46,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `file_system_id` - (Optional) ID that identifies the file system (e.g., fs-ccfc0d65). * `creation_token` - (Optional) Restricts the list to the file system with this creation token. * `tags` - (Optional) Restricts the list to the file system with these tags. @@ -68,4 +69,4 @@ This data source exports the following attributes in addition to the arguments a * `throughput_mode` - Throughput mode for the file system. * `size_in_bytes` - Current byte count used by the file system. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/efs_mount_target.html.markdown b/website/docs/cdktf/python/d/efs_mount_target.html.markdown index f06f0983c339..e94c19b06906 100644 --- a/website/docs/cdktf/python/d/efs_mount_target.html.markdown +++ b/website/docs/cdktf/python/d/efs_mount_target.html.markdown @@ -41,6 +41,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `access_point_id` - (Optional) ID or ARN of the access point whose mount target that you want to find. It must be included if a `file_system_id` and `mount_target_id` are not included. * `file_system_id` - (Optional) ID or ARN of the file system whose mount target that you want to find. It must be included if an `access_point_id` and `mount_target_id` are not included. * `mount_target_id` - (Optional) ID or ARN of the mount target that you want to find. It must be included in your request if an `access_point_id` and `file_system_id` are not included. @@ -52,6 +53,8 @@ This data source exports the following attributes in addition to the arguments a * `file_system_arn` - Amazon Resource Name of the file system for which the mount target is intended. * `subnet_id` - ID of the mount target's subnet. * `ip_address` - Address at which the file system may be mounted via the mount target. +* `ip_address_type` - IP address type for the mount target. +* `ipv6_address` - IPv6 address at which the file system may be mounted via the mount target. * `security_groups` - List of VPC security group IDs attached to the mount target. * `dns_name` - DNS name for the EFS file system. * `mount_target_dns_name` - The DNS name for the given subnet/AZ per [documented convention](http://docs.aws.amazon.com/efs/latest/ug/mounting-fs-mount-cmd-dns-name.html). @@ -60,4 +63,4 @@ This data source exports the following attributes in addition to the arguments a * `availability_zone_id` - The unique and consistent identifier of the Availability Zone (AZ) that the mount target resides in. * `owner_id` - AWS account ID that owns the resource. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/eip.html.markdown b/website/docs/cdktf/python/d/eip.html.markdown index f685371ba0d7..cecc306bb6c4 100644 --- a/website/docs/cdktf/python/d/eip.html.markdown +++ b/website/docs/cdktf/python/d/eip.html.markdown @@ -100,6 +100,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `filter` - (Optional) One or more name/value pairs to use as filters. There are several valid keys, for a full reference, check out the [EC2 API Reference](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeAddresses.html). * `id` - (Optional) Allocation ID of the specific VPC EIP to retrieve. If a classic EIP is required, do NOT set `id`, only set `public_ip` * `public_ip` - (Optional) Public IP of the specific EIP to retrieve. @@ -139,4 +140,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/eips.html.markdown b/website/docs/cdktf/python/d/eips.html.markdown index dadb23ae8941..87195e803c95 100644 --- a/website/docs/cdktf/python/d/eips.html.markdown +++ b/website/docs/cdktf/python/d/eips.html.markdown @@ -45,6 +45,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `filter` - (Optional) Custom filter block as described below. * `tags` - (Optional) Map of tags, each pair of which must exactly match a pair on the desired Elastic IPs. @@ -68,4 +69,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/eks_access_entry.html.markdown b/website/docs/cdktf/python/d/eks_access_entry.html.markdown index 253a5ff33479..199eddb8bdf1 100644 --- a/website/docs/cdktf/python/d/eks_access_entry.html.markdown +++ b/website/docs/cdktf/python/d/eks_access_entry.html.markdown @@ -39,8 +39,9 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: -* `cluster_name` – (Required) Name of the EKS Cluster. -* `principal_arn` – (Required) The IAM Principal ARN which requires Authentication access to the EKS cluster. +* `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). +* `cluster_name` - (Required) Name of the EKS Cluster. +* `principal_arn` - (Required) The IAM Principal ARN which requires Authentication access to the EKS cluster. ## Attribute Reference @@ -48,10 +49,10 @@ This data source exports the following attributes in addition to the arguments a * `access_entry_arn` - Amazon Resource Name (ARN) of the Access Entry. * `created_at` - Date and time in [RFC3339 format](https://tools.ietf.org/html/rfc3339#section-5.8) that the EKS add-on was created. -* `kubernetes_groups` – List of string which can optionally specify the Kubernetes groups the user would belong to when creating an access entry. +* `kubernetes_groups` - List of string which can optionally specify the Kubernetes groups the user would belong to when creating an access entry. * `modified_at` - Date and time in [RFC3339 format](https://tools.ietf.org/html/rfc3339#section-5.8) that the EKS add-on was updated. * `user_name` - Defaults to principal ARN if user is principal else defaults to assume-role/session-name is role is used. * `type` - Defaults to STANDARD which provides the standard workflow. EC2_LINUX, EC2_WINDOWS, FARGATE_LINUX types disallow users to input a username or groups, and prevent associations. * `tags_all` - (Optional) Key-value map of resource tags, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/eks_addon.html.markdown b/website/docs/cdktf/python/d/eks_addon.html.markdown index 206f9c874fac..dfcb942e6371 100644 --- a/website/docs/cdktf/python/d/eks_addon.html.markdown +++ b/website/docs/cdktf/python/d/eks_addon.html.markdown @@ -39,9 +39,10 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: -* `addon_name` – (Required) Name of the EKS add-on. The name must match one of +* `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). +* `addon_name` - (Required) Name of the EKS add-on. The name must match one of the names returned by [list-addon](https://docs.aws.amazon.com/cli/latest/reference/eks/list-addons.html). -* `cluster_name` – (Required) Name of the EKS Cluster. +* `cluster_name` - (Required) Name of the EKS Cluster. ## Attribute Reference @@ -59,4 +60,4 @@ This data source exports the following attributes in addition to the arguments a * `created_at` - Date and time in [RFC3339 format](https://tools.ietf.org/html/rfc3339#section-5.8) that the EKS add-on was created. * `modified_at` - Date and time in [RFC3339 format](https://tools.ietf.org/html/rfc3339#section-5.8) that the EKS add-on was updated. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/eks_addon_version.html.markdown b/website/docs/cdktf/python/d/eks_addon_version.html.markdown index 2776b6635c0a..9632511aaeba 100644 --- a/website/docs/cdktf/python/d/eks_addon_version.html.markdown +++ b/website/docs/cdktf/python/d/eks_addon_version.html.markdown @@ -57,9 +57,10 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: -* `addon_name` – (Required) Name of the EKS add-on. The name must match one of +* `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). +* `addon_name` - (Required) Name of the EKS add-on. The name must match one of the names returned by [list-addon](https://docs.aws.amazon.com/cli/latest/reference/eks/list-addons.html). -* `kubernetes_version` – (Required) Version of the EKS Cluster. Must be between 1-100 characters in length. Must begin with an alphanumeric character, and must only contain alphanumeric characters, dashes and underscores (`^[0-9A-Za-z][A-Za-z0-9\-_]+$`). +* `kubernetes_version` - (Required) Version of the EKS Cluster. Must be between 1-100 characters in length. Must begin with an alphanumeric character, and must only contain alphanumeric characters, dashes and underscores (`^[0-9A-Za-z][A-Za-z0-9\-_]+$`). * `most_recent` - (Optional) Determines if the most recent or default version of the addon should be returned. ## Attribute Reference @@ -69,4 +70,4 @@ This data source exports the following attributes in addition to the arguments a * `id` - Name of the add-on * `version` - Version of the EKS add-on. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/eks_cluster.html.markdown b/website/docs/cdktf/python/d/eks_cluster.html.markdown index cb75f5413a0d..5f70869a9040 100644 --- a/website/docs/cdktf/python/d/eks_cluster.html.markdown +++ b/website/docs/cdktf/python/d/eks_cluster.html.markdown @@ -41,6 +41,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `name` - (Required) Name of the cluster. ## Attribute Reference @@ -60,6 +61,7 @@ This data source exports the following attributes in addition to the arguments a * `data` - The base64 encoded certificate data required to communicate with your cluster. Add this to the `certificate-authority-data` section of the `kubeconfig` file for your cluster. * `cluster_id` - The ID of your local Amazon EKS cluster on the AWS Outpost. This attribute isn't available for an AWS EKS cluster on AWS cloud. * `created_at` - Unix epoch time stamp in seconds for when the cluster was created. +* `deletion_protection` - Whether deletion protection for the cluster is enabled. * `enabled_cluster_log_types` - The enabled control plane logs. * `endpoint` - Endpoint for your Kubernetes API server. * `identity` - Nested attribute containing identity provider information for your cluster. Only available on Kubernetes version 1.13 and 1.14 clusters created or upgraded on or after September 3, 2019. For an example using this information to enable IAM Roles for Service Accounts, see the [`aws_eks_cluster` resource documentation](/docs/providers/aws/r/eks_cluster.html). @@ -96,10 +98,10 @@ This data source exports the following attributes in addition to the arguments a * `endpoint_private_access` - Indicates whether or not the Amazon EKS private API server endpoint is enabled. * `endpoint_public_access` - Indicates whether or not the Amazon EKS public API server endpoint is enabled. * `public_access_cidrs` - List of CIDR blocks. Indicates which CIDR blocks can access the Amazon EKS public API server endpoint. - * `security_group_ids` – List of security group IDs - * `subnet_ids` – List of subnet IDs - * `vpc_id` – The VPC associated with your cluster. + * `security_group_ids` - List of security group IDs + * `subnet_ids` - List of subnet IDs + * `vpc_id` - The VPC associated with your cluster. * `zonal_shift_config` - Contains Zonal Shift Configuration. * `enabled` - Whether zonal shift is enabled. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/eks_cluster_auth.html.markdown b/website/docs/cdktf/python/d/eks_cluster_auth.html.markdown index f09952137048..3faa6859754b 100644 --- a/website/docs/cdktf/python/d/eks_cluster_auth.html.markdown +++ b/website/docs/cdktf/python/d/eks_cluster_auth.html.markdown @@ -58,6 +58,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `name` - (Required) Name of the cluster ## Attribute Reference @@ -67,4 +68,4 @@ This data source exports the following attributes in addition to the arguments a * `id` - Name of the cluster. * `token` - Token to use to authenticate with the cluster. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/eks_cluster_versions.html.markdown b/website/docs/cdktf/python/d/eks_cluster_versions.html.markdown index 77f102dafe13..4e34ce4c7a40 100644 --- a/website/docs/cdktf/python/d/eks_cluster_versions.html.markdown +++ b/website/docs/cdktf/python/d/eks_cluster_versions.html.markdown @@ -19,7 +19,7 @@ Terraform data source for managing AWS EKS (Elastic Kubernetes) Cluster Versions ```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 +from cdktf import TerraformOutput, TerraformStack # # Provider bindings are generated by running `cdktf get`. # See https://cdk.tf/provider-generation for more details. @@ -28,7 +28,16 @@ from imports.aws.data_aws_eks_cluster_versions import DataAwsEksClusterVersions class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) - DataAwsEksClusterVersions(self, "example") + example = DataAwsEksClusterVersions(self, "example") + TerraformOutput(self, "eks_cluster_version_filtered", + value="${[ for version in ${" + example.cluster_versions + "} : version if version.cluster_version == \"1.33\"]}" + ) + TerraformOutput(self, "eks_cluster_version_list", + value="${[ for version in ${" + example.cluster_versions + "} : version.cluster_version]}" + ) + TerraformOutput(self, "eks_cluster_versions", + value=example.cluster_versions + ) ``` ### Filter by Cluster Type @@ -73,9 +82,9 @@ class MyConvertedCode(TerraformStack): The following arguments are optional: +* `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). * `cluster_type` - (Optional) Type of clusters to filter by. Currently, the only valid value is `eks`. -* `cluster_versions` - (Optional) A list of Kubernetes versions that you can use to check if EKS supports it. * `default_only` - (Optional) Whether to show only the default versions of Kubernetes supported by EKS. * `include_all` - (Optional) Whether to include all kubernetes versions in the response. * `version_status` - (Optional) Status of the EKS cluster versions to list. @@ -85,14 +94,15 @@ Valid values are `STANDARD_SUPPORT` or `UNSUPPORTED` or `EXTENDED_SUPPORT`. This data source exports the following attributes in addition to the arguments above: -* `cluster_type` - Type of cluster that the version belongs to. -* `cluster_version` - Kubernetes version supported by EKS. -* `default_platform_version` - Default eks platform version for the cluster version. -* `default_version` - Default Kubernetes version for the cluster version. -* `end_of_extended_support_date` - End of extended support date for the cluster version. -* `end_of_standard_support_date` - End of standard support date for the cluster version. -* `kubernetes_patch_version` - Kubernetes patch version for the cluster version. -* `release_date` - Release date of the cluster version. -* `version_status` - Status of the EKS cluster version. - - \ No newline at end of file +* `cluster_versions` - A list of Kubernetes version information. + * `cluster_type` - Type of cluster that the version belongs to. + * `cluster_version` - Kubernetes version supported by EKS. + * `default_platform_version` - Default eks platform version for the cluster version. + * `default_version` - Default Kubernetes version for the cluster version. + * `end_of_extended_support_date` - End of extended support date for the cluster version. + * `end_of_standard_support_date` - End of standard support date for the cluster version. + * `kubernetes_patch_version` - Kubernetes patch version for the cluster version. + * `release_date` - Release date of the cluster version. + * `version_status` - Status of the EKS cluster version. + + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/eks_clusters.html.markdown b/website/docs/cdktf/python/d/eks_clusters.html.markdown index 6e0462a4fd6b..bb1a8671a057 100644 --- a/website/docs/cdktf/python/d/eks_clusters.html.markdown +++ b/website/docs/cdktf/python/d/eks_clusters.html.markdown @@ -44,7 +44,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -This data source does not support any arguments. +This data source supports the following arguments: + +* `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). ## Attribute Reference @@ -53,4 +55,4 @@ This data source exports the following attributes in addition to the arguments a * `id` - AWS Region. * `names` - Set of EKS clusters names - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/eks_node_group.html.markdown b/website/docs/cdktf/python/d/eks_node_group.html.markdown index 6fcacf087a38..87eed32d5f5e 100644 --- a/website/docs/cdktf/python/d/eks_node_group.html.markdown +++ b/website/docs/cdktf/python/d/eks_node_group.html.markdown @@ -36,6 +36,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `cluster_name` - (Required) Name of the cluster. * `node_group_name` - (Required) Name of the node group. @@ -54,8 +55,8 @@ This data source exports the following attributes in addition to the arguments a * `id` - The ID of the launch template. * `name` - The name of the launch template. * `version` - The version number of the launch template. -* `node_role_arn` – ARN of the IAM Role that provides permissions for the EKS Node Group. -* `release_version` – AMI version of the EKS Node Group. +* `node_role_arn` - ARN of the IAM Role that provides permissions for the EKS Node Group. +* `release_version` - AMI version of the EKS Node Group. * `remote_access` - Configuration block with remote access settings. * `ec2_ssh_key` - EC2 Key Pair name that provides access for SSH communication with the worker nodes in the EKS Node Group. * `source_security_group_ids` - Set of EC2 Security Group IDs to allow SSH access (port 22) from on the worker nodes. @@ -68,12 +69,12 @@ This data source exports the following attributes in addition to the arguments a * `max_size` - Maximum number of worker nodes. * `min_size` - Minimum number of worker nodes. * `status` - Status of the EKS Node Group. -* `subnet_ids` – Identifiers of EC2 Subnets to associate with the EKS Node Group. +* `subnet_ids` - Identifiers of EC2 Subnets to associate with the EKS Node Group. * `taints` - List of objects containing information about taints applied to the nodes in the EKS Node Group. * `key` - The key of the taint. * `value` - The value of the taint. * `effect` - The effect of the taint. * `tags` - Key-value map of resource tags. -* `version` – Kubernetes version. +* `version` - Kubernetes version. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/eks_node_groups.html.markdown b/website/docs/cdktf/python/d/eks_node_groups.html.markdown index 7b431c2e364a..20f23e8963cf 100644 --- a/website/docs/cdktf/python/d/eks_node_groups.html.markdown +++ b/website/docs/cdktf/python/d/eks_node_groups.html.markdown @@ -49,6 +49,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `cluster_name` - (Required) Name of the cluster. ## Attribute Reference @@ -58,4 +59,4 @@ This data source exports the following attributes in addition to the arguments a * `id` - Cluster name. * `names` - Set of all node group names in an EKS Cluster. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/elastic_beanstalk_application.html.markdown b/website/docs/cdktf/python/d/elastic_beanstalk_application.html.markdown index ad28d70a7c3e..a8444f792aae 100644 --- a/website/docs/cdktf/python/d/elastic_beanstalk_application.html.markdown +++ b/website/docs/cdktf/python/d/elastic_beanstalk_application.html.markdown @@ -41,6 +41,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `name` - (Required) Name of the application ## Attribute Reference @@ -58,4 +59,4 @@ Application version lifecycle (`appversion_lifecycle`) supports the nested attri * `max_age_in_days` - Number of days to retain an application version. * `delete_source_from_s3` - Specifies whether delete a version's source bundle from S3 when the application version is deleted. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/elastic_beanstalk_hosted_zone.html.markdown b/website/docs/cdktf/python/d/elastic_beanstalk_hosted_zone.html.markdown index 0c93b3e0af69..c2f1760a41d4 100644 --- a/website/docs/cdktf/python/d/elastic_beanstalk_hosted_zone.html.markdown +++ b/website/docs/cdktf/python/d/elastic_beanstalk_hosted_zone.html.markdown @@ -33,7 +33,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: -* `region` - (Optional) Region you'd like the zone for. By default, fetches the current region. +* `region` - (Optional) Name of the Region whose hosted zone is desired. Defaults to the Region set in the [provider configuration](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#aws-configuration-reference). ## Attribute Reference @@ -41,6 +41,4 @@ This data source exports the following attributes in addition to the arguments a * `id` - ID of the hosted zone. -* `region` - Region of the hosted zone. - - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/elastic_beanstalk_solution_stack.html.markdown b/website/docs/cdktf/python/d/elastic_beanstalk_solution_stack.html.markdown index f7ff8686515a..11081a620a5f 100644 --- a/website/docs/cdktf/python/d/elastic_beanstalk_solution_stack.html.markdown +++ b/website/docs/cdktf/python/d/elastic_beanstalk_solution_stack.html.markdown @@ -36,6 +36,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `most_recent` - (Optional) If more than one result is returned, use the most recent solution stack. * `name_regex` - Regex string to apply to the solution stack list returned @@ -54,4 +55,4 @@ This data source exports the following attributes in addition to the arguments a [beanstalk-platforms]: http://docs.aws.amazon.com/elasticbeanstalk/latest/dg/concepts.platforms.html "AWS Elastic Beanstalk Supported Platforms documentation" - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/elasticache_cluster.html.markdown b/website/docs/cdktf/python/d/elasticache_cluster.html.markdown index 095677c95c3d..d644b8d4b493 100644 --- a/website/docs/cdktf/python/d/elasticache_cluster.html.markdown +++ b/website/docs/cdktf/python/d/elasticache_cluster.html.markdown @@ -35,33 +35,34 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: -* `cluster_id` – (Required) Group identifier. +* `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). +* `cluster_id` - (Required) Group identifier. ## Attribute Reference This data source exports the following attributes in addition to the arguments above: -* `node_type` – The cluster node type. -* `num_cache_nodes` – The number of cache nodes that the cache cluster has. -* `engine` – Name of the cache engine. -* `engine_version` – Version number of the cache engine. +* `node_type` - The cluster node type. +* `num_cache_nodes` - The number of cache nodes that the cache cluster has. +* `engine` - Name of the cache engine. +* `engine_version` - Version number of the cache engine. * `ip_discovery` - The IP version advertised in the discovery protocol. * `network_type` - The IP versions for cache cluster connections. -* `subnet_group_name` – Name of the subnet group associated to the cache cluster. -* `security_group_ids` – List VPC security groups associated with the cache cluster. -* `parameter_group_name` – Name of the parameter group associated with this cache cluster. +* `subnet_group_name` - Name of the subnet group associated to the cache cluster. +* `security_group_ids` - List VPC security groups associated with the cache cluster. +* `parameter_group_name` - Name of the parameter group associated with this cache cluster. * `replication_group_id` - The replication group to which this cache cluster belongs. * `log_delivery_configuration` - Redis [SLOWLOG](https://redis.io/commands/slowlog) or Redis [Engine Log](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Log_Delivery.html#Log_contents-engine-log) delivery settings. -* `maintenance_window` – Specifies the weekly time range for when maintenance +* `maintenance_window` - Specifies the weekly time range for when maintenance on the cache cluster is performed. * `snapshot_window` - Daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of the cache cluster. * `snapshot_retention_limit` - The number of days for which ElastiCache will retain automatic cache cluster snapshots before deleting them. * `availability_zone` - Availability Zone for the cache cluster. -* `notification_topic_arn` – An ARN of an +* `notification_topic_arn` - An ARN of an SNS topic that ElastiCache notifications get sent to. -* `port` – The port number on which each of the cache nodes will +* `port` - The port number on which each of the cache nodes will accept connections. * `configuration_endpoint` - (Memcached only) Configuration endpoint to allow host discovery. * `cluster_address` - (Memcached only) DNS name of the cache cluster without the port appended. @@ -70,4 +71,4 @@ accept connections. Referenceable e.g., as `${data.aws_elasticache_cluster.bar.cache_nodes.0.address}` * `tags` - Tags assigned to the resource - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/elasticache_replication_group.html.markdown b/website/docs/cdktf/python/d/elasticache_replication_group.html.markdown index 3fd1b560e6a3..36da1c79a9ef 100644 --- a/website/docs/cdktf/python/d/elasticache_replication_group.html.markdown +++ b/website/docs/cdktf/python/d/elasticache_replication_group.html.markdown @@ -35,7 +35,8 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: -* `replication_group_id` – (Required) Identifier for the replication group. +* `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). +* `replication_group_id` - (Required) Identifier for the replication group. ## Attribute Reference @@ -46,8 +47,8 @@ This data source exports the following attributes in addition to the arguments a * `auth_token_enabled` - Whether an AuthToken (password) is enabled. * `automatic_failover_enabled` - A flag whether a read-only replica will be automatically promoted to read/write primary if the existing primary fails. * `cluster_mode` - Whether cluster mode is enabled or disabled. -* `node_type` – The cluster node type. -* `num_cache_clusters` – The number of cache clusters that the replication group has. +* `node_type` - The cluster node type. +* `num_cache_clusters` - The number of cache clusters that the replication group has. * `num_node_groups` - Number of node groups (shards) for the replication group. * `member_clusters` - Identifiers of all the nodes that are part of this replication group. * `multi_az_enabled` - Whether Multi-AZ Support is enabled for the replication group. @@ -55,9 +56,9 @@ This data source exports the following attributes in addition to the arguments a * `log_delivery_configuration` - Redis [SLOWLOG](https://redis.io/commands/slowlog) or Redis [Engine Log](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Log_Delivery.html#Log_contents-engine-log) delivery settings. * `snapshot_window` - Daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard). * `snapshot_retention_limit` - The number of days for which ElastiCache retains automatic cache cluster snapshots before deleting them. -* `port` – The port number on which the configuration endpoint will accept connections. +* `port` - The port number on which the configuration endpoint will accept connections. * `configuration_endpoint_address` - The configuration endpoint address to allow host discovery. * `primary_endpoint_address` - The endpoint of the primary node in this node group (shard). * `reader_endpoint_address` - The endpoint of the reader node in this node group (shard). - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/elasticache_reserved_cache_node_offering.html.markdown b/website/docs/cdktf/python/d/elasticache_reserved_cache_node_offering.html.markdown index cff4bcef4ba1..8206781700f1 100644 --- a/website/docs/cdktf/python/d/elasticache_reserved_cache_node_offering.html.markdown +++ b/website/docs/cdktf/python/d/elasticache_reserved_cache_node_offering.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `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). @@ -58,4 +59,4 @@ This data source exports the following attributes in addition to the arguments a * `fixed_price` - Fixed price charged for this reserved cache node. * `offering_id` - Unique identifier for the reservation. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/elasticache_serverless_cache.html.markdown b/website/docs/cdktf/python/d/elasticache_serverless_cache.html.markdown index dd37f479cf86..ab9db064a96e 100644 --- a/website/docs/cdktf/python/d/elasticache_serverless_cache.html.markdown +++ b/website/docs/cdktf/python/d/elasticache_serverless_cache.html.markdown @@ -35,7 +35,8 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: -* `name` – (Required) Identifier for the serverless cache. +* `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). +* `name` - (Required) Identifier for the serverless cache. ## Attribute Reference @@ -47,7 +48,7 @@ This data source exports the following attributes in addition to the arguments a * `daily_snapshot_time` - The daily time that snapshots will be created from the new serverless cache. Only available for engine types `"redis"` and `"valkey"`. * `description` - Description of the serverless cache. * `endpoint` - Represents the information required for client programs to connect to the cache. See [`endpoint` Block](#endpoint-block) for details. -* `engine` – Name of the cache engine. +* `engine` - Name of the cache engine. * `full_engine_version` - The name and version number of the engine the serverless cache is compatible with. * `kms_key_id` - ARN of the customer managed key for encrypting the data at rest. * `major_engine_version` - The version number of the engine the serverless cache is compatible with. @@ -55,7 +56,7 @@ This data source exports the following attributes in addition to the arguments a * `security_group_ids` - A list of the one or more VPC security groups associated with the serverless cache. * `snapshot_retention_limit` - The number of snapshots that will be retained for the serverless cache. Available for Redis only. * `status` - The current status of the serverless cache. -* `subnet_ids` – A list of the identifiers of the subnets where the VPC endpoint for the serverless cache are deployed. +* `subnet_ids` - A list of the identifiers of the subnets where the VPC endpoint for the serverless cache are deployed. * `user_group_id` - The identifier of the UserGroup associated with the serverless cache. Available for Redis only. ### `cache_usage_limits` Block @@ -94,4 +95,4 @@ The `reader_endpoint` block exports the following attributes: * `address` - The DNS hostname of the cache node. * `port` - The port number that the cache engine is listening on. Set as integer. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/elasticache_subnet_group.html.markdown b/website/docs/cdktf/python/d/elasticache_subnet_group.html.markdown index 841f49777848..32e62fa22bc3 100644 --- a/website/docs/cdktf/python/d/elasticache_subnet_group.html.markdown +++ b/website/docs/cdktf/python/d/elasticache_subnet_group.html.markdown @@ -33,8 +33,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `name` - (Required) Name of the subnet group. ## Attribute Reference @@ -48,4 +49,4 @@ This data source exports the following attributes in addition to the arguments a * `tags` - Map of tags assigned to the subnet group. * `vpc_id` - The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/elasticache_user.html.markdown b/website/docs/cdktf/python/d/elasticache_user.html.markdown index 2657b0f8a120..2da36e3094c9 100644 --- a/website/docs/cdktf/python/d/elasticache_user.html.markdown +++ b/website/docs/cdktf/python/d/elasticache_user.html.markdown @@ -35,7 +35,8 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: -* `user_id` – (Required) Identifier for the user. +* `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). +* `user_id` - (Required) Identifier for the user. ## Attribute Reference @@ -45,4 +46,4 @@ This data source exports the following attributes in addition to the arguments a * `user_name` - User name of the user. * `access_string` - String for what access a user possesses within the associated ElastiCache replication groups or clusters. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/elasticsearch_domain.html.markdown b/website/docs/cdktf/python/d/elasticsearch_domain.html.markdown index 6b2d0f878051..0a29be89d04b 100644 --- a/website/docs/cdktf/python/d/elasticsearch_domain.html.markdown +++ b/website/docs/cdktf/python/d/elasticsearch_domain.html.markdown @@ -35,18 +35,19 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: -* `domain_name` – (Required) Name of the domain. +* `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). +* `domain_name` - (Required) Name of the domain. ## Attribute Reference This data source exports the following attributes in addition to the arguments above: -* `access_policies` – The policy document attached to the domain. +* `access_policies` - The policy document attached to the domain. * `advanced_options` - Key-value string pairs to specify advanced configuration options. * `advanced_security_options` - Status of the Elasticsearch domain's advanced security options. The block consists of the following attributes: * `enabled` - Whether advanced security is enabled. * `internal_user_database_enabled` - Whether the internal user database is enabled. -* `arn` – The ARN of the domain. +* `arn` - The ARN of the domain. * `auto_tune_options` - Configuration of the Auto-Tune options of the domain. * `desired_state` - The Auto-Tune desired state for the domain. * `maintenance_schedule` - A list of the nested configurations for the Auto-Tune maintenance windows of the domain. @@ -75,20 +76,20 @@ This data source exports the following attributes in addition to the arguments a * `user_pool_id` - The Cognito User pool used by the domain. * `identity_pool_id` - The Cognito Identity pool used by the domain. * `role_arn` - The IAM Role with the AmazonESCognitoAccess policy attached. -* `created` – Status of the creation of the domain. -* `deleted` – Status of the deletion of the domain. -* `domain_id` – Unique identifier for the domain. +* `created` - Status of the creation of the domain. +* `deleted` - Status of the deletion of the domain. +* `domain_id` - Unique identifier for the domain. * `ebs_options` - EBS Options for the instances in the domain. * `ebs_enabled` - Whether EBS volumes are attached to data nodes in the domain. * `throughput` - The throughput (in MiB/s) of the EBS volumes attached to data nodes. * `volume_type` - The type of EBS volumes attached to data nodes. * `volume_size` - The size of EBS volumes attached to data nodes (in GB). * `iops` - The baseline input/output (I/O) performance of EBS volumes attached to data nodes. -* `elasticsearch_version` – Elasticsearch version for the domain. +* `elasticsearch_version` - Elasticsearch version for the domain. * `encryption_at_rest` - Domain encryption at rest related options. * `enabled` - Whether encryption at rest is enabled in the domain. * `kms_key_id` - The KMS key id used to encrypt data at rest. -* `endpoint` – Domain-specific endpoint used to submit index, search, and data upload requests. +* `endpoint` - Domain-specific endpoint used to submit index, search, and data upload requests. * `kibana_endpoint` - Domain-specific endpoint used to access the Kibana application. * `log_publishing_options` - Domain log publishing related options. * `log_type` - The type of Elasticsearch log being published. @@ -96,7 +97,7 @@ This data source exports the following attributes in addition to the arguments a * `enabled` - Whether log publishing is enabled. * `node_to_node_encryption` - Domain in transit encryption related options. * `enabled` - Whether node to node encryption is enabled. -* `processing` – Status of a configuration change in the domain. +* `processing` - Status of a configuration change in the domain. * `snapshot_options` – Domain snapshot related options. * `automated_snapshot_start_hour` - Hour during which the service takes an automated daily snapshot of the indices in the domain. * `tags` - Tags assigned to the domain. @@ -106,4 +107,4 @@ This data source exports the following attributes in addition to the arguments a * `subnet_ids` - The subnets used by the domain. * `vpc_id` - The VPC used by the domain. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/elb.html.markdown b/website/docs/cdktf/python/d/elb.html.markdown index 546287d2cd8b..8ce4418e25f1 100644 --- a/website/docs/cdktf/python/d/elb.html.markdown +++ b/website/docs/cdktf/python/d/elb.html.markdown @@ -47,6 +47,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `name` - (Required) Unique name of the load balancer. ## Attribute Reference @@ -56,4 +57,4 @@ This data source exports the following attributes in addition to the arguments a See the [ELB Resource](/docs/providers/aws/r/elb.html) for details on the returned attributes - they are identical. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/elb_hosted_zone_id.html.markdown b/website/docs/cdktf/python/d/elb_hosted_zone_id.html.markdown index c62487b955e3..40141c517d05 100644 --- a/website/docs/cdktf/python/d/elb_hosted_zone_id.html.markdown +++ b/website/docs/cdktf/python/d/elb_hosted_zone_id.html.markdown @@ -45,13 +45,12 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: -* `region` - (Optional) Name of the region whose AWS ELB HostedZoneId is desired. - Defaults to the region from the AWS provider configuration. +* `region` - (Optional) Name of the Region whose AWS ELB HostedZoneId is desired. Defaults to the Region set in the [provider configuration](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#aws-configuration-reference). ## Attribute Reference This data source exports the following attributes in addition to the arguments above: -* `id` - ID of the AWS ELB HostedZoneId in the selected region. +* `id` - ID of the AWS ELB HostedZoneId in the selected Region. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/elb_service_account.html.markdown b/website/docs/cdktf/python/d/elb_service_account.html.markdown index f1fdfa7640d7..c7e143de2946 100644 --- a/website/docs/cdktf/python/d/elb_service_account.html.markdown +++ b/website/docs/cdktf/python/d/elb_service_account.html.markdown @@ -82,14 +82,13 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: -* `region` - (Optional) Name of the region whose AWS ELB account ID is desired. - Defaults to the region from the AWS provider configuration. +* `region` - (Optional) Name of the Region whose AWS ELB account ID is desired. Defaults to the Region set in the [provider configuration](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#aws-configuration-reference). ## Attribute Reference This data source exports the following attributes in addition to the arguments above: -* `id` - ID of the AWS ELB service account in the selected region. -* `arn` - ARN of the AWS ELB service account in the selected region. +* `id` - ID of the AWS ELB service account in the selected Region. +* `arn` - ARN of the AWS ELB service account in the selected Region. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/emr_release_labels.html.markdown b/website/docs/cdktf/python/d/emr_release_labels.html.markdown index 3b02677d1dca..a006c0417c51 100644 --- a/website/docs/cdktf/python/d/emr_release_labels.html.markdown +++ b/website/docs/cdktf/python/d/emr_release_labels.html.markdown @@ -38,7 +38,8 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: -* `filters` – (Optional) Filters the results of the request. Prefix specifies the prefix of release labels to return. Application specifies the application (with/without version) of release labels to return. See [Filters](#filters). +* `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). +* `filters` - (Optional) Filters the results of the request. Prefix specifies the prefix of release labels to return. Application specifies the application (with/without version) of release labels to return. See [Filters](#filters). ### Filters @@ -51,4 +52,4 @@ This data source exports the following attributes in addition to the arguments a * `release_labels` - Returned release labels. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/emr_supported_instance_types.html.markdown b/website/docs/cdktf/python/d/emr_supported_instance_types.html.markdown index 04d555093075..25ac9c0a5a2e 100644 --- a/website/docs/cdktf/python/d/emr_supported_instance_types.html.markdown +++ b/website/docs/cdktf/python/d/emr_supported_instance_types.html.markdown @@ -78,8 +78,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `release_label` - (Required) Amazon EMR release label. For more information about Amazon EMR releases and their included application versions and features, see the [Amazon EMR Release Guide](https://docs.aws.amazon.com/emr/latest/ReleaseGuide/emr-release-components.html). ## Attribute Reference @@ -102,4 +103,4 @@ This data source exports the following attributes in addition to the arguments a * `type` - Amazon EC2 instance type. For example, `m5.xlarge`. * `vcpu` - The number of vCPUs available for the instance type. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/emrcontainers_virtual_cluster.html.markdown b/website/docs/cdktf/python/d/emrcontainers_virtual_cluster.html.markdown index c0e51b08621d..ffc2d1c3deba 100644 --- a/website/docs/cdktf/python/d/emrcontainers_virtual_cluster.html.markdown +++ b/website/docs/cdktf/python/d/emrcontainers_virtual_cluster.html.markdown @@ -41,6 +41,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `virtual_cluster_id` - (Required) ID of the cluster. ## Attribute Reference @@ -60,4 +61,4 @@ This data source exports the following attributes in addition to the arguments a * `state` - Status of the EKS cluster. One of `RUNNING`, `TERMINATING`, `TERMINATED`, `ARRESTED`. * `tags` - Key-value mapping of resource tags. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/fis_experiment_templates.html.markdown b/website/docs/cdktf/python/d/fis_experiment_templates.html.markdown index 78da2803825c..42d34992f9c5 100644 --- a/website/docs/cdktf/python/d/fis_experiment_templates.html.markdown +++ b/website/docs/cdktf/python/d/fis_experiment_templates.html.markdown @@ -76,6 +76,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `tags` - (Optional) Map of tags, each pair of which must exactly match a pair on the desired experiment templates. @@ -85,4 +86,4 @@ This data source exports the following attributes in addition to the arguments a * `ids` - List of all the experiment template ids found. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/fsx_ontap_file_system.html.markdown b/website/docs/cdktf/python/d/fsx_ontap_file_system.html.markdown index 62d4cd68c8b2..cf3df5fb2b46 100644 --- a/website/docs/cdktf/python/d/fsx_ontap_file_system.html.markdown +++ b/website/docs/cdktf/python/d/fsx_ontap_file_system.html.markdown @@ -37,6 +37,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `id` - (Required) Identifier of the file system (e.g. `fs-12345678`). ## Attribute Reference @@ -84,4 +85,4 @@ This data source exports the following attributes in addition to the arguments a * `DNSName` - The file system's DNS name. You can mount your file system using its DNS name. * `IpAddresses` - IP addresses of the file system endpoint. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/fsx_ontap_storage_virtual_machine.html.markdown b/website/docs/cdktf/python/d/fsx_ontap_storage_virtual_machine.html.markdown index 672df44e1f0a..b8be58f5c0d2 100644 --- a/website/docs/cdktf/python/d/fsx_ontap_storage_virtual_machine.html.markdown +++ b/website/docs/cdktf/python/d/fsx_ontap_storage_virtual_machine.html.markdown @@ -60,6 +60,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `filter` - (Optional) Configuration block. Detailed below. * `id` - (Optional) Identifier of the storage virtual machine (e.g. `svm-12345678`). @@ -121,4 +122,4 @@ The following arguments are supported for `active_directory_configuration` confi * `DNSName` - The file system's DNS name. You can mount your file system using its DNS name. * `IpAddresses` - The SVM endpoint's IP addresses. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/fsx_ontap_storage_virtual_machines.html.markdown b/website/docs/cdktf/python/d/fsx_ontap_storage_virtual_machines.html.markdown index 7ab2e18ad2cb..17b9a2582490 100644 --- a/website/docs/cdktf/python/d/fsx_ontap_storage_virtual_machines.html.markdown +++ b/website/docs/cdktf/python/d/fsx_ontap_storage_virtual_machines.html.markdown @@ -41,6 +41,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `filter` - (Optional) Configuration block. Detailed below. ### filter @@ -58,4 +59,4 @@ This data source exports the following attributes in addition to the arguments a * `ids` - List of all SVM IDs found. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/fsx_openzfs_snapshot.html.markdown b/website/docs/cdktf/python/d/fsx_openzfs_snapshot.html.markdown index 8b9d50ad5af7..68834f957242 100644 --- a/website/docs/cdktf/python/d/fsx_openzfs_snapshot.html.markdown +++ b/website/docs/cdktf/python/d/fsx_openzfs_snapshot.html.markdown @@ -42,10 +42,9 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `most_recent` - (Optional) If more than one result is returned, use the most recent snapshot. - * `snapshot_ids` - (Optional) Returns information on a specific snapshot_id. - * `filter` - (Optional) One or more name/value pairs to filter off of. The supported names are file-system-id or volume-id. @@ -61,4 +60,4 @@ This data source exports the following attributes in addition to the arguments a * `tags` - List of Tag values, with a maximum of 50 elements. * `volume_id` - ID of the volume that the snapshot is of. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/fsx_windows_file_system.html.markdown b/website/docs/cdktf/python/d/fsx_windows_file_system.html.markdown index f7faacb1722a..5779e042e795 100644 --- a/website/docs/cdktf/python/d/fsx_windows_file_system.html.markdown +++ b/website/docs/cdktf/python/d/fsx_windows_file_system.html.markdown @@ -35,8 +35,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `id` - (Required) Identifier of the file system (e.g. `fs-12345678`). ## Attribute Reference @@ -66,4 +67,4 @@ This data source exports the following attributes in addition to the arguments a * `vpc_id` - The ID of the primary virtual private cloud (VPC) for the file system. * `weekly_maintenance_start_time` - The preferred start time (in `d:HH:MM` format) to perform weekly maintenance, in the UTC time zone. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/glue_catalog_table.html.markdown b/website/docs/cdktf/python/d/glue_catalog_table.html.markdown index b4978e41655e..558a02cf2929 100644 --- a/website/docs/cdktf/python/d/glue_catalog_table.html.markdown +++ b/website/docs/cdktf/python/d/glue_catalog_table.html.markdown @@ -36,6 +36,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `name` - (Required) Name of the table. * `database_name` - (Required) Name of the metadata database where the table metadata resides. * `catalog_id` - (Optional) ID of the Glue Catalog and database where the table metadata resides. If omitted, this defaults to the current AWS Account ID. @@ -69,6 +70,7 @@ This data source exports the following attributes in addition to the arguments a * `comment` - Free-form text comment. * `name` - Name of the Partition Key. +* `parameters` - Map of key-value pairs. * `type` - Datatype of data in the Partition Key. ### storage_descriptor @@ -131,4 +133,4 @@ This data source exports the following attributes in addition to the arguments a * `name` - Name of the target table. * `region` - Region of the target table. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/glue_connection.html.markdown b/website/docs/cdktf/python/d/glue_connection.html.markdown index 9113eb122968..4e43534c66af 100644 --- a/website/docs/cdktf/python/d/glue_connection.html.markdown +++ b/website/docs/cdktf/python/d/glue_connection.html.markdown @@ -35,6 +35,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `id` - (Required) Concatenation of the catalog ID and connection name. For example, if your account ID is `123456789123` and the connection name is `conn` then the ID is `123456789123:conn`. @@ -47,10 +48,10 @@ This data source exports the following attributes in addition to the arguments a * `athena_properties` - A map of connection properties specific to the Athena compute environment. * `connection_properties` - A map of connection properties. * `connection_type` - Type of Glue Connection. -* `description` – Description of the connection. -* `match_criteria` – A list of criteria that can be used in selecting this connection. +* `description` - Description of the connection. +* `match_criteria` - A list of criteria that can be used in selecting this connection. * `name` - Name of the Glue Connection. * `physical_connection_requirements` - A map of physical connection requirements, such as VPC and SecurityGroup. * `tags` - Tags assigned to the resource - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/glue_data_catalog_encryption_settings.html.markdown b/website/docs/cdktf/python/d/glue_data_catalog_encryption_settings.html.markdown index 2c7ea2c5195d..accb41951eb5 100644 --- a/website/docs/cdktf/python/d/glue_data_catalog_encryption_settings.html.markdown +++ b/website/docs/cdktf/python/d/glue_data_catalog_encryption_settings.html.markdown @@ -36,14 +36,15 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `catalog_id` - (Required) ID of the Data Catalog. This is typically the AWS account ID. ## Attribute Reference This data source exports the following attributes in addition to the arguments above: -* `data_catalog_encryption_settings` – The security configuration to set. see [Data Catalog Encryption Settings](#data_catalog_encryption_settings). -* `id` – The ID of the Data Catalog to set the security configuration for. +* `data_catalog_encryption_settings` - The security configuration to set. see [Data Catalog Encryption Settings](#data_catalog_encryption_settings). +* `id` - The ID of the Data Catalog to set the security configuration for. ### data_catalog_encryption_settings @@ -61,4 +62,4 @@ This data source exports the following attributes in addition to the arguments a * `catalog_encryption_service_role` - The ARN of the AWS IAM role used for accessing encrypted Data Catalog data. * `sse_aws_kms_key_id` - ARN of the AWS KMS key to use for encryption at rest. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/glue_registry.html.markdown b/website/docs/cdktf/python/d/glue_registry.html.markdown index 2cc9eafff191..3d2fa2a06154 100644 --- a/website/docs/cdktf/python/d/glue_registry.html.markdown +++ b/website/docs/cdktf/python/d/glue_registry.html.markdown @@ -35,8 +35,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `name` - (Required) Name of the Glue Registry. ## Attribute Reference @@ -46,4 +47,4 @@ This data source exports the following attributes in addition to the arguments a * `arn` - Amazon Resource Name (ARN) of Glue Registry. * `description` - A description of the registry. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/glue_script.html.markdown b/website/docs/cdktf/python/d/glue_script.html.markdown index 55aa6890d7da..c4faef94ac51 100644 --- a/website/docs/cdktf/python/d/glue_script.html.markdown +++ b/website/docs/cdktf/python/d/glue_script.html.markdown @@ -222,6 +222,7 @@ output "scala_code" { This data source supports the following arguments: +* `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). * `dag_edge` - (Required) List of the edges in the DAG. Defined below. * `dag_node` - (Required) List of the nodes in the DAG. Defined below. * `language` - (Optional) Programming language of the resulting code from the DAG. Defaults to `PYTHON`. Valid values are `PYTHON` and `SCALA`. @@ -253,4 +254,4 @@ This data source exports the following attributes in addition to the arguments a * `python_script` - Python script generated from the DAG when the `language` argument is set to `PYTHON`. * `scala_code` - Scala code generated from the DAG when the `language` argument is set to `SCALA`. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/grafana_workspace.html.markdown b/website/docs/cdktf/python/d/grafana_workspace.html.markdown index 3b96eea006df..061720efd0a2 100644 --- a/website/docs/cdktf/python/d/grafana_workspace.html.markdown +++ b/website/docs/cdktf/python/d/grafana_workspace.html.markdown @@ -35,8 +35,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `workspace_id` - (Required) Grafana workspace ID. ## Attribute Reference @@ -62,4 +63,4 @@ This data source exports the following attributes in addition to the arguments a * `status` - Status of the Grafana workspace. * `tags` - Tags assigned to the resource - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/guardduty_detector.html.markdown b/website/docs/cdktf/python/d/guardduty_detector.html.markdown index 0bab4ad7c187..5e3ffdae021c 100644 --- a/website/docs/cdktf/python/d/guardduty_detector.html.markdown +++ b/website/docs/cdktf/python/d/guardduty_detector.html.markdown @@ -33,6 +33,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `id` - (Optional) ID of the detector. ## Attribute Reference @@ -51,4 +52,4 @@ This data source exports the following attributes in addition to the arguments a * `status` - Current status of the detector. * `tags` - Map of tags for the resource. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/guardduty_finding_ids.html.markdown b/website/docs/cdktf/python/d/guardduty_finding_ids.html.markdown index 1c9ef551ac92..6a2e8fccab45 100644 --- a/website/docs/cdktf/python/d/guardduty_finding_ids.html.markdown +++ b/website/docs/cdktf/python/d/guardduty_finding_ids.html.markdown @@ -35,8 +35,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `detector_id` - (Required) ID of the GuardDuty detector. ## Attribute Reference @@ -46,4 +47,4 @@ This data source exports the following attributes in addition to the arguments a * `has_findings` - Indicates whether findings are present for the specified detector. * `finding_ids` - A list of finding IDs for the specified detector. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/iam_principal_policy_simulation.html.markdown b/website/docs/cdktf/python/d/iam_principal_policy_simulation.html.markdown index 2f55b46207f6..963fedc81346 100644 --- a/website/docs/cdktf/python/d/iam_principal_policy_simulation.html.markdown +++ b/website/docs/cdktf/python/d/iam_principal_policy_simulation.html.markdown @@ -65,11 +65,11 @@ from cdktf import TerraformStack # Provider bindings are generated by running `cdktf get`. # See https://cdk.tf/provider-generation for more details. # -from imports.aws.s3_bucket_object import S3BucketObject +from imports.aws.s3_object import S3Object class MyConvertedCode(TerraformStack): def __init__(self, scope, name, *, key): super().__init__(scope, name) - S3BucketObject(self, "example", + S3Object(self, "example", bucket="my-test-bucket", depends_on=[s3_object_access], key=key @@ -236,4 +236,4 @@ This data source exports the following attributes in addition to the arguments a * `missing_context_keys` - A set of context keys (or condition keys) that were needed by some of the policies contributing to this result but not specified using a `context` block in the configuration. Missing or incorrect context keys will typically cause a simulated request to be disallowed. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/identitystore_group.html.markdown b/website/docs/cdktf/python/d/identitystore_group.html.markdown index ae7a9e3a07f5..57236067fdf1 100644 --- a/website/docs/cdktf/python/d/identitystore_group.html.markdown +++ b/website/docs/cdktf/python/d/identitystore_group.html.markdown @@ -53,8 +53,8 @@ The following arguments are required: The following arguments are optional: +* `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). * `alternate_identifier` (Optional) A unique identifier for the group that is not the primary identifier. Conflicts with `group_id` and `filter`. Detailed below. -* `filter` - (Optional, **Deprecated** use the `alternate_identifier` attribute instead) Configuration block for filtering by a unique attribute of the group. Detailed below. * `group_id` - (Optional) The identifier for a group in the Identity Store. -> Exactly one of the above arguments must be provided. Passing both `filter` and `group_id` is allowed for backwards compatibility. @@ -75,15 +75,6 @@ The `external_id` configuration block supports the following arguments: * `id` - (Required) The identifier issued to this resource by an external identity provider. * `issuer` - (Required) The issuer for an external identifier. -### `filter` Configuration Block - -~> The `filter` configuration block has been deprecated. Use `alternate_identifier` instead. - -The following arguments are supported by the `filter` configuration block: - -* `attribute_path` - (Required) Attribute path that is used to specify which attribute name to search. Currently, `DisplayName` is the only valid attribute path. -* `attribute_value` - (Required) Value for an attribute. - ### `unique_attribute` Configuration Block The `unique_attribute` configuration block supports the following arguments: @@ -102,4 +93,4 @@ This data source exports the following attributes in addition to the arguments a * `id` - The identifier issued to this resource by an external identity provider. * `issuer` - The issuer for an external identifier. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/identitystore_group_memberships.html.markdown b/website/docs/cdktf/python/d/identitystore_group_memberships.html.markdown index 8398eb9c51bb..63a264bfd3c7 100644 --- a/website/docs/cdktf/python/d/identitystore_group_memberships.html.markdown +++ b/website/docs/cdktf/python/d/identitystore_group_memberships.html.markdown @@ -57,6 +57,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `group_id` - (Required) The identifier for a group in the Identity Store. * `identity_store_id` - (Required) Identity Store ID associated with the Single Sign-On Instance. @@ -77,4 +78,4 @@ This data source exports the following attributes in addition to the arguments a * `user_id` - User identifier of the group member. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/identitystore_groups.html.markdown b/website/docs/cdktf/python/d/identitystore_groups.html.markdown index fd4b3410dce6..313f1b739bbd 100644 --- a/website/docs/cdktf/python/d/identitystore_groups.html.markdown +++ b/website/docs/cdktf/python/d/identitystore_groups.html.markdown @@ -40,8 +40,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `identity_store_id` - (Required) Identity Store ID associated with the Single Sign-On (SSO) Instance. ## Attribute Reference @@ -56,4 +57,4 @@ This data source exports the following attributes in addition to the arguments a * `id` - Identifier issued to this resource by an external identity provider. * `issuer` - Issuer for an external identifier. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/identitystore_user.html.markdown b/website/docs/cdktf/python/d/identitystore_user.html.markdown index 800caa4982f7..afb996bc67e2 100644 --- a/website/docs/cdktf/python/d/identitystore_user.html.markdown +++ b/website/docs/cdktf/python/d/identitystore_user.html.markdown @@ -53,8 +53,8 @@ The following arguments are required: The following arguments are optional: +* `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). * `alternate_identifier` (Optional) A unique identifier for a user or group that is not the primary identifier. Conflicts with `user_id` and `filter`. Detailed below. -* `filter` - (Optional, **Deprecated** use the `alternate_identifier` attribute instead) Configuration block for filtering by a unique attribute of the user. Detailed below. * `user_id` - (Optional) The identifier for a user in the Identity Store. -> Exactly one of the above arguments must be provided. Passing both `filter` and `user_id` is allowed for backwards compatibility. @@ -75,15 +75,6 @@ The `external_id` configuration block supports the following arguments: * `id` - (Required) The identifier issued to this resource by an external identity provider. * `issuer` - (Required) The issuer for an external identifier. -### `filter` Configuration Block - -~> The `filter` configuration block has been deprecated. Use `alternate_identifier` instead. - -The following arguments are supported by the `filter` configuration block: - -* `attribute_path` - (Required) Attribute path that is used to specify which attribute name to search. Currently, `UserName` is the only valid attribute path. -* `attribute_value` - (Required) Value for an attribute. - ### `unique_attribute` Configuration Block The `unique_attribute` configuration block supports the following arguments: @@ -133,4 +124,4 @@ This data source exports the following attributes in addition to the arguments a * `user_name` - User's user name value. * `user_type` - The user type. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/identitystore_users.html.markdown b/website/docs/cdktf/python/d/identitystore_users.html.markdown index a0871c5a773f..cfedbd2bf617 100644 --- a/website/docs/cdktf/python/d/identitystore_users.html.markdown +++ b/website/docs/cdktf/python/d/identitystore_users.html.markdown @@ -42,6 +42,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `identity_store_id` - (Required) Identity Store ID associated with the Single Sign-On Instance. ## Attribute Reference @@ -87,4 +88,4 @@ This data source exports the following attributes in addition to the arguments a * `user_name` - User's user name value. * `user_type` - User type. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/imagebuilder_component.html.markdown b/website/docs/cdktf/python/d/imagebuilder_component.html.markdown index 23a898397be6..f3b5f0c9b200 100644 --- a/website/docs/cdktf/python/d/imagebuilder_component.html.markdown +++ b/website/docs/cdktf/python/d/imagebuilder_component.html.markdown @@ -35,6 +35,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `arn` - (Required) ARN of the component. ## Attribute Reference @@ -55,4 +56,4 @@ This data source exports the following attributes in addition to the arguments a * `type` - Type of the component. * `version` - Version of the component. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/imagebuilder_components.html.markdown b/website/docs/cdktf/python/d/imagebuilder_components.html.markdown index f06702e59bac..428288dcd89a 100644 --- a/website/docs/cdktf/python/d/imagebuilder_components.html.markdown +++ b/website/docs/cdktf/python/d/imagebuilder_components.html.markdown @@ -40,6 +40,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `owner` - (Optional) Owner of the image recipes. Valid values are `Self`, `Shared`, `Amazon` and `ThirdParty`. Defaults to `Self`. * `filter` - (Optional) Configuration block(s) for filtering. Detailed below. @@ -57,4 +58,4 @@ This data source exports the following attributes in addition to the arguments a * `arns` - Set of ARNs of the matched Image Builder Components. * `names` - Set of names of the matched Image Builder Components. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/imagebuilder_container_recipe.html.markdown b/website/docs/cdktf/python/d/imagebuilder_container_recipe.html.markdown index fad3260ce44f..a7d62de373ec 100644 --- a/website/docs/cdktf/python/d/imagebuilder_container_recipe.html.markdown +++ b/website/docs/cdktf/python/d/imagebuilder_container_recipe.html.markdown @@ -35,6 +35,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `arn` - (Required) ARN of the container recipe. ## Attribute Reference @@ -78,4 +79,4 @@ This data source exports the following attributes in addition to the arguments a * `version` - Version of the container recipe. * `working_directory` - Working directory used during build and test workflows. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/imagebuilder_container_recipes.html.markdown b/website/docs/cdktf/python/d/imagebuilder_container_recipes.html.markdown index e3121f121f52..9dcccf0e3ddd 100644 --- a/website/docs/cdktf/python/d/imagebuilder_container_recipes.html.markdown +++ b/website/docs/cdktf/python/d/imagebuilder_container_recipes.html.markdown @@ -40,6 +40,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `owner` - (Optional) Owner of the container recipes. Valid values are `Self`, `Shared`, `Amazon` and `ThirdParty`. Defaults to `Self`. * `filter` - (Optional) Configuration block(s) for filtering. Detailed below. @@ -57,4 +58,4 @@ This data source exports the following attributes in addition to the arguments a * `arns` - Set of ARNs of the matched Image Builder Container Recipes. * `names` - Set of names of the matched Image Builder Container Recipes. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/imagebuilder_distribution_configuration.html.markdown b/website/docs/cdktf/python/d/imagebuilder_distribution_configuration.html.markdown index 8130d8429c36..a2faa44ab759 100644 --- a/website/docs/cdktf/python/d/imagebuilder_distribution_configuration.html.markdown +++ b/website/docs/cdktf/python/d/imagebuilder_distribution_configuration.html.markdown @@ -35,6 +35,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `arn` - (Required) ARN of the distribution configuration. ## Attribute Reference @@ -89,4 +90,4 @@ This data source exports the following attributes in addition to the arguments a * `name` - Name of the distribution configuration. * `tags` - Key-value map of resource tags for the distribution configuration. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/imagebuilder_distribution_configurations.html.markdown b/website/docs/cdktf/python/d/imagebuilder_distribution_configurations.html.markdown index cb464d52e8d5..e0e0c31cf2ff 100644 --- a/website/docs/cdktf/python/d/imagebuilder_distribution_configurations.html.markdown +++ b/website/docs/cdktf/python/d/imagebuilder_distribution_configurations.html.markdown @@ -39,6 +39,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `filter` - (Optional) Configuration block(s) for filtering. Detailed below. ## filter Configuration Block @@ -55,4 +56,4 @@ This data source exports the following attributes in addition to the arguments a * `arns` - Set of ARNs of the matched Image Builder Distribution Configurations. * `names` - Set of names of the matched Image Builder Distribution Configurations. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/imagebuilder_image.html.markdown b/website/docs/cdktf/python/d/imagebuilder_image.html.markdown index 82ad8161f107..314d637c91df 100644 --- a/website/docs/cdktf/python/d/imagebuilder_image.html.markdown +++ b/website/docs/cdktf/python/d/imagebuilder_image.html.markdown @@ -37,6 +37,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `arn` - (Required) ARN of the image. The suffix can either be specified with wildcards (`x.x.x`) to fetch the latest build version or a full build version (e.g., `2020.11.26/1`) to fetch an exact version. ## Attribute Reference @@ -74,4 +75,4 @@ This data source exports the following attributes in addition to the arguments a * `tags` - Key-value map of resource tags for the image. * `version` - Version of the image. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/imagebuilder_image_pipeline.html.markdown b/website/docs/cdktf/python/d/imagebuilder_image_pipeline.html.markdown index 6330813eff53..f3d6d1ee4ecf 100644 --- a/website/docs/cdktf/python/d/imagebuilder_image_pipeline.html.markdown +++ b/website/docs/cdktf/python/d/imagebuilder_image_pipeline.html.markdown @@ -35,6 +35,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `arn` - (Required) ARN of the image pipeline. ## Attribute Reference @@ -67,4 +68,4 @@ This data source exports the following attributes in addition to the arguments a * `status` - Status of the image pipeline. * `tags` - Key-value map of resource tags for the image pipeline. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/imagebuilder_image_pipelines.html.markdown b/website/docs/cdktf/python/d/imagebuilder_image_pipelines.html.markdown index 98a3440c16c6..4c79bb242331 100644 --- a/website/docs/cdktf/python/d/imagebuilder_image_pipelines.html.markdown +++ b/website/docs/cdktf/python/d/imagebuilder_image_pipelines.html.markdown @@ -39,6 +39,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `filter` - (Optional) Configuration block(s) for filtering. Detailed below. ### filter Configuration Block @@ -55,4 +56,4 @@ This data source exports the following attributes in addition to the arguments a * `arns` - Set of ARNs of the matched Image Builder Image Pipelines. * `names` - Set of names of the matched Image Builder Image Pipelines. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/imagebuilder_image_recipe.html.markdown b/website/docs/cdktf/python/d/imagebuilder_image_recipe.html.markdown index 0b8d1eea856c..7c08d2e3c393 100644 --- a/website/docs/cdktf/python/d/imagebuilder_image_recipe.html.markdown +++ b/website/docs/cdktf/python/d/imagebuilder_image_recipe.html.markdown @@ -33,8 +33,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `arn` - (Required) ARN of the image recipe. ## Attribute Reference @@ -70,4 +71,4 @@ This data source exports the following attributes in addition to the arguments a * `version` - Version of the image recipe. * `working_directory` - Working directory used during build and test workflows. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/imagebuilder_image_recipes.html.markdown b/website/docs/cdktf/python/d/imagebuilder_image_recipes.html.markdown index b02c70abca4b..ff6eb626e0a7 100644 --- a/website/docs/cdktf/python/d/imagebuilder_image_recipes.html.markdown +++ b/website/docs/cdktf/python/d/imagebuilder_image_recipes.html.markdown @@ -40,6 +40,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `owner` - (Optional) Owner of the image recipes. Valid values are `Self`, `Shared`, `Amazon` and `ThirdParty`. Defaults to `Self`. * `filter` - (Optional) Configuration block(s) for filtering. Detailed below. @@ -57,4 +58,4 @@ This data source exports the following attributes in addition to the arguments a * `arns` - Set of ARNs of the matched Image Builder Image Recipes. * `names` - Set of names of the matched Image Builder Image Recipes. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/imagebuilder_infrastructure_configuration.html.markdown b/website/docs/cdktf/python/d/imagebuilder_infrastructure_configuration.html.markdown index 3eaeb6eae0c0..e177e95ef6e6 100644 --- a/website/docs/cdktf/python/d/imagebuilder_infrastructure_configuration.html.markdown +++ b/website/docs/cdktf/python/d/imagebuilder_infrastructure_configuration.html.markdown @@ -33,8 +33,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `arn` - (Required) ARN of the infrastructure configuration. ## Attribute Reference @@ -67,4 +68,4 @@ This data source exports the following attributes in addition to the arguments a * `tags` - Key-value map of resource tags for the infrastructure configuration. * `terminate_instance_on_failure` - Whether instances are terminated on failure. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/imagebuilder_infrastructure_configurations.html.markdown b/website/docs/cdktf/python/d/imagebuilder_infrastructure_configurations.html.markdown index f14cc1520282..fc2958480b09 100644 --- a/website/docs/cdktf/python/d/imagebuilder_infrastructure_configurations.html.markdown +++ b/website/docs/cdktf/python/d/imagebuilder_infrastructure_configurations.html.markdown @@ -39,6 +39,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `filter` - (Optional) Configuration block(s) for filtering. Detailed below. ## filter Configuration Block @@ -55,4 +56,4 @@ This data source exports the following attributes in addition to the arguments a * `arns` - Set of ARNs of the matched Image Builder Infrastructure Configurations. * `names` - Set of names of the matched Image Builder Infrastructure Configurations. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/inspector_rules_packages.html.markdown b/website/docs/cdktf/python/d/inspector_rules_packages.html.markdown index ce1e74d356db..4ddb8f010586 100644 --- a/website/docs/cdktf/python/d/inspector_rules_packages.html.markdown +++ b/website/docs/cdktf/python/d/inspector_rules_packages.html.markdown @@ -54,7 +54,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -This data source does not support any arguments. +This data source supports the following arguments: + +* `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). ## Attribute Reference @@ -63,4 +65,4 @@ This data source exports the following attributes in addition to the arguments a * `id` - AWS Region. * `arns` - List of the Amazon Inspector Classic Rules Packages arns available in the AWS region. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/instance.html.markdown b/website/docs/cdktf/python/d/instance.html.markdown index 31d709012182..a2e17918c7ea 100644 --- a/website/docs/cdktf/python/d/instance.html.markdown +++ b/website/docs/cdktf/python/d/instance.html.markdown @@ -43,6 +43,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `instance_id` - (Optional) Specify the exact Instance ID with which to populate the data source. * `instance_tags` - (Optional) Map of tags, each pair of which must exactly match a pair on the desired Instance. @@ -147,4 +148,4 @@ interpolation. [1]: http://docs.aws.amazon.com/cli/latest/reference/ec2/describe-instances.html - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/instances.html.markdown b/website/docs/cdktf/python/d/instances.html.markdown index a66e4f5de63b..5c146b36f0f4 100644 --- a/website/docs/cdktf/python/d/instances.html.markdown +++ b/website/docs/cdktf/python/d/instances.html.markdown @@ -66,6 +66,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `instance_tags` - (Optional) Map of tags, each pair of which must exactly match a pair on desired instances. * `instance_state_names` - (Optional) List of instance states that should be applicable to the desired instances. The permitted values are: `pending, running, shutting-down, stopped, stopping, terminated`. The default value is `running`. @@ -91,4 +92,4 @@ This data source exports the following attributes in addition to the arguments a [1]: http://docs.aws.amazon.com/cli/latest/reference/ec2/describe-instances.html - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/internet_gateway.html.markdown b/website/docs/cdktf/python/d/internet_gateway.html.markdown index 99021ca3f32b..784d2368c2a8 100644 --- a/website/docs/cdktf/python/d/internet_gateway.html.markdown +++ b/website/docs/cdktf/python/d/internet_gateway.html.markdown @@ -42,6 +42,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `internet_gateway_id` - (Optional) ID of the specific Internet Gateway to retrieve. * `tags` - (Optional) Map of tags, each pair of which must exactly match a pair on the desired Internet Gateway. @@ -79,4 +80,4 @@ Each attachment supports the following: - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/iot_endpoint.html.markdown b/website/docs/cdktf/python/d/iot_endpoint.html.markdown index f497a5125c4e..69e6cf23f759 100644 --- a/website/docs/cdktf/python/d/iot_endpoint.html.markdown +++ b/website/docs/cdktf/python/d/iot_endpoint.html.markdown @@ -55,6 +55,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `endpoint_type` - (Optional) Endpoint type. Valid values: `iot:CredentialProvider`, `iot:Data`, `iot:Data-ATS`, `iot:Jobs`. ## Attribute Reference @@ -68,4 +69,4 @@ This data source exports the following attributes in addition to the arguments a * `iot:Data-ATS`: `IDENTIFIER-ats.iot.REGION.amazonaws.com` * `iot:Jobs`: `IDENTIFIER.jobs.iot.REGION.amazonaws.com` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/iot_registration_code.html.markdown b/website/docs/cdktf/python/d/iot_registration_code.html.markdown index c6c2de575cb8..b28b719fd00e 100644 --- a/website/docs/cdktf/python/d/iot_registration_code.html.markdown +++ b/website/docs/cdktf/python/d/iot_registration_code.html.markdown @@ -48,7 +48,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -This data source does not support any arguments. +This data source supports the following arguments: + +* `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). ## Attribute Reference @@ -56,4 +58,4 @@ This data source exports the following attributes in addition to the arguments a * `registration_code` - The CA certificate registration code. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/ivs_stream_key.html.markdown b/website/docs/cdktf/python/d/ivs_stream_key.html.markdown index 6143aa48ce55..4d49bcdf8c30 100644 --- a/website/docs/cdktf/python/d/ivs_stream_key.html.markdown +++ b/website/docs/cdktf/python/d/ivs_stream_key.html.markdown @@ -35,8 +35,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `channel_arn` - (Required) ARN of the Channel. ## Attribute Reference @@ -47,4 +48,4 @@ This data source exports the following attributes in addition to the arguments a * `tags` - Map of tags assigned to the resource. * `value` - Stream Key value. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/kendra_experience.html.markdown b/website/docs/cdktf/python/d/kendra_experience.html.markdown index ae601a6df671..ec4150a59804 100644 --- a/website/docs/cdktf/python/d/kendra_experience.html.markdown +++ b/website/docs/cdktf/python/d/kendra_experience.html.markdown @@ -36,6 +36,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `experience_id` - (Required) Identifier of the Experience. * `index_id` - (Required) Identifier of the index that contains the Experience. @@ -75,4 +76,4 @@ The `endpoints` block supports the following attributes: * `endpoint` - Endpoint of your Amazon Kendra Experience. * `endpoint_type` - Type of endpoint for your Amazon Kendra Experience. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/kendra_faq.html.markdown b/website/docs/cdktf/python/d/kendra_faq.html.markdown index 31f85b15b66c..bcdc204677a1 100644 --- a/website/docs/cdktf/python/d/kendra_faq.html.markdown +++ b/website/docs/cdktf/python/d/kendra_faq.html.markdown @@ -36,6 +36,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `faq_id` - (Required) Identifier of the FAQ. * `index_id` - (Required) Identifier of the index that contains the FAQ. @@ -62,4 +63,4 @@ The `s3_path` configuration block supports the following attributes: * `bucket` - Name of the S3 bucket that contains the file. * `key` - Name of the file. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/kendra_index.html.markdown b/website/docs/cdktf/python/d/kendra_index.html.markdown index 8f15a4f1f064..8bd124f7c283 100644 --- a/website/docs/cdktf/python/d/kendra_index.html.markdown +++ b/website/docs/cdktf/python/d/kendra_index.html.markdown @@ -35,6 +35,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `id` - (Required) Returns information on a specific Index by id. ## Attribute Reference @@ -129,4 +130,4 @@ A `jwt_token_type_configuration` block supports the following attributes: * `url` - Signing key URL. * `user_name_attribute_field` - The user name attribute field. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/kendra_query_suggestions_block_list.html.markdown b/website/docs/cdktf/python/d/kendra_query_suggestions_block_list.html.markdown index 575a63abdfc0..ea366591115e 100644 --- a/website/docs/cdktf/python/d/kendra_query_suggestions_block_list.html.markdown +++ b/website/docs/cdktf/python/d/kendra_query_suggestions_block_list.html.markdown @@ -36,6 +36,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `index_id` - (Required) Identifier of the index that contains the block list. * `query_suggestions_block_list_id` - (Required) Identifier of the block list. @@ -62,4 +63,4 @@ The `source_s3_path` configuration block supports the following attributes: * `bucket` - Name of the S3 bucket that contains the file. * `key` - Name of the file. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/kendra_thesaurus.html.markdown b/website/docs/cdktf/python/d/kendra_thesaurus.html.markdown index 403f02e820a3..50c8256c9014 100644 --- a/website/docs/cdktf/python/d/kendra_thesaurus.html.markdown +++ b/website/docs/cdktf/python/d/kendra_thesaurus.html.markdown @@ -36,6 +36,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `index_id` - (Required) Identifier of the index that contains the Thesaurus. * `thesaurus_id` - (Required) Identifier of the Thesaurus. @@ -63,4 +64,4 @@ The `source_s3_path` configuration block supports the following attributes: * `bucket` - Name of the S3 bucket that contains the file. * `key` - Name of the file. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/key_pair.html.markdown b/website/docs/cdktf/python/d/key_pair.html.markdown index 75fbbd121201..453320081b9c 100644 --- a/website/docs/cdktf/python/d/key_pair.html.markdown +++ b/website/docs/cdktf/python/d/key_pair.html.markdown @@ -52,6 +52,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `key_pair_id` - (Optional) Key Pair ID. * `key_name` - (Optional) Key Pair name. * `include_public_key` - (Optional) Whether to include the public key material in the response. @@ -86,4 +87,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/kinesis_firehose_delivery_stream.html.markdown b/website/docs/cdktf/python/d/kinesis_firehose_delivery_stream.html.markdown index 7f6cf4b09c2f..a77c6df35024 100644 --- a/website/docs/cdktf/python/d/kinesis_firehose_delivery_stream.html.markdown +++ b/website/docs/cdktf/python/d/kinesis_firehose_delivery_stream.html.markdown @@ -37,6 +37,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `name` - (Required) Name of the Kinesis Firehose Delivery Stream. ## Attribute Reference @@ -48,4 +49,4 @@ This data source exports the following attributes in addition to the arguments a [1]: https://aws.amazon.com/documentation/firehose/ - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/kinesis_stream.html.markdown b/website/docs/cdktf/python/d/kinesis_stream.html.markdown index 3cf729270a04..441d5f901da1 100644 --- a/website/docs/cdktf/python/d/kinesis_stream.html.markdown +++ b/website/docs/cdktf/python/d/kinesis_stream.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `name` - (Required) Name of the Kinesis Stream. ## Attribute Reference @@ -67,4 +68,4 @@ This data source exports the following attributes in addition to the arguments a [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 - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/kinesis_stream_consumer.html.markdown b/website/docs/cdktf/python/d/kinesis_stream_consumer.html.markdown index 1983ef56971a..b6f9792ee061 100644 --- a/website/docs/cdktf/python/d/kinesis_stream_consumer.html.markdown +++ b/website/docs/cdktf/python/d/kinesis_stream_consumer.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `arn` - (Optional) ARN of the stream consumer. * `name` - (Optional) Name of the stream consumer. * `stream_arn` - (Required) ARN of the data stream the consumer is registered with. @@ -52,4 +53,4 @@ This data source exports the following attributes in addition to the arguments a [1]: https://docs.aws.amazon.com/streams/latest/dev/amazon-kinesis-consumers.html - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/kms_alias.html.markdown b/website/docs/cdktf/python/d/kms_alias.html.markdown index cd23f6455489..1215cb470123 100644 --- a/website/docs/cdktf/python/d/kms_alias.html.markdown +++ b/website/docs/cdktf/python/d/kms_alias.html.markdown @@ -37,6 +37,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `name` - (Required) Display name of the alias. The name must start with the word "alias" followed by a forward slash (alias/) ## Attribute Reference @@ -50,4 +51,4 @@ This data source exports the following attributes in addition to the arguments a * `name` - Name of the alias * `name_prefix` - Prefix of the alias - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/kms_ciphertext.html.markdown b/website/docs/cdktf/python/d/kms_ciphertext.html.markdown index 9ba68720d295..72c440cc0877 100644 --- a/website/docs/cdktf/python/d/kms_ciphertext.html.markdown +++ b/website/docs/cdktf/python/d/kms_ciphertext.html.markdown @@ -47,6 +47,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `plaintext` - (Required) Data to be encrypted. Note that this may show up in logs, and it will be stored in the state file. * `key_id` - (Required) Globally unique key ID for the customer master key. * `context` - (Optional) An optional mapping that makes up the encryption context. @@ -58,4 +59,4 @@ This data source exports the following attributes in addition to the arguments a * `id` - Globally unique key ID for the customer master key. * `ciphertext_blob` - Base64 encoded ciphertext - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/kms_custom_key_store.html.markdown b/website/docs/cdktf/python/d/kms_custom_key_store.html.markdown index 04f39717e42a..b0a4a324cc18 100644 --- a/website/docs/cdktf/python/d/kms_custom_key_store.html.markdown +++ b/website/docs/cdktf/python/d/kms_custom_key_store.html.markdown @@ -37,6 +37,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `custom_key_store_id` - (Optional) The ID for the custom key store. * `custom_key_store_name` - (Optional) The user-specified friendly name for the custom key store. @@ -50,4 +51,4 @@ This data source exports the following attributes in addition to the arguments a * `creation_date` - The date and time when the custom key store was created. * `trust_anchor_certificate` - The trust anchor certificate of the associated CloudHSM cluster. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/kms_key.html.markdown b/website/docs/cdktf/python/d/kms_key.html.markdown index 9a8457fc006a..3b5c50c1db68 100644 --- a/website/docs/cdktf/python/d/kms_key.html.markdown +++ b/website/docs/cdktf/python/d/kms_key.html.markdown @@ -47,6 +47,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `key_id` - (Required) Key identifier which can be one of the following format: * Key ID. E.g: `1234abcd-12ab-34cd-56ef-1234567890ab` * Key ARN. E.g.: `arn:aws:kms:us-east-1:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab` @@ -64,7 +65,7 @@ This data source exports the following attributes in addition to the arguments a * `cloud_hsm_cluster_id`: The cluster ID of the AWS CloudHSM cluster that contains the key material for the KMS key. * `creation_date`: The date and time when the key was created * `custom_key_store_id`: A unique identifier for the custom key store that contains the KMS key. -* `customer_master_key_spec`: Specifies whether the key contains a symmetric key or an asymmetric key pair and the encryption algorithms or signing algorithms that the key supports +* `customer_master_key_spec`: See `key_spec`. * `deletion_date`: The date and time after which AWS KMS deletes the key. This value is present only when `key_state` is `PendingDeletion`, otherwise this value is 0 * `description`: The description of the key. * `enabled`: Specifies whether the key is enabled. When `key_state` is `Enabled` this value is true, otherwise it is false @@ -91,4 +92,4 @@ The `primary_key` and `replica_keys` objects support the following: * `arn`: The key ARN of a primary or replica key of a multi-Region key. * `region`: The AWS Region of a primary or replica key in a multi-Region key. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/kms_public_key.html.markdown b/website/docs/cdktf/python/d/kms_public_key.html.markdown index 39cfe0236908..82167e6af77a 100644 --- a/website/docs/cdktf/python/d/kms_public_key.html.markdown +++ b/website/docs/cdktf/python/d/kms_public_key.html.markdown @@ -44,6 +44,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `key_id` - (Required) Key identifier which can be one of the following format: * Key ID. E.g - `1234abcd-12ab-34cd-56ef-1234567890ab` * Key ARN. E.g. - `arn:aws:kms:us-east-1:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab` @@ -64,4 +65,4 @@ This data source exports the following attributes in addition to the arguments a * `public_key_pem` - Exported public key. The value is Privacy Enhanced Mail (PEM) encoded. * `signing_algorithms` - Signing algorithms that AWS KMS supports for this key. Only set when the `key_usage` of the public key is `SIGN_VERIFY`. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/kms_secret.html.markdown b/website/docs/cdktf/python/d/kms_secret.html.markdown index 9edd17eb485e..3a43919f211e 100644 --- a/website/docs/cdktf/python/d/kms_secret.html.markdown +++ b/website/docs/cdktf/python/d/kms_secret.html.markdown @@ -10,6 +10,6 @@ description: |- # Data Source: aws_kms_secret -!> **WARNING:** This data source was removed in version 2.0.0 of the Terraform AWS Provider. You can migrate existing configurations to the [`aws_kms_secrets` data source](/docs/providers/aws/d/kms_secrets.html) following instructions available in the [Version 2 Upgrade Guide](../guides/version-2-upgrade.html#data-source-aws_kms_secret). +!> **WARNING:** This data source's functionality was removed in version 2.0.0 of the Terraform AWS Provider. You can migrate existing configurations to the [`aws_kms_secrets` data source](/docs/providers/aws/d/kms_secrets.html) following instructions available in the [Version 2 Upgrade Guide](../guides/version-2-upgrade.html#data-source-aws_kms_secret). This data source will be removed in a future version. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/lakeformation_data_lake_settings.html.markdown b/website/docs/cdktf/python/d/lakeformation_data_lake_settings.html.markdown index 5c4c7d842b27..b986fa7a497b 100644 --- a/website/docs/cdktf/python/d/lakeformation_data_lake_settings.html.markdown +++ b/website/docs/cdktf/python/d/lakeformation_data_lake_settings.html.markdown @@ -35,13 +35,14 @@ class MyConvertedCode(TerraformStack): The following arguments are optional: -* `catalog_id` – (Optional) Identifier for the Data Catalog. By default, the account ID. +* `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). +* `catalog_id` - (Optional) Identifier for the Data Catalog. By default, the account ID. ## Attribute Reference This data source exports the following attributes in addition to the arguments above: -* `admins` – List of ARNs of AWS Lake Formation principals (IAM users or roles). +* `admins` - List of ARNs of AWS Lake Formation principals (IAM users or roles). * `allow_external_data_filtering` - Whether to allow Amazon EMR clusters to access data managed by Lake Formation. * `allow_full_table_external_data_access` - Whether to allow a third-party query engine to get data access credentials without session tags when a caller has full data access permissions. * `authorized_session_tag_value_list` - Lake Formation relies on a privileged process secured by Amazon EMR or the third party integrator to tag the user's role while assuming it. @@ -49,8 +50,8 @@ This data source exports the following attributes in addition to the arguments a * `create_table_default_permissions` - Up to three configuration blocks of principal permissions for default create table permissions. Detailed below. * `external_data_filtering_allow_list` - A list of the account IDs of Amazon Web Services accounts with Amazon EMR clusters that are to perform data filtering. * `parameters` - Key-value map of additional configuration. `CROSS_ACCOUNT_VERSION` will be set to values `"1"`, `"2"`, `"3"`, or `"4"`. `SET_CONTEXT` will also be returned with a value of `TRUE`. In a fresh account, prior to configuring, `CROSS_ACCOUNT_VERSION` is `"1"`. -* `read_only_admins` – List of ARNs of AWS Lake Formation principals (IAM users or roles) with only view access to the resources. -* `trusted_resource_owners` – List of the resource-owning account IDs that the caller's account can use to share their user access details (user ARNs). +* `read_only_admins` - List of ARNs of AWS Lake Formation principals (IAM users or roles) with only view access to the resources. +* `trusted_resource_owners` - List of the resource-owning account IDs that the caller's account can use to share their user access details (user ARNs). ### create_database_default_permissions @@ -62,4 +63,4 @@ This data source exports the following attributes in addition to the arguments a * `permissions` - List of permissions granted to the principal. * `principal` - Principal who is granted permissions. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/lakeformation_permissions.html.markdown b/website/docs/cdktf/python/d/lakeformation_permissions.html.markdown index ab41d02617c8..dcdb5a3fa1a2 100644 --- a/website/docs/cdktf/python/d/lakeformation_permissions.html.markdown +++ b/website/docs/cdktf/python/d/lakeformation_permissions.html.markdown @@ -95,7 +95,8 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: -* `principal` – (Required) Principal to be granted the permissions on the resource. Supported principals are IAM users or IAM roles. +* `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). +* `principal` - (Required) Principal to be granted the permissions on the resource. Supported principals are IAM users or IAM roles. One of the following is required: @@ -110,7 +111,8 @@ One of the following is required: The following arguments are optional: -* `catalog_id` – (Optional) Identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment. +* `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). +* `catalog_id` - (Optional) Identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment. ### data_cells_filter @@ -123,7 +125,7 @@ The following arguments are optional: The following argument is required: -* `arn` – (Required) ARN that uniquely identifies the data location resource. +* `arn` - (Required) ARN that uniquely identifies the data location resource. The following argument is optional: @@ -133,7 +135,7 @@ The following argument is optional: The following argument is required: -* `name` – (Required) Name of the database resource. Unique to the Data Catalog. +* `name` - (Required) Name of the database resource. Unique to the Data Catalog. The following argument is optional: @@ -143,7 +145,7 @@ The following argument is optional: The following arguments are required: -* `key` – (Required) Key-name for the tag. +* `key` - (Required) Key-name for the tag. * `values` - (Required) List of possible values an attribute can take. The following argument is optional: @@ -154,7 +156,7 @@ The following argument is optional: The following arguments are required: -* `resource_type` – (Required) Resource type for which the tag policy applies. Valid values are `DATABASE` and `TABLE`. +* `resource_type` - (Required) Resource type for which the tag policy applies. Valid values are `DATABASE` and `TABLE`. * `expression` - (Required) List of tag conditions that apply to the resource's tag policy. Configuration block for tag conditions that apply to the policy. See [`expression`](#expression) below. The following argument is optional: @@ -163,17 +165,18 @@ The following argument is optional: #### expression -* `key` – (Required) Key-name of an LF-Tag. +* `key` - (Required) Key-name of an LF-Tag. * `values` - (Required) List of possible values of an LF-Tag. ### table The following argument is required: -* `database_name` – (Required) Name of the database for the table. Unique to a Data Catalog. +* `database_name` - (Required) Name of the database for the table. Unique to a Data Catalog. The following arguments are optional: +* `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). * `catalog_id` - (Optional) Identifier for the Data Catalog. By default, it is the account ID of the caller. * `name` - (Optional) Name of the table. At least one of `name` or `wildcard` is required. * `wildcard` - (Optional) Whether to use a wildcard representing every table under a database. At least one of `name` or `wildcard` is required. Defaults to `false`. @@ -182,11 +185,12 @@ The following arguments are optional: The following arguments are required: -* `database_name` – (Required) Name of the database for the table with columns resource. Unique to the Data Catalog. -* `name` – (Required) Name of the table resource. +* `database_name` - (Required) Name of the database for the table with columns resource. Unique to the Data Catalog. +* `name` - (Required) Name of the table resource. The following arguments are optional: +* `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). * `catalog_id` - (Optional) Identifier for the Data Catalog. By default, it is the account ID of the caller. * `column_names` - (Optional) Set of column names for the table. At least one of `column_names` or `excluded_column_names` is required. * `excluded_column_names` - (Optional) Set of column names for the table to exclude. At least one of `column_names` or `excluded_column_names` is required. @@ -195,7 +199,7 @@ The following arguments are optional: This data source exports the following attributes in addition to the arguments above: -* `permissions` – List of permissions granted to the principal. For details on permissions, see [Lake Formation Permissions Reference](https://docs.aws.amazon.com/lake-formation/latest/dg/lf-permissions-reference.html). +* `permissions` - List of permissions granted to the principal. For details on permissions, see [Lake Formation Permissions Reference](https://docs.aws.amazon.com/lake-formation/latest/dg/lf-permissions-reference.html). * `permissions_with_grant_option` - Subset of `permissions` which the principal can pass. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/lakeformation_resource.html.markdown b/website/docs/cdktf/python/d/lakeformation_resource.html.markdown index c7b0498983d8..949665730611 100644 --- a/website/docs/cdktf/python/d/lakeformation_resource.html.markdown +++ b/website/docs/cdktf/python/d/lakeformation_resource.html.markdown @@ -35,13 +35,17 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: -* `arn` – (Required) ARN of the resource, an S3 path. +* `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). +* `arn` - (Required) ARN of the resource, an S3 path. ## Attribute Reference This data source exports the following attributes in addition to the arguments above: +* `hybrid_access_enabled` - Flag to enable AWS LakeFormation hybrid access permission mode. * `last_modified` - Date and time the resource was last modified in [RFC 3339 format](https://tools.ietf.org/html/rfc3339#section-5.8). -* `role_arn` – Role that the resource was registered with. +* `role_arn` - Role that the resource was registered with. +* `with_federation` - Whether the resource is a federated resource. +* `with_privileged_access` - Boolean to grant the calling principal the permissions to perform all supported Lake Formation operations on the registered data location. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/lambda_alias.html.markdown b/website/docs/cdktf/python/d/lambda_alias.html.markdown index 61593eb5383b..cb535adad083 100644 --- a/website/docs/cdktf/python/d/lambda_alias.html.markdown +++ b/website/docs/cdktf/python/d/lambda_alias.html.markdown @@ -3,21 +3,84 @@ subcategory: "Lambda" layout: "aws" page_title: "AWS: aws_lambda_alias" description: |- - Provides a Lambda Alias data source. + Provides details about an AWS Lambda Alias. --- # Data Source: aws_lambda_alias -Provides information about a Lambda Alias. +Provides details about an AWS Lambda Alias. Use this data source to retrieve information about an existing Lambda function alias for traffic management, deployment strategies, or API integrations. ## 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 TerraformOutput, TerraformStack +# +# Provider bindings are generated by running `cdktf get`. +# See https://cdk.tf/provider-generation for more details. +# +from imports.aws.data_aws_lambda_alias import DataAwsLambdaAlias +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + example = DataAwsLambdaAlias(self, "example", + function_name="my-lambda-function", + name="production" + ) + TerraformOutput(self, "alias_arn", + value=example.arn + ) +``` + +### API Gateway Integration + +```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.api_gateway_integration import ApiGatewayIntegration +from imports.aws.data_aws_lambda_alias import DataAwsLambdaAlias +from imports.aws.lambda_permission import LambdaPermission +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + api_handler = DataAwsLambdaAlias(self, "api_handler", + function_name="api-handler", + name="live" + ) + ApiGatewayIntegration(self, "example", + http_method=Token.as_string(aws_api_gateway_method_example.http_method), + integration_http_method="POST", + resource_id=Token.as_string(aws_api_gateway_resource_example.id), + rest_api_id=Token.as_string(aws_api_gateway_rest_api_example.id), + type="AWS_PROXY", + uri=Token.as_string(api_handler.invoke_arn) + ) + LambdaPermission(self, "api_gateway", + action="lambda:InvokeFunction", + function_name=Token.as_string(api_handler.function_name), + principal="apigateway.amazonaws.com", + qualifier=Token.as_string(api_handler.name), + source_arn="${" + aws_api_gateway_rest_api_example.execution_arn + "}/*/*", + statement_id="AllowExecutionFromAPIGateway" + ) +``` + +### Deployment Version Tracking + ```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 +from cdktf import Op, TerraformOutput, TerraformStack # # Provider bindings are generated by running `cdktf get`. # See https://cdk.tf/provider-generation for more details. @@ -26,26 +89,78 @@ from imports.aws.data_aws_lambda_alias import DataAwsLambdaAlias class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) - DataAwsLambdaAlias(self, "production", - function_name="my-lambda-func", + production = DataAwsLambdaAlias(self, "production", + function_name="payment-processor", name="production" ) + staging = DataAwsLambdaAlias(self, "staging", + function_name="payment-processor", + name="staging" + ) + version_drift = Op.neq(production.function_version, staging.function_version) + TerraformOutput(self, "deployment_status", + value=[{ + "production_version": production.function_version, + "ready_for_promotion": Op.not(version_drift), + "staging_version": staging.function_version, + "version_drift": version_drift + } + ] + ) +``` + +### EventBridge Rule Target + +```terraform +data "aws_lambda_alias" "event_processor" { + function_name = "event-processor" + name = "stable" +} + +resource "aws_cloudwatch_event_rule" "example" { + name = "capture-events" + description = "Capture events for processing" + + event_pattern = jsonencode({ + source = ["myapp.orders"] + detail-type = ["Order Placed"] + }) +} + +resource "aws_cloudwatch_event_target" "lambda" { + rule = aws_cloudwatch_event_rule.example.name + target_id = "SendToLambda" + arn = data.aws_lambda_alias.event_processor.arn +} + +resource "aws_lambda_permission" "allow_eventbridge" { + statement_id = "AllowExecutionFromEventBridge" + action = "lambda:InvokeFunction" + function_name = data.aws_lambda_alias.event_processor.function_name + principal = "events.amazonaws.com" + qualifier = data.aws_lambda_alias.event_processor.name + source_arn = aws_cloudwatch_event_rule.example.arn +} ``` ## Argument Reference -This data source supports the following arguments: +The following arguments are required: * `function_name` - (Required) Name of the aliased Lambda function. * `name` - (Required) Name of the Lambda alias. +The following arguments are optional: + +* `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). + ## Attribute Reference This data source exports the following attributes in addition to the arguments above: * `arn` - ARN identifying the Lambda function alias. -* `description` - Description of alias. +* `description` - Description of the alias. * `function_version` - Lambda function version which the alias uses. -* `invoke_arn` - ARN to be used for invoking Lambda Function from API Gateway - to be used in aws_api_gateway_integration's `uri`. +* `invoke_arn` - ARN to be used for invoking Lambda Function from API Gateway - to be used in [`aws_api_gateway_integration`](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/api_gateway_integration)'s `uri`. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/lambda_code_signing_config.html.markdown b/website/docs/cdktf/python/d/lambda_code_signing_config.html.markdown index efea8545bba5..1a012451601d 100644 --- a/website/docs/cdktf/python/d/lambda_code_signing_config.html.markdown +++ b/website/docs/cdktf/python/d/lambda_code_signing_config.html.markdown @@ -3,60 +3,186 @@ subcategory: "Lambda" layout: "aws" page_title: "AWS: aws_lambda_code_signing_config" description: |- - Provides a Lambda Code Signing Config data source. + Provides details about an AWS Lambda Code Signing Config. --- # Data Source: aws_lambda_code_signing_config -Provides information about a Lambda Code Signing Config. A code signing configuration defines a list of allowed signing profiles and defines the code-signing validation policy (action to be taken if deployment validation checks fail). +Provides details about an AWS Lambda Code Signing Config. Use this data source to retrieve information about an existing code signing configuration for Lambda functions to ensure code integrity and authenticity. -For information about Lambda code signing configurations and how to use them, see [configuring code signing for Lambda functions][1] +For information about Lambda code signing configurations and how to use them, see [configuring code signing for Lambda functions](https://docs.aws.amazon.com/lambda/latest/dg/configuration-codesigning.html). ## 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 TerraformOutput, Fn, TerraformStack +# +# Provider bindings are generated by running `cdktf get`. +# See https://cdk.tf/provider-generation for more details. +# +from imports.aws.data_aws_lambda_code_signing_config import DataAwsLambdaCodeSigningConfig +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + example = DataAwsLambdaCodeSigningConfig(self, "example", + arn="arn:aws:lambda:us-west-2:123456789012:code-signing-config:csc-0f6c334abcdea4d8b" + ) + TerraformOutput(self, "config_details", + value=[{ + "config_id": example.config_id, + "description": example.description, + "policy": Fn.lookup_nested(example.policies, ["0", "untrusted_artifact_on_deployment" + ]) + } + ] + ) +``` + +### Use in Lambda Function + ```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 +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.data_aws_lambda_code_signing_config import DataAwsLambdaCodeSigningConfig +from imports.aws.lambda_function import LambdaFunction class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) - DataAwsLambdaCodeSigningConfig(self, "existing_csc", - arn="arn:aws:lambda:${" + aws_region.value + "}:${" + aws_account.value + "}:code-signing-config:csc-0f6c334abcdea4d8b" + security_config = DataAwsLambdaCodeSigningConfig(self, "security_config", + arn=code_signing_config_arn.string_value + ) + LambdaFunction(self, "example", + code_signing_config_arn=Token.as_string(security_config.arn), + filename="function.zip", + function_name="secure-function", + handler="index.handler", + role=lambda_role.arn, + runtime="nodejs20.x", + tags={ + "Environment": "production", + "Security": "code-signed" + } + ) +``` + +### Validate Signing Profiles + +```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, TerraformOutput, conditional, Token, TerraformCount, TerraformStack +# +# Provider bindings are generated by running `cdktf get`. +# See https://cdk.tf/provider-generation for more details. +# +from imports.aws.data_aws_lambda_code_signing_config import DataAwsLambdaCodeSigningConfig +from imports.aws.lambda_function import LambdaFunction +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + required_profile = "arn:aws:signer:us-west-2:123456789012:/signing-profiles/MyProfile" + example = DataAwsLambdaCodeSigningConfig(self, "example", + arn=code_signing_config_arn.string_value + ) + allowed_profiles = Fn.lookup_nested(example.allowed_publishers, ["0", "signing_profile_version_arns" + ]) + profile_allowed = Fn.contains(allowed_profiles, required_profile) + TerraformOutput(self, "deployment_status", + value=[{ + "function_created": profile_allowed, + "message": conditional(profile_allowed, "Function deployed with valid signing profile", "Deployment blocked - signing profile not allowed"), + "profile_allowed": profile_allowed + } + ] + ) + # In most cases loops should be handled in the programming language context and + # not inside of the Terraform context. If you are looping over something external, e.g. a variable or a file input + # you should consider using a for loop. If you are looping over something only known to Terraform, e.g. a result of a data source + # you need to keep this like it is. + conditional_count = TerraformCount.of( + Token.as_number(conditional(profile_allowed, 1, 0))) + LambdaFunction(self, "conditional", + code_signing_config_arn=Token.as_string(example.arn), + filename="function.zip", + function_name="conditional-function", + handler="index.handler", + role=lambda_role.arn, + runtime="python3.12", + count=conditional_count + ) +``` + +### Multi-Environment Configuration + +```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, Op, TerraformOutput, TerraformStack +# +# Provider bindings are generated by running `cdktf get`. +# See https://cdk.tf/provider-generation for more details. +# +from imports.aws.data_aws_lambda_code_signing_config import DataAwsLambdaCodeSigningConfig +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + dev = DataAwsLambdaCodeSigningConfig(self, "dev", + arn="arn:aws:lambda:us-west-2:123456789012:code-signing-config:csc-dev-456" + ) + prod = DataAwsLambdaCodeSigningConfig(self, "prod", + arn="arn:aws:lambda:us-west-2:123456789012:code-signing-config:csc-prod-123" + ) + dev_policy = Fn.lookup_nested(dev.policies, ["0", "untrusted_artifact_on_deployment" + ]) + prod_policy = Fn.lookup_nested(prod.policies, ["0", "untrusted_artifact_on_deployment" + ]) + config_comparison = { + "dev_enforcement": dev_policy, + "policies_match": Op.eq(prod_policy, dev_policy), + "prod_enforcement": prod_policy + } + TerraformOutput(self, "environment_comparison", + value=config_comparison ) ``` ## Argument Reference -This data source supports the following arguments: +The following arguments are required: * `arn` - (Required) ARN of the code signing configuration. +The following arguments are optional: + +* `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). + ## Attribute Reference This data source exports the following attributes in addition to the arguments above: -* `allowed_publishers` - List of allowed publishers as signing profiles for this code signing configuration. +* `allowed_publishers` - List of allowed publishers as signing profiles for this code signing configuration. [See below](#allowed_publishers-attribute-reference). * `config_id` - Unique identifier for the code signing configuration. * `description` - Code signing configuration description. * `last_modified` - Date and time that the code signing configuration was last modified. -* `policies` - List of code signing policies that control the validation failure action for signature mismatch or expiry. - -`allowed_publishers` is exported with the following attribute: +* `policies` - List of code signing policies that control the validation failure action for signature mismatch or expiry. [See below](#policies-attribute-reference). -* `signing_profile_version_arns` - The ARN for each of the signing profiles. A signing profile defines a trusted user who can sign a code package. +### allowed_publishers Attribute Reference -`policies` is exported with the following attribute: +* `signing_profile_version_arns` - Set of ARNs for each of the signing profiles. A signing profile defines a trusted user who can sign a code package. -* `untrusted_artifact_on_deployment` - Code signing configuration policy for deployment validation failure. +### policies Attribute Reference -[1]: https://docs.aws.amazon.com/lambda/latest/dg/configuration-codesigning.html +* `untrusted_artifact_on_deployment` - Code signing configuration policy for deployment validation failure. Valid values: `Warn`, `Enforce`. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/lambda_function.html.markdown b/website/docs/cdktf/python/d/lambda_function.html.markdown index 1fca905d5b4d..864ece1352b5 100644 --- a/website/docs/cdktf/python/d/lambda_function.html.markdown +++ b/website/docs/cdktf/python/d/lambda_function.html.markdown @@ -3,45 +3,154 @@ subcategory: "Lambda" layout: "aws" page_title: "AWS: aws_lambda_function" description: |- - Provides a Lambda Function data source. + Provides details about an AWS Lambda Function. --- # Data Source: aws_lambda_function -Provides information about a Lambda Function. +Provides details about an AWS Lambda Function. Use this data source to obtain information about an existing Lambda function for use in other resources or as a reference for function configurations. + +~> **Note:** This data source returns information about the latest version or alias specified by the `qualifier`. If no `qualifier` is provided, it returns information about the most recent published version, or `$LATEST` if no published version exists. ## 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 TerraformOutput, TerraformStack +# +# Provider bindings are generated by running `cdktf get`. +# See https://cdk.tf/provider-generation for more details. +# +from imports.aws.data_aws_lambda_function import DataAwsLambdaFunction +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + example = DataAwsLambdaFunction(self, "example", + function_name="my-lambda-function" + ) + TerraformOutput(self, "function_arn", + value=example.arn + ) +``` + +### Using Function Alias + +```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.api_gateway_integration import ApiGatewayIntegration +from imports.aws.data_aws_lambda_function import DataAwsLambdaFunction +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + example = DataAwsLambdaFunction(self, "example", + function_name="api-handler", + qualifier="production" + ) + aws_api_gateway_integration_example = ApiGatewayIntegration(self, "example_1", + http_method=Token.as_string(aws_api_gateway_method_example.http_method), + integration_http_method="POST", + resource_id=Token.as_string(aws_api_gateway_resource_example.id), + rest_api_id=Token.as_string(aws_api_gateway_rest_api_example.id), + type="AWS_PROXY", + uri=Token.as_string(example.invoke_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_api_gateway_integration_example.override_logical_id("example") +``` + +### Function Configuration Reference + ```python # DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug from constructs import Construct -from cdktf import VariableType, TerraformVariable, TerraformStack +from cdktf import Token, Fn, TerraformStack # # Provider bindings are generated by running `cdktf get`. # See https://cdk.tf/provider-generation for more details. # from imports.aws.data_aws_lambda_function import DataAwsLambdaFunction +from imports.aws.lambda_function import LambdaFunction class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) - # Terraform Variables are not always the best fit for getting inputs in the context of Terraform CDK. - # You can read more about this at https://cdk.tf/variables - function_name = TerraformVariable(self, "function_name", - type=VariableType.STRING + reference = DataAwsLambdaFunction(self, "reference", + function_name="existing-function" ) - DataAwsLambdaFunction(self, "existing", - function_name=function_name.string_value + LambdaFunction(self, "example", + architectures=Token.as_list(reference.architectures), + environment=LambdaFunctionEnvironment( + variables=Token.as_string_map( + Fn.lookup_nested(reference.environment, ["0", "variables"])) + ), + filename="new-function.zip", + function_name="new-function", + handler=Token.as_string(reference.handler), + memory_size=Token.as_number(reference.memory_size), + role=Token.as_string(reference.role), + runtime=Token.as_string(reference.runtime), + timeout=Token.as_number(reference.timeout), + vpc_config=LambdaFunctionVpcConfig( + security_group_ids=Token.as_list( + Fn.lookup_nested(reference.vpc_config, ["0", "security_group_ids"])), + subnet_ids=Token.as_list( + Fn.lookup_nested(reference.vpc_config, ["0", "subnet_ids"])) + ) + ) +``` + +### Function Version Management + +```python +# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +from constructs import Construct +from cdktf import TerraformOutput, Op, TerraformStack +# +# Provider bindings are generated by running `cdktf get`. +# See https://cdk.tf/provider-generation for more details. +# +from imports.aws.data_aws_lambda_function import DataAwsLambdaFunction +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + latest = DataAwsLambdaFunction(self, "latest", + function_name="my-function", + qualifier="$LATEST" + ) + version = DataAwsLambdaFunction(self, "version", + function_name="my-function", + qualifier="3" + ) + TerraformOutput(self, "version_comparison", + value=[{ + "code_difference": Op.neq(version.code_sha256, latest.code_sha256), + "latest_version": latest.version, + "specific_version": version.version + } + ] ) ``` ## Argument Reference -This data source supports the following arguments: +The following arguments are required: -* `function_name` - (Required) Name of the lambda function. -* `qualifier` - (Optional) Alias name or version number of the lambda functionE.g., `$LATEST`, `my-alias`, or `1`. When not included: the data source resolves to the most recent published version; if no published version exists: it resolves to the most recent unpublished version. +* `function_name` - (Required) Name of the Lambda function. + +The following arguments are optional: + +* `qualifier` - (Optional) Alias name or version number of the Lambda function. E.g., `$LATEST`, `my-alias`, or `1`. When not included: the data source resolves to the most recent published version; if no published version exists: it resolves to the most recent unpublished version. +* `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). ## Attribute Reference @@ -51,31 +160,67 @@ This data source exports the following attributes in addition to the arguments a * `arn` - Unqualified (no `:QUALIFIER` or `:VERSION` suffix) ARN identifying your Lambda Function. See also `qualified_arn`. * `code_sha256` - Base64-encoded representation of raw SHA-256 sum of the zip file. * `code_signing_config_arn` - ARN for a Code Signing Configuration. -* `dead_letter_config` - Configure the function's *dead letter queue*. +* `dead_letter_config` - Configuration for the function's dead letter queue. [See below](#dead_letter_config-attribute-reference). * `description` - Description of what your Lambda Function does. -* `environment` - Lambda environment's configuration settings. -* `ephemeral_storage` - Amount of Ephemeral storage(`/tmp`) allocated for the Lambda Function. -* `file_system_config` - Connection settings for an Amazon EFS file system. +* `environment` - Lambda environment's configuration settings. [See below](#environment-attribute-reference). +* `ephemeral_storage` - Amount of ephemeral storage (`/tmp`) allocated for the Lambda Function. [See below](#ephemeral_storage-attribute-reference). +* `file_system_config` - Connection settings for an Amazon EFS file system. [See below](#file_system_config-attribute-reference). * `handler` - Function entrypoint in your code. * `image_uri` - URI of the container image. -* `invoke_arn` - ARN to be used for invoking Lambda Function from API Gateway. **NOTE:** Starting with `v4.51.0` of the provider, this will *not* include the qualifier. +* `invoke_arn` - ARN to be used for invoking Lambda Function from API Gateway. **Note:** Starting with `v4.51.0` of the provider, this will not include the qualifier. * `kms_key_arn` - ARN for the KMS encryption key. * `last_modified` - Date this resource was last modified. * `layers` - List of Lambda Layer ARNs attached to your Lambda Function. -* `logging_config` - Advanced logging settings. +* `logging_config` - Advanced logging settings. [See below](#logging_config-attribute-reference). * `memory_size` - Amount of memory in MB your Lambda Function can use at runtime. * `qualified_arn` - Qualified (`:QUALIFIER` or `:VERSION` suffix) ARN identifying your Lambda Function. See also `arn`. * `qualified_invoke_arn` - Qualified (`:QUALIFIER` or `:VERSION` suffix) ARN to be used for invoking Lambda Function from API Gateway. See also `invoke_arn`. -* `reserved_concurrent_executions` - The amount of reserved concurrent executions for this lambda function or `-1` if unreserved. +* `reserved_concurrent_executions` - Amount of reserved concurrent executions for this Lambda function or `-1` if unreserved. * `role` - IAM role attached to the Lambda Function. * `runtime` - Runtime environment for the Lambda function. * `signing_job_arn` - ARN of a signing job. -* `signing_profile_version_arn` - The ARN for a signing profile version. +* `signing_profile_version_arn` - ARN for a signing profile version. * `source_code_hash` - (**Deprecated** use `code_sha256` instead) Base64-encoded representation of raw SHA-256 sum of the zip file. * `source_code_size` - Size in bytes of the function .zip file. +* `source_kms_key_arn` - ARN of the AWS Key Management Service key used to encrypt the function's `.zip` deployment package. +* `tags` - Map of tags assigned to the Lambda Function. * `timeout` - Function execution time at which Lambda should terminate the function. -* `tracing_config` - Tracing settings of the function. -* `version` - The version of the Lambda function returned. If `qualifier` is not set, this will resolve to the most recent published version. If no published version of the function exists, `version` will resolve to `$LATEST`. -* `vpc_config` - VPC configuration associated with your Lambda function. +* `tracing_config` - Tracing settings of the function. [See below](#tracing_config-attribute-reference). +* `version` - Version of the Lambda function returned. If `qualifier` is not set, this will resolve to the most recent published version. If no published version of the function exists, `version` will resolve to `$LATEST`. +* `vpc_config` - VPC configuration associated with your Lambda function. [See below](#vpc_config-attribute-reference). + +### dead_letter_config + +* `target_arn` - ARN of an SNS topic or SQS queue to notify when an invocation fails. + +### environment + +* `variables` - Map of environment variables that are accessible from the function code during execution. + +### ephemeral_storage + +* `size` - Size of the Lambda function ephemeral storage (`/tmp`) in MB. + +### file_system_config + +* `arn` - ARN of the Amazon EFS Access Point that provides access to the file system. +* `local_mount_path` - Path where the function can access the file system, starting with `/mnt/`. + +### logging_config + +* `application_log_level` - Detail level of the logs your application sends to CloudWatch when using supported logging libraries. +* `log_format` - Format for your function's logs. Valid values: `Text`, `JSON`. +* `log_group` - CloudWatch log group your function sends logs to. +* `system_log_level` - Detail level of the Lambda platform event logs sent to CloudWatch. + +### tracing_config + +* `mode` - Tracing mode. Valid values: `Active`, `PassThrough`. + +### vpc_config + +* `security_group_ids` - List of security group IDs associated with the Lambda function. +* `subnet_ids` - List of subnet IDs associated with the Lambda function. +* `vpc_id` - ID of the VPC. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/lambda_function_url.html.markdown b/website/docs/cdktf/python/d/lambda_function_url.html.markdown index 422acb17ff0f..cc2fe192bb6a 100644 --- a/website/docs/cdktf/python/d/lambda_function_url.html.markdown +++ b/website/docs/cdktf/python/d/lambda_function_url.html.markdown @@ -3,21 +3,23 @@ subcategory: "Lambda" layout: "aws" page_title: "AWS: aws_lambda_function_url" description: |- - Provides a Lambda function URL data source. + Provides details about an AWS Lambda Function URL. --- # Data Source: aws_lambda_function_url -Provides information about a Lambda function URL. +Provides details about an AWS Lambda Function URL. Use this data source to retrieve information about an existing function URL 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 VariableType, TerraformVariable, TerraformStack +from cdktf import TerraformOutput, TerraformStack # # Provider bindings are generated by running `cdktf get`. # See https://cdk.tf/provider-generation for more details. @@ -26,29 +28,90 @@ from imports.aws.data_aws_lambda_function_url import DataAwsLambdaFunctionUrl class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) - # Terraform Variables are not always the best fit for getting inputs in the context of Terraform CDK. - # You can read more about this at https://cdk.tf/variables - function_name = TerraformVariable(self, "function_name", - type=VariableType.STRING + example = DataAwsLambdaFunctionUrl(self, "example", + function_name="my_lambda_function" ) - DataAwsLambdaFunctionUrl(self, "existing", - function_name=function_name.string_value + TerraformOutput(self, "function_url", + value=example.function_url + ) +``` + +### With Qualifier + +```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, Fn, TerraformStack +# +# Provider bindings are generated by running `cdktf get`. +# See https://cdk.tf/provider-generation for more details. +# +from imports.aws.data_aws_lambda_function_url import DataAwsLambdaFunctionUrl +from imports.aws.route53_record import Route53Record +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + example = DataAwsLambdaFunctionUrl(self, "example", + function_name=Token.as_string(aws_lambda_function_example.function_name), + qualifier="production" + ) + Route53Record(self, "lambda_alias", + name="api.example.com", + records=[ + Token.as_string( + Fn.replace(Token.as_string(example.function_url), "https://", "")) + ], + ttl=300, + type="CNAME", + zone_id=Token.as_string(aws_route53_zone_example.zone_id) + ) +``` + +### Retrieve CORS Configuration + +```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, Op, conditional, TerraformOutput, TerraformStack +# +# Provider bindings are generated by running `cdktf get`. +# See https://cdk.tf/provider-generation for more details. +# +from imports.aws.data_aws_lambda_function_url import DataAwsLambdaFunctionUrl +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + example = DataAwsLambdaFunctionUrl(self, "example", + function_name="api_function" + ) + cors_config = conditional( + Op.gt(Fn.length_of(example.cors), 0), + Fn.lookup_nested(example.cors, ["0"]), "null") + allowed_origins = conditional( + Op.neq(cors_config, "null"), + Fn.lookup_nested(cors_config, ["allow_origins"]), []) + TerraformOutput(self, "cors_allowed_origins", + value=allowed_origins ) ``` ## Argument Reference -This data source supports the following arguments: +The following arguments are required: -* `function_name` - (Required) The name (or ARN) of the Lambda function. -* `qualifier` - (Optional) Alias name or `"$LATEST"`. +* `function_name` - (Required) Name or ARN of the Lambda function. + +The following arguments are optional: + +* `qualifier` - (Optional) Alias name or `$LATEST`. +* `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). ## Attribute Reference This data source exports the following attributes in addition to the arguments above: * `authorization_type` - Type of authentication that the function URL uses. -* `cors` - The [cross-origin resource sharing (CORS)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) settings for the function URL. See the [`aws_lambda_function_url` resource](/docs/providers/aws/r/lambda_function_url.html) documentation for more details. +* `cors` - Cross-origin resource sharing (CORS) settings for the function URL. [See below](#cors-attribute-reference). * `creation_time` - When the function URL was created, in [ISO-8601 format](https://www.w3.org/TR/NOTE-datetime). * `function_arn` - ARN of the function. * `function_url` - HTTP URL endpoint for the function in the format `https://.lambda-url..on.aws/`. @@ -56,4 +119,13 @@ This data source exports the following attributes in addition to the arguments a * `last_modified_time` - When the function URL configuration was last updated, in [ISO-8601 format](https://www.w3.org/TR/NOTE-datetime). * `url_id` - Generated ID for the endpoint. - \ No newline at end of file +### cors Attribute Reference + +* `allow_credentials` - Whether credentials are included in the CORS request. +* `allow_headers` - List of headers that are specified in the Access-Control-Request-Headers header. +* `allow_methods` - List of HTTP methods that are allowed when calling the function URL. +* `allow_origins` - List of origins that are allowed to make requests to the function URL. +* `expose_headers` - List of headers in the response that you want to expose to the origin that called the function URL. +* `max_age` - Maximum amount of time, in seconds, that web browsers can cache results of a preflight request. + + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/lambda_functions.html.markdown b/website/docs/cdktf/python/d/lambda_functions.html.markdown index 4e2e0f364ac9..465dd7c25646 100644 --- a/website/docs/cdktf/python/d/lambda_functions.html.markdown +++ b/website/docs/cdktf/python/d/lambda_functions.html.markdown @@ -3,41 +3,155 @@ subcategory: "Lambda" layout: "aws" page_title: "AWS: aws_lambda_functions" description: |- - Terraform data resource to get a list of Lambda Functions. + Provides a list of AWS Lambda Functions. --- # Data Source: aws_lambda_functions -Terraform data resource to get a list of Lambda Functions. +Provides a list of AWS Lambda Functions in the current region. Use this data source to discover existing Lambda functions for inventory, monitoring, or bulk operations. ## Example Usage +### List All Functions + +```python +# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +from constructs import Construct +from cdktf import TerraformOutput, Fn, TerraformStack +# +# Provider bindings are generated by running `cdktf get`. +# See https://cdk.tf/provider-generation for more details. +# +from imports.aws.data_aws_lambda_functions import DataAwsLambdaFunctions +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + all = DataAwsLambdaFunctions(self, "all") + TerraformOutput(self, "all_function_names", + value=all.function_names + ) + TerraformOutput(self, "function_count", + value=Fn.length_of(all.function_names) + ) +``` + +### Use Function List for Bulk Operations + +```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, TerraformCount, TerraformStack +# +# Provider bindings are generated by running `cdktf get`. +# See https://cdk.tf/provider-generation for more details. +# +from imports.aws.cloudwatch_metric_alarm import CloudwatchMetricAlarm +from imports.aws.data_aws_lambda_functions import DataAwsLambdaFunctions +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + all = DataAwsLambdaFunctions(self, "all") + # In most cases loops should be handled in the programming language context and + # not inside of the Terraform context. If you are looping over something external, e.g. a variable or a file input + # you should consider using a for loop. If you are looping over something only known to Terraform, e.g. a result of a data source + # you need to keep this like it is. + lambda_errors_count = TerraformCount.of( + Token.as_number(Fn.length_of(all.function_names))) + CloudwatchMetricAlarm(self, "lambda_errors", + alarm_description="This metric monitors lambda errors", + alarm_name= + Token.as_string( + Fn.lookup_nested(all.function_names, [lambda_errors_count.index])) + "-errors", + comparison_operator="GreaterThanThreshold", + dimensions={ + "FunctionName": Token.as_string( + Fn.lookup_nested(all.function_names, [lambda_errors_count.index])) + }, + evaluation_periods=Token.as_number("2"), + metric_name="Errors", + namespace="AWS/Lambda", + period=Token.as_number("300"), + statistic="Sum", + tags={ + "Environment": "monitoring", + "Purpose": "lambda-error-tracking" + }, + threshold=Token.as_number("5"), + count=lambda_errors_count + ) +``` + +### Filter Functions by Name Pattern + +```python +# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +from constructs import Construct +from cdktf import TerraformOutput, TerraformStack +# +# Provider bindings are generated by running `cdktf get`. +# See https://cdk.tf/provider-generation for more details. +# +from imports.aws.data_aws_lambda_functions import DataAwsLambdaFunctions +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + all = DataAwsLambdaFunctions(self, "all") + api_functions = "${[ for name in ${" + all.function_names + "} : name if can(regex(\"^api-\", name))]}" + worker_functions = "${[ for name in ${" + all.function_names + "} : name if can(regex(\"^worker-\", name))]}" + TerraformOutput(self, "api_functions", + value=api_functions + ) + TerraformOutput(self, "worker_functions", + value=worker_functions + ) +``` + +### Create Function Inventory + ```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 +from cdktf import TerraformOutput, Fn, Token, TerraformCount, TerraformStack # # Provider bindings are generated by running `cdktf get`. # See https://cdk.tf/provider-generation for more details. # +from imports.aws.data_aws_lambda_function import DataAwsLambdaFunction from imports.aws.data_aws_lambda_functions import DataAwsLambdaFunctions class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) - DataAwsLambdaFunctions(self, "all") + all = DataAwsLambdaFunctions(self, "all") + function_inventory = "${[ for i, name in ${" + all.function_names + "} : {\n name = name\n arn = data.aws_lambda_functions.all.function_arns[i]\n runtime = data.aws_lambda_function.details[i].runtime\n memory_size = data.aws_lambda_function.details[i].memory_size\n timeout = data.aws_lambda_function.details[i].timeout\n handler = data.aws_lambda_function.details[i].handler\n }]}" + TerraformOutput(self, "function_inventory", + value=function_inventory + ) + # In most cases loops should be handled in the programming language context and + # not inside of the Terraform context. If you are looping over something external, e.g. a variable or a file input + # you should consider using a for loop. If you are looping over something only known to Terraform, e.g. a result of a data source + # you need to keep this like it is. + details_count = TerraformCount.of( + Token.as_number(Fn.length_of(all.function_names))) + DataAwsLambdaFunction(self, "details", + function_name=Token.as_string( + Fn.lookup_nested(all.function_names, [details_count.index])), + count=details_count + ) ``` ## Argument Reference -This data source does not support any arguments. +The following arguments are optional: + +* `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). ## Attribute Reference This data source exports the following attributes in addition to the arguments above: -* `function_names` - A list of Lambda Function names. -* `function_arns` - A list of Lambda Function ARNs. +* `function_arns` - List of Lambda Function ARNs. +* `function_names` - List of Lambda Function names. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/lambda_invocation.html.markdown b/website/docs/cdktf/python/d/lambda_invocation.html.markdown index 74a22a1935c1..c1009046b16a 100644 --- a/website/docs/cdktf/python/d/lambda_invocation.html.markdown +++ b/website/docs/cdktf/python/d/lambda_invocation.html.markdown @@ -3,27 +3,29 @@ subcategory: "Lambda" layout: "aws" page_title: "AWS: aws_lambda_invocation" description: |- - Invoke AWS Lambda Function as data source + Invokes an AWS Lambda Function and returns its results. --- # Data Source: aws_lambda_invocation -Use this data source to invoke custom lambda functions as data source. -The lambda function is invoked with [RequestResponse](https://docs.aws.amazon.com/lambda/latest/dg/API_Invoke.html#API_Invoke_RequestSyntax) -invocation type. +Invokes an AWS Lambda Function and returns its results. Use this data source to execute Lambda functions during Terraform operations and use their results in other resources or outputs. -~> **NOTE:** The `aws_lambda_invocation` data source invokes the function during the first `apply` and every subsequent `plan` when the function is known. +The Lambda function is invoked with [RequestResponse](https://docs.aws.amazon.com/lambda/latest/dg/API_Invoke.html#API_Invoke_RequestSyntax) invocation type. -~> **NOTE:** If you get a `KMSAccessDeniedException: Lambda was unable to decrypt the environment variables because KMS access was denied` error when invoking an [`aws_lambda_function`](/docs/providers/aws/r/lambda_function.html) with environment variables, the IAM role associated with the function may have been deleted and recreated _after_ the function was created. You can fix the problem two ways: 1) updating the function's role to another role and then updating it back again to the recreated role, or 2) by using Terraform to `taint` the function and `apply` your configuration again to recreate the function. (When you create a function, Lambda grants permissions on the KMS key to the function's IAM role. If the IAM role is recreated, the grant is no longer valid. Changing the function's role or recreating the function causes Lambda to update the grant.) +~> **Note:** The `aws_lambda_invocation` data source invokes the function during the first `apply` and every subsequent `plan` when the function is known. + +~> **Note:** If you get a `KMSAccessDeniedException: Lambda was unable to decrypt the environment variables because KMS access was denied` error when invoking a Lambda function with environment variables, the IAM role associated with the function may have been deleted and recreated after the function was created. You can fix the problem two ways: 1) updating the function's role to another role and then updating it back again to the recreated role, or 2) by using Terraform to `taint` the function and `apply` your configuration again to recreate the function. (When you create a function, Lambda grants permissions on the KMS key to the function's IAM role. If the IAM role is recreated, the grant is no longer valid. Changing the function's role or recreating the function causes Lambda to update the grant.) ## Example Usage +### Basic Invocation + ```python # DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug from constructs import Construct -from cdktf import TerraformOutput, Fn, Token, TerraformStack +from cdktf import Token, Fn, TerraformOutput, TerraformStack # # Provider bindings are generated by running `cdktf get`. # See https://cdk.tf/provider-generation for more details. @@ -33,28 +35,115 @@ class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) example = DataAwsLambdaInvocation(self, "example", - function_name=lambda_function_test.function_name, - input="{\n \"key1\": \"value1\",\n \"key2\": \"value2\"\n}\n\n" + function_name=Token.as_string(aws_lambda_function_example.function_name), + input=Token.as_string( + Fn.jsonencode({ + "id": "123456", + "operation": "getStatus" + })) ) - TerraformOutput(self, "result_entry", - value=Fn.lookup_nested(Fn.jsondecode(Token.as_string(example.result)), ["\"key1\"" - ]) + TerraformOutput(self, "result", + value=Fn.jsondecode(Token.as_string(example.result)) + ) +``` + +### Dynamic Resource Configuration + +```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.data_aws_lambda_invocation import DataAwsLambdaInvocation +from imports.aws.elasticache_cluster import ElasticacheCluster +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + resource_config = DataAwsLambdaInvocation(self, "resource_config", + function_name="resource-config-generator", + input=Token.as_string( + Fn.jsonencode({ + "environment": environment.value, + "region": current.region, + "service": "api" + })), + qualifier="production" + ) + config = Fn.jsondecode(Token.as_string(resource_config.result)) + ElasticacheCluster(self, "example", + cluster_id=Token.as_string( + Fn.lookup_nested(config, ["cache", "cluster_id"])), + engine=Token.as_string(Fn.lookup_nested(config, ["cache", "engine"])), + node_type=Token.as_string(Fn.lookup_nested(config, ["cache", "node_type"])), + num_cache_nodes=Token.as_number( + Fn.lookup_nested(config, ["cache", "nodes"])), + parameter_group_name=Token.as_string( + Fn.lookup_nested(config, ["cache", "parameter_group"])), + tags=Token.as_string_map(Fn.lookup_nested(config, ["tags"])) + ) +``` + +### Error Handling + +```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, Fn, Op, conditional, TerraformCount, TerraformStack +# +# Provider bindings are generated by running `cdktf get`. +# See https://cdk.tf/provider-generation for more details. +# +from imports.null.resource import Resource +from imports.aws.data_aws_lambda_invocation import DataAwsLambdaInvocation +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + example = DataAwsLambdaInvocation(self, "example", + function_name=Token.as_string(aws_lambda_function_example.function_name), + input=Token.as_string( + Fn.jsonencode({ + "action": "validate", + "payload": configuration.value + })) + ) + result = Fn.jsondecode(Token.as_string(example.result)) + has_errors = Fn.try([ + Op.neq(Fn.lookup_nested(result, ["errors"]), "null"), False + ]) + error_messages = conditional(has_errors, + Fn.join(", ", Token.as_list(Fn.lookup_nested(result, ["errors"]))), "null") + # In most cases loops should be handled in the programming language context and + # not inside of the Terraform context. If you are looping over something external, e.g. a variable or a file input + # you should consider using a for loop. If you are looping over something only known to Terraform, e.g. a result of a data source + # you need to keep this like it is. + validation_check_count = TerraformCount.of( + Token.as_number( + conditional(has_errors, + fail("Configuration validation failed: ${" + error_messages + "}"), 0))) + Resource(self, "validation_check", + count=validation_check_count ) ``` ## Argument Reference -This data source supports the following arguments: +The following arguments are required: + +* `function_name` - (Required) Name of the Lambda function. +* `input` - (Required) String in JSON format that is passed as payload to the Lambda function. + +The following arguments are optional: -* `function_name` - (Required) Name of the lambda function. -* `input` - (Required) String in JSON format that is passed as payload to the lambda function. -* `qualifier` - (Optional) Qualifier (a.k.a version) of the lambda function. Defaults - to `$LATEST`. +* `qualifier` - (Optional) Qualifier (a.k.a version) of the Lambda function. Defaults to `$LATEST`. +* `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). ## Attribute Reference This data source exports the following attributes in addition to the arguments above: -* `result` - String result of the lambda function invocation. +* `result` - String result of the Lambda function invocation. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/lambda_layer_version.html.markdown b/website/docs/cdktf/python/d/lambda_layer_version.html.markdown index 25c8f90afc51..b483e400906d 100644 --- a/website/docs/cdktf/python/d/lambda_layer_version.html.markdown +++ b/website/docs/cdktf/python/d/lambda_layer_version.html.markdown @@ -3,21 +3,115 @@ subcategory: "Lambda" layout: "aws" page_title: "AWS: aws_lambda_layer_version" description: |- - Provides a Lambda Layer Version data source. + Provides details about an AWS Lambda Layer Version. --- # Data Source: aws_lambda_layer_version -Provides information about a Lambda Layer Version. +Provides details about an AWS Lambda Layer Version. Use this data source to retrieve information about a specific layer version or find the latest version compatible with your runtime and architecture requirements. ## Example Usage +### Get Latest Layer 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 Token, TerraformStack +# +# Provider bindings are generated by running `cdktf get`. +# See https://cdk.tf/provider-generation for more details. +# +from imports.aws.data_aws_lambda_layer_version import DataAwsLambdaLayerVersion +from imports.aws.lambda_function import LambdaFunction +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + example = DataAwsLambdaLayerVersion(self, "example", + layer_name="my-shared-utilities" + ) + aws_lambda_function_example = LambdaFunction(self, "example_1", + filename="function.zip", + function_name="example_function", + handler="index.handler", + layers=[Token.as_string(example.arn)], + role=lambda_role.arn, + runtime="nodejs20.x" + ) + # 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_lambda_function_example.override_logical_id("example") +``` + +### Get Specific Layer 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 TerraformOutput, TerraformStack +# +# Provider bindings are generated by running `cdktf get`. +# See https://cdk.tf/provider-generation for more details. +# +from imports.aws.data_aws_lambda_layer_version import DataAwsLambdaLayerVersion +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + example = DataAwsLambdaLayerVersion(self, "example", + layer_name="production-utilities", + version=5 + ) + TerraformOutput(self, "layer_info", + value=[{ + "arn": example.arn, + "description": example.description, + "version": example.version + } + ] + ) +``` + +### Get Latest Compatible Layer 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 Token, TerraformStack +# +# Provider bindings are generated by running `cdktf get`. +# See https://cdk.tf/provider-generation for more details. +# +from imports.aws.data_aws_lambda_layer_version import DataAwsLambdaLayerVersion +from imports.aws.lambda_function import LambdaFunction +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + arm_layer = DataAwsLambdaLayerVersion(self, "arm_layer", + compatible_architecture="arm64", + layer_name="optimized-libraries" + ) + python_layer = DataAwsLambdaLayerVersion(self, "python_layer", + compatible_runtime="python3.12", + layer_name="python-dependencies" + ) + LambdaFunction(self, "example", + architectures=["arm64"], + filename="function.zip", + function_name="multi_layer_function", + handler="app.handler", + layers=[Token.as_string(python_layer.arn), Token.as_string(arm_layer.arn)], + role=lambda_role.arn, + runtime="python3.12" + ) +``` + +### Compare Layer Versions + ```python # DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug from constructs import Construct -from cdktf import VariableType, TerraformVariable, TerraformStack +from cdktf import Op, TerraformOutput, conditional, TerraformStack # # Provider bindings are generated by running `cdktf get`. # See https://cdk.tf/provider-generation for more details. @@ -26,44 +120,48 @@ from imports.aws.data_aws_lambda_layer_version import DataAwsLambdaLayerVersion class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) - # Terraform Variables are not always the best fit for getting inputs in the context of Terraform CDK. - # You can read more about this at https://cdk.tf/variables - layer_name = TerraformVariable(self, "layer_name", - type=VariableType.STRING + latest = DataAwsLambdaLayerVersion(self, "latest", + layer_name="shared-layer" + ) + stable = DataAwsLambdaLayerVersion(self, "stable", + layer_name="shared-layer", + version=3 ) - DataAwsLambdaLayerVersion(self, "existing", - layer_name=layer_name.string_value + use_latest_layer = Op.gt(latest.version, 5) + TerraformOutput(self, "selected_layer_version", + value=conditional(use_latest_layer, latest.version, stable.version) ) ``` ## Argument Reference -This data source supports the following arguments: +The following arguments are required: + +* `layer_name` - (Required) Name of the Lambda layer. + +The following arguments are optional: -* `layer_name` - (Required) Name of the lambda layer. +* `compatible_architecture` - (Optional) Specific architecture the layer version must support. Conflicts with `version`. If specified, the latest available layer version supporting the provided architecture will be used. +* `compatible_runtime` - (Optional) Specific runtime the layer version must support. Conflicts with `version`. If specified, the latest available layer version supporting the provided runtime will be used. +* `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). * `version` - (Optional) Specific layer version. Conflicts with `compatible_runtime` and `compatible_architecture`. If omitted, the latest available layer version will be used. -* `compatible_runtime` (Optional) Specific runtime the layer version must support. Conflicts with `version`. If specified, the latest available layer version supporting the provided runtime will be used. -* `compatible_architecture` (Optional) Specific architecture the layer version could support. Conflicts with `version`. If specified, the latest available layer version supporting the provided architecture will be used. ## Attribute Reference This data source exports the following attributes in addition to the arguments above: +* `arn` - ARN of the Lambda Layer with version. * `code_sha256` - Base64-encoded representation of raw SHA-256 sum of the zip file. +* `compatible_architectures` - List of [Architectures](https://docs.aws.amazon.com/lambda/latest/dg/API_GetLayerVersion.html#SSS-GetLayerVersion-response-CompatibleArchitectures) the specific Lambda Layer version is compatible with. +* `compatible_runtimes` - List of [Runtimes](https://docs.aws.amazon.com/lambda/latest/dg/API_GetLayerVersion.html#SSS-GetLayerVersion-response-CompatibleRuntimes) the specific Lambda Layer version is compatible with. +* `created_date` - Date this resource was created. * `description` - Description of the specific Lambda Layer version. -* `license_info` - License info associated with the specific Lambda Layer version. -* `compatible_runtimes` - List of [Runtimes][1] the specific Lambda Layer version is compatible with. -* `compatible_architectures` - A list of [Architectures][2] the specific Lambda Layer version is compatible with. -* `arn` - ARN of the Lambda Layer with version. * `layer_arn` - ARN of the Lambda Layer without version. -* `created_date` - Date this resource was created. +* `license_info` - License info associated with the specific Lambda Layer version. * `signing_job_arn` - ARN of a signing job. -* `signing_profile_version_arn` - The ARN for a signing profile version. +* `signing_profile_version_arn` - ARN for a signing profile version. * `source_code_hash` - (**Deprecated** use `code_sha256` instead) Base64-encoded representation of raw SHA-256 sum of the zip file. * `source_code_size` - Size in bytes of the function .zip file. -* `version` - This Lambda Layer version. - -[1]: https://docs.aws.amazon.com/lambda/latest/dg/API_GetLayerVersion.html#SSS-GetLayerVersion-response-CompatibleRuntimes -[2]: https://docs.aws.amazon.com/lambda/latest/dg/API_GetLayerVersion.html#SSS-GetLayerVersion-response-CompatibleArchitectures +* `version` - Lambda Layer version. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/launch_configuration.html.markdown b/website/docs/cdktf/python/d/launch_configuration.html.markdown index 23cafb7e73d5..886fa81d8ce5 100644 --- a/website/docs/cdktf/python/d/launch_configuration.html.markdown +++ b/website/docs/cdktf/python/d/launch_configuration.html.markdown @@ -35,6 +35,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `name` - (Required) Name of the launch configuration. ## Attribute Reference @@ -89,4 +90,4 @@ This data source exports the following attributes in addition to the arguments a * `device_name` - Name of the device. * `virtual_name` - Virtual Name of the device. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/launch_template.html.markdown b/website/docs/cdktf/python/d/launch_template.html.markdown index d419ceef9901..939c606c330b 100644 --- a/website/docs/cdktf/python/d/launch_template.html.markdown +++ b/website/docs/cdktf/python/d/launch_template.html.markdown @@ -58,6 +58,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `filter` - (Optional) Configuration block(s) for filtering. Detailed below. * `id` - (Optional) ID of the specific launch template to retrieve. * `name` - (Optional) Name of the launch template. @@ -84,4 +85,4 @@ This resource also exports a full set of attributes corresponding to the argumen - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/lb.html.markdown b/website/docs/cdktf/python/d/lb.html.markdown index 06d6a7e33f96..03773db42507 100644 --- a/website/docs/cdktf/python/d/lb.html.markdown +++ b/website/docs/cdktf/python/d/lb.html.markdown @@ -52,6 +52,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `arn` - (Optional) Full ARN of the load balancer. * `name` - (Optional) Unique name of the load balancer. * `tags` - (Optional) Mapping of tags, each pair of which must exactly match a pair on the desired load balancer. @@ -71,4 +72,4 @@ returned attributes - they are identical. - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/lb_hosted_zone_id.html.markdown b/website/docs/cdktf/python/d/lb_hosted_zone_id.html.markdown index 1aa33da21d0c..b62e05f34d23 100644 --- a/website/docs/cdktf/python/d/lb_hosted_zone_id.html.markdown +++ b/website/docs/cdktf/python/d/lb_hosted_zone_id.html.markdown @@ -44,14 +44,13 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: -* `region` - (Optional) Name of the region whose AWS ELB HostedZoneId is desired. - Defaults to the region from the AWS provider configuration. +* `region` - (Optional) Name of the Region whose AWS ELB HostedZoneId is desired. Defaults to the Region set in the [provider configuration](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#aws-configuration-reference). * `load_balancer_type` - (Optional) Type of load balancer to create. Possible values are `application` or `network`. The default value is `application`. ## Attribute Reference This data source exports the following attributes in addition to the arguments above: -* `id` - ID of the AWS ELB HostedZoneId in the selected region. +* `id` - ID of the AWS ELB HostedZoneId in the selected Region. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/lb_listener.html.markdown b/website/docs/cdktf/python/d/lb_listener.html.markdown index 0ff8e85baa94..6f5836013dce 100644 --- a/website/docs/cdktf/python/d/lb_listener.html.markdown +++ b/website/docs/cdktf/python/d/lb_listener.html.markdown @@ -52,6 +52,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `arn` - (Optional) ARN of the listener. Required if `load_balancer_arn` and `port` is not set. * `load_balancer_arn` - (Optional) ARN of the load balancer. Required if `arn` is not set. * `port` - (Optional) Port of the listener. Required if `arn` is not set. @@ -68,4 +69,4 @@ See the [LB Listener Resource](/docs/providers/aws/r/lb_listener.html) for detai - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/lb_listener_rule.html.markdown b/website/docs/cdktf/python/d/lb_listener_rule.html.markdown index f4c22860e933..af3fb347bc95 100644 --- a/website/docs/cdktf/python/d/lb_listener_rule.html.markdown +++ b/website/docs/cdktf/python/d/lb_listener_rule.html.markdown @@ -24,7 +24,7 @@ from cdktf import VariableType, TerraformVariable, TerraformStack # Provider bindings are generated by running `cdktf get`. # See https://cdk.tf/provider-generation for more details. # -from imports.aws. import DataAwsLbListenerRule +from imports.aws.data_aws_lb_listener_rule import DataAwsLbListenerRule class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) @@ -34,7 +34,7 @@ class MyConvertedCode(TerraformStack): type=VariableType.STRING ) DataAwsLbListenerRule(self, "example", - arn=lb_rule_arn.value + arn=lb_rule_arn.string_value ) ``` @@ -48,7 +48,7 @@ from cdktf import VariableType, TerraformVariable, TerraformStack # Provider bindings are generated by running `cdktf get`. # See https://cdk.tf/provider-generation for more details. # -from imports.aws. import DataAwsLbListenerRule +from imports.aws.data_aws_lb_listener_rule import DataAwsLbListenerRule class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) @@ -61,8 +61,8 @@ class MyConvertedCode(TerraformStack): type=VariableType.NUMBER ) DataAwsLbListenerRule(self, "example", - listener_arn=lb_listener_arn.value, - priority=lb_rule_priority.value + listener_arn=lb_listener_arn.string_value, + priority=lb_rule_priority.number_value ) ``` @@ -70,6 +70,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `arn` - (Optional) ARN of the Listener Rule. Either `arn` or `listener_arn` must be set. * `listener_arn` - (Optional) ARN of the associated Listener. @@ -185,4 +186,4 @@ This data source exports the following attributes in addition to the arguments a * `values` - Set of `key`-`value` pairs indicating the query string parameters to match. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/lb_target_group.html.markdown b/website/docs/cdktf/python/d/lb_target_group.html.markdown index 1771a87095a7..8db1d5557604 100644 --- a/website/docs/cdktf/python/d/lb_target_group.html.markdown +++ b/website/docs/cdktf/python/d/lb_target_group.html.markdown @@ -52,6 +52,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `arn` - (Optional) Full ARN of the target group. * `name` - (Optional) Unique name of the target group. * `tags` - (Optional) Mapping of tags, each pair of which must exactly match a pair on the desired target group. @@ -71,4 +72,4 @@ on the returned attributes - they are identical. - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/lb_trust_store.html.markdown b/website/docs/cdktf/python/d/lb_trust_store.html.markdown index cf97aecdef5a..f6cc24d80623 100644 --- a/website/docs/cdktf/python/d/lb_trust_store.html.markdown +++ b/website/docs/cdktf/python/d/lb_trust_store.html.markdown @@ -52,6 +52,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `arn` - (Optional) Full ARN of the trust store. * `name` - (Optional) Unique name of the trust store. @@ -70,4 +71,4 @@ on the returned attributes - they are identical. - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/lbs.html.markdown b/website/docs/cdktf/python/d/lbs.html.markdown index 876449d97b00..9fc308e46490 100644 --- a/website/docs/cdktf/python/d/lbs.html.markdown +++ b/website/docs/cdktf/python/d/lbs.html.markdown @@ -40,6 +40,7 @@ class MyConvertedCode(TerraformStack): The following arguments are optional: +* `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). * `tags` - (Optional) Map of tags, each pair of which must exactly match a pair on the desired Load Balancers. @@ -49,4 +50,4 @@ This data source exports the following attributes in addition to the arguments a * `arns` - Set of Load Balancer ARNs. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/lex_bot.html.markdown b/website/docs/cdktf/python/d/lex_bot.html.markdown index 6d9e6dc1a1d7..cdae2e51e57d 100644 --- a/website/docs/cdktf/python/d/lex_bot.html.markdown +++ b/website/docs/cdktf/python/d/lex_bot.html.markdown @@ -36,6 +36,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `name` - (Required) Name of the bot. The name is case sensitive. * `version` - (Optional) Version or alias of the bot. @@ -60,4 +61,4 @@ This data source exports the following attributes in addition to the arguments a * `version` - Version of the bot. For a new bot, the version is always `$LATEST`. * `voice_id` - Amazon Polly voice ID that the Amazon Lex Bot uses for voice interactions with the user. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/lex_bot_alias.html.markdown b/website/docs/cdktf/python/d/lex_bot_alias.html.markdown index f3b40f5f86b2..c80c1109433e 100644 --- a/website/docs/cdktf/python/d/lex_bot_alias.html.markdown +++ b/website/docs/cdktf/python/d/lex_bot_alias.html.markdown @@ -36,6 +36,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `bot_name` - (Required) Name of the bot. * `name` - (Required) Name of the bot alias. The name is case sensitive. @@ -52,4 +53,4 @@ This data source exports the following attributes in addition to the arguments a * `last_updated_date` - Date that the bot alias was updated. When you create a resource, the creation date and the last updated date are the same. * `name` - Name of the alias. The name is not case sensitive. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/lex_intent.html.markdown b/website/docs/cdktf/python/d/lex_intent.html.markdown index d1dde1e2153c..7cf827cdb701 100644 --- a/website/docs/cdktf/python/d/lex_intent.html.markdown +++ b/website/docs/cdktf/python/d/lex_intent.html.markdown @@ -36,6 +36,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `name` - (Required) Name of the intent. The name is case sensitive. * `version` - (Optional) Version of the intent. @@ -56,4 +57,4 @@ intent on. To find the signature for an intent, see in the Alexa Skills Kit. * `version` - Version of the bot. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/lex_slot_type.html.markdown b/website/docs/cdktf/python/d/lex_slot_type.html.markdown index 4f714e2084fc..0b968f30c254 100644 --- a/website/docs/cdktf/python/d/lex_slot_type.html.markdown +++ b/website/docs/cdktf/python/d/lex_slot_type.html.markdown @@ -36,6 +36,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `name` - (Required) Name of the slot type. The name is case sensitive. * `version` - (Optional) Version of the slot type. @@ -58,4 +59,4 @@ value is similar to the slot value. `TOP_RESOLUTION` returns the first value in if there is a resolution list for the slot, otherwise null is returned. * `version` - Version of the slot type. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/licensemanager_grants.html.markdown b/website/docs/cdktf/python/d/licensemanager_grants.html.markdown index 8090e28aadf7..f19680725df6 100644 --- a/website/docs/cdktf/python/d/licensemanager_grants.html.markdown +++ b/website/docs/cdktf/python/d/licensemanager_grants.html.markdown @@ -43,6 +43,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `filter` - (Optional) Custom filter block as described below. ### `filter` @@ -82,4 +83,4 @@ This data source exports the following attributes in addition to the arguments a * `arns` - List of all the license grant ARNs found. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/licensemanager_received_license.html.markdown b/website/docs/cdktf/python/d/licensemanager_received_license.html.markdown index be08e97c2729..7d05d4b2e902 100644 --- a/website/docs/cdktf/python/d/licensemanager_received_license.html.markdown +++ b/website/docs/cdktf/python/d/licensemanager_received_license.html.markdown @@ -37,6 +37,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `license_arn` - (Required) The ARN of the received license you want data for. ## Attribute Reference @@ -120,4 +121,4 @@ A list with a single map. * `begin` - Start of the validity time range. * `end` - End of the validity time range. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/licensemanager_received_licenses.html.markdown b/website/docs/cdktf/python/d/licensemanager_received_licenses.html.markdown index 59280997bfbd..d2b3d23d8b28 100644 --- a/website/docs/cdktf/python/d/licensemanager_received_licenses.html.markdown +++ b/website/docs/cdktf/python/d/licensemanager_received_licenses.html.markdown @@ -41,6 +41,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `filter` - (Optional) Custom filter block as described below. ### `filter` @@ -80,4 +81,4 @@ This data source exports the following attributes in addition to the arguments a * `arns` - List of all the license ARNs found. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/location_geofence_collection.html.markdown b/website/docs/cdktf/python/d/location_geofence_collection.html.markdown index 065b3d1a2a05..158438bbea97 100644 --- a/website/docs/cdktf/python/d/location_geofence_collection.html.markdown +++ b/website/docs/cdktf/python/d/location_geofence_collection.html.markdown @@ -35,8 +35,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `collection_name` - (Required) Name of the geofence collection. ## Attribute Reference @@ -50,4 +51,4 @@ This data source exports the following attributes in addition to the arguments a * `tags` - Key-value map of resource tags for the geofence collection. * `update_time` - Timestamp for when the geofence collection resource was last updated in ISO 8601 format. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/location_map.html.markdown b/website/docs/cdktf/python/d/location_map.html.markdown index 9b4bf1fe01c3..77874edebb08 100644 --- a/website/docs/cdktf/python/d/location_map.html.markdown +++ b/website/docs/cdktf/python/d/location_map.html.markdown @@ -35,6 +35,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `map_name` - (Required) Name of the map resource. ## Attribute Reference @@ -49,4 +50,4 @@ This data source exports the following attributes in addition to the arguments a * `tags` - Key-value map of resource tags for the map. * `update_time` - Timestamp for when the map resource was last updated in ISO 8601 format. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/location_place_index.html.markdown b/website/docs/cdktf/python/d/location_place_index.html.markdown index b56c9eb23d91..f0f6bb061ed9 100644 --- a/website/docs/cdktf/python/d/location_place_index.html.markdown +++ b/website/docs/cdktf/python/d/location_place_index.html.markdown @@ -35,6 +35,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `index_name` - (Required) Name of the place index resource. ## Attribute Reference @@ -49,4 +50,4 @@ This data source exports the following attributes in addition to the arguments a * `tags` - Key-value map of resource tags for the place index. * `update_time` - Timestamp for when the place index resource was last updated in ISO 8601 format. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/location_route_calculator.html.markdown b/website/docs/cdktf/python/d/location_route_calculator.html.markdown index c2df5c4ed156..f9af9d21d067 100644 --- a/website/docs/cdktf/python/d/location_route_calculator.html.markdown +++ b/website/docs/cdktf/python/d/location_route_calculator.html.markdown @@ -35,6 +35,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `calculator_name` - (Required) Name of the route calculator resource. ## Attribute Reference @@ -48,4 +49,4 @@ This data source exports the following attributes in addition to the arguments a * `tags` - Key-value map of resource tags for the route calculator. * `update_time` - Timestamp for when the route calculator resource was last updated in ISO 8601 format. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/location_tracker.html.markdown b/website/docs/cdktf/python/d/location_tracker.html.markdown index d7da7589af11..4a1a18cbb2a2 100644 --- a/website/docs/cdktf/python/d/location_tracker.html.markdown +++ b/website/docs/cdktf/python/d/location_tracker.html.markdown @@ -35,6 +35,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `tracker_name` - (Required) Name of the tracker resource. ## Attribute Reference @@ -49,4 +50,4 @@ This data source exports the following attributes in addition to the arguments a * `tracker_arn` - ARN for the tracker resource. Used when you need to specify a resource across all AWS. * `update_time` - Timestamp for when the tracker resource was last updated in ISO 8601 format. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/location_tracker_association.html.markdown b/website/docs/cdktf/python/d/location_tracker_association.html.markdown index d9a7a50ca571..d20c998b1175 100644 --- a/website/docs/cdktf/python/d/location_tracker_association.html.markdown +++ b/website/docs/cdktf/python/d/location_tracker_association.html.markdown @@ -36,8 +36,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `consumer_arn` - (Required) ARN of the geofence collection associated to tracker resource. * `tracker_name` - (Required) Name of the tracker resource associated with a geofence collection. @@ -45,4 +46,4 @@ The following arguments are required: This data source exports no additional attributes. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/location_tracker_associations.html.markdown b/website/docs/cdktf/python/d/location_tracker_associations.html.markdown index 3c5357332a92..672c304d9079 100644 --- a/website/docs/cdktf/python/d/location_tracker_associations.html.markdown +++ b/website/docs/cdktf/python/d/location_tracker_associations.html.markdown @@ -35,8 +35,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `tracker_name` - (Required) Name of the tracker resource associated with a geofence collection. ## Attribute Reference @@ -45,4 +46,4 @@ This data source exports the following attributes in addition to the arguments a * `consumer_arns` - List of geofence collection ARNs associated to the tracker resource. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/media_convert_queue.html.markdown b/website/docs/cdktf/python/d/media_convert_queue.html.markdown index c6d16e3c52be..c53e793985c1 100644 --- a/website/docs/cdktf/python/d/media_convert_queue.html.markdown +++ b/website/docs/cdktf/python/d/media_convert_queue.html.markdown @@ -35,6 +35,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `id` - (Required) Unique identifier of the queue. The same as `name`. ## Attribute Reference @@ -46,4 +47,4 @@ This data source exports the following attributes in addition to the arguments a * `status` - The status of the queue. * `tags` - A map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/medialive_input.html.markdown b/website/docs/cdktf/python/d/medialive_input.html.markdown index 625c43eb3a93..bb3732791a64 100644 --- a/website/docs/cdktf/python/d/medialive_input.html.markdown +++ b/website/docs/cdktf/python/d/medialive_input.html.markdown @@ -35,8 +35,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `id` - (Required) The ID of the Input. ## Attribute Reference @@ -59,4 +60,4 @@ This data source exports the following attributes in addition to the arguments a * `tags` - A map of tags assigned to the Input. * `type` - The type of the input. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/memorydb_acl.html.markdown b/website/docs/cdktf/python/d/memorydb_acl.html.markdown index 32b141af2b71..5a9670541ea3 100644 --- a/website/docs/cdktf/python/d/memorydb_acl.html.markdown +++ b/website/docs/cdktf/python/d/memorydb_acl.html.markdown @@ -33,8 +33,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `name` - (Required) Name of the ACL. ## Attribute Reference @@ -47,4 +48,4 @@ This data source exports the following attributes in addition to the arguments a * `tags` - Map of tags assigned to the ACL. * `user_names` - Set of MemoryDB user names included in this ACL. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/memorydb_cluster.html.markdown b/website/docs/cdktf/python/d/memorydb_cluster.html.markdown index cc84154b01bb..3fb83b08c0b6 100644 --- a/website/docs/cdktf/python/d/memorydb_cluster.html.markdown +++ b/website/docs/cdktf/python/d/memorydb_cluster.html.markdown @@ -33,8 +33,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `name` - (Required) Name of the cluster. ## Attribute Reference @@ -80,4 +81,4 @@ This data source exports the following attributes in addition to the arguments a * `tls_enabled` - When true, in-transit encryption is enabled for the cluster. * `tags` - Map of tags assigned to the cluster. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/memorydb_parameter_group.html.markdown b/website/docs/cdktf/python/d/memorydb_parameter_group.html.markdown index 94ccc96dbeb1..9e2224d29a40 100644 --- a/website/docs/cdktf/python/d/memorydb_parameter_group.html.markdown +++ b/website/docs/cdktf/python/d/memorydb_parameter_group.html.markdown @@ -33,8 +33,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `name` - (Required) Name of the parameter group. ## Attribute Reference @@ -50,4 +51,4 @@ This data source exports the following attributes in addition to the arguments a * `value` - Value of the parameter. * `tags` - Map of tags assigned to the parameter group. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/memorydb_snapshot.html.markdown b/website/docs/cdktf/python/d/memorydb_snapshot.html.markdown index e07bcacf55cf..549590bd8a7e 100644 --- a/website/docs/cdktf/python/d/memorydb_snapshot.html.markdown +++ b/website/docs/cdktf/python/d/memorydb_snapshot.html.markdown @@ -33,8 +33,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `name` - (Required) Name of the snapshot. ## Attribute Reference @@ -63,4 +64,4 @@ This data source exports the following attributes in addition to the arguments a * `source` - Whether the snapshot is from an automatic backup (`automated`) or was created manually (`manual`). * `tags` - Map of tags assigned to the snapshot. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/memorydb_subnet_group.html.markdown b/website/docs/cdktf/python/d/memorydb_subnet_group.html.markdown index 2612ca33647f..0a74587c4fe2 100644 --- a/website/docs/cdktf/python/d/memorydb_subnet_group.html.markdown +++ b/website/docs/cdktf/python/d/memorydb_subnet_group.html.markdown @@ -33,8 +33,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `name` - (Required) Name of the subnet group. ## Attribute Reference @@ -48,4 +49,4 @@ This data source exports the following attributes in addition to the arguments a * `vpc_id` - VPC in which the subnet group exists. * `tags` - Map of tags assigned to the subnet group. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/memorydb_user.html.markdown b/website/docs/cdktf/python/d/memorydb_user.html.markdown index efe33dec939c..18a0a6a894d9 100644 --- a/website/docs/cdktf/python/d/memorydb_user.html.markdown +++ b/website/docs/cdktf/python/d/memorydb_user.html.markdown @@ -33,8 +33,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `user_name` - (Required) Name of the user. ## Attribute Reference @@ -50,4 +51,4 @@ This data source exports the following attributes in addition to the arguments a * `minimum_engine_version` - Minimum engine version supported for the user. * `tags` - Map of tags assigned to the user. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/mq_broker.html.markdown b/website/docs/cdktf/python/d/mq_broker.html.markdown index 89a1db0aa3bb..8b79e44664b6 100644 --- a/website/docs/cdktf/python/d/mq_broker.html.markdown +++ b/website/docs/cdktf/python/d/mq_broker.html.markdown @@ -3,21 +3,21 @@ subcategory: "MQ" layout: "aws" page_title: "AWS: aws_mq_broker" description: |- - Provides a MQ Broker data source. + Provides details about an existing Amazon MQ broker. --- # Data Source: aws_mq_broker -Provides information about a MQ Broker. +Provides details about an existing Amazon MQ broker. Use this data source to retrieve configuration and metadata for an Amazon MQ broker by ID or name. ## 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 VariableType, TerraformVariable, TerraformStack +from cdktf import TerraformStack # # Provider bindings are generated by running `cdktf get`. # See https://cdk.tf/provider-generation for more details. @@ -26,36 +26,90 @@ from imports.aws.data_aws_mq_broker import DataAwsMqBroker class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) - # Terraform Variables are not always the best fit for getting inputs in the context of Terraform CDK. - # You can read more about this at https://cdk.tf/variables - broker_id = TerraformVariable(self, "broker_id", - default="", - type=VariableType.STRING - ) - broker_name = TerraformVariable(self, "broker_name", - default="", - type=VariableType.STRING - ) - DataAwsMqBroker(self, "by_id", - broker_id=broker_id.string_value - ) - DataAwsMqBroker(self, "by_name", - broker_name=broker_name.string_value + DataAwsMqBroker(self, "example", + broker_id="b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9" ) ``` ## Argument Reference -This data source supports the following arguments: +The following arguments are optional: -* `broker_id` - (Optional) Unique id of the mq broker. -* `broker_name` - (Optional) Unique name of the mq broker. +* `broker_id` - (Optional) Unique ID of the MQ broker. +* `broker_name` - (Optional) Unique name of the MQ broker. +* `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). +~> **Note:** Either `broker_id` or `broker_name` must be specified. ## Attribute Reference This data source exports the following attributes in addition to the arguments above: -See the [`aws_mq_broker` resource](/docs/providers/aws/r/mq_broker.html) for details on the returned attributes. -They are identical except for user password, which is not returned when describing broker. +* `arn` - ARN of the broker. +* `authentication_strategy` - Authentication strategy used to secure the broker. +* `auto_minor_version_upgrade` - Whether to automatically upgrade to new minor versions of brokers as Amazon MQ makes releases available. +* `configuration` - Configuration block for broker configuration. See [Configuration](#configuration) below. +* `deployment_mode` - Deployment mode of the broker. +* `encryption_options` - Configuration block containing encryption options. See [Encryption Options](#encryption-options) below. +* `engine_type` - Type of broker engine. +* `engine_version` - Version of the broker engine. +* `host_instance_type` - Broker's instance type. +* `instances` - List of information about allocated brokers (both active & standby). See [Instances](#instances) below. +* `ldap_server_metadata` - Configuration block for the LDAP server used to authenticate and authorize connections to the broker. See [LDAP Server Metadata](#ldap-server-metadata) below. +* `logs` - Configuration block for the logging configuration of the broker. See [Logs](#logs) below. +* `maintenance_window_start_time` - Configuration block for the maintenance window start time. See [Maintenance Window Start Time](#maintenance-window-start-time) below. +* `publicly_accessible` - Whether to enable connections from applications outside of the VPC that hosts the broker's subnets. +* `security_groups` - List of security group IDs assigned to the broker. +* `storage_type` - Storage type of the broker. +* `subnet_ids` - List of subnet IDs in which to launch the broker. +* `tags` - Map of tags assigned to the broker. +* `user` - Configuration block for broker users. See [User](#user) below. + +### Configuration + +* `id` - Configuration ID. +* `revision` - Revision of the Configuration. + +### Encryption Options + +* `kms_key_id` - Amazon Resource Name (ARN) of Key Management Service (KMS) Customer Master Key (CMK) to use for encryption at rest. +* `use_aws_owned_key` - Whether to enable an AWS-owned KMS CMK that is not in your account. + +### Instances + +* `console_url` - URL of the ActiveMQ Web Console or the RabbitMQ Management UI depending on `engine_type`. +* `endpoints` - Broker's wire-level protocol endpoints. +* `ip_address` - IP Address of the broker. + +### LDAP Server Metadata + +* `hosts` - List of a fully qualified domain name of the LDAP server and an optional failover server. +* `role_base` - Fully qualified name of the directory to search for a user's groups. +* `role_name` - LDAP attribute that identifies the group name attribute in the object returned from the group membership query. +* `role_search_matching` - Search criteria for groups. +* `role_search_subtree` - Whether the directory search scope is the entire sub-tree. +* `service_account_password` - Service account password. +* `service_account_username` - Service account username. +* `user_base` - Fully qualified name of the directory where you want to search for users. +* `user_role_name` - Name of the LDAP attribute for the user group membership. +* `user_search_matching` - Search criteria for users. +* `user_search_subtree` - Whether the directory search scope is the entire sub-tree. + +### Logs + +* `audit` - Whether audit logging is enabled. +* `general` - Whether general logging is enabled. + +### Maintenance Window Start Time + +* `day_of_week` - Day of the week. +* `time_of_day` - Time, in 24-hour format. +* `time_zone` - Time zone in either the Country/City format or the UTC offset format. + +### User + +* `console_access` - Whether to enable access to the ActiveMQ Web Console for the user. +* `groups` - List of groups to which the ActiveMQ user belongs. +* `replication_user` - Whether to set replication user. +* `username` - Username of the user. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/mq_broker_engine_types.html.markdown b/website/docs/cdktf/python/d/mq_broker_engine_types.html.markdown index 2665594885f8..b5f372cc277e 100644 --- a/website/docs/cdktf/python/d/mq_broker_engine_types.html.markdown +++ b/website/docs/cdktf/python/d/mq_broker_engine_types.html.markdown @@ -3,19 +3,17 @@ subcategory: "MQ" layout: "aws" page_title: "AWS: aws_mq_broker_engine_types" description: |- - Retrieve information about available broker engines. + Provides details about available MQ broker engine types. --- # Data Source: aws_mq_broker_engine_types -Retrieve information about available broker engines. +Provides details about available MQ broker engine types. Use this data source to retrieve supported engine types and their versions for Amazon MQ brokers. ## 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 @@ -37,17 +35,22 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: -* `engine_type` - (Optional) The MQ engine type to return version details for. +* `engine_type` - (Optional) MQ engine type to return version details for. +* `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). ## Attribute Reference This data source exports the following attributes in addition to the arguments above: -* `broker_engine_types` - A list of available engine types and versions. See [Engine Types](#engine-types). +* `broker_engine_types` - List of available engine types and versions. See [Engine Types](#engine-types). + +### Engine Types + +* `engine_type` - Broker's engine type. +* `engine_versions` - List of engine versions. See [Engine Versions](#engine-versions). -### engine-types +### Engine Versions -* `engine_type` - The broker's engine type. -* `engine_versions` - The list of engine versions. +* `name` - Name of the engine version. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/mq_broker_instance_type_offerings.html.markdown b/website/docs/cdktf/python/d/mq_broker_instance_type_offerings.html.markdown index 9bd34eb6e55b..b278adc1afe4 100644 --- a/website/docs/cdktf/python/d/mq_broker_instance_type_offerings.html.markdown +++ b/website/docs/cdktf/python/d/mq_broker_instance_type_offerings.html.markdown @@ -3,14 +3,14 @@ subcategory: "MQ" layout: "aws" page_title: "AWS: aws_mq_broker_instance_type_offerings" description: |- - Provides a MQ Broker Instance Offerings data source. + Provides details about available MQ broker instance type offerings. --- # Data Source: aws_mq_broker_instance_type_offerings -Provides information about a MQ Broker Instance Offerings. +Provides details about available MQ broker instance type offerings. Use this data source to discover supported instance types, storage types, and deployment modes for Amazon MQ brokers. ## Example Usage @@ -26,48 +26,49 @@ from imports.aws.data_aws_mq_broker_instance_type_offerings import DataAwsMqBrok class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) - DataAwsMqBrokerInstanceTypeOfferings(self, "all", + DataAwsMqBrokerInstanceTypeOfferings(self, "activemq", + engine_type="ACTIVEMQ" + ) + DataAwsMqBrokerInstanceTypeOfferings(self, "all") + DataAwsMqBrokerInstanceTypeOfferings(self, "ebs", + storage_type="EBS" + ) + DataAwsMqBrokerInstanceTypeOfferings(self, "filtered", engine_type="ACTIVEMQ", host_instance_type="mq.m5.large", storage_type="EBS" ) - DataAwsMqBrokerInstanceTypeOfferings(self, "empty") - DataAwsMqBrokerInstanceTypeOfferings(self, "engine", - engine_type="ACTIVEMQ" - ) - DataAwsMqBrokerInstanceTypeOfferings(self, "instance", + DataAwsMqBrokerInstanceTypeOfferings(self, "m5", host_instance_type="mq.m5.large" ) - DataAwsMqBrokerInstanceTypeOfferings(self, "storage", - storage_type="EBS" - ) ``` ## Argument Reference -This data source supports the following arguments: +The following arguments are optional: * `engine_type` - (Optional) Filter response by engine type. * `host_instance_type` - (Optional) Filter response by host instance type. +* `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). * `storage_type` - (Optional) Filter response by storage type. ## Attribute Reference This data source exports the following attributes in addition to the arguments above: -* `broker_instance_options` - Option for host instance type. See Broker Instance Options below. +* `broker_instance_options` - List of broker instance options. See [Broker Instance Options](#broker-instance-options) below. ### Broker Instance Options -* `availability_zones` - List of available AZs. See Availability Zones. below +* `availability_zones` - List of available Availability Zones. See [Availability Zones](#availability-zones) below. * `engine_type` - Broker's engine type. * `host_instance_type` - Broker's instance type. * `storage_type` - Broker's storage type. -* `supported_deployment_modes` - The list of supported deployment modes. -* `supported_engine_versions` - The list of supported engine versions. +* `supported_deployment_modes` - List of supported deployment modes. +* `supported_engine_versions` - List of supported engine versions. ### Availability Zones * `name` - Name of the Availability Zone. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/msk_bootstrap_brokers.html.markdown b/website/docs/cdktf/python/d/msk_bootstrap_brokers.html.markdown index 5093da9ee30a..ff12dfb7000b 100644 --- a/website/docs/cdktf/python/d/msk_bootstrap_brokers.html.markdown +++ b/website/docs/cdktf/python/d/msk_bootstrap_brokers.html.markdown @@ -35,6 +35,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `cluster_arn` - (Required) ARN of the cluster the nodes belong to. ## Attribute Reference @@ -52,4 +53,4 @@ This data source exports the following attributes in addition to the arguments a * `bootstrap_brokers_vpc_connectivity_sasl_scram` - A string containing one or more DNS names (or IP addresses) and SASL SCRAM port pairs for VPC connectivity. * `bootstrap_brokers_vpc_connectivity_tls` - A string containing one or more DNS names (or IP addresses) and TLS port pairs for VPC connectivity. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/msk_broker_nodes.html.markdown b/website/docs/cdktf/python/d/msk_broker_nodes.html.markdown index 85cb40ae6117..7d0feb19fc31 100644 --- a/website/docs/cdktf/python/d/msk_broker_nodes.html.markdown +++ b/website/docs/cdktf/python/d/msk_broker_nodes.html.markdown @@ -35,6 +35,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `cluster_arn` - (Required) ARN of the cluster the nodes belong to. ## Attribute Reference @@ -52,4 +53,4 @@ This data source exports the following attributes in addition to the arguments a * `endpoints` - Set of endpoints for accessing the broker. This does not include ports * `node_arn` - ARN of the node - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/msk_cluster.html.markdown b/website/docs/cdktf/python/d/msk_cluster.html.markdown index 5ded5ddf3be1..67448f0b07e0 100644 --- a/website/docs/cdktf/python/d/msk_cluster.html.markdown +++ b/website/docs/cdktf/python/d/msk_cluster.html.markdown @@ -37,6 +37,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `cluster_name` - (Required) Name of the cluster. ## Attribute Reference @@ -59,4 +60,4 @@ This data source exports the following attributes in addition to the arguments a * `zookeeper_connect_string` - A comma separated list of one or more hostname:port pairs to use to connect to the Apache Zookeeper cluster. The returned values are sorted alphbetically. The AWS API may not return all endpoints, so this value is not guaranteed to be stable across applies. * `zookeeper_connect_string_tls` - A comma separated list of one or more hostname:port pairs to use to connect to the Apache Zookeeper cluster via TLS. The returned values are sorted alphabetically. The AWS API may not return all endpoints, so this value is not guaranteed to be stable across applies. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/msk_configuration.html.markdown b/website/docs/cdktf/python/d/msk_configuration.html.markdown index de87cb089664..7b313b12f02f 100644 --- a/website/docs/cdktf/python/d/msk_configuration.html.markdown +++ b/website/docs/cdktf/python/d/msk_configuration.html.markdown @@ -35,6 +35,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `name` - (Required) Name of the configuration. ## Attribute Reference @@ -47,4 +48,4 @@ This data source exports the following attributes in addition to the arguments a * `kafka_versions` - List of Apache Kafka versions which can use this configuration. * `server_properties` - Contents of the server.properties file. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/msk_kafka_version.html.markdown b/website/docs/cdktf/python/d/msk_kafka_version.html.markdown index 83342b2c2452..461f754ef78f 100644 --- a/website/docs/cdktf/python/d/msk_kafka_version.html.markdown +++ b/website/docs/cdktf/python/d/msk_kafka_version.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `preferred_versions` - (Optional) Ordered list of preferred Kafka versions. The first match in this list will be returned. Either `preferred_versions` or `version` must be set. * `version` - (Optional) Version of MSK Kafka. For example 2.4.1.1 or "2.2.1" etc. Either `preferred_versions` or `version` must be set. @@ -47,4 +48,4 @@ This data source exports the following attributes in addition to the arguments a * `status` - Status of the MSK Kafka version eg. `ACTIVE` or `DEPRECATED`. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/msk_vpc_connection.html.markdown b/website/docs/cdktf/python/d/msk_vpc_connection.html.markdown index c4b52550d13f..b3b3b57e8306 100644 --- a/website/docs/cdktf/python/d/msk_vpc_connection.html.markdown +++ b/website/docs/cdktf/python/d/msk_vpc_connection.html.markdown @@ -34,6 +34,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `arn` - (Required) ARN of the VPC Connection. ## Attribute Reference @@ -47,4 +48,4 @@ This data source exports the following attributes in addition to the arguments a * `target_cluster_arn` - The Amazon Resource Name (ARN) of the cluster. * `vpc_id` - The VPC ID of the remote client. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/mskconnect_connector.html.markdown b/website/docs/cdktf/python/d/mskconnect_connector.html.markdown index 6efc668de6cf..8c2a11610e7e 100644 --- a/website/docs/cdktf/python/d/mskconnect_connector.html.markdown +++ b/website/docs/cdktf/python/d/mskconnect_connector.html.markdown @@ -35,6 +35,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `name` - (Required) Name of the connector. ## Attribute Reference @@ -46,4 +47,4 @@ This data source exports the following attributes in addition to the arguments a * `tags` - A map of tags assigned to the resource. * `version` - Current version of the connector. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/mskconnect_custom_plugin.html.markdown b/website/docs/cdktf/python/d/mskconnect_custom_plugin.html.markdown index 417f974a09e1..d99ef5c5089a 100644 --- a/website/docs/cdktf/python/d/mskconnect_custom_plugin.html.markdown +++ b/website/docs/cdktf/python/d/mskconnect_custom_plugin.html.markdown @@ -35,6 +35,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `name` - (Required) Name of the custom plugin. ## Attribute Reference @@ -47,4 +48,4 @@ This data source exports the following attributes in addition to the arguments a * `state` - the state of the custom plugin. * `tags` - A map of tags assigned to the resource. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/mskconnect_worker_configuration.html.markdown b/website/docs/cdktf/python/d/mskconnect_worker_configuration.html.markdown index 6267f3eda1d4..aba808760865 100644 --- a/website/docs/cdktf/python/d/mskconnect_worker_configuration.html.markdown +++ b/website/docs/cdktf/python/d/mskconnect_worker_configuration.html.markdown @@ -35,6 +35,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `name` - (Required) Name of the worker configuration. ## Attribute Reference @@ -47,4 +48,4 @@ This data source exports the following attributes in addition to the arguments a * `properties_file_content` - contents of connect-distributed.properties file. * `tags` - A map of tags assigned to the resource. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/nat_gateway.html.markdown b/website/docs/cdktf/python/d/nat_gateway.html.markdown index 47d72052e174..8022276747b9 100644 --- a/website/docs/cdktf/python/d/nat_gateway.html.markdown +++ b/website/docs/cdktf/python/d/nat_gateway.html.markdown @@ -57,6 +57,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `id` - (Optional) ID of the specific NAT Gateway to retrieve. * `subnet_id` - (Optional) ID of subnet that the NAT Gateway resides in. * `vpc_id` - (Optional) ID of the VPC that the NAT Gateway resides in. @@ -98,4 +99,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/nat_gateways.html.markdown b/website/docs/cdktf/python/d/nat_gateways.html.markdown index 898d5b37cf1b..6194e2fc1193 100644 --- a/website/docs/cdktf/python/d/nat_gateways.html.markdown +++ b/website/docs/cdktf/python/d/nat_gateways.html.markdown @@ -53,6 +53,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `filter` - (Optional) Custom filter block as described below. * `vpc_id` - (Optional) VPC ID that you want to filter from. * `tags` - (Optional) Map of tags, each pair of which must exactly match @@ -80,4 +81,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/neptune_engine_version.html.markdown b/website/docs/cdktf/python/d/neptune_engine_version.html.markdown index 09d8badaebb8..6e559f0977e6 100644 --- a/website/docs/cdktf/python/d/neptune_engine_version.html.markdown +++ b/website/docs/cdktf/python/d/neptune_engine_version.html.markdown @@ -46,6 +46,7 @@ This data source supports the following arguments: * `preferred_major_targets` - (Optional) Ordered list of preferred major engine versions. * `preferred_upgrade_targets` - (Optional) Ordered list of preferred upgrade engine versions. * `preferred_versions` - (Optional) Ordered list of preferred engine versions. The first match in this list will be returned. If no preferred matches are found and the original search returned more than one result, an error is returned. If both the `version` and `preferred_versions` arguments are not configured, the data source will return the default version for the engine. +* `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). * `version` - (Optional) Version of the DB engine. For example, `1.0.1.0`, `1.0.2.2`, and `1.0.3.0`. If both the `version` and `preferred_versions` arguments are not configured, the data source will return the default version for the engine. ## Attribute Reference @@ -66,4 +67,4 @@ This data source exports the following attributes in addition to the arguments a * `version_actual` - Actual engine version returned by the API. * `version_description` - Description of the database engine version. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/neptune_orderable_db_instance.html.markdown b/website/docs/cdktf/python/d/neptune_orderable_db_instance.html.markdown index 14571598b5b0..710ee98264f8 100644 --- a/website/docs/cdktf/python/d/neptune_orderable_db_instance.html.markdown +++ b/website/docs/cdktf/python/d/neptune_orderable_db_instance.html.markdown @@ -36,6 +36,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `engine` - (Optional) DB engine. (Default: `neptune`) * `engine_version` - (Optional) Version of the DB engine. For example, `1.0.1.0`, `1.0.1.2`, `1.0.2.2`, and `1.0.3.0`. * `instance_class` - (Optional) DB instance class. Examples of classes are `db.r5.large`, `db.r5.xlarge`, `db.r4.large`, `db.r5.4xlarge`, `db.r5.12xlarge`, `db.r4.xlarge`, and `db.t3.medium`. @@ -63,4 +64,4 @@ This data source exports the following attributes in addition to the arguments a * `supports_performance_insights` - Whether a DB instance supports Performance Insights. * `supports_storage_encryption` - Whether a DB instance supports encrypted storage. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/network_acls.html.markdown b/website/docs/cdktf/python/d/network_acls.html.markdown index 3a3d88488772..e4ccbed48ef3 100644 --- a/website/docs/cdktf/python/d/network_acls.html.markdown +++ b/website/docs/cdktf/python/d/network_acls.html.markdown @@ -88,6 +88,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `vpc_id` - (Optional) VPC ID that you want to filter from. * `tags` - (Optional) Map of tags, each pair of which must exactly match a pair on the desired network ACLs. @@ -115,4 +116,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/network_interface.html.markdown b/website/docs/cdktf/python/d/network_interface.html.markdown index f5c509a0ab9e..a31d42efda6b 100644 --- a/website/docs/cdktf/python/d/network_interface.html.markdown +++ b/website/docs/cdktf/python/d/network_interface.html.markdown @@ -35,15 +35,17 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: -* `id` – (Optional) Identifier for the network interface. -* `filter` – (Optional) One or more name/value pairs to filter off of. There are several valid keys, for a full reference, check out [describe-network-interfaces](https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-network-interfaces.html) in the AWS CLI reference. +* `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). +* `id` - (Optional) Identifier for the network interface. +* `filter` - (Optional) One or more name/value pairs to filter off of. There are several valid keys, for a full reference, check out [describe-network-interfaces](https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-network-interfaces.html) in the AWS CLI reference. ## Attribute Reference This data source exports the following attributes in addition to the arguments above: * `arn` - ARN of the network interface. -* `association` - Association information for an Elastic IP address (IPv4) associated with the network interface. See supported fields below. +* `association` - Association information for an Elastic IP address (IPv4) associated with the network interface. See [association](#association) below. +* `attachment` - Attachment of the ENI. See [attachment](#attachment) below. * `availability_zone` - Availability Zone. * `description` - Description of the network interface. * `interface_type` - Type of interface. @@ -70,10 +72,18 @@ This data source exports the following attributes in addition to the arguments a * `public_dns_name` - Public DNS name. * `public_ip` - Address of the Elastic IP address bound to the network interface. +### `attachment` + +* `attachment_id` - ID of the network interface attachment. +* `device_index` - Device index of the network interface attachment on the instance. +* `instance_id` - ID of the instance. +* `instance_owner_id` - AWS account ID of the owner of the instance. +* `network_card_index` - Index of the network card. + ## Timeouts [Configuration options](https://developer.hashicorp.com/terraform/language/resources/syntax#operation-timeouts): - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/network_interfaces.html.markdown b/website/docs/cdktf/python/d/network_interfaces.html.markdown index 646ca97d94fa..8ebcea51f062 100644 --- a/website/docs/cdktf/python/d/network_interfaces.html.markdown +++ b/website/docs/cdktf/python/d/network_interfaces.html.markdown @@ -91,6 +91,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `tags` - (Optional) Map of tags, each pair of which must exactly match a pair on the desired network interfaces. * `filter` - (Optional) Custom filter block as described below. @@ -116,4 +117,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/networkfirewall_firewall.html.markdown b/website/docs/cdktf/python/d/networkfirewall_firewall.html.markdown index d5f14e1fe6fe..36c75ee9a732 100644 --- a/website/docs/cdktf/python/d/networkfirewall_firewall.html.markdown +++ b/website/docs/cdktf/python/d/networkfirewall_firewall.html.markdown @@ -76,6 +76,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `arn` - ARN of the firewall. * `name` - Descriptive name of the firewall. @@ -86,6 +87,9 @@ One or more of these arguments is required. This data source exports the following attributes in addition to the arguments above: * `arn` - ARN of the firewall. +* `availability_zone_change_protection` - Indicates whether the firewall is protected against changes to its Availability Zone configuration. +* `availability_zone_mapping` - Set of Availability Zones where the firewall endpoints are created for a transit gateway-attached firewall. + * `availability_zone_id` - The ID of the Availability Zone where the firewall endpoint is located. * `delete_protection` - A flag indicating whether the firewall is protected against deletion. * `description` - Description of the firewall. * `enabled_analysis_types` - Set of types for which to collect analysis metrics. @@ -98,6 +102,8 @@ This data source exports the following attributes in addition to the arguments a * `sync_states` - Set of subnets configured for use by the firewall. * `attachment` - Nested list describing the attachment status of the firewall's association with a single VPC subnet. * `endpoint_id` - The identifier of the firewall endpoint that AWS Network Firewall has instantiated in the subnet. You use this to identify the firewall endpoint in the VPC route tables, when you redirect the VPC traffic through the endpoint. + * `status` - The current status of the firewall endpoint instantiation in the subnet. + * `status_message` - It populates this with the reason for the error or failure and how to resolve it. A FAILED status indicates a non-recoverable state, and a ERROR status indicates an issue that you can fix. * `subnet_id` - The unique identifier of the subnet that you've specified to be used for a firewall endpoint. * `availability_zone` - The Availability Zone where the subnet is configured. * `capacity_usage_summary` - Aggregated count of all resources used by reference sets in a firewall. @@ -107,6 +113,10 @@ This data source exports the following attributes in addition to the arguments a * `resolved_cidr_count` - Total number of CIDR blocks used by the IP set references in a firewall. * `utilized_cidr_count` - Number of CIDR blocks used by the IP set references in a firewall. * `configuration_sync_state_summary` - Summary of sync states for all availability zones in which the firewall is configured. + * `transit_gateway_attachment_sync_states` - Set of transit gateway configured for use by the firewall. + * `attachment_id` - The unique identifier of the transit gateway attachment. + * `status_message` - A message providing additional information about the current status. + * `transit_gateway_attachment_status` - The current status of the transit gateway attachment. * `id` - ARN that identifies the firewall. * `name` - Descriptive name of the firewall. * `subnet_change_protection` - A flag indicating whether the firewall is protected against changes to the subnet associations. @@ -114,6 +124,8 @@ This data source exports the following attributes in addition to the arguments a * `subnet_id` - The unique identifier for the subnet. * `tags` - Map of resource tags to associate with the resource. If configured with a provider [`default_tags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. * `update_token` - String token used when updating a firewall. +* `transit_gateway_id` - The unique identifier of the transit gateway associated with this firewall. +* `transit_gateway_owner_account_id` - The AWS account ID that owns the transit gateway. * `vpc_id` - Unique identifier of the VPC where AWS Network Firewall should create the firewall. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/networkfirewall_firewall_policy.html.markdown b/website/docs/cdktf/python/d/networkfirewall_firewall_policy.html.markdown index 3c9d987659b9..ab3751838915 100644 --- a/website/docs/cdktf/python/d/networkfirewall_firewall_policy.html.markdown +++ b/website/docs/cdktf/python/d/networkfirewall_firewall_policy.html.markdown @@ -80,6 +80,7 @@ AWS Network Firewall does not allow multiple firewall policies with the same nam This data source supports the following arguments: +* `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). * `arn` - ARN of the firewall policy. * `name` - Descriptive name of the firewall policy. @@ -97,4 +98,4 @@ This data source exports the following attributes in addition to the arguments a [1]: https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/ram_resource_share [2]: https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/networkfirewall_firewall_policy - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/networkfirewall_resource_policy.html.markdown b/website/docs/cdktf/python/d/networkfirewall_resource_policy.html.markdown index 21a7ba3ca462..37fc0507011e 100644 --- a/website/docs/cdktf/python/d/networkfirewall_resource_policy.html.markdown +++ b/website/docs/cdktf/python/d/networkfirewall_resource_policy.html.markdown @@ -35,6 +35,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `resource_arn` - (Required) The Amazon Resource Name (ARN) that identifies the resource policy. ## Attribute Reference @@ -46,4 +47,4 @@ This data source exports the following attributes in addition to the arguments a [1]: https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/networkfirewall_resource_policy - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/networkmanager_connection.html.markdown b/website/docs/cdktf/python/d/networkmanager_connection.html.markdown index 028edca460fb..302e79bfd51e 100644 --- a/website/docs/cdktf/python/d/networkmanager_connection.html.markdown +++ b/website/docs/cdktf/python/d/networkmanager_connection.html.markdown @@ -3,14 +3,14 @@ subcategory: "Network Manager" layout: "aws" page_title: "AWS: aws_networkmanager_connection" description: |- - Retrieve information about a connection. + Provides details about an existing Network Manager connection. --- # Data Source: aws_networkmanager_connection -Retrieve information about a connection. +Provides details about an existing Network Manager connection. ## Example Usage @@ -51,4 +51,4 @@ This data source exports the following attributes in addition to the arguments a * `link_id` - ID of the link for the first device. * `tags` - Key-value tags for the connection. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/networkmanager_connections.html.markdown b/website/docs/cdktf/python/d/networkmanager_connections.html.markdown index d800f64ee99d..4f46452533d2 100644 --- a/website/docs/cdktf/python/d/networkmanager_connections.html.markdown +++ b/website/docs/cdktf/python/d/networkmanager_connections.html.markdown @@ -3,14 +3,14 @@ subcategory: "Network Manager" layout: "aws" page_title: "AWS: aws_networkmanager_connections" description: |- - Retrieve information about connections. + Provides details about existing Network Manager connections. --- # Data Source: aws_networkmanager_connections -Retrieve information about connections. +Provides details about existing Network Manager connections. ## Example Usage @@ -48,4 +48,4 @@ This data source exports the following attributes in addition to the arguments a * `ids` - IDs of the connections. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/networkmanager_core_network_policy_document.html.markdown b/website/docs/cdktf/python/d/networkmanager_core_network_policy_document.html.markdown index e9882bdb511e..47fdcf09d74f 100644 --- a/website/docs/cdktf/python/d/networkmanager_core_network_policy_document.html.markdown +++ b/website/docs/cdktf/python/d/networkmanager_core_network_policy_document.html.markdown @@ -3,7 +3,7 @@ subcategory: "Network Manager" layout: "aws" page_title: "AWS: aws_networkmanager_core_network_policy_document" description: |- - Generates an Core Network policy document in JSON format + Generates a Core Network policy document in JSON format --- @@ -223,6 +223,8 @@ The following arguments are available: * `inside_cidr_blocks` (Optional) - The Classless Inter-Domain Routing (CIDR) block range used to create tunnels for AWS Transit Gateway Connect. The format is standard AWS CIDR range (for example, `10.0.1.0/24`). You can optionally define the inside CIDR in the Core Network Edges section per Region. The minimum is a `/24` for IPv4 or `/64` for IPv6. You can provide multiple `/24` subnets or a larger CIDR range. If you define a larger CIDR range, new Core Network Edges will be automatically assigned `/24` and `/64` subnets from the larger CIDR. an Inside CIDR block is required for attaching Connect attachments to a Core Network Edge. * `vpn_ecmp_support` (Optional) - Indicates whether the core network forwards traffic over multiple equal-cost routes using VPN. The value can be either `true` or `false`. The default is `true`. * `edge_locations` (Required) - A block value of AWS Region locations where you're creating Core Network Edges. Detailed below. +* `dns_support` (Optional) - Indicates whether DNS resolution is enabled for the core network. The value can be either `true` or `false`. When set to `true`, DNS resolution is enabled for VPCs attached to the core network, allowing resources in different VPCs to resolve each other's domain names. The default is `true`. +* `security_group_referencing_support` — (Optional) Indicates whether security group referencing is enabled for the core network. The value can be either `true` or `false`. When set to `true`, security groups in one VPC can reference security groups in another VPC attached to the core network, enabling more flexible security configurations across your network. The default is `false`. ### `edge_locations` @@ -281,4 +283,4 @@ This data source exports the following attributes in addition to the arguments a * `json` - Standard JSON policy document rendered based on the arguments above. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/networkmanager_device.html.markdown b/website/docs/cdktf/python/d/networkmanager_device.html.markdown index 2950e68579a3..98eb4e99689f 100644 --- a/website/docs/cdktf/python/d/networkmanager_device.html.markdown +++ b/website/docs/cdktf/python/d/networkmanager_device.html.markdown @@ -3,14 +3,14 @@ subcategory: "Network Manager" layout: "aws" page_title: "AWS: aws_networkmanager_device" description: |- - Retrieve information about a device. + Provides details about an existing Network Manager device. --- # Data Source: aws_networkmanager_device -Retrieve information about a device. +Provides details about an existing Network Manager device. ## Example Usage @@ -24,12 +24,11 @@ from cdktf import TerraformStack # from imports.aws.data_aws_networkmanager_device import DataAwsNetworkmanagerDevice class MyConvertedCode(TerraformStack): - def __init__(self, scope, name, *, globalNetworkId): + def __init__(self, scope, name): super().__init__(scope, name) DataAwsNetworkmanagerDevice(self, "example", device_id=device_id.string_value, - global_network_id_id=global_network_id.value, - global_network_id=global_network_id + global_network_id=global_network_id.string_value ) ``` @@ -66,4 +65,4 @@ The `location` object supports the following: * `latitude` - Latitude. * `longitude` - Longitude. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/networkmanager_devices.html.markdown b/website/docs/cdktf/python/d/networkmanager_devices.html.markdown index 8dbc1aea273b..1e86a99ee377 100644 --- a/website/docs/cdktf/python/d/networkmanager_devices.html.markdown +++ b/website/docs/cdktf/python/d/networkmanager_devices.html.markdown @@ -3,14 +3,14 @@ subcategory: "Network Manager" layout: "aws" page_title: "AWS: aws_networkmanager_devices" description: |- - Retrieve information about devices. + Provides details about existing Network Manager devices. --- # Data Source: aws_networkmanager_devices -Retrieve information about devices. +Provides details about existing Network Manager devices. ## Example Usage @@ -48,4 +48,4 @@ This data source exports the following attributes in addition to the arguments a * `ids` - IDs of the devices. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/networkmanager_global_network.html.markdown b/website/docs/cdktf/python/d/networkmanager_global_network.html.markdown index 6bfcecb1d4a0..4ddceb5d1d7e 100644 --- a/website/docs/cdktf/python/d/networkmanager_global_network.html.markdown +++ b/website/docs/cdktf/python/d/networkmanager_global_network.html.markdown @@ -3,14 +3,14 @@ subcategory: "Network Manager" layout: "aws" page_title: "AWS: aws_networkmanager_global_network" description: |- - Retrieve information about a global network. + Provides details about an existing Network Manager global network. --- # Data Source: aws_networkmanager_global_network -Retrieve information about a global network. +Provides details about an existing Network Manager global network. ## Example Usage @@ -45,4 +45,4 @@ This data source exports the following attributes in addition to the arguments a * `description` - Description of the global network. * `tags` - Map of resource tags. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/networkmanager_global_networks.html.markdown b/website/docs/cdktf/python/d/networkmanager_global_networks.html.markdown index effd5bcc84d9..ab42910ea852 100644 --- a/website/docs/cdktf/python/d/networkmanager_global_networks.html.markdown +++ b/website/docs/cdktf/python/d/networkmanager_global_networks.html.markdown @@ -3,14 +3,14 @@ subcategory: "Network Manager" layout: "aws" page_title: "AWS: aws_networkmanager_global_networks" description: |- - Retrieve information about global networks. + Provides details about existing Network Manager global networks. --- # Data Source: aws_networkmanager_global_networks -Retrieve information about global networks. +Provides details about existing Network Manager global networks. ## Example Usage @@ -45,4 +45,4 @@ This data source exports the following attributes in addition to the arguments a * `ids` - IDs of the global networks. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/networkmanager_link.html.markdown b/website/docs/cdktf/python/d/networkmanager_link.html.markdown index 2e01f311f2b0..cfc11b59473f 100644 --- a/website/docs/cdktf/python/d/networkmanager_link.html.markdown +++ b/website/docs/cdktf/python/d/networkmanager_link.html.markdown @@ -3,14 +3,14 @@ subcategory: "Network Manager" layout: "aws" page_title: "AWS: aws_networkmanager_link" description: |- - Retrieve information about a link. + Provides details about an existing Network Manager link. --- # Data Source: aws_networkmanager_link -Retrieve information about a link. +Provides details about an existing Network Manager link. ## Example Usage @@ -56,4 +56,4 @@ The `bandwidth` object supports the following: * `download_speed` - Download speed in Mbps. * `upload_speed` - Upload speed in Mbps. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/networkmanager_links.html.markdown b/website/docs/cdktf/python/d/networkmanager_links.html.markdown index 5ace33bf7521..f3bc990cf19a 100644 --- a/website/docs/cdktf/python/d/networkmanager_links.html.markdown +++ b/website/docs/cdktf/python/d/networkmanager_links.html.markdown @@ -3,14 +3,14 @@ subcategory: "Network Manager" layout: "aws" page_title: "AWS: aws_networkmanager_links" description: |- - Retrieve information about links. + Provides details about existing Network Manager links. --- # Data Source: aws_networkmanager_links -Retrieve information about link. +Provides details about existing Network Manager links. ## Example Usage @@ -50,4 +50,4 @@ This data source exports the following attributes in addition to the arguments a * `ids` - IDs of the links. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/networkmanager_site.html.markdown b/website/docs/cdktf/python/d/networkmanager_site.html.markdown index 752b3f0f62fb..dcba66e00f35 100644 --- a/website/docs/cdktf/python/d/networkmanager_site.html.markdown +++ b/website/docs/cdktf/python/d/networkmanager_site.html.markdown @@ -3,14 +3,14 @@ subcategory: "Network Manager" layout: "aws" page_title: "AWS: aws_networkmanager_site" description: |- - Retrieve information about a site. + Provides details about an existing Network Manager site. --- # Data Source: aws_networkmanager_site -Retrieve information about a site. +Provides details about an existing Network Manager site. ## Example Usage @@ -54,4 +54,4 @@ The `location` object supports the following: * `latitude` - Latitude of the location. * `longitude` - Longitude of the location. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/networkmanager_sites.html.markdown b/website/docs/cdktf/python/d/networkmanager_sites.html.markdown index 8251eb48b832..89f51227592c 100644 --- a/website/docs/cdktf/python/d/networkmanager_sites.html.markdown +++ b/website/docs/cdktf/python/d/networkmanager_sites.html.markdown @@ -3,14 +3,14 @@ subcategory: "Network Manager" layout: "aws" page_title: "AWS: aws_networkmanager_sites" description: |- - Retrieve information about sites. + Provides details about existing Network Manager sites. --- # Data Source: aws_networkmanager_sites -Retrieve information about sites. +Provides details about existing Network Manager sites. ## Example Usage @@ -47,4 +47,4 @@ This data source exports the following attributes in addition to the arguments a * `ids` - IDs of the sites. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/oam_link.html.markdown b/website/docs/cdktf/python/d/oam_link.html.markdown index b94ec6ab07f0..88c90d04312b 100644 --- a/website/docs/cdktf/python/d/oam_link.html.markdown +++ b/website/docs/cdktf/python/d/oam_link.html.markdown @@ -35,8 +35,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `link_identifier` - (Required) ARN of the link. ## Attribute Reference @@ -71,4 +72,4 @@ The `metric_configuration` configuration block supports the following arguments: * `filter` - Filter string that specifies which metrics are to be shared with the monitoring account. See [MetricConfiguration](https://docs.aws.amazon.com/OAM/latest/APIReference/API_MetricConfiguration.html) for details. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/oam_links.html.markdown b/website/docs/cdktf/python/d/oam_links.html.markdown index 36ce819eb277..4b4d6571fd62 100644 --- a/website/docs/cdktf/python/d/oam_links.html.markdown +++ b/website/docs/cdktf/python/d/oam_links.html.markdown @@ -33,7 +33,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -This data source does not support any arguments. +This data source supports the following arguments: + +* `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). ## Attribute Reference @@ -41,4 +43,4 @@ This data source exports the following attributes in addition to the arguments a * `arns` - Set of ARN of the Links. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/oam_sink.html.markdown b/website/docs/cdktf/python/d/oam_sink.html.markdown index a68c91647ef2..acd25a58b799 100644 --- a/website/docs/cdktf/python/d/oam_sink.html.markdown +++ b/website/docs/cdktf/python/d/oam_sink.html.markdown @@ -35,8 +35,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `sink_identifier` - (Required) ARN of the sink. ## Attribute Reference @@ -49,4 +50,4 @@ This data source exports the following attributes in addition to the arguments a * `sink_id` - Random ID string that AWS generated as part of the sink ARN. * `tags` - Tags assigned to the sink. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/oam_sinks.html.markdown b/website/docs/cdktf/python/d/oam_sinks.html.markdown index dea17c0b0b98..7ea263169d0b 100644 --- a/website/docs/cdktf/python/d/oam_sinks.html.markdown +++ b/website/docs/cdktf/python/d/oam_sinks.html.markdown @@ -33,7 +33,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -This data source does not support any arguments. +This data source supports the following arguments: + +* `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). ## Attribute Reference @@ -41,4 +43,4 @@ This data source exports the following attributes in addition to the arguments a * `arns` - Set of ARN of the Sinks. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/opensearch_domain.html.markdown b/website/docs/cdktf/python/d/opensearch_domain.html.markdown index b4ecdcbfcc80..fe6db76c8448 100644 --- a/website/docs/cdktf/python/d/opensearch_domain.html.markdown +++ b/website/docs/cdktf/python/d/opensearch_domain.html.markdown @@ -35,18 +35,19 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: -* `domain_name` – (Required) Name of the domain. +* `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). +* `domain_name` - (Required) Name of the domain. ## Attribute Reference This data source exports the following attributes in addition to the arguments above: -* `access_policies` – Policy document attached to the domain. +* `access_policies` - Policy document attached to the domain. * `advanced_options` - Key-value string pairs to specify advanced configuration options. * `advanced_security_options` - Status of the OpenSearch domain's advanced security options. The block consists of the following attributes: * `enabled` - Whether advanced security is enabled. * `internal_user_database_enabled` - Whether the internal user database is enabled. -* `arn` – ARN of the domain. +* `arn` - ARN of the domain. * `auto_tune_options` - Configuration of the Auto-Tune options of the domain. * `desired_state` - Auto-Tune desired state for the domain. * `maintenance_schedule` - A list of the nested configurations for the Auto-Tune maintenance windows of the domain. @@ -83,26 +84,25 @@ This data source exports the following attributes in addition to the arguments a * `user_pool_id` - Cognito User pool used by the domain. * `identity_pool_id` - Cognito Identity pool used by the domain. * `role_arn` - IAM Role with the AmazonOpenSearchServiceCognitoAccess policy attached. -* `created` – Status of the creation of the domain. +* `created` - Status of the creation of the domain. * `dashboard_endpoint` - Domain-specific endpoint used to access the [Dashboard application](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/dashboards.html). * `dashboard_endpoint_v2` - V2 domain-specific endpoint used to access the [Dashboard application](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/dashboards.html) -* `deleted` – Status of the deletion of the domain. +* `deleted` - Status of the deletion of the domain. * `domain_endpoint_v2_hosted_zone_id` - Dual stack hosted zone ID for the domain. -* `domain_id` – Unique identifier for the domain. +* `domain_id` - Unique identifier for the domain. * `ebs_options` - EBS Options for the instances in the domain. * `ebs_enabled` - Whether EBS volumes are attached to data nodes in the domain. * `throughput` - The throughput (in MiB/s) of the EBS volumes attached to data nodes. * `volume_type` - Type of EBS volumes attached to data nodes. * `volume_size` - Size of EBS volumes attached to data nodes (in GB). * `iops` - Baseline input/output (I/O) performance of EBS volumes attached to data nodes. -* `engine_version` – OpenSearch version for the domain. +* `engine_version` - OpenSearch version for the domain. * `encryption_at_rest` - Domain encryption at rest related options. * `enabled` - Whether encryption at rest is enabled in the domain. * `kms_key_id` - KMS key id used to encrypt data at rest. -* `endpoint` – Domain-specific endpoint used to submit index, search, and data upload requests. +* `endpoint` - Domain-specific endpoint used to submit index, search, and data upload requests. * `endpoint_v2` - V2 domain-specific endpoint that works with both IPv4 and IPv6 addresses, used to submit index, search, and data upload requests. * `ip_address_type` - Type of IP addresses supported by the endpoint for the domain. -* `kibana_endpoint` - (**Deprecated**) Domain-specific endpoint for kibana without https scheme. Use the `dashboard_endpoint` attribute instead. * `log_publishing_options` - Domain log publishing related options. * `log_type` - Type of OpenSearch log being published. * `cloudwatch_log_group_arn` - CloudWatch Log Group where the logs are published. @@ -115,7 +115,7 @@ This data source exports the following attributes in addition to the arguments a * `window_start_time` - 10h window for updates * `hours` - Starting hour of the 10-hour window for updates * `minutes` - Starting minute of the 10-hour window for updates -* `processing` – Status of a configuration change in the domain. +* `processing` - Status of a configuration change in the domain. * `snapshot_options` – Domain snapshot related options. * `automated_snapshot_start_hour` - Hour during which the service takes an automated daily snapshot of the indices in the domain. * `software_update_options` - Software update options for the domain @@ -127,4 +127,4 @@ This data source exports the following attributes in addition to the arguments a * `subnet_ids` - Subnets used by the domain. * `vpc_id` - VPC used by the domain. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/opensearchserverless_access_policy.html.markdown b/website/docs/cdktf/python/d/opensearchserverless_access_policy.html.markdown index cfe670da820d..eaeb6aa37644 100644 --- a/website/docs/cdktf/python/d/opensearchserverless_access_policy.html.markdown +++ b/website/docs/cdktf/python/d/opensearchserverless_access_policy.html.markdown @@ -36,8 +36,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `name` - (Required) Name of the policy. * `type` - (Required) Type of access policy. Must be `data`. @@ -49,4 +50,4 @@ This data source exports the following attributes in addition to the arguments a * `policy` - JSON policy document to use as the content for the new policy. * `policy_version` - Version of the policy. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/opensearchserverless_collection.html.markdown b/website/docs/cdktf/python/d/opensearchserverless_collection.html.markdown index 09c1a88403ef..eafe5d07ed6d 100644 --- a/website/docs/cdktf/python/d/opensearchserverless_collection.html.markdown +++ b/website/docs/cdktf/python/d/opensearchserverless_collection.html.markdown @@ -37,11 +37,12 @@ class MyConvertedCode(TerraformStack): The following arguments are optional: -~> Exactly one of `id` or `name` is required. - +* `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). * `id` - (Optional) ID of the collection. * `name` - (Optional) Name of the collection. +~> Exactly one of `id` or `name` is required. + ## Attribute Reference This data source exports the following attributes in addition to the arguments above: @@ -59,4 +60,4 @@ This data source exports the following attributes in addition to the arguments a * `tags` - A map of tags to assign to the collection. * `type` - Type of collection. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/opensearchserverless_lifecycle_policy.html.markdown b/website/docs/cdktf/python/d/opensearchserverless_lifecycle_policy.html.markdown index 54b62b51a155..f0e1161f1d12 100644 --- a/website/docs/cdktf/python/d/opensearchserverless_lifecycle_policy.html.markdown +++ b/website/docs/cdktf/python/d/opensearchserverless_lifecycle_policy.html.markdown @@ -36,8 +36,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `name` - (Required) Name of the policy * `type` - (Required) Type of lifecycle policy. Must be `retention`. @@ -51,4 +52,4 @@ This data source exports the following attributes in addition to the arguments a * `policy` - JSON policy document to use as the content for the new policy. * `policy_version` - Version of the policy. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/opensearchserverless_security_config.html.markdown b/website/docs/cdktf/python/d/opensearchserverless_security_config.html.markdown index 40f0470e14a7..dc135d0821a7 100644 --- a/website/docs/cdktf/python/d/opensearchserverless_security_config.html.markdown +++ b/website/docs/cdktf/python/d/opensearchserverless_security_config.html.markdown @@ -35,8 +35,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `id` - (Required) The unique identifier of the security configuration. ## Attribute Reference @@ -59,4 +60,4 @@ SAML options for the security configuration. * `session_timeout` - Session timeout, in minutes. Minimum is 5 minutes and maximum is 720 minutes (12 hours). Default is 60 minutes. * `user_attribute` - User attribute for this SAML integration. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/opensearchserverless_security_policy.html.markdown b/website/docs/cdktf/python/d/opensearchserverless_security_policy.html.markdown index 61cf7b401398..8301048febbb 100644 --- a/website/docs/cdktf/python/d/opensearchserverless_security_policy.html.markdown +++ b/website/docs/cdktf/python/d/opensearchserverless_security_policy.html.markdown @@ -36,6 +36,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `name` - (Required) Name of the policy * `type` - (Required) Type of security policy. One of `encryption` or `network`. @@ -49,4 +50,4 @@ This data source exports the following attributes in addition to the arguments a * `policy` - The JSON policy document without any whitespaces. * `policy_version` - Version of the policy. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/opensearchserverless_vpc_endpoint.html.markdown b/website/docs/cdktf/python/d/opensearchserverless_vpc_endpoint.html.markdown index 21ffcb6be0a7..3163ffa3c0f7 100644 --- a/website/docs/cdktf/python/d/opensearchserverless_vpc_endpoint.html.markdown +++ b/website/docs/cdktf/python/d/opensearchserverless_vpc_endpoint.html.markdown @@ -33,8 +33,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `vpc_endpoint_id` - (Required) The unique identifier of the endpoint. ## Attribute Reference @@ -47,4 +48,4 @@ This data source exports the following attributes in addition to the arguments a * `subnet_ids` - The IDs of the subnets from which you access OpenSearch Serverless. * `vpc_id` - The ID of the VPC from which you access OpenSearch Serverless. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/organizations_resource_tags.html.markdown b/website/docs/cdktf/python/d/organizations_resource_tags.html.markdown index eb44688fde7f..8ca74e84b813 100644 --- a/website/docs/cdktf/python/d/organizations_resource_tags.html.markdown +++ b/website/docs/cdktf/python/d/organizations_resource_tags.html.markdown @@ -41,10 +41,10 @@ This data source supports the following arguments: You can specify any of the following taggable resources. -* AWS account – specify the account ID number. -* Organizational unit – specify the OU ID that begins with `ou-` and looks similar to: `ou-1a2b-34uvwxyz` -* Root – specify the root ID that begins with `r-` and looks similar to: `r-1a2b` -* Policy – specify the policy ID that begins with `p-` and looks similar to: `p-12abcdefg3` +* AWS account - specify the account ID number. +* Organizational unit - specify the OU ID that begins with `ou-` and looks similar to: `ou-1a2b-34uvwxyz` +* Root - specify the root ID that begins with `r-` and looks similar to: `r-1a2b` +* Policy - specify the policy ID that begins with `p-` and looks similar to: `p-12abcdefg3` ## Attribute Reference @@ -52,4 +52,4 @@ This data source exports the following attributes in addition to the arguments a * `tags` - Map of key=value pairs for each tag set on the resource. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/outposts_asset.html.markdown b/website/docs/cdktf/python/d/outposts_asset.html.markdown index 3aeb4c1da7d3..4b82a492f37a 100644 --- a/website/docs/cdktf/python/d/outposts_asset.html.markdown +++ b/website/docs/cdktf/python/d/outposts_asset.html.markdown @@ -48,8 +48,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `arn` - (Required) Outpost ARN. * `asset_id` - (Required) ID of the asset. @@ -62,4 +63,4 @@ This data source exports the following attributes in addition to the arguments a * `rack_elevation` - Position of an asset in a rack measured in rack units. * `rack_id` - Rack ID of the asset. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/outposts_assets.html.markdown b/website/docs/cdktf/python/d/outposts_assets.html.markdown index 9a6238c21cf0..1afab98a69b8 100644 --- a/website/docs/cdktf/python/d/outposts_assets.html.markdown +++ b/website/docs/cdktf/python/d/outposts_assets.html.markdown @@ -77,6 +77,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `arn` - (Required) Outpost ARN. * `host_id_filter` - (Optional) Filters by list of Host IDs of a Dedicated Host. * `status_id_filter` - (Optional) Filters by list of state status. Valid values: "ACTIVE", "RETIRING". @@ -87,4 +88,4 @@ This data source exports the following attributes in addition to the arguments a * `asset_ids` - List of all the asset ids found. This data source will fail if none are found. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/outposts_outpost.html.markdown b/website/docs/cdktf/python/d/outposts_outpost.html.markdown index ec1dc3ef1fe3..aacf7d16dd4a 100644 --- a/website/docs/cdktf/python/d/outposts_outpost.html.markdown +++ b/website/docs/cdktf/python/d/outposts_outpost.html.markdown @@ -35,6 +35,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `id` - (Optional) Identifier of the Outpost. * `name` - (Optional) Name of the Outpost. * `arn` - (Optional) ARN. @@ -53,4 +54,4 @@ This data source exports the following attributes in addition to the arguments a * `supported_hardware_type` - The hardware type. * `tags` - The Outpost tags. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/outposts_outpost_instance_type.html.markdown b/website/docs/cdktf/python/d/outposts_outpost_instance_type.html.markdown index a1ec05fdc675..8388aa28201b 100644 --- a/website/docs/cdktf/python/d/outposts_outpost_instance_type.html.markdown +++ b/website/docs/cdktf/python/d/outposts_outpost_instance_type.html.markdown @@ -46,6 +46,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `instance_type` - (Optional) Desired instance type. Conflicts with `preferred_instance_types`. * `preferred_instance_types` - (Optional) Ordered list of preferred instance types. The first match in this list will be returned. If no preferred matches are found and the original search returned more than one result, an error is returned. Conflicts with `instance_type`. @@ -55,4 +56,4 @@ This data source exports the following attributes in addition to the arguments a * `id` - Outpost identifier. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/outposts_outpost_instance_types.html.markdown b/website/docs/cdktf/python/d/outposts_outpost_instance_types.html.markdown index 0c450229637b..6f8e3a33ce7f 100644 --- a/website/docs/cdktf/python/d/outposts_outpost_instance_types.html.markdown +++ b/website/docs/cdktf/python/d/outposts_outpost_instance_types.html.markdown @@ -33,8 +33,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `arn` - (Required) Outpost ARN. ## Attribute Reference @@ -43,4 +44,4 @@ This data source exports the following attributes in addition to the arguments a * `instance_types` - Set of instance types. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/outposts_outposts.html.markdown b/website/docs/cdktf/python/d/outposts_outposts.html.markdown index f4306c4771cf..88b24c66a795 100644 --- a/website/docs/cdktf/python/d/outposts_outposts.html.markdown +++ b/website/docs/cdktf/python/d/outposts_outposts.html.markdown @@ -35,6 +35,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `availability_zone` - (Optional) Availability Zone name. * `availability_zone_id` - (Optional) Availability Zone identifier. * `site_id` - (Optional) Site identifier. @@ -48,4 +49,4 @@ This data source exports the following attributes in addition to the arguments a * `id` - AWS Region. * `ids` - Set of identifiers. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/outposts_site.html.markdown b/website/docs/cdktf/python/d/outposts_site.html.markdown index b19459475cc7..4ebf5fce0ad5 100644 --- a/website/docs/cdktf/python/d/outposts_site.html.markdown +++ b/website/docs/cdktf/python/d/outposts_site.html.markdown @@ -35,6 +35,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `id` - (Optional) Identifier of the Site. * `name` - (Optional) Name of the Site. @@ -45,4 +46,4 @@ This data source exports the following attributes in addition to the arguments a * `account_id` - AWS Account identifier. * `description` - Description. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/outposts_sites.html.markdown b/website/docs/cdktf/python/d/outposts_sites.html.markdown index 4b3b8c50d352..cb3a682fe1ce 100644 --- a/website/docs/cdktf/python/d/outposts_sites.html.markdown +++ b/website/docs/cdktf/python/d/outposts_sites.html.markdown @@ -31,7 +31,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -This data source does not support any arguments. +This data source supports the following arguments: + +* `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). ## Attribute Reference @@ -40,4 +42,4 @@ This data source exports the following attributes in addition to the arguments a * `id` - AWS Region. * `ids` - Set of Outposts Site identifiers. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/polly_voices.html.markdown b/website/docs/cdktf/python/d/polly_voices.html.markdown index c78bd1694b57..e8fde77924ba 100644 --- a/website/docs/cdktf/python/d/polly_voices.html.markdown +++ b/website/docs/cdktf/python/d/polly_voices.html.markdown @@ -54,6 +54,7 @@ class MyConvertedCode(TerraformStack): The following arguments are optional: +* `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). * `engine` - (Optional) Engine used by Amazon Polly when processing input text for speech synthesis. Valid values are `standard`, `neural`, and `long-form`. * `include_additional_language_codes` - (Optional) Whether to return any bilingual voices that use the specified language as an additional language. * `language_code` - (Optional) Language identification tag for filtering the list of voices returned. If not specified, all available voices are returned. @@ -77,4 +78,4 @@ See the [AWS Polly Voice documentation](https://docs.aws.amazon.com/polly/latest * `name` - Name of the voice. * `supported_engines` - Specifies which engines are supported by a given voice. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/prefix_list.html.markdown b/website/docs/cdktf/python/d/prefix_list.html.markdown index 9de2870d8933..7d0cb850f74a 100644 --- a/website/docs/cdktf/python/d/prefix_list.html.markdown +++ b/website/docs/cdktf/python/d/prefix_list.html.markdown @@ -91,6 +91,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `prefix_list_id` - (Optional) ID of the prefix list to select. * `name` - (Optional) Name of the prefix list to select. * `filter` - (Optional) Configuration block(s) for filtering. Detailed below. @@ -120,4 +121,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/prometheus_default_scraper_configuration.html.markdown b/website/docs/cdktf/python/d/prometheus_default_scraper_configuration.html.markdown index 20242ab9f19b..c0a0c208c9bd 100644 --- a/website/docs/cdktf/python/d/prometheus_default_scraper_configuration.html.markdown +++ b/website/docs/cdktf/python/d/prometheus_default_scraper_configuration.html.markdown @@ -32,7 +32,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -This data source does not support any arguments. +This data source supports the following arguments: + +* `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). ## Attribute Reference @@ -40,4 +42,4 @@ This data source exports the following attributes in addition to the arguments a * `configuration` - The configuration file. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/prometheus_workspace.html.markdown b/website/docs/cdktf/python/d/prometheus_workspace.html.markdown index 527177c094fc..2ae80fde2222 100644 --- a/website/docs/cdktf/python/d/prometheus_workspace.html.markdown +++ b/website/docs/cdktf/python/d/prometheus_workspace.html.markdown @@ -35,8 +35,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `workspace_id` - (Required) Prometheus workspace ID. ## Attribute Reference @@ -51,4 +52,4 @@ This data source exports the following attributes in addition to the arguments a * `status` - Status of the Prometheus workspace. * `tags` - Tags assigned to the resource. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/prometheus_workspaces.html.markdown b/website/docs/cdktf/python/d/prometheus_workspaces.html.markdown index 3b281a496246..60074c22df31 100644 --- a/website/docs/cdktf/python/d/prometheus_workspaces.html.markdown +++ b/website/docs/cdktf/python/d/prometheus_workspaces.html.markdown @@ -55,6 +55,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `alias_prefix` - (Optional) Limits results to workspaces with aliases that begin with this value. ## Attribute Reference @@ -65,4 +66,4 @@ This data source exports the following attributes in addition to the arguments a * `arns` - List of ARNs of the matched Prometheus workspaces. * `workspace_ids` - List of workspace IDs of the matched Prometheus workspaces. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/qldb_ledger.html.markdown b/website/docs/cdktf/python/d/qldb_ledger.html.markdown index 305ccf1870ad..3a20c5c0ef61 100644 --- a/website/docs/cdktf/python/d/qldb_ledger.html.markdown +++ b/website/docs/cdktf/python/d/qldb_ledger.html.markdown @@ -35,6 +35,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `name` - (Required) Friendly name of the ledger to match. ## Attribute Reference @@ -44,4 +45,4 @@ This data source exports the following attributes in addition to the arguments a See the [QLDB Ledger Resource](/docs/providers/aws/r/qldb_ledger.html) for details on the returned attributes - they are identical. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/quicksight_analysis.html.markdown b/website/docs/cdktf/python/d/quicksight_analysis.html.markdown index 61e4082dc9dc..d1e9d1c6fbad 100644 --- a/website/docs/cdktf/python/d/quicksight_analysis.html.markdown +++ b/website/docs/cdktf/python/d/quicksight_analysis.html.markdown @@ -38,7 +38,8 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: * `analysis_id` - (Required) Identifier for the analysis. -* `aws_account_id` - (Optional) AWS account ID. +* `aws_account_id` - (Optional) AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider. +* `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). ## Attribute Reference @@ -47,4 +48,4 @@ This data source exports the following attributes in addition to the arguments a See the [Analysis Resource](/docs/providers/aws/r/quicksight_analysis.html) for details on the returned attributes - they are identical. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/quicksight_data_set.html.markdown b/website/docs/cdktf/python/d/quicksight_data_set.html.markdown index 949227ab5ae7..e876f35376df 100644 --- a/website/docs/cdktf/python/d/quicksight_data_set.html.markdown +++ b/website/docs/cdktf/python/d/quicksight_data_set.html.markdown @@ -37,8 +37,9 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `aws_account_id` - (Optional) AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider. * `data_set_id` - (Required) Identifier for the data set. -* `aws_account_id` - (Optional) AWS account ID. +* `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). ## Attribute Reference @@ -47,4 +48,4 @@ This data source exports the following attributes in addition to the arguments a See the [Data Set Resource](/docs/providers/aws/r/quicksight_data_set.html) for details on the returned attributes - they are identical. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/quicksight_group.html.markdown b/website/docs/cdktf/python/d/quicksight_group.html.markdown index b7c945ee817c..d963834e80d8 100644 --- a/website/docs/cdktf/python/d/quicksight_group.html.markdown +++ b/website/docs/cdktf/python/d/quicksight_group.html.markdown @@ -43,8 +43,9 @@ The following arguments are required: The following arguments are optional: -* `aws_account_id` - (Optional) AWS account ID. +* `aws_account_id` - (Optional) AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider. * `namespace` - (Optional) QuickSight namespace. Defaults to `default`. +* `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). ## Attribute Reference @@ -54,4 +55,4 @@ This data source exports the following attributes in addition to the arguments a * `description` - The group description. * `principal_id` - The principal ID of the group. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/quicksight_theme.html.markdown b/website/docs/cdktf/python/d/quicksight_theme.html.markdown index eec05ca078f4..595ad5b8d278 100644 --- a/website/docs/cdktf/python/d/quicksight_theme.html.markdown +++ b/website/docs/cdktf/python/d/quicksight_theme.html.markdown @@ -41,7 +41,8 @@ The following arguments are required: The following arguments are optional: -* `aws_account_id` - AWS account ID. +* `aws_account_id` - AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider. +* `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). ## Attribute Reference @@ -131,4 +132,4 @@ This data source exports the following attributes in addition to the arguments a * `warning` - Color (hexadecimal) that applies to warning and informational messages. * `warning_foreground` - Color (hexadecimal) that applies to any text or other elements that appear over the warning color. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/quicksight_user.html.markdown b/website/docs/cdktf/python/d/quicksight_user.html.markdown index 81c34aceeedb..3100d77c6635 100644 --- a/website/docs/cdktf/python/d/quicksight_user.html.markdown +++ b/website/docs/cdktf/python/d/quicksight_user.html.markdown @@ -43,8 +43,9 @@ The following arguments are required: The following arguments are optional: -* `aws_account_id` - (Optional) AWS account ID. +* `aws_account_id` - (Optional) AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider. * `namespace` - (Optional) QuickSight namespace. Defaults to `default`. +* `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). ## Attribute Reference @@ -52,6 +53,7 @@ This data source exports the following attributes in addition to the arguments a * `active` - The active status of user. When you create an Amazon QuickSight user that’s not an IAM user or an Active Directory user, that user is inactive until they sign in and provide a password. * `arn` - The Amazon Resource Name (ARN) for the user. +* `custom_permissions_name` - The custom permissions profile associated with this user. * `email` - The user's email address. * `identity_type` - The type of identity authentication used by the user. * `principal_id` - The principal ID of the user. @@ -60,4 +62,4 @@ This data source exports the following attributes in addition to the arguments a - `AUTHOR`: A user who can create data sources, datasets, analyzes, and dashboards. - `ADMIN`: A user who is an author, who can also manage Amazon QuickSight settings. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/ram_resource_share.html.markdown b/website/docs/cdktf/python/d/ram_resource_share.html.markdown index 03ac47da2710..623a66ad6b27 100644 --- a/website/docs/cdktf/python/d/ram_resource_share.html.markdown +++ b/website/docs/cdktf/python/d/ram_resource_share.html.markdown @@ -60,10 +60,11 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `name` - (Optional) Name of the resource share to retrieve. * `resource_owner` (Required) Owner of the resource share. Valid values are `SELF` or `OTHER-ACCOUNTS`. * `resource_share_status` (Optional) Specifies that you want to retrieve details of only those resource shares that have this status. Valid values are `PENDING`, `ACTIVE`, `FAILED`, `DELETING`, and `DELETED`. -* `filter` - (Optional) Filter used to scope the list e.g., by tags. See [related docs] (https://docs.aws.amazon.com/ram/latest/APIReference/API_TagFilter.html). +* `filter` - (Optional) Filter used to scope the list of owned shares e.g., by tags. See [related docs] (https://docs.aws.amazon.com/ram/latest/APIReference/API_TagFilter.html). * `name` - (Required) Name of the tag key to filter on. * `values` - (Required) Value of the tag key. @@ -78,4 +79,4 @@ This data source exports the following attributes in addition to the arguments a * `status` - Status of the resource share. * `tags` - Tags attached to the resource share. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/rds_certificate.html.markdown b/website/docs/cdktf/python/d/rds_certificate.html.markdown index e1cd22829f87..a1ed29d6c453 100644 --- a/website/docs/cdktf/python/d/rds_certificate.html.markdown +++ b/website/docs/cdktf/python/d/rds_certificate.html.markdown @@ -35,6 +35,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `id` - (Optional) Certificate identifier. For example, `rds-ca-2019`. * `default_for_new_launches` - (Optional) When enabled, returns the default certificate for new RDS instances. * `latest_valid_till` - (Optional) When enabled, returns the certificate with the latest `ValidTill`. @@ -51,4 +52,4 @@ This data source exports the following attributes in addition to the arguments a * `valid_from` - [RFC3339 format](https://tools.ietf.org/html/rfc3339#section-5.8) of certificate starting validity date. * `valid_till` - [RFC3339 format](https://tools.ietf.org/html/rfc3339#section-5.8) of certificate ending validity date. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/rds_cluster.html.markdown b/website/docs/cdktf/python/d/rds_cluster.html.markdown index e8df0047b506..ba6f6dbfaa82 100644 --- a/website/docs/cdktf/python/d/rds_cluster.html.markdown +++ b/website/docs/cdktf/python/d/rds_cluster.html.markdown @@ -35,6 +35,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `cluster_identifier` - (Required) Cluster identifier of the RDS cluster. ## Attribute Reference @@ -46,4 +47,4 @@ returned attributes - they are identical for all attributes, except the `tags_al * `tags` - A map of tags assigned to the resource. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/rds_cluster_parameter_group.html.markdown b/website/docs/cdktf/python/d/rds_cluster_parameter_group.html.markdown index 67ea1f378b57..b2bfe9cba53a 100644 --- a/website/docs/cdktf/python/d/rds_cluster_parameter_group.html.markdown +++ b/website/docs/cdktf/python/d/rds_cluster_parameter_group.html.markdown @@ -33,8 +33,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `name` - (Required) DB cluster parameter group name. ## Attribute Reference @@ -45,4 +46,4 @@ This data source exports the following attributes in addition to the arguments a * `family` - Family of the cluster parameter group. * `description` - Description of the cluster parameter group. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/rds_clusters.html.markdown b/website/docs/cdktf/python/d/rds_clusters.html.markdown index 885ca2d5515f..10bf8f04b3f7 100644 --- a/website/docs/cdktf/python/d/rds_clusters.html.markdown +++ b/website/docs/cdktf/python/d/rds_clusters.html.markdown @@ -41,6 +41,7 @@ class MyConvertedCode(TerraformStack): The following arguments are optional: +* `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). * `filter` - (Optional) Configuration block(s) for filtering. Detailed below. ### filter Configuration block @@ -57,4 +58,4 @@ This data source exports the following attributes in addition to the arguments a * `cluster_arns` - Set of cluster ARNs of the matched RDS clusters. * `cluster_identifiers` - Set of ARNs of cluster identifiers of the matched RDS clusters. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/rds_engine_version.html.markdown b/website/docs/cdktf/python/d/rds_engine_version.html.markdown index fd2b83015f1d..286546763e1a 100644 --- a/website/docs/cdktf/python/d/rds_engine_version.html.markdown +++ b/website/docs/cdktf/python/d/rds_engine_version.html.markdown @@ -68,6 +68,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `default_only` - (Optional) Whether the engine version must be an AWS-defined default version. Some engines have multiple default versions, such as for each major version. Using `default_only` may help avoid `multiple RDS engine versions` errors. See also `latest`. * `filter` - (Optional) One or more name/value pairs to use in filtering versions. There are several valid keys; for a full reference, check out [describe-db-engine-versions in the AWS CLI reference](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/describe-db-engine-versions.html). * `has_major_target` - (Optional) Whether the engine version must have one or more major upgrade targets. Not including `has_major_target` or setting it to `false` doesn't imply that there's no corresponding major upgrade target for the engine version. @@ -106,4 +107,4 @@ This data source exports the following attributes in addition to the arguments a * `version_actual` - Complete engine version. * `version_description` - Description of the engine version. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/rds_orderable_db_instance.html.markdown b/website/docs/cdktf/python/d/rds_orderable_db_instance.html.markdown index 7fe1d9900c43..4628c0f82c07 100644 --- a/website/docs/cdktf/python/d/rds_orderable_db_instance.html.markdown +++ b/website/docs/cdktf/python/d/rds_orderable_db_instance.html.markdown @@ -61,6 +61,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `availability_zone_group` - (Optional) Availability zone group. * `engine_latest_version` - (Optional) When set to `true`, the data source attempts to return the most recent version matching the other criteria you provide. You must use `engine_latest_version` with `preferred_instance_classes` and/or `preferred_engine_versions`. Using `engine_latest_version` will avoid `multiple RDS DB Instance Classes` errors. If you use `engine_latest_version` with `preferred_instance_classes`, the data source returns the latest version for the _first_ matching instance class (instance class priority). **Note:** The data source uses a best-effort approach at selecting the latest version but due to the complexity of version identifiers across engines, using `engine_latest_version` may _not_ return the latest version in every situation. * `engine_version` - (Optional) Version of the DB engine. If none is provided, the data source tries to use the AWS-defined default version that matches any other criteria. @@ -99,4 +100,4 @@ This data source exports the following attributes in addition to the arguments a * `multi_az_capable` - Whether a DB instance is Multi-AZ capable. * `outpost_capable` - Whether a DB instance supports RDS on Outposts. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/rds_reserved_instance_offering.html.markdown b/website/docs/cdktf/python/d/rds_reserved_instance_offering.html.markdown index 484da7e115b6..a556aedfe959 100644 --- a/website/docs/cdktf/python/d/rds_reserved_instance_offering.html.markdown +++ b/website/docs/cdktf/python/d/rds_reserved_instance_offering.html.markdown @@ -39,11 +39,12 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `db_instance_class` - (Required) DB instance class for the reserved DB instance. * `duration` - (Required) Duration of the reservation in years or seconds. Valid values are `1`, `3`, `31536000`, `94608000` * `multi_az` - (Required) Whether the reservation applies to Multi-AZ deployments. * `offering_type` - (Required) Offering type of this reserved DB instance. Valid values are `No Upfront`, `Partial Upfront`, `All Upfront`. -* `product_description` - (Required) Description of the reserved DB instance. +* `product_description` - (Required) Description of the reserved DB instance. Example values are `postgresql`, `aurora-postgresql`, `mysql`, `aurora-mysql`, `mariadb`. ## Attribute Reference @@ -54,4 +55,4 @@ This data source exports the following attributes in addition to the arguments a * `fixed_price` - Fixed price charged for this reserved DB instance. * `offering_id` - Unique identifier for the reservation. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/redshift_cluster.html.markdown b/website/docs/cdktf/python/d/redshift_cluster.html.markdown index 4c4841440f0a..a0ed5cba1119 100644 --- a/website/docs/cdktf/python/d/redshift_cluster.html.markdown +++ b/website/docs/cdktf/python/d/redshift_cluster.html.markdown @@ -56,6 +56,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `cluster_identifier` - (Required) Cluster identifier ## Attribute Reference @@ -108,4 +109,4 @@ Cluster nodes (for `cluster_nodes`) support the following attributes: * `private_ip_address` - Private IP address of a node within a cluster * `public_ip_address` - Public IP address of a node within a cluster - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/redshift_cluster_credentials.html.markdown b/website/docs/cdktf/python/d/redshift_cluster_credentials.html.markdown index 07ca23941af6..316715bef9fc 100644 --- a/website/docs/cdktf/python/d/redshift_cluster_credentials.html.markdown +++ b/website/docs/cdktf/python/d/redshift_cluster_credentials.html.markdown @@ -36,6 +36,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `auto_create` - (Optional) Create a database user with the name specified for the user named in `db_user` if one does not exist. * `cluster_identifier` - (Required) Unique identifier of the cluster that contains the database for which your are requesting credentials. * `db_name` - (Optional) Name of a database that DbUser is authorized to log on to. If `db_name` is not specified, `db_user` can log on to any existing database. @@ -50,4 +51,4 @@ This data source exports the following attributes in addition to the arguments a * `db_password` - Temporary password that authorizes the user name returned by `db_user` to log on to the database `db_name`. * `expiration` - Date and time the password in `db_password` expires. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/redshift_data_shares.html.markdown b/website/docs/cdktf/python/d/redshift_data_shares.html.markdown index 1cf5986e5dcc..602dac39a8c3 100644 --- a/website/docs/cdktf/python/d/redshift_data_shares.html.markdown +++ b/website/docs/cdktf/python/d/redshift_data_shares.html.markdown @@ -33,7 +33,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -This data source does not support any arguments. +This data source supports the following arguments: + +* `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). ## Attribute Reference @@ -48,4 +50,4 @@ This data source exports the following attributes in addition to the arguments a * `managed_by` - Identifier of a datashare to show its managing entity. * `producer_arn` - ARN (Amazon Resource Name) of the producer. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/redshift_orderable_cluster.html.markdown b/website/docs/cdktf/python/d/redshift_orderable_cluster.html.markdown index 60ce882a6573..1c133fd17cce 100644 --- a/website/docs/cdktf/python/d/redshift_orderable_cluster.html.markdown +++ b/website/docs/cdktf/python/d/redshift_orderable_cluster.html.markdown @@ -36,6 +36,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `cluster_type` - (Optional) Reshift Cluster typeE.g., `multi-node` or `single-node` * `cluster_version` - (Optional) Redshift Cluster versionE.g., `1.0` * `node_type` - (Optional) Redshift Cluster node typeE.g., `dc2.8xlarge` @@ -47,4 +48,4 @@ This data source exports the following attributes in addition to the arguments a * `availability_zones` - List of Availability Zone names where the Redshift Cluster is available. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/redshift_producer_data_shares.html.markdown b/website/docs/cdktf/python/d/redshift_producer_data_shares.html.markdown index b27959cc2b56..b384002e42bc 100644 --- a/website/docs/cdktf/python/d/redshift_producer_data_shares.html.markdown +++ b/website/docs/cdktf/python/d/redshift_producer_data_shares.html.markdown @@ -41,6 +41,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `status` - (Optional) Status of a datashare in the producer. Valid values are `ACTIVE`, `AUTHORIZED`, `PENDING_AUTHORIZATION`, `DEAUTHORIZED`, and `REJECTED`. Omit this argument to return all statuses. ## Attribute Reference @@ -56,4 +57,4 @@ This data source exports the following attributes in addition to the arguments a * `managed_by` - Identifier of a datashare to show its managing entity. * `producer_arn` - ARN (Amazon Resource Name) of the producer. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/redshift_subnet_group.html.markdown b/website/docs/cdktf/python/d/redshift_subnet_group.html.markdown index f1e6b883d56f..9f3245ed6053 100644 --- a/website/docs/cdktf/python/d/redshift_subnet_group.html.markdown +++ b/website/docs/cdktf/python/d/redshift_subnet_group.html.markdown @@ -35,6 +35,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `name` - (Required) Name of the cluster subnet group for which information is requested. ## Attribute Reference @@ -47,4 +48,4 @@ This data source exports the following attributes in addition to the arguments a * `subnet_ids` - An array of VPC subnet IDs. * `tags` - Tags associated to the Subnet Group - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/redshiftserverless_credentials.html.markdown b/website/docs/cdktf/python/d/redshiftserverless_credentials.html.markdown index 41d0d342d44e..e5edecccb9c3 100644 --- a/website/docs/cdktf/python/d/redshiftserverless_credentials.html.markdown +++ b/website/docs/cdktf/python/d/redshiftserverless_credentials.html.markdown @@ -35,6 +35,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `workgroup_name` - (Required) The name of the workgroup associated with the database. * `db_name` - (Optional) The name of the database to get temporary authorization to log on to. * `duration_seconds` - (Optional) The number of seconds until the returned temporary password expires. The minimum is 900 seconds, and the maximum is 3600 seconds. @@ -47,4 +48,4 @@ This data source exports the following attributes in addition to the arguments a * `db_user` - A database user name that is authorized to log on to the database `db_name` using the password `db_password` . If the specified `db_user` exists in the database, the new user name has the same database privileges as the user named in `db_user` . By default, the user is added to PUBLIC. the user doesn't exist in the database. * `expiration` - Date and time the password in `db_password` expires. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/redshiftserverless_namespace.html.markdown b/website/docs/cdktf/python/d/redshiftserverless_namespace.html.markdown index caf96f668c48..4cbb14327b88 100644 --- a/website/docs/cdktf/python/d/redshiftserverless_namespace.html.markdown +++ b/website/docs/cdktf/python/d/redshiftserverless_namespace.html.markdown @@ -35,6 +35,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `namespace_name` - (Required) The name of the namespace. ## Attribute Reference @@ -50,4 +51,4 @@ This data source exports the following attributes in addition to the arguments a * `log_exports` - The types of logs the namespace can export. Available export types are `userlog`, `connectionlog`, and `useractivitylog`. * `namespace_id` - The Redshift Namespace ID. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/redshiftserverless_workgroup.html.markdown b/website/docs/cdktf/python/d/redshiftserverless_workgroup.html.markdown index 5449fabc09ce..91df488241ce 100644 --- a/website/docs/cdktf/python/d/redshiftserverless_workgroup.html.markdown +++ b/website/docs/cdktf/python/d/redshiftserverless_workgroup.html.markdown @@ -35,8 +35,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `workgroup_name` - (Required) The name of the workgroup associated with the database. ## Attribute Reference @@ -72,4 +73,4 @@ This data source exports the following attributes in addition to the arguments a * `private_ip_address` - The IPv4 address of the network interface within the subnet. * `subnet_id` - The unique identifier of the subnet. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/region.html.markdown b/website/docs/cdktf/python/d/region.html.markdown index 11a856e8a09c..e2015e3f70f5 100644 --- a/website/docs/cdktf/python/d/region.html.markdown +++ b/website/docs/cdktf/python/d/region.html.markdown @@ -3,24 +3,24 @@ subcategory: "Meta Data Sources" layout: "aws" page_title: "AWS: aws_region" description: |- - Provides details about a specific service region + Provides details about a specific AWS Region --- # Data Source: aws_region -`aws_region` provides details about a specific AWS region. +`aws_region` provides details about a specific AWS Region. -As well as validating a given region name this resource can be used to -discover the name of the region configured within the provider. The latter +As well as validating a given Region name this resource can be used to +discover the name of the Region configured within the provider. The latter can be useful in a child module which is inheriting an AWS provider configuration from its parent module. ## Example Usage The following example shows how the resource might be used to obtain -the name of the AWS region configured on the provider. +the name of the AWS Region configured on the provider. ```python # DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -41,8 +41,9 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: -* `name` - (Optional) Full name of the region to select. +* `region` - (Optional) Full name of the region to select (e.g. `us-east-1`), and the 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). * `endpoint` - (Optional) EC2 endpoint of the region to select. +* `name` - (Optional, **Deprecated**) Full name of the region to select. Use `region` instead. ## Attribute Reference @@ -50,4 +51,4 @@ This data source exports the following attributes in addition to the arguments a * `description` - Region's description in this format: "Location (Region name)". - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/resourceexplorer2_search.html.markdown b/website/docs/cdktf/python/d/resourceexplorer2_search.html.markdown index 7dcf927c4d5f..73c91d668177 100644 --- a/website/docs/cdktf/python/d/resourceexplorer2_search.html.markdown +++ b/website/docs/cdktf/python/d/resourceexplorer2_search.html.markdown @@ -41,6 +41,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `view_arn` - (Optional) Specifies the Amazon resource name (ARN) of the view to use for the query. If you don't specify a value for this parameter, then the operation automatically uses the default view for the AWS Region in which you called this operation. If the Region either doesn't have a default view or if you don't have permission to use the default view, then the operation fails with a `401 Unauthorized` exception. ## Attribute Reference @@ -72,4 +73,4 @@ This data source exports the following attributes in addition to the arguments a * `last_reported_at` - The date and time that the information about this resource property was last updated. * `name` - Name of this property of the resource. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/resourcegroupstaggingapi_resources.html.markdown b/website/docs/cdktf/python/d/resourcegroupstaggingapi_resources.html.markdown index 3b7bc7e9cfbb..02225782837c 100644 --- a/website/docs/cdktf/python/d/resourcegroupstaggingapi_resources.html.markdown +++ b/website/docs/cdktf/python/d/resourcegroupstaggingapi_resources.html.markdown @@ -77,6 +77,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `exclude_compliant_resources` - (Optional) Specifies whether to exclude resources that are compliant with the tag policy. You can use this parameter only if the `include_compliance_details` argument is also set to `true`. * `include_compliance_details` - (Optional) Specifies whether to include details regarding the compliance with the effective tag policy. * `tag_filter` - (Optional) Specifies a list of Tag Filters (keys and values) to restrict the output to only those resources that have the specified tag and, if included, the specified value. See [Tag Filter](#tag-filter) below. Conflicts with `resource_arn_list`. @@ -105,4 +106,4 @@ This data source exports the following attributes in addition to the arguments a * `resource_arn` - ARN of the resource. * `tags` - Map of tags assigned to the resource. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/route.html.markdown b/website/docs/cdktf/python/d/route.html.markdown index e8716ae8a7a7..058ee4938422 100644 --- a/website/docs/cdktf/python/d/route.html.markdown +++ b/website/docs/cdktf/python/d/route.html.markdown @@ -51,6 +51,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `route_table_id` - (Required) ID of the specific Route Table containing the Route entry. * `carrier_gateway_id` - (Optional) EC2 Carrier Gateway ID of the Route belonging to the Route Table. * `core_network_arn` - (Optional) Core network ARN of the Route belonging to the Route Table. @@ -78,4 +79,4 @@ This data source exports no additional attributes. - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/route53_resolver_endpoint.html.markdown b/website/docs/cdktf/python/d/route53_resolver_endpoint.html.markdown index 089385147531..e04d3251cea5 100644 --- a/website/docs/cdktf/python/d/route53_resolver_endpoint.html.markdown +++ b/website/docs/cdktf/python/d/route53_resolver_endpoint.html.markdown @@ -58,6 +58,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `resolver_endpoint_id` - (Optional) ID of the Route53 Resolver Endpoint. * `filter` - (Optional) One or more name/value pairs to use as filters. There are several valid keys, for a full reference, check out @@ -77,4 +78,4 @@ This data source exports the following attributes in addition to the arguments a [1]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_Filter.html - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/route53_resolver_firewall_config.html.markdown b/website/docs/cdktf/python/d/route53_resolver_firewall_config.html.markdown index 72f4675d5036..629a3b9f28d1 100644 --- a/website/docs/cdktf/python/d/route53_resolver_firewall_config.html.markdown +++ b/website/docs/cdktf/python/d/route53_resolver_firewall_config.html.markdown @@ -39,6 +39,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `resource_id` - (Required) The ID of the VPC from Amazon VPC that the configuration is for. ## Attribute Reference @@ -49,4 +50,4 @@ This data source exports the following attributes in addition to the arguments a * `id` - The ID of the firewall configuration. * `owner_id` - The Amazon Web Services account ID of the owner of the VPC that this firewall configuration applies to. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/route53_resolver_firewall_domain_list.html.markdown b/website/docs/cdktf/python/d/route53_resolver_firewall_domain_list.html.markdown index b9fa352e6adc..1d233b534a67 100644 --- a/website/docs/cdktf/python/d/route53_resolver_firewall_domain_list.html.markdown +++ b/website/docs/cdktf/python/d/route53_resolver_firewall_domain_list.html.markdown @@ -39,6 +39,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `firewall_domain_list_id` - (Required) The ID of the domain list. ## Attribute Reference @@ -55,4 +56,4 @@ This data source exports the following attributes in addition to the arguments a * `status` - The status of the domain list. * `status_message` - Additional information about the status of the list, if available. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/route53_resolver_firewall_rule_group.html.markdown b/website/docs/cdktf/python/d/route53_resolver_firewall_rule_group.html.markdown index c5d332c1609f..7c63b8025747 100644 --- a/website/docs/cdktf/python/d/route53_resolver_firewall_rule_group.html.markdown +++ b/website/docs/cdktf/python/d/route53_resolver_firewall_rule_group.html.markdown @@ -39,6 +39,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `firewall_rule_group_id` - (Required) The ID of the rule group. ## Attribute Reference @@ -56,4 +57,4 @@ This data source exports the following attributes in addition to the arguments a * `status` - The status of the rule group. * `status_message` - Additional information about the status of the rule group, if available. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/route53_resolver_firewall_rule_group_association.html.markdown b/website/docs/cdktf/python/d/route53_resolver_firewall_rule_group_association.html.markdown index ff23e5c9dd4c..ce2aed2d1de5 100644 --- a/website/docs/cdktf/python/d/route53_resolver_firewall_rule_group_association.html.markdown +++ b/website/docs/cdktf/python/d/route53_resolver_firewall_rule_group_association.html.markdown @@ -39,6 +39,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `firewall_rule_group_association_id` - (Required) The identifier for the association. ## Attribute Reference @@ -58,4 +59,4 @@ This data source exports the following attributes in addition to the arguments a * `status_message` - Additional information about the status of the response, if available. * `vpc_id` - The unique identifier of the VPC that is associated with the rule group. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/route53_resolver_firewall_rules.html.markdown b/website/docs/cdktf/python/d/route53_resolver_firewall_rules.html.markdown index 80fb0ca053e4..963c404cb60d 100644 --- a/website/docs/cdktf/python/d/route53_resolver_firewall_rules.html.markdown +++ b/website/docs/cdktf/python/d/route53_resolver_firewall_rules.html.markdown @@ -37,6 +37,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `firewall_rule_group_id` - (Required) The unique identifier of the firewall rule group that you want to retrieve the rules for. * `action` - (Optional) The action that DNS Firewall should take on a DNS query when it matches one of the domains in the rule's domain list. * `priority` - (Optional) The setting that determines the processing order of the rules in a rule group. @@ -59,4 +60,4 @@ This data source exports the following attributes in addition to the arguments a * `modification_time` - The date and time that the rule was last modified, in Unix time format and Coordinated Universal Time (UTC). * `name` - The name of the rule. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/route53_resolver_query_log_config.html.markdown b/website/docs/cdktf/python/d/route53_resolver_query_log_config.html.markdown index f6fde4af86df..8198b48a1291 100644 --- a/website/docs/cdktf/python/d/route53_resolver_query_log_config.html.markdown +++ b/website/docs/cdktf/python/d/route53_resolver_query_log_config.html.markdown @@ -59,6 +59,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `resolver_query_log_config_id` - (Optional) ID of the Route53 Resolver Query Logging Configuration. * `filter` - (Optional) One or more name/value pairs to use as filters. There are several valid keys, for a full reference, check out @@ -78,4 +79,4 @@ This data source exports the following attributes in addition to the arguments a [1]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_Filter.html - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/route53_resolver_rule.html.markdown b/website/docs/cdktf/python/d/route53_resolver_rule.html.markdown index d35f39c3e3cf..086806242b89 100644 --- a/website/docs/cdktf/python/d/route53_resolver_rule.html.markdown +++ b/website/docs/cdktf/python/d/route53_resolver_rule.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `domain_name` - (Optional) Domain name the desired resolver rule forwards DNS queries for. Conflicts with `resolver_rule_id`. * `name` - (Optional) Friendly name of the desired resolver rule. Conflicts with `resolver_rule_id`. * `resolver_endpoint_id` (Optional) ID of the outbound resolver endpoint of the desired resolver rule. Conflicts with `resolver_rule_id`. @@ -55,4 +56,4 @@ This data source exports the following attributes in addition to the arguments a Values are `NOT_SHARED`, `SHARED_BY_ME` or `SHARED_WITH_ME` * `tags` - Map of tags assigned to the resolver rule. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/route53_resolver_rules.html.markdown b/website/docs/cdktf/python/d/route53_resolver_rules.html.markdown index 345b93437f73..69dab524ee67 100644 --- a/website/docs/cdktf/python/d/route53_resolver_rules.html.markdown +++ b/website/docs/cdktf/python/d/route53_resolver_rules.html.markdown @@ -80,6 +80,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `name_regex` - (Optional) Regex string to filter resolver rule names. The filtering is done locally, so could have a performance impact if the result is large. This argument should be used along with other arguments to limit the number of results returned. @@ -95,4 +96,4 @@ This data source exports the following attributes in addition to the arguments a * `id` - AWS Region. * `resolver_rule_ids` - IDs of the matched resolver rules. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/route53_traffic_policy_document.html.markdown b/website/docs/cdktf/python/d/route53_traffic_policy_document.html.markdown index 75ce14767a81..fb52551ff6b1 100644 --- a/website/docs/cdktf/python/d/route53_traffic_policy_document.html.markdown +++ b/website/docs/cdktf/python/d/route53_traffic_policy_document.html.markdown @@ -35,10 +35,10 @@ class MyConvertedCode(TerraformStack): endpoint=[DataAwsRoute53TrafficPolicyDocumentEndpoint( id="my_elb", type="elastic-load-balancer", - value="elb-111111.${" + current.name + "}.elb.amazonaws.com" + value="elb-111111.${" + current.region + "}.elb.amazonaws.com" ), DataAwsRoute53TrafficPolicyDocumentEndpoint( id="site_down_banner", - region=Token.as_string(current.name), + region=Token.as_string(current.region), type="s3-website", value="www.example.com" ) @@ -222,4 +222,4 @@ This data source exports the following attributes in addition to the arguments a * `json` - Standard JSON policy document rendered based on the arguments above. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/route53profiles_profiles.html.markdown b/website/docs/cdktf/python/d/route53profiles_profiles.html.markdown index 7fca436aae59..2793dc8c5fcd 100644 --- a/website/docs/cdktf/python/d/route53profiles_profiles.html.markdown +++ b/website/docs/cdktf/python/d/route53profiles_profiles.html.markdown @@ -33,7 +33,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -This data source does not support any arguments. +This data source supports the following arguments: + +* `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). ## Attribute Reference @@ -45,4 +47,4 @@ This data source exports the following attributes in addition to the arguments a * `name` - Name of the Profile. * `share_status` - Share status of the Profile. Valid values [AWS docs](https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53profiles_Profile.html) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/route_table.html.markdown b/website/docs/cdktf/python/d/route_table.html.markdown index 764d991e01cc..fe1e47aa9e73 100644 --- a/website/docs/cdktf/python/d/route_table.html.markdown +++ b/website/docs/cdktf/python/d/route_table.html.markdown @@ -48,6 +48,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `filter` - (Optional) Configuration block. Detailed below. * `gateway_id` - (Optional) ID of an Internet Gateway or Virtual Private Gateway which is connected to the Route Table (not exported if not passed as a parameter). * `route_table_id` - (Optional) ID of the specific Route Table to retrieve. @@ -113,4 +114,4 @@ Associations are also exported with the following attributes: - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/route_tables.html.markdown b/website/docs/cdktf/python/d/route_tables.html.markdown index dca13d379521..aaa65e009450 100644 --- a/website/docs/cdktf/python/d/route_tables.html.markdown +++ b/website/docs/cdktf/python/d/route_tables.html.markdown @@ -57,6 +57,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `filter` - (Optional) Custom filter block as described below. * `vpc_id` - (Optional) VPC ID that you want to filter from. * `tags` - (Optional) Map of tags, each pair of which must exactly match @@ -84,4 +85,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/s3_access_point.html.markdown b/website/docs/cdktf/python/d/s3_access_point.html.markdown new file mode 100644 index 000000000000..d20f8b51fb85 --- /dev/null +++ b/website/docs/cdktf/python/d/s3_access_point.html.markdown @@ -0,0 +1,63 @@ +--- +subcategory: "S3 Control" +layout: "aws" +page_title: "AWS: aws_s3_access_point" +description: |- + Provides details about a specific S3 access point +--- + + + +# Data Source: aws_s3_access_point + +Provides details about a specific S3 access point. + +## 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_s3_access_point import DataAwsS3AccessPoint +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + DataAwsS3AccessPoint(self, "example", + name="example-access-point" + ) +``` + +## Argument Reference + +This data source supports the following arguments: + +* `account_id` - (Optional) AWS account ID for the account that owns the specified access point. +* `name` - (Required) Name of the access point. +* `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). + +## Attribute Reference + +This data source exports the following attributes in addition to the arguments above: + +* `alias` - Access point alias. +* `arn` - Access point ARN. +* `bucket` - Name of the bucket associated with the access point. +* `bucket_account_id` - AWS account ID associated with the S3 bucket associated with the access point. +* `data_source_id` - Unique identifier for the data source of the access point. +* `data_source_type` - Type of the data source that the access point is attached to. +* `endpoints` - VPC endpoint for the access point. +* `network_origin` - Indicates whether the access point allows access from the public Internet. +* `public_access_block_configuration` - `PublicAccessBlock` configuration for the access point. + * `block_public_acls` - Whether Amazon S3 blocks public ACLs for buckets in this account. + * `block_public_policy` - Whether Amazon S3 blocks public bucket policies for buckets in this account. + * `ignore_public_acls` - Whether Amazon S3 ignores public ACLs for buckets in this account. + * `restrict_public_buckets` - Whether Amazon S3 restricts public bucket policies for buckets in this account. +* `tags` - Tags assigned to the access point. +* `vpc_configuration` - VPC configuration for the access point. + * `vpc_id` - Access point will only allow connections from this VPC. + + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/s3_bucket.html.markdown b/website/docs/cdktf/python/d/s3_bucket.html.markdown index 951e4819f9be..283036a89b6d 100644 --- a/website/docs/cdktf/python/d/s3_bucket.html.markdown +++ b/website/docs/cdktf/python/d/s3_bucket.html.markdown @@ -86,6 +86,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `bucket` - (Required) Name of the bucket ## Attribute Reference @@ -95,10 +96,10 @@ This data source exports the following attributes in addition to the arguments a * `id` - Name of the bucket. * `arn` - ARN of the bucket. Will be of format `arn:aws:s3:::bucketname`. * `bucket_domain_name` - Bucket domain name. Will be of format `bucketname.s3.amazonaws.com`. +* `bucket_region` - AWS region this bucket resides in. * `bucket_regional_domain_name` - The bucket region-specific domain name. The bucket domain name including the region name. Please refer to the [S3 endpoints reference](https://docs.aws.amazon.com/general/latest/gr/s3.html#s3_region) for format. Note: AWS CloudFront allows specifying an S3 region-specific endpoint when creating an S3 origin. This will prevent redirect issues from CloudFront to the S3 Origin URL. For more information, see the [Virtual Hosted-Style Requests for Other Regions](https://docs.aws.amazon.com/AmazonS3/latest/userguide/VirtualHosting.html#deprecated-global-endpoint) section in the AWS S3 User Guide. * `hosted_zone_id` - The [Route 53 Hosted Zone ID](https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_website_region_endpoints) for this bucket's region. -* `region` - AWS region this bucket resides in. * `website_endpoint` - Website endpoint, if the bucket is configured with a website. If not, this will be an empty string. * `website_domain` - Domain of the website endpoint, if the bucket is configured with a website. If not, this will be an empty string. This is used to create Route 53 alias records. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/s3_bucket_object.html.markdown b/website/docs/cdktf/python/d/s3_bucket_object.html.markdown index 7325c779877d..fb1ff696827c 100644 --- a/website/docs/cdktf/python/d/s3_bucket_object.html.markdown +++ b/website/docs/cdktf/python/d/s3_bucket_object.html.markdown @@ -96,6 +96,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `bucket` - (Required) Name of the bucket to read the object from. Alternatively, an [S3 access point](https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html) ARN can be specified * `key` - (Required) Full path to the object inside the bucket * `version_id` - (Optional) Specific version ID of the object returned (defaults to latest version) @@ -129,4 +130,4 @@ This data source exports the following attributes in addition to the arguments a -> **Note:** Terraform ignores all leading `/`s in the object's `key` and treats multiple `/`s in the rest of the object's `key` as a single `/`, so values of `/index.html` and `index.html` correspond to the same S3 object as do `first//second///third//` and `first/second/third/`. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/s3_bucket_objects.html.markdown b/website/docs/cdktf/python/d/s3_bucket_objects.html.markdown index d0c86c94504c..26ae864e9903 100644 --- a/website/docs/cdktf/python/d/s3_bucket_objects.html.markdown +++ b/website/docs/cdktf/python/d/s3_bucket_objects.html.markdown @@ -54,6 +54,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `bucket` - (Required) Lists object keys in this S3 bucket. Alternatively, an [S3 access point](https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html) ARN can be specified * `prefix` - (Optional) Limits results to object keys with this prefix (Default: none) * `delimiter` - (Optional) Character used to group keys (Default: none) @@ -71,4 +72,4 @@ This data source exports the following attributes in addition to the arguments a * `id` - S3 Bucket. * `owners` - List of strings representing object owner IDs (see `fetch_owner` above) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/s3_bucket_policy.html.markdown b/website/docs/cdktf/python/d/s3_bucket_policy.html.markdown index 592ebc2ddc2a..ded8f0fc6282 100644 --- a/website/docs/cdktf/python/d/s3_bucket_policy.html.markdown +++ b/website/docs/cdktf/python/d/s3_bucket_policy.html.markdown @@ -40,6 +40,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `bucket` - (Required) Bucket name. ## Attribute Reference @@ -48,4 +49,4 @@ This data source exports the following attributes in addition to the arguments a * `policy` - IAM bucket policy. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/s3_directory_buckets.html.markdown b/website/docs/cdktf/python/d/s3_directory_buckets.html.markdown index d6740a7b30a8..868f850f853e 100644 --- a/website/docs/cdktf/python/d/s3_directory_buckets.html.markdown +++ b/website/docs/cdktf/python/d/s3_directory_buckets.html.markdown @@ -31,7 +31,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -This data source does not support any arguments. +This data source supports the following arguments: + +* `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). ## Attribute Reference @@ -40,4 +42,4 @@ This data source exports the following attributes in addition to the arguments a * `arns` - Bucket ARNs. * `buckets` - Buckets names. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/s3_object.html.markdown b/website/docs/cdktf/python/d/s3_object.html.markdown index cdcc97768e86..12873c00b04d 100644 --- a/website/docs/cdktf/python/d/s3_object.html.markdown +++ b/website/docs/cdktf/python/d/s3_object.html.markdown @@ -95,6 +95,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `bucket` - (Required) Name of the bucket to read the object from. Alternatively, an [S3 access point](https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html) ARN can be specified * `checksum_mode` - (Optional) To retrieve the object's checksum, this argument must be `ENABLED`. If you enable `checksum_mode` and the object is encrypted with KMS, you must have permission to use the `kms:Decrypt` action. Valid values: `ENABLED` * `key` - (Required) Full path to the object inside the bucket @@ -135,4 +136,4 @@ This data source exports the following attributes in addition to the arguments a -> **Note:** Terraform ignores all leading `/`s in the object's `key` and treats multiple `/`s in the rest of the object's `key` as a single `/`, so values of `/index.html` and `index.html` correspond to the same S3 object as do `first//second///third//` and `first/second/third/`. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/s3_objects.html.markdown b/website/docs/cdktf/python/d/s3_objects.html.markdown index f6cbcc45720e..968c3cf8e7c7 100644 --- a/website/docs/cdktf/python/d/s3_objects.html.markdown +++ b/website/docs/cdktf/python/d/s3_objects.html.markdown @@ -52,6 +52,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `bucket` - (Required) Lists object keys in this S3 bucket. Alternatively, an [S3 access point](https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html) ARN can be specified * `prefix` - (Optional) Limits results to object keys with this prefix (Default: none) * `delimiter` - (Optional) Character used to group keys (Default: none) @@ -71,4 +72,4 @@ This data source exports the following attributes in addition to the arguments a * `owners` - List of strings representing object owner IDs (see `fetch_owner` above) * `request_charged` - If present, indicates that the requester was successfully charged for the request. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/s3control_multi_region_access_point.html.markdown b/website/docs/cdktf/python/d/s3control_multi_region_access_point.html.markdown index 28808cbf3448..ab9cb5039c66 100644 --- a/website/docs/cdktf/python/d/s3control_multi_region_access_point.html.markdown +++ b/website/docs/cdktf/python/d/s3control_multi_region_access_point.html.markdown @@ -35,6 +35,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `account_id` - (Optional) The AWS account ID of the S3 Multi-Region Access Point. Defaults to automatically determined account ID of the Terraform AWS provider. * `name` - (Required) The name of the Multi-Region Access Point. @@ -69,4 +70,4 @@ This data source exports the following attributes in addition to the arguments a * `bucket_account_id` - The AWS account ID that owns the bucket. * `region` - The name of the region. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/sagemaker_prebuilt_ecr_image.html.markdown b/website/docs/cdktf/python/d/sagemaker_prebuilt_ecr_image.html.markdown index b95abf490985..e4d784d2d3c9 100644 --- a/website/docs/cdktf/python/d/sagemaker_prebuilt_ecr_image.html.markdown +++ b/website/docs/cdktf/python/d/sagemaker_prebuilt_ecr_image.html.markdown @@ -43,7 +43,7 @@ This data source supports the following arguments: * `repository_name` - (Required) Name of the repository, which is generally the algorithm or library. Values include `autogluon-inference`, `autogluon-training`, `blazingtext`, `djl-inference`, `factorization-machines`, `forecasting-deepar`, `huggingface-pytorch-inference`, `huggingface-pytorch-inference-neuron`, `huggingface-pytorch-inference-neuronx`, `huggingface-pytorch-tgi-inference`, `huggingface-pytorch-training`, `huggingface-pytorch-training-neuronx`, `huggingface-pytorch-trcomp-training`, `huggingface-tensorflow-inference`, `huggingface-tensorflow-training`, `huggingface-tensorflow-trcomp-training`, `image-classification`, `image-classification-neo`, `ipinsights`, `kmeans`, `knn`, `lda`, `linear-learner`, `mxnet-inference`, `mxnet-inference-eia`, `mxnet-training`, `ntm`, `object-detection`, `object2vec`, `pca`, `pytorch-inference`, `pytorch-inference-eia`, `pytorch-inference-graviton`, `pytorch-inference-neuronx`, `pytorch-training`, `pytorch-training-neuronx`, `pytorch-trcomp-training`, `randomcutforest`, `sagemaker-base-python`, `sagemaker-chainer`, `sagemaker-clarify-processing`, `sagemaker-data-wrangler-container`, `sagemaker-debugger-rules`, `sagemaker-geospatial-v1-0`, `sagemaker-inference-mxnet`, `sagemaker-inference-pytorch`, `sagemaker-inference-tensorflow`, `sagemaker-model-monitor-analyzer`, `sagemaker-mxnet`, `sagemaker-mxnet-eia`, `sagemaker-mxnet-serving`, `sagemaker-mxnet-serving-eia`, `sagemaker-neo-mxnet`, `sagemaker-neo-pytorch`, `sagemaker-neo-tensorflow`, `sagemaker-pytorch`, `sagemaker-rl-coach-container`, `sagemaker-rl-mxnet`, `sagemaker-rl-ray-container`, `sagemaker-rl-tensorflow`, `sagemaker-rl-vw-container`, `sagemaker-scikit-learn`, `sagemaker-spark-processing`, `sagemaker-sparkml-serving`, `sagemaker-tensorflow`, `sagemaker-tensorflow-eia`, `sagemaker-tensorflow-scriptmode`, `sagemaker-tensorflow-serving`, `sagemaker-tensorflow-serving-eia`, `sagemaker-tritonserver`, `sagemaker-xgboost`, `semantic-segmentation`, `seq2seq`, `stabilityai-pytorch-inference`, `tei`, `tei-cpu`, `tensorflow-inference`, `tensorflow-inference-eia`, `tensorflow-inference-graviton`, `tensorflow-training`, and `xgboost-neo`. * `dns_suffix` - (Optional) DNS suffix to use in the registry path. If not specified, the AWS provider sets it to the DNS suffix for the current region. * `image_tag` - (Optional) Image tag for the Docker image. If not specified, the AWS provider sets the value to `1`, which for many repositories indicates the latest version. Some repositories, such as XGBoost, do not support `1` or `latest` and specific version must be used. -* `region` (Optional) - Region to use in the registry path. If not specified, the AWS provider sets it to the current region. +* `region` - (Optional) Region to use in the registry path. Defaults to the Region set in the [provider configuration](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#aws-configuration-reference). ## Attribute Reference @@ -52,4 +52,4 @@ This data source exports the following attributes in addition to the arguments a * `registry_id` - Account ID containing the image. For example, `469771592824`. * `registry_path` - Docker image URL. For example, `341280168497.dkr.ecr.ca-central-1.amazonaws.com/sagemaker-sparkml-serving:2.4`. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/secretsmanager_random_password.html.markdown b/website/docs/cdktf/python/d/secretsmanager_random_password.html.markdown index 7a6c347e848f..09bf21ed7b34 100644 --- a/website/docs/cdktf/python/d/secretsmanager_random_password.html.markdown +++ b/website/docs/cdktf/python/d/secretsmanager_random_password.html.markdown @@ -36,6 +36,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `exclude_characters` - (Optional) String of the characters that you don't want in the password. * `exclude_lowercase` - (Optional) Specifies whether to exclude lowercase letters from the password. * `exclude_numbers` - (Optional) Specifies whether to exclude numbers from the password. @@ -51,4 +52,4 @@ This data source exports the following attributes in addition to the arguments a * `random_password` - Random password. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/secretsmanager_secret.html.markdown b/website/docs/cdktf/python/d/secretsmanager_secret.html.markdown index e03833423feb..3b8dd7cb2212 100644 --- a/website/docs/cdktf/python/d/secretsmanager_secret.html.markdown +++ b/website/docs/cdktf/python/d/secretsmanager_secret.html.markdown @@ -56,6 +56,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `arn` - (Optional) ARN of the secret to retrieve. * `name` - (Optional) Name of the secret to retrieve. @@ -72,4 +73,4 @@ This data source exports the following attributes in addition to the arguments a * `policy` - Resource-based policy document that's attached to the secret. * `tags` - Tags of the secret. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/secretsmanager_secret_rotation.html.markdown b/website/docs/cdktf/python/d/secretsmanager_secret_rotation.html.markdown index 15606519126e..924eda960bb8 100644 --- a/website/docs/cdktf/python/d/secretsmanager_secret_rotation.html.markdown +++ b/website/docs/cdktf/python/d/secretsmanager_secret_rotation.html.markdown @@ -37,14 +37,21 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `secret_id` - (Required) Specifies the secret containing the version that you want to retrieve. You can specify either the ARN or the friendly name of the secret. ## Attribute Reference This data source exports the following attributes in addition to the arguments above: -* `rotation_enabled` - ARN of the secret. -* `rotation_lambda_arn` - Decrypted part of the protected secret information that was originally provided as a string. -* `rotation_rules` - Decrypted part of the protected secret information that was originally provided as a binary. Base64 encoded. +* `rotation_enabled` - Specifies whether automatic rotation is enabled for this secret. +* `rotation_lambda_arn` - Amazon Resource Name (ARN) of the lambda function used for rotation. +* `rotation_rules` - Configuration block for rotation rules. See [`rotation_rules`](#rotation_rules) below. - \ No newline at end of file +### rotation_rules + +* `automatically_after_days` - Number of days between automatic scheduled rotations of the secret. +* `duration` - Length of the rotation window in hours. +* `schedule_expression` - A `cron()` or `rate()` expression that defines the schedule for rotating the secret. + + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/secretsmanager_secret_version.html.markdown b/website/docs/cdktf/python/d/secretsmanager_secret_version.html.markdown index 68bbf3e4a4dd..f17b0d8d83bb 100644 --- a/website/docs/cdktf/python/d/secretsmanager_secret_version.html.markdown +++ b/website/docs/cdktf/python/d/secretsmanager_secret_version.html.markdown @@ -76,6 +76,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `secret_id` - (Required) Specifies the secret containing the version that you want to retrieve. You can specify either the ARN or the friendly name of the secret. * `version_id` - (Optional) Specifies the unique identifier of the version of the secret that you want to retrieve. Overrides `version_stage`. * `version_stage` - (Optional) Specifies the secret version that you want to retrieve by the staging label attached to the version. Defaults to `AWSCURRENT`. @@ -91,4 +92,4 @@ This data source exports the following attributes in addition to the arguments a * `secret_binary` - Decrypted part of the protected secret information that was originally provided as a binary. * `version_id` - Unique identifier of this version of the secret. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/secretsmanager_secret_versions.html.markdown b/website/docs/cdktf/python/d/secretsmanager_secret_versions.html.markdown index ec0995da820c..c3996e2cd75a 100644 --- a/website/docs/cdktf/python/d/secretsmanager_secret_versions.html.markdown +++ b/website/docs/cdktf/python/d/secretsmanager_secret_versions.html.markdown @@ -76,6 +76,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `secret_id` - (Required) Specifies the secret containing the version that you want to retrieve. You can specify either the ARN or the friendly name of the secret. * `include_deprecated` - (Optional) If true, all deprecated secret versions are included in the response. If false, no deprecated secret versions are included in the response. If no value is specified, the default value is `false`. @@ -95,4 +96,4 @@ This data source exports the following attributes in addition to the arguments a * `version_id` - Unique version identifier of this version of the secret. * `version_stages` - List of staging labels attached to the version. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/secretsmanager_secrets.html.markdown b/website/docs/cdktf/python/d/secretsmanager_secrets.html.markdown index 1e2449c662f1..6e6c83a30cb2 100644 --- a/website/docs/cdktf/python/d/secretsmanager_secrets.html.markdown +++ b/website/docs/cdktf/python/d/secretsmanager_secrets.html.markdown @@ -39,6 +39,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `filter` - (Optional) Configuration block(s) for filtering. Detailed below. ## filter Configuration Block @@ -55,4 +56,4 @@ This data source exports the following attributes in addition to the arguments a * `arns` - Set of ARNs of the matched Secrets Manager secrets. * `names` - Set of names of the matched Secrets Manager secrets. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/security_group.html.markdown b/website/docs/cdktf/python/d/security_group.html.markdown index 9e4fb274096c..bb29d1f7e8cf 100644 --- a/website/docs/cdktf/python/d/security_group.html.markdown +++ b/website/docs/cdktf/python/d/security_group.html.markdown @@ -50,6 +50,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `filter` - (Optional) Custom filter block as described below. * `id` - (Optional) Id of the specific security group to retrieve. * `name` - (Optional) Name that the desired security group must have. @@ -85,4 +86,4 @@ The following fields are also exported: - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/security_groups.html.markdown b/website/docs/cdktf/python/d/security_groups.html.markdown index e732f1265722..d29e41c37837 100644 --- a/website/docs/cdktf/python/d/security_groups.html.markdown +++ b/website/docs/cdktf/python/d/security_groups.html.markdown @@ -62,6 +62,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `tags` - (Optional) Map of tags, each pair of which must exactly match for desired security groups. * `filter` - (Optional) One or more name/value pairs to use as filters. There are several valid keys, for a full reference, check out [describe-security-groups in the AWS CLI reference][1]. @@ -82,4 +83,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/securityhub_standards_control_associations.html.markdown b/website/docs/cdktf/python/d/securityhub_standards_control_associations.html.markdown index 3da5c4337037..a44cc5d0f59a 100644 --- a/website/docs/cdktf/python/d/securityhub_standards_control_associations.html.markdown +++ b/website/docs/cdktf/python/d/securityhub_standards_control_associations.html.markdown @@ -43,6 +43,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `security_control_id` - (Required) The identifier of the control (identified with `SecurityControlId`, `SecurityControlArn`, or a mix of both parameters). ## Attribute Reference @@ -64,4 +65,4 @@ See [`standards_control_associations`](#standards_control_associations-attribute * `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. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/serverlessapplicationrepository_application.html.markdown b/website/docs/cdktf/python/d/serverlessapplicationrepository_application.html.markdown index a6a709c17765..9c0b988df2a5 100644 --- a/website/docs/cdktf/python/d/serverlessapplicationrepository_application.html.markdown +++ b/website/docs/cdktf/python/d/serverlessapplicationrepository_application.html.markdown @@ -45,6 +45,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `application_id` - (Required) ARN of the application. * `semantic_version` - (Optional) Requested version of the application. By default, retrieves the latest version. @@ -58,4 +59,4 @@ This data source exports the following attributes in addition to the arguments a * `source_code_url` - URL pointing to the source code of the application version. * `template_url` - URL pointing to the Cloud Formation template for the application version. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/service.html.markdown b/website/docs/cdktf/python/d/service.html.markdown index 2216513eee29..75dd334b6881 100644 --- a/website/docs/cdktf/python/d/service.html.markdown +++ b/website/docs/cdktf/python/d/service.html.markdown @@ -31,7 +31,7 @@ class MyConvertedCode(TerraformStack): super().__init__(scope, name) current = DataAwsRegion(self, "current") DataAwsService(self, "test", - region=Token.as_string(current.name), + region=Token.as_string(current.region), service_id="ec2" ) ``` @@ -79,8 +79,8 @@ class MyConvertedCode(TerraformStack): The following arguments are optional: * `dns_name` - (Optional) DNS name of the service (_e.g.,_ `rds.us-east-1.amazonaws.com`). One of `dns_name`, `reverse_dns_name`, or `service_id` is required. -* `partition` - (Optional) Partition corresponding to the region. -* `region` - (Optional) Region of the service (_e.g.,_ `us-west-2`, `ap-northeast-1`). +* `partition` - (Optional) Partition corresponding to the Region. +* `region` - (Optional) Region of the service (_e.g.,_ `us-west-2`, `ap-northeast-1`). Defaults to the Region set in the [provider configuration](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#aws-configuration-reference). * `reverse_dns_name` - (Optional) Reverse DNS name of the service (_e.g.,_ `com.amazonaws.us-west-2.s3`). One of `dns_name`, `reverse_dns_name`, or `service_id` is required. * `reverse_dns_prefix` - (Optional) Prefix of the service (_e.g.,_ `com.amazonaws` in AWS Commercial, `cn.com.amazonaws` in AWS China). * `service_id` - (Optional) Service endpoint ID (_e.g.,_ `s3`, `rds`, `ec2`). One of `dns_name`, `reverse_dns_name`, or `service_id` is required. A service's endpoint ID can be found in the [_AWS General Reference_](https://docs.aws.amazon.com/general/latest/gr/aws-service-information.html). @@ -91,4 +91,4 @@ This data source exports the following attributes in addition to the arguments a * `supported` - Whether the service is supported in the region's partition. New services may not be listed immediately as supported. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/service_discovery_dns_namespace.html.markdown b/website/docs/cdktf/python/d/service_discovery_dns_namespace.html.markdown index 2a382092dcf3..2c5f83a9b566 100644 --- a/website/docs/cdktf/python/d/service_discovery_dns_namespace.html.markdown +++ b/website/docs/cdktf/python/d/service_discovery_dns_namespace.html.markdown @@ -36,6 +36,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `name` - (Required) Name of the namespace. * `type` - (Required) Type of the namespace. Allowed values are `DNS_PUBLIC` or `DNS_PRIVATE`. @@ -49,4 +50,4 @@ This data source exports the following attributes in addition to the arguments a * `hosted_zone` - ID for the hosted zone that Amazon Route 53 creates when you create a namespace. * `tags` - Map of tags for the resource. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/service_discovery_http_namespace.html.markdown b/website/docs/cdktf/python/d/service_discovery_http_namespace.html.markdown index b7c060fb6bf1..35a61d91dd97 100644 --- a/website/docs/cdktf/python/d/service_discovery_http_namespace.html.markdown +++ b/website/docs/cdktf/python/d/service_discovery_http_namespace.html.markdown @@ -33,6 +33,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `name` - (Required) Name of the http namespace. ## Attribute Reference @@ -45,4 +46,4 @@ This data source exports the following attributes in addition to the arguments a * `http_name` - Name of an HTTP namespace. * `tags` - Map of tags for the resource. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/service_discovery_service.html.markdown b/website/docs/cdktf/python/d/service_discovery_service.html.markdown index 4c52fbda0c3f..4e6fd80b1f27 100644 --- a/website/docs/cdktf/python/d/service_discovery_service.html.markdown +++ b/website/docs/cdktf/python/d/service_discovery_service.html.markdown @@ -36,6 +36,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `name` - (Required) Name of the service. * `namespace_id` - (Required) ID of the namespace that the service belongs to. @@ -81,4 +82,4 @@ The `health_check_custom_config` configuration block supports the following argu * `failure_threshold` - The number of 30-second intervals that you want service discovery to wait before it changes the health status of a service instance. Maximum value of 10. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/service_principal.html.markdown b/website/docs/cdktf/python/d/service_principal.html.markdown index a58f709ff169..2a1120cfdc50 100644 --- a/website/docs/cdktf/python/d/service_principal.html.markdown +++ b/website/docs/cdktf/python/d/service_principal.html.markdown @@ -40,16 +40,15 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: * `service_name` - (Required) Name of the service you want to generate a Service Principal Name for. -* `region` - (Optional) Region you'd like the SPN for. By default, uses the current region. +* `region` - (Optional) Region you'd like the SPN for. Defaults to the Region set in the [provider configuration](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#aws-configuration-reference). ## Attribute Reference This data source exports the following attributes in addition to the arguments above: -* `id` - Identifier of the current Service Principal (compound of service, region and suffix). (e.g. `logs.us-east-1.amazonaws.com`in AWS Commercial, `logs.cn-north-1.amazonaws.com.cn` in AWS China). +* `id` - Identifier of the current Service Principal (compound of service, Region and suffix). (e.g. `logs.us-east-1.amazonaws.com`in AWS Commercial, `logs.cn-north-1.amazonaws.com.cn` in AWS China). * `name` - Service Principal Name (e.g., `logs.amazonaws.com` in AWS Commercial, `logs.amazonaws.com.cn` in AWS China). * `service` - Service used for SPN generation (e.g. `logs`). * `suffix` - Suffix of the SPN (e.g., `amazonaws.com` in AWS Commercial, `amazonaws.com.cn` in AWS China). -*`region` - Region identifier of the generated SPN (e.g., `us-east-1` in AWS Commercial, `cn-north-1` in AWS China). - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/servicecatalog_constraint.html.markdown b/website/docs/cdktf/python/d/servicecatalog_constraint.html.markdown index a97efc80137f..f551681aa979 100644 --- a/website/docs/cdktf/python/d/servicecatalog_constraint.html.markdown +++ b/website/docs/cdktf/python/d/servicecatalog_constraint.html.markdown @@ -42,6 +42,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `accept_language` - (Optional) Language code. Valid values: `en` (English), `jp` (Japanese), `zh` (Chinese). Default value is `en`. ## Attribute Reference @@ -56,4 +57,4 @@ This data source exports the following attributes in addition to the arguments a * `status` - Constraint status. * `type` - Type of constraint. Valid values are `LAUNCH`, `NOTIFICATION`, `RESOURCE_UPDATE`, `STACKSET`, and `TEMPLATE`. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/servicecatalog_launch_paths.html.markdown b/website/docs/cdktf/python/d/servicecatalog_launch_paths.html.markdown index 69f5ae8da69f..221be7b66c4f 100644 --- a/website/docs/cdktf/python/d/servicecatalog_launch_paths.html.markdown +++ b/website/docs/cdktf/python/d/servicecatalog_launch_paths.html.markdown @@ -41,6 +41,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `accept_language` - (Optional) Language code. Valid values: `en` (English), `jp` (Japanese), `zh` (Chinese). Default value is `en`. ## Attribute Reference @@ -61,4 +62,4 @@ This data source exports the following attributes in addition to the arguments a * `description` - Description of the constraint. * `type` - Type of constraint. Valid values are `LAUNCH`, `NOTIFICATION`, `STACKSET`, and `TEMPLATE`. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/servicecatalog_portfolio.html.markdown b/website/docs/cdktf/python/d/servicecatalog_portfolio.html.markdown index 5ea5f2b82edb..26532ce07b29 100644 --- a/website/docs/cdktf/python/d/servicecatalog_portfolio.html.markdown +++ b/website/docs/cdktf/python/d/servicecatalog_portfolio.html.markdown @@ -39,6 +39,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `accept_language` - (Optional) Language code. Valid values: `en` (English), `jp` (Japanese), `zh` (Chinese). Default value is `en`. ## Attribute Reference @@ -52,4 +53,4 @@ This data source exports the following attributes in addition to the arguments a * `provider_name` - Name of the person or organization who owns the portfolio. * `tags` - Tags applied to the portfolio. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/servicecatalog_portfolio_constraints.html.markdown b/website/docs/cdktf/python/d/servicecatalog_portfolio_constraints.html.markdown index 5fda31628c04..306a44e5782a 100644 --- a/website/docs/cdktf/python/d/servicecatalog_portfolio_constraints.html.markdown +++ b/website/docs/cdktf/python/d/servicecatalog_portfolio_constraints.html.markdown @@ -41,6 +41,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `accept_language` - (Optional) Language code. Valid values: `en` (English), `jp` (Japanese), `zh` (Chinese). Default value is `en`. * `product_id` - (Optional) Product identifier. @@ -58,4 +59,4 @@ This data source exports the following attributes in addition to the arguments a * `product_id` - Identifier of the product the constraint applies to. A constraint applies to a specific instance of a product within a certain portfolio. * `type` - Type of constraint. Valid values are `LAUNCH`, `NOTIFICATION`, `STACKSET`, and `TEMPLATE`. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/servicecatalog_product.html.markdown b/website/docs/cdktf/python/d/servicecatalog_product.html.markdown index d85ed2a0203c..a2ccb367fb5f 100644 --- a/website/docs/cdktf/python/d/servicecatalog_product.html.markdown +++ b/website/docs/cdktf/python/d/servicecatalog_product.html.markdown @@ -43,6 +43,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `accept_language` - (Optional) Language code. Valid values are `en` (English), `jp` (Japanese), `zh` (Chinese). The default value is `en`. ## Attribute Reference @@ -63,4 +64,4 @@ This data source exports the following attributes in addition to the arguments a * `tags` - Tags applied to the product. * `type` - Type of product. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/servicecatalog_provisioning_artifacts.html.markdown b/website/docs/cdktf/python/d/servicecatalog_provisioning_artifacts.html.markdown index b788bc535377..62a43e4f4b90 100644 --- a/website/docs/cdktf/python/d/servicecatalog_provisioning_artifacts.html.markdown +++ b/website/docs/cdktf/python/d/servicecatalog_provisioning_artifacts.html.markdown @@ -41,6 +41,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `accept_language` - (Optional) Language code. Valid values: `en` (English), `jp` (Japanese), `zh` (Chinese). Default value is `en`. ## Attribute Reference @@ -59,4 +60,4 @@ This data source exports the following attributes in addition to the arguments a * `name` - The name of the provisioning artifact. * `type` - The type of provisioning artifact. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/servicecatalogappregistry_application.html.markdown b/website/docs/cdktf/python/d/servicecatalogappregistry_application.html.markdown index f0075a11a3e1..eb51aa079f49 100644 --- a/website/docs/cdktf/python/d/servicecatalogappregistry_application.html.markdown +++ b/website/docs/cdktf/python/d/servicecatalogappregistry_application.html.markdown @@ -35,8 +35,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `id` - (Required) Application identifier. ## Attribute Reference @@ -49,4 +50,4 @@ This data source exports the following attributes in addition to the arguments a * `name` - Name of the application. * `tags` - A map of tags assigned to the Application. 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. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/servicecatalogappregistry_attribute_group.html.markdown b/website/docs/cdktf/python/d/servicecatalogappregistry_attribute_group.html.markdown index 745253c6adfe..2870e4168ded 100644 --- a/website/docs/cdktf/python/d/servicecatalogappregistry_attribute_group.html.markdown +++ b/website/docs/cdktf/python/d/servicecatalogappregistry_attribute_group.html.markdown @@ -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 DataAwsServicecatalogappregistryAttributeGroup +from imports.aws.data_aws_servicecatalogappregistry_attribute_group import DataAwsServicecatalogappregistryAttributeGroup class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) @@ -37,8 +37,8 @@ class MyConvertedCode(TerraformStack): The following arguments are optional: +* `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). ~> Exactly one of `arn`, `id`, or `name` must be set. - * `arn` - (Optional) ARN of the Attribute Group to find. * `id` - (Optional) ID of the Attribute Group to find. * `name` - (Optional) Name of the Attribute Group to find. @@ -51,4 +51,4 @@ This data source exports the following attributes in addition to the arguments a * `description` - Description of the Attribute Group. * `tags` - A map of tags assigned to the Attribute Group. 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. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/servicecatalogappregistry_attribute_group_associations.html.markdown b/website/docs/cdktf/python/d/servicecatalogappregistry_attribute_group_associations.html.markdown index 8630a33191d7..f0623037f268 100644 --- a/website/docs/cdktf/python/d/servicecatalogappregistry_attribute_group_associations.html.markdown +++ b/website/docs/cdktf/python/d/servicecatalogappregistry_attribute_group_associations.html.markdown @@ -37,17 +37,15 @@ class MyConvertedCode(TerraformStack): The following arguments are optional: +* `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). ~> Exactly one of `id`or `name` must be set. - * `id` - (Optional) ID of the application to which attribute groups are associated. * `name` - (Optional) Name of the application to which attribute groups are associated. -The following arguments are optional: - ## Attribute Reference This data source exports the following attributes in addition to the arguments above: * `attribute_group_ids` - Set of attribute group IDs this application is associated with. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/servicequotas_service.html.markdown b/website/docs/cdktf/python/d/servicequotas_service.html.markdown index 4ed83cb26b29..200bd6e9aa48 100644 --- a/website/docs/cdktf/python/d/servicequotas_service.html.markdown +++ b/website/docs/cdktf/python/d/servicequotas_service.html.markdown @@ -37,6 +37,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `service_name` - (Required) Service name to lookup within Service Quotas. Available values can be found with the [AWS CLI service-quotas list-services command](https://docs.aws.amazon.com/cli/latest/reference/service-quotas/list-services.html). ## Attribute Reference @@ -46,4 +47,4 @@ This data source exports the following attributes in addition to the arguments a * `id` - Code of the service. * `service_code` - Code of the service. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/servicequotas_service_quota.html.markdown b/website/docs/cdktf/python/d/servicequotas_service_quota.html.markdown index b3409e6ffff9..b64818efefc1 100644 --- a/website/docs/cdktf/python/d/servicequotas_service_quota.html.markdown +++ b/website/docs/cdktf/python/d/servicequotas_service_quota.html.markdown @@ -42,6 +42,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `service_code` - (Required) Service code for the quota. Available values can be found with the [`aws_servicequotas_service` data source](/docs/providers/aws/d/servicequotas_service.html) or [AWS CLI service-quotas list-services command](https://docs.aws.amazon.com/cli/latest/reference/service-quotas/list-services.html). * `quota_code` - (Optional) Quota code within the service. When configured, the data source directly looks up the service quota. Available values can be found with the [AWS CLI service-quotas list-service-quotas command](https://docs.aws.amazon.com/cli/latest/reference/service-quotas/list-service-quotas.html). One of `quota_code` or `quota_name` must be specified. * `quota_name` - (Optional) Quota name within the service. When configured, the data source searches through all service quotas to find the matching quota name. Available values can be found with the [AWS CLI service-quotas list-service-quotas command](https://docs.aws.amazon.com/cli/latest/reference/service-quotas/list-service-quotas.html). One of `quota_name` or `quota_code` must be specified. @@ -69,4 +70,4 @@ This data source exports the following attributes in addition to the arguments a * `metric_statistic_recommendation` - The metric statistic that AWS recommend you use when determining quota usage. * `value` - Current value of the service quota. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/servicequotas_templates.html.markdown b/website/docs/cdktf/python/d/servicequotas_templates.html.markdown index 37a6c91db733..98f134ce99e2 100644 --- a/website/docs/cdktf/python/d/servicequotas_templates.html.markdown +++ b/website/docs/cdktf/python/d/servicequotas_templates.html.markdown @@ -3,14 +3,14 @@ subcategory: "Service Quotas" layout: "aws" page_title: "AWS: aws_servicequotas_templates" description: |- - Terraform data source for managing an AWS Service Quotas Templates. + Terraform data source for managing AWS Service Quotas Templates. --- # Data Source: aws_servicequotas_templates -Terraform data source for managing an AWS Service Quotas Templates. +Terraform data source for managing AWS Service Quotas Templates. ## Example Usage @@ -29,15 +29,16 @@ class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) DataAwsServicequotasTemplates(self, "example", - region="us-east-1" + aws_region="us-east-1" ) ``` ## Argument Reference -The following arguments are required: +This data source supports the following arguments: -* `region` - (Required) AWS Region to which the quota increases apply. +* `aws_region` - (Optional) AWS Region to which the quota increases apply. +* `region` - (Optional, **Deprecated**) AWS Region to which the quota increases apply. Use `aws_region` instead. ## Attribute Reference @@ -51,9 +52,9 @@ This data source exports the following attributes in addition to the arguments a * `quota_name` - Quota name. * `quota_code` - Quota identifier. * `region` - AWS Region to which the template applies. -* `service_code` - (Required) Service identifier. +* `service_code` - Service identifier. * `service_name` - Service name. * `unit` - Unit of measurement. -* `value` - (Required) The new, increased value for the quota. +* `value` - The new, increased value for the quota. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/ses_active_receipt_rule_set.html.markdown b/website/docs/cdktf/python/d/ses_active_receipt_rule_set.html.markdown index 1d70845e28b6..3ff9964df6fb 100644 --- a/website/docs/cdktf/python/d/ses_active_receipt_rule_set.html.markdown +++ b/website/docs/cdktf/python/d/ses_active_receipt_rule_set.html.markdown @@ -31,7 +31,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -This data source does not support any arguments. +This data source supports the following arguments: + +* `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). ## Attribute Reference @@ -40,4 +42,4 @@ This data source exports the following attributes in addition to the arguments a * `arn` - SES receipt rule set ARN. * `rule_set_name` - Name of the rule set - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/ses_domain_identity.html.markdown b/website/docs/cdktf/python/d/ses_domain_identity.html.markdown index b2dd7038e8b6..a13312c48035 100644 --- a/website/docs/cdktf/python/d/ses_domain_identity.html.markdown +++ b/website/docs/cdktf/python/d/ses_domain_identity.html.markdown @@ -33,7 +33,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -This data source does not support any arguments. +This data source supports the following arguments: + +* `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). ## Attribute Reference @@ -43,4 +45,4 @@ This data source exports the following attributes in addition to the arguments a * `domain` - Name of the domain * `verification_token` - Code which when added to the domain as a TXT record will signal to SES that the owner of the domain has authorized SES to act on their behalf. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/ses_email_identity.html.markdown b/website/docs/cdktf/python/d/ses_email_identity.html.markdown index 47880e1ac236..2129bde48116 100644 --- a/website/docs/cdktf/python/d/ses_email_identity.html.markdown +++ b/website/docs/cdktf/python/d/ses_email_identity.html.markdown @@ -33,7 +33,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -This data source does not support any arguments. +This data source supports the following arguments: + +* `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). ## Attribute Reference @@ -42,4 +44,4 @@ This data source exports the following attributes in addition to the arguments a * `arn` - The ARN of the email identity. * `email` - Email identity. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/sesv2_configuration_set.html.markdown b/website/docs/cdktf/python/d/sesv2_configuration_set.html.markdown index 26a10b7e3497..2aff77630e65 100644 --- a/website/docs/cdktf/python/d/sesv2_configuration_set.html.markdown +++ b/website/docs/cdktf/python/d/sesv2_configuration_set.html.markdown @@ -35,8 +35,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `configuration_set_name` - (Required) The name of the configuration set. ## Attribute Reference @@ -64,4 +65,4 @@ This data source exports the following attributes in addition to the arguments a * `guardian_options` - Specifies additional settings for your VDM configuration as applicable to the Guardian. * `optimized_shared_delivery` - Specifies the status of your VDM optimized shared delivery. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/sesv2_dedicated_ip_pool.html.markdown b/website/docs/cdktf/python/d/sesv2_dedicated_ip_pool.html.markdown index bb8bf384ee82..f763ea567932 100644 --- a/website/docs/cdktf/python/d/sesv2_dedicated_ip_pool.html.markdown +++ b/website/docs/cdktf/python/d/sesv2_dedicated_ip_pool.html.markdown @@ -35,8 +35,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `pool_name` - (Required) Name of the dedicated IP pool. ## Attribute Reference @@ -54,4 +55,4 @@ This data source exports the following attributes in addition to the arguments a * `warmup_percentage` - Indicates how complete the dedicated IP warm-up process is. When this value equals `1`, the address has completed the warm-up process and is ready for use. * `warmup_status` - The warm-up status of a dedicated IP address. Valid values: `IN_PROGRESS`, `DONE`. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/sesv2_email_identity.html.markdown b/website/docs/cdktf/python/d/sesv2_email_identity.html.markdown index f50eeb0a55bb..bc31bd256fea 100644 --- a/website/docs/cdktf/python/d/sesv2_email_identity.html.markdown +++ b/website/docs/cdktf/python/d/sesv2_email_identity.html.markdown @@ -35,8 +35,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `email_identity` - (Required) The name of the email identity. ## Attribute Reference @@ -53,6 +54,7 @@ This data source exports the following attributes in addition to the arguments a * `tokens` - If you used Easy DKIM to configure DKIM authentication for the domain, then this object contains a set of unique strings that you use to create a set of CNAME records that you add to the DNS configuration for your domain. When Amazon SES detects these records in the DNS configuration for your domain, the DKIM authentication process is complete. If you configured DKIM authentication for the domain by providing your own public-private key pair, then this object contains the selector for the public key. * `identity_type` - The email identity type. Valid values: `EMAIL_ADDRESS`, `DOMAIN`. * `tags` - Key-value mapping of resource tags. +* `verification_status` - The verification status of the identity. The status can be one of the following: `PENDING`, `SUCCESS`, `FAILED`, `TEMPORARY_FAILURE`, and `NOT_STARTED`. * `verified_for_sending_status` - Specifies whether or not the identity is verified. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/sesv2_email_identity_mail_from_attributes.html.markdown b/website/docs/cdktf/python/d/sesv2_email_identity_mail_from_attributes.html.markdown index fe5a8d977e2e..88b03c60c701 100644 --- a/website/docs/cdktf/python/d/sesv2_email_identity_mail_from_attributes.html.markdown +++ b/website/docs/cdktf/python/d/sesv2_email_identity_mail_from_attributes.html.markdown @@ -42,8 +42,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `email_identity` - (Required) The name of the email identity. ## Attribute Reference @@ -53,4 +54,4 @@ This data source exports the following attributes in addition to the arguments a * `behavior_on_mx_failure` - The action to take if the required MX record isn't found when you send an email. Valid values: `USE_DEFAULT_VALUE`, `REJECT_MESSAGE`. * `mail_from_domain` - The custom MAIL FROM domain that you want the verified identity to use. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/sfn_activity.html.markdown b/website/docs/cdktf/python/d/sfn_activity.html.markdown index 3da7edb60730..61642a34b7fb 100644 --- a/website/docs/cdktf/python/d/sfn_activity.html.markdown +++ b/website/docs/cdktf/python/d/sfn_activity.html.markdown @@ -35,6 +35,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `name` - (Optional) Name that identifies the activity. * `arn` - (Optional) ARN that identifies the activity. @@ -45,4 +46,4 @@ This data source exports the following attributes in addition to the arguments a * `id` - ARN that identifies the activity. * `creation_date` - Date the activity was created. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/sfn_alias.html.markdown b/website/docs/cdktf/python/d/sfn_alias.html.markdown index 4e88faed6ee6..308c7f103247 100644 --- a/website/docs/cdktf/python/d/sfn_alias.html.markdown +++ b/website/docs/cdktf/python/d/sfn_alias.html.markdown @@ -36,8 +36,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `name` - (Required) Name of the State Machine alias. * `statemachine_arn` - (Required) ARN of the State Machine. @@ -50,4 +51,4 @@ This data source exports the following attributes in addition to the arguments a * `description` - Description of state machine alias. * `routing_configuration` - Routing Configuration of state machine alias - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/sfn_state_machine.html.markdown b/website/docs/cdktf/python/d/sfn_state_machine.html.markdown index d25072df4cb5..f48e44b1d205 100644 --- a/website/docs/cdktf/python/d/sfn_state_machine.html.markdown +++ b/website/docs/cdktf/python/d/sfn_state_machine.html.markdown @@ -37,6 +37,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `name` - (Required) Friendly name of the state machine to match. ## Attribute Reference @@ -51,4 +52,4 @@ This data source exports the following attributes in addition to the arguments a * `revision_id` - The revision identifier for the state machine. * `status` - Set to the current status of the state machine. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/sfn_state_machine_versions.html.markdown b/website/docs/cdktf/python/d/sfn_state_machine_versions.html.markdown index 8da67deb2cb3..074d97ea8bf9 100644 --- a/website/docs/cdktf/python/d/sfn_state_machine_versions.html.markdown +++ b/website/docs/cdktf/python/d/sfn_state_machine_versions.html.markdown @@ -35,8 +35,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `statemachine_arn` - (Required) ARN of the State Machine. ## Attribute Reference @@ -45,4 +46,4 @@ This data source exports the following attributes in addition to the arguments a * `statemachine_versions` - ARN List identifying the statemachine versions. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/signer_signing_job.html.markdown b/website/docs/cdktf/python/d/signer_signing_job.html.markdown index 880f1c8a4a77..3487dfd3c2cd 100644 --- a/website/docs/cdktf/python/d/signer_signing_job.html.markdown +++ b/website/docs/cdktf/python/d/signer_signing_job.html.markdown @@ -35,6 +35,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `job_id` - (Required) ID of the signing job on output. ## Attribute Reference @@ -57,4 +58,4 @@ This data source exports the following attributes in addition to the arguments a * `status` - Status of the signing job. * `status_reason` - String value that contains the status reason. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/signer_signing_profile.html.markdown b/website/docs/cdktf/python/d/signer_signing_profile.html.markdown index 8d4ddae7df93..49a1299c792d 100644 --- a/website/docs/cdktf/python/d/signer_signing_profile.html.markdown +++ b/website/docs/cdktf/python/d/signer_signing_profile.html.markdown @@ -35,6 +35,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `name` - (Required) Name of the target signing profile. ## Attribute Reference @@ -46,9 +47,12 @@ This data source exports the following attributes in addition to the arguments a * `platform_id` - ID of the platform that is used by the target signing profile. * `revocation_record` - Revocation information for a signing profile. * `signature_validity_period` - The validity period for a signing job. +* `signing_material` - AWS Certificate Manager certificate that will be used to sign code with the new signing profile. + * `certificate_arn` - ARN of the certificate used for signing. +* `signing_parameters` - Map of key-value pairs for signing. * `status` - Status of the target signing profile. * `tags` - List of tags associated with the signing profile. * `version` - Current version of the signing profile. * `version_arn` - Signing profile ARN, including the profile version. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/sns_topic.html.markdown b/website/docs/cdktf/python/d/sns_topic.html.markdown index 1201fc5b3cef..db46ee81716e 100644 --- a/website/docs/cdktf/python/d/sns_topic.html.markdown +++ b/website/docs/cdktf/python/d/sns_topic.html.markdown @@ -37,6 +37,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `name` - (Required) Friendly name of the topic to match. ## Attribute Reference @@ -47,4 +48,4 @@ This data source exports the following attributes in addition to the arguments a * `id` - ARN of the found topic, suitable for referencing in other resources that support SNS topics. * `tags` - Map of tags for the resource. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/spot_datafeed_subscription.html.markdown b/website/docs/cdktf/python/d/spot_datafeed_subscription.html.markdown index 17b96bbe7d99..5306c87f3590 100644 --- a/website/docs/cdktf/python/d/spot_datafeed_subscription.html.markdown +++ b/website/docs/cdktf/python/d/spot_datafeed_subscription.html.markdown @@ -33,7 +33,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -This data source does not support any arguments. +This data source supports the following arguments: + +* `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). ## Attribute Reference @@ -42,4 +44,4 @@ This data source exports the following attributes in addition to the arguments a * `bucket` - The name of the Amazon S3 bucket where the spot instance data feed is located. * `prefix` - The prefix for the data feed files. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/sqs_queue.html.markdown b/website/docs/cdktf/python/d/sqs_queue.html.markdown index 12127153678b..ba9c0daeea8c 100644 --- a/website/docs/cdktf/python/d/sqs_queue.html.markdown +++ b/website/docs/cdktf/python/d/sqs_queue.html.markdown @@ -39,6 +39,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `name` - (Required) Name of the queue to match. ## Attribute Reference @@ -49,4 +50,4 @@ This data source exports the following attributes in addition to the arguments a * `url` - URL of the queue. * `tags` - Map of tags for the resource. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/sqs_queues.html.markdown b/website/docs/cdktf/python/d/sqs_queues.html.markdown index 5928e33e308f..c05641d04057 100644 --- a/website/docs/cdktf/python/d/sqs_queues.html.markdown +++ b/website/docs/cdktf/python/d/sqs_queues.html.markdown @@ -37,6 +37,7 @@ class MyConvertedCode(TerraformStack): The following arguments are optional: +* `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). * `queue_name_prefix` - (Optional) A string to use for filtering the list results. Only those queues whose name begins with the specified string are returned. Queue URLs and names are case-sensitive. ## Attribute Reference @@ -45,4 +46,4 @@ This data source exports the following attributes in addition to the arguments a * `queue_urls` - A list of queue URLs. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/ssm_document.html.markdown b/website/docs/cdktf/python/d/ssm_document.html.markdown index ca16b466f32a..5b1f42f97739 100644 --- a/website/docs/cdktf/python/d/ssm_document.html.markdown +++ b/website/docs/cdktf/python/d/ssm_document.html.markdown @@ -61,6 +61,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `name` - (Required) The name of the document. * `document_format` - The format of the document. Valid values: `JSON`, `TEXT`, `YAML`. * `document_version` - The document version. @@ -73,4 +74,4 @@ This data source exports the following attributes in addition to the arguments a * `content` - The content for the SSM document in JSON or YAML format. * `document_type` - The type of the document. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/ssm_instances.html.markdown b/website/docs/cdktf/python/d/ssm_instances.html.markdown index 6a0b482b396a..e22fee64c125 100644 --- a/website/docs/cdktf/python/d/ssm_instances.html.markdown +++ b/website/docs/cdktf/python/d/ssm_instances.html.markdown @@ -39,6 +39,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `filter` - (Optional) Configuration block(s) for filtering. Detailed below. ### filter Configuration Block @@ -54,4 +55,4 @@ This data source exports the following attributes in addition to the arguments a * `ids` - Set of instance IDs of the matched SSM managed instances. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/ssm_maintenance_windows.html.markdown b/website/docs/cdktf/python/d/ssm_maintenance_windows.html.markdown index 837c2b00571e..84208c0f40a7 100644 --- a/website/docs/cdktf/python/d/ssm_maintenance_windows.html.markdown +++ b/website/docs/cdktf/python/d/ssm_maintenance_windows.html.markdown @@ -39,6 +39,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `filter` - (Optional) Configuration block(s) for filtering. Detailed below. ### filter Configuration Block @@ -54,4 +55,4 @@ This data source exports the following attributes in addition to the arguments a * `ids` - List of window IDs of the matched SSM maintenance windows. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/ssm_parameter.html.markdown b/website/docs/cdktf/python/d/ssm_parameter.html.markdown index 4c59ab68acb2..53547f557994 100644 --- a/website/docs/cdktf/python/d/ssm_parameter.html.markdown +++ b/website/docs/cdktf/python/d/ssm_parameter.html.markdown @@ -40,6 +40,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `name` - (Required) Name of the parameter. * `with_decryption` - (Optional) Whether to return decrypted `SecureString` value. Defaults to `true`. @@ -54,4 +55,4 @@ This data source exports the following attributes in addition to the arguments a * `insecure_value` - Value of the parameter. **Use caution:** This value is never marked as sensitive. * `version` - Version of the parameter. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/ssm_parameters_by_path.html.markdown b/website/docs/cdktf/python/d/ssm_parameters_by_path.html.markdown index cc81c270ec94..5b3d03c71f47 100644 --- a/website/docs/cdktf/python/d/ssm_parameters_by_path.html.markdown +++ b/website/docs/cdktf/python/d/ssm_parameters_by_path.html.markdown @@ -39,6 +39,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `path` - (Required) The hierarchy for the parameter. Hierarchies start with a forward slash (/). The hierarchy is the parameter name except the last part of the parameter. The last part of the parameter name can't be in the path. A parameter name hierarchy can have a maximum of 15 levels. **Note:** If the parameter name (e.g., `/my-app/my-param`) is specified, the data source will not retrieve any value as designed, unless there are other parameters that happen to use the former path in their hierarchy (e.g., `/my-app/my-param/my-actual-param`). * `with_decryption` - (Optional) Whether to retrieve all parameters in the hierarchy, particularly those of `SecureString` type, with their value decrypted. Defaults to `true`. * `recursive` - (Optional) Whether to retrieve all parameters within the hirerachy. Defaults to `false`. @@ -52,4 +53,4 @@ This data source exports the following attributes in addition to the arguments a * `types` - A list that contains the types (`String`, `StringList`, or `SecureString`) of retrieved parameters. * `values` - A list that contains the retrieved parameter values. **Note:** This value is always marked as sensitive in the Terraform plan output, regardless of whether any retrieved parameters are of `SecureString` type. Use the [`nonsensitive` function](https://developer.hashicorp.com/terraform/language/functions/nonsensitive) to override the behavior at your own risk and discretion, if you are certain that there are no sensitive values being retrieved. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/ssm_patch_baseline.html.markdown b/website/docs/cdktf/python/d/ssm_patch_baseline.html.markdown index 30772992f136..39a9a8626a4d 100644 --- a/website/docs/cdktf/python/d/ssm_patch_baseline.html.markdown +++ b/website/docs/cdktf/python/d/ssm_patch_baseline.html.markdown @@ -65,6 +65,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `default_baseline` - (Optional) Filters the results against the baselines default_baseline field. * `name_prefix` - (Optional) Filter results by the baseline name prefix. * `operating_system` - (Optional) Specified OS for the baseline. Valid values: `AMAZON_LINUX`, `AMAZON_LINUX_2`, `UBUNTU`, `REDHAT_ENTERPRISE_LINUX`, `SUSE`, `CENTOS`, `ORACLE_LINUX`, `DEBIAN`, `MACOS`, `RASPBIAN` and `ROCKY_LINUX`. @@ -84,6 +85,7 @@ This data source exports the following attributes in addition to the arguments a * `patch_filter` - Patch filter group that defines the criteria for the rule. * `key` - Key for the filter. * `values` - Value for the filter. +* `available_security_updates_compliance_status` - Indicates the compliance status of managed nodes for which security-related patches are available but were not approved. Supported for Windows Server managed nodes only. * `global_filter` - Set of global filters used to exclude patches from the baseline. * `key` - Key for the filter. * `values` - Value for the filter. @@ -98,4 +100,4 @@ This data source exports the following attributes in addition to the arguments a * `name` - Name specified to identify the patch source. * `products` - Specific operating system versions a patch repository applies to. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/ssm_patch_baselines.html.markdown b/website/docs/cdktf/python/d/ssm_patch_baselines.html.markdown index 88d4c2039461..458990a4dc73 100644 --- a/website/docs/cdktf/python/d/ssm_patch_baselines.html.markdown +++ b/website/docs/cdktf/python/d/ssm_patch_baselines.html.markdown @@ -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 DataAwsSsmPatchBaselines +from imports.aws.data_aws_ssm_patch_baselines import DataAwsSsmPatchBaselines class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) @@ -41,18 +41,18 @@ 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 DataAwsSsmPatchBaselines +from imports.aws.data_aws_ssm_patch_baselines import DataAwsSsmPatchBaselines class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) DataAwsSsmPatchBaselines(self, "example", - filter=[{ - "key": "OWNER", - "values": ["AWS"] - }, { - "key": "OPERATING_SYSTEM", - "values": ["WINDOWS"] - } + filter=[DataAwsSsmPatchBaselinesFilter( + key="OWNER", + values=["AWS"] + ), DataAwsSsmPatchBaselinesFilter( + key="OPERATING_SYSTEM", + values=["WINDOWS"] + ) ] ) ``` @@ -61,6 +61,7 @@ class MyConvertedCode(TerraformStack): The following arguments are optional: +* `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). * `filter` - (Optional) Key-value pairs used to filter the results. See [`filter`](#filter-argument-reference) below. * `default_baselines` - (Optional) Only return baseline identities where `default_baseline` is `true`. @@ -83,4 +84,4 @@ This data source exports the following attributes in addition to the arguments a * `default_baseline` - Indicates whether this is the default baseline. AWS Systems Manager supports creating multiple default patch baselines. For example, you can create a default patch baseline for each operating system. * `operating_system` - Operating system the patch baseline applies to. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/ssmcontacts_contact.html.markdown b/website/docs/cdktf/python/d/ssmcontacts_contact.html.markdown index bbfbf777b279..df224a72810a 100644 --- a/website/docs/cdktf/python/d/ssmcontacts_contact.html.markdown +++ b/website/docs/cdktf/python/d/ssmcontacts_contact.html.markdown @@ -35,8 +35,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `arn` - (Required) The Amazon Resource Name (ARN) of the contact or escalation plan. ## Attribute Reference @@ -48,4 +49,4 @@ This data source exports the following attributes in addition to the arguments a * `display_name` - Full friendly name of the contact or escalation plan. * `tags` - Map of tags to assign to the resource. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/ssmcontacts_contact_channel.html.markdown b/website/docs/cdktf/python/d/ssmcontacts_contact_channel.html.markdown index 51f87a898da3..9afbca7a535a 100644 --- a/website/docs/cdktf/python/d/ssmcontacts_contact_channel.html.markdown +++ b/website/docs/cdktf/python/d/ssmcontacts_contact_channel.html.markdown @@ -35,8 +35,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +- `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). - `arn` - Amazon Resource Name (ARN) of the contact channel. ## Attribute Reference @@ -44,13 +45,9 @@ The following arguments are required: This data source exports the following attributes in addition to the arguments above: - `activation_status` - Whether the contact channel is activated. - - `contact_id` - Amazon Resource Name (ARN) of the AWS SSM Contact that the contact channel belongs to. - - `delivery_address` - Details used to engage the contact channel. - - `name` - Name of the contact channel. - - `type` - Type of the contact channel. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/ssmcontacts_plan.html.markdown b/website/docs/cdktf/python/d/ssmcontacts_plan.html.markdown index bc0a3a5b15cc..b25422075e18 100644 --- a/website/docs/cdktf/python/d/ssmcontacts_plan.html.markdown +++ b/website/docs/cdktf/python/d/ssmcontacts_plan.html.markdown @@ -35,8 +35,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `contact_id` - (Required) The Amazon Resource Name (ARN) of the contact or escalation plan. ## Attribute Reference @@ -45,4 +46,4 @@ This data source exports the following attributes in addition to the arguments a * `stage` - List of stages. A contact has an engagement plan with stages that contact specified contact channels. An escalation plan uses stages that contact specified contacts. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/ssmcontacts_rotation.html.markdown b/website/docs/cdktf/python/d/ssmcontacts_rotation.html.markdown index 9d60e09e917d..80a41ac6b94b 100644 --- a/website/docs/cdktf/python/d/ssmcontacts_rotation.html.markdown +++ b/website/docs/cdktf/python/d/ssmcontacts_rotation.html.markdown @@ -35,8 +35,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `arn` - (Required) The Amazon Resource Name (ARN) of the rotation. ## Attribute Reference @@ -50,4 +51,4 @@ This data source exports the following attributes in addition to the arguments a * `start_time` - The date and time, in RFC 3339 format, that the rotation goes into effect. * `tags` - A map of tags to assign to the resource. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/ssmincidents_replication_set.html.markdown b/website/docs/cdktf/python/d/ssmincidents_replication_set.html.markdown index a635d5ba591d..0f38aaf0af66 100644 --- a/website/docs/cdktf/python/d/ssmincidents_replication_set.html.markdown +++ b/website/docs/cdktf/python/d/ssmincidents_replication_set.html.markdown @@ -42,14 +42,16 @@ This data source does not support any arguments. This data source exports the following attributes in addition to the arguments above: * `arn` - The Amazon Resource Name (ARN) of the replication set. -* `tags` - All tags applied to the replication set. * `created_by` - The ARN of the user who created the replication set. * `deletion_protected` - If `true`, the last remaining Region in a replication set can’t be deleted. * `last_modified_by` - The ARN of the user who last modified the replication set. +* `region` - (**Deprecated**) The replication set's Regions. Use `regions` instead. +* `regions` - The replication set's Regions. * `status` - The overall status of a replication set. * Valid Values: `ACTIVE` | `CREATING` | `UPDATING` | `DELETING` | `FAILED` +* `tags` - All tags applied to the replication set. -The `region` configuration block exports the following attributes for each Region: +The `regions` configuration block exports the following attributes for each Region: * `name` - The name of the Region. * `kms_key_arn` - The ARN of the AWS Key Management Service (AWS KMS) encryption key. @@ -57,4 +59,4 @@ The `region` configuration block exports the following attributes for each Regio * Valid Values: `ACTIVE` | `CREATING` | `UPDATING` | `DELETING` | `FAILED` * `status_message` - More information about the status of a Region. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/ssmincidents_response_plan.html.markdown b/website/docs/cdktf/python/d/ssmincidents_response_plan.html.markdown index ab5892539959..d820071fb1ac 100644 --- a/website/docs/cdktf/python/d/ssmincidents_response_plan.html.markdown +++ b/website/docs/cdktf/python/d/ssmincidents_response_plan.html.markdown @@ -37,8 +37,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `arn` - (Required) The Amazon Resource Name (ARN) of the response plan. ## Attribute Reference @@ -87,4 +88,4 @@ The `integration` configuration block exports the following attributes: * `service_id` - The ID of the PagerDuty service that the response plan associates with an incident when it launches. * `secret_id` - The ID of the AWS Secrets Manager secret that stores your PagerDuty key — either a General Access REST API Key or User Token REST API Key — and other user credentials. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/ssoadmin_application.html.markdown b/website/docs/cdktf/python/d/ssoadmin_application.html.markdown index cf36ce241c1c..250c900b39f4 100644 --- a/website/docs/cdktf/python/d/ssoadmin_application.html.markdown +++ b/website/docs/cdktf/python/d/ssoadmin_application.html.markdown @@ -35,8 +35,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `application_arn` - (Required) ARN of the application. ## Attribute Reference @@ -52,4 +53,4 @@ This data source exports the following attributes in addition to the arguments a * `portal_options` - Options for the portal associated with an application. See the `aws_ssoadmin_application` [resource documentation](../r/ssoadmin_application.html.markdown#portal_options-argument-reference). The attributes are the same. * `status` - Status of the application. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/ssoadmin_application_assignments.html.markdown b/website/docs/cdktf/python/d/ssoadmin_application_assignments.html.markdown index ace12553c08f..df8ad2061747 100644 --- a/website/docs/cdktf/python/d/ssoadmin_application_assignments.html.markdown +++ b/website/docs/cdktf/python/d/ssoadmin_application_assignments.html.markdown @@ -29,14 +29,15 @@ class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) DataAwsSsoadminApplicationAssignments(self, "example", - application_arn=Token.as_string(aws_ssoadmin_application_example.application_arn) + application_arn=Token.as_string(aws_ssoadmin_application_example.arn) ) ``` ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `application_arn` - (Required) ARN of the application. ## Attribute Reference @@ -51,4 +52,4 @@ This data source exports the following attributes in addition to the arguments a * `principal_id` - An identifier for an object in IAM Identity Center, such as a user or group. * `principal_type` - Entity type for which the assignment will be created. Valid values are `USER` or `GROUP`. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/ssoadmin_application_providers.html.markdown b/website/docs/cdktf/python/d/ssoadmin_application_providers.html.markdown index 57c1aca2d77f..6f914fa9d0a0 100644 --- a/website/docs/cdktf/python/d/ssoadmin_application_providers.html.markdown +++ b/website/docs/cdktf/python/d/ssoadmin_application_providers.html.markdown @@ -33,7 +33,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -This data source does not support any arguments. +This data source supports the following arguments: + +* `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). ## Attribute Reference @@ -54,4 +56,4 @@ This data source exports the following attributes in addition to the arguments a * `display_name` - Name of the application provider. * `icon_url` - URL that points to an icon that represents the application provider. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/ssoadmin_instances.html.markdown b/website/docs/cdktf/python/d/ssoadmin_instances.html.markdown index 5409c5093de4..ad43e1c84902 100644 --- a/website/docs/cdktf/python/d/ssoadmin_instances.html.markdown +++ b/website/docs/cdktf/python/d/ssoadmin_instances.html.markdown @@ -37,7 +37,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -This data source does not support any arguments. +This data source supports the following arguments: + +* `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). ## Attribute Reference @@ -47,4 +49,4 @@ This data source exports the following attributes in addition to the arguments a * `id` - AWS Region. * `identity_store_ids` - Set of identifiers of the identity stores connected to the SSO Instances. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/ssoadmin_permission_set.html.markdown b/website/docs/cdktf/python/d/ssoadmin_permission_set.html.markdown index 7c0cd7a76fbd..873c7c864144 100644 --- a/website/docs/cdktf/python/d/ssoadmin_permission_set.html.markdown +++ b/website/docs/cdktf/python/d/ssoadmin_permission_set.html.markdown @@ -45,12 +45,13 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: -~> **NOTE:** Either `arn` or `name` must be configured. - +* `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). * `arn` - (Optional) ARN of the permission set. * `instance_arn` - (Required) ARN of the SSO Instance associated with the permission set. * `name` - (Optional) Name of the SSO Permission Set. +~> **NOTE:** Either `arn` or `name` must be configured. + ## Attribute Reference This data source exports the following attributes in addition to the arguments above: @@ -61,4 +62,4 @@ This data source exports the following attributes in addition to the arguments a * `session_duration` - Length of time that the application user sessions are valid in the ISO-8601 standard. * `tags` - Key-value map of resource tags. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/ssoadmin_permission_sets.html.markdown b/website/docs/cdktf/python/d/ssoadmin_permission_sets.html.markdown index 050c69e1fd09..5c1ccbb817df 100644 --- a/website/docs/cdktf/python/d/ssoadmin_permission_sets.html.markdown +++ b/website/docs/cdktf/python/d/ssoadmin_permission_sets.html.markdown @@ -41,8 +41,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `instance_arn` - (Required) ARN of the SSO Instance associated with the permission set. ## Attribute Reference @@ -51,4 +52,4 @@ This data source exports the following attributes in addition to the arguments a * `arns` - Set of string contain the ARN of all Permission Sets. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/ssoadmin_principal_application_assignments.html.markdown b/website/docs/cdktf/python/d/ssoadmin_principal_application_assignments.html.markdown index dd54fcb0eecf..bff13faafc0e 100644 --- a/website/docs/cdktf/python/d/ssoadmin_principal_application_assignments.html.markdown +++ b/website/docs/cdktf/python/d/ssoadmin_principal_application_assignments.html.markdown @@ -37,8 +37,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `instance_arn` - (Required) ARN of the instance of IAM Identity Center. * `principal_id` - (Required) An identifier for an object in IAM Identity Center, such as a user or group. * `principal_type` - (Required) Entity type for which the assignment will be created. Valid values are `USER` or `GROUP`. @@ -55,4 +56,4 @@ This data source exports the following attributes in addition to the arguments a * `principal_id` - An identifier for an object in IAM Identity Center, such as a user or group. * `principal_type` - Entity type for which the assignment will be created. Valid values are `USER` or `GROUP`. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/storagegateway_local_disk.html.markdown b/website/docs/cdktf/python/d/storagegateway_local_disk.html.markdown index 61207a566a3f..8799db73e9de 100644 --- a/website/docs/cdktf/python/d/storagegateway_local_disk.html.markdown +++ b/website/docs/cdktf/python/d/storagegateway_local_disk.html.markdown @@ -36,6 +36,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `gateway_arn` - (Required) ARN of the gateway. * `disk_node` - (Optional) Device node of the local disk to retrieve. For example, `/dev/sdb`. * `disk_path` - (Optional) Device path of the local disk to retrieve. For example, `/dev/xvdb` or `/dev/nvme1n1`. @@ -47,4 +48,4 @@ This data source exports the following attributes in addition to the arguments a * `disk_id` - Disk identifierE.g., `pci-0000:03:00.0-scsi-0:0:0:0` * `id` - Disk identifierE.g., `pci-0000:03:00.0-scsi-0:0:0:0` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/subnet.html.markdown b/website/docs/cdktf/python/d/subnet.html.markdown index 05a16d7e1293..01693d7c3b30 100644 --- a/website/docs/cdktf/python/d/subnet.html.markdown +++ b/website/docs/cdktf/python/d/subnet.html.markdown @@ -78,6 +78,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `availability_zone` - (Optional) Availability zone where the subnet must reside. * `availability_zone_id` - (Optional) ID of the Availability Zone for the subnet. This argument is not supported in all regions or partitions. If necessary, use `availability_zone` instead. * `cidr_block` - (Optional) CIDR block of the desired subnet. @@ -124,4 +125,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/subnets.html.markdown b/website/docs/cdktf/python/d/subnets.html.markdown index 1df3d9fd579b..a4e925b4fa2b 100644 --- a/website/docs/cdktf/python/d/subnets.html.markdown +++ b/website/docs/cdktf/python/d/subnets.html.markdown @@ -98,6 +98,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `filter` - (Optional) Custom filter block as described below. * `tags` - (Optional) Map of tags, each pair of which must exactly match a pair on the desired subnets. @@ -148,4 +149,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/synthetics_runtime_version.html.markdown b/website/docs/cdktf/python/d/synthetics_runtime_version.html.markdown index f1e203f516bb..4eab77567a53 100644 --- a/website/docs/cdktf/python/d/synthetics_runtime_version.html.markdown +++ b/website/docs/cdktf/python/d/synthetics_runtime_version.html.markdown @@ -61,6 +61,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `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`. @@ -74,4 +75,4 @@ This data source exports the following attributes in addition to the arguments a * `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). - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/synthetics_runtime_versions.html.markdown b/website/docs/cdktf/python/d/synthetics_runtime_versions.html.markdown index 365d379450e9..850d8a5f3fc9 100644 --- a/website/docs/cdktf/python/d/synthetics_runtime_versions.html.markdown +++ b/website/docs/cdktf/python/d/synthetics_runtime_versions.html.markdown @@ -33,7 +33,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -This data source does not support any arguments. +This data source supports the following arguments: + +* `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). ## Attribute Reference @@ -50,4 +52,4 @@ This data source exports the following attributes in addition to the arguments a * `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). - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/timestreamwrite_database.html.markdown b/website/docs/cdktf/python/d/timestreamwrite_database.html.markdown index 629cba4a33ef..390063e0a69d 100644 --- a/website/docs/cdktf/python/d/timestreamwrite_database.html.markdown +++ b/website/docs/cdktf/python/d/timestreamwrite_database.html.markdown @@ -35,9 +35,10 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This data source supports the following arguments: -* `database_name` – (Required) The name of the Timestream database. Minimum length of 3. Maximum length of 256. +* `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). +* `database_name` - (Required) The name of the Timestream database. Minimum length of 3. Maximum length of 256. ## Attribute Reference @@ -45,9 +46,9 @@ This data source exports the following attributes in addition to the arguments a * `arn` - The ARN that uniquely identifies this database. * `created_time` - Creation time of database. -* `database_name` – (Required) The name of the Timestream database. Minimum length of 3. Maximum length of 256. +* `database_name` - (Required) The name of the Timestream database. Minimum length of 3. Maximum length of 256. * `kms_key_id` - The ARN of the KMS key used to encrypt the data stored in the database. * `last_updated_time` - Last time database was updated. * `table_count` - Total number of tables in the Timestream database. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/timestreamwrite_table.html.markdown b/website/docs/cdktf/python/d/timestreamwrite_table.html.markdown index 626686fb5bfb..f0b1250de256 100644 --- a/website/docs/cdktf/python/d/timestreamwrite_table.html.markdown +++ b/website/docs/cdktf/python/d/timestreamwrite_table.html.markdown @@ -36,8 +36,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `database_name` - (Required) Name of the Timestream database. * `name` - (Required) Name of the Timestream table. @@ -67,4 +68,4 @@ This data source exports the following attributes in addition to the arguments a * `name` - Name of the table. * `table_status` - Current state of table. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/transfer_connector.html.markdown b/website/docs/cdktf/python/d/transfer_connector.html.markdown index 6b0376102f93..2507c854ed93 100644 --- a/website/docs/cdktf/python/d/transfer_connector.html.markdown +++ b/website/docs/cdktf/python/d/transfer_connector.html.markdown @@ -35,6 +35,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `id` - (Required) Unique identifier for connector ## Attribute Reference @@ -64,4 +65,4 @@ This data source exports the following attributes in addition to the arguments a * `value` - Values associated with the tags key. * `url` - URL of the partner's AS2 or SFTP endpoint. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/transfer_server.html.markdown b/website/docs/cdktf/python/d/transfer_server.html.markdown index 04707628baf2..155cf0ee6519 100644 --- a/website/docs/cdktf/python/d/transfer_server.html.markdown +++ b/website/docs/cdktf/python/d/transfer_server.html.markdown @@ -36,6 +36,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `server_id` - (Required) ID for an SFTP server. ## Attribute Reference @@ -56,4 +57,4 @@ This data source exports the following attributes in addition to the arguments a * `tags` - Map of tags assigned to the resource. * `url` - URL of the service endpoint used to authenticate users with an `identity_provider_type` of `API_GATEWAY`. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/verifiedpermissions_policy_store.html.markdown b/website/docs/cdktf/python/d/verifiedpermissions_policy_store.html.markdown index 2469a1b01922..32fb1b61a972 100644 --- a/website/docs/cdktf/python/d/verifiedpermissions_policy_store.html.markdown +++ b/website/docs/cdktf/python/d/verifiedpermissions_policy_store.html.markdown @@ -35,8 +35,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `id` - (Required) The ID of the Policy Store. ## Attribute Reference @@ -45,8 +46,9 @@ This data source exports the following attributes in addition to the arguments a * `arn` - The ARN of the Policy Store. * `created_date` - The date the Policy Store was created. +* `deletion_protection` - Whether the policy store can be deleted. * `last_updated_date` - The date the Policy Store was last updated. * `tags` - Map of key-value pairs associated with the policy store. * `validation_settings` - Validation settings for the policy store. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/vpc.html.markdown b/website/docs/cdktf/python/d/vpc.html.markdown index 713dd7b915e4..4f23c9575e27 100644 --- a/website/docs/cdktf/python/d/vpc.html.markdown +++ b/website/docs/cdktf/python/d/vpc.html.markdown @@ -53,6 +53,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `cidr_block` - (Optional) Cidr block of the desired VPC. * `dhcp_options_id` - (Optional) DHCP options id of the desired VPC. * `default` - (Optional) Boolean constraint on whether the desired VPC is @@ -104,4 +105,4 @@ The following attribute is additionally exported: - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/vpc_dhcp_options.html.markdown b/website/docs/cdktf/python/d/vpc_dhcp_options.html.markdown index 7daa21496033..04753085eb12 100644 --- a/website/docs/cdktf/python/d/vpc_dhcp_options.html.markdown +++ b/website/docs/cdktf/python/d/vpc_dhcp_options.html.markdown @@ -63,6 +63,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `dhcp_options_id` - (Optional) EC2 DHCP Options ID. * `filter` - (Optional) List of custom filters as described below. @@ -97,4 +98,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/vpc_endpoint.html.markdown b/website/docs/cdktf/python/d/vpc_endpoint.html.markdown index 0cb81ddb49af..32d18712494a 100644 --- a/website/docs/cdktf/python/d/vpc_endpoint.html.markdown +++ b/website/docs/cdktf/python/d/vpc_endpoint.html.markdown @@ -42,6 +42,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `filter` - (Optional) Custom filter block as described below. * `id` - (Optional) ID of the specific VPC Endpoint to retrieve. * `service_name` - (Optional) Service name of the specific VPC Endpoint to retrieve. For AWS services the service name is usually in the form `com.amazonaws..` (the SageMaker AI Notebook service is an exception to this rule, the service name is in the form `aws.sagemaker..notebook`). @@ -102,4 +103,4 @@ DNS options (for `dns_options`) support the following attributes: - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/vpc_endpoint_associations.html.markdown b/website/docs/cdktf/python/d/vpc_endpoint_associations.html.markdown index 5b240ffe0634..8cb64de94d18 100644 --- a/website/docs/cdktf/python/d/vpc_endpoint_associations.html.markdown +++ b/website/docs/cdktf/python/d/vpc_endpoint_associations.html.markdown @@ -35,8 +35,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `vpc_endpoint_id` - ID of the specific VPC Endpoint to retrieve. ## Attribute Reference @@ -72,4 +73,4 @@ DNS blocks (for `private_dns_entry`) support the following attributes: * `dns_name` - DNS name. * `hosted_zone_id` - ID of the private hosted zone. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/vpc_endpoint_service.html.markdown b/website/docs/cdktf/python/d/vpc_endpoint_service.html.markdown index b02fd678c7ff..0d2c2b1419bf 100644 --- a/website/docs/cdktf/python/d/vpc_endpoint_service.html.markdown +++ b/website/docs/cdktf/python/d/vpc_endpoint_service.html.markdown @@ -118,8 +118,9 @@ This data source exports the following attributes in addition to the arguments a * `owner` - AWS account ID of the service owner or `amazon`. * `private_dns_name` - Private DNS name for the service. * `private_dns_names` - Private DNS names assigned to the VPC endpoint service. -* `region` - Region of the endpoint service. +* `region` - (**Deprecated**) Region of the endpoint service. Use `service_region` instead. * `service_id` - ID of the endpoint service. +* `service_region` - Region of the endpoint service. * `supported_ip_address_types` - The supported IP address types. * `tags` - Map of tags assigned to the resource. * `vpc_endpoint_policy_supported` - Whether or not the service supports endpoint policies - `true` or `false`. @@ -130,4 +131,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/vpc_ipam.html.markdown b/website/docs/cdktf/python/d/vpc_ipam.html.markdown index 4a5bb762a6b8..a2371aacb4bc 100644 --- a/website/docs/cdktf/python/d/vpc_ipam.html.markdown +++ b/website/docs/cdktf/python/d/vpc_ipam.html.markdown @@ -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 DataAwsVpcIpam +from imports.aws.data_aws_vpc_ipam import DataAwsVpcIpam class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) @@ -35,8 +35,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `id` - (Required) ID of the IPAM. ## Attribute Reference @@ -50,6 +51,7 @@ This data source exports the following attributes in addition to the arguments a * `enable_private_gua` - If private GUA is enabled. * `id` - ID of the IPAM resource. * `ipam_region` - Region that the IPAM exists in. +* `metered_account` - AWS account that is charged for active IP addresses managed in IPAM. * `operating_regions` - Regions that the IPAM is configured to operate in. * `owner_id` - ID of the account that owns this IPAM. * `private_default_scope_id` - ID of the default private scope. @@ -61,4 +63,4 @@ This data source exports the following attributes in addition to the arguments a * `tier` - IPAM Tier. * `tags` - Tags of the IPAM resource. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/vpc_ipam_pool.html.markdown b/website/docs/cdktf/python/d/vpc_ipam_pool.html.markdown index c35e5d025219..255272ca6082 100644 --- a/website/docs/cdktf/python/d/vpc_ipam_pool.html.markdown +++ b/website/docs/cdktf/python/d/vpc_ipam_pool.html.markdown @@ -57,6 +57,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `ipam_pool_id` - (Optional) ID of the IPAM pool you would like information on. * `filter` - (Optional) Custom filter block as described below. @@ -91,4 +92,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/vpc_ipam_pool_cidrs.html.markdown b/website/docs/cdktf/python/d/vpc_ipam_pool_cidrs.html.markdown index 2035ce7cf6b6..39daaab5a5fe 100644 --- a/website/docs/cdktf/python/d/vpc_ipam_pool_cidrs.html.markdown +++ b/website/docs/cdktf/python/d/vpc_ipam_pool_cidrs.html.markdown @@ -91,6 +91,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `ipam_pool_id` - ID of the IPAM pool you would like the list of provisioned CIDRs. * `filter` - Custom filter block as described below. @@ -119,4 +120,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `1m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/vpc_ipam_pools.html.markdown b/website/docs/cdktf/python/d/vpc_ipam_pools.html.markdown index 911a0214f953..47865414243e 100644 --- a/website/docs/cdktf/python/d/vpc_ipam_pools.html.markdown +++ b/website/docs/cdktf/python/d/vpc_ipam_pools.html.markdown @@ -46,6 +46,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `filter` - (Required) Custom filter block as described below. The arguments of this data source act as filters for querying the available IPAM Pools in the current region. @@ -81,4 +82,4 @@ The following attributes are available on each pool entry found. * `source_ipam_pool_id` - ID of the source IPAM pool. * `tags` - Map of tags to assigned to the resource. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/vpc_ipam_preview_next_cidr.html.markdown b/website/docs/cdktf/python/d/vpc_ipam_preview_next_cidr.html.markdown index 2fb804b36b2b..af41446f8337 100644 --- a/website/docs/cdktf/python/d/vpc_ipam_preview_next_cidr.html.markdown +++ b/website/docs/cdktf/python/d/vpc_ipam_preview_next_cidr.html.markdown @@ -52,6 +52,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `disallowed_cidrs` - (Optional) Exclude a particular CIDR range from being returned by the pool. * `ipam_pool_id` - (Required) ID of the pool to which you want to assign a CIDR. * `netmask_length` - (Optional) Netmask length of the CIDR you would like to preview from the IPAM pool. @@ -69,4 +70,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/vpc_ipams.html.markdown b/website/docs/cdktf/python/d/vpc_ipams.html.markdown index 5aba47d42fda..f2b2f29e7fbe 100644 --- a/website/docs/cdktf/python/d/vpc_ipams.html.markdown +++ b/website/docs/cdktf/python/d/vpc_ipams.html.markdown @@ -83,6 +83,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `ipam_ids` - (Optional) IDs of the IPAM resources to query for. * `filter` - (Optional) Custom filter block as described below. @@ -122,4 +123,4 @@ This data source exports the following attributes in addition to the arguments a * `state_message` - State message of the IPAM. * `tier` - IPAM Tier. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/vpc_peering_connection.html.markdown b/website/docs/cdktf/python/d/vpc_peering_connection.html.markdown index e37936505df2..248fd2b885fd 100644 --- a/website/docs/cdktf/python/d/vpc_peering_connection.html.markdown +++ b/website/docs/cdktf/python/d/vpc_peering_connection.html.markdown @@ -52,11 +52,9 @@ This data source supports the following arguments: * `vpc_id` - (Optional) ID of the requester VPC of the specific VPC Peering Connection to retrieve. * `owner_id` - (Optional) AWS account ID of the owner of the requester VPC of the specific VPC Peering Connection to retrieve. * `cidr_block` - (Optional) Primary CIDR block of the requester VPC of the specific VPC Peering Connection to retrieve. -* `region` - (Optional) Region of the requester VPC of the specific VPC Peering Connection to retrieve. * `peer_vpc_id` - (Optional) ID of the accepter VPC of the specific VPC Peering Connection to retrieve. * `peer_owner_id` - (Optional) AWS account ID of the owner of the accepter VPC of the specific VPC Peering Connection to retrieve. * `peer_cidr_block` - (Optional) Primary CIDR block of the accepter VPC of the specific VPC Peering Connection to retrieve. -* `peer_region` - (Optional) Region of the accepter VPC of the specific VPC Peering Connection to retrieve. * `filter` - (Optional) Custom filter block as described below. * `tags` - (Optional) Map of tags, each pair of which must exactly match a pair on the desired VPC Peering Connection. @@ -70,7 +68,6 @@ More complex filters can be expressed using one or more `filter` sub-blocks, whi * `name` - (Required) Name of the field to filter by, as defined by [the underlying AWS API](http://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeVpcPeeringConnections.html). - * `values` - (Required) Set of values that are accepted for the given field. A VPC Peering Connection will be selected if any one of the given values matches. @@ -84,8 +81,11 @@ This data source exports the following attributes in addition to the arguments a * `ipv6_cidr_block_set` - List of objects with IPv6 CIDR blocks of the requester VPC. * `peer_cidr_block_set` - List of objects with IPv4 CIDR blocks of the accepter VPC. * `peer_ipv6_cidr_block_set` - List of objects with IPv6 CIDR blocks of the accepter VPC. +* `peer_region` - Region of the accepter VPC. +* `region` - (**Deprecated**) Region of the requester VPC. Use `requester_region` instead. * `requester` - Configuration block that describes [VPC Peering Connection] (https://docs.aws.amazon.com/vpc/latest/peering/what-is-vpc-peering.html) options set for the requester VPC. +* `requester_region` - Region of the requester VPC. #### Accepter and Requester Attribute Reference @@ -102,4 +102,4 @@ private IP addresses when queried from instances in a peer VPC. - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/vpc_peering_connections.html.markdown b/website/docs/cdktf/python/d/vpc_peering_connections.html.markdown index e2805efce7df..3b48ef234dd4 100644 --- a/website/docs/cdktf/python/d/vpc_peering_connections.html.markdown +++ b/website/docs/cdktf/python/d/vpc_peering_connections.html.markdown @@ -53,6 +53,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `filter` - (Optional) Custom filter block as described below. * `tags` - (Optional) Mapping of tags, each pair of which must exactly match a pair on the desired VPC Peering Connection. @@ -81,4 +82,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/vpc_security_group_rule.html.markdown b/website/docs/cdktf/python/d/vpc_security_group_rule.html.markdown index b4fb6b75d69e..4c5bac000653 100644 --- a/website/docs/cdktf/python/d/vpc_security_group_rule.html.markdown +++ b/website/docs/cdktf/python/d/vpc_security_group_rule.html.markdown @@ -35,6 +35,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `security_group_rule_id` - (Optional) ID of the security group rule to select. * `filter` - (Optional) Configuration block(s) for filtering. Detailed below. @@ -64,4 +65,4 @@ This data source exports the following attributes in addition to the arguments a * `tags` - A map of tags assigned to the resource. * `to_port` - (Optional) The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/vpc_security_group_rules.html.markdown b/website/docs/cdktf/python/d/vpc_security_group_rules.html.markdown index bab194b0a8a5..701ceea0d04e 100644 --- a/website/docs/cdktf/python/d/vpc_security_group_rules.html.markdown +++ b/website/docs/cdktf/python/d/vpc_security_group_rules.html.markdown @@ -39,6 +39,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `filter` - (Optional) Custom filter block as described below. * `tags` - (Optional) Map of tags, each pair of which must exactly match a pair on the desired security group rule. @@ -59,4 +60,4 @@ This data source exports the following attributes in addition to the arguments a * `ids` - List of all the security group rule IDs found. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/vpclattice_auth_policy.html.markdown b/website/docs/cdktf/python/d/vpclattice_auth_policy.html.markdown index b3418f427c64..5a3d96a971fd 100644 --- a/website/docs/cdktf/python/d/vpclattice_auth_policy.html.markdown +++ b/website/docs/cdktf/python/d/vpclattice_auth_policy.html.markdown @@ -35,8 +35,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `resource_identifier` - (Required) The ID or Amazon Resource Name (ARN) of the service network or service for which the policy is created. ## Attribute Reference @@ -46,4 +47,4 @@ This data source exports the following attributes in addition to the arguments a * `policy` - The auth policy. The policy string in JSON must not contain newlines or blank lines. * `state` - The state of the auth policy. The auth policy is only active when the auth type is set to AWS_IAM. If you provide a policy, then authentication and authorization decisions are made based on this policy and the client's IAM policy. If the Auth type is NONE, then, any auth policy you provide will remain inactive. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/vpclattice_listener.html.markdown b/website/docs/cdktf/python/d/vpclattice_listener.html.markdown index 1ef4b8a1e16e..100cb95d798f 100644 --- a/website/docs/cdktf/python/d/vpclattice_listener.html.markdown +++ b/website/docs/cdktf/python/d/vpclattice_listener.html.markdown @@ -36,8 +36,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `service_identifier` - (Required) ID or Amazon Resource Name (ARN) of the service network * `listener_identifier` - (Required) ID or Amazon Resource Name (ARN) of the listener @@ -57,4 +58,4 @@ This data source exports the following attributes in addition to the arguments a * `service_id` - The ID of the service. * `tags` - List of tags associated with the listener. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/vpclattice_resource_policy.html.markdown b/website/docs/cdktf/python/d/vpclattice_resource_policy.html.markdown index ffce8540e4ab..a3ab9a00dc19 100644 --- a/website/docs/cdktf/python/d/vpclattice_resource_policy.html.markdown +++ b/website/docs/cdktf/python/d/vpclattice_resource_policy.html.markdown @@ -35,8 +35,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `resource_arn` - (Required) Resource ARN of the resource for which a policy is retrieved. ## Attribute Reference @@ -45,4 +46,4 @@ This data source exports the following attributes in addition to the arguments a * `policy` - JSON-encoded string representation of the applied resource policy. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/vpclattice_service.html.markdown b/website/docs/cdktf/python/d/vpclattice_service.html.markdown index e02ff5d55d58..cfe3dcfd96b6 100644 --- a/website/docs/cdktf/python/d/vpclattice_service.html.markdown +++ b/website/docs/cdktf/python/d/vpclattice_service.html.markdown @@ -37,6 +37,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `name` - (Optional) Service name. * `service_identifier` - (Optional) ID or Amazon Resource Name (ARN) of the service. @@ -55,4 +56,4 @@ This data source exports the following attributes in addition to the arguments a * `status` - Status of the service. * `tags` - List of tags associated with the service. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/vpclattice_service_network.html.markdown b/website/docs/cdktf/python/d/vpclattice_service_network.html.markdown index 9e9550be163e..ff0d3fe3c51f 100644 --- a/website/docs/cdktf/python/d/vpclattice_service_network.html.markdown +++ b/website/docs/cdktf/python/d/vpclattice_service_network.html.markdown @@ -37,6 +37,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `service_network_identifier` - (Required) Identifier of the service network. ## Attribute Reference @@ -52,4 +53,4 @@ This data source exports the following attributes in addition to the arguments a * `number_of_associated_services` - Number of services associated with this service network. * `number_of_associated_vpcs` - Number of VPCs associated with this service network. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/vpcs.html.markdown b/website/docs/cdktf/python/d/vpcs.html.markdown index 013b8a607d6b..e0998c4fd45b 100644 --- a/website/docs/cdktf/python/d/vpcs.html.markdown +++ b/website/docs/cdktf/python/d/vpcs.html.markdown @@ -93,6 +93,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `tags` - (Optional) Map of tags, each pair of which must exactly match a pair on the desired vpcs. * `filter` - (Optional) Custom filter block as described below. @@ -119,4 +120,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/vpn_gateway.html.markdown b/website/docs/cdktf/python/d/vpn_gateway.html.markdown index a42f2765e4e6..f730c407f212 100644 --- a/website/docs/cdktf/python/d/vpn_gateway.html.markdown +++ b/website/docs/cdktf/python/d/vpn_gateway.html.markdown @@ -43,6 +43,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `id` - (Optional) ID of the specific VPN Gateway to retrieve. * `state` - (Optional) State of the specific VPN Gateway to retrieve. * `availability_zone` - (Optional) Availability Zone of the specific VPN Gateway to retrieve. @@ -74,4 +75,4 @@ This data source exports no additional attributes. - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/wafregional_ipset.html.markdown b/website/docs/cdktf/python/d/wafregional_ipset.html.markdown index 95ccc6cdc22c..7eaab7a5ff7c 100644 --- a/website/docs/cdktf/python/d/wafregional_ipset.html.markdown +++ b/website/docs/cdktf/python/d/wafregional_ipset.html.markdown @@ -35,6 +35,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `name` - (Required) Name of the WAF Regional IP set. ## Attribute Reference @@ -43,4 +44,4 @@ This data source exports the following attributes in addition to the arguments a * `id` - ID of the WAF Regional IP set. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/wafregional_rate_based_rule.html.markdown b/website/docs/cdktf/python/d/wafregional_rate_based_rule.html.markdown index 0f88bb952912..0568817b6700 100644 --- a/website/docs/cdktf/python/d/wafregional_rate_based_rule.html.markdown +++ b/website/docs/cdktf/python/d/wafregional_rate_based_rule.html.markdown @@ -35,6 +35,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `name` - (Required) Name of the WAF Regional rate based rule. ## Attribute Reference @@ -43,4 +44,4 @@ This data source exports the following attributes in addition to the arguments a * `id` - ID of the WAF Regional rate based rule. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/wafregional_rule.html.markdown b/website/docs/cdktf/python/d/wafregional_rule.html.markdown index b86bc6990faf..96d6ca98ef87 100644 --- a/website/docs/cdktf/python/d/wafregional_rule.html.markdown +++ b/website/docs/cdktf/python/d/wafregional_rule.html.markdown @@ -35,6 +35,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `name` - (Required) Name of the WAF Regional rule. ## Attribute Reference @@ -43,4 +44,4 @@ This data source exports the following attributes in addition to the arguments a * `id` - ID of the WAF Regional rule. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/wafregional_subscribed_rule_group.html.markdown b/website/docs/cdktf/python/d/wafregional_subscribed_rule_group.html.markdown index 6bf00fe37268..ac4f744f120e 100644 --- a/website/docs/cdktf/python/d/wafregional_subscribed_rule_group.html.markdown +++ b/website/docs/cdktf/python/d/wafregional_subscribed_rule_group.html.markdown @@ -54,6 +54,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `name` - (Optional) Name of the WAF rule group. * `metric_name` - (Optional) Name of the WAF rule group. @@ -65,4 +66,4 @@ This data source exports the following attributes in addition to the arguments a * `id` - ID of the WAF rule group. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/wafregional_web_acl.html.markdown b/website/docs/cdktf/python/d/wafregional_web_acl.html.markdown index 55ec368847f5..3a744c5a287b 100644 --- a/website/docs/cdktf/python/d/wafregional_web_acl.html.markdown +++ b/website/docs/cdktf/python/d/wafregional_web_acl.html.markdown @@ -35,6 +35,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `name` - (Required) Name of the WAF Regional Web ACL. ## Attribute Reference @@ -43,4 +44,4 @@ This data source exports the following attributes in addition to the arguments a * `id` - ID of the WAF Regional Web ACL. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/wafv2_ip_set.html.markdown b/website/docs/cdktf/python/d/wafv2_ip_set.html.markdown index 28157bb5262d..53dfede9d7ae 100644 --- a/website/docs/cdktf/python/d/wafv2_ip_set.html.markdown +++ b/website/docs/cdktf/python/d/wafv2_ip_set.html.markdown @@ -36,6 +36,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `name` - (Required) Name of the WAFv2 IP Set. * `scope` - (Required) Specifies whether this is for an AWS CloudFront distribution or for a regional application. Valid values are `CLOUDFRONT` or `REGIONAL`. To work with CloudFront, you must also specify the region `us-east-1` (N. Virginia) on the AWS provider. @@ -49,4 +50,4 @@ This data source exports the following attributes in addition to the arguments a * `id` - Unique identifier for the set. * `ip_address_version` - IP address version of the set. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/wafv2_regex_pattern_set.html.markdown b/website/docs/cdktf/python/d/wafv2_regex_pattern_set.html.markdown index 9e4e2849e01d..503270ed08ae 100644 --- a/website/docs/cdktf/python/d/wafv2_regex_pattern_set.html.markdown +++ b/website/docs/cdktf/python/d/wafv2_regex_pattern_set.html.markdown @@ -36,6 +36,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `name` - (Required) Name of the WAFv2 Regex Pattern Set. * `scope` - (Required) Specifies whether this is for an AWS CloudFront distribution or for a regional application. Valid values are `CLOUDFRONT` or `REGIONAL`. To work with CloudFront, you must also specify the region `us-east-1` (N. Virginia) on the AWS provider. @@ -54,4 +55,4 @@ Each `regular_expression` supports the following argument: * `regex_string` - (Required) String representing the regular expression, see the AWS WAF [documentation](https://docs.aws.amazon.com/waf/latest/developerguide/waf-regex-pattern-set-creating.html) for more information. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/wafv2_rule_group.html.markdown b/website/docs/cdktf/python/d/wafv2_rule_group.html.markdown index e745cf683305..87fd2cf82723 100644 --- a/website/docs/cdktf/python/d/wafv2_rule_group.html.markdown +++ b/website/docs/cdktf/python/d/wafv2_rule_group.html.markdown @@ -36,6 +36,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `name` - (Required) Name of the WAFv2 Rule Group. * `scope` - (Required) Specifies whether this is for an AWS CloudFront distribution or for a regional application. Valid values are `CLOUDFRONT` or `REGIONAL`. To work with CloudFront, you must also specify the region `us-east-1` (N. Virginia) on the AWS provider. @@ -47,4 +48,4 @@ This data source exports the following attributes in addition to the arguments a * `description` - Description of the rule group that helps with identification. * `id` - Unique identifier of the rule group. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/wafv2_web_acl.html.markdown b/website/docs/cdktf/python/d/wafv2_web_acl.html.markdown index 7b3a17b56639..fc054c899e3c 100644 --- a/website/docs/cdktf/python/d/wafv2_web_acl.html.markdown +++ b/website/docs/cdktf/python/d/wafv2_web_acl.html.markdown @@ -14,6 +14,8 @@ Retrieves the summary of a WAFv2 Web ACL. ## Example Usage +### Lookup by name + ```python # DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug from constructs import Construct @@ -32,11 +34,37 @@ class MyConvertedCode(TerraformStack): ) ``` +### Lookup by associated resource + +```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_wafv2_web_acl import DataAwsWafv2WebAcl +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + DataAwsWafv2WebAcl(self, "alb_example", + resource_arn="arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/app/my-alb/xxxxx", + scope="REGIONAL" + ) + DataAwsWafv2WebAcl(self, "cloudfront_example", + resource_arn="arn:aws:cloudfront::123456789012:distribution/XXX", + scope="CLOUDFRONT" + ) +``` + ## Argument Reference This data source supports the following arguments: -* `name` - (Required) Name of the WAFv2 Web ACL. +* `name` - (Optional) Name of the WAFv2 Web ACL. Exactly one of `name` or `resource_arn` must be specified. +* `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). +* `resource_arn` - (Optional) ARN of the AWS resource associated with the Web ACL. This can be an ARN of an Application Load Balancer, Amazon API Gateway REST API, AWS AppSync GraphQL API, Amazon Cognito user pool, AWS App Runner service, AWS Verified Access instance, or AWS Amplify application. Exactly one of `name` or `resource_arn` must be specified. * `scope` - (Required) Specifies whether this is for an AWS CloudFront distribution or for a regional application. Valid values are `CLOUDFRONT` or `REGIONAL`. To work with CloudFront, you must also specify the region `us-east-1` (N. Virginia) on the AWS provider. ## Attribute Reference @@ -47,4 +75,4 @@ This data source exports the following attributes in addition to the arguments a * `description` - Description of the WebACL that helps with identification. * `id` - Unique identifier of the WebACL. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/workspaces_bundle.html.markdown b/website/docs/cdktf/python/d/workspaces_bundle.html.markdown index cb7ff5eea7b7..e3f5b4635c21 100644 --- a/website/docs/cdktf/python/d/workspaces_bundle.html.markdown +++ b/website/docs/cdktf/python/d/workspaces_bundle.html.markdown @@ -57,21 +57,22 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: -* `bundle_id` – (Optional) ID of the bundle. -* `owner` – (Optional) Owner of the bundles. You have to leave it blank for own bundles. You cannot combine this parameter with `bundle_id`. -* `name` – (Optional) Name of the bundle. You cannot combine this parameter with `bundle_id`. +* `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). +* `bundle_id` - (Optional) ID of the bundle. +* `owner` - (Optional) Owner of the bundles. You have to leave it blank for own bundles. You cannot combine this parameter with `bundle_id`. +* `name` - (Optional) Name of the bundle. You cannot combine this parameter with `bundle_id`. ## Attribute Reference This data source exports the following attributes in addition to the arguments above: -* `description` – The description of the bundle. -* `bundle_id` – The ID of the bundle. -* `name` – The name of the bundle. -* `owner` – The owner of the bundle. -* `compute_type` – The compute type. See supported fields below. -* `root_storage` – The root volume. See supported fields below. -* `user_storage` – The user storage. See supported fields below. +* `description` - The description of the bundle. +* `bundle_id` - The ID of the bundle. +* `name` - The name of the bundle. +* `owner` - The owner of the bundle. +* `compute_type` - The compute type. See supported fields below. +* `root_storage` - The root volume. See supported fields below. +* `user_storage` - The user storage. See supported fields below. ### `compute_type` @@ -85,4 +86,4 @@ This data source exports the following attributes in addition to the arguments a * `capacity` - Size of the user storage. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/workspaces_directory.html.markdown b/website/docs/cdktf/python/d/workspaces_directory.html.markdown index 5448d2575dc1..e180979469f6 100644 --- a/website/docs/cdktf/python/d/workspaces_directory.html.markdown +++ b/website/docs/cdktf/python/d/workspaces_directory.html.markdown @@ -35,6 +35,7 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `directory_id` - (Required) Directory identifier for registration in WorkSpaces service. ## Attribute Reference @@ -43,8 +44,8 @@ This data source exports the following attributes in addition to the arguments a * `id` - WorkSpaces directory identifier. * `active_directory_config` - Configuration for Active Directory integration when `workspace_type` is set to `POOLS`. - * `domain_name` – Fully qualified domain name of the AWS Directory Service directory. - * `service_account_secret_arn` – ARN of the Secrets Manager secret that contains the credentials for the service account. + * `domain_name` - Fully qualified domain name of the AWS Directory Service directory. + * `service_account_secret_arn` - ARN of the Secrets Manager secret that contains the credentials for the service account. * `alias` - Directory alias. * `customer_user_name` - User name for the service account. * `directory_name` - Name of the directory. @@ -53,33 +54,33 @@ This data source exports the following attributes in addition to the arguments a * `iam_role_id` - Identifier of the IAM role. This is the role that allows Amazon WorkSpaces to make calls to other services, such as Amazon EC2, on your behalf. * `ip_group_ids` - Identifiers of the IP access control groups associated with the directory. * `registration_code` - Registration code for the directory. This is the code that users enter in their Amazon WorkSpaces client application to connect to the directory. -* `self_service_permissions` – The permissions to enable or disable self-service capabilities. - * `change_compute_type` – Whether WorkSpaces directory users can change the compute type (bundle) for their workspace. - * `increase_volume_size` – Whether WorkSpaces directory users can increase the volume size of the drives on their workspace. - * `rebuild_workspace` – Whether WorkSpaces directory users can rebuild the operating system of a workspace to its original state. - * `restart_workspace` – Whether WorkSpaces directory users can restart their workspace. - * `switch_running_mode` – Whether WorkSpaces directory users can switch the running mode of their workspace. +* `self_service_permissions` - The permissions to enable or disable self-service capabilities. + * `change_compute_type` - Whether WorkSpaces directory users can change the compute type (bundle) for their workspace. + * `increase_volume_size` - Whether WorkSpaces directory users can increase the volume size of the drives on their workspace. + * `rebuild_workspace` - Whether WorkSpaces directory users can rebuild the operating system of a workspace to its original state. + * `restart_workspace` - Whether WorkSpaces directory users can restart their workspace. + * `switch_running_mode` - Whether WorkSpaces directory users can switch the running mode of their workspace. * `subnet_ids` - Identifiers of the subnets where the directory resides. -* `tags` – A map of tags assigned to the WorkSpaces directory. +* `tags` - A map of tags assigned to the WorkSpaces directory. * `user_identity_type` - The user identity type for the WorkSpaces directory. -* `workspace_access_properties` – Specifies which devices and operating systems users can use to access their WorkSpaces. - * `device_type_android` – (Optional) Indicates whether users can use Android devices to access their WorkSpaces. - * `device_type_chromeos` – (Optional) Indicates whether users can use Chromebooks to access their WorkSpaces. - * `device_type_ios` – (Optional) Indicates whether users can use iOS devices to access their WorkSpaces. - * `device_type_linux` – (Optional) Indicates whether users can use Linux clients to access their WorkSpaces. - * `device_type_osx` – (Optional) Indicates whether users can use macOS clients to access their WorkSpaces. - * `device_type_web` – (Optional) Indicates whether users can access their WorkSpaces through a web browser. - * `device_type_windows` – (Optional) Indicates whether users can use Windows clients to access their WorkSpaces. - * `device_type_zeroclient` – (Optional) Indicates whether users can use zero client devices to access their WorkSpaces. -* `workspace_creation_properties` – The default properties that are used for creating WorkSpaces. - * `custom_security_group_id` – The identifier of your custom security group. Should relate to the same VPC, where workspaces reside in. - * `default_ou` – The default organizational unit (OU) for your WorkSpace directories. - * `enable_internet_access` – Indicates whether internet access is enabled for your WorkSpaces. - * `enable_maintenance_mode` – Indicates whether maintenance mode is enabled for your WorkSpaces. For more information, see [WorkSpace Maintenance](https://docs.aws.amazon.com/workspaces/latest/adminguide/workspace-maintenance.html). - * `user_enabled_as_local_administrator` – Indicates whether users are local administrators of their WorkSpaces. +* `workspace_access_properties` - Specifies which devices and operating systems users can use to access their WorkSpaces. + * `device_type_android` - (Optional) Indicates whether users can use Android devices to access their WorkSpaces. + * `device_type_chromeos` - (Optional) Indicates whether users can use Chromebooks to access their WorkSpaces. + * `device_type_ios` - (Optional) Indicates whether users can use iOS devices to access their WorkSpaces. + * `device_type_linux` - (Optional) Indicates whether users can use Linux clients to access their WorkSpaces. + * `device_type_osx` - (Optional) Indicates whether users can use macOS clients to access their WorkSpaces. + * `device_type_web` - (Optional) Indicates whether users can access their WorkSpaces through a web browser. + * `device_type_windows` - (Optional) Indicates whether users can use Windows clients to access their WorkSpaces. + * `device_type_zeroclient` - (Optional) Indicates whether users can use zero client devices to access their WorkSpaces. +* `workspace_creation_properties` - The default properties that are used for creating WorkSpaces. + * `custom_security_group_id` - The identifier of your custom security group. Should relate to the same VPC, where workspaces reside in. + * `default_ou` - The default organizational unit (OU) for your WorkSpace directories. + * `enable_internet_access` - Indicates whether internet access is enabled for your WorkSpaces. + * `enable_maintenance_mode` - Indicates whether maintenance mode is enabled for your WorkSpaces. For more information, see [WorkSpace Maintenance](https://docs.aws.amazon.com/workspaces/latest/adminguide/workspace-maintenance.html). + * `user_enabled_as_local_administrator` - Indicates whether users are local administrators of their WorkSpaces. * `workspace_directory_description` - The description of the WorkSpaces directory when `workspace_type` is set to `POOLS`. * `workspace_directory_name` - The name of the WorkSpaces directory when `workspace_type` is set to `POOLS`. * `workspace_security_group_id` - The identifier of the security group that is assigned to new WorkSpaces. * `workspace_type` - The type of WorkSpaces directory. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/workspaces_image.html.markdown b/website/docs/cdktf/python/d/workspaces_image.html.markdown index 1dd64d61c8aa..7eddb5f3e5c9 100644 --- a/website/docs/cdktf/python/d/workspaces_image.html.markdown +++ b/website/docs/cdktf/python/d/workspaces_image.html.markdown @@ -35,16 +35,17 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: -* `image_id` – (Required) ID of the image. +* `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). +* `image_id` - (Required) ID of the image. ## Attribute Reference This data source exports the following attributes in addition to the arguments above: -* `name` – The name of the image. -* `description` – The description of the image. -* `os` – The operating system that the image is running. -* `required_tenancy` – Specifies whether the image is running on dedicated hardware. When Bring Your Own License (BYOL) is enabled, this value is set to DEDICATED. For more information, see [Bring Your Own Windows Desktop Images](https://docs.aws.amazon.com/workspaces/latest/adminguide/byol-windows-images.html). -* `state` – The status of the image. +* `name` - The name of the image. +* `description` - The description of the image. +* `os` - The operating system that the image is running. +* `required_tenancy` - Specifies whether the image is running on dedicated hardware. When Bring Your Own License (BYOL) is enabled, this value is set to DEDICATED. For more information, see [Bring Your Own Windows Desktop Images](https://docs.aws.amazon.com/workspaces/latest/adminguide/byol-windows-images.html). +* `state` - The status of the image. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/d/workspaces_workspace.html.markdown b/website/docs/cdktf/python/d/workspaces_workspace.html.markdown index b024c6212a1a..bc911959d3a4 100644 --- a/website/docs/cdktf/python/d/workspaces_workspace.html.markdown +++ b/website/docs/cdktf/python/d/workspaces_workspace.html.markdown @@ -57,23 +57,24 @@ class MyConvertedCode(TerraformStack): This data source supports the following arguments: +* `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). * `bundle_id` - (Optional) ID of the bundle for the WorkSpace. * `directory_id` - (Optional) ID of the directory for the WorkSpace. You have to specify `user_name` along with `directory_id`. You cannot combine this parameter with `workspace_id`. * `root_volume_encryption_enabled` - (Optional) Indicates whether the data stored on the root volume is encrypted. * `tags` - (Optional) Tags for the WorkSpace. -* `user_name` – (Optional) User name of the user for the WorkSpace. This user name must exist in the directory for the WorkSpace. You cannot combine this parameter with `workspace_id`. -* `user_volume_encryption_enabled` – (Optional) Indicates whether the data stored on the user volume is encrypted. -* `volume_encryption_key` – (Optional) Symmetric AWS KMS customer master key (CMK) used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric CMKs. +* `user_name` - (Optional) User name of the user for the WorkSpace. This user name must exist in the directory for the WorkSpace. You cannot combine this parameter with `workspace_id`. +* `user_volume_encryption_enabled` - (Optional) Indicates whether the data stored on the user volume is encrypted. +* `volume_encryption_key` - (Optional) Symmetric AWS KMS customer master key (CMK) used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric CMKs. * `workspace_id` - (Optional) ID of the WorkSpace. You cannot combine this parameter with `directory_id`. -* `workspace_properties` – (Optional) WorkSpace properties. +* `workspace_properties` - (Optional) WorkSpace properties. `workspace_properties` supports the following: -* `compute_type_name` – (Optional) Compute type. For more information, see [Amazon WorkSpaces Bundles](http://aws.amazon.com/workspaces/details/#Amazon_WorkSpaces_Bundles). Valid values are `VALUE`, `STANDARD`, `PERFORMANCE`, `POWER`, `GRAPHICS`, `POWERPRO` and `GRAPHICSPRO`. -* `root_volume_size_gib` – (Optional) Size of the root volume. -* `running_mode` – (Optional) Running mode. For more information, see [Manage the WorkSpace Running Mode](https://docs.aws.amazon.com/workspaces/latest/adminguide/running-mode.html). Valid values are `AUTO_STOP` and `ALWAYS_ON`. -* `running_mode_auto_stop_timeout_in_minutes` – (Optional) Time after a user logs off when WorkSpaces are automatically stopped. Configured in 60-minute intervals. -* `user_volume_size_gib` – (Optional) Size of the user storage. +* `compute_type_name` - (Optional) Compute type. For more information, see [Amazon WorkSpaces Bundles](http://aws.amazon.com/workspaces/details/#Amazon_WorkSpaces_Bundles). Valid values are `VALUE`, `STANDARD`, `PERFORMANCE`, `POWER`, `GRAPHICS`, `POWERPRO` and `GRAPHICSPRO`. +* `root_volume_size_gib` - (Optional) Size of the root volume. +* `running_mode` - (Optional) Running mode. For more information, see [Manage the WorkSpace Running Mode](https://docs.aws.amazon.com/workspaces/latest/adminguide/running-mode.html). Valid values are `AUTO_STOP` and `ALWAYS_ON`. +* `running_mode_auto_stop_timeout_in_minutes` - (Optional) Time after a user logs off when WorkSpaces are automatically stopped. Configured in 60-minute intervals. +* `user_volume_size_gib` - (Optional) Size of the user storage. ## Attribute Reference @@ -84,4 +85,4 @@ This data source exports the following attributes in addition to the arguments a * `computer_name` - Name of the WorkSpace, as seen by the operating system. * `state` - Operational state of the WorkSpace. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/ephemeral-resources/cognito_identity_openid_token_for_developer_identity.markdown b/website/docs/cdktf/python/ephemeral-resources/cognito_identity_openid_token_for_developer_identity.markdown index aa72df322c11..e0599cea54d0 100644 --- a/website/docs/cdktf/python/ephemeral-resources/cognito_identity_openid_token_for_developer_identity.markdown +++ b/website/docs/cdktf/python/ephemeral-resources/cognito_identity_openid_token_for_developer_identity.markdown @@ -13,7 +13,7 @@ description: |- Terraform ephemeral resource for managing an AWS Cognito Identity Open ID Token for Developer Identity. -~> Ephemeral resources are a new feature and may evolve as we continue to explore their most effective uses. [Learn more](https://developer.hashicorp.com/terraform/language/v1.10.x/resources/ephemeral). +~> Ephemeral resources are a new feature and may evolve as we continue to explore their most effective uses. [Learn more](https://developer.hashicorp.com/terraform/language/resources/ephemeral). ## Example Usage @@ -38,12 +38,14 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `identity_pool_id` - (Required) An identity pool ID in the format REGION:GUID. The following arguments are optional: +* `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). * `identity_id` - (Optional) A unique identifier in the format REGION:GUID. * `logins` - (Optional) A set of optional name-value pairs that map provider names to provider tokens. Each name-value pair represents a user from a public provider or developer provider. If the user is from a developer provider, the name-value pair will follow the syntax `"developer_provider_name": "developer_user_identifier"`. The developer provider is the "domain" by which Cognito will refer to your users; you provided this domain while creating/updating the identity pool. The developer user identifier is an identifier from your backend that uniquely identifies a user. When you create an identity pool, you can specify the supported logins. @@ -58,4 +60,4 @@ This resource exports the following attributes in addition to the arguments abov * `token` - An OpenID token. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/ephemeral-resources/eks_cluster_auth.html.markdown b/website/docs/cdktf/python/ephemeral-resources/eks_cluster_auth.html.markdown index 6fcab61ba842..9fc5c7745563 100644 --- a/website/docs/cdktf/python/ephemeral-resources/eks_cluster_auth.html.markdown +++ b/website/docs/cdktf/python/ephemeral-resources/eks_cluster_auth.html.markdown @@ -12,7 +12,7 @@ description: |- Retrieve an authentication token to communicate with an EKS cluster. -~> **NOTE:** Ephemeral resources are a new feature and may evolve as we continue to explore their most effective uses. [Learn more](https://developer.hashicorp.com/terraform/language/v1.10.x/resources/ephemeral). +~> **NOTE:** Ephemeral resources are a new feature and may evolve as we continue to explore their most effective uses. [Learn more](https://developer.hashicorp.com/terraform/language/resources/ephemeral). ## Example Usage @@ -54,6 +54,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) Name of the EKS cluster. ## Attribute Reference @@ -62,4 +63,4 @@ This resource exports the following attributes in addition to the arguments abov * `token` - Token to use to authenticate with the cluster. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/ephemeral-resources/kms_secrets.html.markdown b/website/docs/cdktf/python/ephemeral-resources/kms_secrets.html.markdown index 10762623698c..9a0d63e1cc8d 100644 --- a/website/docs/cdktf/python/ephemeral-resources/kms_secrets.html.markdown +++ b/website/docs/cdktf/python/ephemeral-resources/kms_secrets.html.markdown @@ -12,7 +12,7 @@ description: |- Decrypt multiple secrets from data encrypted with the AWS KMS service. -~> **NOTE:** Ephemeral resources are a new feature and may evolve as we continue to explore their most effective uses. [Learn more](https://developer.hashicorp.com/terraform/language/v1.10.x/resources/ephemeral). +~> **NOTE:** Ephemeral resources are a new feature and may evolve as we continue to explore their most effective uses. [Learn more](https://developer.hashicorp.com/terraform/language/resources/ephemeral). ## Example Usage @@ -50,6 +50,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `secret` - (Required) One or more encrypted payload definitions from the KMS service. See the Secret Definitions below. ### Secret Definitions @@ -72,4 +73,4 @@ This resource exports the following attributes in addition to the arguments abov * `plaintext` - Map containing each `secret` `name` as the key with its decrypted plaintext value - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/ephemeral-resources/lambda_invocation.html.markdown b/website/docs/cdktf/python/ephemeral-resources/lambda_invocation.html.markdown index 85ea3d8b3ba6..24629fcff433 100644 --- a/website/docs/cdktf/python/ephemeral-resources/lambda_invocation.html.markdown +++ b/website/docs/cdktf/python/ephemeral-resources/lambda_invocation.html.markdown @@ -3,34 +3,187 @@ subcategory: "Lambda" layout: "aws" page_title: "AWS: aws_lambda_invocation" description: |- - Invoke AWS Lambda Function + Invokes an AWS Lambda Function as an ephemeral resource. --- # Ephemeral: aws_lambda_invocation -Use this ephemeral resource to invoke a Lambda function. The lambda function is invoked with the [RequestResponse](https://docs.aws.amazon.com/lambda/latest/dg/API_Invoke.html#API_Invoke_RequestSyntax) invocation type. +Invokes an AWS Lambda Function as an ephemeral resource. Use this ephemeral resource to execute Lambda functions during Terraform operations without persisting results in state, ideal for generating sensitive data or performing lightweight operations. -~> **NOTE:** Ephemeral resources are a new feature and may evolve as we continue to explore their most effective uses. [Learn more](https://developer.hashicorp.com/terraform/language/v1.10.x/resources/ephemeral). +The Lambda function is invoked with [RequestResponse](https://docs.aws.amazon.com/lambda/latest/dg/API_Invoke.html#API_Invoke_RequestSyntax) invocation type. -~> **NOTE:** The `aws_lambda_invocation` ephemeral resource invokes the function during every `plan` and `apply` when the function is known. A common use case for this functionality is when invoking a lightweight function—where repeated invocations are acceptable—that produces sensitive information you do not want to store in the state. +~> **Note:** Ephemeral resources are a new feature and may evolve as we continue to explore their most effective uses. [Learn more](https://developer.hashicorp.com/terraform/language/resources/ephemeral). -~> **NOTE:** If you get a `KMSAccessDeniedException: Lambda was unable to decrypt the environment variables because KMS access was denied` error when invoking an [`aws_lambda_function`](/docs/providers/aws/r/lambda_function.html) with environment variables, the IAM role associated with the function may have been deleted and recreated _after_ the function was created. You can fix the problem two ways: 1) updating the function's role to another role and then updating it back again to the recreated role, or 2) by using Terraform to `taint` the function and `apply` your configuration again to recreate the function. (When you create a function, Lambda grants permissions on the KMS key to the function's IAM role. If the IAM role is recreated, the grant is no longer valid. Changing the function's role or recreating the function causes Lambda to update the grant.) +~> **Note:** The `aws_lambda_invocation` ephemeral resource invokes the function during every `plan` and `apply` when the function is known. A common use case for this functionality is when invoking a lightweight function—where repeated invocations are acceptable—that produces sensitive information you do not want to store in the state. + +~> **Note:** If you get a `KMSAccessDeniedException: Lambda was unable to decrypt the environment variables because KMS access was denied` error when invoking a Lambda function with environment variables, the IAM role associated with the function may have been deleted and recreated after the function was created. You can fix the problem two ways: 1) updating the function's role to another role and then updating it back again to the recreated role, or 2) by using Terraform to `taint` the function and `apply` your configuration again to recreate the function. (When you create a function, Lambda grants permissions on the KMS key to the function's IAM role. If the IAM role is recreated, the grant is no longer valid. Changing the function's role or recreating the function causes Lambda to update the grant.) ## Example Usage -### Basic Example +### Generate Sensitive Configuration ```python # DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug from constructs import Construct -from cdktf import TerraformOutput, Fn, TerraformStack +from cdktf import VariableType, TerraformVariable, TerraformOutput, Fn, Token, TerraformStack +# +# Provider bindings are generated by running `cdktf get`. +# See https://cdk.tf/provider-generation for more details. +# +from imports.aws.ssm_parameter import SsmParameter +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + # Terraform Variables are not always the best fit for getting inputs in the context of Terraform CDK. + # You can read more about this at https://cdk.tf/variables + environment = TerraformVariable(self, "environment", + description="The environment name (e.g., dev, prod)", + type=VariableType.STRING + ) + TerraformOutput(self, "key_generated", + value="API key generated and stored in Parameter Store" + ) + SsmParameter(self, "api_key", + name="/app/${" + environment.value + "}/api-key", + tags={ + "Environment": environment.string_value, + "Generated": "ephemeral-lambda" + }, + type="SecureString", + value=Token.as_string( + Fn.lookup_nested( + Fn.jsondecode(aws_lambda_invocation.secret_generator.result), ["api_key"])) + ) +``` + +### Dynamic Resource Configuration + +```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.autoscaling_group import AutoscalingGroup +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + sizing = Fn.jsondecode(aws_lambda_invocation.resource_calculator.result) + AutoscalingGroup(self, "example", + desired_capacity=Token.as_number( + Fn.lookup_nested(sizing, ["desired_instances"])), + health_check_type="ELB", + launch_template=AutoscalingGroupLaunchTemplate( + id=Token.as_string(aws_launch_template_example.id), + version="$Latest" + ), + max_size=Token.as_number(Fn.lookup_nested(sizing, ["max_instances"])), + min_size=Token.as_number(Fn.lookup_nested(sizing, ["min_instances"])), + name="optimized-asg", + tag=[AutoscalingGroupTag( + key="OptimizedBy", + propagate_at_launch=True, + value="ephemeral-lambda" + ) + ], + target_group_arns=[Token.as_string(aws_lb_target_group_example.arn)], + vpc_zone_identifier=subnet_ids.list_value + ) +``` + +### Validation and Compliance Checks + +```python +# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +from cdktf import FileProvisioner +from constructs import Construct +from cdktf import VariableType, TerraformVariable, conditional, Token, TerraformCount, Fn, TerraformStack +# +# Provider bindings are generated by running `cdktf get`. +# See https://cdk.tf/provider-generation for more details. +# +from imports.null.resource import Resource +from imports.aws.instance import Instance +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + # Terraform Variables are not always the best fit for getting inputs in the context of Terraform CDK. + # You can read more about this at https://cdk.tf/variables + instance_type = TerraformVariable(self, "instance_type", + description="The EC2 instance type to use", + type=VariableType.STRING + ) + is_compliant = compliant + violations = validation_result_violations + # In most cases loops should be handled in the programming language context and + # not inside of the Terraform context. If you are looping over something external, e.g. a variable or a file input + # you should consider using a for loop. If you are looping over something only known to Terraform, e.g. a result of a data source + # you need to keep this like it is. + example_count = TerraformCount.of( + Token.as_number(conditional(is_compliant, 1, 0))) + Instance(self, "example", + ami=Token.as_string(data_aws_ami_example.id), + instance_type=instance_type.string_value, + root_block_device=InstanceRootBlockDevice( + encrypted=encrypt_storage.boolean_value + ), + tags={ + "ComplianceCheck": "passed", + "Environment": environment.string_value + }, + count=example_count + ) + # In most cases loops should be handled in the programming language context and + # not inside of the Terraform context. If you are looping over something external, e.g. a variable or a file input + # you should consider using a for loop. If you are looping over something only known to Terraform, e.g. a result of a data source + # you need to keep this like it is. + compliance_gate_count = TerraformCount.of( + Token.as_number(conditional(is_compliant, 0, 1))) + Resource(self, "compliance_gate", + count=compliance_gate_count, + provisioners=[FileProvisioner( + type="local-exec", + command="echo 'Compliance violations: " + + Token.as_string(Fn.join(", ", Token.as_list(violations))) + "' && exit 1" + ) + ] + ) +``` + +### External API Integration + +```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.ecs_service import EcsService class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) - TerraformOutput(self, "result_entry", - value=Fn.lookup_nested(Fn.jsondecode(example.result), ["\"key1\""]) + external_config = Fn.jsondecode(aws_lambda_invocation.external_config.result) + EcsService(self, "example", + cluster=Token.as_string(aws_ecs_cluster_example.id), + deployment_configuration=EcsServiceDeploymentConfiguration( + maximum_percent=Fn.lookup_nested(external_config, ["max_percent"]), + minimum_healthy_percent=Fn.lookup_nested(external_config, ["min_healthy_percent" + ]) + ), + desired_count=Token.as_number( + Fn.lookup_nested(external_config, ["replica_count"])), + name="web-app", + tags={ + "ConfigSource": "external-api", + "Environment": environment.string_value + }, + task_definition=Token.as_string(aws_ecs_task_definition_example.arn) ) ``` @@ -44,17 +197,91 @@ The following arguments are required: The following arguments are optional: * `client_context` - (Optional) Up to 3583 bytes of base64-encoded data about the invoking client to pass to the function in the context object. -* `log_type` - (Optional) Set to `Tail` to include the execution log in the response. Valid values are `None` and `Tail`. +* `log_type` - (Optional) Set to `Tail` to include the execution log in the response. Valid values: `None` and `Tail`. * `qualifier` - (Optional) Version or alias to invoke a published version of the function. Defaults to `$LATEST`. +* `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). ## Attribute Reference -This resource exports the following attributes in addition to the arguments above: +This ephemeral resource exports the following attributes in addition to the arguments above: -* `executed_version` - Version of the function that executed. When you invoke a function with an alias, the version the alias resolved to. +* `executed_version` - Version of the function that executed. When you invoke a function with an alias, this shows the version the alias resolved to. * `function_error` - If present, indicates that an error occurred during function execution. Details about the error are included in `result`. * `log_result` - Last 4 KB of the execution log, which is base64-encoded. -* `result` - String result of the lambda function invocation. +* `result` - String result of the Lambda function invocation. * `status_code` - HTTP status code is in the 200 range for a successful request. - \ No newline at end of file +## Usage Notes + +### Handling Sensitive Data + +Since ephemeral resources are designed to not persist data in state, they are ideal for handling sensitive information: + +```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.secretsmanager_secret_version import SecretsmanagerSecretVersion +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + SecretsmanagerSecretVersion(self, "example", + secret_id=Token.as_string(aws_secretsmanager_secret_example.id), + secret_string=aws_lambda_invocation.credentials.result + ) +``` + +### Error Handling + +Always check for function errors in your configuration: + +```python +# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +from constructs import Construct +from cdktf import Op, Fn, Token, conditional, TerraformCount, TerraformStack +# +# Provider bindings are generated by running `cdktf get`. +# See https://cdk.tf/provider-generation for more details. +# +from imports.null.resource import Resource +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + has_error = Op.neq(aws_lambda_invocation.example.function_error, "null") + invocation_result = Fn.jsondecode(aws_lambda_invocation.example.result) + # In most cases loops should be handled in the programming language context and + # not inside of the Terraform context. If you are looping over something external, e.g. a variable or a file input + # you should consider using a for loop. If you are looping over something only known to Terraform, e.g. a result of a data source + # you need to keep this like it is. + validation_count = TerraformCount.of( + Token.as_number( + conditional(has_error, + fail("Lambda function error: " + + Token.as_string( + Fn.lookup_nested(invocation_result, ["errorMessage"]))), 0))) + Resource(self, "validation", + count=validation_count + ) +``` + +### Logging + +Enable detailed logging for debugging: + +```python +# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +from constructs import Construct +from cdktf import TerraformOutput, Fn, TerraformStack +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + TerraformOutput(self, "execution_logs", + value=Fn.base64decode(aws_lambda_invocation.example.log_result) + ) +``` + + \ No newline at end of file diff --git a/website/docs/cdktf/python/ephemeral-resources/secretsmanager_random_password.html.markdown b/website/docs/cdktf/python/ephemeral-resources/secretsmanager_random_password.html.markdown index 18d394bacbc1..83fc2af4a6a3 100644 --- a/website/docs/cdktf/python/ephemeral-resources/secretsmanager_random_password.html.markdown +++ b/website/docs/cdktf/python/ephemeral-resources/secretsmanager_random_password.html.markdown @@ -29,6 +29,7 @@ class MyConvertedCode(TerraformStack): The following arguments are optional: +* `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). * `exclude_characters` - (Optional) String of the characters that you don't want in the password. * `exclude_lowercase` - (Optional) Specifies whether to exclude lowercase letters from the password. * `exclude_numbers` - (Optional) Specifies whether to exclude numbers from the password. @@ -44,4 +45,4 @@ This resource exports the following attributes in addition to the arguments abov * `random_password` - Random password. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/ephemeral-resources/secretsmanager_secret_version.html.markdown b/website/docs/cdktf/python/ephemeral-resources/secretsmanager_secret_version.html.markdown index c86604ad451a..3f9a09a1eb65 100644 --- a/website/docs/cdktf/python/ephemeral-resources/secretsmanager_secret_version.html.markdown +++ b/website/docs/cdktf/python/ephemeral-resources/secretsmanager_secret_version.html.markdown @@ -12,7 +12,7 @@ description: |- Retrieve information about a Secrets Manager secret version, including its secret value. To retrieve secret metadata, see the [`aws_secretsmanager_secret` data source](/docs/providers/aws/d/secretsmanager_secret.html). -~> **NOTE:** Ephemeral resources are a new feature and may evolve as we continue to explore their most effective uses. [Learn more](https://developer.hashicorp.com/terraform/language/v1.10.x/resources/ephemeral). +~> **NOTE:** Ephemeral resources are a new feature and may evolve as we continue to explore their most effective uses. [Learn more](https://developer.hashicorp.com/terraform/language/resources/ephemeral). ## Example Usage @@ -60,6 +60,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `secret_id` - (Required) Specifies the secret containing the version that you want to retrieve. You can specify either the ARN or the friendly name of the secret. * `version_id` - (Optional) Specifies the unique identifier of the version of the secret that you want to retrieve. Overrides `version_stage`. * `version_stage` - (Optional) Specifies the secret version that you want to retrieve by the staging label attached to the version. Defaults to `AWSCURRENT`. @@ -75,4 +76,4 @@ This resource exports the following attributes in addition to the arguments abov * `secret_binary` - Decrypted part of the protected secret information that was originally provided as a binary. * `version_id` - Unique identifier of this version of the secret. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/ephemeral-resources/ssm_parameter.html.markdown b/website/docs/cdktf/python/ephemeral-resources/ssm_parameter.html.markdown index ddd72a2b032b..3985bf51d981 100644 --- a/website/docs/cdktf/python/ephemeral-resources/ssm_parameter.html.markdown +++ b/website/docs/cdktf/python/ephemeral-resources/ssm_parameter.html.markdown @@ -12,7 +12,7 @@ description: |- Retrieve information about an SSM parameter, including its value. -~> **NOTE:** Ephemeral resources are a new feature and may evolve as we continue to explore their most effective uses. [Learn more](https://developer.hashicorp.com/terraform/language/v1.10.x/resources/ephemeral). +~> **NOTE:** Ephemeral resources are a new feature and may evolve as we continue to explore their most effective uses. [Learn more](https://developer.hashicorp.com/terraform/language/resources/ephemeral). ## Example Usage @@ -33,6 +33,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `arn` - (Required) The Amazon Resource Name (ARN) of the parameter that you want to query * `with_decryption` - (Optional) Return decrypted values for a secure string parameter (Defaults to `true`). @@ -46,4 +47,4 @@ This resource exports the following attributes in addition to the arguments abov * `version` - The parameter version. * `with_decryption` - Indicates whether the secure string parameters were decrypted. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/guides/custom-service-endpoints.html.markdown b/website/docs/cdktf/python/guides/custom-service-endpoints.html.markdown index 305bfbc9f633..e9cd17638338 100644 --- a/website/docs/cdktf/python/guides/custom-service-endpoints.html.markdown +++ b/website/docs/cdktf/python/guides/custom-service-endpoints.html.markdown @@ -126,6 +126,7 @@ class MyConvertedCode(TerraformStack): |App Runner|`apprunner`|`AWS_ENDPOINT_URL_APPRUNNER`|`apprunner`| |AppStream 2.0|`appstream`|`AWS_ENDPOINT_URL_APPSTREAM`|`appstream`| |AppSync|`appsync`|`AWS_ENDPOINT_URL_APPSYNC`|`appsync`| +|Application Resilience Controller Region Switch|`arcregionswitch`|`AWS_ENDPOINT_URL_ARC_REGION_SWITCH`|`arc_region_switch`| |Athena|`athena`|`AWS_ENDPOINT_URL_ATHENA`|`athena`| |Audit Manager|`auditmanager`|`AWS_ENDPOINT_URL_AUDITMANAGER`|`auditmanager`| |Auto Scaling|`autoscaling`|`AWS_ENDPOINT_URL_AUTO_SCALING`|`auto_scaling`| @@ -135,6 +136,7 @@ class MyConvertedCode(TerraformStack): |BCM Data Exports|`bcmdataexports`|`AWS_ENDPOINT_URL_BCM_DATA_EXPORTS`|`bcm_data_exports`| |Bedrock|`bedrock`|`AWS_ENDPOINT_URL_BEDROCK`|`bedrock`| |Bedrock Agents|`bedrockagent`|`AWS_ENDPOINT_URL_BEDROCK_AGENT`|`bedrock_agent`| +|Bedrock AgentCore|`bedrockagentcore`|`AWS_ENDPOINT_URL_BEDROCK_AGENTCORE_CONTROL`|`bedrock_agentcore_control`| |Billing|`billing`|`AWS_ENDPOINT_URL_BILLING`|`billing`| |Web Services Budgets|`budgets`|`AWS_ENDPOINT_URL_BUDGETS`|`budgets`| |CE (Cost Explorer)|`ce`(or `costexplorer`)|`AWS_ENDPOINT_URL_COST_EXPLORER`|`cost_explorer`| @@ -232,8 +234,6 @@ class MyConvertedCode(TerraformStack): |CloudWatch Internet Monitor|`internetmonitor`|`AWS_ENDPOINT_URL_INTERNETMONITOR`|`internetmonitor`| |Invoicing|`invoicing`|`AWS_ENDPOINT_URL_INVOICING`|`invoicing`| |IoT Core|`iot`|`AWS_ENDPOINT_URL_IOT`|`iot`| -|IoT Analytics|`iotanalytics`|`AWS_ENDPOINT_URL_IOTANALYTICS`|`iotanalytics`| -|IoT Events|`iotevents`|`AWS_ENDPOINT_URL_IOT_EVENTS`|`iot_events`| |IVS (Interactive Video)|`ivs`|`AWS_ENDPOINT_URL_IVS`|`ivs`| |IVS (Interactive Video) Chat|`ivschat`|`AWS_ENDPOINT_URL_IVSCHAT`|`ivschat`| |Managed Streaming for Kafka|`kafka`(or `msk`)|`AWS_ENDPOINT_URL_KAFKA`|`kafka`| @@ -276,9 +276,9 @@ class MyConvertedCode(TerraformStack): |User Notifications|`notifications`|`AWS_ENDPOINT_URL_NOTIFICATIONS`|`notifications`| |User Notifications Contacts|`notificationscontacts`|`AWS_ENDPOINT_URL_NOTIFICATIONSCONTACTS`|`notificationscontacts`| |CloudWatch Observability Access Manager|`oam`(or `cloudwatchobservabilityaccessmanager`)|`AWS_ENDPOINT_URL_OAM`|`oam`| +|Oracle Database@AWS|`odb`|`AWS_ENDPOINT_URL_ODB`|`odb`| |OpenSearch|`opensearch`(or `opensearchservice`)|`AWS_ENDPOINT_URL_OPENSEARCH`|`opensearch`| |OpenSearch Serverless|`opensearchserverless`|`AWS_ENDPOINT_URL_OPENSEARCHSERVERLESS`|`opensearchserverless`| -|OpsWorks|`opsworks`|`AWS_ENDPOINT_URL_OPSWORKS`|`opsworks`| |Organizations|`organizations`|`AWS_ENDPOINT_URL_ORGANIZATIONS`|`organizations`| |OpenSearch Ingestion|`osis`(or `opensearchingestion`)|`AWS_ENDPOINT_URL_OSIS`|`osis`| |Outposts|`outposts`|`AWS_ENDPOINT_URL_OUTPOSTS`|`outposts`| @@ -316,6 +316,7 @@ class MyConvertedCode(TerraformStack): |S3 Control|`s3control`|`AWS_ENDPOINT_URL_S3_CONTROL`|`s3_control`| |S3 on Outposts|`s3outposts`|`AWS_ENDPOINT_URL_S3OUTPOSTS`|`s3outposts`| |S3 Tables|`s3tables`|`AWS_ENDPOINT_URL_S3TABLES`|`s3tables`| +|S3 Vectors|`s3vectors`|`AWS_ENDPOINT_URL_S3VECTORS`|`s3vectors`| |SageMaker AI|`sagemaker`|`AWS_ENDPOINT_URL_SAGEMAKER`|`sagemaker`| |EventBridge Scheduler|`scheduler`|`AWS_ENDPOINT_URL_SCHEDULER`|`scheduler`| |EventBridge Schemas|`schemas`|`AWS_ENDPOINT_URL_SCHEMAS`|`schemas`| @@ -332,7 +333,6 @@ class MyConvertedCode(TerraformStack): |SFN (Step Functions)|`sfn`(or `stepfunctions`)|`AWS_ENDPOINT_URL_SFN`|`sfn`| |Shield|`shield`|`AWS_ENDPOINT_URL_SHIELD`|`shield`| |Signer|`signer`|`AWS_ENDPOINT_URL_SIGNER`|`signer`| -|SDB (SimpleDB)|`simpledb`(or `sdb`)|`AWS_ENDPOINT_URL_SIMPLEDB`|`simpledb`| |SNS (Simple Notification)|`sns`|`AWS_ENDPOINT_URL_SNS`|`sns`| |SQS (Simple Queue)|`sqs`|`AWS_ENDPOINT_URL_SQS`|`sqs`| |SSM (Systems Manager)|`ssm`|`AWS_ENDPOINT_URL_SSM`|`ssm`| @@ -358,7 +358,6 @@ class MyConvertedCode(TerraformStack): |WAF Classic Regional|`wafregional`|`AWS_ENDPOINT_URL_WAF_REGIONAL`|`waf_regional`| |WAF|`wafv2`|`AWS_ENDPOINT_URL_WAFV2`|`wafv2`| |Well-Architected Tool|`wellarchitected`|`AWS_ENDPOINT_URL_WELLARCHITECTED`|`wellarchitected`| -|WorkLink|`worklink`|`AWS_ENDPOINT_URL_WORKLINK`|`worklink`| |WorkSpaces|`workspaces`|`AWS_ENDPOINT_URL_WORKSPACES`|`workspaces`| |WorkSpaces Web|`workspacesweb`|`AWS_ENDPOINT_URL_WORKSPACES_WEB`|`workspaces_web`| |X-Ray|`xray`|`AWS_ENDPOINT_URL_XRAY`|`xray`| @@ -461,4 +460,4 @@ class MyConvertedCode(TerraformStack): ) ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/guides/enhanced-region-support.html.markdown b/website/docs/cdktf/python/guides/enhanced-region-support.html.markdown new file mode 100644 index 000000000000..208c3b70e25a --- /dev/null +++ b/website/docs/cdktf/python/guides/enhanced-region-support.html.markdown @@ -0,0 +1,628 @@ +--- +subcategory: "" +layout: "aws" +page_title: "Terraform AWS Provider Enhanced Region Support" +description: |- + Enhanced Region support with the Terraform AWS Provider. +--- + + + +# Enhanced Region Support + +Version 6.0.0 of the Terraform AWS Provider adds `region` to most resources making it significantly easier to manage infrastructure across AWS Regions without requiring multiple provider configurations. + + + +- [What's new](#whats-new) +- [What's not changing](#whats-not-changing) +- [Can I use `region` in every resource?](#can-i-use-region-in-every-resource) +- [Why make this change](#why-make-this-change) +- [How `region` works](#how-region-works) +- [Migrating from multiple provider configurations](#migrating-from-multiple-provider-configurations) +- [Before and after examples using `region`](#before-and-after-examples-using-region) +- [Non–region-aware resources](#nonregion-aware-resources) + + + +## What's new + +As of v6.0.0, most existing resources, data sources, and ephemeral resources are now [Region-aware](#nonregion-aware-resources), meaning they support a new top-level `region`. This allows you to manage a resource in a Region different from the one specified in the provider configuration without requiring multiple provider blocks. See [How `region` works](#how-region-works) for details. + +For example, if your provider is configured for `us-east-1`, you can now manage a VPC in `us-west-2` without defining an additional provider block: + +```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.vpc import Vpc +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + Vpc(self, "peer", + cidr_block="10.1.0.0/16", + region="us-west-2" + ) +``` + +## What's _not_ changing + +_Pre-v6.0.0 configurations that use provider blocks per Region remain valid in v6.0.0 and are not deprecated._ + +You can still define the Region at the provider level using any of the existing methods—for example, through the AWS [config file](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html), [provider configuration](https://developer.hashicorp.com/terraform/language/providers/configuration), [environment variables](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#environment-variables), [shared configuration files](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#shared-configuration-and-credentials-files), or explicitly using the `provider`’s [`region`](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#region). + +## Can I use `region` in every resource? + +No. While most resources are now Region-aware, there are exceptions. These include a few resources that already had a `region` and resources that are inherently global. See [Non–region-aware resources](#nonregion-aware-resources). + +## Why make this change + +Before version 6.0.0, managing infrastructure across multiple Regions required a separate provider configuration for each Region. This approach led to complex and repetitive configurations, especially for large infrastructures—AWS currently operates in [36 Regions](https://aws.amazon.com/about-aws/global-infrastructure/), with more announced. Additionally, each provider configuration adds overhead in terms of memory and compute resources. + +See the [examples](#before-and-after-examples-using-region) below for a comparison of configurations before and after introducing `region`. + +## How `region` works + +The new top-level `region` is [_Optional_ and _Computed_](https://developer.hashicorp.com/terraform/plugin/framework/handling-data/attributes/string#configurability), and defaults to the Region specified in the provider configuration. Its value is validated to ensure it belongs to the configured [partition](https://docs.aws.amazon.com/whitepapers/latest/aws-fault-isolation-boundaries/partitions.html). **Changing the value of `region` will force resource replacement.** + +To [import](https://developer.hashicorp.com/terraform/cli/import) a resource in a specific Region, append `@` to the [import ID](https://developer.hashicorp.com/terraform/language/import#import-id)—for example: + +```sh +terraform import aws_vpc.test_vpc vpc-a01106c2@eu-west-1 +``` + +## Migrating from multiple provider configurations + +To migrate from a separate provider configuration for each Region to a single provider configuration block and per-resource `region` values you must ensure that Terraform state is refreshed before editing resource configuration: + +1. Upgrade to v6.0.0 +2. Run a Terraform apply in [refresh-only mode](https://developer.hashicorp.com/terraform/cli/commands/plan#planning-modes) -- `terraform apply -refresh-only` +3. Modify the affected resource configurations, replacing the [`provider` meta-argument](https://developer.hashicorp.com/terraform/language/meta-arguments/resource-provider) with a `region` argument + +## Before and after examples using `region` + +### Cross-region VPC peering + +
+Before, Pre-v6.0.0 +

+ +```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.data_aws_caller_identity import DataAwsCallerIdentity +from imports.aws.provider import AwsProvider +from imports.aws.vpc import Vpc +from imports.aws.vpc_peering_connection import VpcPeeringConnection +from imports.aws.vpc_peering_connection_accepter import VpcPeeringConnectionAccepterA +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + AwsProvider(self, "aws", + region="us-east-1" + ) + peer = AwsProvider(self, "aws_1", + alias="peer", + region="us-west-2" + ) + main = Vpc(self, "main", + cidr_block="10.0.0.0/16" + ) + aws_vpc_peer = Vpc(self, "peer", + cidr_block="10.1.0.0/16", + provider=peer + ) + data_aws_caller_identity_peer = DataAwsCallerIdentity(self, "peer_4", + provider=peer + ) + # 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_caller_identity_peer.override_logical_id("peer") + aws_vpc_peering_connection_peer = VpcPeeringConnection(self, "peer_5", + auto_accept=False, + peer_owner_id=Token.as_string(data_aws_caller_identity_peer.account_id), + peer_region="us-west-2", + peer_vpc_id=Token.as_string(aws_vpc_peer.id), + vpc_id=main.id + ) + # 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_vpc_peering_connection_peer.override_logical_id("peer") + aws_vpc_peering_connection_accepter_peer = + VpcPeeringConnectionAccepterA(self, "peer_6", + auto_accept=True, + provider=peer, + vpc_peering_connection_id=Token.as_string(aws_vpc_peering_connection_peer.id) + ) + # 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_vpc_peering_connection_accepter_peer.override_logical_id("peer") +``` + +

+
+ +
+After, v6.0.0+ +

+ +```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.provider import AwsProvider +from imports.aws.vpc import Vpc +from imports.aws.vpc_peering_connection import VpcPeeringConnection +from imports.aws.vpc_peering_connection_accepter import VpcPeeringConnectionAccepterA +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + AwsProvider(self, "aws", + region="us-east-1" + ) + main = Vpc(self, "main", + cidr_block="10.0.0.0/16" + ) + peer = Vpc(self, "peer", + cidr_block="10.1.0.0/16", + region="us-west-2" + ) + aws_vpc_peering_connection_peer = VpcPeeringConnection(self, "peer_3", + auto_accept=False, + peer_region="us-west-2", + peer_vpc_id=peer.id, + vpc_id=main.id + ) + # 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_vpc_peering_connection_peer.override_logical_id("peer") + aws_vpc_peering_connection_accepter_peer = + VpcPeeringConnectionAccepterA(self, "peer_4", + auto_accept=True, + region="us-west-2", + vpc_peering_connection_id=Token.as_string(aws_vpc_peering_connection_peer.id) + ) + # 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_vpc_peering_connection_accepter_peer.override_logical_id("peer") +``` + +

+
+ +### KMS replica key + +
+Before, Pre-v6.0.0 +

+ +```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.kms_key import KmsKey +from imports.aws.kms_replica_key import KmsReplicaKey +from imports.aws.provider import AwsProvider +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + primary = AwsProvider(self, "aws", + alias="primary", + region="us-east-1" + ) + AwsProvider(self, "aws_1", + region="us-west-2" + ) + aws_kms_key_primary = KmsKey(self, "primary", + deletion_window_in_days=30, + description="Multi-Region primary key", + multi_region=True, + provider=primary + ) + KmsReplicaKey(self, "replica", + deletion_window_in_days=7, + description="Multi-Region replica key", + primary_key_arn=Token.as_string(aws_kms_key_primary.arn) + ) +``` + +

+
+ +
+After, v6.0.0 +

+ +```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.kms_key import KmsKey +from imports.aws.kms_replica_key import KmsReplicaKey +from imports.aws.provider import AwsProvider +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + AwsProvider(self, "aws", + region="us-west-2" + ) + primary = KmsKey(self, "primary", + deletion_window_in_days=30, + description="Multi-Region primary key", + multi_region=True, + region="us-east-1" + ) + KmsReplicaKey(self, "replica", + deletion_window_in_days=7, + description="Multi-Region replica key", + primary_key_arn=primary.arn + ) +``` + +

+
+ +### S3 bucket replication configuration + +
+Before, Pre-v6.0.0 +

+ +```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.data_aws_iam_policy_document import DataAwsIamPolicyDocument +from imports.aws.iam_policy import IamPolicy +from imports.aws.iam_role import IamRole +from imports.aws.iam_role_policy_attachment import IamRolePolicyAttachment +from imports.aws.provider import AwsProvider +from imports.aws.s3_bucket import S3Bucket +from imports.aws.s3_bucket_acl import S3BucketAcl +from imports.aws.s3_bucket_replication_configuration import S3BucketReplicationConfigurationA +from imports.aws.s3_bucket_versioning import S3BucketVersioningA +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + AwsProvider(self, "aws", + region="eu-west-1" + ) + central = AwsProvider(self, "aws_1", + alias="central", + region="eu-central-1" + ) + destination = S3Bucket(self, "destination", + bucket="tf-test-bucket-destination-12345" + ) + source = S3Bucket(self, "source", + bucket="tf-test-bucket-source-12345", + provider=central + ) + S3BucketAcl(self, "source_bucket_acl", + acl="private", + bucket=source.id, + provider=central + ) + aws_s3_bucket_versioning_destination = S3BucketVersioningA(self, "destination_5", + bucket=destination.id, + versioning_configuration=S3BucketVersioningVersioningConfiguration( + status="Enabled" + ) + ) + # 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_s3_bucket_versioning_destination.override_logical_id("destination") + aws_s3_bucket_versioning_source = S3BucketVersioningA(self, "source_6", + bucket=source.id, + provider=central, + versioning_configuration=S3BucketVersioningVersioningConfiguration( + status="Enabled" + ) + ) + # 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_s3_bucket_versioning_source.override_logical_id("source") + assume_role = DataAwsIamPolicyDocument(self, "assume_role", + statement=[DataAwsIamPolicyDocumentStatement( + actions=["sts:AssumeRole"], + effect="Allow", + principals=[DataAwsIamPolicyDocumentStatementPrincipals( + identifiers=["s3.amazonaws.com"], + type="Service" + ) + ] + ) + ] + ) + replication = DataAwsIamPolicyDocument(self, "replication", + statement=[DataAwsIamPolicyDocumentStatement( + actions=["s3:GetReplicationConfiguration", "s3:ListBucket"], + effect="Allow", + resources=[source.arn] + ), DataAwsIamPolicyDocumentStatement( + actions=["s3:GetObjectVersionForReplication", "s3:GetObjectVersionAcl", "s3:GetObjectVersionTagging" + ], + effect="Allow", + resources=["${" + source.arn + "}/*"] + ), DataAwsIamPolicyDocumentStatement( + actions=["s3:ReplicateObject", "s3:ReplicateDelete", "s3:ReplicateTags" + ], + effect="Allow", + resources=["${" + destination.arn + "}/*"] + ) + ] + ) + aws_iam_policy_replication = IamPolicy(self, "replication_9", + name="tf-iam-role-policy-replication-12345", + policy=Token.as_string(replication.json) + ) + # 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_iam_policy_replication.override_logical_id("replication") + aws_iam_role_replication = IamRole(self, "replication_10", + assume_role_policy=Token.as_string(assume_role.json), + name="tf-iam-role-replication-12345" + ) + # 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_iam_role_replication.override_logical_id("replication") + aws_iam_role_policy_attachment_replication = IamRolePolicyAttachment(self, "replication_11", + policy_arn=Token.as_string(aws_iam_policy_replication.arn), + role=Token.as_string(aws_iam_role_replication.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. + aws_iam_role_policy_attachment_replication.override_logical_id("replication") + aws_s3_bucket_replication_configuration_replication = + S3BucketReplicationConfigurationA(self, "replication_12", + bucket=source.id, + depends_on=[aws_s3_bucket_versioning_source], + provider=central, + role=Token.as_string(aws_iam_role_replication.arn), + rule=[S3BucketReplicationConfigurationRule( + destination=S3BucketReplicationConfigurationRuleDestination( + bucket=destination.arn, + storage_class="STANDARD" + ), + filter=S3BucketReplicationConfigurationRuleFilter( + prefix="example" + ), + id="examplerule", + status="Enabled" + ) + ] + ) + # 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_s3_bucket_replication_configuration_replication.override_logical_id("replication") +``` + +

+
+ +
+After, v6.0.0 +

+ +```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.data_aws_iam_policy_document import DataAwsIamPolicyDocument +from imports.aws.iam_policy import IamPolicy +from imports.aws.iam_role import IamRole +from imports.aws.iam_role_policy_attachment import IamRolePolicyAttachment +from imports.aws.provider import AwsProvider +from imports.aws.s3_bucket import S3Bucket +from imports.aws.s3_bucket_acl import S3BucketAcl +from imports.aws.s3_bucket_replication_configuration import S3BucketReplicationConfigurationA +from imports.aws.s3_bucket_versioning import S3BucketVersioningA +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + AwsProvider(self, "aws", + region="eu-west-1" + ) + destination = S3Bucket(self, "destination", + bucket="tf-test-bucket-destination-12345" + ) + source = S3Bucket(self, "source", + bucket="tf-test-bucket-source-12345", + region="eu-central-1" + ) + S3BucketAcl(self, "source_bucket_acl", + acl="private", + bucket=source.id, + region="eu-central-1" + ) + aws_s3_bucket_versioning_destination = S3BucketVersioningA(self, "destination_4", + bucket=destination.id, + versioning_configuration=S3BucketVersioningVersioningConfiguration( + status="Enabled" + ) + ) + # 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_s3_bucket_versioning_destination.override_logical_id("destination") + aws_s3_bucket_versioning_source = S3BucketVersioningA(self, "source_5", + bucket=source.id, + region="eu-central-1", + versioning_configuration=S3BucketVersioningVersioningConfiguration( + status="Enabled" + ) + ) + # 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_s3_bucket_versioning_source.override_logical_id("source") + assume_role = DataAwsIamPolicyDocument(self, "assume_role", + statement=[DataAwsIamPolicyDocumentStatement( + actions=["sts:AssumeRole"], + effect="Allow", + principals=[DataAwsIamPolicyDocumentStatementPrincipals( + identifiers=["s3.amazonaws.com"], + type="Service" + ) + ] + ) + ] + ) + replication = DataAwsIamPolicyDocument(self, "replication", + statement=[DataAwsIamPolicyDocumentStatement( + actions=["s3:GetReplicationConfiguration", "s3:ListBucket"], + effect="Allow", + resources=[source.arn] + ), DataAwsIamPolicyDocumentStatement( + actions=["s3:GetObjectVersionForReplication", "s3:GetObjectVersionAcl", "s3:GetObjectVersionTagging" + ], + effect="Allow", + resources=["${" + source.arn + "}/*"] + ), DataAwsIamPolicyDocumentStatement( + actions=["s3:ReplicateObject", "s3:ReplicateDelete", "s3:ReplicateTags" + ], + effect="Allow", + resources=["${" + destination.arn + "}/*"] + ) + ] + ) + aws_iam_policy_replication = IamPolicy(self, "replication_8", + name="tf-iam-role-policy-replication-12345", + policy=Token.as_string(replication.json) + ) + # 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_iam_policy_replication.override_logical_id("replication") + aws_iam_role_replication = IamRole(self, "replication_9", + assume_role_policy=Token.as_string(assume_role.json), + name="tf-iam-role-replication-12345" + ) + # 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_iam_role_replication.override_logical_id("replication") + aws_iam_role_policy_attachment_replication = IamRolePolicyAttachment(self, "replication_10", + policy_arn=Token.as_string(aws_iam_policy_replication.arn), + role=Token.as_string(aws_iam_role_replication.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. + aws_iam_role_policy_attachment_replication.override_logical_id("replication") + aws_s3_bucket_replication_configuration_replication = + S3BucketReplicationConfigurationA(self, "replication_11", + bucket=source.id, + depends_on=[aws_s3_bucket_versioning_source], + region="eu-central-1", + role=Token.as_string(aws_iam_role_replication.arn), + rule=[S3BucketReplicationConfigurationRule( + destination=S3BucketReplicationConfigurationRuleDestination( + bucket=destination.arn, + storage_class="STANDARD" + ), + filter=S3BucketReplicationConfigurationRuleFilter( + prefix="example" + ), + id="examplerule", + status="Enabled" + ) + ] + ) + # 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_s3_bucket_replication_configuration_replication.override_logical_id("replication") +``` + +

+
+ +## Non–region-aware resources + +This section lists resources that are not Region-aware—meaning `region` has not been added to them. + +Some resources, such as [IAM and STS](https://docs.aws.amazon.com/IAM/latest/UserGuide/programming.html#IAMEndpoints), are [global](https://docs.aws.amazon.com/whitepapers/latest/aws-fault-isolation-boundaries/global-services.html) and exist in all Regions within a partition. + +Other resources are not Region-aware because they already had a top-level `region`, are inherently global, or because adding `region` would not be appropriate for other reasons. + +### Resources deprecating `region` + +The following regional resources and data sources had a top-level `region` prior to version 6.0.0. It is now deprecated and will be replaced in a future version to support the new Region-aware behavior. + +* `aws_cloudformation_stack_set_instance` resource +* `aws_config_aggregate_authorization` resource +* `aws_dx_hosted_connection` resource +* `aws_region` data source +* `aws_s3_bucket` data source +* `aws_servicequotas_template` resource +* `aws_servicequotas_templates` data source +* `aws_ssmincidents_replication_set` resource and data source +* `aws_vpc_endpoint_service` data source +* `aws_vpc_peering_connection` data source + +### Global services + +All resources for the following services are considered _global_: + +* Account Management (`aws_account_*`) +* Billing (`aws_billing_*`) +* Billing and Cost Management Data Exports (`aws_bcmdataexports_*`) +* Budgets (`aws_budgets_*`) +* CloudFront (`aws_cloudfront_*` and `aws_cloudfrontkeyvaluestore_*`) +* Cost Explorer (`aws_ce_*`) +* Cost Optimization Hub (`aws_costoptimizationhub_*`) +* Cost and Usage Report (`aws_cur_*`) +* Global Accelerator (`aws_globalaccelerator_*`) +* IAM (`aws_iam_*`, `aws_rolesanywhere_*` and `aws_caller_identity`) +* Network Manager (`aws_networkmanager_*`) +* Organizations (`aws_organizations_*`) +* Price List (`aws_pricing_*`) +* Route 53 (`aws_route53_*` and `aws_route53domains_*`) +* Route 53 ARC (`aws_route53recoverycontrolconfig_*` and `aws_route53recoveryreadiness_*`) +* Shield Advanced (`aws_shield_*`) +* User Notifications (`aws_notifications_*`) +* User Notifications Contacts (`aws_notificationscontacts_*`) +* WAF Classic (`aws_waf_*`) + +### Global resources in regional services + +Some regional services have a subset of resources that are global: + +| Service | Type | Name | +|---|---|---| +| Backup | Resource | `aws_backup_global_settings` | +| Chime SDK Voice | Resource | `aws_chimesdkvoice_global_settings` | +| CloudTrail | Resource | `aws_cloudtrail_organization_delegated_admin_account` | +| Direct Connect | Resource | `aws_dx_gateway` | +| Direct Connect | Data Source | `aws_dx_gateway` | +| EC2 | Resource | `aws_ec2_image_block_public_access` | +| Firewall Manager | Resource | `aws_fms_admin_account` | +| IPAM | Resource | `aws_vpc_ipam_organization_admin_account` | +| QuickSight | Resource | `aws_quicksight_account_settings` | +| Resource Access Manager | Resource | `aws_ram_sharing_with_organization` | +| S3 | Data Source | `aws_canonical_user_id` | +| S3 | Resource | `aws_s3_account_public_access_block` | +| S3 | Data Source | `aws_s3_account_public_access_block` | +| Service Catalog | Resource | `aws_servicecatalog_organizations_access` | + +### Meta data sources + +The `aws_default_tags`, `aws_partition`, and `aws_regions` data sources are effectively global. + +`region` of the `aws_arn` data source stays as-is. + +### Policy Document Data Sources + +Some data sources convert HCL into JSON policy documents and are effectively global: + +* `aws_cloudwatch_log_data_protection_policy_document` +* `aws_ecr_lifecycle_policy_document` + + \ No newline at end of file diff --git a/website/docs/cdktf/python/guides/version-6-upgrade.html.markdown b/website/docs/cdktf/python/guides/version-6-upgrade.html.markdown new file mode 100644 index 000000000000..8c6e0886cb40 --- /dev/null +++ b/website/docs/cdktf/python/guides/version-6-upgrade.html.markdown @@ -0,0 +1,747 @@ +--- +subcategory: "" +layout: "aws" +page_title: "Terraform AWS Provider Version 6 Upgrade Guide" +description: |- + Terraform AWS Provider Version 6 Upgrade Guide +--- + + + +# Terraform AWS Provider Version 6 Upgrade Guide + +Version 6.0.0 of the AWS provider for Terraform is a major release and includes changes that you need to consider when upgrading. This guide will help with that process and focuses only on changes from version 5.x to version 6.0.0. See the [Version 5 Upgrade Guide](/docs/providers/aws/guides/version-5-upgrade.html) for information on upgrading from 4.x to version 5.0.0. + +Upgrade topics: + + + +- [Prerequisites to Upgrade to v6.0.0](#prerequisites-to-upgrade-to-v600) +- [Removed Provider Arguments](#removed-provider-arguments) +- [Enhanced Region Support](#enhanced-region-support) +- [Amazon Elastic Transcoder Deprecation](#amazon-elastic-transcoder-deprecation) +- [CloudWatch Evidently Deprecation](#cloudwatch-evidently-deprecation) +- [Nullable Boolean Validation Update](#nullable-boolean-validation-update) +- [OpsWorks Stacks Removal](#opsworks-stacks-removal) +- [S3 Global Endpoint Deprecation](#s3-global-endpoint-deprecation) +- [SimpleDB Support Removed](#simpledb-support-removed) +- [Worklink Support Removed](#worklink-support-removed) +- [Data Source `aws_ami`](#data-source-aws_ami) +- [Data Source `aws_batch_compute_environment`](#data-source-aws_batch_compute_environment) +- [Data Source `aws_ecs_task_definition`](#data-source-aws_ecs_task_definition) +- [Data Source `aws_ecs_task_execution`](#data-source-aws_ecs_task_execution) +- [Data Source `aws_elbv2_listener_rule`](#data-source-aws_elbv2_listener_rule) +- [Data Source `aws_globalaccelerator_accelerator`](#data-source-aws_globalaccelerator_accelerator) +- [Data Source `aws_identitystore_group`](#data-source-aws_identitystore_group) +- [Data Source `aws_identitystore_user`](#data-source-aws_identitystore_user) +- [Data Source `aws_kms_secret`](#data-source-aws_kms_secret) +- [Data Source `aws_launch_template`](#data-source-aws_launch_template) +- [Data Source `aws_opensearch_domain`](#data-source-aws_opensearch_domain) +- [Data Source `aws_opensearchserverless_security_config`](#data-source-aws_opensearchserverless_security_config) +- [Data Source `aws_quicksight_data_set`](#data-source-aws_quicksight_data_set) +- [Data Source `aws_region`](#data-source-aws_region) +- [Data Source `aws_s3_bucket`](#data-source-aws_s3_bucket) +- [Data Source `aws_service_discovery_service`](#data-source-aws_service_discovery_service) +- [Data Source `aws_servicequotas_templates`](#data-source-aws_servicequotas_templates) +- [Data Source `aws_ssmincidents_replication_set`](#data-source-aws_ssmincidents_replication_set) +- [Data Source `aws_vpc_endpoint_service`](#data-source-aws_vpc_endpoint_service) +- [Data Source `aws_vpc_peering_connection`](#data-source-aws_vpc_peering_connection) +- [Resource `aws_accessanalyzer_archive_rule`](#typenullablebool-validation-update) +- [Resource `aws_alb_target_group`](#typenullablebool-validation-update) +- [Resource `aws_api_gateway_account`](#resource-aws_api_gateway_account) +- [Resource `aws_api_gateway_deployment`](#resource-aws_api_gateway_deployment) +- [Resource `aws_appflow_connector_profile`](#resource-aws_appflow_connector_profile) +- [Resource `aws_appflow_flow`](#resource-aws_appflow_flow) +- [Resource `aws_batch_compute_environment`](#resource-aws_batch_compute_environment) +- [Resource `aws_batch_job_queue`](#resource-aws_batch_job_queue) +- [Resource `aws_bedrock_model_invocation_logging_configuration`](#resource-aws_bedrock_model_invocation_logging_configuration) +- [Resource `aws_cloudformation_stack_set_instance`](#resource-aws_cloudformation_stack_set_instance) +- [Resource `aws_cloudfront_key_value_store`](#resource-aws_cloudfront_key_value_store) +- [Resource `aws_cloudfront_response_headers_policy`](#resource-aws_cloudfront_response_headers_policy) +- [Resource `aws_cloudtrail_event_data_store`](#typenullablebool-validation-update) +- [Resource `aws_cognito_user_in_group`](#resource-aws_cognito_user_in_group) +- [Resource `aws_config_aggregate_authorization`](#resource-aws_config_aggregate_authorization) +- [Resource `aws_cur_report_definition`](#resource-aws_cur_report_definition) +- [Resource `aws_db_instance`](#resource-aws_db_instance) +- [Resource `aws_dms_endpoint`](#resource-aws_dms_endpoint) +- [Resource `aws_dx_gateway_association`](#resource-aws_dx_gateway_association) +- [Resource `aws_dx_hosted_connection`](#resource-aws_dx_hosted_connection) +- [Resource `aws_ec2_spot_instance_fleet`](#typenullablebool-validation-update) +- [Resource `aws_ecs_task_definition`](#resource-aws_ecs_task_definition) +- [Resource `aws_eip`](#resource-aws_eip) +- [Resource `aws_eks_addon`](#resource-aws_eks_addon) +- [Resource `aws_elasticache_cluster`](#typenullablebool-validation-update) +- [Resource `aws_elasticache_replication_group`](#resource-aws_elasticache_replication_group) +- [Resource `aws_elasticache_user`](#resource-aws_elasticache_user) +- [Resource `aws_elasticache_user_group`](#resource-aws_elasticache_user_group) +- [Resource `aws_evidently_feature`](#typenullablebool-validation-update) +- [Resource `aws_flow_log`](#resource-aws_flow_log) +- [Resource `aws_guardduty_detector`](#resource-aws_guardduty_detector) +- [Resource `aws_guardduty_organization_configuration`](#resource-aws_guardduty_organization_configuration) +- [Resource `aws_imagebuilder_container_recipe`](#typenullablebool-validation-update) +- [Resource `aws_imagebuilder_image_recipe`](#typenullablebool-validation-update) +- [Resource `aws_instance`](#resource-aws_instance) +- [Resource `aws_kinesis_analytics_application`](#resource-aws_kinesis_analytics_application) +- [Resource `aws_launch_template`](#resource-aws_launch_template) +- [Resource `aws_lb_listener`](#resource-aws_lb_listener) +- [Resource `aws_lb_target_group`](#typenullablebool-validation-update) +- [Resource `aws_media_store_container`](#resource-aws_media_store_container) +- [Resource `aws_media_store_container_policy`](#resource-aws_media_store_container_policy) +- [Resource `aws_mq_broker`](#typenullablebool-validation-update) +- [Resource `aws_networkmanager_core_network`](#resource-aws_networkmanager_core_network) +- [Resource `aws_opensearch_domain`](#resource-aws_opensearch_domain) +- [Resource `aws_opensearchserverless_security_config`](#resource-aws_opensearchserverless_security_config) +- [Resource `aws_paymentcryptography_key`](#resource-aws_paymentcryptography_key) +- [Resource `aws_redshift_cluster`](#resource-aws_redshift_cluster) +- [Resource `aws_redshift_service_account`](#resource-aws_redshift_service_account) +- [Resource `aws_rekognition_stream_processor`](#resource-aws_rekognition_stream_processor) +- [Resource `aws_resiliencehub_resiliency_policy`](#resource-aws_resiliencehub_resiliency_policy) +- [Resource `aws_s3_bucket`](#resource-aws_s3_bucket) +- [Resource `aws_sagemaker_image_version`](#resource-aws_sagemaker_image_version) +- [Resource `aws_sagemaker_notebook_instance`](#resource-aws_sagemaker_notebook_instance) +- [Resource `aws_servicequotas_template`](#resource-aws_servicequotas_template) +- [Resource `aws_spot_instance_request`](#resource-aws_spot_instance_request) +- [Resource `aws_ssm_association`](#resource-aws_ssm_association) +- [Resource `aws_ssmincidents_replication_set`](#resource-aws_ssmincidents_replication_set) +- [Resource `aws_verifiedpermissions_schema`](#resource-aws_verifiedpermissions_schema) +- [Resource `aws_wafv2_web_acl`](#resource-aws_wafv2_web_acl) + + + +## Prerequisites to Upgrade to v6.0.0 + +-> Before upgrading to version `6.0.0`, first upgrade to the latest available `5.x` version of the provider. Run [`terraform plan`](https://developer.hashicorp.com/terraform/cli/commands/plan) and confirm that: + +- Your plan completes without errors or unexpected changes. +- There are no deprecation warnings related to the changes described in this guide. + +If you use [version constraints](https://developer.hashicorp.com/terraform/language/providers/requirements#provider-versions) (recommended), update them to allow the `6.x` series and run [`terraform init -upgrade`](https://developer.hashicorp.com/terraform/cli/commands/init) to download the new version. + +### Example + +**Before:** + +```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") +``` + +**After:** + +```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") +``` + +## Removed Provider Arguments + +Remove the following from your provider configuration—they are no longer supported: + +- `endpoints.opsworks` – removed following AWS OpsWorks Stacks End of Life. +- `endpoints.simpledb` and `endpoints.sdb` – removed due to the removal of Amazon SimpleDB support. +- `endpoints.worklink` – removed due to the removal of Amazon Worklink support. + +## Enhanced Region Support + +Version 6.0.0 adds `region` to most resources making it significantly easier to manage infrastructure across AWS Regions without requiring multiple provider configurations. See [Enhanced Region Support](enhanced-region-support.html). + +## Amazon Elastic Transcoder Deprecation + +Amazon Elastic Transcoder will be [discontinued](https://aws.amazon.com/blogs/media/support-for-amazon-elastic-transcoder-ending-soon/) on **November 13, 2025**. + +The following resources are deprecated and will be removed in a future major release: + +- `aws_elastictranscoder_pipeline` +- `aws_elastictranscoder_preset` + +Use [AWS Elemental MediaConvert](https://aws.amazon.com/blogs/media/migrating-workflows-from-amazon-elastic-transcoder-to-aws-elemental-mediaconvert/) instead. + +## CloudWatch Evidently Deprecation + +AWS will [end support](https://aws.amazon.com/blogs/mt/support-for-amazon-cloudwatch-evidently-ending-soon/) for CloudWatch Evidently on **October 17, 2025**. + +The following resources are deprecated and will be removed in a future major release: + +- `aws_evidently_feature` +- `aws_evidently_launch` +- `aws_evidently_project` +- `aws_evidently_segment` + +Migrate to [AWS AppConfig Feature Flags](https://aws.amazon.com/blogs/mt/using-aws-appconfig-feature-flags/). + +## Nullable Boolean Validation Update + +Update your configuration to _only_ use `""`, `true`, or `false` if you use the arguments below _and_ you are using `0` or `1` to represent boolean values: + +| Resource | Attribute(s) | +|-----------------------------------------|--------------------------------------------------------------------------| +| `aws_accessanalyzer_archive_rule` | `filter.exists` | +| `aws_alb_target_group` | `preserve_client_ip` | +| `aws_cloudtrail_event_data_store` | `suspend` | +| `aws_ec2_spot_instance_fleet` | `terminate_instances_on_delete` | +| `aws_elasticache_cluster` | `auto_minor_version_upgrade` | +| `aws_elasticache_replication_group` | `at_rest_encryption_enabled`, `auto_minor_version_upgrade` | +| `aws_evidently_feature` | `variations.value.bool_value` | +| `aws_imagebuilder_container_recipe` | `instance_configuration.block_device_mapping.ebs.delete_on_termination`, `instance_configuration.block_device_mapping.ebs.encrypted` | +| `aws_imagebuilder_image_recipe` | `block_device_mapping.ebs.delete_on_termination`, `block_device_mapping.ebs.encrypted` | +| `aws_launch_template` | `block_device_mappings.ebs.delete_on_termination`, `block_device_mappings.ebs.encrypted`, `ebs_optimized`, `network_interfaces.associate_carrier_ip_address`, `network_interfaces.associate_public_ip_address`, `network_interfaces.delete_on_termination`, `network_interfaces.primary_ipv6` | +| `aws_lb_target_group` | `preserve_client_ip` | +| `aws_mq_broker` | `logs.audit` | + +This is due to changes to `TypeNullableBool`. + +## OpsWorks Stacks Removal + +The AWS OpsWorks Stacks service has reached [End of Life](https://docs.aws.amazon.com/opsworks/latest/userguide/stacks-eol-faqs.html). The following resources have been removed: + +- `aws_opsworks_application` +- `aws_opsworks_custom_layer` +- `aws_opsworks_ecs_cluster_layer` +- `aws_opsworks_ganglia_layer` +- `aws_opsworks_haproxy_layer` +- `aws_opsworks_instance` +- `aws_opsworks_java_app_layer` +- `aws_opsworks_memcached_layer` +- `aws_opsworks_mysql_layer` +- `aws_opsworks_nodejs_app_layer` +- `aws_opsworks_permission` +- `aws_opsworks_php_app_layer` +- `aws_opsworks_rails_app_layer` +- `aws_opsworks_rds_db_instance` +- `aws_opsworks_stack` +- `aws_opsworks_static_web_layer` +- `aws_opsworks_user_profile` + +## SimpleDB Support Removed + +The `aws_simpledb_domain` resource has been removed, as the [AWS SDK for Go v2](https://docs.aws.amazon.com/sdk-for-go/v2/developer-guide/welcome.html) no longer supports Amazon SimpleDB. + +## Worklink Support Removed + +The following resources have been removed due to dropped support for Amazon Worklink in the [AWS SDK for Go v2](https://github.com/aws/aws-sdk-go-v2/pull/2814): + +- `aws_worklink_fleet` +- `aws_worklink_website_certificate_authority_association` + +## S3 Global Endpoint Deprecation + +Support for the global S3 endpoint is deprecated. This affects S3 resources in `us-east-1` (excluding directory buckets) when `s3_us_east_1_regional_endpoint` is set to `legacy`. + +`s3_us_east_1_regional_endpoint` will be removed in `v7.0.0`. + +To prepare: + +- Remove `s3_us_east_1_regional_endpoint` from your provider configuration, **or** +- Set its value to `regional` and verify functionality. + +## Data Source `aws_ami` + +When using `most_recent = true`, your configuration **must now include** an `owner` or a `filter` that identifies the image by `image-id` or `owner-id`. + +- **Before (v5 and earlier):** + Terraform allowed this setup and showed only a warning. + +- **Now (v6+):** + Terraform will stop with an **error** to prevent unsafe or ambiguous AMI lookups. + +### How to fix it + +Do one of the following: + +- Add `owner`: + +```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 +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) +``` + +- Or add a `filter` block that includes either `image-id` or `owner-id`: + +```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 +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) +``` + +### Unsafe option (not recommended) + +To override this check, you can set: + +```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 +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) +``` + +However, this may lead to unreliable results and should be avoided unless absolutely necessary. + +## Data Source `aws_batch_compute_environment` + +`compute_environment_name` has been renamed to `name`. + +Update your configurations to replace any usage of `compute_environment_name` with `name` to use this version. + +## Data Source `aws_ecs_task_definition` + +Remove `inference_accelerator`—it is no longer supported. Amazon Elastic Inference reached end of life in April 2024. + +## Data Source `aws_ecs_task_execution` + +Remove `inference_accelerator_overrides`—it is no longer supported. Amazon Elastic Inference reached end of life in April 2024. + +## Data Source `aws_elbv2_listener_rule` + +Treat the following as lists of nested blocks instead of single-nested blocks: + +- `action.authenticate_cognito` +- `action.authenticate_oidc` +- `action.fixed_response` +- `action.forward` +- `action.forward.stickiness` +- `action.redirect` +- `condition.host_header` +- `condition.http_header` +- `condition.http_request_method` +- `condition.path_pattern` +- `condition.query_string` +- `condition.source_ip` + +The data source configuration itself does not change. However, now, include an index when referencing them. For example, update `action[0].authenticate_cognito.scope` to `action[0].authenticate_cognito[0].scope`. + +## Data Source `aws_globalaccelerator_accelerator` + +`id` is now **computed only** and can no longer be set manually. +If your configuration explicitly attempts to set a value for `id`, you must remove it to avoid an error. + +## Data Source `aws_identitystore_group` + +Remove `filter`—it is no longer supported. To locate a group, update your configuration to use `alternate_identifier` instead. + +## Data Source `aws_identitystore_user` + +Remove `filter`—it is no longer supported. +To locate a user, update your configuration to use `alternate_identifier` instead. + +## Data Source `aws_kms_secret` + +The functionality for this data source was removed in **v2.0.0** and the data source will be removed in a future version. + +## Data Source `aws_launch_template` + +Remove the following—they are no longer supported: + +- `elastic_gpu_specifications`: Amazon Elastic Graphics reached end of life in January 2024. +- `elastic_inference_accelerator`: Amazon Elastic Inference reached end of life in April 2024. + +## Data Source `aws_opensearch_domain` + +Remove `kibana_endpoint`—it is no longer supported. AWS OpenSearch Service no longer uses Kibana endpoints. The service now uses **Dashboards**, accessible at the `/_dashboards/` path on the domain endpoint. +For more details, refer to the [AWS OpenSearch Dashboards documentation](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/dashboards.html). + +## Data Source `aws_opensearchserverless_security_config` + +Treat `saml_options` as a list of nested blocks instead of a single-nested block. The data source configuration itself does not change. However, now, include an index when referencing it. For example, update `saml_options.session_timeout` to `saml_options[0].session_timeout`. + +## Data Source `aws_quicksight_data_set` + +Remove `tags_all`—it is no longer supported. + +## Data Source `aws_region` + +`name` has been deprecated. Use `region` instead. + +## Data Source `aws_s3_bucket` + +`bucket_region` has been added and should be used instead of `region`, which is now used for [Enhanced Region Support](enhanced-region-support.html). + +## Data Source `aws_service_discovery_service` + +Remove `tags_all`—it is no longer supported. + +## Data Source `aws_servicequotas_templates` + +`region` has been deprecated. Use `aws_region` instead. + +## Data Source `aws_ssmincidents_replication_set` + +`region` has been deprecated. Use `regions` instead. + +## Data Source `aws_vpc_endpoint_service` + +`region` has been deprecated. Use `service_region` instead. + +## Data Source `aws_vpc_peering_connection` + +`region` has been deprecated. Use `requester_region` instead. + +## Resource `aws_api_gateway_account` + +Remove `reset_on_delete`—it is no longer supported. The destroy operation will now always reset the API Gateway account settings by default. + +If you want to retain the previous behavior (where the account settings were not changed upon destruction), use a `removed` block in your configuration. For more details, see the [removing resources documentation](https://developer.hashicorp.com/terraform/language/resources/syntax#removing-resources). + +## Resource `aws_api_gateway_deployment` + +* Use the `aws_api_gateway_stage` resource if your configuration uses any of the following, which have been removed from the `aws_api_gateway_deployment` resource: + - `stage_name` + - `stage_description` + - `canary_settings` +* Remove `invoke_url` and `execution_arn`—they are no longer supported. Use the `aws_api_gateway_stage` resource instead. + +### Migration Example + +**Before (v5 and earlier, using implicit stage):** + +```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.api_gateway_deployment import ApiGatewayDeployment +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + ApiGatewayDeployment(self, "example", + rest_api_id=Token.as_string(aws_api_gateway_rest_api_example.id), + stage_name="prod" + ) +``` + +**After (v6+, using explicit stage):** + +If your previous configuration relied on an implicitly created stage, you must now define and manage that stage explicitly using the `aws_api_gateway_stage` resource. To do this, create a corresponding resource and import the existing stage into your configuration. + +```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.api_gateway_deployment import ApiGatewayDeployment +from imports.aws.api_gateway_stage import ApiGatewayStage +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + example = ApiGatewayDeployment(self, "example", + rest_api_id=Token.as_string(aws_api_gateway_rest_api_example.id) + ) + ApiGatewayStage(self, "prod", + deployment_id=example.id, + rest_api_id=Token.as_string(aws_api_gateway_rest_api_example.id), + stage_name="prod" + ) +``` + +Import the existing stage, replacing `rest_api_id` and `stage_name` with your values: + +```sh +terraform import aws_api_gateway_stage.prod rest_api_id/stage_name +``` + +## Resource `aws_appflow_connector_profile` + +Importing an `aws_appflow_connector_profile` resource now uses the `name` of the Connector Profile. + +## Resource `aws_appflow_flow` + +Importing an `aws_appflow_flow` resource now uses the `name` of the Flow. + +## Resource `aws_batch_compute_environment` + +Replace any usage of `compute_environment_name` with `name` and `compute_environment_name_prefix` with `name_prefix` as they have been renamed. + +## Resource `aws_batch_job_queue` + +Remove `compute_environments`—it is no longer supported. +Use `compute_environment_order` configuration blocks instead. While you must update your configuration, Terraform will upgrade states with `compute_environments` to `compute_environment_order`. + +**Before (v5 and earlier):** + +```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.batch_job_queue import BatchJobQueue +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + BatchJobQueue(self, "example", + compute_environments=[aws_batch_compute_environment_example.arn], + name="patagonia", + priority=1, + state="ENABLED" + ) +``` + +**After (v6+):** + +```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.batch_job_queue import BatchJobQueue +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + BatchJobQueue(self, "example", + compute_environment_order=[BatchJobQueueComputeEnvironmentOrder( + compute_environment=Token.as_string(aws_batch_compute_environment_example.arn), + order=0 + ) + ], + name="patagonia", + priority=1, + state="ENABLED" + ) +``` + +## Resource `aws_bedrock_model_invocation_logging_configuration` + +Treat the following as lists of nested blocks instead of single-nested blocks: + +- `logging_config` +- `logging_config.cloudwatch_config` +- `logging_config.cloudwatch_config.large_data_delivery_s3_config` +- `logging_config.s3_config` + +The resource configuration itself does not change, but you must now include an index when referencing them. For example, update `logging_config.cloudwatch_config.log_group_name` to `logging_config[0].cloudwatch_config[0].log_group_name`. + +## Resource `aws_cloudformation_stack_set_instance` + +`region` has been deprecated. Use `stack_set_instance_region` instead. + +## Resource `aws_cloudfront_key_value_store` + +Use `name` to reference the resource name. `id` represents the ID value returned by the AWS API. + +## Resource `aws_cloudfront_response_headers_policy` + +Do not set a value for `etag` as it is now computed only. + +## Resource `aws_cognito_user_in_group` + +For the `id`, use a comma-delimited string concatenating `user_pool_id`, `group_name`, and `username`. For example, in an import command, use comma-delimiting for the composite `id`. + +## Resource `aws_config_aggregate_authorization` + +`region` has been deprecated. Use `authorized_aws_region` instead. + +## Resource `aws_cur_report_definition` + +`s3_prefix` is now required. + +## Resource `aws_db_instance` + +Do not use `character_set_name` with `replicate_source_db`, `restore_to_point_in_time`, `s3_import`, or `snapshot_identifier`. The combination is no longer valid. + +## Resource `aws_dms_endpoint` + +`s3_settings` has been removed. Use the `aws_dms_s3_endpoint` resource rather than `s3_settings` of `aws_dms_endpoint`. + +## Resource `aws_dx_gateway_association` + +Remove `vpn_gateway_id`—it is no longer supported. Use `associated_gateway_id` instead. + +## Resource `aws_dx_hosted_connection` + +`region` has been deprecated. Use `connection_region` instead. + +## Resource `aws_ecs_task_definition` + +Remove `inference_accelerator`—it is no longer supported. Amazon Elastic Inference reached end of life in April 2024. + +## Resource `aws_eip` + +Remove `vpc`—it is no longer supported. Use `domain` instead. + +## Resource `aws_eks_addon` + +Remove `resolve_conflicts`—it is no longer supported. Use `resolve_conflicts_on_create` and `resolve_conflicts_on_update` instead. + +## Resource `aws_elasticache_replication_group` + +* `auth_token_update_strategy` no longer has a default value. If `auth_token` is set, it must also be explicitly configured. +* The ability to provide an uppercase `engine` value is deprecated. In `v7.0.0`, plan-time validation of `engine` will require an entirely lowercase value to match the returned value from the AWS API without diff suppression. +* See also [changes](#typenullablebool-validation-update) to `at_rest_encryption_enabled` and `auto_minor_version_upgrade`. + +## Resource `aws_elasticache_user` + +The ability to provide an uppercase `engine` value is deprecated. +In `v7.0.0`, plan-time validation of `engine` will require an entirely lowercase value to match the returned value from the AWS API without diff suppression. + +## Resource `aws_elasticache_user_group` + +The ability to provide an uppercase `engine` value is deprecated. +In `v7.0.0`, plan-time validation of `engine` will require an entirely lowercase value to match the returned value from the AWS API without diff suppression. + +## Resource `aws_flow_log` + +Remove `log_group_name`—it is no longer supported. Use `log_destination` instead. + +## Resource `aws_guardduty_detector` + +`datasources` is deprecated. +Use the `aws_guardduty_detector_feature` resource instead. + +## Resource `aws_guardduty_organization_configuration` + +* Remove `auto_enable`—it is no longer supported. +* `auto_enable_organization_members` is now required. +* `datasources` is deprecated. + +## Resource `aws_instance` + +* `user_data` no longer applies hashing and is now stored in clear text. **Do not include passwords or sensitive information** in `user_data`, as it will be visible in plaintext. Follow [AWS Best Practices](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html) to secure your instance metadata. If you need to provide base64-encoded user data, use `user_data_base64` instead. +* Remove `cpu_core_count` and `cpu_threads_per_core`—they are no longer supported. Instead, use the `cpu_options` configuration block with `core_count` and `threads_per_core`. + +## Resource `aws_kinesis_analytics_application` + +This resource is deprecated and will be removed in a future version. [Effective January 27, 2026](https://aws.amazon.com/blogs/big-data/migrate-from-amazon-kinesis-data-analytics-for-sql-to-amazon-managed-service-for-apache-flink-and-amazon-managed-service-for-apache-flink-studio/), AWS will [no longer support](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/discontinuation.html) Amazon Kinesis Data Analytics for SQL. Use the `aws_kinesisanalyticsv2_application` resource instead to manage Amazon Kinesis Data Analytics for Apache Flink applications. AWS provides guidance for migrating from [Amazon Kinesis Data Analytics for SQL Applications to Amazon Managed Service for Apache Flink Studio](https://aws.amazon.com/blogs/big-data/migrate-from-amazon-kinesis-data-analytics-for-sql-applications-to-amazon-managed-service-for-apache-flink-studio/) including [examples](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/migrating-to-kda-studio-overview.html). + +## Resource `aws_launch_template` + +* Remove `elastic_gpu_specifications`—it is no longer supported. Amazon Elastic Graphics reached end of life in January 2024. +* Remove `elastic_inference_accelerator`—it is no longer supported. Amazon Elastic Inference reached end of life in April 2024. +* See also [changes](#typenullablebool-validation-update) to `block_device_mappings.ebs.delete_on_termination`, `block_device_mappings.ebs.encrypted`, `ebs_optimized`, `network_interfaces.associate_carrier_ip_address`, `network_interfaces.associate_public_ip_address`, `network_interfaces.delete_on_termination`, and `network_interfaces.primary_ipv6`. + +## Resource `aws_lb_listener` + +* For `mutual_authentication`, `advertise_trust_store_ca_names`, `ignore_client_certificate_expiry`, and `trust_store_arn` can now only be set when `mode` is `verify`. +* `trust_store_arn` is required when `mode` is `verify`. + +## Resource `aws_media_store_container` + +This resource is deprecated and will be removed in a future version. AWS has [announced](https://aws.amazon.com/blogs/media/support-for-aws-elemental-mediastore-ending-soon/) the discontinuation of AWS Elemental MediaStore, effective November 13, 2025. Users should begin transitioning to alternative solutions as soon as possible. For simple live streaming workflows, AWS recommends migrating to Amazon S3. For advanced use cases that require features such as packaging, DRM, or cross-region redundancy, consider using AWS Elemental MediaPackage. + +## Resource `aws_media_store_container_policy` + +This resource is deprecated and will be removed in a future version. AWS has [announced](https://aws.amazon.com/blogs/media/support-for-aws-elemental-mediastore-ending-soon/) the discontinuation of AWS Elemental MediaStore, effective November 13, 2025. Users should begin transitioning to alternative solutions as soon as possible. For simple live streaming workflows, AWS recommends migrating to Amazon S3. For advanced use cases that require features such as packaging, DRM, or cross-region redundancy, consider using AWS Elemental MediaPackage. + +## Resource `aws_networkmanager_core_network` + +Remove `base_policy_region`—it is no longer supported. Use `base_policy_regions` instead. + +## Resource `aws_opensearch_domain` + +Remove `kibana_endpoint`—it is no longer supported. AWS OpenSearch Service does not use Kibana endpoints (i.e., `_plugin/kibana`). Instead, OpenSearch uses Dashboards, accessible at the path `/_dashboards/` on the domain endpoint. The terminology has shifted from “Kibana” to “Dashboards.” + +For more information, see the [AWS OpenSearch Dashboards documentation](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/dashboards.html). + +## Resource `aws_opensearchserverless_security_config` + +Treat `saml_options` as a list of nested blocks instead of a single-nested block. The resource configuration itself does not change. However, now, include an index when referencing it. For example, update `saml_options.session_timeout` to `saml_options[0].session_timeout`. + +## Resource `aws_paymentcryptography_key` + +Treat the `key_attributes` and `key_attributes.key_modes_of_use` as lists of nested blocks instead of single-nested blocks. The resource configuration itself does not change. However, now, include an index when referencing them. For example, update `key_attributes.key_modes_of_use.decrypt` to `key_attributes[0].key_modes_of_use[0].decrypt`. + +## Resource `aws_redshift_cluster` + +* `encrypted` now defaults to `true`. +* `publicly_accessible` now defaults to `false`. +* Remove `snapshot_copy`—it is no longer supported. Use the `aws_redshift_snapshot_copy` resource instead. +* Remove `logging`—it is no longer supported. Use the `aws_redshift_logging` resource instead. +* `cluster_public_key`, `cluster_revision_number`, and `endpoint` are now read only and should not be set. + +## Resource `aws_redshift_service_account` + +The `aws_redshift_service_account` resource has been removed. AWS [recommends](https://docs.aws.amazon.com/redshift/latest/mgmt/db-auditing.html#db-auditing-bucket-permissions) that a [service principal name](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html#principal-services) should be used instead of an AWS account ID in any relevant IAM policy. + +## Resource `aws_rekognition_stream_processor` + +Treat `regions_of_interest.bounding_box` as a list of nested blocks instead of a single-nested block. The resource configuration itself does not change. However, now, include an index when referencing it. For example, update `regions_of_interest[0].bounding_box.height` to `regions_of_interest[0].bounding_box[0].height`. + +## Resource `aws_resiliencehub_resiliency_policy` + +Treat the following as lists of nested blocks instead of single-nested blocks: + +- `policy` +- `policy.az` +- `policy.hardware` +- `policy.software` +- `policy.region` + +The resource configuration itself does not change. However, now, include an index when referencing them. For example, update `policy.az.rpo` to `policy[0].az[0].rpo`. + +## Resource `aws_s3_bucket` + +`bucket_region` has been added and should be used instead of `region`, which is now used for [Enhanced Region Support](enhanced-region-support.html). + +## Resource `aws_sagemaker_image_version` + +For the `id`, use a comma-delimited string concatenating `image_name` and `version`. For example, in an import command, use comma-delimiting for the composite `id`. +Use `image_name` to reference the image name. + +## Resource `aws_sagemaker_notebook_instance` + +Remove `accelerator_types`—it is no longer supported. Instead, use `instance_type` to use [Inferentia](https://docs.aws.amazon.com/sagemaker/latest/dg/neo-supported-cloud.html). + +## Resource `aws_servicequotas_template` + +`region` has been deprecated. Use `aws_region` instead. + +## Resource `aws_spot_instance_request` + +Remove `block_duration_minutes`—it is no longer supported. + +## Resource `aws_ssm_association` + +Remove `instance_id`—it is no longer supported. Use `targets` instead. + +## Resource `aws_ssmincidents_replication_set` + +`region` has been deprecated. Use `regions` instead. + +## Resource `aws_verifiedpermissions_schema` + +Treat `definition` as a list of nested blocks instead of a single-nested block. The resource configuration itself does not change. However, now, include an index when referencing it. For example, update `definition.value` to `definition[0].value`. + +## Resource `aws_wafv2_web_acl` + +The default value for `rule.statement.managed_rule_group_statement.managed_rule_group_configs.aws_managed_rules_bot_control_rule_set.enable_machine_learning` is now `false`. +To retain the previous behavior where the argument was omitted, explicitly set the value to `true`. + + \ No newline at end of file diff --git a/website/docs/cdktf/python/index.html.markdown b/website/docs/cdktf/python/index.html.markdown index 560c6273ba8b..4b061487e164 100644 --- a/website/docs/cdktf/python/index.html.markdown +++ b/website/docs/cdktf/python/index.html.markdown @@ -9,18 +9,13 @@ description: |- # AWS Provider -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. +The Amazon Web Services (AWS) provider is Terraform’s most widely-used provider and the industry-standard way to manage AWS infrastructure as code. It is an indispensable part of how leading technology companies, global banks, government agencies, and some of the largest enterprises in the world build and operate in the cloud. Every day, it provisions and orchestrates billions of dollars of AWS infrastructure across thousands of organizations. -Use the navigation to the left to read about the available resources. There are currently 1514 resources and 608 data sources available in the provider. +With 1,523 resources and 609 data sources, the AWS provider spans the full breadth of AWS services—from foundational capabilities like compute, storage, networking, and identity management to advanced services for AI, analytics, and event-driven architectures, including Lambda, RDS, SageMaker, and Bedrock. Whether automating a single S3 bucket or orchestrating a multi-region, enterprise-scale environment, the provider delivers consistent, reliable workflows that scale with your needs. -To learn the basics of Terraform using this provider, follow the -hands-on [get started tutorials](https://developer.hashicorp.com/terraform/tutorials/aws-get-started/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, -including Lambda, RDS, and IAM by following the [AWS services -tutorials](https://developer.hashicorp.com/terraform/tutorials/aws?utm_source=WEBSITE&utm_medium=WEB_IO&utm_offer=ARTICLE_PAGE&utm_content=DOCS). +Configure the provider with your AWS credentials, and you can immediately begin creating and managing infrastructure in a safe, repeatable way. Use the navigation on the left to explore the available resources, or start with our [Get Started tutorials](https://developer.hashicorp.com/terraform/tutorials/aws-get-started/infrastructure-as-code?in=terraform/aws-get-started&utm_source=WEBSITE&utm_medium=WEB_IO&utm_offer=ARTICLE_PAGE&utm_content=DOCS) to learn the fundamentals. For deeper guidance on specific AWS services, visit the [AWS services tutorials](https://developer.hashicorp.com/terraform/tutorials/aws?utm_source=WEBSITE&utm_medium=WEB_IO&utm_offer=ARTICLE_PAGE&utm_content=DOCS). -Some AWS services do not support IPv6. As a result, the provider may not be able to interact with AWS APIs using IPv6 addresses. +Note: Some AWS services do not yet support IPv6. In those cases, the provider may not be able to connect to AWS APIs over IPv6 addresses. ## Example Usage @@ -450,17 +445,19 @@ In addition to [generic `provider` arguments](https://www.terraform.io/docs/conf Can also be set with either the `AWS_REGION` or `AWS_DEFAULT_REGION` environment variables, or via a shared config file parameter `region` if `profile` is used. If credentials are retrieved from the EC2 Instance Metadata Service, the Region can also be retrieved from the metadata. + Most Regional resources, data sources and ephemeral resources support an optional top-level `region` argument which can be used to override the provider configuration value. See the individual resource's documentation for details. * `retry_mode` - (Optional) Specifies how retries are attempted. Valid values are `standard` and `adaptive`. Can also be configured using the `AWS_RETRY_MODE` environment variable or the shared config file parameter `retry_mode`. * `s3_use_path_style` - (Optional) Whether to enable the request to use path-style addressing, i.e., `https://s3.amazonaws.com/BUCKET/KEY`. By default, the S3 client will use virtual hosted bucket addressing, `https://BUCKET.s3.amazonaws.com/KEY`, when possible. Specific to the Amazon S3 service. -* `s3_us_east_1_regional_endpoint` - (Optional) Specifies whether S3 API calls in the `us-east-1` Region use the legacy global endpoint or a regional endpoint. +* `s3_us_east_1_regional_endpoint` - (Optional, **Deprecated**) Specifies whether S3 API calls in the `us-east-1` Region use the legacy global endpoint or a regional endpoint. Valid values are `legacy` or `regional`. If omitted, the default behavior in the `us-east-1` Region is to use the global endpoint for general purpose buckets and the regional endpoint for directory buckets. Can also be configured using the `AWS_S3_US_EAST_1_REGIONAL_ENDPOINT` environment variable or the `s3_us_east_1_regional_endpoint` shared config file parameter. Specific to the Amazon S3 service. + This argument and the ability to use the global S3 endpoint are deprecated and will be removed in `v7.0.0`. * `secret_key` - (Optional) AWS secret key. Can also be set with the `AWS_SECRET_ACCESS_KEY` environment variable, or via a shared configuration and credentials files if `profile` is used. See also `access_key`. * `shared_config_files` - (Optional) List of paths to AWS shared config files. If not set, the default is `[~/.aws/config]`. A single value can also be set with the `AWS_CONFIG_FILE` environment variable. * `shared_credentials_files` - (Optional) List of paths to the shared credentials file. If not set and a profile is used, the default value is `[~/.aws/credentials]`. A single value can also be set with the `AWS_SHARED_CREDENTIALS_FILE` environment variable. @@ -900,4 +897,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. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/accessanalyzer_analyzer.html.markdown b/website/docs/cdktf/python/r/accessanalyzer_analyzer.html.markdown index 41d9201b1176..b9e2db2794ac 100644 --- a/website/docs/cdktf/python/r/accessanalyzer_analyzer.html.markdown +++ b/website/docs/cdktf/python/r/accessanalyzer_analyzer.html.markdown @@ -60,7 +60,7 @@ class MyConvertedCode(TerraformStack): aws_accessanalyzer_analyzer_example.override_logical_id("example") ``` -### Organization Unused Access Analyzer with analysis rule +### Organization Unused Access Analyzer With Analysis Rule ```python # DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -78,20 +78,19 @@ class MyConvertedCode(TerraformStack): analyzer_name="example", configuration=AccessanalyzerAnalyzerConfiguration( unused_access=AccessanalyzerAnalyzerConfigurationUnusedAccess( - analysis_rule=[{ - "exclusion": [{ - "account_ids": ["123456789012", "234567890123"] - }, { - "resource_tags": [{ + analysis_rule=AccessanalyzerAnalyzerConfigurationUnusedAccessAnalysisRule( + exclusion=[AccessanalyzerAnalyzerConfigurationUnusedAccessAnalysisRuleExclusion( + account_ids=["123456789012", "234567890123"] + ), AccessanalyzerAnalyzerConfigurationUnusedAccessAnalysisRuleExclusion( + resource_tags=[{ "key1": "value1" }, { "key2": "value2" } ] - } + ) ] - } - ], + ), unused_access_age=180 ) ), @@ -99,6 +98,68 @@ class MyConvertedCode(TerraformStack): ) ``` +### Account Internal Access Analyzer by Resource Types + +```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.accessanalyzer_analyzer import AccessanalyzerAnalyzer +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + AccessanalyzerAnalyzer(self, "test", + analyzer_name="example", + configuration=AccessanalyzerAnalyzerConfiguration( + internal_access=AccessanalyzerAnalyzerConfigurationInternalAccess( + analysis_rule=AccessanalyzerAnalyzerConfigurationInternalAccessAnalysisRule( + inclusion=[AccessanalyzerAnalyzerConfigurationInternalAccessAnalysisRuleInclusion( + resource_types=["AWS::S3::Bucket", "AWS::RDS::DBSnapshot", "AWS::DynamoDB::Table" + ] + ) + ] + ) + ) + ), + type="ORGANIZATION_INTERNAL_ACCESS" + ) +``` + +### Organization Internal Access Analyzer by Account ID and Resource ARN + +```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.accessanalyzer_analyzer import AccessanalyzerAnalyzer +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + AccessanalyzerAnalyzer(self, "test", + analyzer_name="example", + configuration=AccessanalyzerAnalyzerConfiguration( + internal_access=AccessanalyzerAnalyzerConfigurationInternalAccess( + analysis_rule=AccessanalyzerAnalyzerConfigurationInternalAccessAnalysisRule( + inclusion=[AccessanalyzerAnalyzerConfigurationInternalAccessAnalysisRuleInclusion( + account_ids=["123456789012"], + resource_arns=["arn:aws:s3:::my-example-bucket"] + ) + ] + ) + ) + ), + type="ORGANIZATION_INTERNAL_ACCESS" + ) +``` + ## Argument Reference The following arguments are required: @@ -107,34 +168,64 @@ The following arguments are required: The following arguments are optional: -* `configuration` - (Optional) A block that specifies the configuration of the analyzer. [Documented below](#configuration-argument-reference) +* `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). +* `configuration` - (Optional) A block that specifies the configuration of the analyzer. See [`configuration` Block](#configuration-block) for details. * `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. -* `type` - (Optional) Type of Analyzer. Valid values are `ACCOUNT`, `ORGANIZATION`, `ACCOUNT_UNUSED_ACCESS `, `ORGANIZATION_UNUSED_ACCESS`. Defaults to `ACCOUNT`. +* `type` - (Optional) Type that represents the zone of trust or scope for the analyzer. Valid values are `ACCOUNT`, `ACCOUNT_INTERNAL_ACCESS`, `ACCOUNT_UNUSED_ACCESS`, `ORGANIZATION`, `ORGANIZATION_INTERNAL_ACCESS`, `ORGANIZATION_UNUSED_ACCESS`. Defaults to `ACCOUNT`. + +### `configuration` Block + +The `configuration` configuration block supports the following arguments: + +* `internal_access` - (Optional) Specifies the configuration of an internal access analyzer for an AWS organization or account. This configuration determines how the analyzer evaluates access within your AWS environment. See [`internal_access` Block](#internal_access-block) for details. +* `unused_access` - (Optional) Specifies the configuration of an unused access analyzer for an AWS organization or account. See [`unused_access` Block](#unused_access-block) for details. + +### `internal_access` Block + +The `internal_access` configuration block supports the following arguments: + +* `analysis_rule` - (Optional) Information about analysis rules for the internal access analyzer. These rules determine which resources and access patterns will be analyzed. See [`analysis_rule` Block for Internal Access Analyzer](#analysis_rule-block-for-internal-access-analyzer) for details. + +### `analysis_rule` Block for Internal Access Analyzer + +The `analysis_rule` configuration block for internal access analyzer supports the following arguments: + +* `inclusion` - (Optional) List of rules for the internal access analyzer containing criteria to include in analysis. Only resources that meet the rule criteria will generate findings. See [`inclusion` Block](#inclusion-block) for details. + +### `inclusion` Block + +The `inclusion` configuration block supports the following arguments: + +* `account_ids` - (Optional) List of AWS account IDs to apply to the internal access analysis rule criteria. Account IDs can only be applied to the analysis rule criteria for organization-level analyzers. +* `resource_arns` - (Optional) List of resource ARNs to apply to the internal access analysis rule criteria. The analyzer will only generate findings for resources that match these ARNs. +* `resource_types` - (Optional) List of resource types to apply to the internal access analysis rule criteria. The analyzer will only generate findings for resources of these types. Refer to [InternalAccessAnalysisRuleCriteria](https://docs.aws.amazon.com/access-analyzer/latest/APIReference/API_InternalAccessAnalysisRuleCriteria.html) in the AWS IAM Access Analyzer API Reference for valid values. + +### `unused_access` Block -### `configuration` Argument Reference +The `unused_access` configuration block supports the following arguments: -* `unused_access` - (Optional) A block that specifies the configuration of an unused access analyzer for an AWS organization or account. [Documented below](#unused_access-argument-reference) +* `unused_access_age` - (Optional) Specified access age in days for which to generate findings for unused access. +* `analysis_rule` - (Optional) Information about analysis rules for the analyzer. Analysis rules determine which entities will generate findings based on the criteria you define when you create the rule. See [`analysis_rule` Block for Unused Access Analyzer](#analysis_rule-block-for-unused-access-analyzer) for details. -### `unused_access` Argument Reference +### `analysis_rule` Block for Unused Access Analyzer -* `unused_access_age` - (Optional) The specified access age in days for which to generate findings for unused access. -* `analysis_rule` - (Optional) A block for analysis rules. [Documented below](#analysis_rule-argument-reference) +The `analysis_rule` configuration block for unused access analyzer supports the following arguments: -### `analysis_rule` Argument Reference +* `exclusion` - (Optional) List of rules for the analyzer containing criteria to exclude from analysis. Entities that meet the rule criteria will not generate findings. See [`exclusion` Block](#exclusion-block) for details. -* `exclusion` - (Optional) A block for the analyzer rules containing criteria to exclude from analysis. [Documented below](#exclusion-argument-reference) +### `exclusion` Block -#### `exclusion` Argument Reference +The `exclusion` configuration block supports the following arguments: -* `account_ids` - (Optional) A list of account IDs to exclude from the analysis. -* `resource_tags` - (Optional) A list of key-value pairs for resource tags to exclude from the analysis. +* `account_ids` - (Optional) List of AWS account IDs to apply to the analysis rule criteria. The accounts cannot include the organization analyzer owner account. Account IDs can only be applied to the analysis rule criteria for organization-level analyzers. +* `resource_tags` - (Optional) List of key-value pairs for resource tags to exclude from the analysis. ## Attribute Reference This resource exports the following attributes in addition to the arguments above: * `arn` - ARN of the Analyzer. -* `id` - Analyzer name. +* `id` - Name of the analyzer. * `tags_all` - Map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). ## Import @@ -162,4 +253,4 @@ Using `terraform import`, import Access Analyzer Analyzers using the `analyzer_n % terraform import aws_accessanalyzer_analyzer.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/accessanalyzer_archive_rule.html.markdown b/website/docs/cdktf/python/r/accessanalyzer_archive_rule.html.markdown index 84ce8a26c0be..c21d436e6002 100644 --- a/website/docs/cdktf/python/r/accessanalyzer_archive_rule.html.markdown +++ b/website/docs/cdktf/python/r/accessanalyzer_archive_rule.html.markdown @@ -47,8 +47,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `analyzer_name` - (Required) Analyzer name. * `filter` - (Required) Filter criteria for the archive rule. See [Filter](#filter) for more details. * `rule_name` - (Required) Rule name. @@ -94,4 +95,4 @@ Using `terraform import`, import AccessAnalyzer ArchiveRule using the `analyzer_ % terraform import aws_accessanalyzer_archive_rule.example example-analyzer/example-rule ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/acm_certificate.html.markdown b/website/docs/cdktf/python/r/acm_certificate.html.markdown index e1aafb3a6aba..02b24f86b7f6 100644 --- a/website/docs/cdktf/python/r/acm_certificate.html.markdown +++ b/website/docs/cdktf/python/r/acm_certificate.html.markdown @@ -187,6 +187,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * Creating an Amazon issued certificate * `domain_name` - (Required) Domain name for which the certificate should be issued * `subject_alternative_names` - (Optional) Set of domains that should be SANs in the issued certificate. To remove all elements of a previously configured list, set this value equal to an empty list (`[]`) or use the [`terraform taint` command](https://www.terraform.io/docs/commands/taint.html) to trigger recreation. @@ -214,6 +215,7 @@ This resource supports the following arguments: Supported nested arguments for the `options` configuration block: * `certificate_transparency_logging_preference` - (Optional) Whether certificate details should be added to a certificate transparency log. Valid values are `ENABLED` or `DISABLED`. See https://docs.aws.amazon.com/acm/latest/userguide/acm-concepts.html#concept-transparency for more details. +* `export` - (Optional) Whether the certificate can be exported. Valid values are `ENABLED` or `DISABLED` (default). **Note** Issuing an exportable certificate is subject to additional charges. See [AWS Certificate Manager pricing](https://aws.amazon.com/certificate-manager/pricing/) for more details. ## validation_option Configuration Block @@ -281,4 +283,4 @@ Using `terraform import`, import certificates using their ARN. For example: % terraform import aws_acm_certificate.cert arn:aws:acm:eu-central-1:123456789012:certificate/7e7a28d2-163f-4b8f-b9cd-822f96c08d6a ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/acm_certificate_validation.html.markdown b/website/docs/cdktf/python/r/acm_certificate_validation.html.markdown index edad40e3e09e..2fa0141c7da2 100644 --- a/website/docs/cdktf/python/r/acm_certificate_validation.html.markdown +++ b/website/docs/cdktf/python/r/acm_certificate_validation.html.markdown @@ -187,6 +187,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `certificate_arn` - (Required) ARN of the certificate that is being validated. * `validation_record_fqdns` - (Optional) List of FQDNs that implement the validation. Only valid for DNS validation method ACM certificates. If this is set, the resource can implement additional sanity checks and has an explicit dependency on the resource that is implementing the validation @@ -202,4 +203,4 @@ This resource exports the following attributes in addition to the arguments abov - `create` - (Default `75m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/acmpca_certificate.html.markdown b/website/docs/cdktf/python/r/acmpca_certificate.html.markdown index d68ec0852772..88a4fca96f15 100644 --- a/website/docs/cdktf/python/r/acmpca_certificate.html.markdown +++ b/website/docs/cdktf/python/r/acmpca_certificate.html.markdown @@ -75,6 +75,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `certificate_authority_arn` - (Required) ARN of the certificate authority. * `certificate_signing_request` - (Required) Certificate Signing Request in PEM format. * `signing_algorithm` - (Required) Algorithm to use to sign certificate requests. Valid values: `SHA256WITHRSA`, `SHA256WITHECDSA`, `SHA384WITHRSA`, `SHA384WITHECDSA`, `SHA512WITHRSA`, `SHA512WITHECDSA`. @@ -121,4 +122,4 @@ Using `terraform import`, import ACM PCA Certificates using their ARN. For examp % terraform import aws_acmpca_certificate.cert arn:aws:acm-pca:eu-west-1:675225743824:certificate-authority/08319ede-83g9-1400-8f21-c7d12b2b6edb/certificate/a4e9c2aa4bcfab625g1b9136464cd3a ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/acmpca_certificate_authority.html.markdown b/website/docs/cdktf/python/r/acmpca_certificate_authority.html.markdown index e4cc97fef17a..31a685f13a59 100644 --- a/website/docs/cdktf/python/r/acmpca_certificate_authority.html.markdown +++ b/website/docs/cdktf/python/r/acmpca_certificate_authority.html.markdown @@ -135,6 +135,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `certificate_authority_configuration` - (Required) Nested argument containing algorithms and certificate subject information. Defined below. * `enabled` - (Optional) Whether the certificate authority is enabled or disabled. Defaults to `true`. Can only be disabled if the CA is in an `ACTIVE` state. * `revocation_configuration` - (Optional) Nested argument containing revocation configuration. Defined below. @@ -232,4 +233,4 @@ Using `terraform import`, import `aws_acmpca_certificate_authority` using the ce % terraform import aws_acmpca_certificate_authority.example arn:aws:acm-pca:us-east-1:123456789012:certificate-authority/12345678-1234-1234-1234-123456789012 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/acmpca_certificate_authority_certificate.html.markdown b/website/docs/cdktf/python/r/acmpca_certificate_authority_certificate.html.markdown index 6cd18c242545..a7b117f75004 100644 --- a/website/docs/cdktf/python/r/acmpca_certificate_authority_certificate.html.markdown +++ b/website/docs/cdktf/python/r/acmpca_certificate_authority_certificate.html.markdown @@ -138,6 +138,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `certificate` - (Required) PEM-encoded certificate for the Certificate Authority. * `certificate_authority_arn` - (Required) ARN of the Certificate Authority. * `certificate_chain` - (Optional) PEM-encoded certificate chain that includes any intermediate certificates and chains up to root CA. Required for subordinate Certificate Authorities. Not allowed for root Certificate Authorities. @@ -146,4 +147,4 @@ This resource supports the following arguments: This resource exports no additional attributes. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/acmpca_permission.html.markdown b/website/docs/cdktf/python/r/acmpca_permission.html.markdown index fc6b92cbe36f..212f92295ad5 100644 --- a/website/docs/cdktf/python/r/acmpca_permission.html.markdown +++ b/website/docs/cdktf/python/r/acmpca_permission.html.markdown @@ -50,6 +50,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `certificate_authority_arn` - (Required) ARN of the CA that grants the permissions. * `actions` - (Required) Actions that the specified AWS service principal can use. These include `IssueCertificate`, `GetCertificate`, and `ListPermissions`. Note that in order for ACM to automatically rotate certificates issued by a PCA, it must be granted permission on all 3 actions, as per the example above. * `principal` - (Required) AWS service or identity that receives the permission. At this time, the only valid principal is `acm.amazonaws.com`. @@ -61,4 +62,4 @@ This resource exports the following attributes in addition to the arguments abov * `policy` - IAM policy that is associated with the permission. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/acmpca_policy.html.markdown b/website/docs/cdktf/python/r/acmpca_policy.html.markdown index 290e9f9195c3..821627cceae5 100644 --- a/website/docs/cdktf/python/r/acmpca_policy.html.markdown +++ b/website/docs/cdktf/python/r/acmpca_policy.html.markdown @@ -72,6 +72,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `resource_arn` - (Required) ARN of the private CA to associate with the policy. * `policy` - (Required) JSON-formatted IAM policy to attach to the specified private CA resource. @@ -104,4 +105,4 @@ Using `terraform import`, import `aws_acmpca_policy` using the `resource_arn` va % terraform import aws_acmpca_policy.example arn:aws:acm-pca:us-east-1:123456789012:certificate-authority/12345678-1234-1234-1234-123456789012 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ami.html.markdown b/website/docs/cdktf/python/r/ami.html.markdown index e4dfe32e236e..5255f343bde8 100644 --- a/website/docs/cdktf/python/r/ami.html.markdown +++ b/website/docs/cdktf/python/r/ami.html.markdown @@ -51,6 +51,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) Region-unique name for the AMI. * `boot_mode` - (Optional) Boot mode of the AMI. For more information, see [Boot modes](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-boot.html) in the Amazon Elastic Compute Cloud User Guide. * `deprecation_time` - (Optional) Date and time to deprecate the AMI. If you specified a value for seconds, Amazon EC2 rounds the seconds to the nearest minute. Valid values: [RFC3339 time string](https://tools.ietf.org/html/rfc3339#section-5.8) (`YYYY-MM-DDTHH:MM:SSZ`) @@ -161,4 +162,4 @@ Using `terraform import`, import `aws_ami` using the ID of the AMI. For example: % terraform import aws_ami.example ami-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ami_copy.html.markdown b/website/docs/cdktf/python/r/ami_copy.html.markdown index a3bb0dfbd954..752097ee895d 100644 --- a/website/docs/cdktf/python/r/ami_copy.html.markdown +++ b/website/docs/cdktf/python/r/ami_copy.html.markdown @@ -50,6 +50,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) Region-unique name for the AMI. * `source_ami_id` - (Required) Id of the AMI to copy. This id must be valid in the region given by `source_ami_region`. @@ -82,4 +83,4 @@ configuration. * `update` - (Default `40m`) * `delete` - (Default `90m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ami_from_instance.html.markdown b/website/docs/cdktf/python/r/ami_from_instance.html.markdown index d286288b11c7..57cce226b620 100644 --- a/website/docs/cdktf/python/r/ami_from_instance.html.markdown +++ b/website/docs/cdktf/python/r/ami_from_instance.html.markdown @@ -52,6 +52,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) Region-unique name for the AMI. * `source_instance_id` - (Required) ID of the instance to use as the basis of the AMI. * `snapshot_without_reboot` - (Optional) Boolean that overrides the behavior of stopping @@ -79,4 +80,4 @@ This resource also exports a full set of attributes corresponding to the argumen [`aws_ami`](/docs/providers/aws/r/ami.html) resource, allowing the properties of the created AMI to be used elsewhere in the configuration. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ami_launch_permission.html.markdown b/website/docs/cdktf/python/r/ami_launch_permission.html.markdown index ed11a8b4637b..273284cde179 100644 --- a/website/docs/cdktf/python/r/ami_launch_permission.html.markdown +++ b/website/docs/cdktf/python/r/ami_launch_permission.html.markdown @@ -80,6 +80,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `account_id` - (Optional) AWS account ID for the launch permission. * `group` - (Optional) Name of the group for the launch permission. Valid values: `"all"`. * `image_id` - (Required) ID of the AMI. @@ -117,4 +118,4 @@ Using `terraform import`, import AMI Launch Permissions using `[ACCOUNT-ID|GROUP % terraform import aws_ami_launch_permission.example 123456789012/ami-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/amplify_app.html.markdown b/website/docs/cdktf/python/r/amplify_app.html.markdown index 6f93c6489fbd..c5e88e074e44 100644 --- a/website/docs/cdktf/python/r/amplify_app.html.markdown +++ b/website/docs/cdktf/python/r/amplify_app.html.markdown @@ -181,10 +181,33 @@ class MyConvertedCode(TerraformStack): ) ``` +### Job Config + +```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.amplify_app import AmplifyApp +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + AmplifyApp(self, "example", + job_config=AmplifyAppJobConfig( + build_compute_type="STANDARD_8GB" + ), + name="example" + ) +``` + ## Argument Reference This resource supports the following arguments: +* `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). * `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. See [`auto_branch_creation_config` Block](#auto_branch_creation_config-block) for details. @@ -202,6 +225,7 @@ This resource supports the following arguments: * `enable_branch_auto_deletion` - (Optional) Automatically disconnects a branch in the Amplify Console when you delete a branch from your Git repository. * `environment_variables` - (Optional) Environment variables map for an Amplify app. * `iam_service_role_arn` - (Optional) AWS Identity and Access Management (IAM) service role for an Amplify app. +* `job_config` - (Optional) Used to configure the [Amplify Application build instance compute type](https://docs.aws.amazon.com/amplify/latest/APIReference/API_JobConfig.html#amplify-Type-JobConfig-buildComputeType). See [`job_config` Block](#job_config-block) for details. * `oauth_token` - (Optional) OAuth token for a third-party source control system for an Amplify app. The OAuth token is used to create a webhook and a read-only deploy key. The OAuth token is not stored. * `platform` - (Optional) Platform or framework for an Amplify app. Valid values: `WEB`, `WEB_COMPUTE`. Default value: `WEB`. * `repository` - (Optional) Repository for an Amplify app. @@ -237,6 +261,12 @@ The `custom_rule` configuration block supports the following arguments: * `status` - (Optional) Status code for a URL rewrite or redirect rule. Valid values: `200`, `301`, `302`, `404`, `404-200`. * `target` - (Required) Target pattern for a URL rewrite or redirect rule. +### `job_config` Block + +The `job_config` configuration block supports the following arguments: + +* `build_compute_type` - (Optional) Size of the build instance. Valid values: `STANDARD_8GB`, `LARGE_16GB`, and `XLARGE_72GB`. Default: `STANDARD_8GB`. + ## Attribute Reference This resource exports the following attributes in addition to the arguments above: @@ -281,4 +311,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`). - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/amplify_backend_environment.html.markdown b/website/docs/cdktf/python/r/amplify_backend_environment.html.markdown index ed02a722229c..0f6a0e9661f2 100644 --- a/website/docs/cdktf/python/r/amplify_backend_environment.html.markdown +++ b/website/docs/cdktf/python/r/amplify_backend_environment.html.markdown @@ -44,6 +44,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `app_id` - (Required) Unique ID for an Amplify app. * `environment_name` - (Required) Name for the backend environment. * `deployment_artifacts` - (Optional) Name of deployment artifacts. @@ -81,4 +82,4 @@ Using `terraform import`, import Amplify backend environment using `app_id` and % terraform import aws_amplify_backend_environment.example d2ypk4k47z8u6/example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/amplify_branch.html.markdown b/website/docs/cdktf/python/r/amplify_branch.html.markdown index ba288b0addf3..cbd51dcf7ed2 100644 --- a/website/docs/cdktf/python/r/amplify_branch.html.markdown +++ b/website/docs/cdktf/python/r/amplify_branch.html.markdown @@ -169,6 +169,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `app_id` - (Required) Unique ID for an Amplify app. * `branch_name` - (Required) Name for the branch. * `backend_environment_arn` - (Optional) ARN for a backend environment that is part of an Amplify app. @@ -180,6 +181,7 @@ This resource supports the following arguments: * `enable_notification` - (Optional) Enables notifications for the branch. * `enable_performance_mode` - (Optional) Enables performance mode for the branch. * `enable_pull_request_preview` - (Optional) Enables pull request previews for this branch. +* `enable_skew_protection` - (Optional) Enables skew protection for the branch. * `environment_variables` - (Optional) Environment variables for the branch. * `framework` - (Optional) Framework for the branch. * `pull_request_environment_name` - (Optional) Amplify environment name for the pull request. @@ -223,4 +225,4 @@ Using `terraform import`, import Amplify branch using `app_id` and `branch_name` % terraform import aws_amplify_branch.master d2ypk4k47z8u6/master ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/amplify_domain_association.html.markdown b/website/docs/cdktf/python/r/amplify_domain_association.html.markdown index b6689d821cdc..8bcc5454db16 100644 --- a/website/docs/cdktf/python/r/amplify_domain_association.html.markdown +++ b/website/docs/cdktf/python/r/amplify_domain_association.html.markdown @@ -61,6 +61,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `app_id` - (Required) Unique ID for an Amplify app. * `certificate_settings` - (Optional) The type of SSL/TLS certificate to use for your custom domain. If you don't specify a certificate type, Amplify uses the default certificate that it provisions and manages for you. * `domain_name` - (Required) Domain name for the domain association. @@ -117,4 +118,4 @@ Using `terraform import`, import Amplify domain association using `app_id` and ` % terraform import aws_amplify_domain_association.app d2ypk4k47z8u6/example.com ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/amplify_webhook.html.markdown b/website/docs/cdktf/python/r/amplify_webhook.html.markdown index 362c2b580d8f..474374f94fe4 100644 --- a/website/docs/cdktf/python/r/amplify_webhook.html.markdown +++ b/website/docs/cdktf/python/r/amplify_webhook.html.markdown @@ -48,6 +48,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `app_id` - (Required) Unique ID for an Amplify app. * `branch_name` - (Required) Name for a branch that is part of the Amplify app. * `description` - (Optional) Description for a webhook. @@ -84,4 +85,4 @@ Using `terraform import`, import Amplify webhook using a webhook ID. For example % terraform import aws_amplify_webhook.master a26b22a0-748b-4b57-b9a0-ae7e601fe4b1 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/api_gateway_account.html.markdown b/website/docs/cdktf/python/r/api_gateway_account.html.markdown index 5785c35dc886..71de427338f3 100644 --- a/website/docs/cdktf/python/r/api_gateway_account.html.markdown +++ b/website/docs/cdktf/python/r/api_gateway_account.html.markdown @@ -74,6 +74,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `cloudwatch_role_arn` - (Optional) ARN of an IAM role for CloudWatch (to allow logging & monitoring). See more [in AWS Docs](https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-stage-settings.html#how-to-stage-settings-console). Logging & monitoring can be enabled/disabled and otherwise tuned on the API Gateway Stage level. * `reset_on_delete` - (Optional) If `true`, destroying the resource will reset account settings to default, otherwise account settings are not modified. Defaults to `false`. @@ -94,7 +95,7 @@ This resource exports the following attributes in addition to the arguments abov ## Import -In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import API Gateway Accounts using the word `api-gateway-account`. For example: +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import API Gateway Accounts using the account ID. For example: ```python # DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -108,13 +109,13 @@ from imports.aws.api_gateway_account import ApiGatewayAccount class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) - ApiGatewayAccount.generate_config_for_import(self, "demo", "api-gateway-account") + ApiGatewayAccount.generate_config_for_import(self, "demo", "123456789012") ``` -Using `terraform import`, import API Gateway Accounts using the word `api-gateway-account`. For example: +Using `terraform import`, import API Gateway Accounts using the account ID. For example: ```console -% terraform import aws_api_gateway_account.demo api-gateway-account +% terraform import aws_api_gateway_account.demo 123456789012 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/api_gateway_api_key.html.markdown b/website/docs/cdktf/python/r/api_gateway_api_key.html.markdown index 12933789b5c8..ecce7306b26e 100644 --- a/website/docs/cdktf/python/r/api_gateway_api_key.html.markdown +++ b/website/docs/cdktf/python/r/api_gateway_api_key.html.markdown @@ -37,6 +37,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) Name of the API key. * `customer_id` - (Optional) An Amazon Web Services Marketplace customer identifier, when integrating with the Amazon Web Services SaaS Marketplace. * `description` - (Optional) API key description. Defaults to "Managed by Terraform". @@ -79,4 +80,4 @@ Using `terraform import`, import API Gateway Keys using the `id`. For example: % terraform import aws_api_gateway_api_key.example 8bklk8bl1k3sB38D9B3l0enyWT8c09B30lkq0blk ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/api_gateway_authorizer.html.markdown b/website/docs/cdktf/python/r/api_gateway_authorizer.html.markdown index dee0c9e90cec..a8316d12d9dc 100644 --- a/website/docs/cdktf/python/r/api_gateway_authorizer.html.markdown +++ b/website/docs/cdktf/python/r/api_gateway_authorizer.html.markdown @@ -104,6 +104,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `authorizer_uri` - (Optional, required for type `TOKEN`/`REQUEST`) Authorizer's Uniform Resource Identifier (URI). This must be a well-formed Lambda function URI in the form of `arn:aws:apigateway:{region}:lambda:path/{service_api}`, e.g., `arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:012345678912:function:my-function/invocations` * `name` - (Required) Name of the authorizer @@ -147,4 +148,4 @@ Using `terraform import`, import AWS API Gateway Authorizer using the `REST-API- % terraform import aws_api_gateway_authorizer.authorizer 12345abcde/example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/api_gateway_base_path_mapping.html.markdown b/website/docs/cdktf/python/r/api_gateway_base_path_mapping.html.markdown index 702a803c0cb1..d23dbe80ef41 100644 --- a/website/docs/cdktf/python/r/api_gateway_base_path_mapping.html.markdown +++ b/website/docs/cdktf/python/r/api_gateway_base_path_mapping.html.markdown @@ -62,6 +62,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `domain_name` - (Required) Already-registered domain name to connect the API to. * `api_id` - (Required) ID of the API to connect. * `stage_name` - (Optional) Name of a specific deployment stage to expose at the given path. If omitted, callers may select any stage by including its name as a path element after the base path. @@ -147,4 +148,4 @@ For a non-root `base_path` and a private custom domain name: % terraform import aws_api_gateway_base_path_mapping.example api.internal.example.com/base-path/abcde12345 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/api_gateway_client_certificate.html.markdown b/website/docs/cdktf/python/r/api_gateway_client_certificate.html.markdown index 2fbecf171850..1f8112b8f656 100644 --- a/website/docs/cdktf/python/r/api_gateway_client_certificate.html.markdown +++ b/website/docs/cdktf/python/r/api_gateway_client_certificate.html.markdown @@ -35,6 +35,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `description` - (Optional) Description of the client certificate. * `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. @@ -74,4 +75,4 @@ Using `terraform import`, import API Gateway Client Certificates using the id. F % terraform import aws_api_gateway_client_certificate.demo ab1cqe ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/api_gateway_deployment.html.markdown b/website/docs/cdktf/python/r/api_gateway_deployment.html.markdown index 6b241fc4cdc9..76ee4ba50028 100644 --- a/website/docs/cdktf/python/r/api_gateway_deployment.html.markdown +++ b/website/docs/cdktf/python/r/api_gateway_deployment.html.markdown @@ -17,8 +17,6 @@ To properly capture all REST API configuration in a deployment, this resource mu * For REST APIs that are configured via OpenAPI specification ([`aws_api_gateway_rest_api` resource](api_gateway_rest_api.html) `body` argument), no special dependency setup is needed beyond referencing the `id` attribute of that resource unless additional Terraform resources have further customized the REST API. * When the REST API configuration involves other Terraform resources ([`aws_api_gateway_integration` resource](api_gateway_integration.html), etc.), the dependency setup can be done with implicit resource references in the `triggers` argument or explicit resource references using the [resource `depends_on` meta-argument](https://www.terraform.io/docs/configuration/meta-arguments/depends_on.html). The `triggers` argument should be preferred over `depends_on`, since `depends_on` can only capture dependency ordering and will not cause the resource to recreate (redeploy the REST API) with upstream configuration changes. -!> **WARNING:** We recommend using the [`aws_api_gateway_stage` resource](api_gateway_stage.html) instead of managing an API Gateway Stage via the `stage_name` argument of this resource. When this resource is recreated (REST API redeployment) with the `stage_name` configured, the stage is deleted and recreated. This will cause a temporary service interruption, increase Terraform plan differences, and can require a second Terraform apply to recreate any downstream stage configuration such as associated `aws_api_method_settings` resources. - ~> **NOTE:** Enable the [resource `lifecycle` configuration block `create_before_destroy` argument](https://www.terraform.io/language/meta-arguments/lifecycle#create_before_destroy) in this resource configuration to properly order redeployments in Terraform. Without enabling `create_before_destroy`, API Gateway can return errors such as `BadRequestException: Active stages pointing to this deployment must be moved or deleted` on recreation. ## Example Usage @@ -145,35 +143,17 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: -* `canary_settings` - (Optional, **Deprecated** Use an explicit [`aws_api_gateway_stage` resource](api_gateway_stage.html) instead) Input configuration for the canary deployment when the deployment is a canary release deployment. - See [`canary_settings](#canary_settings-argument-reference) below. - Has no effect when `stage_name` is not set. -* `description` - (Optional) Description of the deployment +* `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). +* `description` - (Optional) Description of the deployment. * `rest_api_id` - (Required) REST API identifier. -* `stage_description` - (Optional, **Deprecated** Use an explicit [`aws_api_gateway_stage` resource](api_gateway_stage.html) instead) Description to set on the stage managed by the `stage_name` argument. - Has no effect when `stage_name` is not set. -* `stage_name` - (Optional, **Deprecated** Use an explicit [`aws_api_gateway_stage` resource](api_gateway_stage.html) instead) Name of the stage to create with this deployment. - If the specified stage already exists, it will be updated to point to the new deployment. - We recommend using the [`aws_api_gateway_stage` resource](api_gateway_stage.html) instead to manage stages. * `triggers` - (Optional) Map of arbitrary keys and values that, when changed, will trigger a redeployment. To force a redeployment without changing these keys/values, use the [`-replace` option](https://developer.hashicorp.com/terraform/cli/commands/plan#replace-address) with `terraform plan` or `terraform apply`. -* `variables` - (Optional) Map to set on the stage managed by the `stage_name` argument. - -### `canary_settings` Argument Reference - -* `percent_traffic` - Percentage (0.0-100.0) of traffic routed to the canary deployment. -* `stage_variable_overrides` - Stage variable overrides used for the canary release deployment. They can override existing stage variables or add new stage variables for the canary release deployment. These stage variables are represented as a string-to-string map between stage variable names and their values. -* `use_stage_cache` - Boolean flag to indicate whether the canary release deployment uses the stage cache or not. +* `variables` - (Optional) Map to set on the related stage. ## Attribute Reference This resource exports the following attributes in addition to the arguments above: * `id` - ID of the deployment -* `invoke_url` - **DEPRECATED: Use the `aws_api_gateway_stage` resource instead.** URL to invoke the API pointing to the stage, - e.g., `https://z4675bid1j.execute-api.eu-west-2.amazonaws.com/prod` -* `execution_arn` - **DEPRECATED: Use the `aws_api_gateway_stage` resource instead.** Execution ARN to be used in [`lambda_permission`](/docs/providers/aws/r/lambda_permission.html)'s `source_arn` - when allowing API Gateway to invoke a Lambda function, - e.g., `arn:aws:execute-api:eu-west-2:123456789012:z4675bid1j/prod` * `created_date` - Creation date of the deployment ## Import @@ -201,8 +181,8 @@ Using `terraform import`, import `aws_api_gateway_deployment` using `REST-API-ID % terraform import aws_api_gateway_deployment.example aabbccddee/1122334 ``` -The `stage_name`, `stage_description`, and `variables` arguments cannot be imported. Use the [`aws_api_gateway_stage` resource](api_gateway_stage.html) to import and manage stages. +The `variables` arguments cannot be imported. Use the [`aws_api_gateway_stage` resource](api_gateway_stage.html) to import and manage stages. The `triggers` argument cannot be imported. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/api_gateway_documentation_part.html.markdown b/website/docs/cdktf/python/r/api_gateway_documentation_part.html.markdown index 14178965b2fa..29c86579fbb9 100644 --- a/website/docs/cdktf/python/r/api_gateway_documentation_part.html.markdown +++ b/website/docs/cdktf/python/r/api_gateway_documentation_part.html.markdown @@ -48,6 +48,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `location` - (Required) Location of the targeted API entity of the to-be-created documentation part. See below. * `properties` - (Required) Content map of API-specific key-value pairs describing the targeted API entity. The map must be encoded as a JSON string, e.g., "{ \"description\": \"The API does ...\" }". Only Swagger-compliant key-value pairs can be exported and, hence, published. * `rest_api_id` - (Required) ID of the associated Rest API @@ -96,4 +97,4 @@ Using `terraform import`, import API Gateway documentation_parts using `REST-API % terraform import aws_api_gateway_documentation_part.example 5i4e1ko720/3oyy3t ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/api_gateway_documentation_version.html.markdown b/website/docs/cdktf/python/r/api_gateway_documentation_version.html.markdown index 789cee123588..7db439161f70 100644 --- a/website/docs/cdktf/python/r/api_gateway_documentation_version.html.markdown +++ b/website/docs/cdktf/python/r/api_gateway_documentation_version.html.markdown @@ -56,6 +56,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `version` - (Required) Version identifier of the API documentation snapshot. * `rest_api_id` - (Required) ID of the associated Rest API * `description` - (Optional) Description of the API documentation version. @@ -89,4 +90,4 @@ Using `terraform import`, import API Gateway documentation versions using `REST- % terraform import aws_api_gateway_documentation_version.example 5i4e1ko720/example-version ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/api_gateway_domain_name.html.markdown b/website/docs/cdktf/python/r/api_gateway_domain_name.html.markdown index 863d27df627f..19310237066c 100644 --- a/website/docs/cdktf/python/r/api_gateway_domain_name.html.markdown +++ b/website/docs/cdktf/python/r/api_gateway_domain_name.html.markdown @@ -198,6 +198,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `domain_name` - (Required) Fully-qualified domain name to register. * `endpoint_configuration` - (Optional) Configuration block defining API endpoint information including type. See below. * `mutual_tls_authentication` - (Optional) Mutual TLS authentication configuration for the domain name. See below. @@ -291,4 +292,4 @@ For a private custom domain name: % terraform import aws_api_gateway_domain_name.example dev.api.internal.example.com/abcde12345 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/api_gateway_domain_name_access_association.html.markdown b/website/docs/cdktf/python/r/api_gateway_domain_name_access_association.html.markdown index ca773272fbad..e7cfc9e195c4 100644 --- a/website/docs/cdktf/python/r/api_gateway_domain_name_access_association.html.markdown +++ b/website/docs/cdktf/python/r/api_gateway_domain_name_access_association.html.markdown @@ -37,6 +37,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `access_association_source` - (Required) The identifier of the domain name access association source. For a `VPCE`, the value is the VPC endpoint ID. * `access_association_source_type` - (Required) The type of the domain name access association source. Valid values are `VPCE`. * `domain_name_arn` - (Required) The ARN of the domain name. @@ -75,4 +76,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 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/api_gateway_gateway_response.html.markdown b/website/docs/cdktf/python/r/api_gateway_gateway_response.html.markdown index e030cdee8b6c..0bdbf55a07bc 100644 --- a/website/docs/cdktf/python/r/api_gateway_gateway_response.html.markdown +++ b/website/docs/cdktf/python/r/api_gateway_gateway_response.html.markdown @@ -47,6 +47,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `rest_api_id` - (Required) String identifier of the associated REST API. * `response_type` - (Required) Response type of the associated GatewayResponse. * `status_code` - (Optional) HTTP status code of the Gateway Response. @@ -82,4 +83,4 @@ Using `terraform import`, import `aws_api_gateway_gateway_response` using `REST- % terraform import aws_api_gateway_gateway_response.example 12345abcde/UNAUTHORIZED ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/api_gateway_integration.html.markdown b/website/docs/cdktf/python/r/api_gateway_integration.html.markdown index 4478e3b4a9a8..e2df214cd049 100644 --- a/website/docs/cdktf/python/r/api_gateway_integration.html.markdown +++ b/website/docs/cdktf/python/r/api_gateway_integration.html.markdown @@ -227,6 +227,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `rest_api_id` - (Required) ID of the associated REST API. * `resource_id` - (Required) API resource ID. * `http_method` - (Required) HTTP method (`GET`, `POST`, `PUT`, `DELETE`, `HEAD`, `OPTION`, `ANY`) @@ -288,4 +289,4 @@ Using `terraform import`, import `aws_api_gateway_integration` using `REST-API-I % terraform import aws_api_gateway_integration.example 12345abcde/67890fghij/GET ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/api_gateway_integration_response.html.markdown b/website/docs/cdktf/python/r/api_gateway_integration_response.html.markdown index 3394df3df211..6eb0558804b1 100644 --- a/website/docs/cdktf/python/r/api_gateway_integration_response.html.markdown +++ b/website/docs/cdktf/python/r/api_gateway_integration_response.html.markdown @@ -83,6 +83,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `content_handling` - (Optional) How to handle request payload content type conversions. Supported values are `CONVERT_TO_BINARY` and `CONVERT_TO_TEXT`. If this property is not defined, the response payload will be passed through from the integration response to the method response without modification. * `response_parameters` - (Optional) Map of response parameters that can be read from the backend response. For example: `response_parameters = { "method.response.header.X-Some-Header" = "integration.response.header.X-Some-Other-Header" }`. * `response_templates` - (Optional) Map of templates used to transform the integration response body. @@ -117,4 +118,4 @@ Using `terraform import`, import `aws_api_gateway_integration_response` using `R % terraform import aws_api_gateway_integration_response.example 12345abcde/67890fghij/GET/200 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/api_gateway_method.html.markdown b/website/docs/cdktf/python/r/api_gateway_method.html.markdown index 47ecc2fd3962..3c5b77ff211b 100644 --- a/website/docs/cdktf/python/r/api_gateway_method.html.markdown +++ b/website/docs/cdktf/python/r/api_gateway_method.html.markdown @@ -105,6 +105,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `rest_api_id` - (Required) ID of the associated REST API * `resource_id` - (Required) API resource ID * `http_method` - (Required) HTTP Method (`GET`, `POST`, `PUT`, `DELETE`, `HEAD`, `OPTIONS`, `ANY`) @@ -149,4 +150,4 @@ Using `terraform import`, import `aws_api_gateway_method` using `REST-API-ID/RES % terraform import aws_api_gateway_method.example 12345abcde/67890fghij/GET ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/api_gateway_method_response.html.markdown b/website/docs/cdktf/python/r/api_gateway_method_response.html.markdown index cc1efdd6b2d3..fa5977ec5725 100644 --- a/website/docs/cdktf/python/r/api_gateway_method_response.html.markdown +++ b/website/docs/cdktf/python/r/api_gateway_method_response.html.markdown @@ -137,6 +137,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `rest_api_id` - (Required) The string identifier of the associated REST API. * `resource_id` - (Required) The Resource identifier for the method resource. * `http_method` - (Required) The HTTP verb of the method resource (`GET`, `POST`, `PUT`, `DELETE`, `HEAD`, `OPTIONS`, `ANY`). @@ -144,7 +145,7 @@ This resource supports the following arguments: * `response_models` - (Optional) A map specifying the model resources used for the response's content type. Response models are represented as a key/value map, with a content type as the key and a Model name as the value. * `response_parameters` - (Optional) A map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header name and the associated value is a boolean flag indicating whether the method response parameter is required. The method response header names must match the pattern of `method.response.header.{name}`, where `name` is a valid and unique header name. - The response parameter names defined here are available in the integration response to be mapped from an integration response header expressed in `integration.response.header.{name}`, a static value enclosed within a pair of single quotes (e.g., '`application/json'`), or a JSON expression from the back-end response payload in the form of `integration.response.body.{JSON-expression}`, where `JSON-expression` is a valid JSON expression without the `$` prefix.) +The response parameter names defined here are available in the integration response to be mapped from an integration response header expressed in `integration.response.header.{name}`, a static value enclosed within a pair of single quotes (e.g., '`application/json'`), or a JSON expression from the back-end response payload in the form of `integration.response.body.{JSON-expression}`, where `JSON-expression` is a valid JSON expression without the `$` prefix.) ## Attribute Reference @@ -175,4 +176,4 @@ Using `terraform import`, import `aws_api_gateway_method_response` using `REST-A % terraform import aws_api_gateway_method_response.example 12345abcde/67890fghij/GET/200 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/api_gateway_method_settings.html.markdown b/website/docs/cdktf/python/r/api_gateway_method_settings.html.markdown index 9b5b864681ac..374bc294e788 100644 --- a/website/docs/cdktf/python/r/api_gateway_method_settings.html.markdown +++ b/website/docs/cdktf/python/r/api_gateway_method_settings.html.markdown @@ -198,6 +198,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `rest_api_id` - (Required) ID of the REST API * `stage_name` - (Required) Name of the stage * `method_path` - (Required) Method path defined as `{resource_path}/{http_method}` for an individual method override, or `*/*` for overriding all methods in the stage. Ensure to trim any leading forward slashes in the path (e.g., `trimprefix(aws_api_gateway_resource.example.path, "/")`). @@ -245,4 +246,4 @@ Using `terraform import`, import `aws_api_gateway_method_settings` using `REST-A % terraform import aws_api_gateway_method_settings.example 12345abcde/example/test/GET ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/api_gateway_model.html.markdown b/website/docs/cdktf/python/r/api_gateway_model.html.markdown index 51c2aabb4544..3f5eb91d82b5 100644 --- a/website/docs/cdktf/python/r/api_gateway_model.html.markdown +++ b/website/docs/cdktf/python/r/api_gateway_model.html.markdown @@ -47,6 +47,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `rest_api_id` - (Required) ID of the associated REST API * `name` - (Required) Name of the model * `description` - (Optional) Description of the model @@ -84,4 +85,4 @@ Using `terraform import`, import `aws_api_gateway_model` using `REST-API-ID/NAME % terraform import aws_api_gateway_model.example 12345abcde/example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/api_gateway_request_validator.html.markdown b/website/docs/cdktf/python/r/api_gateway_request_validator.html.markdown index 2643757683fc..fd266ad584eb 100644 --- a/website/docs/cdktf/python/r/api_gateway_request_validator.html.markdown +++ b/website/docs/cdktf/python/r/api_gateway_request_validator.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) Name of the request validator * `rest_api_id` - (Required) ID of the associated Rest API * `validate_request_body` - (Optional) Boolean whether to validate request body. Defaults to `false`. @@ -74,4 +75,4 @@ Using `terraform import`, import `aws_api_gateway_request_validator` using `REST % terraform import aws_api_gateway_request_validator.example 12345abcde/67890fghij ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/api_gateway_resource.html.markdown b/website/docs/cdktf/python/r/api_gateway_resource.html.markdown index 3039424cbb2a..04a5cc865725 100644 --- a/website/docs/cdktf/python/r/api_gateway_resource.html.markdown +++ b/website/docs/cdktf/python/r/api_gateway_resource.html.markdown @@ -42,6 +42,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `rest_api_id` - (Required) ID of the associated REST API * `parent_id` - (Required) ID of the parent API resource * `path_part` - (Required) Last path segment of this API resource. @@ -78,4 +79,4 @@ Using `terraform import`, import `aws_api_gateway_resource` using `REST-API-ID/R % terraform import aws_api_gateway_resource.example 12345abcde/67890fghij ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/api_gateway_rest_api.html.markdown b/website/docs/cdktf/python/r/api_gateway_rest_api.html.markdown index a12e3b1cb058..0f50a3bb15fe 100644 --- a/website/docs/cdktf/python/r/api_gateway_rest_api.html.markdown +++ b/website/docs/cdktf/python/r/api_gateway_rest_api.html.markdown @@ -236,6 +236,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `api_key_source` - (Optional) Source of the API key for requests. Valid values are `HEADER` (default) and `AUTHORIZER`. If importing an OpenAPI specification via the `body` argument, this corresponds to the [`x-amazon-apigateway-api-key-source` extension](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-api-key-source.html). If the argument value is provided and is different than the OpenAPI value, the argument value will override the OpenAPI value. * `binary_media_types` - (Optional) List of binary media types supported by the REST API. By default, the REST API supports only UTF-8-encoded text payloads. If importing an OpenAPI specification via the `body` argument, this corresponds to the [`x-amazon-apigateway-binary-media-types` extension](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-binary-media-types.html). If the argument value is provided and is different than the OpenAPI value, the argument value will override the OpenAPI value. * `body` - (Optional) OpenAPI specification that defines the set of routes and integrations to create as part of the REST API. This configuration, and any updates to it, will replace all REST API configuration except values overridden in this resource configuration and other resource updates applied after this resource but before any `aws_api_gateway_deployment` creation. More information about REST API OpenAPI support can be found in the [API Gateway Developer Guide](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-import-api.html). @@ -307,4 +308,4 @@ Using `terraform import`, import `aws_api_gateway_rest_api` using the REST API I ~> **NOTE:** Resource import does not currently support the `body` attribute. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/api_gateway_rest_api_policy.html.markdown b/website/docs/cdktf/python/r/api_gateway_rest_api_policy.html.markdown index 5a8f9b4348ee..b396bfd7a95c 100644 --- a/website/docs/cdktf/python/r/api_gateway_rest_api_policy.html.markdown +++ b/website/docs/cdktf/python/r/api_gateway_rest_api_policy.html.markdown @@ -68,6 +68,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `rest_api_id` - (Required) ID of the REST API. * `policy` - (Required) JSON formatted policy document that controls access to the API Gateway. For more information about building AWS IAM policy documents with Terraform, see the [AWS IAM Policy Document Guide](https://learn.hashicorp.com/terraform/aws/iam-policy) @@ -102,4 +103,4 @@ Using `terraform import`, import `aws_api_gateway_rest_api_policy` using the RES % terraform import aws_api_gateway_rest_api_policy.example 12345abcde ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/api_gateway_rest_api_put.markdown b/website/docs/cdktf/python/r/api_gateway_rest_api_put.markdown index 44110258bd50..1e39f6fa59e8 100644 --- a/website/docs/cdktf/python/r/api_gateway_rest_api_put.markdown +++ b/website/docs/cdktf/python/r/api_gateway_rest_api_put.markdown @@ -144,13 +144,15 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `body` - (Required) PUT request body containing external API definitions. Currently, only OpenAPI definition JSON/YAML files are supported. The maximum size of the API definition file is 6MB. * `rest_api_id` - (Required) Identifier of the associated REST API. The following arguments are optional: +* `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). * `fail_on_warnings` - (Optional) Whether to rollback the API update when a warning is encountered. The default value is `false`. * `parameters` - (Optional) Map of customizations for importing the specification in the `body` argument. For example, to exclude DocumentationParts from an imported API, use `ignore = "documentation"`. Additional documentation, including other parameters such as `basepath`, can be found in the [API Gateway Developer Guide](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-import-api.html). * `triggers` - (Optional) Map of arbitrary keys and values that, when changed, will trigger a redeployment. To force a redeployment without changing these keys/values, use the [`-replace` option](https://developer.hashicorp.com/terraform/cli/commands/plan#replace-address) with `terraform plan` or `terraform apply`. @@ -190,4 +192,4 @@ Using `terraform import`, import API Gateway REST API Put using the `rest_api_id % terraform import aws_api_gateway_rest_api_put.example import-id-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/api_gateway_stage.html.markdown b/website/docs/cdktf/python/r/api_gateway_stage.html.markdown index 86c2164ac961..7805db66e523 100644 --- a/website/docs/cdktf/python/r/api_gateway_stage.html.markdown +++ b/website/docs/cdktf/python/r/api_gateway_stage.html.markdown @@ -120,6 +120,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `rest_api_id` - (Required) ID of the associated REST API * `stage_name` - (Required) Name of the stage * `deployment_id` - (Required) ID of the deployment that the stage points to @@ -129,8 +130,8 @@ This resource supports the following arguments: * `canary_settings` - (Optional) Configuration settings of a canary deployment. See [Canary Settings](#canary-settings) below. * `client_certificate_id` - (Optional) Identifier of a client certificate for the stage. * `description` - (Optional) Description of the stage. -* `documentation_version` - (Optional) Version of the associated API documentation -* `variables` - (Optional) Map that defines the stage variables +* `documentation_version` - (Optional) Version of the associated API documentation. +* `variables` - (Optional) Map that defines the stage variables. * `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. * `xray_tracing_enabled` - (Optional) Whether active tracing with X-ray is enabled. Defaults to `false`. @@ -186,4 +187,4 @@ Using `terraform import`, import `aws_api_gateway_stage` using `REST-API-ID/STAG % terraform import aws_api_gateway_stage.example 12345abcde/example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/api_gateway_usage_plan.html.markdown b/website/docs/cdktf/python/r/api_gateway_usage_plan.html.markdown index 01848f3fe834..4dd01ca707b8 100644 --- a/website/docs/cdktf/python/r/api_gateway_usage_plan.html.markdown +++ b/website/docs/cdktf/python/r/api_gateway_usage_plan.html.markdown @@ -95,6 +95,7 @@ resource "aws_api_gateway_usage_plan" "example" { This resource supports the following arguments: +* `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). * `name` - (Required) Name of the usage plan. * `description` - (Optional) Description of a usage plan. * `api_stages` - (Optional) Associated [API stages](#api-stages-arguments) of the usage plan. @@ -165,4 +166,4 @@ Using `terraform import`, import AWS API Gateway Usage Plan using the `id`. For % terraform import aws_api_gateway_usage_plan.myusageplan ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/api_gateway_usage_plan_key.html.markdown b/website/docs/cdktf/python/r/api_gateway_usage_plan_key.html.markdown index 79a5b2358751..86c9d8dcb643 100644 --- a/website/docs/cdktf/python/r/api_gateway_usage_plan_key.html.markdown +++ b/website/docs/cdktf/python/r/api_gateway_usage_plan_key.html.markdown @@ -54,6 +54,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `key_id` - (Required) Identifier of the API key resource. * `key_type` - (Required) Type of the API key resource. Currently, the valid key type is API_KEY. * `usage_plan_id` - (Required) Id of the usage plan resource representing to associate the key to. @@ -94,4 +95,4 @@ Using `terraform import`, import AWS API Gateway Usage Plan Key using the `USAGE % terraform import aws_api_gateway_usage_plan_key.key 12345abcde/zzz ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/api_gateway_vpc_link.html.markdown b/website/docs/cdktf/python/r/api_gateway_vpc_link.html.markdown index 49a8838b13dd..8ce2b87097fc 100644 --- a/website/docs/cdktf/python/r/api_gateway_vpc_link.html.markdown +++ b/website/docs/cdktf/python/r/api_gateway_vpc_link.html.markdown @@ -52,6 +52,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) Name used to label and identify the VPC link. * `description` - (Optional) Description of the VPC link. * `target_arns` - (Required, ForceNew) List of network load balancer arns in the VPC targeted by the VPC link. Currently AWS only supports 1 target. @@ -89,4 +90,4 @@ Using `terraform import`, import API Gateway VPC Link using the `id`. For exampl % terraform import aws_api_gateway_vpc_link.example 12345abcde ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/apigatewayv2_api.html.markdown b/website/docs/cdktf/python/r/apigatewayv2_api.html.markdown index 1787c2273a6a..e895804d1ffe 100644 --- a/website/docs/cdktf/python/r/apigatewayv2_api.html.markdown +++ b/website/docs/cdktf/python/r/apigatewayv2_api.html.markdown @@ -61,6 +61,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) Name of the API. Must be less than or equal to 128 characters in length. * `protocol_type` - (Required) API protocol. Valid values: `HTTP`, `WEBSOCKET`. * `api_key_selection_expression` - (Optional) An [API key selection expression](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions). @@ -137,4 +138,4 @@ Using `terraform import`, import `aws_apigatewayv2_api` using the API identifier % terraform import aws_apigatewayv2_api.example aabbccddee ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/apigatewayv2_api_mapping.html.markdown b/website/docs/cdktf/python/r/apigatewayv2_api_mapping.html.markdown index 561fbb548c39..31fe7f9a39b6 100644 --- a/website/docs/cdktf/python/r/apigatewayv2_api_mapping.html.markdown +++ b/website/docs/cdktf/python/r/apigatewayv2_api_mapping.html.markdown @@ -40,6 +40,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `api_id` - (Required) API identifier. * `domain_name` - (Required) Domain name. Use the [`aws_apigatewayv2_domain_name`](/docs/providers/aws/r/apigatewayv2_domain_name.html) resource to configure a domain name. * `stage` - (Required) API stage. Use the [`aws_apigatewayv2_stage`](/docs/providers/aws/r/apigatewayv2_stage.html) resource to configure an API stage. @@ -76,4 +77,4 @@ Using `terraform import`, import `aws_apigatewayv2_api_mapping` using the API ma % terraform import aws_apigatewayv2_api_mapping.example 1122334/ws-api.example.com ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/apigatewayv2_authorizer.html.markdown b/website/docs/cdktf/python/r/apigatewayv2_authorizer.html.markdown index 9e548d11f18a..bc1994d41983 100644 --- a/website/docs/cdktf/python/r/apigatewayv2_authorizer.html.markdown +++ b/website/docs/cdktf/python/r/apigatewayv2_authorizer.html.markdown @@ -66,6 +66,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `api_id` - (Required) API identifier. * `authorizer_type` - (Required) Authorizer type. Valid values: `JWT`, `REQUEST`. Specify `REQUEST` for a Lambda function using incoming request parameters. @@ -131,4 +132,4 @@ Using `terraform import`, import `aws_apigatewayv2_authorizer` using the API ide % terraform import aws_apigatewayv2_authorizer.example aabbccddee/1122334 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/apigatewayv2_deployment.html.markdown b/website/docs/cdktf/python/r/apigatewayv2_deployment.html.markdown index 3844bab60dc1..85212da811a3 100644 --- a/website/docs/cdktf/python/r/apigatewayv2_deployment.html.markdown +++ b/website/docs/cdktf/python/r/apigatewayv2_deployment.html.markdown @@ -84,6 +84,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `api_id` - (Required) API identifier. * `description` - (Optional) Description for the deployment resource. Must be less than or equal to 1024 characters in length. * `triggers` - (Optional) Map of arbitrary keys and values that, when changed, will trigger a redeployment. To force a redeployment without changing these keys/values, use the [`terraform taint` command](https://www.terraform.io/docs/commands/taint.html). @@ -122,4 +123,4 @@ Using `terraform import`, import `aws_apigatewayv2_deployment` using the API ide The `triggers` argument cannot be imported. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/apigatewayv2_domain_name.html.markdown b/website/docs/cdktf/python/r/apigatewayv2_domain_name.html.markdown index 93a536a4ea1e..6df3169eda9a 100644 --- a/website/docs/cdktf/python/r/apigatewayv2_domain_name.html.markdown +++ b/website/docs/cdktf/python/r/apigatewayv2_domain_name.html.markdown @@ -87,6 +87,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `domain_name` - (Required) Domain name. Must be between 1 and 512 characters in length. * `domain_name_configuration` - (Required) Domain name configuration. See below. * `mutual_tls_authentication` - (Optional) Mutual TLS authentication configuration for the domain name. @@ -148,4 +149,4 @@ Using `terraform import`, import `aws_apigatewayv2_domain_name` using the domain % terraform import aws_apigatewayv2_domain_name.example ws-api.example.com ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/apigatewayv2_integration.html.markdown b/website/docs/cdktf/python/r/apigatewayv2_integration.html.markdown index 317368ff0303..15ff78ac3de9 100644 --- a/website/docs/cdktf/python/r/apigatewayv2_integration.html.markdown +++ b/website/docs/cdktf/python/r/apigatewayv2_integration.html.markdown @@ -147,6 +147,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `api_id` - (Required) API identifier. * `integration_type` - (Required) Integration type of an integration. Valid values: `AWS` (supported only for WebSocket APIs), `AWS_PROXY`, `HTTP` (supported only for WebSocket APIs), `HTTP_PROXY`, `MOCK` (supported only for WebSocket APIs). For an HTTP API private integration, use `HTTP_PROXY`. @@ -218,4 +219,4 @@ Using `terraform import`, import `aws_apigatewayv2_integration` using the API id -> **Note:** The API Gateway managed integration created as part of [_quick_create_](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-basic-concept.html#apigateway-definition-quick-create) cannot be imported. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/apigatewayv2_integration_response.html.markdown b/website/docs/cdktf/python/r/apigatewayv2_integration_response.html.markdown index d146ac3ae21a..126d9102a379 100644 --- a/website/docs/cdktf/python/r/apigatewayv2_integration_response.html.markdown +++ b/website/docs/cdktf/python/r/apigatewayv2_integration_response.html.markdown @@ -40,6 +40,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `api_id` - (Required) API identifier. * `integration_id` - (Required) Identifier of the [`aws_apigatewayv2_integration`](/docs/providers/aws/r/apigatewayv2_integration.html). * `integration_response_key` - (Required) Integration response key. @@ -78,4 +79,4 @@ Using `terraform import`, import `aws_apigatewayv2_integration_response` using t % terraform import aws_apigatewayv2_integration_response.example aabbccddee/1122334/998877 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/apigatewayv2_model.html.markdown b/website/docs/cdktf/python/r/apigatewayv2_model.html.markdown index 2c26befea7e5..15faec4d81ed 100644 --- a/website/docs/cdktf/python/r/apigatewayv2_model.html.markdown +++ b/website/docs/cdktf/python/r/apigatewayv2_model.html.markdown @@ -50,6 +50,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `api_id` - (Required) API identifier. * `content_type` - (Required) The content-type for the model, for example, `application/json`. Must be between 1 and 256 characters in length. * `name` - (Required) Name of the model. Must be alphanumeric. Must be between 1 and 128 characters in length. @@ -87,4 +88,4 @@ Using `terraform import`, import `aws_apigatewayv2_model` using the API identifi % terraform import aws_apigatewayv2_model.example aabbccddee/1122334 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/apigatewayv2_route.html.markdown b/website/docs/cdktf/python/r/apigatewayv2_route.html.markdown index 0f75806b978b..2c2b40782082 100644 --- a/website/docs/cdktf/python/r/apigatewayv2_route.html.markdown +++ b/website/docs/cdktf/python/r/apigatewayv2_route.html.markdown @@ -84,6 +84,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `api_id` - (Required) API identifier. * `route_key` - (Required) Route key for the route. For HTTP APIs, the route key can be either `$default`, or a combination of an HTTP method and resource path, for example, `GET /pets`. * `api_key_required` - (Optional) Boolean whether an API key is required for the route. Defaults to `false`. Supported only for WebSocket APIs. @@ -138,4 +139,4 @@ Using `terraform import`, import `aws_apigatewayv2_route` using the API identifi -> **Note:** The API Gateway managed route created as part of [_quick_create_](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-basic-concept.html#apigateway-definition-quick-create) cannot be imported. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/apigatewayv2_route_response.html.markdown b/website/docs/cdktf/python/r/apigatewayv2_route_response.html.markdown index 7c481acef797..d3067b0fdbb1 100644 --- a/website/docs/cdktf/python/r/apigatewayv2_route_response.html.markdown +++ b/website/docs/cdktf/python/r/apigatewayv2_route_response.html.markdown @@ -46,6 +46,7 @@ You can only define the $default route response for WebSocket APIs. You can use This resource supports the following arguments: +* `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). * `api_id` - (Required) API identifier. * `route_id` - (Required) Identifier of the [`aws_apigatewayv2_route`](/docs/providers/aws/r/apigatewayv2_route.html). * `route_response_key` - (Required) Route response key. @@ -83,4 +84,4 @@ Using `terraform import`, import `aws_apigatewayv2_route_response` using the API % terraform import aws_apigatewayv2_route_response.example aabbccddee/1122334/998877 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/apigatewayv2_stage.html.markdown b/website/docs/cdktf/python/r/apigatewayv2_stage.html.markdown index 589c3f947e9d..c70fae460aff 100644 --- a/website/docs/cdktf/python/r/apigatewayv2_stage.html.markdown +++ b/website/docs/cdktf/python/r/apigatewayv2_stage.html.markdown @@ -44,6 +44,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `access_log_settings` - (Optional) Settings for logging access in this stage. Use the [`aws_api_gateway_account`](/docs/providers/aws/r/api_gateway_account.html) resource to configure [permissions for CloudWatch Logging](https://docs.aws.amazon.com/apigateway/latest/developerguide/set-up-logging.html#set-up-access-logging-permissions). * `auto_deploy` - (Optional) Whether updates to an API automatically trigger a new deployment. Defaults to `false`. Applicable for HTTP APIs. @@ -122,4 +123,4 @@ Using `terraform import`, import `aws_apigatewayv2_stage` using the API identifi -> **Note:** The API Gateway managed stage created as part of [_quick_create_](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-basic-concept.html#apigateway-definition-quick-create) cannot be imported. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/apigatewayv2_vpc_link.html.markdown b/website/docs/cdktf/python/r/apigatewayv2_vpc_link.html.markdown index c314aae90920..d47c4809ebba 100644 --- a/website/docs/cdktf/python/r/apigatewayv2_vpc_link.html.markdown +++ b/website/docs/cdktf/python/r/apigatewayv2_vpc_link.html.markdown @@ -43,6 +43,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) Name of the VPC Link. Must be between 1 and 128 characters in length. * `security_group_ids` - (Required) Security group IDs for the VPC Link. * `subnet_ids` - (Required) Subnet IDs for the VPC Link. @@ -81,4 +82,4 @@ Using `terraform import`, import `aws_apigatewayv2_vpc_link` using the VPC Link % terraform import aws_apigatewayv2_vpc_link.example aabbccddee ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/app_cookie_stickiness_policy.html.markdown b/website/docs/cdktf/python/r/app_cookie_stickiness_policy.html.markdown index bfa97e5e4e03..e0b6782faa00 100644 --- a/website/docs/cdktf/python/r/app_cookie_stickiness_policy.html.markdown +++ b/website/docs/cdktf/python/r/app_cookie_stickiness_policy.html.markdown @@ -50,6 +50,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) Name of the stickiness policy. * `load_balancer` - (Required) Name of load balancer to which the policy should be attached. @@ -93,4 +94,4 @@ Using `terraform import`, import application cookie stickiness policies using th % terraform import aws_app_cookie_stickiness_policy.example my-elb:80:my-policy ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/appautoscaling_policy.html.markdown b/website/docs/cdktf/python/r/appautoscaling_policy.html.markdown index 4c86e5fb2f58..9f3610821c43 100644 --- a/website/docs/cdktf/python/r/appautoscaling_policy.html.markdown +++ b/website/docs/cdktf/python/r/appautoscaling_policy.html.markdown @@ -241,6 +241,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) Name of the policy. Must be between 1 and 255 characters in length. * `policy_type` - (Optional) Policy type. Valid values are `StepScaling` and `TargetTrackingScaling`. Defaults to `StepScaling`. Certain services only support only one policy type. For more information see the [Target Tracking Scaling Policies](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-target-tracking.html) and [Step Scaling Policies](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-step-scaling-policies.html) documentation. * `resource_id` - (Required) Resource type and unique identifier string for the resource associated with the scaling policy. Documentation can be found in the `ResourceId` parameter at: [AWS Application Auto Scaling API Reference](https://docs.aws.amazon.com/autoscaling/application/APIReference/API_RegisterScalableTarget.html) @@ -435,4 +436,4 @@ Using `terraform import`, import Application AutoScaling Policy using the `servi % terraform import aws_appautoscaling_policy.test-policy service-namespace/resource-id/scalable-dimension/policy-name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/appautoscaling_scheduled_action.html.markdown b/website/docs/cdktf/python/r/appautoscaling_scheduled_action.html.markdown index 11a910626d4b..48b0e1aadbfe 100644 --- a/website/docs/cdktf/python/r/appautoscaling_scheduled_action.html.markdown +++ b/website/docs/cdktf/python/r/appautoscaling_scheduled_action.html.markdown @@ -94,6 +94,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) Name of the scheduled action. * `service_namespace` - (Required) Namespace of the AWS service. Documentation can be found in the `ServiceNamespace` parameter at: [AWS Application Auto Scaling API Reference](https://docs.aws.amazon.com/autoscaling/application/APIReference/API_PutScheduledAction.html) Example: ecs * `resource_id` - (Required) Identifier of the resource associated with the scheduled action. Documentation can be found in the `ResourceId` parameter at: [AWS Application Auto Scaling API Reference](https://docs.aws.amazon.com/autoscaling/application/APIReference/API_PutScheduledAction.html) @@ -115,4 +116,4 @@ This resource exports the following attributes in addition to the arguments abov * `arn` - ARN of the scheduled action. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/appautoscaling_target.html.markdown b/website/docs/cdktf/python/r/appautoscaling_target.html.markdown index e1e894c99011..52362d742999 100644 --- a/website/docs/cdktf/python/r/appautoscaling_target.html.markdown +++ b/website/docs/cdktf/python/r/appautoscaling_target.html.markdown @@ -141,6 +141,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `max_capacity` - (Required) Max capacity of the scalable target. * `min_capacity` - (Required) Min capacity of the scalable target. * `resource_id` - (Required) Resource type and unique identifier string for the resource associated with the scaling policy. Documentation can be found in the `ResourceId` parameter at: [AWS Application Auto Scaling API Reference](https://docs.aws.amazon.com/autoscaling/application/APIReference/API_RegisterScalableTarget.html#API_RegisterScalableTarget_RequestParameters) @@ -190,4 +191,4 @@ Using `terraform import`, import Application AutoScaling Target using the `servi % terraform import aws_appautoscaling_target.test-target service-namespace/resource-id/scalable-dimension ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/appconfig_application.html.markdown b/website/docs/cdktf/python/r/appconfig_application.html.markdown index 22d0d5542b5a..20a98bf3bb56 100644 --- a/website/docs/cdktf/python/r/appconfig_application.html.markdown +++ b/website/docs/cdktf/python/r/appconfig_application.html.markdown @@ -39,6 +39,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) Name for the application. Must be between 1 and 64 characters in length. * `description` - (Optional) Description of the application. Can be at most 1024 characters. * `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. @@ -76,4 +77,4 @@ Using `terraform import`, import AppConfig Applications using their application % terraform import aws_appconfig_application.example 71rxuzt ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/appconfig_configuration_profile.html.markdown b/website/docs/cdktf/python/r/appconfig_configuration_profile.html.markdown index b44a0bab9444..c2cf8f5c78ca 100644 --- a/website/docs/cdktf/python/r/appconfig_configuration_profile.html.markdown +++ b/website/docs/cdktf/python/r/appconfig_configuration_profile.html.markdown @@ -46,6 +46,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `application_id` - (Required, Forces new resource) Application ID. Must be between 4 and 7 characters in length. * `location_uri` - (Required, Forces new resource) URI to locate the configuration. You can specify the AWS AppConfig hosted configuration store, Systems Manager (SSM) document, an SSM Parameter Store parameter, or an Amazon S3 object. For the hosted configuration store, specify `hosted`. For an SSM document, specify either the document name in the format `ssm-document://` or the ARN. For a parameter, specify either the parameter name in the format `ssm-parameter://` or the ARN. For an Amazon S3 object, specify the URI in the following format: `s3:///`. * `name` - (Required) Name for the configuration profile. Must be between 1 and 128 characters in length. @@ -97,4 +98,4 @@ Using `terraform import`, import AppConfig Configuration Profiles using the conf % terraform import aws_appconfig_configuration_profile.example 71abcde:11xxxxx ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/appconfig_deployment.html.markdown b/website/docs/cdktf/python/r/appconfig_deployment.html.markdown index a01e283c2241..60268bb8a1f9 100644 --- a/website/docs/cdktf/python/r/appconfig_deployment.html.markdown +++ b/website/docs/cdktf/python/r/appconfig_deployment.html.markdown @@ -44,6 +44,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `application_id` - (Required, Forces new resource) Application ID. Must be between 4 and 7 characters in length. * `configuration_profile_id` - (Required, Forces new resource) Configuration profile ID. Must be between 4 and 7 characters in length. * `configuration_version` - (Required, Forces new resource) Configuration version to deploy. Can be at most 1024 characters. @@ -89,4 +90,4 @@ Using `terraform import`, import AppConfig Deployments using the application ID, % terraform import aws_appconfig_deployment.example 71abcde/11xxxxx/1 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/appconfig_deployment_strategy.html.markdown b/website/docs/cdktf/python/r/appconfig_deployment_strategy.html.markdown index 20221d8bdb99..6e7456fa0dbe 100644 --- a/website/docs/cdktf/python/r/appconfig_deployment_strategy.html.markdown +++ b/website/docs/cdktf/python/r/appconfig_deployment_strategy.html.markdown @@ -44,6 +44,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `deployment_duration_in_minutes` - (Required) Total amount of time for a deployment to last. Minimum value of 0, maximum value of 1440. * `growth_factor` - (Required) Percentage of targets to receive a deployed configuration during each interval. Minimum value of 1.0, maximum value of 100.0. * `name` - (Required, Forces new resource) Name for the deployment strategy. Must be between 1 and 64 characters in length. @@ -86,4 +87,4 @@ Using `terraform import`, import AppConfig Deployment Strategies using their dep % terraform import aws_appconfig_deployment_strategy.example 11xxxxx ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/appconfig_environment.html.markdown b/website/docs/cdktf/python/r/appconfig_environment.html.markdown index b7130b489adf..cf60d6a7ebb9 100644 --- a/website/docs/cdktf/python/r/appconfig_environment.html.markdown +++ b/website/docs/cdktf/python/r/appconfig_environment.html.markdown @@ -55,6 +55,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `application_id` - (Required, Forces new resource) AppConfig application ID. Must be between 4 and 7 characters in length. * `name` - (Required) Name for the environment. Must be between 1 and 64 characters in length. * `description` - (Optional) Description of the environment. Can be at most 1024 characters. @@ -104,4 +105,4 @@ Using `terraform import`, import AppConfig Environments using the environment ID % terraform import aws_appconfig_environment.example 71abcde:11xxxxx ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/appconfig_extension.html.markdown b/website/docs/cdktf/python/r/appconfig_extension.html.markdown index 94f3dce01f0e..ca700746a0d5 100644 --- a/website/docs/cdktf/python/r/appconfig_extension.html.markdown +++ b/website/docs/cdktf/python/r/appconfig_extension.html.markdown @@ -76,6 +76,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) A name for the extension. Each extension name in your account must be unique. Extension versions use the same name. * `description` - (Optional) Information about the extension. * `action_point` - (Required) The action points defined in the extension. [Detailed below](#action_point). @@ -139,4 +140,4 @@ Using `terraform import`, import AppConfig Extensions using their extension ID. % terraform import aws_appconfig_extension.example 71rxuzt ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/appconfig_extension_association.html.markdown b/website/docs/cdktf/python/r/appconfig_extension_association.html.markdown index 26e0696df111..302a513c25a7 100644 --- a/website/docs/cdktf/python/r/appconfig_extension_association.html.markdown +++ b/website/docs/cdktf/python/r/appconfig_extension_association.html.markdown @@ -90,6 +90,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `extension_arn` - (Required) The ARN of the extension defined in the association. * `resource_arn` - (Optional) The ARN of the application, configuration profile, or environment to associate with the extension. * `parameters` - (Optional) The parameter names and values defined for the association. @@ -127,4 +128,4 @@ Using `terraform import`, import AppConfig Extension Associations using their ex % terraform import aws_appconfig_extension_association.example 71rxuzt ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/appconfig_hosted_configuration_version.html.markdown b/website/docs/cdktf/python/r/appconfig_hosted_configuration_version.html.markdown index ca97fa3ef4d6..af1aef0d4d4f 100644 --- a/website/docs/cdktf/python/r/appconfig_hosted_configuration_version.html.markdown +++ b/website/docs/cdktf/python/r/appconfig_hosted_configuration_version.html.markdown @@ -107,6 +107,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `application_id` - (Required, Forces new resource) Application ID. * `configuration_profile_id` - (Required, Forces new resource) Configuration profile ID. * `content` - (Required, Forces new resource) Content of the configuration or the configuration data. @@ -146,4 +147,4 @@ Using `terraform import`, import AppConfig Hosted Configuration Versions using t % terraform import aws_appconfig_hosted_configuration_version.example 71abcde/11xxxxx/2 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/appfabric_app_authorization.html.markdown b/website/docs/cdktf/python/r/appfabric_app_authorization.html.markdown index dada575b20e5..97b5a95a20bf 100644 --- a/website/docs/cdktf/python/r/appfabric_app_authorization.html.markdown +++ b/website/docs/cdktf/python/r/appfabric_app_authorization.html.markdown @@ -51,6 +51,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `app` - (Required) The name of the application for valid values see https://docs.aws.amazon.com/appfabric/latest/api/API_CreateAppAuthorization.html. * `app_bundle_arn` - (Required) The Amazon Resource Name (ARN) of the app bundle to use for the request. * `auth_type` - (Required) The authorization type for the app authorization valid values are oauth2 and apiKey. @@ -93,4 +94,4 @@ This resource exports the following attributes in addition to the arguments abov * `update` - (Default `30m`) * `delete` - (Default `30m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/appfabric_app_authorization_connection.html.markdown b/website/docs/cdktf/python/r/appfabric_app_authorization_connection.html.markdown index 7b5968075ccb..5a8e03d0569b 100644 --- a/website/docs/cdktf/python/r/appfabric_app_authorization_connection.html.markdown +++ b/website/docs/cdktf/python/r/appfabric_app_authorization_connection.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `app_bundle_arn` - (Required) The Amazon Resource Name (ARN) of the app bundle to use for the request. * `app_authorization_arn` - (Required) The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app authorization to use for the request. * `auth_request` - (Optional) Contains OAuth2 authorization information.This is required if the app authorization for the request is configured with an OAuth2 (oauth2) authorization type. @@ -60,4 +61,4 @@ This resource exports the following attributes in addition to the arguments abov * `create` - (Default `30m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/appfabric_app_bundle.html.markdown b/website/docs/cdktf/python/r/appfabric_app_bundle.html.markdown index 0cdeee527c28..72669cc967ea 100644 --- a/website/docs/cdktf/python/r/appfabric_app_bundle.html.markdown +++ b/website/docs/cdktf/python/r/appfabric_app_bundle.html.markdown @@ -40,6 +40,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `customer_managed_key_arn` - (Optional) The Amazon Resource Name (ARN) of the AWS Key Management Service (AWS KMS) key to use to encrypt the application data. If this is not specified, an AWS owned key is used for encryption. * `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. @@ -75,4 +76,4 @@ Using `terraform import`, import AppFabric AppBundle using the `arn`. For exampl % terraform import aws_appfabric_app_bundle.example arn:aws:appfabric:[region]:[account]:appbundle/ee5587b4-5765-4288-a202-xxxxxxxxxx ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/appfabric_ingestion.html.markdown b/website/docs/cdktf/python/r/appfabric_ingestion.html.markdown index 3228b00fd384..a5013a89a723 100644 --- a/website/docs/cdktf/python/r/appfabric_ingestion.html.markdown +++ b/website/docs/cdktf/python/r/appfabric_ingestion.html.markdown @@ -43,6 +43,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `app` - (Required) Name of the application. Refer to the AWS Documentation for the [list of valid values](https://docs.aws.amazon.com/appfabric/latest/api/API_CreateIngestion.html#appfabric-CreateIngestion-request-app) * `app_bundle_arn` - (Required) Amazon Resource Name (ARN) of the app bundle to use for the request. @@ -82,4 +83,4 @@ Using `terraform import`, import AppFabric Ingestion using the `app_bundle_ident % terraform import aws_appfabric_ingestion.example arn:aws:appfabric:[region]:[account]:appbundle/a9b91477-8831-43c0-970c-xxxxxxxxxx,arn:aws:appfabric:[region]:[account]:appbundle/a9b91477-8831-43c0-970c-xxxxxxxxxx/ingestion/32251416-710b-4425-96ca-xxxxxxxxxx ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/appfabric_ingestion_destination.html.markdown b/website/docs/cdktf/python/r/appfabric_ingestion_destination.html.markdown index a16df580724f..161b7bc7a125 100644 --- a/website/docs/cdktf/python/r/appfabric_ingestion_destination.html.markdown +++ b/website/docs/cdktf/python/r/appfabric_ingestion_destination.html.markdown @@ -59,6 +59,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `app_bundle_arn` - (Required) The Amazon Resource Name (ARN) of the app bundle to use for the request. * `ingestion_arn` - (Required) The Amazon Resource Name (ARN) of the ingestion to use for the request. * `destination_configuration` - (Required) Contains information about the destination of ingested data. @@ -111,4 +112,4 @@ This resource exports the following attributes in addition to the arguments abov * `update` - (Default `5m`) * `delete` - (Default `5m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/appflow_connector_profile.html.markdown b/website/docs/cdktf/python/r/appflow_connector_profile.html.markdown index d414f0e8b965..d21ffa3059e2 100644 --- a/website/docs/cdktf/python/r/appflow_connector_profile.html.markdown +++ b/website/docs/cdktf/python/r/appflow_connector_profile.html.markdown @@ -99,6 +99,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name ` (Required) - Name of the connector profile. The name is unique for each `ConnectorProfile` in your AWS account. * `connection_mode` (Required) - Indicates the connection mode and specifies whether it is public or private. Private flows use AWS PrivateLink to route data over AWS infrastructure without exposing it to the public internet. One of: `Public`, `Private`. * `connector_label` (Optional) - The label of the connector. The label is unique for each ConnectorRegistration in your AWS account. Only needed if calling for `CustomConnector` connector type. @@ -339,7 +340,7 @@ This resource exports the following attributes in addition to the arguments abov ## Import -In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import AppFlow Connector Profile using the connector profile `arn`. For example: +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import AppFlow Connector Profile using the connector profile `name`. For example: ```python # DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -353,16 +354,16 @@ from imports.aws.appflow_connector_profile import AppflowConnectorProfile class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) - AppflowConnectorProfile.generate_config_for_import(self, "profile", "arn:aws:appflow:us-west-2:123456789012:connectorprofile/example-profile") + AppflowConnectorProfile.generate_config_for_import(self, "example", "example-profile") ``` -Using `terraform import`, import AppFlow Connector Profile using the connector profile `arn`. For example: +Using `terraform import`, import AppFlow Connector Profile using the connector profile `name`. For example: ```console -% terraform import aws_appflow_connector_profile.profile arn:aws:appflow:us-west-2:123456789012:connectorprofile/example-profile +% terraform import aws_appflow_connector_profile.example example-profile ``` [1]: https://docs.aws.amazon.com/appflow/1.0/APIReference/Welcome.html [2]: https://docs.aws.amazon.com/appflow/1.0/APIReference/API_CreateConnectorProfile.html - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/appflow_flow.html.markdown b/website/docs/cdktf/python/r/appflow_flow.html.markdown index a426dc14b145..1cad26308088 100644 --- a/website/docs/cdktf/python/r/appflow_flow.html.markdown +++ b/website/docs/cdktf/python/r/appflow_flow.html.markdown @@ -136,6 +136,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) Name of the flow. * `destination_flow_config` - (Required) A [Destination Flow Config](#destination-flow-config) that controls how Amazon AppFlow places data in the destination connector. * `source_flow_config` - (Required) The [Source Flow Config](#source-flow-config) that controls how Amazon AppFlow retrieves data from the source connector. @@ -435,7 +436,7 @@ This resource exports the following attributes in addition to the arguments abov ## Import -In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import AppFlow flows using the `arn`. For example: +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import AppFlow flows using the `name`. For example: ```python # DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -449,13 +450,13 @@ from imports.aws.appflow_flow import AppflowFlow class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) - AppflowFlow.generate_config_for_import(self, "example", "arn:aws:appflow:us-west-2:123456789012:flow/example-flow") + AppflowFlow.generate_config_for_import(self, "example", "example-flow") ``` -Using `terraform import`, import AppFlow flows using the `arn`. For example: +Using `terraform import`, import AppFlow flows using the `name`. For example: ```console -% terraform import aws_appflow_flow.example arn:aws:appflow:us-west-2:123456789012:flow/example-flow +% terraform import aws_appflow_flow.example example-flow ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/appintegrations_data_integration.html.markdown b/website/docs/cdktf/python/r/appintegrations_data_integration.html.markdown index 37153fe18486..c9db9ae3de48 100644 --- a/website/docs/cdktf/python/r/appintegrations_data_integration.html.markdown +++ b/website/docs/cdktf/python/r/appintegrations_data_integration.html.markdown @@ -46,6 +46,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `description` - (Optional) Specifies the description of the Data Integration. * `kms_key` - (Required) Specifies the KMS key Amazon Resource Name (ARN) for the Data Integration. * `name` - (Required) Specifies the name of the Data Integration. @@ -92,4 +93,4 @@ Using `terraform import`, import Amazon AppIntegrations Data Integrations using % terraform import aws_appintegrations_data_integration.example 12345678-1234-1234-1234-123456789123 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/appintegrations_event_integration.html.markdown b/website/docs/cdktf/python/r/appintegrations_event_integration.html.markdown index 1f0eeb211788..d79f4fa78448 100644 --- a/website/docs/cdktf/python/r/appintegrations_event_integration.html.markdown +++ b/website/docs/cdktf/python/r/appintegrations_event_integration.html.markdown @@ -43,6 +43,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `description` - (Optional) Description of the Event Integration. * `eventbridge_bus` - (Required) EventBridge bus. * `event_filter` - (Required) Block that defines the configuration information for the event filter. The Event Filter block is documented below. @@ -86,4 +87,4 @@ Using `terraform import`, import Amazon AppIntegrations Event Integrations using % terraform import aws_appintegrations_event_integration.example example-name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/applicationinsights_application.html.markdown b/website/docs/cdktf/python/r/applicationinsights_application.html.markdown index 714f4ca2a243..a64b186c46e5 100644 --- a/website/docs/cdktf/python/r/applicationinsights_application.html.markdown +++ b/website/docs/cdktf/python/r/applicationinsights_application.html.markdown @@ -57,6 +57,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `auto_config_enabled` - (Optional) Indicates whether Application Insights automatically configures unmonitored resources in the resource group. * `auto_create` - (Optional) Configures all of the resources in the resource group by applying the recommended configurations. * `cwe_monitor_enabled` - (Optional) Indicates whether Application Insights can listen to CloudWatch events for the application resources, such as instance terminated, failed deployment, and others. @@ -98,4 +99,4 @@ Using `terraform import`, import ApplicationInsights Applications using the `res % terraform import aws_applicationinsights_application.some some-application ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/appmesh_gateway_route.html.markdown b/website/docs/cdktf/python/r/appmesh_gateway_route.html.markdown index 3df90a88d863..1fc54fafa55c 100644 --- a/website/docs/cdktf/python/r/appmesh_gateway_route.html.markdown +++ b/website/docs/cdktf/python/r/appmesh_gateway_route.html.markdown @@ -54,6 +54,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) Name to use for the gateway route. Must be between 1 and 255 characters in length. * `mesh_name` - (Required) Name of the service mesh in which to create the gateway route. Must be between 1 and 255 characters in length. * `virtual_gateway_name` - (Required) Name of the [virtual gateway](/docs/providers/aws/r/appmesh_virtual_gateway.html) to associate the gateway route with. Must be between 1 and 255 characters in length. @@ -200,4 +201,4 @@ Using `terraform import`, import App Mesh gateway routes using `mesh_name` and ` [1]: /docs/providers/aws/index.html - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/appmesh_mesh.html.markdown b/website/docs/cdktf/python/r/appmesh_mesh.html.markdown index c2bfdac4699a..a1ef67ba016f 100644 --- a/website/docs/cdktf/python/r/appmesh_mesh.html.markdown +++ b/website/docs/cdktf/python/r/appmesh_mesh.html.markdown @@ -61,6 +61,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `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. @@ -106,4 +107,4 @@ Using `terraform import`, import App Mesh service meshes using the `name`. For e % terraform import aws_appmesh_mesh.simple simpleapp ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/appmesh_route.html.markdown b/website/docs/cdktf/python/r/appmesh_route.html.markdown index 6c3af977db1b..710cdf6a7943 100644 --- a/website/docs/cdktf/python/r/appmesh_route.html.markdown +++ b/website/docs/cdktf/python/r/appmesh_route.html.markdown @@ -175,6 +175,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) Name to use for the route. Must be between 1 and 255 characters in length. * `mesh_name` - (Required) Name of the service mesh in which to create the route. Must be between 1 and 255 characters in length. * `mesh_owner` - (Optional) AWS account ID of the service mesh's owner. Defaults to the account ID the [AWS provider][1] is currently connected to. @@ -380,4 +381,4 @@ Using `terraform import`, import App Mesh virtual routes using `mesh_name` and ` [1]: /docs/providers/aws/index.html - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/appmesh_virtual_gateway.html.markdown b/website/docs/cdktf/python/r/appmesh_virtual_gateway.html.markdown index 523c1258dfd4..023f428af6b9 100644 --- a/website/docs/cdktf/python/r/appmesh_virtual_gateway.html.markdown +++ b/website/docs/cdktf/python/r/appmesh_virtual_gateway.html.markdown @@ -94,6 +94,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) Name to use for the virtual gateway. Must be between 1 and 255 characters in length. * `mesh_name` - (Required) Name of the service mesh in which to create the virtual gateway. Must be between 1 and 255 characters in length. * `mesh_owner` - (Optional) AWS account ID of the service mesh's owner. Defaults to the account ID the [AWS provider][1] is currently connected to. @@ -319,4 +320,4 @@ Using `terraform import`, import App Mesh virtual gateway using `mesh_name` toge [1]: /docs/providers/aws/index.html - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/appmesh_virtual_node.html.markdown b/website/docs/cdktf/python/r/appmesh_virtual_node.html.markdown index 89e9fdb74204..2747eaaa0bfb 100644 --- a/website/docs/cdktf/python/r/appmesh_virtual_node.html.markdown +++ b/website/docs/cdktf/python/r/appmesh_virtual_node.html.markdown @@ -212,6 +212,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) Name to use for the virtual node. Must be between 1 and 255 characters in length. * `mesh_name` - (Required) Name of the service mesh in which to create the virtual node. Must be between 1 and 255 characters in length. * `mesh_owner` - (Optional) AWS account ID of the service mesh's owner. Defaults to the account ID the [AWS provider][1] is currently connected to. @@ -522,4 +523,4 @@ Using `terraform import`, import App Mesh virtual nodes using `mesh_name` togeth [1]: /docs/providers/aws/index.html - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/appmesh_virtual_router.html.markdown b/website/docs/cdktf/python/r/appmesh_virtual_router.html.markdown index 2d0a212729a1..3b346999842d 100644 --- a/website/docs/cdktf/python/r/appmesh_virtual_router.html.markdown +++ b/website/docs/cdktf/python/r/appmesh_virtual_router.html.markdown @@ -55,6 +55,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) Name to use for the virtual router. Must be between 1 and 255 characters in length. * `mesh_name` - (Required) Name of the service mesh in which to create the virtual router. Must be between 1 and 255 characters in length. * `mesh_owner` - (Optional) AWS account ID of the service mesh's owner. Defaults to the account ID the [AWS provider][1] is currently connected to. @@ -113,4 +114,4 @@ Using `terraform import`, import App Mesh virtual routers using `mesh_name` toge [1]: /docs/providers/aws/index.html - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/appmesh_virtual_service.html.markdown b/website/docs/cdktf/python/r/appmesh_virtual_service.html.markdown index 4d36bd937642..95467864d74d 100644 --- a/website/docs/cdktf/python/r/appmesh_virtual_service.html.markdown +++ b/website/docs/cdktf/python/r/appmesh_virtual_service.html.markdown @@ -72,6 +72,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) Name to use for the virtual service. Must be between 1 and 255 characters in length. * `mesh_name` - (Required) Name of the service mesh in which to create the virtual service. Must be between 1 and 255 characters in length. * `mesh_owner` - (Optional) AWS account ID of the service mesh's owner. Defaults to the account ID the [AWS provider][1] is currently connected to. @@ -133,4 +134,4 @@ Using `terraform import`, import App Mesh virtual services using `mesh_name` tog [1]: /docs/providers/aws/index.html - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/apprunner_auto_scaling_configuration_version.html.markdown b/website/docs/cdktf/python/r/apprunner_auto_scaling_configuration_version.html.markdown index c5886b890179..be7b0b9b8725 100644 --- a/website/docs/cdktf/python/r/apprunner_auto_scaling_configuration_version.html.markdown +++ b/website/docs/cdktf/python/r/apprunner_auto_scaling_configuration_version.html.markdown @@ -41,6 +41,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `auto_scaling_configuration_name` - (Required, Forces new resource) Name of the auto scaling configuration. * `max_concurrency` - (Optional, Forces new resource) Maximal number of concurrent requests that you want an instance to process. When the number of concurrent requests goes over this limit, App Runner scales up your service. * `max_size` - (Optional, Forces new resource) Maximal number of instances that App Runner provisions for your service. @@ -82,4 +83,4 @@ Using `terraform import`, import App Runner AutoScaling Configuration Versions u % terraform import aws_apprunner_auto_scaling_configuration_version.example "arn:aws:apprunner:us-east-1:1234567890:autoscalingconfiguration/example/1/69bdfe0115224b0db49398b7beb68e0f ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/apprunner_connection.html.markdown b/website/docs/cdktf/python/r/apprunner_connection.html.markdown index cbfe99f94c71..7ae25bdbe7cf 100644 --- a/website/docs/cdktf/python/r/apprunner_connection.html.markdown +++ b/website/docs/cdktf/python/r/apprunner_connection.html.markdown @@ -41,6 +41,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `connection_name` - (Required) Name of the connection. * `provider_type` - (Required) Source repository provider. Valid values: `GITHUB`. * `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. @@ -78,4 +79,4 @@ Using `terraform import`, import App Runner Connections using the `connection_na % terraform import aws_apprunner_connection.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/apprunner_custom_domain_association.html.markdown b/website/docs/cdktf/python/r/apprunner_custom_domain_association.html.markdown index ad21b21b2a76..7c1e81aff74e 100644 --- a/website/docs/cdktf/python/r/apprunner_custom_domain_association.html.markdown +++ b/website/docs/cdktf/python/r/apprunner_custom_domain_association.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `domain_name` - (Required) Custom domain endpoint to association. Specify a base domain e.g., `example.com` or a subdomain e.g., `subdomain.example.com`. * `enable_www_subdomain` (Optional) Whether to associate the subdomain with the App Runner service in addition to the base domain. Defaults to `true`. * `service_arn` - (Required) ARN of the App Runner service. @@ -84,4 +85,4 @@ Using `terraform import`, import App Runner Custom Domain Associations using the % terraform import aws_apprunner_custom_domain_association.example example.com,arn:aws:apprunner:us-east-1:123456789012:service/example-app/8fe1e10304f84fd2b0df550fe98a71fa ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/apprunner_default_auto_scaling_configuration_version.html.markdown b/website/docs/cdktf/python/r/apprunner_default_auto_scaling_configuration_version.html.markdown index b8994c9386a6..c8a73e344abb 100644 --- a/website/docs/cdktf/python/r/apprunner_default_auto_scaling_configuration_version.html.markdown +++ b/website/docs/cdktf/python/r/apprunner_default_auto_scaling_configuration_version.html.markdown @@ -48,6 +48,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `auto_scaling_configuration_arn` - (Required) The ARN of the App Runner auto scaling configuration that you want to set as the default. ## Attribute Reference @@ -79,4 +80,4 @@ Using `terraform import`, import App Runner default auto scaling configurations % terraform import aws_apprunner_default_auto_scaling_configuration_version.example us-west-2 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/apprunner_deployment.html.markdown b/website/docs/cdktf/python/r/apprunner_deployment.html.markdown index 46151db09b1e..b9187447e26d 100644 --- a/website/docs/cdktf/python/r/apprunner_deployment.html.markdown +++ b/website/docs/cdktf/python/r/apprunner_deployment.html.markdown @@ -35,6 +35,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `service_arn` - (Required) The Amazon Resource Name (ARN) of the App Runner service to start the deployment for. ## Attribute Reference @@ -45,4 +46,4 @@ This resource exports the following attributes in addition to the arguments abov * `operation_id` - The unique ID of the operation associated with deployment. * `status` - The current status of the App Runner service deployment. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/apprunner_observability_configuration.html.markdown b/website/docs/cdktf/python/r/apprunner_observability_configuration.html.markdown index 78be9a1292ac..bc81b8299bb1 100644 --- a/website/docs/cdktf/python/r/apprunner_observability_configuration.html.markdown +++ b/website/docs/cdktf/python/r/apprunner_observability_configuration.html.markdown @@ -41,6 +41,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `observability_configuration_name` - (Required, Forces new resource) Name of the observability configuration. * `trace_configuration` - (Optional) Configuration of the tracing feature within this observability configuration. If you don't specify it, App Runner doesn't enable tracing. See [Trace Configuration](#trace-configuration) below for more details. * `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. @@ -86,4 +87,4 @@ Using `terraform import`, import App Runner Observability Configuration using th % terraform import aws_apprunner_observability_configuration.example arn:aws:apprunner:us-east-1:1234567890:observabilityconfiguration/example/1/d75bc7ea55b71e724fe5c23452fe22a1 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/apprunner_service.html.markdown b/website/docs/cdktf/python/r/apprunner_service.html.markdown index 472cfd867ead..2ecb76c60145 100644 --- a/website/docs/cdktf/python/r/apprunner_service.html.markdown +++ b/website/docs/cdktf/python/r/apprunner_service.html.markdown @@ -149,6 +149,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `auto_scaling_configuration_arn` - ARN of an App Runner automatic scaling configuration resource that you want to associate with your service. If not provided, App Runner associates the latest revision of a default auto scaling configuration. * `encryption_configuration` - (Forces new resource) An optional custom encryption key that App Runner uses to encrypt the copy of your source repository that it maintains and your service logs. By default, App Runner uses an AWS managed CMK. See [Encryption Configuration](#encryption-configuration) below for more details. * `health_check_configuration` - Settings of the health check that AWS App Runner performs to monitor the health of your service. See [Health Check Configuration](#health-check-configuration) below for more details. @@ -323,4 +324,4 @@ Using `terraform import`, import App Runner Services using the `arn`. For exampl % terraform import aws_apprunner_service.example arn:aws:apprunner:us-east-1:1234567890:service/example/0a03292a89764e5882c41d8f991c82fe ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/apprunner_vpc_connector.html.markdown b/website/docs/cdktf/python/r/apprunner_vpc_connector.html.markdown index e669d3a5d622..c3787abc1900 100644 --- a/website/docs/cdktf/python/r/apprunner_vpc_connector.html.markdown +++ b/website/docs/cdktf/python/r/apprunner_vpc_connector.html.markdown @@ -37,6 +37,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `vpc_connector_name` - (Required) Name for the VPC connector. * `subnets` (Required) List of IDs of subnets that App Runner should use when it associates your service with a custom Amazon VPC. Specify IDs of subnets of a single Amazon VPC. App Runner determines the Amazon VPC from the subnets you specify. * `security_groups` - List of IDs of security groups that App Runner should use for access to AWS resources under the specified subnets. If not specified, App Runner uses the default security group of the Amazon VPC. The default security group allows all outbound traffic. @@ -76,4 +77,4 @@ Using `terraform import`, import App Runner vpc connector using the `arn`. For e % terraform import aws_apprunner_vpc_connector.example arn:aws:apprunner:us-east-1:1234567890:vpcconnector/example/1/0a03292a89764e5882c41d8f991c82fe ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/apprunner_vpc_ingress_connection.html.markdown b/website/docs/cdktf/python/r/apprunner_vpc_ingress_connection.html.markdown index 95e031e3b0be..3cb8a406aa2c 100644 --- a/website/docs/cdktf/python/r/apprunner_vpc_ingress_connection.html.markdown +++ b/website/docs/cdktf/python/r/apprunner_vpc_ingress_connection.html.markdown @@ -43,6 +43,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) A name for the VPC Ingress Connection resource. It must be unique across all the active VPC Ingress Connections in your AWS account in the AWS Region. * `service_arn` - (Required) The Amazon Resource Name (ARN) for this App Runner service that is used to create the VPC Ingress Connection resource. * `ingress_vpc_configuration` - (Required) Specifications for the customer’s Amazon VPC and the related AWS PrivateLink VPC endpoint that are used to create the VPC Ingress Connection resource. See [Ingress VPC Configuration](#ingress-vpc-configuration) below for more details. @@ -89,4 +90,4 @@ Using `terraform import`, import App Runner VPC Ingress Connection using the `ar % terraform import aws_apprunner_vpc_ingress_connection.example "arn:aws:apprunner:us-west-2:837424938642:vpcingressconnection/example/b379f86381d74825832c2e82080342fa" ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/appstream_directory_config.html.markdown b/website/docs/cdktf/python/r/appstream_directory_config.html.markdown index 8bfe4361b100..d1390c6a9a4b 100644 --- a/website/docs/cdktf/python/r/appstream_directory_config.html.markdown +++ b/website/docs/cdktf/python/r/appstream_directory_config.html.markdown @@ -38,8 +38,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `directory_name` - (Required) Fully qualified name of the directory. * `organizational_unit_distinguished_names` - (Required) Distinguished names of the organizational units for computer accounts. * `service_account_credentials` - (Required) Configuration block for the name of the directory and organizational unit (OU) to use to join the directory config to a Microsoft Active Directory domain. See [`service_account_credentials`](#service_account_credentials) below. @@ -81,4 +82,4 @@ Using `terraform import`, import `aws_appstream_directory_config` using the id. % terraform import aws_appstream_directory_config.example directoryNameExample ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/appstream_fleet.html.markdown b/website/docs/cdktf/python/r/appstream_fleet.html.markdown index b30779614815..c36a88ac8afe 100644 --- a/website/docs/cdktf/python/r/appstream_fleet.html.markdown +++ b/website/docs/cdktf/python/r/appstream_fleet.html.markdown @@ -58,6 +58,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `description` - (Optional) Description to display. * `disconnect_timeout_in_seconds` - (Optional) Amount of time that a streaming session remains active after users disconnect. * `display_name` - (Optional) Human-readable friendly name for the AppStream fleet. @@ -132,4 +133,4 @@ Using `terraform import`, import `aws_appstream_fleet` using the id. For example % terraform import aws_appstream_fleet.example fleetNameExample ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/appstream_fleet_stack_association.html.markdown b/website/docs/cdktf/python/r/appstream_fleet_stack_association.html.markdown index 8048447f6b8d..17a9da492622 100644 --- a/website/docs/cdktf/python/r/appstream_fleet_stack_association.html.markdown +++ b/website/docs/cdktf/python/r/appstream_fleet_stack_association.html.markdown @@ -52,8 +52,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `fleet_name` - (Required) Name of the fleet. * `stack_name` (Required) Name of the stack. @@ -88,4 +89,4 @@ Using `terraform import`, import AppStream Stack Fleet Association using the `fl % terraform import aws_appstream_fleet_stack_association.example fleetName/stackName ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/appstream_image_builder.html.markdown b/website/docs/cdktf/python/r/appstream_image_builder.html.markdown index 7517b032d4ba..a1fe794ffdda 100644 --- a/website/docs/cdktf/python/r/appstream_image_builder.html.markdown +++ b/website/docs/cdktf/python/r/appstream_image_builder.html.markdown @@ -51,6 +51,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `access_endpoint` - (Optional) Set of interface VPC endpoint (interface endpoint) objects. Maximum of 4. See below. * `appstream_agent_version` - (Optional) Version of the AppStream 2.0 agent to use for this image builder. * `description` - (Optional) Description to display. @@ -119,4 +120,4 @@ Using `terraform import`, import `aws_appstream_image_builder` using the `name`. % terraform import aws_appstream_image_builder.example imageBuilderExample ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/appstream_stack.html.markdown b/website/docs/cdktf/python/r/appstream_stack.html.markdown index 36771264aee2..903d53a98585 100644 --- a/website/docs/cdktf/python/r/appstream_stack.html.markdown +++ b/website/docs/cdktf/python/r/appstream_stack.html.markdown @@ -80,6 +80,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `access_endpoints` - (Optional) Set of configuration blocks defining the interface VPC endpoints. Users of the stack can connect to AppStream 2.0 only through the specified endpoints. See [`access_endpoints`](#access_endpoints) below. * `application_settings` - (Optional) Settings for application settings persistence. @@ -162,4 +163,4 @@ Using `terraform import`, import `aws_appstream_stack` using the id. For example % terraform import aws_appstream_stack.example stackID ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/appstream_user.html.markdown b/website/docs/cdktf/python/r/appstream_user.html.markdown index 8440a67ab875..a97af3c805a5 100644 --- a/website/docs/cdktf/python/r/appstream_user.html.markdown +++ b/website/docs/cdktf/python/r/appstream_user.html.markdown @@ -43,6 +43,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `enabled` - (Optional) Whether the user in the user pool is enabled. * `first_name` - (Optional) First name, or given name, of the user. * `last_name` - (Optional) Last name, or surname, of the user. @@ -82,4 +83,4 @@ Using `terraform import`, import `aws_appstream_user` using the `user_name` and % terraform import aws_appstream_user.example UserName/AuthenticationType ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/appstream_user_stack_association.html.markdown b/website/docs/cdktf/python/r/appstream_user_stack_association.html.markdown index e4b3005678af..017bd80f2faa 100644 --- a/website/docs/cdktf/python/r/appstream_user_stack_association.html.markdown +++ b/website/docs/cdktf/python/r/appstream_user_stack_association.html.markdown @@ -57,6 +57,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `send_email_notification` - (Optional) Whether a welcome email is sent to a user after the user is created in the user pool. ## Attribute Reference @@ -90,4 +91,4 @@ Using `terraform import`, import AppStream User Stack Association using the `use % terraform import aws_appstream_user_stack_association.example userName/auhtenticationType/stackName ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/appsync_api.html.markdown b/website/docs/cdktf/python/r/appsync_api.html.markdown new file mode 100644 index 000000000000..7c24f105ceb5 --- /dev/null +++ b/website/docs/cdktf/python/r/appsync_api.html.markdown @@ -0,0 +1,254 @@ +--- +subcategory: "AppSync" +layout: "aws" +page_title: "AWS: aws_appsync_api" +description: |- + Manages an AWS AppSync Event API. +--- + + + +# Resource: aws_appsync_api + +Manages an [AWS AppSync Event API](https://docs.aws.amazon.com/appsync/latest/eventapi/event-api-concepts.html#API). Event APIs enable real-time subscriptions and event-driven communication in AppSync applications. + +## 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.appsync_api import AppsyncApi +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + AppsyncApi(self, "example", + event_config=[AppsyncApiEventConfig( + auth_provider=[AppsyncApiEventConfigAuthProvider( + auth_type="API_KEY" + ) + ], + connection_auth_mode=[AppsyncApiEventConfigConnectionAuthMode( + auth_type="API_KEY" + ) + ], + default_publish_auth_mode=[AppsyncApiEventConfigDefaultPublishAuthMode( + auth_type="API_KEY" + ) + ], + default_subscribe_auth_mode=[AppsyncApiEventConfigDefaultSubscribeAuthMode( + auth_type="API_KEY" + ) + ] + ) + ], + name="example-event-api" + ) +``` + +### With Cognito Authentication + +```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.appsync_api import AppsyncApi +from imports.aws.cognito_user_pool import CognitoUserPool +from imports.aws.data_aws_region import DataAwsRegion +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + example = CognitoUserPool(self, "example", + name="example-user-pool" + ) + current = DataAwsRegion(self, "current") + aws_appsync_api_example = AppsyncApi(self, "example_2", + event_config=[AppsyncApiEventConfig( + auth_provider=[AppsyncApiEventConfigAuthProvider( + auth_type="AMAZON_COGNITO_USER_POOLS", + cognito_config=[AppsyncApiEventConfigAuthProviderCognitoConfig( + aws_region=Token.as_string(current.name), + user_pool_id=example.id + ) + ] + ) + ], + connection_auth_mode=[AppsyncApiEventConfigConnectionAuthMode( + auth_type="AMAZON_COGNITO_USER_POOLS" + ) + ], + default_publish_auth_mode=[AppsyncApiEventConfigDefaultPublishAuthMode( + auth_type="AMAZON_COGNITO_USER_POOLS" + ) + ], + default_subscribe_auth_mode=[AppsyncApiEventConfigDefaultSubscribeAuthMode( + auth_type="AMAZON_COGNITO_USER_POOLS" + ) + ] + ) + ], + name="example-event-api" + ) + # 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_appsync_api_example.override_logical_id("example") +``` + +### With Lambda Authorizer + +```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.appsync_api import AppsyncApi +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + AppsyncApi(self, "example", + event_config=[AppsyncApiEventConfig( + auth_provider=[AppsyncApiEventConfigAuthProvider( + auth_type="AWS_LAMBDA", + lambda_authorizer_config=[AppsyncApiEventConfigAuthProviderLambdaAuthorizerConfig( + authorizer_result_ttl_in_seconds=300, + authorizer_uri=Token.as_string(aws_lambda_function_example.invoke_arn) + ) + ] + ) + ], + connection_auth_mode=[AppsyncApiEventConfigConnectionAuthMode( + auth_type="AWS_LAMBDA" + ) + ], + default_publish_auth_mode=[AppsyncApiEventConfigDefaultPublishAuthMode( + auth_type="AWS_LAMBDA" + ) + ], + default_subscribe_auth_mode=[AppsyncApiEventConfigDefaultSubscribeAuthMode( + auth_type="AWS_LAMBDA" + ) + ] + ) + ], + name="example-event-api" + ) +``` + +## Argument Reference + +The following arguments are required: + +* `event_config` - (Required) Configuration for the Event API. See [Event Config](#event-config) below. +* `name` - (Required) Name of the Event API. + +The following arguments are optional: + +* `owner_contact` - (Optional) Contact information for the owner of the Event API. +* `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). +* `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. + +### Event Config + +The `event_config` block supports the following: + +* `auth_provider` - (Required) List of authentication providers. See [Auth Providers](#auth-providers) below. +* `connection_auth_mode` - (Required) List of authentication modes for connections. See [Auth Modes](#auth-modes) below. +* `default_publish_auth_mode` - (Required) List of default authentication modes for publishing. See [Auth Modes](#auth-modes) below. +* `default_subscribe_auth_mode` - (Required) List of default authentication modes for subscribing. See [Auth Modes](#auth-modes) below. +* `log_config` - (Optional) Logging configuration. See [Log Config](#log-config) below. + +### Auth Providers + +The `auth_provider` block supports the following: + +* `auth_type` - (Required) Type of authentication provider. Valid values: `AMAZON_COGNITO_USER_POOLS`, `AWS_LAMBDA`, `OPENID_CONNECT`, `API_KEY`. +* `cognito_config` - (Optional) Configuration for Cognito user pool authentication. Required when `auth_type` is `AMAZON_COGNITO_USER_POOLS`. See [Cognito Config](#cognito-config) below. +* `lambda_authorizer_config` - (Optional) Configuration for Lambda authorization. Required when `auth_type` is `AWS_LAMBDA`. See [Lambda Authorizer Config](#lambda-authorizer-config) below. +* `openid_connect_config` - (Optional) Configuration for OpenID Connect. Required when `auth_type` is `OPENID_CONNECT`. See [OpenID Connect Config](#openid-connect-config) below. + +### Cognito Config + +The `cognito_config` block supports the following: + +* `app_id_client_regex` - (Optional) Regular expression for matching the client ID. +* `aws_region` - (Required) AWS region where the user pool is located. +* `user_pool_id` - (Required) ID of the Cognito user pool. + +### Lambda Authorizer Config + +The `lambda_authorizer_config` block supports the following: + +* `authorizer_result_ttl_in_seconds` - (Optional) TTL in seconds for the authorization result cache. +* `authorizer_uri` - (Required) URI of the Lambda function for authorization. +* `identity_validation_expression` - (Optional) Regular expression for identity validation. + +### OpenID Connect Config + +The `openid_connect_config` block supports the following: + +* `auth_ttl` - (Optional) TTL in seconds for the authentication token. +* `client_id` - (Optional) Client ID for the OpenID Connect provider. +* `iat_ttl` - (Optional) TTL in seconds for the issued at time. +* `issuer` - (Required) Issuer URL for the OpenID Connect provider. + +### Auth Modes + +The `connection_auth_mode`, `default_publish_auth_mode`, and `default_subscribe_auth_mode` blocks support the following: + +* `auth_type` - (Required) Type of authentication. Valid values: `API_KEY`, `AWS_IAM`, `AMAZON_COGNITO_USER_POOLS`, `OPENID_CONNECT`, `AWS_LAMBDA`. + +### Log Config + +The `log_config` block supports the following: + +* `cloudwatch_logs_role_arn` - (Required) ARN of the IAM role for CloudWatch logs. +* `log_level` - (Required) Log level. Valid values: `NONE`, `ERROR`, `ALL`, `INFO`, `DEBUG`. + +## Attribute Reference + +This resource exports the following attributes in addition to the arguments above: + +* `api_id` - ID of the Event API. +* `api_arn` - ARN of the Event API. +* `dns` - DNS configuration for the Event API. +* `tags_all` - Map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). +* `waf_web_acl_arn` - ARN of the associated WAF web ACL. + +## Import + +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import AppSync Event API using the `api_id`. 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.appsync_api import AppsyncApi +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + AppsyncApi.generate_config_for_import(self, "example", "example-api-id") +``` + +Using `terraform import`, import AppSync Event API using the `api_id`. For example: + +```console +% terraform import aws_appsync_api.example example-api-id +``` + + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/appsync_api_cache.html.markdown b/website/docs/cdktf/python/r/appsync_api_cache.html.markdown index 6e8a8859505c..dd84abb6457c 100644 --- a/website/docs/cdktf/python/r/appsync_api_cache.html.markdown +++ b/website/docs/cdktf/python/r/appsync_api_cache.html.markdown @@ -45,6 +45,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `api_id` - (Required) GraphQL API ID. * `api_caching_behavior` - (Required) Caching behavior. Valid values are `FULL_REQUEST_CACHING` and `PER_RESOLVER_CACHING`. * `type` - (Required) Cache instance type. Valid values are `SMALL`, `MEDIUM`, `LARGE`, `XLARGE`, `LARGE_2X`, `LARGE_4X`, `LARGE_8X`, `LARGE_12X`, `T2_SMALL`, `T2_MEDIUM`, `R4_LARGE`, `R4_XLARGE`, `R4_2XLARGE`, `R4_4XLARGE`, `R4_8XLARGE`. @@ -83,4 +84,4 @@ Using `terraform import`, import `aws_appsync_api_cache` using the AppSync API I % terraform import aws_appsync_api_cache.example xxxxx ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/appsync_api_key.html.markdown b/website/docs/cdktf/python/r/appsync_api_key.html.markdown index 688c31fc3282..cc1483ec584e 100644 --- a/website/docs/cdktf/python/r/appsync_api_key.html.markdown +++ b/website/docs/cdktf/python/r/appsync_api_key.html.markdown @@ -43,6 +43,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `api_id` - (Required) ID of the associated AppSync API * `description` - (Optional) API key description. Defaults to "Managed by Terraform". * `expires` - (Optional) RFC3339 string representation of the expiry date. Rounded down to nearest hour. By default, it is 7 days from the date of creation. @@ -79,4 +80,4 @@ Using `terraform import`, import `aws_appsync_api_key` using the AppSync API ID % terraform import aws_appsync_api_key.example xxxxx:yyyyy ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/appsync_channel_namespace.html.markdown b/website/docs/cdktf/python/r/appsync_channel_namespace.html.markdown new file mode 100644 index 000000000000..22d186ce7d64 --- /dev/null +++ b/website/docs/cdktf/python/r/appsync_channel_namespace.html.markdown @@ -0,0 +1,118 @@ +--- +subcategory: "AppSync" +layout: "aws" +page_title: "AWS: aws_appsync_channel_namespace" +description: |- + Manages an AWS AppSync Channel Namespace. +--- + + + +# Resource: aws_appsync_channel_namespace + +Manages an [AWS AppSync Channel Namespace](https://docs.aws.amazon.com/appsync/latest/eventapi/event-api-concepts.html#namespace). + +## 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.appsync_channel_namespace import AppsyncChannelNamespace +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + AppsyncChannelNamespace(self, "example", + api_id=Token.as_string(aws_appsync_api_example.api_id), + name="example-channel-namespace" + ) +``` + +## Argument Reference + +The following arguments are required: + +* `api_id` - (Required) Event API ID. +* `name` - (Required) Name of the channel namespace. + +The following arguments are optional: + +* `code_handlers` - (Optional) Event handler functions that run custom business logic to process published events and subscribe requests. +* `handler_configs` - (Optional) Configuration for the `on_publish` and `on_subscribe` handlers. See [Handler Configs](#handler-configs) below. +* `publish_auth_mode` - (Optional) Authorization modes to use for publishing messages on the channel namespace. This configuration overrides the default API authorization configuration. See [Auth Modes](#auth-modes) below. +* `subscribe_auth_mode` - (Optional) Authorization modes to use for subscribing to messages on the channel namespace. This configuration overrides the default API authorization configuration. See [Auth Modes](#auth-modes) below. +* `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). +* `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. + +### Auth Modes + +The `publish_auth_mode`, and `subscribe_auth_mode` blocks support the following: + +* `auth_type` - (Required) Type of authentication. Valid values: `API_KEY`, `AWS_IAM`, `AMAZON_COGNITO_USER_POOLS`, `OPENID_CONNECT`, `AWS_LAMBDA`. + +### Handler Configs + +The `handler_configs` block support the following: + +* `on_publish` - (Optional) Handler configuration. See [Handler Config](#handler-config) below. +* `on_subscribe` - (Optional) Handler configuration. See [Handler Config](#handler-config) below. + +### Handler Config + +The `on_publish` and `on_subscribe` blocks support the following: + +* `behavior` - (Required) Behavior for the handler. Valid values: `CODE`, `DIRECT`. +* `integration` - (Required) Integration data source configuration for the handler. See [Integration](#integration) below. + +### Integration + +The `integration` block support the following: + +* `data_source_name` - (Required) Unique name of the data source that has been configured on the API. +* `lambda_config` - (Optional) Configuration for a Lambda data source. See [Lambda Config](#lambda-config) below. + +### Lambad Config + +The `lambda_config` block support the following: + +* `invoke_type` - (Optional) Invocation type for a Lambda data source. Valid values: `REQUEST_RESPONSE`, `EVENT`. + +## Attribute Reference + +This resource exports the following attributes in addition to the arguments above: + +* `channel_namespace_arn` - ARN of the channel namespace. +* `tags_all` - Map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). + +## Import + +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import AppSync Channel Namespace using the `api_id` and `name` separated by a comma (`,`). 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.appsync_channel_namespace import AppsyncChannelNamespace +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + AppsyncChannelNamespace.generate_config_for_import(self, "example", "example-api-id,example-channel-namespace") +``` + +Using `terraform import`, import AppSync Channel Namespace using the `api_id` and `name` separated by a comma (`,`). For example: + +```console +% terraform import aws_appsync_channel_namespace.example example-api-id,example-channel-namespace +``` + + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/appsync_datasource.html.markdown b/website/docs/cdktf/python/r/appsync_datasource.html.markdown index 5d31f3f4fb8d..873ccdc4a4b0 100644 --- a/website/docs/cdktf/python/r/appsync_datasource.html.markdown +++ b/website/docs/cdktf/python/r/appsync_datasource.html.markdown @@ -100,6 +100,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `api_id` - (Required) API ID for the GraphQL API for the data source. * `name` - (Required) User-supplied name for the data source. * `type` - (Required) Type of the Data Source. Valid values: `AWS_LAMBDA`, `AMAZON_DYNAMODB`, `AMAZON_ELASTICSEARCH`, `HTTP`, `NONE`, `RELATIONAL_DATABASE`, `AMAZON_EVENTBRIDGE`, `AMAZON_OPENSEARCH_SERVICE`. @@ -226,4 +227,4 @@ Using `terraform import`, import `aws_appsync_datasource` using the `api_id`, a % terraform import aws_appsync_datasource.example abcdef123456-example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/appsync_domain_name.html.markdown b/website/docs/cdktf/python/r/appsync_domain_name.html.markdown index bb63baa6f08f..1c14a51a3102 100644 --- a/website/docs/cdktf/python/r/appsync_domain_name.html.markdown +++ b/website/docs/cdktf/python/r/appsync_domain_name.html.markdown @@ -36,6 +36,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `certificate_arn` - (Required) ARN of the certificate. This can be an Certificate Manager (ACM) certificate or an Identity and Access Management (IAM) server certificate. The certifiacte must reside in us-east-1. * `description` - (Optional) A description of the Domain Name. * `domain_name` - (Required) Domain name. @@ -73,4 +74,4 @@ Using `terraform import`, import `aws_appsync_domain_name` using the AppSync dom % terraform import aws_appsync_domain_name.example example.com ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/appsync_domain_name_api_association.html.markdown b/website/docs/cdktf/python/r/appsync_domain_name_api_association.html.markdown index 66cc1ced6072..c13158adf1f3 100644 --- a/website/docs/cdktf/python/r/appsync_domain_name_api_association.html.markdown +++ b/website/docs/cdktf/python/r/appsync_domain_name_api_association.html.markdown @@ -36,6 +36,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `api_id` - (Required) API ID. * `domain_name` - (Required) Appsync domain name. @@ -70,4 +71,4 @@ Using `terraform import`, import `aws_appsync_domain_name_api_association` using % terraform import aws_appsync_domain_name_api_association.example example.com ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/appsync_function.html.markdown b/website/docs/cdktf/python/r/appsync_function.html.markdown index 23743836fc9f..19fada978905 100644 --- a/website/docs/cdktf/python/r/appsync_function.html.markdown +++ b/website/docs/cdktf/python/r/appsync_function.html.markdown @@ -84,6 +84,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `api_id` - (Required) ID of the associated AppSync API. * `code` - (Optional) The function code that contains the request and response functions. When code is used, the runtime is required. The runtime value must be APPSYNC_JS. * `data_source` - (Required) Function data source name. @@ -150,4 +151,4 @@ Using `terraform import`, import `aws_appsync_function` using the AppSync API ID % terraform import aws_appsync_function.example xxxxx-yyyyy ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/appsync_graphql_api.html.markdown b/website/docs/cdktf/python/r/appsync_graphql_api.html.markdown index 7968fed08b85..89c56598db98 100644 --- a/website/docs/cdktf/python/r/appsync_graphql_api.html.markdown +++ b/website/docs/cdktf/python/r/appsync_graphql_api.html.markdown @@ -72,7 +72,7 @@ class MyConvertedCode(TerraformStack): authentication_type="AMAZON_COGNITO_USER_POOLS", name="example", user_pool_config=AppsyncGraphqlApiUserPoolConfig( - aws_region=Token.as_string(current.name), + aws_region=Token.as_string(current.region), default_action="DENY", user_pool_id=Token.as_string(aws_cognito_user_pool_example.id) ) @@ -316,13 +316,15 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `authentication_type` - (Required) Authentication type. Valid values: `API_KEY`, `AWS_IAM`, `AMAZON_COGNITO_USER_POOLS`, `OPENID_CONNECT`, `AWS_LAMBDA` * `name` - (Required) User-supplied name for the GraphQL API. The following arguments are optional: +* `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). * `additional_authentication_provider` - (Optional) One or more additional authentication providers for the GraphQL API. See [`additional_authentication_provider` Block](#additional_authentication_provider-block) for details. * `api_type` - (Optional) API type. Valid values are `GRAPHQL` or `MERGED`. A `MERGED` type requires `merged_api_execution_role_arn` to be set. * `enhanced_metrics_config` - (Optional) Enables and controls the enhanced metrics feature. See [`enhanced_metrics_config` Block](#enhanced_metrics_config-block) for details. @@ -425,4 +427,4 @@ Using `terraform import`, import AppSync GraphQL API using the GraphQL API ID. F % terraform import aws_appsync_graphql_api.example 0123456789 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/appsync_resolver.html.markdown b/website/docs/cdktf/python/r/appsync_resolver.html.markdown index 54a9393f165e..f5f45d08bc7e 100644 --- a/website/docs/cdktf/python/r/appsync_resolver.html.markdown +++ b/website/docs/cdktf/python/r/appsync_resolver.html.markdown @@ -104,6 +104,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `api_id` - (Required) API ID for the GraphQL API. * `code` - (Optional) The function code that contains the request and response functions. When code is used, the runtime is required. The runtime value must be APPSYNC_JS. * `type` - (Required) Type name from the schema defined in the GraphQL API. @@ -173,4 +174,4 @@ Using `terraform import`, import `aws_appsync_resolver` using the `api_id`, a hy % terraform import aws_appsync_resolver.example abcdef123456-exampleType-exampleField ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/appsync_source_api_association.html.markdown b/website/docs/cdktf/python/r/appsync_source_api_association.html.markdown index 90c675815ad4..64b3e3e92f0d 100644 --- a/website/docs/cdktf/python/r/appsync_source_api_association.html.markdown +++ b/website/docs/cdktf/python/r/appsync_source_api_association.html.markdown @@ -3,13 +3,13 @@ subcategory: "AppSync" layout: "aws" page_title: "AWS: aws_appsync_source_api_association" description: |- - Terraform resource for managing an AWS AppSync Source Api Association. + Terraform resource for managing an AWS AppSync Source API Association. --- # Resource: aws_appsync_source_api_association -Terraform resource for managing an AWS AppSync Source Api Association. +Terraform resource for managing an AWS AppSync Source API Association. ## Example Usage @@ -38,6 +38,7 @@ class MyConvertedCode(TerraformStack): The following arguments are optional: +* `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). * `description` - (Optional) Description of the source API being merged. * `merged_api_arn` - (Optional) ARN of the merged API. One of `merged_api_arn` or `merged_api_id` must be specified. * `merged_api_id` - (Optional) ID of the merged API. One of `merged_api_arn` or `merged_api_id` must be specified. @@ -54,9 +55,9 @@ The `source_api_association_config` configuration block supports the following a This resource exports the following attributes in addition to the arguments above: -* `arn` - ARN of the Source Api Association. -* `association_id` - ID of the Source Api Association. -* `id` - Combined ID of the Source Api Association and Merge Api. +* `arn` - ARN of the Source API Association. +* `association_id` - ID of the Source API Association. +* `id` - Combined ID of the Source API Association and Merge API. ## Timeouts @@ -68,7 +69,7 @@ This resource exports the following attributes in addition to the arguments abov ## Import -In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import AppSync Source Api Association using the `example_id_arg`. For example: +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import AppSync Source API Association using the `association_id` and `merged_api_id` separated by `,`. For example: ```python # DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -85,10 +86,10 @@ class MyConvertedCode(TerraformStack): AppsyncSourceApiAssociation.generate_config_for_import(self, "example", "gzos6bteufdunffzzifiowisoe,243685a0-9347-4a1a-89c1-9b57dea01e31") ``` -Using `terraform import`, import AppSync Source Api Association using the `gzos6bteufdunffzzifiowisoe,243685a0-9347-4a1a-89c1-9b57dea01e31`. For example: +Using `terraform import`, import AppSync Source API Association using the `association_id` and `merged_api_id` separated by `,`. For example: ```console % terraform import aws_appsync_source_api_association.example gzos6bteufdunffzzifiowisoe,243685a0-9347-4a1a-89c1-9b57dea01e31 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/appsync_type.html.markdown b/website/docs/cdktf/python/r/appsync_type.html.markdown index 0f4b01c03d9d..c641d8670399 100644 --- a/website/docs/cdktf/python/r/appsync_type.html.markdown +++ b/website/docs/cdktf/python/r/appsync_type.html.markdown @@ -44,6 +44,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `api_id` - (Required) GraphQL API ID. * `format` - (Required) The type format: `SDL` or `JSON`. * `definition` - (Required) The type definition. @@ -82,4 +83,4 @@ Using `terraform import`, import Appsync Types using the `id`. For example: % terraform import aws_appsync_type.example api-id:format:name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/athena_capacity_reservation.html.markdown b/website/docs/cdktf/python/r/athena_capacity_reservation.html.markdown index 20c35effea5c..e7d553a31dd6 100644 --- a/website/docs/cdktf/python/r/athena_capacity_reservation.html.markdown +++ b/website/docs/cdktf/python/r/athena_capacity_reservation.html.markdown @@ -44,6 +44,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `tags` - (Optional) Map of tags assigned to the resource. If configured with a provider [`default_tags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. ## Attribute Reference @@ -88,4 +89,4 @@ Using `terraform import`, import Athena Capacity Reservation using the `name`. F % terraform import aws_athena_capacity_reservation.example example-reservation ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/athena_data_catalog.html.markdown b/website/docs/cdktf/python/r/athena_data_catalog.html.markdown index 9d9626c266da..e4a53b9346af 100644 --- a/website/docs/cdktf/python/r/athena_data_catalog.html.markdown +++ b/website/docs/cdktf/python/r/athena_data_catalog.html.markdown @@ -120,6 +120,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +- `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). - `name` - (Required) Name of the data catalog. The catalog name must be unique for the AWS account and can use a maximum of 128 alphanumeric, underscore, at sign, or hyphen characters. - `type` - (Required) Type of data catalog: `LAMBDA` for a federated catalog, `GLUE` for AWS Glue Catalog, or `HIVE` for an external hive metastore. - `parameters` - (Required) Key value pairs that specifies the Lambda function or functions to use for the data catalog. The mapping used depends on the catalog type. @@ -159,4 +160,4 @@ Using `terraform import`, import data catalogs using their `name`. For example: % terraform import aws_athena_data_catalog.example example-data-catalog ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/athena_database.html.markdown b/website/docs/cdktf/python/r/athena_database.html.markdown index 58a106b5631f..ba8302c0c379 100644 --- a/website/docs/cdktf/python/r/athena_database.html.markdown +++ b/website/docs/cdktf/python/r/athena_database.html.markdown @@ -42,6 +42,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `bucket` - (Required) Name of S3 bucket to save the results of the query execution. * `name` - (Required) Name of the database to create. * `acl_configuration` - (Optional) That an Amazon S3 canned ACL should be set to control ownership of stored query results. See [ACL Configuration](#acl-configuration) below. @@ -50,6 +51,7 @@ This resource supports the following arguments: * `expected_bucket_owner` - (Optional) AWS account ID that you expect to be the owner of the Amazon S3 bucket. * `force_destroy` - (Optional, Default: false) Boolean that indicates all tables should be deleted from the database so that the database can be destroyed without error. The tables are *not* recoverable. * `properties` - (Optional) Key-value map of custom metadata properties for the database definition. +* `workgroup` - (Optional) Name of the workgroup. ### ACL Configuration @@ -117,4 +119,4 @@ class MyConvertedCode(TerraformStack): ) ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/athena_named_query.html.markdown b/website/docs/cdktf/python/r/athena_named_query.html.markdown index 73962b895978..b41ecf65d1df 100644 --- a/website/docs/cdktf/python/r/athena_named_query.html.markdown +++ b/website/docs/cdktf/python/r/athena_named_query.html.markdown @@ -68,6 +68,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) Plain language name for the query. Maximum length of 128. * `workgroup` - (Optional) Workgroup to which the query belongs. Defaults to `primary` * `database` - (Required) Database to which the query belongs. @@ -105,4 +106,4 @@ Using `terraform import`, import Athena Named Query using the query ID. For exam % terraform import aws_athena_named_query.example 0123456789 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/athena_prepared_statement.html.markdown b/website/docs/cdktf/python/r/athena_prepared_statement.html.markdown index a7ce97b0cd13..6fb7e243618d 100644 --- a/website/docs/cdktf/python/r/athena_prepared_statement.html.markdown +++ b/website/docs/cdktf/python/r/athena_prepared_statement.html.markdown @@ -57,6 +57,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) The name of the prepared statement. Maximum length of 256. * `workgroup` - (Required) The name of the workgroup to which the prepared statement belongs. * `query_statement` - (Required) The query string for the prepared statement. @@ -101,4 +102,4 @@ Using `terraform import`, import Athena Prepared Statement using the `WORKGROUP- % terraform import aws_athena_prepared_statement.example 12345abcde/example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/athena_workgroup.html.markdown b/website/docs/cdktf/python/r/athena_workgroup.html.markdown index 0a0cf4b2ac5f..9395a708f015 100644 --- a/website/docs/cdktf/python/r/athena_workgroup.html.markdown +++ b/website/docs/cdktf/python/r/athena_workgroup.html.markdown @@ -46,6 +46,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) Name of the workgroup. * `configuration` - (Optional) Configuration block with various settings for the workgroup. Documented below. * `description` - (Optional) Description of the workgroup. @@ -58,19 +59,25 @@ This resource supports the following arguments: * `bytes_scanned_cutoff_per_query` - (Optional) Integer for the upper data usage limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan. Must be at least `10485760`. * `enforce_workgroup_configuration` - (Optional) Boolean whether the settings for the workgroup override client-side settings. For more information, see [Workgroup Settings Override Client-Side Settings](https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html). Defaults to `true`. * `engine_version` - (Optional) Configuration block for the Athena Engine Versioning. For more information, see [Athena Engine Versioning](https://docs.aws.amazon.com/athena/latest/ug/engine-versions.html). See [Engine Version](#engine-version) below. -* `execution_role` - (Optional) Role used in a notebook session for accessing the user's resources. +* `execution_role` - (Optional) Role used to access user resources in notebook sessions and IAM Identity Center enabled workgroups. The property is required for IAM Identity Center enabled workgroups. +* `identity_center_configuration` - (Optional) Configuration block to set up an IAM Identity Center enabled workgroup. See [Identity Center Configuration](#identity-center-configuration) below. * `publish_cloudwatch_metrics_enabled` - (Optional) Boolean whether Amazon CloudWatch metrics are enabled for the workgroup. Defaults to `true`. -* `result_configuration` - (Optional) Configuration block with result settings. See [Result Configuration](#result-configuration) below. * `requester_pays_enabled` - (Optional) If set to true , allows members assigned to a workgroup to reference Amazon S3 Requester Pays buckets in queries. If set to false , workgroup members cannot query data from Requester Pays buckets, and queries that retrieve data from Requester Pays buckets cause an error. The default is false . For more information about Requester Pays buckets, see [Requester Pays Buckets](https://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html) in the Amazon Simple Storage Service Developer Guide. +* `result_configuration` - (Optional) Configuration block with result settings. See [Result Configuration](#result-configuration) below. #### Engine Version * `selected_engine_version` - (Optional) Requested engine version. Defaults to `AUTO`. +#### Identity Center Configuration + +* `enable_identity_center` - (Optional) Specifies whether the workgroup is IAM Identity Center supported. +* `identity_center_instance_arn` - (Optional) The IAM Identity Center instance ARN that the workgroup associates to. + #### Result Configuration -* `encryption_configuration` - (Optional) Configuration block with encryption settings. See [Encryption Configuration](#encryption-configuration) below. * `acl_configuration` - (Optional) That an Amazon S3 canned ACL should be set to control ownership of stored query results. See [ACL Configuration](#acl-configuration) below. +* `encryption_configuration` - (Optional) Configuration block with encryption settings. See [Encryption Configuration](#encryption-configuration) below. * `expected_bucket_owner` - (Optional) AWS account ID that you expect to be the owner of the Amazon S3 bucket. * `output_location` - (Optional) Location in Amazon S3 where your query results are stored, such as `s3://path/to/query/bucket/`. For more information, see [Queries and Query Result Files](https://docs.aws.amazon.com/athena/latest/ug/querying.html). @@ -119,4 +126,4 @@ Using `terraform import`, import Athena Workgroups using their name. For example % terraform import aws_athena_workgroup.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/auditmanager_account_registration.html.markdown b/website/docs/cdktf/python/r/auditmanager_account_registration.html.markdown index 30d29991c4f1..41f05dcceb30 100644 --- a/website/docs/cdktf/python/r/auditmanager_account_registration.html.markdown +++ b/website/docs/cdktf/python/r/auditmanager_account_registration.html.markdown @@ -54,6 +54,7 @@ class MyConvertedCode(TerraformStack): The following arguments are optional: +* `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). * `delegated_admin_account` - (Optional) Identifier for the delegated administrator account. * `deregister_on_destroy` - (Optional) Flag to deregister AuditManager in the account upon destruction. Defaults to `false` (ie. AuditManager will remain active in the account, even if this resource is removed). * `kms_key` - (Optional) KMS key identifier. @@ -90,4 +91,4 @@ Using `terraform import`, import Audit Manager Account Registration resources us % terraform import aws_auditmanager_account_registration.example us-east-1 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/auditmanager_assessment.html.markdown b/website/docs/cdktf/python/r/auditmanager_assessment.html.markdown index 6af1dbfae50a..e98f0f0f8a17 100644 --- a/website/docs/cdktf/python/r/auditmanager_assessment.html.markdown +++ b/website/docs/cdktf/python/r/auditmanager_assessment.html.markdown @@ -67,6 +67,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `description` - (Optional) Description of the assessment. * `tags` - (Optional) A map of tags to assign to the assessment. 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. @@ -127,4 +128,4 @@ Using `terraform import`, import Audit Manager Assessments using the assessment % terraform import aws_auditmanager_assessment.example abc123-de45 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/auditmanager_assessment_delegation.html.markdown b/website/docs/cdktf/python/r/auditmanager_assessment_delegation.html.markdown index 9f6b8f2c86a3..63066e43dc38 100644 --- a/website/docs/cdktf/python/r/auditmanager_assessment_delegation.html.markdown +++ b/website/docs/cdktf/python/r/auditmanager_assessment_delegation.html.markdown @@ -47,6 +47,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `comment` - (Optional) Comment describing the delegation request. ## Attribute Reference @@ -82,4 +83,4 @@ Using `terraform import`, import Audit Manager Assessment Delegation using the ` % terraform import aws_auditmanager_assessment_delegation.example abcdef-123456,arn:aws:iam::123456789012:role/example,example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/auditmanager_assessment_report.html.markdown b/website/docs/cdktf/python/r/auditmanager_assessment_report.html.markdown index ad6b14a3e1bc..66d85e6d4861 100644 --- a/website/docs/cdktf/python/r/auditmanager_assessment_report.html.markdown +++ b/website/docs/cdktf/python/r/auditmanager_assessment_report.html.markdown @@ -43,6 +43,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `description` - (Optional) Description of the assessment report. ## Attribute Reference @@ -78,4 +79,4 @@ Using `terraform import`, import Audit Manager Assessment Reports using the asse % terraform import aws_auditmanager_assessment_report.example abc123-de45 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/auditmanager_control.html.markdown b/website/docs/cdktf/python/r/auditmanager_control.html.markdown index cecbd1f08683..267d22fa117a 100644 --- a/website/docs/cdktf/python/r/auditmanager_control.html.markdown +++ b/website/docs/cdktf/python/r/auditmanager_control.html.markdown @@ -48,6 +48,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `action_plan_instructions` - (Optional) Recommended actions to carry out if the control isn't fulfilled. * `action_plan_title` - (Optional) Title of the action plan for remediating the control. * `description` - (Optional) Description of the control. @@ -64,6 +65,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `source_description` - (Optional) Description of the source. * `source_frequency` - (Optional) Frequency of evidence collection. Valid values are `DAILY`, `WEEKLY`, or `MONTHLY`. * `source_keyword` - (Optional) The keyword to search for in CloudTrail logs, Config rules, Security Hub checks, and Amazon Web Services API names. See [`source_keyword`](#source_keyword) below. @@ -110,4 +112,4 @@ Using `terraform import`, import an Audit Manager Control using the `id`. For ex % terraform import aws_auditmanager_control.example abc123-de45 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/auditmanager_framework.html.markdown b/website/docs/cdktf/python/r/auditmanager_framework.html.markdown index 5481b5638140..ac78dceebf42 100644 --- a/website/docs/cdktf/python/r/auditmanager_framework.html.markdown +++ b/website/docs/cdktf/python/r/auditmanager_framework.html.markdown @@ -52,6 +52,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `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. @@ -103,4 +104,4 @@ Using `terraform import`, import Audit Manager Framework using the framework `id % terraform import aws_auditmanager_framework.example abc123-de45 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/auditmanager_framework_share.html.markdown b/website/docs/cdktf/python/r/auditmanager_framework_share.html.markdown index c058ebd560a9..050a35052880 100644 --- a/website/docs/cdktf/python/r/auditmanager_framework_share.html.markdown +++ b/website/docs/cdktf/python/r/auditmanager_framework_share.html.markdown @@ -45,6 +45,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `comment` - (Optional) Comment from the sender about the share request. ## Attribute Reference @@ -79,4 +80,4 @@ Using `terraform import`, import Audit Manager Framework Share using the `id`. F % terraform import aws_auditmanager_framework_share.example abcdef-123456 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/auditmanager_organization_admin_account_registration.html.markdown b/website/docs/cdktf/python/r/auditmanager_organization_admin_account_registration.html.markdown index 225013e38ab6..2fc716614813 100644 --- a/website/docs/cdktf/python/r/auditmanager_organization_admin_account_registration.html.markdown +++ b/website/docs/cdktf/python/r/auditmanager_organization_admin_account_registration.html.markdown @@ -35,8 +35,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `admin_account_id` - (Required) Identifier for the organization administrator account. ## Attribute Reference @@ -71,4 +72,4 @@ Using `terraform import`, import Audit Manager Organization Admin Account Regist % terraform import aws_auditmanager_organization_admin_account_registration.example 123456789012 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/autoscaling_attachment.html.markdown b/website/docs/cdktf/python/r/autoscaling_attachment.html.markdown index 6ef47e3ae26d..340ceeb43303 100644 --- a/website/docs/cdktf/python/r/autoscaling_attachment.html.markdown +++ b/website/docs/cdktf/python/r/autoscaling_attachment.html.markdown @@ -56,6 +56,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `autoscaling_group_name` - (Required) Name of ASG to associate with the ELB. * `elb` - (Optional) Name of the ELB. * `lb_target_group_arn` - (Optional) ARN of a load balancer target group. @@ -64,4 +65,4 @@ This resource supports the following arguments: This resource exports no additional attributes. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/autoscaling_group.html.markdown b/website/docs/cdktf/python/r/autoscaling_group.html.markdown index b25c164b6939..4ed5c1218f6d 100644 --- a/website/docs/cdktf/python/r/autoscaling_group.html.markdown +++ b/website/docs/cdktf/python/r/autoscaling_group.html.markdown @@ -495,6 +495,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +- `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). - `name` - (Optional) Name of the Auto Scaling Group. By default generated by Terraform. Conflicts with `name_prefix`. - `name_prefix` - (Optional) Creates a unique name beginning with the specified prefix. Conflicts with `name`. @@ -952,4 +953,4 @@ Using `terraform import`, import Auto Scaling Groups using the `name`. For examp % terraform import aws_autoscaling_group.web web-asg ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/autoscaling_group_tag.html.markdown b/website/docs/cdktf/python/r/autoscaling_group_tag.html.markdown index 2bbcdbfcce99..89f9cfcf977e 100644 --- a/website/docs/cdktf/python/r/autoscaling_group_tag.html.markdown +++ b/website/docs/cdktf/python/r/autoscaling_group_tag.html.markdown @@ -63,6 +63,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `autoscaling_group_name` - (Required) Name of the Autoscaling Group to apply the tag to. * `tag` - (Required) Tag to create. The `tag` block is documented below. @@ -103,4 +104,4 @@ Using `terraform import`, import `aws_autoscaling_group_tag` using the ASG name % terraform import aws_autoscaling_group_tag.example asg-example,k8s.io/cluster-autoscaler/node-template/label/eks.amazonaws.com/capacityType ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/autoscaling_lifecycle_hook.html.markdown b/website/docs/cdktf/python/r/autoscaling_lifecycle_hook.html.markdown index 003a45f03293..70b237c40060 100644 --- a/website/docs/cdktf/python/r/autoscaling_lifecycle_hook.html.markdown +++ b/website/docs/cdktf/python/r/autoscaling_lifecycle_hook.html.markdown @@ -74,13 +74,14 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) Name of the lifecycle hook. * `autoscaling_group_name` - (Required) Name of the Auto Scaling group to which you want to assign the lifecycle hook * `default_result` - (Optional) Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. The value for this parameter can be either CONTINUE or ABANDON. The default value for this parameter is ABANDON. * `heartbeat_timeout` - (Optional) Defines the amount of time, in seconds, that can elapse before the lifecycle hook times out. When the lifecycle hook times out, Auto Scaling performs the action defined in the DefaultResult parameter * `lifecycle_transition` - (Required) Instance state to which you want to attach the lifecycle hook. For a list of lifecycle hook types, see [describe-lifecycle-hook-types](https://docs.aws.amazon.com/cli/latest/reference/autoscaling/describe-lifecycle-hook-types.html#examples) * `notification_metadata` - (Optional) Contains additional information that you want to include any time Auto Scaling sends a message to the notification target. -* `notification_target_arn` - (Optional) ARN of the notification target that Auto Scaling will use to notify you when an instance is in the transition state for the lifecycle hook. This ARN target can be either an SQS queue or an SNS topic. +* `notification_target_arn` - (Optional) ARN of the notification target that Auto Scaling will use to notify you when an instance is in the transition state for the lifecycle hook. This ARN target can be either an SQS queue, an SNS topic, or a Lambda function. * `role_arn` - (Optional) ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target. ## Attribute Reference @@ -112,4 +113,4 @@ Using `terraform import`, import AutoScaling Lifecycle Hooks using the role auto % terraform import aws_autoscaling_lifecycle_hook.test-lifecycle-hook asg-name/lifecycle-hook-name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/autoscaling_notification.html.markdown b/website/docs/cdktf/python/r/autoscaling_notification.html.markdown index eb4bc671b4e0..cdad80c75994 100644 --- a/website/docs/cdktf/python/r/autoscaling_notification.html.markdown +++ b/website/docs/cdktf/python/r/autoscaling_notification.html.markdown @@ -57,6 +57,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `group_names` - (Required) List of AutoScaling Group Names * `notifications` - (Required) List of Notification Types that trigger notifications. Acceptable values are documented [in the AWS documentation here][1] @@ -73,4 +74,4 @@ This resource exports the following attributes in addition to the arguments abov [1]: https://docs.aws.amazon.com/AutoScaling/latest/APIReference/API_NotificationConfiguration.html [2]: https://docs.aws.amazon.com/AutoScaling/latest/APIReference/API_DescribeNotificationConfigurations.html - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/autoscaling_policy.html.markdown b/website/docs/cdktf/python/r/autoscaling_policy.html.markdown index 0bfcb9d4b661..78d40d23b5de 100644 --- a/website/docs/cdktf/python/r/autoscaling_policy.html.markdown +++ b/website/docs/cdktf/python/r/autoscaling_policy.html.markdown @@ -228,6 +228,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) Name of the policy. * `autoscaling_group_name` - (Required) Name of the autoscaling group. * `adjustment_type` - (Optional) Whether the adjustment is an absolute number or a percentage of the current capacity. Valid values are `ChangeInCapacity`, `ExactCapacity`, and `PercentChangeInCapacity`. @@ -517,4 +518,4 @@ Using `terraform import`, import AutoScaling scaling policy using the role autos % terraform import aws_autoscaling_policy.test-policy asg-name/policy-name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/autoscaling_schedule.html.markdown b/website/docs/cdktf/python/r/autoscaling_schedule.html.markdown index 048d6c7129be..a5f8b2852e33 100644 --- a/website/docs/cdktf/python/r/autoscaling_schedule.html.markdown +++ b/website/docs/cdktf/python/r/autoscaling_schedule.html.markdown @@ -59,6 +59,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `desired_capacity` - (Optional) The initial capacity of the Auto Scaling group after the scheduled action runs and the capacity it attempts to maintain. Set to `-1` if you don't want to change the desired capacity at the scheduled time. Defaults to `0`. * `end_time` - (Optional) The date and time for the recurring schedule to end, in UTC with the format `"YYYY-MM-DDThh:mm:ssZ"` (e.g. `"2021-06-01T00:00:00Z"`). * `max_size` - (Optional) The maximum size of the Auto Scaling group. Set to `-1` if you don't want to change the maximum size at the scheduled time. Defaults to `0`. @@ -100,4 +101,4 @@ Using `terraform import`, import AutoScaling ScheduledAction using the `auto-sca % terraform import aws_autoscaling_schedule.resource-name auto-scaling-group-name/scheduled-action-name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/autoscaling_traffic_source_attachment.html.markdown b/website/docs/cdktf/python/r/autoscaling_traffic_source_attachment.html.markdown index ed85c276c916..e31dd23839f5 100644 --- a/website/docs/cdktf/python/r/autoscaling_traffic_source_attachment.html.markdown +++ b/website/docs/cdktf/python/r/autoscaling_traffic_source_attachment.html.markdown @@ -43,6 +43,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +- `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). - `autoscaling_group_name` - (Required) The name of the Auto Scaling group. - `traffic_source` - (Required) The unique identifiers of a traffic sources. @@ -59,4 +60,4 @@ This resource supports the following arguments: This resource exports no additional attributes. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/autoscalingplans_scaling_plan.html.markdown b/website/docs/cdktf/python/r/autoscalingplans_scaling_plan.html.markdown index ff112877c736..906630310825 100644 --- a/website/docs/cdktf/python/r/autoscalingplans_scaling_plan.html.markdown +++ b/website/docs/cdktf/python/r/autoscalingplans_scaling_plan.html.markdown @@ -155,6 +155,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) Name of the scaling plan. Names cannot contain vertical bars, colons, or forward slashes. * `application_source` - (Required) CloudFormation stack or set of tags. You can create one scaling plan per application source. * `scaling_instruction` - (Required) Scaling instructions. More details can be found in the [AWS Auto Scaling API Reference](https://docs.aws.amazon.com/autoscaling/plans/APIReference/API_ScalingInstruction.html). @@ -263,4 +264,4 @@ Using `terraform import`, import Auto Scaling scaling plans using the `name`. Fo % terraform import aws_autoscalingplans_scaling_plan.example MyScale1 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/backup_framework.html.markdown b/website/docs/cdktf/python/r/backup_framework.html.markdown index 627621a2a852..5867b1ab4d4b 100644 --- a/website/docs/cdktf/python/r/backup_framework.html.markdown +++ b/website/docs/cdktf/python/r/backup_framework.html.markdown @@ -98,6 +98,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `control` - (Required) One or more control blocks that make up the framework. Each control in the list has a name, input parameters, and scope. Detailed below. * `description` - (Optional) The description of the framework with a maximum of 1,024 characters * `name` - (Required) The unique name of the framework. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters, numbers, and underscores. @@ -170,4 +171,4 @@ Using `terraform import`, import Backup Framework using the `id` which correspon % terraform import aws_backup_framework.test ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/backup_logically_air_gapped_vault.html.markdown b/website/docs/cdktf/python/r/backup_logically_air_gapped_vault.html.markdown index e609aa01524f..bb2ad8e11a2f 100644 --- a/website/docs/cdktf/python/r/backup_logically_air_gapped_vault.html.markdown +++ b/website/docs/cdktf/python/r/backup_logically_air_gapped_vault.html.markdown @@ -39,6 +39,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) Name of the Logically Air Gapped Backup Vault to create. * `max_retention_days` - (Required) Maximum retention period that the Logically Air Gapped Backup Vault retains recovery points. * `min_retention_days` - (Required) Minimum retention period that the Logically Air Gapped Backup Vault retains recovery points. @@ -84,4 +85,4 @@ Using `terraform import`, import Backup Logically Air Gapped Vault using the `id % terraform import aws_backup_logically_air_gapped_vault.example lag-example-vault ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/backup_plan.html.markdown b/website/docs/cdktf/python/r/backup_plan.html.markdown index 1a44c387d682..6dac5f89c1ce 100644 --- a/website/docs/cdktf/python/r/backup_plan.html.markdown +++ b/website/docs/cdktf/python/r/backup_plan.html.markdown @@ -51,6 +51,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) The display name of a backup plan. * `rule` - (Required) A rule object that specifies a scheduled task that is used to back up a selection of resources. * `advanced_backup_setting` - (Optional) An object that specifies backup options for each resource type. @@ -127,4 +128,4 @@ Using `terraform import`, import Backup Plan using the `id`. For example: % terraform import aws_backup_plan.test ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/backup_region_settings.html.markdown b/website/docs/cdktf/python/r/backup_region_settings.html.markdown index 018be137f777..b2327eef1af0 100644 --- a/website/docs/cdktf/python/r/backup_region_settings.html.markdown +++ b/website/docs/cdktf/python/r/backup_region_settings.html.markdown @@ -59,6 +59,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `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). @@ -93,4 +94,4 @@ Using `terraform import`, import Backup Region Settings using the `region`. For % terraform import aws_backup_region_settings.test us-west-2 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/backup_report_plan.html.markdown b/website/docs/cdktf/python/r/backup_report_plan.html.markdown index b8bac73a1d6a..3f1ca57aa89a 100644 --- a/website/docs/cdktf/python/r/backup_report_plan.html.markdown +++ b/website/docs/cdktf/python/r/backup_report_plan.html.markdown @@ -46,6 +46,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `description` - (Optional) The description of the report plan with a maximum of 1,024 characters * `name` - (Required) The unique name of the report plan. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters, numbers, and underscores. * `report_delivery_channel` - (Required) An object that contains information about where and how to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports. Detailed below. @@ -106,4 +107,4 @@ Using `terraform import`, import Backup Report Plan using the `id` which corresp % terraform import aws_backup_report_plan.test ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/backup_restore_testing_plan.html.markdown b/website/docs/cdktf/python/r/backup_restore_testing_plan.html.markdown index c29bbecbd079..04331c24e1e7 100644 --- a/website/docs/cdktf/python/r/backup_restore_testing_plan.html.markdown +++ b/website/docs/cdktf/python/r/backup_restore_testing_plan.html.markdown @@ -41,8 +41,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `name` (Required): The name of the restore testing plan. Must be between 1 and 50 characters long and contain only alphanumeric characters and underscores. * `schedule_expression` (Required): The schedule expression for the restore testing plan. * `schedule_expression_timezone` (Optional): The timezone for the schedule expression. If not provided, the state value will be used. @@ -89,4 +90,4 @@ Using `terraform import`, import Backup Restore Testing Plan using the `name`. F % terraform import aws_backup_restore_testing_plan.example my_testing_plan ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/backup_restore_testing_selection.html.markdown b/website/docs/cdktf/python/r/backup_restore_testing_selection.html.markdown index 9abce4c87786..2f8f12547e94 100644 --- a/website/docs/cdktf/python/r/backup_restore_testing_selection.html.markdown +++ b/website/docs/cdktf/python/r/backup_restore_testing_selection.html.markdown @@ -71,6 +71,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) The name of the backup restore testing selection. * `restore_testing_plan_name` - (Required) The name of the restore testing plan. * `protected_resource_type` - (Required) The type of the protected resource. @@ -119,4 +120,4 @@ Using `terraform import`, import Backup Restore Testing Selection using `name:re % terraform import aws_backup_restore_testing_selection.example restore_testing_selection_12345678:restore_testing_plan_12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/backup_selection.html.markdown b/website/docs/cdktf/python/r/backup_selection.html.markdown index 6dc3813ffa73..4a11e4796849 100644 --- a/website/docs/cdktf/python/r/backup_selection.html.markdown +++ b/website/docs/cdktf/python/r/backup_selection.html.markdown @@ -194,6 +194,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) The display name of a resource selection document. * `plan_id` - (Required) The backup plan ID to be associated with the selection of resources. * `iam_role_arn` - (Required) The ARN of the IAM role that AWS Backup uses to authenticate when restoring and backing up the target resource. See the [AWS Backup Developer Guide](https://docs.aws.amazon.com/aws-backup/latest/devguide/access-control.html#managed-policies) for additional information about using AWS managed policies or creating custom policies attached to the IAM role. @@ -278,4 +279,4 @@ Using `terraform import`, import Backup selection using the role plan_id and id % terraform import aws_backup_selection.example plan-id|selection-id ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/backup_vault.html.markdown b/website/docs/cdktf/python/r/backup_vault.html.markdown index 096af9b16eca..962e81f822cb 100644 --- a/website/docs/cdktf/python/r/backup_vault.html.markdown +++ b/website/docs/cdktf/python/r/backup_vault.html.markdown @@ -36,6 +36,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `force_destroy` - (Optional, Default: `false`) A boolean that indicates that all recovery points stored in the vault are deleted so that the vault can be destroyed without error. * `kms_key_arn` - (Optional) The server-side encryption key that is used to protect your backups. * `name` - (Required) Name of the backup vault to create. @@ -81,4 +82,4 @@ Using `terraform import`, import Backup vault using the `name`. For example: % terraform import aws_backup_vault.test-vault TestVault ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/backup_vault_lock_configuration.html.markdown b/website/docs/cdktf/python/r/backup_vault_lock_configuration.html.markdown index 36f61f3fefbc..348ee3403267 100644 --- a/website/docs/cdktf/python/r/backup_vault_lock_configuration.html.markdown +++ b/website/docs/cdktf/python/r/backup_vault_lock_configuration.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `backup_vault_name` - (Required) Name of the backup vault to add a lock configuration for. * `changeable_for_days` - (Optional) The number of days before the lock date. If omitted creates a vault lock in `governance` mode, otherwise it will create a vault lock in `compliance` mode. * `max_retention_days` - (Optional) The maximum retention period that the vault retains its recovery points. @@ -75,4 +76,4 @@ Using `terraform import`, import Backup vault lock configuration using the `name % terraform import aws_backup_vault_lock_configuration.test TestVault ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/backup_vault_notifications.html.markdown b/website/docs/cdktf/python/r/backup_vault_notifications.html.markdown index b322f94b6420..2edb2995bbac 100644 --- a/website/docs/cdktf/python/r/backup_vault_notifications.html.markdown +++ b/website/docs/cdktf/python/r/backup_vault_notifications.html.markdown @@ -68,6 +68,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `backup_vault_name` - (Required) Name of the backup vault to add notifications for. * `sns_topic_arn` - (Required) The Amazon Resource Name (ARN) that specifies the topic for a backup vault’s events * `backup_vault_events` - (Required) An array of events that indicate the status of jobs to back up resources to the backup vault. @@ -104,4 +105,4 @@ Using `terraform import`, import Backup vault notifications using the `name`. Fo % terraform import aws_backup_vault_notifications.test TestVault ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/backup_vault_policy.html.markdown b/website/docs/cdktf/python/r/backup_vault_policy.html.markdown index 34e6c8aa403f..1f730b58e574 100644 --- a/website/docs/cdktf/python/r/backup_vault_policy.html.markdown +++ b/website/docs/cdktf/python/r/backup_vault_policy.html.markdown @@ -61,6 +61,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `backup_vault_name` - (Required) Name of the backup vault to add policy for. * `policy` - (Required) The backup vault access policy document in JSON format. @@ -96,4 +97,4 @@ Using `terraform import`, import Backup vault policy using the `name`. For examp % terraform import aws_backup_vault_policy.test TestVault ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/batch_compute_environment.html.markdown b/website/docs/cdktf/python/r/batch_compute_environment.html.markdown index 9892c05ad2c9..8b071a11747d 100644 --- a/website/docs/cdktf/python/r/batch_compute_environment.html.markdown +++ b/website/docs/cdktf/python/r/batch_compute_environment.html.markdown @@ -122,7 +122,6 @@ class MyConvertedCode(TerraformStack): # 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_iam_instance_profile_ecs_instance_role.override_logical_id("ecs_instance_role") aws_batch_compute_environment_sample = BatchComputeEnvironment(self, "sample_11", - name="sample", compute_resources=BatchComputeEnvironmentComputeResources( instance_role=Token.as_string(aws_iam_instance_profile_ecs_instance_role.arn), instance_type=["c4.large"], @@ -134,6 +133,7 @@ class MyConvertedCode(TerraformStack): type="EC2" ), depends_on=[aws_iam_role_policy_attachment_aws_batch_service_role], + name="sample", service_role=aws_batch_service_role.arn, type="MANAGED" ) @@ -156,7 +156,6 @@ class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) BatchComputeEnvironment(self, "sample", - name="sample", compute_resources=BatchComputeEnvironmentComputeResources( max_vcpus=16, security_group_ids=[Token.as_string(aws_security_group_sample.id)], @@ -164,6 +163,7 @@ class MyConvertedCode(TerraformStack): type="FARGATE" ), depends_on=[aws_batch_service_role], + name="sample", service_role=Token.as_string(aws_iam_role_aws_batch_service_role.arn), type="MANAGED" ) @@ -184,7 +184,6 @@ class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) BatchComputeEnvironment(self, "sample", - name="sample", compute_resources=BatchComputeEnvironmentComputeResources( allocation_strategy="BEST_FIT_PROGRESSIVE", instance_role=ecs_instance.arn, @@ -195,6 +194,7 @@ class MyConvertedCode(TerraformStack): subnets=[Token.as_string(aws_subnet_sample.id)], type="EC2" ), + name="sample", type="MANAGED", update_policy=BatchComputeEnvironmentUpdatePolicy( job_execution_timeout_minutes=30, @@ -207,6 +207,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Optional, Forces new resource) The name for your compute environment. Up to 128 letters (uppercase and lowercase), numbers, and underscores are allowed. If omitted, Terraform will assign a random, unique name. * `name_prefix` - (Optional, Forces new resource) Creates a unique compute environment name beginning with the specified prefix. Conflicts with `name`. * `compute_resources` - (Optional) Details of the compute resources managed by the compute environment. This parameter is required for managed compute environments. See details below. @@ -242,6 +243,7 @@ This resource supports the following arguments: `ec2_configuration` supports the following: * `image_id_override` - (Optional) The AMI ID used for instances launched in the compute environment that match the image type. This setting overrides the `image_id` argument in the [`compute_resources`](#compute_resources) block. +* `image_kubernetes_version` - (Optional) The Kubernetes version for the compute environment. If you don't specify a value, the latest version that AWS Batch supports is used. See [Supported Kubernetes versions](https://docs.aws.amazon.com/batch/latest/userguide/supported_kubernetes_version.html) for the list of Kubernetes versions supported by AWS Batch on Amazon EKS. * `image_type` - (Optional) The image type to match with the instance type to select an AMI. If the `image_id_override` parameter isn't specified, then a recent [Amazon ECS-optimized Amazon Linux 2 AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#al2ami) (`ECS_AL2`) is used. ### launch_template @@ -264,7 +266,7 @@ This resource supports the following arguments: `update_policy` supports the following: * `job_execution_timeout_minutes` - (Required) Specifies the job timeout (in minutes) when the compute environment infrastructure is updated. -* `terminate_jobs_on_update` - (Required) Specifies whether jobs are automatically terminated when the computer environment infrastructure is updated. +* `terminate_jobs_on_update` - (Required) Specifies whether jobs are automatically terminated when the compute environment infrastructure is updated. ## Attribute Reference @@ -305,4 +307,4 @@ Using `terraform import`, import AWS Batch compute using the `name`. For example [2]: http://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html [3]: http://docs.aws.amazon.com/batch/latest/userguide/troubleshooting.html - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/batch_job_definition.html.markdown b/website/docs/cdktf/python/r/batch_job_definition.html.markdown index 4733ff8b8702..ea89c014b5da 100644 --- a/website/docs/cdktf/python/r/batch_job_definition.html.markdown +++ b/website/docs/cdktf/python/r/batch_job_definition.html.markdown @@ -306,6 +306,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `container_properties` - (Optional) 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`. * `ecs_properties` - (Optional) Valid [ECS 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`. @@ -368,7 +369,7 @@ The following arguments are optional: #### eks_metadata -* `labels` - Key-value pairs used to identify, sort, and organize cube resources. +* `labels` - Key-value pairs used to identify, sort, and organize kubernetes resources. #### `eks_secret` @@ -425,4 +426,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 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/batch_job_queue.html.markdown b/website/docs/cdktf/python/r/batch_job_queue.html.markdown index b7169152989e..dab5b5dd569f 100644 --- a/website/docs/cdktf/python/r/batch_job_queue.html.markdown +++ b/website/docs/cdktf/python/r/batch_job_queue.html.markdown @@ -92,6 +92,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) Specifies the name of the job queue. * `compute_environment_order` - (Optional) The set of compute environments mapped to a job queue and their order relative to each other. The job scheduler uses this parameter to determine which compute environment runs a specific job. Compute environments must be in the VALID state before you can associate them with a job queue. You can associate up to three compute environments with a job queue. * `job_state_time_limit_action` - (Optional) The set of job state time limit actions mapped to a job queue. Specifies an action that AWS Batch will take after the job has remained at the head of the queue in the specified state for longer than the specified time. @@ -153,4 +154,4 @@ Using `terraform import`, import Batch Job Queue using the `arn`. For example: % terraform import aws_batch_job_queue.test_queue arn:aws:batch:us-east-1:123456789012:job-queue/sample ``` - + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/batch_scheduling_policy.html.markdown b/website/docs/cdktf/python/r/batch_scheduling_policy.html.markdown index 45b8bb1811d6..ef3c355f8995 100644 --- a/website/docs/cdktf/python/r/batch_scheduling_policy.html.markdown +++ b/website/docs/cdktf/python/r/batch_scheduling_policy.html.markdown @@ -50,6 +50,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `fairshare_policy` - (Optional) A fairshare policy block specifies the `compute_reservation`, `share_delay_seconds`, and `share_distribution` of the scheduling policy. The `fairshare_policy` block is documented below. * `name` - (Required) Specifies the name of the scheduling policy. * `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. @@ -97,4 +98,4 @@ Using `terraform import`, import Batch Scheduling Policy using the `arn`. For ex % terraform import aws_batch_scheduling_policy.test_policy arn:aws:batch:us-east-1:123456789012:scheduling-policy/sample ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/bcmdataexports_export.html.markdown b/website/docs/cdktf/python/r/bcmdataexports_export.html.markdown index f34678505899..7e54a10d52ef 100644 --- a/website/docs/cdktf/python/r/bcmdataexports_export.html.markdown +++ b/website/docs/cdktf/python/r/bcmdataexports_export.html.markdown @@ -25,15 +25,22 @@ from cdktf import Token, TerraformStack # See https://cdk.tf/provider-generation for more details. # from imports.aws.bcmdataexports_export import BcmdataexportsExport +from imports.aws.data_aws_caller_identity import DataAwsCallerIdentity +from imports.aws.data_aws_partition import DataAwsPartition class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) + current = DataAwsCallerIdentity(self, "current") + data_aws_partition_current = DataAwsPartition(self, "current_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_partition_current.override_logical_id("current") BcmdataexportsExport(self, "test", export=[BcmdataexportsExportExport( data_query=[BcmdataexportsExportExportDataQuery( query_statement="SELECT identity_line_item_id, identity_time_interval, line_item_product_code,line_item_unblended_cost FROM COST_AND_USAGE_REPORT", table_configurations={ "COST_AND_USAGE_REPORT": { + "BILLING_VIEW_ARN": "arn:${" + data_aws_partition_current.partition + "}:billing::${" + current.account_id + "}:billingview/primary", "INCLUDE_MANUAL_DISCOUNT_COMPATIBILITY": "FALSE", "INCLUDE_RESOURCES": "FALSE", "INCLUDE_SPLIT_COST_ALLOCATION_DATA": "FALSE", @@ -84,8 +91,8 @@ The following arguments are required: ### `data_query` Argument Reference -* `query_statement` - (Required) Query statement. -* `table_configurations` - (Optional) Table configuration. +* `query_statement` - (Required) Query statement. The SQL table name for CUR 2.0 is `COST_AND_USAGE_REPORT`. See the [AWS documentation](https://docs.aws.amazon.com/cur/latest/userguide/table-dictionary-cur2.html) for a list of available columns. +* `table_configurations` - (Optional) Table configuration. See the [AWS documentation](https://docs.aws.amazon.com/cur/latest/userguide/table-dictionary-cur2.html#cur2-table-configurations) for the available configurations. In addition to those listed in the documentation, `BILLING_VIEW_ARN` must also be included, as shown in the example above. ### `destination_configurations` Argument Reference @@ -113,7 +120,8 @@ The following arguments are required: This resource exports the following attributes in addition to the arguments above: -* `export_arn` - Amazon Resource Name (ARN) for this export. +* `arn` - Amazon Resource Name (ARN) for this export. +* `export[0].export_arn` - Amazon Resource Name (ARN) for this export. ## Timeouts @@ -147,4 +155,4 @@ Using `terraform import`, import BCM Data Exports Export using the export ARN. F % terraform import aws_bcmdataexports_export.example arn:aws:bcm-data-exports:us-east-1:123456789012:export/CostUsageReport-9f1c75f3-f982-4d9a-b936-1e7ecab814b7 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/bedrock_custom_model.html.markdown b/website/docs/cdktf/python/r/bedrock_custom_model.html.markdown index fb3a8646d2e3..608fe902eef3 100644 --- a/website/docs/cdktf/python/r/bedrock_custom_model.html.markdown +++ b/website/docs/cdktf/python/r/bedrock_custom_model.html.markdown @@ -71,6 +71,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `base_model_identifier` - (Required) The Amazon Resource Name (ARN) of the base model. * `custom_model_kms_key_id` - (Optional) The custom model is encrypted at rest using this key. Specify the key ARN. * `custom_model_name` - (Required) Name for the custom model. @@ -87,8 +88,8 @@ This resource supports the following arguments: * `validator` - (Required) Information about the validators. * `s3_uri` - (Required) The S3 URI where the validation data is stored. * `vpc_config` - (Optional) Configuration parameters for the private Virtual Private Cloud (VPC) that contains the resources you are using for this job. - * `security_group_ids` – (Required) VPC configuration security group IDs. - * `subnet_ids` – (Required) VPC configuration subnets. + * `security_group_ids` - (Required) VPC configuration security group IDs. + * `subnet_ids` - (Required) VPC configuration subnets. ## Attribute Reference @@ -134,4 +135,4 @@ Using `terraform import`, import Bedrock custom model using the `job_arn`. For e % terraform import aws_bedrock_custom_model.example arn:aws:bedrock:us-west-2:123456789012:model-customization-job/amazon.titan-text-express-v1:0:8k/1y5n57gh5y2e ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/bedrock_guardrail.html.markdown b/website/docs/cdktf/python/r/bedrock_guardrail.html.markdown index 94a9613857b1..e7b04b5940da 100644 --- a/website/docs/cdktf/python/r/bedrock_guardrail.html.markdown +++ b/website/docs/cdktf/python/r/bedrock_guardrail.html.markdown @@ -29,19 +29,30 @@ resource "aws_bedrock_guardrail" "example" { output_strength = "MEDIUM" type = "HATE" } + tier_config { + tier_name = "STANDARD" + } } sensitive_information_policy_config { pii_entities_config { - action = "BLOCK" - type = "NAME" + action = "BLOCK" + input_action = "BLOCK" + output_action = "ANONYMIZE" + input_enabled = true + output_enabled = true + type = "NAME" } regexes_config { - action = "BLOCK" - description = "example regex" - name = "regex_example" - pattern = "^\\d{3}-\\d{2}-\\d{4}$" + action = "BLOCK" + input_action = "BLOCK" + output_action = "BLOCK" + input_enabled = true + output_enabled = false + description = "example regex" + name = "regex_example" + pattern = "^\\d{3}-\\d{2}-\\d{4}$" } } @@ -52,6 +63,9 @@ resource "aws_bedrock_guardrail" "example" { type = "DENY" definition = "Investment advice refers to inquiries, guidance, or recommendations regarding the management or allocation of funds or assets with the goal of generating returns ." } + tier_config { + tier_name = "CLASSIC" + } } word_policy_config { @@ -75,6 +89,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `content_policy_config` - (Optional) Content policy config for a guardrail. See [Content Policy Config](#content-policy-config) for more information. * `contextual_grounding_policy_config` - (Optional) Contextual grounding policy config for a guardrail. See [Contextual Grounding Policy Config](#contextual-grounding-policy-config) for more information. * `description` (Optional) Description of the guardrail or its version. @@ -90,6 +105,7 @@ The `content_policy_config` configuration block supports the following arguments * `filters_config` - (Optional) Set of content filter configs in content policy. See [Filters Config](#content-filters-config) for more information. +* `tier_config` - (Optional) Configuration block for the content policy tier. See [Tier Config](#content-tier-config) for more information. #### Content Filters Config @@ -99,6 +115,12 @@ The `filters_config` configuration block supports the following arguments: * `output_strength` - (Optional) Strength for filters. * `type` - (Optional) Type of filter in content policy. +#### Content Tier Config + +The `tier_config` configuration block supports the following arguments: + +* `tier_name` - (Required) The name of the content policy tier. Valid values include STANDARD or CLASSIC. + ### Contextual Grounding Policy Config * `filters_config` (Required) List of contextual grounding filter configs. See [Contextual Grounding Filters Config](#contextual-grounding-filters-config) for more information. @@ -110,8 +132,17 @@ The `filters_config` configuration block supports the following arguments: * `threshold` - (Required) The threshold for this filter. * `type` - (Required) Type of contextual grounding filter. +### Cross Region Inference + +* `cross_region_config` (Optional) Configuration block to enable cross-region routing for bedrock guardrails. See [Cross Region Config](#cross-region-config for more information. Note see [available regions](https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-cross-region.html) here. + +#### Cross Region Config + +* `guardrail_profile_identifier` (Required) Guardrail profile ARN. + ### Topic Policy Config +* `tier_config` - (Optional) Configuration block for the topic policy tier. See [Tier Config](#topics-tier-config) for more information. * `topics_config` (Required) List of topic configs in topic policy. See [Topics Config](#topics-config) for more information. #### Topics Config @@ -121,6 +152,12 @@ The `filters_config` configuration block supports the following arguments: * `type` (Required) Type of topic in a policy. * `examples` (Optional) List of text examples. +#### Topics Tier Config + +The `tier_config` configuration block supports the following arguments: + +* `tier_name` - (Required) The name of the content policy tier. Valid values include STANDARD or CLASSIC. + ### Sensitive Information Policy Config * `pii_entities_config` (Optional) List of entities. See [PII Entities Config](#pii-entities-config) for more information. @@ -128,13 +165,21 @@ The `filters_config` configuration block supports the following arguments: #### PII Entities Config -* `action` (Required) Options for sensitive information action. +* `action` (Required) Options for sensitive information action. Valid values: `BLOCK`, `ANONYMIZE`, `NONE`. +* `input_action` (Optional) Action to take when harmful content is detected in the input. Valid values: `BLOCK`, `ANONYMIZE`, `NONE`. +* `input_enabled` (Optional) Whether to enable guardrail evaluation on the input. When disabled, you aren't charged for the evaluation. +* `output_action` (Optional) Action to take when harmful content is detected in the output. Valid values: `BLOCK`, `ANONYMIZE`, `NONE`. +* `output_enabled` (Optional) Whether to enable guardrail evaluation on the output. When disabled, you aren't charged for the evaluation. * `type` (Required) The currently supported PII entities. #### Regexes Config -* `action` (Required) Options for sensitive information action. +* `action` (Required) Options for sensitive information action. Valid values: `BLOCK`, `ANONYMIZE`, `NONE`. +* `input_action` (Optional) Action to take when harmful content is detected in the input. Valid values: `BLOCK`, `ANONYMIZE`, `NONE`. +* `input_enabled` (Optional) Whether to enable guardrail evaluation on the input. When disabled, you aren't charged for the evaluation. * `name` (Required) The regex name. +* `output_action` (Optional) Action to take when harmful content is detected in the output. Valid values: `BLOCK`, `ANONYMIZE`, `NONE`. +* `output_enabled` (Optional) Whether to enable guardrail evaluation on the output. When disabled, you aren't charged for the evaluation. * `pattern` (Required) The regex pattern. * `description` (Optional) The regex description. @@ -194,4 +239,4 @@ Using `terraform import`, import Amazon Bedrock Guardrail using using a comma-de % terraform import aws_bedrock_guardrail.example guardrail-id-12345678,DRAFT ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/bedrock_guardrail_version.html.markdown b/website/docs/cdktf/python/r/bedrock_guardrail_version.html.markdown index 8c7b16dfc27b..9533cd0874dc 100644 --- a/website/docs/cdktf/python/r/bedrock_guardrail_version.html.markdown +++ b/website/docs/cdktf/python/r/bedrock_guardrail_version.html.markdown @@ -42,6 +42,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `description` - (Optional) Description of the Guardrail version. * `skip_destroy` - (Optional) Whether to retain the old version of a previously deployed Guardrail. Default is `false` @@ -83,4 +84,4 @@ Using `terraform import`, import Amazon Bedrock Guardrail Version using using a % terraform import aws_bedrock_guardrail_version.example arn:aws:bedrock:us-west-2:123456789012:guardrail-id-12345678,1 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/bedrock_inference_profile.html.markdown b/website/docs/cdktf/python/r/bedrock_inference_profile.html.markdown index 09a3af064472..f699f826b912 100644 --- a/website/docs/cdktf/python/r/bedrock_inference_profile.html.markdown +++ b/website/docs/cdktf/python/r/bedrock_inference_profile.html.markdown @@ -24,16 +24,16 @@ 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 BedrockInferenceProfile +from imports.aws.bedrock_inference_profile import BedrockInferenceProfile from imports.aws.data_aws_caller_identity import DataAwsCallerIdentity class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) BedrockInferenceProfile(self, "example", description="Profile with tag for cost allocation tracking", - model_source=[{ - "copy_from": "arn:aws:bedrock:us-west-2::foundation-model/anthropic.claude-3-5-sonnet-20241022-v2:0" - } + model_source=[BedrockInferenceProfileModelSource( + copy_from="arn:aws:bedrock:us-west-2::foundation-model/anthropic.claude-3-5-sonnet-20241022-v2:0" + ) ], name="Claude Sonnet for Project 123", tags={ @@ -52,6 +52,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `description` - (Optional) The description of the inference profile. * `tags` - (Optional) Key-value mapping of resource tags for the inference profile. @@ -87,7 +88,7 @@ This resource exports the following attributes in addition to the arguments abov ## Import -In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import Bedrock Inference Profile using the `example_id_arg`. For example: +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import Bedrock Inference Profile using the `name`. For example: ```python # DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -97,17 +98,17 @@ 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 BedrockInferenceProfile +from imports.aws.bedrock_inference_profile import BedrockInferenceProfile class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) BedrockInferenceProfile.generate_config_for_import(self, "example", "inference_profile-id-12345678") ``` -Using `terraform import`, import Bedrock Inference Profile using the `example_id_arg`. For example: +Using `terraform import`, import Bedrock Inference Profile using the `name`. For example: ```console % terraform import aws_bedrock_inference_profile.example inference_profile-id-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/bedrock_model_invocation_logging_configuration.html.markdown b/website/docs/cdktf/python/r/bedrock_model_invocation_logging_configuration.html.markdown index 927088d6b889..2adf1c701cfd 100644 --- a/website/docs/cdktf/python/r/bedrock_model_invocation_logging_configuration.html.markdown +++ b/website/docs/cdktf/python/r/bedrock_model_invocation_logging_configuration.html.markdown @@ -51,17 +51,17 @@ class MyConvertedCode(TerraformStack): aws_bedrock_model_invocation_logging_configuration_example = BedrockModelInvocationLoggingConfiguration(self, "example_3", depends_on=[aws_s3_bucket_policy_example], - logging_config=[{ - "embedding_data_delivery_enabled": True, - "image_data_delivery_enabled": True, - "s3_config": [{ - "bucket_name": example.id, - "key_prefix": "bedrock" - } + logging_config=[BedrockModelInvocationLoggingConfigurationLoggingConfig( + embedding_data_delivery_enabled=True, + image_data_delivery_enabled=True, + s3_config=[BedrockModelInvocationLoggingConfigurationLoggingConfigS3Config( + bucket_name=example.id, + key_prefix="bedrock" + ) ], - "text_data_delivery_enabled": True, - "video_data_delivery_enabled": True - } + text_data_delivery_enabled=True, + video_data_delivery_enabled=True + ) ] ) # This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match. @@ -70,42 +70,43 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `logging_config` - (Required) The logging configuration values to set. See [`logging_config` Block](#logging_config-block) for details. ### `logging_config` Block The `logging_config` configuration block supports the following arguments: -* `cloudwatch_config` – (Optional) CloudWatch logging configuration. See [`cloudwatch_config` Block](#cloudwatch_config-block) for details. -* `embedding_data_delivery_enabled` – (Optional) Set to include embeddings data in the log delivery. Defaults to `true`. -* `image_data_delivery_enabled` – (Optional) Set to include image data in the log delivery. Defaults to `true`. -* `s3_config` – (Optional) S3 configuration for storing log data. See [`s3_config` Block](#s3_config-block) for details. -* `text_data_delivery_enabled` – (Optional) Set to include text data in the log delivery. Defaults to `true`. -* `video_data_delivery_enabled` – (Optional) Set to include text data in the log delivery. Defaults to `true`. +* `cloudwatch_config` - (Optional) CloudWatch logging configuration. See [`cloudwatch_config` Block](#cloudwatch_config-block) for details. +* `embedding_data_delivery_enabled` - (Optional) Set to include embeddings data in the log delivery. Defaults to `true`. +* `image_data_delivery_enabled` - (Optional) Set to include image data in the log delivery. Defaults to `true`. +* `s3_config` - (Optional) S3 configuration for storing log data. See [`s3_config` Block](#s3_config-block) for details. +* `text_data_delivery_enabled` - (Optional) Set to include text data in the log delivery. Defaults to `true`. +* `video_data_delivery_enabled` - (Optional) Set to include text data in the log delivery. Defaults to `true`. ### `cloudwatch_config` Block The `cloudwatch_config` configuration block supports the following arguments: -* `large_data_delivery_s3_config` – (Optional) S3 configuration for delivering a large amount of data. See [`large_data_delivery_s3_config` Block](#large_data_delivery_s3_config-block) for details. -* `log_group_name` – (Required) Log group name. -* `role_arn` – (Optional) The role ARN. +* `large_data_delivery_s3_config` - (Optional) S3 configuration for delivering a large amount of data. See [`large_data_delivery_s3_config` Block](#large_data_delivery_s3_config-block) for details. +* `log_group_name` - (Required) Log group name. +* `role_arn` - (Optional) The role ARN. ### `large_data_delivery_s3_config` Block The `large_data_delivery_s3_config` configuration block supports the following arguments: -* `bucket_name` – (Required) S3 bucket name. -* `key_prefix` – (Optional) S3 prefix. +* `bucket_name` - (Required) S3 bucket name. +* `key_prefix` - (Optional) S3 prefix. ### `s3_config` Block The `s3_config` configuration block supports the following arguments: -* `bucket_name` – (Required) S3 bucket name. -* `key_prefix` – (Optional) S3 prefix. +* `bucket_name` - (Required) S3 bucket name. +* `key_prefix` - (Optional) S3 prefix. ## Attribute Reference @@ -138,4 +139,4 @@ Using `terraform import`, import Bedrock custom model using the `id` set to the % terraform import aws_bedrock_model_invocation_logging_configuration.my_config us-east-1 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/bedrock_provisioned_model_throughput.html.markdown b/website/docs/cdktf/python/r/bedrock_provisioned_model_throughput.html.markdown index 9cb6938cda59..5184e9ab6935 100644 --- a/website/docs/cdktf/python/r/bedrock_provisioned_model_throughput.html.markdown +++ b/website/docs/cdktf/python/r/bedrock_provisioned_model_throughput.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `commitment_duration` - (Optional) Commitment duration requested for the Provisioned Throughput. For custom models, you can purchase on-demand Provisioned Throughput by omitting this argument. Valid values: `OneMonth`, `SixMonths`. * `model_arn` - (Required) ARN of the model to associate with this Provisioned Throughput. * `model_units` - (Required) Number of model units to allocate. A model unit delivers a specific throughput level for the specified model. @@ -82,4 +83,4 @@ Using `terraform import`, import Provisioned Throughput using the `provisioned_m % terraform import aws_bedrock_provisioned_model_throughput.example arn:aws:bedrock:us-west-2:123456789012:provisioned-model/1y5n57gh5y2e ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/bedrockagent_agent.html.markdown b/website/docs/cdktf/python/r/bedrockagent_agent.html.markdown index 8fe54812c9b9..98d367f325e8 100644 --- a/website/docs/cdktf/python/r/bedrockagent_agent.html.markdown +++ b/website/docs/cdktf/python/r/bedrockagent_agent.html.markdown @@ -43,7 +43,7 @@ class MyConvertedCode(TerraformStack): example_agent_permissions = DataAwsIamPolicyDocument(self, "example_agent_permissions", statement=[DataAwsIamPolicyDocumentStatement( actions=["bedrock:InvokeModel"], - resources=["arn:${" + data_aws_partition_current.partition + "}:bedrock:${" + data_aws_region_current.name + "}::foundation-model/anthropic.claude-v2" + resources=["arn:${" + data_aws_partition_current.partition + "}:bedrock:${" + data_aws_region_current.region + "}::foundation-model/anthropic.claude-v2" ] ) ] @@ -57,7 +57,7 @@ class MyConvertedCode(TerraformStack): variable="aws:SourceAccount" ), DataAwsIamPolicyDocumentStatementCondition( test="ArnLike", - values=["arn:${" + data_aws_partition_current.partition + "}:bedrock:${" + data_aws_region_current.name + "}:${" + current.account_id + "}:agent/*" + values=["arn:${" + data_aws_partition_current.partition + "}:bedrock:${" + data_aws_region_current.region + "}:${" + current.account_id + "}:agent/*" ], variable="AWS:SourceArn" ) @@ -100,6 +100,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `agent_collaboration` - (Optional) Agents collaboration role. Valid values: `SUPERVISOR`, `SUPERVISOR_ROUTER`, `DISABLED`. * `customer_encryption_key_arn` - (Optional) ARN of the AWS KMS key that encrypts the agent. * `description` - (Optional) Description of the agent. @@ -198,4 +199,4 @@ Using `terraform import`, import Agents for Amazon Bedrock Agent using the agent % terraform import aws_bedrockagent_agent.example GGRRAED6JP ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/bedrockagent_agent_action_group.html.markdown b/website/docs/cdktf/python/r/bedrockagent_agent_action_group.html.markdown index 91d0b3e5ab2e..338720f86cc2 100644 --- a/website/docs/cdktf/python/r/bedrockagent_agent_action_group.html.markdown +++ b/website/docs/cdktf/python/r/bedrockagent_agent_action_group.html.markdown @@ -167,6 +167,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `action_group_state` - (Optional) Whether the action group is available for the agent to invoke or not when sending an [InvokeAgent](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html) request. Valid values: `ENABLED`, `DISABLED`. * `api_schema` - (Optional) Either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see [Action group OpenAPI schemas](https://docs.aws.amazon.com/bedrock/latest/userguide/agents-api-schema.html). See [`api_schema` Block](#api_schema-block) for details. * `description` - (Optional) Description of the action group. @@ -249,6 +250,7 @@ This resource exports the following attributes in addition to the arguments abov * `create` - (Default `30m`) * `update` - (Default `30m`) +* `delete` - (Default `30m`) ## Import @@ -275,4 +277,4 @@ Using `terraform import`, import Agents for Amazon Bedrock Agent Action Group th % terraform import aws_bedrockagent_agent_action_group.example MMAUDBZTH4,GGRRAED6JP,DRAFT ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/bedrockagent_agent_alias.html.markdown b/website/docs/cdktf/python/r/bedrockagent_agent_alias.html.markdown index 40212676f958..a51dd80ae47d 100644 --- a/website/docs/cdktf/python/r/bedrockagent_agent_alias.html.markdown +++ b/website/docs/cdktf/python/r/bedrockagent_agent_alias.html.markdown @@ -44,7 +44,7 @@ class MyConvertedCode(TerraformStack): example_agent_permissions = DataAwsIamPolicyDocument(self, "example_agent_permissions", statement=[DataAwsIamPolicyDocumentStatement( actions=["bedrock:InvokeModel"], - resources=["arn:${" + data_aws_partition_current.partition + "}:bedrock:${" + data_aws_region_current.name + "}::foundation-model/anthropic.claude-v2" + resources=["arn:${" + data_aws_partition_current.partition + "}:bedrock:${" + data_aws_region_current.region + "}::foundation-model/anthropic.claude-v2" ] ) ] @@ -58,7 +58,7 @@ class MyConvertedCode(TerraformStack): variable="aws:SourceAccount" ), DataAwsIamPolicyDocumentStatementCondition( test="ArnLike", - values=["arn:${" + data_aws_partition_current.partition + "}:bedrock:${" + data_aws_region_current.name + "}:${" + current.account_id + "}:agent/*" + values=["arn:${" + data_aws_partition_current.partition + "}:bedrock:${" + data_aws_region_current.region + "}:${" + current.account_id + "}:agent/*" ], variable="AWS:SourceArn" ) @@ -107,6 +107,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `description` - (Optional) Description of the alias. * `routing_configuration` - (Optional) Details about the routing configuration of the alias. See [`routing_configuration` Block](#routing_configuration-block) for details. * `tags` - (Optional) Map of tags assigned to the resource. If configured with a provider [`default_tags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. @@ -160,4 +161,4 @@ Using `terraform import`, import Agents for Amazon Bedrock Agent Alias using the % terraform import aws_bedrockagent_agent_alias.example 66IVY0GUTF,GGRRAED6JP ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/bedrockagent_agent_collaborator.html.markdown b/website/docs/cdktf/python/r/bedrockagent_agent_collaborator.html.markdown index 91f437e647f4..e549329675ef 100644 --- a/website/docs/cdktf/python/r/bedrockagent_agent_collaborator.html.markdown +++ b/website/docs/cdktf/python/r/bedrockagent_agent_collaborator.html.markdown @@ -45,11 +45,11 @@ class MyConvertedCode(TerraformStack): example_agent_permissions = DataAwsIamPolicyDocument(self, "example_agent_permissions", statement=[DataAwsIamPolicyDocumentStatement( actions=["bedrock:InvokeModel"], - resources=["arn:${" + data_aws_partition_current.partition + "}:bedrock:${" + data_aws_region_current.name + "}::foundation-model/anthropic.claude-3-5-sonnet-20241022-v2:0" + resources=["arn:${" + data_aws_partition_current.partition + "}:bedrock:${" + data_aws_region_current.region + "}::foundation-model/anthropic.claude-3-5-sonnet-20241022-v2:0" ] ), DataAwsIamPolicyDocumentStatement( actions=["bedrock:GetAgentAlias", "bedrock:InvokeAgent"], - resources=["arn:${" + current_agent.partition + "}:bedrock:${" + data_aws_region_current.name + "}:${" + current.account_id + "}:agent/*", "arn:${" + current_agent.partition + "}:bedrock:${" + data_aws_region_current.name + "}:${" + current.account_id + "}:agent-alias/*" + resources=["arn:${" + current_agent.partition + "}:bedrock:${" + data_aws_region_current.region + "}:${" + current.account_id + "}:agent/*", "arn:${" + current_agent.partition + "}:bedrock:${" + data_aws_region_current.region + "}:${" + current.account_id + "}:agent-alias/*" ] ) ] @@ -63,7 +63,7 @@ class MyConvertedCode(TerraformStack): variable="aws:SourceAccount" ), DataAwsIamPolicyDocumentStatementCondition( test="ArnLike", - values=["arn:${" + data_aws_partition_current.partition + "}:bedrock:${" + data_aws_region_current.name + "}:${" + current.account_id + "}:agent/*" + values=["arn:${" + data_aws_partition_current.partition + "}:bedrock:${" + data_aws_region_current.region + "}:${" + current.account_id + "}:agent/*" ], variable="AWS:SourceArn" ) @@ -130,10 +130,11 @@ The following arguments are required: * `agent_id` - (Required) ID if the agent to associate the collaborator. * `collaboration_instruction` - (Required) Instruction to give the collaborator. -* `collbaorator_name` - (Required) Name of this collaborator. +* `collaborator_name` - (Required) Name of this collaborator. The following arguments are optional: +* `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). * `prepare_agent` (Optional) Whether to prepare the agent after creation or modification. Defaults to `true`. * `relay_conversation_history` - (Optional) Configure relaying the history to the collaborator. @@ -182,4 +183,4 @@ Using `terraform import`, import Bedrock Agents Agent Collaborator using a comma % terraform import aws_bedrockagent_agent_collaborator.example 9LSJO0BFI8,DRAFT,AG3TN4RQIY ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/bedrockagent_agent_knowledge_base_association.html.markdown b/website/docs/cdktf/python/r/bedrockagent_agent_knowledge_base_association.html.markdown index 1cf7d3bc6038..591872538860 100644 --- a/website/docs/cdktf/python/r/bedrockagent_agent_knowledge_base_association.html.markdown +++ b/website/docs/cdktf/python/r/bedrockagent_agent_knowledge_base_association.html.markdown @@ -46,6 +46,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `agent_version` - (Optional, Forces new resource) Version of the agent with which you want to associate the knowledge base. Valid values: `DRAFT`. ## Attribute Reference @@ -60,6 +61,7 @@ This resource exports the following attributes in addition to the arguments abov * `create` - (Default `5m`) * `update` - (Default `5m`) +* `delete` - (Default `5m`) ## Import @@ -86,4 +88,4 @@ Using `terraform import`, import Agents for Amazon Bedrock Agent Knowledge Base % terraform import aws_bedrockagent_agent_knowledge_base_association.example GGRRAED6JP,DRAFT,EMDPPAYPZI ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/bedrockagent_data_source.html.markdown b/website/docs/cdktf/python/r/bedrockagent_data_source.html.markdown index 95f257852ecb..fe8af993826e 100644 --- a/website/docs/cdktf/python/r/bedrockagent_data_source.html.markdown +++ b/website/docs/cdktf/python/r/bedrockagent_data_source.html.markdown @@ -52,6 +52,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `data_deletion_policy` - (Optional) Data deletion policy for a data source. Valid values: `RETAIN`, `DELETE`. * `description` - (Optional) Description of the data source. * `server_side_encryption_configuration` - (Optional) Details about the configuration of the server-side encryption. See [`server_side_encryption_configuration` block](#server_side_encryption_configuration-block) for details. @@ -351,4 +352,4 @@ Using `terraform import`, import Agents for Amazon Bedrock Data Source using the [3]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_SharePointDataSourceConfiguration.html [4]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_WebDataSourceConfiguration.html - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/bedrockagent_flow.html.markdown b/website/docs/cdktf/python/r/bedrockagent_flow.html.markdown new file mode 100644 index 000000000000..c6cb452e6471 --- /dev/null +++ b/website/docs/cdktf/python/r/bedrockagent_flow.html.markdown @@ -0,0 +1,434 @@ +--- +subcategory: "Bedrock Agents" +layout: "aws" +page_title: "AWS: aws_bedrockagent_flow" +description: |- + Terraform resource for managing an AWS Bedrock Agents Flow. +--- + + + +# Resource: aws_bedrockagent_flow + +Terraform resource for managing an AWS Bedrock Agents Flow. + +### 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.bedrockagent_flow import BedrockagentFlow +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + BedrockagentFlow(self, "example", + execution_role_arn=Token.as_string(aws_iam_role_example.arn), + name="example-flow" + ) +``` + +## Example Usage + +The default definition: + +```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.bedrockagent_flow import BedrockagentFlow +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + BedrockagentFlow(self, "example", + definition=[BedrockagentFlowDefinition( + connection={ + "configuration": [{ + "data": [{ + "source_output": "document", + "target_input": "topic" + } + ] + } + ], + "name": "FlowInputNodeFlowInputNode0ToPrompt_1PromptsNode0", + "source": "FlowInputNode", + "target": "Prompt_1", + "type": "Data" + }, + node_attribute=[BedrockagentFlowDefinitionNode( + configuration=[BedrockagentFlowDefinitionNodeConfiguration( + input=[BedrockagentFlowDefinitionNodeConfigurationInput()] + ) + ], + name="FlowInputNode", + output=[BedrockagentFlowDefinitionNodeOutput( + name="document", + type="String" + ) + ], + type="Input" + ), BedrockagentFlowDefinitionNode( + configuration=[BedrockagentFlowDefinitionNodeConfiguration( + prompt=[BedrockagentFlowDefinitionNodeConfigurationPrompt( + source_configuration=[BedrockagentFlowDefinitionNodeConfigurationPromptSourceConfiguration( + inline=[BedrockagentFlowDefinitionNodeConfigurationPromptSourceConfigurationInline( + inference_configuration=[BedrockagentFlowDefinitionNodeConfigurationPromptSourceConfigurationInlineInferenceConfiguration( + text=[BedrockagentFlowDefinitionNodeConfigurationPromptSourceConfigurationInlineInferenceConfigurationText( + max_tokens=2048, + stop_sequences=["User:"], + temperature=0, + top_p=0.8999999761581421 + ) + ] + ) + ], + model_id="amazon.titan-text-express-v1", + template_configuration=[BedrockagentFlowDefinitionNodeConfigurationPromptSourceConfigurationInlineTemplateConfiguration( + text=[BedrockagentFlowDefinitionNodeConfigurationPromptSourceConfigurationInlineTemplateConfigurationText( + input_variable=[BedrockagentFlowDefinitionNodeConfigurationPromptSourceConfigurationInlineTemplateConfigurationTextInputVariable( + name="topic" + ) + ], + text="Write a paragraph about {{topic}}." + ) + ] + ) + ], + template_type="TEXT" + ) + ] + ) + ] + ) + ] + ) + ], + input=[BedrockagentFlowDefinitionNodeInput( + expression="$.data", + name="topic", + type="String" + ) + ], + name="Prompt_1", + output=[BedrockagentFlowDefinitionNodeOutput( + name="modelCompletion", + type="String" + ) + ], + type="Prompt" + ), BedrockagentFlowDefinitionNode( + configuration=[BedrockagentFlowDefinitionNodeConfiguration( + output=[BedrockagentFlowDefinitionNodeConfigurationOutput()] + ) + ], + input=[BedrockagentFlowDefinitionNodeInput( + expression="$.data", + name="document", + type="String" + ) + ], + name="FlowOutputNode", + type="Output" + ) + ] + ) + ], + execution_role_arn=Token.as_string(aws_iam_role_example.arn), + name="example" + ) +``` + +## Argument Reference + +The following arguments are required: + +* `name` - (Required) A name for the flow. +* `execution_role_arn` - (Required) The Amazon Resource Name (ARN) of the service role with permissions to create and manage a flow. For more information, see [Create a service role for flows in Amazon Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/flows-permissions.html) in the Amazon Bedrock User Guide. + +The following arguments are optional: + +* `description` - (Optional) A description for the flow. +* `customer_encryption_key_arn` - (Optional) The Amazon Resource Name (ARN) of the KMS key to encrypt the flow. +* `definition` - (Optional) A definition of the nodes and connections between nodes in the flow. See [Definition](#definition) for more information. +* `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). +* `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. + +### Definition + +* `connection` - (Optional) A list of connection definitions in the flow. See [Connection](#connection) for more information. +* `node` - (Optional) A list of node definitions in the flow. See [Node](#node) for more information. + +### Connection + +* `name` - (Required) A name for the connection that you can reference. +* `source` - (Required) The node that the connection starts at. +* `target` - (Required) The node that the connection ends at. +* `type` - (Required) Whether the source node that the connection begins from is a condition node `Conditional` or not `Data`. +* `configuration` - (Required) Configuration of the connection. See [Connection Configuration](#connection-configuration) for more information. + +### Connection Configuration + +* `data` - (Optional) The configuration of a connection originating from a node that isn’t a Condition node. See [Data Connection Configuration](#data-connection-configuration) for more information. +* `conditional` - (Optional) The configuration of a connection originating from a Condition node. See [Conditional Connection Configuration](#conditional-connection-configuration) for more information. + +#### Data Connection Configuration + +* `source_output` - (Required) The name of the output in the source node that the connection begins from. +* `target_input` - (Required) The name of the input in the target node that the connection ends at. + +#### Conditional Connection Configuration + +* `condition` - (Required) The condition that triggers this connection. For more information about how to write conditions, see the Condition node type in the [Node types](https://docs.aws.amazon.com/bedrock/latest/userguide/node-types.html) topic in the Amazon Bedrock User Guide. + +### Node + +* `name` - (Required) A name for the node. +* `type` - (Required) The type of node. This value must match the name of the key that you provide in the configuration. Valid values: `Agent`, `Collector`, `Condition`, `Input`, `Iterator`, `KnowledgeBase`, `LambdaFunction`, `Lex`, `Output`, `Prompt`, `Retrieval`, `Storage` +* `configuration` - (Required) Contains configurations for the node. See [Node Configuration](#node-configuration) for more information. +* `input` - (Optional) A list of objects containing information about an input into the node. See [Node Input](#node-input) for more information. +* `output` - (Optional) A list of objects containing information about an output from the node. See [Node Output](#node-output) for more information. + +### Node Input + +* `name` - (Required) A name for the input that you can reference. +* `type` - (Required) The data type of the input. If the input doesn’t match this type at runtime, a validation error will be thrown. +* `expression` - (Required) An expression that formats the input for the node. For an explanation of how to create expressions, see [Expressions in Prompt flows in Amazon Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/flows-expressions.html). +* `category` - (Optional) How input data flows between iterations in a DoWhile loop. + +### Node Output + +* `name` - (Required) A name for the output that you can reference. +* `type` - (Required) The data type of the output. If the output doesn’t match this type at runtime, a validation error will be thrown. + +### Node Configuration + +* `agent` - (Optional) Contains configurations for an agent node in your flow. Invokes an alias of an agent and returns the response. See [Agent Node Configuration](#agent-node-configuration) for more information. +* `collector` - (Optional) Contains configurations for a collector node in your flow. Collects an iteration of inputs and consolidates them into an array of outputs. This object has no fields. +* `condition` - (Optional) Contains configurations for a Condition node in your flow. Defines conditions that lead to different branches of the flow. See [Condition Node Configuration](#condition-node-configuration) for more information. +* `inline_code` - (Optional) Contains configurations for an inline code node in your flow. See [Inline Code Node Configuration](#inline-code-node-configuration) for more information. +* `input` - (Optional) Contains configurations for an input flow node in your flow. The node `inputs` can’t be specified for this node. This object has no fields. +* `iterator` - (Optional) Contains configurations for an iterator node in your flow. Takes an input that is an array and iteratively sends each item of the array as an output to the following node. The size of the array is also returned in the output. The output flow node at the end of the flow iteration will return a response for each member of the array. To return only one response, you can include a collector node downstream from the iterator node. This object has no fields. +* `knowledge_base` - (Optional) Contains configurations for a knowledge base node in your flow. Queries a knowledge base and returns the retrieved results or generated response. See [Knowledge Base Node Configuration](#knowledge-base-node-configuration) for more information. +* `lambda_function` - (Optional) Contains configurations for a Lambda function node in your flow. Invokes a Lambda function. See [Lambda Function Node Configuration](#lambda-function-node-configuration) for more information. +* `lex` - (Optional) Contains configurations for a Lex node in your flow. Invokes an Amazon Lex bot to identify the intent of the input and return the intent as the output. See [Lex Node Configuration](#lex-node-configuration) for more information. +* `output` - (Optional) Contains configurations for an output flow node in your flow. The node `outputs` can’t be specified for this node. This object has no fields. +* `prompt` - (Optional) Contains configurations for a prompt node in your flow. Runs a prompt and generates the model response as the output. You can use a prompt from Prompt management or you can configure one in this node. See [Prompt Node Configuration](#prompt-node-configuration) for more information. +* `retrieval` - (Optional) Contains configurations for a Retrieval node in your flow. Retrieves data from an Amazon S3 location and returns it as the output. See [Retrieval Node Configuration](#retrieval-node-configuration) for more information. +* `storage` - (Optional) Contains configurations for a Storage node in your flow. Stores an input in an Amazon S3 location. See [Storage Node Configuration](#storage-node-configuration) for more information. + +### Agent Node Configuration + +* `agent_alias_arn` - (Required) The Amazon Resource Name (ARN) of the alias of the agent to invoke. + +### Condition Node Configuration + +* `condition` - (Optional) A list of conditions. See [Condition Config](#condition-config) for more information. + +#### Condition Config + +* `name` - (Required) A name for the condition that you can reference. +* `expression` - (Optional) Defines the condition. You must refer to at least one of the inputs in the condition. For more information, expand the Condition node section in [Node types in prompt flows](https://docs.aws.amazon.com/bedrock/latest/userguide/flows-how-it-works.html#flows-nodes). + +### Inline Code Node Configuration + +* `code` - (Required) The code that's executed in your inline code node. +* `language` - (Required) The programming language used by your inline code node. + +### Knowledge Base Node Configuration + +* `knowledge_base_id` - (Required) The unique identifier of the knowledge base to query. +* `model_id` - (Required) The unique identifier of the model or inference profile to use to generate a response from the query results. Omit this field if you want to return the retrieved results as an array. +* `guardrail_configuration` - (Required) Contains configurations for a guardrail to apply during query and response generation for the knowledge base in this configuration. See [Guardrail Configuration](#guardrail-configuration) for more information. + +#### Guardrail Configuration + +* `guardrail_identifier` - (Required) The unique identifier of the guardrail. +* `guardrail_version` - (Required) The version of the guardrail. + +### Lambda Function Node Configuration + +* `lambda_arn` - (Required) The Amazon Resource Name (ARN) of the Lambda function to invoke. + +### Lex Node Configuration + +* `bot_alias_arn` - (Required) The Amazon Resource Name (ARN) of the Amazon Lex bot alias to invoke. +* `locale_id` - (Required) The Region to invoke the Amazon Lex bot in + +### Prompt Node Configuration + +* `resource` - (Optional) Contains configurations for a prompt from Prompt management. See [Prompt Resource Configuration](#prompt-resource-configuration) for more information. +* `inline` - (Optional) Contains configurations for a prompt that is defined inline. See [Prompt Inline Configuration](#prompt-inline-configuration) for more information. + +#### Prompt Resource Configuration + +* `prompt_arn` - (Required) The Amazon Resource Name (ARN) of the prompt from Prompt management. + +#### Prompt Inline Configuration + +* `additional_model_request_fields` - (Optional) Additional fields to be included in the model request for the Prompt node. +* `inference_configuration` - (Optional) Contains inference configurations for the prompt. See [Prompt Inference Configuration](#prompt-inference-configuration) for more information. +* `model_id` - (Required) The unique identifier of the model or [inference profile](https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference.html) to run inference with. +* `template_type` - (Required) The type of prompt template. Valid values: `TEXT`, `CHAT`. +* `template_configuration` - (Required) Contains a prompt and variables in the prompt that can be replaced with values at runtime. See [Prompt Template Configuration](#prompt-template-configuration) for more information. + +#### Prompt Inference Configuration + +* `text` - (Optional) Contains inference configurations for a text prompt. See [Text Inference Configuration](#text-inference-configuration) for more information. + +#### Text Inference Configuration + +* `max_tokens` - (Optional) Maximum number of tokens to return in the response. +* `stop_sequences` - (Optional) List of strings that define sequences after which the model will stop generating. +* `temperature` - (Optional) Controls the randomness of the response. Choose a lower value for more predictable outputs and a higher value for more surprising outputs. +* `top_p` - (Optional) Percentage of most-likely candidates that the model considers for the next token. + +#### Prompt Template Configuration + +* `text` - (Optional) Contains configurations for the text in a message for a prompt. See [Text Template Configuration](#text-template-configuration) +* `chat` - (Optional) Contains configurations to use the prompt in a conversational format. See [Chat Template Configuration](#chat-template-configuration) for more information. + +#### Text Template Configuration + +* `text` - (Required) The message for the prompt. +* `input_variable` - (Optional) A list of variables in the prompt template. See [Input Variable](#input-variable) for more information. +* `cache_point` - (Optional) A cache checkpoint within a template configuration. See [Cache Point](#cache-point) for more information. + +#### Chat Template Configuration + +* `input_variable` - (Optional) A list of variables in the prompt template. See [Input Variable](#input-variable) for more information. +* `message` - (Optional) A list of messages in the chat for the prompt. See [Message](#message) for more information. +* `system` - (Optional) A list of system prompts to provide context to the model or to describe how it should behave. See [System](#system) for more information. +* `tool_configuration` - (Optional) Configuration information for the tools that the model can use when generating a response. See [Tool Configuration](#tool-configuration) for more information. + +#### Message + +* `role` - (Required) The role that the message belongs to. +* `content` - (Required) Contains the content for the message you pass to, or receive from a model. See [Message Content] for more information. + +#### Message Content + +* `cache_point` - (Optional) Creates a cache checkpoint within a message. See [Cache Point](#cache-point) for more information. +* `text` - (Optional) The text in the message. + +#### System + +* `cache_point` - (Optional) Creates a cache checkpoint within a tool designation. See [Cache Point](#cache-point) for more information. +* `text` - (Optional) The text in the system prompt. + +#### Tool Configuration + +* `tool_choice` - (Optional) Defines which tools the model should request when invoked. See [Tool Choice](#tool-choice) for more information. +* `tool` - (Optional) A list of tools to pass to a model. See [Tool](#tool) for more information. + +#### Tool Choice + +* `any` - (Optional) Defines tools, at least one of which must be requested by the model. No text is generated but the results of tool use are sent back to the model to help generate a response. This object has no fields. +* `auto` - (Optional) Defines tools. The model automatically decides whether to call a tool or to generate text instead. This object has no fields. +* `tool` - (Optional) Defines a specific tool that the model must request. No text is generated but the results of tool use are sent back to the model to help generate a response. See [Named Tool](#named-tool) for more information. + +#### Named Tool + +* `name` - (Required) The name of the tool. + +#### Tool + +* `cache_point` - (Optional) Creates a cache checkpoint within a tool designation. See [Cache Point](#cache-point) for more information. +* `tool_spec` - (Optional) The specification for the tool. See [Tool Specification](#tool-specification) for more information. + +#### Tool Specification + +* `name` - (Required) The name of the tool. +* `description` - (Optional) The description of the tool. +* `input_schema` - (Optional) The input schema of the tool. See [Tool Input Schema](#tool-input-schema) for more information. + +#### Tool Input Schema + +* `json` - (Optional) A JSON object defining the input schema for the tool. + +#### Input Variable + +* `name` - (Required) The name of the variable. + +#### Cache Point + +* `type` - (Required) Indicates that the CachePointBlock is of the default type. Valid values: `default`. + +### Retrieval Node Configuration + +* `service_configuration` - (Required) Contains configurations for the service to use for retrieving data to return as the output from the node. See [Retrieval Service Configuration](#retrieval-service-configuration) for more information. + +#### Retrieval Service Configuration + +* `s3` - (Optional) Contains configurations for the Amazon S3 location from which to retrieve data to return as the output from the node. See [Retrieval S3 Service Configuration](#retrieval-s3-service-configuration) for more information. + +#### Retrieval S3 Service Configuration + +* `bucket_name` - (Required) The name of the Amazon S3 bucket from which to retrieve data. + +### Storage Node Configuration + +* `service_configuration` - (Required) Contains configurations for a Storage node in your flow. Stores an input in an Amazon S3 location. See [Storage Service Configuration](#storage-service-configuration) for more information. + +#### Storage Service Configuration + +* `s3` - (Optional) Contains configurations for the service to use for storing the input into the node. See [Storage S3 Service Configuration](#storage-s3-service-configuration) for more information. + +#### Storage S3 Service Configuration + +* `bucket_name` - (Required) The name of the Amazon S3 bucket in which to store the input into the node. + +## Attribute Reference + +This resource exports the following attributes in addition to the arguments above: + +* `arn` - The Amazon Resource Name (ARN) of the flow. +* `id` - The unique identifier of the flow. +* `created_at` - The time at which the flow was created. +* `updated_at` - The time at which the flow was last updated. +* `version` - The version of the flow. +* `status` - The status of the flow. +* `tags_all` - A map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). + +## Timeouts + +[Configuration options](https://developer.hashicorp.com/terraform/language/resources/syntax#operation-timeouts): + +* `create` - (Default `5m`) +* `update` - (Default `5m`) +* `delete` - (Default `5m`) + +## Import + +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import Bedrock Agents Flow using the `id`. 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.bedrockagent_flow import BedrockagentFlow +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + BedrockagentFlow.generate_config_for_import(self, "example", "ABCDEFGHIJ") +``` + +Using `terraform import`, import Bedrock Agents Flow using the `id`. For example: + +```console +% terraform import aws_bedrockagent_flow.example ABCDEFGHIJ +``` + + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/bedrockagent_knowledge_base.html.markdown b/website/docs/cdktf/python/r/bedrockagent_knowledge_base.html.markdown index 4008122704c4..8ce28e694607 100644 --- a/website/docs/cdktf/python/r/bedrockagent_knowledge_base.html.markdown +++ b/website/docs/cdktf/python/r/bedrockagent_knowledge_base.html.markdown @@ -76,24 +76,24 @@ class MyConvertedCode(TerraformStack): type="VECTOR", vector_knowledge_base_configuration=[BedrockagentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfiguration( embedding_model_arn="arn:aws:bedrock:us-west-2::foundation-model/amazon.titan-embed-text-v2:0", - embedding_model_configuration=[{ - "bedrock_embedding_model_configuration": [{ - "dimensions": 1024, - "embedding_data_type": "FLOAT32" - } + embedding_model_configuration=[BedrockagentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfigurationEmbeddingModelConfiguration( + bedrock_embedding_model_configuration=[BedrockagentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfigurationEmbeddingModelConfigurationBedrockEmbeddingModelConfiguration( + dimensions=1024, + embedding_data_type="FLOAT32" + ) ] - } + ) ], - supplemental_data_storage_configuration=[{ - "storage_location": [{ - "s3_location": [{ - "uri": "s3://my-bucket/chunk-processor/" - } + supplemental_data_storage_configuration=[BedrockagentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfigurationSupplementalDataStorageConfiguration( + storage_location=[BedrockagentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfigurationSupplementalDataStorageConfigurationStorageLocation( + s3_location=[BedrockagentKnowledgeBaseKnowledgeBaseConfigurationVectorKnowledgeBaseConfigurationSupplementalDataStorageConfigurationStorageLocationS3Location( + uri="s3://my-bucket/chunk-processor/" + ) ], - "type": "S3" - } + type="S3" + ) ] - } + ) ] ) ] @@ -130,6 +130,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `description` - (Optional) Description of the knowledge base. * `tags` - (Optional) Map of tags assigned to the resource. If configured with a provider [`default_tags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. @@ -281,4 +282,4 @@ Using `terraform import`, import Agents for Amazon Bedrock Knowledge Base using % terraform import aws_bedrockagent_knowledge_base.example EMDPPAYPZI ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/bedrockagent_prompt.html.markdown b/website/docs/cdktf/python/r/bedrockagent_prompt.html.markdown index 272b9fbc5c4c..655496e756db 100644 --- a/website/docs/cdktf/python/r/bedrockagent_prompt.html.markdown +++ b/website/docs/cdktf/python/r/bedrockagent_prompt.html.markdown @@ -88,6 +88,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `description` - (Optional) Description of the prompt. * `default_variant` - (Optional) Name of the default variant for your prompt. * `customer_encryption_key_arn` - (Optional) Amazon Resource Name (ARN) of the KMS key that you encrypted the prompt with. @@ -236,4 +237,4 @@ Using `terraform import`, import Bedrock Agents Prompt using the `id`. For examp % terraform import aws_bedrockagent_prompt.example 1A2BC3DEFG ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/chatbot_slack_channel_configuration.html.markdown b/website/docs/cdktf/python/r/chatbot_slack_channel_configuration.html.markdown index d1dc24b3d564..c517afd32b80 100644 --- a/website/docs/cdktf/python/r/chatbot_slack_channel_configuration.html.markdown +++ b/website/docs/cdktf/python/r/chatbot_slack_channel_configuration.html.markdown @@ -50,6 +50,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `guardrail_policy_arns` - (Optional) List of IAM policy ARNs that are applied as channel guardrails. The AWS managed `AdministratorAccess` policy is applied by default if this is not set. * `logging_level` - (Optional) Logging levels include `ERROR`, `INFO`, or `NONE`. * `sns_topic_arns` - (Optional) ARNs of the SNS topics that deliver notifications to AWS Chatbot. @@ -98,4 +99,4 @@ Using `terraform import`, import Chatbot Slack Channel Configuration using the ` % terraform import aws_chatbot_slack_channel_configuration.example arn:aws:chatbot::123456789012:chat-configuration/slack-channel/min-slaka-kanal ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/chatbot_teams_channel_configuration.html.markdown b/website/docs/cdktf/python/r/chatbot_teams_channel_configuration.html.markdown index d07a4803ff85..d77d66e4b772 100644 --- a/website/docs/cdktf/python/r/chatbot_teams_channel_configuration.html.markdown +++ b/website/docs/cdktf/python/r/chatbot_teams_channel_configuration.html.markdown @@ -54,6 +54,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `channel_name` - (Optional) Name of the Microsoft Teams channel. * `guardrail_policy_arns` - (Optional) List of IAM policy ARNs that are applied as channel guardrails. The AWS managed `AdministratorAccess` policy is applied by default if this is not set. * `logging_level` - (Optional) Logging levels include `ERROR`, `INFO`, or `NONE`. @@ -102,4 +103,4 @@ Using `terraform import`, import Chatbot Microsoft Teams Channel Configuration u % terraform import aws_chatbot_teams_channel_configuration.example 5f4f15d2-b958-522a-8333-124aa8bf0925 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/chime_voice_connector.html.markdown b/website/docs/cdktf/python/r/chime_voice_connector.html.markdown index 210110e47ec5..163f537f7fb3 100644 --- a/website/docs/cdktf/python/r/chime_voice_connector.html.markdown +++ b/website/docs/cdktf/python/r/chime_voice_connector.html.markdown @@ -42,6 +42,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `aws_region` - (Optional) The AWS Region in which the Amazon Chime Voice Connector is created. Default value: `us-east-1` * `tags` - (Optional) Key-value mapping of resource tags. If configured with a provider [`default_tags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. @@ -78,4 +79,4 @@ Using `terraform import`, import Configuration Recorder using the name. For exam % terraform import aws_chime_voice_connector.test example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/chime_voice_connector_group.html.markdown b/website/docs/cdktf/python/r/chime_voice_connector_group.html.markdown index 222b165bed4d..328ec145cde7 100644 --- a/website/docs/cdktf/python/r/chime_voice_connector_group.html.markdown +++ b/website/docs/cdktf/python/r/chime_voice_connector_group.html.markdown @@ -56,6 +56,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) The name of the Amazon Chime Voice Connector group. * `connector` - (Optional) The Amazon Chime Voice Connectors to route inbound calls to. @@ -97,4 +98,4 @@ Using `terraform import`, import Configuration Recorder using the name. For exam % terraform import aws_chime_voice_connector_group.default example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/chime_voice_connector_logging.html.markdown b/website/docs/cdktf/python/r/chime_voice_connector_logging.html.markdown index 94d45b816e81..f1e89dd3efb1 100644 --- a/website/docs/cdktf/python/r/chime_voice_connector_logging.html.markdown +++ b/website/docs/cdktf/python/r/chime_voice_connector_logging.html.markdown @@ -44,6 +44,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `voice_connector_id` - (Required) The Amazon Chime Voice Connector ID. * `enable_sip_logs` - (Optional) When true, enables SIP message logs for sending to Amazon CloudWatch Logs. * `enable_media_metric_logs` - (Optional) When true, enables logging of detailed media metrics for Voice Connectors to Amazon CloudWatch logs. @@ -79,4 +80,4 @@ Using `terraform import`, import Chime Voice Connector Logging using the `voice_ % terraform import aws_chime_voice_connector_logging.default abcdef1ghij2klmno3pqr4 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/chime_voice_connector_origination.html.markdown b/website/docs/cdktf/python/r/chime_voice_connector_origination.html.markdown index 7004c17d0669..2d0fb4e5e977 100644 --- a/website/docs/cdktf/python/r/chime_voice_connector_origination.html.markdown +++ b/website/docs/cdktf/python/r/chime_voice_connector_origination.html.markdown @@ -58,6 +58,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `voice_connector_id` - (Required) The Amazon Chime Voice Connector ID. * `route` - (Required) Set of call distribution properties defined for your SIP hosts. See [route](#route) below for more details. Minimum of 1. Maximum of 20. * `disabled` - (Optional) When origination settings are disabled, inbound calls are not enabled for your Amazon Chime Voice Connector. @@ -103,4 +104,4 @@ Using `terraform import`, import Chime Voice Connector Origination using the `vo % terraform import aws_chime_voice_connector_origination.default abcdef1ghij2klmno3pqr4 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/chime_voice_connector_streaming.html.markdown b/website/docs/cdktf/python/r/chime_voice_connector_streaming.html.markdown index 533cfbbeb20c..fa8be5a6bc57 100644 --- a/website/docs/cdktf/python/r/chime_voice_connector_streaming.html.markdown +++ b/website/docs/cdktf/python/r/chime_voice_connector_streaming.html.markdown @@ -126,6 +126,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `voice_connector_id` - (Required) The Amazon Chime Voice Connector ID. * `data_retention` - (Required) The retention period, in hours, for the Amazon Kinesis data. * `disabled` - (Optional) When true, media streaming to Amazon Kinesis is turned off. Default: `false` @@ -168,4 +169,4 @@ Using `terraform import`, import Chime Voice Connector Streaming using the `voic % terraform import aws_chime_voice_connector_streaming.default abcdef1ghij2klmno3pqr4 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/chime_voice_connector_termination.html.markdown b/website/docs/cdktf/python/r/chime_voice_connector_termination.html.markdown index 817269f149f6..a3b47d00688e 100644 --- a/website/docs/cdktf/python/r/chime_voice_connector_termination.html.markdown +++ b/website/docs/cdktf/python/r/chime_voice_connector_termination.html.markdown @@ -47,6 +47,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `voice_connector_id` - (Required) The Amazon Chime Voice Connector ID. * `cidr_allow_list` - (Required) The IP addresses allowed to make calls, in CIDR format. * `calling_regions` - (Required) The countries to which calls are allowed, in ISO 3166-1 alpha-2 format. @@ -85,4 +86,4 @@ Using `terraform import`, import Chime Voice Connector Termination using the `vo % terraform import aws_chime_voice_connector_termination.default abcdef1ghij2klmno3pqr4 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/chime_voice_connector_termination_credentials.html.markdown b/website/docs/cdktf/python/r/chime_voice_connector_termination_credentials.html.markdown index bd081ac48335..64f6fdbb69f0 100644 --- a/website/docs/cdktf/python/r/chime_voice_connector_termination_credentials.html.markdown +++ b/website/docs/cdktf/python/r/chime_voice_connector_termination_credentials.html.markdown @@ -62,6 +62,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `voice_connector_id` - (Required) Amazon Chime Voice Connector ID. * `credentials` - (Required) List of termination SIP credentials. @@ -103,4 +104,4 @@ Using `terraform import`, import Chime Voice Connector Termination Credentials u % terraform import aws_chime_voice_connector_termination_credentials.default abcdef1ghij2klmno3pqr4 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/chimesdkmediapipelines_media_insights_pipeline_configuration.html.markdown b/website/docs/cdktf/python/r/chimesdkmediapipelines_media_insights_pipeline_configuration.html.markdown index 95a6c56b8dd0..52e02c867dd4 100644 --- a/website/docs/cdktf/python/r/chimesdkmediapipelines_media_insights_pipeline_configuration.html.markdown +++ b/website/docs/cdktf/python/r/chimesdkmediapipelines_media_insights_pipeline_configuration.html.markdown @@ -319,6 +319,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) Configuration name. * `resource_access_role_arn` - (Required) ARN of IAM Role used by service to invoke processors and sinks specified by configuration elements. * `elements` - (Required) Collection of processors and sinks to transform media and deliver data. @@ -429,4 +430,4 @@ Using `terraform import`, import Chime SDK Media Pipelines Media Insights Pipeli % terraform import aws_chimesdkmediapipelines_media_insights_pipeline_configuration.example abcdef123456 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/chimesdkvoice_sip_media_application.html.markdown b/website/docs/cdktf/python/r/chimesdkvoice_sip_media_application.html.markdown index a5ed50234036..2ca12a13a4bf 100644 --- a/website/docs/cdktf/python/r/chimesdkvoice_sip_media_application.html.markdown +++ b/website/docs/cdktf/python/r/chimesdkvoice_sip_media_application.html.markdown @@ -47,6 +47,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `tags` - (Optional) Key-value mapping of resource tags. If configured with a provider [`default_tags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. ### `endpoints` @@ -88,4 +89,4 @@ Using `terraform import`, import a ChimeSDKVoice SIP Media Application using the % terraform import aws_chimesdkvoice_sip_media_application.example abcdef123456 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/chimesdkvoice_sip_rule.html.markdown b/website/docs/cdktf/python/r/chimesdkvoice_sip_rule.html.markdown index 99ab91026700..2e71f49a4735 100644 --- a/website/docs/cdktf/python/r/chimesdkvoice_sip_rule.html.markdown +++ b/website/docs/cdktf/python/r/chimesdkvoice_sip_rule.html.markdown @@ -51,6 +51,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `disabled` - (Optional) Enables or disables a rule. You must disable rules before you can delete them. ### `target_applications` @@ -92,4 +93,4 @@ Using `terraform import`, import a ChimeSDKVoice SIP Rule using the `id`. For ex % terraform import aws_chimesdkvoice_sip_rule.example abcdef123456 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/chimesdkvoice_voice_profile_domain.html.markdown b/website/docs/cdktf/python/r/chimesdkvoice_voice_profile_domain.html.markdown index e9a5612f6b13..d62ec981d2d2 100644 --- a/website/docs/cdktf/python/r/chimesdkvoice_voice_profile_domain.html.markdown +++ b/website/docs/cdktf/python/r/chimesdkvoice_voice_profile_domain.html.markdown @@ -58,6 +58,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `description` - (Optional) Description of Voice Profile Domain. ## Attribute Reference @@ -100,4 +101,4 @@ Using `terraform import`, import AWS Chime SDK Voice Profile Domain using the `i % terraform import aws_chimesdkvoice_voice_profile_domain.example abcdef123456 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/cleanrooms_collaboration.html.markdown b/website/docs/cdktf/python/r/cleanrooms_collaboration.html.markdown index bd7947283cc5..1042dc98bfa5 100644 --- a/website/docs/cdktf/python/r/cleanrooms_collaboration.html.markdown +++ b/website/docs/cdktf/python/r/cleanrooms_collaboration.html.markdown @@ -10,13 +10,11 @@ description: |- # Resource: aws_cleanrooms_collaboration -Provides a AWS Clean Rooms collaboration. All members included in the definition will be invited to -join the collaboration and can create memberships. +Provides a AWS Clean Rooms collaboration. +All members included in the definition will be invited to join the collaboration and can create memberships. ## Example Usage -### Collaboration with tags - ```python # DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug from constructs import Construct @@ -30,6 +28,7 @@ class MyConvertedCode(TerraformStack): def __init__(self, scope, name, *, memberAbilities): super().__init__(scope, name) CleanroomsCollaboration(self, "test_collaboration", + analytics_engine="SPARK", creator_display_name="Creator ", creator_member_abilities=["CAN_QUERY", "CAN_RECEIVE_RESULTS"], data_encryption_metadata=CleanroomsCollaborationDataEncryptionMetadata( @@ -55,7 +54,7 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -This resource supports the following arguments: +The following arguments are required: * `name` - (Required) - The name of the collaboration. Collaboration names do not need to be unique. * `description` - (Required) - A description for a collaboration. @@ -63,6 +62,10 @@ This resource supports the following arguments: * `creator_display_name` - (Required - Forces new resource) - The name for the member record for the collaboration creator. * `query_log_status` - (Required - Forces new resource) - Determines if members of the collaboration can enable query logs within their own. emberships. Valid values [may be found here](https://docs.aws.amazon.com/clean-rooms/latest/apireference/API_CreateCollaboration.html#API-CreateCollaboration-request-queryLogStatus). + +The following arguments are optional: + +* `analytics_engine` - (Optional) Analytics engine used by the collaboration. Valid values are `CLEAN_ROOMS_SQL` (deprecated) and `SPARK`. * `data_encryption_metadata` - (Required - Forces new resource) - a collection of settings which determine how the [c3r client](https://docs.aws.amazon.com/clean-rooms/latest/userguide/crypto-computing.html) will encrypt data for use within this collaboration. * `data_encryption_metadata.allow_clear_text` - (Required - Forces new resource) - Indicates whether encrypted tables can contain cleartext data. This is a boolea field. @@ -76,17 +79,18 @@ or cryptographically processed (false). * `member.account_id` - (Required - Forces new resource) - The account id for the invited member. * `member.display_name` - (Required - Forces new resource) - The display name for the invited member. * `member.member_abilities` - (Required - Forces new resource) - The list of abilities for the invited member. Valid values [may be found here](https://docs.aws.amazon.com/clean-rooms/latest/apireference/API_CreateCollaboration.html#API-CreateCollaboration-request-creatorMemberAbilities). +* `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). * `tags` - (Optional) - Key value pairs which tag the collaboration. ## Attribute Reference This resource exports the following attributes in addition to the arguments above: -* `arn` - The arn of the collaboration. -* `id` - The id of the collaboration. -* `create_time` - The date and time the collaboration was created. +* `arn` - ARN of the collaboration. +* `id` - ID of the collaboration. +* `create_time` - Date and time the collaboration was created. * `member status` - For each member included in the collaboration an additional computed attribute of status is added. These values [may be found here](https://docs.aws.amazon.com/clean-rooms/latest/apireference/API_MemberSummary.html#API-Type-MemberSummary-status). -* `updated_time` - The date and time the collaboration was last updated. +* `updated_time` - Date and time the collaboration was last updated. ## Timeouts @@ -121,4 +125,4 @@ Using `terraform import`, import `aws_cleanrooms_collaboration` using the `id`. % terraform import aws_cleanrooms_collaboration.collaboration 1234abcd-12ab-34cd-56ef-1234567890ab ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/cleanrooms_configured_table.html.markdown b/website/docs/cdktf/python/r/cleanrooms_configured_table.html.markdown index 1746ecd79183..0adfa3c2f9e7 100644 --- a/website/docs/cdktf/python/r/cleanrooms_configured_table.html.markdown +++ b/website/docs/cdktf/python/r/cleanrooms_configured_table.html.markdown @@ -47,6 +47,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) - The name of the configured table. * `description` - (Optional) - A description for the configured table. * `analysis_method` - (Required) - The analysis method for the configured table. The only valid value is currently `DIRECT_QUERY`. @@ -98,4 +99,4 @@ Using `terraform import`, import `aws_cleanrooms_configured_table` using the `id % terraform import aws_cleanrooms_configured_table.table 1234abcd-12ab-34cd-56ef-1234567890ab ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/cleanrooms_membership.html.markdown b/website/docs/cdktf/python/r/cleanrooms_membership.html.markdown index f68a0630e038..00a4e474c34e 100644 --- a/website/docs/cdktf/python/r/cleanrooms_membership.html.markdown +++ b/website/docs/cdktf/python/r/cleanrooms_membership.html.markdown @@ -24,24 +24,24 @@ 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 CleanroomsMembership +from imports.aws.cleanrooms_membership import CleanroomsMembership class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) CleanroomsMembership(self, "test_membership", collaboration_id="1234abcd-12ab-34cd-56ef-1234567890ab", - default_result_configuration=[{ - "output_configuration": [{ - "s3": [{ - "bucket": "test-bucket", - "key_prefix": "test-prefix", - "result_format": "PARQUET" - } + default_result_configuration=[CleanroomsMembershipDefaultResultConfiguration( + output_configuration=[CleanroomsMembershipDefaultResultConfigurationOutputConfiguration( + s3=[CleanroomsMembershipDefaultResultConfigurationOutputConfigurationS3( + bucket="test-bucket", + key_prefix="test-prefix", + result_format="PARQUET" + ) ] - } + ) ], - "role_arn": "arn:aws:iam::123456789012:role/role-name" - } + role_arn="arn:aws:iam::123456789012:role/role-name" + ) ], query_log_status="DISABLED", tags={ @@ -54,6 +54,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `collaboration_id` - (Required - Forces new resource) - The ID of the collaboration to which the member was invited. * `query_log_status` - (Required) - An indicator as to whether query logging has been enabled or disabled for the membership. * `default_result_configuration` - (Optional) - The default configuration for a query result. @@ -92,7 +93,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 CleanroomsMembership +from imports.aws.cleanrooms_membership import CleanroomsMembership class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) @@ -105,4 +106,4 @@ Using `terraform import`, import `aws_cleanrooms_membership` using the `id`. For % terraform import aws_cleanrooms_membership.membership 1234abcd-12ab-34cd-56ef-1234567890ab ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/cloud9_environment_ec2.html.markdown b/website/docs/cdktf/python/r/cloud9_environment_ec2.html.markdown index 28cf6cf5cb4a..85d14bb36e13 100644 --- a/website/docs/cdktf/python/r/cloud9_environment_ec2.html.markdown +++ b/website/docs/cdktf/python/r/cloud9_environment_ec2.html.markdown @@ -108,6 +108,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) The name of the environment. * `instance_type` - (Required) The type of instance to connect to the environment, e.g., `t2.micro`. * `image_id` - (Required) The identifier for the Amazon Machine Image (AMI) that's used to create the EC2 instance. Valid values are @@ -135,4 +136,4 @@ This resource exports the following attributes in addition to the arguments abov * `tags_all` - A map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). * `type` - The type of the environment (e.g., `ssh` or `ec2`). - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/cloud9_environment_membership.html.markdown b/website/docs/cdktf/python/r/cloud9_environment_membership.html.markdown index 282d43498dc5..94ccb891f12b 100644 --- a/website/docs/cdktf/python/r/cloud9_environment_membership.html.markdown +++ b/website/docs/cdktf/python/r/cloud9_environment_membership.html.markdown @@ -51,6 +51,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `environment_id` - (Required) The ID of the environment that contains the environment member you want to add. * `permissions` - (Required) The type of environment member permissions you want to associate with this environment member. Allowed values are `read-only` and `read-write` . * `user_arn` - (Required) The Amazon Resource Name (ARN) of the environment member you want to add. @@ -87,4 +88,4 @@ Using `terraform import`, import Cloud9 environment membership using the `enviro % terraform import aws_cloud9_environment_membership.test environment-id#user-arn ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/cloudcontrolapi_resource.html.markdown b/website/docs/cdktf/python/r/cloudcontrolapi_resource.html.markdown index 4caf3cd7b7d2..1ea9232fd5f2 100644 --- a/website/docs/cdktf/python/r/cloudcontrolapi_resource.html.markdown +++ b/website/docs/cdktf/python/r/cloudcontrolapi_resource.html.markdown @@ -49,6 +49,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `role_arn` - (Optional) Amazon Resource Name (ARN) of the IAM Role to assume for operations. * `schema` - (Optional) JSON string of the CloudFormation resource type schema which is used for plan time validation where possible. Automatically fetched if not provided. In large scale environments with multiple resources using the same `type_name`, it is recommended to fetch the schema once via the [`aws_cloudformation_type` data source](/docs/providers/aws/d/cloudformation_type.html) and use this argument to reduce `DescribeType` API operation throttling. This value is marked sensitive only to prevent large plan differences from showing. * `type_version_id` - (Optional) Identifier of the CloudFormation resource type version. @@ -59,4 +60,4 @@ This resource exports the following attributes in addition to the arguments abov * `properties` - JSON string matching the CloudFormation resource type schema with current configuration. Underlying attributes can be referenced via the [`jsondecode()` function](https://www.terraform.io/docs/language/functions/jsondecode.html), for example, `jsondecode(data.aws_cloudcontrolapi_resource.example.properties)["example"]`. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/cloudformation_stack.html.markdown b/website/docs/cdktf/python/r/cloudformation_stack.html.markdown index 8b3e963f8a57..cb3005cfdd59 100644 --- a/website/docs/cdktf/python/r/cloudformation_stack.html.markdown +++ b/website/docs/cdktf/python/r/cloudformation_stack.html.markdown @@ -63,6 +63,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) Stack name. * `template_body` - (Optional) Structure containing the template body (max size: 51,200 bytes). * `template_url` - (Optional) Location of a file containing the template body (max size: 460,800 bytes). @@ -123,4 +124,4 @@ Using `terraform import`, import Cloudformation Stacks using the `name`. For exa % terraform import aws_cloudformation_stack.stack networking-stack ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/cloudformation_stack_instances.html.markdown b/website/docs/cdktf/python/r/cloudformation_stack_instances.html.markdown index 554b59303a56..ec7acd7ad7ba 100644 --- a/website/docs/cdktf/python/r/cloudformation_stack_instances.html.markdown +++ b/website/docs/cdktf/python/r/cloudformation_stack_instances.html.markdown @@ -129,6 +129,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `accounts` - (Optional) Accounts where you want to create stack instances in the specified `regions`. You can specify either `accounts` or `deployment_targets`, but not both. * `deployment_targets` - (Optional) AWS Organizations accounts for which to create stack instances in the `regions`. stack sets doesn't deploy stack instances to the organization management account, even if the organization management account is in your organization or in an OU in your organization. Drift detection is not possible for most of this argument. See [deployment_targets](#deployment_targets) below. * `parameter_overrides` - (Optional) Key-value map of input parameters to override from the stack set for these instances. This argument's drift detection is limited to the first account and region since each instance can have unique parameters. @@ -233,4 +234,4 @@ Using `terraform import`, Import CloudFormation stack instances that target OUs, % terraform import aws_cloudformation_stack_instances.example example,SELF,OU ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/cloudformation_stack_set.html.markdown b/website/docs/cdktf/python/r/cloudformation_stack_set.html.markdown index 9477da1748c8..e6975f8425ee 100644 --- a/website/docs/cdktf/python/r/cloudformation_stack_set.html.markdown +++ b/website/docs/cdktf/python/r/cloudformation_stack_set.html.markdown @@ -108,6 +108,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `administration_role_arn` - (Optional) Amazon Resource Number (ARN) of the IAM Role in the administrator account. This must be defined when using the `SELF_MANAGED` permission model. * `auto_deployment` - (Optional) Configuration block containing the auto-deployment model for your StackSet. This can only be defined when using the `SERVICE_MANAGED` permission model. * `enabled` - (Optional) Whether or not auto-deployment is enabled. @@ -200,4 +201,4 @@ Using `terraform import`, import CloudFormation StackSets when acting a delegate % terraform import aws_cloudformation_stack_set.example example,DELEGATED_ADMIN ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/cloudformation_stack_set_instance.html.markdown b/website/docs/cdktf/python/r/cloudformation_stack_set_instance.html.markdown index 160d38e30d18..3984a24159f9 100644 --- a/website/docs/cdktf/python/r/cloudformation_stack_set_instance.html.markdown +++ b/website/docs/cdktf/python/r/cloudformation_stack_set_instance.html.markdown @@ -34,7 +34,7 @@ class MyConvertedCode(TerraformStack): super().__init__(scope, name) CloudformationStackSetInstance(self, "example", account_id="123456789012", - region="us-east-1", + stack_set_instance_region="us-east-1", stack_set_name=Token.as_string(aws_cloudformation_stack_set_example.name) ) ``` @@ -114,7 +114,7 @@ class MyConvertedCode(TerraformStack): ])) ] ), - region="us-east-1", + stack_set_instance_region="us-east-1", stack_set_name=Token.as_string(aws_cloudformation_stack_set_example.name) ) ``` @@ -125,12 +125,13 @@ This resource supports the following arguments: * `stack_set_name` - (Required) Name of the StackSet. * `account_id` - (Optional) Target AWS Account ID to create a Stack based on the StackSet. Defaults to current account. +* `call_as` - (Optional) Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account. Valid values: `SELF` (default), `DELEGATED_ADMIN`. * `deployment_targets` - (Optional) AWS Organizations accounts to which StackSets deploys. StackSets doesn't deploy stack instances to the organization management account, even if the organization management account is in your organization or in an OU in your organization. Drift detection is not possible for this argument. See [deployment_targets](#deployment_targets-argument-reference) below. +* `operation_preferences` - (Optional) Preferences for how AWS CloudFormation performs a stack set operation. * `parameter_overrides` - (Optional) Key-value map of input parameters to override from the StackSet for this Instance. -* `region` - (Optional) Target AWS Region to create a Stack based on the StackSet. Defaults to current region. +* `region` - (Optional, **Deprecated**) Target AWS Region to create a Stack based on the StackSet. Defaults to current region. Use `stack_set_instance_region` instead. * `retain_stack` - (Optional) During Terraform resource destroy, remove Instance from StackSet while keeping the Stack and its associated resources. Must be enabled in Terraform state _before_ destroy operation to take effect. You cannot reassociate a retained Stack or add an existing, saved Stack to a new StackSet. Defaults to `false`. -* `call_as` - (Optional) Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account. Valid values: `SELF` (default), `DELEGATED_ADMIN`. -* `operation_preferences` - (Optional) Preferences for how AWS CloudFormation performs a stack set operation. +* `stack_set_instance_region` - Target AWS Region to create a Stack based on the StackSet. Defaults to current region. ### `deployment_targets` Argument Reference @@ -247,4 +248,4 @@ Using `terraform import`, import CloudFormation StackSet Instances when acting a % terraform import aws_cloudformation_stack_set_instance.example example,ou-sdas-123123123/ou-sdas-789789789,us-east-1,DELEGATED_ADMIN ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/cloudformation_type.html.markdown b/website/docs/cdktf/python/r/cloudformation_type.html.markdown index 7394ca47af01..58fe9fe91a71 100644 --- a/website/docs/cdktf/python/r/cloudformation_type.html.markdown +++ b/website/docs/cdktf/python/r/cloudformation_type.html.markdown @@ -47,6 +47,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `execution_role_arn` - (Optional) Amazon Resource Name (ARN) of the IAM Role for CloudFormation to assume when invoking the extension. If your extension calls AWS APIs in any of its handlers, you must create an IAM execution role that includes the necessary permissions to call those AWS APIs, and provision that execution role in your account. When CloudFormation needs to invoke the extension handler, CloudFormation assumes this execution role to create a temporary session token, which it then passes to the extension handler, thereby supplying your extension with the appropriate credentials. * `logging_config` - (Optional) Configuration block containing logging configuration. * `schema_handler_package` - (Required) URL to the S3 bucket containing the extension project package that contains the necessary files for the extension you want to register. Must begin with `s3://` or `https://`. For example, `s3://example-bucket/example-object`. @@ -102,4 +103,4 @@ Using `terraform import`, import `aws_cloudformation_type` using the type versio % terraform import aws_cloudformation_type.example arn:aws:cloudformation:us-east-1:123456789012:type/resource/ExampleCompany-ExampleService-ExampleType/1 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/cloudfront_continuous_deployment_policy.html.markdown b/website/docs/cdktf/python/r/cloudfront_continuous_deployment_policy.html.markdown index 5be056d435f2..eefc5d87a2e8 100644 --- a/website/docs/cdktf/python/r/cloudfront_continuous_deployment_policy.html.markdown +++ b/website/docs/cdktf/python/r/cloudfront_continuous_deployment_policy.html.markdown @@ -163,8 +163,8 @@ The following arguments are required: ### `session_stickiness_config` -* `idle_ttl` - (Required) The amount of time in seconds after which sessions will cease if no requests are received. Valid values are `300` – `3600` (5–60 minutes). The value must be less than or equal to `maximum_ttl`. -* `maximum_ttl` - (Required) The maximum amount of time in seconds to consider requests from the viewer as being part of the same session. Valid values are `300` – `3600` (5–60 minutes). The value must be greater than or equal to `idle_ttl`. +* `idle_ttl` - (Required) The amount of time in seconds after which sessions will cease if no requests are received. Valid values are `300` - `3600` (5–60 minutes). The value must be less than or equal to `maximum_ttl`. +* `maximum_ttl` - (Required) The maximum amount of time in seconds to consider requests from the viewer as being part of the same session. Valid values are `300` - `3600` (5–60 minutes). The value must be greater than or equal to `idle_ttl`. ## Attribute Reference @@ -200,4 +200,4 @@ Using `terraform import`, import CloudFront Continuous Deployment Policy using t % terraform import aws_cloudfront_continuous_deployment_policy.example abcd-1234 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/cloudfront_distribution.html.markdown b/website/docs/cdktf/python/r/cloudfront_distribution.html.markdown index 5a4037df90e4..3e41d940277a 100644 --- a/website/docs/cdktf/python/r/cloudfront_distribution.html.markdown +++ b/website/docs/cdktf/python/r/cloudfront_distribution.html.markdown @@ -201,7 +201,7 @@ from cdktf import TerraformStack # from imports.aws.cloudfront_distribution import CloudfrontDistribution class MyConvertedCode(TerraformStack): - def __init__(self, scope, name, *, cachedMethods, viewerProtocolPolicy): + def __init__(self, scope, name): super().__init__(scope, name) s3_origin_id = "myS3Origin" CloudfrontDistribution(self, "s3_distribution", @@ -209,9 +209,9 @@ class MyConvertedCode(TerraformStack): default_cache_behavior=CloudfrontDistributionDefaultCacheBehavior( allowed_methods=["GET", "HEAD", "OPTIONS"], cache_policy_id="4135ea2d-6df8-44a3-9df3-4b5a84be39ad", + cached_methods=["GET", "HEAD"], target_origin_id=s3_origin_id, - cached_methods=cached_methods, - viewer_protocol_policy=viewer_protocol_policy + viewer_protocol_policy="allow-all" ), default_root_object="index.html", enabled=True, @@ -252,20 +252,11 @@ from imports.aws.cloudfront_distribution import CloudfrontDistribution from imports.aws.cloudwatch_log_delivery import CloudwatchLogDelivery from imports.aws.cloudwatch_log_delivery_destination import CloudwatchLogDeliveryDestination from imports.aws.cloudwatch_log_delivery_source import CloudwatchLogDeliverySource -from imports.aws.provider import AwsProvider from imports.aws.s3_bucket import S3Bucket class MyConvertedCode(TerraformStack): def __init__(self, scope, name, *, defaultCacheBehavior, enabled, origin, restrictions, viewerCertificate): super().__init__(scope, name) - AwsProvider(self, "aws", - region=region.string_value - ) - us_east1 = AwsProvider(self, "aws_1", - alias="us_east_1", - region="us-east-1" - ) example = CloudfrontDistribution(self, "example", - provider=us_east1, default_cache_behavior=default_cache_behavior, enabled=enabled, origin=origin, @@ -273,36 +264,36 @@ class MyConvertedCode(TerraformStack): viewer_certificate=viewer_certificate ) aws_cloudwatch_log_delivery_source_example = - CloudwatchLogDeliverySource(self, "example_3", + CloudwatchLogDeliverySource(self, "example_1", log_type="ACCESS_LOGS", name="example", - provider=us_east1, + region="us-east-1", resource_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_cloudwatch_log_delivery_source_example.override_logical_id("example") - aws_s3_bucket_example = S3Bucket(self, "example_4", + aws_s3_bucket_example = S3Bucket(self, "example_2", bucket="testbucket", force_destroy=True ) # 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_s3_bucket_example.override_logical_id("example") aws_cloudwatch_log_delivery_destination_example = - CloudwatchLogDeliveryDestination(self, "example_5", + CloudwatchLogDeliveryDestination(self, "example_3", delivery_destination_configuration=[CloudwatchLogDeliveryDestinationDeliveryDestinationConfiguration( destination_resource_arn="${" + aws_s3_bucket_example.arn + "}/prefix" ) ], name="s3-destination", output_format="parquet", - provider=us_east1 + region="us-east-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. aws_cloudwatch_log_delivery_destination_example.override_logical_id("example") - aws_cloudwatch_log_delivery_example = CloudwatchLogDelivery(self, "example_6", + aws_cloudwatch_log_delivery_example = CloudwatchLogDelivery(self, "example_4", delivery_destination_arn=Token.as_string(aws_cloudwatch_log_delivery_destination_example.arn), delivery_source_name=Token.as_string(aws_cloudwatch_log_delivery_source_example.name), - provider=us_east1, + region="us-east-1", s3_delivery_configuration=[CloudwatchLogDeliveryS3DeliveryConfiguration( suffix_path="/123456678910/{DistributionId}/{yyyy}/{MM}/{dd}/{HH}" ) @@ -312,11 +303,77 @@ class MyConvertedCode(TerraformStack): aws_cloudwatch_log_delivery_example.override_logical_id("example") ``` +### With V2 logging to Data Firehose + +The example below creates a CloudFront distribution with [standard logging V2 to Data Firehose](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/standard-logging.html#enable-access-logging-api). + +```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.cloudfront_distribution import CloudfrontDistribution +from imports.aws.cloudwatch_log_delivery import CloudwatchLogDelivery +from imports.aws.cloudwatch_log_delivery_destination import CloudwatchLogDeliveryDestination +from imports.aws.cloudwatch_log_delivery_source import CloudwatchLogDeliverySource +from imports.aws.kinesis_firehose_delivery_stream import KinesisFirehoseDeliveryStream +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name, *, defaultCacheBehavior, enabled, origin, restrictions, viewerCertificate, destination, name): + super().__init__(scope, name) + example = CloudfrontDistribution(self, "example", + default_cache_behavior=default_cache_behavior, + enabled=enabled, + origin=origin, + restrictions=restrictions, + viewer_certificate=viewer_certificate + ) + aws_cloudwatch_log_delivery_source_example = + CloudwatchLogDeliverySource(self, "example_1", + log_type="ACCESS_LOGS", + name="cloudfront-logs-source", + region="us-east-1", + resource_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_cloudwatch_log_delivery_source_example.override_logical_id("example") + cloudfront_logs = KinesisFirehoseDeliveryStream(self, "cloudfront_logs", + region="us-east-1", + tags={ + "LogDeliveryEnabled": "true" + }, + destination=destination, + name=name + ) + aws_cloudwatch_log_delivery_destination_example = + CloudwatchLogDeliveryDestination(self, "example_3", + delivery_destination_configuration=[CloudwatchLogDeliveryDestinationDeliveryDestinationConfiguration( + destination_resource_arn=cloudfront_logs.arn + ) + ], + name="firehose-destination", + output_format="json", + region="us-east-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. + aws_cloudwatch_log_delivery_destination_example.override_logical_id("example") + aws_cloudwatch_log_delivery_example = CloudwatchLogDelivery(self, "example_4", + delivery_destination_arn=Token.as_string(aws_cloudwatch_log_delivery_destination_example.arn), + delivery_source_name=Token.as_string(aws_cloudwatch_log_delivery_source_example.name), + region="us-east-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. + aws_cloudwatch_log_delivery_example.override_logical_id("example") +``` + ## Argument Reference This resource supports the following arguments: * `aliases` (Optional) - Extra CNAMEs (alternate domain names), if any, for this distribution. +* `anycast_ip_list_id` (Optional) - ID of the Anycast static IP list that is associated with the distribution. * `comment` (Optional) - Any comments you want to include about the distribution. * `continuous_deployment_policy_id` (Optional) - Identifier of a continuous deployment policy. This argument should only be set on a production distribution. See the [`aws_cloudfront_continuous_deployment_policy` resource](./cloudfront_continuous_deployment_policy.html.markdown) for additional details. * `custom_error_response` (Optional) - One or more [custom error response](#custom-error-response-arguments) elements (multiples allowed). @@ -474,6 +531,8 @@ class MyConvertedCode(TerraformStack): #### Custom Error Response Arguments +~> **NOTE:** When specifying either `response_page_path` or `response_code`, **both** must be set. + * `error_caching_min_ttl` (Optional) - Minimum amount of time you want HTTP error codes to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated. * `error_code` (Required) - 4xx or 5xx HTTP status code that you want to customize. * `response_code` (Optional) - HTTP status code that you want CloudFront to return with the custom error page to the viewer. @@ -618,4 +677,4 @@ Using `terraform import`, import CloudFront Distributions using the `id`. For ex % terraform import aws_cloudfront_distribution.distribution E74FTE3EXAMPLE ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/cloudfront_function.html.markdown b/website/docs/cdktf/python/r/cloudfront_function.html.markdown index 9d5a3d127da1..7f66cfe10d2a 100644 --- a/website/docs/cdktf/python/r/cloudfront_function.html.markdown +++ b/website/docs/cdktf/python/r/cloudfront_function.html.markdown @@ -53,7 +53,7 @@ The following arguments are optional: * `comment` - (Optional) Comment. * `publish` - (Optional) Whether to publish creation/change as Live CloudFront Function Version. Defaults to `true`. -* `key_value_store_associations` - (Optional) List of `aws_cloudfront_key_value_store` ARNs to be associated to the function. AWS limits associations to on key value store per function. +* `key_value_store_associations` - (Optional) List of `aws_cloudfront_key_value_store` ARNs to be associated to the function. AWS limits associations to one key value store per function. ## Attribute Reference @@ -89,4 +89,4 @@ Using `terraform import`, import CloudFront Functions using the `name`. For exam % terraform import aws_cloudfront_function.test my_test_function ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/cloudfront_key_value_store.html.markdown b/website/docs/cdktf/python/r/cloudfront_key_value_store.html.markdown index e16030b4fd21..493a9c253633 100644 --- a/website/docs/cdktf/python/r/cloudfront_key_value_store.html.markdown +++ b/website/docs/cdktf/python/r/cloudfront_key_value_store.html.markdown @@ -49,8 +49,8 @@ The following arguments are optional: This resource exports the following attributes in addition to the arguments above: * `arn` - Amazon Resource Name (ARN) identifying your CloudFront KeyValueStore. -* `id` - A unique identifier for the KeyValueStore. Same as `name`. * `etag` - ETag hash of the KeyValueStore. +* `id` - A unique identifier for the KeyValueStore. ## Timeouts @@ -83,4 +83,4 @@ Using `terraform import`, import CloudFront Key Value Store using the `name`. Fo % terraform import aws_cloudfront_key_value_store.example example_store ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/cloudfrontkeyvaluestore_key.html.markdown b/website/docs/cdktf/python/r/cloudfrontkeyvaluestore_key.html.markdown index 57ef50dfd362..58337a4b5b99 100644 --- a/website/docs/cdktf/python/r/cloudfrontkeyvaluestore_key.html.markdown +++ b/website/docs/cdktf/python/r/cloudfrontkeyvaluestore_key.html.markdown @@ -61,7 +61,7 @@ This resource exports the following attributes in addition to the arguments abov ## Import -In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import CloudFront KeyValueStore Key using the `example_id_arg`. For example: +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import CloudFront KeyValueStore Key using the `key_value_store_arn` and 'key' separated by `,`. For example: ```python # DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -78,10 +78,10 @@ class MyConvertedCode(TerraformStack): CloudfrontkeyvaluestoreKey.generate_config_for_import(self, "example", "arn:aws:cloudfront::111111111111:key-value-store/8562g61f-caba-2845-9d99-b97diwae5d3c,someKey") ``` -Using `terraform import`, import CloudFront KeyValueStore Key using the `id`. For example: +Using `terraform import`, import CloudFront KeyValueStore Key using the `key_value_store_arn` and 'key' separated by `,`. For example: ```console % terraform import aws_cloudfrontkeyvaluestore_key.example arn:aws:cloudfront::111111111111:key-value-store/8562g61f-caba-2845-9d99-b97diwae5d3c,someKey ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/cloudhsm_v2_cluster.html.markdown b/website/docs/cdktf/python/r/cloudhsm_v2_cluster.html.markdown index c177ee4c62cd..b5c0ee74e284 100644 --- a/website/docs/cdktf/python/r/cloudhsm_v2_cluster.html.markdown +++ b/website/docs/cdktf/python/r/cloudhsm_v2_cluster.html.markdown @@ -82,6 +82,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `source_backup_identifier` - (Optional) ID of Cloud HSM v2 cluster backup to be restored. * `hsm_type` - (Required) The type of HSM module in the cluster. Currently, `hsm1.medium` and `hsm2m.medium` are supported. * `subnet_ids` - (Required) The IDs of subnets in which cluster will operate. @@ -132,4 +133,4 @@ Using `terraform import`, import CloudHSM v2 Clusters using the cluster `id`. Fo % terraform import aws_cloudhsm_v2_cluster.test_cluster cluster-aeb282a201 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/cloudhsm_v2_hsm.html.markdown b/website/docs/cdktf/python/r/cloudhsm_v2_hsm.html.markdown index 065d832016af..814ad28088ec 100644 --- a/website/docs/cdktf/python/r/cloudhsm_v2_hsm.html.markdown +++ b/website/docs/cdktf/python/r/cloudhsm_v2_hsm.html.markdown @@ -42,13 +42,14 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: -~> **NOTE:** Either `subnet_id` or `availability_zone` must be specified. - +* `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). * `cluster_id` - (Required) The ID of Cloud HSM v2 cluster to which HSM will be added. * `subnet_id` - (Optional) The ID of subnet in which HSM module will be located. Conflicts with `availability_zone`. * `availability_zone` - (Optional) The IDs of AZ in which HSM module will be located. Conflicts with `subnet_id`. * `ip_address` - (Optional) The IP address of HSM module. Must be within the CIDR of selected subnet. +~> **NOTE:** Either `subnet_id` or `availability_zone` must be specified. + ## Attribute Reference This resource exports the following attributes in addition to the arguments above: @@ -86,4 +87,4 @@ Using `terraform import`, import HSM modules using their HSM ID. For example: % terraform import aws_cloudhsm_v2_hsm.bar hsm-quo8dahtaca ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/cloudsearch_domain.html.markdown b/website/docs/cdktf/python/r/cloudsearch_domain.html.markdown index 3ced77999f0e..72c4008af953 100644 --- a/website/docs/cdktf/python/r/cloudsearch_domain.html.markdown +++ b/website/docs/cdktf/python/r/cloudsearch_domain.html.markdown @@ -58,6 +58,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `endpoint_options` - (Optional) Domain endpoint options. Documented below. * `index_field` - (Optional) The index fields for documents added to the domain. Documented below. * `multi_az` - (Optional) Whether or not to maintain extra instances for the domain in a second Availability Zone to ensure high availability. @@ -136,4 +137,4 @@ Using `terraform import`, import CloudSearch Domains using the `name`. For examp % terraform import aws_cloudsearch_domain.example example-domain ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/cloudsearch_domain_service_access_policy.html.markdown b/website/docs/cdktf/python/r/cloudsearch_domain_service_access_policy.html.markdown index 2072abaa9197..249166fc65dd 100644 --- a/website/docs/cdktf/python/r/cloudsearch_domain_service_access_policy.html.markdown +++ b/website/docs/cdktf/python/r/cloudsearch_domain_service_access_policy.html.markdown @@ -67,6 +67,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `access_policy` - (Required) The access rules you want to configure. These rules replace any existing rules. See the [AWS documentation](https://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-access.html) for details. * `domain_name` - (Required) The CloudSearch domain name the policy applies to. @@ -106,4 +107,4 @@ Using `terraform import`, import CloudSearch domain service access policies usin % terraform import aws_cloudsearch_domain_service_access_policy.example example-domain ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/cloudtrail.html.markdown b/website/docs/cdktf/python/r/cloudtrail.html.markdown index 542356f83c20..ec8fc77c6b01 100644 --- a/website/docs/cdktf/python/r/cloudtrail.html.markdown +++ b/website/docs/cdktf/python/r/cloudtrail.html.markdown @@ -57,7 +57,7 @@ class MyConvertedCode(TerraformStack): actions=["s3:GetBucketAcl"], condition=[DataAwsIamPolicyDocumentStatementCondition( test="StringEquals", - values=["arn:${" + data_aws_partition_current.partition + "}:cloudtrail:${" + data_aws_region_current.name + "}:${" + current.account_id + "}:trail/example" + values=["arn:${" + data_aws_partition_current.partition + "}:cloudtrail:${" + data_aws_region_current.region + "}:${" + current.account_id + "}:trail/example" ], variable="aws:SourceArn" ) @@ -78,7 +78,7 @@ class MyConvertedCode(TerraformStack): variable="s3:x-amz-acl" ), DataAwsIamPolicyDocumentStatementCondition( test="StringEquals", - values=["arn:${" + data_aws_partition_current.partition + "}:cloudtrail:${" + data_aws_region_current.name + "}:${" + current.account_id + "}:trail/example" + values=["arn:${" + data_aws_partition_current.partition + "}:cloudtrail:${" + data_aws_region_current.region + "}:${" + current.account_id + "}:trail/example" ], variable="aws:SourceArn" ) @@ -372,6 +372,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `advanced_event_selector` - (Optional) Specifies an advanced event selector for enabling data event logging. Fields documented below. Conflicts with `event_selector`. * `cloud_watch_logs_group_arn` - (Optional) Log group name using an ARN that represents the log group to which CloudTrail logs will be delivered. Note that CloudTrail requires the Log Stream wildcard. * `cloud_watch_logs_role_arn` - (Optional) Role for the CloudWatch Logs endpoint to assume to write to a user’s log group. @@ -453,4 +454,4 @@ Using `terraform import`, import Cloudtrails using the `arn`. For example: % terraform import aws_cloudtrail.sample arn:aws:cloudtrail:us-east-1:123456789012:trail/my-sample-trail ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/cloudtrail_event_data_store.html.markdown b/website/docs/cdktf/python/r/cloudtrail_event_data_store.html.markdown index 4669864dc89d..f4b92569af03 100644 --- a/website/docs/cdktf/python/r/cloudtrail_event_data_store.html.markdown +++ b/website/docs/cdktf/python/r/cloudtrail_event_data_store.html.markdown @@ -90,6 +90,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +- `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). - `name` - (Required) The name of the event data store. - `billing_mode` - (Optional) The billing mode for the event data store. The valid values are `EXTENDABLE_RETENTION_PRICING` and `FIXED_RETENTION_PRICING`. Defaults to `EXTENDABLE_RETENTION_PRICING`. - `suspend` - (Optional) Specifies whether to stop ingesting new events into the event data store. If set to `true`, ingestion is suspended while maintaining the ability to query existing events. If set to `false`, ingestion is active. @@ -153,4 +154,4 @@ Using `terraform import`, import event data stores using their `arn`. For exampl % terraform import aws_cloudtrail_event_data_store.example arn:aws:cloudtrail:us-east-1:123456789123:eventdatastore/22333815-4414-412c-b155-dd254033gfhf ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/cloudwatch_composite_alarm.html.markdown b/website/docs/cdktf/python/r/cloudwatch_composite_alarm.html.markdown index 840e123c94a2..1c9bb4499e7c 100644 --- a/website/docs/cdktf/python/r/cloudwatch_composite_alarm.html.markdown +++ b/website/docs/cdktf/python/r/cloudwatch_composite_alarm.html.markdown @@ -46,6 +46,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `actions_enabled` - (Optional, Forces new resource) Indicates whether actions should be executed during any changes to the alarm state of the composite alarm. Defaults to `true`. * `actions_suppressor` - (Optional) Actions will be suppressed if the suppressor alarm is in the ALARM state. * `alarm` - (Required) Can be an AlarmName or an Amazon Resource Name (ARN) from an existing alarm. @@ -92,4 +93,4 @@ Using `terraform import`, import a CloudWatch Composite Alarm using the `alarm_n % terraform import aws_cloudwatch_composite_alarm.test my-alarm ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/cloudwatch_contributor_insight_rule.html.markdown b/website/docs/cdktf/python/r/cloudwatch_contributor_insight_rule.html.markdown index c3c8839747c7..e671763ff207 100644 --- a/website/docs/cdktf/python/r/cloudwatch_contributor_insight_rule.html.markdown +++ b/website/docs/cdktf/python/r/cloudwatch_contributor_insight_rule.html.markdown @@ -44,6 +44,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `rule_state` - (Optional) State of the rule. Valid values are `ENABLED` and `DISABLED`. ## Attribute Reference @@ -77,4 +78,4 @@ Using `terraform import`, import CloudWatch Contributor Insight Rule using the ` % terraform import aws_cloudwatch_contributor_insight_rule.example contributor_insight_rule-name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/cloudwatch_contributor_managed_insight_rule.html.markdown b/website/docs/cdktf/python/r/cloudwatch_contributor_managed_insight_rule.html.markdown index 5c26f91dd8cd..b7274390cd41 100644 --- a/website/docs/cdktf/python/r/cloudwatch_contributor_managed_insight_rule.html.markdown +++ b/website/docs/cdktf/python/r/cloudwatch_contributor_managed_insight_rule.html.markdown @@ -44,6 +44,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `rule_state` - (Optional) State of the rule. Valid values are `ENABLED` and `DISABLED`. ## Attribute Reference @@ -77,4 +78,4 @@ Using `terraform import`, import CloudWatch Contributor Managed Insight Rule usi % terraform import aws_cloudwatch_contributor_managed_insight_rule.example contributor_managed_insight_rule-id-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/cloudwatch_dashboard.html.markdown b/website/docs/cdktf/python/r/cloudwatch_dashboard.html.markdown index 9b47ece6a912..ab64d465f19d 100644 --- a/website/docs/cdktf/python/r/cloudwatch_dashboard.html.markdown +++ b/website/docs/cdktf/python/r/cloudwatch_dashboard.html.markdown @@ -63,6 +63,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `dashboard_name` - (Required) The name of the dashboard. * `dashboard_body` - (Required) The detailed information about the dashboard, including what widgets are included and their location on the dashboard. You can read more about the body structure in the [documentation](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/CloudWatch-Dashboard-Body-Structure.html). @@ -97,4 +98,4 @@ Using `terraform import`, import CloudWatch dashboards using the `dashboard_name % terraform import aws_cloudwatch_dashboard.sample dashboard_name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/cloudwatch_event_api_destination.html.markdown b/website/docs/cdktf/python/r/cloudwatch_event_api_destination.html.markdown index 54ef4723ba56..6a6932b69510 100644 --- a/website/docs/cdktf/python/r/cloudwatch_event_api_destination.html.markdown +++ b/website/docs/cdktf/python/r/cloudwatch_event_api_destination.html.markdown @@ -42,6 +42,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) The name of the new API Destination. The name must be unique for your account. Maximum of 64 characters consisting of numbers, lower/upper case letters, .,-,_. * `description` - (Optional) The description of the new API Destination. Maximum of 512 characters. * `invocation_endpoint` - (Required) URL endpoint to invoke as a target. This could be a valid endpoint generated by a partner service. You can include "*" as path parameters wildcards to be set from the Target HttpParameters. @@ -80,4 +81,4 @@ Using `terraform import`, import EventBridge API Destinations using the `name`. % terraform import aws_cloudwatch_event_api_destination.test api-destination ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/cloudwatch_event_archive.html.markdown b/website/docs/cdktf/python/r/cloudwatch_event_archive.html.markdown index f7c14bc87978..fd8a5cd859ba 100644 --- a/website/docs/cdktf/python/r/cloudwatch_event_archive.html.markdown +++ b/website/docs/cdktf/python/r/cloudwatch_event_archive.html.markdown @@ -40,7 +40,7 @@ class MyConvertedCode(TerraformStack): aws_cloudwatch_event_archive_order.override_logical_id("order") ``` -## Example all optional arguments +## Example Usage Optional Arguments ```python # DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -72,21 +72,101 @@ class MyConvertedCode(TerraformStack): aws_cloudwatch_event_archive_order.override_logical_id("order") ``` +## Example Usage CMK Encryption + +```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.cloudwatch_event_archive import CloudwatchEventArchive +from imports.aws.cloudwatch_event_bus import CloudwatchEventBus +from imports.aws.data_aws_caller_identity import DataAwsCallerIdentity +from imports.aws.data_aws_partition import DataAwsPartition +from imports.aws.kms_key import KmsKey +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + example = CloudwatchEventBus(self, "example", + name="example" + ) + current = DataAwsCallerIdentity(self, "current") + data_aws_partition_current = DataAwsPartition(self, "current_2") + # 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_partition_current.override_logical_id("current") + aws_kms_key_example = KmsKey(self, "example_3", + deletion_window_in_days=7, + policy=Token.as_string( + Fn.jsonencode({ + "Id": "key-policy-example", + "Statement": [{ + "Action": "kms:*", + "Effect": "Allow", + "Principal": { + "AWS": "arn:${" + data_aws_partition_current.partition + "}:iam::${" + current.account_id + "}:root" + }, + "Resource": "*", + "Sid": "Enable IAM User Permissions" + }, { + "Action": ["kms:DescribeKey"], + "Effect": "Allow", + "Principal": { + "Service": "events.amazonaws.com" + }, + "Resource": "*", + "Sid": "Allow describing of the key" + }, { + "Action": ["kms:GenerateDataKey", "kms:Decrypt", "kms:ReEncrypt*"], + "Condition": { + "StringEquals": { + "kms:_encryption_context:aws:events:event-bus:arn": example.arn + } + }, + "Effect": "Allow", + "Principal": { + "Service": "events.amazonaws.com" + }, + "Resource": "*", + "Sid": "Allow use of the key" + } + ], + "Version": "2012-10-17" + })), + tags={ + "EventBridgeApiDestinations": "true" + } + ) + # 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_kms_key_example.override_logical_id("example") + aws_cloudwatch_event_archive_example = CloudwatchEventArchive(self, "example_4", + event_source_arn=example.arn, + kms_key_identifier=Token.as_string(aws_kms_key_example.id), + name="example" + ) + # 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_cloudwatch_event_archive_example.override_logical_id("example") +``` + ## Argument Reference This resource supports the following arguments: -* `name` - (Required) The name of the new event archive. The archive name cannot exceed 48 characters. -* `event_source_arn` - (Required) Event bus source ARN from where these events should be archived. -* `description` - (Optional) The description of the new event archive. -* `event_pattern` - (Optional) Instructs the new event archive to only capture events matched by this pattern. By default, it attempts to archive every event received in the `event_source_arn`. +* `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). +* `name` - (Required) Name of the archive. The archive name cannot exceed 48 characters. +* `event_source_arn` - (Required) ARN of the event bus associated with the archive. Only events from this event bus are sent to the archive. +* `description` - (Optional) Description for the archive. +* `event_pattern` - (Optional) Event pattern to use to filter events sent to the archive. By default, it attempts to archive every event received in the `event_source_arn`. +* `kms_key_identifier` - (Optional) Identifier of the AWS KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt this archive. The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN. * `retention_days` - (Optional) The maximum number of days to retain events in the new event archive. By default, it archives indefinitely. ## Attribute Reference This resource exports the following attributes in addition to the arguments above: -* `arn` - The Amazon Resource Name (ARN) of the event archive. +* `arn` - ARN of the archive. ## Import @@ -113,4 +193,4 @@ Using `terraform import`, import an EventBridge archive using the `name`. For ex % terraform import aws_cloudwatch_event_archive.imported_event_archive order-archive ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/cloudwatch_event_bus.html.markdown b/website/docs/cdktf/python/r/cloudwatch_event_bus.html.markdown index 70d053a5c29f..dd6d288a8f13 100644 --- a/website/docs/cdktf/python/r/cloudwatch_event_bus.html.markdown +++ b/website/docs/cdktf/python/r/cloudwatch_event_bus.html.markdown @@ -16,6 +16,8 @@ Provides an EventBridge event bus resource. ## Example Usage +### Basic Usages + ```python # DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug from constructs import Construct @@ -58,21 +60,249 @@ class MyConvertedCode(TerraformStack): aws_cloudwatch_event_bus_examplepartner.override_logical_id("examplepartner") ``` +### Logging to CloudWatch Logs, S3, and Data Firehose + +See [Configuring logs for Amazon EventBridge event buses](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-bus-logs.html) for more details. + +#### Required Resources + +* EventBridge Event Bus with `log_config` configured +* Log destinations: + + * CloudWatch Logs log group + * S3 bucket + * Data Firehose delivery stream + +* Resource-based policy or tagging for the service-linked role: + + * CloudWatch Logs log group - `aws_cloudwatch_log_resource_policy` to allow `delivery.logs.amazonaws.com` to put logs into the log group + * S3 bucket - `aws_s3_bucket_policy` to allow `delivery.logs.amazonaws.com` to put logs into the bucket + * Data Firehose delivery stream - tagging the delivery stream with `LogDeliveryEnabled = "true"` to allow the service-linked role `AWSServiceRoleForLogDelivery` to deliver logs + +* CloudWatch Logs Delivery: + + * `aws_cloudwatch_log_delivery_source` for each log type (INFO, ERROR, TRACE) + * `aws_cloudwatch_log_delivery_destination` for the log destination (S3 bucket, CloudWatch Logs log group, or Data Firehose delivery stream) + * `aws_cloudwatch_log_delivery` to link each log type’s delivery source to the delivery destination + +#### Example Usage + +The following example demonstrates how to set up logging for an EventBridge event bus to all three destinations: CloudWatch Logs, S3, and Data Firehose. + +```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.cloudwatch_event_bus import CloudwatchEventBus +from imports.aws.cloudwatch_log_delivery import CloudwatchLogDelivery +from imports.aws.cloudwatch_log_delivery_destination import CloudwatchLogDeliveryDestination +from imports.aws.cloudwatch_log_delivery_source import CloudwatchLogDeliverySource +from imports.aws.cloudwatch_log_group import CloudwatchLogGroup +from imports.aws.cloudwatch_log_resource_policy import CloudwatchLogResourcePolicy +from imports.aws.data_aws_caller_identity import DataAwsCallerIdentity +from imports.aws.data_aws_iam_policy_document import DataAwsIamPolicyDocument +from imports.aws.kinesis_firehose_delivery_stream import KinesisFirehoseDeliveryStream +from imports.aws.s3_bucket import S3Bucket +from imports.aws.s3_bucket_policy import S3BucketPolicy +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name, *, destination, name): + super().__init__(scope, name) + example = CloudwatchEventBus(self, "example", + log_config=CloudwatchEventBusLogConfig( + include_detail="FULL", + level="TRACE" + ), + name="example-event-bus" + ) + error_logs = CloudwatchLogDeliverySource(self, "error_logs", + log_type="ERROR_LOGS", + name="EventBusSource-${" + example.name + "}-ERROR_LOGS", + resource_arn=example.arn + ) + info_logs = CloudwatchLogDeliverySource(self, "info_logs", + log_type="INFO_LOGS", + name="EventBusSource-${" + example.name + "}-INFO_LOGS", + resource_arn=example.arn + ) + trace_logs = CloudwatchLogDeliverySource(self, "trace_logs", + log_type="TRACE_LOGS", + name="EventBusSource-${" + example.name + "}-TRACE_LOGS", + resource_arn=example.arn + ) + event_bus_logs = CloudwatchLogGroup(self, "event_bus_logs", + name="/aws/vendedlogs/events/event-bus/${" + example.name + "}" + ) + cloudfront_logs = KinesisFirehoseDeliveryStream(self, "cloudfront_logs", + tags={ + "LogDeliveryEnabled": "true" + }, + destination=destination, + name=name + ) + aws_s3_bucket_example = S3Bucket(self, "example_6", + bucket="example-event-bus-logs" + ) + # 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_s3_bucket_example.override_logical_id("example") + current = DataAwsCallerIdentity(self, "current") + bucket = DataAwsIamPolicyDocument(self, "bucket", + statement=[DataAwsIamPolicyDocumentStatement( + actions=["s3:PutObject"], + condition=[DataAwsIamPolicyDocumentStatementCondition( + test="StringEquals", + values=["bucket-owner-full-control"], + variable="s3:x-amz-acl" + ), DataAwsIamPolicyDocumentStatementCondition( + test="StringEquals", + values=[Token.as_string(current.account_id)], + variable="aws:SourceAccount" + ), DataAwsIamPolicyDocumentStatementCondition( + test="ArnLike", + values=[info_logs.arn, error_logs.arn, trace_logs.arn], + variable="aws:SourceArn" + ) + ], + effect="Allow", + principals=[DataAwsIamPolicyDocumentStatementPrincipals( + identifiers=["delivery.logs.amazonaws.com"], + type="Service" + ) + ], + resources=["${" + aws_s3_bucket_example.arn + "}/AWSLogs/${" + current.account_id + "}/EventBusLogs/*" + ] + ) + ] + ) + cwlogs = DataAwsIamPolicyDocument(self, "cwlogs", + statement=[DataAwsIamPolicyDocumentStatement( + actions=["logs:CreateLogStream", "logs:PutLogEvents"], + condition=[DataAwsIamPolicyDocumentStatementCondition( + test="StringEquals", + values=[Token.as_string(current.account_id)], + variable="aws:SourceAccount" + ), DataAwsIamPolicyDocumentStatementCondition( + test="ArnLike", + values=[info_logs.arn, error_logs.arn, trace_logs.arn], + variable="aws:SourceArn" + ) + ], + effect="Allow", + principals=[DataAwsIamPolicyDocumentStatementPrincipals( + identifiers=["delivery.logs.amazonaws.com"], + type="Service" + ) + ], + resources=["${" + event_bus_logs.arn + "}:log-stream:*"] + ) + ] + ) + aws_cloudwatch_log_delivery_destination_cwlogs = + CloudwatchLogDeliveryDestination(self, "cwlogs_10", + delivery_destination_configuration=[CloudwatchLogDeliveryDestinationDeliveryDestinationConfiguration( + destination_resource_arn=event_bus_logs.arn + ) + ], + name="EventsDeliveryDestination-${" + example.name + "}-CWLogs" + ) + # 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_cloudwatch_log_delivery_destination_cwlogs.override_logical_id("cwlogs") + firehose = CloudwatchLogDeliveryDestination(self, "firehose", + delivery_destination_configuration=[CloudwatchLogDeliveryDestinationDeliveryDestinationConfiguration( + destination_resource_arn=cloudfront_logs.arn + ) + ], + name="EventsDeliveryDestination-${" + example.name + "}-Firehose" + ) + s3 = CloudwatchLogDeliveryDestination(self, "s3", + delivery_destination_configuration=[CloudwatchLogDeliveryDestinationDeliveryDestinationConfiguration( + destination_resource_arn=Token.as_string(aws_s3_bucket_example.arn) + ) + ], + name="EventsDeliveryDestination-${" + example.name + "}-S3" + ) + aws_cloudwatch_log_resource_policy_example = + CloudwatchLogResourcePolicy(self, "example_13", + policy_document=Token.as_string(cwlogs.json), + policy_name="AWSLogDeliveryWrite-${" + example.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. + aws_cloudwatch_log_resource_policy_example.override_logical_id("example") + aws_s3_bucket_policy_example = S3BucketPolicy(self, "example_14", + bucket=Token.as_string(aws_s3_bucket_example.bucket), + policy=Token.as_string(bucket.json) + ) + # 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_s3_bucket_policy_example.override_logical_id("example") + s3_info_logs = CloudwatchLogDelivery(self, "s3_info_logs", + delivery_destination_arn=s3.arn, + delivery_source_name=info_logs.name + ) + cwlogs_info_logs = CloudwatchLogDelivery(self, "cwlogs_info_logs", + delivery_destination_arn=Token.as_string(aws_cloudwatch_log_delivery_destination_cwlogs.arn), + delivery_source_name=info_logs.name, + depends_on=[s3_info_logs] + ) + firehose_info_logs = CloudwatchLogDelivery(self, "firehose_info_logs", + delivery_destination_arn=firehose.arn, + delivery_source_name=info_logs.name, + depends_on=[cwlogs_info_logs] + ) + s3_error_logs = CloudwatchLogDelivery(self, "s3_error_logs", + delivery_destination_arn=s3.arn, + delivery_source_name=error_logs.name, + depends_on=[s3_info_logs] + ) + s3_trace_logs = CloudwatchLogDelivery(self, "s3_trace_logs", + delivery_destination_arn=s3.arn, + delivery_source_name=trace_logs.name, + depends_on=[s3_error_logs] + ) + cwlogs_error_logs = CloudwatchLogDelivery(self, "cwlogs_error_logs", + delivery_destination_arn=Token.as_string(aws_cloudwatch_log_delivery_destination_cwlogs.arn), + delivery_source_name=error_logs.name, + depends_on=[s3_error_logs, cwlogs_info_logs] + ) + cwlogs_trace_logs = CloudwatchLogDelivery(self, "cwlogs_trace_logs", + delivery_destination_arn=Token.as_string(aws_cloudwatch_log_delivery_destination_cwlogs.arn), + delivery_source_name=trace_logs.name, + depends_on=[s3_trace_logs, cwlogs_error_logs] + ) + firehose_error_logs = CloudwatchLogDelivery(self, "firehose_error_logs", + delivery_destination_arn=firehose.arn, + delivery_source_name=error_logs.name, + depends_on=[cwlogs_error_logs, firehose_info_logs] + ) + CloudwatchLogDelivery(self, "firehose_trace_logs", + delivery_destination_arn=firehose.arn, + delivery_source_name=trace_logs.name, + depends_on=[cwlogs_trace_logs, firehose_error_logs] + ) +``` + ## Argument Reference This resource supports the following arguments: +* `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). The following arguments are required: * `name` - (Required) Name of the new event bus. The names of custom event buses can't contain the / character. To create a partner event bus, ensure that the `name` matches the `event_source_name`. The following arguments are optional: +* `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). * `dead_letter_config` - (Optional) Configuration details of the Amazon SQS queue for EventBridge to use as a dead-letter queue (DLQ). This block supports the following arguments: * `arn` - (Optional) The ARN of the SQS queue specified as the target for the dead-letter queue. * `description` - (Optional) Event bus description. * `event_source_name` - (Optional) Partner event source that the new event bus will be matched with. Must match `name`. * `kms_key_identifier` - (Optional) Identifier of the AWS KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt events on this event bus. The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN. +* `log_config` - (Optional) Block for logging configuration settings for the event bus. + * `include_detail` - (Optional) Whether EventBridge include detailed event information in the records it generates. Valid values are `NONE` and `FULL`. + * `level` - (Optional) Level of logging detail to include. Valid values are `OFF`, `ERROR`, `INFO`, and `TRACE`. * `tags` - (Optional) Map of tags assigned to the resource. If configured with a provider [`default_tags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. ## Attribute Reference @@ -108,4 +338,4 @@ Using `terraform import`, import EventBridge event buses using the name of the e % terraform import aws_cloudwatch_event_bus.messenger chat-messages ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/cloudwatch_event_bus_policy.html.markdown b/website/docs/cdktf/python/r/cloudwatch_event_bus_policy.html.markdown index ef5516b5c2ba..5c2cb7cba3b6 100644 --- a/website/docs/cdktf/python/r/cloudwatch_event_bus_policy.html.markdown +++ b/website/docs/cdktf/python/r/cloudwatch_event_bus_policy.html.markdown @@ -161,6 +161,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `policy` - (Required) The text of the policy. For more information about building AWS IAM policy documents with Terraform, see the [AWS IAM Policy Document Guide](https://learn.hashicorp.com/terraform/aws/iam-policy). * `event_bus_name` - (Optional) The name of the event bus to set the permissions on. If you omit this, the permissions are set on the `default` event bus. @@ -196,4 +197,4 @@ Using `terraform import`, import an EventBridge policy using the `event_bus_name % terraform import aws_cloudwatch_event_bus_policy.DevAccountAccess example-event-bus ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/cloudwatch_event_connection.html.markdown b/website/docs/cdktf/python/r/cloudwatch_event_connection.html.markdown index c922d506b1e7..3910f34f7b49 100644 --- a/website/docs/cdktf/python/r/cloudwatch_event_connection.html.markdown +++ b/website/docs/cdktf/python/r/cloudwatch_event_connection.html.markdown @@ -247,6 +247,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) The name for the connection. Maximum of 64 characters consisting of numbers, lower/upper case letters, .,-,_. * `description` - (Optional) Description for the connection. Maximum of 512 characters. * `authorization_type` - (Required) Type of authorization to use for the connection. One of `API_KEY`,`BASIC`,`OAUTH_CLIENT_CREDENTIALS`. @@ -337,4 +338,4 @@ Using `terraform import`, import EventBridge EventBridge connection using the `n % terraform import aws_cloudwatch_event_connection.test ngrok-connection ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/cloudwatch_event_endpoint.html.markdown b/website/docs/cdktf/python/r/cloudwatch_event_endpoint.html.markdown index 00c016add749..7fa434cdfb34 100644 --- a/website/docs/cdktf/python/r/cloudwatch_event_endpoint.html.markdown +++ b/website/docs/cdktf/python/r/cloudwatch_event_endpoint.html.markdown @@ -57,6 +57,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `description` - (Optional) A description of the global endpoint. * `event_bus` - (Required) The event buses to use. The names of the event buses must be identical in each Region. Exactly two event buses are required. Documented below. * `name` - (Required) The name of the global endpoint. @@ -121,4 +122,4 @@ Using `terraform import`, import EventBridge Global Endpoints using the `name`. % terraform import aws_cloudwatch_event_endpoint.imported_endpoint example-endpoint ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/cloudwatch_event_permission.html.markdown b/website/docs/cdktf/python/r/cloudwatch_event_permission.html.markdown index 783d98050941..a20da0fdbf3e 100644 --- a/website/docs/cdktf/python/r/cloudwatch_event_permission.html.markdown +++ b/website/docs/cdktf/python/r/cloudwatch_event_permission.html.markdown @@ -67,6 +67,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `principal` - (Required) The 12-digit AWS account ID that you are permitting to put events to your default event bus. Specify `*` to permit any account to put events to your default event bus, optionally limited by `condition`. * `statement_id` - (Required) An identifier string for the external account that you are granting permissions to. * `action` - (Optional) The action that you are enabling the other account to perform. Defaults to `events:PutEvents`. @@ -111,4 +112,4 @@ Using `terraform import`, import EventBridge permissions using the `event_bus_na % terraform import aws_cloudwatch_event_permission.DevAccountAccess example-event-bus/DevAccountAccess ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/cloudwatch_event_rule.html.markdown b/website/docs/cdktf/python/r/cloudwatch_event_rule.html.markdown index ed1a0797c9eb..70ce93b54cfa 100644 --- a/website/docs/cdktf/python/r/cloudwatch_event_rule.html.markdown +++ b/website/docs/cdktf/python/r/cloudwatch_event_rule.html.markdown @@ -62,28 +62,21 @@ data "aws_iam_policy_document" "sns_topic_policy" { This resource supports the following arguments: +* `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). * `name` - (Optional) The name of the rule. If omitted, Terraform will assign a random, unique name. Conflicts with `name_prefix`. * `name_prefix` - (Optional) Creates a unique name beginning with the specified prefix. Conflicts with `name`. **Note**: Due to the length of the generated suffix, must be 38 characters or less. * `schedule_expression` - (Optional) The scheduling expression. For example, `cron(0 20 * * ? *)` or `rate(5 minutes)`. At least one of `schedule_expression` or `event_pattern` is required. Can only be used on the default event bus. For more information, refer to the AWS documentation [Schedule Expressions for Rules](https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html). -* `event_bus_name` - (Optional) The name or ARN of the event bus to associate with this rule. - If you omit this, the `default` event bus is used. +* `event_bus_name` - (Optional) The name or ARN of the event bus to associate with this rule. If you omit this, the `default` event bus is used. * `event_pattern` - (Optional) The event pattern described a JSON object. At least one of `schedule_expression` or `event_pattern` is required. See full documentation of [Events and Event Patterns in EventBridge](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) for details. **Note**: The event pattern size is 2048 by default but it is adjustable up to 4096 characters by submitting a service quota increase request. See [Amazon EventBridge quotas](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-quota.html) for details. * `force_destroy` - (Optional) Used to delete managed rules created by AWS. Defaults to `false`. * `description` - (Optional) The description of the rule. * `role_arn` - (Optional) The Amazon Resource Name (ARN) associated with the role that is used for target invocation. -* `is_enabled` - (Optional, **Deprecated** Use `state` instead) Whether the rule should be enabled. - Defaults to `true`. - Conflicts with `state`. -* `state` - (Optional) State of the rule. - Valid values are `DISABLED`, `ENABLED`, and `ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS`. - When state is `ENABLED`, the rule is enabled for all events except those delivered by CloudTrail. - To also enable the rule for events delivered by CloudTrail, set `state` to `ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS`. - Defaults to `ENABLED`. - Conflicts with `is_enabled`. - - **NOTE:** The rule state `ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS` cannot be used in conjunction with the `schedule_expression` argument. +* `is_enabled` - (Optional, **Deprecated** Use `state` instead) Whether the rule should be enabled. Defaults to `true`. Conflicts with `state`. +* `state` - (Optional) State of the rule. Valid values are `DISABLED`, `ENABLED`, and `ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS`. When state is `ENABLED`, the rule is enabled for all events except those delivered by CloudTrail. To also enable the rule for events delivered by CloudTrail, set `state` to `ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS`. Defaults to `ENABLED`. Conflicts with `is_enabled`. * `tags` - (Optional) A 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. +**NOTE:** The rule state `ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS` cannot be used in conjunction with the `schedule_expression` argument. + ## Attribute Reference This resource exports the following attributes in addition to the arguments above: @@ -117,4 +110,4 @@ Using `terraform import`, import EventBridge Rules using the `event_bus_name/rul % terraform import aws_cloudwatch_event_rule.console example-event-bus/capture-console-sign-in ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/cloudwatch_event_target.html.markdown b/website/docs/cdktf/python/r/cloudwatch_event_target.html.markdown index 0a2c083cb4f7..71bc2b77816d 100644 --- a/website/docs/cdktf/python/r/cloudwatch_event_target.html.markdown +++ b/website/docs/cdktf/python/r/cloudwatch_event_target.html.markdown @@ -633,6 +633,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `appsync_target` - (Optional) Parameters used when you are using the rule to invoke an AppSync GraphQL API mutation. Documented below. A maximum of 1 are allowed. * `batch_target` - (Optional) Parameters used when you are using the rule to invoke an Amazon Batch Job. Documented below. A maximum of 1 are allowed. * `dead_letter_config` - (Optional) Parameters used when you are providing a dead letter config. Documented below. A maximum of 1 are allowed. @@ -787,4 +788,4 @@ Using `terraform import`, import EventBridge Targets using `event_bus_name/rule- % terraform import aws_cloudwatch_event_target.test-event-target rule-name/target-id ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/cloudwatch_log_account_policy.html.markdown b/website/docs/cdktf/python/r/cloudwatch_log_account_policy.html.markdown index b893cf5094de..d6b8b2cbd9e7 100644 --- a/website/docs/cdktf/python/r/cloudwatch_log_account_policy.html.markdown +++ b/website/docs/cdktf/python/r/cloudwatch_log_account_policy.html.markdown @@ -113,6 +113,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `policy_document` - (Required) Text of the account policy. Refer to the [AWS docs](https://docs.aws.amazon.com/cli/latest/reference/logs/put-account-policy.html) for more information. * `policy_type` - (Required) Type of account policy. One of `DATA_PROTECTION_POLICY`, `SUBSCRIPTION_FILTER_POLICY`, `FIELD_INDEX_POLICY` or `TRANSFORMER_POLICY`. You can have one account policy per type in an account. * `policy_name` - (Required) Name of the account policy. @@ -148,4 +149,4 @@ Using `terraform import`, import this resource using the `policy_name` and `poli % terraform import aws_cloudwatch_log_account_policy.example "my-account-policy:SUBSCRIPTION_FILTER_POLICY" ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/cloudwatch_log_anomaly_detector.html.markdown b/website/docs/cdktf/python/r/cloudwatch_log_anomaly_detector.html.markdown index 826949386671..5443285927b1 100644 --- a/website/docs/cdktf/python/r/cloudwatch_log_anomaly_detector.html.markdown +++ b/website/docs/cdktf/python/r/cloudwatch_log_anomaly_detector.html.markdown @@ -52,12 +52,14 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `log_group_arn_list` - (Required) Array containing the ARN of the log group that this anomaly detector will watch. You can specify only one log group ARN. The following arguments are optional: +* `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). * `anomaly_visibility_time` - (Optional) Number of days to have visibility on an anomaly. After this time period has elapsed for an anomaly, it will be automatically baselined and the anomaly detector will treat new occurrences of a similar anomaly as normal. Therefore, if you do not correct the cause of an anomaly during the time period specified in `anomaly_visibility_time`, it will be considered normal going forward and will not be detected as an anomaly. Valid Range: Minimum value of 7. Maximum value of 90. * `detector_name` - (Optional) Name for this anomaly detector. @@ -93,10 +95,10 @@ class MyConvertedCode(TerraformStack): CloudwatchLogAnomalyDetector.generate_config_for_import(self, "example", "log_anomaly_detector-arn-12345678") ``` -Using `terraform import`, import CloudWatch Log Anomaly Detector using the `example_id_arg`. For example: +Using `terraform import`, import CloudWatch Log Anomaly Detector using the `arn`. For example: ```console % terraform import aws_cloudwatch_log_anomaly_detector.example log_anomaly_detector-arn-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/cloudwatch_log_data_protection_policy.html.markdown b/website/docs/cdktf/python/r/cloudwatch_log_data_protection_policy.html.markdown index a71813fbe479..0242edfb768c 100644 --- a/website/docs/cdktf/python/r/cloudwatch_log_data_protection_policy.html.markdown +++ b/website/docs/cdktf/python/r/cloudwatch_log_data_protection_policy.html.markdown @@ -79,6 +79,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `log_group_name` - (Required) The name of the log group under which the log stream is to be created. * `policy_document` - (Required) Specifies the data protection policy in JSON. Read more at [Data protection policy syntax](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/mask-sensitive-log-data-start.html#mask-sensitive-log-data-policysyntax). @@ -111,4 +112,4 @@ Using `terraform import`, import this resource using the `log_group_name`. For e % terraform import aws_cloudwatch_log_data_protection_policy.example my-log-group ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/cloudwatch_log_delivery.html.markdown b/website/docs/cdktf/python/r/cloudwatch_log_delivery.html.markdown index e1e2d4739bd5..d7b2e22604d2 100644 --- a/website/docs/cdktf/python/r/cloudwatch_log_delivery.html.markdown +++ b/website/docs/cdktf/python/r/cloudwatch_log_delivery.html.markdown @@ -40,6 +40,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `delivery_destination_arn` - (Required) The ARN of the delivery destination to use for this delivery. * `delivery_source_name` - (Required) The name of the delivery source to use for this delivery. * `field_delimiter` - (Optional) The field delimiter to use between record fields when the final output format of a delivery is in `plain`, `w3c`, or `raw` format. @@ -82,4 +83,4 @@ Using `terraform import`, import CloudWatch Logs Delivery using the `id`. For ex % terraform import aws_cloudwatch_log_delivery.example jsoGVi4Zq8VlYp9n ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/cloudwatch_log_delivery_destination.html.markdown b/website/docs/cdktf/python/r/cloudwatch_log_delivery_destination.html.markdown index bccdb4f55517..6fcbff8b4430 100644 --- a/website/docs/cdktf/python/r/cloudwatch_log_delivery_destination.html.markdown +++ b/website/docs/cdktf/python/r/cloudwatch_log_delivery_destination.html.markdown @@ -41,6 +41,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `delivery_destination_configuration` - (Required) The AWS resource that will receive the logs. * `destination_resource_arn` - (Required) The ARN of the AWS destination that this delivery destination represents. * `name` - (Required) The name for this delivery destination. @@ -80,4 +81,4 @@ Using `terraform import`, import CloudWatch Logs Delivery Destination using the % terraform import aws_cloudwatch_log_delivery_destination.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/cloudwatch_log_delivery_destination_policy.html.markdown b/website/docs/cdktf/python/r/cloudwatch_log_delivery_destination_policy.html.markdown index 2885a38dff01..43012eb88396 100644 --- a/website/docs/cdktf/python/r/cloudwatch_log_delivery_destination_policy.html.markdown +++ b/website/docs/cdktf/python/r/cloudwatch_log_delivery_destination_policy.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `delivery_destination_name` - (Required) The name of the delivery destination to assign this policy to. * `delivery_destination_policy` - (Required) The contents of the policy. @@ -70,4 +71,4 @@ Using `terraform import`, import CloudWatch Logs Delivery Destination Policy usi % terraform import aws_cloudwatch_log_delivery_destination_policy.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/cloudwatch_log_delivery_source.html.markdown b/website/docs/cdktf/python/r/cloudwatch_log_delivery_source.html.markdown index 0309cbbf5bfc..8c952ecafa3d 100644 --- a/website/docs/cdktf/python/r/cloudwatch_log_delivery_source.html.markdown +++ b/website/docs/cdktf/python/r/cloudwatch_log_delivery_source.html.markdown @@ -39,6 +39,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `log_type` - (Required) The type of log that the source is sending. For Amazon Bedrock, the valid value is `APPLICATION_LOGS`. For Amazon CodeWhisperer, the valid value is `EVENT_LOGS`. For IAM Identity Center, the valid value is `ERROR_LOGS`. For Amazon WorkMail, the valid values are `ACCESS_CONTROL_LOGS`, `AUTHENTICATION_LOGS`, `WORKMAIL_AVAILABILITY_PROVIDER_LOGS`, and `WORKMAIL_MAILBOX_ACCESS_LOGS`. * `name` - (Required) The name for this delivery source. * `resource_arn` - (Required) The ARN of the AWS resource that is generating and sending logs. @@ -77,4 +78,4 @@ Using `terraform import`, import CloudWatch Logs Delivery Source using the `name % terraform import aws_cloudwatch_log_delivery_source.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/cloudwatch_log_destination.html.markdown b/website/docs/cdktf/python/r/cloudwatch_log_destination.html.markdown index 9e6bac69141b..2608877eb8d7 100644 --- a/website/docs/cdktf/python/r/cloudwatch_log_destination.html.markdown +++ b/website/docs/cdktf/python/r/cloudwatch_log_destination.html.markdown @@ -37,6 +37,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) A name for the log destination. * `role_arn` - (Required) The ARN of an IAM role that grants Amazon CloudWatch Logs permissions to put data into the target. * `target_arn` - (Required) The ARN of the target Amazon Kinesis stream resource for the destination. @@ -74,4 +75,4 @@ Using `terraform import`, import CloudWatch Logs destinations using the `name`. % terraform import aws_cloudwatch_log_destination.test_destination test_destination ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/cloudwatch_log_destination_policy.html.markdown b/website/docs/cdktf/python/r/cloudwatch_log_destination_policy.html.markdown index 52691bec1a88..41feb1f093f7 100644 --- a/website/docs/cdktf/python/r/cloudwatch_log_destination_policy.html.markdown +++ b/website/docs/cdktf/python/r/cloudwatch_log_destination_policy.html.markdown @@ -59,6 +59,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `destination_name` - (Required) A name for the subscription filter * `access_policy` - (Required) The policy document. This is a JSON formatted string. * `force_update` - (Optional) Specify true if you are updating an existing destination policy to grant permission to an organization ID instead of granting permission to individual AWS accounts. @@ -92,4 +93,4 @@ Using `terraform import`, import CloudWatch Logs destination policies using the % terraform import aws_cloudwatch_log_destination_policy.test_destination_policy test_destination ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/cloudwatch_log_group.html.markdown b/website/docs/cdktf/python/r/cloudwatch_log_group.html.markdown index 35f227db2908..40d654ae89e5 100644 --- a/website/docs/cdktf/python/r/cloudwatch_log_group.html.markdown +++ b/website/docs/cdktf/python/r/cloudwatch_log_group.html.markdown @@ -39,13 +39,14 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Optional, Forces new resource) The name of the log group. If omitted, Terraform will assign a random, unique name. * `name_prefix` - (Optional, Forces new resource) Creates a unique name beginning with the specified prefix. Conflicts with `name`. * `skip_destroy` - (Optional) Set to true if you do not wish the log group (and any logs it may contain) to be deleted at destroy time, and instead just remove the log group from the Terraform state. -* `log_group_class` - (Optional) Specified the log class of the log group. Possible values are: `STANDARD` or `INFREQUENT_ACCESS`. +* `log_group_class` - (Optional) Specified the log class of the log group. Possible values are: `STANDARD`, `INFREQUENT_ACCESS`, or `DELIVERY`. * `retention_in_days` - (Optional) Specifies the number of days you want to retain log events in the specified log group. Possible values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1096, 1827, 2192, 2557, 2922, 3288, 3653, and 0. - If you select 0, the events in the log group are always retained and never expire. + If you select 0, the events in the log group are always retained and never expire. If `log_group_class` is set to `DELIVERY`, this argument is ignored and `retention_in_days` is forcibly set to 2. * `kms_key_id` - (Optional) The ARN of the KMS Key to use when encrypting log data. Please note, after the AWS KMS CMK is disassociated from the log group, AWS CloudWatch Logs stops encrypting newly ingested data for the log group. All previously ingested data remains encrypted, and AWS CloudWatch Logs requires permissions for the CMK whenever the encrypted data is requested. @@ -83,4 +84,4 @@ Using `terraform import`, import Cloudwatch Log Groups using the `name`. For exa % terraform import aws_cloudwatch_log_group.test_group yada ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/cloudwatch_log_index_policy.html.markdown b/website/docs/cdktf/python/r/cloudwatch_log_index_policy.html.markdown index fc7bf9b8aaa7..cc0617667e26 100644 --- a/website/docs/cdktf/python/r/cloudwatch_log_index_policy.html.markdown +++ b/website/docs/cdktf/python/r/cloudwatch_log_index_policy.html.markdown @@ -19,13 +19,13 @@ Terraform resource for managing an AWS CloudWatch Logs Index Policy. ```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, TerraformStack +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. import CloudwatchLogIndexPolicy from imports.aws.cloudwatch_log_group import CloudwatchLogGroup +from imports.aws.cloudwatch_log_index_policy import CloudwatchLogIndexPolicy class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) @@ -34,9 +34,10 @@ class MyConvertedCode(TerraformStack): ) aws_cloudwatch_log_index_policy_example = CloudwatchLogIndexPolicy(self, "example_1", log_group_name=example.name, - policy_document=Fn.jsonencode({ - "Fields": ["eventName"] - }) + policy_document=Token.as_string( + Fn.jsonencode({ + "Fields": ["eventName"] + })) ) # 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_cloudwatch_log_index_policy_example.override_logical_id("example") @@ -44,8 +45,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `log_group_name` - (Required) Log group name to set the policy for. * `policy_document` - (Required) JSON policy document. This is a JSON formatted string. @@ -65,7 +67,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 CloudwatchLogIndexPolicy +from imports.aws.cloudwatch_log_index_policy import CloudwatchLogIndexPolicy class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) @@ -78,4 +80,4 @@ Using `terraform import`, import CloudWatch Logs Index Policy using the `log_gro % terraform import aws_cloudwatch_log_index_policy.example /aws/log/group/name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/cloudwatch_log_metric_filter.html.markdown b/website/docs/cdktf/python/r/cloudwatch_log_metric_filter.html.markdown index 427003406301..9b2b08e548b1 100644 --- a/website/docs/cdktf/python/r/cloudwatch_log_metric_filter.html.markdown +++ b/website/docs/cdktf/python/r/cloudwatch_log_metric_filter.html.markdown @@ -46,11 +46,13 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) A name for the metric filter. * `pattern` - (Required) A valid [CloudWatch Logs filter pattern](https://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/FilterAndPatternSyntax.html) for extracting metric data out of ingested log events. * `log_group_name` - (Required) The name of the log group to associate the metric filter with. * `metric_transformation` - (Required) A block defining collection of information needed to define how metric data gets emitted. See below. +* `apply_on_transformed_logs` - (Optional) Whether the metric filter will be applied on the transformed version of the log events instead of the original ingested log events. Defaults to `false`. Valid only for log groups that have an active log transformer. The `metric_transformation` block supports the following arguments: @@ -92,4 +94,4 @@ Using `terraform import`, import CloudWatch Log Metric Filter using the `log_gro % terraform import aws_cloudwatch_log_metric_filter.test /aws/lambda/function:test ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/cloudwatch_log_resource_policy.html.markdown b/website/docs/cdktf/python/r/cloudwatch_log_resource_policy.html.markdown index c96be995cb4a..92fd61ab2acb 100644 --- a/website/docs/cdktf/python/r/cloudwatch_log_resource_policy.html.markdown +++ b/website/docs/cdktf/python/r/cloudwatch_log_resource_policy.html.markdown @@ -91,6 +91,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `policy_document` - (Required) Details of the resource policy, including the identity of the principal that is enabled to put logs to this account. This is formatted as a JSON string. Maximum length of 5120 characters. * `policy_name` - (Required) Name of the resource policy. @@ -125,4 +126,4 @@ Using `terraform import`, import CloudWatch log resource policies using the poli % terraform import aws_cloudwatch_log_resource_policy.MyPolicy MyPolicy ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/cloudwatch_log_stream.html.markdown b/website/docs/cdktf/python/r/cloudwatch_log_stream.html.markdown index c977190421e5..3d62e8bab1f6 100644 --- a/website/docs/cdktf/python/r/cloudwatch_log_stream.html.markdown +++ b/website/docs/cdktf/python/r/cloudwatch_log_stream.html.markdown @@ -40,6 +40,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) The name of the log stream. Must not be longer than 512 characters and must not contain `:` * `log_group_name` - (Required) The name of the log group under which the log stream is to be created. @@ -74,4 +75,4 @@ Using `terraform import`, import Cloudwatch Log Stream using the stream's `log_g % terraform import aws_cloudwatch_log_stream.foo Yada:SampleLogStream1234 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/cloudwatch_log_subscription_filter.html.markdown b/website/docs/cdktf/python/r/cloudwatch_log_subscription_filter.html.markdown index ded1a6dd3cc2..ac18cecaedae 100644 --- a/website/docs/cdktf/python/r/cloudwatch_log_subscription_filter.html.markdown +++ b/website/docs/cdktf/python/r/cloudwatch_log_subscription_filter.html.markdown @@ -40,6 +40,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) A name for the subscription filter * `destination_arn` - (Required) The ARN of the destination to deliver matching log events to. Kinesis stream or Lambda function ARN. * `filter_pattern` - (Required) A valid CloudWatch Logs filter pattern for subscribing to a filtered stream of log events. Use empty string `""` to match everything. For more information, see the [Amazon CloudWatch Logs User Guide](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html). @@ -76,4 +77,4 @@ Using `terraform import`, import CloudWatch Logs subscription filter using the l % terraform import aws_cloudwatch_log_subscription_filter.test_lambdafunction_logfilter "/aws/lambda/example_lambda_name|test_lambdafunction_logfilter" ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/cloudwatch_metric_alarm.html.markdown b/website/docs/cdktf/python/r/cloudwatch_metric_alarm.html.markdown index 94b8da8e07a9..c0ece3e48548 100644 --- a/website/docs/cdktf/python/r/cloudwatch_metric_alarm.html.markdown +++ b/website/docs/cdktf/python/r/cloudwatch_metric_alarm.html.markdown @@ -219,6 +219,7 @@ You must choose one or the other This resource supports the following arguments: +* `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). * `alarm_name` - (Required) The descriptive name for the alarm. This name must be unique within the user's AWS account * `comparison_operator` - (Required) The arithmetic operation to use when comparing the specified Statistic and Threshold. The specified Statistic value is used as the first operand. Either of the following is supported: `GreaterThanOrEqualToThreshold`, `GreaterThanThreshold`, `LessThanThreshold`, `LessThanOrEqualToThreshold`. Additionally, the values `LessThanLowerOrGreaterThanUpperThreshold`, `LessThanLowerThreshold`, and `GreaterThanUpperThreshold` are used only for alarms based on anomaly detection models. * `evaluation_periods` - (Required) The number of periods over which data is compared to the specified threshold. @@ -317,4 +318,4 @@ Using `terraform import`, import CloudWatch Metric Alarm using the `alarm_name`. % terraform import aws_cloudwatch_metric_alarm.test alarm-12345 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/cloudwatch_metric_stream.html.markdown b/website/docs/cdktf/python/r/cloudwatch_metric_stream.html.markdown index e2e79497c1af..eb0bce0a1df6 100644 --- a/website/docs/cdktf/python/r/cloudwatch_metric_stream.html.markdown +++ b/website/docs/cdktf/python/r/cloudwatch_metric_stream.html.markdown @@ -180,6 +180,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `exclude_filter` - (Optional) List of exclusive metric filters. If you specify this parameter, the stream sends metrics from all metric namespaces except for the namespaces and the conditional metric names that you specify here. If you don't specify metric names or provide empty metric names whole metric namespace is excluded. Conflicts with `include_filter`. * `include_filter` - (Optional) List of inclusive metric filters. If you specify this parameter, the stream sends only the conditional metric names from the metric namespaces that you specify here. If you don't specify metric names or provide empty metric names whole metric namespace is included. Conflicts with `exclude_filter`. * `name` - (Optional, Forces new resource) Friendly name of the metric stream. If omitted, Terraform will assign a random, unique name. Conflicts with `name_prefix`. @@ -245,4 +246,4 @@ Using `terraform import`, import CloudWatch metric streams using the `name`. For % terraform import aws_cloudwatch_metric_stream.sample sample-stream-name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/cloudwatch_query_definition.html.markdown b/website/docs/cdktf/python/r/cloudwatch_query_definition.html.markdown index 161528007090..812a750c0c38 100644 --- a/website/docs/cdktf/python/r/cloudwatch_query_definition.html.markdown +++ b/website/docs/cdktf/python/r/cloudwatch_query_definition.html.markdown @@ -37,6 +37,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) The name of the query. * `query_string` - (Required) The query to save. You can read more about CloudWatch Logs Query Syntax in the [documentation](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_QuerySyntax.html). * `log_group_names` - (Optional) Specific log groups to use with the query. @@ -72,4 +73,4 @@ Using `terraform import`, import CloudWatch query definitions using the query de % terraform import aws_cloudwatch_query_definition.example arn:aws:logs:us-west-2:123456789012:query-definition:269951d7-6f75-496d-9d7b-6b7a5486bdbd ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/codeartifact_domain.html.markdown b/website/docs/cdktf/python/r/codeartifact_domain.html.markdown index c22e4533708c..014b3fe12327 100644 --- a/website/docs/cdktf/python/r/codeartifact_domain.html.markdown +++ b/website/docs/cdktf/python/r/codeartifact_domain.html.markdown @@ -35,6 +35,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `domain` - (Required) The name of the domain to create. All domain names in an AWS Region that are in the same AWS account must be unique. The domain name is used as the prefix in DNS hostnames. Do not use sensitive information in a domain name because it is publicly discoverable. * `encryption_key` - (Optional) The encryption key for the domain. This is used to encrypt content stored in a domain. The KMS Key Amazon Resource Name (ARN). The default aws/codeartifact AWS KMS master key is used if this element is absent. * `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. @@ -77,4 +78,4 @@ Using `terraform import`, import CodeArtifact Domain using the CodeArtifact Doma % terraform import aws_codeartifact_domain.example arn:aws:codeartifact:us-west-2:012345678912:domain/tf-acc-test-8593714120730241305 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/codeartifact_domain_permissions_policy.html.markdown b/website/docs/cdktf/python/r/codeartifact_domain_permissions_policy.html.markdown index 46dd2baf0dfe..5ed899789c61 100644 --- a/website/docs/cdktf/python/r/codeartifact_domain_permissions_policy.html.markdown +++ b/website/docs/cdktf/python/r/codeartifact_domain_permissions_policy.html.markdown @@ -64,6 +64,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `domain` - (Required) The name of the domain on which to set the resource policy. * `policy_document` - (Required) A JSON policy string to be set as the access control resource policy on the provided domain. * `domain_owner` - (Optional) The account number of the AWS account that owns the domain. @@ -101,4 +102,4 @@ Using `terraform import`, import CodeArtifact Domain Permissions Policies using % terraform import aws_codeartifact_domain_permissions_policy.example arn:aws:codeartifact:us-west-2:012345678912:domain/tf-acc-test-1928056699409417367 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/codeartifact_repository.html.markdown b/website/docs/cdktf/python/r/codeartifact_repository.html.markdown index 91061224b3d3..fad616fe6424 100644 --- a/website/docs/cdktf/python/r/codeartifact_repository.html.markdown +++ b/website/docs/cdktf/python/r/codeartifact_repository.html.markdown @@ -102,6 +102,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `domain` - (Required) The domain that contains the created repository. * `repository` - (Required) The name of the repository to create. * `domain_owner` - (Optional) The account number of the AWS account that owns the domain. @@ -152,4 +153,4 @@ Using `terraform import`, import CodeArtifact Repository using the CodeArtifact % terraform import aws_codeartifact_repository.example arn:aws:codeartifact:us-west-2:012345678912:repository/tf-acc-test-6968272603913957763/tf-acc-test-6968272603913957763 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/codeartifact_repository_permissions_policy.html.markdown b/website/docs/cdktf/python/r/codeartifact_repository_permissions_policy.html.markdown index 5e79518fefa8..4c05b907f598 100644 --- a/website/docs/cdktf/python/r/codeartifact_repository_permissions_policy.html.markdown +++ b/website/docs/cdktf/python/r/codeartifact_repository_permissions_policy.html.markdown @@ -74,6 +74,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `repository` - (Required) The name of the repository to set the resource policy on. * `domain` - (Required) The name of the domain on which to set the resource policy. * `policy_document` - (Required) A JSON policy string to be set as the access control resource policy on the provided domain. @@ -112,4 +113,4 @@ Using `terraform import`, import CodeArtifact Repository Permissions Policies us % terraform import aws_codeartifact_repository_permissions_policy.example arn:aws:codeartifact:us-west-2:012345678912:repository/tf-acc-test-6968272603913957763/tf-acc-test-6968272603913957763 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/codebuild_fleet.html.markdown b/website/docs/cdktf/python/r/codebuild_fleet.html.markdown index 82ec92053adb..ada755c829ab 100644 --- a/website/docs/cdktf/python/r/codebuild_fleet.html.markdown +++ b/website/docs/cdktf/python/r/codebuild_fleet.html.markdown @@ -77,7 +77,8 @@ The following arguments are required: The following arguments are optional: -* `compute_configuration` - (Optional) The compute configuration of the compute fleet. This is only required if `compute_type` is set to `ATTRIBUTE_BASED_COMPUTE`. See [`compute_configuration`](#compute_configuration) below. +* `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). +* `compute_configuration` - (Optional) The compute configuration of the compute fleet. This is only required if `compute_type` is set to `ATTRIBUTE_BASED_COMPUTE` or `CUSTOM_INSTANCE_TYPE`. See [`compute_configuration`](#compute_configuration) below. * `fleet_service_role` - (Optional) The service role associated with the compute fleet. * `image_id` - (Optional) The Amazon Machine Image (AMI) of the compute fleet. * `overflow_behavior` - (Optional) Overflow behavior for compute fleet. Valid values: `ON_DEMAND`, `QUEUE`. @@ -88,9 +89,10 @@ The following arguments are optional: ### compute_configuration * `disk` - (Optional) Amount of disk space of the instance type included in the fleet. -* `machine_type` - (Optional) Machine type of the instance type included in the fleet. Valid values: `GENERAL`, `NVME`. -* `memory` - (Optional) Amount of memory of the instance type included in the fleet. -* `vcpu` - (Optional) Number of vCPUs of the instance type included in the fleet. +* `instance_type` - (Optional) EC2 instance type to be launched in the fleet. Specify only if `compute_type` is set to `CUSTOM_INSTANCE_TYPE`. See [Supported instance families](https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-compute-types.html#environment-reserved-capacity.instance-types). +* `machine_type` - (Optional) Machine type of the instance type included in the fleet. Valid values: `GENERAL`, `NVME`. Specify only if `compute_type` is set to `ATTRIBUTE_BASED_COMPUTE`. +* `memory` - (Optional) Amount of memory of the instance type included in the fleet. Specify only if `compute_type` is set to `ATTRIBUTE_BASED_COMPUTE`. +* `vcpu` - (Optional) Number of vCPUs of the instance type included in the fleet. Specify only if `compute_type` is set to `ATTRIBUTE_BASED_COMPUTE`. ### scaling_configuration @@ -147,4 +149,4 @@ Using `terraform import`, import CodeBuild Fleet using the `name`. For example: % terraform import aws_codebuild_fleet.name fleet-name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/codebuild_project.html.markdown b/website/docs/cdktf/python/r/codebuild_project.html.markdown index 0f1669782355..0311810fe434 100644 --- a/website/docs/cdktf/python/r/codebuild_project.html.markdown +++ b/website/docs/cdktf/python/r/codebuild_project.html.markdown @@ -16,6 +16,8 @@ source (e.g., the "rebuild every time a code change is pushed" option in the Cod ## 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 @@ -224,6 +226,11 @@ class MyConvertedCode(TerraformStack): ) ``` +### Runner Project + +While no special configuration is required for `aws_codebuild_project` to create a project as a Runner Project, an `aws_codebuild_webhook` resource with an appropriate `filter_group` is required. +See the [`aws_codebuild_webhook` resource documentation example](/docs/providers/aws/r/codebuild_webhook.html#for-codebuild-runner-project) for more details. + ## Argument Reference The following arguments are required: @@ -237,6 +244,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `badge_enabled` - (Optional) Generates a publicly-accessible URL for the projects build badge. Available as `badge_url` attribute when enabled. * `build_batch_config` - (Optional) Defines the batch build options for the project. @@ -324,6 +332,7 @@ The following arguments are optional: `BUILD_GENERAL1_SMALL`, `BUILD_GENERAL1_MEDIUM`, `BUILD_GENERAL1_LARGE`, `BUILD_GENERAL1_XLARGE`, `BUILD_GENERAL1_2XLARGE`, `BUILD_LAMBDA_1GB`, `BUILD_LAMBDA_2GB`, `BUILD_LAMBDA_4GB`, `BUILD_LAMBDA_8GB`, `BUILD_LAMBDA_10GB`. For additional information, see the [CodeBuild User Guide](https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-compute-types.html). +* `docker_server` - (Optional) Configuration block. Detailed below. * `fleet` - (Optional) Configuration block. Detailed below. * `environment_variable` - (Optional) Configuration block. Detailed below. * `image_pull_credentials_type` - (Optional) Type of credentials AWS CodeBuild uses to pull images in your build. Valid @@ -342,6 +351,11 @@ The following arguments are optional: `LINUX_LAMBDA_CONTAINER`, `ARM_LAMBDA_CONTAINER`, `LINUX_EC2`, `ARM_EC2`, `WINDOWS_EC2`, `MAC_ARM`. For additional information, see the [CodeBuild User Guide](https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-compute-types.html). +#### environment: docker_server + +* `compute_type` - (Required) Compute type for the Docker server. Valid values: `BUILD_GENERAL1_SMALL`, `BUILD_GENERAL1_MEDIUM`, `BUILD_GENERAL1_LARGE`, `BUILD_GENERAL1_XLARGE`, and `BUILD_GENERAL1_2XLARGE`. +* `security_group_ids` - (Optional) List of security group IDs to assign to the Docker server. + #### environment: fleet * `fleet_arn` - (Optional) Compute fleet ARN for the build project. @@ -565,4 +579,4 @@ Using `terraform import`, import CodeBuild Project using the `name`. For example % terraform import aws_codebuild_project.name project-name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/codebuild_report_group.html.markdown b/website/docs/cdktf/python/r/codebuild_report_group.html.markdown index 524d9a8cc25a..1246dcfa6eef 100644 --- a/website/docs/cdktf/python/r/codebuild_report_group.html.markdown +++ b/website/docs/cdktf/python/r/codebuild_report_group.html.markdown @@ -79,6 +79,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) The name of a Report Group. * `type` - (Required) The type of the Report Group. Valid value are `TEST` and `CODE_COVERAGE`. * `export_config` - (Required) Information about the destination where the raw data of this Report Group is exported. see [Export Config](#export-config) documented below. @@ -133,4 +134,4 @@ Using `terraform import`, import CodeBuild Report Group using the CodeBuild Repo % terraform import aws_codebuild_report_group.example arn:aws:codebuild:us-west-2:123456789:report-group/report-group-name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/codebuild_resource_policy.html.markdown b/website/docs/cdktf/python/r/codebuild_resource_policy.html.markdown index 2c16a7a93413..1605f3f6a18a 100644 --- a/website/docs/cdktf/python/r/codebuild_resource_policy.html.markdown +++ b/website/docs/cdktf/python/r/codebuild_resource_policy.html.markdown @@ -67,6 +67,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `resource_arn` - (Required) The ARN of the Project or ReportGroup resource you want to associate with a resource policy. * `policy` - (Required) A JSON-formatted resource policy. For more information, see [Sharing a Projec](https://docs.aws.amazon.com/codebuild/latest/userguide/project-sharing.html#project-sharing-share) and [Sharing a Report Group](https://docs.aws.amazon.com/codebuild/latest/userguide/report-groups-sharing.html#report-groups-sharing-share). @@ -101,4 +102,4 @@ Using `terraform import`, import CodeBuild Resource Policy using the CodeBuild R % terraform import aws_codebuild_resource_policy.example arn:aws:codebuild:us-west-2:123456789:report-group/report-group-name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/codebuild_source_credential.html.markdown b/website/docs/cdktf/python/r/codebuild_source_credential.html.markdown index a74b800d5e29..cbcfa165f9fd 100644 --- a/website/docs/cdktf/python/r/codebuild_source_credential.html.markdown +++ b/website/docs/cdktf/python/r/codebuild_source_credential.html.markdown @@ -85,6 +85,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `auth_type` - (Required) The type of authentication used to connect to a GitHub, GitHub Enterprise, or Bitbucket repository. Valid values are `BASIC_AUTH`, `PERSONAL_ACCESS_TOKEN`, `CODECONNECTIONS`, and `SECRETS_MANAGER`. An OAUTH connection is not supported by the API. @@ -128,4 +129,4 @@ Using `terraform import`, import CodeBuild Source Credential using the CodeBuild % terraform import aws_codebuild_source_credential.example arn:aws:codebuild:us-west-2:123456789:token:github ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/codebuild_webhook.html.markdown b/website/docs/cdktf/python/r/codebuild_webhook.html.markdown index 81a8e35d4066..9efed3d9fad6 100644 --- a/website/docs/cdktf/python/r/codebuild_webhook.html.markdown +++ b/website/docs/cdktf/python/r/codebuild_webhook.html.markdown @@ -92,10 +92,42 @@ class MyConvertedCode(TerraformStack): github_repository_webhook_example.override_logical_id("example") ``` +### For CodeBuild Runner Project + +To create a CodeBuild project as a Runner Project, the following `aws_codebuild_webhook` resource is required for the project. +See thr [AWS Documentation](https://docs.aws.amazon.com/codebuild/latest/userguide/action-runner.html) for more information about CodeBuild Runner Projects. + +```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.codebuild_webhook import CodebuildWebhook +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + CodebuildWebhook(self, "example", + build_type="BUILD", + filter_group=[CodebuildWebhookFilterGroup( + filter=[CodebuildWebhookFilterGroupFilter( + pattern="WORKFLOW_JOB_QUEUED", + type="EVENT" + ) + ] + ) + ], + project_name=Token.as_string(aws_codebuild_project_example.name) + ) +``` + ## Argument Reference This resource supports the following arguments: +* `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). * `project_name` - (Required) The name of the build project. * `build_type` - (Optional) The type of build this webhook will trigger. Valid values for this parameter are: `BUILD`, `BUILD_BATCH`. * `manual_creation` - (Optional) If true, CodeBuild doesn't create a webhook in GitHub and instead returns `payload_url` and `secret` values for the webhook. The `payload_url` and `secret` values in the output can be used to manually create a webhook within GitHub. @@ -155,4 +187,4 @@ Using `terraform import`, import CodeBuild Webhooks using the CodeBuild Project % terraform import aws_codebuild_webhook.example MyProjectName ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/codecatalyst_dev_environment.html.markdown b/website/docs/cdktf/python/r/codecatalyst_dev_environment.html.markdown index 9e671f0e9f44..804d6dd999de 100644 --- a/website/docs/cdktf/python/r/codecatalyst_dev_environment.html.markdown +++ b/website/docs/cdktf/python/r/codecatalyst_dev_environment.html.markdown @@ -58,6 +58,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `inactivity_timeout_minutes` - (Optional) The amount of time the Dev Environment will run without any activity detected before stopping, in minutes. Only whole integers are allowed. Dev Environments consume compute minutes when running. * `repositories` - (Optional) The source repository that contains the branch to clone into the Dev Environment. @@ -89,4 +90,4 @@ This resource exports the following attributes in addition to the arguments abov - `update` - (Default `10m`) - `delete` - (Default `10m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/codecatalyst_project.html.markdown b/website/docs/cdktf/python/r/codecatalyst_project.html.markdown index e0fd642e07b2..fb97ecc57b7a 100644 --- a/website/docs/cdktf/python/r/codecatalyst_project.html.markdown +++ b/website/docs/cdktf/python/r/codecatalyst_project.html.markdown @@ -44,6 +44,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `description` - (Optional) The description of the project. This description will be displayed to all users of the project. We recommend providing a brief description of the project and its intended purpose. ## Attribute Reference @@ -86,4 +87,4 @@ Using `terraform import`, import CodeCatalyst Project using the `id`. For exampl % terraform import aws_codecatalyst_project.example project-id-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/codecatalyst_source_repository.html.markdown b/website/docs/cdktf/python/r/codecatalyst_source_repository.html.markdown index 90f6443e2264..3e39b94b8e73 100644 --- a/website/docs/cdktf/python/r/codecatalyst_source_repository.html.markdown +++ b/website/docs/cdktf/python/r/codecatalyst_source_repository.html.markdown @@ -45,6 +45,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `description` - (Optional) The description of the project. This description will be displayed to all users of the project. We recommend providing a brief description of the project and its intended purpose. ## Attribute Reference @@ -86,4 +87,4 @@ Using `terraform import`, import CodeCatalyst Source Repository using the `id`. % terraform import aws_codecatalyst_source_repository.example example-repo ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/codecommit_approval_rule_template.html.markdown b/website/docs/cdktf/python/r/codecommit_approval_rule_template.html.markdown index 78572d8fbe94..d00c7ffa4da8 100644 --- a/website/docs/cdktf/python/r/codecommit_approval_rule_template.html.markdown +++ b/website/docs/cdktf/python/r/codecommit_approval_rule_template.html.markdown @@ -48,6 +48,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `content` - (Required) The content of the approval rule template. Maximum of 3000 characters. * `name` - (Required) The name for the approval rule template. Maximum of 100 characters. * `description` - (Optional) The description of the approval rule template. Maximum of 1000 characters. @@ -87,4 +88,4 @@ Using `terraform import`, import CodeCommit approval rule templates using the `n % terraform import aws_codecommit_approval_rule_template.imported ExistingApprovalRuleTemplateName ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/codecommit_approval_rule_template_association.html.markdown b/website/docs/cdktf/python/r/codecommit_approval_rule_template_association.html.markdown index d3b8da4db125..9c00e790116d 100644 --- a/website/docs/cdktf/python/r/codecommit_approval_rule_template_association.html.markdown +++ b/website/docs/cdktf/python/r/codecommit_approval_rule_template_association.html.markdown @@ -36,6 +36,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `approval_rule_template_name` - (Required) The name for the approval rule template. * `repository_name` - (Required) The name of the repository that you want to associate with the template. @@ -70,4 +71,4 @@ Using `terraform import`, import CodeCommit approval rule template associations % terraform import aws_codecommit_approval_rule_template_association.example approver-rule-for-example,MyExampleRepo ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/codecommit_repository.html.markdown b/website/docs/cdktf/python/r/codecommit_repository.html.markdown index 5f8d7471fe58..da8d0edf7d33 100644 --- a/website/docs/cdktf/python/r/codecommit_repository.html.markdown +++ b/website/docs/cdktf/python/r/codecommit_repository.html.markdown @@ -64,6 +64,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `repository_name` - (Required) The name for the repository. This needs to be less than 100 characters. * `description` - (Optional) The description of the repository. This needs to be less than 1000 characters * `default_branch` - (Optional) The default branch of the repository. The branch specified here needs to exist. @@ -105,4 +106,4 @@ Using `terraform import`, import CodeCommit repository using repository name. Fo % terraform import aws_codecommit_repository.imported ExistingRepo ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/codecommit_trigger.html.markdown b/website/docs/cdktf/python/r/codecommit_trigger.html.markdown index 6e4188ed374d..e0b23fbe054a 100644 --- a/website/docs/cdktf/python/r/codecommit_trigger.html.markdown +++ b/website/docs/cdktf/python/r/codecommit_trigger.html.markdown @@ -49,6 +49,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `repository_name` - (Required) The name for the repository. This needs to be less than 100 characters. * `trigger` - (Required) The name of the trigger. * `name` - (Required) The name of the trigger. @@ -63,4 +64,4 @@ This resource exports the following attributes in addition to the arguments abov * `configuration_id` - System-generated unique identifier. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/codeconnections_connection.html.markdown b/website/docs/cdktf/python/r/codeconnections_connection.html.markdown index f761c1bac3e6..8b9e4a3d799a 100644 --- a/website/docs/cdktf/python/r/codeconnections_connection.html.markdown +++ b/website/docs/cdktf/python/r/codeconnections_connection.html.markdown @@ -40,6 +40,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) The name of the connection to be created. The name must be unique in the calling AWS account. Changing `name` will create a new resource. * `provider_type` - (Optional) The name of the external provider where your third-party code repository is configured. Changing `provider_type` will create a new resource. Conflicts with `host_arn`. * `host_arn` - (Optional) The Amazon Resource Name (ARN) of the host associated with the connection. Conflicts with `provider_type` @@ -49,9 +50,9 @@ This resource supports the following arguments: This resource exports the following attributes in addition to the arguments above: -* `id` - The codeconnections connection ARN. * `arn` - The codeconnections connection ARN. * `connection_status` - The codeconnections connection status. Possible values are `PENDING`, `AVAILABLE` and `ERROR`. +* `id` - (**Deprecated**) The codeconnections connection ARN. * `tags_all` - A map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). ## Import @@ -79,4 +80,4 @@ Using `terraform import`, import CodeConnections connection using the ARN. For e % terraform import aws_codeconnections_connection.test-connection arn:aws:codeconnections:us-west-1:0123456789:connection/79d4d357-a2ee-41e4-b350-2fe39ae59448 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/codeconnections_host.html.markdown b/website/docs/cdktf/python/r/codeconnections_host.html.markdown index f412201d32c2..858d28953504 100644 --- a/website/docs/cdktf/python/r/codeconnections_host.html.markdown +++ b/website/docs/cdktf/python/r/codeconnections_host.html.markdown @@ -41,6 +41,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) The name of the host to be created. The name must be unique in the calling AWS account. * `provider_endpoint` - (Required) The endpoint of the infrastructure to be represented by the host after it is created. * `provider_type` - (Required) The name of the external provider where your third-party code repository is configured. @@ -57,8 +58,8 @@ A `vpc_configuration` block supports the following arguments: This resource exports the following attributes in addition to the arguments above: -* `id` - The CodeConnections Host ARN. * `arn` - The CodeConnections Host ARN. +* `id` - (**Deprecated**) The CodeConnections Host ARN. * `status` - The CodeConnections Host status. Possible values are `PENDING`, `AVAILABLE`, `VPC_CONFIG_DELETING`, `VPC_CONFIG_INITIALIZING`, and `VPC_CONFIG_FAILED_INITIALIZATION`. ## Import @@ -86,4 +87,4 @@ Using `terraform import`, import CodeConnections Host using the ARN. For example % terraform import aws_codeconnections_host.example-host arn:aws:codeconnections:us-west-1:0123456789:host/79d4d357-a2ee-41e4-b350-2fe39ae59448 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/codedeploy_app.html.markdown b/website/docs/cdktf/python/r/codedeploy_app.html.markdown index c87845367884..2518b6f3b758 100644 --- a/website/docs/cdktf/python/r/codedeploy_app.html.markdown +++ b/website/docs/cdktf/python/r/codedeploy_app.html.markdown @@ -78,6 +78,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) The name of the application. * `compute_platform` - (Optional) The compute platform can either be `ECS`, `Lambda`, or `Server`. Default is `Server`. * `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. @@ -119,4 +120,4 @@ Using `terraform import`, import CodeDeploy Applications using the `name`. For e % terraform import aws_codedeploy_app.example my-application ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/codedeploy_deployment_config.html.markdown b/website/docs/cdktf/python/r/codedeploy_deployment_config.html.markdown index 55e554c4ea9a..ba7186342f4d 100644 --- a/website/docs/cdktf/python/r/codedeploy_deployment_config.html.markdown +++ b/website/docs/cdktf/python/r/codedeploy_deployment_config.html.markdown @@ -114,6 +114,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `deployment_config_name` - (Required) The name of the deployment config. * `compute_platform` - (Optional) The compute platform can be `Server`, `Lambda`, or `ECS`. Default is `Server`. * `minimum_healthy_hosts` - (Optional) A minimum_healthy_hosts block. Required for `Server` compute platform. Minimum Healthy Hosts are documented below. @@ -188,4 +189,4 @@ Using `terraform import`, import CodeDeploy Deployment Configurations using the % terraform import aws_codedeploy_deployment_config.example my-deployment-config ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/codedeploy_deployment_group.html.markdown b/website/docs/cdktf/python/r/codedeploy_deployment_group.html.markdown index bceea40dfd5b..9f3c5009e11f 100644 --- a/website/docs/cdktf/python/r/codedeploy_deployment_group.html.markdown +++ b/website/docs/cdktf/python/r/codedeploy_deployment_group.html.markdown @@ -216,6 +216,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `app_name` - (Required) The name of the application. * `deployment_group_name` - (Required) The name of the deployment group. * `service_role_arn` - (Required) The service role ARN that allows deployments. @@ -415,4 +416,4 @@ Using `terraform import`, import CodeDeploy Deployment Groups using `app_name`, [1]: http://docs.aws.amazon.com/codedeploy/latest/userguide/monitoring-sns-event-notifications-create-trigger.html - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/codeguruprofiler_profiling_group.html.markdown b/website/docs/cdktf/python/r/codeguruprofiler_profiling_group.html.markdown index e03de65b03d6..b7e8decc3393 100644 --- a/website/docs/cdktf/python/r/codeguruprofiler_profiling_group.html.markdown +++ b/website/docs/cdktf/python/r/codeguruprofiler_profiling_group.html.markdown @@ -46,6 +46,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `compute_platform` - (Optional) Compute platform of the profiling group. * `tags` - (Optional) Map of tags assigned to the resource. If configured with a provider [`default_tags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. @@ -86,4 +87,4 @@ Using `terraform import`, import CodeGuru Profiler Profiling Group using the `id % terraform import aws_codeguruprofiler_profiling_group.example profiling_group-name-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/codegurureviewer_repository_association.html.markdown b/website/docs/cdktf/python/r/codegurureviewer_repository_association.html.markdown index 7d3209263039..85e591733eaf 100644 --- a/website/docs/cdktf/python/r/codegurureviewer_repository_association.html.markdown +++ b/website/docs/cdktf/python/r/codegurureviewer_repository_association.html.markdown @@ -62,6 +62,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `kms_key_details` - (Optional) An object describing the KMS key to asssociate. Block is documented below. ## repository @@ -118,4 +119,4 @@ This resource exports the following attributes in addition to the arguments abov * `update` - (Default `180m`) * `delete` - (Default `90m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/codepipeline.html.markdown b/website/docs/cdktf/python/r/codepipeline.html.markdown index c8a1a269802e..d1183d2ff503 100644 --- a/website/docs/cdktf/python/r/codepipeline.html.markdown +++ b/website/docs/cdktf/python/r/codepipeline.html.markdown @@ -161,18 +161,19 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) The name of the pipeline. * `pipeline_type` - (Optional) Type of the pipeline. Possible values are: `V1` and `V2`. Default value is `V1`. * `role_arn` - (Required) A service role Amazon Resource Name (ARN) that grants AWS CodePipeline permission to make calls to AWS services on your behalf. * `artifact_store` (Required) One or more artifact_store blocks. Artifact stores are documented below. * `execution_mode` (Optional) The method that the pipeline will use to handle multiple executions. The default mode is `SUPERSEDED`. For value values, refer to the [AWS documentation](https://docs.aws.amazon.com/codepipeline/latest/APIReference/API_PipelineDeclaration.html#CodePipeline-Type-PipelineDeclaration-executionMode). - - **Note:** `QUEUED` or `PARALLEL` mode can only be used with V2 pipelines. * `stage` (Minimum of at least two `stage` blocks is required) A stage block. Stages are documented below. * `tags` - (Optional) A 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. * `trigger` - (Optional) A trigger block. Valid only when `pipeline_type` is `V2`. Triggers are documented below. * `variable` - (Optional) A pipeline-level variable block. Valid only when `pipeline_type` is `V2`. Variable are documented below. +**Note:** `QUEUED` or `PARALLEL` mode can only be used with V2 pipelines. + ### `artifact_store` An `artifact_store` block supports the following arguments: @@ -367,4 +368,4 @@ Using `terraform import`, import CodePipelines using the `name`. For example: % terraform import aws_codepipeline.example example-pipeline ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/codepipeline_custom_action_type.html.markdown b/website/docs/cdktf/python/r/codepipeline_custom_action_type.html.markdown index 6f28ae56bf1a..9877dc45579b 100644 --- a/website/docs/cdktf/python/r/codepipeline_custom_action_type.html.markdown +++ b/website/docs/cdktf/python/r/codepipeline_custom_action_type.html.markdown @@ -45,6 +45,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `category` - (Required) The category of the custom action. Valid values: `Source`, `Build`, `Deploy`, `Test`, `Invoke`, `Approval` * `configuration_property` - (Optional) The configuration properties for the custom action. Max 10 items. @@ -119,4 +120,4 @@ Using `terraform import`, import CodeDeploy CustomActionType using the `id`. For % terraform import aws_codepipeline_custom_action_type.example Build:terraform:1 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/codepipeline_webhook.html.markdown b/website/docs/cdktf/python/r/codepipeline_webhook.html.markdown index 45d3cf2dbbfb..40b753a54aae 100644 --- a/website/docs/cdktf/python/r/codepipeline_webhook.html.markdown +++ b/website/docs/cdktf/python/r/codepipeline_webhook.html.markdown @@ -112,6 +112,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) The name of the webhook. * `authentication` - (Required) The type of authentication to use. One of `IP`, `GITHUB_HMAC`, or `UNAUTHENTICATED`. * `authentication_configuration` - (Optional) An `auth` block. Required for `IP` and `GITHUB_HMAC`. Auth blocks are documented below. @@ -164,4 +165,4 @@ Using `terraform import`, import CodePipeline Webhooks using their ARN. For exam % terraform import aws_codepipeline_webhook.example arn:aws:codepipeline:us-west-2:123456789012:webhook:example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/codestarconnections_connection.html.markdown b/website/docs/cdktf/python/r/codestarconnections_connection.html.markdown index 57a60e872d3e..67a7a49a24e1 100644 --- a/website/docs/cdktf/python/r/codestarconnections_connection.html.markdown +++ b/website/docs/cdktf/python/r/codestarconnections_connection.html.markdown @@ -88,6 +88,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) The name of the connection to be created. The name must be unique in the calling AWS account. Changing `name` will create a new resource. * `provider_type` - (Optional) The name of the external provider where your third-party code repository is configured. Valid values are `Bitbucket`, `GitHub`, `GitHubEnterpriseServer`, `GitLab` or `GitLabSelfManaged`. Changing `provider_type` will create a new resource. Conflicts with `host_arn` * `host_arn` - (Optional) The Amazon Resource Name (ARN) of the host associated with the connection. Conflicts with `provider_type` @@ -127,4 +128,4 @@ Using `terraform import`, import CodeStar connections using the ARN. For example % terraform import aws_codestarconnections_connection.test-connection arn:aws:codestar-connections:us-west-1:0123456789:connection/79d4d357-a2ee-41e4-b350-2fe39ae59448 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/codestarconnections_host.html.markdown b/website/docs/cdktf/python/r/codestarconnections_host.html.markdown index 09f740c51021..646f9bc6ea12 100644 --- a/website/docs/cdktf/python/r/codestarconnections_host.html.markdown +++ b/website/docs/cdktf/python/r/codestarconnections_host.html.markdown @@ -39,6 +39,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) The name of the host to be created. The name must be unique in the calling AWS account. * `provider_endpoint` - (Required) The endpoint of the infrastructure to be represented by the host after it is created. * `provider_type` - (Required) The name of the external provider where your third-party code repository is configured. @@ -84,4 +85,4 @@ Using `terraform import`, import CodeStar Host using the ARN. For example: % terraform import aws_codestarconnections_host.example-host arn:aws:codestar-connections:us-west-1:0123456789:host/79d4d357-a2ee-41e4-b350-2fe39ae59448 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/codestarnotifications_notification_rule.html.markdown b/website/docs/cdktf/python/r/codestarnotifications_notification_rule.html.markdown index bf65f4735075..ac59e5e98be6 100644 --- a/website/docs/cdktf/python/r/codestarnotifications_notification_rule.html.markdown +++ b/website/docs/cdktf/python/r/codestarnotifications_notification_rule.html.markdown @@ -68,6 +68,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `detail_type` - (Required) The level of detail to include in the notifications for this resource. Possible values are `BASIC` and `FULL`. * `event_type_ids` - (Required) A list of event types associated with this notification rule. For list of allowed events see [here](https://docs.aws.amazon.com/codestar-notifications/latest/userguide/concepts.html#concepts-api). @@ -115,4 +116,4 @@ Using `terraform import`, import CodeStar notification rule using the ARN. For e % terraform import aws_codestarnotifications_notification_rule.foo arn:aws:codestar-notifications:us-west-1:0123456789:notificationrule/2cdc68a3-8f7c-4893-b6a5-45b362bd4f2b ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/cognito_identity_pool.html.markdown b/website/docs/cdktf/python/r/cognito_identity_pool.html.markdown index 32503b283487..69887be2e57a 100644 --- a/website/docs/cdktf/python/r/cognito_identity_pool.html.markdown +++ b/website/docs/cdktf/python/r/cognito_identity_pool.html.markdown @@ -59,6 +59,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `identity_pool_name` (Required) - The Cognito Identity Pool name. * `allow_unauthenticated_identities` (Required) - Whether the identity pool supports unauthenticated logins or not. * `allow_classic_flow` (Optional) - Enables or disables the classic / basic authentication flow. Default is `false`. @@ -109,4 +110,4 @@ Using `terraform import`, import Cognito Identity Pool using its ID. For example % terraform import aws_cognito_identity_pool.mypool us-west-2:1a234567-8901-234b-5cde-f6789g01h2i3 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/cognito_identity_pool_provider_principal_tag.html.markdown b/website/docs/cdktf/python/r/cognito_identity_pool_provider_principal_tag.html.markdown index c0eac9f43e5b..d5afe67ec741 100644 --- a/website/docs/cdktf/python/r/cognito_identity_pool_provider_principal_tag.html.markdown +++ b/website/docs/cdktf/python/r/cognito_identity_pool_provider_principal_tag.html.markdown @@ -70,6 +70,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `identity_pool_id` (Required) - An identity pool ID. * `identity_provider_name` (Required) - The name of the identity provider. * `principal_tags`: (Optional: []) - String to string map of variables. @@ -104,4 +105,4 @@ Using `terraform import`, import Cognito Identity Pool Roles Attachment using th % terraform import aws_cognito_identity_pool_provider_principal_tag.example us-west-2_abc123:CorpAD ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/cognito_identity_pool_roles_attachment.html.markdown b/website/docs/cdktf/python/r/cognito_identity_pool_roles_attachment.html.markdown index b8fcfba9dc04..af41dc4a721d 100644 --- a/website/docs/cdktf/python/r/cognito_identity_pool_roles_attachment.html.markdown +++ b/website/docs/cdktf/python/r/cognito_identity_pool_roles_attachment.html.markdown @@ -109,6 +109,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `identity_pool_id` (Required) - An identity pool ID in the format `REGION_GUID`. * `role_mapping` (Optional) - A List of [Role Mapping](#role-mappings). * `roles` (Required) - The map of roles associated with this pool. For a given role, the key will be either "authenticated" or "unauthenticated" and the value will be the Role ARN. @@ -158,4 +159,4 @@ Using `terraform import`, import Cognito Identity Pool Roles Attachment using th % terraform import aws_cognito_identity_pool_roles_attachment.example us-west-2:b64805ad-cb56-40ba-9ffc-f5d8207e6d42 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/cognito_identity_provider.html.markdown b/website/docs/cdktf/python/r/cognito_identity_provider.html.markdown index c9fa696d76ce..857225fcef67 100644 --- a/website/docs/cdktf/python/r/cognito_identity_provider.html.markdown +++ b/website/docs/cdktf/python/r/cognito_identity_provider.html.markdown @@ -52,6 +52,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `user_pool_id` (Required) - The user pool id * `provider_name` (Required) - The provider name * `provider_type` (Required) - The provider type. [See AWS API for valid values](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateIdentityProvider.html#CognitoUserPools-CreateIdentityProvider-request-ProviderType) @@ -88,4 +89,4 @@ Using `terraform import`, import `aws_cognito_identity_provider` resources using % terraform import aws_cognito_identity_provider.example us-west-2_abc123:CorpAD ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/cognito_log_delivery_configuration.html.markdown b/website/docs/cdktf/python/r/cognito_log_delivery_configuration.html.markdown new file mode 100644 index 000000000000..a78d6ac18c17 --- /dev/null +++ b/website/docs/cdktf/python/r/cognito_log_delivery_configuration.html.markdown @@ -0,0 +1,272 @@ +--- +subcategory: "Cognito IDP (Identity Provider)" +layout: "aws" +page_title: "AWS: aws_cognito_log_delivery_configuration" +description: |- + Manages an AWS Cognito IDP (Identity Provider) Log Delivery Configuration. +--- + + + +# Resource: aws_cognito_log_delivery_configuration + +Manages an AWS Cognito IDP (Identity Provider) Log Delivery Configuration. + +## Example Usage + +### Basic Usage with CloudWatch Logs + +```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.cloudwatch_log_group import CloudwatchLogGroup +from imports.aws.cognito_log_delivery_configuration import CognitoLogDeliveryConfiguration +from imports.aws.cognito_user_pool import CognitoUserPool +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + example = CloudwatchLogGroup(self, "example", + name="example" + ) + aws_cognito_user_pool_example = CognitoUserPool(self, "example_1", + name="example" + ) + # 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_cognito_user_pool_example.override_logical_id("example") + aws_cognito_log_delivery_configuration_example = + CognitoLogDeliveryConfiguration(self, "example_2", + log_configurations=[CognitoLogDeliveryConfigurationLogConfigurations( + cloud_watch_logs_configuration=[CognitoLogDeliveryConfigurationLogConfigurationsCloudWatchLogsConfiguration( + log_group_arn=example.arn + ) + ], + event_source="userNotification", + log_level="ERROR" + ) + ], + user_pool_id=Token.as_string(aws_cognito_user_pool_example.id) + ) + # 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_cognito_log_delivery_configuration_example.override_logical_id("example") +``` + +### Multiple Log Configurations with Different Destinations + +```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.cloudwatch_log_group import CloudwatchLogGroup +from imports.aws.cognito_log_delivery_configuration import CognitoLogDeliveryConfiguration +from imports.aws.cognito_user_pool import CognitoUserPool +from imports.aws.iam_role import IamRole +from imports.aws.iam_role_policy import IamRolePolicy +from imports.aws.kinesis_firehose_delivery_stream import KinesisFirehoseDeliveryStream +from imports.aws.s3_bucket import S3Bucket +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + example = CloudwatchLogGroup(self, "example", + name="example" + ) + aws_cognito_user_pool_example = CognitoUserPool(self, "example_1", + name="example" + ) + # 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_cognito_user_pool_example.override_logical_id("example") + firehose = IamRole(self, "firehose", + assume_role_policy=Token.as_string( + Fn.jsonencode({ + "Statement": [{ + "Action": "sts:AssumeRole", + "Effect": "Allow", + "Principal": { + "Service": "firehose.amazonaws.com" + } + } + ], + "Version": "2012-10-17" + })), + name="firehose-role" + ) + aws_s3_bucket_example = S3Bucket(self, "example_3", + bucket="example-bucket", + force_destroy=True + ) + # 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_s3_bucket_example.override_logical_id("example") + aws_iam_role_policy_firehose = IamRolePolicy(self, "firehose_4", + name="firehose-policy", + policy=Token.as_string( + Fn.jsonencode({ + "Statement": [{ + "Action": ["s3:AbortMultipartUpload", "s3:GetBucketLocation", "s3:GetObject", "s3:ListBucket", "s3:ListBucketMultipartUploads", "s3:PutObject" + ], + "Effect": "Allow", + "Resource": [aws_s3_bucket_example.arn, "${" + aws_s3_bucket_example.arn + "}/*" + ] + } + ], + "Version": "2012-10-17" + })), + role=firehose.id + ) + # 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_iam_role_policy_firehose.override_logical_id("firehose") + aws_kinesis_firehose_delivery_stream_example = + KinesisFirehoseDeliveryStream(self, "example_5", + destination="extended_s3", + extended_s3_configuration=KinesisFirehoseDeliveryStreamExtendedS3Configuration( + bucket_arn=Token.as_string(aws_s3_bucket_example.arn), + role_arn=firehose.arn + ), + name="example-stream" + ) + # 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_kinesis_firehose_delivery_stream_example.override_logical_id("example") + aws_cognito_log_delivery_configuration_example = + CognitoLogDeliveryConfiguration(self, "example_6", + log_configurations=[CognitoLogDeliveryConfigurationLogConfigurations( + cloud_watch_logs_configuration=[CognitoLogDeliveryConfigurationLogConfigurationsCloudWatchLogsConfiguration( + log_group_arn=example.arn + ) + ], + event_source="userNotification", + log_level="INFO" + ), CognitoLogDeliveryConfigurationLogConfigurations( + event_source="userAuthEvents", + firehose_configuration=[CognitoLogDeliveryConfigurationLogConfigurationsFirehoseConfiguration( + stream_arn=Token.as_string(aws_kinesis_firehose_delivery_stream_example.arn) + ) + ], + log_level="ERROR" + ) + ], + user_pool_id=Token.as_string(aws_cognito_user_pool_example.id) + ) + # 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_cognito_log_delivery_configuration_example.override_logical_id("example") +``` + +### S3 Configuration + +```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.cognito_log_delivery_configuration import CognitoLogDeliveryConfiguration +from imports.aws.cognito_user_pool import CognitoUserPool +from imports.aws.s3_bucket import S3Bucket +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + example = CognitoUserPool(self, "example", + name="example" + ) + aws_s3_bucket_example = S3Bucket(self, "example_1", + bucket="example-bucket", + force_destroy=True + ) + # 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_s3_bucket_example.override_logical_id("example") + aws_cognito_log_delivery_configuration_example = + CognitoLogDeliveryConfiguration(self, "example_2", + log_configurations=[CognitoLogDeliveryConfigurationLogConfigurations( + event_source="userNotification", + log_level="ERROR", + s3_configuration=[CognitoLogDeliveryConfigurationLogConfigurationsS3Configuration( + bucket_arn=Token.as_string(aws_s3_bucket_example.arn) + ) + ] + ) + ], + user_pool_id=example.id + ) + # 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_cognito_log_delivery_configuration_example.override_logical_id("example") +``` + +## Argument Reference + +The following arguments are required: + +* `user_pool_id` - (Required) The ID of the user pool for which to configure log delivery. + +The following arguments are optional: + +* `log_configurations` - (Optional) Configuration block for log delivery. At least one configuration block is required. See [Log Configurations](#log-configurations) below. +* `region` - (Optional) The AWS region. + +### Log Configurations + +The `log_configurations` block supports the following: + +* `event_source` - (Required) The event source to configure logging for. Valid values are `userNotification` and `userAuthEvents`. +* `log_level` - (Required) The log level to set for the event source. Valid values are `ERROR` and `INFO`. +* `cloud_watch_logs_configuration` - (Optional) Configuration for CloudWatch Logs delivery. See [CloudWatch Logs Configuration](#cloudwatch-logs-configuration) below. +* `firehose_configuration` - (Optional) Configuration for Kinesis Data Firehose delivery. See [Firehose Configuration](#firehose-configuration) below. +* `s3_configuration` - (Optional) Configuration for S3 delivery. See [S3 Configuration](#s3-configuration) below. + +~> **Note:** At least one destination configuration (`cloud_watch_logs_configuration`, `firehose_configuration`, or `s3_configuration`) must be specified for each log configuration. + +#### CloudWatch Logs Configuration + +The `cloud_watch_logs_configuration` block supports the following: + +* `log_group_arn` - (Optional) The ARN of the CloudWatch Logs log group to which the logs should be delivered. + +#### Firehose Configuration + +The `firehose_configuration` block supports the following: + +* `stream_arn` - (Optional) The ARN of the Kinesis Data Firehose delivery stream to which the logs should be delivered. + +#### S3 Configuration + +The `s3_configuration` block supports the following: + +* `bucket_arn` - (Optional) The ARN of the S3 bucket to which the logs should be delivered. + +## Attribute Reference + +This resource exports the following attributes in addition to the arguments above: + +## Import + +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import Cognito IDP (Identity Provider) Log Delivery Configuration using the `user_pool_id`. 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.cognito_log_delivery_configuration import CognitoLogDeliveryConfiguration +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + CognitoLogDeliveryConfiguration.generate_config_for_import(self, "example", "us-west-2_example123") +``` + +Using `terraform import`, import Cognito IDP (Identity Provider) Log Delivery Configuration using the `user_pool_id`. For example: + +```console +% terraform import aws_cognito_log_delivery_configuration.example us-west-2_example123 +``` + + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/cognito_managed_user_pool_client.html.markdown b/website/docs/cdktf/python/r/cognito_managed_user_pool_client.html.markdown index 99e8187f026f..39bbd188b464 100644 --- a/website/docs/cdktf/python/r/cognito_managed_user_pool_client.html.markdown +++ b/website/docs/cdktf/python/r/cognito_managed_user_pool_client.html.markdown @@ -126,6 +126,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `access_token_validity` - (Optional) Time limit, between 5 minutes and 1 day, after which the access token is no longer valid and cannot be used. By default, the unit is hours. The unit can be overridden by a value in `token_validity_units.access_token`. * `allowed_oauth_flows_user_pool_client` - (Optional) Whether the client is allowed to use OAuth 2.0 features. `allowed_oauth_flows_user_pool_client` must be set to `true` before you can configure the following arguments: `callback_urls`, `logout_urls`, `allowed_oauth_scopes` and `allowed_oauth_flows`. * `allowed_oauth_flows` - (Optional) List of allowed OAuth flows, including `code`, `implicit`, and `client_credentials`. `allowed_oauth_flows_user_pool_client` must be set to `true` before you can configure this option. @@ -204,4 +205,4 @@ Using `terraform import`, import Cognito User Pool Clients using the `id` of the % terraform import aws_cognito_managed_user_pool_client.client us-west-2_abc123/3ho4ek12345678909nh3fmhpko ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/cognito_resource_server.html.markdown b/website/docs/cdktf/python/r/cognito_resource_server.html.markdown index c212cd7ff369..ee728b79fbcc 100644 --- a/website/docs/cdktf/python/r/cognito_resource_server.html.markdown +++ b/website/docs/cdktf/python/r/cognito_resource_server.html.markdown @@ -74,6 +74,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `identifier` - (Required) An identifier for the resource server. * `name` - (Required) A name for the resource server. * `user_pool_id` - (Required) User pool the client belongs to. @@ -115,4 +116,4 @@ Using `terraform import`, import `aws_cognito_resource_server` using their User % terraform import aws_cognito_resource_server.example "us-west-2_abc123|https://example.com" ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/cognito_risk_configuration.html.markdown b/website/docs/cdktf/python/r/cognito_risk_configuration.html.markdown index 8daec104447c..b43ad8236db3 100644 --- a/website/docs/cdktf/python/r/cognito_risk_configuration.html.markdown +++ b/website/docs/cdktf/python/r/cognito_risk_configuration.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `user_pool_id` - (Required) The user pool ID. * `client_id` - (Optional) The app client ID. When the client ID is not provided, the same risk configuration is applied to all the clients in the User Pool. * `account_takeover_risk_configuration` - (Optional) The account takeover risk configuration. See details below. @@ -151,4 +152,4 @@ Import using the user pool ID and Client ID separated by a `:`: % terraform import aws_cognito_risk_configuration.main example:example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/cognito_user.html.markdown b/website/docs/cdktf/python/r/cognito_user.html.markdown index bc0069066dd8..b49225a1ce31 100644 --- a/website/docs/cdktf/python/r/cognito_user.html.markdown +++ b/website/docs/cdktf/python/r/cognito_user.html.markdown @@ -96,6 +96,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `attributes` - (Optional) A map that contains user attributes and attribute values to be set for the user. * `client_metadata` - (Optional) A map of custom key-value pairs that you can provide as input for any custom workflows that user creation triggers. Amazon Cognito does not store the `client_metadata` value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose. For more information, see [Customizing User Pool Workflows with Lambda Triggers](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html). * `desired_delivery_mediums` - (Optional) A list of mediums to the welcome message will be sent through. Allowed values are `EMAIL` and `SMS`. If it's provided, make sure you have also specified `email` attribute for the `EMAIL` medium and `phone_number` for the `SMS`. More than one value can be specified. Amazon Cognito does not store the `desired_delivery_mediums` value. Defaults to `["SMS"]`. @@ -141,4 +142,4 @@ Using `terraform import`, import Cognito User using the `user_pool_id`/`name` at % terraform import aws_cognito_user.user us-east-1_vG78M4goG/user ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/cognito_user_group.html.markdown b/website/docs/cdktf/python/r/cognito_user_group.html.markdown index 2c32128dbfd9..a03530fceddf 100644 --- a/website/docs/cdktf/python/r/cognito_user_group.html.markdown +++ b/website/docs/cdktf/python/r/cognito_user_group.html.markdown @@ -75,6 +75,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) The name of the user group. * `user_pool_id` - (Required) The user pool ID. * `description` - (Optional) The description of the user group. @@ -110,4 +111,4 @@ Using `terraform import`, import Cognito User Groups using the `user_pool_id`/`n % terraform import aws_cognito_user_group.group us-east-1_vG78M4goG/user-group ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/cognito_user_in_group.html.markdown b/website/docs/cdktf/python/r/cognito_user_in_group.html.markdown index 422d0cad80ba..815b5f554706 100644 --- a/website/docs/cdktf/python/r/cognito_user_in_group.html.markdown +++ b/website/docs/cdktf/python/r/cognito_user_in_group.html.markdown @@ -62,8 +62,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `user_pool_id` - (Required) The user pool ID of the user and group. * `group_name` - (Required) The name of the group to which the user is to be added. * `username` - (Required) The username of the user to be added to the group. @@ -72,4 +73,29 @@ The following arguments are required: This resource exports no additional attributes. - \ No newline at end of file +## Import + +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import a Cognito Group User using a comma-delimited string concatenating the `user_pool_id`, `group_name`, and `username` arguments. 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.cognito_user_in_group import CognitoUserInGroup +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + CognitoUserInGroup.generate_config_for_import(self, "example", "us-east-1_vG78M4goG,example-group,example-user") +``` + +Using `terraform import`, import a Cognito Group User using a comma-delimited string concatenating the `user_pool_id`, `group_name`, and `username` arguments. For example: + +```console +% terraform import aws_cognito_user_in_group.example us-east-1_vG78M4goG,example-group,example-user +``` + + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/cognito_user_pool.html.markdown b/website/docs/cdktf/python/r/cognito_user_pool.html.markdown index 5668689a3dfe..147f2338e5d6 100644 --- a/website/docs/cdktf/python/r/cognito_user_pool.html.markdown +++ b/website/docs/cdktf/python/r/cognito_user_pool.html.markdown @@ -95,6 +95,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) Name of the user pool. * `account_recovery_setting` - (Optional) Configuration block to define which verified available method a user can use to recover their forgotten password. [Detailed below](#account_recovery_setting). * `admin_create_user_config` - (Optional) Configuration block for creating a new user profile. [Detailed below](#admin_create_user_config). @@ -103,18 +104,18 @@ This resource supports the following arguments: * `deletion_protection` - (Optional) When active, DeletionProtection prevents accidental deletion of your user pool. Before you can delete a user pool that you have protected against deletion, you must deactivate this feature. Valid values are `ACTIVE` and `INACTIVE`, Default value is `INACTIVE`. * `device_configuration` - (Optional) Configuration block for the user pool's device tracking. [Detailed below](#device_configuration). * `email_configuration` - (Optional) Configuration block for configuring email. [Detailed below](#email_configuration). -* `email_mfa_configuration` - (Optional) Configuration block for configuring email Multi-Factor Authentication (MFA); requires at least 2 `account_recovery_setting` entries; requires an `email_configuration` configuration block. [Detailed below](#email_mfa_configuration). +* `email_mfa_configuration` - (Optional) Configuration block for configuring email Multi-Factor Authentication (MFA); requires at least 2 `account_recovery_setting` entries; requires an `email_configuration` configuration block. Effective only when `mfa_configuration` is `ON` or `OPTIONAL`. [Detailed below](#email_mfa_configuration). * `email_verification_message` - (Optional) String representing the email verification message. Conflicts with `verification_message_template` configuration block `email_message` argument. * `email_verification_subject` - (Optional) String representing the email verification subject. Conflicts with `verification_message_template` configuration block `email_subject` argument. * `lambda_config` - (Optional) Configuration block for the AWS Lambda triggers associated with the user pool. [Detailed below](#lambda_config). -* `mfa_configuration` - (Optional) Multi-Factor Authentication (MFA) configuration for the User Pool. Defaults of `OFF`. Valid values are `OFF` (MFA Tokens are not required), `ON` (MFA is required for all users to sign in; requires at least one of `sms_configuration` or `software_token_mfa_configuration` to be configured), or `OPTIONAL` (MFA Will be required only for individual users who have MFA Enabled; requires at least one of `sms_configuration` or `software_token_mfa_configuration` to be configured). +* `mfa_configuration` - (Optional) Multi-Factor Authentication (MFA) configuration for the User Pool. Defaults of `OFF`. Valid values are `OFF` (MFA Tokens are not required), `ON` (MFA is required for all users to sign in; requires at least one of `email_mfa_configuration`, `sms_configuration` or `software_token_mfa_configuration` to be configured), or `OPTIONAL` (MFA Will be required only for individual users who have MFA Enabled; requires at least one of `email_mfa_configuration`, `sms_configuration` or `software_token_mfa_configuration` to be configured). * `password_policy` - (Optional) Configuration block for information about the user pool password policy. [Detailed below](#password_policy). * `schema` - (Optional) Configuration block for the schema attributes of a user pool. [Detailed below](#schema). Schema attributes from the [standard attribute set](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html#cognito-user-pools-standard-attributes) only need to be specified if they are different from the default configuration. Attributes can be added, but not modified or removed. Maximum of 50 attributes. * `sign_in_policy` - (Optional) Configuration block for information about the user pool sign in policy. [Detailed below](#sign_in_policy). * `sms_authentication_message` - (Optional) String representing the SMS authentication message. The Message must contain the `{####}` placeholder, which will be replaced with the code. -* `sms_configuration` - (Optional) Configuration block for Short Message Service (SMS) settings. [Detailed below](#sms_configuration). These settings apply to SMS user verification and SMS Multi-Factor Authentication (MFA). Due to Cognito API restrictions, the SMS configuration cannot be removed without recreating the Cognito User Pool. For user data safety, this resource will ignore the removal of this configuration by disabling drift detection. To force resource recreation after this configuration has been applied, see the [`taint` command](https://www.terraform.io/docs/commands/taint.html). +* `sms_configuration` - (Optional) Configuration block for Short Message Service (SMS) settings. [Detailed below](#sms_configuration). These settings apply to SMS user verification and SMS Multi-Factor Authentication (MFA). SMS MFA is activated only when `mfa_configuration` is set to `ON` or `OPTIONAL` along with this block. Due to Cognito API restrictions, the SMS configuration cannot be removed without recreating the Cognito User Pool. For user data safety, this resource will ignore the removal of this configuration by disabling drift detection. To force resource recreation after this configuration has been applied, see the [`taint` command](https://www.terraform.io/docs/commands/taint.html). * `sms_verification_message` - (Optional) String representing the SMS verification message. Conflicts with `verification_message_template` configuration block `sms_message` argument. -* `software_token_mfa_configuration` - (Optional) Configuration block for software token Mult-Factor Authentication (MFA) settings. [Detailed below](#software_token_mfa_configuration). +* `software_token_mfa_configuration` - (Optional) Configuration block for software token Mult-Factor Authentication (MFA) settings. Effective only when `mfa_configuration` is `ON` or `OPTIONAL`. [Detailed below](#software_token_mfa_configuration). * `tags` - (Optional) Map of tags to assign to the User Pool. 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. * `user_attribute_update_settings` - (Optional) Configuration block for user attribute update settings. [Detailed below](#user_attribute_update_settings). * `user_pool_add_ons` - (Optional) Configuration block for user pool add-ons to enable user pool advanced security mode features. [Detailed below](#user_pool_add_ons). @@ -344,4 +345,4 @@ Using `terraform import`, import Cognito User Pools using the `id`. For example: % terraform import aws_cognito_user_pool.pool us-west-2_abc123 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/cognito_user_pool_client.html.markdown b/website/docs/cdktf/python/r/cognito_user_pool_client.html.markdown index 1fbe378444f3..9b53159ae062 100644 --- a/website/docs/cdktf/python/r/cognito_user_pool_client.html.markdown +++ b/website/docs/cdktf/python/r/cognito_user_pool_client.html.markdown @@ -198,10 +198,10 @@ class MyConvertedCode(TerraformStack): CognitoUserPoolClient(self, "userpool_client", explicit_auth_flows=["ADMIN_NO_SRP_AUTH"], name="client", - refresh_token_rotation=[{ - "feature": "ENABLED", - "retry_grace_period_seconds": 10 - } + refresh_token_rotation=[CognitoUserPoolClientRefreshTokenRotation( + feature="ENABLED", + retry_grace_period_seconds=10 + ) ], user_pool_id=pool.id ) @@ -216,6 +216,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `access_token_validity` - (Optional) Time limit, between 5 minutes and 1 day, after which the access token is no longer valid and cannot be used. By default, the unit is hours. The unit can be overridden by a value in `token_validity_units.access_token`. * `allowed_oauth_flows_user_pool_client` - (Optional) Whether the client is allowed to use OAuth 2.0 features. `allowed_oauth_flows_user_pool_client` must be set to `true` before you can configure the following arguments: `callback_urls`, `logout_urls`, `allowed_oauth_scopes` and `allowed_oauth_flows`. * `allowed_oauth_flows` - (Optional) List of allowed OAuth flows, including `code`, `implicit`, and `client_credentials`. `allowed_oauth_flows_user_pool_client` must be set to `true` before you can configure this option. @@ -293,4 +294,4 @@ Using `terraform import`, import Cognito User Pool Clients using the `id` of the % terraform import aws_cognito_user_pool_client.client us-west-2_abc123/3ho4ek12345678909nh3fmhpko ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/cognito_user_pool_domain.html.markdown b/website/docs/cdktf/python/r/cognito_user_pool_domain.html.markdown index cd4f89fab7a3..d0587c7044eb 100644 --- a/website/docs/cdktf/python/r/cognito_user_pool_domain.html.markdown +++ b/website/docs/cdktf/python/r/cognito_user_pool_domain.html.markdown @@ -84,6 +84,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `domain` - (Required) For custom domains, this is the fully-qualified domain name, such as auth.example.com. For Amazon Cognito prefix domains, this is the prefix alone, such as auth. * `user_pool_id` - (Required) The user pool ID. * `certificate_arn` - (Optional) The ARN of an ISSUED ACM certificate in us-east-1 for a custom domain. @@ -125,4 +126,4 @@ Using `terraform import`, import Cognito User Pool Domains using the `domain`. F % terraform import aws_cognito_user_pool_domain.main auth.example.org ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/cognito_user_pool_ui_customization.html.markdown b/website/docs/cdktf/python/r/cognito_user_pool_ui_customization.html.markdown index 12a5e2c13a7f..36cd35774120 100644 --- a/website/docs/cdktf/python/r/cognito_user_pool_ui_customization.html.markdown +++ b/website/docs/cdktf/python/r/cognito_user_pool_ui_customization.html.markdown @@ -98,6 +98,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `client_id` (Optional) The client ID for the client app. Defaults to `ALL`. If `ALL` is specified, the `css` and/or `image_file` settings will be used for every client that has no UI customization set previously. * `css` (Optional) - The CSS values in the UI customization, provided as a String. At least one of `css` or `image_file` is required. * `image_file` (Optional) - The uploaded logo image for the UI customization, provided as a base64-encoded String. Drift detection is not possible for this argument. At least one of `css` or `image_file` is required. @@ -137,4 +138,4 @@ Using `terraform import`, import Cognito User Pool UI Customizations using the ` % terraform import aws_cognito_user_pool_ui_customization.example us-west-2_ZCTarbt5C,12bu4fuk3mlgqa2rtrujgp6egq ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/comprehend_document_classifier.html.markdown b/website/docs/cdktf/python/r/comprehend_document_classifier.html.markdown index 54ace878b56c..5c746ed86ea2 100644 --- a/website/docs/cdktf/python/r/comprehend_document_classifier.html.markdown +++ b/website/docs/cdktf/python/r/comprehend_document_classifier.html.markdown @@ -41,7 +41,7 @@ class MyConvertedCode(TerraformStack): data_access_role_arn=Token.as_string(aws_iam_role_example.arn), depends_on=[aws_iam_role_policy_example], input_data_config=ComprehendDocumentClassifierInputDataConfig( - s3_uri="s3://${" + test.bucket + "}/${" + documents.id + "}" + s3_uri="s3://${" + test.bucket + "}/${" + documents.key + "}" ), language_code="en", name="example" @@ -63,6 +63,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `mode` - (Optional, Default: `MULTI_CLASS`) The document classification mode. One of `MULTI_CLASS` or `MULTI_LABEL`. `MULTI_CLASS` is also known as "Single Label" in the AWS Console. @@ -165,4 +166,4 @@ Using `terraform import`, import Comprehend Document Classifier using the ARN. F % terraform import aws_comprehend_document_classifier.example arn:aws:comprehend:us-west-2:123456789012:document_classifier/example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/comprehend_entity_recognizer.html.markdown b/website/docs/cdktf/python/r/comprehend_entity_recognizer.html.markdown index 371dc6774c6d..18469ddff654 100644 --- a/website/docs/cdktf/python/r/comprehend_entity_recognizer.html.markdown +++ b/website/docs/cdktf/python/r/comprehend_entity_recognizer.html.markdown @@ -42,10 +42,10 @@ class MyConvertedCode(TerraformStack): depends_on=[aws_iam_role_policy_example], input_data_config=ComprehendEntityRecognizerInputDataConfig( documents=ComprehendEntityRecognizerInputDataConfigDocuments( - s3_uri="s3://${" + aws_s3_bucket_documents.bucket + "}/${" + documents.id + "}" + s3_uri="s3://${" + aws_s3_bucket_documents.bucket + "}/${" + documents.key + "}" ), entity_list=ComprehendEntityRecognizerInputDataConfigEntityListStruct( - s3_uri="s3://${" + aws_s3_bucket_entities.bucket + "}/${" + entities.id + "}" + s3_uri="s3://${" + aws_s3_bucket_entities.bucket + "}/${" + entities.key + "}" ), entity_types=[ComprehendEntityRecognizerInputDataConfigEntityTypes( type="ENTITY_1" @@ -74,6 +74,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `model_kms_key_id` - (Optional) The ID or ARN of a KMS Key used to encrypt trained Entity Recognizers. * `tags` - (Optional) A map of tags to assign to the resource. If configured with a provider [`default_tags` Configuration Block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. * `version_name` - (Optional) Name for the version of the Entity Recognizer. @@ -188,4 +189,4 @@ Using `terraform import`, import Comprehend Entity Recognizer using the ARN. For % terraform import aws_comprehend_entity_recognizer.example arn:aws:comprehend:us-west-2:123456789012:entity-recognizer/example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/computeoptimizer_enrollment_status.html.markdown b/website/docs/cdktf/python/r/computeoptimizer_enrollment_status.html.markdown index 71e90b080f2a..4550fb9b55dd 100644 --- a/website/docs/cdktf/python/r/computeoptimizer_enrollment_status.html.markdown +++ b/website/docs/cdktf/python/r/computeoptimizer_enrollment_status.html.markdown @@ -35,6 +35,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `include_member_accounts` - (Optional) Whether to enroll member accounts of the organization if the account is the management account of an organization. Default is `false`. * `status` - (Required) The enrollment status of the account. Valid values: `Active`, `Inactive`. @@ -76,4 +77,4 @@ Using `terraform import`, import enrollment status using the account ID. For exa % terraform import aws_computeoptimizer_enrollment_status.example 123456789012 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/computeoptimizer_recommendation_preferences.html.markdown b/website/docs/cdktf/python/r/computeoptimizer_recommendation_preferences.html.markdown index a6981901fe51..8463bb65c5f5 100644 --- a/website/docs/cdktf/python/r/computeoptimizer_recommendation_preferences.html.markdown +++ b/website/docs/cdktf/python/r/computeoptimizer_recommendation_preferences.html.markdown @@ -77,12 +77,13 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `enhanced_infrastructure_metrics` - (Optional) The status of the enhanced infrastructure metrics recommendation preference. Valid values: `Active`, `Inactive`. * `external_metrics_preference` - (Optional) The provider of the external metrics recommendation preference. See [External Metrics Preference](#external-metrics-preference) below. * `inferred_workload_types` - (Optional) The status of the inferred workload types recommendation preference. Valid values: `Active`, `Inactive`. * `look_back_period` - (Optional) The preference to control the number of days the utilization metrics of the AWS resource are analyzed. Valid values: `DAYS_14`, `DAYS_32`, `DAYS_93`. * `preferred_resource` - (Optional) The preference to control which resource type values are considered when generating rightsizing recommendations. See [Preferred Resources](#preferred-resources) below. -* `resource_type` - (Required) The target resource type of the recommendation preferences. Valid values: `Ec2Instance`, `AutoScalingGroup`, `RdsDBInstance`. +* `resource_type` - (Required) The target resource type of the recommendation preferences. Valid values: `Ec2Instance`, `AutoScalingGroup`, `RdsDBInstance`, `AuroraDBClusterStorage`. * `savings_estimation_mode` - (Optional) The status of the savings estimation mode preference. Valid values: `AfterDiscounts`, `BeforeDiscounts`. * `scope` - (Required) The scope of the recommendation preferences. See [Scope](#scope) below. * `utilization_preference` - (Optional) The preference to control the resource’s CPU utilization threshold, CPU utilization headroom, and memory utilization headroom. See [Utilization Preferences](#utilization-preferences) below. @@ -141,4 +142,4 @@ Using `terraform import`, import recommendation preferences using the resource t % terraform import aws_computeoptimizer_recommendation_preferences.example Ec2Instance,AccountId,123456789012 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/config_aggregate_authorization.html.markdown b/website/docs/cdktf/python/r/config_aggregate_authorization.html.markdown index b70ed07d609a..c31bb1a70f31 100644 --- a/website/docs/cdktf/python/r/config_aggregate_authorization.html.markdown +++ b/website/docs/cdktf/python/r/config_aggregate_authorization.html.markdown @@ -28,7 +28,7 @@ class MyConvertedCode(TerraformStack): super().__init__(scope, name) ConfigAggregateAuthorization(self, "example", account_id="123456789012", - region="eu-west-2" + authorized_aws_region="eu-west-2" ) ``` @@ -36,8 +36,9 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: -* `account_id` - (Required) Account ID -* `region` - (Required) Region +* `account_id` - (Required) Account ID. +* `authorized_aws_region` - (Optional) The region authorized to collect aggregated data. +* `region` - (Optional, **Deprecated**) The region authorized to collect aggregated data. Use `authorized_aws_region` instead. * `tags` - (Optional) A 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. ## Attribute Reference @@ -49,7 +50,7 @@ This resource exports the following attributes in addition to the arguments abov ## Import -In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import Config aggregate authorizations using `account_id:region`. For example: +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import Config aggregate authorizations using `account_id:authorized_aws_region`. For example: ```python # DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -66,10 +67,10 @@ class MyConvertedCode(TerraformStack): ConfigAggregateAuthorization.generate_config_for_import(self, "example", "123456789012:us-east-1") ``` -Using `terraform import`, import Config aggregate authorizations using `account_id:region`. For example: +Using `terraform import`, import Config aggregate authorizations using `account_id:authorized_aws_region`. For example: ```console % terraform import aws_config_aggregate_authorization.example 123456789012:us-east-1 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/config_config_rule.html.markdown b/website/docs/cdktf/python/r/config_config_rule.html.markdown index 5f417e8afa15..b729f34a0b2e 100644 --- a/website/docs/cdktf/python/r/config_config_rule.html.markdown +++ b/website/docs/cdktf/python/r/config_config_rule.html.markdown @@ -165,6 +165,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) The name of the rule * `description` - (Optional) Description of the rule * `evaluation_mode` - (Optional) The modes the Config rule can be evaluated in. See [Evaluation Mode](#evaluation-mode) for more details. @@ -246,4 +247,4 @@ Using `terraform import`, import Config Rule using the name. For example: % terraform import aws_config_config_rule.foo example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/config_configuration_aggregator.html.markdown b/website/docs/cdktf/python/r/config_configuration_aggregator.html.markdown index 07f4f9b92ec2..bdf2184cad9a 100644 --- a/website/docs/cdktf/python/r/config_configuration_aggregator.html.markdown +++ b/website/docs/cdktf/python/r/config_configuration_aggregator.html.markdown @@ -93,6 +93,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) The name of the configuration aggregator. * `account_aggregation_source` - (Optional) The account(s) to aggregate config data from as documented below. * `organization_aggregation_source` - (Optional) The organization to aggregate config data from as documented below. @@ -150,4 +151,4 @@ Using `terraform import`, import Configuration Aggregators using the name. For e % terraform import aws_config_configuration_aggregator.example foo ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/config_configuration_recorder.html.markdown b/website/docs/cdktf/python/r/config_configuration_recorder.html.markdown index 0dc856c50f96..796023c15d60 100644 --- a/website/docs/cdktf/python/r/config_configuration_recorder.html.markdown +++ b/website/docs/cdktf/python/r/config_configuration_recorder.html.markdown @@ -122,6 +122,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Optional) The name of the recorder. Defaults to `default`. Changing it recreates the resource. * `role_arn` - (Required) Amazon Resource Name (ARN) of the IAM role. Used to make read or write requests to the delivery channel and to describe the AWS resources associated with the account. See [AWS Docs](http://docs.aws.amazon.com/config/latest/developerguide/iamrole-permissions.html) for more details. * `recording_group` - (Optional) Recording group - see below. @@ -185,4 +186,4 @@ Using `terraform import`, import Configuration Recorder using the name. For exam % terraform import aws_config_configuration_recorder.foo example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/config_configuration_recorder_status.html.markdown b/website/docs/cdktf/python/r/config_configuration_recorder_status.html.markdown index 7e606e82893f..c9a730613f5a 100644 --- a/website/docs/cdktf/python/r/config_configuration_recorder_status.html.markdown +++ b/website/docs/cdktf/python/r/config_configuration_recorder_status.html.markdown @@ -97,6 +97,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) The name of the recorder * `is_enabled` - (Required) Whether the configuration recorder should be enabled or disabled. @@ -129,4 +130,4 @@ Using `terraform import`, import Configuration Recorder Status using the name of % terraform import aws_config_configuration_recorder_status.foo example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/config_conformance_pack.html.markdown b/website/docs/cdktf/python/r/config_conformance_pack.html.markdown index c940fe4269fd..3a4d4ac84725 100644 --- a/website/docs/cdktf/python/r/config_conformance_pack.html.markdown +++ b/website/docs/cdktf/python/r/config_conformance_pack.html.markdown @@ -86,6 +86,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required, Forces new resource) The name of the conformance pack. Must begin with a letter and contain from 1 to 256 alphanumeric characters and hyphens. * `delivery_s3_bucket` - (Optional) Amazon S3 bucket where AWS Config stores conformance pack templates. Maximum length of 63. * `delivery_s3_key_prefix` - (Optional) The prefix for the Amazon S3 bucket. Maximum length of 1024. @@ -133,4 +134,4 @@ Using `terraform import`, import Config Conformance Packs using the `name`. For % terraform import aws_config_conformance_pack.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/config_delivery_channel.html.markdown b/website/docs/cdktf/python/r/config_delivery_channel.html.markdown index 2c1a388a9a92..8cacd64a277d 100644 --- a/website/docs/cdktf/python/r/config_delivery_channel.html.markdown +++ b/website/docs/cdktf/python/r/config_delivery_channel.html.markdown @@ -85,6 +85,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Optional) The name of the delivery channel. Defaults to `default`. Changing it recreates the resource. * `s3_bucket_name` - (Required) The name of the S3 bucket used to store the configuration history. * `s3_key_prefix` - (Optional) The prefix for the specified S3 bucket. @@ -127,4 +128,4 @@ Using `terraform import`, import Delivery Channel using the name. For example: % terraform import aws_config_delivery_channel.foo example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/config_organization_conformance_pack.html.markdown b/website/docs/cdktf/python/r/config_organization_conformance_pack.html.markdown index ecd9e32c1d87..5cfe942597c3 100644 --- a/website/docs/cdktf/python/r/config_organization_conformance_pack.html.markdown +++ b/website/docs/cdktf/python/r/config_organization_conformance_pack.html.markdown @@ -97,6 +97,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required, Forces new resource) The name of the organization conformance pack. Must begin with a letter and contain from 1 to 128 alphanumeric characters and hyphens. * `delivery_s3_bucket` - (Optional) Amazon S3 bucket where AWS Config stores conformance pack templates. Delivery bucket must begin with `awsconfigconforms` prefix. Maximum length of 63. * `delivery_s3_key_prefix` - (Optional) The prefix for the Amazon S3 bucket. Maximum length of 1024. @@ -152,4 +153,4 @@ Using `terraform import`, import Config Organization Conformance Packs using the % terraform import aws_config_organization_conformance_pack.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/config_organization_custom_policy_rule.html.markdown b/website/docs/cdktf/python/r/config_organization_custom_policy_rule.html.markdown index 1f7177afe62d..1f1d0888f4c2 100644 --- a/website/docs/cdktf/python/r/config_organization_custom_policy_rule.html.markdown +++ b/website/docs/cdktf/python/r/config_organization_custom_policy_rule.html.markdown @@ -43,28 +43,29 @@ class MyConvertedCode(TerraformStack): The following arguments are required: -* `name` - (Required) name of the rule -* `policy_text` - (Required) policy definition containing the logic for your organization AWS Config Custom Policy rule -* `policy_runtime` - (Required) runtime system for your organization AWS Config Custom Policy rules -* `trigger_types` - (Required) List of notification types that trigger AWS Config to run an evaluation for the rule. Valid values: `ConfigurationItemChangeNotification`, `OversizedConfigurationItemChangeNotification` +* `name` - (Required) Name of the rule. +* `policy_text` - (Required) Policy definition containing the rule logic. +* `policy_runtime` - (Required) Runtime system for policy rules. +* `trigger_types` - (Required) List of notification types that trigger AWS Config to run an evaluation for the rule. Valid values: `ConfigurationItemChangeNotification`, `OversizedConfigurationItemChangeNotification`. The following arguments are optional: -* `description` - (Optional) Description of the rule -* `debug_log_delivery_accounts` - (Optional) List of AWS account identifiers to exclude from the rule -* `excluded_accounts` - (Optional) List of AWS account identifiers to exclude from the rule -* `input_parameters` - (Optional) A string in JSON format that is passed to the AWS Config Rule Lambda Function +* `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). +* `description` - (Optional) Description of the rule. +* `debug_log_delivery_accounts` - (Optional) List of accounts that you can enable debug logging for. The list is null when debug logging is enabled for all accounts. +* `excluded_accounts` - (Optional) List of AWS account identifiers to exclude from the rule. +* `input_parameters` - (Optional) A string in JSON format that is passed to the AWS Config Rule Lambda Function. * `maximum_execution_frequency` - (Optional) Maximum frequency with which AWS Config runs evaluations for a rule, if the rule is triggered at a periodic frequency. Defaults to `TwentyFour_Hours` for periodic frequency triggered rules. Valid values: `One_Hour`, `Three_Hours`, `Six_Hours`, `Twelve_Hours`, or `TwentyFour_Hours`. -* `resource_id_scope` - (Optional) Identifier of the AWS resource to evaluate -* `resource_types_scope` - (Optional) List of types of AWS resources to evaluate -* `tag_key_scope` - (Optional, Required if `tag_value_scope` is configured) Tag key of AWS resources to evaluate -* `tag_value_scope` - (Optional) Tag value of AWS resources to evaluate +* `resource_id_scope` - (Optional) Identifier of the AWS resource to evaluate. +* `resource_types_scope` - (Optional) List of types of AWS resources to evaluate. +* `tag_key_scope` - (Optional, Required if `tag_value_scope` is configured) Tag key of AWS resources to evaluate. +* `tag_value_scope` - (Optional) Tag value of AWS resources to evaluate. ## Attribute Reference This resource exports the following attributes in addition to the arguments above: -* `arn` - Amazon Resource Name (ARN) of the rule +* `arn` - Amazon Resource Name (ARN) of the rule. ## Timeouts @@ -99,4 +100,4 @@ Using `terraform import`, import a Config Organization Custom Policy Rule using % terraform import aws_config_organization_custom_policy_rule.example example_rule_name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/config_organization_custom_rule.html.markdown b/website/docs/cdktf/python/r/config_organization_custom_rule.html.markdown index adf79787532a..6463ef816829 100644 --- a/website/docs/cdktf/python/r/config_organization_custom_rule.html.markdown +++ b/website/docs/cdktf/python/r/config_organization_custom_rule.html.markdown @@ -59,6 +59,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `lambda_function_arn` - (Required) Amazon Resource Name (ARN) of the rule Lambda Function * `name` - (Required) The name of the rule * `trigger_types` - (Required) List of notification types that trigger AWS Config to run an evaluation for the rule. Valid values: `ConfigurationItemChangeNotification`, `OversizedConfigurationItemChangeNotification`, and `ScheduledNotification` @@ -110,4 +111,4 @@ Using `terraform import`, import Config Organization Custom Rules using the name % terraform import aws_config_organization_custom_rule.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/config_organization_managed_rule.html.markdown b/website/docs/cdktf/python/r/config_organization_managed_rule.html.markdown index e643d0be910a..1a3968021ffd 100644 --- a/website/docs/cdktf/python/r/config_organization_managed_rule.html.markdown +++ b/website/docs/cdktf/python/r/config_organization_managed_rule.html.markdown @@ -49,6 +49,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) The name of the rule * `rule_identifier` - (Required) Identifier of an available AWS Config Managed Rule to call. For available values, see the [List of AWS Config Managed Rules](https://docs.aws.amazon.com/config/latest/developerguide/managed-rules-by-aws-config.html) documentation * `description` - (Optional) Description of the rule @@ -99,4 +100,4 @@ Using `terraform import`, import Config Organization Managed Rules using the nam % terraform import aws_config_organization_managed_rule.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/config_remediation_configuration.html.markdown b/website/docs/cdktf/python/r/config_remediation_configuration.html.markdown index 311500bd1410..0171c2664749 100644 --- a/website/docs/cdktf/python/r/config_remediation_configuration.html.markdown +++ b/website/docs/cdktf/python/r/config_remediation_configuration.html.markdown @@ -80,6 +80,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `automatic` - (Optional) Remediation is triggered automatically if `true`. * `execution_controls` - (Optional) Configuration block for execution controls. See below. * `maximum_automatic_attempts` - (Optional) Maximum number of failed attempts for auto-remediation. If you do not select a number, the default is 5. @@ -139,4 +140,4 @@ Using `terraform import`, import Remediation Configurations using the name confi % terraform import aws_config_remediation_configuration.this example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/config_retention_configuration.html.markdown b/website/docs/cdktf/python/r/config_retention_configuration.html.markdown index e5d2a7782ee1..d0fdd073cc00 100644 --- a/website/docs/cdktf/python/r/config_retention_configuration.html.markdown +++ b/website/docs/cdktf/python/r/config_retention_configuration.html.markdown @@ -36,6 +36,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `retention_period_in_days` - (Required) The number of days AWS Config stores historical information. ## Attribute Reference @@ -69,4 +70,4 @@ Using `terraform import`, import the AWS Config retention configuration using th % terraform import aws_config_retention_configuration.example default ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/connect_bot_association.html.markdown b/website/docs/cdktf/python/r/connect_bot_association.html.markdown index 131bb278346b..557d80eab46c 100644 --- a/website/docs/cdktf/python/r/connect_bot_association.html.markdown +++ b/website/docs/cdktf/python/r/connect_bot_association.html.markdown @@ -96,7 +96,7 @@ class MyConvertedCode(TerraformStack): aws_connect_bot_association_example = ConnectBotAssociation(self, "example_3", instance_id=Token.as_string(aws_connect_instance_example.id), lex_bot=ConnectBotAssociationLexBot( - lex_region=Token.as_string(current.name), + lex_region=Token.as_string(current.region), name=Token.as_string(aws_lex_bot_example.name) ) ) @@ -108,6 +108,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `instance_id` - (Required) The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance. * `lex_bot` - (Required) Configuration information of an Amazon Lex (V1) bot. Detailed below. @@ -149,4 +150,4 @@ Using `terraform import`, import `aws_connect_bot_association` using the Amazon % terraform import aws_connect_bot_association.example aaaaaaaa-bbbb-cccc-dddd-111111111111:Example:us-west-2 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/connect_contact_flow.html.markdown b/website/docs/cdktf/python/r/connect_contact_flow.html.markdown index bfe5da4aaf71..fc0daf00c8b1 100644 --- a/website/docs/cdktf/python/r/connect_contact_flow.html.markdown +++ b/website/docs/cdktf/python/r/connect_contact_flow.html.markdown @@ -112,6 +112,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `content` - (Optional) Specifies the content of the Contact Flow, provided as a JSON string, written in Amazon Connect Contact Flow Language. If defined, the `filename` argument cannot be used. * `content_hash` - (Optional) Used to trigger updates. Must be set to a base64-encoded SHA256 hash of the Contact Flow source specified with `filename`. The usual way to set this is filebase64sha256("mycontact_flow.json") (Terraform 0.11.12 and later) or base64sha256(file("mycontact_flow.json")) (Terraform 0.11.11 and earlier), where "mycontact_flow.json" is the local filename of the Contact Flow source. * `description` - (Optional) Specifies the description of the Contact Flow. @@ -155,4 +156,4 @@ Using `terraform import`, import Amazon Connect Contact Flows using the `instanc % terraform import aws_connect_contact_flow.example f1288a1f-6193-445a-b47e-af739b2:c1d4e5f6-1b3c-1b3c-1b3c-c1d4e5f6c1d4e5 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/connect_contact_flow_module.html.markdown b/website/docs/cdktf/python/r/connect_contact_flow_module.html.markdown index cfb65720d5b2..a6c53335fd62 100644 --- a/website/docs/cdktf/python/r/connect_contact_flow_module.html.markdown +++ b/website/docs/cdktf/python/r/connect_contact_flow_module.html.markdown @@ -125,6 +125,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `content` - (Optional) Specifies the content of the Contact Flow Module, provided as a JSON string, written in Amazon Connect Contact Flow Language. If defined, the `filename` argument cannot be used. * `content_hash` - (Optional) Used to trigger updates. Must be set to a base64-encoded SHA256 hash of the Contact Flow Module source specified with `filename`. The usual way to set this is filebase64sha256("contact_flow_module.json") (Terraform 0.11.12 and later) or base64sha256(file("contact_flow_module.json")) (Terraform 0.11.11 and earlier), where "contact_flow_module.json" is the local filename of the Contact Flow Module source. * `description` - (Optional) Specifies the description of the Contact Flow Module. @@ -167,4 +168,4 @@ Using `terraform import`, import Amazon Connect Contact Flow Modules using the ` % terraform import aws_connect_contact_flow_module.example f1288a1f-6193-445a-b47e-af739b2:c1d4e5f6-1b3c-1b3c-1b3c-c1d4e5f6c1d4e5 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/connect_hours_of_operation.html.markdown b/website/docs/cdktf/python/r/connect_hours_of_operation.html.markdown index ed21fdd5ce98..8e7f47c70eda 100644 --- a/website/docs/cdktf/python/r/connect_hours_of_operation.html.markdown +++ b/website/docs/cdktf/python/r/connect_hours_of_operation.html.markdown @@ -64,6 +64,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `config` - (Required) One or more config blocks which define the configuration information for the hours of operation: day, start time, and end time . Config blocks are documented below. * `description` - (Optional) Specifies the description of the Hours of Operation. * `instance_id` - (Required) Specifies the identifier of the hosting Amazon Connect Instance. @@ -121,4 +122,4 @@ Using `terraform import`, import Amazon Connect Hours of Operations using the `i % terraform import aws_connect_hours_of_operation.example f1288a1f-6193-445a-b47e-af739b2:c1d4e5f6-1b3c-1b3c-1b3c-c1d4e5f6c1d4e5 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/connect_instance.html.markdown b/website/docs/cdktf/python/r/connect_instance.html.markdown index dba65825ffa5..888c4b12d852 100644 --- a/website/docs/cdktf/python/r/connect_instance.html.markdown +++ b/website/docs/cdktf/python/r/connect_instance.html.markdown @@ -89,6 +89,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `auto_resolve_best_voices_enabled` - (Optional) Specifies whether auto resolve best voices is enabled. Defaults to `true`. * `contact_flow_logs_enabled` - (Optional) Specifies whether contact flow logs are enabled. Defaults to `false`. * `contact_lens_enabled` - (Optional) Specifies whether contact lens is enabled. Defaults to `true`. @@ -145,4 +146,4 @@ Using `terraform import`, import Connect instances using the `id`. For example: % terraform import aws_connect_instance.example f1288a1f-6193-445a-b47e-af739b2 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/connect_instance_storage_config.html.markdown b/website/docs/cdktf/python/r/connect_instance_storage_config.html.markdown index 841daca5f92f..6e2a95124000 100644 --- a/website/docs/cdktf/python/r/connect_instance_storage_config.html.markdown +++ b/website/docs/cdktf/python/r/connect_instance_storage_config.html.markdown @@ -160,6 +160,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `instance_id` - (Required) Specifies the identifier of the hosting Amazon Connect Instance. * `resource_type` - (Required) A valid resource type. Valid Values: `AGENT_EVENTS` | `ATTACHMENTS` | `CALL_RECORDINGS` | `CHAT_TRANSCRIPTS` | `CONTACT_EVALUATIONS` | `CONTACT_TRACE_RECORDS` | `EMAIL_MESSAGES` | `MEDIA_STREAMS` | `REAL_TIME_CONTACT_ANALYSIS_CHAT_SEGMENTS` | `REAL_TIME_CONTACT_ANALYSIS_SEGMENTS` | `REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS` | `SCHEDULED_REPORTS` | `SCREEN_RECORDINGS`. * `storage_config` - (Required) Specifies the storage configuration options for the Connect Instance. [Documented below](#storage_config). @@ -241,4 +242,4 @@ Using `terraform import`, import Amazon Connect Instance Storage Configs using t % terraform import aws_connect_instance_storage_config.example f1288a1f-6193-445a-b47e-af739b2:c1d4e5f6-1b3c-1b3c-1b3c-c1d4e5f6c1d4e5:CHAT_TRANSCRIPTS ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/connect_lambda_function_association.html.markdown b/website/docs/cdktf/python/r/connect_lambda_function_association.html.markdown index 7426c20f68d0..b615f0f2b1c4 100644 --- a/website/docs/cdktf/python/r/connect_lambda_function_association.html.markdown +++ b/website/docs/cdktf/python/r/connect_lambda_function_association.html.markdown @@ -37,6 +37,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `function_arn` - (Required) Amazon Resource Name (ARN) of the Lambda Function, omitting any version or alias qualifier. * `instance_id` - (Required) The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance. @@ -71,4 +72,4 @@ Using `terraform import`, import `aws_connect_lambda_function_association` using % terraform import aws_connect_lambda_function_association.example aaaaaaaa-bbbb-cccc-dddd-111111111111,arn:aws:lambda:us-west-2:123456789123:function:example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/connect_phone_number.html.markdown b/website/docs/cdktf/python/r/connect_phone_number.html.markdown index bd4dce84fcc7..2f0fe5da8240 100644 --- a/website/docs/cdktf/python/r/connect_phone_number.html.markdown +++ b/website/docs/cdktf/python/r/connect_phone_number.html.markdown @@ -87,6 +87,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `country_code` - (Required, Forces new resource) The ISO country code. For a list of Valid values, refer to [PhoneNumberCountryCode](https://docs.aws.amazon.com/connect/latest/APIReference/API_SearchAvailablePhoneNumbers.html#connect-SearchAvailablePhoneNumbers-request-PhoneNumberCountryCode). * `description` - (Optional, Forces new resource) The description of the phone number. * `prefix` - (Optional, Forces new resource) The prefix of the phone number that is used to filter available phone numbers. If provided, it must contain `+` as part of the country code. Do not specify this argument when importing the resource. @@ -144,4 +145,4 @@ Using `terraform import`, import Amazon Connect Phone Numbers using its `id`. Fo % terraform import aws_connect_phone_number.example 12345678-abcd-1234-efgh-9876543210ab ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/connect_phone_number_contact_flow_association.html.markdown b/website/docs/cdktf/python/r/connect_phone_number_contact_flow_association.html.markdown new file mode 100644 index 000000000000..313a17e828dd --- /dev/null +++ b/website/docs/cdktf/python/r/connect_phone_number_contact_flow_association.html.markdown @@ -0,0 +1,74 @@ +--- +subcategory: "Connect" +layout: "aws" +page_title: "AWS: aws_connect_phone_number_contact_flow_association" +description: |- + Associates a flow with a phone number claimed to an Amazon Connect instance. +--- + + + +# Resource: aws_connect_phone_number_contact_flow_association + +Associates a flow with a phone number claimed to an Amazon Connect instance. + +## 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. import ConnectPhoneNumberContactFlowAssociation +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + ConnectPhoneNumberContactFlowAssociation(self, "example", + contact_flow_id=aws_connect_contact_flow_example.contact_flow_id, + instance_id=aws_connect_instance_example.id, + phone_number_id=aws_connect_phone_number_example.id + ) +``` + +## Argument Reference + +This resource supports the following arguments: + +* `contact_flow_id` - (Required) Contact flow ID. +* `instance_id` - (Required) Amazon Connect instance ID. +* `phone_number_id` - (Required) Phone number ID. +* `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). + +## 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 `aws_connect_phone_number_contact_flow_association` using the `phone_number_id`, `instance_id` and `contact_flow_id` separated by a comma (`,`). 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. import ConnectPhoneNumberContactFlowAssociation +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + ConnectPhoneNumberContactFlowAssociation.generate_config_for_import(self, "example", "36727a4c-4683-4e49-880c-3347c61110a4,fa6c1691-e2eb-4487-bdb9-1aaed6268ebd,c4acdc79-395e-4280-a294-9062f56b07bb") +``` + +Using `terraform import`, import `aws_connect_phone_number_contact_flow_association` using the `phone_number_id`, `instance_id` and `contact_flow_id` separated by a comma (`,`). For example: + +```console +% terraform import aws_connect_phone_number_contact_flow_association.example 36727a4c-4683-4e49-880c-3347c61110a4,fa6c1691-e2eb-4487-bdb9-1aaed6268ebd,c4acdc79-395e-4280-a294-9062f56b07bb +``` + + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/connect_queue.html.markdown b/website/docs/cdktf/python/r/connect_queue.html.markdown index d7722f766c6b..519fbdf8ed98 100644 --- a/website/docs/cdktf/python/r/connect_queue.html.markdown +++ b/website/docs/cdktf/python/r/connect_queue.html.markdown @@ -100,6 +100,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `description` - (Optional) Specifies the description of the Queue. * `hours_of_operation_id` - (Required) Specifies the identifier of the Hours of Operation. * `instance_id` - (Required) Specifies the identifier of the hosting Amazon Connect Instance. @@ -150,4 +151,4 @@ Using `terraform import`, import Amazon Connect Queues using the `instance_id` a % terraform import aws_connect_queue.example f1288a1f-6193-445a-b47e-af739b2:c1d4e5f6-1b3c-1b3c-1b3c-c1d4e5f6c1d4e5 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/connect_quick_connect.html.markdown b/website/docs/cdktf/python/r/connect_quick_connect.html.markdown index 81d8fc04ac90..63d56857ce26 100644 --- a/website/docs/cdktf/python/r/connect_quick_connect.html.markdown +++ b/website/docs/cdktf/python/r/connect_quick_connect.html.markdown @@ -48,6 +48,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `description` - (Optional) Specifies the description of the Quick Connect. * `instance_id` - (Required) Specifies the identifier of the hosting Amazon Connect Instance. * `name` - (Required) Specifies the name of the Quick Connect. @@ -109,4 +110,4 @@ Using `terraform import`, import Amazon Connect Quick Connects using the `instan % terraform import aws_connect_quick_connect.example f1288a1f-6193-445a-b47e-af739b2:c1d4e5f6-1b3c-1b3c-1b3c-c1d4e5f6c1d4e5 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/connect_routing_profile.html.markdown b/website/docs/cdktf/python/r/connect_routing_profile.html.markdown index 3fa6d18fc542..5e5374f6a449 100644 --- a/website/docs/cdktf/python/r/connect_routing_profile.html.markdown +++ b/website/docs/cdktf/python/r/connect_routing_profile.html.markdown @@ -54,6 +54,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `default_outbound_queue_id` - (Required) Specifies the default outbound queue for the Routing Profile. * `description` - (Required) Specifies the description of the Routing Profile. * `instance_id` - (Required) Specifies the identifier of the hosting Amazon Connect Instance. @@ -115,4 +116,4 @@ Using `terraform import`, import Amazon Connect Routing Profiles using the `inst % terraform import aws_connect_routing_profile.example f1288a1f-6193-445a-b47e-af739b2:c1d4e5f6-1b3c-1b3c-1b3c-c1d4e5f6c1d4e5 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/connect_security_profile.html.markdown b/website/docs/cdktf/python/r/connect_security_profile.html.markdown index fb1a64ea6a0d..51717216be50 100644 --- a/website/docs/cdktf/python/r/connect_security_profile.html.markdown +++ b/website/docs/cdktf/python/r/connect_security_profile.html.markdown @@ -42,6 +42,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `description` - (Optional) Specifies the description of the Security Profile. * `instance_id` - (Required) Specifies the identifier of the hosting Amazon Connect Instance. * `name` - (Required) Specifies the name of the Security Profile. @@ -84,4 +85,4 @@ Using `terraform import`, import Amazon Connect Security Profiles using the `ins % terraform import aws_connect_security_profile.example f1288a1f-6193-445a-b47e-af739b2:c1d4e5f6-1b3c-1b3c-1b3c-c1d4e5f6c1d4e5 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/connect_user.html.markdown b/website/docs/cdktf/python/r/connect_user.html.markdown index 0c5b949147d8..6efecdba2ca1 100644 --- a/website/docs/cdktf/python/r/connect_user.html.markdown +++ b/website/docs/cdktf/python/r/connect_user.html.markdown @@ -181,6 +181,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `directory_user_id` - (Optional) The identifier of the user account in the directory used for identity management. If Amazon Connect cannot access the directory, you can specify this identifier to authenticate users. If you include the identifier, we assume that Amazon Connect cannot access the directory. Otherwise, the identity information is used to authenticate users from your directory. This parameter is required if you are using an existing directory for identity management in Amazon Connect when Amazon Connect cannot access your directory to authenticate users. If you are using SAML for identity management and include this parameter, an error is returned. * `hierarchy_group_id` - (Optional) The identifier of the hierarchy group for the user. * `identity_info` - (Optional) A block that contains information about the identity of the user. Documented below. @@ -242,4 +243,4 @@ Using `terraform import`, import Amazon Connect Users using the `instance_id` an % terraform import aws_connect_user.example f1288a1f-6193-445a-b47e-af739b2:c1d4e5f6-1b3c-1b3c-1b3c-c1d4e5f6c1d4e5 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/connect_user_hierarchy_group.html.markdown b/website/docs/cdktf/python/r/connect_user_hierarchy_group.html.markdown index 1203b4521a9f..82b2d12ec11f 100644 --- a/website/docs/cdktf/python/r/connect_user_hierarchy_group.html.markdown +++ b/website/docs/cdktf/python/r/connect_user_hierarchy_group.html.markdown @@ -75,6 +75,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `instance_id` - (Required) Specifies the identifier of the hosting Amazon Connect Instance. * `name` - (Required) The name of the user hierarchy group. Must not be more than 100 characters. * `parent_group_id` - (Optional) The identifier for the parent hierarchy group. The user hierarchy is created at level one if the parent group ID is null. @@ -132,4 +133,4 @@ Using `terraform import`, import Amazon Connect User Hierarchy Groups using the % terraform import aws_connect_user_hierarchy_group.example f1288a1f-6193-445a-b47e-af739b2:c1d4e5f6-1b3c-1b3c-1b3c-c1d4e5f6c1d4e5 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/connect_user_hierarchy_structure.html.markdown b/website/docs/cdktf/python/r/connect_user_hierarchy_structure.html.markdown index 44a49d929b38..c32f2380fc1c 100644 --- a/website/docs/cdktf/python/r/connect_user_hierarchy_structure.html.markdown +++ b/website/docs/cdktf/python/r/connect_user_hierarchy_structure.html.markdown @@ -79,6 +79,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `hierarchy_structure` - (Required) A block that defines the hierarchy structure's levels. The `hierarchy_structure` block is documented below. * `instance_id` - (Required) Specifies the identifier of the hosting Amazon Connect Instance. @@ -131,4 +132,4 @@ Using `terraform import`, import Amazon Connect User Hierarchy Structures using % terraform import aws_connect_user_hierarchy_structure.example f1288a1f-6193-445a-b47e-af739b2 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/connect_vocabulary.html.markdown b/website/docs/cdktf/python/r/connect_vocabulary.html.markdown index e8b01e5ba4b3..341a2fb21db0 100644 --- a/website/docs/cdktf/python/r/connect_vocabulary.html.markdown +++ b/website/docs/cdktf/python/r/connect_vocabulary.html.markdown @@ -42,6 +42,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `content` - (Required) The content of the custom vocabulary in plain-text format with a table of values. Each row in the table represents a word or a phrase, described with Phrase, IPA, SoundsLike, and DisplayAs fields. Separate the fields with TAB characters. For more information, see [Create a custom vocabulary using a table](https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html#create-vocabulary-table). Minimum length of `1`. Maximum length of `60000`. * `instance_id` - (Required) Specifies the identifier of the hosting Amazon Connect Instance. * `language_code` - (Required) The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see [What is Amazon Transcribe?](https://docs.aws.amazon.com/transcribe/latest/dg/transcribe-whatis.html). Valid Values are `ar-AE`, `de-CH`, `de-DE`, `en-AB`, `en-AU`, `en-GB`, `en-IE`, `en-IN`, `en-US`, `en-WL`, `es-ES`, `es-US`, `fr-CA`, `fr-FR`, `hi-IN`, `it-IT`, `ja-JP`, `ko-KR`, `pt-BR`, `pt-PT`, `zh-CN`. @@ -94,4 +95,4 @@ Using `terraform import`, import Amazon Connect Vocabularies using the `instance % terraform import aws_connect_vocabulary.example f1288a1f-6193-445a-b47e-af739b2:c1d4e5f6-1b3c-1b3c-1b3c-c1d4e5f6c1d4e5 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/controltower_control.html.markdown b/website/docs/cdktf/python/r/controltower_control.html.markdown index a414ee618cd1..d220572f6c22 100644 --- a/website/docs/cdktf/python/r/controltower_control.html.markdown +++ b/website/docs/cdktf/python/r/controltower_control.html.markdown @@ -39,7 +39,7 @@ class MyConvertedCode(TerraformStack): data_aws_organizations_organizational_units_example.override_logical_id("example") current = DataAwsRegion(self, "current") aws_controltower_control_example = ControltowerControl(self, "example_3", - control_identifier="arn:aws:controltower:${" + current.name + "}::control/AWS-GR_EC2_VOLUME_INUSE_CHECK", + control_identifier="arn:aws:controltower:${" + current.region + "}::control/AWS-GR_EC2_VOLUME_INUSE_CHECK", parameters=[ControltowerControlParameters( key="AllowedRegions", value=Token.as_string(Fn.jsonencode(["us-east-1"])) @@ -61,6 +61,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `parameters` - (Optional) Parameter values which are specified to configure the control when you enable it. See [Parameters](#parameters) for more details. ### Parameters @@ -100,4 +101,4 @@ Using `terraform import`, import Control Tower Controls using their `organizatio % terraform import aws_controltower_control.example arn:aws:organizations::123456789101:ou/o-qqaejywet/ou-qg5o-ufbhdtv3,arn:aws:controltower:us-east-1::control/WTDSMKDKDNLE ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/controltower_landing_zone.html.markdown b/website/docs/cdktf/python/r/controltower_landing_zone.html.markdown index e8375d53c360..2fed1786a19f 100644 --- a/website/docs/cdktf/python/r/controltower_landing_zone.html.markdown +++ b/website/docs/cdktf/python/r/controltower_landing_zone.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `manifest_json` - (Required) The manifest JSON file is a text file that describes your AWS resources. For examples, review [Launch your landing zone](https://docs.aws.amazon.com/controltower/latest/userguide/lz-api-launch). * `version` - (Required) The landing zone version. * `tags` - (Optional) Tags to apply to the landing zone. 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. @@ -86,4 +87,4 @@ Using `terraform import`, import a Control Tower Landing Zone using the `id`. Fo % terraform import aws_controltower_landing_zone.example 1A2B3C4D5E6F7G8H ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/cur_report_definition.html.markdown b/website/docs/cdktf/python/r/cur_report_definition.html.markdown index 28e7ea6f54cf..3925496b87f2 100644 --- a/website/docs/cdktf/python/r/cur_report_definition.html.markdown +++ b/website/docs/cdktf/python/r/cur_report_definition.html.markdown @@ -35,6 +35,7 @@ class MyConvertedCode(TerraformStack): format="textORcsv", report_name="example-cur-report-definition", s3_bucket="example-bucket-name", + s3_prefix="example-cur-report", s3_region="us-east-1", time_unit="HOURLY" ) @@ -48,9 +49,9 @@ This resource supports the following arguments: * `time_unit` - (Required) The frequency on which report data are measured and displayed. Valid values are: `DAILY`, `HOURLY`, `MONTHLY`. * `format` - (Required) Format for report. Valid values are: `textORcsv`, `Parquet`. If `Parquet` is used, then Compression must also be `Parquet`. * `compression` - (Required) Compression format for report. Valid values are: `GZIP`, `ZIP`, `Parquet`. If `Parquet` is used, then format must also be `Parquet`. -* `additional_schema_elements` - (Required) A list of schema elements. Valid values are: `RESOURCES`, `SPLIT_COST_ALLOCATION_DATA`. +* `additional_schema_elements` - (Required) A list of schema elements. Valid values are: `RESOURCES`, `SPLIT_COST_ALLOCATION_DATA`, `MANUAL_DISCOUNT_COMPATIBILITY`. * `s3_bucket` - (Required) Name of the existing S3 bucket to hold generated reports. -* `s3_prefix` - (Optional) Report path prefix. Limited to 256 characters. +* `s3_prefix` - (Required) Report path prefix. Limited to 256 characters. May be empty (`""`) but the resource can then not be modified via the AWS Console. * `s3_region` - (Required) Region of the existing S3 bucket to hold generated reports. * `additional_artifacts` - (Required) A list of additional artifacts. Valid values are: `REDSHIFT`, `QUICKSIGHT`, `ATHENA`. When ATHENA exists within additional_artifacts, no other artifact type can be declared and report_versioning must be `OVERWRITE_REPORT`. * `refresh_closed_reports` - (Optional) Set to true to update your reports after they have been finalized if AWS detects charges related to previous months. @@ -89,4 +90,4 @@ Using `terraform import`, import Report Definitions using the `report_name`. For % terraform import aws_cur_report_definition.example_cur_report_definition example-cur-report-definition ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/customer_gateway.html.markdown b/website/docs/cdktf/python/r/customer_gateway.html.markdown index cfa2f1441894..9cd4e18dbabe 100644 --- a/website/docs/cdktf/python/r/customer_gateway.html.markdown +++ b/website/docs/cdktf/python/r/customer_gateway.html.markdown @@ -42,6 +42,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `bgp_asn` - (Optional, Forces new resource) The gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN). Valid values are from `1` to `2147483647`. Conflicts with `bgp_asn_extended`. * `bgp_asn_extended` - (Optional, Forces new resource) The gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN). Valid values are from `2147483648` to `4294967295` Conflicts with `bgp_asn`. * `certificate_arn` - (Optional) The Amazon Resource Name (ARN) for the customer gateway certificate. @@ -84,4 +85,4 @@ Using `terraform import`, import Customer Gateways using the `id`. For example: % terraform import aws_customer_gateway.main cgw-b4dc3961 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/customerprofiles_domain.html.markdown b/website/docs/cdktf/python/r/customerprofiles_domain.html.markdown index 65d98b95cdb9..4128c4d721a7 100644 --- a/website/docs/cdktf/python/r/customerprofiles_domain.html.markdown +++ b/website/docs/cdktf/python/r/customerprofiles_domain.html.markdown @@ -117,6 +117,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `dead_letter_queue_url` - The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications. * `default_encryption_key` - The default encryption key, which is an AWS managed key, is used when no specific type of encryption key is specified. It is used to encrypt all data before it is placed in permanent or semi-permanent storage. * `matching` - A block that specifies the process of matching duplicate profiles. [Documented below](#matching). @@ -242,4 +243,4 @@ Using `terraform import`, import Amazon Customer Profiles Domain using the resou % terraform import aws_customerprofiles_domain.example e6f777be-22d0-4b40-b307-5d2720ef16b2 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/customerprofiles_profile.html.markdown b/website/docs/cdktf/python/r/customerprofiles_profile.html.markdown index 85086003ccf2..83f25d3e5216 100644 --- a/website/docs/cdktf/python/r/customerprofiles_profile.html.markdown +++ b/website/docs/cdktf/python/r/customerprofiles_profile.html.markdown @@ -47,6 +47,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `account_number` - A unique account number that you have given to the customer. * `additional_information` - Any additional information relevant to the customer’s profile. * `address` - A block that specifies a generic address associated with the customer that is not mailing, shipping, or billing. [Documented below](#address). @@ -123,4 +124,4 @@ Using `terraform import`, import Amazon Customer Profiles Profile using the reso % terraform import aws_customerprofiles_profile.example domain-name/5f2f473dfbe841eb8d05cfc2a4c926df ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/dataexchange_data_set.html.markdown b/website/docs/cdktf/python/r/dataexchange_data_set.html.markdown index d78d3c0878b8..1ee941e16ba6 100644 --- a/website/docs/cdktf/python/r/dataexchange_data_set.html.markdown +++ b/website/docs/cdktf/python/r/dataexchange_data_set.html.markdown @@ -37,6 +37,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `asset_type` - (Required) The type of asset that is added to a data set. Valid values include `API_GATEWAY_API`, `LAKE_FORMATION_DATA_PERMISSION`, `REDSHIFT_DATA_SHARE`, `S3_DATA_ACCESS`, `S3_SNAPSHOT`. * `description` - (Required) A description for the data set. * `name` - (Required) The name of the data set. @@ -75,4 +76,4 @@ Using `terraform import`, import DataExchange DataSets using their `id`. For exa % terraform import aws_dataexchange_data_set.example 4fa784c7-ccb4-4dbf-ba4f-02198320daa1 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/dataexchange_event_action.html.markdown b/website/docs/cdktf/python/r/dataexchange_event_action.html.markdown index b5795037af97..9de612dd2709 100644 --- a/website/docs/cdktf/python/r/dataexchange_event_action.html.markdown +++ b/website/docs/cdktf/python/r/dataexchange_event_action.html.markdown @@ -57,6 +57,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `action` - (Required) Describes the action to take. Described in [`action` Configuration Block](#action-configuration-block) below. * `event` - (Required) Describes the event that triggers the `action`. @@ -130,4 +131,4 @@ Using `terraform import`, import Data Exchange Event Action using the id. For ex % terraform import aws_dataexchange_event_action.example example-event-action-id ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/dataexchange_revision.html.markdown b/website/docs/cdktf/python/r/dataexchange_revision.html.markdown index f18e1bdafab5..20867253b425 100644 --- a/website/docs/cdktf/python/r/dataexchange_revision.html.markdown +++ b/website/docs/cdktf/python/r/dataexchange_revision.html.markdown @@ -35,6 +35,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `data_set_id` - (Required) The dataset id. * `comment` - (Required) An optional comment about the revision. * `tags` - (Optional) A 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. @@ -73,4 +74,4 @@ Using `terraform import`, import DataExchange Revisions using their `data-set-id % terraform import aws_dataexchange_revision.example 4fa784c7-ccb4-4dbf-ba4f-02198320daa1:4fa784c7-ccb4-4dbf-ba4f-02198320daa1 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/dataexchange_revision_assets.html.markdown b/website/docs/cdktf/python/r/dataexchange_revision_assets.html.markdown index ecbea09b9165..cc57a8d6ab36 100644 --- a/website/docs/cdktf/python/r/dataexchange_revision_assets.html.markdown +++ b/website/docs/cdktf/python/r/dataexchange_revision_assets.html.markdown @@ -57,6 +57,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `comment` - (Optional) A comment for the revision. Maximum length is 16,348 characters. * `finalize` - (Optional) Finalized a revision. Defaults to `false`. * `force_destoy` - (Optional) Force destroy the revision. Defaults to `false`. @@ -103,4 +104,4 @@ Configuration options: * `create` - (Default 30m) Time to create the revision. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/datapipeline_pipeline.html.markdown b/website/docs/cdktf/python/r/datapipeline_pipeline.html.markdown index 0bcf17d2973c..6126d5bc2f8b 100644 --- a/website/docs/cdktf/python/r/datapipeline_pipeline.html.markdown +++ b/website/docs/cdktf/python/r/datapipeline_pipeline.html.markdown @@ -35,6 +35,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) The name of Pipeline. * `description` - (Optional) The description of Pipeline. * `tags` - (Optional) A 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. @@ -71,4 +72,4 @@ Using `terraform import`, import `aws_datapipeline_pipeline` using the id (Pipel % terraform import aws_datapipeline_pipeline.default df-1234567890 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/datapipeline_pipeline_definition.html.markdown b/website/docs/cdktf/python/r/datapipeline_pipeline_definition.html.markdown index e4fb43d9f0e7..1ff5a0e0b94a 100644 --- a/website/docs/cdktf/python/r/datapipeline_pipeline_definition.html.markdown +++ b/website/docs/cdktf/python/r/datapipeline_pipeline_definition.html.markdown @@ -88,6 +88,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `parameter_object` - (Optional) Configuration block for the parameter objects used in the pipeline definition. See below * `parameter_value` - (Optional) Configuration block for the parameter values used in the pipeline definition. See below @@ -149,4 +150,4 @@ Using `terraform import`, import `aws_datapipeline_pipeline_definition` using th % terraform import aws_datapipeline_pipeline_definition.example df-1234567890 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/datasync_agent.html.markdown b/website/docs/cdktf/python/r/datasync_agent.html.markdown index 055cd4781c3d..569be094c944 100644 --- a/website/docs/cdktf/python/r/datasync_agent.html.markdown +++ b/website/docs/cdktf/python/r/datasync_agent.html.markdown @@ -54,7 +54,7 @@ class MyConvertedCode(TerraformStack): current = DataAwsRegion(self, "current") example = VpcEndpoint(self, "example", security_group_ids=[Token.as_string(aws_security_group_example.id)], - service_name="com.amazonaws.${" + current.name + "}.datasync", + service_name="com.amazonaws.${" + current.region + "}.datasync", subnet_ids=[Token.as_string(aws_subnet_example.id)], vpc_endpoint_type="Interface", vpc_id=Token.as_string(aws_vpc_example.id) @@ -81,6 +81,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) Name of the DataSync Agent. * `activation_key` - (Optional) DataSync Agent activation key during resource creation. Conflicts with `ip_address`. If an `ip_address` is provided instead, Terraform will retrieve the `activation_key` as part of the resource creation. * `ip_address` - (Optional) DataSync Agent IP address to retrieve activation key during resource creation. Conflicts with `activation_key`. DataSync Agent must be accessible on port 80 from where Terraform is running. @@ -129,4 +130,4 @@ Using `terraform import`, import `aws_datasync_agent` using the DataSync Agent A % terraform import aws_datasync_agent.example arn:aws:datasync:us-east-1:123456789012:agent/agent-12345678901234567 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/datasync_location_azure_blob.html.markdown b/website/docs/cdktf/python/r/datasync_location_azure_blob.html.markdown index 687341b299e3..adc5660b9259 100644 --- a/website/docs/cdktf/python/r/datasync_location_azure_blob.html.markdown +++ b/website/docs/cdktf/python/r/datasync_location_azure_blob.html.markdown @@ -42,6 +42,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `access_tier` - (Optional) The access tier that you want your objects or files transferred into. Valid values: `HOT`, `COOL` and `ARCHIVE`. Default: `HOT`. * `agent_arns` - (Required) A list of DataSync Agent ARNs with which this location will be associated. * `authentication_type` - (Required) The authentication method DataSync uses to access your Azure Blob Storage. Valid values: `SAS`. @@ -87,4 +88,4 @@ Using `terraform import`, import `aws_datasync_location_azure_blob` using the Am % terraform import aws_datasync_location_azure_blob.example arn:aws:datasync:us-east-1:123456789012:location/loc-12345678901234567 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/datasync_location_efs.html.markdown b/website/docs/cdktf/python/r/datasync_location_efs.html.markdown index 59bcbb614203..3709eb1dea65 100644 --- a/website/docs/cdktf/python/r/datasync_location_efs.html.markdown +++ b/website/docs/cdktf/python/r/datasync_location_efs.html.markdown @@ -41,6 +41,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `access_point_arn` - (Optional) Specifies the Amazon Resource Name (ARN) of the access point that DataSync uses to access the Amazon EFS file system. * `ec2_config` - (Required) Configuration block containing EC2 configurations for connecting to the EFS File System. * `efs_file_system_arn` - (Required) Amazon Resource Name (ARN) of EFS File System. @@ -89,4 +90,4 @@ Using `terraform import`, import `aws_datasync_location_efs` using the DataSync % terraform import aws_datasync_location_efs.example arn:aws:datasync:us-east-1:123456789012:location/loc-12345678901234567 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/datasync_location_fsx_lustre_file_system.html.markdown b/website/docs/cdktf/python/r/datasync_location_fsx_lustre_file_system.html.markdown index 4519d5882515..94bd41cee6d6 100644 --- a/website/docs/cdktf/python/r/datasync_location_fsx_lustre_file_system.html.markdown +++ b/website/docs/cdktf/python/r/datasync_location_fsx_lustre_file_system.html.markdown @@ -36,6 +36,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `fsx_filesystem_arn` - (Required) The Amazon Resource Name (ARN) for the FSx for Lustre file system. * `security_group_arns` - (Optional) The Amazon Resource Names (ARNs) of the security groups that are to use to configure the FSx for Lustre file system. * `subdirectory` - (Optional) Subdirectory to perform actions as source or destination. @@ -76,4 +77,4 @@ Using `terraform import`, import `aws_datasync_location_fsx_lustre_file_system` % terraform import aws_datasync_location_fsx_lustre_file_system.example arn:aws:datasync:us-west-2:123456789012:location/loc-12345678901234567#arn:aws:fsx:us-west-2:476956259333:file-system/fs-08e04cd442c1bb94a ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/datasync_location_fsx_ontap_file_system.html.markdown b/website/docs/cdktf/python/r/datasync_location_fsx_ontap_file_system.html.markdown index 29ab4e0c5925..bc5c868ce336 100644 --- a/website/docs/cdktf/python/r/datasync_location_fsx_ontap_file_system.html.markdown +++ b/website/docs/cdktf/python/r/datasync_location_fsx_ontap_file_system.html.markdown @@ -54,6 +54,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `subdirectory` - (Optional) Path to the file share in the SVM where you'll copy your data. You can specify a junction path (also known as a mount point), qtree path (for NFS file shares), or share name (for SMB file shares) (e.g. `/vol1`, `/vol1/tree1`, `share1`). * `tags` - (Optional) Key-value pairs of resource tags to assign to the DataSync Location. 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. @@ -114,4 +115,4 @@ Using `terraform import`, import `aws_datasync_location_fsx_ontap_file_system` u % terraform import aws_datasync_location_fsx_ontap_file_system.example arn:aws:datasync:us-west-2:123456789012:location/loc-12345678901234567#arn:aws:fsx:us-west-2:123456789012:storage-virtual-machine/svm-12345678abcdef123 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/datasync_location_fsx_openzfs_file_system.html.markdown b/website/docs/cdktf/python/r/datasync_location_fsx_openzfs_file_system.html.markdown index ef2e7d4a3c02..c4ce5816d212 100644 --- a/website/docs/cdktf/python/r/datasync_location_fsx_openzfs_file_system.html.markdown +++ b/website/docs/cdktf/python/r/datasync_location_fsx_openzfs_file_system.html.markdown @@ -43,6 +43,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `fsx_filesystem_arn` - (Required) The Amazon Resource Name (ARN) for the FSx for OpenZfs file system. * `protocol` - (Required) The type of protocol that DataSync uses to access your file system. See below. * `security_group_arns` - (Optional) The Amazon Resource Names (ARNs) of the security groups that are to use to configure the FSx for openzfs file system. @@ -96,4 +97,4 @@ Using `terraform import`, import `aws_datasync_location_fsx_openzfs_file_system` % terraform import aws_datasync_location_fsx_openzfs_file_system.example arn:aws:datasync:us-west-2:123456789012:location/loc-12345678901234567#arn:aws:fsx:us-west-2:123456789012:file-system/fs-08e04cd442c1bb94a ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/datasync_location_fsx_windows_file_system.html.markdown b/website/docs/cdktf/python/r/datasync_location_fsx_windows_file_system.html.markdown index 0a1fc9e16979..c7e07577c98d 100644 --- a/website/docs/cdktf/python/r/datasync_location_fsx_windows_file_system.html.markdown +++ b/website/docs/cdktf/python/r/datasync_location_fsx_windows_file_system.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `fsx_filesystem_arn` - (Required) The Amazon Resource Name (ARN) for the FSx for Windows file system. * `password` - (Required) The password of the user who has the permissions to access files and folders in the FSx for Windows file system. * `user` - (Required) The user who has the permissions to access files and folders in the FSx for Windows file system. @@ -81,4 +82,4 @@ Using `terraform import`, import `aws_datasync_location_fsx_windows_file_system` % terraform import aws_datasync_location_fsx_windows_file_system.example arn:aws:datasync:us-west-2:123456789012:location/loc-12345678901234567#arn:aws:fsx:us-west-2:476956259333:file-system/fs-08e04cd442c1bb94a ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/datasync_location_hdfs.html.markdown b/website/docs/cdktf/python/r/datasync_location_hdfs.html.markdown index 5f0c53e1cab3..c566f6e24af3 100644 --- a/website/docs/cdktf/python/r/datasync_location_hdfs.html.markdown +++ b/website/docs/cdktf/python/r/datasync_location_hdfs.html.markdown @@ -72,6 +72,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `agent_arns` - (Required) A list of DataSync Agent ARNs with which this location will be associated. * `authentication_type` - (Required) The type of authentication used to determine the identity of the user. Valid values are `SIMPLE` and `KERBEROS`. * `block_size` - (Optional) The size of data blocks to write into the HDFS cluster. The block size must be a multiple of 512 bytes. The default block size is 128 mebibytes (MiB). @@ -130,4 +131,4 @@ Using `terraform import`, import `aws_datasync_location_hdfs` using the Amazon R % terraform import aws_datasync_location_hdfs.example arn:aws:datasync:us-east-1:123456789012:location/loc-12345678901234567 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/datasync_location_nfs.html.markdown b/website/docs/cdktf/python/r/datasync_location_nfs.html.markdown index e0988a3c7e3c..cf59c9102af5 100644 --- a/website/docs/cdktf/python/r/datasync_location_nfs.html.markdown +++ b/website/docs/cdktf/python/r/datasync_location_nfs.html.markdown @@ -41,6 +41,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `mount_options` - (Optional) Configuration block containing mount options used by DataSync to access the NFS Server. * `on_prem_config` - (Required) Configuration block containing information for connecting to the NFS File System. * `server_hostname` - (Required) Specifies the IP address or DNS name of the NFS server. The DataSync Agent(s) use this to mount the NFS server. @@ -92,4 +93,4 @@ Using `terraform import`, import `aws_datasync_location_nfs` using the DataSync % terraform import aws_datasync_location_nfs.example arn:aws:datasync:us-east-1:123456789012:location/loc-12345678901234567 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/datasync_location_object_storage.html.markdown b/website/docs/cdktf/python/r/datasync_location_object_storage.html.markdown index 1ab82e9151ac..5504f1533528 100644 --- a/website/docs/cdktf/python/r/datasync_location_object_storage.html.markdown +++ b/website/docs/cdktf/python/r/datasync_location_object_storage.html.markdown @@ -39,6 +39,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `agent_arns` - (Required) A list of DataSync Agent ARNs with which this location will be associated. * `access_key` - (Optional) The access key is used if credentials are required to access the self-managed object storage server. If your object storage requires a user name and password to authenticate, use `access_key` and `secret_key` to provide the user name and password, respectively. * `bucket_name` - (Required) The bucket on the self-managed object storage server that is used to read data from. @@ -83,4 +84,4 @@ Using `terraform import`, import `aws_datasync_location_object_storage` using th % terraform import aws_datasync_location_object_storage.example arn:aws:datasync:us-east-1:123456789012:location/loc-12345678901234567 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/datasync_location_s3.html.markdown b/website/docs/cdktf/python/r/datasync_location_s3.html.markdown index 6878734c163c..aa0bb97f0427 100644 --- a/website/docs/cdktf/python/r/datasync_location_s3.html.markdown +++ b/website/docs/cdktf/python/r/datasync_location_s3.html.markdown @@ -66,6 +66,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `agent_arns` - (Optional) (Amazon S3 on Outposts only) Amazon Resource Name (ARN) of the DataSync agent on the Outpost. * `s3_bucket_arn` - (Required) Amazon Resource Name (ARN) of the S3 bucket, or the Amazon S3 access point if the S3 bucket is located on an AWS Outposts resource. * `s3_config` - (Required) Configuration block containing information for connecting to S3. @@ -112,4 +113,4 @@ Using `terraform import`, import `aws_datasync_location_s3` using the DataSync T % terraform import aws_datasync_location_s3.example arn:aws:datasync:us-east-1:123456789012:location/loc-12345678901234567 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/datasync_location_smb.html.markdown b/website/docs/cdktf/python/r/datasync_location_smb.html.markdown index 1dac0cce2ae3..3fe44609c8d4 100644 --- a/website/docs/cdktf/python/r/datasync_location_smb.html.markdown +++ b/website/docs/cdktf/python/r/datasync_location_smb.html.markdown @@ -41,6 +41,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `agent_arns` - (Required) A list of DataSync Agent ARNs with which this location will be associated. * `domain` - (Optional) The name of the Windows domain the SMB server belongs to. * `mount_options` - (Optional) Configuration block containing mount options used by DataSync to access the SMB Server. Can be `AUTOMATIC`, `SMB2`, or `SMB3`. @@ -88,4 +89,4 @@ Using `terraform import`, import `aws_datasync_location_smb` using the Amazon Re % terraform import aws_datasync_location_smb.example arn:aws:datasync:us-east-1:123456789012:location/loc-12345678901234567 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/datasync_task.html.markdown b/website/docs/cdktf/python/r/datasync_task.html.markdown index a5837f9473ae..565f69f6b8a3 100644 --- a/website/docs/cdktf/python/r/datasync_task.html.markdown +++ b/website/docs/cdktf/python/r/datasync_task.html.markdown @@ -121,6 +121,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `destination_location_arn` - (Required) Amazon Resource Name (ARN) of destination DataSync Location. * `source_location_arn` - (Required) Amazon Resource Name (ARN) of source DataSync Location. * `cloudwatch_log_group_arn` - (Optional) Amazon Resource Name (ARN) of the CloudWatch Log Group that is used to monitor and log events in the sync task. @@ -239,4 +240,4 @@ Using `terraform import`, import `aws_datasync_task` using the DataSync Task Ama % terraform import aws_datasync_task.example arn:aws:datasync:us-east-1:123456789012:task/task-12345678901234567 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/datazone_asset_type.html.markdown b/website/docs/cdktf/python/r/datazone_asset_type.html.markdown index ec6ee8f7a752..0e28a7642f5f 100644 --- a/website/docs/cdktf/python/r/datazone_asset_type.html.markdown +++ b/website/docs/cdktf/python/r/datazone_asset_type.html.markdown @@ -46,6 +46,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `description` - (Optional) The description of the custom asset type. * `forms_input` - (Optional) The metadata forms that are to be attached to the custom asset type. @@ -88,4 +89,4 @@ Using `terraform import`, import DataZone Asset Type using the `domain_identifie % terraform import aws_datazone_asset_type.example domain-id-12345678,example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/datazone_domain.html.markdown b/website/docs/cdktf/python/r/datazone_domain.html.markdown index 1d9eecbde6dc..c81ca6cea5ed 100644 --- a/website/docs/cdktf/python/r/datazone_domain.html.markdown +++ b/website/docs/cdktf/python/r/datazone_domain.html.markdown @@ -26,6 +26,7 @@ from cdktf import Fn, Token, TerraformStack # from imports.aws.datazone_domain import DatazoneDomain from imports.aws.iam_role import IamRole +from imports.aws.iam_role_policy import IamRolePolicy class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) @@ -48,28 +49,122 @@ class MyConvertedCode(TerraformStack): ], "Version": "2012-10-17" })), - inline_policy=[IamRoleInlinePolicy( - name="domain_execution_policy", - policy=Token.as_string( - Fn.jsonencode({ - "Statement": [{ - "Action": ["datazone:*", "ram:*", "sso:*", "kms:*"], - "Effect": "Allow", - "Resource": "*" - } - ], - "Version": "2012-10-17" - })) - ) - ], name="my_domain_execution_role" ) + aws_iam_role_policy_domain_execution_role = IamRolePolicy(self, "domain_execution_role_1", + policy=Token.as_string( + Fn.jsonencode({ + "Statement": [{ + "Action": ["datazone:*", "ram:*", "sso:*", "kms:*"], + "Effect": "Allow", + "Resource": "*" + } + ], + "Version": "2012-10-17" + })), + role=domain_execution_role.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. + aws_iam_role_policy_domain_execution_role.override_logical_id("domain_execution_role") DatazoneDomain(self, "example", domain_execution_role=domain_execution_role.arn, name="example" ) ``` +### V2 Domain + +```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.data_aws_caller_identity import DataAwsCallerIdentity +from imports.aws.data_aws_iam_policy import DataAwsIamPolicy +from imports.aws.data_aws_iam_policy_document import DataAwsIamPolicyDocument +from imports.aws.datazone_domain import DatazoneDomain +from imports.aws.iam_role import IamRole +from imports.aws.iam_role_policy_attachment import IamRolePolicyAttachment +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + current = DataAwsCallerIdentity(self, "current") + domain_execution_role = DataAwsIamPolicy(self, "domain_execution_role", + name="SageMakerStudioDomainExecutionRolePolicy" + ) + domain_service_role = DataAwsIamPolicy(self, "domain_service_role", + name="SageMakerStudioDomainServiceRolePolicy" + ) + assume_role_domain_execution = DataAwsIamPolicyDocument(self, "assume_role_domain_execution", + statement=[DataAwsIamPolicyDocumentStatement( + actions=["sts:AssumeRole", "sts:TagSession", "sts:SetContext"], + condition=[DataAwsIamPolicyDocumentStatementCondition( + test="StringEquals", + values=[Token.as_string(current.account_id)], + variable="aws:SourceAccount" + ), DataAwsIamPolicyDocumentStatementCondition( + test="ForAllValues:StringLike", + values=["datazone*"], + variable="aws:TagKeys" + ) + ], + principals=[DataAwsIamPolicyDocumentStatementPrincipals( + identifiers=["datazone.amazonaws.com"], + type="Service" + ) + ] + ) + ] + ) + assume_role_domain_service = DataAwsIamPolicyDocument(self, "assume_role_domain_service", + statement=[DataAwsIamPolicyDocumentStatement( + actions=["sts:AssumeRole"], + condition=[DataAwsIamPolicyDocumentStatementCondition( + test="StringEquals", + values=[Token.as_string(current.account_id)], + variable="aws:SourceAccount" + ) + ], + principals=[DataAwsIamPolicyDocumentStatementPrincipals( + identifiers=["datazone.amazonaws.com"], + type="Service" + ) + ] + ) + ] + ) + domain_execution = IamRole(self, "domain_execution", + assume_role_policy=Token.as_string(assume_role_domain_execution.json), + name="example-domain-execution-role" + ) + domain_service = IamRole(self, "domain_service", + assume_role_policy=Token.as_string(assume_role_domain_service.json), + name="example-domain-service-role" + ) + aws_iam_role_policy_attachment_domain_execution = + IamRolePolicyAttachment(self, "domain_execution_7", + policy_arn=Token.as_string(domain_execution_role.arn), + role=domain_execution.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. + aws_iam_role_policy_attachment_domain_execution.override_logical_id("domain_execution") + aws_iam_role_policy_attachment_domain_service = IamRolePolicyAttachment(self, "domain_service_8", + policy_arn=Token.as_string(domain_service_role.arn), + role=domain_service.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. + aws_iam_role_policy_attachment_domain_service.override_logical_id("domain_service") + DatazoneDomain(self, "example", + domain_execution_role=domain_execution.arn, + domain_version="V2", + name="example-domain", + service_role=domain_service.arn + ) +``` + ## Argument Reference The following arguments are required: @@ -79,8 +174,11 @@ The following arguments are required: The following arguments are optional: +* `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). * `description` - (Optional) Description of the Domain. +* `domain_version` - (Optional) Version of the Domain. Valid values are `V1` and `V2`. Defaults to `V1`. * `kms_key_identifier` - (Optional) ARN of the KMS key used to encrypt the Amazon DataZone domain, metadata and reporting data. +* `service_role` - (Optional) ARN of the service role used by DataZone. Required when `domain_version` is set to `V2`. * `single_sign_on` - (Optional) Single sign on options, used to [enable AWS IAM Identity Center](https://docs.aws.amazon.com/datazone/latest/userguide/enable-IAM-identity-center-for-datazone.html) for DataZone. * `skip_deletion_check` - (Optional) Whether to skip the deletion check for the Domain. @@ -125,4 +223,4 @@ Using `terraform import`, import DataZone Domain using the `domain_id`. For exam % terraform import aws_datazone_domain.example domain-id-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/datazone_environment.html.markdown b/website/docs/cdktf/python/r/datazone_environment.html.markdown index 6b84a2e864cd..818666bdd011 100644 --- a/website/docs/cdktf/python/r/datazone_environment.html.markdown +++ b/website/docs/cdktf/python/r/datazone_environment.html.markdown @@ -61,6 +61,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `account_identifier` - (Optional) The ID of the Amazon Web Services account where the environment exists * `account_region` - (Optional) The Amazon Web Services region where the environment exists. * `blueprint_identifier` - (Optional) The blueprint with which the environment is created. @@ -117,4 +118,4 @@ Using `terraform import`, import DataZone Environment using the `domain_idntifie % terraform import aws_datazone_environment.example dzd_d2i7tzk3tnjjf4,5vpywijpwryec0 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/datazone_environment_blueprint_configuration.html.markdown b/website/docs/cdktf/python/r/datazone_environment_blueprint_configuration.html.markdown index 69700053c4ef..eb926c58e94a 100644 --- a/website/docs/cdktf/python/r/datazone_environment_blueprint_configuration.html.markdown +++ b/website/docs/cdktf/python/r/datazone_environment_blueprint_configuration.html.markdown @@ -64,6 +64,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `manage_access_role_arn` - (Optional) ARN of the manage access role with which this blueprint is created. * `provisioning_role_arn` - (Optional) ARN of the provisioning role with which this blueprint is created. * `regional_parameters` - (Optional) Parameters for each region in which the blueprint is enabled @@ -97,4 +98,4 @@ Using `terraform import`, import DataZone Environment Blueprint Configuration us % terraform import aws_datazone_environment_blueprint_configuration.example domain-id-12345/environment-blueprint-id-54321 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/datazone_environment_profile.html.markdown b/website/docs/cdktf/python/r/datazone_environment_profile.html.markdown index d7481f67caba..e7dd6c874612 100644 --- a/website/docs/cdktf/python/r/datazone_environment_profile.html.markdown +++ b/website/docs/cdktf/python/r/datazone_environment_profile.html.markdown @@ -134,6 +134,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `aws_account_id` - (Required) - Id of the AWS account being used. * `aws_account_region` - (Required) - Desired region for environment profile. * `domain_identifier` - (Required) - Domain Identifier for environment profile. @@ -179,4 +180,4 @@ Using `terraform import`, import DataZone Environment Profile using a comma-deli % terraform import aws_datazone_environment_profile.example environment_profile-id-12345678,domain-id-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/datazone_form_type.html.markdown b/website/docs/cdktf/python/r/datazone_form_type.html.markdown index c95372861f68..e99ecde138c7 100644 --- a/website/docs/cdktf/python/r/datazone_form_type.html.markdown +++ b/website/docs/cdktf/python/r/datazone_form_type.html.markdown @@ -112,6 +112,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `description` - (Optional) Description of form type. Must have a length of between 1 and 2048 characters. * `status` - (Optional) Status of form type. Must be "ENABLED" or "DISABLED" If status is set to "ENABLED" terraform cannot delete the resource until it is manually changed in the AWS console. @@ -151,4 +152,4 @@ Using `terraform import`, import DataZone Form Type using a comma separated valu % terraform import aws_datazone_form_type.example domain_identifier,name,revision ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/datazone_glossary.html.markdown b/website/docs/cdktf/python/r/datazone_glossary.html.markdown index 5bca6c5042b1..29c0ac25dc95 100644 --- a/website/docs/cdktf/python/r/datazone_glossary.html.markdown +++ b/website/docs/cdktf/python/r/datazone_glossary.html.markdown @@ -125,6 +125,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `description` - (Optional) Description of the glossary. Must have a length between 0 and 4096. * `status` - (Optional) Status of business glossary. Valid values are DISABLED and ENABLED. @@ -136,7 +137,7 @@ This resource exports the following attributes in addition to the arguments abov ## Import -In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import DataZone Glossary using the `example_id_arg`. For example: +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import DataZone Glossary using a comma-delimited string combining the domain id, glossary id, and the id of the project it's under. For example: ```python # DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -159,4 +160,4 @@ Using `terraform import`, import DataZone Glossary using the import Datazone Glo % terraform import aws_datazone_glossary.example domain-id,glossary-id,owning-project-identifier ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/datazone_glossary_term.html.markdown b/website/docs/cdktf/python/r/datazone_glossary_term.html.markdown index e1b311240a0f..68c4edafcaf1 100644 --- a/website/docs/cdktf/python/r/datazone_glossary_term.html.markdown +++ b/website/docs/cdktf/python/r/datazone_glossary_term.html.markdown @@ -113,6 +113,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `long_description` - (Optional) Long description of entry. * `short_description` - (Optional) Short description of entry. * `status` - (Optional) If glossary term is ENABLED or DISABLED. @@ -159,4 +160,4 @@ Using `terraform import`, import DataZone Glossary Term using a comma-delimited % terraform import aws_datazone_glossary_term.example domain-id,glossary-term-id,glossary-id ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/datazone_project.html.markdown b/website/docs/cdktf/python/r/datazone_project.html.markdown index 652bfe19ad2a..feb13ba9dc09 100644 --- a/website/docs/cdktf/python/r/datazone_project.html.markdown +++ b/website/docs/cdktf/python/r/datazone_project.html.markdown @@ -64,6 +64,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `skip_deletion_check` - (Optional) Optional flag to delete all child entities within the project. * `description` - (Optional) Description of project. * `glossary_terms` - (Optional) List of glossary terms that can be used in the project. The list cannot be empty or include over 20 values. Each value must follow the regex of `[a-zA-Z0-9_-]{1,36}$`. @@ -115,4 +116,4 @@ Using `terraform import`, import DataZone Project using a colon-delimited string % terraform import aws_datazone_project.example domain-1234:project-1234 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/datazone_user_profile.html.markdown b/website/docs/cdktf/python/r/datazone_user_profile.html.markdown index cc146e0d8c82..98058b354c4a 100644 --- a/website/docs/cdktf/python/r/datazone_user_profile.html.markdown +++ b/website/docs/cdktf/python/r/datazone_user_profile.html.markdown @@ -44,6 +44,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `status` - (Optional) The user profile status. * `user_type` - (Optional) The user type. @@ -87,4 +88,4 @@ Using `terraform import`, import DataZone User Profile using the `user_identifie % terraform import aws_datazone_user_profile.example arn:aws:iam::123456789012:user/example,dzd_54nakfrg9k6suo,IAM ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/dax_cluster.html.markdown b/website/docs/cdktf/python/r/dax_cluster.html.markdown index 7e6896b16083..28a607bb5277 100644 --- a/website/docs/cdktf/python/r/dax_cluster.html.markdown +++ b/website/docs/cdktf/python/r/dax_cluster.html.markdown @@ -38,49 +38,37 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: -* `cluster_endpoint_encryption_type` – (Optional) The type of encryption the +* `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). +* `cluster_endpoint_encryption_type` - (Optional) The type of encryption the cluster's endpoint should support. Valid values are: `NONE` and `TLS`. Default value is `NONE`. - -* `cluster_name` – (Required) Group identifier. DAX converts this name to +* `cluster_name` - (Required) Group identifier. DAX converts this name to lowercase - * `iam_role_arn` - (Required) A valid Amazon Resource Name (ARN) that identifies an IAM role. At runtime, DAX will assume this role and use the role's permissions to access DynamoDB on your behalf - -* `node_type` – (Required) The compute and memory capacity of the nodes. See +* `node_type` - (Required) The compute and memory capacity of the nodes. See [Nodes][1] for supported node types - -* `replication_factor` – (Required) The number of nodes in the DAX cluster. A +* `replication_factor` - (Required) The number of nodes in the DAX cluster. A replication factor of 1 will create a single-node cluster, without any read replicas - * `availability_zones` - (Optional) List of Availability Zones in which the nodes will be created - -* `description` – (Optional) Description for the cluster - -* `notification_topic_arn` – (Optional) An Amazon Resource Name (ARN) of an +* `description` - (Optional) Description for the cluster +* `notification_topic_arn` - (Optional) An Amazon Resource Name (ARN) of an SNS topic to send DAX notifications to. Example: `arn:aws:sns:us-east-1:012345678999:my_sns_topic` - -* `parameter_group_name` – (Optional) Name of the parameter group to associate +* `parameter_group_name` - (Optional) Name of the parameter group to associate with this DAX cluster - -* `maintenance_window` – (Optional) Specifies the weekly time range for when +* `maintenance_window` - (Optional) Specifies the weekly time range for when maintenance on the cluster is performed. The format is `ddd:hh24:mi-ddd:hh24:mi` (24H Clock UTC). The minimum maintenance window is a 60 minute period. Example: `sun:05:00-sun:09:00` - -* `security_group_ids` – (Optional) One or more VPC security groups associated +* `security_group_ids` - (Optional) One or more VPC security groups associated with the cluster - * `server_side_encryption` - (Optional) Encrypt at rest options - -* `subnet_group_name` – (Optional) Name of the subnet group to be used for the +* `subnet_group_name` - (Optional) Name of the subnet group to be used for the cluster - * `tags` - (Optional) A 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 `server_side_encryption` object supports the following: @@ -141,4 +129,4 @@ Using `terraform import`, import DAX Clusters using the `cluster_name`. For exam [1]: http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DAX.concepts.cluster.html#DAX.concepts.nodes - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/dax_parameter_group.html.markdown b/website/docs/cdktf/python/r/dax_parameter_group.html.markdown index be1b23d56038..13c40fbef4b4 100644 --- a/website/docs/cdktf/python/r/dax_parameter_group.html.markdown +++ b/website/docs/cdktf/python/r/dax_parameter_group.html.markdown @@ -43,11 +43,10 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: -* `name` – (Required) The name of the parameter group. - +* `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). +* `name` - (Required) The name of the parameter group. * `description` - (Optional, ForceNew) A description of the parameter group. - -* `parameters` – (Optional) The parameters of the parameter group. +* `parameters` - (Optional) The parameters of the parameter group. ## parameters @@ -87,4 +86,4 @@ Using `terraform import`, import DAX Parameter Group using the `name`. For examp % terraform import aws_dax_parameter_group.example my_dax_pg ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/dax_subnet_group.html.markdown b/website/docs/cdktf/python/r/dax_subnet_group.html.markdown index c9269c3fa99d..6988f0bf6e59 100644 --- a/website/docs/cdktf/python/r/dax_subnet_group.html.markdown +++ b/website/docs/cdktf/python/r/dax_subnet_group.html.markdown @@ -36,16 +36,17 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: -* `name` – (Required) The name of the subnet group. +* `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). +* `name` - (Required) The name of the subnet group. * `description` - (Optional) A description of the subnet group. -* `subnet_ids` – (Required) A list of VPC subnet IDs for the subnet group. +* `subnet_ids` - (Required) A list of VPC subnet IDs for the subnet group. ## Attribute Reference This resource exports the following attributes in addition to the arguments above: * `id` - The name of the subnet group. -* `vpc_id` – VPC ID of the subnet group. +* `vpc_id` - VPC ID of the subnet group. ## Import @@ -72,4 +73,4 @@ Using `terraform import`, import DAX Subnet Group using the `name`. For example: % terraform import aws_dax_subnet_group.example my_dax_sg ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/db_cluster_snapshot.html.markdown b/website/docs/cdktf/python/r/db_cluster_snapshot.html.markdown index c9e9555c5d15..a484b4459b58 100644 --- a/website/docs/cdktf/python/r/db_cluster_snapshot.html.markdown +++ b/website/docs/cdktf/python/r/db_cluster_snapshot.html.markdown @@ -36,6 +36,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `db_cluster_identifier` - (Required) The DB Cluster Identifier from which to take the snapshot. * `db_cluster_snapshot_identifier` - (Required) The Identifier for the snapshot. * `shared_accounts` - (Optional) List of AWS Account IDs to share the snapshot with. Use `all` to make the snapshot public. @@ -91,4 +92,4 @@ Using `terraform import`, import `aws_db_cluster_snapshot` using the cluster sna % terraform import aws_db_cluster_snapshot.example my-cluster-snapshot ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/db_event_subscription.html.markdown b/website/docs/cdktf/python/r/db_event_subscription.html.markdown index f386f765d0ec..e1903de9b918 100644 --- a/website/docs/cdktf/python/r/db_event_subscription.html.markdown +++ b/website/docs/cdktf/python/r/db_event_subscription.html.markdown @@ -60,6 +60,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Optional) The name of the DB event subscription. By default generated by Terraform. * `name_prefix` - (Optional) The name of the DB event subscription. Conflicts with `name`. * `sns_topic` - (Required) The SNS topic to send events to. @@ -111,4 +112,4 @@ Using `terraform import`, import DB Event Subscriptions using the `name`. For ex % terraform import aws_db_event_subscription.default rds-event-sub ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/db_instance.html.markdown b/website/docs/cdktf/python/r/db_instance.html.markdown index 1ffdd2ca027e..a4e1a33d5509 100644 --- a/website/docs/cdktf/python/r/db_instance.html.markdown +++ b/website/docs/cdktf/python/r/db_instance.html.markdown @@ -29,7 +29,7 @@ See the AWS Docs on [RDS Instance Maintenance][instance-maintenance] for more in ~> **Note:** All arguments including the username and password will be stored in the raw state as plain-text. [Read more about sensitive data instate](https://www.terraform.io/docs/state/sensitive-data.html). --> **Note:** Write-Only argument `password_wo` is available to use in place of `password`. Write-Only arguments are supported in HashiCorp Terraform 1.11.0 and later. [Learn more](https://developer.hashicorp.com/terraform/language/v1.11.x/resources/ephemeral#write-only-arguments). +-> **Note:** Write-Only argument `password_wo` is available to use in place of `password`. Write-Only arguments are supported in HashiCorp Terraform 1.11.0 and later. [Learn more](https://developer.hashicorp.com/terraform/language/resources/ephemeral#write-only-arguments). > **Hands-on:** Try the [Manage AWS RDS Instances](https://learn.hashicorp.com/tutorials/terraform/aws-rds) tutorial on HashiCorp Learn. @@ -352,6 +352,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `allocated_storage` - (Required unless a `snapshot_identifier` or `replicate_source_db` is provided) The allocated storage in gibibytes. If `max_allocated_storage` is configured, this argument represents the initial storage allocation and differences from the configuration will be ignored automatically when Storage Autoscaling occurs. If `replicate_source_db` is set, the value is ignored during the creation of the instance. * `allow_major_version_upgrade` - (Optional) Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and @@ -381,7 +382,7 @@ Defaults to true. See [Oracle Character Sets Supported in Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.OracleCharacterSets.html) or [Server-Level Collation for Microsoft SQL Server](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.SQLServer.CommonDBATasks.Collation.html) for more information. Cannot be set with `replicate_source_db`, `restore_to_point_in_time`, `s3_import`, or `snapshot_identifier`. -* `copy_tags_to_snapshot` – (Optional, boolean) Copy all Instance `tags` to snapshots. Default is `false`. +* `copy_tags_to_snapshot` - (Optional, boolean) Copy all Instance `tags` to snapshots. Default is `false`. * `custom_iam_instance_profile` - (Optional) The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. * `database_insights_mode` - (Optional) The mode of Database Insights that is enabled for the instance. Valid values: `standard`, `advanced` . * `db_name` - (Optional) The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance. Note that this does not apply for Oracle or SQL Server engines. See the [AWS documentation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/create-db-instance.html) for more details on what applies for those engines. If you are providing an Oracle db name, it needs to be in all upper case. Cannot be specified for a replica. @@ -656,4 +657,4 @@ Using `terraform import`, import DB Instances using the `identifier`. For exampl % terraform import aws_db_instance.default mydb-rds-instance ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/db_instance_automated_backups_replication.html.markdown b/website/docs/cdktf/python/r/db_instance_automated_backups_replication.html.markdown index 6e6a762551b9..b35ddf537c6a 100644 --- a/website/docs/cdktf/python/r/db_instance_automated_backups_replication.html.markdown +++ b/website/docs/cdktf/python/r/db_instance_automated_backups_replication.html.markdown @@ -113,6 +113,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `kms_key_id` - (Optional, Forces new resource) The AWS KMS key identifier for encryption of the replicated automated backups. The KMS key ID is the Amazon Resource Name (ARN) for the KMS encryption key in the destination AWS Region, for example, `arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE`. * `pre_signed_url` - (Optional, Forces new resource) A URL that contains a [Signature Version 4](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) signed request for the [`StartDBInstanceAutomatedBackupsReplication`](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_StartDBInstanceAutomatedBackupsReplication.html) action to be called in the AWS Region of the source DB instance. * `retention_period` - (Optional, Forces new resource) The retention period for the replicated automated backups, defaults to `7`. @@ -156,4 +157,4 @@ Using `terraform import`, import RDS instance automated backups replication usin % terraform import aws_db_instance_automated_backups_replication.default arn:aws:rds:us-east-1:123456789012:auto-backup:ab-faaa2mgdj1vmp4xflr7yhsrmtbtob7ltrzzz2my ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/db_instance_role_association.html.markdown b/website/docs/cdktf/python/r/db_instance_role_association.html.markdown index b2443b2cea7f..3d7caf438efe 100644 --- a/website/docs/cdktf/python/r/db_instance_role_association.html.markdown +++ b/website/docs/cdktf/python/r/db_instance_role_association.html.markdown @@ -46,6 +46,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `db_instance_identifier` - (Required) DB Instance Identifier to associate with the IAM Role. * `feature_name` - (Required) Name of the feature for association. This can be found in the AWS documentation relevant to the integration or a full list is available in the `SupportedFeatureNames` list returned by [AWS CLI rds describe-db-engine-versions](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-engine-versions.html). * `role_arn` - (Required) Amazon Resource Name (ARN) of the IAM Role to associate with the DB Instance. @@ -88,4 +89,4 @@ Using `terraform import`, import `aws_db_instance_role_association` using the DB % terraform import aws_db_instance_role_association.example my-db-instance,arn:aws:iam::123456789012:role/my-role ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/db_option_group.html.markdown b/website/docs/cdktf/python/r/db_option_group.html.markdown index 7e4da681bd47..cba219749d21 100644 --- a/website/docs/cdktf/python/r/db_option_group.html.markdown +++ b/website/docs/cdktf/python/r/db_option_group.html.markdown @@ -71,6 +71,7 @@ More information about this can be found [here](https://docs.aws.amazon.com/Amaz This resource supports the following arguments: +* `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). * `name` - (Optional, Forces new resource) Name of the option group. If omitted, Terraform will assign a random, unique name. Must be lowercase, to match as it is stored in AWS. * `name_prefix` - (Optional, Forces new resource) Creates a unique name beginning with the specified prefix. Conflicts with `name`. Must be lowercase, to match as it is stored in AWS. * `option_group_description` - (Optional) Description of the option group. Defaults to "Managed by Terraform". @@ -137,4 +138,4 @@ Using `terraform import`, import DB option groups using the `name`. For example: % terraform import aws_db_option_group.example mysql-option-group ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/db_parameter_group.html.markdown b/website/docs/cdktf/python/r/db_parameter_group.html.markdown index aa6fefca0f3c..b15de19f07d6 100644 --- a/website/docs/cdktf/python/r/db_parameter_group.html.markdown +++ b/website/docs/cdktf/python/r/db_parameter_group.html.markdown @@ -221,6 +221,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Optional, Forces new resource) The name of the DB parameter group. If omitted, Terraform will assign a random, unique name. * `name_prefix` - (Optional, Forces new resource) Creates a unique name beginning with the specified prefix. Conflicts with `name`. * `family` - (Required, Forces new resource) The family of the DB parameter group. @@ -272,4 +273,4 @@ Using `terraform import`, import DB Parameter groups using the `name`. For examp % terraform import aws_db_parameter_group.rds_pg rds-pg ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/db_proxy.html.markdown b/website/docs/cdktf/python/r/db_proxy.html.markdown index 99838e224138..423d1a16e89e 100644 --- a/website/docs/cdktf/python/r/db_proxy.html.markdown +++ b/website/docs/cdktf/python/r/db_proxy.html.markdown @@ -143,6 +143,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) The identifier for the proxy. This name must be unique for all proxies owned by your AWS account in the specified AWS Region. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens. * `auth` - (Required) Configuration block(s) with authorization mechanisms to connect to the associated instances or clusters. Described below. * `debug_logging` - (Optional) Whether the proxy includes detailed information about SQL statements in its logs. This information helps you to debug issues involving SQL behavior or the performance and scalability of the proxy connections. The debug information includes the text of SQL statements that you submit through the proxy. Thus, only enable this setting when needed for debugging, and only when you have security measures in place to safeguard any sensitive information that appears in the logs. @@ -205,4 +206,4 @@ Using `terraform import`, import DB proxies using the `name`. For example: % terraform import aws_db_proxy.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/db_proxy_default_target_group.html.markdown b/website/docs/cdktf/python/r/db_proxy_default_target_group.html.markdown index 67a68bf8e014..2b85fd030c4a 100644 --- a/website/docs/cdktf/python/r/db_proxy_default_target_group.html.markdown +++ b/website/docs/cdktf/python/r/db_proxy_default_target_group.html.markdown @@ -68,6 +68,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `db_proxy_name` - (Required) Name of the RDS DB Proxy. * `connection_pool_config` - (Optional) The settings that determine the size and behavior of the connection pool for the target group. @@ -119,4 +120,4 @@ Using `terraform import`, import DB proxy default target groups using the `db_pr % terraform import aws_db_proxy_default_target_group.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/db_proxy_endpoint.html.markdown b/website/docs/cdktf/python/r/db_proxy_endpoint.html.markdown index 98c72343c39c..47926b4f6c35 100644 --- a/website/docs/cdktf/python/r/db_proxy_endpoint.html.markdown +++ b/website/docs/cdktf/python/r/db_proxy_endpoint.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `db_proxy_endpoint_name` - (Required) The identifier for the proxy endpoint. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens. * `db_proxy_name` - (Required) The name of the DB proxy associated with the DB proxy endpoint that you create. * `vpc_subnet_ids` - (Required) One or more VPC subnet IDs to associate with the new proxy. @@ -88,4 +89,4 @@ Using `terraform import`, import DB proxy endpoints using the `DB-PROXY-NAME/DB- % terraform import aws_db_proxy_endpoint.example example/example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/db_proxy_target.html.markdown b/website/docs/cdktf/python/r/db_proxy_target.html.markdown index 197e5c608d40..b93dbfe6b553 100644 --- a/website/docs/cdktf/python/r/db_proxy_target.html.markdown +++ b/website/docs/cdktf/python/r/db_proxy_target.html.markdown @@ -74,6 +74,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `db_proxy_name` - (Required, Forces new resource) The name of the DB proxy. * `target_group_name` - (Required, Forces new resource) The name of the target group. * `db_instance_identifier` - (Optional, Forces new resource) DB instance identifier. @@ -145,4 +146,4 @@ Provisioned Clusters: % terraform import aws_db_proxy_target.example example-proxy/default/TRACKED_CLUSTER/example-cluster ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/db_snapshot.html.markdown b/website/docs/cdktf/python/r/db_snapshot.html.markdown index 558f607da6a0..cde92eaf7916 100644 --- a/website/docs/cdktf/python/r/db_snapshot.html.markdown +++ b/website/docs/cdktf/python/r/db_snapshot.html.markdown @@ -49,6 +49,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `db_instance_identifier` - (Required) The DB Instance Identifier from which to take the snapshot. * `db_snapshot_identifier` - (Required) The Identifier for the snapshot. * `shared_accounts` - (Optional) List of AWS Account IDs to share the snapshot with. Use `all` to make the snapshot public. @@ -106,4 +107,4 @@ Using `terraform import`, import `aws_db_snapshot` using the snapshot identifier % terraform import aws_db_snapshot.example my-snapshot ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/db_snapshot_copy.html.markdown b/website/docs/cdktf/python/r/db_snapshot_copy.html.markdown index a349241cf8fc..a65109977928 100644 --- a/website/docs/cdktf/python/r/db_snapshot_copy.html.markdown +++ b/website/docs/cdktf/python/r/db_snapshot_copy.html.markdown @@ -58,6 +58,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `copy_tags` - (Optional) Whether to copy existing tags. Defaults to `false`. * `destination_region` - (Optional) The Destination region to place snapshot copy. * `kms_key_id` - (Optional) KMS key ID. @@ -122,4 +123,4 @@ Using `terraform import`, import `aws_db_snapshot_copy` using the snapshot ident % terraform import aws_db_snapshot_copy.example my-snapshot ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/db_subnet_group.html.markdown b/website/docs/cdktf/python/r/db_subnet_group.html.markdown index b274dd14b96e..f974742a2dcf 100644 --- a/website/docs/cdktf/python/r/db_subnet_group.html.markdown +++ b/website/docs/cdktf/python/r/db_subnet_group.html.markdown @@ -41,6 +41,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Optional, Forces new resource) The name of the DB subnet group. If omitted, Terraform will assign a random, unique name. * `name_prefix` - (Optional, Forces new resource) Creates a unique name beginning with the specified prefix. Conflicts with `name`. * `description` - (Optional) The description of the DB subnet group. Defaults to "Managed by Terraform". @@ -82,4 +83,4 @@ Using `terraform import`, import DB Subnet groups using the `name`. For example: % terraform import aws_db_subnet_group.default production-subnet-group ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/default_network_acl.html.markdown b/website/docs/cdktf/python/r/default_network_acl.html.markdown index bacde57de404..e214fb794556 100644 --- a/website/docs/cdktf/python/r/default_network_acl.html.markdown +++ b/website/docs/cdktf/python/r/default_network_acl.html.markdown @@ -167,6 +167,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `egress` - (Optional) Configuration block for an egress rule. Detailed below. * `ingress` - (Optional) Configuration block for an ingress rule. Detailed below. * `subnet_ids` - (Optional) List of Subnet IDs to apply the ACL to. See the notes above on Managing Subnets in the Default Network ACL @@ -186,6 +187,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `cidr_block` - (Optional) The CIDR block to match. This must be a valid network mask. * `icmp_code` - (Optional) The ICMP type code to be used. Default 0. * `icmp_type` - (Optional) The ICMP type to be used. Default 0. @@ -230,4 +232,4 @@ Using `terraform import`, import Default Network ACLs using the `id`. For exampl % terraform import aws_default_network_acl.sample acl-7aaabd18 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/default_route_table.html.markdown b/website/docs/cdktf/python/r/default_route_table.html.markdown index 57f5f268fc4b..6fdd540df225 100644 --- a/website/docs/cdktf/python/r/default_route_table.html.markdown +++ b/website/docs/cdktf/python/r/default_route_table.html.markdown @@ -79,6 +79,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `propagating_vgws` - (Optional) List of virtual gateways for propagation. * `route` - (Optional) Configuration block of routes. Detailed below. This argument is processed in [attribute-as-blocks mode](https://www.terraform.io/docs/configuration/attr-as-blocks.html). This means that omitting this argument is interpreted as ignoring any existing routes. To remove all managed routes an empty list should be specified. See the example above. * `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. @@ -151,4 +152,4 @@ Using `terraform import`, import Default VPC route tables using the `vpc_id`. Fo [tf-main-route-table-association]: /docs/providers/aws/r/main_route_table_association.html - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/default_security_group.html.markdown b/website/docs/cdktf/python/r/default_security_group.html.markdown index 12d83193f2f6..fd4023459f55 100644 --- a/website/docs/cdktf/python/r/default_security_group.html.markdown +++ b/website/docs/cdktf/python/r/default_security_group.html.markdown @@ -99,6 +99,7 @@ Removing this resource from your configuration will remove it from your statefil The following arguments are optional: +* `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). * `egress` - (Optional, VPC only) Configuration block. Detailed below. * `ingress` - (Optional) Configuration block. Detailed below. * `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. @@ -158,4 +159,4 @@ Using `terraform import`, import Security Groups using the security group `id`. % terraform import aws_default_security_group.default_sg sg-903004f8 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/detective_graph.html.markdown b/website/docs/cdktf/python/r/detective_graph.html.markdown index 476cbc013e62..0cd77e255e34 100644 --- a/website/docs/cdktf/python/r/detective_graph.html.markdown +++ b/website/docs/cdktf/python/r/detective_graph.html.markdown @@ -37,6 +37,7 @@ class MyConvertedCode(TerraformStack): The following arguments are optional: +* `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). * `tags` - (Optional) A map of tags to assign to the instance. 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. ## Attribute Reference @@ -71,4 +72,4 @@ Using `terraform import`, import `aws_detective_graph` using the ARN. For exampl % terraform import aws_detective_graph.example arn:aws:detective:us-east-1:123456789101:graph:231684d34gh74g4bae1dbc7bd807d02d ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/detective_invitation_accepter.html.markdown b/website/docs/cdktf/python/r/detective_invitation_accepter.html.markdown index e1cce64b5f50..c28468557a25 100644 --- a/website/docs/cdktf/python/r/detective_invitation_accepter.html.markdown +++ b/website/docs/cdktf/python/r/detective_invitation_accepter.html.markdown @@ -48,6 +48,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `graph_arn` - (Required) ARN of the behavior graph that the member account is accepting the invitation for. ## Attribute Reference @@ -81,4 +82,4 @@ Using `terraform import`, import `aws_detective_invitation_accepter` using the g % terraform import aws_detective_invitation_accepter.example arn:aws:detective:us-east-1:123456789101:graph:231684d34gh74g4bae1dbc7bd807d02d ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/detective_member.html.markdown b/website/docs/cdktf/python/r/detective_member.html.markdown index 514ba38dae61..a5f34f29b4dc 100644 --- a/website/docs/cdktf/python/r/detective_member.html.markdown +++ b/website/docs/cdktf/python/r/detective_member.html.markdown @@ -43,6 +43,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `account_id` - (Required) AWS account ID for the account. * `email_address` - (Required) Email address for the account. * `graph_arn` - (Required) ARN of the behavior graph to invite the member accounts to contribute their data to. @@ -85,4 +86,4 @@ Using `terraform import`, import `aws_detective_member` using the ARN of the gra % terraform import aws_detective_member.example arn:aws:detective:us-east-1:123456789101:graph:231684d34gh74g4bae1dbc7bd807d02d/123456789012 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/detective_organization_admin_account.html.markdown b/website/docs/cdktf/python/r/detective_organization_admin_account.html.markdown index 307543f5f2e2..bf52d0ba6846 100644 --- a/website/docs/cdktf/python/r/detective_organization_admin_account.html.markdown +++ b/website/docs/cdktf/python/r/detective_organization_admin_account.html.markdown @@ -44,6 +44,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `account_id` - (Required) AWS account identifier to designate as a delegated administrator for Detective. ## Attribute Reference @@ -71,4 +72,4 @@ Using `terraform import`, import `aws_detective_organization_admin_account` usin % terraform import aws_detective_organization_admin_account.example 123456789012 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/detective_organization_configuration.html.markdown b/website/docs/cdktf/python/r/detective_organization_configuration.html.markdown index ab313214c4c6..db649c49f53a 100644 --- a/website/docs/cdktf/python/r/detective_organization_configuration.html.markdown +++ b/website/docs/cdktf/python/r/detective_organization_configuration.html.markdown @@ -45,6 +45,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `auto_enable` - (Required) When this setting is enabled, all new accounts that are created in, or added to, the organization are added as a member accounts of the organization’s Detective delegated administrator and Detective is enabled in that AWS Region. * `graph_arn` - (Required) ARN of the behavior graph. @@ -79,4 +80,4 @@ Using `terraform import`, import `aws_detective_organization_admin_account` usin % terraform import aws_detective_organization_configuration.example arn:aws:detective:us-east-1:123456789012:graph:00b00fd5aecc0ab60a708659477e9617 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/devicefarm_device_pool.html.markdown b/website/docs/cdktf/python/r/devicefarm_device_pool.html.markdown index 7fd353b32730..66be48524cb0 100644 --- a/website/docs/cdktf/python/r/devicefarm_device_pool.html.markdown +++ b/website/docs/cdktf/python/r/devicefarm_device_pool.html.markdown @@ -42,6 +42,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) The name of the Device Pool * `project_arn` - (Required) The ARN of the project for the device pool. * `rule` - (Required) The device pool's rules. See [Rule](#rule). @@ -87,4 +88,4 @@ Using `terraform import`, import DeviceFarm Device Pools using their ARN. For ex % terraform import aws_devicefarm_device_pool.example arn:aws:devicefarm:us-west-2:123456789012:devicepool:4fa784c7-ccb4-4dbf-ba4f-02198320daa1/4fa784c7-ccb4-4dbf-ba4f-02198320daa1 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/devicefarm_instance_profile.html.markdown b/website/docs/cdktf/python/r/devicefarm_instance_profile.html.markdown index 9d718474e407..571a226a32f8 100644 --- a/website/docs/cdktf/python/r/devicefarm_instance_profile.html.markdown +++ b/website/docs/cdktf/python/r/devicefarm_instance_profile.html.markdown @@ -37,6 +37,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `description` - (Optional) The description of the instance profile. * `exclude_app_packages_from_cleanup` - (Optional) An array of strings that specifies the list of app packages that should not be cleaned up from the device after a test run. * `name` - (Required) The name for the instance profile. @@ -76,4 +77,4 @@ Using `terraform import`, import DeviceFarm Instance Profiles using their ARN. F % terraform import aws_devicefarm_instance_profile.example arn:aws:devicefarm:us-west-2:123456789012:instanceprofile:4fa784c7-ccb4-4dbf-ba4f-02198320daa1 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/devicefarm_network_profile.html.markdown b/website/docs/cdktf/python/r/devicefarm_network_profile.html.markdown index b456495d8ede..269f643f7fe3 100644 --- a/website/docs/cdktf/python/r/devicefarm_network_profile.html.markdown +++ b/website/docs/cdktf/python/r/devicefarm_network_profile.html.markdown @@ -44,6 +44,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `description` - (Optional) The description of the network profile. * `downlink_bandwidth_bits` - (Optional) The data throughput rate in bits per second, as an integer from `0` to `104857600`. Default value is `104857600`. * `downlink_delay_ms` - (Optional) Delay time for all packets to destination in milliseconds as an integer from `0` to `2000`. @@ -90,4 +91,4 @@ Using `terraform import`, import DeviceFarm Network Profiles using their ARN. Fo % terraform import aws_devicefarm_network_profile.example arn:aws:devicefarm:us-west-2:123456789012:networkprofile:4fa784c7-ccb4-4dbf-ba4f-02198320daa1 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/devicefarm_project.html.markdown b/website/docs/cdktf/python/r/devicefarm_project.html.markdown index 2fc9bb8a4609..b771b7237e90 100644 --- a/website/docs/cdktf/python/r/devicefarm_project.html.markdown +++ b/website/docs/cdktf/python/r/devicefarm_project.html.markdown @@ -40,6 +40,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) The name of the project * `default_job_timeout_minutes` - (Optional) Sets the execution timeout value (in minutes) for a project. All test runs in this project use the specified execution timeout value unless overridden when scheduling a run. * `tags` - (Optional) A 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. @@ -78,4 +79,4 @@ Using `terraform import`, import DeviceFarm Projects using their ARN. For exampl % terraform import aws_devicefarm_project.example arn:aws:devicefarm:us-west-2:123456789012:project:4fa784c7-ccb4-4dbf-ba4f-02198320daa1 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/devicefarm_test_grid_project.html.markdown b/website/docs/cdktf/python/r/devicefarm_test_grid_project.html.markdown index 35a74043003a..164546a3fbd9 100644 --- a/website/docs/cdktf/python/r/devicefarm_test_grid_project.html.markdown +++ b/website/docs/cdktf/python/r/devicefarm_test_grid_project.html.markdown @@ -43,6 +43,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) The name of the Selenium testing project. * `description` - (Optional) Human-readable description of the project. * `vpc_config` - (Required) The VPC security groups and subnets that are attached to a project. See [VPC Config](#vpc-config) below. @@ -86,4 +87,4 @@ Using `terraform import`, import DeviceFarm Test Grid Projects using their ARN. % terraform import aws_devicefarm_test_grid_project.example arn:aws:devicefarm:us-west-2:123456789012:testgrid-project:4fa784c7-ccb4-4dbf-ba4f-02198320daa1 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/devicefarm_upload.html.markdown b/website/docs/cdktf/python/r/devicefarm_upload.html.markdown index 3c6c03bbd53c..b25f253802c1 100644 --- a/website/docs/cdktf/python/r/devicefarm_upload.html.markdown +++ b/website/docs/cdktf/python/r/devicefarm_upload.html.markdown @@ -45,6 +45,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `content_type` - (Optional) The upload's content type (for example, application/octet-stream). * `name` - (Required) The upload's file name. The name should not contain any forward slashes (/). If you are uploading an iOS app, the file name must end with the .ipa extension. If you are uploading an Android app, the file name must end with the .apk extension. For all others, the file name must end with the .zip file extension. * `project_arn` - (Required) The ARN of the project for the upload. @@ -84,4 +85,4 @@ Using `terraform import`, import DeviceFarm Uploads using their ARN. For example % terraform import aws_devicefarm_upload.example arn:aws:devicefarm:us-west-2:123456789012:upload:4fa784c7-ccb4-4dbf-ba4f-02198320daa1 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/devopsguru_event_sources_config.html.markdown b/website/docs/cdktf/python/r/devopsguru_event_sources_config.html.markdown index 47d31bc6012f..e867097397de 100644 --- a/website/docs/cdktf/python/r/devopsguru_event_sources_config.html.markdown +++ b/website/docs/cdktf/python/r/devopsguru_event_sources_config.html.markdown @@ -44,8 +44,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `event_sources` - (Required) Configuration information about the integration of DevOps Guru as the Consumer via EventBridge with another AWS Service. See [`event_sources`](#event_sources-argument-reference) below. ### `event_sources` Argument Reference @@ -64,7 +65,7 @@ This resource exports the following attributes in addition to the arguments abov ## Import -In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import DevOps Guru Event Sources Config using the `id`. For example: +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import DevOps Guru Event Sources Config using the region. For example: ```python # DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -81,10 +82,10 @@ class MyConvertedCode(TerraformStack): DevopsguruEventSourcesConfig.generate_config_for_import(self, "example", "us-east-1") ``` -Using `terraform import`, import DevOps Guru Event Sources Config using the `id`. For example: +Using `terraform import`, import DevOps Guru Event Sources Config using the region. For example: ```console % terraform import aws_devopsguru_event_sources_config.example us-east-1 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/devopsguru_notification_channel.html.markdown b/website/docs/cdktf/python/r/devopsguru_notification_channel.html.markdown index e76fada9bb02..d06488dc44e1 100644 --- a/website/docs/cdktf/python/r/devopsguru_notification_channel.html.markdown +++ b/website/docs/cdktf/python/r/devopsguru_notification_channel.html.markdown @@ -70,6 +70,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `filters` - (Optional) Filter configurations for the Amazon SNS notification topic. See the [`filters` argument reference](#filters-argument-reference) below. ### `sns` Argument Reference @@ -112,4 +113,4 @@ Using `terraform import`, import DevOps Guru Notification Channel using the `id` % terraform import aws_devopsguru_notification_channel.example id-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/devopsguru_resource_collection.html.markdown b/website/docs/cdktf/python/r/devopsguru_resource_collection.html.markdown index c49551bfcad7..4a1af5094b93 100644 --- a/website/docs/cdktf/python/r/devopsguru_resource_collection.html.markdown +++ b/website/docs/cdktf/python/r/devopsguru_resource_collection.html.markdown @@ -119,6 +119,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `cloudformation` - (Optional) A collection of AWS CloudFormation stacks. See [`cloudformation`](#cloudformation-argument-reference) below for additional details. * `tags` - (Optional) AWS tags used to filter the resources in the resource collection. See [`tags`](#tags-argument-reference) below for additional details. @@ -162,4 +163,4 @@ Using `terraform import`, import DevOps Guru Resource Collection using the `id`. % terraform import aws_devopsguru_resource_collection.example AWS_CLOUD_FORMATION ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/devopsguru_service_integration.html.markdown b/website/docs/cdktf/python/r/devopsguru_service_integration.html.markdown index 7462665ce369..49c733d7992e 100644 --- a/website/docs/cdktf/python/r/devopsguru_service_integration.html.markdown +++ b/website/docs/cdktf/python/r/devopsguru_service_integration.html.markdown @@ -84,8 +84,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `kms_server_side_encryption` - (Required) Information about whether DevOps Guru is configured to encrypt server-side data using KMS. See [`kms_server_side_encryption`](#kms_server_side_encryption-argument-reference) below. * `logs_anomaly_detection` - (Required) Information about whether DevOps Guru is configured to perform log anomaly detection on Amazon CloudWatch log groups. See [`logs_anomaly_detection`](#logs_anomaly_detection-argument-reference) below. * `ops_center` - (Required) Information about whether DevOps Guru is configured to create an OpsItem in AWS Systems Manager OpsCenter for each created insight. See [`ops_center`](#ops_center-argument-reference) below. @@ -112,7 +113,7 @@ This resource exports the following attributes in addition to the arguments abov ## Import -In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import DevOps Guru Service Integration using the `id`. For example: +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import DevOps Guru Service Integration using the region. For example: ```python # DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -129,10 +130,10 @@ class MyConvertedCode(TerraformStack): DevopsguruServiceIntegration.generate_config_for_import(self, "example", "us-east-1") ``` -Using `terraform import`, import DevOps Guru Service Integration using the `id`. For example: +Using `terraform import`, import DevOps Guru Service Integration using the region. For example: ```console % terraform import aws_devopsguru_service_integration.example us-east-1 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/directory_service_conditional_forwarder.html.markdown b/website/docs/cdktf/python/r/directory_service_conditional_forwarder.html.markdown index fb24ffc1e21b..c2c8896ace3c 100644 --- a/website/docs/cdktf/python/r/directory_service_conditional_forwarder.html.markdown +++ b/website/docs/cdktf/python/r/directory_service_conditional_forwarder.html.markdown @@ -37,6 +37,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `directory_id` - (Required) ID of directory. * `dns_ips` - (Required) A list of forwarder IP addresses. * `remote_domain_name` - (Required) The fully qualified domain name of the remote domain for which forwarders will be used. @@ -70,4 +71,4 @@ Using `terraform import`, import conditional forwarders using the directory id a % terraform import aws_directory_service_conditional_forwarder.example d-1234567890:example.com ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/directory_service_directory.html.markdown b/website/docs/cdktf/python/r/directory_service_directory.html.markdown index 26c1cac9bb6d..e53a23c48113 100644 --- a/website/docs/cdktf/python/r/directory_service_directory.html.markdown +++ b/website/docs/cdktf/python/r/directory_service_directory.html.markdown @@ -155,6 +155,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) The fully qualified name for the directory, such as `corp.example.com` * `password` - (Required) The password for the directory administrator or connector user. * `size` - (Optional) (For `SimpleAD` and `ADConnector` types) The size of the directory (`Small` or `Large` are accepted values). `Large` by default. @@ -228,4 +229,4 @@ Using `terraform import`, import DirectoryService directories using the director % terraform import aws_directory_service_directory.sample d-926724cf57 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/directory_service_log_subscription.html.markdown b/website/docs/cdktf/python/r/directory_service_log_subscription.html.markdown index c275cc50a3d3..a803eff9f971 100644 --- a/website/docs/cdktf/python/r/directory_service_log_subscription.html.markdown +++ b/website/docs/cdktf/python/r/directory_service_log_subscription.html.markdown @@ -66,6 +66,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `directory_id` - (Required) ID of directory. * `log_group_name` - (Required) Name of the cloudwatch log group to which the logs should be published. The log group should be already created and the directory service principal should be provided with required permission to create stream and publish logs. Changing this value would delete the current subscription and create a new one. A directory can only have one log subscription at a time. @@ -98,4 +99,4 @@ Using `terraform import`, import Directory Service Log Subscriptions using the d % terraform import aws_directory_service_log_subscription.msad d-1234567890 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/directory_service_radius_settings.html.markdown b/website/docs/cdktf/python/r/directory_service_radius_settings.html.markdown index 7406207930ed..ddbec5fe9f1d 100644 --- a/website/docs/cdktf/python/r/directory_service_radius_settings.html.markdown +++ b/website/docs/cdktf/python/r/directory_service_radius_settings.html.markdown @@ -42,6 +42,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `authentication_protocol` - (Optional) The protocol specified for your RADIUS endpoints. Valid values: `PAP`, `CHAP`, `MS-CHAPv1`, `MS-CHAPv2`. * `directory_id` - (Required) The identifier of the directory for which you want to manager RADIUS settings. * `display_label` - (Required) Display label. @@ -90,4 +91,4 @@ Using `terraform import`, import RADIUS settings using the directory ID. For exa % terraform import aws_directory_service_radius_settings.example d-926724cf57 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/directory_service_region.html.markdown b/website/docs/cdktf/python/r/directory_service_region.html.markdown index ee89a46666bd..52ff7413472b 100644 --- a/website/docs/cdktf/python/r/directory_service_region.html.markdown +++ b/website/docs/cdktf/python/r/directory_service_region.html.markdown @@ -145,6 +145,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `desired_number_of_domain_controllers` - (Optional) The number of domain controllers desired in the replicated directory. Minimum value of `2`. * `directory_id` - (Required) The identifier of the directory to which you want to add Region replication. * `region_name` - (Required) The name of the Region where you want to add domain controllers for replication. @@ -195,4 +196,4 @@ Using `terraform import`, import Replicated Regions using directory ID,Region na % terraform import aws_directory_service_region.example d-9267651497,us-east-2 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/directory_service_shared_directory.html.markdown b/website/docs/cdktf/python/r/directory_service_shared_directory.html.markdown index 6489e179bde3..05be75594d67 100644 --- a/website/docs/cdktf/python/r/directory_service_shared_directory.html.markdown +++ b/website/docs/cdktf/python/r/directory_service_shared_directory.html.markdown @@ -58,6 +58,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `method` - (Optional) Method used when sharing a directory. Valid values are `ORGANIZATIONS` and `HANDSHAKE`. Default is `HANDSHAKE`. * `notes` - (Optional, Sensitive) Message sent by the directory owner to the directory consumer to help the directory consumer administrator determine whether to approve or reject the share invitation. @@ -104,4 +105,4 @@ Using `terraform import`, import Directory Service Shared Directories using the % terraform import aws_directory_service_shared_directory.example d-1234567890/d-9267633ece ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/directory_service_shared_directory_accepter.html.markdown b/website/docs/cdktf/python/r/directory_service_shared_directory_accepter.html.markdown index f71a04a2a84e..b0fde64e2f6d 100644 --- a/website/docs/cdktf/python/r/directory_service_shared_directory_accepter.html.markdown +++ b/website/docs/cdktf/python/r/directory_service_shared_directory_accepter.html.markdown @@ -47,8 +47,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `shared_directory_id` - (Required) Identifier of the directory that is stored in the directory consumer account that corresponds to the shared directory in the owner account. ## Attribute Reference @@ -93,4 +94,4 @@ Using `terraform import`, import Directory Service Shared Directories using the % terraform import aws_directory_service_shared_directory_accepter.example d-9267633ece ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/directory_service_trust.html.markdown b/website/docs/cdktf/python/r/directory_service_trust.html.markdown index 366829645c20..e8aa29be120e 100644 --- a/website/docs/cdktf/python/r/directory_service_trust.html.markdown +++ b/website/docs/cdktf/python/r/directory_service_trust.html.markdown @@ -114,6 +114,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `conditional_forwarder_ip_addrs` - (Optional) Set of IPv4 addresses for the DNS server associated with the remote Directory. Can contain between 1 and 4 values. * `delete_associated_conditional_forwarder` - (Optional) Whether to delete the conditional forwarder when deleting the Trust relationship. @@ -169,4 +170,4 @@ Using `terraform import`, import the Trust relationship using the directory ID a % terraform import aws_directory_service_trust.example d-926724cf57/directory.example.com ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/dlm_lifecycle_policy.html.markdown b/website/docs/cdktf/python/r/dlm_lifecycle_policy.html.markdown index 894080355157..cca8feecf54b 100644 --- a/website/docs/cdktf/python/r/dlm_lifecycle_policy.html.markdown +++ b/website/docs/cdktf/python/r/dlm_lifecycle_policy.html.markdown @@ -96,6 +96,39 @@ class MyConvertedCode(TerraformStack): ) ``` +### Example Default Policy + +```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.dlm_lifecycle_policy import DlmLifecyclePolicy +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + DlmLifecyclePolicy(self, "example", + default_policy="VOLUME", + description="tf-acc-basic", + execution_role_arn=Token.as_string(aws_iam_role_example.arn), + policy_details=DlmLifecyclePolicyPolicyDetails( + create_interval=5, + exclusions=DlmLifecyclePolicyPolicyDetailsExclusions( + exclude_boot_volumes=False, + exclude_tags={ + "test": "exclude" + }, + exclude_volume_types=["gp2"] + ), + policy_language="SIMPLIFIED", + resource_type="VOLUME" + ) + ) +``` + ### Example Cross-Region Snapshot Copy Usage ```python @@ -231,12 +264,66 @@ class MyConvertedCode(TerraformStack): aws_iam_role_policy_attachment_example.override_logical_id("example") ``` +### Example Post/Pre Scripts + +```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.data_aws_iam_policy import DataAwsIamPolicy +from imports.aws.dlm_lifecycle_policy import DlmLifecyclePolicy +from imports.aws.iam_role_policy_attachment import IamRolePolicyAttachment +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + DlmLifecyclePolicy(self, "example", + description="tf-acc-basic", + execution_role_arn=Token.as_string(aws_iam_role_example.arn), + policy_details=DlmLifecyclePolicyPolicyDetails( + resource_types=["INSTANCE"], + schedule=[DlmLifecyclePolicyPolicyDetailsSchedule( + create_rule=DlmLifecyclePolicyPolicyDetailsScheduleCreateRule( + interval=12, + scripts=DlmLifecyclePolicyPolicyDetailsScheduleCreateRuleScripts( + execute_operation_on_script_failure=False, + execution_handler="AWS_VSS_BACKUP", + maximum_retry_count=2 + ) + ), + name="Windows VSS", + retain_rule=DlmLifecyclePolicyPolicyDetailsScheduleRetainRule( + count=10 + ) + ) + ], + target_tags={ + "tag1": "Windows" + } + ) + ) + aws_iam_role_policy_attachment_example = IamRolePolicyAttachment(self, "example_1", + policy_arn=Token.as_string(data_aws_iam_policy_example.arn), + role=test.id + ) + # 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_iam_role_policy_attachment_example.override_logical_id("example") + DataAwsIamPolicy(self, "test", + name="AWSDataLifecycleManagerSSMFullAccess" + ) +``` + ## Argument Reference This resource supports the following arguments: +* `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). * `description` - (Required) A description for the DLM lifecycle policy. * `execution_role_arn` - (Required) The ARN of an IAM role that is able to be assumed by the DLM service. +* `default_policy` - (Required) Specify the type of default policy to create. valid values are `VOLUME` or `INSTANCE`. * `policy_details` - (Required) See the [`policy_details` configuration](#policy-details-arguments) block. Max of 1. * `state` - (Optional) Whether the lifecycle policy should be enabled or disabled. `ENABLED` or `DISABLED` are valid values. Defaults to `ENABLED`. * `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. @@ -244,13 +331,20 @@ This resource supports the following arguments: #### Policy Details arguments * `action` - (Optional) The actions to be performed when the event-based policy is triggered. You can specify only one action per policy. This parameter is required for event-based policies only. If you are creating a snapshot or AMI policy, omit this parameter. See the [`action` configuration](#action-arguments) block. +* `copy_tags` - (Optional, Default policies only) Indicates whether the policy should copy tags from the source resource to the snapshot or AMI. Default value is `false`. +* `create_interval` - (Optional, Default policies only) How often the policy should run and create snapshots or AMIs. valid values range from `1` to `7`. Default value is `1`. +* `exclusions` - (Optional, Default policies only) Specifies exclusion parameters for volumes or instances for which you do not want to create snapshots or AMIs. See the [`exclusions` configuration](#exclusions-arguments) block. +* `extend_deletion` - (Optional, Default policies only) snapshot or AMI retention behavior for the policy if the source volume or instance is deleted, or if the policy enters the error, disabled, or deleted state. Default value is `false`. +* `retain_interval` - (Optional, Default policies only) Specifies how long the policy should retain snapshots or AMIs before deleting them. valid values range from `2` to `14`. Default value is `7`. * `event_source` - (Optional) The event that triggers the event-based policy. This parameter is required for event-based policies only. If you are creating a snapshot or AMI policy, omit this parameter. See the [`event_source` configuration](#event-source-arguments) block. +* `resource_type` - (Optional, Default policies only) Type of default policy to create. Valid values are `VOLUME` and `INSTANCE`. * `resource_types` - (Optional) A list of resource types that should be targeted by the lifecycle policy. Valid values are `VOLUME` and `INSTANCE`. -* `resource_locations` - (Optional) The location of the resources to backup. If the source resources are located in an AWS Region, specify `CLOUD`. If the source resources are located on an Outpost in your account, specify `OUTPOST`. If you specify `OUTPOST`, Amazon Data Lifecycle Manager backs up all resources of the specified type with matching target tags across all of the Outposts in your account. Valid values are `CLOUD` and `OUTPOST`. +* `resource_locations` - (Optional) The location of the resources to backup. If the source resources are located in an AWS Region, specify `CLOUD`. If the source resources are located on an Outpost in your account, specify `OUTPOST`. If the source resources are located in a Local Zone, specify `LOCAL_ZONE`. Valid values are `CLOUD`, `LOCAL_ZONE`, and `OUTPOST`. +* `policy_language` - (Optional) Type of policy to create. `SIMPLIFIED` To create a default policy. `STANDARD` To create a custom policy. * `policy_type` - (Optional) The valid target resource types and actions a policy can manage. Specify `EBS_SNAPSHOT_MANAGEMENT` to create a lifecycle policy that manages the lifecycle of Amazon EBS snapshots. Specify `IMAGE_MANAGEMENT` to create a lifecycle policy that manages the lifecycle of EBS-backed AMIs. Specify `EVENT_BASED_POLICY` to create an event-based policy that performs specific actions when a defined event occurs in your AWS account. Default value is `EBS_SNAPSHOT_MANAGEMENT`. * `parameters` - (Optional) A set of optional parameters for snapshot and AMI lifecycle policies. See the [`parameters` configuration](#parameters-arguments) block. * `schedule` - (Optional) See the [`schedule` configuration](#schedule-arguments) block. -* `target_tags` (Optional) A map of tag keys and their values. Any resources that match the `resource_types` and are tagged with _any_ of these tags will be targeted. +* `target_tags` (Optional) A map of tag keys and their values. Any resources that match the `resource_types` and are tagged with _any_ of these tags will be targeted. Required when `policy_type` is `EBS_SNAPSHOT_MANAGEMENT` or `IMAGE_MANAGEMENT`. Must not be specified when `policy_type` is `EVENT_BASED_POLICY`. ~> Note: You cannot have overlapping lifecycle policies that share the same `target_tags`. Terraform is unable to detect this at plan time but it will fail during apply. @@ -281,6 +375,12 @@ This resource supports the following arguments: * `event_type` - (Required) The type of event. Currently, only `shareSnapshot` events are supported. * `snapshot_owner` - (Required) The IDs of the AWS accounts that can trigger policy by sharing snapshots with your account. The policy only runs if one of the specified AWS accounts shares a snapshot with your account. +#### Exclusions arguments + +* `exclude_boot_volumes` - (Optional) Indicates whether to exclude volumes that are attached to instances as the boot volume. To exclude boot volumes, specify `true`. +* `exclude_tags` - (Optional) Map specifies whether to exclude volumes that have specific tags. +* `exclude_volume_types` - (Optional) List specifies the volume types to exclude. + #### Parameters arguments * `exclude_boot_volume` - (Optional) Indicates whether to exclude the root volume from snapshots created using CreateSnapshots. The default is `false`. @@ -288,6 +388,7 @@ This resource supports the following arguments: #### Schedule arguments +* `archive_rule` - (Optional) Specifies a snapshot archiving rule for a schedule. See [`archive_rule`](#archive-rule-arguments) block. * `copy_tags` - (Optional) Copy all user-defined tags on a source volume to snapshots of the volume created by this policy. * `create_rule` - (Required) See the [`create_rule`](#create-rule-arguments) block. Max of 1 per schedule. * `cross_region_copy_rule` (Optional) - See the [`cross_region_copy_rule`](#cross-region-copy-rule-arguments) block. Max of 3 per schedule. @@ -299,12 +400,21 @@ This resource supports the following arguments: * `tags_to_add` - (Optional) A map of tag keys and their values. DLM lifecycle policies will already tag the snapshot with the tags on the volume. This configuration adds extra tags on top of these. * `variable_tags` - (Optional) A map of tag keys and variable values, where the values are determined when the policy is executed. Only `$(instance-id)` or `$(timestamp)` are valid values. Can only be used when `resource_types` is `INSTANCE`. +#### Archive Rule Arguments + +* `archive_retain_rule` - (Required) Information about the retention period for the snapshot archiving rule. See the [`archive_retain_rule`](#archive-retain-rule-arguments) block. + +#### Archive Retain Rule Arguments + +* `retention_archive_tier` - (Required) Information about retention period in the Amazon EBS Snapshots Archive. See the [`retention_archive_tier`](#retention-archive-tier-arguments) block. + #### Create Rule arguments * `cron_expression` - (Optional) The schedule, as a Cron expression. The schedule interval must be between 1 hour and 1 year. Conflicts with `interval`, `interval_unit`, and `times`. * `interval` - (Optional) How often this lifecycle policy should be evaluated. `1`, `2`,`3`,`4`,`6`,`8`,`12` or `24` are valid values. Conflicts with `cron_expression`. If set, `interval_unit` and `times` must also be set. * `interval_unit` - (Optional) The unit for how often the lifecycle policy should be evaluated. `HOURS` is currently the only allowed value and also the default value. Conflicts with `cron_expression`. Must be set if `interval` is set. * `location` - (Optional) Specifies the destination for snapshots created by the policy. To create snapshots in the same Region as the source resource, specify `CLOUD`. To create snapshots on the same Outpost as the source resource, specify `OUTPOST_LOCAL`. If you omit this parameter, `CLOUD` is used by default. If the policy targets resources in an AWS Region, then you must create snapshots in the same Region as the source resource. If the policy targets resources on an Outpost, then you can create snapshots on the same Outpost as the source resource, or in the Region of that Outpost. Valid values are `CLOUD` and `OUTPOST_LOCAL`. +* `scripts` - (Optional) Specifies pre and/or post scripts for a snapshot lifecycle policy that targets instances. Valid only when `resource_type` is INSTANCE. See the [`scripts` configuration](#scripts-rule-arguments) block. * `times` - (Optional) A list of times in 24 hour clock format that sets when the lifecycle policy should be evaluated. Max of 1. Conflicts with `cron_expression`. Must be set if `interval` is set. #### Deprecate Rule arguments @@ -339,7 +449,8 @@ This resource supports the following arguments: * `deprecate_rule` - (Optional) The AMI deprecation rule for cross-Region AMI copies created by the rule. See the [`deprecate_rule`](#cross-region-copy-rule-deprecate-rule-arguments) block. * `encrypted` - (Required) To encrypt a copy of an unencrypted snapshot if encryption by default is not enabled, enable encryption using this parameter. Copies of encrypted snapshots are encrypted, even if this parameter is false or if encryption by default is not enabled. * `retain_rule` - (Required) The retention rule that indicates how long snapshot copies are to be retained in the destination Region. See the [`retain_rule`](#cross-region-copy-rule-retain-rule-arguments) block. Max of 1 per schedule. -* `target` - (Required) The target Region or the Amazon Resource Name (ARN) of the target Outpost for the snapshot copies. +* `target` - Use only for DLM policies of `policy_type=EBS_SNAPSHOT_MANAGEMENT`. The target Region or the Amazon Resource Name (ARN) of the target Outpost for the snapshot copies. +* `target_region` - Use only for DLM policies of `policy_type=IMAGE_MANAGEMENT`. The target Region or the Amazon Resource Name (ARN) of the target Outpost for the snapshot copies. #### Cross Region Copy Rule Deprecate Rule arguments @@ -351,6 +462,26 @@ This resource supports the following arguments: * `interval` - (Required) The amount of time to retain each snapshot. The maximum is 100 years. This is equivalent to 1200 months, 5200 weeks, or 36500 days. * `interval_unit` - (Required) The unit of time for time-based retention. Valid values: `DAYS`, `WEEKS`, `MONTHS`, or `YEARS`. +#### Scripts Rule arguments + +* `execute_operation_on_script_failure` - (Optional) Indicates whether Amazon Data Lifecycle Manager should default to crash-consistent snapshots if the pre script fails. The default is `true`. + +* `execution_handler` - (Required) The SSM document that includes the pre and/or post scripts to run. In case automating VSS backups, specify `AWS_VSS_BACKUP`. In case automating application-consistent snapshots for SAP HANA workloads, specify `AWSSystemsManagerSAP-CreateDLMSnapshotForSAPHANA`. If you are using a custom SSM document that you own, specify either the name or ARN of the SSM document. + +* `execution_handler_service` - (Optional) Indicates the service used to execute the pre and/or post scripts. If using custom SSM documents or automating application-consistent snapshots of SAP HANA workloads, specify `AWS_SYSTEMS_MANAGER`. In case automating VSS Backups, omit this parameter. The default is `AWS_SYSTEMS_MANAGER`. + +* `execution_timeout` - (Optional) Specifies a timeout period, in seconds, after which Amazon Data Lifecycle Manager fails the script run attempt if it has not completed. In case automating VSS Backups, omit this parameter. The default is `10`. + +* `maximum_retry_count` - (Optional) Specifies the number of times Amazon Data Lifecycle Manager should retry scripts that fail. Must be an integer between `0` and `3`. The default is `0`. + +* `stages` - (Optional) List to indicate which scripts Amazon Data Lifecycle Manager should run on target instances. Pre scripts run before Amazon Data Lifecycle Manager initiates snapshot creation. Post scripts run after Amazon Data Lifecycle Manager initiates snapshot creation. Valid values: `PRE` and `POST`. The default is `PRE` and `POST` + +#### Retention Archive Tier Arguments + +* `count` - (Optional)The maximum number of snapshots to retain in the archive storage tier for each volume. Must be an integer between `1` and `1000`. Conflicts with `interval` and `interval_unit`. +* `interval` - (Optional) Specifies the period of time to retain snapshots in the archive tier. After this period expires, the snapshot is permanently deleted. Conflicts with `count`. If set, `interval_unit` must also be set. +* `interval_unit` - (Optional) The unit of time for time-based retention. Valid values are `DAYS`, `WEEKS`, `MONTHS`, `YEARS`. Conflicts with `count`. Must be set if `interval` is set. + ## Attribute Reference This resource exports the following attributes in addition to the arguments above: @@ -384,4 +515,4 @@ Using `terraform import`, import DLM lifecycle policies using their policy ID. F % terraform import aws_dlm_lifecycle_policy.example policy-abcdef12345678901 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/dms_certificate.html.markdown b/website/docs/cdktf/python/r/dms_certificate.html.markdown index 57870b5896e9..ad83ed9fb06e 100644 --- a/website/docs/cdktf/python/r/dms_certificate.html.markdown +++ b/website/docs/cdktf/python/r/dms_certificate.html.markdown @@ -42,10 +42,8 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `certificate_id` - (Required) The certificate identifier. - - - Must contain from 1 to 255 alphanumeric characters and hyphens. - * `certificate_pem` - (Optional) The contents of the .pem X.509 certificate file for the certificate. Either `certificate_pem` or `certificate_wallet` must be set. * `certificate_wallet` - (Optional) The contents of the Oracle Wallet certificate for use with SSL, provided as a base64-encoded String. Either `certificate_pem` or `certificate_wallet` must be set. * `tags` - (Optional) A 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. @@ -82,4 +80,4 @@ Using `terraform import`, import certificates using the `certificate_id`. For ex % terraform import aws_dms_certificate.test test-dms-certificate-tf ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/dms_endpoint.html.markdown b/website/docs/cdktf/python/r/dms_endpoint.html.markdown index e6a73e73beef..49558849386a 100644 --- a/website/docs/cdktf/python/r/dms_endpoint.html.markdown +++ b/website/docs/cdktf/python/r/dms_endpoint.html.markdown @@ -14,8 +14,6 @@ Provides a DMS (Data Migration Service) endpoint resource. DMS endpoints can be ~> **Note:** All arguments including the password will be stored in the raw state as plain-text. [Read more about sensitive data in state](https://www.terraform.io/docs/state/sensitive-data.html). -~> **Note:** The `s3_settings` argument is deprecated, may not be maintained, and will be removed in a future version. Use the [`aws_dms_s3_endpoint`](/docs/providers/aws/r/dms_s3_endpoint.html) resource instead. - ## Example Usage ```python @@ -51,15 +49,17 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `endpoint_id` - (Required) Database endpoint identifier. Identifiers must contain from 1 to 255 alphanumeric characters or hyphens, begin with a letter, contain only ASCII letters, digits, and hyphens, not end with a hyphen, and not contain two consecutive hyphens. * `endpoint_type` - (Required) Type of endpoint. Valid values are `source`, `target`. * `engine_name` - (Required) Type of engine for the endpoint. Valid values are `aurora`, `aurora-postgresql`, `aurora-serverless`, `aurora-postgresql-serverless`,`azuredb`, `azure-sql-managed-instance`, `babelfish`, `db2`, `db2-zos`, `docdb`, `dynamodb`, `elasticsearch`, `kafka`, `kinesis`, `mariadb`, `mongodb`, `mysql`, `opensearch`, `oracle`, `postgres`, `redshift`,`redshift-serverless`, `s3`, `sqlserver`, `neptune` ,`sybase`. Please note that some of engine names are available only for `target` endpoint type (e.g. `redshift`). -* `kms_key_arn` - (Required when `engine_name` is `mongodb`, cannot be set when `engine_name` is `s3`, optional otherwise) ARN for the KMS key that will be used to encrypt the connection parameters. If you do not specify a value for `kms_key_arn`, then AWS DMS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS region. To encrypt an S3 target with a KMS Key, use the parameter `s3_settings.server_side_encryption_kms_key_id`. When `engine_name` is `redshift`, `kms_key_arn` is the KMS Key for the Redshift target and the parameter `redshift_settings.server_side_encryption_kms_key_id` encrypts the S3 intermediate storage. +* `kms_key_arn` - (Required when `engine_name` is `mongodb`, optional otherwise) ARN for the KMS key that will be used to encrypt the connection parameters. If you do not specify a value for `kms_key_arn`, then AWS DMS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS region. When `engine_name` is `redshift`, `kms_key_arn` is the KMS Key for the Redshift target and the parameter `redshift_settings.server_side_encryption_kms_key_id` encrypts the S3 intermediate storage. The following arguments are optional: +* `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). * `certificate_arn` - (Optional, Default: empty string) ARN for the certificate. * `database_name` - (Optional) Name of the endpoint database. * `elasticsearch_settings` - (Optional) Configuration block for OpenSearch settings. See below. @@ -67,12 +67,12 @@ The following arguments are optional: * `kafka_settings` - (Optional) Configuration block for Kafka settings. See below. * `kinesis_settings` - (Optional) Configuration block for Kinesis settings. See below. * `mongodb_settings` - (Optional) Configuration block for MongoDB settings. See below. +* `oracle_settings` - (Optional) Configuration block for Oracle settings. See below. * `password` - (Optional) Password to be used to login to the endpoint database. * `postgres_settings` - (Optional) Configuration block for Postgres settings. See below. * `pause_replication_tasks` - (Optional) Whether to pause associated running replication tasks, regardless if they are managed by Terraform, prior to modifying the endpoint. Only tasks paused by the resource will be restarted after the modification completes. Default is `false`. * `port` - (Optional) Port used by the endpoint database. * `redshift_settings` - (Optional) Configuration block for Redshift settings. See below. -* `s3_settings` - (Optional) (**Deprecated**, use the [`aws_dms_s3_endpoint`](/docs/providers/aws/r/dms_s3_endpoint.html) resource instead) Configuration block for S3 settings. See below. * `secrets_manager_access_role_arn` - (Optional) ARN of the IAM role that specifies AWS DMS as the trusted entity and has the required permissions to access the value in the Secrets Manager secret referred to by `secrets_manager_arn`. The role must allow the `iam:PassRole` action. ~> **Note:** You can specify one of two sets of values for these permissions. You can specify the values for this setting and `secrets_manager_arn`. Or you can specify clear-text values for `username`, `password` , `server_name`, and `port`. You can't specify both. @@ -144,11 +144,18 @@ The following arguments are optional: * `extract_doc_id` - (Optional) Document ID. Use this setting when `nesting_level` is set to `none`. Default is `false`. * `nesting_level` - (Optional) Specifies either document or table mode. Default is `none`. Valid values are `one` (table mode) and `none` (document mode). +### oracle_settings + +-> Additional information can be found in the [Using Oracle as a Source for AWS DMS documentation](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html). + +* `authentication_method` - (Optional) Authentication mechanism to access the Oracle source endpoint. Default is `password`. Valid values are `password` and `kerberos`. + ### postgres_settings -> Additional information can be found in the [Using PostgreSQL as a Source for AWS DMS documentation](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.PostgreSQL.html). * `after_connect_script` - (Optional) For use with change data capture (CDC) only, this attribute has AWS DMS bypass foreign keys and user triggers to reduce the time it takes to bulk load data. +* `authentication_method` - (Optional) Specifies the authentication method. Valid values: `password`, `iam`. * `babelfish_database_name` - (Optional) The Babelfish for Aurora PostgreSQL database name for the endpoint. * `capture_ddls` - (Optional) To capture DDL events, AWS DMS creates various artifacts in the PostgreSQL database when the task starts. * `database_mode` - (Optional) Specifies the default behavior of the replication's handling of PostgreSQL- compatible endpoints that require some additional configuration, such as Babelfish endpoints. @@ -163,6 +170,7 @@ The following arguments are optional: * `map_long_varchar_as` - Optional When true, DMS migrates LONG values as VARCHAR. * `max_file_size` - (Optional) Specifies the maximum size (in KB) of any .csv file used to transfer data to PostgreSQL. Default is `32,768 KB`. * `plugin_name` - (Optional) Specifies the plugin to use to create a replication slot. Valid values: `pglogical`, `test_decoding`. +* `service_access_role_arn` - (Optional) Specifies the IAM role to use to authenticate the connection. * `slot_name` - (Optional) Sets the name of a previously created logical replication slot for a CDC load of the PostgreSQL source instance. ### redis_settings @@ -187,51 +195,6 @@ The following arguments are optional: * `server_side_encryption_kms_key_id` - (Required when `encryption_mode` is `SSE_KMS`, must not be set otherwise) ARN or Id of KMS Key to use when `encryption_mode` is `SSE_KMS`. * `service_access_role_arn` - (Optional) Amazon Resource Name (ARN) of the IAM Role with permissions to read from or write to the S3 Bucket for intermediate storage. -### s3_settings - -~> **Deprecated:** This argument is deprecated, may not be maintained, and will be removed in a future version. Use the [`aws_dms_s3_endpoint`](/docs/providers/aws/r/dms_s3_endpoint.html) resource instead. - --> Additional information can be found in the [Using Amazon S3 as a Source for AWS Database Migration Service documentation](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.S3.html) and [Using Amazon S3 as a Target for AWS Database Migration Service documentation](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html). - -* `add_column_name` - (Optional) Whether to add column name information to the .csv output file. Default is `false`. -* `bucket_folder` - (Optional) S3 object prefix. -* `bucket_name` - (Optional) S3 bucket name. -* `canned_acl_for_objects` - (Optional) Predefined (canned) access control list for objects created in an S3 bucket. Valid values include `none`, `private`, `public-read`, `public-read-write`, `authenticated-read`, `aws-exec-read`, `bucket-owner-read`, and `bucket-owner-full-control`. Default is `none`. -* `cdc_inserts_and_updates` - (Optional) Whether to write insert and update operations to .csv or .parquet output files. Default is `false`. -* `cdc_inserts_only` - (Optional) Whether to write insert operations to .csv or .parquet output files. Default is `false`. -* `cdc_max_batch_interval` - (Optional) Maximum length of the interval, defined in seconds, after which to output a file to Amazon S3. Default is `60`. -* `cdc_min_file_size` - (Optional) Minimum file size condition as defined in kilobytes to output a file to Amazon S3. Default is `32000`. **NOTE:** Previously, this setting was measured in megabytes but now represents kilobytes. Update configurations accordingly. -* `cdc_path` - (Optional) Folder path of CDC files. For an S3 source, this setting is required if a task captures change data; otherwise, it's optional. If `cdc_path` is set, AWS DMS reads CDC files from this path and replicates the data changes to the target endpoint. Supported in AWS DMS versions 3.4.2 and later. -* `compression_type` - (Optional) Set to compress target files. Default is `NONE`. Valid values are `GZIP` and `NONE`. -* `csv_delimiter` - (Optional) Delimiter used to separate columns in the source files. Default is `,`. -* `csv_no_sup_value` - (Optional) String to use for all columns not included in the supplemental log. -* `csv_null_value` - (Optional) String to as null when writing to the target. -* `csv_row_delimiter` - (Optional) Delimiter used to separate rows in the source files. Default is `\n`. -* `data_format` - (Optional) Output format for the files that AWS DMS uses to create S3 objects. Valid values are `csv` and `parquet`. Default is `csv`. -* `data_page_size` - (Optional) Size of one data page in bytes. Default is `1048576` (1 MiB). -* `date_partition_delimiter` - (Optional) Date separating delimiter to use during folder partitioning. Valid values are `SLASH`, `UNDERSCORE`, `DASH`, and `NONE`. Default is `SLASH`. -* `date_partition_enabled` - (Optional) Partition S3 bucket folders based on transaction commit dates. Default is `false`. -* `date_partition_sequence` - (Optional) Date format to use during folder partitioning. Use this parameter when `date_partition_enabled` is set to true. Valid values are `YYYYMMDD`, `YYYYMMDDHH`, `YYYYMM`, `MMYYYYDD`, and `DDMMYYYY`. Default is `YYYYMMDD`. -* `dict_page_size_limit` - (Optional) Maximum size in bytes of an encoded dictionary page of a column. Default is `1048576` (1 MiB). -* `enable_statistics` - (Optional) Whether to enable statistics for Parquet pages and row groups. Default is `true`. -* `encoding_type` - (Optional) Type of encoding to use. Value values are `rle_dictionary`, `plain`, and `plain_dictionary`. Default is `rle_dictionary`. -* `encryption_mode` - (Optional) Server-side encryption mode that you want to encrypt your .csv or .parquet object files copied to S3. Valid values are `SSE_S3` and `SSE_KMS`. Default is `SSE_S3`. -* `external_table_definition` - (Optional) JSON document that describes how AWS DMS should interpret the data. -* `glue_catalog_generation` - (Optional) Whether to integrate AWS Glue Data Catalog with an Amazon S3 target. See [Using AWS Glue Data Catalog with an Amazon S3 target for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.GlueCatalog) for more information. Default is `false`. -* `ignore_header_rows` - (Optional) When this value is set to `1`, DMS ignores the first row header in a .csv file. Default is `0`. -* `include_op_for_full_load` - (Optional) Whether to enable a full load to write INSERT operations to the .csv output files only to indicate how the rows were added to the source database. Default is `false`. -* `max_file_size` - (Optional) Maximum size (in KB) of any .csv file to be created while migrating to an S3 target during full load. Valid values are from `1` to `1048576`. Default is `1048576` (1 GB). -* `parquet_timestamp_in_millisecond` - (Optional) - Specifies the precision of any TIMESTAMP column values written to an S3 object file in .parquet format. Default is `false`. -* `parquet_version` - (Optional) Version of the .parquet file format. Default is `parquet-1-0`. Valid values are `parquet-1-0` and `parquet-2-0`. -* `preserve_transactions` - (Optional) Whether DMS saves the transaction order for a CDC load on the S3 target specified by `cdc_path`. Default is `false`. -* `rfc_4180` - (Optional) For an S3 source, whether each leading double quotation mark has to be followed by an ending double quotation mark. Default is `true`. -* `row_group_length` - (Optional) Number of rows in a row group. Default is `10000`. -* `server_side_encryption_kms_key_id` - (Required when `encryption_mode` is `SSE_KMS`, must not be set otherwise) ARN or Id of KMS Key to use when `encryption_mode` is `SSE_KMS`. -* `service_access_role_arn` - (Optional) ARN of the IAM Role with permissions to read from or write to the S3 Bucket. -* `timestamp_column_name` - (Optional) Column to add with timestamp information to the endpoint data for an Amazon S3 target. -* `use_csv_no_sup_value` - (Optional) Whether to use `csv_no_sup_value` for columns not included in the supplemental log. -* `use_task_start_time_for_full_load_timestamp` - (Optional) When set to true, uses the task start time as the timestamp column value instead of the time data is written to target. For full load, when set to true, each row of the timestamp column contains the task start time. For CDC loads, each row of the timestamp column contains the transaction commit time. When set to false, the full load timestamp in the timestamp column increments with the time data arrives at the target. Default is `false`. - ## Attribute Reference This resource exports the following attributes in addition to the arguments above: @@ -271,4 +234,4 @@ Using `terraform import`, import endpoints using the `endpoint_id`. For example: % terraform import aws_dms_endpoint.test test-dms-endpoint-tf ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/dms_event_subscription.html.markdown b/website/docs/cdktf/python/r/dms_event_subscription.html.markdown index c7a59ddf0783..0c112a530fee 100644 --- a/website/docs/cdktf/python/r/dms_event_subscription.html.markdown +++ b/website/docs/cdktf/python/r/dms_event_subscription.html.markdown @@ -45,6 +45,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) Name of event subscription. * `enabled` - (Optional, Default: true) Whether the event subscription should be enabled. * `event_categories` - (Optional) List of event categories to listen for, see `DescribeEventCategories` for a canonical list. @@ -93,4 +94,4 @@ Using `terraform import`, import event subscriptions using the `name`. For examp % terraform import aws_dms_event_subscription.test my-awesome-event-subscription ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/dms_replication_config.html.markdown b/website/docs/cdktf/python/r/dms_replication_config.html.markdown index 4cf27b6bf81e..d882b816d636 100644 --- a/website/docs/cdktf/python/r/dms_replication_config.html.markdown +++ b/website/docs/cdktf/python/r/dms_replication_config.html.markdown @@ -49,6 +49,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `compute_config` - (Required) Configuration block for provisioning an DMS Serverless replication. * `start_replication` - (Optional) Whether to run or stop the serverless replication, default is false. * `replication_config_identifier` - (Required) Unique identifier that you want to use to create the config. @@ -119,4 +120,4 @@ Using `terraform import`, import a replication config using the `arn`. For examp % terraform import aws_dms_replication_config.example arn:aws:dms:us-east-1:123456789012:replication-config:UX6OL6MHMMJKFFOXE3H7LLJCMEKBDUG4ZV7DRSI ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/dms_replication_instance.html.markdown b/website/docs/cdktf/python/r/dms_replication_instance.html.markdown index c5b18d17bcef..24471c9ff68d 100644 --- a/website/docs/cdktf/python/r/dms_replication_instance.html.markdown +++ b/website/docs/cdktf/python/r/dms_replication_instance.html.markdown @@ -94,35 +94,34 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `allocated_storage` - (Optional, Default: 50, Min: 5, Max: 6144) The amount of storage (in gigabytes) to be initially allocated for the replication instance. * `allow_major_version_upgrade` - (Optional, Default: false) Indicates that major version upgrades are allowed. * `apply_immediately` - (Optional, Default: false) Indicates whether the changes should be applied immediately or during the next maintenance window. Only used when updating an existing resource. * `auto_minor_version_upgrade` - (Optional, Default: false) Indicates that minor engine upgrades will be applied automatically to the replication instance during the maintenance window. * `availability_zone` - (Optional) The EC2 Availability Zone that the replication instance will be created in. +* `dns_name_servers` - (Optional) A list of custom DNS name servers supported for the replication instance to access your on-premise source or target database. This list overrides the default name servers supported by the replication instance. You can specify a comma-separated list of internet addresses for up to four on-premise DNS name servers. * `engine_version` - (Optional) The engine version number of the replication instance. +* `kerberos_authentication_settings` - (Optional) Configuration block for settings required for Kerberos authentication. See below. * `kms_key_arn` - (Optional) The Amazon Resource Name (ARN) for the KMS key that will be used to encrypt the connection parameters. If you do not specify a value for `kms_key_arn`, then AWS DMS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS region. * `multi_az` - (Optional) Specifies if the replication instance is a multi-az deployment. You cannot set the `availability_zone` parameter if the `multi_az` parameter is set to `true`. * `network_type` - (Optional) The type of IP address protocol used by a replication instance. Valid values: `IPV4`, `DUAL`. * `preferred_maintenance_window` - (Optional) The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). - - - Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. - - Format: `ddd:hh24:mi-ddd:hh24:mi` - - Valid Days: `mon, tue, wed, thu, fri, sat, sun` - - Constraints: Minimum 30-minute window. - * `publicly_accessible` - (Optional, Default: false) Specifies the accessibility options for the replication instance. A value of true represents an instance with a public IP address. A value of false represents an instance with a private IP address. * `replication_instance_class` - (Required) The compute and memory capacity of the replication instance as specified by the replication instance class. See [AWS DMS User Guide](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_ReplicationInstance.Types.html) for available instance sizes and advice on which one to choose. * `replication_instance_id` - (Required) The replication instance identifier. This parameter is stored as a lowercase string. - - - Must contain from 1 to 63 alphanumeric characters or hyphens. - - First character must be a letter. - - Cannot end with a hyphen - - Cannot contain two consecutive hyphens. - * `replication_subnet_group_id` - (Optional) A subnet group to associate with the replication instance. * `tags` - (Optional) A 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. * `vpc_security_group_ids` - (Optional) A list of VPC security group IDs to be used with the replication instance. The VPC security groups must work with the VPC containing the replication instance. +## kerberos_authentication_settings + +-> Additional information can be found in the [Using Kerberos Authentication with AWS Database Migration Service documentation](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.Kerberos.html). + +* `key_cache_secret_iam_arn` - (Required) ARN of the IAM role that grants AWS DMS access to the secret containing key cache file for the Kerberos authentication. +* `key_cache_secret_id` - (Required) Secret ID that stores the key cache file required for Kerberos authentication. +* `krb5_file_contents` - (Required) Contents of krb5 configuration file required for Kerberos authentication. + ## Attribute Reference This resource exports the following attributes in addition to the arguments above: @@ -165,4 +164,4 @@ Using `terraform import`, import replication instances using the `replication_in % terraform import aws_dms_replication_instance.test test-dms-replication-instance-tf ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/dms_replication_subnet_group.html.markdown b/website/docs/cdktf/python/r/dms_replication_subnet_group.html.markdown index 860655e8f341..2861f07a9514 100644 --- a/website/docs/cdktf/python/r/dms_replication_subnet_group.html.markdown +++ b/website/docs/cdktf/python/r/dms_replication_subnet_group.html.markdown @@ -95,6 +95,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `replication_subnet_group_description` - (Required) Description for the subnet group. * `replication_subnet_group_id` - (Required) Name for the replication subnet group. This value is stored as a lowercase string. It must contain no more than 255 alphanumeric characters, periods, spaces, underscores, or hyphens and cannot be `default`. * `subnet_ids` - (Required) List of at least 2 EC2 subnet IDs for the subnet group. The subnets must cover at least 2 availability zones. @@ -140,4 +141,4 @@ Using `terraform import`, import replication subnet groups using the `replicatio % terraform import aws_dms_replication_subnet_group.test test-dms-replication-subnet-group-tf ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/dms_replication_task.html.markdown b/website/docs/cdktf/python/r/dms_replication_task.html.markdown index 6da4a7630543..3253351196e6 100644 --- a/website/docs/cdktf/python/r/dms_replication_task.html.markdown +++ b/website/docs/cdktf/python/r/dms_replication_task.html.markdown @@ -47,6 +47,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `cdc_start_position` - (Optional, Conflicts with `cdc_start_time`) Indicates when you want a change data capture (CDC) operation to start. The value can be a RFC3339 formatted date, a checkpoint, or a LSN/SCN format depending on the source engine. For more information see [Determining a CDC native start point](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Task.CDC.html#CHAP_Task.CDC.StartPoint.Native). * `cdc_start_time` - (Optional, Conflicts with `cdc_start_position`) RFC3339 formatted date string or UNIX timestamp for the start of the Change Data Capture (CDC) operation. * `migration_type` - (Required) Migration type. Can be one of `full-load | cdc | full-load-and-cdc`. @@ -93,4 +94,4 @@ Using `terraform import`, import replication tasks using the `replication_task_i % terraform import aws_dms_replication_task.test test-dms-replication-task-tf ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/dms_s3_endpoint.html.markdown b/website/docs/cdktf/python/r/dms_s3_endpoint.html.markdown index c726d40f9055..eb2646e8950c 100644 --- a/website/docs/cdktf/python/r/dms_s3_endpoint.html.markdown +++ b/website/docs/cdktf/python/r/dms_s3_endpoint.html.markdown @@ -122,6 +122,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `add_column_name` - (Optional) Whether to add column name information to the .csv output file. Default is `false`. * `add_trailing_padding_character` - (Optional) Whether to add padding. Default is `false`. (Ignored for source endpoints.) * `bucket_folder` - (Optional) S3 object prefix. @@ -209,4 +210,4 @@ Using `terraform import`, import endpoints using the `endpoint_id`. For example: % terraform import aws_dms_s3_endpoint.example example-dms-endpoint-tf ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/docdb_cluster.html.markdown b/website/docs/cdktf/python/r/docdb_cluster.html.markdown index 2c3f02c7879f..d70d1a0a25b2 100644 --- a/website/docs/cdktf/python/r/docdb_cluster.html.markdown +++ b/website/docs/cdktf/python/r/docdb_cluster.html.markdown @@ -23,7 +23,7 @@ phase because a modification has not yet taken place. You can use the ~> **Note:** All arguments including the username and password will be stored in the raw state as plain-text. [Read more about sensitive data in state](https://www.terraform.io/docs/state/sensitive-data.html). --> **Note:** Write-Only argument `master_password_wo` is available to use in place of `master_password`. Write-Only arguments are supported in HashiCorp Terraform 1.11.0 and later. [Learn more](https://developer.hashicorp.com/terraform/language/v1.11.x/resources/ephemeral#write-only-arguments). +-> **Note:** Write-Only argument `master_password_wo` is available to use in place of `master_password`. Write-Only arguments are supported in HashiCorp Terraform 1.11.0 and later. [Learn more](https://developer.hashicorp.com/terraform/language/resources/ephemeral#write-only-arguments). ## Example Usage @@ -54,6 +54,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `allow_major_version_upgrade` - (Optional) A value that indicates whether major version upgrades are allowed. Constraints: You must allow major version upgrades when specifying a value for the EngineVersion parameter that is a different major version than the DB cluster's current version. * `apply_immediately` - (Optional) Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is @@ -87,6 +88,7 @@ This resource supports the following arguments: Default: A 30-minute window selected at random from an 8-hour block of time per regionE.g., 04:00-09:00 * `preferred_maintenance_window` - (Optional) The weekly time range during which system maintenance can occur, in (UTC) e.g., wed:04:00-wed:04:30 * `restore_to_point_in_time` - (Optional, Forces new resource) A configuration block for restoring a DB instance to an arbitrary point in time. Requires the `identifier` argument to be set with the name of the new DB instance to be created. See [Restore To Point In Time](#restore-to-point-in-time) below for details. +* `serverless_v2_scaling_configuration` - (Optional) Scaling configuration of an Amazon DocumentDB Serverless cluster. See [Serverless V2 Scaling Configuration](#serverless-v2-scaling-configuration) below for details. * `skip_final_snapshot` - (Optional) Determines whether a final DB snapshot is created before the DB cluster is deleted. If true is specified, no DB snapshot is created. If false is specified, a DB snapshot is created before the DB cluster is deleted, using the value from `final_snapshot_identifier`. Default is `false`. * `snapshot_identifier` - (Optional) Specifies whether or not to create this cluster from a snapshot. You can use either the name or ARN when specifying a DB cluster snapshot, or the ARN when specifying a DB snapshot. Automated snapshots **should not** be used for this attribute, unless from a different cluster. Automated snapshots are deleted as part of cluster destruction when the resource is replaced. * `storage_encrypted` - (Optional) Specifies whether the DB cluster is encrypted. The default is `false`. @@ -107,16 +109,24 @@ The `restore_to_point_in_time` block supports the following arguments: * `source_cluster_identifier` - (Required) The identifier of the source DB cluster from which to restore. Must match the identifier of an existing DB cluster. * `use_latest_restorable_time` - (Optional) A boolean value that indicates whether the DB cluster is restored from the latest backup time. Defaults to `false`. Cannot be specified with `restore_to_time`. +### Serverless V2 Scaling Configuration + +The `serverless_v2_scaling_configuration` block supports the following arguments. +Adding this block (i.e. switching to serverless) or removing it (i.e. switching from serverless) will trigger cluster replacement. + +* `max_capacity` - (Required) Maximum number of Amazon DocumentDB capacity units (DCUs) for an instance in an Amazon DocumentDB Serverless cluster. Valid values are multiples of 0.5 between 1 and 256. +* `min_capacity` - (Required) Minimum number of Amazon DocumentDB capacity units (DCUs) for an instance in an Amazon DocumentDB Serverless cluster. Valid values are multiples of 0.5 between 0.5 and 256. + ## Attribute Reference This resource exports the following attributes in addition to the arguments above: * `arn` - Amazon Resource Name (ARN) of cluster -* `cluster_members` – List of DocumentDB Instances that are a part of this cluster +* `cluster_members` - List of DocumentDB Instances that are a part of this cluster * `cluster_resource_id` - The DocumentDB Cluster Resource ID * `endpoint` - The DNS address of the DocumentDB instance * `hosted_zone_id` - The Route53 Hosted Zone ID of the endpoint -* `id` - The DocumentDB Cluster Identifier +* `id` - (**Deprecated**) Amazon Resource Name (ARN) of cluster * `reader_endpoint` - A read-only endpoint for the DocumentDB cluster, automatically load-balanced across replicas * `tags_all` - A map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). @@ -154,4 +164,4 @@ Using `terraform import`, import DocumentDB Clusters using the `cluster_identifi % terraform import aws_docdb_cluster.docdb_cluster docdb-prod-cluster ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/docdb_cluster_instance.html.markdown b/website/docs/cdktf/python/r/docdb_cluster_instance.html.markdown index a3a43a9caf1b..67093474bc42 100644 --- a/website/docs/cdktf/python/r/docdb_cluster_instance.html.markdown +++ b/website/docs/cdktf/python/r/docdb_cluster_instance.html.markdown @@ -57,13 +57,14 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `apply_immediately` - (Optional) Specifies whether any database modifications are applied immediately, or during the next maintenance window. Default is`false`. * `auto_minor_version_upgrade` - (Optional) This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set (see [docs](https://docs.aws.amazon.com/documentdb/latest/developerguide/API_DBInstance.html)). Default `true`. * `availability_zone` - (Optional, Computed) The EC2 Availability Zone that the DB instance is created in. See [docs](https://docs.aws.amazon.com/documentdb/latest/developerguide/API_CreateDBInstance.html) about the details. * `ca_cert_identifier` - (Optional) The identifier of the certificate authority (CA) certificate for the DB instance. * `cluster_identifier` - (Required) The identifier of the [`aws_docdb_cluster`](/docs/providers/aws/r/docdb_cluster.html) in which to launch this instance. -* `copy_tags_to_snapshot` – (Optional, boolean) Copy all DB instance `tags` to snapshots. Default is `false`. +* `copy_tags_to_snapshot` - (Optional, boolean) Copy all DB instance `tags` to snapshots. Default is `false`. * `enable_performance_insights` - (Optional) A value that indicates whether to enable Performance Insights for the DB Instance. Default `false`. See [docs] (https://docs.aws.amazon.com/documentdb/latest/developerguide/performance-insights.html) about the details. * `engine` - (Optional) The name of the database engine to be used for the DocumentDB instance. Defaults to `docdb`. Valid Values: `docdb`. * `identifier` - (Optional, Forces new resource) The identifier for the DocumentDB instance, if omitted, Terraform will assign a random, unique identifier. @@ -112,7 +113,10 @@ This resource exports the following attributes in addition to the arguments abov * `preferred_backup_window` - The daily time range during which automated backups are created if automated backups are enabled. * `storage_encrypted` - Specifies whether the DB cluster is encrypted. * `tags_all` - A map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). -* `writer` – Boolean indicating if this instance is writable. `False` indicates this instance is a read replica. +* `writer` - Boolean indicating if this instance is writable. `False` indicates this instance is a read replica. + +For more detailed documentation about each argument, refer to +the [AWS official documentation](https://docs.aws.amazon.com/cli/latest/reference/docdb/create-db-instance.html). For more detailed documentation about each argument, refer to the [AWS official documentation](https://docs.aws.amazon.com/cli/latest/reference/docdb/create-db-instance.html). @@ -157,4 +161,4 @@ Using `terraform import`, import DocumentDB Cluster Instances using the `identif % terraform import aws_docdb_cluster_instance.prod_instance_1 aurora-cluster-instance-1 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/docdb_cluster_parameter_group.html.markdown b/website/docs/cdktf/python/r/docdb_cluster_parameter_group.html.markdown index 5fca22c63a12..771f7915c859 100644 --- a/website/docs/cdktf/python/r/docdb_cluster_parameter_group.html.markdown +++ b/website/docs/cdktf/python/r/docdb_cluster_parameter_group.html.markdown @@ -42,6 +42,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Optional, Forces new resource) The name of the DocumentDB cluster parameter group. If omitted, Terraform will assign a random, unique name. * `name_prefix` - (Optional, Forces new resource) Creates a unique name beginning with the specified prefix. Conflicts with `name`. * `family` - (Required, Forces new resource) The family of the DocumentDB cluster parameter group. @@ -90,4 +91,4 @@ Using `terraform import`, import DocumentDB Cluster Parameter Groups using the ` % terraform import aws_docdb_cluster_parameter_group.cluster_pg production-pg-1 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/docdb_cluster_snapshot.html.markdown b/website/docs/cdktf/python/r/docdb_cluster_snapshot.html.markdown index 30da89821622..ab0cd83ff54c 100644 --- a/website/docs/cdktf/python/r/docdb_cluster_snapshot.html.markdown +++ b/website/docs/cdktf/python/r/docdb_cluster_snapshot.html.markdown @@ -36,6 +36,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `db_cluster_identifier` - (Required) The DocumentDB Cluster Identifier from which to take the snapshot. * `db_cluster_snapshot_identifier` - (Required) The Identifier for the snapshot. @@ -85,4 +86,4 @@ Using `terraform import`, import `aws_docdb_cluster_snapshot` using the cluster % terraform import aws_docdb_cluster_snapshot.example my-cluster-snapshot ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/docdb_event_subscription.html.markdown b/website/docs/cdktf/python/r/docdb_event_subscription.html.markdown index 51845f6afccd..8aeb6b0adb55 100644 --- a/website/docs/cdktf/python/r/docdb_event_subscription.html.markdown +++ b/website/docs/cdktf/python/r/docdb_event_subscription.html.markdown @@ -60,6 +60,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Optional) The name of the DocumentDB event subscription. By default generated by Terraform. * `name_prefix` - (Optional) The name of the DocumentDB event subscription. Conflicts with `name`. * `sns_topic` - (Required) The SNS topic to send events to. @@ -111,4 +112,4 @@ Using `terraform import`, import DocumentDB Event Subscriptions using the `name` % terraform import aws_docdb_event_subscription.example event-sub ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/docdb_global_cluster.html.markdown b/website/docs/cdktf/python/r/docdb_global_cluster.html.markdown index 8b276dcb33e1..18023da03c64 100644 --- a/website/docs/cdktf/python/r/docdb_global_cluster.html.markdown +++ b/website/docs/cdktf/python/r/docdb_global_cluster.html.markdown @@ -119,6 +119,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `global_cluster_identifier` - (Required, Forces new resources) The global cluster identifier. * `database_name` - (Optional, Forces new resources) Name for an automatically created database on cluster creation. * `deletion_protection` - (Optional) If the Global Cluster should have deletion protection enabled. The database can't be deleted when this value is set to `true`. The default is `false`. @@ -195,4 +196,4 @@ class MyConvertedCode(TerraformStack): ) ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/docdb_subnet_group.html.markdown b/website/docs/cdktf/python/r/docdb_subnet_group.html.markdown index dcc116e73d46..9f910c1af3c6 100644 --- a/website/docs/cdktf/python/r/docdb_subnet_group.html.markdown +++ b/website/docs/cdktf/python/r/docdb_subnet_group.html.markdown @@ -39,6 +39,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Optional, Forces new resource) The name of the docDB subnet group. If omitted, Terraform will assign a random, unique name. * `name_prefix` - (Optional, Forces new resource) Creates a unique name beginning with the specified prefix. Conflicts with `name`. * `description` - (Optional) The description of the docDB subnet group. Defaults to "Managed by Terraform". @@ -78,4 +79,4 @@ Using `terraform import`, import DocumentDB Subnet groups using the `name`. For % terraform import aws_docdb_subnet_group.default production-subnet-group ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/docdbelastic_cluster.html.markdown b/website/docs/cdktf/python/r/docdbelastic_cluster.html.markdown index aec0097fc971..19bb687f9d7f 100644 --- a/website/docs/cdktf/python/r/docdbelastic_cluster.html.markdown +++ b/website/docs/cdktf/python/r/docdbelastic_cluster.html.markdown @@ -51,6 +51,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `backup_retention_period` - (Optional) The number of days for which automatic snapshots are retained. It should be in between 1 and 35. If not specified, the default value of 1 is set. * `kms_key_id` - (Optional) ARN of a KMS key that is used to encrypt the Elastic DocumentDB cluster. If not specified, the default encryption key that KMS creates for your account is used. * `preferred_backup_window` - (Optional) The daily time range during which automated backups are created if automated backups are enabled, as determined by the `backup_retention_period`. @@ -102,4 +103,4 @@ Using `terraform import`, import DocDB (DocumentDB) Elastic Cluster using the `a % terraform import aws_docdbelastic_cluster.example arn:aws:docdb-elastic:us-east-1:000011112222:cluster/12345678-7abc-def0-1234-56789abcdef ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/drs_replication_configuration_template.html.markdown b/website/docs/cdktf/python/r/drs_replication_configuration_template.html.markdown index aee9673b4244..8cb8c0b0011a 100644 --- a/website/docs/cdktf/python/r/drs_replication_configuration_template.html.markdown +++ b/website/docs/cdktf/python/r/drs_replication_configuration_template.html.markdown @@ -87,6 +87,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `auto_replicate_new_disks` - (Optional) Whether to allow the AWS replication agent to automatically replicate newly added disks. * `tags` - (Optional) Set of tags to be associated with the Replication Configuration Template resource. @@ -141,4 +142,4 @@ Using `terraform import`, import DRS Replication Configuration Template using th % terraform import aws_drs_replication_configuration_template.example templateid ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/dsql_cluster.html.markdown b/website/docs/cdktf/python/r/dsql_cluster.html.markdown index b055945ec35b..4f36ae2ef4e6 100644 --- a/website/docs/cdktf/python/r/dsql_cluster.html.markdown +++ b/website/docs/cdktf/python/r/dsql_cluster.html.markdown @@ -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 DsqlCluster +from imports.aws.dsql_cluster import DsqlCluster class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) @@ -44,6 +44,7 @@ This resource supports the following arguments: * `kms_encryption_key` - (Optional) The ARN of the AWS KMS key that encrypts data in the DSQL Cluster, or `"AWS_OWNED_KMS_KEY"`. * `multi_region_properties` - (Optional) Multi-region properties of the DSQL Cluster. * `witness_region` - (Required) Witness region for the multi-region clusters. Setting this makes this cluster a multi-region cluster. Changing it recreates the resource. +* `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). * `tags` - (Optional) Set of tags to be associated with the AWS DSQL Cluster resource. ## Attribute Reference @@ -80,7 +81,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 DsqlCluster +from imports.aws.dsql_cluster import DsqlCluster class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) @@ -93,4 +94,4 @@ Using `terraform import`, import DSQL Cluster using the `identifier`. For exampl % terraform import aws_dsql_cluster.example abcde1f234ghijklmnop5qr6st ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/dsql_cluster_peering.html.markdown b/website/docs/cdktf/python/r/dsql_cluster_peering.html.markdown index aee594d72660..5eac79ea8003 100644 --- a/website/docs/cdktf/python/r/dsql_cluster_peering.html.markdown +++ b/website/docs/cdktf/python/r/dsql_cluster_peering.html.markdown @@ -19,33 +19,35 @@ Terraform resource for managing an Amazon Aurora DSQL Cluster Peering. ```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, TerraformStack +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. import DsqlCluster, DsqlClusterPeering +from imports.aws.dsql_cluster import DsqlCluster +from imports.aws.dsql_cluster_peering import DsqlClusterPeering class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) example1 = DsqlCluster(self, "example_1", - multi_region_properties=[{ - "witness_region": "us-west-2" - } + multi_region_properties=[DsqlClusterMultiRegionProperties( + witness_region="us-west-2" + ) ] ) example2 = DsqlCluster(self, "example_2", - multi_region_properties=[{ - "witness_region": "us-west-2" - } + multi_region_properties=[DsqlClusterMultiRegionProperties( + witness_region="us-west-2" + ) ], provider=alternate ) aws_dsql_cluster_peering_example1 = DsqlClusterPeering(self, "example_1_2", clusters=[example2.arn], identifier=example1.identifier, - witness_region=Fn.lookup_nested(example1.multi_region_properties, ["0", "witness_region" - ]) + witness_region=Token.as_string( + Fn.lookup_nested(example1.multi_region_properties, ["0", "witness_region" + ])) ) # 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_dsql_cluster_peering_example1.override_logical_id("example_1") @@ -53,8 +55,9 @@ class MyConvertedCode(TerraformStack): clusters=[example1.arn], identifier=example2.identifier, provider=alternate, - witness_region=Fn.lookup_nested(example2.multi_region_properties, ["0", "witness_region" - ]) + witness_region=Token.as_string( + Fn.lookup_nested(example2.multi_region_properties, ["0", "witness_region" + ])) ) # 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_dsql_cluster_peering_example2.override_logical_id("example_2") @@ -66,6 +69,7 @@ This resource supports the following arguments: * `clusters` - (Required) List of DSQL Cluster ARNs to be peered to this cluster. * `identifier` - (Required) DSQL Cluster Identifier. +* `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). * `witness_region` - (Required) Witness region for a multi-region cluster. ## Attribute Reference @@ -90,7 +94,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 DsqlClusterPeering +from imports.aws.dsql_cluster_peering import DsqlClusterPeering class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) @@ -103,4 +107,4 @@ Using `terraform import`, import DSQL Cluster Peering using the `identifier`. Fo % terraform import aws_dsql_cluster_peering.example cluster-id-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/dx_bgp_peer.html.markdown b/website/docs/cdktf/python/r/dx_bgp_peer.html.markdown index c249a3cab0bb..34a58496d818 100644 --- a/website/docs/cdktf/python/r/dx_bgp_peer.html.markdown +++ b/website/docs/cdktf/python/r/dx_bgp_peer.html.markdown @@ -37,6 +37,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `address_family` - (Required) The address family for the BGP peer. `ipv4 ` or `ipv6`. * `bgp_asn` - (Required) The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration. * `virtual_interface_id` - (Required) The ID of the Direct Connect virtual interface on which to create the BGP peer. @@ -62,4 +63,4 @@ This resource exports the following attributes in addition to the arguments abov - `create` - (Default `10m`) - `delete` - (Default `10m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/dx_connection.html.markdown b/website/docs/cdktf/python/r/dx_connection.html.markdown index 4545ea2376d1..7d4abd5b65c6 100644 --- a/website/docs/cdktf/python/r/dx_connection.html.markdown +++ b/website/docs/cdktf/python/r/dx_connection.html.markdown @@ -86,6 +86,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `bandwidth` - (Required) The bandwidth of the connection. Valid values for dedicated connections: 1Gbps, 10Gbps, 100Gbps, and 400Gbps. Valid values for hosted connections: 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, 500Mbps, 1Gbps, 2Gbps, 5Gbps, 10Gbps, and 25Gbps. Case sensitive. Refer to the AWS Direct Connection supported bandwidths for [Dedicated Connections](https://docs.aws.amazon.com/directconnect/latest/UserGuide/dedicated_connection.html) and [Hosted Connections](https://docs.aws.amazon.com/directconnect/latest/UserGuide/hosted_connection.html). * `encryption_mode` - (Optional) The connection MAC Security (MACsec) encryption mode. MAC Security (MACsec) is only available on dedicated connections. Valid values are `no_encrypt`, `should_encrypt`, and `must_encrypt`. * `location` - (Required) The AWS Direct Connect location where the connection is located. See [DescribeLocations](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_DescribeLocations.html) for the list of AWS Direct Connect locations. Use `locationCode`. @@ -139,4 +140,4 @@ Using `terraform import`, import Direct Connect connections using the connection % terraform import aws_dx_connection.test_connection dxcon-ffre0ec3 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/dx_connection_association.html.markdown b/website/docs/cdktf/python/r/dx_connection_association.html.markdown index df05e70f4c6d..e9cb9552e3c3 100644 --- a/website/docs/cdktf/python/r/dx_connection_association.html.markdown +++ b/website/docs/cdktf/python/r/dx_connection_association.html.markdown @@ -52,6 +52,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `connection_id` - (Required) The ID of the connection. * `lag_id` - (Required) The ID of the LAG with which to associate the connection. @@ -59,4 +60,4 @@ This resource supports the following arguments: This resource exports no additional attributes. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/dx_connection_confirmation.html.markdown b/website/docs/cdktf/python/r/dx_connection_confirmation.html.markdown index 6f5b5d6559bd..ed184a8379e7 100644 --- a/website/docs/cdktf/python/r/dx_connection_confirmation.html.markdown +++ b/website/docs/cdktf/python/r/dx_connection_confirmation.html.markdown @@ -35,6 +35,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `connection_id` - (Required) The ID of the hosted connection. ### Removing `aws_dx_connection_confirmation` from your configuration @@ -48,4 +49,4 @@ This resource exports the following attributes in addition to the arguments abov * `id` - The ID of the connection. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/dx_gateway_association.html.markdown b/website/docs/cdktf/python/r/dx_gateway_association.html.markdown index df0c71c7522e..38d6ad68b8fc 100644 --- a/website/docs/cdktf/python/r/dx_gateway_association.html.markdown +++ b/website/docs/cdktf/python/r/dx_gateway_association.html.markdown @@ -135,6 +135,7 @@ A full example of how to create a VPN Gateway in one AWS account, create a Direc This resource supports the following arguments: +* `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). * `dx_gateway_id` - (Required) The ID of the Direct Connect gateway. * `associated_gateway_id` - (Optional) The ID of the VGW or transit gateway with which to associate the Direct Connect gateway. Used for single account Direct Connect gateway associations. @@ -152,10 +153,10 @@ Used for cross-account Direct Connect gateway associations. This resource exports the following attributes in addition to the arguments above: -* `id` - The ID of the Direct Connect gateway association resource. * `associated_gateway_type` - The type of the associated gateway, `transitGateway` or `virtualPrivateGateway`. * `dx_gateway_association_id` - The ID of the Direct Connect gateway association. * `dx_gateway_owner_account_id` - The ID of the AWS account that owns the Direct Connect gateway. +* `transit_gateway_attachment_id` - The ID of the Transit Gateway Attachment when the type is `transitGateway`. ## Timeouts @@ -190,4 +191,4 @@ Using `terraform import`, import Direct Connect gateway associations using `dx_g % terraform import aws_dx_gateway_association.example 345508c3-7215-4aef-9832-07c125d5bd0f/vgw-98765432 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/dx_gateway_association_proposal.html.markdown b/website/docs/cdktf/python/r/dx_gateway_association_proposal.html.markdown index c2fab6988064..627f669142e0 100644 --- a/website/docs/cdktf/python/r/dx_gateway_association_proposal.html.markdown +++ b/website/docs/cdktf/python/r/dx_gateway_association_proposal.html.markdown @@ -39,6 +39,7 @@ A full example of how to create a VPN Gateway in one AWS account, create a Direc This resource supports the following arguments: +* `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). * `associated_gateway_id` - (Required) The ID of the VGW or transit gateway with which to associate the Direct Connect gateway. * `dx_gateway_id` - (Required) Direct Connect Gateway identifier. * `dx_gateway_owner_account_id` - (Required) AWS Account identifier of the Direct Connect Gateway's owner. @@ -107,4 +108,4 @@ Using a proposal ID, Direct Connect Gateway ID and associated gateway ID separat The latter case is useful when a previous proposal has been accepted and deleted by AWS. The `aws_dx_gateway_association_proposal` resource will then represent a pseudo-proposal for the same Direct Connect Gateway and associated gateway. If no previous proposal is available, use a tool like [`uuidgen`](http://manpages.ubuntu.com/manpages/bionic/man1/uuidgen.1.html) to generate a new random pseudo-proposal ID. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/dx_hosted_connection.html.markdown b/website/docs/cdktf/python/r/dx_hosted_connection.html.markdown index 9a652be05cd4..347087c8df73 100644 --- a/website/docs/cdktf/python/r/dx_hosted_connection.html.markdown +++ b/website/docs/cdktf/python/r/dx_hosted_connection.html.markdown @@ -49,16 +49,17 @@ This resource supports the following arguments: This resource exports the following attributes in addition to the arguments above: -* `id` - The ID of the connection. -* `jumbo_frame_capable` - Boolean value representing if jumbo frames have been enabled for this connection. -* `has_logical_redundancy` - Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6). * `aws_device` - The Direct Connect endpoint on which the physical connection terminates. -* `state` - The state of the connection. Possible values include: ordering, requested, pending, available, down, deleting, deleted, rejected, unknown. See [AllocateHostedConnection](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_AllocateHostedConnection.html) for a description of each connection state. +* `connection_region` - The AWS Region where the connection is located. +* `has_logical_redundancy` - Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6). +* `id` - The ID of the hosted connection. +* `jumbo_frame_capable` - Boolean value representing if jumbo frames have been enabled for this connection. * `lag_id` - The ID of the LAG. * `loa_issue_time` - The time of the most recent call to [DescribeLoa](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_DescribeLoa.html) for this connection. * `location` - The location of the connection. * `partner_name` - The name of the AWS Direct Connect service provider associated with the connection. * `provider_name` - The name of the service provider associated with the connection. -* `region` - The AWS Region where the connection is located. +* `region` - (**Deprecated**) The AWS Region where the connection is located. Use `connection_region` instead. +* `state` - The state of the connection. Possible values include: ordering, requested, pending, available, down, deleting, deleted, rejected, unknown. See [AllocateHostedConnection](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_AllocateHostedConnection.html) for a description of each connection state. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/dx_hosted_private_virtual_interface.html.markdown b/website/docs/cdktf/python/r/dx_hosted_private_virtual_interface.html.markdown index 6264585db080..7d41c9abe98d 100644 --- a/website/docs/cdktf/python/r/dx_hosted_private_virtual_interface.html.markdown +++ b/website/docs/cdktf/python/r/dx_hosted_private_virtual_interface.html.markdown @@ -41,6 +41,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `address_family` - (Required) The address family for the BGP peer. `ipv4 ` or `ipv6`. * `bgp_asn` - (Required) The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration. * `connection_id` - (Required) The ID of the Direct Connect connection (or LAG) on which to create the virtual interface. @@ -94,4 +95,4 @@ Using `terraform import`, import Direct Connect hosted private virtual interface % terraform import aws_dx_hosted_private_virtual_interface.test dxvif-33cc44dd ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/dx_hosted_private_virtual_interface_accepter.html.markdown b/website/docs/cdktf/python/r/dx_hosted_private_virtual_interface_accepter.html.markdown index 86585c91e9fe..1ca2755af201 100644 --- a/website/docs/cdktf/python/r/dx_hosted_private_virtual_interface_accepter.html.markdown +++ b/website/docs/cdktf/python/r/dx_hosted_private_virtual_interface_accepter.html.markdown @@ -67,6 +67,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `virtual_interface_id` - (Required) The ID of the Direct Connect virtual interface to accept. * `dx_gateway_id` - (Optional) The ID of the Direct Connect gateway to which to connect the virtual interface. * `tags` - (Optional) A 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. @@ -120,4 +121,4 @@ Using `terraform import`, import Direct Connect hosted private virtual interface % terraform import aws_dx_hosted_private_virtual_interface_accepter.test dxvif-33cc44dd ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/dx_hosted_public_virtual_interface.html.markdown b/website/docs/cdktf/python/r/dx_hosted_public_virtual_interface.html.markdown index 3a05d67da817..5b17d4b8a34b 100644 --- a/website/docs/cdktf/python/r/dx_hosted_public_virtual_interface.html.markdown +++ b/website/docs/cdktf/python/r/dx_hosted_public_virtual_interface.html.markdown @@ -44,6 +44,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `address_family` - (Required) The address family for the BGP peer. `ipv4 ` or `ipv6`. * `bgp_asn` - (Required) The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration. * `connection_id` - (Required) The ID of the Direct Connect connection (or LAG) on which to create the virtual interface. @@ -95,4 +96,4 @@ Using `terraform import`, import Direct Connect hosted public virtual interfaces % terraform import aws_dx_hosted_public_virtual_interface.test dxvif-33cc44dd ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/dx_hosted_public_virtual_interface_accepter.html.markdown b/website/docs/cdktf/python/r/dx_hosted_public_virtual_interface_accepter.html.markdown index 0053f598bcd1..0c52f7ab5d7d 100644 --- a/website/docs/cdktf/python/r/dx_hosted_public_virtual_interface_accepter.html.markdown +++ b/website/docs/cdktf/python/r/dx_hosted_public_virtual_interface_accepter.html.markdown @@ -64,6 +64,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `virtual_interface_id` - (Required) The ID of the Direct Connect virtual interface to accept. * `tags` - (Optional) A 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. @@ -115,4 +116,4 @@ Using `terraform import`, import Direct Connect hosted public virtual interfaces % terraform import aws_dx_hosted_public_virtual_interface_accepter.test dxvif-33cc44dd ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/dx_hosted_transit_virtual_interface.html.markdown b/website/docs/cdktf/python/r/dx_hosted_transit_virtual_interface.html.markdown index 44130df93f39..39f1bc3375e6 100644 --- a/website/docs/cdktf/python/r/dx_hosted_transit_virtual_interface.html.markdown +++ b/website/docs/cdktf/python/r/dx_hosted_transit_virtual_interface.html.markdown @@ -42,6 +42,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `address_family` - (Required) The address family for the BGP peer. `ipv4 ` or `ipv6`. * `bgp_asn` - (Required) The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration. * `connection_id` - (Required) The ID of the Direct Connect connection (or LAG) on which to create the virtual interface. @@ -95,4 +96,4 @@ Using `terraform import`, import Direct Connect hosted transit virtual interface % terraform import aws_dx_hosted_transit_virtual_interface.test dxvif-33cc44dd ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/dx_hosted_transit_virtual_interface_accepter.html.markdown b/website/docs/cdktf/python/r/dx_hosted_transit_virtual_interface_accepter.html.markdown index 1e8c08166c4d..274de8a5aa25 100644 --- a/website/docs/cdktf/python/r/dx_hosted_transit_virtual_interface_accepter.html.markdown +++ b/website/docs/cdktf/python/r/dx_hosted_transit_virtual_interface_accepter.html.markdown @@ -71,6 +71,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `dx_gateway_id` - (Required) The ID of the [Direct Connect gateway](dx_gateway.html) to which to connect the virtual interface. * `virtual_interface_id` - (Required) The ID of the Direct Connect virtual interface to accept. * `tags` - (Optional) A 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. @@ -115,4 +116,4 @@ Using `terraform import`, import Direct Connect hosted transit virtual interface % terraform import aws_dx_hosted_transit_virtual_interface_accepter.test dxvif-33cc44dd ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/dx_lag.html.markdown b/website/docs/cdktf/python/r/dx_lag.html.markdown index c1fa3d7eeb16..e574b6b4f3ce 100644 --- a/website/docs/cdktf/python/r/dx_lag.html.markdown +++ b/website/docs/cdktf/python/r/dx_lag.html.markdown @@ -40,6 +40,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) The name of the LAG. * `connections_bandwidth` - (Required) The bandwidth of the individual dedicated connections bundled by the LAG. Valid values: 1Gbps, 10Gbps, 100Gbps, and 400Gbps. Case sensitive. Refer to the AWS Direct Connection supported bandwidths for [Dedicated Connections](https://docs.aws.amazon.com/directconnect/latest/UserGuide/dedicated_connection.html). * `location` - (Required) The AWS Direct Connect location in which the LAG should be allocated. See [DescribeLocations](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_DescribeLocations.html) for the list of AWS Direct Connect locations. Use `locationCode`. @@ -84,4 +85,4 @@ Using `terraform import`, import Direct Connect LAGs using the LAG `id`. For exa % terraform import aws_dx_lag.test_lag dxlag-fgnsp5rq ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/dx_macsec_key_association.html.markdown b/website/docs/cdktf/python/r/dx_macsec_key_association.html.markdown index dedbaa3b099d..0aafe9d0c478 100644 --- a/website/docs/cdktf/python/r/dx_macsec_key_association.html.markdown +++ b/website/docs/cdktf/python/r/dx_macsec_key_association.html.markdown @@ -80,6 +80,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `cak` - (Optional) The MAC Security (MACsec) CAK to associate with the dedicated connection. The valid values are 64 hexadecimal characters (0-9, A-E). Required if using `ckn`. * `ckn` - (Optional) The MAC Security (MACsec) CKN to associate with the dedicated connection. The valid values are 64 hexadecimal characters (0-9, A-E). Required if using `cak`. * `connection_id` - (Required) The ID of the dedicated Direct Connect connection. The connection must be a dedicated connection in the `AVAILABLE` state. @@ -95,4 +96,4 @@ This resource exports the following attributes in addition to the arguments abov * `start_on` - The date in UTC format that the MAC Security (MACsec) secret key takes effect. * `state` - The state of the MAC Security (MACsec) secret key. The possible values are: associating, associated, disassociating, disassociated. See [MacSecKey](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_MacSecKey.html#DX-Type-MacSecKey-state) for descriptions of each state. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/dx_private_virtual_interface.html.markdown b/website/docs/cdktf/python/r/dx_private_virtual_interface.html.markdown index 951eb0395af9..1746663a84bf 100644 --- a/website/docs/cdktf/python/r/dx_private_virtual_interface.html.markdown +++ b/website/docs/cdktf/python/r/dx_private_virtual_interface.html.markdown @@ -39,6 +39,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `address_family` - (Required) The address family for the BGP peer. `ipv4 ` or `ipv6`. * `bgp_asn` - (Required) The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration. * `connection_id` - (Required) The ID of the Direct Connect connection (or LAG) on which to create the virtual interface. @@ -97,4 +98,4 @@ Using `terraform import`, import Direct Connect private virtual interfaces using % terraform import aws_dx_private_virtual_interface.test dxvif-33cc44dd ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/dx_public_virtual_interface.html.markdown b/website/docs/cdktf/python/r/dx_public_virtual_interface.html.markdown index f2d15dce029d..3bc84d4cd80a 100644 --- a/website/docs/cdktf/python/r/dx_public_virtual_interface.html.markdown +++ b/website/docs/cdktf/python/r/dx_public_virtual_interface.html.markdown @@ -42,6 +42,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `address_family` - (Required) The address family for the BGP peer. `ipv4 ` or `ipv6`. * `bgp_asn` - (Required) The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration. * `connection_id` - (Required) The ID of the Direct Connect connection (or LAG) on which to create the virtual interface. @@ -94,4 +95,4 @@ Using `terraform import`, import Direct Connect public virtual interfaces using % terraform import aws_dx_public_virtual_interface.test dxvif-33cc44dd ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/dx_transit_virtual_interface.html.markdown b/website/docs/cdktf/python/r/dx_transit_virtual_interface.html.markdown index 30d7957983fd..4f0265a8add4 100644 --- a/website/docs/cdktf/python/r/dx_transit_virtual_interface.html.markdown +++ b/website/docs/cdktf/python/r/dx_transit_virtual_interface.html.markdown @@ -48,6 +48,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `address_family` - (Required) The address family for the BGP peer. `ipv4 ` or `ipv6`. * `bgp_asn` - (Required) The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration. * `connection_id` - (Required) The ID of the Direct Connect connection (or LAG) on which to create the virtual interface. @@ -105,4 +106,4 @@ Using `terraform import`, import Direct Connect transit virtual interfaces using % terraform import aws_dx_transit_virtual_interface.test dxvif-33cc44dd ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/dynamodb_contributor_insights.html.markdown b/website/docs/cdktf/python/r/dynamodb_contributor_insights.html.markdown index 7ad5d918d81d..5f9572c34482 100644 --- a/website/docs/cdktf/python/r/dynamodb_contributor_insights.html.markdown +++ b/website/docs/cdktf/python/r/dynamodb_contributor_insights.html.markdown @@ -35,8 +35,10 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `table_name` - (Required) The name of the table to enable contributor insights * `index_name` - (Optional) The global secondary index name +* `mode` - (Optional) argument to specify the [CloudWatch contributor insights mode](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/contributorinsights_HowItWorks.html#contributorinsights_HowItWorks.Modes) ## Attribute Reference @@ -67,4 +69,4 @@ Using `terraform import`, import `aws_dynamodb_contributor_insights` using the f % terraform import aws_dynamodb_contributor_insights.test name:ExampleTableName/index:ExampleIndexName/123456789012 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/dynamodb_global_table.html.markdown b/website/docs/cdktf/python/r/dynamodb_global_table.html.markdown index 7445aedad0e1..c7d764dbf37d 100644 --- a/website/docs/cdktf/python/r/dynamodb_global_table.html.markdown +++ b/website/docs/cdktf/python/r/dynamodb_global_table.html.markdown @@ -85,6 +85,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) The name of the global table. Must match underlying DynamoDB Table names in all regions. * `replica` - (Required) Underlying DynamoDB Table. At least 1 replica must be defined. See below. @@ -126,4 +127,4 @@ Using `terraform import`, import DynamoDB Global Tables using the global table n % terraform import aws_dynamodb_global_table.MyTable MyTable ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/dynamodb_kinesis_streaming_destination.html.markdown b/website/docs/cdktf/python/r/dynamodb_kinesis_streaming_destination.html.markdown index 95a6107feed5..d6d0b7e44153 100644 --- a/website/docs/cdktf/python/r/dynamodb_kinesis_streaming_destination.html.markdown +++ b/website/docs/cdktf/python/r/dynamodb_kinesis_streaming_destination.html.markdown @@ -57,6 +57,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `approximate_creation_date_time_precision` - (Optional) Toggle for the precision of Kinesis data stream timestamp. Valid values: `MILLISECOND` and `MICROSECOND`. * `stream_arn` - (Required) The ARN for a Kinesis data stream. This must exist in the same account and region as the DynamoDB table. * `table_name` - (Required) The name of the DynamoDB table. There can only be one Kinesis streaming destination for a given DynamoDB table. @@ -92,4 +93,4 @@ Using `terraform import`, import DynamoDB Kinesis Streaming Destinations using t % terraform import aws_dynamodb_kinesis_streaming_destination.example example,arn:aws:kinesis:us-east-1:111122223333:exampleStreamName ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/dynamodb_resource_policy.html.markdown b/website/docs/cdktf/python/r/dynamodb_resource_policy.html.markdown index 0c3e75496f0f..4aa7b6a69da4 100644 --- a/website/docs/cdktf/python/r/dynamodb_resource_policy.html.markdown +++ b/website/docs/cdktf/python/r/dynamodb_resource_policy.html.markdown @@ -44,6 +44,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `confirm_remove_self_resource_access` - (Optional) Set this parameter to true to confirm that you want to remove your permissions to change the policy of this resource in the future. ## Attribute Reference @@ -54,7 +55,7 @@ This resource exports the following attributes in addition to the arguments abov ## Import -In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import DynamoDB Resource Policy using the `example_id_arg`. For example: +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import DynamoDB Resource Policy using the `resource_arn`. For example: ```python # DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -71,10 +72,10 @@ class MyConvertedCode(TerraformStack): DynamodbResourcePolicy.generate_config_for_import(self, "example", "arn:aws:dynamodb:us-east-1:1234567890:table/my-table") ``` -Using `terraform import`, import DynamoDB Resource Policy using the `example_id_arg`. For example: +Using `terraform import`, import DynamoDB Resource Policy using the `resource_arn`. For example: ```console % terraform import aws_dynamodb_resource_policy.example arn:aws:dynamodb:us-east-1:1234567890:table/my-table ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/dynamodb_table.html.markdown b/website/docs/cdktf/python/r/dynamodb_table.html.markdown index 8b35174c3e23..75913eb8153b 100644 --- a/website/docs/cdktf/python/r/dynamodb_table.html.markdown +++ b/website/docs/cdktf/python/r/dynamodb_table.html.markdown @@ -120,6 +120,48 @@ class MyConvertedCode(TerraformStack): ) ``` +#### Global Tables with Multi-Region Strong Consistency + +A global table configured for Multi-Region strong consistency (MRSC) provides the ability to perform a strongly consistent read with multi-Region scope. Performing a strongly consistent read on an MRSC table ensures you're always reading the latest version of an item, irrespective of the Region in which you're performing the read. + +**Note** Please see detailed information, restrictions, caveats etc on the [AWS Support Page](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/multi-region-strong-consistency-gt.html). + +Consistency Mode (`consistency_mode`) is a new argument on the embedded `replica` that allows you to configure consistency mode for Global Tables. + +```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.dynamodb_table import DynamodbTable +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + DynamodbTable(self, "example", + attribute=[DynamodbTableAttribute( + name="TestTableHashKey", + type="S" + ) + ], + billing_mode="PAY_PER_REQUEST", + hash_key="TestTableHashKey", + name="example", + replica=[DynamodbTableReplica( + consistency_mode="STRONG", + region_name="us-east-2" + ), DynamodbTableReplica( + consistency_mode="STRONG", + region_name="us-west-2" + ) + ], + stream_enabled=True, + stream_view_type="NEW_AND_OLD_IMAGES" + ) +``` + ### Replica Tagging You can manage global table replicas' tags in various ways. This example shows using `replica.*.propagate_tags` for the first replica and the `aws_dynamodb_tag` resource for the other. @@ -186,7 +228,7 @@ class MyConvertedCode(TerraformStack): key="Architect", resource_arn=Token.as_string( Fn.replace(example.arn, - Token.as_string(current.name), + Token.as_string(current.region), Token.as_string(alternate.name))), value="Gigi" ) @@ -204,6 +246,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `billing_mode` - (Optional) Controls how you are charged for read and write throughput and how you manage capacity. The valid values are `PROVISIONED` and `PAY_PER_REQUEST`. Defaults to `PROVISIONED`. * `deletion_protection_enabled` - (Optional) Enables deletion protection for table. Defaults to `false`. * `import_table` - (Optional) Import Amazon S3 data into a new table. See below. @@ -292,6 +335,7 @@ The following arguments are optional: **Note:** This attribute will _not_ be populated with the ARN of _default_ keys. **Note:** Changing this value will recreate the replica. * `point_in_time_recovery` - (Optional) Whether to enable Point In Time Recovery for the replica. Default is `false`. +* `deletion_protection_enabled` - (Optional) Whether deletion protection is enabled (true) or disabled (false) on the replica. Default is `false`. * `propagate_tags` - (Optional) Whether to propagate the global table's tags to a replica. Default is `false`. Changes to tags only move in one direction: from global (source) to replica. @@ -299,6 +343,7 @@ The following arguments are optional: Tag changes on the global table are propagated to replicas. Changing from `true` to `false` on a subsequent `apply` leaves replica tags as-is and no longer manages them. * `region_name` - (Required) Region name of the replica. +* `consistency_mode` - (Optional) Whether this global table will be using `STRONG` consistency mode or `EVENTUAL` consistency mode. Default value is `EVENTUAL`. ### `server_side_encryption` @@ -360,4 +405,4 @@ Using `terraform import`, import DynamoDB tables using the `name`. For example: % terraform import aws_dynamodb_table.basic-dynamodb-table GameScores ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/dynamodb_table_export.html.markdown b/website/docs/cdktf/python/r/dynamodb_table_export.html.markdown index 04722c469192..496b5df9dc5b 100644 --- a/website/docs/cdktf/python/r/dynamodb_table_export.html.markdown +++ b/website/docs/cdktf/python/r/dynamodb_table_export.html.markdown @@ -118,6 +118,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `export_format` - (Optional, Forces new resource) Format for the exported data. Valid values are: `DYNAMODB_JSON`, `ION`. See the [AWS Documentation](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/S3DataExport.Output.html#S3DataExport.Output_Data) for more information on these export formats. Default is `DYNAMODB_JSON`. * `export_time` - (Optional, Forces new resource) Time in RFC3339 format from which to export table data. The table export will be a snapshot of the table's state at this point in time. Omitting this value will result in a snapshot from the current time. * `export_type` - (Optional, Forces new resource) Whether to execute as a full export or incremental export. Valid values are: `FULL_EXPORT`, `INCREMENTAL_EXPORT`. Defaults to `FULL_EXPORT`. If `INCREMENTAL_EXPORT` is provided, the `incremental_export_specification` argument must also be provided. @@ -179,4 +180,4 @@ Using `terraform import`, import DynamoDB table exports using the `arn`. For exa % terraform import aws_dynamodb_table_export.example arn:aws:dynamodb:us-west-2:12345678911:table/my-table-1/export/01580735656614-2c2f422e ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/dynamodb_table_item.html.markdown b/website/docs/cdktf/python/r/dynamodb_table_item.html.markdown index 82cb4b9be9f5..184485fd7a78 100644 --- a/website/docs/cdktf/python/r/dynamodb_table_item.html.markdown +++ b/website/docs/cdktf/python/r/dynamodb_table_item.html.markdown @@ -54,6 +54,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `hash_key` - (Required) Hash key to use for lookups and identification of the item * `item` - (Required) JSON representation of a map of attribute name/value pairs, one for each attribute. Only the primary key attributes are required; you can optionally provide other attribute name-value pairs for the item. * `range_key` - (Optional) Range key to use for lookups and identification of the item. Required if there is range key defined in the table. @@ -69,4 +70,4 @@ This resource exports the following attributes in addition to the arguments abov You cannot import DynamoDB table items. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/dynamodb_table_replica.html.markdown b/website/docs/cdktf/python/r/dynamodb_table_replica.html.markdown index 547f8daa5268..a7d4b23fa8d3 100644 --- a/website/docs/cdktf/python/r/dynamodb_table_replica.html.markdown +++ b/website/docs/cdktf/python/r/dynamodb_table_replica.html.markdown @@ -79,6 +79,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `kms_key_arn` - (Optional, Forces new resource) ARN of the CMK that should be used for the AWS KMS encryption. This argument should only be used if the key is different from the default KMS-managed DynamoDB key, `alias/aws/dynamodb`. **Note:** This attribute will _not_ be populated with the ARN of _default_ keys. * `deletion_protection_enabled` - (Optional) Whether deletion protection is enabled (true) or disabled (false) on the table replica. * `point_in_time_recovery` - (Optional) Whether to enable Point In Time Recovery for the table replica. Default is `false`. @@ -130,4 +131,4 @@ Using `terraform import`, import DynamoDB table replicas using the `table-name:m % terraform import aws_dynamodb_table_replica.example TestTable:us-west-2 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/dynamodb_tag.html.markdown b/website/docs/cdktf/python/r/dynamodb_tag.html.markdown index ac4ba82ad88a..23b5951a20ba 100644 --- a/website/docs/cdktf/python/r/dynamodb_tag.html.markdown +++ b/website/docs/cdktf/python/r/dynamodb_tag.html.markdown @@ -56,7 +56,7 @@ class MyConvertedCode(TerraformStack): provider=replica, resource_arn=Token.as_string( Fn.replace(example.arn, - Token.as_string(current.name), + Token.as_string(current.region), Token.as_string(data_aws_region_replica.name))), value="testvalue" ) @@ -66,6 +66,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `resource_arn` - (Required) Amazon Resource Name (ARN) of the DynamoDB resource to tag. * `key` - (Required) Tag name. * `value` - (Required) Tag value. @@ -101,4 +102,4 @@ Using `terraform import`, import `aws_dynamodb_tag` using the DynamoDB resource % terraform import aws_dynamodb_tag.example arn:aws:dynamodb:us-east-1:123456789012:table/example,Name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ebs_default_kms_key.html.markdown b/website/docs/cdktf/python/r/ebs_default_kms_key.html.markdown index affc3bdfe5ea..617f753e61cf 100644 --- a/website/docs/cdktf/python/r/ebs_default_kms_key.html.markdown +++ b/website/docs/cdktf/python/r/ebs_default_kms_key.html.markdown @@ -42,6 +42,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `key_arn` - (Required, ForceNew) The ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use to encrypt the EBS volume. ## Attribute Reference @@ -73,4 +74,4 @@ Using `terraform import`, import the EBS default KMS CMK using the KMS key ARN. % terraform import aws_ebs_default_kms_key.example arn:aws:kms:us-east-1:123456789012:key/abcd-1234 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ebs_encryption_by_default.html.markdown b/website/docs/cdktf/python/r/ebs_encryption_by_default.html.markdown index 2f93248479c4..078ba6643d01 100644 --- a/website/docs/cdktf/python/r/ebs_encryption_by_default.html.markdown +++ b/website/docs/cdktf/python/r/ebs_encryption_by_default.html.markdown @@ -37,6 +37,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `enabled` - (Optional) Whether or not default EBS encryption is enabled. Valid values are `true` or `false`. Defaults to `true`. ## Attribute Reference @@ -68,4 +69,4 @@ Using `terraform import`, import the default EBS encryption state. For example: % terraform import aws_ebs_encryption_by_default.example default ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ebs_fast_snapshot_restore.html.markdown b/website/docs/cdktf/python/r/ebs_fast_snapshot_restore.html.markdown index 790e9096cd8a..4505918828cd 100644 --- a/website/docs/cdktf/python/r/ebs_fast_snapshot_restore.html.markdown +++ b/website/docs/cdktf/python/r/ebs_fast_snapshot_restore.html.markdown @@ -36,8 +36,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `availability_zone` - (Required) Availability zone in which to enable fast snapshot restores. * `snapshot_id` - (Required) ID of the snapshot. @@ -57,7 +58,7 @@ This resource exports the following attributes in addition to the arguments abov ## Import -In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import EC2 (Elastic Compute Cloud) EBS Fast Snapshot Restore using the `example_id_arg`. For example: +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import EC2 (Elastic Compute Cloud) EBS Fast Snapshot Restore using the `availability_zone` and `snapshot_id` separated by `,`. For example: ```python # DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -74,10 +75,10 @@ class MyConvertedCode(TerraformStack): EbsFastSnapshotRestore.generate_config_for_import(self, "example", "us-west-2a,snap-abcdef123456") ``` -Using `terraform import`, import EC2 (Elastic Compute Cloud) EBS Fast Snapshot Restore using the `id`. For example: +Using `terraform import`, import EC2 (Elastic Compute Cloud) EBS Fast Snapshot Restore using the `availability_zone` and `snapshot_id` separated by `,`. For example: ```console % terraform import aws_ebs_fast_snapshot_restore.example us-west-2a,snap-abcdef123456 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ebs_snapshot.html.markdown b/website/docs/cdktf/python/r/ebs_snapshot.html.markdown index 360c7c6fd6a1..440460ac33d4 100644 --- a/website/docs/cdktf/python/r/ebs_snapshot.html.markdown +++ b/website/docs/cdktf/python/r/ebs_snapshot.html.markdown @@ -46,6 +46,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `volume_id` - (Required) The Volume ID of which to make a snapshot. * `description` - (Optional) A description of what the snapshot is. * `outpost_arn` - (Optional) The Amazon Resource Name (ARN) of the Outpost on which to create a local snapshot. @@ -100,4 +101,4 @@ Using `terraform import`, import EBS Snapshot using the `id`. For example: % terraform import aws_ebs_snapshot.id snap-049df61146c4d7901 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ebs_snapshot_block_public_access.html.markdown b/website/docs/cdktf/python/r/ebs_snapshot_block_public_access.html.markdown index b3d812835d91..7185f5e318e9 100644 --- a/website/docs/cdktf/python/r/ebs_snapshot_block_public_access.html.markdown +++ b/website/docs/cdktf/python/r/ebs_snapshot_block_public_access.html.markdown @@ -37,6 +37,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `state` - (Required) The mode in which to enable "Block public access for snapshots" for the region. Allowed values are `block-all-sharing`, `block-new-sharing`, `unblocked`. ## Attribute Reference @@ -68,4 +69,4 @@ Using `terraform import`, import the state. For example: % terraform import aws_ebs_snapshot_block_public_access.example default ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ebs_snapshot_copy.html.markdown b/website/docs/cdktf/python/r/ebs_snapshot_copy.html.markdown index 6e8fa7aa8042..2eee4b7ff36f 100644 --- a/website/docs/cdktf/python/r/ebs_snapshot_copy.html.markdown +++ b/website/docs/cdktf/python/r/ebs_snapshot_copy.html.markdown @@ -54,6 +54,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `description` - (Optional) A description of what the snapshot is. * `encrypted` - Whether the snapshot is encrypted. * `kms_key_id` - The ARN for the KMS encryption key. @@ -84,4 +85,4 @@ This resource exports the following attributes in addition to the arguments abov - `create` - (Default `10m`) - `delete` - (Default `10m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ebs_snapshot_import.html.markdown b/website/docs/cdktf/python/r/ebs_snapshot_import.html.markdown index d7f2d379b401..881da936f3a2 100644 --- a/website/docs/cdktf/python/r/ebs_snapshot_import.html.markdown +++ b/website/docs/cdktf/python/r/ebs_snapshot_import.html.markdown @@ -45,6 +45,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `client_data` - (Optional) The client-specific data. Detailed below. * `description` - (Optional) The description string for the import snapshot task. * `disk_container` - (Required) Information about the disk container. Detailed below. @@ -94,4 +95,4 @@ This resource exports the following attributes in addition to the arguments abov * `data_encryption_key_id` - The data encryption key identifier for the snapshot. * `tags_all` - A map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ebs_volume.html.markdown b/website/docs/cdktf/python/r/ebs_volume.html.markdown index 56602c9115af..3f667d6b3f93 100644 --- a/website/docs/cdktf/python/r/ebs_volume.html.markdown +++ b/website/docs/cdktf/python/r/ebs_volume.html.markdown @@ -39,6 +39,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `availability_zone` - (Required) Availability zone where the EBS volume will exist. * `encrypted` - (Optional) If true, the disk will be encrypted. * `final_snapshot` - (Optional) If true, snapshot will be created before volume deletion. Any tags on the volume will be migrated to the snapshot. By default set to false @@ -51,6 +52,7 @@ This resource supports the following arguments: * `tags` - (Optional) A 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. * `throughput` - (Optional) Throughput that the volume supports, in MiB/s. Only valid for `type` of `gp3`. * `type` - (Optional) Type of EBS volume. Can be `standard`, `gp2`, `gp3`, `io1`, `io2`, `sc1` or `st1` (Default: `gp2`). +* `volume_initialization_rate` - (Optional) EBS provisioned rate for volume initialization, in MiB/s, at which to download the snapshot blocks from Amazon S3 to the volume. This argument can only be set if `snapshot_id` is specified. ~> **NOTE:** At least one of `size` or `snapshot_id` is required. @@ -98,4 +100,4 @@ Using `terraform import`, import EBS Volumes using the `id`. For example: % terraform import aws_ebs_volume.id vol-049df61146c4d7901 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ec2_availability_zone_group.html.markdown b/website/docs/cdktf/python/r/ec2_availability_zone_group.html.markdown index 73bb5082acaf..631a68d4aef1 100644 --- a/website/docs/cdktf/python/r/ec2_availability_zone_group.html.markdown +++ b/website/docs/cdktf/python/r/ec2_availability_zone_group.html.markdown @@ -36,8 +36,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `group_name` - (Required) Name of the Availability Zone Group. * `opt_in_status` - (Required) Indicates whether to enable or disable Availability Zone Group. Valid values: `opted-in` or `not-opted-in`. @@ -72,4 +73,4 @@ Using `terraform import`, import EC2 Availability Zone Groups using the group na % terraform import aws_ec2_availability_zone_group.example us-west-2-lax-1 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ec2_capacity_block_reservation.html.markdown b/website/docs/cdktf/python/r/ec2_capacity_block_reservation.html.markdown index 7b4e05a476d0..e582d956bf26 100644 --- a/website/docs/cdktf/python/r/ec2_capacity_block_reservation.html.markdown +++ b/website/docs/cdktf/python/r/ec2_capacity_block_reservation.html.markdown @@ -51,6 +51,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `capacity_block_offering_id` - (Required) The Capacity Block Reservation ID. * `instance_platform` - (Required) The type of operating system for which to reserve capacity. Valid options are `Linux/UNIX`, `Red Hat Enterprise Linux`, `SUSE Linux`, `Windows`, `Windows with SQL Server`, `Windows with SQL Server Enterprise`, `Windows with SQL Server Standard` or `Windows with SQL Server Web`. * `tags` - (Optional) A 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. @@ -75,4 +76,4 @@ This resource exports the following attributes in addition to the arguments abov * `tenancy` - Indicates the tenancy of the Capacity Block Reservation. Specify either `default` or `dedicated`. * `tags_all` - A map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ec2_capacity_reservation.html.markdown b/website/docs/cdktf/python/r/ec2_capacity_reservation.html.markdown index c582020b6afc..fee9493724cb 100644 --- a/website/docs/cdktf/python/r/ec2_capacity_reservation.html.markdown +++ b/website/docs/cdktf/python/r/ec2_capacity_reservation.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `availability_zone` - (Required) The Availability Zone in which to create the Capacity Reservation. * `ebs_optimized` - (Optional) Indicates whether the Capacity Reservation supports EBS-optimized instances. * `end_date` - (Optional) The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity is released and you can no longer launch instances into it. Valid values: [RFC3339 time string](https://tools.ietf.org/html/rfc3339#section-5.8) (`YYYY-MM-DDTHH:MM:SSZ`) @@ -94,4 +95,4 @@ Using `terraform import`, import Capacity Reservations using the `id`. For examp % terraform import aws_ec2_capacity_reservation.web cr-0123456789abcdef0 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ec2_carrier_gateway.html.markdown b/website/docs/cdktf/python/r/ec2_carrier_gateway.html.markdown index 2c1e548c4f45..05b8560794e4 100644 --- a/website/docs/cdktf/python/r/ec2_carrier_gateway.html.markdown +++ b/website/docs/cdktf/python/r/ec2_carrier_gateway.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `tags` - (Optional) A 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. * `vpc_id` - (Required) The ID of the VPC to associate with the carrier gateway. @@ -75,4 +76,4 @@ Using `terraform import`, import `aws_ec2_carrier_gateway` using the carrier gat % terraform import aws_ec2_carrier_gateway.example cgw-12345 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ec2_client_vpn_authorization_rule.html.markdown b/website/docs/cdktf/python/r/ec2_client_vpn_authorization_rule.html.markdown index 9544447222e1..d0e008ba01d5 100644 --- a/website/docs/cdktf/python/r/ec2_client_vpn_authorization_rule.html.markdown +++ b/website/docs/cdktf/python/r/ec2_client_vpn_authorization_rule.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `client_vpn_endpoint_id` - (Required) The ID of the Client VPN endpoint. * `target_network_cidr` - (Required) The IPv4 address range, in CIDR notation, of the network to which the authorization rule applies. * `access_group_id` - (Optional) The ID of the group to which the authorization rule grants access. One of `access_group_id` or `authorize_all_groups` must be set. @@ -107,4 +108,4 @@ Using the endpoint ID, target network CIDR, and group name: % terraform import aws_ec2_client_vpn_authorization_rule.example cvpn-endpoint-0ac3a1abbccddd666,10.1.0.0/24,team-a ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ec2_client_vpn_endpoint.html.markdown b/website/docs/cdktf/python/r/ec2_client_vpn_endpoint.html.markdown index 6ec5dab51ef1..c1fcef138e1a 100644 --- a/website/docs/cdktf/python/r/ec2_client_vpn_endpoint.html.markdown +++ b/website/docs/cdktf/python/r/ec2_client_vpn_endpoint.html.markdown @@ -48,8 +48,9 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `authentication_options` - (Required) Information about the authentication method to be used to authenticate clients. -* `client_cidr_block` - (Required) The IPv4 address range, in CIDR notation, from which to assign client IP addresses. The address range cannot overlap with the local CIDR of the VPC in which the associated subnet is located, or the routes that you add manually. The address range cannot be changed after the Client VPN endpoint has been created. The CIDR block should be /22 or greater. +* `client_cidr_block` - (Optional) The IPv4 address range, in CIDR notation, from which to assign client IP addresses. The address range cannot overlap with the local CIDR of the VPC in which the associated subnet is located, or the routes that you add manually. The address range cannot be changed after the Client VPN endpoint has been created. The CIDR block should be /22 or greater. When `traffic_ip_address_type` is set to `ipv6`, it must not be specified. Otherwise, it is required. * `client_connect_options` - (Optional) The options for managing connection authorization for new client connections. * `client_login_banner_options` - (Optional) Options for enabling a customizable text banner that will be displayed on AWS provided clients when a VPN session is established. * `client_route_enforcement_options` - (Optional) Options for enforce administrator defined routes on devices connected through the VPN. @@ -57,12 +58,14 @@ This resource supports the following arguments: * `description` - (Optional) A brief description of the Client VPN endpoint. * `disconnect_on_session_timeout` - (Optional) Indicates whether the client VPN session is disconnected after the maximum `session_timeout_hours` is reached. If `true`, users are prompted to reconnect client VPN. If `false`, client VPN attempts to reconnect automatically. The default value is `false`. * `dns_servers` - (Optional) Information about the DNS servers to be used for DNS resolution. A Client VPN endpoint can have up to two DNS servers. If no DNS server is specified, the DNS address of the connecting device is used. +* `endpoint_ip_address_type` - (Optional) IP address type for the Client VPN endpoint. Valid values are `ipv4`, `ipv6`, or `dual-stack`. Defaults to `ipv4`. * `security_group_ids` - (Optional) The IDs of one or more security groups to apply to the target network. You must also specify the ID of the VPC that contains the security groups. * `self_service_portal` - (Optional) Specify whether to enable the self-service portal for the Client VPN endpoint. Values can be `enabled` or `disabled`. Default value is `disabled`. * `server_certificate_arn` - (Required) The ARN of the ACM server certificate. * `session_timeout_hours` - (Optional) The maximum session duration is a trigger by which end-users are required to re-authenticate prior to establishing a VPN session. Default value is `24` - Valid values: `8 | 10 | 12 | 24` * `split_tunnel` - (Optional) Indicates whether split-tunnel is enabled on VPN endpoint. Default value is `false`. * `tags` - (Optional) A mapping 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. +* `traffic_ip_address_type` - (Optional) IP address type for traffic within the Client VPN tunnel. Valid values are `ipv4`, `ipv6`, or `dual-stack`. Defaults to `ipv4`. When it is set to `ipv6`, `client_cidr_block` must not be specified. * `transport_protocol` - (Optional) The transport protocol to be used by the VPN session. Default value is `udp`. * `vpc_id` - (Optional) The ID of the VPC to associate with the Client VPN endpoint. If no security group IDs are specified in the request, the default security group for the VPC is applied. * `vpn_port` - (Optional) The port number for the Client VPN endpoint. Valid values are `443` and `1194`. Default value is `443`. @@ -134,4 +137,4 @@ Using `terraform import`, import AWS Client VPN endpoints using the `id` value f % terraform import aws_ec2_client_vpn_endpoint.example cvpn-endpoint-0ac3a1abbccddd666 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ec2_client_vpn_network_association.html.markdown b/website/docs/cdktf/python/r/ec2_client_vpn_network_association.html.markdown index 7987a6692788..24b3a19cdbae 100644 --- a/website/docs/cdktf/python/r/ec2_client_vpn_network_association.html.markdown +++ b/website/docs/cdktf/python/r/ec2_client_vpn_network_association.html.markdown @@ -37,6 +37,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `client_vpn_endpoint_id` - (Required) The ID of the Client VPN endpoint. * `subnet_id` - (Required) The ID of the subnet to associate with the Client VPN endpoint. @@ -80,4 +81,4 @@ Using `terraform import`, import AWS Client VPN network associations using the e % terraform import aws_ec2_client_vpn_network_association.example cvpn-endpoint-0ac3a1abbccddd666,cvpn-assoc-0b8db902465d069ad ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ec2_client_vpn_route.html.markdown b/website/docs/cdktf/python/r/ec2_client_vpn_route.html.markdown index 1b965762af4c..d1c1f827fe46 100644 --- a/website/docs/cdktf/python/r/ec2_client_vpn_route.html.markdown +++ b/website/docs/cdktf/python/r/ec2_client_vpn_route.html.markdown @@ -62,6 +62,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `client_vpn_endpoint_id` - (Required) The ID of the Client VPN endpoint. * `destination_cidr_block` - (Required) The IPv4 address range, in CIDR notation, of the route destination. * `description` - (Optional) A brief description of the route. @@ -107,4 +108,4 @@ Using `terraform import`, import AWS Client VPN routes using the endpoint ID, ta % terraform import aws_ec2_client_vpn_route.example cvpn-endpoint-1234567890abcdef,subnet-9876543210fedcba,10.1.0.0/24 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ec2_default_credit_specification.html.markdown b/website/docs/cdktf/python/r/ec2_default_credit_specification.html.markdown index 3e49d20c0799..27f515bfa37b 100644 --- a/website/docs/cdktf/python/r/ec2_default_credit_specification.html.markdown +++ b/website/docs/cdktf/python/r/ec2_default_credit_specification.html.markdown @@ -23,7 +23,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 Ec2DefaultCreditSpecification +from imports.aws.ec2_default_credit_specification import Ec2DefaultCreditSpecification class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) @@ -35,8 +35,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `cpu_credits` - (Required) Credit option for CPU usage of the instance family. Valid values: `standard`, `unlimited`. * `instance_family` - (Required) Instance family. Valid values are `t2`, `t3`, `t3a`, `t4g`. @@ -63,7 +64,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 Ec2DefaultCreditSpecification +from imports.aws.ec2_default_credit_specification import Ec2DefaultCreditSpecification class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) @@ -75,4 +76,4 @@ Using `terraform import`, import EC2 (Elastic Compute Cloud) Default Credit Spec ```console % terraform import aws_ec2_default_credit_specification.example t2 - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ec2_fleet.html.markdown b/website/docs/cdktf/python/r/ec2_fleet.html.markdown index c7b520edb2b2..7db81cb9f37e 100644 --- a/website/docs/cdktf/python/r/ec2_fleet.html.markdown +++ b/website/docs/cdktf/python/r/ec2_fleet.html.markdown @@ -45,6 +45,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `context` - (Optional) Reserved. * `excess_capacity_termination_policy` - (Optional) Whether running instances should be terminated if the total target capacity of the EC2 Fleet is decreased below the current size of the EC2. Valid values: `no-termination`, `termination`. Defaults to `termination`. Supported only for fleets of type `maintain`. * `launch_template_config` - (Required) Nested argument containing EC2 Launch Template configurations. Defined below. @@ -270,4 +271,4 @@ Using `terraform import`, import `aws_ec2_fleet` using the Fleet identifier. For % terraform import aws_ec2_fleet.example fleet-b9b55d27-c5fc-41ac-a6f3-48fcc91f080c ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ec2_host.html.markdown b/website/docs/cdktf/python/r/ec2_host.html.markdown index 0a7b8c435200..06b5df23cbe4 100644 --- a/website/docs/cdktf/python/r/ec2_host.html.markdown +++ b/website/docs/cdktf/python/r/ec2_host.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `asset_id` - (Optional) The ID of the Outpost hardware asset on which to allocate the Dedicated Hosts. This parameter is supported only if you specify OutpostArn. If you are allocating the Dedicated Hosts in a Region, omit this parameter. * `auto_placement` - (Optional) Indicates whether the host accepts any untargeted instance launches that match its instance type configuration, or if it only accepts Host tenancy instance launches that specify its unique host ID. Valid values: `on`, `off`. Default: `on`. * `availability_zone` - (Required) The Availability Zone in which to allocate the Dedicated Host. @@ -89,4 +90,4 @@ Using `terraform import`, import hosts using the host `id`. For example: % terraform import aws_ec2_host.example h-0385a99d0e4b20cbb ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ec2_instance_connect_endpoint.html.markdown b/website/docs/cdktf/python/r/ec2_instance_connect_endpoint.html.markdown index 72487bb18a03..588eee128048 100644 --- a/website/docs/cdktf/python/r/ec2_instance_connect_endpoint.html.markdown +++ b/website/docs/cdktf/python/r/ec2_instance_connect_endpoint.html.markdown @@ -35,6 +35,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `preserve_client_ip` - (Optional) Indicates whether your client's IP address is preserved as the source. Default: `true`. * `security_group_ids` - (Optional) One or more security groups to associate with the endpoint. If you don't specify a security group, the default security group for the VPC will be associated with the endpoint. * `subnet_id` - (Required) The ID of the subnet in which to create the EC2 Instance Connect Endpoint. @@ -85,4 +86,4 @@ Using `terraform import`, import EC2 Instance Connect Endpoints using the `id`. % terraform import aws_ec2_instance_connect_endpoint.example eice-012345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ec2_instance_metadata_defaults.html.markdown b/website/docs/cdktf/python/r/ec2_instance_metadata_defaults.html.markdown index 22f1481a8c3c..5531486fc2d4 100644 --- a/website/docs/cdktf/python/r/ec2_instance_metadata_defaults.html.markdown +++ b/website/docs/cdktf/python/r/ec2_instance_metadata_defaults.html.markdown @@ -37,6 +37,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `http_endpoint` - (Optional) Whether the metadata service is available. Can be `"enabled"`, `"disabled"`, or `"no-preference"`. Default: `"no-preference"`. * `http_tokens` - (Optional) Whether the metadata service requires session tokens, also referred to as _Instance Metadata Service Version 2 (IMDSv2)_. Can be `"optional"`, `"required"`, or `"no-preference"`. Default: `"no-preference"`. * `http_put_response_hop_limit` - (Optional) The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel. Can be an integer from `1` to `64`, or `-1` to indicate no preference. Default: `-1`. @@ -50,4 +51,4 @@ This data source exports no additional attributes. You cannot import this resource. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ec2_instance_state.html.markdown b/website/docs/cdktf/python/r/ec2_instance_state.html.markdown index 36e690233001..8191d0803f4d 100644 --- a/website/docs/cdktf/python/r/ec2_instance_state.html.markdown +++ b/website/docs/cdktf/python/r/ec2_instance_state.html.markdown @@ -66,6 +66,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `force` - (Optional) Whether to request a forced stop when `state` is `stopped`. Otherwise (_i.e._, `state` is `running`), ignored. When an instance is forced to stop, it does not flush file system caches or file system metadata, and you must subsequently perform file system check and repair. Not recommended for Windows instances. Defaults to `false`. ## Attribute Reference @@ -107,4 +108,4 @@ Using `terraform import`, import `aws_ec2_instance_state` using the `instance_id % terraform import aws_ec2_instance_state.test i-02cae6557dfcf2f96 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ec2_local_gateway_route.html.markdown b/website/docs/cdktf/python/r/ec2_local_gateway_route.html.markdown index c590809734ae..5ff6870d2566 100644 --- a/website/docs/cdktf/python/r/ec2_local_gateway_route.html.markdown +++ b/website/docs/cdktf/python/r/ec2_local_gateway_route.html.markdown @@ -35,8 +35,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `destination_cidr_block` - (Required) IPv4 CIDR range used for destination matches. Routing decisions are based on the most specific match. * `local_gateway_route_table_id` - (Required) Identifier of EC2 Local Gateway Route Table. * `local_gateway_virtual_interface_group_id` - (Required) Identifier of EC2 Local Gateway Virtual Interface Group. @@ -72,4 +73,4 @@ Using `terraform import`, import `aws_ec2_local_gateway_route` using the EC2 Loc % terraform import aws_ec2_local_gateway_route.example lgw-rtb-12345678_172.16.0.0/16 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ec2_local_gateway_route_table_vpc_association.html.markdown b/website/docs/cdktf/python/r/ec2_local_gateway_route_table_vpc_association.html.markdown index cce5af9d84d8..444c77e9c2fc 100644 --- a/website/docs/cdktf/python/r/ec2_local_gateway_route_table_vpc_association.html.markdown +++ b/website/docs/cdktf/python/r/ec2_local_gateway_route_table_vpc_association.html.markdown @@ -55,6 +55,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `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. ## Attribute Reference @@ -89,4 +90,4 @@ Using `terraform import`, import `aws_ec2_local_gateway_route_table_vpc_associat % terraform import aws_ec2_local_gateway_route_table_vpc_association.example lgw-vpc-assoc-1234567890abcdef ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ec2_managed_prefix_list.html.markdown b/website/docs/cdktf/python/r/ec2_managed_prefix_list.html.markdown index 85efe476ea8d..ae86279a3d5d 100644 --- a/website/docs/cdktf/python/r/ec2_managed_prefix_list.html.markdown +++ b/website/docs/cdktf/python/r/ec2_managed_prefix_list.html.markdown @@ -62,6 +62,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `address_family` - (Required, Forces new resource) Address family (`IPv4` or `IPv6`) of this prefix list. * `entry` - (Optional) Configuration block for prefix list entry. Detailed below. Different entries may have overlapping CIDR blocks, but a particular CIDR should not be duplicated. * `max_entries` - (Required) Maximum number of entries that this prefix list can contain. @@ -108,4 +109,4 @@ Using `terraform import`, import Prefix Lists using the `id`. For example: % terraform import aws_ec2_managed_prefix_list.default pl-0570a1d2d725c16be ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ec2_managed_prefix_list_entry.html.markdown b/website/docs/cdktf/python/r/ec2_managed_prefix_list_entry.html.markdown index 90cf1e441870..b9ee322877e7 100644 --- a/website/docs/cdktf/python/r/ec2_managed_prefix_list_entry.html.markdown +++ b/website/docs/cdktf/python/r/ec2_managed_prefix_list_entry.html.markdown @@ -52,6 +52,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `cidr` - (Required) CIDR block of this entry. * `description` - (Optional) Description of this entry. Please note that due to API limitations, updating only the description of an entry will require recreating the entry. * `prefix_list_id` - (Required) The ID of the prefix list. @@ -87,4 +88,4 @@ Using `terraform import`, import prefix list entries using `prefix_list_id` and % terraform import aws_ec2_managed_prefix_list_entry.default pl-0570a1d2d725c16be,10.0.3.0/24 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ec2_network_insights_analysis.html.markdown b/website/docs/cdktf/python/r/ec2_network_insights_analysis.html.markdown index 24be9c94b660..aa4defdfb8af 100644 --- a/website/docs/cdktf/python/r/ec2_network_insights_analysis.html.markdown +++ b/website/docs/cdktf/python/r/ec2_network_insights_analysis.html.markdown @@ -45,6 +45,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `filter_in_arns` - (Optional) A list of ARNs for resources the path must traverse. * `wait_for_completion` - (Optional) If enabled, the resource will wait for the Network Insights Analysis status to change to `succeeded` or `failed`. Setting this to `false` will skip the process. Default: `true`. * `tags` - (Optional) Map of tags to assign to the resource. If configured with a provider [`default_tags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. @@ -96,4 +97,4 @@ Using `terraform import`, import Network Insights Analyzes using the `id`. For e % terraform import aws_ec2_network_insights_analysis.test nia-0462085c957f11a55 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ec2_network_insights_path.html.markdown b/website/docs/cdktf/python/r/ec2_network_insights_path.html.markdown index 38f55089d470..7144c5d4215f 100644 --- a/website/docs/cdktf/python/r/ec2_network_insights_path.html.markdown +++ b/website/docs/cdktf/python/r/ec2_network_insights_path.html.markdown @@ -42,6 +42,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `source_ip` - (Optional) IP address of the source resource. * `destination` - (Optional) ID or ARN of the resource which is the destination of the path. Can be an Instance, Internet Gateway, Network Interface, Transit Gateway, VPC Endpoint, VPC Peering Connection or VPN Gateway. If the resource is in another account, you must specify an ARN. Either the `destination` argument or the `destination_address` argument in the `filter_at_source` block must be specified. * `destination_ip` - (Optional) IP address of the destination resource. @@ -97,4 +98,4 @@ Using `terraform import`, import Network Insights Paths using the `id`. For exam % terraform import aws_ec2_network_insights_path.test nip-00edfba169923aefd ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ec2_serial_console_access.html.markdown b/website/docs/cdktf/python/r/ec2_serial_console_access.html.markdown index a5145fc70f02..27010c0a93d0 100644 --- a/website/docs/cdktf/python/r/ec2_serial_console_access.html.markdown +++ b/website/docs/cdktf/python/r/ec2_serial_console_access.html.markdown @@ -37,6 +37,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `enabled` - (Optional) Whether or not serial console access is enabled. Valid values are `true` or `false`. Defaults to `true`. ## Attribute Reference @@ -68,4 +69,4 @@ Using `terraform import`, import serial console access state. For example: % terraform import aws_ec2_serial_console_access.example default ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ec2_subnet_cidr_reservation.html.markdown b/website/docs/cdktf/python/r/ec2_subnet_cidr_reservation.html.markdown index 8abbc4dc1354..7bd429121576 100644 --- a/website/docs/cdktf/python/r/ec2_subnet_cidr_reservation.html.markdown +++ b/website/docs/cdktf/python/r/ec2_subnet_cidr_reservation.html.markdown @@ -37,6 +37,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `cidr_block` - (Required) The CIDR block for the reservation. * `reservation_type` - (Required) The type of reservation to create. Valid values: `explicit`, `prefix` * `subnet_id` - (Required) The ID of the subnet to create the reservation for. @@ -74,4 +75,4 @@ Using `terraform import`, import Existing CIDR reservations using `SUBNET_ID:RES % terraform import aws_ec2_subnet_cidr_reservation.example subnet-01llsxvsxabqiymcz:scr-4mnvz6wb7otksjcs9 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ec2_tag.html.markdown b/website/docs/cdktf/python/r/ec2_tag.html.markdown index 6e98dde36f4c..a3d8feb9c32f 100644 --- a/website/docs/cdktf/python/r/ec2_tag.html.markdown +++ b/website/docs/cdktf/python/r/ec2_tag.html.markdown @@ -61,6 +61,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `resource_id` - (Required) The ID of the EC2 resource to manage the tag for. * `key` - (Required) The tag name. * `value` - (Required) The value of the tag. @@ -96,4 +97,4 @@ Using `terraform import`, import `aws_ec2_tag` using the EC2 resource identifier % terraform import aws_ec2_tag.example tgw-attach-1234567890abcdef,Name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ec2_traffic_mirror_filter.html.markdown b/website/docs/cdktf/python/r/ec2_traffic_mirror_filter.html.markdown index ddbc5424004d..af8803532ef9 100644 --- a/website/docs/cdktf/python/r/ec2_traffic_mirror_filter.html.markdown +++ b/website/docs/cdktf/python/r/ec2_traffic_mirror_filter.html.markdown @@ -39,6 +39,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `description` - (Optional, Forces new resource) A description of the filter. * `network_services` - (Optional) List of amazon network services that should be mirrored. Valid values: `amazon-dns`. * `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. @@ -76,4 +77,4 @@ Using `terraform import`, import traffic mirror filter using the `id`. For examp % terraform import aws_ec2_traffic_mirror_filter.foo tmf-0fbb93ddf38198f64 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ec2_traffic_mirror_filter_rule.html.markdown b/website/docs/cdktf/python/r/ec2_traffic_mirror_filter_rule.html.markdown index 8916f34c4e35..0bdcf5e7a02f 100644 --- a/website/docs/cdktf/python/r/ec2_traffic_mirror_filter_rule.html.markdown +++ b/website/docs/cdktf/python/r/ec2_traffic_mirror_filter_rule.html.markdown @@ -67,6 +67,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `description` - (Optional) Description of the traffic mirror filter rule. * `traffic_mirror_filter_id` - (Required) ID of the traffic mirror filter to which this rule should be added * `destination_cidr_block` - (Required) Destination CIDR block to assign to the Traffic Mirror rule. @@ -115,4 +116,4 @@ Using `terraform import`, import traffic mirror rules using the `traffic_mirror_ % terraform import aws_ec2_traffic_mirror_filter_rule.rule tmf-0fbb93ddf38198f64:tmfr-05a458f06445d0aee ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ec2_traffic_mirror_session.html.markdown b/website/docs/cdktf/python/r/ec2_traffic_mirror_session.html.markdown index f496f81b3ba4..f802fd5d4424 100644 --- a/website/docs/cdktf/python/r/ec2_traffic_mirror_session.html.markdown +++ b/website/docs/cdktf/python/r/ec2_traffic_mirror_session.html.markdown @@ -51,6 +51,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `description` - (Optional) A description of the traffic mirror session. * `network_interface_id` - (Required, Forces new) ID of the source network interface. Not all network interfaces are eligible as mirror sources. On EC2 instances only nitro based instances support mirroring. * `traffic_mirror_filter_id` - (Required) ID of the traffic mirror filter to be used @@ -94,4 +95,4 @@ Using `terraform import`, import traffic mirror sessions using the `id`. For exa % terraform import aws_ec2_traffic_mirror_session.session tms-0d8aa3ca35897b82e ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ec2_traffic_mirror_target.html.markdown b/website/docs/cdktf/python/r/ec2_traffic_mirror_target.html.markdown index 8c803466f6c8..2f4736c2424a 100644 --- a/website/docs/cdktf/python/r/ec2_traffic_mirror_target.html.markdown +++ b/website/docs/cdktf/python/r/ec2_traffic_mirror_target.html.markdown @@ -47,6 +47,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `description` - (Optional, Forces new) A description of the traffic mirror session. * `network_interface_id` - (Optional, Forces new) The network interface ID that is associated with the target. * `network_load_balancer_arn` - (Optional, Forces new) The Amazon Resource Name (ARN) of the Network Load Balancer that is associated with the target. @@ -89,4 +90,4 @@ Using `terraform import`, import traffic mirror targets using the `id`. For exam % terraform import aws_ec2_traffic_mirror_target.target tmt-0c13a005422b86606 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ec2_transit_gateway.html.markdown b/website/docs/cdktf/python/r/ec2_transit_gateway.html.markdown index 5eef0f2c4578..2853e8fd3bdd 100644 --- a/website/docs/cdktf/python/r/ec2_transit_gateway.html.markdown +++ b/website/docs/cdktf/python/r/ec2_transit_gateway.html.markdown @@ -35,6 +35,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `amazon_side_asn` - (Optional) Private Autonomous System Number (ASN) for the Amazon side of a BGP session. The range is `64512` to `65534` for 16-bit ASNs and `4200000000` to `4294967294` for 32-bit ASNs. Default value: `64512`. -> **NOTE:** Modifying `amazon_side_asn` on a Transit Gateway with active BGP sessions is [not allowed](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyTransitGatewayOptions.html). You must first delete all Transit Gateway attachments that have BGP configured prior to modifying `amazon_side_asn`. @@ -94,4 +95,4 @@ Using `terraform import`, import `aws_ec2_transit_gateway` using the EC2 Transit % terraform import aws_ec2_transit_gateway.example tgw-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ec2_transit_gateway_connect.html.markdown b/website/docs/cdktf/python/r/ec2_transit_gateway_connect.html.markdown index 1377a015fd1b..1e9668fe7877 100644 --- a/website/docs/cdktf/python/r/ec2_transit_gateway_connect.html.markdown +++ b/website/docs/cdktf/python/r/ec2_transit_gateway_connect.html.markdown @@ -42,6 +42,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `protocol` - (Optional) The tunnel protocol. Valid values: `gre`. Default is `gre`. * `tags` - (Optional) Key-value tags for the EC2 Transit Gateway Connect. 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. * `transit_gateway_default_route_table_association` - (Optional) Boolean whether the Connect should be associated with the EC2 Transit Gateway association default route table. This cannot be configured or perform drift detection with Resource Access Manager shared EC2 Transit Gateways. Default value: `true`. @@ -89,4 +90,4 @@ Using `terraform import`, import `aws_ec2_transit_gateway_connect` using the EC2 % terraform import aws_ec2_transit_gateway_connect.example tgw-attach-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ec2_transit_gateway_connect_peer.html.markdown b/website/docs/cdktf/python/r/ec2_transit_gateway_connect_peer.html.markdown index e01d3f6d1753..bc14a1674d01 100644 --- a/website/docs/cdktf/python/r/ec2_transit_gateway_connect_peer.html.markdown +++ b/website/docs/cdktf/python/r/ec2_transit_gateway_connect_peer.html.markdown @@ -45,6 +45,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `bgp_asn` - (Optional) The BGP ASN number assigned customer device. If not provided, it will use the same BGP ASN as is associated with Transit Gateway. * `inside_cidr_blocks` - (Required) The CIDR block that will be used for addressing within the tunnel. It must contain exactly one IPv4 CIDR block and up to one IPv6 CIDR block. The IPv4 CIDR block must be /29 size and must be within 169.254.0.0/16 range, with exception of: 169.254.0.0/29, 169.254.1.0/29, 169.254.2.0/29, 169.254.3.0/29, 169.254.4.0/29, 169.254.5.0/29, 169.254.169.248/29. The IPv6 CIDR block must be /125 size and must be within fd00::/8. The first IP from each CIDR block is assigned for customer gateway, the second and third is for Transit Gateway (An example: from range 169.254.100.0/29, .1 is assigned to customer gateway and .2 and .3 are assigned to Transit Gateway) * `peer_address` - (Required) The IP addressed assigned to customer device, which will be used as tunnel endpoint. It can be IPv4 or IPv6 address, but must be the same address family as `transit_gateway_address` @@ -94,4 +95,4 @@ Using `terraform import`, import `aws_ec2_transit_gateway_connect_peer` using th % terraform import aws_ec2_transit_gateway_connect_peer.example tgw-connect-peer-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ec2_transit_gateway_default_route_table_association.html.markdown b/website/docs/cdktf/python/r/ec2_transit_gateway_default_route_table_association.html.markdown index bdd9930bfd1e..c5617058776c 100644 --- a/website/docs/cdktf/python/r/ec2_transit_gateway_default_route_table_association.html.markdown +++ b/website/docs/cdktf/python/r/ec2_transit_gateway_default_route_table_association.html.markdown @@ -35,8 +35,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `transit_gateway_id` - (Required) ID of the Transit Gateway to change the default association route table on. * `transit_gateway_route_table_id` - (Required) ID of the Transit Gateway Route Table to be made the default association route table. @@ -52,4 +53,4 @@ This resource exports no additional attributes. * `update` - (Default `5m`) * `delete` - (Default `5m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ec2_transit_gateway_default_route_table_propagation.html.markdown b/website/docs/cdktf/python/r/ec2_transit_gateway_default_route_table_propagation.html.markdown index 3b6b12ce17a6..2eb334f8788e 100644 --- a/website/docs/cdktf/python/r/ec2_transit_gateway_default_route_table_propagation.html.markdown +++ b/website/docs/cdktf/python/r/ec2_transit_gateway_default_route_table_propagation.html.markdown @@ -35,8 +35,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `transit_gateway_id` - (Required) ID of the Transit Gateway to change the default association route table on. * `transit_gateway_route_table_id` - (Required) ID of the Transit Gateway Route Table to be made the default association route table. @@ -52,4 +53,4 @@ This resource exports no additional attributes. * `update` - (Default `5m`) * `delete` - (Default `5m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ec2_transit_gateway_multicast_domain.html.markdown b/website/docs/cdktf/python/r/ec2_transit_gateway_multicast_domain.html.markdown index 234308bc1df1..ccc047cb9e11 100644 --- a/website/docs/cdktf/python/r/ec2_transit_gateway_multicast_domain.html.markdown +++ b/website/docs/cdktf/python/r/ec2_transit_gateway_multicast_domain.html.markdown @@ -143,6 +143,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `transit_gateway_id` - (Required) EC2 Transit Gateway identifier. The EC2 Transit Gateway must have `multicast_support` enabled. * `auto_accept_shared_associations` - (Optional) Whether to automatically accept cross-account subnet associations that are associated with the EC2 Transit Gateway Multicast Domain. Valid values: `disable`, `enable`. Default value: `disable`. * `igmpv2_support` - (Optional) Whether to enable Internet Group Management Protocol (IGMP) version 2 for the EC2 Transit Gateway Multicast Domain. Valid values: `disable`, `enable`. Default value: `disable`. @@ -190,4 +191,4 @@ Using `terraform import`, import `aws_ec2_transit_gateway_multicast_domain` usin % terraform import aws_ec2_transit_gateway_multicast_domain.example tgw-mcast-domain-12345 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ec2_transit_gateway_multicast_domain_association.html.markdown b/website/docs/cdktf/python/r/ec2_transit_gateway_multicast_domain_association.html.markdown index bce08a6b5552..f7477a2b6e7d 100644 --- a/website/docs/cdktf/python/r/ec2_transit_gateway_multicast_domain_association.html.markdown +++ b/website/docs/cdktf/python/r/ec2_transit_gateway_multicast_domain_association.html.markdown @@ -60,6 +60,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `subnet_id` - (Required) The ID of the subnet to associate with the transit gateway multicast domain. * `transit_gateway_attachment_id` - (Required) The ID of the transit gateway attachment. * `transit_gateway_multicast_domain_id` - (Required) The ID of the transit gateway multicast domain. @@ -77,4 +78,4 @@ This resource exports the following attributes in addition to the arguments abov - `create` - (Default `10m`) - `delete` - (Default `10m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ec2_transit_gateway_multicast_group_member.html.markdown b/website/docs/cdktf/python/r/ec2_transit_gateway_multicast_group_member.html.markdown index 3a4f7cce3f09..394c9e46d076 100644 --- a/website/docs/cdktf/python/r/ec2_transit_gateway_multicast_group_member.html.markdown +++ b/website/docs/cdktf/python/r/ec2_transit_gateway_multicast_group_member.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `group_ip_address` - (Required) The IP address assigned to the transit gateway multicast group. * `network_interface_id` - (Required) The group members' network interface ID to register with the transit gateway multicast group. * `transit_gateway_multicast_domain_id` - (Required) The ID of the transit gateway multicast domain. @@ -48,4 +49,4 @@ This resource exports the following attributes in addition to the arguments abov * `id` - EC2 Transit Gateway Multicast Group Member identifier. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ec2_transit_gateway_multicast_group_source.html.markdown b/website/docs/cdktf/python/r/ec2_transit_gateway_multicast_group_source.html.markdown index 824190e8ff1e..348e0082b073 100644 --- a/website/docs/cdktf/python/r/ec2_transit_gateway_multicast_group_source.html.markdown +++ b/website/docs/cdktf/python/r/ec2_transit_gateway_multicast_group_source.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `group_ip_address` - (Required) The IP address assigned to the transit gateway multicast group. * `network_interface_id` - (Required) The group members' network interface ID to register with the transit gateway multicast group. * `transit_gateway_multicast_domain_id` - (Required) The ID of the transit gateway multicast domain. @@ -48,4 +49,4 @@ This resource exports the following attributes in addition to the arguments abov * `id` - EC2 Transit Gateway Multicast Group Member identifier. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ec2_transit_gateway_peering_attachment.html.markdown b/website/docs/cdktf/python/r/ec2_transit_gateway_peering_attachment.html.markdown index 700c324f43c1..22c64a7016fd 100644 --- a/website/docs/cdktf/python/r/ec2_transit_gateway_peering_attachment.html.markdown +++ b/website/docs/cdktf/python/r/ec2_transit_gateway_peering_attachment.html.markdown @@ -72,6 +72,7 @@ A full example of how to create a Transit Gateway in one AWS account, share it w This resource supports the following arguments: +* `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). * `peer_account_id` - (Optional) Account ID of EC2 Transit Gateway to peer with. Defaults to the account ID the [AWS provider][1] is currently connected to. * `peer_region` - (Required) Region of EC2 Transit Gateway to peer with. * `peer_transit_gateway_id` - (Required) Identifier of EC2 Transit Gateway to peer with. @@ -120,4 +121,4 @@ Using `terraform import`, import `aws_ec2_transit_gateway_peering_attachment` us [1]: /docs/providers/aws/index.html - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ec2_transit_gateway_peering_attachment_accepter.html.markdown b/website/docs/cdktf/python/r/ec2_transit_gateway_peering_attachment_accepter.html.markdown index bc6c9ddfe6be..8722b6ca5ad4 100644 --- a/website/docs/cdktf/python/r/ec2_transit_gateway_peering_attachment_accepter.html.markdown +++ b/website/docs/cdktf/python/r/ec2_transit_gateway_peering_attachment_accepter.html.markdown @@ -40,6 +40,7 @@ A full example of how to create a Transit Gateway in one AWS account, share it w This resource supports the following arguments: +* `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). * `transit_gateway_attachment_id` - (Required) The ID of the EC2 Transit Gateway Peering Attachment to manage. * `tags` - (Optional) Key-value tags for the EC2 Transit Gateway Peering Attachment. 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. @@ -78,4 +79,4 @@ Using `terraform import`, import `aws_ec2_transit_gateway_peering_attachment_acc % terraform import aws_ec2_transit_gateway_peering_attachment_accepter.example tgw-attach-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ec2_transit_gateway_policy_table.html.markdown b/website/docs/cdktf/python/r/ec2_transit_gateway_policy_table.html.markdown index 9d4ef3d85f71..096924e782b7 100644 --- a/website/docs/cdktf/python/r/ec2_transit_gateway_policy_table.html.markdown +++ b/website/docs/cdktf/python/r/ec2_transit_gateway_policy_table.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `transit_gateway_id` - (Required) EC2 Transit Gateway identifier. * `tags` - (Optional) Key-value tags for the EC2 Transit Gateway Policy Table. 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. @@ -75,4 +76,4 @@ Using `terraform import`, import `aws_ec2_transit_gateway_policy_table` using th % terraform import aws_ec2_transit_gateway_policy_table.example tgw-rtb-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ec2_transit_gateway_policy_table_association.html.markdown b/website/docs/cdktf/python/r/ec2_transit_gateway_policy_table_association.html.markdown index bffe7caf4fc1..9d8d39d35b63 100644 --- a/website/docs/cdktf/python/r/ec2_transit_gateway_policy_table_association.html.markdown +++ b/website/docs/cdktf/python/r/ec2_transit_gateway_policy_table_association.html.markdown @@ -36,6 +36,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `transit_gateway_attachment_id` - (Required) Identifier of EC2 Transit Gateway Attachment. * `transit_gateway_policy_table_id` - (Required) Identifier of EC2 Transit Gateway Policy Table. @@ -72,4 +73,4 @@ Using `terraform import`, import `aws_ec2_transit_gateway_policy_table_associati % terraform import aws_ec2_transit_gateway_policy_table_association.example tgw-rtb-12345678_tgw-attach-87654321 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ec2_transit_gateway_prefix_list_reference.html.markdown b/website/docs/cdktf/python/r/ec2_transit_gateway_prefix_list_reference.html.markdown index f497f1dbc0d3..94ce26d14cc8 100644 --- a/website/docs/cdktf/python/r/ec2_transit_gateway_prefix_list_reference.html.markdown +++ b/website/docs/cdktf/python/r/ec2_transit_gateway_prefix_list_reference.html.markdown @@ -65,6 +65,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `blackhole` - (Optional) Indicates whether to drop traffic that matches the Prefix List. Defaults to `false`. * `transit_gateway_attachment_id` - (Optional) Identifier of EC2 Transit Gateway Attachment. @@ -99,4 +100,4 @@ Using `terraform import`, import `aws_ec2_transit_gateway_prefix_list_reference` % terraform import aws_ec2_transit_gateway_prefix_list_reference.example tgw-rtb-12345678_pl-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ec2_transit_gateway_route.html.markdown b/website/docs/cdktf/python/r/ec2_transit_gateway_route.html.markdown index 28135adfd164..df61058e9fca 100644 --- a/website/docs/cdktf/python/r/ec2_transit_gateway_route.html.markdown +++ b/website/docs/cdktf/python/r/ec2_transit_gateway_route.html.markdown @@ -60,6 +60,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `destination_cidr_block` - (Required) IPv4 or IPv6 RFC1924 CIDR used for destination matches. Routing decisions are based on the most specific match. * `transit_gateway_attachment_id` - (Optional) Identifier of EC2 Transit Gateway Attachment (required if `blackhole` is set to false). * `blackhole` - (Optional) Indicates whether to drop traffic that matches this route (default to `false`). @@ -96,4 +97,4 @@ Using `terraform import`, import `aws_ec2_transit_gateway_route` using the EC2 T % terraform import aws_ec2_transit_gateway_route.example tgw-rtb-12345678_0.0.0.0/0 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ec2_transit_gateway_route_table.html.markdown b/website/docs/cdktf/python/r/ec2_transit_gateway_route_table.html.markdown index e2b5eb9da98a..49f43a79e2e6 100644 --- a/website/docs/cdktf/python/r/ec2_transit_gateway_route_table.html.markdown +++ b/website/docs/cdktf/python/r/ec2_transit_gateway_route_table.html.markdown @@ -35,6 +35,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `transit_gateway_id` - (Required) Identifier of EC2 Transit Gateway. * `tags` - (Optional) Key-value tags for the EC2 Transit Gateway Route Table. 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. @@ -73,4 +74,4 @@ Using `terraform import`, import `aws_ec2_transit_gateway_route_table` using the % terraform import aws_ec2_transit_gateway_route_table.example tgw-rtb-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ec2_transit_gateway_route_table_association.html.markdown b/website/docs/cdktf/python/r/ec2_transit_gateway_route_table_association.html.markdown index 34b68757f82e..b590b2679664 100644 --- a/website/docs/cdktf/python/r/ec2_transit_gateway_route_table_association.html.markdown +++ b/website/docs/cdktf/python/r/ec2_transit_gateway_route_table_association.html.markdown @@ -36,6 +36,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `transit_gateway_attachment_id` - (Required) Identifier of EC2 Transit Gateway Attachment. * `transit_gateway_route_table_id` - (Required) Identifier of EC2 Transit Gateway Route Table. * `replace_existing_association` - (Optional) Boolean whether the Gateway Attachment should remove any current Route Table association before associating with the specified Route Table. Default value: `false`. This argument is intended for use with EC2 Transit Gateways shared into the current account, otherwise the `transit_gateway_default_route_table_association` argument of the `aws_ec2_transit_gateway_vpc_attachment` resource should be used. @@ -73,4 +74,4 @@ Using `terraform import`, import `aws_ec2_transit_gateway_route_table_associatio % terraform import aws_ec2_transit_gateway_route_table_association.example tgw-rtb-12345678_tgw-attach-87654321 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ec2_transit_gateway_route_table_propagation.html.markdown b/website/docs/cdktf/python/r/ec2_transit_gateway_route_table_propagation.html.markdown index 61ffd4dbc36b..888bddc5f2c4 100644 --- a/website/docs/cdktf/python/r/ec2_transit_gateway_route_table_propagation.html.markdown +++ b/website/docs/cdktf/python/r/ec2_transit_gateway_route_table_propagation.html.markdown @@ -36,6 +36,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `transit_gateway_attachment_id` - (Required) Identifier of EC2 Transit Gateway Attachment. * `transit_gateway_route_table_id` - (Required) Identifier of EC2 Transit Gateway Route Table. @@ -72,4 +73,4 @@ Using `terraform import`, import `aws_ec2_transit_gateway_route_table_propagatio % terraform import aws_ec2_transit_gateway_route_table_propagation.example tgw-rtb-12345678_tgw-attach-87654321 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ec2_transit_gateway_vpc_attachment.html.markdown b/website/docs/cdktf/python/r/ec2_transit_gateway_vpc_attachment.html.markdown index 341aa7c453fa..8319d5634fee 100644 --- a/website/docs/cdktf/python/r/ec2_transit_gateway_vpc_attachment.html.markdown +++ b/website/docs/cdktf/python/r/ec2_transit_gateway_vpc_attachment.html.markdown @@ -39,6 +39,7 @@ A full example of how to create a Transit Gateway in one AWS account, share it w This resource supports the following arguments: +* `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). * `subnet_ids` - (Required) Identifiers of EC2 Subnets. * `transit_gateway_id` - (Required) Identifier of EC2 Transit Gateway. * `vpc_id` - (Required) Identifier of EC2 VPC. @@ -84,4 +85,4 @@ Using `terraform import`, import `aws_ec2_transit_gateway_vpc_attachment` using % terraform import aws_ec2_transit_gateway_vpc_attachment.example tgw-attach-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ec2_transit_gateway_vpc_attachment_accepter.html.markdown b/website/docs/cdktf/python/r/ec2_transit_gateway_vpc_attachment_accepter.html.markdown index 66f43fa1baca..38314444ec35 100644 --- a/website/docs/cdktf/python/r/ec2_transit_gateway_vpc_attachment_accepter.html.markdown +++ b/website/docs/cdktf/python/r/ec2_transit_gateway_vpc_attachment_accepter.html.markdown @@ -46,6 +46,7 @@ A full example of how to create a Transit Gateway in one AWS account, share it w This resource supports the following arguments: +* `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). * `transit_gateway_attachment_id` - (Required) The ID of the EC2 Transit Gateway Attachment to manage. * `transit_gateway_default_route_table_association` - (Optional) Boolean whether the VPC Attachment should be associated with the EC2 Transit Gateway association default route table. Default value: `true`. * `transit_gateway_default_route_table_propagation` - (Optional) Boolean whether the VPC Attachment should propagate routes with the EC2 Transit Gateway propagation default route table. Default value: `true`. @@ -91,4 +92,4 @@ Using `terraform import`, import `aws_ec2_transit_gateway_vpc_attachment_accepte % terraform import aws_ec2_transit_gateway_vpc_attachment_accepter.example tgw-attach-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ecr_account_setting.html.markdown b/website/docs/cdktf/python/r/ecr_account_setting.html.markdown index 616ca7a0c1ee..294d20d100c6 100644 --- a/website/docs/cdktf/python/r/ecr_account_setting.html.markdown +++ b/website/docs/cdktf/python/r/ecr_account_setting.html.markdown @@ -58,6 +58,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) Name of the account setting. One of: `BASIC_SCAN_TYPE_VERSION`, `REGISTRY_POLICY_SCOPE`. * `value` - (Required) Setting value that is specified. Valid values are: * If `name` is specified as `BASIC_SCAN_TYPE_VERSION`, one of: `AWS_NATIVE`, `CLAIR`. @@ -94,4 +95,4 @@ Using `terraform import`, import EMR Security Configurations using the account s % terraform import aws_ecr_account_setting.foo BASIC_SCAN_TYPE_VERSION ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ecr_lifecycle_policy.html.markdown b/website/docs/cdktf/python/r/ecr_lifecycle_policy.html.markdown index 3452b85fa483..c4d6eff0dd41 100644 --- a/website/docs/cdktf/python/r/ecr_lifecycle_policy.html.markdown +++ b/website/docs/cdktf/python/r/ecr_lifecycle_policy.html.markdown @@ -74,6 +74,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `repository` - (Required) Name of the repository to apply the policy. * `policy` - (Required) The policy document. This is a JSON formatted string. See more details about [Policy Parameters](http://docs.aws.amazon.com/AmazonECR/latest/userguide/LifecyclePolicies.html#lifecycle_policy_parameters) in the official AWS docs. Consider using the [`aws_ecr_lifecycle_policy_document` data_source](/docs/providers/aws/d/ecr_lifecycle_policy_document.html) to generate/manage the JSON document used for the `policy` argument. @@ -86,6 +87,32 @@ This resource exports the following attributes in addition to the arguments abov ## Import +In Terraform v1.12.0 and later, the [`import` block](https://developer.hashicorp.com/terraform/language/import) can be used with the `identity` attribute. For example: + +```terraform +import { + to = aws_ecr_lifecycle_policy.example + identity = { + repository = "tf-example" + } +} + +resource "aws_ecr_lifecycle_policy" "example" { + ### Configuration omitted for brevity ### +} +``` + +### Identity Schema + +#### Required + +* `repository` - (String) Name of the ECR repository. + +#### Optional + +- `account_id` (String) AWS Account where this resource is managed. +- `region` (String) Region where this resource is managed. + In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import ECR Lifecycle Policy using the name of the repository. For example: ```python @@ -109,4 +136,4 @@ Using `terraform import`, import ECR Lifecycle Policy using the name of the repo % terraform import aws_ecr_lifecycle_policy.example tf-example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ecr_pull_through_cache_rule.html.markdown b/website/docs/cdktf/python/r/ecr_pull_through_cache_rule.html.markdown index 627d7d93d055..9e9c10d10b68 100644 --- a/website/docs/cdktf/python/r/ecr_pull_through_cache_rule.html.markdown +++ b/website/docs/cdktf/python/r/ecr_pull_through_cache_rule.html.markdown @@ -40,6 +40,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `credential_arn` - (Optional) ARN of the Secret which will be used to authenticate against the registry. * `custom_role_arn` - (Optional) The ARN of the IAM role associated with the pull through cache rule. Must be specified if the upstream registry is a cross-account ECR private registry. See [AWS Document - Setting up permissions for cross-account ECR to ECR PTC](https://docs.aws.amazon.com/AmazonECR/latest/userguide/pull-through-cache-private.html). * `ecr_repository_prefix` - (Required, Forces new resource) The repository name prefix to use when caching images from the source registry. Use `ROOT` as the prefix to apply a template to all repositories in your registry that don't have an associated pull through cache rule. @@ -77,4 +78,4 @@ Using `terraform import`, import a pull-through cache rule using the `ecr_reposi % terraform import aws_ecr_pull_through_cache_rule.example ecr-public ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ecr_registry_policy.html.markdown b/website/docs/cdktf/python/r/ecr_registry_policy.html.markdown index 5d92f4a4d004..7e7700bb21fd 100644 --- a/website/docs/cdktf/python/r/ecr_registry_policy.html.markdown +++ b/website/docs/cdktf/python/r/ecr_registry_policy.html.markdown @@ -47,7 +47,7 @@ class MyConvertedCode(TerraformStack): "Principal": { "AWS": "arn:${" + data_aws_partition_current.partition + "}:iam::${" + current.account_id + "}:root" }, - "Resource": ["arn:${" + data_aws_partition_current.partition + "}:ecr:${" + data_aws_region_current.name + "}:${" + current.account_id + "}:repository/*" + "Resource": ["arn:${" + data_aws_partition_current.partition + "}:ecr:${" + data_aws_region_current.region + "}:${" + current.account_id + "}:repository/*" ], "Sid": "testpolicy" } @@ -61,6 +61,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `policy` - (Required) The policy document. This is a JSON formatted string. For more information about building IAM policy documents with Terraform, see the [AWS IAM Policy Document Guide](https://learn.hashicorp.com/terraform/aws/iam-policy) ## Attribute Reference @@ -94,4 +95,4 @@ Using `terraform import`, import ECR Registry Policy using the registry id. For % terraform import aws_ecr_registry_policy.example 123456789012 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ecr_registry_scanning_configuration.html.markdown b/website/docs/cdktf/python/r/ecr_registry_scanning_configuration.html.markdown index 3bc6c7c73ff9..ea00950a3074 100644 --- a/website/docs/cdktf/python/r/ecr_registry_scanning_configuration.html.markdown +++ b/website/docs/cdktf/python/r/ecr_registry_scanning_configuration.html.markdown @@ -81,6 +81,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +- `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). - `scan_type` - (Required) the scanning type to set for the registry. Can be either `ENHANCED` or `BASIC`. - `rule` - (Optional) One or multiple blocks specifying scanning rules to determine which repository filters are used and at what frequency scanning will occur. See [below for schema](#rule). @@ -120,4 +121,4 @@ Using `terraform import`, import ECR Scanning Configurations using the `registry % terraform import aws_ecr_registry_scanning_configuration.example 123456789012 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ecr_replication_configuration.html.markdown b/website/docs/cdktf/python/r/ecr_replication_configuration.html.markdown index 04765013aa98..be405892173b 100644 --- a/website/docs/cdktf/python/r/ecr_replication_configuration.html.markdown +++ b/website/docs/cdktf/python/r/ecr_replication_configuration.html.markdown @@ -129,6 +129,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `replication_configuration` - (Required) Replication configuration for a registry. See [Replication Configuration](#replication-configuration). ### Replication Configuration @@ -181,4 +182,4 @@ Using `terraform import`, import ECR Replication Configuration using the `regist % terraform import aws_ecr_replication_configuration.service 012345678912 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ecr_repository.html.markdown b/website/docs/cdktf/python/r/ecr_repository.html.markdown index 76eab30f6ae5..d37aa19efd1f 100644 --- a/website/docs/cdktf/python/r/ecr_repository.html.markdown +++ b/website/docs/cdktf/python/r/ecr_repository.html.markdown @@ -35,15 +35,45 @@ class MyConvertedCode(TerraformStack): ) ``` +### With Image Tag Mutability Exclusion + +```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.ecr_repository import EcrRepository +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + EcrRepository(self, "example", + image_tag_mutability="IMMUTABLE_WITH_EXCLUSION", + image_tag_mutability_exclusion_filter=[EcrRepositoryImageTagMutabilityExclusionFilter( + filter="latest*", + filter_type="WILDCARD" + ), EcrRepositoryImageTagMutabilityExclusionFilter( + filter="dev-*", + filter_type="WILDCARD" + ) + ], + name="example-repo" + ) +``` + ## Argument Reference This resource supports the following arguments: +* `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). * `name` - (Required) Name of the repository. * `encryption_configuration` - (Optional) Encryption configuration for the repository. See [below for schema](#encryption_configuration). * `force_delete` - (Optional) If `true`, will delete the repository even if it contains images. Defaults to `false`. -* `image_tag_mutability` - (Optional) The tag mutability setting for the repository. Must be one of: `MUTABLE` or `IMMUTABLE`. Defaults to `MUTABLE`. +* `image_tag_mutability` - (Optional) The tag mutability setting for the repository. Must be one of: `MUTABLE`, `IMMUTABLE`, `IMMUTABLE_WITH_EXCLUSION`, or `MUTABLE_WITH_EXCLUSION`. Defaults to `MUTABLE`. +* `image_tag_mutability_exclusion_filter` - (Optional) Configuration block that defines filters to specify which image tags can override the default tag mutability setting. Only applicable when `image_tag_mutability` is set to `IMMUTABLE_WITH_EXCLUSION` or `MUTABLE_WITH_EXCLUSION`. See [below for schema](#image_tag_mutability_exclusion_filter). * `image_scanning_configuration` - (Optional) Configuration block that defines image scanning configuration for the repository. By default, image scanning must be manually triggered. See the [ECR User Guide](https://docs.aws.amazon.com/AmazonECR/latest/userguide/image-scanning.html) for more information about image scanning. * `scan_on_push` - (Required) Indicates whether images are scanned after being pushed to the repository (true) or not scanned (false). * `tags` - (Optional) A 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. @@ -53,6 +83,11 @@ This resource supports the following arguments: * `encryption_type` - (Optional) The encryption type to use for the repository. Valid values are `AES256` or `KMS`. Defaults to `AES256`. * `kms_key` - (Optional) The ARN of the KMS key to use when `encryption_type` is `KMS`. If not specified, uses the default AWS managed key for ECR. +### image_tag_mutability_exclusion_filter + +* `filter` - (Required) The filter pattern to use for excluding image tags from the mutability setting. Must contain only letters, numbers, and special characters (._*-). Each filter can be up to 128 characters long and can contain a maximum of 2 wildcards (*). +* `filter_type` - (Required) The type of filter to use. Must be `WILDCARD`. + ## Attribute Reference This resource exports the following attributes in addition to the arguments above: @@ -70,6 +105,32 @@ This resource exports the following attributes in addition to the arguments abov ## Import +In Terraform v1.12.0 and later, the [`import` block](https://developer.hashicorp.com/terraform/language/import) can be used with the `identity` attribute. For example: + +```terraform +import { + to = aws_ecr_repository.service + identity = { + name = "test-service" + } +} + +resource "aws_ecr_repository" "service" { + ### Configuration omitted for brevity ### +} +``` + +### Identity Schema + +#### Required + +* `name` - (String) Name of the ECR repository. + +#### Optional + +- `account_id` (String) AWS Account where this resource is managed. +- `region` (String) Region where this resource is managed. + In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import ECR Repositories using the `name`. For example: ```python @@ -93,4 +154,4 @@ Using `terraform import`, import ECR Repositories using the `name`. For example: % terraform import aws_ecr_repository.service test-service ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ecr_repository_creation_template.html.markdown b/website/docs/cdktf/python/r/ecr_repository_creation_template.html.markdown index ce186db14c03..802747a5209d 100644 --- a/website/docs/cdktf/python/r/ecr_repository_creation_template.html.markdown +++ b/website/docs/cdktf/python/r/ecr_repository_creation_template.html.markdown @@ -66,12 +66,14 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `prefix` - (Required, Forces new resource) The repository name prefix to match against. Use `ROOT` to match any prefix that doesn't explicitly match another template. * `applied_for` - (Required) Which features this template applies to. Must contain one or more of `PULL_THROUGH_CACHE` or `REPLICATION`. * `custom_role_arn` - (Optional) A custom IAM role to use for repository creation. Required if using repository tags or KMS encryption. * `description` - (Optional) The description for this template. * `encryption_configuration` - (Optional) Encryption configuration for any created repositories. See [below for schema](#encryption_configuration). * `image_tag_mutability` - (Optional) The tag mutability setting for any created repositories. Must be one of: `MUTABLE` or `IMMUTABLE`. Defaults to `MUTABLE`. +* `image_tag_mutability_exclusion_filter` - (Optional) Configuration block that defines filters to specify which image tags can override the default tag mutability setting. Only applicable when `image_tag_mutability` is set to `IMMUTABLE_WITH_EXCLUSION` or `MUTABLE_WITH_EXCLUSION`. See [below for schema](#image_tag_mutability_exclusion_filter). * `lifecycle_policy` - (Optional) The lifecycle policy document to apply to any created repositories. See more details about [Policy Parameters](http://docs.aws.amazon.com/AmazonECR/latest/userguide/LifecyclePolicies.html#lifecycle_policy_parameters) in the official AWS docs. Consider using the [`aws_ecr_lifecycle_policy_document` data_source](/docs/providers/aws/d/ecr_lifecycle_policy_document.html) to generate/manage the JSON document used for the `lifecycle_policy` argument. * `repository_policy` - (Optional) The registry policy document to apply to any created repositories. This is a JSON formatted string. For more information about building IAM policy documents with Terraform, see the [AWS IAM Policy Document Guide](https://learn.hashicorp.com/terraform/aws/iam-policy). * `resource_tags` - (Optional) A map of tags to assign to any created repositories. @@ -81,6 +83,11 @@ This resource supports the following arguments: * `encryption_type` - (Optional) The encryption type to use for any created repositories. Valid values are `AES256` or `KMS`. Defaults to `AES256`. * `kms_key` - (Optional) The ARN of the KMS key to use when `encryption_type` is `KMS`. If not specified, uses the default AWS managed key for ECR. +### image_tag_mutability_exclusion_filter + +* `filter` - (Required) The filter pattern to use for excluding image tags from the mutability setting. Must contain only letters, numbers, and special characters (._*-). Each filter can be up to 128 characters long and can contain a maximum of 2 wildcards (*). +* `filter_type` - (Required) The type of filter to use. Must be `WILDCARD`. + ## Attribute Reference This resource exports the following attributes in addition to the arguments above: @@ -112,4 +119,4 @@ Using `terraform import`, import the ECR Repository Creating Templates using the % terraform import aws_ecr_repository_creation_template.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ecr_repository_policy.html.markdown b/website/docs/cdktf/python/r/ecr_repository_policy.html.markdown index ebd15bc02ac0..a441c730777f 100644 --- a/website/docs/cdktf/python/r/ecr_repository_policy.html.markdown +++ b/website/docs/cdktf/python/r/ecr_repository_policy.html.markdown @@ -61,6 +61,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `repository` - (Required) Name of the repository to apply the policy. * `policy` - (Required) The policy document. This is a JSON formatted string. For more information about building IAM policy documents with Terraform, see the [AWS IAM Policy Document Guide](https://learn.hashicorp.com/terraform/aws/iam-policy) @@ -73,6 +74,32 @@ This resource exports the following attributes in addition to the arguments abov ## Import +In Terraform v1.12.0 and later, the [`import` block](https://developer.hashicorp.com/terraform/language/import) can be used with the `identity` attribute. For example: + +```terraform +import { + to = aws_ecr_repository_policy.example + identity = { + repository = "example" + } +} + +resource "aws_ecr_repository_policy" "example" { + ### Configuration omitted for brevity ### +} +``` + +### Identity Schema + +#### Required + +* `repository` - (String) Name of the ECR repository. + +#### Optional + +- `account_id` (String) AWS Account where this resource is managed. +- `region` (String) Region where this resource is managed. + In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import ECR Repository Policy using the repository name. For example: ```python @@ -96,4 +123,4 @@ Using `terraform import`, import ECR Repository Policy using the repository name % terraform import aws_ecr_repository_policy.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ecrpublic_repository.html.markdown b/website/docs/cdktf/python/r/ecrpublic_repository.html.markdown index 2aa5552eac0b..7b4d1ade3eef 100644 --- a/website/docs/cdktf/python/r/ecrpublic_repository.html.markdown +++ b/website/docs/cdktf/python/r/ecrpublic_repository.html.markdown @@ -54,6 +54,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `repository_name` - (Required) Name of the repository. * `catalog_data` - (Optional) Catalog data configuration for the repository. See [below for schema](#catalog_data). * `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. @@ -108,4 +109,4 @@ Using `terraform import`, import ECR Public Repositories using the `repository_n % terraform import aws_ecrpublic_repository.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ecrpublic_repository_policy.html.markdown b/website/docs/cdktf/python/r/ecrpublic_repository_policy.html.markdown index 03ef58999381..f8353d20317a 100644 --- a/website/docs/cdktf/python/r/ecrpublic_repository_policy.html.markdown +++ b/website/docs/cdktf/python/r/ecrpublic_repository_policy.html.markdown @@ -63,6 +63,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `repository_name` - (Required) Name of the repository to apply the policy. * `policy` - (Required) The policy document. This is a JSON formatted string. For more information about building IAM policy documents with Terraform, see the [AWS IAM Policy Document Guide](https://learn.hashicorp.com/terraform/aws/iam-policy) @@ -97,4 +98,4 @@ Using `terraform import`, import ECR Public Repository Policy using the reposito % terraform import aws_ecrpublic_repository_policy.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ecs_account_setting_default.html.markdown b/website/docs/cdktf/python/r/ecs_account_setting_default.html.markdown index d5e514d82d54..78eb921e0775 100644 --- a/website/docs/cdktf/python/r/ecs_account_setting_default.html.markdown +++ b/website/docs/cdktf/python/r/ecs_account_setting_default.html.markdown @@ -62,6 +62,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) Name of the account setting to set. * `value` - (Required) State of the setting. @@ -69,7 +70,6 @@ This resource supports the following arguments: This resource exports the following attributes in addition to the arguments above: -* `id` - ARN that identifies the account setting. * `prinicpal_arn` - ARN that identifies the account setting. ## Import @@ -97,4 +97,4 @@ Using `terraform import`, import ECS Account Setting defaults using the `name`. % terraform import aws_ecs_account_setting_default.example taskLongArnFormat ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ecs_capacity_provider.html.markdown b/website/docs/cdktf/python/r/ecs_capacity_provider.html.markdown index 8aae409d1ce3..e31665c717a7 100644 --- a/website/docs/cdktf/python/r/ecs_capacity_provider.html.markdown +++ b/website/docs/cdktf/python/r/ecs_capacity_provider.html.markdown @@ -29,7 +29,7 @@ from imports.aws.ecs_capacity_provider import EcsCapacityProvider class MyConvertedCode(TerraformStack): def __init__(self, scope, name, *, maxSize, minSize): super().__init__(scope, name) - test = AutoscalingGroup(self, "test", + example = AutoscalingGroup(self, "example", tag=[AutoscalingGroupTag( key="AmazonECSManaged", propagate_at_launch=True, @@ -39,9 +39,9 @@ class MyConvertedCode(TerraformStack): max_size=max_size, min_size=min_size ) - aws_ecs_capacity_provider_test = EcsCapacityProvider(self, "test_1", + aws_ecs_capacity_provider_example = EcsCapacityProvider(self, "example_1", auto_scaling_group_provider=EcsCapacityProviderAutoScalingGroupProvider( - auto_scaling_group_arn=test.arn, + auto_scaling_group_arn=example.arn, managed_scaling=EcsCapacityProviderAutoScalingGroupProviderManagedScaling( maximum_scaling_step_size=1000, minimum_scaling_step_size=1, @@ -50,16 +50,17 @@ class MyConvertedCode(TerraformStack): ), managed_termination_protection="ENABLED" ), - name="test" + name="example" ) # 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_ecs_capacity_provider_test.override_logical_id("test") + aws_ecs_capacity_provider_example.override_logical_id("example") ``` ## Argument Reference This resource supports the following arguments: +* `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). * `auto_scaling_group_provider` - (Required) Configuration block for the provider for the ECS auto scaling group. Detailed below. * `name` - (Required) Name of the capacity provider. * `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. @@ -86,12 +87,11 @@ This resource supports the following arguments: This resource exports the following attributes in addition to the arguments above: * `arn` - ARN that identifies the capacity provider. -* `id` - ARN that identifies the capacity provider. * `tags_all` - Map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). ## Import -In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import ECS Capacity Providers using the `name`. For example: +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import ECS Capacity Providers using the `arn`. For example: ```python # DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -105,13 +105,13 @@ from imports.aws.ecs_capacity_provider import EcsCapacityProvider class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) - EcsCapacityProvider.generate_config_for_import(self, "example", "example") + EcsCapacityProvider.generate_config_for_import(self, "example", "arn:aws:ecs:us-west-2:123456789012:capacity-provider/example") ``` -Using `terraform import`, import ECS Capacity Providers using the `name`. For example: +Using `terraform import`, import ECS Capacity Providers using the `arn`. For example: ```console -% terraform import aws_ecs_capacity_provider.example example +% terraform import aws_ecs_capacity_provider.example arn:aws:ecs:us-west-2:123456789012:capacity-provider/example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ecs_cluster.html.markdown b/website/docs/cdktf/python/r/ecs_cluster.html.markdown index b10c3cb1be3c..05f924c8a92e 100644 --- a/website/docs/cdktf/python/r/ecs_cluster.html.markdown +++ b/website/docs/cdktf/python/r/ecs_cluster.html.markdown @@ -170,6 +170,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `configuration` - (Optional) Execute command configuration for the cluster. See [`configuration` Block](#configuration-block) for details. * `service_connect_defaults` - (Optional) Default Service Connect namespace. See [`service_connect_defaults` Block](#service_connect_defaults-block) for details. * `setting` - (Optional) Configuration block(s) with cluster settings. For example, this can be used to enable CloudWatch Container Insights for a cluster. See [`setting` Block](#setting-block) for details. @@ -225,7 +226,6 @@ The `setting` configuration block supports the following arguments: This resource exports the following attributes in addition to the arguments above: * `arn` - ARN that identifies the cluster. -* `id` - ARN that identifies the cluster. * `tags_all` - Map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). ## Import @@ -253,4 +253,4 @@ Using `terraform import`, import ECS clusters using the cluster name. For exampl % terraform import aws_ecs_cluster.stateless stateless-app ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ecs_cluster_capacity_providers.html.markdown b/website/docs/cdktf/python/r/ecs_cluster_capacity_providers.html.markdown index 4a3fcbbc918c..b328449b35e4 100644 --- a/website/docs/cdktf/python/r/ecs_cluster_capacity_providers.html.markdown +++ b/website/docs/cdktf/python/r/ecs_cluster_capacity_providers.html.markdown @@ -51,6 +51,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `capacity_providers` - (Optional) Set of names of one or more capacity providers to associate with the cluster. Valid values also include `FARGATE` and `FARGATE_SPOT`. * `cluster_name` - (Required, Forces new resource) Name of the ECS cluster to manage capacity providers for. * `default_capacity_provider_strategy` - (Optional) Set of capacity provider strategies to use by default for the cluster. Detailed below. @@ -92,4 +93,4 @@ Using `terraform import`, import ECS cluster capacity providers using the `clust % terraform import aws_ecs_cluster_capacity_providers.example my-cluster ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ecs_service.html.markdown b/website/docs/cdktf/python/r/ecs_service.html.markdown index 211e2b07fb17..3270f7e7e77f 100644 --- a/website/docs/cdktf/python/r/ecs_service.html.markdown +++ b/website/docs/cdktf/python/r/ecs_service.html.markdown @@ -152,6 +152,31 @@ class MyConvertedCode(TerraformStack): ) ``` +### Blue/Green Deployment with SIGINT Rollback + +```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.ecs_service import EcsService +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + EcsService(self, "example", + cluster=Token.as_string(aws_ecs_cluster_example.id), + deployment_configuration=EcsServiceDeploymentConfiguration( + strategy="BLUE_GREEN" + ), + name="example", + sigint_rollback=True, + wait_for_steady_state=True + ) +``` + ### Redeploy Service On Every Apply The key used with `triggers` is arbitrary. @@ -185,11 +210,13 @@ The following arguments are required: The following arguments are optional: +* `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). * `alarms` - (Optional) Information about the CloudWatch alarms. [See below](#alarms). * `availability_zone_rebalancing` - (Optional) ECS automatically redistributes tasks within a service across Availability Zones (AZs) to mitigate the risk of impaired application availability due to underlying infrastructure failures and task lifecycle activities. The valid values are `ENABLED` and `DISABLED`. Defaults to `DISABLED`. * `capacity_provider_strategy` - (Optional) Capacity provider strategies to use for the service. Can be one or more. These can be updated without destroying and recreating the service only if `force_new_deployment = true` and not changing from 0 `capacity_provider_strategy` blocks to greater than 0, or vice versa. [See below](#capacity_provider_strategy). Conflicts with `launch_type`. * `cluster` - (Optional) ARN of an ECS cluster. * `deployment_circuit_breaker` - (Optional) Configuration block for deployment circuit breaker. [See below](#deployment_circuit_breaker). +* `deployment_configuration` - (Optional) Configuration block for deployment settings. [See below](#deployment_configuration). * `deployment_controller` - (Optional) Configuration block for deployment controller configuration. [See below](#deployment_controller). * `deployment_maximum_percent` - (Optional) Upper limit (as a percentage of the service's desiredCount) of the number of running tasks that can be running in a service during a deployment. Not valid when using the `DAEMON` scheduling strategy. * `deployment_minimum_healthy_percent` - (Optional) Lower limit (as a percentage of the service's desiredCount) of the number of running tasks that must remain running and healthy in a service during a deployment. @@ -210,6 +237,7 @@ The following arguments are optional: * `scheduling_strategy` - (Optional) Scheduling strategy to use for the service. The valid values are `REPLICA` and `DAEMON`. Defaults to `REPLICA`. Note that [*Tasks using the Fargate launch type or the `CODE_DEPLOY` or `EXTERNAL` deployment controller types don't support the `DAEMON` scheduling strategy*](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html). * `service_connect_configuration` - (Optional) ECS Service Connect configuration for this service to discover and connect to services, and be discovered by, and connected from, other services within a namespace. [See below](#service_connect_configuration). * `service_registries` - (Optional) Service discovery registries for the service. The maximum number of `service_registries` blocks is `1`. [See below](#service_registries). +* `sigint_rollback` - (Optional) Whether to enable graceful termination of deployments using SIGINT signals. When enabled, allows customers to safely cancel an in-progress deployment and automatically trigger a rollback to the previous stable state. Defaults to `false`. Only applicable when using `ECS` deployment controller and requires `wait_for_steady_state = true`. * `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. * `task_definition` - (Optional) Family and revision (`family:revision`) or full ARN of the task definition that you want to run in your service. Required unless using the `EXTERNAL` deployment controller. If a revision is not specified, the latest `ACTIVE` revision is used. * `triggers` - (Optional) Map of arbitrary keys and values that, when changed, will trigger an in-place update (redeployment). Useful with `plantimestamp()`. See example above. @@ -264,6 +292,22 @@ The `capacity_provider_strategy` configuration block supports the following: * `capacity_provider` - (Required) Short name of the capacity provider. * `weight` - (Required) Relative percentage of the total number of launched tasks that should use the specified capacity provider. +### deployment_configuration + +The `deployment_configuration` configuration block supports the following: + +* `strategy` - (Optional) Type of deployment strategy. Valid values: `ROLLING`, `BLUE_GREEN`. Default: `ROLLING`. +* `bake_time_in_minutes` - (Optional) Number of minutes to wait after a new deployment is fully provisioned before terminating the old deployment. Only used when `strategy` is set to `BLUE_GREEN`. +* `lifecycle_hook` - (Optional) Configuration block for lifecycle hooks that are invoked during deployments. [See below](#lifecycle_hook). + +### lifecycle_hook + +The `lifecycle_hook` configuration block supports the following: + +* `hook_target_arn` - (Required) ARN of the Lambda function to invoke for the lifecycle hook. +* `role_arn` - (Required) ARN of the IAM role that grants the service permission to invoke the Lambda function. +* `lifecycle_stages` - (Required) Stages during the deployment when the hook should be invoked. Valid values: `RECONCILE_SERVICE`, `PRE_SCALE_UP`, `POST_SCALE_UP`, `TEST_TRAFFIC_SHIFT`, `POST_TEST_TRAFFIC_SHIFT`, `PRODUCTION_TRAFFIC_SHIFT`, `POST_PRODUCTION_TRAFFIC_SHIFT`. + ### deployment_circuit_breaker The `deployment_circuit_breaker` configuration block supports the following: @@ -285,9 +329,19 @@ The `deployment_controller` configuration block supports the following: * `target_group_arn` - (Required for ALB/NLB) ARN of the Load Balancer target group to associate with the service. * `container_name` - (Required) Name of the container to associate with the load balancer (as it appears in a container definition). * `container_port` - (Required) Port on the container to associate with the load balancer. +* `advanced_configuration` - (Optional) Configuration block for Blue/Green deployment settings. Required when using `BLUE_GREEN` deployment strategy. [See below](#advanced_configuration). -> **Version note:** Multiple `load_balancer` configuration block support was added in Terraform AWS Provider version 2.22.0. This allows configuration of [ECS service support for multiple target groups](https://aws.amazon.com/about-aws/whats-new/2019/07/amazon-ecs-services-now-support-multiple-load-balancer-target-groups/). +### advanced_configuration + +The `advanced_configuration` configuration block supports the following: + +* `alternate_target_group_arn` - (Required) ARN of the alternate target group to use for Blue/Green deployments. +* `production_listener_rule` - (Required) ARN of the listener rule that routes production traffic. +* `role_arn` - (Required) ARN of the IAM role that allows ECS to manage the target groups. +* `test_listener_rule` - (Optional) ARN of the listener rule that routes test traffic. + ### network_configuration `network_configuration` support the following: @@ -354,7 +408,7 @@ For more information, see [Task Networking](https://docs.aws.amazon.com/AmazonEC `service` supports the following: -* `client_alias` - (Optional) List of client aliases for this Service Connect service. You use these to assign names that can be used by client applications. The maximum number of client aliases that you can have in this list is 1. [See below](#client_alias). +* `client_alias` - (Optional) List of client aliases for this Service Connect service. You use these to assign names that can be used by client applications. For each service block where enabled is true, exactly one `client_alias` with one `port` should be specified. [See below](#client_alias). * `discovery_name` - (Optional) Name of the new AWS Cloud Map service that Amazon ECS creates for this Amazon ECS service. * `ingress_port_override` - (Optional) Port number for the Service Connect proxy to listen on. * `port_name` - (Required) Name of one of the `portMappings` from all the containers in the task definition of this Amazon ECS service. @@ -388,6 +442,26 @@ For more information, see [Task Networking](https://docs.aws.amazon.com/AmazonEC * `dns_name` - (Optional) Name that you use in the applications of client tasks to connect to this service. * `port` - (Required) Listening port number for the Service Connect proxy. This port is available inside of all of the tasks within the same namespace. +* `test_traffic_rules` - (Optional) Configuration block for test traffic routing rules. [See below](#test_traffic_rules). + +### test_traffic_rules + +The `test_traffic_rules` configuration block supports the following: + +* `header` - (Optional) Configuration block for header-based routing rules. [See below](#header). + +### header + +The `header` configuration block supports the following: + +* `name` - (Required) Name of the HTTP header to match. +* `value` - (Required) Configuration block for header value matching criteria. [See below](#value). + +### value + +The `value` configuration block supports the following: + +* `exact` - (Required) Exact string value to match in the header. ### tag_specifications @@ -401,7 +475,7 @@ For more information, see [Task Networking](https://docs.aws.amazon.com/AmazonEC This resource exports the following attributes in addition to the arguments above: -* `id` - ARN that identifies the service. +* `arn` - ARN that identifies the service. * `tags_all` - A map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). ## Timeouts @@ -437,4 +511,4 @@ Using `terraform import`, import ECS services using the `name` together with ecs % terraform import aws_ecs_service.imported cluster-name/service-name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ecs_tag.html.markdown b/website/docs/cdktf/python/r/ecs_tag.html.markdown index 660a77242f94..6afe82cc9f29 100644 --- a/website/docs/cdktf/python/r/ecs_tag.html.markdown +++ b/website/docs/cdktf/python/r/ecs_tag.html.markdown @@ -32,7 +32,7 @@ class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) example = BatchComputeEnvironment(self, "example", - compute_environment_name="example", + name="example", service_role=Token.as_string(aws_iam_role_example.arn), type="UNMANAGED" ) @@ -49,6 +49,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `resource_arn` - (Required) Amazon Resource Name (ARN) of the ECS resource to tag. * `key` - (Required) Tag name. * `value` - (Required) Tag value. @@ -84,4 +85,4 @@ Using `terraform import`, import `aws_ecs_tag` using the ECS resource identifier % terraform import aws_ecs_tag.example arn:aws:ecs:us-east-1:123456789012:cluster/example,Name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ecs_task_definition.html.markdown b/website/docs/cdktf/python/r/ecs_task_definition.html.markdown index 3c3b8dfbd148..7dd077fcb83d 100644 --- a/website/docs/cdktf/python/r/ecs_task_definition.html.markdown +++ b/website/docs/cdktf/python/r/ecs_task_definition.html.markdown @@ -198,7 +198,7 @@ resource "aws_secretsmanager_secret_version" "test" { } ``` -### Example Using `container_definitions` and `inference_accelerator` +### Example Using `container_definitions` ```python # DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -213,13 +213,8 @@ class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) EcsTaskDefinition(self, "test", - container_definitions="[\n {\n \"cpu\": 10,\n \"command\": [\"sleep\", \"10\"],\n \"entryPoint\": [\"/\"],\n \"environment\": [\n {\"name\": \"VARNAME\", \"value\": \"VARVAL\"}\n ],\n \"essential\": true,\n \"image\": \"jenkins\",\n \"memory\": 128,\n \"name\": \"jenkins\",\n \"portMappings\": [\n {\n \"containerPort\": 80,\n \"hostPort\": 8080\n }\n ],\n \"resourceRequirements\":[\n {\n \"type\":\"InferenceAccelerator\",\n \"value\":\"device_1\"\n }\n ]\n }\n]\n\n", - family="test", - inference_accelerator=[EcsTaskDefinitionInferenceAccelerator( - device_name="device_1", - device_type="eia1.medium" - ) - ] + container_definitions="[\n {\n \"cpu\": 10,\n \"command\": [\"sleep\", \"10\"],\n \"entryPoint\": [\"/\"],\n \"environment\": [\n {\"name\": \"VARNAME\", \"value\": \"VARVAL\"}\n ],\n \"essential\": true,\n \"image\": \"jenkins\",\n \"memory\": 128,\n \"name\": \"jenkins\",\n \"portMappings\": [\n {\n \"containerPort\": 80,\n \"hostPort\": 8080\n }\n ]\n }\n]\n\n", + family="test" ) ``` @@ -260,12 +255,10 @@ The following arguments are required: The following arguments are optional: +* `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). * `cpu` - (Optional) Number of cpu units used by the task. If the `requires_compatibilities` is `FARGATE` this field is required. * `enable_fault_injection` - (Optional) Enables fault injection and allows for fault injection requests to be accepted from the task's containers. Default is `false`. - - **Note:** Fault injection only works with tasks using the `awsvpc` or `host` network modes. Fault injection isn't available on Windows. * `execution_role_arn` - (Optional) ARN of the task execution role that the Amazon ECS container agent and the Docker daemon can assume. -* `inference_accelerator` - (Optional) Configuration block(s) with Inference Accelerators settings. [Detailed below.](#inference_accelerator) * `ipc_mode` - (Optional) IPC resource namespace to be used for the containers in the task The valid values are `host`, `task`, and `none`. * `memory` - (Optional) Amount (in MiB) of memory used by the task. If the `requires_compatibilities` is `FARGATE` this field is required. * `network_mode` - (Optional) Docker networking mode to use for the containers in the task. Valid values are `none`, `bridge`, `awsvpc`, and `host`. @@ -283,6 +276,8 @@ The following arguments are optional: ~> **NOTE:** Proper escaping is required for JSON field values containing quotes (`"`) such as `environment` values. If directly setting the JSON, they should be escaped as `\"` in the JSON, e.g., `"value": "I \"love\" escaped quotes"`. If using a Terraform variable value, they should be escaped as `\\\"` in the variable, e.g., `value = "I \\\"love\\\" escaped quotes"` in the variable and `"value": "${var.myvariable}"` in the JSON. +~> **Note:** Fault injection only works with tasks using the `awsvpc` or `host` network modes. Fault injection isn't available on Windows. + ### volume * `docker_volume_configuration` - (Optional) Configuration block to configure a [docker volume](#docker_volume_configuration). Detailed below. @@ -351,11 +346,6 @@ For more information, see [Specifying an FSX Windows File Server volume in your * `size_in_gib` - (Required) The total amount, in GiB, of ephemeral storage to set for the task. The minimum supported value is `21` GiB and the maximum supported value is `200` GiB. -### inference_accelerator - -* `device_name` - (Required) Elastic Inference accelerator device name. The deviceName must also be referenced in a container definition as a ResourceRequirement. -* `device_type` - (Required) Elastic Inference accelerator type to use. - ## Attribute Reference This resource exports the following attributes in addition to the arguments above: @@ -390,4 +380,4 @@ Using `terraform import`, import ECS Task Definitions using their ARNs. For exam % terraform import aws_ecs_task_definition.example arn:aws:ecs:us-east-1:012345678910:task-definition/mytaskfamily:123 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ecs_task_set.html.markdown b/website/docs/cdktf/python/r/ecs_task_set.html.markdown index 7ecd5c246cd9..8123407572cd 100644 --- a/website/docs/cdktf/python/r/ecs_task_set.html.markdown +++ b/website/docs/cdktf/python/r/ecs_task_set.html.markdown @@ -81,6 +81,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `capacity_provider_strategy` - (Optional) The capacity provider strategy to use for the service. Can be one or more. [Defined below](#capacity_provider_strategy). * `external_id` - (Optional) The external ID associated with the task set. * `force_delete` - (Optional) Whether to allow deleting the task set without waiting for scaling down to 0. You can force a task set to delete even if it's in the process of scaling a resource. Normally, Terraform drains all the tasks before deleting the task set. This bypasses that behavior and potentially leaves resources dangling. @@ -175,4 +176,4 @@ Using `terraform import`, import ECS Task Sets using the `task_set_id`, `service % terraform import aws_ecs_task_set.example ecs-svc/7177320696926227436,arn:aws:ecs:us-west-2:123456789101:service/example/example-1234567890,arn:aws:ecs:us-west-2:123456789101:cluster/example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/efs_access_point.html.markdown b/website/docs/cdktf/python/r/efs_access_point.html.markdown index 43e5fa3ea9e9..e5803faec35c 100644 --- a/website/docs/cdktf/python/r/efs_access_point.html.markdown +++ b/website/docs/cdktf/python/r/efs_access_point.html.markdown @@ -35,6 +35,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `file_system_id` - (Required) ID of the file system for which the access point is intended. * `posix_user` - (Optional) Operating system user and group applied to all file system requests made using the access point. [Detailed](#posix_user) below. * `root_directory`- (Optional) Directory on the Amazon EFS file system that the access point provides access to. [Detailed](#root_directory) below. @@ -95,4 +96,4 @@ Using `terraform import`, import the EFS access points using the `id`. For examp % terraform import aws_efs_access_point.test fsap-52a643fb ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/efs_backup_policy.html.markdown b/website/docs/cdktf/python/r/efs_backup_policy.html.markdown index 24e8c0a639f6..8ce041290a19 100644 --- a/website/docs/cdktf/python/r/efs_backup_policy.html.markdown +++ b/website/docs/cdktf/python/r/efs_backup_policy.html.markdown @@ -43,6 +43,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `file_system_id` - (Required) The ID of the EFS file system. * `backup_policy` - (Required) A backup_policy object (documented below). @@ -83,4 +84,4 @@ Using `terraform import`, import the EFS backup policies using the `id`. For exa % terraform import aws_efs_backup_policy.example fs-6fa144c6 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/efs_file_system.html.markdown b/website/docs/cdktf/python/r/efs_file_system.html.markdown index d6326b42e817..f283d94285a3 100644 --- a/website/docs/cdktf/python/r/efs_file_system.html.markdown +++ b/website/docs/cdktf/python/r/efs_file_system.html.markdown @@ -63,6 +63,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `availability_zone_name` - (Optional) the AWS Availability Zone in which to create the file system. Used to create a file system that uses One Zone storage classes. See [user guide](https://docs.aws.amazon.com/efs/latest/ug/availability-durability.html) for more information. * `creation_token` - (Optional) A unique name (a maximum of 64 characters are allowed) used as reference when creating the Elastic File System to ensure idempotent file @@ -140,4 +141,4 @@ Using `terraform import`, import the EFS file systems using the `id`. For exampl % terraform import aws_efs_file_system.foo fs-6fa144c6 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/efs_file_system_policy.html.markdown b/website/docs/cdktf/python/r/efs_file_system_policy.html.markdown index 6362b31ab69e..f890bc90b0d6 100644 --- a/website/docs/cdktf/python/r/efs_file_system_policy.html.markdown +++ b/website/docs/cdktf/python/r/efs_file_system_policy.html.markdown @@ -69,6 +69,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `bypass_policy_lockout_safety_check` - (Optional) A flag to indicate whether to bypass the `aws_efs_file_system_policy` lockout safety check. The policy lockout safety check determines whether the policy in the request will prevent the principal making the request will be locked out from making future `PutFileSystemPolicy` requests on the file system. Set `bypass_policy_lockout_safety_check` to `true` only when you intend to prevent the principal that is making the request from making a subsequent `PutFileSystemPolicy` request on the file system. The default value is `false`. ## Attribute Reference @@ -102,4 +103,4 @@ Using `terraform import`, import the EFS file system policies using the `id`. Fo % terraform import aws_efs_file_system_policy.foo fs-6fa144c6 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/efs_mount_target.html.markdown b/website/docs/cdktf/python/r/efs_mount_target.html.markdown index 68a7c2b3a350..a67b2328ae3f 100644 --- a/website/docs/cdktf/python/r/efs_mount_target.html.markdown +++ b/website/docs/cdktf/python/r/efs_mount_target.html.markdown @@ -48,10 +48,13 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `file_system_id` - (Required) The ID of the file system for which the mount target is intended. * `subnet_id` - (Required) The ID of the subnet to add the mount target in. * `ip_address` - (Optional) The address (within the address range of the specified subnet) at which the file system may be mounted via the mount target. +* `ip_address_type` - (Optional) IP address type for the mount target. Valid values are `IPV4_ONLY` (only IPv4 addresses), `IPV6_ONLY` (only IPv6 addresses), and `DUAL_STACK` (dual-stack, both IPv4 and IPv6 addresses). Defaults to `IPV4_ONLY`. +* `ipv6_address` - (Optional) IPv6 address to use. Valid only when `ip_address_type` is set to `IPV6_ONLY` or `DUAL_STACK`. * `security_groups` - (Optional) A list of up to 5 VPC security group IDs (that must be for the same VPC as subnet specified) in effect for the mount target. @@ -104,4 +107,4 @@ Using `terraform import`, import the EFS mount targets using the `id`. For examp % terraform import aws_efs_mount_target.alpha fsmt-52a643fb ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/efs_replication_configuration.html.markdown b/website/docs/cdktf/python/r/efs_replication_configuration.html.markdown index f37dc65c81ce..9dc8b9368d4c 100644 --- a/website/docs/cdktf/python/r/efs_replication_configuration.html.markdown +++ b/website/docs/cdktf/python/r/efs_replication_configuration.html.markdown @@ -102,6 +102,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `destination` - (Required) A destination configuration block (documented below). * `source_file_system_id` - (Required) The ID of the file system that is to be replicated. @@ -157,4 +158,4 @@ Using `terraform import`, import EFS Replication Configurations using the file s % terraform import aws_efs_replication_configuration.example fs-id ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/egress_only_internet_gateway.html.markdown b/website/docs/cdktf/python/r/egress_only_internet_gateway.html.markdown index 528d8eed14c7..dbabde4fd8eb 100644 --- a/website/docs/cdktf/python/r/egress_only_internet_gateway.html.markdown +++ b/website/docs/cdktf/python/r/egress_only_internet_gateway.html.markdown @@ -48,6 +48,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `vpc_id` - (Required) The VPC ID to create in. * `tags` - (Optional) A 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. @@ -83,4 +84,4 @@ Using `terraform import`, import Egress-only Internet gateways using the `id`. F % terraform import aws_egress_only_internet_gateway.example eigw-015e0e244e24dfe8a ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/eip.html.markdown b/website/docs/cdktf/python/r/eip.html.markdown index 9c346ded412a..fd65fd4d0807 100644 --- a/website/docs/cdktf/python/r/eip.html.markdown +++ b/website/docs/cdktf/python/r/eip.html.markdown @@ -158,6 +158,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `address` - (Optional) IP address from an EC2 BYOIP pool. This option is only available for VPC EIPs. * `associate_with_private_ip` - (Optional) User-specified primary or secondary private IP address to associate with the Elastic IP address. If no private IP address is specified, the Elastic IP address is associated with the primary private IP address. * `customer_owned_ipv4_pool` - (Optional) ID of a customer-owned address pool. For more on customer owned IP addressed check out [Customer-owned IP addresses guide](https://docs.aws.amazon.com/outposts/latest/userguide/outposts-networking-components.html#ip-addressing). @@ -169,13 +170,12 @@ This resource supports the following arguments: * `public_ipv4_pool` - (Optional) EC2 IPv4 address pool identifier or `amazon`. This option is only available for VPC EIPs. * `tags` - (Optional) Map of tags to assign to the resource. Tags can only be applied to EIPs in a VPC. 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. -* `vpc` - (Optional **Deprecated**) Boolean if the EIP is in a VPC or not. Use `domain` instead. - Defaults to `true` unless the region supports EC2-Classic. -~> **NOTE:** You can specify either the `instance` ID or the `network_interface` ID, but not both. Including both will **not** return an error from the AWS API, but will have undefined behavior. See the relevant [AssociateAddress API Call][1] for more information. +~> **NOTE:** You can specify either the `instance` ID or the `network_interface` ID, but not both. +Including both will **not** return an error from the AWS API, but will have undefined behavior. +See the relevant [AssociateAddress API Call][1] for more information. -~> **NOTE:** Specifying both `public_ipv4_pool` and `address` won't cause an error but `address` will be used in the -case both options are defined as the api only requires one or the other. +~> **NOTE:** Specifying both `public_ipv4_pool` and `address` won't cause an error, however, only `address` will be used if both options are defined as the API only requires one of the two. ## Attribute Reference @@ -230,4 +230,4 @@ Using `terraform import`, import EIPs in a VPC using their Allocation ID. For ex [1]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_AssociateAddress.html - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/eip_association.html.markdown b/website/docs/cdktf/python/r/eip_association.html.markdown index 0c0d7065d79d..be2da022b985 100644 --- a/website/docs/cdktf/python/r/eip_association.html.markdown +++ b/website/docs/cdktf/python/r/eip_association.html.markdown @@ -53,6 +53,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `allocation_id` - (Optional, Forces new resource) ID of the associated Elastic IP. This argument is required despite being optional at the resource level due to legacy support for EC2-Classic networking. * `allow_reassociation` - (Optional, Forces new resource) Whether to allow an Elastic IP address to be re-associated. @@ -98,4 +99,4 @@ Using `terraform import`, import EIP Assocations using their association IDs. Fo % terraform import aws_eip_association.test eipassoc-ab12c345 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/eip_domain_name.html.markdown b/website/docs/cdktf/python/r/eip_domain_name.html.markdown index 1ee3bd505295..77deef86f457 100644 --- a/website/docs/cdktf/python/r/eip_domain_name.html.markdown +++ b/website/docs/cdktf/python/r/eip_domain_name.html.markdown @@ -51,6 +51,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `allocation_id` - (Required) The allocation ID. * `domain_name` - (Required) The domain name to modify for the IP address. @@ -68,4 +69,4 @@ This resource exports the following attributes in addition to the arguments abov - `update` - (Default `10m`) - `delete` - (Default `10m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/eks_access_entry.html.markdown b/website/docs/cdktf/python/r/eks_access_entry.html.markdown index e7829d076372..de7c21766e3b 100644 --- a/website/docs/cdktf/python/r/eks_access_entry.html.markdown +++ b/website/docs/cdktf/python/r/eks_access_entry.html.markdown @@ -38,12 +38,13 @@ class MyConvertedCode(TerraformStack): The following arguments are required: -* `cluster_name` – (Required) Name of the EKS Cluster. -* `principal_arn` – (Required) The IAM Principal ARN which requires Authentication access to the EKS cluster. +* `cluster_name` - (Required) Name of the EKS Cluster. +* `principal_arn` - (Required) The IAM Principal ARN which requires Authentication access to the EKS cluster. The following arguments are optional: -* `kubernetes_groups` – (Optional) List of string which can optionally specify the Kubernetes groups the user would belong to when creating an access entry. +* `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). +* `kubernetes_groups` - (Optional) List of string which can optionally specify the Kubernetes groups the user would belong to when creating an access entry. * `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. * `type` - (Optional) Defaults to STANDARD which provides the standard workflow. EC2_LINUX, EC2_WINDOWS, FARGATE_LINUX types disallow users to input a username or groups, and prevent associations. * `user_name` - (Optional) Defaults to principal ARN if user is principal else defaults to assume-role/session-name is role is used. @@ -90,4 +91,4 @@ Using `terraform import`, import EKS access entry using the `cluster_name` and ` % terraform import aws_eks_access_entry.my_eks_access_entry my_cluster_name:my_principal_arn ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/eks_access_policy_association.html.markdown b/website/docs/cdktf/python/r/eks_access_policy_association.html.markdown index 60ff40395477..d2080e934a63 100644 --- a/website/docs/cdktf/python/r/eks_access_policy_association.html.markdown +++ b/website/docs/cdktf/python/r/eks_access_policy_association.html.markdown @@ -39,12 +39,13 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This resource supports the following arguments: -* `cluster_name` – (Required) Name of the EKS Cluster. -* `policy_arn` – (Required) The ARN of the access policy that you're associating. -* `principal_arn` – (Required) The IAM Principal ARN which requires Authentication access to the EKS cluster. -* `access_scope` – (Required) The configuration block to determine the scope of the access. See [`access_scope` Block](#access_scope-block) below. +* `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). +* `cluster_name` - (Required) Name of the EKS Cluster. +* `policy_arn` - (Required) The ARN of the access policy that you're associating. +* `principal_arn` - (Required) The IAM Principal ARN which requires Authentication access to the EKS cluster. +* `access_scope` - (Required) The configuration block to determine the scope of the access. See [`access_scope` Block](#access_scope-block) below. ### `access_scope` Block @@ -99,4 +100,4 @@ Using `terraform import`, import EKS access entry using the `cluster_name` `prin % terraform import aws_eks_access_policy_association.my_eks_access_entry my_cluster_name#my_principal_arn#my_policy_arn ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/eks_addon.html.markdown b/website/docs/cdktf/python/r/eks_addon.html.markdown index e8907003162f..151f22ee9529 100644 --- a/website/docs/cdktf/python/r/eks_addon.html.markdown +++ b/website/docs/cdktf/python/r/eks_addon.html.markdown @@ -189,20 +189,21 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This resource supports the following arguments: -* `addon_name` – (Required) Name of the EKS add-on. The name must match one of +* `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). +* `addon_name` - (Required) Name of the EKS add-on. The name must match one of the names returned by [describe-addon-versions](https://docs.aws.amazon.com/cli/latest/reference/eks/describe-addon-versions.html). -* `cluster_name` – (Required) Name of the EKS Cluster. +* `cluster_name` - (Required) Name of the EKS Cluster. The following arguments are optional: -* `addon_version` – (Optional) The version of the EKS add-on. The version must +* `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). +* `addon_version` - (Optional) The version of the EKS add-on. The version must match one of the versions returned by [describe-addon-versions](https://docs.aws.amazon.com/cli/latest/reference/eks/describe-addon-versions.html). * `configuration_values` - (Optional) custom configuration values for addons with single JSON string. This JSON string value must match the JSON schema derived from [describe-addon-configuration](https://docs.aws.amazon.com/cli/latest/reference/eks/describe-addon-configuration.html). -* `resolve_conflicts_on_create` - (Optional) How to resolve field value conflicts when migrating a self-managed add-on to an Amazon EKS add-on. Valid values are `NONE` and `OVERWRITE`. For more details see the [CreateAddon](https://docs.aws.amazon.com/eks/latest/APIReference/API_CreateAddon.html) API Docs. -* `resolve_conflicts_on_update` - (Optional) How to resolve field value conflicts for an Amazon EKS add-on if you've changed a value from the Amazon EKS default value. Valid values are `NONE`, `OVERWRITE`, and `PRESERVE`. For more details see the [UpdateAddon](https://docs.aws.amazon.com/eks/latest/APIReference/API_UpdateAddon.html) API Docs. -* `resolve_conflicts` - (**Deprecated** use the `resolve_conflicts_on_create` and `resolve_conflicts_on_update` attributes instead) Define how to resolve parameter value conflicts when migrating an existing add-on to an Amazon EKS add-on or when applying version updates to the add-on. Valid values are `NONE`, `OVERWRITE` and `PRESERVE`. Note that `PRESERVE` is only valid on addon update, not for initial addon creation. If you need to set this to `PRESERVE`, use the `resolve_conflicts_on_create` and `resolve_conflicts_on_update` attributes instead. For more details check [UpdateAddon](https://docs.aws.amazon.com/eks/latest/APIReference/API_UpdateAddon.html) API Docs. +* `resolve_conflicts_on_create` - (Optional) How to resolve field value conflicts when migrating a self-managed add-on to an Amazon EKS add-on. Valid values are `NONE` and `OVERWRITE`. For more details see the [CreateAddon](https://docs.aws.amazon.com/eks/latest/APIReference/API_CreateAddon.html) API Documentation. +* `resolve_conflicts_on_update` - (Optional) How to resolve field value conflicts for an Amazon EKS add-on if you've changed a value from the Amazon EKS default value. Valid values are `NONE`, `OVERWRITE`, and `PRESERVE`. For more details see the [UpdateAddon](https://docs.aws.amazon.com/eks/latest/APIReference/API_UpdateAddon.html) API Documentation. * `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. * `pod_identity_association` - (Optional) Configuration block with EKS Pod Identity association settings. See [`pod_identity_association`](#pod-identity-association) below for details. * `preserve` - (Optional) Indicates if you want to preserve the created resources when deleting the EKS add-on. @@ -267,4 +268,4 @@ Using `terraform import`, import EKS add-on using the `cluster_name` and `addon_ % terraform import aws_eks_addon.my_eks_addon my_cluster_name:my_addon_name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/eks_cluster.html.markdown b/website/docs/cdktf/python/r/eks_cluster.html.markdown index a409223810fd..1a2abe6bb275 100644 --- a/website/docs/cdktf/python/r/eks_cluster.html.markdown +++ b/website/docs/cdktf/python/r/eks_cluster.html.markdown @@ -301,7 +301,7 @@ class MyConvertedCode(TerraformStack): The following arguments are required: -* `name` – (Required) Name of the cluster. Must be between 1-100 characters in length. Must begin with an alphanumeric character, and must only contain alphanumeric characters, dashes and underscores (`^[0-9A-Za-z][A-Za-z0-9\-_]*$`). +* `name` - (Required) Name of the cluster. Must be between 1-100 characters in length. Must begin with an alphanumeric character, and must only contain alphanumeric characters, dashes and underscores (`^[0-9A-Za-z][A-Za-z0-9\-_]*$`). * `role_arn` - (Required) ARN of the IAM role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. Ensure the resource configuration includes explicit dependencies on the IAM Role permissions by adding [`depends_on`](https://www.terraform.io/docs/configuration/meta-arguments/depends_on.html) if using the [`aws_iam_role_policy` resource](/docs/providers/aws/r/iam_role_policy.html) or [`aws_iam_role_policy_attachment` resource](/docs/providers/aws/r/iam_role_policy_attachment.html), otherwise EKS cannot delete EKS managed EC2 infrastructure such as Security Groups on EKS Cluster deletion. * `vpc_config` - (Required) Configuration block for the VPC associated with your cluster. Amazon EKS VPC resources have specific requirements to work properly with Kubernetes. For more information, see [Cluster VPC Considerations](https://docs.aws.amazon.com/eks/latest/userguide/network_reqs.html) and [Cluster Security Group Considerations](https://docs.aws.amazon.com/eks/latest/userguide/sec-group-reqs.html) in the Amazon EKS User Guide. Detailed below. Also contains attributes detailed in the Attributes section. @@ -310,16 +310,18 @@ The following arguments are optional: * `access_config` - (Optional) Configuration block for the access config associated with your cluster, see [Amazon EKS Access Entries](https://docs.aws.amazon.com/eks/latest/userguide/access-entries.html). [Detailed](#access_config) below. * `bootstrap_self_managed_addons` - (Optional) Install default unmanaged add-ons, such as `aws-cni`, `kube-proxy`, and CoreDNS during cluster creation. If `false`, you must manually install desired add-ons. Changing this value will force a new cluster to be created. Defaults to `true`. * `compute_config` - (Optional) Configuration block with compute configuration for EKS Auto Mode. [Detailed](#compute_config) below. +* `deletion_protection` - (Optional) Whether to enable deletion protection for the cluster. When enabled, the cluster cannot be deleted unless deletion protection is first disabled. Default: `false`. * `enabled_cluster_log_types` - (Optional) List of the desired control plane logging to enable. For more information, see [Amazon EKS Control Plane Logging](https://docs.aws.amazon.com/eks/latest/userguide/control-plane-logs.html). * `encryption_config` - (Optional) Configuration block with encryption configuration for the cluster. [Detailed](#encryption_config) below. * `force_update_version` - (Optional) Force version update by overriding upgrade-blocking readiness checks when updating a cluster. * `kubernetes_network_config` - (Optional) Configuration block with kubernetes network configuration for the cluster. [Detailed](#kubernetes_network_config) below. If removed, Terraform will only perform drift detection if a configuration value is provided. * `outpost_config` - (Optional) Configuration block representing the configuration of your local Amazon EKS cluster on an AWS Outpost. This block isn't available for creating Amazon EKS clusters on the AWS cloud. +* `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). * `remote_network_config` - (Optional) Configuration block with remote network configuration for EKS Hybrid Nodes. [Detailed](#remote_network_config) below. * `storage_config` - (Optional) Configuration block with storage configuration for EKS Auto Mode. [Detailed](#storage_config) below. * `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. * `upgrade_policy` - (Optional) Configuration block for the support policy to use for the cluster. See [upgrade_policy](#upgrade_policy) for details. -* `version` – (Optional) Desired Kubernetes master version. If you do not specify a value, the latest available version at resource creation is used and no upgrades will occur except those automatically triggered by EKS. The value must be configured and increased to upgrade the version when desired. Downgrades are not supported by EKS. +* `version` - (Optional) Desired Kubernetes master version. If you do not specify a value, the latest available version at resource creation is used and no upgrades will occur except those automatically triggered by EKS. The value must be configured and increased to upgrade the version when desired. Downgrades are not supported by EKS. * `zonal_shift_config` - (Optional) Configuration block with zonal shift configuration for the cluster. [Detailed](#zonal_shift_config) below. ### access_config @@ -327,7 +329,7 @@ The following arguments are optional: The `access_config` configuration block supports the following arguments: * `authentication_mode` - (Optional) The authentication mode for the cluster. Valid values are `CONFIG_MAP`, `API` or `API_AND_CONFIG_MAP` -* `bootstrap_cluster_creator_admin_permissions` - (Optional) Whether or not to bootstrap the access config values to the cluster. Default is `false`. +* `bootstrap_cluster_creator_admin_permissions` - (Optional) Whether or not to bootstrap the access config values to the cluster. Default is `true`. ### compute_config @@ -375,8 +377,8 @@ The `remote_pod_networks` configuration block supports the following arguments: * `endpoint_private_access` - (Optional) Whether the Amazon EKS private API server endpoint is enabled. Default is `false`. * `endpoint_public_access` - (Optional) Whether the Amazon EKS public API server endpoint is enabled. Default is `true`. * `public_access_cidrs` - (Optional) List of CIDR blocks. Indicates which CIDR blocks can access the Amazon EKS public API server endpoint when enabled. EKS defaults this to a list with `0.0.0.0/0`. Terraform will only perform drift detection of its value when present in a configuration. -* `security_group_ids` – (Optional) List of security group IDs for the cross-account elastic network interfaces that Amazon EKS creates to use to allow communication between your worker nodes and the Kubernetes control plane. -* `subnet_ids` – (Required) List of subnet IDs. Must be in at least two different availability zones. Amazon EKS creates cross-account elastic network interfaces in these subnets to allow communication between your worker nodes and the Kubernetes control plane. +* `security_group_ids` - (Optional) List of security group IDs for the cross-account elastic network interfaces that Amazon EKS creates to use to allow communication between your worker nodes and the Kubernetes control plane. +* `subnet_ids` - (Required) List of subnet IDs. Must be in at least two different availability zones. Amazon EKS creates cross-account elastic network interfaces in these subnets to allow communication between your worker nodes and the Kubernetes control plane. * `vpc_id` - (Computed) ID of the VPC associated with your cluster. ### kubernetes_network_config @@ -507,4 +509,4 @@ Using `terraform import`, import EKS Clusters using the `name`. For example: % terraform import aws_eks_cluster.my_cluster my_cluster ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/eks_fargate_profile.html.markdown b/website/docs/cdktf/python/r/eks_fargate_profile.html.markdown index de56e06e52e0..a68d572261a1 100644 --- a/website/docs/cdktf/python/r/eks_fargate_profile.html.markdown +++ b/website/docs/cdktf/python/r/eks_fargate_profile.html.markdown @@ -78,14 +78,15 @@ class MyConvertedCode(TerraformStack): The following arguments are required: -* `cluster_name` – (Required) Name of the EKS Cluster. -* `fargate_profile_name` – (Required) Name of the EKS Fargate Profile. -* `pod_execution_role_arn` – (Required) Amazon Resource Name (ARN) of the IAM Role that provides permissions for the EKS Fargate Profile. +* `cluster_name` - (Required) Name of the EKS Cluster. +* `fargate_profile_name` - (Required) Name of the EKS Fargate Profile. +* `pod_execution_role_arn` - (Required) Amazon Resource Name (ARN) of the IAM Role that provides permissions for the EKS Fargate Profile. * `selector` - (Required) Configuration block(s) for selecting Kubernetes Pods to execute with this EKS Fargate Profile. Detailed below. -* `subnet_ids` – (Required) Identifiers of private EC2 Subnets to associate with the EKS Fargate Profile. These subnets must have the following resource tag: `kubernetes.io/cluster/CLUSTER_NAME` (where `CLUSTER_NAME` is replaced with the name of the EKS Cluster). +* `subnet_ids` - (Required) Identifiers of private EC2 Subnets to associate with the EKS Fargate Profile. These subnets must have the following resource tag: `kubernetes.io/cluster/CLUSTER_NAME` (where `CLUSTER_NAME` is replaced with the name of the EKS Cluster). The following arguments are optional: +* `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). * `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. ### selector Configuration Block @@ -96,6 +97,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `labels` - (Optional) Key-value map of Kubernetes labels for selection. ## Attribute Reference @@ -139,4 +141,4 @@ Using `terraform import`, import EKS Fargate Profiles using the `cluster_name` a % terraform import aws_eks_fargate_profile.my_fargate_profile my_cluster:my_fargate_profile ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/eks_identity_provider_config.html.markdown b/website/docs/cdktf/python/r/eks_identity_provider_config.html.markdown index 85cc1ea484a4..d39aa7acab17 100644 --- a/website/docs/cdktf/python/r/eks_identity_provider_config.html.markdown +++ b/website/docs/cdktf/python/r/eks_identity_provider_config.html.markdown @@ -40,16 +40,17 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: -* `cluster_name` – (Required) Name of the EKS Cluster. +* `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). +* `cluster_name` - (Required) Name of the EKS Cluster. * `oidc` - (Required) Nested attribute containing [OpenID Connect](https://openid.net/connect/) identity provider information for the cluster. Detailed below. * `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. ### oidc Configuration Block -* `client_id` – (Required) Client ID for the OpenID Connect identity provider. +* `client_id` - (Required) Client ID for the OpenID Connect identity provider. * `groups_claim` - (Optional) The JWT claim that the provider will use to return groups. * `groups_prefix` - (Optional) A prefix that is prepended to group claims e.g., `oidc:`. -* `identity_provider_config_name` – (Required) The name of the identity provider config. +* `identity_provider_config_name` - (Required) The name of the identity provider config. * `issuer_url` - (Required) Issuer URL for the OpenID Connect identity provider. * `required_claims` - (Optional) The key value pairs that describe required claims in the identity token. * `username_claim` - (Optional) The JWT claim that the provider will use as the username. @@ -96,4 +97,4 @@ Using `terraform import`, import EKS Identity Provider Configurations using the % terraform import aws_eks_identity_provider_config.my_identity_provider_config my_cluster:my_identity_provider_config ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/eks_node_group.html.markdown b/website/docs/cdktf/python/r/eks_node_group.html.markdown index 331ed134fccc..aba09c864eae 100644 --- a/website/docs/cdktf/python/r/eks_node_group.html.markdown +++ b/website/docs/cdktf/python/r/eks_node_group.html.markdown @@ -191,13 +191,14 @@ class MyConvertedCode(TerraformStack): The following arguments are required: -* `cluster_name` – (Required) Name of the EKS Cluster. -* `node_role_arn` – (Required) Amazon Resource Name (ARN) of the IAM Role that provides permissions for the EKS Node Group. +* `cluster_name` - (Required) Name of the EKS Cluster. +* `node_role_arn` - (Required) Amazon Resource Name (ARN) of the IAM Role that provides permissions for the EKS Node Group. * `scaling_config` - (Required) Configuration block with scaling settings. See [`scaling_config`](#scaling_config-configuration-block) below for details. -* `subnet_ids` – (Required) Identifiers of EC2 Subnets to associate with the EKS Node Group. +* `subnet_ids` - (Required) Identifiers of EC2 Subnets to associate with the EKS Node Group. The following arguments are optional: +* `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). * `ami_type` - (Optional) Type of Amazon Machine Image (AMI) associated with the EKS Node Group. See the [AWS documentation](https://docs.aws.amazon.com/eks/latest/APIReference/API_Nodegroup.html#AmazonEKS-Type-Nodegroup-amiType) for valid values. Terraform will only perform drift detection if a configuration value is provided. * `capacity_type` - (Optional) Type of capacity associated with the EKS Node Group. Valid values: `ON_DEMAND`, `SPOT`. Terraform will only perform drift detection if a configuration value is provided. * `disk_size` - (Optional) Disk size in GiB for worker nodes. Defaults to `50` for Windows, `20` all other node groups. Terraform will only perform drift detection if a configuration value is provided. @@ -205,15 +206,15 @@ The following arguments are optional: * `instance_types` - (Optional) List of instance types associated with the EKS Node Group. Defaults to `["t3.medium"]`. Terraform will only perform drift detection if a configuration value is provided. * `labels` - (Optional) Key-value map of Kubernetes labels. Only labels that are applied with the EKS API are managed by this argument. Other Kubernetes labels applied to the EKS Node Group will not be managed. * `launch_template` - (Optional) Configuration block with Launch Template settings. See [`launch_template`](#launch_template-configuration-block) below for details. Conflicts with `remote_access`. -* `node_group_name` – (Optional) Name of the EKS Node Group. If omitted, Terraform will assign a random, unique name. Conflicts with `node_group_name_prefix`. The node group name can't be longer than 63 characters. It must start with a letter or digit, but can also include hyphens and underscores for the remaining characters. -* `node_group_name_prefix` – (Optional) Creates a unique name beginning with the specified prefix. Conflicts with `node_group_name`. +* `node_group_name` - (Optional) Name of the EKS Node Group. If omitted, Terraform will assign a random, unique name. Conflicts with `node_group_name_prefix`. The node group name can't be longer than 63 characters. It must start with a letter or digit, but can also include hyphens and underscores for the remaining characters. +* `node_group_name_prefix` - (Optional) Creates a unique name beginning with the specified prefix. Conflicts with `node_group_name`. * `node_repair_config` - (Optional) The node auto repair configuration for the node group. See [`node_repair_config`](#node_repair_config-configuration-block) below for details. -* `release_version` – (Optional) AMI version of the EKS Node Group. Defaults to latest version for Kubernetes version. +* `release_version` - (Optional) AMI version of the EKS Node Group. Defaults to latest version for Kubernetes version. * `remote_access` - (Optional) Configuration block with remote access settings. See [`remote_access`](#remote_access-configuration-block) below for details. Conflicts with `launch_template`. * `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. * `taint` - (Optional) The Kubernetes taints to be applied to the nodes in the node group. Maximum of 50 taints per node group. See [taint](#taint-configuration-block) below for details. * `update_config` - (Optional) Configuration block with update settings. See [`update_config`](#update_config-configuration-block) below for details. -* `version` – (Optional) Kubernetes version. Defaults to EKS Cluster Kubernetes version. Terraform will only perform drift detection if a configuration value is provided. +* `version` - (Optional) Kubernetes version. Defaults to EKS Cluster Kubernetes version. Terraform will only perform drift detection if a configuration value is provided. ### launch_template Configuration Block @@ -297,4 +298,4 @@ Using `terraform import`, import EKS Node Groups using the `cluster_name` and `n % terraform import aws_eks_node_group.my_node_group my_cluster:my_node_group ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/eks_pod_identity_association.html.markdown b/website/docs/cdktf/python/r/eks_pod_identity_association.html.markdown index e2dd9fed63a3..887d9316c21d 100644 --- a/website/docs/cdktf/python/r/eks_pod_identity_association.html.markdown +++ b/website/docs/cdktf/python/r/eks_pod_identity_association.html.markdown @@ -80,7 +80,10 @@ The following arguments are required: The following arguments are optional: +* `disable_session_tags` - (Optional) Disable the tags that are automatically added to role session by Amazon EKS. +* `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). * `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. +* `target_role_arn` - (Optional) The Amazon Resource Name (ARN) of the IAM role to be chained to the the IAM role specified as `role_arn`. ## Attribute Reference @@ -88,6 +91,7 @@ This resource exports the following attributes in addition to the arguments abov * `association_arn` - The Amazon Resource Name (ARN) of the association. * `association_id` - The ID of the association. +* `external_id` - The unique identifier for this association for a target IAM role. You put this value in the trust policy of the target role, in a Condition to match the sts.ExternalId. * `tags_all` - A map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). ## Import @@ -115,4 +119,4 @@ Using `terraform import`, import EKS (Elastic Kubernetes) Pod Identity Associati % terraform import aws_eks_pod_identity_association.example example,a-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/elastic_beanstalk_application.html.markdown b/website/docs/cdktf/python/r/elastic_beanstalk_application.html.markdown index 0640b7b069c4..dcf46e5cefca 100644 --- a/website/docs/cdktf/python/r/elastic_beanstalk_application.html.markdown +++ b/website/docs/cdktf/python/r/elastic_beanstalk_application.html.markdown @@ -46,6 +46,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) The name of the application, must be unique within your account * `description` - (Optional) Short description of the application * `tags` - (Optional) Key-value map of tags for the Elastic Beanstalk Application. 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. @@ -89,4 +90,4 @@ Using `terraform import`, import Elastic Beanstalk Applications using the `name` % terraform import aws_elastic_beanstalk_application.tf_test tf-test-name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/elastic_beanstalk_application_version.html.markdown b/website/docs/cdktf/python/r/elastic_beanstalk_application_version.html.markdown index 696d1052c129..882bbf68d195 100644 --- a/website/docs/cdktf/python/r/elastic_beanstalk_application_version.html.markdown +++ b/website/docs/cdktf/python/r/elastic_beanstalk_application_version.html.markdown @@ -60,7 +60,7 @@ class MyConvertedCode(TerraformStack): application="tf-test-name", bucket=Token.as_string(aws_s3_bucket_default.id), description="application version created by terraform", - key=Token.as_string(aws_s3_object_default.id), + key=Token.as_string(aws_s3_object_default.key), name="tf-test-version-label" ) # This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match. @@ -78,6 +78,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `description` - (Optional) Short description of the Application Version. * `force_delete` - (Optional) On delete, force an Application Version to be deleted when it may be in use by multiple Elastic Beanstalk Environments. * `process` - (Optional) Pre-processes and validates the environment manifest (env.yaml ) and configuration files (*.config files in the .ebextensions folder) in the source bundle. Validating configuration files can identify issues prior to deploying the application version to an environment. You must turn processing on for application versions that you create using AWS CodeBuild or AWS CodeCommit. For application versions built from a source bundle in Amazon S3, processing is optional. It validates Elastic Beanstalk configuration files. It doesn’t validate your application’s configuration files, like proxy server or Docker configuration. @@ -90,4 +91,4 @@ This resource exports the following attributes in addition to the arguments abov * `arn` - ARN assigned by AWS for this Elastic Beanstalk Application. * `tags_all` - Map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/elastic_beanstalk_configuration_template.html.markdown b/website/docs/cdktf/python/r/elastic_beanstalk_configuration_template.html.markdown index b8cb70baaa7d..6005a0943ca4 100644 --- a/website/docs/cdktf/python/r/elastic_beanstalk_configuration_template.html.markdown +++ b/website/docs/cdktf/python/r/elastic_beanstalk_configuration_template.html.markdown @@ -44,14 +44,15 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) A unique name for this Template. -* `application` – (Required) name of the application to associate with this configuration template +* `application` - (Required) name of the application to associate with this configuration template * `description` - (Optional) Short description of the Template -* `environment_id` – (Optional) The ID of the environment used with this configuration template -* `setting` – (Optional) Option settings to configure the new Environment. These +* `environment_id` - (Optional) The ID of the environment used with this configuration template +* `setting` - (Optional) Option settings to configure the new Environment. These override specific values that are set as defaults. The format is detailed below in [Option Settings](#option-settings) -* `solution_stack_name` – (Optional) A solution stack to base your Template +* `solution_stack_name` - (Optional) A solution stack to base your Template off of. Example stacks can be found in the [Amazon API documentation][1] ## Option Settings @@ -76,4 +77,4 @@ This resource exports the following attributes in addition to the arguments abov [1]: https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/concepts.platforms.html - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/elastic_beanstalk_environment.html.markdown b/website/docs/cdktf/python/r/elastic_beanstalk_environment.html.markdown index bcc516fc0114..73ccb55bfabf 100644 --- a/website/docs/cdktf/python/r/elastic_beanstalk_environment.html.markdown +++ b/website/docs/cdktf/python/r/elastic_beanstalk_environment.html.markdown @@ -47,29 +47,30 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) A unique name for this Environment. This name is used in the application URL -* `application` – (Required) Name of the application that contains the version +* `application` - (Required) Name of the application that contains the version to be deployed * `cname_prefix` - (Optional) Prefix to use for the fully qualified DNS name of the Environment. * `description` - (Optional) Short description of the Environment * `tier` - (Optional) Elastic Beanstalk Environment tier. Valid values are `Worker` or `WebServer`. If tier is left blank `WebServer` will be used. -* `setting` – (Optional) Option settings to configure the new Environment. These +* `setting` - (Optional) Option settings to configure the new Environment. These override specific values that are set as defaults. The format is detailed below in [Option Settings](#option-settings) -* `solution_stack_name` – (Optional) A solution stack to base your environment +* `solution_stack_name` - (Optional) A solution stack to base your environment off of. Example stacks can be found in the [Amazon API documentation][1] -* `template_name` – (Optional) The name of the Elastic Beanstalk Configuration +* `template_name` - (Optional) The name of the Elastic Beanstalk Configuration template to use in deployment -* `platform_arn` – (Optional) The [ARN][2] of the Elastic Beanstalk [Platform][3] +* `platform_arn` - (Optional) The [ARN][2] of the Elastic Beanstalk [Platform][3] to use in deployment * `wait_for_ready_timeout` - (Default `20m`) The maximum [duration](https://golang.org/pkg/time/#ParseDuration) that Terraform should wait for an Elastic Beanstalk Environment to be in a ready state before timing out. -* `poll_interval` – The time between polling the AWS API to +* `poll_interval` - The time between polling the AWS API to check if changes have been applied. Use this to adjust the rate of API calls for any `create` or `update` action. Minimum `10s`, maximum `180s`. Omit this to use the default behavior, which is an exponential backoff @@ -134,9 +135,9 @@ This resource exports the following attributes in addition to the arguments abov * `description` - Description of the Elastic Beanstalk Environment. * `tier` - The environment tier specified. * `tags_all` - A map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). -* `application` – The Elastic Beanstalk Application specified for this environment. -* `setting` – Settings specifically set for this Environment. -* `all_settings` – List of all option settings configured in this Environment. These +* `application` - The Elastic Beanstalk Application specified for this environment. +* `setting` - Settings specifically set for this Environment. +* `all_settings` - List of all option settings configured in this Environment. These are a combination of default settings and their overrides from `setting` in the configuration. * `cname` - Fully qualified DNS name for this Environment. @@ -177,4 +178,4 @@ Using `terraform import`, import Elastic Beanstalk Environments using the `id`. % terraform import aws_elastic_beanstalk_environment.prodenv e-rpqsewtp2j ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/elasticache_cluster.html.markdown b/website/docs/cdktf/python/r/elasticache_cluster.html.markdown index bf11a585d0f4..8364dea84fe9 100644 --- a/website/docs/cdktf/python/r/elasticache_cluster.html.markdown +++ b/website/docs/cdktf/python/r/elasticache_cluster.html.markdown @@ -201,26 +201,24 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This resource supports the following arguments: -* `cluster_id` – (Required) Group identifier. ElastiCache converts this name to lowercase. Changing this value will re-create the resource. -* `engine` – (Optional, Required if `replication_group_id` is not specified) Name of the cache engine to be used for this cache cluster. Valid values are `memcached`, `redis` and `valkey`. -* `node_type` – (Required unless `replication_group_id` is provided) The instance class used. +* `cluster_id` - (Required) Group identifier. ElastiCache converts this name to lowercase. Changing this value will re-create the resource. +* `engine` - (Optional, Required if `replication_group_id` is not specified) Name of the cache engine to be used for this cache cluster. Valid values are `memcached`, `redis` and `valkey`. +* `node_type` - (Required unless `replication_group_id` is provided) The instance class used. See AWS documentation for information on [supported node types for Valkey or Redis OSS](https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/CacheNodes.SupportedTypes.html#CacheNodes.CurrentGen) and [guidance on selecting node types for Valkey or Redis OSS](https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/CacheNodes.SelectSize.html#CacheNodes.SelectSize.redis). See AWS documentation for information on [supported node types for Memcached](https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/CacheNodes.SupportedTypes.html#CacheNodes.CurrentGen-Memcached) and [guidance on selecting node types for Memcached](https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/CacheNodes.SelectSize.html#CacheNodes.SelectSize.Mem). For Memcached, changing this value will re-create the resource. -* `num_cache_nodes` – (Required unless `replication_group_id` is provided) The initial number of cache nodes that the cache cluster will have. For Redis, this value must be 1. For Memcached, this value must be between 1 and 40. If this number is reduced on subsequent runs, the highest numbered nodes will be removed. -* `parameter_group_name` – (Required unless `replication_group_id` is provided) The name of the parameter group to associate with this cache cluster. - -The following arguments are optional: - +* `num_cache_nodes` - (Required unless `replication_group_id` is provided) The initial number of cache nodes that the cache cluster will have. For Redis, this value must be 1. For Memcached, this value must be between 1 and 40. If this number is reduced on subsequent runs, the highest numbered nodes will be removed. +* `parameter_group_name` - (Required unless `replication_group_id` is provided) The name of the parameter group to associate with this cache cluster. +* `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). * `apply_immediately` - (Optional) Whether any database modifications are applied immediately, or during the next maintenance window. Default is `false`. See [Amazon ElastiCache Documentation for more information](https://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_ModifyCacheCluster.html). * `auto_minor_version_upgrade` - (Optional) Specifies whether minor version engine upgrades will be applied automatically to the underlying Cache Cluster instances during the maintenance window. Only supported for engine type `"redis"` and if the engine version is 6 or higher. Defaults to `true`. * `availability_zone` - (Optional) Availability Zone for the cache cluster. If you want to create cache nodes in multi-az, use `preferred_availability_zones` instead. Default: System chosen Availability Zone. Changing this value will re-create the resource. * `az_mode` - (Optional, Memcached only) Whether the nodes in this Memcached node group are created in a single Availability Zone or created across multiple Availability Zones in the cluster's region. Valid values for this parameter are `single-az` or `cross-az`, default is `single-az`. If you want to choose `cross-az`, `num_cache_nodes` must be greater than `1`. -* `engine_version` – (Optional) Version number of the cache engine to be used. +* `engine_version` - (Optional) Version number of the cache engine to be used. If not set, defaults to the latest version. See [Describe Cache Engine Versions](https://docs.aws.amazon.com/cli/latest/reference/elasticache/describe-cache-engine-versions.html) in the AWS Documentation for supported versions. When `engine` is `redis` and the version is 7 or higher, the major and minor version should be set, e.g., `7.2`. @@ -231,22 +229,22 @@ The following arguments are optional: * `final_snapshot_identifier` - (Optional, Redis only) Name of your final cluster snapshot. If omitted, no final snapshot will be made. * `ip_discovery` - (Optional) The IP version to advertise in the discovery protocol. Valid values are `ipv4` or `ipv6`. * `log_delivery_configuration` - (Optional, Redis only) Specifies the destination and format of Redis [SLOWLOG](https://redis.io/commands/slowlog) or Redis [Engine Log](https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/Log_Delivery.html#Log_contents-engine-log). See the documentation on [Amazon ElastiCache](https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/Log_Delivery.html). See [Log Delivery Configuration](#log-delivery-configuration) below for more details. -* `maintenance_window` – (Optional) Specifies the weekly time range for when maintenance +* `maintenance_window` - (Optional) Specifies the weekly time range for when maintenance on the cache cluster is performed. The format is `ddd:hh24:mi-ddd:hh24:mi` (24H Clock UTC). The minimum maintenance window is a 60 minute period. Example: `sun:05:00-sun:09:00`. * `network_type` - (Optional) The IP versions for cache cluster connections. IPv6 is supported with Redis engine `6.2` onword or Memcached version `1.6.6` for all [Nitro system](https://aws.amazon.com/ec2/nitro/) instances. Valid values are `ipv4`, `ipv6` or `dual_stack`. -* `notification_topic_arn` – (Optional) ARN of an SNS topic to send ElastiCache notifications to. Example: `arn:aws:sns:us-east-1:012345678999:my_sns_topic`. +* `notification_topic_arn` - (Optional) ARN of an SNS topic to send ElastiCache notifications to. Example: `arn:aws:sns:us-east-1:012345678999:my_sns_topic`. * `outpost_mode` - (Optional) Specify the outpost mode that will apply to the cache cluster creation. Valid values are `"single-outpost"` and `"cross-outpost"`, however AWS currently only supports `"single-outpost"` mode. -* `port` – (Optional) The port number on which each of the cache nodes will accept connections. For Memcached the default is 11211, and for Redis the default port is 6379. Cannot be provided with `replication_group_id`. Changing this value will re-create the resource. +* `port` - (Optional) The port number on which each of the cache nodes will accept connections. For Memcached the default is 11211, and for Redis the default port is 6379. Cannot be provided with `replication_group_id`. Changing this value will re-create the resource. * `preferred_availability_zones` - (Optional, Memcached only) List of the Availability Zones in which cache nodes are created. If you are creating your cluster in an Amazon VPC you can only locate nodes in Availability Zones that are associated with the subnets in the selected subnet group. The number of Availability Zones listed must equal the value of `num_cache_nodes`. If you want all the nodes in the same Availability Zone, use `availability_zone` instead, or repeat the Availability Zone multiple times in the list. Default: System chosen Availability Zones. Detecting drift of existing node availability zone is not currently supported. Updating this argument by itself to migrate existing node availability zones is not currently supported and will show a perpetual difference. * `preferred_outpost_arn` - (Optional, Required if `outpost_mode` is specified) The outpost ARN in which the cache cluster will be created. * `replication_group_id` - (Optional, Required if `engine` is not specified) ID of the replication group to which this cluster should belong. If this parameter is specified, the cluster is added to the specified replication group as a read replica; otherwise, the cluster is a standalone primary that is not part of any replication group. -* `security_group_ids` – (Optional, VPC only) One or more VPC security groups associated with the cache cluster. Cannot be provided with `replication_group_id.` -* `snapshot_arns` – (Optional, Redis only) Single-element string list containing an Amazon Resource Name (ARN) of a Redis RDB snapshot file stored in Amazon S3. The object name cannot contain any commas. Changing `snapshot_arns` forces a new resource. +* `security_group_ids` - (Optional, VPC only) One or more VPC security groups associated with the cache cluster. Cannot be provided with `replication_group_id.` +* `snapshot_arns` - (Optional, Redis only) Single-element string list containing an Amazon Resource Name (ARN) of a Redis RDB snapshot file stored in Amazon S3. The object name cannot contain any commas. Changing `snapshot_arns` forces a new resource. * `snapshot_name` - (Optional, Redis only) Name of a snapshot from which to restore data into the new node group. Changing `snapshot_name` forces a new resource. * `snapshot_retention_limit` - (Optional, Redis only) Number of days for which ElastiCache will retain automatic cache cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, then a snapshot that was taken today will be retained for 5 days before being deleted. If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off. Please note that setting a `snapshot_retention_limit` is not supported on cache.t1.micro cache nodes * `snapshot_window` - (Optional, Redis only) Daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your cache cluster. Example: 05:00-09:00 -* `subnet_group_name` – (Optional, VPC only) Name of the subnet group to be used for the cache cluster. Changing this value will re-create the resource. Cannot be provided with `replication_group_id.` +* `subnet_group_name` - (Optional, VPC only) Name of the subnet group to be used for the cache cluster. Changing this value will re-create the resource. Cannot be provided with `replication_group_id.` * `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. * `transit_encryption_enabled` - (Optional) Enable encryption in-transit. Supported with Memcached versions `1.6.12` and later, Valkey `7.2` and later, Redis OSS versions `3.2.6`, `4.0.10` and later, running in a VPC. See the [ElastiCache in-transit encryption documentation](https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/in-transit-encryption.html#in-transit-encryption-constraints) for more details. @@ -303,4 +301,4 @@ Using `terraform import`, import ElastiCache Clusters using the `cluster_id`. Fo % terraform import aws_elasticache_cluster.my_cluster my_cluster ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/elasticache_global_replication_group.html.markdown b/website/docs/cdktf/python/r/elasticache_global_replication_group.html.markdown index c2ff8bcf76b9..ec23b0c390bd 100644 --- a/website/docs/cdktf/python/r/elasticache_global_replication_group.html.markdown +++ b/website/docs/cdktf/python/r/elasticache_global_replication_group.html.markdown @@ -58,8 +58,7 @@ The initial Redis version is determined by the version set on the primary replic However, once it is part of a Global Replication Group, the Global Replication Group manages the version of all member replication groups. -The member replication groups must have [`lifecycle.ignore_changes[engine_version]`](https://www.terraform.io/language/meta-arguments/lifecycle) set, -or Terraform will always return a diff. +The provider is configured to ignore changes to `engine`, `engine_version` and `parameter_group_name` inside `aws_elasticache_replication_group` resources if they belong to a global replication group. In this example, the primary replication group will be created with Redis 6.0, @@ -68,7 +67,6 @@ The secondary replication group will be created with Redis 6.2. ```python # DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug -from cdktf import TerraformResourceLifecycle, TerraformResourceLifecycle from constructs import Construct from cdktf import TerraformStack # @@ -84,9 +82,6 @@ class MyConvertedCode(TerraformStack): description="primary replication group", engine="redis", engine_version="6.0", - lifecycle=TerraformResourceLifecycle( - ignore_changes=[engine_version] - ), node_type="cache.m5.large", num_cache_clusters=1, replication_group_id="example-primary" @@ -99,9 +94,6 @@ class MyConvertedCode(TerraformStack): ElasticacheReplicationGroup(self, "secondary", description="secondary replication group", global_replication_group_id=example.global_replication_group_id, - lifecycle=TerraformResourceLifecycle( - ignore_changes=[engine_version] - ), num_cache_clusters=1, provider=other_region, replication_group_id="example-secondary" @@ -112,13 +104,19 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `automatic_failover_enabled` - (Optional) Specifies whether read-only replicas will be automatically promoted to read/write primary if the existing primary fails. When creating, by default the Global Replication Group inherits the automatic failover setting of the primary replication group. * `cache_node_type` - (Optional) The instance class used. See AWS documentation for information on [supported node types](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html) and [guidance on selecting node types](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/nodes-select-size.html). When creating, by default the Global Replication Group inherits the node type of the primary replication group. -* `engine_version` - (Optional) Redis version to use for the Global Replication Group. +* `engine` - (Optional) The name of the cache engine to be used for the clusters in this global replication group. + When creating, by default the Global Replication Group inherits the engine of the primary replication group. + If an engine is specified, the Global Replication Group and all member replication groups will be upgraded to this engine. + Valid values are `redis` or `valkey`. + Default is `redis` if `engine_version` is specified. +* `engine_version` - (Optional) Engine version to use for the Global Replication Group. When creating, by default the Global Replication Group inherits the version of the primary replication group. If a version is specified, the Global Replication Group and all member replication groups will be upgraded to this version. Cannot be downgraded without replacing the Global Replication Group and all member replication groups. @@ -126,12 +124,12 @@ This resource supports the following arguments: When the version is 6, the major and minor version can be set, e.g., `6.2`, or the minor version can be unspecified which will use the latest version at creation time, e.g., `6.x`. The actual engine version used is returned in the attribute `engine_version_actual`, see [Attribute Reference](#attribute-reference) below. -* `global_replication_group_id_suffix` – (Required) The suffix name of a Global Datastore. If `global_replication_group_id_suffix` is changed, creates a new resource. -* `primary_replication_group_id` – (Required) The ID of the primary cluster that accepts writes and will replicate updates to the secondary cluster. If `primary_replication_group_id` is changed, creates a new resource. -* `global_replication_group_description` – (Optional) A user-created description for the global replication group. +* `global_replication_group_id_suffix` - (Required) The suffix name of a Global Datastore. If `global_replication_group_id_suffix` is changed, creates a new resource. +* `primary_replication_group_id` - (Required) The ID of the primary cluster that accepts writes and will replicate updates to the secondary cluster. If `primary_replication_group_id` is changed, creates a new resource. +* `global_replication_group_description` - (Optional) A user-created description for the global replication group. * `num_node_groups` - (Optional) The number of node groups (shards) on the global replication group. * `parameter_group_name` - (Optional) An ElastiCache Parameter Group to use for the Global Replication Group. - Required when upgrading a major engine version, but will be ignored if left configured after the upgrade is complete. + Required when upgrading an engine or major engine version, but will be ignored if left configured after the upgrade is complete. Specifying without a major version upgrade will fail. Note that ElastiCache creates a copy of this parameter group for each member replication group. @@ -145,7 +143,6 @@ This resource exports the following attributes in addition to the arguments abov * `at_rest_encryption_enabled` - A flag that indicate whether the encryption at rest is enabled. * `auth_token_enabled` - A flag that indicate whether AuthToken (password) is enabled. * `cluster_enabled` - Indicates whether the Global Datastore is cluster enabled. -* `engine` - The name of the cache engine to be used for the clusters in this global replication group. * `global_replication_group_id` - The full ID of the global replication group. * `global_node_groups` - Set of node groups (shards) on the global replication group. Has the values: @@ -186,4 +183,4 @@ Using `terraform import`, import ElastiCache Global Replication Groups using the % terraform import aws_elasticache_global_replication_group.my_global_replication_group okuqm-global-replication-group-1 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/elasticache_parameter_group.html.markdown b/website/docs/cdktf/python/r/elasticache_parameter_group.html.markdown index 37bf0f1d3159..a6dfc6ca16eb 100644 --- a/website/docs/cdktf/python/r/elasticache_parameter_group.html.markdown +++ b/website/docs/cdktf/python/r/elasticache_parameter_group.html.markdown @@ -46,6 +46,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) The name of the ElastiCache parameter group. * `family` - (Required) The family of the ElastiCache parameter group. * `description` - (Optional) The description of the ElastiCache parameter group. Defaults to "Managed by Terraform". @@ -90,4 +91,4 @@ Using `terraform import`, import ElastiCache Parameter Groups using the `name`. % terraform import aws_elasticache_parameter_group.default redis-params ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/elasticache_replication_group.html.markdown b/website/docs/cdktf/python/r/elasticache_replication_group.html.markdown index e32eff935ae0..982686a996c6 100644 --- a/website/docs/cdktf/python/r/elasticache_replication_group.html.markdown +++ b/website/docs/cdktf/python/r/elasticache_replication_group.html.markdown @@ -252,17 +252,18 @@ class MyConvertedCode(TerraformStack): The following arguments are required: -* `description` – (Required) User-created description for the replication group. Must not be empty. -* `replication_group_id` – (Required) Replication group identifier. This parameter is stored as a lowercase string. +* `description` - (Required) User-created description for the replication group. Must not be empty. +* `replication_group_id` - (Required) Replication group identifier. This parameter is stored as a lowercase string. The following arguments are optional: +* `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). * `apply_immediately` - (Optional) Specifies whether any modifications are applied immediately, or during the next maintenance window. Default is `false`. * `at_rest_encryption_enabled` - (Optional) Whether to enable encryption at rest. When `engine` is `redis`, default is `false`. When `engine` is `valkey`, default is `true`. * `auth_token` - (Optional) Password used to access a password protected server. Can be specified only if `transit_encryption_enabled = true`. -* `auth_token_update_strategy` - (Optional) Strategy to use when updating the `auth_token`. Valid values are `SET`, `ROTATE`, and `DELETE`. Defaults to `ROTATE`. +* `auth_token_update_strategy` - (Optional) Strategy to use when updating the `auth_token`. Valid values are `SET`, `ROTATE`, and `DELETE`. Required if `auth_token` is set. * `auto_minor_version_upgrade` - (Optional) Specifies whether minor version engine upgrades will be applied automatically to the underlying Cache Cluster instances during the maintenance window. Only supported for engine types `"redis"` and `"valkey"` and if the engine version is 6 or higher. Defaults to `true`. @@ -283,7 +284,7 @@ The following arguments are optional: * `ip_discovery` - (Optional) The IP version to advertise in the discovery protocol. Valid values are `ipv4` or `ipv6`. * `kms_key_id` - (Optional) The ARN of the key that you wish to use if encrypting at rest. If not supplied, uses service managed encryption. Can be specified only if `at_rest_encryption_enabled = true`. * `log_delivery_configuration` - (Optional, Redis only) Specifies the destination and format of Redis OSS/Valkey [SLOWLOG](https://redis.io/commands/slowlog) or Redis OSS/Valkey [Engine Log](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Log_Delivery.html#Log_contents-engine-log). See the documentation on [Amazon ElastiCache](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Log_Delivery.html#Log_contents-engine-log). See [Log Delivery Configuration](#log-delivery-configuration) below for more details. -* `maintenance_window` – (Optional) Specifies the weekly time range for when maintenance on the cache cluster is performed. The format is `ddd:hh24:mi-ddd:hh24:mi` (24H Clock UTC). The minimum maintenance window is a 60 minute period. Example: `sun:05:00-sun:09:00` +* `maintenance_window` - (Optional) Specifies the weekly time range for when maintenance on the cache cluster is performed. The format is `ddd:hh24:mi-ddd:hh24:mi` (24H Clock UTC). The minimum maintenance window is a 60 minute period. Example: `sun:05:00-sun:09:00` * `multi_az_enabled` - (Optional) Specifies whether to enable Multi-AZ Support for the replication group. If `true`, `automatic_failover_enabled` must also be enabled. Defaults to `false`. @@ -292,7 +293,7 @@ The following arguments are optional: See AWS documentation for information on [supported node types](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html) and [guidance on selecting node types](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/nodes-select-size.html). Required unless `global_replication_group_id` is set. Cannot be set if `global_replication_group_id` is set. -* `notification_topic_arn` – (Optional) ARN of an SNS topic to send ElastiCache notifications to. Example: `arn:aws:sns:us-east-1:012345678999:my_sns_topic` +* `notification_topic_arn` - (Optional) ARN of an SNS topic to send ElastiCache notifications to. Example: `arn:aws:sns:us-east-1:012345678999:my_sns_topic` * `num_cache_clusters` - (Optional) Number of cache clusters (primary and replicas) this replication group will have. If `automatic_failover_enabled` or `multi_az_enabled` are `true`, must be at least 2. Updates will occur before other modifications. @@ -302,7 +303,7 @@ The following arguments are optional: Changing this number will trigger a resizing operation before other settings modifications. Conflicts with `num_cache_clusters`. * `parameter_group_name` - (Optional) Name of the parameter group to associate with this replication group. If this argument is omitted, the default cache parameter group for the specified engine is used. To enable "cluster mode", i.e., data sharding, use a parameter group that has the parameter `cluster-enabled` set to true. -* `port` – (Optional) Port number on which each of the cache nodes will accept connections. For Memcache the default is 11211, and for Redis the default port is 6379. +* `port` - (Optional) Port number on which each of the cache nodes will accept connections. For Memcache the default is 11211, and for Redis the default port is 6379. * `preferred_cache_cluster_azs` - (Optional) List of EC2 availability zones in which the replication group's cache clusters will be created. The order of the availability zones in the list is considered. The first item in the list will be the primary node. Ignored when updating. * `replicas_per_node_group` - (Optional) Number of replica nodes in each node group. Changing this number will trigger a resizing operation before other settings modifications. @@ -311,7 +312,7 @@ The following arguments are optional: Can only be set if `num_node_groups` is set. * `security_group_ids` - (Optional) IDs of one or more Amazon VPC security groups associated with this replication group. Use this parameter only when you are creating a replication group in an Amazon Virtual Private Cloud. * `security_group_names` - (Optional) Names of one or more Amazon VPC security groups associated with this replication group. Use this parameter only when you are creating a replication group in an Amazon Virtual Private Cloud. -* `snapshot_arns` – (Optional) List of ARNs that identify Redis RDB snapshot files stored in Amazon S3. The names object names cannot contain any commas. +* `snapshot_arns` - (Optional) List of ARNs that identify Redis RDB snapshot files stored in Amazon S3. The names object names cannot contain any commas. * `snapshot_name` - (Optional) Name of a snapshot from which to restore data into the new node group. Changing the `snapshot_name` forces a new resource. * `snapshot_retention_limit` - (Optional, Redis only) Number of days for which ElastiCache will retain automatic cache cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, then a snapshot that was taken today will be retained for 5 days before being deleted. If the value of `snapshot_retention_limit` is set to zero (0), backups are turned off. Please note that setting a `snapshot_retention_limit` is not supported on cache.t1.micro cache nodes * `snapshot_window` - (Optional, Redis only) Daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your cache cluster. The minimum snapshot window is a 60 minute period. Example: `05:00-09:00` @@ -382,4 +383,4 @@ Using `terraform import`, import ElastiCache Replication Groups using the `repli % terraform import aws_elasticache_replication_group.my_replication_group replication-group-1 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/elasticache_reserved_cache_node.html.markdown b/website/docs/cdktf/python/r/elasticache_reserved_cache_node.html.markdown index 050fc2b8d1de..f7ee8f77666c 100644 --- a/website/docs/cdktf/python/r/elasticache_reserved_cache_node.html.markdown +++ b/website/docs/cdktf/python/r/elasticache_reserved_cache_node.html.markdown @@ -56,6 +56,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `cache_node_count` - (Optional) Number of cache node instances to reserve. Default value is `1`. * `id` - (Optional) Customer-specified identifier to track this reservation. @@ -68,7 +69,7 @@ This resource exports the following attributes in addition to the arguments abov * `arn` - ARN for the reserved cache node. * `duration` - Duration of the reservation as an RFC3339 duration. -* `fixed_price` – Fixed price charged for this reserved cache node. +* `fixed_price` - Fixed price charged for this reserved cache node. * `cache_node_type` - Node type for the reserved cache nodes. * `offering_type` - Offering type of this reserved cache node. * `product_description` - Engine type for the reserved cache node. @@ -111,4 +112,4 @@ Using `terraform import`, import ElastiCache Reserved Cache Node using the `id`. % terraform import aws_elasticache_reserved_cache_node.example CustomReservationID ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/elasticache_serverless_cache.html.markdown b/website/docs/cdktf/python/r/elasticache_serverless_cache.html.markdown index 3c99616ade4d..15a8848e5a25 100644 --- a/website/docs/cdktf/python/r/elasticache_serverless_cache.html.markdown +++ b/website/docs/cdktf/python/r/elasticache_serverless_cache.html.markdown @@ -133,21 +133,22 @@ class MyConvertedCode(TerraformStack): The following arguments are required: -* `engine` – (Required) Name of the cache engine to be used for this cache cluster. Valid values are `memcached`, `redis` or `valkey`. -* `name` – (Required) The Cluster name which serves as a unique identifier to the serverless cache +* `engine` - (Required) Name of the cache engine to be used for this cache cluster. Valid values are `memcached`, `redis` or `valkey`. +* `name` - (Required) The Cluster name which serves as a unique identifier to the serverless cache The following arguments are optional: +* `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). * `cache_usage_limits` - (Optional) Sets the cache usage limits for storage and ElastiCache Processing Units for the cache. See [`cache_usage_limits` Block](#cache_usage_limits-block) for details. * `daily_snapshot_time` - (Optional) The daily time that snapshots will be created from the new serverless cache. Only supported for engine types `"redis"` or `"valkey"`. Defaults to `0`. * `description` - (Optional) User-provided description for the serverless cache. The default is NULL. * `kms_key_id` - (Optional) ARN of the customer managed key for encrypting the data at rest. If no KMS key is provided, a default service key is used. -* `major_engine_version` – (Optional) The version of the cache engine that will be used to create the serverless cache. +* `major_engine_version` - (Optional) The version of the cache engine that will be used to create the serverless cache. See [Describe Cache Engine Versions](https://docs.aws.amazon.com/cli/latest/reference/elasticache/describe-cache-engine-versions.html) in the AWS Documentation for supported versions. * `security_group_ids` - (Optional) A list of the one or more VPC security groups to be associated with the serverless cache. The security group will authorize traffic access for the VPC end-point (private-link). If no other information is given this will be the VPC’s Default Security Group that is associated with the cluster VPC end-point. * `snapshot_arns_to_restore` - (Optional, Redis only) The list of ARN(s) of the snapshot that the new serverless cache will be created from. Available for Redis only. * `snapshot_retention_limit` - (Optional, Redis only) The number of snapshots that will be retained for the serverless cache that is being created. As new snapshots beyond this limit are added, the oldest snapshots will be deleted on a rolling basis. Available for Redis only. -* `subnet_ids` – (Optional) A list of the identifiers of the subnets where the VPC endpoint for the serverless cache will be deployed. All the subnetIds must belong to the same VPC. +* `subnet_ids` - (Optional) A list of the identifiers of the subnets where the VPC endpoint for the serverless cache will be deployed. All the subnetIds must belong to the same VPC. * `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. * `user_group_id` - (Optional) The identifier of the UserGroup to be associated with the serverless cache. Available for Redis only. Default is NULL. @@ -232,4 +233,4 @@ Using `terraform import`, import ElastiCache Serverless Cache using the `name`. % terraform import aws_elasticache_serverless_cache.my_cluster my_cluster ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/elasticache_subnet_group.html.markdown b/website/docs/cdktf/python/r/elasticache_subnet_group.html.markdown index 899f9d02fedd..3a7587e33624 100644 --- a/website/docs/cdktf/python/r/elasticache_subnet_group.html.markdown +++ b/website/docs/cdktf/python/r/elasticache_subnet_group.html.markdown @@ -54,9 +54,10 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: -* `name` – (Required) Name for the cache subnet group. ElastiCache converts this name to lowercase. -* `description` – (Optional) Description for the cache subnet group. Defaults to "Managed by Terraform". -* `subnet_ids` – (Required) List of VPC Subnet IDs for the cache subnet group +* `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). +* `name` - (Required) Name for the cache subnet group. ElastiCache converts this name to lowercase. +* `description` - (Optional) Description for the cache subnet group. Defaults to "Managed by Terraform". +* `subnet_ids` - (Required) List of VPC Subnet IDs for the cache subnet group * `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. ## Attribute Reference @@ -91,4 +92,4 @@ Using `terraform import`, import ElastiCache Subnet Groups using the `name`. For % terraform import aws_elasticache_subnet_group.bar tf-test-cache-subnet ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/elasticache_user.html.markdown b/website/docs/cdktf/python/r/elasticache_user.html.markdown index ec11e3e9b961..1b185c97f9e6 100644 --- a/website/docs/cdktf/python/r/elasticache_user.html.markdown +++ b/website/docs/cdktf/python/r/elasticache_user.html.markdown @@ -96,6 +96,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `authentication_mode` - (Optional) Denotes the user's authentication properties. Detailed below. * `no_password_required` - (Optional) Indicates a password is not required for this user. * `passwords` - (Optional) Passwords used for this user. You can create up to two passwords for each user. @@ -146,4 +147,4 @@ Using `terraform import`, import ElastiCache users using the `user_id`. For exam % terraform import aws_elasticache_user.my_user userId1 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/elasticache_user_group.html.markdown b/website/docs/cdktf/python/r/elasticache_user_group.html.markdown index 18dd9acffebd..e4b650946e3c 100644 --- a/website/docs/cdktf/python/r/elasticache_user_group.html.markdown +++ b/website/docs/cdktf/python/r/elasticache_user_group.html.markdown @@ -52,6 +52,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `user_ids` - (Optional) The list of user IDs that belong to the user group. * `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. @@ -88,4 +89,4 @@ Using `terraform import`, import ElastiCache user groups using the `user_group_i % terraform import aws_elasticache_user_group.my_user_group userGoupId1 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/elasticache_user_group_association.html.markdown b/website/docs/cdktf/python/r/elasticache_user_group_association.html.markdown index df1cb3120f34..337af7e9ed10 100644 --- a/website/docs/cdktf/python/r/elasticache_user_group_association.html.markdown +++ b/website/docs/cdktf/python/r/elasticache_user_group_association.html.markdown @@ -66,8 +66,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `user_group_id` - (Required) ID of the user group. * `user_id` - (Required) ID of the user to associated with the user group. @@ -107,4 +108,4 @@ Using `terraform import`, import ElastiCache user group associations using the ` % terraform import aws_elasticache_user_group_association.example userGoupId1,userId ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/elasticsearch_domain.html.markdown b/website/docs/cdktf/python/r/elasticsearch_domain.html.markdown index 1188356187d6..298ca519ad08 100644 --- a/website/docs/cdktf/python/r/elasticsearch_domain.html.markdown +++ b/website/docs/cdktf/python/r/elasticsearch_domain.html.markdown @@ -68,7 +68,7 @@ class MyConvertedCode(TerraformStack): # 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_region_current.override_logical_id("current") ElasticsearchDomain(self, "example", - access_policies="{\n \"Version\": \"2012-10-17\",\n \"Statement\": [\n {\n \"Action\": \"es:*\",\n \"Principal\": \"*\",\n \"Effect\": \"Allow\",\n \"Resource\": \"arn:aws:es:${" + data_aws_region_current.name + "}:${" + current.account_id + "}:domain/${" + domain.value + "}/*\",\n \"Condition\": {\n \"IpAddress\": {\"aws:SourceIp\": [\"66.193.100.22/32\"]}\n }\n }\n ]\n}\n\n", + access_policies="{\n \"Version\": \"2012-10-17\",\n \"Statement\": [\n {\n \"Action\": \"es:*\",\n \"Principal\": \"*\",\n \"Effect\": \"Allow\",\n \"Resource\": \"arn:aws:es:${" + data_aws_region_current.region + "}:${" + current.account_id + "}:domain/${" + domain.value + "}/*\",\n \"Condition\": {\n \"IpAddress\": {\"aws:SourceIp\": [\"66.193.100.22/32\"]}\n }\n }\n ]\n}\n\n", domain_name=domain.string_value ) ``` @@ -193,7 +193,7 @@ class MyConvertedCode(TerraformStack): # 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_subnets_selected.override_logical_id("selected") aws_elasticsearch_domain_es = ElasticsearchDomain(self, "es_8", - access_policies="{\n\t\"Version\": \"2012-10-17\",\n\t\"Statement\": [\n\t\t{\n\t\t\t\"Action\": \"es:*\",\n\t\t\t\"Principal\": \"*\",\n\t\t\t\"Effect\": \"Allow\",\n\t\t\t\"Resource\": \"arn:aws:es:${" + data_aws_region_current.name + "}:${" + current.account_id + "}:domain/${" + domain.value + "}/*\"\n\t\t}\n\t]\n}\n\n", + access_policies="{\n\t\"Version\": \"2012-10-17\",\n\t\"Statement\": [\n\t\t{\n\t\t\t\"Action\": \"es:*\",\n\t\t\t\"Principal\": \"*\",\n\t\t\t\"Effect\": \"Allow\",\n\t\t\t\"Resource\": \"arn:aws:es:${" + data_aws_region_current.region + "}:${" + current.account_id + "}:domain/${" + domain.value + "}/*\"\n\t\t}\n\t]\n}\n\n", advanced_options={ "rest.action.multi.allow_explicit_index": "true" }, @@ -227,6 +227,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `access_policies` - (Optional) IAM policy document specifying the access policies for the domain. * `advanced_options` - (Optional) Key-value string pairs to specify advanced configuration options. Note that the values for these configuration options must be strings (wrapped in quotes) or they may be wrong and cause a perpetual diff, causing Terraform to want to recreate your Elasticsearch domain on every apply. * `advanced_security_options` - (Optional) Configuration block for [fine-grained access control](https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/fgac.html). Detailed below. @@ -359,7 +360,6 @@ This resource exports the following attributes in addition to the arguments abov * `arn` - ARN of the domain. * `domain_id` - Unique identifier for the domain. -* `domain_name` - Name of the Elasticsearch domain. * `endpoint` - Domain-specific endpoint used to submit index, search, and data upload requests. * `kibana_endpoint` - Domain-specific endpoint for kibana without https scheme. * `tags_all` - Map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). @@ -399,4 +399,4 @@ Using `terraform import`, import Elasticsearch domains using the `domain_name`. % terraform import aws_elasticsearch_domain.example domain_name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/elasticsearch_domain_policy.html.markdown b/website/docs/cdktf/python/r/elasticsearch_domain_policy.html.markdown index b1b4d3a50c4f..3258c758a604 100644 --- a/website/docs/cdktf/python/r/elasticsearch_domain_policy.html.markdown +++ b/website/docs/cdktf/python/r/elasticsearch_domain_policy.html.markdown @@ -41,6 +41,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `domain_name` - (Required) Name of the domain. * `access_policies` - (Optional) IAM policy document specifying the access policies for the domain @@ -48,4 +49,4 @@ This resource supports the following arguments: This resource exports no additional attributes. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/elasticsearch_domain_saml_options.html.markdown b/website/docs/cdktf/python/r/elasticsearch_domain_saml_options.html.markdown index 271db340ac0b..efaa142fe5b8 100644 --- a/website/docs/cdktf/python/r/elasticsearch_domain_saml_options.html.markdown +++ b/website/docs/cdktf/python/r/elasticsearch_domain_saml_options.html.markdown @@ -65,6 +65,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `saml_options` - (Optional) The SAML authentication options for an AWS Elasticsearch Domain. ### saml_options @@ -113,4 +114,4 @@ Using `terraform import`, import Elasticsearch domains using the `domain_name`. % terraform import aws_elasticsearch_domain_saml_options.example domain_name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/elasticsearch_vpc_endpoint.html.markdown b/website/docs/cdktf/python/r/elasticsearch_vpc_endpoint.html.markdown index d39ec6f540d3..9bea786bc8b2 100644 --- a/website/docs/cdktf/python/r/elasticsearch_vpc_endpoint.html.markdown +++ b/website/docs/cdktf/python/r/elasticsearch_vpc_endpoint.html.markdown @@ -44,6 +44,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `domain_arn` - (Required, Forces new resource) Specifies the Amazon Resource Name (ARN) of the domain to create the endpoint for * `vpc_options` - (Required) Options to specify the subnets and security groups for the endpoint. @@ -92,4 +93,4 @@ Using `terraform import`, import elasticsearch VPC endpoint connections using th % terraform import aws_elasticsearch_vpc_endpoint_connection.example endpoint-id ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/elastictranscoder_pipeline.html.markdown b/website/docs/cdktf/python/r/elastictranscoder_pipeline.html.markdown index 19bdbfe19031..4eac0f5ccc61 100644 --- a/website/docs/cdktf/python/r/elastictranscoder_pipeline.html.markdown +++ b/website/docs/cdktf/python/r/elastictranscoder_pipeline.html.markdown @@ -12,6 +12,8 @@ description: |- Provides an Elastic Transcoder pipeline resource. +~> **Warning:** This resource is deprecated. Use [AWS Elemental MediaConvert](https://aws.amazon.com/blogs/media/migrating-workflows-from-amazon-elastic-transcoder-to-aws-elemental-mediaconvert/) instead. AWS will [discontinue support for Amazon Elastic Transcoder](https://aws.amazon.com/blogs/media/support-for-amazon-elastic-transcoder-ending-soon/), effective November 13, 2025. + ## Example Usage ```python @@ -45,6 +47,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `aws_kms_key_arn` - (Optional) The AWS Key Management Service (AWS KMS) key that you want to use with this pipeline. * `content_config` - (Optional) The ContentConfig object specifies information about the Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files and playlists. (documented below) * `content_config_permissions` - (Optional) The permissions for the `content_config` object. (documented below) @@ -136,4 +139,4 @@ Using `terraform import`, import Elastic Transcoder pipelines using the `id`. Fo % terraform import aws_elastictranscoder_pipeline.basic_pipeline 1407981661351-cttk8b ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/elastictranscoder_preset.html.markdown b/website/docs/cdktf/python/r/elastictranscoder_preset.html.markdown index 3d11d5080ff7..e24f488c32af 100644 --- a/website/docs/cdktf/python/r/elastictranscoder_preset.html.markdown +++ b/website/docs/cdktf/python/r/elastictranscoder_preset.html.markdown @@ -12,6 +12,8 @@ description: |- Provides an Elastic Transcoder preset resource. +~> **Warning:** This resource is deprecated. Use [AWS Elemental MediaConvert](https://aws.amazon.com/blogs/media/migrating-workflows-from-amazon-elastic-transcoder-to-aws-elemental-mediaconvert/) instead. AWS will [discontinue support for Amazon Elastic Transcoder](https://aws.amazon.com/blogs/media/support-for-amazon-elastic-transcoder-ending-soon/), effective November 13, 2025. + ## Example Usage ```python @@ -88,6 +90,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `audio` - (Optional, Forces new resource) Audio parameters object (documented below). * `audio_codec_options` - (Optional, Forces new resource) Codec options for the audio parameters (documented below) * `container` - (Required, Forces new resource) The container type for the output file. Valid values are `flac`, `flv`, `fmp4`, `gif`, `mp3`, `mp4`, `mpg`, `mxf`, `oga`, `ogg`, `ts`, and `webm`. @@ -198,4 +201,4 @@ Using `terraform import`, import Elastic Transcoder presets using the `id`. For % terraform import aws_elastictranscoder_preset.basic_preset 1407981661351-cttk8b ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/elb.html.markdown b/website/docs/cdktf/python/r/elb.html.markdown index b3a43e06adf5..2e9d2ccca71f 100644 --- a/website/docs/cdktf/python/r/elb.html.markdown +++ b/website/docs/cdktf/python/r/elb.html.markdown @@ -78,6 +78,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Optional) The name of the ELB. By default generated by Terraform. * `name_prefix` - (Optional, Forces new resource) Creates a unique name beginning with the specified prefix. Conflicts with `name`. @@ -180,4 +181,4 @@ Using `terraform import`, import ELBs using the `name`. For example: % terraform import aws_elb.bar elb-production-12345 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/elb_attachment.html.markdown b/website/docs/cdktf/python/r/elb_attachment.html.markdown index ab92965a7a0e..1295ed8a2c27 100644 --- a/website/docs/cdktf/python/r/elb_attachment.html.markdown +++ b/website/docs/cdktf/python/r/elb_attachment.html.markdown @@ -43,6 +43,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `elb` - (Required) The name of the ELB. * `instance` - (Required) Instance ID to place in the ELB pool. @@ -50,4 +51,4 @@ This resource supports the following arguments: This resource exports no additional attributes. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/emr_block_public_access_configuration.html.markdown b/website/docs/cdktf/python/r/emr_block_public_access_configuration.html.markdown index 6ee850aaa789..5f4e5c4d851c 100644 --- a/website/docs/cdktf/python/r/emr_block_public_access_configuration.html.markdown +++ b/website/docs/cdktf/python/r/emr_block_public_access_configuration.html.markdown @@ -119,6 +119,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `permitted_public_security_group_rule_range` - (Optional) Configuration block for defining permitted public security group rule port ranges. Can be defined multiple times per resource. Only valid if `block_public_security_group_rules` is set to `true`. ### `permitted_public_security_group_rule_range` @@ -157,4 +158,4 @@ Using `terraform import`, import the current EMR Block Public Access Configurati % terraform import aws_emr_block_public_access_configuration.example current ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/emr_cluster.html.markdown b/website/docs/cdktf/python/r/emr_cluster.html.markdown index 75a4d51b13f6..d469614d7ce5 100644 --- a/website/docs/cdktf/python/r/emr_cluster.html.markdown +++ b/website/docs/cdktf/python/r/emr_cluster.html.markdown @@ -463,6 +463,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `additional_info` - (Optional) JSON string for selecting additional features such as adding proxy information. Note: Currently there is no API to retrieve the value of this argument after EMR cluster creation from provider, therefore Terraform cannot detect drift from the actual EMR cluster if its value is changed outside Terraform. * `applications` - (Optional) A case-insensitive list of applications for Amazon EMR to install and configure when launching the cluster. For a list of applications available for each Amazon EMR release version, see the [Amazon EMR Release Guide](https://docs.aws.amazon.com/emr/latest/ReleaseGuide/emr-release-components.html). * `autoscaling_role` - (Optional) IAM role for automatic scaling policies. The IAM role provides permissions that the automatic scaling feature requires to launch and terminate EC2 instances in an instance group. @@ -505,6 +506,7 @@ class MyConvertedCode(TerraformStack): * `log_uri` - (Optional) S3 bucket to write the log files of the job flow. If a value is not provided, logs are not created. * `master_instance_fleet` - (Optional) Configuration block to use an [Instance Fleet](https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-instance-fleet.html) for the master node type. Cannot be specified if any `master_instance_group` configuration blocks are set. Detailed below. * `master_instance_group` - (Optional) Configuration block to use an [Instance Group](https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-instance-group-configuration.html#emr-plan-instance-groups) for the [master node type](https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-master-core-task-nodes.html#emr-plan-master). +* `os_release_label` - (Optional) Amazon Linux release for all nodes in a cluster launch RunJobFlow request. If not specified, Amazon EMR uses the latest validated Amazon Linux release for cluster launch. * `placement_group_config` - (Optional) The specified placement group configuration for an Amazon EMR cluster. * `scale_down_behavior` - (Optional) Way that individual Amazon EC2 instances terminate when an automatic scale-in activity occurs or an `instance group` is resized. * `security_configuration` - (Optional) Security configuration name to attach to the EMR cluster. Only valid for EMR clusters with `release_label` 4.8.0 or greater. @@ -515,6 +517,8 @@ class MyConvertedCode(TerraformStack): * `unhealthy_node_replacement` - (Optional) Whether whether Amazon EMR should gracefully replace core nodes that have degraded within the cluster. Default value is `false`. * `visible_to_all_users` - (Optional) Whether the job flow is visible to all IAM users of the AWS account associated with the job flow. Default value is `true`. + **NOTE:** As per the [Amazon EMR API Reference](https://docs.aws.amazon.com/emr/latest/APIReference/API_RunJobFlow.html#EMR-RunJobFlow-request-VisibleToAllUsers), this argument is no longer supported. Do not set this argument, particularly to `false`, as it would lead to perpetual differences. + ### bootstrap_action * `args` - (Optional) List of command line arguments to pass to the bootstrap action script. @@ -681,7 +685,6 @@ This resource exports the following attributes in addition to the arguments abov * `release_label` - Release label for the Amazon EMR release. * `service_role` - IAM role that will be assumed by the Amazon EMR service to access AWS resources on your behalf. * `tags_all` - Map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). -* `visible_to_all_users` - Indicates whether the job flow is visible to all IAM users of the AWS account associated with the job flow. ## Import @@ -733,4 +736,4 @@ class MyConvertedCode(TerraformStack): ) ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/emr_instance_fleet.html.markdown b/website/docs/cdktf/python/r/emr_instance_fleet.html.markdown index dcca5929e92e..3ea55851e4c8 100644 --- a/website/docs/cdktf/python/r/emr_instance_fleet.html.markdown +++ b/website/docs/cdktf/python/r/emr_instance_fleet.html.markdown @@ -74,6 +74,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `cluster_id` - (Required) ID of the EMR Cluster to attach to. Changing this forces a new resource to be created. * `instance_type_configs` - (Optional) Configuration block for instance fleet * `launch_specifications` - (Optional) Configuration block for launch specification @@ -166,4 +167,4 @@ Using `terraform import`, import EMR Instance Fleet using the EMR Cluster identi % terraform import aws_emr_instance_fleet.example j-123456ABCDEF/if-15EK4O09RZLNR ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/emr_instance_group.html.markdown b/website/docs/cdktf/python/r/emr_instance_group.html.markdown index 96a573d6098e..7d578950372c 100644 --- a/website/docs/cdktf/python/r/emr_instance_group.html.markdown +++ b/website/docs/cdktf/python/r/emr_instance_group.html.markdown @@ -43,6 +43,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` (Required) Human friendly name given to the instance group. Changing this forces a new resource to be created. * `cluster_id` (Required) ID of the EMR Cluster to attach to. Changing this forces a new resource to be created. * `instance_type` (Required) The EC2 instance type for all instances in the instance group. Changing this forces a new resource to be created. @@ -112,4 +113,4 @@ Using `terraform import`, import EMR task instance group using their EMR Cluster % terraform import aws_emr_instance_group.task_group j-123456ABCDEF/ig-15EK4O09RZLNR ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/emr_managed_scaling_policy.html.markdown b/website/docs/cdktf/python/r/emr_managed_scaling_policy.html.markdown index 8b2545891408..02bf29909528 100644 --- a/website/docs/cdktf/python/r/emr_managed_scaling_policy.html.markdown +++ b/website/docs/cdktf/python/r/emr_managed_scaling_policy.html.markdown @@ -55,6 +55,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `cluster_id` - (Required) ID of the EMR cluster * `compute_limits` - (Required) Configuration block with compute limit settings. Described below. @@ -95,4 +96,4 @@ Using `terraform import`, import EMR Managed Scaling Policies using the EMR Clus % terraform import aws_emr_managed_scaling_policy.example j-123456ABCDEF ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/emr_security_configuration.html.markdown b/website/docs/cdktf/python/r/emr_security_configuration.html.markdown index 475e624c153f..ab040c7cf62f 100644 --- a/website/docs/cdktf/python/r/emr_security_configuration.html.markdown +++ b/website/docs/cdktf/python/r/emr_security_configuration.html.markdown @@ -36,6 +36,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Optional) The name of the EMR Security Configuration. By default generated by Terraform. * `name_prefix` - (Optional) Creates a unique name beginning with the specified prefix. Conflicts with `name`. @@ -75,4 +76,4 @@ Using `terraform import`, import EMR Security Configurations using the `name`. F % terraform import aws_emr_security_configuration.sc example-sc-name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/emr_studio.html.markdown b/website/docs/cdktf/python/r/emr_studio.html.markdown index 2d6a87dae8f3..2ddd360de594 100644 --- a/website/docs/cdktf/python/r/emr_studio.html.markdown +++ b/website/docs/cdktf/python/r/emr_studio.html.markdown @@ -54,6 +54,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `description` - (Optional) A detailed description of the Amazon EMR Studio. * `encryption_key_arn` - (Optional) The AWS KMS key identifier (ARN) used to encrypt Amazon EMR Studio workspace and notebook files when backed up to Amazon S3. * `idp_auth_url` - (Optional) The authentication endpoint of your identity provider (IdP). Specify this value when you use IAM authentication and want to let federated users log in to a Studio with the Studio URL and credentials from your IdP. Amazon EMR Studio redirects users to this endpoint to enter credentials. @@ -93,4 +94,4 @@ Using `terraform import`, import EMR studios using the `id`. For example: % terraform import aws_emr_studio.studio es-123456ABCDEF ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/emr_studio_session_mapping.html.markdown b/website/docs/cdktf/python/r/emr_studio_session_mapping.html.markdown index fbe43e2a31c1..833a1061494c 100644 --- a/website/docs/cdktf/python/r/emr_studio_session_mapping.html.markdown +++ b/website/docs/cdktf/python/r/emr_studio_session_mapping.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `identity_id`- (Optional) The globally unique identifier (GUID) of the user or group from the Amazon Web Services SSO Identity Store. * `identity_name` - (Optional) The name of the user or group from the Amazon Web Services SSO Identity Store. * `identity_type` - (Required) Specifies whether the identity to map to the Amazon EMR Studio is a `USER` or a `GROUP`. @@ -75,4 +76,4 @@ Using `terraform import`, import EMR studio session mappings using `studio-id:id % terraform import aws_emr_studio_session_mapping.example es-xxxxx:USER:xxxxx-xxx-xxx ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/emrcontainers_job_template.html.markdown b/website/docs/cdktf/python/r/emrcontainers_job_template.html.markdown index fb8aa73d0017..ef9fb1bce497 100644 --- a/website/docs/cdktf/python/r/emrcontainers_job_template.html.markdown +++ b/website/docs/cdktf/python/r/emrcontainers_job_template.html.markdown @@ -46,9 +46,10 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `job_template_data` - (Required) The job template data which holds values of StartJobRun API request. * `kms_key_arn` - (Optional) The KMS key ARN used to encrypt the job template. -* `name` – (Required) The specified name of the job template. +* `name` - (Required) The specified name of the job template. * `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. ### job_template_data Arguments @@ -134,4 +135,4 @@ Using `terraform import`, import EKS job templates using the `id`. For example: % terraform import aws_emrcontainers_job_template.example a1b2c3d4e5f6g7h8i9j10k11l ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/emrcontainers_virtual_cluster.html.markdown b/website/docs/cdktf/python/r/emrcontainers_virtual_cluster.html.markdown index aa6ebcf64265..aabf9e9a2e51 100644 --- a/website/docs/cdktf/python/r/emrcontainers_virtual_cluster.html.markdown +++ b/website/docs/cdktf/python/r/emrcontainers_virtual_cluster.html.markdown @@ -46,8 +46,9 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `container_provider` - (Required) Configuration block for the container provider associated with your cluster. -* `name` – (Required) Name of the virtual cluster. +* `name` - (Required) Name of the virtual cluster. * `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. ### container_provider Arguments @@ -91,4 +92,4 @@ Using `terraform import`, import EKS Clusters using the `id`. For example: % terraform import aws_emrcontainers_virtual_cluster.example a1b2c3d4e5f6g7h8i9j10k11l ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/emrserverless_application.html.markdown b/website/docs/cdktf/python/r/emrserverless_application.html.markdown index 34bcd127e427..3521492f3b6a 100644 --- a/website/docs/cdktf/python/r/emrserverless_application.html.markdown +++ b/website/docs/cdktf/python/r/emrserverless_application.html.markdown @@ -96,17 +96,18 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: -* `architecture` – (Optional) The CPU architecture of an application. Valid values are `ARM64` or `X86_64`. Default value is `X86_64`. -* `auto_start_configuration` – (Optional) The configuration for an application to automatically start on job submission. -* `auto_stop_configuration` – (Optional) The configuration for an application to automatically stop after a certain amount of time being idle. -* `image_configuration` – (Optional) The image configuration applied to all worker types. -* `initial_capacity` – (Optional) The capacity to initialize when the application is created. -* `interactive_configuration` – (Optional) Enables the interactive use cases to use when running an application. -* `maximum_capacity` – (Optional) The maximum capacity to allocate when the application is created. This is cumulative across all workers at any given point in time, not just when an application is created. No new resources will be created once any one of the defined limits is hit. -* `name` – (Required) The name of the application. -* `network_configuration` – (Optional) The network configuration for customer VPC connectivity. -* `release_label` – (Required) The EMR release version associated with the application. -* `type` – (Required) The type of application you want to start, such as `spark` or `hive`. +* `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). +* `architecture` - (Optional) The CPU architecture of an application. Valid values are `ARM64` or `X86_64`. Default value is `X86_64`. +* `auto_start_configuration` - (Optional) The configuration for an application to automatically start on job submission. +* `auto_stop_configuration` - (Optional) The configuration for an application to automatically stop after a certain amount of time being idle. +* `image_configuration` - (Optional) The image configuration applied to all worker types. +* `initial_capacity` - (Optional) The capacity to initialize when the application is created. +* `interactive_configuration` - (Optional) Enables the interactive use cases to use when running an application. +* `maximum_capacity` - (Optional) The maximum capacity to allocate when the application is created. This is cumulative across all workers at any given point in time, not just when an application is created. No new resources will be created once any one of the defined limits is hit. +* `name` - (Required) The name of the application. +* `network_configuration` - (Optional) The network configuration for customer VPC connectivity. +* `release_label` - (Required) The EMR release version associated with the application. +* `type` - (Required) The type of application you want to start, such as `spark` or `hive`. * `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. ### auto_start_configuration Arguments @@ -187,4 +188,4 @@ Using `terraform import`, import EMR Severless applications using the `id`. For % terraform import aws_emrserverless_application.example id ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/evidently_feature.html.markdown b/website/docs/cdktf/python/r/evidently_feature.html.markdown index c6a5d3686545..2847e8b978f4 100644 --- a/website/docs/cdktf/python/r/evidently_feature.html.markdown +++ b/website/docs/cdktf/python/r/evidently_feature.html.markdown @@ -12,6 +12,8 @@ description: |- Provides a CloudWatch Evidently Feature resource. +~> **Warning:** This resource is deprecated. Use [AWS AppConfig feature flags](https://aws.amazon.com/blogs/mt/using-aws-appconfig-feature-flags/) instead. + ## Example Usage ### Basic @@ -148,6 +150,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `default_variation` - (Optional) The name of the variation to use as the default variation. The default variation is served to users who are not allocated to any ongoing launches or experiments of this feature. This variation must also be listed in the `variations` structure. If you omit `default_variation`, the first variation listed in the `variations` structure is used as the default variation. * `description` - (Optional) Specifies the description of the feature. * `entity_overrides` - (Optional) Specify users that should always be served a specific variation of a feature. Each user is specified by a key-value pair . For each key, specify a user by entering their user ID, account ID, or some other identifier. For the value, specify the name of the variation that they are to be served. @@ -228,4 +231,4 @@ Using `terraform import`, import CloudWatch Evidently Feature using the feature % terraform import aws_evidently_feature.example exampleFeatureName:arn:aws:evidently:us-east-1:123456789012:project/example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/evidently_launch.html.markdown b/website/docs/cdktf/python/r/evidently_launch.html.markdown index bf6ca28fff84..94052bba9d97 100644 --- a/website/docs/cdktf/python/r/evidently_launch.html.markdown +++ b/website/docs/cdktf/python/r/evidently_launch.html.markdown @@ -12,6 +12,8 @@ description: |- Provides a CloudWatch Evidently Launch resource. +~> **Warning:** This resource is deprecated. Use [AWS AppConfig feature flags](https://aws.amazon.com/blogs/mt/using-aws-appconfig-feature-flags/) instead. + ## Example Usage ### Basic @@ -321,6 +323,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `description` - (Optional) Specifies the description of the launch. * `groups` - (Required) One or up to five blocks that contain the feature and variations that are to be used for the launch. [Detailed below](#groups). * `metric_monitors` - (Optional) One or up to three blocks that define the metrics that will be used to monitor the launch performance. [Detailed below](#metric_monitors). @@ -456,4 +459,4 @@ Import using the `name` of the launch and `arn` of the project separated by a `: % terraform import aws_evidently_launch.example exampleLaunchName:arn:aws:evidently:us-east-1:123456789012:project/exampleProjectName ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/evidently_project.html.markdown b/website/docs/cdktf/python/r/evidently_project.html.markdown index c454992d03bf..c55e9b81c179 100644 --- a/website/docs/cdktf/python/r/evidently_project.html.markdown +++ b/website/docs/cdktf/python/r/evidently_project.html.markdown @@ -12,6 +12,8 @@ description: |- Provides a CloudWatch Evidently Project resource. +~> **Warning:** This resource is deprecated. Use [AWS AppConfig feature flags](https://aws.amazon.com/blogs/mt/using-aws-appconfig-feature-flags/) instead. + ## Example Usage ### Basic @@ -98,6 +100,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `data_delivery` - (Optional) A block that contains information about where Evidently is to store evaluation events for longer term storage, if you choose to do so. If you choose not to store these events, Evidently deletes them after using them to produce metrics and other experiment results that you can view. See below. * `description` - (Optional) Specifies the description of the project. * `name` - (Required) A name for the project. @@ -168,4 +171,4 @@ Using `terraform import`, import CloudWatch Evidently Project using the `arn`. F % terraform import aws_evidently_project.example arn:aws:evidently:us-east-1:123456789012:segment/example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/evidently_segment.html.markdown b/website/docs/cdktf/python/r/evidently_segment.html.markdown index 80daa7a34867..9e9321c234b2 100644 --- a/website/docs/cdktf/python/r/evidently_segment.html.markdown +++ b/website/docs/cdktf/python/r/evidently_segment.html.markdown @@ -12,6 +12,8 @@ description: |- Provides a CloudWatch Evidently Segment resource. +~> **Warning:** This resource is deprecated. Use [AWS AppConfig feature flags](https://aws.amazon.com/blogs/mt/using-aws-appconfig-feature-flags/) instead. + ## Example Usage ### Basic @@ -85,6 +87,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `description` - (Optional, Forces new resource) Specifies the description of the segment. * `name` - (Required, Forces new resource) A name for the segment. * `pattern` - (Required, Forces new resource) The pattern to use for the segment. For more information about pattern syntax, see [Segment rule pattern syntax](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Evidently-segments.html#CloudWatch-Evidently-segments-syntax.html). @@ -127,4 +130,4 @@ Using `terraform import`, import CloudWatch Evidently Segment using the `arn`. F % terraform import aws_evidently_segment.example arn:aws:evidently:us-west-2:123456789012:segment/example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/finspace_kx_cluster.html.markdown b/website/docs/cdktf/python/r/finspace_kx_cluster.html.markdown index 6614c7098cf0..0e4c61f9b1e4 100644 --- a/website/docs/cdktf/python/r/finspace_kx_cluster.html.markdown +++ b/website/docs/cdktf/python/r/finspace_kx_cluster.html.markdown @@ -87,11 +87,12 @@ The following arguments are required: * RDB - Realtime Database. This type of database captures all the data from a ticker plant and stores it in memory until the end of day, after which it writes all of its data to a disk and reloads the HDB. This cluster type requires local storage for temporary storage of data during the savedown process. If you specify this field in your request, you must provide the `savedownStorageConfiguration` parameter. * GATEWAY - A gateway cluster allows you to access data across processes in kdb systems. It allows you to create your own routing logic using the initialization scripts and custom code. This type of cluster does not require a writable local storage. * GP - A general purpose cluster allows you to quickly iterate on code during development by granting greater access to system commands and enabling a fast reload of custom code. This cluster type can optionally mount databases including cache and savedown storage. For this cluster type, the node count is fixed at 1. It does not support autoscaling and supports only `SINGLE` AZ mode. - * Tickerplant – A tickerplant cluster allows you to subscribe to feed handlers based on IAM permissions. It can publish to RDBs, other Tickerplants, and real-time subscribers (RTS). Tickerplants can persist messages to log, which is readable by any RDB environment. It supports only single-node that is only one kdb process. + * Tickerplant - A tickerplant cluster allows you to subscribe to feed handlers based on IAM permissions. It can publish to RDBs, other Tickerplants, and real-time subscribers (RTS). Tickerplants can persist messages to log, which is readable by any RDB environment. It supports only single-node that is only one kdb process. * `vpc_configuration` - (Required) Configuration details about the network where the Privatelink endpoint of the cluster resides. See [vpc_configuration](#vpc_configuration). The following arguments are optional: +* `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). * `auto_scaling_configuration` - (Optional) Configuration based on which FinSpace will scale in or scale out nodes in your cluster. See [auto_scaling_configuration](#auto_scaling_configuration). * `availability_zone_id` - (Optional) The availability zone identifiers for the requested regions. Required when `az_mode` is set to SINGLE. * `cache_storage_configurations` - (Optional) Configurations for a read only cache storage associated with a cluster. This cache will be stored as an FSx Lustre that reads from the S3 store. See [cache_storage_configuration](#cache_storage_configuration). @@ -124,13 +125,13 @@ The capacity_configuration block supports the following arguments: * `node_type` - (Required) Determines the hardware of the host computer used for your cluster instance. Each node type offers different memory and storage capabilities. Choose a node type based on the requirements of the application or software that you plan to run on your instance. You can only specify one of the following values: - * kx.s.large – The node type with a configuration of 12 GiB memory and 2 vCPUs. - * kx.s.xlarge – The node type with a configuration of 27 GiB memory and 4 vCPUs. - * kx.s.2xlarge – The node type with a configuration of 54 GiB memory and 8 vCPUs. - * kx.s.4xlarge – The node type with a configuration of 108 GiB memory and 16 vCPUs. - * kx.s.8xlarge – The node type with a configuration of 216 GiB memory and 32 vCPUs. - * kx.s.16xlarge – The node type with a configuration of 432 GiB memory and 64 vCPUs. - * kx.s.32xlarge – The node type with a configuration of 864 GiB memory and 128 vCPUs. + * kx.s.large - The node type with a configuration of 12 GiB memory and 2 vCPUs. + * kx.s.xlarge - The node type with a configuration of 27 GiB memory and 4 vCPUs. + * kx.s.2xlarge - The node type with a configuration of 54 GiB memory and 8 vCPUs. + * kx.s.4xlarge - The node type with a configuration of 108 GiB memory and 16 vCPUs. + * kx.s.8xlarge - The node type with a configuration of 216 GiB memory and 32 vCPUs. + * kx.s.16xlarge - The node type with a configuration of 432 GiB memory and 64 vCPUs. + * kx.s.32xlarge - The node type with a configuration of 864 GiB memory and 128 vCPUs. * `node_count` - (Required) Number of instances running in a cluster. Must be at least 1 and at most 5. ### cache_storage_configuration @@ -247,4 +248,4 @@ Using `terraform import`, import an AWS FinSpace Kx Cluster using the `id` (envi % terraform import aws_finspace_kx_cluster.example n3ceo7wqxoxcti5tujqwzs,my-tf-kx-cluster ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/finspace_kx_database.html.markdown b/website/docs/cdktf/python/r/finspace_kx_database.html.markdown index d87bbb81ded8..e122c8c75bf3 100644 --- a/website/docs/cdktf/python/r/finspace_kx_database.html.markdown +++ b/website/docs/cdktf/python/r/finspace_kx_database.html.markdown @@ -58,6 +58,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `description` - (Optional) Description of the KX database. * `tags` - (Optional) Key-value mapping of resource tags. If configured with a provider [`default_tags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. @@ -104,4 +105,4 @@ Using `terraform import`, import an AWS FinSpace Kx Database using the `id` (env % terraform import aws_finspace_kx_database.example n3ceo7wqxoxcti5tujqwzs,my-tf-kx-database ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/finspace_kx_dataview.html.markdown b/website/docs/cdktf/python/r/finspace_kx_dataview.html.markdown index d5076d957289..23aa73d24db9 100644 --- a/website/docs/cdktf/python/r/finspace_kx_dataview.html.markdown +++ b/website/docs/cdktf/python/r/finspace_kx_dataview.html.markdown @@ -63,6 +63,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `auto_update` - (Optional) The option to specify whether you want to apply all the future additions and corrections automatically to the dataview, when you ingest new changesets. The default value is false. * `availability_zone_id` - (Optional) The identifier of the availability zones. If attaching a volume, the volume must be in the same availability zone as the dataview that you are attaching to. * `changeset_id` - (Optional) A unique identifier of the changeset of the database that you want to use to ingest data. @@ -123,4 +124,4 @@ Using `terraform import`, import an AWS FinSpace Kx Cluster using the `id` (envi % terraform import aws_finspace_kx_dataview.example n3ceo7wqxoxcti5tujqwzs,my-tf-kx-database,my-tf-kx-dataview ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/finspace_kx_environment.html.markdown b/website/docs/cdktf/python/r/finspace_kx_environment.html.markdown index 8b2c36eae569..dc62c7f7fa0d 100644 --- a/website/docs/cdktf/python/r/finspace_kx_environment.html.markdown +++ b/website/docs/cdktf/python/r/finspace_kx_environment.html.markdown @@ -147,6 +147,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `custom_dns_configuration` - (Optional) List of DNS server name and server IP. This is used to set up Route-53 outbound resolvers. Defined below. * `description` - (Optional) Description for the KX environment. * `tags` - (Optional) Key-value mapping of resource tags. If configured with a provider [`default_tags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. @@ -240,4 +241,4 @@ Using `terraform import`, import an AWS FinSpace Kx Environment using the `id`. % terraform import aws_finspace_kx_environment.example n3ceo7wqxoxcti5tujqwzs ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/finspace_kx_scaling_group.html.markdown b/website/docs/cdktf/python/r/finspace_kx_scaling_group.html.markdown index 37831b0155a6..1852f1aaaa02 100644 --- a/website/docs/cdktf/python/r/finspace_kx_scaling_group.html.markdown +++ b/website/docs/cdktf/python/r/finspace_kx_scaling_group.html.markdown @@ -47,6 +47,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `tags` - (Optional) Key-value mapping of resource tags. If configured with a provider [`default_tags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. You can add up to 50 tags to a scaling group. ## Attribute Reference @@ -58,14 +59,14 @@ This resource exports the following attributes in addition to the arguments abov * `created_timestamp` - The timestamp at which the scaling group was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000. * `last_modified_timestamp` - Last timestamp at which the scaling group was updated in FinSpace. Value determined as epoch time in seconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000. * `status` - The status of scaling group. - * `CREATING` – The scaling group creation is in progress. - * `CREATE_FAILED` – The scaling group creation has failed. - * `ACTIVE` – The scaling group is active. - * `UPDATING` – The scaling group is in the process of being updated. - * `UPDATE_FAILED` – The update action failed. - * `DELETING` – The scaling group is in the process of being deleted. - * `DELETE_FAILED` – The system failed to delete the scaling group. - * `DELETED` – The scaling group is successfully deleted. + * `CREATING` - The scaling group creation is in progress. + * `CREATE_FAILED` - The scaling group creation has failed. + * `ACTIVE` - The scaling group is active. + * `UPDATING` - The scaling group is in the process of being updated. + * `UPDATE_FAILED` - The update action failed. + * `DELETING` - The scaling group is in the process of being deleted. + * `DELETE_FAILED` - The system failed to delete the scaling group. + * `DELETED` - The scaling group is successfully deleted. * `status_reason` - The error message when a failed state occurs. * `tags_all` - Map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block). @@ -102,4 +103,4 @@ Using `terraform import`, import an AWS FinSpace Kx Scaling Group using the `id` % terraform import aws_finspace_kx_scaling_group.example n3ceo7wqxoxcti5tujqwzs,my-tf-kx-scalinggroup ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/finspace_kx_user.html.markdown b/website/docs/cdktf/python/r/finspace_kx_user.html.markdown index 0ef85fe2e382..f34179a3e607 100644 --- a/website/docs/cdktf/python/r/finspace_kx_user.html.markdown +++ b/website/docs/cdktf/python/r/finspace_kx_user.html.markdown @@ -78,6 +78,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `tags` - (Optional) Key-value mapping of resource tags. If configured with a provider [`default_tags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. ## Attribute Reference @@ -121,4 +122,4 @@ Using `terraform import`, import an AWS FinSpace Kx User using the `id` (environ % terraform import aws_finspace_kx_user.example n3ceo7wqxoxcti5tujqwzs,my-tf-kx-user ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/finspace_kx_volume.html.markdown b/website/docs/cdktf/python/r/finspace_kx_volume.html.markdown index 52c0666da605..35c10fb8a992 100644 --- a/website/docs/cdktf/python/r/finspace_kx_volume.html.markdown +++ b/website/docs/cdktf/python/r/finspace_kx_volume.html.markdown @@ -29,7 +29,7 @@ class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) FinspaceKxVolume(self, "example", - availability_zones=Token.as_list("use1-az2"), + availability_zones=["use1-az2"], az_mode="SINGLE", environment_id=Token.as_string(aws_finspace_kx_environment_example.id), name="my-tf-kx-volume", @@ -55,6 +55,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `nas1_configuration` - (Optional) Specifies the configuration for the Network attached storage (`NAS_1`) file system volume. This parameter is required when `volume_type` is `NAS_1`. See [`nas1_configuration` Argument Reference](#nas1_configuration-argument-reference) below. * `description` - (Optional) Description of the volume. * `tags` - (Optional) A list of key-value pairs to label the volume. You can add up to 50 tags to a volume @@ -73,15 +74,15 @@ This resource exports the following attributes in addition to the arguments abov * `arn` - Amazon Resource Name (ARN) identifier of the KX volume. * `created_timestamp` - The timestamp at which the volume was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000. * `status` - The status of volume creation. - * `CREATING` – The volume creation is in progress. - * `CREATE_FAILED` – The volume creation has failed. - * `ACTIVE` – The volume is active. - * `UPDATING` – The volume is in the process of being updated. - * `UPDATE_FAILED` – The update action failed. - * `UPDATED` – The volume is successfully updated. - * `DELETING` – The volume is in the process of being deleted. - * `DELETE_FAILED` – The system failed to delete the volume. - * `DELETED` – The volume is successfully deleted. + * `CREATING` - The volume creation is in progress. + * `CREATE_FAILED` - The volume creation has failed. + * `ACTIVE` - The volume is active. + * `UPDATING` - The volume is in the process of being updated. + * `UPDATE_FAILED` - The update action failed. + * `UPDATED` - The volume is successfully updated. + * `DELETING` - The volume is in the process of being deleted. + * `DELETE_FAILED` - The system failed to delete the volume. + * `DELETED` - The volume is successfully deleted. * `status_reason` - The error message when a failed state occurs. * `last_modified_timestamp` - Last timestamp at which the volume was updated in FinSpace. Value determined as epoch time in seconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000. @@ -118,4 +119,4 @@ Using `terraform import`, import an AWS FinSpace Kx Volume using the `id` (envir % terraform import aws_finspace_kx_volume.example n3ceo7wqxoxcti5tujqwzs,my-tf-kx-volume ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/fis_experiment_template.html.markdown b/website/docs/cdktf/python/r/fis_experiment_template.html.markdown index 83bdd4585969..8bc22cbd236a 100644 --- a/website/docs/cdktf/python/r/fis_experiment_template.html.markdown +++ b/website/docs/cdktf/python/r/fis_experiment_template.html.markdown @@ -194,6 +194,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `experiment_options` - (Optional) The experiment options for the experiment template. See [experiment_options](#experiment_options) below for more details! * `tags` - (Optional) Key-value mapping of 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. * `target` - (Optional) Target of an action. See below. @@ -327,4 +328,4 @@ Using `terraform import`, import FIS Experiment Templates using the `id`. For ex % terraform import aws_fis_experiment_template.template EXT123AbCdEfGhIjK ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/flow_log.html.markdown b/website/docs/cdktf/python/r/flow_log.html.markdown index 3a34eb74a526..804cb270ae64 100644 --- a/website/docs/cdktf/python/r/flow_log.html.markdown +++ b/website/docs/cdktf/python/r/flow_log.html.markdown @@ -11,7 +11,7 @@ description: |- # Resource: aws_flow_log Provides a VPC/Subnet/ENI/Transit Gateway/Transit Gateway Attachment Flow Log to capture IP traffic for a specific network -interface, subnet, or VPC. Logs are sent to a CloudWatch Log Group, a S3 Bucket, or Amazon Kinesis Data Firehose +interface, subnet, or VPC. Logs are sent to a CloudWatch Log Group, a S3 Bucket, or Amazon Data Firehose ## Example Usage @@ -82,7 +82,7 @@ class MyConvertedCode(TerraformStack): aws_flow_log_example.override_logical_id("example") ``` -### Amazon Kinesis Data Firehose logging +### Amazon Data Firehose logging ```python # DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -228,26 +228,162 @@ class MyConvertedCode(TerraformStack): aws_flow_log_example.override_logical_id("example") ``` +### Cross-Account Amazon Data Firehose Logging + +The following example shows how to set up a flow log in one AWS account (source) that sends logs to an Amazon Data Firehose delivery stream in another AWS account (destination). +See the [AWS Documentation](https://docs.aws.amazon.com/vpc/latest/userguide/flow-logs-firehose.html). + +```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.data_aws_iam_policy_document import DataAwsIamPolicyDocument +from imports.aws.flow_log import FlowLog +from imports.aws.iam_role import IamRole +from imports.aws.iam_role_policy import IamRolePolicy +from imports.aws.kinesis_firehose_delivery_stream import KinesisFirehoseDeliveryStream +from imports.aws.provider import AwsProvider +from imports.aws.vpc import Vpc +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name, *, destination, name): + super().__init__(scope, name) + AwsProvider(self, "aws", + profile="admin-src" + ) + destination_account = AwsProvider(self, "aws_1", + alias="destination_account", + profile="admin-dst" + ) + dst = KinesisFirehoseDeliveryStream(self, "dst", + provider=destination_account, + tags={ + "LogDeliveryEnabled": "true" + }, + destination=destination, + name=name + ) + src = Vpc(self, "src") + dst_role_policy = DataAwsIamPolicyDocument(self, "dst_role_policy", + statement=[DataAwsIamPolicyDocumentStatement( + actions=["iam:CreateServiceLinkedRole", "firehose:TagDeliveryStream" + ], + effect="Allow", + resources=["*"] + ) + ] + ) + src_assume_role_policy = DataAwsIamPolicyDocument(self, "src_assume_role_policy", + statement=[DataAwsIamPolicyDocumentStatement( + actions=["sts:AssumeRole"], + effect="Allow", + principals=[DataAwsIamPolicyDocumentStatementPrincipals( + identifiers=["delivery.logs.amazonaws.com"], + type="Service" + ) + ] + ) + ] + ) + aws_iam_role_src = IamRole(self, "src_6", + assume_role_policy=Token.as_string(src_assume_role_policy.json), + name="tf-example-mySourceRole" + ) + # 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_iam_role_src.override_logical_id("src") + dst_assume_role_policy = DataAwsIamPolicyDocument(self, "dst_assume_role_policy", + statement=[DataAwsIamPolicyDocumentStatement( + actions=["sts:AssumeRole"], + effect="Allow", + principals=[DataAwsIamPolicyDocumentStatementPrincipals( + identifiers=[Token.as_string(aws_iam_role_src.arn)], + type="AWS" + ) + ] + ) + ] + ) + aws_iam_role_dst = IamRole(self, "dst_8", + assume_role_policy=Token.as_string(dst_assume_role_policy.json), + name="AWSLogDeliveryFirehoseCrossAccountRole", + provider=destination_account + ) + # 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_iam_role_dst.override_logical_id("dst") + aws_iam_role_policy_dst = IamRolePolicy(self, "dst_9", + name="AWSLogDeliveryFirehoseCrossAccountRolePolicy", + policy=Token.as_string(dst_role_policy.json), + provider=destination_account, + role=Token.as_string(aws_iam_role_dst.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. + aws_iam_role_policy_dst.override_logical_id("dst") + src_role_policy = DataAwsIamPolicyDocument(self, "src_role_policy", + statement=[DataAwsIamPolicyDocumentStatement( + actions=["iam:PassRole"], + condition=[DataAwsIamPolicyDocumentStatementCondition( + test="StringEquals", + values=["delivery.logs.amazonaws.com"], + variable="iam:PassedToService" + ), DataAwsIamPolicyDocumentStatementCondition( + test="StringLike", + values=[src.arn], + variable="iam:AssociatedResourceARN" + ) + ], + effect="Allow", + resources=[Token.as_string(aws_iam_role_src.arn)] + ), DataAwsIamPolicyDocumentStatement( + actions=["logs:CreateLogDelivery", "logs:DeleteLogDelivery", "logs:ListLogDeliveries", "logs:GetLogDelivery" + ], + effect="Allow", + resources=["*"] + ), DataAwsIamPolicyDocumentStatement( + actions=["sts:AssumeRole"], + effect="Allow", + resources=[Token.as_string(aws_iam_role_dst.arn)] + ) + ] + ) + aws_flow_log_src = FlowLog(self, "src_11", + deliver_cross_account_role=Token.as_string(aws_iam_role_dst.arn), + iam_role_arn=Token.as_string(aws_iam_role_src.arn), + log_destination=dst.arn, + log_destination_type="kinesis-data-firehose", + traffic_type="ALL", + vpc_id=src.id + ) + # 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_flow_log_src.override_logical_id("src") + IamRolePolicy(self, "src_policy", + name="tf-example-mySourceRolePolicy", + policy=Token.as_string(src_role_policy.json), + role=Token.as_string(aws_iam_role_src.name) + ) +``` + ## Argument Reference This resource supports the following arguments: +* `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). * `traffic_type` - (Required) The type of traffic to capture. Valid values: `ACCEPT`,`REJECT`, `ALL`. -* `deliver_cross_account_role` - (Optional) ARN of the IAM role that allows Amazon EC2 to publish flow logs across accounts. -* `eni_id` - (Optional) Elastic Network Interface ID to attach to -* `iam_role_arn` - (Optional) The ARN for the IAM role that's used to post flow logs to a CloudWatch Logs log group -* `log_destination_type` - (Optional) The type of the logging destination. Valid values: `cloud-watch-logs`, `s3`, `kinesis-data-firehose`. Default: `cloud-watch-logs`. -* `log_destination` - (Optional) The ARN of the logging destination. Either `log_destination` or `log_group_name` must be set. -* `log_group_name` - (Optional) **Deprecated:** Use `log_destination` instead. The name of the CloudWatch log group. Either `log_group_name` or `log_destination` must be set. -* `subnet_id` - (Optional) Subnet ID to attach to -* `transit_gateway_id` - (Optional) Transit Gateway ID to attach to -* `transit_gateway_attachment_id` - (Optional) Transit Gateway Attachment ID to attach to -* `vpc_id` - (Optional) VPC ID to attach to +* `deliver_cross_account_role` - (Optional) ARN of the IAM role in the destination account used for cross-account delivery of flow logs. +* `eni_id` - (Optional) Elastic Network Interface ID to attach to. +* `iam_role_arn` - (Optional) ARN of the IAM role used to post flow logs. Corresponds to `DeliverLogsPermissionArn` in the [AWS API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFlowLogs.html). +* `log_destination_type` - (Optional) Logging destination type. Valid values: `cloud-watch-logs`, `s3`, `kinesis-data-firehose`. Default: `cloud-watch-logs`. +* `log_destination` - (Optional) ARN of the logging destination. +* `subnet_id` - (Optional) Subnet ID to attach to. +* `transit_gateway_id` - (Optional) Transit Gateway ID to attach to. +* `transit_gateway_attachment_id` - (Optional) Transit Gateway Attachment ID to attach to. +* `vpc_id` - (Optional) VPC ID to attach to. * `log_format` - (Optional) The fields to include in the flow log record. Accepted format example: `"$${interface-id} $${srcaddr} $${dstaddr} $${srcport} $${dstport}"`. -* `max_aggregation_interval` - (Optional) The maximum interval of time - during which a flow of packets is captured and aggregated into a flow - log record. Valid Values: `60` seconds (1 minute) or `600` seconds (10 - minutes). Default: `600`. When `transit_gateway_id` or `transit_gateway_attachment_id` is specified, `max_aggregation_interval` *must* be 60 seconds (1 minute). +* `max_aggregation_interval` - (Optional) The maximum interval of time during which a flow of packets is captured and aggregated into a flow log record. + Valid Values: `60` seconds (1 minute) or `600` seconds (10 minutes). Default: `600`. + When `transit_gateway_id` or `transit_gateway_attachment_id` is specified, `max_aggregation_interval` *must* be 60 seconds (1 minute). * `destination_options` - (Optional) Describes the destination options for a flow log. More details below. * `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. @@ -257,7 +393,7 @@ This resource supports the following arguments: Describes the destination options for a flow log. -* `file_format` - (Optional) The format for the flow log. Default value: `plain-text`. Valid values: `plain-text`, `parquet`. +* `file_format` - (Optional) File format for the flow log. Default value: `plain-text`. Valid values: `plain-text`, `parquet`. * `hive_compatible_partitions` - (Optional) Indicates whether to use Hive-compatible prefixes for flow logs stored in Amazon S3. Default value: `false`. * `per_hour_partition` - (Optional) Indicates whether to partition the flow log per hour. This reduces the cost and response time for queries. Default value: `false`. @@ -265,8 +401,8 @@ Describes the destination options for a flow log. This resource exports the following attributes in addition to the arguments above: -* `id` - The Flow Log ID -* `arn` - The ARN of the Flow Log. +* `id` - Flow Log ID. +* `arn` - ARN of the Flow Log. * `tags_all` - A map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). ## Import @@ -294,4 +430,4 @@ Using `terraform import`, import Flow Logs using the `id`. For example: % terraform import aws_flow_log.test_flow_log fl-1a2b3c4d ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/fms_policy.html.markdown b/website/docs/cdktf/python/r/fms_policy.html.markdown index aabe25680cc4..8449c72aec7e 100644 --- a/website/docs/cdktf/python/r/fms_policy.html.markdown +++ b/website/docs/cdktf/python/r/fms_policy.html.markdown @@ -68,6 +68,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required, Forces new resource) The friendly name of the AWS Firewall Manager Policy. * `delete_all_policy_resources` - (Optional) If true, the request will also perform a clean-up process. Defaults to `true`. More information can be found here [AWS Firewall Manager delete policy](https://docs.aws.amazon.com/fms/2018-01-01/APIReference/API_DeletePolicy.html) * `delete_unused_fm_managed_resources` - (Optional) If true, Firewall Manager will automatically remove protections from resources that leave the policy scope. Defaults to `false`. More information can be found here [AWS Firewall Manager policy contents](https://docs.aws.amazon.com/fms/2018-01-01/APIReference/API_Policy.html) @@ -76,6 +77,7 @@ This resource supports the following arguments: * `exclude_resource_tags` - (Required, Forces new resource) A boolean value, if true the tags that are specified in the `resource_tags` are not protected by this policy. If set to false and resource_tags are populated, resources that contain tags will be protected by this policy. * `include_map` - (Optional) A map of lists of accounts and OU's to include in the policy. See the [`include_map`](#include_map-configuration-block) block. * `remediation_enabled` - (Required) A boolean value, indicates if the policy should automatically applied to resources that already exist in the account. +* `resource_tag_logical_operator` - (Optional) Controls how multiple resource tags are combined: with AND, so that a resource must have all tags to be included or excluded, or OR, so that a resource must have at least one tag. The valid values are `AND` and `OR`. * `resource_tags` - (Optional) A map of resource tags, that if present will filter protections on resources based on the exclude_resource_tags. * `resource_type` - (Optional) A resource type to protect. Conflicts with `resource_type_list`. See the [FMS API Reference](https://docs.aws.amazon.com/fms/2018-01-01/APIReference/API_Policy.html#fms-Type-Policy-ResourceType) for more information about supported values. * `resource_type_list` - (Optional) A list of resource types to protect. Conflicts with `resource_type`. See the [FMS API Reference](https://docs.aws.amazon.com/fms/2018-01-01/APIReference/API_Policy.html#fms-Type-Policy-ResourceType) for more information about supported values. Lists with only one element are not supported, instead use `resource_type`. @@ -190,4 +192,4 @@ Using `terraform import`, import Firewall Manager policies using the policy ID. % terraform import aws_fms_policy.example 5be49585-a7e3-4c49-dde1-a179fe4a619a ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/fms_resource_set.html.markdown b/website/docs/cdktf/python/r/fms_resource_set.html.markdown index c053a616a7f8..40aad5a5d0fa 100644 --- a/website/docs/cdktf/python/r/fms_resource_set.html.markdown +++ b/website/docs/cdktf/python/r/fms_resource_set.html.markdown @@ -39,8 +39,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `resource_set` - (Required) Details about the resource set to be created or updated. See [`resource_set` Attribute Reference](#resource_set-attribute-reference) below. ### `resource_set` Attribute Reference @@ -91,4 +92,4 @@ Using `terraform import`, import FMS (Firewall Manager) Resource Set using the ` % terraform import aws_fms_resource_set.example resource_set-id-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/fsx_backup.html.markdown b/website/docs/cdktf/python/r/fsx_backup.html.markdown index 5fb30951d635..2ff293fe6440 100644 --- a/website/docs/cdktf/python/r/fsx_backup.html.markdown +++ b/website/docs/cdktf/python/r/fsx_backup.html.markdown @@ -132,12 +132,13 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: -Note - Only file_system_id or volume_id can be specified. file_system_id is used for Lustre and Windows, volume_id is used for ONTAP. - +* `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). * `file_system_id` - (Optional) The ID of the file system to back up. Required if backing up Lustre or Windows file systems. * `tags` - (Optional) A map of tags to assign to the file system. 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. If you have set `copy_tags_to_backups` to true, and you specify one or more tags, no existing file system tags are copied from the file system to the backup. * `volume_id` - (Optional) The ID of the volume to back up. Required if backing up a ONTAP Volume. +Note - One of `file_system_id` or `volume_id` can be specified. `file_system_id` is used for Lustre and Windows, `volume_id` is used for ONTAP. + ## Attribute Reference This resource exports the following attributes in addition to the arguments above: @@ -181,4 +182,4 @@ Using `terraform import`, import FSx Backups using the `id`. For example: % terraform import aws_fsx_backup.example fs-543ab12b1ca672f33 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/fsx_data_repository_association.html.markdown b/website/docs/cdktf/python/r/fsx_data_repository_association.html.markdown index b9b3d637b695..b409d79be6fb 100644 --- a/website/docs/cdktf/python/r/fsx_data_repository_association.html.markdown +++ b/website/docs/cdktf/python/r/fsx_data_repository_association.html.markdown @@ -70,6 +70,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `batch_import_meta_data_on_create` - (Optional) Set to true to run an import data repository task to import metadata from the data repository to the file system after the data repository association is created. Defaults to `false`. * `data_repository_path` - (Required) The path to the Amazon S3 data repository that will be linked to the file system. The path must be an S3 bucket s3://myBucket/myPrefix/. This path specifies where in the S3 data repository files will be imported from or exported to. The same S3 bucket cannot be linked more than once to the same file system. * `file_system_id` - (Required) The ID of the Amazon FSx file system to on which to create a data repository association. @@ -130,4 +131,4 @@ Using `terraform import`, import FSx Data Repository Associations using the `id` % terraform import aws_fsx_data_repository_association.example dra-0b1cfaeca11088b10 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/fsx_file_cache.html.markdown b/website/docs/cdktf/python/r/fsx_file_cache.html.markdown index d7631484f04f..3a14dfd0462e 100644 --- a/website/docs/cdktf/python/r/fsx_file_cache.html.markdown +++ b/website/docs/cdktf/python/r/fsx_file_cache.html.markdown @@ -67,6 +67,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `copy_tags_to_data_repository_associations` - A boolean flag indicating whether tags for the cache should be copied to data repository associations. This value defaults to false. * `data_repository_association` - See the [`data_repository_association` configuration](#data-repository-association-arguments) block. Max of 8. A list of up to 8 configurations for data repository associations (DRAs) to be created during the cache creation. The DRAs link the cache to either an Amazon S3 data repository or a Network File System (NFS) data repository that supports the NFSv3 protocol. The DRA configurations must meet the following requirements: 1) All configurations on the list must be of the same data repository type, either all S3 or all NFS. A cache can't link to different data repository types at the same time. 2) An NFS DRA must link to an NFS file system that supports the NFSv3 protocol. DRA automatic import and automatic export is not supported. @@ -151,4 +152,4 @@ Using `terraform import`, import Amazon File Cache cache using the resource `id` % terraform import aws_fsx_file_cache.example fc-8012925589 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/fsx_lustre_file_system.html.markdown b/website/docs/cdktf/python/r/fsx_lustre_file_system.html.markdown index fd7eb8368d2f..f60957a35d15 100644 --- a/website/docs/cdktf/python/r/fsx_lustre_file_system.html.markdown +++ b/website/docs/cdktf/python/r/fsx_lustre_file_system.html.markdown @@ -37,12 +37,14 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `subnet_ids` - (Required) A list of IDs for the subnets that the file system will be accessible from. File systems currently support only one subnet. The file server is also launched in that subnet's Availability Zone. The following arguments are optional: +* `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). * `auto_import_policy` - (Optional) How Amazon FSx keeps your file and directory listings up to date as you add or modify objects in your linked S3 bucket. see [Auto Import Data Repo](https://docs.aws.amazon.com/fsx/latest/LustreGuide/autoimport-data-repo.html) for more details. Only supported on `PERSISTENT_1` deployment types. * `automatic_backup_retention_days` - (Optional) The number of days to retain automatic backups. Setting this to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. only valid for `PERSISTENT_1` and `PERSISTENT_2` deployment_type. * `backup_id` - (Optional) The ID of the source backup to create the filesystem from. @@ -174,4 +176,4 @@ class MyConvertedCode(TerraformStack): ) ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/fsx_ontap_file_system.html.markdown b/website/docs/cdktf/python/r/fsx_ontap_file_system.html.markdown index 4c6bc8259f77..0f06a9361e29 100644 --- a/website/docs/cdktf/python/r/fsx_ontap_file_system.html.markdown +++ b/website/docs/cdktf/python/r/fsx_ontap_file_system.html.markdown @@ -106,6 +106,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `storage_capacity` - (Required) The storage capacity (GiB) of the file system. Valid values between `1024` and `196608` for file systems with deployment_type `SINGLE_AZ_1` and `MULTI_AZ_1`. Valid values are between `1024` and `524288` for `MULTI_AZ_2`. Valid values between `1024` (`1024` per ha pair) and `1048576` for file systems with deployment_type `SINGLE_AZ_2`. For `SINGLE_AZ_2`, the `1048576` (1PB) maximum is only supported when using 2 or more ha_pairs, the maximum is `524288` (512TB) when using 1 ha_pair. * `subnet_ids` - (Required) A list of IDs for the subnets that the file system will be accessible from. Up to 2 subnets can be provided. * `preferred_subnet_id` - (Required) The ID for a subnet. A subnet is a range of IP addresses in your virtual private cloud (VPC). @@ -215,4 +216,4 @@ class MyConvertedCode(TerraformStack): ) ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/fsx_ontap_storage_virtual_machine.html.markdown b/website/docs/cdktf/python/r/fsx_ontap_storage_virtual_machine.html.markdown index 9e9bfa3cff71..60eb5eca080f 100644 --- a/website/docs/cdktf/python/r/fsx_ontap_storage_virtual_machine.html.markdown +++ b/website/docs/cdktf/python/r/fsx_ontap_storage_virtual_machine.html.markdown @@ -70,6 +70,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `active_directory_configuration` - (Optional) Configuration block that Amazon FSx uses to join the FSx ONTAP Storage Virtual Machine(SVM) to your Microsoft Active Directory (AD) directory. Detailed below. * `file_system_id` - (Required) The ID of the Amazon FSx ONTAP File System that this SVM will be created on. * `name` - (Required) The name of the SVM. You can use a maximum of 47 alphanumeric characters, plus the underscore (_) special character. @@ -176,4 +177,4 @@ class MyConvertedCode(TerraformStack): ) ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/fsx_ontap_volume.html.markdown b/website/docs/cdktf/python/r/fsx_ontap_volume.html.markdown index d6e1bcd4b8e8..e6860b43fadb 100644 --- a/website/docs/cdktf/python/r/fsx_ontap_volume.html.markdown +++ b/website/docs/cdktf/python/r/fsx_ontap_volume.html.markdown @@ -76,6 +76,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `aggregate_configuration` - (Optional) The Aggregate configuration only applies to `FLEXGROUP` volumes. See [`aggregate_configuration` Block] for details. * `bypass_snaplock_enterprise_retention` - (Optional) Setting this to `true` allows a SnapLock administrator to delete an FSx for ONTAP SnapLock Enterprise volume with unexpired write once, read many (WORM) files. This configuration must be applied separately before attempting to delete the resource to have the desired behavior. Defaults to `false`. * `copy_tags_to_backups` - (Optional) A boolean flag indicating whether tags for the volume should be copied to backups. This value defaults to `false`. @@ -200,4 +201,4 @@ Using `terraform import`, import FSx ONTAP volume using the `id`. For example: % terraform import aws_fsx_ontap_volume.example fsvol-12345678abcdef123 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/fsx_openzfs_file_system.html.markdown b/website/docs/cdktf/python/r/fsx_openzfs_file_system.html.markdown index 3c15e2b10d4c..9382c0dd41a0 100644 --- a/website/docs/cdktf/python/r/fsx_openzfs_file_system.html.markdown +++ b/website/docs/cdktf/python/r/fsx_openzfs_file_system.html.markdown @@ -46,6 +46,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `automatic_backup_retention_days` - (Optional) The number of days to retain automatic backups. Setting this to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. * `backup_id` - (Optional) The ID of the source backup to create the filesystem from. * `copy_tags_to_backups` - (Optional) A boolean flag indicating whether tags for the file system should be copied to backups. The default value is false. @@ -177,4 +178,4 @@ class MyConvertedCode(TerraformStack): ) ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/fsx_openzfs_snapshot.html.markdown b/website/docs/cdktf/python/r/fsx_openzfs_snapshot.html.markdown index 8fef768fe059..eb191f186808 100644 --- a/website/docs/cdktf/python/r/fsx_openzfs_snapshot.html.markdown +++ b/website/docs/cdktf/python/r/fsx_openzfs_snapshot.html.markdown @@ -84,6 +84,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) The name of the Snapshot. You can use a maximum of 203 alphanumeric characters plus either _ or - or : or . for the name. * `tags` - (Optional) A map of tags to assign to the file system. 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. If you have set `copy_tags_to_backups` to true, and you specify one or more tags, no existing file system tags are copied from the file system to the backup. * `volume_id` - (Optional) The ID of the volume to snapshot. This can be the root volume or a child volume. @@ -129,4 +130,4 @@ Using `terraform import`, import FSx OpenZFS snapshot using the `id`. For exampl % terraform import aws_fsx_openzfs_snapshot.example fs-543ab12b1ca672f33 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/fsx_openzfs_volume.html.markdown b/website/docs/cdktf/python/r/fsx_openzfs_volume.html.markdown index 250b76b4815a..c4208c628d83 100644 --- a/website/docs/cdktf/python/r/fsx_openzfs_volume.html.markdown +++ b/website/docs/cdktf/python/r/fsx_openzfs_volume.html.markdown @@ -37,6 +37,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) The name of the Volume. You can use a maximum of 203 alphanumeric characters, plus the underscore (_) special character. * `parent_volume_id` - (Required) The volume id of volume that will be the parent volume for the volume being created, this could be the root volume created from the `aws_fsx_openzfs_file_system` resource with the `root_volume_id` or the `id` property of another `aws_fsx_openzfs_volume`. * `copy_tags_to_snapshots` - (Optional) A boolean flag indicating whether tags for the file system should be copied to snapshots. The default value is false. @@ -120,4 +121,4 @@ Using `terraform import`, import FSx Volumes using the `id`. For example: % terraform import aws_fsx_openzfs_volume.example fsvol-543ab12b1ca672f33 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/fsx_s3_access_point_attachment.html.markdown b/website/docs/cdktf/python/r/fsx_s3_access_point_attachment.html.markdown new file mode 100644 index 000000000000..679b6d63e710 --- /dev/null +++ b/website/docs/cdktf/python/r/fsx_s3_access_point_attachment.html.markdown @@ -0,0 +1,135 @@ +--- +subcategory: "FSx" +layout: "aws" +page_title: "AWS: aws_fsx_s3_access_point_attachment" +description: |- + Manages an Amazon FSx S3 Access Point attachment. +--- + + + +# Resource: aws_fsx_s3_access_point_attachment + +Manages an Amazon FSx S3 Access Point attachment. + +## 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 Token, TerraformStack +# +# Provider bindings are generated by running `cdktf get`. +# See https://cdk.tf/provider-generation for more details. +# +from imports.aws.fsx_s3_access_point_attachment import FsxS3AccessPointAttachment +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + FsxS3AccessPointAttachment(self, "example", + name="example-attachment", + openzfs_configuration=[FsxS3AccessPointAttachmentOpenzfsConfiguration( + file_system_identity=[FsxS3AccessPointAttachmentOpenzfsConfigurationFileSystemIdentity( + posix_user=[FsxS3AccessPointAttachmentOpenzfsConfigurationFileSystemIdentityPosixUser( + gid=1001, + uid=1001 + ) + ], + type="POSIX" + ) + ], + volume_id=Token.as_string(aws_fsx_openzfs_volume_example.id) + ) + ], + type="OPENZFS" + ) +``` + +## Argument Reference + +The following arguments are required: + +* `name` - (Required) Name of the S3 access point. +* `openzfs_configuration` - (Required) Configuration to use when creating and attaching an S3 access point to an FSx for OpenZFS volume. See [`openzfs_configuration` Block](#openzfs_configuration-block) for details. +* `type` - (Required) Type of S3 access point. Valid values: `OpenZFS`. + +The following arguments are optional: + +* `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). +* `s3_access_point` - (Optional) S3 access point configuration. See [`s3_access_point` Block](#s3_access_point-block) for details. + +### `openzfs_configuration` Block + +The `openzfs_configuration` configuration block supports the following arguments: + +* `file_system_identity` - (Required) File system user identity to use for authorizing file read and write requests that are made using the S3 access point. See [`file_system_identity` Block](#file_system_identity-block) for details. +* `volume_id` - (Required) ID of the FSx for OpenZFS volume to which the S3 access point is attached. + +### `file_system_identity` Block + +The `file_system_identity` configuration block supports the following arguments: + +* `posix_user` - (Required) UID and GIDs of the file system POSIX user. See [`posix_user` Block](#posix_user-block) for details. +* `type` - (Required) FSx for OpenZFS user identity type. Valid values: `POSIX`. + +### `posix_user` Block + +The `posix_user` configuration block supports the following arguments: + +* `gid` - (Required) GID of the file system user. +* `secondary_gids` - (Optional) List of secondary GIDs for the file system user.. +* `uid` - (Required) UID of the file system user. + +### `s3_access_point` Block + +The `s3_access_point` configuration block supports the following arguments: + +* `policy` - (Required) Access policy associated with the S3 access point configuration. +* `vpc_configuration` - (Optional) Amazon S3 restricts access to the S3 access point to requests made from the specified VPC. See [`vpc_configuration` Block](#vpc_configuration-block) for details. + +### `vpc_configuration` Block + +The `vpc_configuration` configuration block supports the following arguments: + +* `vpc_id` - (Required) VPC ID. + +## Attribute Reference + +This resource exports the following attributes in addition to the arguments above: + +* `s3_access_point_alias` - S3 access point's alias. +* `s3_access_point_arn` - S3 access point's ARN. + +## Timeouts + +[Configuration options](https://developer.hashicorp.com/terraform/language/resources/syntax#operation-timeouts): + +* `create` - (Default `15m`) +* `delete` - (Default `15m`) + +## Import + +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import FSx S3 Access Point attachments using the `name`. 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.fsx_s3_access_point_attachment import FsxS3AccessPointAttachment +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + FsxS3AccessPointAttachment.generate_config_for_import(self, "example", "example-attachment") +``` + +Using `terraform import`, import FSx S3 Access Point attachments using the `name`. For example: + +```console +% terraform import aws_fsx_s3_access_point_attachment.example example-attachment +``` + + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/fsx_windows_file_system.html.markdown b/website/docs/cdktf/python/r/fsx_windows_file_system.html.markdown index 77a593bf09cd..b3a247c8a27a 100644 --- a/website/docs/cdktf/python/r/fsx_windows_file_system.html.markdown +++ b/website/docs/cdktf/python/r/fsx_windows_file_system.html.markdown @@ -80,6 +80,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `active_directory_id` - (Optional) The ID for an existing Microsoft Active Directory instance that the file system should join when it's created. Cannot be specified with `self_managed_active_directory`. * `aliases` - (Optional) An array DNS alias names that you want to associate with the Amazon FSx file system. For more information, see [Working with DNS Aliases](https://docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-dns-aliases.html) * `audit_log_configuration` - (Optional) The configuration that Amazon FSx for Windows File Server uses to audit and log user accesses of files, folders, and file shares on the Amazon FSx for Windows File Server file system. See [`audit_log_configuration` Block](#audit_log_configuration-block) for details. @@ -198,4 +199,4 @@ class MyConvertedCode(TerraformStack): ) ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/gamelift_alias.html.markdown b/website/docs/cdktf/python/r/gamelift_alias.html.markdown index ef4677127174..0853b1b4a867 100644 --- a/website/docs/cdktf/python/r/gamelift_alias.html.markdown +++ b/website/docs/cdktf/python/r/gamelift_alias.html.markdown @@ -40,6 +40,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) Name of the alias. * `description` - (Optional) Description of the alias. * `routing_strategy` - (Required) Specifies the fleet and/or routing type to use for the alias. @@ -86,4 +87,4 @@ Using `terraform import`, import GameLift Aliases using the ID. For example: % terraform import aws_gamelift_alias.example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/gamelift_build.html.markdown b/website/docs/cdktf/python/r/gamelift_build.html.markdown index dbd019d5a1c7..b307aa14cfcf 100644 --- a/website/docs/cdktf/python/r/gamelift_build.html.markdown +++ b/website/docs/cdktf/python/r/gamelift_build.html.markdown @@ -41,6 +41,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) Name of the build * `operating_system` - (Required) Operating system that the game server binaries are built to run on. Valid values: `WINDOWS_2012`, `AMAZON_LINUX`, `AMAZON_LINUX_2`, `WINDOWS_2016`, `AMAZON_LINUX_2023`. * `storage_location` - (Required) Information indicating where your game build files are stored. See below. @@ -89,4 +90,4 @@ Using `terraform import`, import GameLift Builds using the ID. For example: % terraform import aws_gamelift_build.example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/gamelift_fleet.html.markdown b/website/docs/cdktf/python/r/gamelift_fleet.html.markdown index ceae405a8db6..98493fad6f88 100644 --- a/website/docs/cdktf/python/r/gamelift_fleet.html.markdown +++ b/website/docs/cdktf/python/r/gamelift_fleet.html.markdown @@ -34,7 +34,8 @@ resource "aws_gamelift_fleet" "example" { This resource supports the following arguments: -* `build_id` - (Optional) ID of the GameLift Build to be deployed on the fleet. +* `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). +* `build_id` - (Optional) ID of the GameLift Build to be deployed on the fleet. Conflicts with `script_id`. * `certificate_configuration` - (Optional) Prompts GameLift to generate a TLS/SSL certificate for the fleet. See [certificate_configuration](#certificate_configuration). * `description` - (Optional) Human-readable description of the fleet. * `ec2_inbound_permission` - (Optional) Range of IP addresses and port settings that permit inbound traffic to access server processes running on the fleet. See below. @@ -46,7 +47,7 @@ This resource supports the following arguments: * `new_game_session_protection_policy` - (Optional) Game session protection policy to apply to all instances in this fleetE.g., `FullProtection`. Defaults to `NoProtection`. * `resource_creation_limit_policy` - (Optional) Policy that limits the number of game sessions an individual player can create over a span of time for this fleet. See below. * `runtime_configuration` - (Optional) Instructions for launching server processes on each instance in the fleet. See below. -* `script_id` - (Optional) ID of the GameLift Script to be deployed on the fleet. +* `script_id` - (Optional) ID of the GameLift Script to be deployed on the fleet. Conflicts with `build_id`. * `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. ### Nested Fields @@ -122,4 +123,4 @@ Using `terraform import`, import GameLift Fleets using the ID. For example: % terraform import aws_gamelift_fleet.example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/gamelift_game_server_group.html.markdown b/website/docs/cdktf/python/r/gamelift_game_server_group.html.markdown index 923a5a2df0c8..326792c8aff4 100644 --- a/website/docs/cdktf/python/r/gamelift_game_server_group.html.markdown +++ b/website/docs/cdktf/python/r/gamelift_game_server_group.html.markdown @@ -138,6 +138,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `balancing_strategy` - (Optional) Indicates how GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances. Valid values: `SPOT_ONLY`, `SPOT_PREFERRED`, `ON_DEMAND_ONLY`. Defaults to `SPOT_PREFERRED`. * `game_server_group_name` - (Required) Name of the game server group. @@ -236,4 +237,4 @@ Using `terraform import`, import GameLift Game Server Group using the `name`. Fo % terraform import aws_gamelift_game_server_group.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/gamelift_game_session_queue.html.markdown b/website/docs/cdktf/python/r/gamelift_game_session_queue.html.markdown index b640115c75cc..adfa876b0d59 100644 --- a/website/docs/cdktf/python/r/gamelift_game_session_queue.html.markdown +++ b/website/docs/cdktf/python/r/gamelift_game_session_queue.html.markdown @@ -45,6 +45,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) Name of the session queue. * `timeout_in_seconds` - (Required) Maximum time a game session request can remain in the queue. * `custom_event_data` - (Optional) Information to be added to all events that are related to this game session queue. @@ -92,4 +93,4 @@ Using `terraform import`, import GameLift Game Session Queues using their `name` % terraform import aws_gamelift_game_session_queue.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/gamelift_script.html.markdown b/website/docs/cdktf/python/r/gamelift_script.html.markdown index 446bf4ea4d84..1101e3c33a84 100644 --- a/website/docs/cdktf/python/r/gamelift_script.html.markdown +++ b/website/docs/cdktf/python/r/gamelift_script.html.markdown @@ -40,6 +40,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) Name of the script * `storage_location` - (Optional) Information indicating where your game script files are stored. See below. * `version` - (Optional) Version that is associated with this script. @@ -88,4 +89,4 @@ Using `terraform import`, import GameLift Scripts using the ID. For example: % terraform import aws_gamelift_script.example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/glacier_vault.html.markdown b/website/docs/cdktf/python/r/glacier_vault.html.markdown index 487e87bd600e..01b798c167bc 100644 --- a/website/docs/cdktf/python/r/glacier_vault.html.markdown +++ b/website/docs/cdktf/python/r/glacier_vault.html.markdown @@ -67,6 +67,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) The name of the Vault. Names can be between 1 and 255 characters long and the valid characters are a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), and '.' (period). * `access_policy` - (Optional) The policy document. This is a JSON formatted string. The heredoc syntax or `file` function is helpful here. Use the [Glacier Developer Guide](https://docs.aws.amazon.com/amazonglacier/latest/dev/vault-access-policy.html) for more information on Glacier Vault Policy @@ -111,4 +112,4 @@ Using `terraform import`, import Glacier Vaults using the `name`. For example: % terraform import aws_glacier_vault.archive my_archive ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/glacier_vault_lock.html.markdown b/website/docs/cdktf/python/r/glacier_vault_lock.html.markdown index dcbbdddb9fd6..7e93db636399 100644 --- a/website/docs/cdktf/python/r/glacier_vault_lock.html.markdown +++ b/website/docs/cdktf/python/r/glacier_vault_lock.html.markdown @@ -89,6 +89,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `complete_lock` - (Required) Boolean whether to permanently apply this Glacier Lock Policy. Once completed, this cannot be undone. If set to `false`, the Glacier Lock Policy remains in a testing mode for 24 hours. After that time, the Glacier Lock Policy is automatically removed by Glacier and the Terraform resource will show as needing recreation. Changing this from `false` to `true` will show as resource recreation, which is expected. Changing this from `true` to `false` is not possible unless the Glacier Vault is recreated at the same time. * `policy` - (Required) JSON string containing the IAM policy to apply as the Glacier Vault Lock policy. * `vault_name` - (Required) The name of the Glacier Vault. @@ -125,4 +126,4 @@ Using `terraform import`, import Glacier Vault Locks using the Glacier Vault nam % terraform import aws_glacier_vault_lock.example example-vault ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/globalaccelerator_cross_account_attachment.html.markdown b/website/docs/cdktf/python/r/globalaccelerator_cross_account_attachment.html.markdown index 18222a027531..c7e5d32ec89a 100644 --- a/website/docs/cdktf/python/r/globalaccelerator_cross_account_attachment.html.markdown +++ b/website/docs/cdktf/python/r/globalaccelerator_cross_account_attachment.html.markdown @@ -93,7 +93,7 @@ This resource exports the following attributes in addition to the arguments abov ## Import -In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import Global Accelerator Cross Account Attachment using the `example_id_arg`. For example: +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import Global Accelerator Cross Account Attachment using the `arn`. For example: ```python # DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -110,10 +110,10 @@ class MyConvertedCode(TerraformStack): GlobalacceleratorCrossAccountAttachment.generate_config_for_import(self, "example", "arn:aws:globalaccelerator::012345678910:attachment/01234567-abcd-8910-efgh-123456789012") ``` -Using `terraform import`, import Global Accelerator Cross Account Attachment using the `example_id_arg`. For example: +Using `terraform import`, import Global Accelerator Cross Account Attachment using the `arn`. For example: ```console % terraform import aws_globalaccelerator_cross_account_attachment.example arn:aws:globalaccelerator::012345678910:attachment/01234567-abcd-8910-efgh-123456789012 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/glue_catalog_database.html.markdown b/website/docs/cdktf/python/r/glue_catalog_database.html.markdown index 056825dd66eb..989ce227972c 100644 --- a/website/docs/cdktf/python/r/glue_catalog_database.html.markdown +++ b/website/docs/cdktf/python/r/glue_catalog_database.html.markdown @@ -61,6 +61,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `catalog_id` - (Optional) ID of the Glue Catalog to create the database in. If omitted, this defaults to the AWS Account ID. * `create_table_default_permission` - (Optional) Creates a set of default permissions on the table for principals. See [`create_table_default_permission`](#create_table_default_permission) below. * `description` - (Optional) Description of the database. @@ -124,4 +125,4 @@ Using `terraform import`, import Glue Catalog Databases using the `catalog_id:na % terraform import aws_glue_catalog_database.database 123456789012:my_database ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/glue_catalog_table.html.markdown b/website/docs/cdktf/python/r/glue_catalog_table.html.markdown index 4cdeaa0f1726..a2e6559b29f2 100644 --- a/website/docs/cdktf/python/r/glue_catalog_table.html.markdown +++ b/website/docs/cdktf/python/r/glue_catalog_table.html.markdown @@ -100,6 +100,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `catalog_id` - (Optional) ID of the Glue Catalog and database to create the table in. If omitted, this defaults to the AWS Account ID plus the database name. * `description` - (Optional) Description of the table. * `owner` - (Optional) Owner of the table. @@ -142,6 +143,7 @@ To add an index to an existing table, see the [`glue_partition_index` resource]( * `comment` - (Optional) Free-form text comment. * `name` - (Required) Name of the Partition Key. +* `parameters` - (Optional) Map of key-value pairs. * `type` - (Optional) Datatype of data in the Partition Key. ### storage_descriptor @@ -236,4 +238,4 @@ Using `terraform import`, import Glue Tables using the catalog ID (usually AWS a % terraform import aws_glue_catalog_table.MyTable 123456789012:MyDatabase:MyTable ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/glue_catalog_table_optimizer.html.markdown b/website/docs/cdktf/python/r/glue_catalog_table_optimizer.html.markdown index 3bfe1e1a2599..34bdf645c2b8 100644 --- a/website/docs/cdktf/python/r/glue_catalog_table_optimizer.html.markdown +++ b/website/docs/cdktf/python/r/glue_catalog_table_optimizer.html.markdown @@ -59,14 +59,14 @@ class MyConvertedCode(TerraformStack): catalog_id="123456789012", configuration=[GlueCatalogTableOptimizerConfiguration( enabled=True, - retention_configuration=[{ - "iceberg_configuration": [{ - "clean_expired_files": True, - "number_of_snapshots_to_retain": 3, - "snapshot_retention_period_in_days": 7 - } + retention_configuration=[GlueCatalogTableOptimizerConfigurationRetentionConfiguration( + iceberg_configuration=[GlueCatalogTableOptimizerConfigurationRetentionConfigurationIcebergConfiguration( + clean_expired_files=True, + number_of_snapshots_to_retain=3, + snapshot_retention_period_in_days=7 + ) ] - } + ) ], role_arn="arn:aws:iam::123456789012:role/example-role" ) @@ -95,13 +95,13 @@ class MyConvertedCode(TerraformStack): catalog_id="123456789012", configuration=[GlueCatalogTableOptimizerConfiguration( enabled=True, - orphan_file_deletion_configuration=[{ - "iceberg_configuration": [{ - "location": "s3://example-bucket/example_table/", - "orphan_file_retention_period_in_days": 7 - } + orphan_file_deletion_configuration=[GlueCatalogTableOptimizerConfigurationOrphanFileDeletionConfiguration( + iceberg_configuration=[GlueCatalogTableOptimizerConfigurationOrphanFileDeletionConfigurationIcebergConfiguration( + location="s3://example-bucket/example_table/", + orphan_file_retention_period_in_days=7 + ) ] - } + ) ], role_arn="arn:aws:iam::123456789012:role/example-role" ) @@ -114,8 +114,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `catalog_id` - (Required) The Catalog ID of the table. * `configuration` - (Required) A configuration block that defines the table optimizer settings. See [Configuration](#configuration) for additional details. * `database_name` - (Required) The name of the database in the catalog in which the table resides. @@ -171,4 +172,4 @@ Using `terraform import`, import Glue Catalog Table Optimizer using the `catalog % terraform import aws_glue_catalog_table_optimizer.example 123456789012,example_database,example_table,compaction ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/glue_classifier.html.markdown b/website/docs/cdktf/python/r/glue_classifier.html.markdown index 28f95baa4061..d95dc8e7588f 100644 --- a/website/docs/cdktf/python/r/glue_classifier.html.markdown +++ b/website/docs/cdktf/python/r/glue_classifier.html.markdown @@ -115,11 +115,12 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `csv_classifier` - (Optional) A classifier for CSV content. Defined below. -* `grok_classifier` – (Optional) A classifier that uses grok patterns. Defined below. -* `json_classifier` – (Optional) A classifier for JSON content. Defined below. -* `name` – (Required) The name of the classifier. -* `xml_classifier` – (Optional) A classifier for XML content. Defined below. +* `grok_classifier` - (Optional) A classifier that uses grok patterns. Defined below. +* `json_classifier` - (Optional) A classifier for JSON content. Defined below. +* `name` - (Required) The name of the classifier. +* `xml_classifier` - (Optional) A classifier for XML content. Defined below. ### csv_classifier @@ -131,7 +132,7 @@ This resource supports the following arguments: * `disable_value_trimming` - (Optional) Specifies whether to trim column values. * `header` - (Optional) A list of strings representing column names. * `quote_symbol` - (Optional) A custom symbol to denote what combines content into a single column value. It must be different from the column delimiter. -* `serde` – (Optional) The SerDe for processing CSV. Valid values are `OpenCSVSerDe`, `LazySimpleSerDe`, `None`. +* `serde` - (Optional) The SerDe for processing CSV. Valid values are `OpenCSVSerDe`, `LazySimpleSerDe`, `None`. ### grok_classifier @@ -179,4 +180,4 @@ Using `terraform import`, import Glue Classifiers using their name. For example: % terraform import aws_glue_classifier.MyClassifier MyClassifier ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/glue_connection.html.markdown b/website/docs/cdktf/python/r/glue_connection.html.markdown index f28a70bba82e..f03a5431a70d 100644 --- a/website/docs/cdktf/python/r/glue_connection.html.markdown +++ b/website/docs/cdktf/python/r/glue_connection.html.markdown @@ -406,20 +406,22 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This resource supports the following arguments: -* `name` – (Required) Name of the connection. +* `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). +* `name` - (Required) Name of the connection. The following arguments are optional: -* `catalog_id` – (Optional) ID of the Data Catalog in which to create the connection. If none is supplied, the AWS account ID is used by default. -* `athena_properties` – (Optional) Map of key-value pairs used as connection properties specific to the Athena compute environment. -* `connection_properties` – (Optional) Map of key-value pairs used as parameters for this connection. For more information, see the [AWS Documentation](https://docs.aws.amazon.com/glue/latest/dg/connection-properties.html). +* `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). +* `catalog_id` - (Optional) ID of the Data Catalog in which to create the connection. If none is supplied, the AWS account ID is used by default. +* `athena_properties` - (Optional) Map of key-value pairs used as connection properties specific to the Athena compute environment. +* `connection_properties` - (Optional) Map of key-value pairs used as parameters for this connection. For more information, see the [AWS Documentation](https://docs.aws.amazon.com/glue/latest/dg/connection-properties.html). **Note:** Some connection types require the `SparkProperties` property with a JSON document that contains the actual connection properties. For specific examples, refer to [Example Usage](#example-usage). -* `connection_type` – (Optional) Type of the connection. Valid values: `AZURECOSMOS`, `AZURESQL`, `BIGQUERY`, `CUSTOM`, `DYNAMODB`, `JDBC`, `KAFKA`, `MARKETPLACE`, `MONGODB`, `NETWORK`, `OPENSEARCH`, `SNOWFLAKE`. Defaults to `JDBC`. -* `description` – (Optional) Description of the connection. -* `match_criteria` – (Optional) List of criteria that can be used in selecting this connection. +* `connection_type` - (Optional) Type of the connection. Valid values: `AZURECOSMOS`, `AZURESQL`, `BIGQUERY`, `CUSTOM`, `DYNAMODB`, `JDBC`, `KAFKA`, `MARKETPLACE`, `MONGODB`, `NETWORK`, `OPENSEARCH`, `SNOWFLAKE`. Defaults to `JDBC`. +* `description` - (Optional) Description of the connection. +* `match_criteria` - (Optional) List of criteria that can be used in selecting this connection. * `physical_connection_requirements` - (Optional) Map of physical connection requirements, such as VPC and SecurityGroup. See [`physical_connection_requirements` Block](#physical_connection_requirements-block) for details. * `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. @@ -464,4 +466,4 @@ Using `terraform import`, import Glue Connections using the `CATALOG-ID` (AWS ac % terraform import aws_glue_connection.MyConnection 123456789012:MyConnection ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/glue_crawler.html.markdown b/website/docs/cdktf/python/r/glue_crawler.html.markdown index 61c70bbe2795..9db3c9162963 100644 --- a/website/docs/cdktf/python/r/glue_crawler.html.markdown +++ b/website/docs/cdktf/python/r/glue_crawler.html.markdown @@ -189,6 +189,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `database_name` (Required) Glue database where results are written. * `name` (Required) Name of the crawler. * `role` (Required) The IAM role friendly name (including path without leading slash), or ARN of an IAM role, used by the crawler to access other resources. @@ -326,4 +327,4 @@ Using `terraform import`, import Glue Crawlers using `name`. For example: % terraform import aws_glue_crawler.MyJob MyJob ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/glue_data_catalog_encryption_settings.html.markdown b/website/docs/cdktf/python/r/glue_data_catalog_encryption_settings.html.markdown index 8f098bb9b8f2..3388a6e7a4db 100644 --- a/website/docs/cdktf/python/r/glue_data_catalog_encryption_settings.html.markdown +++ b/website/docs/cdktf/python/r/glue_data_catalog_encryption_settings.html.markdown @@ -45,8 +45,9 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: -* `data_catalog_encryption_settings` – (Required) The security configuration to set. see [Data Catalog Encryption Settings](#data_catalog_encryption_settings). -* `catalog_id` – (Optional) The ID of the Data Catalog to set the security configuration for. If none is provided, the AWS account ID is used by default. +* `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). +* `data_catalog_encryption_settings` - (Required) The security configuration to set. see [Data Catalog Encryption Settings](#data_catalog_encryption_settings). +* `catalog_id` - (Optional) The ID of the Data Catalog to set the security configuration for. If none is provided, the AWS account ID is used by default. ### data_catalog_encryption_settings @@ -95,4 +96,4 @@ Using `terraform import`, import Glue Data Catalog Encryption Settings using `CA % terraform import aws_glue_data_catalog_encryption_settings.example 123456789012 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/glue_data_quality_ruleset.html.markdown b/website/docs/cdktf/python/r/glue_data_quality_ruleset.html.markdown index 72a28e6d7d81..61da1c84fce9 100644 --- a/website/docs/cdktf/python/r/glue_data_quality_ruleset.html.markdown +++ b/website/docs/cdktf/python/r/glue_data_quality_ruleset.html.markdown @@ -106,6 +106,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `description` - (Optional) Description of the data quality ruleset. * `name` - (Required, Forces new resource) Name of the data quality ruleset. * `ruleset` - (Optional) A Data Quality Definition Language (DQDL) ruleset. For more information, see the AWS Glue developer guide. @@ -153,4 +154,4 @@ Using `terraform import`, import Glue Data Quality Ruleset using the `name`. For % terraform import aws_glue_data_quality_ruleset.example exampleName ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/glue_dev_endpoint.html.markdown b/website/docs/cdktf/python/r/glue_dev_endpoint.html.markdown index 894270b5c86f..3af17439e8f8 100644 --- a/website/docs/cdktf/python/r/glue_dev_endpoint.html.markdown +++ b/website/docs/cdktf/python/r/glue_dev_endpoint.html.markdown @@ -64,6 +64,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `arguments` - (Optional) A map of arguments used to configure the endpoint. * `extra_jars_s3_path` - (Optional) Path to one or more Java Jars in an S3 bucket that should be loaded in this endpoint. * `extra_python_libs_s3_path` - (Optional) Path(s) to one or more Python libraries in an S3 bucket that should be loaded in this endpoint. Multiple values must be complete paths separated by a comma. @@ -121,4 +122,4 @@ Using `terraform import`, import a Glue Development Endpoint using the `name`. F % terraform import aws_glue_dev_endpoint.example foo ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/glue_job.html.markdown b/website/docs/cdktf/python/r/glue_job.html.markdown index fface3745d00..9d59519e862e 100644 --- a/website/docs/cdktf/python/r/glue_job.html.markdown +++ b/website/docs/cdktf/python/r/glue_job.html.markdown @@ -268,34 +268,29 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: -* `command` – (Required) The command of the job. Defined below. -* `connections` – (Optional) The list of connections used for this job. -* `default_arguments` – (Optional) The map of default arguments for this job. You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes. For information about how to specify and consume your own Job arguments, see the [Calling AWS Glue APIs in Python](http://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-calling.html) topic in the developer guide. For information about the key-value pairs that AWS Glue consumes to set up your job, see the [Special Parameters Used by AWS Glue](http://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-glue-arguments.html) topic in the developer guide. -* `non_overridable_arguments` – (Optional) Non-overridable arguments for this job, specified as name-value pairs. -* `description` – (Optional) Description of the job. -* `execution_property` – (Optional) Execution property of the job. Defined below. +* `command` - (Required) The command of the job. Defined below. +* `connections` - (Optional) The list of connections used for this job. +* `default_arguments` - (Optional) The map of default arguments for this job. You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes. For information about how to specify and consume your own Job arguments, see the [Calling AWS Glue APIs in Python](http://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-calling.html) topic in the developer guide. For information about the key-value pairs that AWS Glue consumes to set up your job, see the [Special Parameters Used by AWS Glue](http://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-glue-arguments.html) topic in the developer guide. +* `description` - (Optional) Description of the job. +* `execution_class` - (Optional) Indicates whether the job is run with a standard or flexible execution class. The standard execution class is ideal for time-sensitive workloads that require fast job startup and dedicated resources. Valid value: `FLEX`, `STANDARD`. +* `execution_property` - (Optional) Execution property of the job. Defined below. * `glue_version` - (Optional) The version of glue to use, for example "1.0". Ray jobs should set this to 4.0 or greater. For information about available versions, see the [AWS Glue Release Notes](https://docs.aws.amazon.com/glue/latest/dg/release-notes.html). +* `job_mode` - (Optional) Describes how a job was created. Valid values are `SCRIPT`, `NOTEBOOK` and `VISUAL`. * `job_run_queuing_enabled` - (Optional) Specifies whether job run queuing is enabled for the job runs for this job. A value of true means job run queuing is enabled for the job runs. If false or not populated, the job runs will not be considered for queueing. -* `execution_class` - (Optional) Indicates whether the job is run with a standard or flexible execution class. The standard execution class is ideal for time-sensitive workloads that require fast job startup and dedicated resources. Valid value: `FLEX`, `STANDARD`. -* `maintenance_window` – (Optional) Specifies the day of the week and hour for the maintenance window for streaming jobs. -* `max_capacity` – (Optional) The maximum number of AWS Glue data processing units (DPUs) that can be allocated when this job runs. `Required` when `pythonshell` is set, accept either `0.0625` or `1.0`. Use `number_of_workers` and `worker_type` arguments instead with `glue_version` `2.0` and above. -* `max_retries` – (Optional) The maximum number of times to retry this job if it fails. -* `name` – (Required) The name you assign to this job. It must be unique in your account. +* `maintenance_window` - (Optional) Specifies the day of the week and hour for the maintenance window for streaming jobs. +* `max_capacity` - (Optional) The maximum number of AWS Glue data processing units (DPUs) that can be allocated when this job runs. `Required` when `pythonshell` is set, accept either `0.0625` or `1.0`. Use `number_of_workers` and `worker_type` arguments instead with `glue_version` `2.0` and above. +* `max_retries` - (Optional) The maximum number of times to retry this job if it fails. +* `name` - (Required) The name you assign to this job. It must be unique in your account. +* `non_overridable_arguments` - (Optional) Non-overridable arguments for this job, specified as name-value pairs. * `notification_property` - (Optional) Notification property of the job. Defined below. -* `role_arn` – (Required) The ARN of the IAM role associated with this job. +* `number_of_workers` - (Optional) The number of workers of a defined workerType that are allocated when a job runs. +* `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). +* `role_arn` - (Required) The ARN of the IAM role associated with this job. * `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) The job timeout in minutes. The default is 2880 minutes (48 hours) for `glueetl` and `pythonshell` jobs, and null (unlimited) for `gluestreaming` jobs. +* `timeout` - (Optional) The job timeout in minutes. The default is 2880 minutes (48 hours) for `glueetl` and `pythonshell` jobs, and null (unlimited) for `gluestreaming` jobs. * `security_configuration` - (Optional) The name of the Security Configuration to be associated with the job. * `source_control_details` - (Optional) The details for a source control configuration for a job, allowing synchronization of job artifacts to or from a remote repository. Defined below. -* `worker_type` - (Optional) The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, G.2X, or G.025X for Spark jobs. Accepts the value Z.2X for Ray jobs. - * For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker. - * For the G.1X worker type, each worker maps to 1 DPU (4 vCPU, 16 GB of memory, 64 GB disk), and provides 1 executor per worker. Recommended for memory-intensive jobs. - * For the G.2X worker type, each worker maps to 2 DPU (8 vCPU, 32 GB of memory, 128 GB disk), and provides 1 executor per worker. Recommended for memory-intensive jobs. - * For the G.4X worker type, each worker maps to 4 DPU (16 vCPUs, 64 GB of memory) with 256GB disk (approximately 235GB free), and provides 1 executor per worker. Recommended for memory-intensive jobs. Only available for Glue version 3.0. Available AWS Regions: US East (Ohio), US East (N. Virginia), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe (Stockholm). - * For the G.8X worker type, each worker maps to 8 DPU (32 vCPUs, 128 GB of memory) with 512GB disk (approximately 487GB free), and provides 1 executor per worker. Recommended for memory-intensive jobs. Only available for Glue version 3.0. Available AWS Regions: US East (Ohio), US East (N. Virginia), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe (Stockholm). - * For the G.025X worker type, each worker maps to 0.25 DPU (2 vCPU, 4GB of memory, 64 GB disk), and provides 1 executor per worker. Recommended for low volume streaming jobs. Only available for Glue version 3.0. - * For the Z.2X worker type, each worker maps to 2 M-DPU (8vCPU, 64 GB of m emory, 128 GB disk), and provides up to 8 Ray workers based on the autoscaler. -* `number_of_workers` - (Optional) The number of workers of a defined workerType that are allocated when a job runs. +* `worker_type` - (Optional) The type of predefined worker that is allocated when a job runs. Valid values: `Standard`, `G.1X`, `G.2X`, `G.025X`, `G.4X`, `G.8X`, `G.12X`, `G.16X`, `R.1X`, `R.2X`, `R.4X`, `R.8X`, `Z.2X` (Ray jobs). See the [AWS documentation](https://docs.aws.amazon.com/glue/latest/dg/worker-types.html) for details. ### command Argument Reference @@ -356,4 +351,4 @@ Using `terraform import`, import Glue Jobs using `name`. For example: % terraform import aws_glue_job.MyJob MyJob ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/glue_ml_transform.html.markdown b/website/docs/cdktf/python/r/glue_ml_transform.html.markdown index a167af48a5dd..adcd07f976dc 100644 --- a/website/docs/cdktf/python/r/glue_ml_transform.html.markdown +++ b/website/docs/cdktf/python/r/glue_ml_transform.html.markdown @@ -120,16 +120,17 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: -* `name` – (Required) The name you assign to this ML Transform. It must be unique in your account. +* `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). +* `name` - (Required) The name you assign to this ML Transform. It must be unique in your account. * `input_record_tables` - (Required) A list of AWS Glue table definitions used by the transform. see [Input Record Tables](#input_record_tables). * `parameters` - (Required) The algorithmic parameters that are specific to the transform type used. Conditionally dependent on the transform type. see [Parameters](#parameters). -* `role_arn` – (Required) The ARN of the IAM role associated with this ML Transform. -* `description` – (Optional) Description of the ML Transform. +* `role_arn` - (Required) The ARN of the IAM role associated with this ML Transform. +* `description` - (Optional) Description of the ML Transform. * `glue_version` - (Optional) The version of glue to use, for example "1.0". For information about available versions, see the [AWS Glue Release Notes](https://docs.aws.amazon.com/glue/latest/dg/release-notes.html). -* `max_capacity` – (Optional) The number of AWS Glue data processing units (DPUs) that are allocated to task runs for this transform. You can allocate from `2` to `100` DPUs; the default is `10`. `max_capacity` is a mutually exclusive option with `number_of_workers` and `worker_type`. -* `max_retries` – (Optional) The maximum number of times to retry this ML Transform if it fails. +* `max_capacity` - (Optional) The number of AWS Glue data processing units (DPUs) that are allocated to task runs for this transform. You can allocate from `2` to `100` DPUs; the default is `10`. `max_capacity` is a mutually exclusive option with `number_of_workers` and `worker_type`. +* `max_retries` - (Optional) The maximum number of times to retry this ML Transform if it fails. * `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) The ML Transform timeout in minutes. The default is 2880 minutes (48 hours). +* `timeout` - (Optional) The ML Transform timeout in minutes. The default is 2880 minutes (48 hours). * `worker_type` - (Optional) The type of predefined worker that is allocated when an ML Transform runs. Accepts a value of `Standard`, `G.1X`, or `G.2X`. Required with `number_of_workers`. * `number_of_workers` - (Optional) The number of workers of a defined `worker_type` that are allocated when an ML Transform runs. Required with `worker_type`. @@ -192,4 +193,4 @@ Using `terraform import`, import Glue ML Transforms using `id`. For example: % terraform import aws_glue_ml_transform.example tfm-c2cafbe83b1c575f49eaca9939220e2fcd58e2d5 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/glue_partition.html.markdown b/website/docs/cdktf/python/r/glue_partition.html.markdown index 39a4057e86ae..ca1a1d63b201 100644 --- a/website/docs/cdktf/python/r/glue_partition.html.markdown +++ b/website/docs/cdktf/python/r/glue_partition.html.markdown @@ -37,6 +37,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `database_name` - (Required) Name of the metadata database where the table metadata resides. For Hive compatibility, this must be all lowercase. * `partition_values` - (Required) The values that define the partition. * `catalog_id` - (Optional) ID of the Glue Catalog and database to create the table in. If omitted, this defaults to the AWS Account ID plus the database name. @@ -116,4 +117,4 @@ Using `terraform import`, import Glue Partitions using the catalog ID (usually A % terraform import aws_glue_partition.part 123456789012:MyDatabase:MyTable:val1#val2 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/glue_partition_index.html.markdown b/website/docs/cdktf/python/r/glue_partition_index.html.markdown index db0d4e65d3bc..270053419df6 100644 --- a/website/docs/cdktf/python/r/glue_partition_index.html.markdown +++ b/website/docs/cdktf/python/r/glue_partition_index.html.markdown @@ -110,6 +110,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `table_name` - (Required) Name of the table. For Hive compatibility, this must be entirely lowercase. * `database_name` - (Required) Name of the metadata database where the table metadata resides. For Hive compatibility, this must be all lowercase. * `partition_index` - (Required) Configuration block for a partition index. See [`partition_index`](#partition_index) below. @@ -158,4 +159,4 @@ Using `terraform import`, import Glue Partition Indexes using the catalog ID (us % terraform import aws_glue_partition_index.example 123456789012:MyDatabase:MyTable:index-name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/glue_registry.html.markdown b/website/docs/cdktf/python/r/glue_registry.html.markdown index 3a480442c170..c85a7c1d5f61 100644 --- a/website/docs/cdktf/python/r/glue_registry.html.markdown +++ b/website/docs/cdktf/python/r/glue_registry.html.markdown @@ -35,8 +35,9 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: -* `registry_name` – (Required) The Name of the registry. -* `description` – (Optional) A description of the registry. +* `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). +* `registry_name` - (Required) The Name of the registry. +* `description` - (Optional) A description of the registry. * `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. ## Attribute Reference @@ -72,4 +73,4 @@ Using `terraform import`, import Glue Registries using `arn`. For example: % terraform import aws_glue_registry.example arn:aws:glue:us-west-2:123456789012:registry/example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/glue_resource_policy.html.markdown b/website/docs/cdktf/python/r/glue_resource_policy.html.markdown index 06293c5d2a54..69a05a33254c 100644 --- a/website/docs/cdktf/python/r/glue_resource_policy.html.markdown +++ b/website/docs/cdktf/python/r/glue_resource_policy.html.markdown @@ -45,7 +45,7 @@ class MyConvertedCode(TerraformStack): type="AWS" ) ], - resources=["arn:${" + data_aws_partition_current.partition + "}:glue:${" + data_aws_region_current.name + "}:${" + current.account_id + "}:*" + resources=["arn:${" + data_aws_partition_current.partition + "}:glue:${" + data_aws_region_current.region + "}:${" + current.account_id + "}:*" ] ) ] @@ -59,7 +59,8 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: -* `policy` – (Required) The policy to be applied to the aws glue data catalog. +* `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). +* `policy` - (Required) The policy to be applied to the aws glue data catalog. * `enable_hybrid` - (Optional) Indicates that you are using both methods to grant cross-account. Valid values are `TRUE` and `FALSE`. Note the terraform will not perform drift detetction on this field as its not return on read. ## Attribute Reference @@ -91,4 +92,4 @@ Using `terraform import`, import Glue Resource Policy using the account ID. For % terraform import aws_glue_resource_policy.Test 12356789012 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/glue_schema.html.markdown b/website/docs/cdktf/python/r/glue_schema.html.markdown index 8186cd83138a..02d618243a82 100644 --- a/website/docs/cdktf/python/r/glue_schema.html.markdown +++ b/website/docs/cdktf/python/r/glue_schema.html.markdown @@ -39,12 +39,13 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: -* `schema_name` – (Required) The Name of the schema. +* `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). +* `schema_name` - (Required) The Name of the schema. * `registry_arn` - (Required) The ARN of the Glue Registry to create the schema in. * `data_format` - (Required) The data format of the schema definition. Valid values are `AVRO`, `JSON` and `PROTOBUF`. * `compatibility` - (Required) The compatibility mode of the schema. Values values are: `NONE`, `DISABLED`, `BACKWARD`, `BACKWARD_ALL`, `FORWARD`, `FORWARD_ALL`, `FULL`, and `FULL_ALL`. * `schema_definition` - (Required) The schema definition using the `data_format` setting for `schema_name`. -* `description` – (Optional) A description of the schema. +* `description` - (Optional) A description of the schema. * `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. ## Attribute Reference @@ -84,4 +85,4 @@ Using `terraform import`, import Glue Registries using `arn`. For example: % terraform import aws_glue_schema.example arn:aws:glue:us-west-2:123456789012:schema/example/example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/glue_security_configuration.html.markdown b/website/docs/cdktf/python/r/glue_security_configuration.html.markdown index 26bc3cad774b..3e5a374e2da1 100644 --- a/website/docs/cdktf/python/r/glue_security_configuration.html.markdown +++ b/website/docs/cdktf/python/r/glue_security_configuration.html.markdown @@ -47,8 +47,9 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: -* `encryption_configuration` – (Required) Configuration block containing encryption configuration. Detailed below. -* `name` – (Required) Name of the security configuration. +* `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). +* `encryption_configuration` - (Required) Configuration block containing encryption configuration. Detailed below. +* `name` - (Required) Name of the security configuration. ### encryption_configuration Argument Reference @@ -102,4 +103,4 @@ Using `terraform import`, import Glue Security Configurations using `name`. For % terraform import aws_glue_security_configuration.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/glue_trigger.html.markdown b/website/docs/cdktf/python/r/glue_trigger.html.markdown index dd90d88b2ebe..e18a594b5f01 100644 --- a/website/docs/cdktf/python/r/glue_trigger.html.markdown +++ b/website/docs/cdktf/python/r/glue_trigger.html.markdown @@ -164,15 +164,16 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: -* `actions` – (Required) List of actions initiated by this trigger when it fires. See [Actions](#actions) Below. -* `description` – (Optional) A description of the new trigger. -* `enabled` – (Optional) Start the trigger. Defaults to `true`. -* `name` – (Required) The name of the trigger. -* `predicate` – (Optional) A predicate to specify when the new trigger should fire. Required when trigger type is `CONDITIONAL`. See [Predicate](#predicate) Below. -* `schedule` – (Optional) A cron expression used to specify the schedule. [Time-Based Schedules for Jobs and Crawlers](https://docs.aws.amazon.com/glue/latest/dg/monitor-data-warehouse-schedule.html) +* `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). +* `actions` - (Required) List of actions initiated by this trigger when it fires. See [Actions](#actions) Below. +* `description` - (Optional) A description of the new trigger. +* `enabled` - (Optional) Start the trigger. Defaults to `true`. +* `name` - (Required) The name of the trigger. +* `predicate` - (Optional) A predicate to specify when the new trigger should fire. Required when trigger type is `CONDITIONAL`. See [Predicate](#predicate) Below. +* `schedule` - (Optional) A cron expression used to specify the schedule. [Time-Based Schedules for Jobs and Crawlers](https://docs.aws.amazon.com/glue/latest/dg/monitor-data-warehouse-schedule.html) * `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. -* `start_on_creation` – (Optional) Set to true to start `SCHEDULED` and `CONDITIONAL` triggers when created. True is not supported for `ON_DEMAND` triggers. -* `type` – (Required) The type of trigger. Valid values are `CONDITIONAL`, `EVENT`, `ON_DEMAND`, and `SCHEDULED`. +* `start_on_creation` - (Optional) Set to true to start `SCHEDULED` and `CONDITIONAL` triggers when created. True is not supported for `ON_DEMAND` triggers. +* `type` - (Required) The type of trigger. Valid values are `CONDITIONAL`, `EVENT`, `ON_DEMAND`, and `SCHEDULED`. * `workflow_name` - (Optional) A workflow to which the trigger should be associated to. Every workflow graph (DAG) needs a starting trigger (`ON_DEMAND` or `SCHEDULED` type) and can contain multiple additional `CONDITIONAL` triggers. * `event_batching_condition` - (Optional) Batch condition that must be met (specified number of events received or batch time window expired) before EventBridge event trigger fires. See [Event Batching Condition](#event-batching-condition). @@ -249,4 +250,4 @@ Using `terraform import`, import Glue Triggers using `name`. For example: % terraform import aws_glue_trigger.MyTrigger MyTrigger ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/glue_user_defined_function.html.markdown b/website/docs/cdktf/python/r/glue_user_defined_function.html.markdown index a2956adf9b00..1a985d24e6a5 100644 --- a/website/docs/cdktf/python/r/glue_user_defined_function.html.markdown +++ b/website/docs/cdktf/python/r/glue_user_defined_function.html.markdown @@ -51,6 +51,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) The name of the function. * `catalog_id` - (Optional) ID of the Glue Catalog to create the function in. If omitted, this defaults to the AWS Account ID. * `database_name` - (Required) The name of the Database to create the Function. @@ -97,4 +98,4 @@ Using `terraform import`, import Glue User Defined Functions using the `catalog_ % terraform import aws_glue_user_defined_function.func 123456789012:my_database:my_func ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/glue_workflow.html.markdown b/website/docs/cdktf/python/r/glue_workflow.html.markdown index 7ad2c693d718..50d6863eb4c3 100644 --- a/website/docs/cdktf/python/r/glue_workflow.html.markdown +++ b/website/docs/cdktf/python/r/glue_workflow.html.markdown @@ -63,9 +63,10 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: -* `name` – (Required) The name you assign to this workflow. -* `default_run_properties` – (Optional) A map of default run properties for this workflow. These properties are passed to all jobs associated to the workflow. -* `description` – (Optional) Description of the workflow. +* `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). +* `name` - (Required) The name you assign to this workflow. +* `default_run_properties` - (Optional) A map of default run properties for this workflow. These properties are passed to all jobs associated to the workflow. +* `description` - (Optional) Description of the workflow. * `max_concurrent_runs` - (Optional) Prevents exceeding the maximum number of concurrent runs of any of the component jobs. If you leave this parameter blank, there is no limit to the number of concurrent workflow runs. * `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. @@ -102,4 +103,4 @@ Using `terraform import`, import Glue Workflows using `name`. For example: % terraform import aws_glue_workflow.MyWorkflow MyWorkflow ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/grafana_license_association.html.markdown b/website/docs/cdktf/python/r/grafana_license_association.html.markdown index 0264d5486de5..939c2900e78c 100644 --- a/website/docs/cdktf/python/r/grafana_license_association.html.markdown +++ b/website/docs/cdktf/python/r/grafana_license_association.html.markdown @@ -64,6 +64,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `grafana_token` - (Optional) A token from Grafana Labs that ties your AWS account with a Grafana Labs account. * `license_type` - (Required) The type of license for the workspace license association. Valid values are `ENTERPRISE` and `ENTERPRISE_FREE_TRIAL`. * `workspace_id` - (Required) The workspace id. @@ -100,4 +101,4 @@ Using `terraform import`, import Grafana workspace license association using the % terraform import aws_grafana_license_association.example g-2054c75a02 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/grafana_role_association.html.markdown b/website/docs/cdktf/python/r/grafana_role_association.html.markdown index 5ebdbd353378..e71f81a610b0 100644 --- a/website/docs/cdktf/python/r/grafana_role_association.html.markdown +++ b/website/docs/cdktf/python/r/grafana_role_association.html.markdown @@ -70,6 +70,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `group_ids` - (Optional) The AWS SSO group ids to be assigned the role given in `role`. * `user_ids` - (Optional) The AWS SSO user ids to be assigned the role given in `role`. @@ -77,4 +78,4 @@ The following arguments are optional: This resource exports no additional attributes. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/grafana_workspace.html.markdown b/website/docs/cdktf/python/r/grafana_workspace.html.markdown index d34da24e950a..12f354c35d8c 100644 --- a/website/docs/cdktf/python/r/grafana_workspace.html.markdown +++ b/website/docs/cdktf/python/r/grafana_workspace.html.markdown @@ -84,7 +84,7 @@ class MyConvertedCode(TerraformStack): ) ``` -The optional argument `configuration` is a JSON string that enables the unified `Grafana Alerting` (Grafana version 10 or newer) and `Plugins Management` (Grafana version 9 or newer) on the Grafana Workspaces. +The optional argument `configuration` is a JSON string that disables the unified `Grafana Alerting` (Grafana version 10 or newer) and enables `Plugin Management` (Grafana version 9 or newer) on the Grafana Workspaces. For more information about using Grafana alerting, and the effects of turning it on or off, see [Alerts in Grafana version 10](https://docs.aws.amazon.com/grafana/latest/userguide/v10-alerts.html). @@ -98,8 +98,9 @@ The following arguments are required: The following arguments are optional: +* `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). * `configuration` - (Optional) The configuration string for the workspace that you create. For more information about the format and configuration options available, see [Working in your Grafana workspace](https://docs.aws.amazon.com/grafana/latest/userguide/AMG-configure-workspace.html). -* `data_sources` - (Optional) The data sources for the workspace. Valid values are `AMAZON_OPENSEARCH_SERVICE`, `ATHENA`, `CLOUDWATCH`, `PROMETHEUS`, `REDSHIFT`, `SITEWISE`, `TIMESTREAM`, `XRAY` +* `data_sources` - (Optional) The data sources for the workspace. Valid values are `AMAZON_OPENSEARCH_SERVICE`, `ATHENA`, `CLOUDWATCH`, `PROMETHEUS`, `REDSHIFT`, `SITEWISE`, `TIMESTREAM`, `TWINMAKER`, XRAY` * `description` - (Optional) The workspace description. * `grafana_version` - (Optional) Specifies the version of Grafana to support in the new workspace. Supported values are `8.4`, `9.4` and `10.4`. If not specified, defaults to the latest version. * `name` - (Optional) The Grafana workspace name. @@ -156,4 +157,4 @@ Using `terraform import`, import Grafana Workspace using the workspace's `id`. F % terraform import aws_grafana_workspace.example g-2054c75a02 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/grafana_workspace_api_key.html.markdown b/website/docs/cdktf/python/r/grafana_workspace_api_key.html.markdown index 4a7c1ce2f131..80762ea33914 100644 --- a/website/docs/cdktf/python/r/grafana_workspace_api_key.html.markdown +++ b/website/docs/cdktf/python/r/grafana_workspace_api_key.html.markdown @@ -38,8 +38,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +- `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). - `key_name` - (Required) Specifies the name of the API key. Key names must be unique to the workspace. - `key_role` - (Required) Specifies the permission level of the API key. Valid values are `VIEWER`, `EDITOR`, or `ADMIN`. - `seconds_to_live` - (Required) Specifies the time in seconds until the API key expires. Keys can be valid for up to 30 days. @@ -51,4 +52,4 @@ This resource exports the following attributes in addition to the arguments abov * `key` - The key token in JSON format. Use this value as a bearer token to authenticate HTTP requests to the workspace. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/grafana_workspace_saml_configuration.html.markdown b/website/docs/cdktf/python/r/grafana_workspace_saml_configuration.html.markdown index 062ee72ba783..13faeae17396 100644 --- a/website/docs/cdktf/python/r/grafana_workspace_saml_configuration.html.markdown +++ b/website/docs/cdktf/python/r/grafana_workspace_saml_configuration.html.markdown @@ -71,6 +71,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `admin_role_values` - (Optional) The admin role values. * `allowed_organizations` - (Optional) The allowed organizations. * `email_assertion` - (Optional) The email assertion. @@ -114,4 +115,4 @@ Using `terraform import`, import Grafana Workspace SAML configuration using the % terraform import aws_grafana_workspace_saml_configuration.example g-2054c75a02 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/grafana_workspace_service_account.html.markdown b/website/docs/cdktf/python/r/grafana_workspace_service_account.html.markdown index 685f24f35057..ba1da9d757ae 100644 --- a/website/docs/cdktf/python/r/grafana_workspace_service_account.html.markdown +++ b/website/docs/cdktf/python/r/grafana_workspace_service_account.html.markdown @@ -40,8 +40,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `name` - (Required) A name for the service account. The name must be unique within the workspace, as it determines the ID associated with the service account. * `grafana_role` - (Required) The permission level to use for this service account. For more information about the roles and the permissions each has, see the [User roles](https://docs.aws.amazon.com/grafana/latest/userguide/Grafana-user-roles.html) documentation. * `workspace_id` - (Required) The Grafana workspace with which the service account is associated. @@ -77,4 +78,4 @@ Using `terraform import`, import Managed Grafana Workspace Service Account using % terraform import aws_grafana_workspace_service_account.example g-abc12345,1 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/grafana_workspace_service_account_token.html.markdown b/website/docs/cdktf/python/r/grafana_workspace_service_account_token.html.markdown index c0f1bbc0f0ff..187557ae2620 100644 --- a/website/docs/cdktf/python/r/grafana_workspace_service_account_token.html.markdown +++ b/website/docs/cdktf/python/r/grafana_workspace_service_account_token.html.markdown @@ -50,8 +50,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `name` - (Required) A name for the token to create. The name must be unique within the workspace. * `seconds_to_live` - (Required) Sets how long the token will be valid, in seconds. You can set the time up to 30 days in the future. * `service_account_id` - (Required) The ID of the service account for which to create a token. @@ -66,4 +67,4 @@ This resource exports the following attributes in addition to the arguments abov * `expires_at` - Specifies when the service account token will expire. * `key` - The key for the service account token. Used when making calls to the Grafana HTTP APIs to authenticate and authorize the requests. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/guardduty_detector.html.markdown b/website/docs/cdktf/python/r/guardduty_detector.html.markdown index 6a56e1dac006..ccc608eba982 100644 --- a/website/docs/cdktf/python/r/guardduty_detector.html.markdown +++ b/website/docs/cdktf/python/r/guardduty_detector.html.markdown @@ -54,9 +54,10 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `enable` - (Optional) Enable monitoring and feedback reporting. Setting to `false` is equivalent to "suspending" GuardDuty. Defaults to `true`. * `finding_publishing_frequency` - (Optional) Specifies the frequency of notifications sent for subsequent finding occurrences. If the detector is a GuardDuty member account, the value is determined by the GuardDuty primary account and cannot be modified, otherwise defaults to `SIX_HOURS`. For standalone and GuardDuty primary accounts, it must be configured in Terraform to enable drift detection. Valid values for standalone and primary accounts: `FIFTEEN_MINUTES`, `ONE_HOUR`, `SIX_HOURS`. See [AWS Documentation](https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_findings_cloudwatch.html#guardduty_findings_cloudwatch_notification_frequency) for more information. -* `datasources` - (Optional) Describes which data sources will be enabled for the detector. See [Data Sources](#data-sources) below for more details. [Deprecated](https://docs.aws.amazon.com/guardduty/latest/ug/guardduty-feature-object-api-changes-march2023.html) in favor of [`aws_guardduty_detector_feature` resources](guardduty_detector_feature.html). +* `datasources` - (Optional, **Deprecated** use `aws_guardduty_detector_feature` resources instead) Describes which data sources will be enabled for the detector. See [Data Sources](#data-sources) below for more details. [Deprecated](https://docs.aws.amazon.com/guardduty/latest/ug/guardduty-feature-object-api-changes-march2023.html) in favor of [`aws_guardduty_detector_feature` resources](guardduty_detector_feature.html). * `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. ### Data Sources @@ -150,4 +151,4 @@ Using `terraform import`, import GuardDuty detectors using the detector ID. For The ID of the detector can be retrieved via the [AWS CLI](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/guardduty/list-detectors.html) using `aws guardduty list-detectors`. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/guardduty_detector_feature.html.markdown b/website/docs/cdktf/python/r/guardduty_detector_feature.html.markdown index b5ac1ca8a689..59a2fe082820 100644 --- a/website/docs/cdktf/python/r/guardduty_detector_feature.html.markdown +++ b/website/docs/cdktf/python/r/guardduty_detector_feature.html.markdown @@ -32,6 +32,38 @@ class MyConvertedCode(TerraformStack): example = GuarddutyDetector(self, "example", enable=True ) + GuarddutyDetectorFeature(self, "s3_protection", + detector_id=example.id, + name="S3_DATA_EVENTS", + status="ENABLED" + ) +``` + +## Extended Threat Detection for EKS + +To enable GuardDuty [Extended Threat Detection](https://docs.aws.amazon.com/guardduty/latest/ug/guardduty-extended-threat-detection.html) for EKS, you need at least one of these features enabled: [EKS Protection](https://docs.aws.amazon.com/guardduty/latest/ug/kubernetes-protection.html) or [Runtime Monitoring](https://docs.aws.amazon.com/guardduty/latest/ug/runtime-monitoring-configuration.html). For maximum detection coverage, enabling both is recommended to enhance detection capabilities. + +```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.guardduty_detector import GuarddutyDetector +from imports.aws.guardduty_detector_feature import GuarddutyDetectorFeature +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + example = GuarddutyDetector(self, "example", + enable=True + ) + GuarddutyDetectorFeature(self, "eks_protection", + detector_id=example.id, + name="EKS_AUDIT_LOGS", + status="ENABLED" + ) GuarddutyDetectorFeature(self, "eks_runtime_monitoring", additional_configuration=[GuarddutyDetectorFeatureAdditionalConfiguration( name="EKS_ADDON_MANAGEMENT", @@ -48,6 +80,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `detector_id` - (Required) Amazon GuardDuty detector ID. * `name` - (Required) The name of the detector feature. Valid values: `S3_DATA_EVENTS`, `EKS_AUDIT_LOGS`, `EBS_MALWARE_PROTECTION`, `RDS_LOGIN_EVENTS`, `EKS_RUNTIME_MONITORING`, `LAMBDA_NETWORK_LOGS`, `RUNTIME_MONITORING`. Only one of two features `EKS_RUNTIME_MONITORING` or `RUNTIME_MONITORING` can be added, adding both features will cause an error. Refer to the [AWS Documentation](https://docs.aws.amazon.com/guardduty/latest/APIReference/API_DetectorFeatureConfiguration.html) for the current list of supported values. * `status` - (Required) The status of the detector feature. Valid values: `ENABLED`, `DISABLED`. @@ -64,4 +97,4 @@ The `additional_configuration` block supports the following: This resource exports no additional attributes. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/guardduty_filter.html.markdown b/website/docs/cdktf/python/r/guardduty_filter.html.markdown index 54abea1b18d4..5e34c28fc64c 100644 --- a/website/docs/cdktf/python/r/guardduty_filter.html.markdown +++ b/website/docs/cdktf/python/r/guardduty_filter.html.markdown @@ -55,6 +55,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `detector_id` - (Required) ID of a GuardDuty detector, attached to your account. * `name` - (Required) The name of your filter. * `description` - (Optional) Description of the filter. @@ -80,7 +81,6 @@ The `criterion` block suports the following: This resource exports the following attributes in addition to the arguments above: * `arn` - The ARN of the GuardDuty filter. -* `id` - A compound field, consisting of the ID of the GuardDuty detector and the name of the filter. * `tags_all` - A map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). ## Import @@ -108,4 +108,4 @@ Using `terraform import`, import GuardDuty filters using the detector ID and fil % terraform import aws_guardduty_filter.MyFilter 00b00fd5aecc0ab60a708659477e9617:MyFilter ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/guardduty_invite_accepter.html.markdown b/website/docs/cdktf/python/r/guardduty_invite_accepter.html.markdown index d325ba21e3ac..c111f8faba5d 100644 --- a/website/docs/cdktf/python/r/guardduty_invite_accepter.html.markdown +++ b/website/docs/cdktf/python/r/guardduty_invite_accepter.html.markdown @@ -64,14 +64,13 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `detector_id` - (Required) The detector ID of the member GuardDuty account. * `master_account_id` - (Required) AWS account ID for primary account. ## Attribute Reference -This resource exports the following attributes in addition to the arguments above: - -* `id` - GuardDuty member detector ID +This resource exports no additional attributes. ## Timeouts @@ -104,4 +103,4 @@ Using `terraform import`, import `aws_guardduty_invite_accepter` using the membe % terraform import aws_guardduty_invite_accepter.member 00b00fd5aecc0ab60a708659477e9617 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/guardduty_ipset.html.markdown b/website/docs/cdktf/python/r/guardduty_ipset.html.markdown index 79cd626ee600..5f6764e97db9 100644 --- a/website/docs/cdktf/python/r/guardduty_ipset.html.markdown +++ b/website/docs/cdktf/python/r/guardduty_ipset.html.markdown @@ -57,6 +57,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `activate` - (Required) Specifies whether GuardDuty is to start using the uploaded IPSet. * `detector_id` - (Required) The detector ID of the GuardDuty. * `format` - (Required) The format of the file that contains the IPSet. Valid values: `TXT` | `STIX` | `OTX_CSV` | `ALIEN_VAULT` | `PROOF_POINT` | `FIRE_EYE` @@ -69,7 +70,6 @@ This resource supports the following arguments: This resource exports the following attributes in addition to the arguments above: * `arn` - Amazon Resource Name (ARN) of the GuardDuty IPSet. -* `id` - The ID of the GuardDuty IPSet. * `tags_all` - A map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). ## Import @@ -97,4 +97,4 @@ Using `terraform import`, import GuardDuty IPSet using the primary GuardDuty det % terraform import aws_guardduty_ipset.MyIPSet 00b00fd5aecc0ab60a708659477e9617:123456789012 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/guardduty_malware_protection_plan.html.markdown b/website/docs/cdktf/python/r/guardduty_malware_protection_plan.html.markdown index c5548c9fbc20..c5b99833173d 100644 --- a/website/docs/cdktf/python/r/guardduty_malware_protection_plan.html.markdown +++ b/website/docs/cdktf/python/r/guardduty_malware_protection_plan.html.markdown @@ -53,6 +53,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `actions` - (Optional) Information about whether the tags will be added to the S3 object after scanning. See [`actions`](#actions-argument-reference) below. * `protected_resource` - (Required) Information about the protected resource that is associated with the created Malware Protection plan. Presently, S3Bucket is the only supported protected resource. See [`protected_resource`](#protected_resource-argument-reference) below. * `role` - (Required) ARN of IAM role that includes the permissions required to scan and add tags to the associated protected resource. @@ -109,4 +110,4 @@ Using `terraform import`, import GuardDuty malware protection plans using their % terraform import aws_guardduty_malware_protection_plan.example 1234567890abcdef0123 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/guardduty_member.html.markdown b/website/docs/cdktf/python/r/guardduty_member.html.markdown index a285073167b2..7b1a5d5abbf4 100644 --- a/website/docs/cdktf/python/r/guardduty_member.html.markdown +++ b/website/docs/cdktf/python/r/guardduty_member.html.markdown @@ -49,6 +49,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `account_id` - (Required) AWS account ID for member account. * `detector_id` - (Required) The detector ID of the GuardDuty account where you want to create member accounts. * `email` - (Required) Email address for member account. @@ -60,7 +61,6 @@ This resource supports the following arguments: This resource exports the following attributes in addition to the arguments above: -* `id` - The ID of the GuardDuty member * `relationship_status` - The status of the relationship between the member account and its primary account. More information can be found in [Amazon GuardDuty API Reference](https://docs.aws.amazon.com/guardduty/latest/ug/get-members.html). ## Timeouts @@ -95,4 +95,4 @@ Using `terraform import`, import GuardDuty members using the primary GuardDuty d % terraform import aws_guardduty_member.MyMember 00b00fd5aecc0ab60a708659477e9617:123456789012 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/guardduty_member_detector_feature.html.markdown b/website/docs/cdktf/python/r/guardduty_member_detector_feature.html.markdown index 4ae01e57a234..53f5b837326f 100644 --- a/website/docs/cdktf/python/r/guardduty_member_detector_feature.html.markdown +++ b/website/docs/cdktf/python/r/guardduty_member_detector_feature.html.markdown @@ -24,8 +24,8 @@ 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 GuarddutyMemberDetectorFeature from imports.aws.guardduty_detector import GuarddutyDetector +from imports.aws.guardduty_member_detector_feature import GuarddutyMemberDetectorFeature class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) @@ -34,16 +34,47 @@ class MyConvertedCode(TerraformStack): ) GuarddutyMemberDetectorFeature(self, "runtime_monitoring", account_id="123456789012", - additional_configuration=[{ - "name": "EKS_ADDON_MANAGEMENT", - "status": "ENABLED" - }, { - "name": "ECS_FARGATE_AGENT_MANAGEMENT", - "status": "ENABLED" - } + detector_id=example.id, + name="S3_DATA_EVENTS", + status="ENABLED" + ) +``` + +## Extended Threat Detection for EKS + +To enable GuardDuty [Extended Threat Detection](https://docs.aws.amazon.com/guardduty/latest/ug/guardduty-extended-threat-detection.html) for EKS, you need at least one of these features enabled: [EKS Protection](https://docs.aws.amazon.com/guardduty/latest/ug/kubernetes-protection.html) or [Runtime Monitoring](https://docs.aws.amazon.com/guardduty/latest/ug/runtime-monitoring-configuration.html). For maximum detection coverage, enabling both is recommended to enhance detection capabilities. + +```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.guardduty_detector import GuarddutyDetector +from imports.aws.guardduty_detector_feature import GuarddutyDetectorFeature +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + example = GuarddutyDetector(self, "example", + enable=True + ) + GuarddutyDetectorFeature(self, "eks_protection", + account_id="123456789012", + detector_id=example.id, + name="EKS_AUDIT_LOGS", + status="ENABLED" + ) + GuarddutyDetectorFeature(self, "eks_runtime_monitoring", + account_id="123456789012", + additional_configuration=[GuarddutyDetectorFeatureAdditionalConfiguration( + name="EKS_ADDON_MANAGEMENT", + status="ENABLED" + ) ], detector_id=example.id, - name="RUNTIME_MONITORING", + name="EKS_RUNTIME_MONITORING", status="ENABLED" ) ``` @@ -52,6 +83,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `detector_id` - (Required) Amazon GuardDuty detector ID. * `account_id` - (Required) Member account ID to be updated. * `name` - (Required) The name of the detector feature. Valid values: `S3_DATA_EVENTS`, `EKS_AUDIT_LOGS`, `EBS_MALWARE_PROTECTION`, `RDS_LOGIN_EVENTS`, `EKS_RUNTIME_MONITORING`,`RUNTIME_MONITORING`, `LAMBDA_NETWORK_LOGS`. @@ -69,4 +101,4 @@ The `additional_configuration` block supports the following: This resource exports no additional attributes. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/guardduty_organization_admin_account.html.markdown b/website/docs/cdktf/python/r/guardduty_organization_admin_account.html.markdown index a2755dfb58ac..cb12b9344990 100644 --- a/website/docs/cdktf/python/r/guardduty_organization_admin_account.html.markdown +++ b/website/docs/cdktf/python/r/guardduty_organization_admin_account.html.markdown @@ -48,13 +48,12 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `admin_account_id` - (Required) AWS account identifier to designate as a delegated administrator for GuardDuty. ## Attribute Reference -This resource exports the following attributes in addition to the arguments above: - -* `id` - AWS account identifier. +This resource exports no additional attributes. ## Import @@ -81,4 +80,4 @@ Using `terraform import`, import GuardDuty Organization Admin Account using the % terraform import aws_guardduty_organization_admin_account.example 123456789012 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/guardduty_organization_configuration.html.markdown b/website/docs/cdktf/python/r/guardduty_organization_configuration.html.markdown index f07d5b997d2a..bb42e1cf2d8b 100644 --- a/website/docs/cdktf/python/r/guardduty_organization_configuration.html.markdown +++ b/website/docs/cdktf/python/r/guardduty_organization_configuration.html.markdown @@ -62,8 +62,9 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: -* `auto_enable` - (Optional) *Deprecated:* Use `auto_enable_organization_members` instead. When this setting is enabled, all new accounts that are created in, or added to, the organization are added as a member accounts of the organization’s GuardDuty delegated administrator and GuardDuty is enabled in that AWS Region. -* `auto_enable_organization_members` - (Optional) Indicates the auto-enablement configuration of GuardDuty for the member accounts in the organization. Valid values are `ALL`, `NEW`, `NONE`. +* `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). +* `auto_enable_organization_members` - (Required) Indicates the auto-enablement configuration of GuardDuty for the member accounts in the organization. + Valid values are `ALL`, `NEW`, `NONE`. * `detector_id` - (Required) The detector ID of the GuardDuty account. * `datasources` - (Optional) Configuration for the collected datasources. [Deprecated](https://docs.aws.amazon.com/guardduty/latest/ug/guardduty-feature-object-api-changes-march2023.html) in favor of [`aws_guardduty_organization_configuration_feature` resources](guardduty_organization_configuration_feature.html). @@ -118,9 +119,7 @@ The `ebs_volumes` block supports the following: ## Attribute Reference -This resource exports the following attributes in addition to the arguments above: - -* `id` - Identifier of the GuardDuty Detector. +This resource exports no additional attributes. ## Import @@ -147,4 +146,4 @@ Using `terraform import`, import GuardDuty Organization Configurations using the % terraform import aws_guardduty_organization_configuration.example 00b00fd5aecc0ab60a708659477e9617 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/guardduty_organization_configuration_feature.html.markdown b/website/docs/cdktf/python/r/guardduty_organization_configuration_feature.html.markdown index fce52115dff3..5c4f273f4144 100644 --- a/website/docs/cdktf/python/r/guardduty_organization_configuration_feature.html.markdown +++ b/website/docs/cdktf/python/r/guardduty_organization_configuration_feature.html.markdown @@ -12,7 +12,7 @@ description: |- Provides a resource to manage a single Amazon GuardDuty [organization configuration feature](https://docs.aws.amazon.com/guardduty/latest/ug/guardduty-features-activation-model.html#guardduty-features). -~> **NOTE:** Deleting this resource does not disable the organization configuration feature, the resource in simply removed from state instead. +~> **NOTE:** Deleting this resource does not disable the organization configuration feature, the resource is simply removed from state instead. ## Example Usage @@ -48,6 +48,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `auto_enable` - (Required) The status of the feature that is configured for the member accounts within the organization. Valid values: `NEW`, `ALL`, `NONE`. * `detector_id` - (Required) The ID of the detector that configures the delegated administrator. * `name` - (Required) The name of the feature that will be configured for the organization. Valid values: `S3_DATA_EVENTS`, `EKS_AUDIT_LOGS`, `EBS_MALWARE_PROTECTION`, `RDS_LOGIN_EVENTS`, `EKS_RUNTIME_MONITORING`, `LAMBDA_NETWORK_LOGS`, `RUNTIME_MONITORING`. Only one of two features `EKS_RUNTIME_MONITORING` or `RUNTIME_MONITORING` can be added, adding both features will cause an error. Refer to the [AWS Documentation](https://docs.aws.amazon.com/guardduty/latest/APIReference/API_DetectorFeatureConfiguration.html) for the current list of supported values. @@ -64,4 +65,4 @@ The `additional_configuration` block supports the following: This resource exports no additional attributes. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/guardduty_publishing_destination.html.markdown b/website/docs/cdktf/python/r/guardduty_publishing_destination.html.markdown index 83985ae0d383..78d068638f19 100644 --- a/website/docs/cdktf/python/r/guardduty_publishing_destination.html.markdown +++ b/website/docs/cdktf/python/r/guardduty_publishing_destination.html.markdown @@ -82,7 +82,7 @@ class MyConvertedCode(TerraformStack): type="Service" ) ], - resources=["arn:aws:kms:${" + data_aws_region_current.name + "}:${" + current.account_id + "}:key/*" + resources=["arn:aws:kms:${" + data_aws_region_current.region + "}:${" + current.account_id + "}:key/*" ], sid="Allow GuardDuty to encrypt findings" ), DataAwsIamPolicyDocumentStatement( @@ -92,7 +92,7 @@ class MyConvertedCode(TerraformStack): type="AWS" ) ], - resources=["arn:aws:kms:${" + data_aws_region_current.name + "}:${" + current.account_id + "}:key/*" + resources=["arn:aws:kms:${" + data_aws_region_current.region + "}:${" + current.account_id + "}:key/*" ], sid="Allow all users to modify/delete key (test only)" ) @@ -117,6 +117,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `detector_id` - (Required) The detector ID of the GuardDuty. * `destination_arn` - (Required) The bucket arn and prefix under which the findings get exported. Bucket-ARN is required, the prefix is optional and will be `AWSLogs/[Account-ID]/GuardDuty/[Region]/` if not provided * `kms_key_arn` - (Required) The ARN of the KMS key used to encrypt GuardDuty findings. GuardDuty enforces this to be encrypted. @@ -126,9 +127,7 @@ This resource supports the following arguments: ## Attribute Reference -This resource exports the following attributes in addition to the arguments above: - -* `id` - The ID of the GuardDuty PublishingDestination and the detector ID. Format: `:` +This resource exports no additional attributes. ## Import @@ -155,4 +154,4 @@ Using `terraform import`, import GuardDuty PublishingDestination using the maste % terraform import aws_guardduty_publishing_destination.test a4b86f26fa42e7e7cf0d1c333ea77777:a4b86f27a0e464e4a7e0516d242f1234 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/guardduty_threatintelset.html.markdown b/website/docs/cdktf/python/r/guardduty_threatintelset.html.markdown index bfbd9c460fed..8836a9bbe7f9 100644 --- a/website/docs/cdktf/python/r/guardduty_threatintelset.html.markdown +++ b/website/docs/cdktf/python/r/guardduty_threatintelset.html.markdown @@ -61,6 +61,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `activate` - (Required) Specifies whether GuardDuty is to start using the uploaded ThreatIntelSet. * `detector_id` - (Required) The detector ID of the GuardDuty. * `format` - (Required) The format of the file that contains the ThreatIntelSet. Valid values: `TXT` | `STIX` | `OTX_CSV` | `ALIEN_VAULT` | `PROOF_POINT` | `FIRE_EYE` @@ -73,7 +74,6 @@ This resource supports the following arguments: This resource exports the following attributes in addition to the arguments above: * `arn` - Amazon Resource Name (ARN) of the GuardDuty ThreatIntelSet. -* `id` - The ID of the GuardDuty ThreatIntelSet and the detector ID. Format: `:` * `tags_all` - A map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). ## Import @@ -101,4 +101,4 @@ Using `terraform import`, import GuardDuty ThreatIntelSet using the primary Guar % terraform import aws_guardduty_threatintelset.MyThreatIntelSet 00b00fd5aecc0ab60a708659477e9617:123456789012 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/iam_group_membership.html.markdown b/website/docs/cdktf/python/r/iam_group_membership.html.markdown index 54da12abdf23..29a12709f385 100644 --- a/website/docs/cdktf/python/r/iam_group_membership.html.markdown +++ b/website/docs/cdktf/python/r/iam_group_membership.html.markdown @@ -57,7 +57,7 @@ This resource supports the following arguments: * `name` - (Required) The name to identify the Group Membership * `users` - (Required) A list of IAM User names to associate with the Group -* `group` – (Required) The IAM Group name to attach the list of `users` to +* `group` - (Required) The IAM Group name to attach the list of `users` to ## Attribute Reference @@ -65,10 +65,10 @@ This resource exports the following attributes in addition to the arguments abov * `name` - The name to identify the Group Membership * `users` - list of IAM User names -* `group` – IAM Group name +* `group` - IAM Group name [1]: /docs/providers/aws/r/iam_group.html [2]: /docs/providers/aws/r/iam_user.html [3]: /docs/providers/aws/r/iam_user_group_membership.html - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/iam_role_policy.html.markdown b/website/docs/cdktf/python/r/iam_role_policy.html.markdown index dae25a71f0f6..e6e5b000c82c 100644 --- a/website/docs/cdktf/python/r/iam_role_policy.html.markdown +++ b/website/docs/cdktf/python/r/iam_role_policy.html.markdown @@ -67,21 +67,18 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: -* `name` - (Optional) The name of the role policy. If omitted, Terraform will -assign a random, unique name. -* `name_prefix` - (Optional) Creates a unique name beginning with the specified - prefix. Conflicts with `name`. -* `policy` - (Required) The inline policy document. This is a JSON formatted string. For more information about building IAM policy documents with Terraform, see the [AWS IAM Policy Document Guide](https://learn.hashicorp.com/terraform/aws/iam-policy) +* `name` - (Optional) The name of the role policy. + If omitted, Terraform will assign a random, unique name. +* `name_prefix` - (Optional) Creates a unique name beginning with the specified prefix. + Conflicts with `name`. +* `policy` - (Required) The inline policy document. + This is a JSON formatted string. + For more information about building IAM policy documents with Terraform, see the [AWS IAM Policy Document Guide](https://learn.hashicorp.com/terraform/aws/iam-policy) * `role` - (Required) The name of the IAM role to attach to the policy. ## Attribute Reference -This resource exports the following attributes in addition to the arguments above: - -* `id` - The role policy ID, in the form of `role_name:role_policy_name`. -* `name` - The name of the policy. -* `policy` - The policy document attached to the role. -* `role` - The name of the role associated with the policy. +This resource exports no additional attributes. ## Import @@ -108,4 +105,4 @@ Using `terraform import`, import IAM Role Policies using the `role_name:role_pol % terraform import aws_iam_role_policy.mypolicy role_of_mypolicy_name:mypolicy_name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/iam_server_certificate.html.markdown b/website/docs/cdktf/python/r/iam_server_certificate.html.markdown index a71fd5ca8309..a67694d9dc31 100644 --- a/website/docs/cdktf/python/r/iam_server_certificate.html.markdown +++ b/website/docs/cdktf/python/r/iam_server_certificate.html.markdown @@ -118,9 +118,9 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: -* `certificate_body` – (Required, Forces new resource) The contents of the public key certificate in +* `certificate_body` - (Required, Forces new resource) The contents of the public key certificate in PEM-encoded format. -* `certificate_chain` – (Optional, Forces new resource) The contents of the certificate chain. +* `certificate_chain` - (Optional, Forces new resource) The contents of the certificate chain. This is typically a concatenation of the PEM-encoded public key certificates of the chain. * `name` - (Optional) The name of the Server Certificate. Do not include the path in this value. If omitted, Terraform will assign a random, unique name. @@ -130,7 +130,7 @@ This resource supports the following arguments: included, it defaults to a slash (/). If this certificate is for use with AWS CloudFront, the path must be in format `/cloudfront/your_path_here`. See [IAM Identifiers][1] for more details on IAM Paths. -* `private_key` – (Required, Forces new resource) The contents of the private key in PEM-encoded format. +* `private_key` - (Required, Forces new resource) The contents of the private key in PEM-encoded format. * `tags` - (Optional) Map of resource tags for the server certificate. 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. ~> **NOTE:** AWS performs behind-the-scenes modifications to some certificate files if they do not adhere to a specific format. These modifications will result in terraform forever believing that it needs to update the resources since the local and AWS file contents will not match after theses modifications occur. In order to prevent this from happening you must ensure that all your PEM-encoded files use UNIX line-breaks and that `certificate_body` contains only one certificate. All other certificates should go in `certificate_chain`. It is common for some Certificate Authorities to issue certificate files that have DOS line-breaks and that are actually multiple certificates concatenated together in order to form a full certificate chain. @@ -180,4 +180,4 @@ Using `terraform import`, import IAM Server Certificates using the `name`. For e [2]: https://docs.aws.amazon.com/IAM/latest/UserGuide/ManagingServerCerts.html [lifecycle]: /docs/configuration/resources.html - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/iam_signing_certificate.html.markdown b/website/docs/cdktf/python/r/iam_signing_certificate.html.markdown index 37ec406ecdc5..6ad1f0e99bcb 100644 --- a/website/docs/cdktf/python/r/iam_signing_certificate.html.markdown +++ b/website/docs/cdktf/python/r/iam_signing_certificate.html.markdown @@ -63,9 +63,9 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: -* `certificate_body` – (Required) The contents of the signing certificate in PEM-encoded format. -* `status` – (Optional) The status you want to assign to the certificate. `Active` means that the certificate can be used for programmatic calls to Amazon Web Services `Inactive` means that the certificate cannot be used. -* `user_name` – (Required) The name of the user the signing certificate is for. +* `certificate_body` - (Required) The contents of the signing certificate in PEM-encoded format. +* `status` - (Optional) The status you want to assign to the certificate. `Active` means that the certificate can be used for programmatic calls to Amazon Web Services `Inactive` means that the certificate cannot be used. +* `user_name` - (Required) The name of the user the signing certificate is for. ## Attribute Reference @@ -99,4 +99,4 @@ Using `terraform import`, import IAM Signing Certificates using the `id`. For ex % terraform import aws_iam_signing_certificate.certificate IDIDIDIDID:user-name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/iam_virtual_mfa_device.html.markdown b/website/docs/cdktf/python/r/iam_virtual_mfa_device.html.markdown index 8e15ee0afe27..959d4bcf1596 100644 --- a/website/docs/cdktf/python/r/iam_virtual_mfa_device.html.markdown +++ b/website/docs/cdktf/python/r/iam_virtual_mfa_device.html.markdown @@ -45,7 +45,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: * `virtual_mfa_device_name` - (Required) The name of the virtual MFA device. Use with path to uniquely identify a virtual MFA device. -* `path` – (Optional) The path for the virtual MFA device. +* `path` - (Optional) The path for the virtual MFA device. * `tags` - (Optional) Map of resource tags for the virtual mfa device. 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. ## Attribute Reference @@ -84,4 +84,4 @@ Using `terraform import`, import IAM Virtual MFA Devices using the `arn`. For ex % terraform import aws_iam_virtual_mfa_device.example arn:aws:iam::123456789012:mfa/example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/identitystore_group.html.markdown b/website/docs/cdktf/python/r/identitystore_group.html.markdown index 0a93db73f7d6..bdb4280edee8 100644 --- a/website/docs/cdktf/python/r/identitystore_group.html.markdown +++ b/website/docs/cdktf/python/r/identitystore_group.html.markdown @@ -44,6 +44,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `display_name` - (Optional) A string containing the name of the group. This value is commonly displayed when the group is referenced. * `description` - (Optional) A string containing the description of the group. @@ -92,4 +93,4 @@ Using `terraform import`, import an Identity Store Group using the combination ` % terraform import aws_identitystore_group.example d-9c6705e95c/b8a1c340-8031-7071-a2fb-7dc540320c30 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/identitystore_group_membership.html.markdown b/website/docs/cdktf/python/r/identitystore_group_membership.html.markdown index 6f3103c3bc02..06388b4e729b 100644 --- a/website/docs/cdktf/python/r/identitystore_group_membership.html.markdown +++ b/website/docs/cdktf/python/r/identitystore_group_membership.html.markdown @@ -65,6 +65,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `member_id` - (Required) The identifier for a user in the Identity Store. * `group_id` - (Required) The identifier for a group in the Identity Store. * `identity_store_id` - (Required) Identity Store ID associated with the Single Sign-On Instance. @@ -100,4 +101,4 @@ Using `terraform import`, import `aws_identitystore_group_membership` using the % terraform import aws_identitystore_group_membership.example d-0000000000/00000000-0000-0000-0000-000000000000 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/identitystore_user.html.markdown b/website/docs/cdktf/python/r/identitystore_user.html.markdown index 33dd3f8c2f5b..0d3ce8581912 100644 --- a/website/docs/cdktf/python/r/identitystore_user.html.markdown +++ b/website/docs/cdktf/python/r/identitystore_user.html.markdown @@ -60,6 +60,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `addresses` - (Optional) Details about the user's address. At most 1 address is allowed. Detailed below. * `emails` - (Optional) Details about the user's email. At most 1 email is allowed. Detailed below. * `locale` - (Optional) The user's geographical region or location. @@ -99,6 +100,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `formatted` - (Optional) The name that is typically displayed when the name is shown for display. * `honorific_prefix` - (Optional) The honorific prefix of the user. * `honorific_suffix` - (Optional) The honorific suffix of the user. @@ -144,4 +146,4 @@ Using `terraform import`, import an Identity Store User using the combination `i % terraform import aws_identitystore_user.example d-9c6705e95c/065212b4-9061-703b-5876-13a517ae2a7c ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/imagebuilder_component.html.markdown b/website/docs/cdktf/python/r/imagebuilder_component.html.markdown index 2b4968759b9d..0e804d732d1f 100644 --- a/website/docs/cdktf/python/r/imagebuilder_component.html.markdown +++ b/website/docs/cdktf/python/r/imagebuilder_component.html.markdown @@ -84,6 +84,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `change_description` - (Optional) Change description of the component. * `data` - (Optional) Inline YAML string with data of the component. Exactly one of `data` and `uri` can be specified. Terraform will only perform drift detection of its value when present in a configuration. * `description` - (Optional) Description of the component. @@ -133,4 +134,4 @@ Using `terraform import`, import `aws_imagebuilder_components` resources using t Certain resource arguments, such as `uri`, cannot be read via the API and imported into Terraform. Terraform will display a difference for these arguments the first run after import if declared in the Terraform configuration for an imported resource. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/imagebuilder_container_recipe.html.markdown b/website/docs/cdktf/python/r/imagebuilder_container_recipe.html.markdown index e52a1666f369..fea0892f221a 100644 --- a/website/docs/cdktf/python/r/imagebuilder_container_recipe.html.markdown +++ b/website/docs/cdktf/python/r/imagebuilder_container_recipe.html.markdown @@ -64,6 +64,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `description` - (Optional) The description of the container recipe. * `dockerfile_template_data` - (Optional) The Dockerfile template used to build the image as an inline data blob. * `dockerfile_template_uri` - (Optional) The Amazon S3 URI for the Dockerfile that will be used to build the container image. @@ -98,6 +99,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `block_device_mapping` - (Optional) Configuration block(s) with block device mappings for the container recipe. Detailed below. * `image` - (Optional) The AMI ID to use as the base image for a container build and test instance. If not specified, Image Builder will use the appropriate ECS-optimized AMI as a base image. @@ -105,6 +107,7 @@ The following arguments are optional: The following arguments are optional: +* `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). * `device_name` - (Optional) Name of the device. For example, `/dev/sda` or `/dev/xvdb`. * `ebs` - (Optional) Configuration block with Elastic Block Storage (EBS) block device mapping settings. Detailed below. * `no_device` - (Optional) Set to `true` to remove a mapping from the parent image. @@ -114,6 +117,7 @@ The following arguments are optional: The following arguments are optional: +* `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). * `delete_on_termination` - (Optional) Whether to delete the volume on termination. Defaults to unset, which is the value inherited from the parent image. * `encrypted` - (Optional) Whether to encrypt the volume. Defaults to unset, which is the value inherited from the parent image. * `iops` - (Optional) Number of Input/Output (I/O) operations per second to provision for an `io1` or `io2` volume. @@ -159,4 +163,4 @@ Using `terraform import`, import `aws_imagebuilder_container_recipe` resources u % terraform import aws_imagebuilder_container_recipe.example arn:aws:imagebuilder:us-east-1:123456789012:container-recipe/example/1.0.0 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/imagebuilder_distribution_configuration.html.markdown b/website/docs/cdktf/python/r/imagebuilder_distribution_configuration.html.markdown index fd3e2ce09558..5fc16c5fa653 100644 --- a/website/docs/cdktf/python/r/imagebuilder_distribution_configuration.html.markdown +++ b/website/docs/cdktf/python/r/imagebuilder_distribution_configuration.html.markdown @@ -57,6 +57,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `description` - (Optional) Description of the distribution configuration. * `tags` - (Optional) Key-value map of resource tags for the distribution configuration. 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. @@ -68,6 +69,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `ami_distribution_configuration` - (Optional) Configuration block with Amazon Machine Image (AMI) distribution settings. Detailed below. * `container_distribution_configuration` - (Optional) Configuration block with container distribution settings. Detailed below. * `fast_launch_configuration` - (Optional) Set of Windows faster-launching configurations to use for AMI distribution. Detailed below. @@ -80,6 +82,7 @@ The following arguments are optional: The following arguments are optional: +* `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). * `ami_tags` - (Optional) Key-value map of tags to apply to the distributed AMI. * `description` - (Optional) Description to apply to the distributed AMI. * `kms_key_id` - (Optional) Amazon Resource Name (ARN) of the Key Management Service (KMS) Key to encrypt the distributed AMI. @@ -91,6 +94,7 @@ The following arguments are optional: The following arguments are optional: +* `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). * `organization_arns` - (Optional) Set of AWS Organization ARNs to assign. * `organizational_unit_arns` - (Optional) Set of AWS Organizational Unit ARNs to assign. * `user_groups` - (Optional) Set of EC2 launch permission user groups to assign. Use `all` to distribute a public AMI. @@ -178,4 +182,4 @@ Using `terraform import`, import `aws_imagebuilder_distribution_configurations` % terraform import aws_imagebuilder_distribution_configuration.example arn:aws:imagebuilder:us-east-1:123456789012:distribution-configuration/example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/imagebuilder_image.html.markdown b/website/docs/cdktf/python/r/imagebuilder_image.html.markdown index c3a83b32c3f4..5ddbc5f6a261 100644 --- a/website/docs/cdktf/python/r/imagebuilder_image.html.markdown +++ b/website/docs/cdktf/python/r/imagebuilder_image.html.markdown @@ -41,6 +41,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `container_recipe_arn` - (Optional) - Amazon Resource Name (ARN) of the container recipe. * `distribution_configuration_arn` - (Optional) Amazon Resource Name (ARN) of the Image Builder Distribution Configuration. * `enhanced_image_metadata_enabled` - (Optional) Whether additional information about the image being created is collected. Defaults to `true`. @@ -55,6 +56,7 @@ The following arguments are optional: The following arguments are optional: +* `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). * `image_tests_enabled` - (Optional) Whether image tests are enabled. Defaults to `true`. * `timeout_minutes` - (Optional) Number of minutes before image tests time out. Valid values are between `60` and `1440`. Defaults to `720`. @@ -62,6 +64,7 @@ The following arguments are optional: The following arguments are optional: +* `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). * `image_scanning_enabled` - (Optional) Indicates whether Image Builder keeps a snapshot of the vulnerability scans that Amazon Inspector runs against the build instance when you create a new image. Defaults to `false`. * `ecr_configuration` - (Optional) Configuration block with ECR configuration. Detailed below. @@ -69,6 +72,7 @@ The following arguments are optional: The following arguments are optional: +* `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). * `repository_name` - (Optional) The name of the container repository that Amazon Inspector scans to identify findings for your container images. * `container_tags` - (Optional) Set of tags for Image Builder to apply to the output container image that that Amazon Inspector scans. @@ -80,6 +84,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `on_failure` - (Optional) The action to take if the workflow fails. Must be one of `CONTINUE` or `ABORT`. * `parallel_group` - (Optional) The parallel group in which to run a test Workflow. * `parameter` - (Optional) Configuration block for the workflow parameters. Detailed below. @@ -143,4 +148,4 @@ Using `terraform import`, import `aws_imagebuilder_image` resources using the Am % terraform import aws_imagebuilder_image.example arn:aws:imagebuilder:us-east-1:123456789012:image/example/1.0.0/1 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/imagebuilder_image_pipeline.html.markdown b/website/docs/cdktf/python/r/imagebuilder_image_pipeline.html.markdown index 67e5f392005e..c1b2c1fe37c2 100644 --- a/website/docs/cdktf/python/r/imagebuilder_image_pipeline.html.markdown +++ b/website/docs/cdktf/python/r/imagebuilder_image_pipeline.html.markdown @@ -53,7 +53,7 @@ class MyConvertedCode(TerraformStack): ) ], name="example", - parent_image="arn:${" + current.partition + "}:imagebuilder:${" + data_aws_region_current.name + "}:aws:image/amazon-linux-2-x86/x.x.x", + parent_image="arn:${" + current.partition + "}:imagebuilder:${" + data_aws_region_current.region + "}:aws:image/amazon-linux-2-x86/x.x.x", version="1.0.0" ) aws_imagebuilder_image_pipeline_example = ImagebuilderImagePipeline(self, "example_1", @@ -80,6 +80,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `container_recipe_arn` - (Optional) Amazon Resource Name (ARN) of the container recipe. * `description` - (Optional) Description of the image pipeline. * `distribution_configuration_arn` - (Optional) Amazon Resource Name (ARN) of the Image Builder Distribution Configuration. @@ -97,6 +98,7 @@ The following arguments are optional: The following arguments are optional: +* `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). * `image_scanning_enabled` - (Optional) Whether image scans are enabled. Defaults to `false`. * `ecr_configuration` - (Optional) Configuration block with ECR configuration for image scanning. Detailed below. @@ -104,6 +106,7 @@ The following arguments are optional: The following arguments are optional: +* `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). * `container tags` - (Optional) list of tags to apply to scanned images * `repository_name` - (Optional) The name of the repository to scan @@ -111,6 +114,7 @@ The following arguments are optional: The following arguments are optional: +* `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). * `image_tests_enabled` - (Optional) Whether image tests are enabled. Defaults to `true`. * `timeout_minutes` - (Optional) Number of minutes before image tests time out. Valid values are between `60` and `1440`. Defaults to `720`. @@ -122,6 +126,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `pipeline_execution_start_condition` - (Optional) Condition when the pipeline should trigger a new image build. Valid values are `EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE` and `EXPRESSION_MATCH_ONLY`. Defaults to `EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE`. * `timezone` - (Optional) The timezone that applies to the scheduling expression. For example, "Etc/UTC", "America/Los_Angeles" in the [IANA timezone format](https://www.joda.org/joda-time/timezones.html). If not specified this defaults to UTC. @@ -134,6 +139,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `on_failure` - (Optional) The action to take if the workflow fails. Must be one of `CONTINUE` or `ABORT`. * `parallel_group` - (Optional) The parallel group in which to run a test Workflow. * `parameter` - (Optional) Configuration block for the workflow parameters. Detailed below. @@ -182,4 +188,4 @@ Using `terraform import`, import `aws_imagebuilder_image_pipeline` resources usi % terraform import aws_imagebuilder_image_pipeline.example arn:aws:imagebuilder:us-east-1:123456789012:image-pipeline/example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/imagebuilder_image_recipe.html.markdown b/website/docs/cdktf/python/r/imagebuilder_image_recipe.html.markdown index fefc3f20a324..16d06694f2fd 100644 --- a/website/docs/cdktf/python/r/imagebuilder_image_recipe.html.markdown +++ b/website/docs/cdktf/python/r/imagebuilder_image_recipe.html.markdown @@ -49,7 +49,7 @@ class MyConvertedCode(TerraformStack): ) ], name="example", - parent_image="arn:${" + current.partition + "}:imagebuilder:${" + data_aws_region_current.name + "}:aws:image/amazon-linux-2-x86/x.x.x", + parent_image="arn:${" + current.partition + "}:imagebuilder:${" + data_aws_region_current.region + "}:aws:image/amazon-linux-2-x86/x.x.x", version="1.0.0" ) ``` @@ -65,6 +65,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `block_device_mapping` - (Optional) Configuration block(s) with block device mappings for the image recipe. Detailed below. * `description` - (Optional) Description of the image recipe. * `systems_manager_agent` - (Optional) Configuration block for the Systems Manager Agent installed by default by Image Builder. Detailed below. @@ -139,4 +140,4 @@ Using `terraform import`, import `aws_imagebuilder_image_recipe` resources using % terraform import aws_imagebuilder_image_recipe.example arn:aws:imagebuilder:us-east-1:123456789012:image-recipe/example/1.0.0 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/imagebuilder_infrastructure_configuration.html.markdown b/website/docs/cdktf/python/r/imagebuilder_infrastructure_configuration.html.markdown index 5f4eb731563b..e5cb94609827 100644 --- a/website/docs/cdktf/python/r/imagebuilder_infrastructure_configuration.html.markdown +++ b/website/docs/cdktf/python/r/imagebuilder_infrastructure_configuration.html.markdown @@ -57,6 +57,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `description` - (Optional) Description for the configuration. * `instance_metadata_options` - (Optional) Configuration block with instance metadata options for the HTTP requests that pipeline builds use to launch EC2 build and test instances. Detailed below. * `instance_types` - (Optional) Set of EC2 Instance Types. @@ -74,6 +75,7 @@ The following arguments are optional: The following arguments are optional: +* `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). * `http_put_response_hop_limit` - The number of hops that an instance can traverse to reach its destonation. * `http_tokens` - Whether a signed token is required for instance metadata retrieval requests. Valid values: `required`, `optional`. @@ -91,12 +93,14 @@ The following arguments are required: The following arguments are optional: +* `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). * `s3_key_prefix` - (Optional) Prefix to use for S3 logs. Defaults to `/`. ### placement The following arguments are optional: +* `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). * `availability_zone` - (Optional) Availability Zone where your build and test instances will launch. * `host_id` - (Optional) ID of the Dedicated Host on which build and test instances run. Conflicts with `host_resource_group_arn`. * `host_resource_group_arn` - (Optional) ARN of the host resource group in which to launch build and test instances. Conflicts with `host_id`. @@ -137,4 +141,4 @@ Using `terraform import`, import `aws_imagebuilder_infrastructure_configuration` % terraform import aws_imagebuilder_infrastructure_configuration.example arn:aws:imagebuilder:us-east-1:123456789012:infrastructure-configuration/example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/imagebuilder_lifecycle_policy.html.markdown b/website/docs/cdktf/python/r/imagebuilder_lifecycle_policy.html.markdown index 630162e1293b..0120e7673e66 100644 --- a/website/docs/cdktf/python/r/imagebuilder_lifecycle_policy.html.markdown +++ b/website/docs/cdktf/python/r/imagebuilder_lifecycle_policy.html.markdown @@ -22,11 +22,11 @@ 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. import ImagebuilderLifecyclePolicy from imports.aws.data_aws_partition import DataAwsPartition from imports.aws.data_aws_region import DataAwsRegion from imports.aws.iam_role import IamRole from imports.aws.iam_role_policy_attachment import IamRolePolicyAttachment +from imports.aws.imagebuilder_lifecycle_policy import ImagebuilderLifecyclePolicy class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) @@ -61,27 +61,26 @@ class MyConvertedCode(TerraformStack): description="Example description", execution_role=example.arn, name="name", - policy_detail=[{ - "action": [{ - "type": "DELETE" - } + policy_detail=[ImagebuilderLifecyclePolicyPolicyDetail( + action=[ImagebuilderLifecyclePolicyPolicyDetailAction( + type="DELETE" + ) ], - "filter": [{ - "retain_at_least": 10, - "type": "AGE", - "unit": "YEARS", - "value": 6 - } + filter=[ImagebuilderLifecyclePolicyPolicyDetailFilter( + retain_at_least=10, + type="AGE", + unit="YEARS", + value=6 + ) ] - } + ) ], - resource_selection=[{ - "tag_map": [{ + resource_selection=[ImagebuilderLifecyclePolicyResourceSelection( + tag_map={ "key1": "value1", "key2": "value2" } - ] - } + ) ], resource_type="AMI_IMAGE" ) @@ -101,6 +100,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `description` - (Optional) description for the lifecycle policy. * `tags` - (Optional) Key-value map of resource tags for the Image Builder Lifecycle Policy. 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. @@ -113,6 +113,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `exclusion_rules` - (Optional) Additional rules to specify resources that should be exempt from policy actions. ### action @@ -123,12 +124,14 @@ The following arguments are required: The following arguments are optional: +* `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). * `include_resources` - (Optional) Specifies the resources that the lifecycle policy applies to. Detailed below. ### include_resources The following arguments are optional: +* `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). * `amis` - (Optional) Specifies whether the lifecycle action should apply to distributed AMIs. * `containers` - (Optional) Specifies whether the lifecycle action should apply to distributed containers. * `snapshots` - (Optional) Specifies whether the lifecycle action should apply to snapshots associated with distributed AMIs. @@ -142,6 +145,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `retain_at_least` - (Optional) For age-based filters, this is the number of resources to keep on hand after the lifecycle DELETE action is applied. Impacted resources are only deleted if you have more than this number of resources. If you have fewer resources than this number, the impacted resource is not deleted. * `unit` - (Optional) Defines the unit of time that the lifecycle policy uses to determine impacted resources. This is required for age-based rules. Valid values: `DAYS`, `WEEKS`, `MONTHS` or `YEARS`. @@ -149,6 +153,7 @@ The following arguments are optional: The following arguments are optional: +* `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). * `amis` - (Optional) Lists configuration values that apply to AMIs that Image Builder should exclude from the lifecycle action. Detailed below. * `tag_map` - (Optional) Contains a list of tags that Image Builder uses to skip lifecycle actions for Image Builder image resources that have them. @@ -156,6 +161,7 @@ The following arguments are optional: The following arguments are optional: +* `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). * `is_public` - (Optional) Configures whether public AMIs are excluded from the lifecycle action. * `last_launched` - (Optional) Specifies configuration details for Image Builder to exclude the most recent resources from lifecycle actions. Detailed below. * `regions` - (Optional) Configures AWS Regions that are excluded from the lifecycle action. @@ -173,6 +179,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `recipe` - (Optional) A list of recipe that are used as selection criteria for the output images that the lifecycle policy applies to. Detailed below. * `tag_map` - (Optional) A list of tags that are used as selection criteria for the Image Builder image resources that the lifecycle policy applies to. @@ -204,7 +211,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 ImagebuilderLifecyclePolicy +from imports.aws.imagebuilder_lifecycle_policy import ImagebuilderLifecyclePolicy class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) @@ -217,4 +224,4 @@ Using `terraform import`, import `aws_imagebuilder_lifecycle_policy` using the A % terraform import aws_imagebuilder_lifecycle_policy.example arn:aws:imagebuilder:us-east-1:123456789012:lifecycle-policy/example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/imagebuilder_workflow.html.markdown b/website/docs/cdktf/python/r/imagebuilder_workflow.html.markdown index b8fd7a441db9..f43b2399d2f1 100644 --- a/website/docs/cdktf/python/r/imagebuilder_workflow.html.markdown +++ b/website/docs/cdktf/python/r/imagebuilder_workflow.html.markdown @@ -47,6 +47,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `change_description` - (Optional) Change description of the workflow. * `data` - (Optional) Inline YAML string with data of the workflow. Exactly one of `data` and `uri` can be specified. * `description` - (Optional) Description of the workflow. @@ -64,7 +65,7 @@ This resource exports the following attributes in addition to the arguments abov ## Import -In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import EC2 Image Builder Workflow using the `example_id_arg`. For example: +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import EC2 Image Builder Workflow using the `arn`. For example: ```python # DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -81,7 +82,7 @@ class MyConvertedCode(TerraformStack): ImagebuilderWorkflow.generate_config_for_import(self, "example", "workflow-id-12345678") ``` -Using `terraform import`, import EC2 Image Builder Workflow using the `example_id_arg`. For example: +Using `terraform import`, import EC2 Image Builder Workflow using the `arn`. For example: ```console % terraform import aws_imagebuilder_workflow.example arn:aws:imagebuilder:us-east-1:aws:workflow/test/example/1.0.1/1 @@ -89,4 +90,4 @@ Using `terraform import`, import EC2 Image Builder Workflow using the `example_i Certain resource arguments, such as `uri`, cannot be read via the API and imported into Terraform. Terraform will display a difference for these arguments the first run after import if declared in the Terraform configuration for an imported resource. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/inspector2_delegated_admin_account.html.markdown b/website/docs/cdktf/python/r/inspector2_delegated_admin_account.html.markdown index 1627599b92b0..180813edf3dd 100644 --- a/website/docs/cdktf/python/r/inspector2_delegated_admin_account.html.markdown +++ b/website/docs/cdktf/python/r/inspector2_delegated_admin_account.html.markdown @@ -37,8 +37,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `account_id` - (Required) Account to enable as delegated admin account. ## Attribute Reference @@ -79,4 +80,4 @@ Using `terraform import`, import Inspector Delegated Admin Account using the `ac % terraform import aws_inspector2_delegated_admin_account.example 123456789012 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/inspector2_enabler.html.markdown b/website/docs/cdktf/python/r/inspector2_enabler.html.markdown index 26ac957ac720..5b686d092abd 100644 --- a/website/docs/cdktf/python/r/inspector2_enabler.html.markdown +++ b/website/docs/cdktf/python/r/inspector2_enabler.html.markdown @@ -60,12 +60,13 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `account_ids` - (Required) Set of account IDs. Can contain one of: the Organization's Administrator Account, or one or more Member Accounts. * `resource_types` - (Required) Type of resources to scan. - Valid values are `EC2`, `ECR`, `LAMBDA` and `LAMBDA_CODE`. + Valid values are `EC2`, `ECR`, `LAMBDA`, `LAMBDA_CODE` and `CODE_REPOSITORY`. At least one item is required. ## Attribute Reference @@ -80,4 +81,29 @@ This resource exports no additional attributes. * `update` - (Default `5m`) * `delete` - (Default `5m`) - \ No newline at end of file +## Import + +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import Inspector Enabler using `account_ids` and `region_types` formatted as `[account_id1]:[account_id2]:...-[resource_type1]:[resource_type2]:...`, where `account_ids` are sorted in ascending order and `resource_types` are sorted in alphabetical order. 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.inspector2_enabler import Inspector2Enabler +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + Inspector2Enabler.generate_config_for_import(self, "example", "123456789012:234567890123-EC2:ECR") +``` + +Using `terraform import`, import Inspector Enabler using using `account_ids` and `region_types` formatted as `[account_id1]:[account_id2]:...-[resource_type1]:[resource_type2]:...`, where `account_ids` are sorted in ascending order and `resource_types` are sorted in alphabetical order. For example: + +```console +% terraform import aws_inspector2_enabler.example 123456789012:234567890123-EC2:ECR +``` + + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/inspector2_filter.html.markdown b/website/docs/cdktf/python/r/inspector2_filter.html.markdown index c3ca351b859b..c5d2c9cd0f73 100644 --- a/website/docs/cdktf/python/r/inspector2_filter.html.markdown +++ b/website/docs/cdktf/python/r/inspector2_filter.html.markdown @@ -52,6 +52,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `description` - (Optional) Description * `reason` - (Optional) Reason for creating the filter * `tags` - (Optional) Map of tags assigned to the resource. If configured with a provider [`default_tags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. @@ -68,6 +69,8 @@ This resource exports the following attributes in addition to the arguments abov The `filter_criteria` configuration block supports the following attributes: * `aws_account_id` - (Optional) The AWS account ID in which the finding was generated. [Documented below](#string-filter). +* `code_repository_project_name` - (Optional) The project name in a code repository. [Documented below](#string-filter). +* `code_repository_provider_type` - (Optional) The repository provider type (such as GitHub, GitLab, etc.) [Documented below](#string-filter). * `code_vulnerability_detector_name` - (Optional) The ID of the component. [Documented below](#string-filter). * `code_vulnerability_detector_tags` - (Optional) The ID of the component. [Documented below](#string-filter). * `code_vulnerability_file_path` - (Optional) The ID of the component. [Documented below](#string-filter). @@ -77,6 +80,8 @@ The `filter_criteria` configuration block supports the following attributes: * `ec2_instance_subnet_id` - (Optional) The ID of the subnet. [Documented below](#string-filter). * `ec2_instance_vpc_id` - (Optional) The ID of the VPC. [Documented below](#string-filter). * `ecr_image_architecture` - (Optional) The architecture of the ECR image. [Documented below](#string-filter). +* `ecr_image_in_use_count` - (Optional) The number of the ECR images in use. [Documented below](#number-filter). +* `ecr_image_last_in_use_at` - (Optional) The date range when an ECR image was last used in an ECS cluster task or EKS cluster pod. [Documented below](#date-filter). * `ecr_image_hash` - (Optional) The SHA256 hash of the ECR image. [Documented below](#string-filter). * `ecr_image_pushed_at` - (Optional) The date range when the image was pushed. [Documented below](#date-filter). * `ecr_image_registry` - (Optional) The registry of the ECR image. [Documented below](#string-filter). @@ -178,10 +183,10 @@ class MyConvertedCode(TerraformStack): Inspector2Filter.generate_config_for_import(self, "example", "arn:aws:inspector2:us-east-1:111222333444:owner/111222333444/filter/abcdefgh12345678") ``` -Using `terraform import`, import Inspector Filter using the `example_id_arg`. For example: +Using `terraform import`, import Inspector Filter using the `arn`. For example: ```console % terraform import aws_inspector2_filter.example "arn:aws:inspector2:us-east-1:111222333444:owner/111222333444/filter/abcdefgh12345678" ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/inspector2_member_association.html.markdown b/website/docs/cdktf/python/r/inspector2_member_association.html.markdown index cff5f731aa84..56a9c9ea0b58 100644 --- a/website/docs/cdktf/python/r/inspector2_member_association.html.markdown +++ b/website/docs/cdktf/python/r/inspector2_member_association.html.markdown @@ -35,8 +35,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `account_id` - (Required) ID of the account to associate ## Attribute Reference @@ -72,4 +73,4 @@ Using `terraform import`, import Amazon Inspector Member Association using the ` % terraform import aws_inspector2_member_association.example 123456789012 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/inspector2_organization_configuration.html.markdown b/website/docs/cdktf/python/r/inspector2_organization_configuration.html.markdown index 229bc33c510f..a7e77091dcd7 100644 --- a/website/docs/cdktf/python/r/inspector2_organization_configuration.html.markdown +++ b/website/docs/cdktf/python/r/inspector2_organization_configuration.html.markdown @@ -34,6 +34,7 @@ class MyConvertedCode(TerraformStack): super().__init__(scope, name) Inspector2OrganizationConfiguration(self, "example", auto_enable=Inspector2OrganizationConfigurationAutoEnable( + code_repository=False, ec2=True, ecr=False, lambda_=True, @@ -44,14 +45,16 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `auto_enable` - (Required) Configuration block for auto enabling. See below. ### `auto_enable` * `ec2` - (Required) Whether Amazon EC2 scans are automatically enabled for new members of your Amazon Inspector organization. * `ecr` - (Required) Whether Amazon ECR scans are automatically enabled for new members of your Amazon Inspector organization. +* `code_repository` - (Optional) Whether code repository scans are automatically enabled for new members of your Amazon Inspector organization. * `lambda` - (Optional) Whether Lambda Function scans are automatically enabled for new members of your Amazon Inspector organization. * `lambda_code` - (Optional) Whether AWS Lambda code scans are automatically enabled for new members of your Amazon Inspector organization. **Note:** Lambda code scanning requires Lambda standard scanning to be activated. Consequently, if you are setting this argument to `true`, you must also set the `lambda` argument to `true`. See [Scanning AWS Lambda functions with Amazon Inspector](https://docs.aws.amazon.com/inspector/latest/user/scanning-lambda.html#lambda-code-scans) for more information. @@ -69,4 +72,4 @@ This resource exports the following attributes in addition to the arguments abov * `update` - (Default `5m`) * `delete` - (Default `5m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/inspector_assessment_target.html.markdown b/website/docs/cdktf/python/r/inspector_assessment_target.html.markdown index 4ab34fd8e3f8..d20aba91c15e 100644 --- a/website/docs/cdktf/python/r/inspector_assessment_target.html.markdown +++ b/website/docs/cdktf/python/r/inspector_assessment_target.html.markdown @@ -43,6 +43,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) The name of the assessment target. * `resource_group_arn` (Optional) Inspector Resource Group Amazon Resource Name (ARN) stating tags for instance matching. If not specified, all EC2 instances in the current AWS account and region are included in the assessment target. @@ -77,4 +78,4 @@ Using `terraform import`, import Inspector Classic Assessment Targets using thei % terraform import aws_inspector_assessment_target.example arn:aws:inspector:us-east-1:123456789012:target/0-xxxxxxx ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/inspector_assessment_template.html.markdown b/website/docs/cdktf/python/r/inspector_assessment_template.html.markdown index 333d5a9144d0..ee9b56bcbc7a 100644 --- a/website/docs/cdktf/python/r/inspector_assessment_template.html.markdown +++ b/website/docs/cdktf/python/r/inspector_assessment_template.html.markdown @@ -44,6 +44,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) The name of the assessment template. * `target_arn` - (Required) The assessment target ARN to attach the template to. * `duration` - (Required) The duration of the inspector run. @@ -90,4 +91,4 @@ Using `terraform import`, import `aws_inspector_assessment_template` using the t % terraform import aws_inspector_assessment_template.example arn:aws:inspector:us-west-2:123456789012:target/0-9IaAzhGR/template/0-WEcjR8CH ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/inspector_resource_group.html.markdown b/website/docs/cdktf/python/r/inspector_resource_group.html.markdown index 0c3aaeebe3a0..41dcf4c140de 100644 --- a/website/docs/cdktf/python/r/inspector_resource_group.html.markdown +++ b/website/docs/cdktf/python/r/inspector_resource_group.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `tags` - (Required) Key-value map of tags that are used to select the EC2 instances to be included in an [Amazon Inspector assessment target](/docs/providers/aws/r/inspector_assessment_target.html). ## Attribute Reference @@ -46,4 +47,4 @@ This resource exports the following attributes in addition to the arguments abov * `arn` - The resource group ARN. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/instance.html.markdown b/website/docs/cdktf/python/r/instance.html.markdown index 9cca4b555f67..c90c6c5602ea 100644 --- a/website/docs/cdktf/python/r/instance.html.markdown +++ b/website/docs/cdktf/python/r/instance.html.markdown @@ -43,7 +43,7 @@ class MyConvertedCode(TerraformStack): most_recent=True, owners=["099720109477"] ) - Instance(self, "web", + Instance(self, "example", ami=Token.as_string(ubuntu.id), instance_type="t3.micro", tags={ @@ -66,7 +66,7 @@ from imports.aws.instance import Instance class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) - Instance(self, "web", + Instance(self, "example", ami="resolve:ssm:/aws/service/ami-amazon-linux-latest/al2023-ami-kernel-default-x86_64", instance_type="t3.micro", tags={ @@ -90,7 +90,7 @@ from imports.aws.instance import Instance class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) - this_var = DataAwsAmi(self, "this", + example = DataAwsAmi(self, "example", filter=[DataAwsAmiFilter( name="architecture", values=["arm64"] @@ -102,8 +102,8 @@ class MyConvertedCode(TerraformStack): most_recent=True, owners=["amazon"] ) - aws_instance_this = Instance(self, "this_1", - ami=Token.as_string(this_var.id), + aws_instance_example = Instance(self, "example_1", + ami=Token.as_string(example.id), instance_market_options=InstanceInstanceMarketOptions( market_type="spot", spot_options=InstanceInstanceMarketOptionsSpotOptions( @@ -116,7 +116,7 @@ class MyConvertedCode(TerraformStack): } ) # 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_instance_this.override_logical_id("this") + aws_instance_example.override_logical_id("example") ``` ### Network and credit specification example @@ -150,27 +150,25 @@ class MyConvertedCode(TerraformStack): }, vpc_id=my_vpc.id ) - foo = NetworkInterface(self, "foo", + example = NetworkInterface(self, "example", private_ips=["172.16.10.100"], subnet_id=my_subnet.id, tags={ "Name": "primary_network_interface" } ) - aws_instance_foo = Instance(self, "foo_3", + aws_instance_example = Instance(self, "example_3", ami="ami-005e54dee72cc1d00", credit_specification=InstanceCreditSpecification( cpu_credits="unlimited" ), instance_type="t2.micro", - network_interface=[InstanceNetworkInterface( - device_index=0, - network_interface_id=foo.id + primary_network_interface=InstancePrimaryNetworkInterface( + network_interface_id=example.id ) - ] ) # 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_instance_foo.override_logical_id("foo") + aws_instance_example.override_logical_id("example") ``` ### CPU options example @@ -273,17 +271,12 @@ Do not use `volume_tags` if you plan to manage block device tags outside the `aw This resource supports the following arguments: +* `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). * `ami` - (Optional) AMI to use for the instance. Required unless `launch_template` is specified and the Launch Template specifes an AMI. If an AMI is specified in the Launch Template, setting `ami` will override the AMI specified in the Launch Template. * `associate_public_ip_address` - (Optional) Whether to associate a public IP address with an instance in a VPC. * `availability_zone` - (Optional) AZ to start the instance in. - * `capacity_reservation_specification` - (Optional) Describes an instance's Capacity Reservation targeting option. See [Capacity Reservation Specification](#capacity-reservation-specification) below for more details. - --> **NOTE:** Changing `cpu_core_count` and/or `cpu_threads_per_core` will cause the resource to be destroyed and re-created. - -* `cpu_core_count` - (Optional, **Deprecated** use the `cpu_options` argument instead) Sets the number of CPU cores for an instance. This option is only supported on creation of instance type that support CPU Options [CPU Cores and Threads Per CPU Core Per Instance Type](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-optimize-cpu.html#cpu-options-supported-instances-values) - specifying this option for unsupported instance types will return an error from the EC2 API. * `cpu_options` - (Optional) The CPU options for the instance. See [CPU Options](#cpu-options) below for more details. -* `cpu_threads_per_core` - (Optional - has no effect unless `cpu_core_count` is also set, **Deprecated** use the `cpu_options` argument instead) If set to 1, hyperthreading is disabled on the launched instance. Defaults to 2 if not set. See [Optimizing CPU Options](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-optimize-cpu.html) for more information. * `credit_specification` - (Optional) Configuration block for customizing the credit specification of the instance. See [Credit Specification](#credit-specification) below for more details. Terraform will only perform drift detection of its value when present in a configuration. Removing this configuration on existing instances will only stop managing it. It will not change the configuration back to the default for the instance type. * `disable_api_stop` - (Optional) If true, enables [EC2 Instance Stop Protection](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Stop_Start.html#Using_StopProtection). * `disable_api_termination` - (Optional) If true, enables [EC2 Instance Termination Protection](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/terminating-instances.html#Using_ChangingDisableAPITermination). @@ -292,6 +285,7 @@ This resource supports the following arguments: * `enable_primary_ipv6` - (Optional) Whether to assign a primary IPv6 Global Unicast Address (GUA) to the instance when launched in a dual-stack or IPv6-only subnet. A primary IPv6 address ensures a consistent IPv6 address for the instance and is automatically assigned by AWS to the ENI. Once enabled, the first IPv6 GUA becomes the primary IPv6 address and cannot be disabled. The primary IPv6 address remains until the instance is terminated or the ENI is detached. Disabling `enable_primary_ipv6` after it has been enabled forces recreation of the instance. * `enclave_options` - (Optional) Enable Nitro Enclaves on launched instances. See [Enclave Options](#enclave-options) below for more details. * `ephemeral_block_device` - (Optional) One or more configuration blocks to customize Ephemeral (also known as "Instance Store") volumes on the instance. See [Block Devices](#ebs-ephemeral-and-root-block-devices) below for details. When accessing this as an attribute reference, it is a set of objects. +* `force_destroy` - (Optional) Destroys instance even if `disable_api_termination` or `disable_api_stop` is set to `true`. Defaults to `false`. Once this parameter is set to `true`, a successful `terraform apply` run before a destroy is required to update this value in the resource state. Without a successful `terraform apply` after this parameter is set, this flag will have no effect. If setting this field in the same operation that would require replacing the instance or destroying the instance, this flag will not work. Additionally when importing an instance, a successful `terraform apply` is required to set this value in state before it will take effect on a destroy operation. * `get_password_data` - (Optional) If true, wait for password data to become available and retrieve it. Useful for getting the administrator password for instances running Microsoft Windows. The password data is exported to the `password_data` attribute. See [GetPasswordData](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetPasswordData.html) for more information. * `hibernation` - (Optional) If true, the launched EC2 instance will support hibernation. * `host_id` - (Optional) ID of a dedicated host that the instance will be assigned to. Use when an instance is to be launched on a specific dedicated host. @@ -307,9 +301,10 @@ This resource supports the following arguments: * `maintenance_options` - (Optional) Maintenance and recovery options for the instance. See [Maintenance Options](#maintenance-options) below for more details. * `metadata_options` - (Optional) Customize the metadata options of the instance. See [Metadata Options](#metadata-options) below for more details. * `monitoring` - (Optional) If true, the launched EC2 instance will have detailed monitoring enabled. (Available since v0.6.0) -* `network_interface` - (Optional) Customize network interfaces to be attached at instance boot time. See [Network Interfaces](#network-interfaces) below for more details. +* `network_interface` - (Optional, **Deprecated** to specify the primary network interface, use `primary_network_interface`, to attach additional network interfaces, use `aws_network_interface_attachment` resources) Customize network interfaces to be attached at instance boot time. See [Network Interfaces](#network-interfaces) below for more details. * `placement_group` - (Optional) Placement Group to start the instance in. * `placement_partition_number` - (Optional) Number of the partition the instance is in. Valid only if [the `aws_placement_group` resource's](placement_group.html) `strategy` argument is set to `"partition"`. +* `primary_network_interface` - (Optional) The primary network interface. See [Primary Network Interface](#primary-network-interface) below. * `private_dns_name_options` - (Optional) Options for the instance hostname. The default values are inherited from the subnet. See [Private DNS Name Options](#private-dns-name-options) below for more details. * `private_ip` - (Optional) Private IP address to associate with the instance in a VPC. * `root_block_device` - (Optional) Configuration block to customize details about the root block device of the instance. See [Block Devices](#ebs-ephemeral-and-root-block-devices) below for details. When accessing this as an attribute reference, it is a list containing one object. @@ -456,7 +451,11 @@ For more information, see the documentation on the [Instance Metadata Service](h ### Network Interfaces -Each of the `network_interface` blocks attach a network interface to an EC2 Instance during boot time. However, because the network interface is attached at boot-time, replacing/modifying the network interface **WILL** trigger a recreation of the EC2 Instance. If you should need at any point to detach/modify/re-attach a network interface to the instance, use the `aws_network_interface` or `aws_network_interface_attachment` resources instead. +`network_interface` is **deprecated**. +Use `primary_network_interface` to specify the primary network interface. +To attach additional network interfaces, use [`aws_network_interface_attachment`](docs/r/network_interface_attachment.html.markdown) resources. + +Each of the `network_interface` blocks attach a network interface to an EC2 Instance during boot time. However, because the network interface is attached at boot-time, replacing/modifying the network interface **WILL** trigger a recreation of the EC2 Instance. If you should need at any point to detach/modify/re-attach a network interface to the instance, use [`aws_network_interface_attachment`](docs/r/network_interface_attachment.html.markdown) resources instead. The `network_interface` configuration block _does_, however, allow users to supply their own network interface to be used as the default network interface on an EC2 Instance, attached at `eth0`. @@ -467,6 +466,16 @@ Each `network_interface` block supports the following: * `network_card_index` - (Optional) Integer index of the network card. Limited by instance type. The default index is `0`. * `network_interface_id` - (Required) ID of the network interface to attach. +### Primary Network Interface + +Represents the primary network interface on the EC2 Instance. +To manage additional network interfaces, use [`aws_network_interface_attachment`](docs/r/network_interface_attachment.html.markdown) resources. + +Each `primary_network_interface` block supports the following: + +* `delete_on_termination` - (Read-Only) Whether the network interface will be deleted when the instance terminates. +* `network_interface_id` - (Required) ID of the network interface to attach. + ### Private DNS Name Options The `private_dns_name_options` block supports the following: @@ -540,6 +549,32 @@ For `instance_market_options`, in addition to the arguments above, the following ## Import +In Terraform v1.12.0 and later, the [`import` block](https://developer.hashicorp.com/terraform/language/import) can be used with the `identity` attribute. For example: + +```terraform +import { + to = aws_instance.example + identity = { + id = "i-12345678" + } +} + +resource "aws_instance" "example" { + ### Configuration omitted for brevity ### +} +``` + +### Identity Schema + +#### Required + +* `id` - (String) ID of the instance. + +#### Optional + +- `account_id` (String) AWS Account where this resource is managed. +- `region` (String) Region where this resource is managed. + In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import instances using the `id`. For example: ```python @@ -563,4 +598,4 @@ Using `terraform import`, import instances using the `id`. For example: % terraform import aws_instance.web i-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/internet_gateway.html.markdown b/website/docs/cdktf/python/r/internet_gateway.html.markdown index 33f68b07f931..d5716e09e6a4 100644 --- a/website/docs/cdktf/python/r/internet_gateway.html.markdown +++ b/website/docs/cdktf/python/r/internet_gateway.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `vpc_id` - (Optional) The VPC ID to create in. See the [aws_internet_gateway_attachment](internet_gateway_attachment.html) resource for an alternate way to attach an Internet Gateway to a VPC. * `tags` - (Optional) A 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. @@ -106,4 +107,4 @@ Using `terraform import`, import Internet Gateways using the `id`. For example: % terraform import aws_internet_gateway.gw igw-c0a643a9 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/internet_gateway_attachment.html.markdown b/website/docs/cdktf/python/r/internet_gateway_attachment.html.markdown index 5931035085c9..0f5dd373862b 100644 --- a/website/docs/cdktf/python/r/internet_gateway_attachment.html.markdown +++ b/website/docs/cdktf/python/r/internet_gateway_attachment.html.markdown @@ -46,6 +46,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `internet_gateway_id` - (Required) The ID of the internet gateway. * `vpc_id` - (Required) The ID of the VPC. @@ -87,4 +88,4 @@ Using `terraform import`, import Internet Gateway Attachments using the `id`. Fo % terraform import aws_internet_gateway_attachment.example igw-c0a643a9:vpc-123456 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/internetmonitor_monitor.html.markdown b/website/docs/cdktf/python/r/internetmonitor_monitor.html.markdown index 7097cb39f035..21871117cfa8 100644 --- a/website/docs/cdktf/python/r/internetmonitor_monitor.html.markdown +++ b/website/docs/cdktf/python/r/internetmonitor_monitor.html.markdown @@ -39,6 +39,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `health_events_config` - (Optional) Health event thresholds. A health event threshold percentage, for performance and availability, determines when Internet Monitor creates a health event when there's an internet issue that affects your application end users. See [Health Events Config](#health-events-config) below. * `internet_measurements_log_delivery` - (Optional) Publish internet measurements for Internet Monitor to an Amazon S3 bucket in addition to CloudWatch Logs. * `max_city_networks_to_monitor` - (Optional) The maximum number of city-networks to monitor for your resources. A city-network is the location (city) where clients access your application resources from and the network or ASN, such as an internet service provider (ISP), that clients access the resources through. This limit helps control billing costs. @@ -87,4 +88,4 @@ Using `terraform import`, import Internet Monitor Monitors using the `monitor_na % terraform import aws_internetmonitor_monitor.some some-monitor ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/iot_authorizer.html.markdown b/website/docs/cdktf/python/r/iot_authorizer.html.markdown index 34bc60f9d6e1..f12c38630181 100644 --- a/website/docs/cdktf/python/r/iot_authorizer.html.markdown +++ b/website/docs/cdktf/python/r/iot_authorizer.html.markdown @@ -46,6 +46,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `authorizer_function_arn` - (Required) The ARN of the authorizer's Lambda function. * `enable_caching_for_http` - (Optional) Specifies whether the HTTP caching is enabled or not. Default: `false`. * `name` - (Required) The name of the authorizer. @@ -87,4 +88,4 @@ Using `terraform import`, import IOT Authorizers using the name. For example: % terraform import aws_iot_authorizer.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/iot_billing_group.html.markdown b/website/docs/cdktf/python/r/iot_billing_group.html.markdown index 58c827c40872..01558ca78624 100644 --- a/website/docs/cdktf/python/r/iot_billing_group.html.markdown +++ b/website/docs/cdktf/python/r/iot_billing_group.html.markdown @@ -42,6 +42,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) The name of the Billing Group. * `properties` - (Optional) The Billing Group properties. Defined below. * `tags` - (Optional) Key-value mapping of resource tags @@ -83,4 +84,4 @@ Using `terraform import`, import IoT Billing Groups using the name. For example: % terraform import aws_iot_billing_group.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/iot_ca_certificate.html.markdown b/website/docs/cdktf/python/r/iot_ca_certificate.html.markdown index 26e834079849..0e07fd303b0f 100644 --- a/website/docs/cdktf/python/r/iot_ca_certificate.html.markdown +++ b/website/docs/cdktf/python/r/iot_ca_certificate.html.markdown @@ -85,6 +85,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `active` - (Required) Boolean flag to indicate if the certificate should be active for device authentication. * `allow_auto_registration` - (Required) Boolean flag to indicate if the certificate should be active for device regisration. * `ca_certificate_pem` - (Required) PEM encoded CA certificate. @@ -113,4 +114,4 @@ This resource exports the following attributes in addition to the arguments abov * `not_after` - The certificate is not valid after this date. * `not_before` - The certificate is not valid before this date. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/iot_certificate.html.markdown b/website/docs/cdktf/python/r/iot_certificate.html.markdown index 1c89af796051..5fc3b995a3f0 100644 --- a/website/docs/cdktf/python/r/iot_certificate.html.markdown +++ b/website/docs/cdktf/python/r/iot_certificate.html.markdown @@ -77,6 +77,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `active` - (Required) Boolean flag to indicate if the certificate should be active * `csr` - (Optional) The certificate signing request. Review [CreateCertificateFromCsr](https://docs.aws.amazon.com/iot/latest/apireference/API_CreateCertificateFromCsr.html) @@ -101,4 +102,4 @@ This resource exports the following attributes in addition to the arguments abov * `public_key` - When neither CSR nor certificate is provided, the public key. * `private_key` - When neither CSR nor certificate is provided, the private key. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/iot_domain_configuration.html.markdown b/website/docs/cdktf/python/r/iot_domain_configuration.html.markdown index 4853e83e6a67..4899230d5423 100644 --- a/website/docs/cdktf/python/r/iot_domain_configuration.html.markdown +++ b/website/docs/cdktf/python/r/iot_domain_configuration.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `application_protocol` - (Optional) An enumerated string that specifies the application-layer protocol. Valid values are `SECURE_MQTT`, `MQTT_WSS`, `HTTPS` or `DEFAULT`. * `authentication_type` - (Optional) An enumerated string that specifies the authentication type. Valid values are `CUSTOM_AUTH_X509`, `CUSTOM_AUTH`, `AWS_X509`, `AWS_SIGV4` or `DEFAULT`. * `authorizer_config` - (Optional) An object that specifies the authorization service for a domain. See the [`authorizer_config` Block](#authorizer_config-block) below for details. @@ -97,4 +98,4 @@ Using `terraform import`, import domain configurations using the name. For examp % terraform import aws_iot_domain_configuration.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/iot_event_configurations.html.markdown b/website/docs/cdktf/python/r/iot_event_configurations.html.markdown index 9b82a8924303..61032c874cbe 100644 --- a/website/docs/cdktf/python/r/iot_event_configurations.html.markdown +++ b/website/docs/cdktf/python/r/iot_event_configurations.html.markdown @@ -49,6 +49,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `event_configurations` - (Required) Map. The new event configuration values. You can use only these strings as keys: `THING_GROUP_HIERARCHY`, `THING_GROUP_MEMBERSHIP`, `THING_TYPE`, `THING_TYPE_ASSOCIATION`, `THING_GROUP`, `THING`, `POLICY`, `CA_CERTIFICATE`, `JOB_EXECUTION`, `CERTIFICATE`, `JOB`. Use boolean for values of mapping. ## Attribute Reference @@ -80,4 +81,4 @@ Using `terraform import`, import IoT Event Configurations using the AWS Region. % terraform import aws_iot_event_configurations.example us-west-2 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/iot_indexing_configuration.html.markdown b/website/docs/cdktf/python/r/iot_indexing_configuration.html.markdown index eedf625dd70c..54a08b6b7111 100644 --- a/website/docs/cdktf/python/r/iot_indexing_configuration.html.markdown +++ b/website/docs/cdktf/python/r/iot_indexing_configuration.html.markdown @@ -57,6 +57,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `thing_group_indexing_configuration` - (Optional) Thing group indexing configuration. See below. * `thing_indexing_configuration` - (Optional) Thing indexing configuration. See below. @@ -97,4 +98,4 @@ The `filter` configuration block supports the following: This resource exports no additional attributes. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/iot_logging_options.html.markdown b/website/docs/cdktf/python/r/iot_logging_options.html.markdown index 810ecef7d22f..3364caf35a5f 100644 --- a/website/docs/cdktf/python/r/iot_logging_options.html.markdown +++ b/website/docs/cdktf/python/r/iot_logging_options.html.markdown @@ -36,6 +36,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `default_log_level` - (Optional) The default logging level. Valid Values: `"DEBUG"`, `"INFO"`, `"ERROR"`, `"WARN"`, `"DISABLED"`. * `disable_all_logs` - (Optional) If `true` all logs are disabled. The default is `false`. * `role_arn` - (Required) The ARN of the role that allows IoT to write to Cloudwatch logs. @@ -44,4 +45,4 @@ This resource supports the following arguments: This resource exports no additional attributes. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/iot_policy.html.markdown b/website/docs/cdktf/python/r/iot_policy.html.markdown index 314f024cc80b..9bbe8cb38526 100644 --- a/website/docs/cdktf/python/r/iot_policy.html.markdown +++ b/website/docs/cdktf/python/r/iot_policy.html.markdown @@ -47,6 +47,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) The name of the policy. * `policy` - (Required) The policy document. This is a JSON formatted string. Use the [IoT Developer Guide](http://docs.aws.amazon.com/iot/latest/developerguide/iot-policies.html) for more information on IoT Policies. For more information about building AWS IAM policy documents with Terraform, see the [AWS IAM Policy Document Guide](https://learn.hashicorp.com/terraform/aws/iam-policy). * `tags` - (Optional) Key-value mapping of resource tags. If configured with a provider [`default_tags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. @@ -93,4 +94,4 @@ Using `terraform import`, import IoT policies using the `name`. For example: % terraform import aws_iot_policy.pubsub PubSubToAnyTopic ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/iot_policy_attachment.html.markdown b/website/docs/cdktf/python/r/iot_policy_attachment.html.markdown index 86523f69abe4..615c0b0fe7ce 100644 --- a/website/docs/cdktf/python/r/iot_policy_attachment.html.markdown +++ b/website/docs/cdktf/python/r/iot_policy_attachment.html.markdown @@ -57,6 +57,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `policy` - (Required) The name of the policy to attach. * `target` - (Required) The identity to which the policy is attached. @@ -64,4 +65,4 @@ This resource supports the following arguments: This resource exports no additional attributes. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/iot_provisioning_template.html.markdown b/website/docs/cdktf/python/r/iot_provisioning_template.html.markdown index 344ba7acb976..b6b470c0497a 100644 --- a/website/docs/cdktf/python/r/iot_provisioning_template.html.markdown +++ b/website/docs/cdktf/python/r/iot_provisioning_template.html.markdown @@ -100,6 +100,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) The name of the fleet provisioning template. * `description` - (Optional) The description of the fleet provisioning template. * `enabled` - (Optional) True to enable the fleet provisioning template, otherwise false. @@ -149,4 +150,4 @@ Using `terraform import`, import IoT fleet provisioning templates using the `nam % terraform import aws_iot_provisioning_template.fleet FleetProvisioningTemplate ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/iot_role_alias.html.markdown b/website/docs/cdktf/python/r/iot_role_alias.html.markdown index 61f2a31079fb..6b97f7a9e028 100644 --- a/website/docs/cdktf/python/r/iot_role_alias.html.markdown +++ b/website/docs/cdktf/python/r/iot_role_alias.html.markdown @@ -51,6 +51,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `alias` - (Required) The name of the role alias. * `role_arn` - (Required) The identity of the role to which the alias refers. * `credential_duration` - (Optional) The duration of the credential, in seconds. If you do not specify a value for this setting, the default maximum of one hour is applied. This setting can have a value from 900 seconds (15 minutes) to 43200 seconds (12 hours). @@ -88,4 +89,4 @@ Using `terraform import`, import IOT Role Alias using the alias. For example: % terraform import aws_iot_role_alias.example myalias ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/iot_thing.html.markdown b/website/docs/cdktf/python/r/iot_thing.html.markdown index 0c4b28e260b8..50034085db81 100644 --- a/website/docs/cdktf/python/r/iot_thing.html.markdown +++ b/website/docs/cdktf/python/r/iot_thing.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) The name of the thing. * `attributes` - (Optional) Map of attributes of the thing. * `thing_type_name` - (Optional) The thing type name. @@ -75,4 +76,4 @@ Using `terraform import`, import IOT Things using the name. For example: % terraform import aws_iot_thing.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/iot_thing_group.html.markdown b/website/docs/cdktf/python/r/iot_thing_group.html.markdown index d048e000d528..ab2b2a01957b 100644 --- a/website/docs/cdktf/python/r/iot_thing_group.html.markdown +++ b/website/docs/cdktf/python/r/iot_thing_group.html.markdown @@ -51,6 +51,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) The name of the Thing Group. * `parent_group_name` - (Optional) The name of the parent Thing Group. * `properties` - (Optional) The Thing Group properties. Defined below. @@ -98,4 +99,4 @@ Using `terraform import`, import IoT Things Groups using the name. For example: % terraform import aws_iot_thing_group.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/iot_thing_group_membership.html.markdown b/website/docs/cdktf/python/r/iot_thing_group_membership.html.markdown index 09265c2b5613..801209655000 100644 --- a/website/docs/cdktf/python/r/iot_thing_group_membership.html.markdown +++ b/website/docs/cdktf/python/r/iot_thing_group_membership.html.markdown @@ -37,6 +37,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `thing_name` - (Required) The name of the thing to add to a group. * `thing_group_name` - (Required) The name of the group to which you are adding a thing. * `override_dynamic_group` - (Optional) Override dynamic thing groups with static thing groups when 10-group limit is reached. If a thing belongs to 10 thing groups, and one or more of those groups are dynamic thing groups, adding a thing to a static group removes the thing from the last dynamic group. @@ -72,4 +73,4 @@ Using `terraform import`, import IoT Thing Group Membership using the thing grou % terraform import aws_iot_thing_group_membership.example thing_group_name/thing_name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/iot_thing_principal_attachment.html.markdown b/website/docs/cdktf/python/r/iot_thing_principal_attachment.html.markdown index 4c014a0975f9..15dc6d73123d 100644 --- a/website/docs/cdktf/python/r/iot_thing_principal_attachment.html.markdown +++ b/website/docs/cdktf/python/r/iot_thing_principal_attachment.html.markdown @@ -45,11 +45,13 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `principal` - (Required) The AWS IoT Certificate ARN or Amazon Cognito Identity ID. * `thing` - (Required) The name of the thing. +* `thing_principal_type` - (Optional) The type of relationship to specify when attaching a principal to a thing. Valid values are `EXCLUSIVE_THING` (the thing will be the only one attached to the principal) or `NON_EXCLUSIVE_THING` (multiple things can be attached to the principal). Defaults to `NON_EXCLUSIVE_THING`. ## Attribute Reference This resource exports no additional attributes. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/iot_thing_type.html.markdown b/website/docs/cdktf/python/r/iot_thing_type.html.markdown index f179ebbc6ab0..233c44f7fbd7 100644 --- a/website/docs/cdktf/python/r/iot_thing_type.html.markdown +++ b/website/docs/cdktf/python/r/iot_thing_type.html.markdown @@ -35,6 +35,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required, Forces New Resource) The name of the thing type. * `deprecated` - (Optional, Defaults to false) Whether the thing type is deprecated. If true, no new things could be associated with this type. * `properties` - (Optional), Configuration block that can contain the following properties of the thing type: @@ -74,4 +75,4 @@ Using `terraform import`, import IOT Thing Types using the name. For example: % terraform import aws_iot_thing_type.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/iot_topic_rule.html.markdown b/website/docs/cdktf/python/r/iot_topic_rule.html.markdown index dbcdf7b5ba2f..445221db172c 100644 --- a/website/docs/cdktf/python/r/iot_topic_rule.html.markdown +++ b/website/docs/cdktf/python/r/iot_topic_rule.html.markdown @@ -93,6 +93,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) The name of the rule. * `description` - (Optional) The description of the rule. * `enabled` - (Required) Specifies whether the rule is enabled. @@ -278,4 +279,4 @@ Using `terraform import`, import IoT Topic Rules using the `name`. For example: % terraform import aws_iot_topic_rule.rule ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/iot_topic_rule_destination.html.markdown b/website/docs/cdktf/python/r/iot_topic_rule_destination.html.markdown index 3d728ec019c1..cbefdf73a8b1 100644 --- a/website/docs/cdktf/python/r/iot_topic_rule_destination.html.markdown +++ b/website/docs/cdktf/python/r/iot_topic_rule_destination.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `enabled` - (Optional) Whether or not to enable the destination. Default: `true`. * `vpc_configuration` - (Required) Configuration of the virtual private cloud (VPC) connection. For more info, see the [AWS documentation](https://docs.aws.amazon.com/iot/latest/developerguide/vpc-rule-action.html). @@ -79,4 +80,4 @@ Using `terraform import`, import IoT topic rule destinations using the `arn`. Fo % terraform import aws_iot_topic_rule_destination.example arn:aws:iot:us-west-2:123456789012:ruledestination/vpc/2ce781c8-68a6-4c52-9c62-63fe489ecc60 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ivs_channel.html.markdown b/website/docs/cdktf/python/r/ivs_channel.html.markdown index 110f99be7b0b..503f8cff3fcf 100644 --- a/website/docs/cdktf/python/r/ivs_channel.html.markdown +++ b/website/docs/cdktf/python/r/ivs_channel.html.markdown @@ -37,6 +37,7 @@ class MyConvertedCode(TerraformStack): The following arguments are optional: +* `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). * `authorized` - (Optional) If `true`, channel is private (enabled for playback authorization). * `latency_mode` - (Optional) Channel latency mode. Valid values: `NORMAL`, `LOW`. * `name` - (Optional) Channel name. @@ -86,4 +87,4 @@ Using `terraform import`, import IVS (Interactive Video) Channel using the ARN. % terraform import aws_ivs_channel.example arn:aws:ivs:us-west-2:326937407773:channel/0Y1lcs4U7jk5 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ivs_playback_key_pair.html.markdown b/website/docs/cdktf/python/r/ivs_playback_key_pair.html.markdown index 813f4c509e4f..972949593343 100644 --- a/website/docs/cdktf/python/r/ivs_playback_key_pair.html.markdown +++ b/website/docs/cdktf/python/r/ivs_playback_key_pair.html.markdown @@ -41,6 +41,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `name` - (Optional) Playback Key Pair name. * `tags` - (Optional) A 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. @@ -84,4 +85,4 @@ Using `terraform import`, import IVS (Interactive Video) Playback Key Pair using % terraform import aws_ivs_playback_key_pair.example arn:aws:ivs:us-west-2:326937407773:playback-key/KDJRJNQhiQzA ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ivs_recording_configuration.html.markdown b/website/docs/cdktf/python/r/ivs_recording_configuration.html.markdown index e8e773315e26..62783e55ff91 100644 --- a/website/docs/cdktf/python/r/ivs_recording_configuration.html.markdown +++ b/website/docs/cdktf/python/r/ivs_recording_configuration.html.markdown @@ -48,6 +48,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `name` - (Optional) Recording Configuration name. * `recording_reconnect_window_seconds` - (Optional) If a broadcast disconnects and then reconnects within the specified interval, the multiple streams will be considered a single broadcast and merged together. * `tags` - (Optional) A 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. @@ -95,4 +96,4 @@ Using `terraform import`, import IVS (Interactive Video) Recording Configuration % terraform import aws_ivs_recording_configuration.example arn:aws:ivs:us-west-2:326937407773:recording-configuration/KAk1sHBl2L47 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ivschat_logging_configuration.html.markdown b/website/docs/cdktf/python/r/ivschat_logging_configuration.html.markdown index 7227a8955145..d754b09df7b4 100644 --- a/website/docs/cdktf/python/r/ivschat_logging_configuration.html.markdown +++ b/website/docs/cdktf/python/r/ivschat_logging_configuration.html.markdown @@ -159,6 +159,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `name` - (Optional) Logging Configuration name. * `tags` - (Optional) A 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. @@ -204,4 +205,4 @@ Using `terraform import`, import IVS (Interactive Video) Chat Logging Configurat % terraform import aws_ivschat_logging_configuration.example arn:aws:ivschat:us-west-2:326937407773:logging-configuration/MMUQc8wcqZmC ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ivschat_room.html.markdown b/website/docs/cdktf/python/r/ivschat_room.html.markdown index 6868e72efe39..93ef4af6e5bb 100644 --- a/website/docs/cdktf/python/r/ivschat_room.html.markdown +++ b/website/docs/cdktf/python/r/ivschat_room.html.markdown @@ -82,6 +82,7 @@ class MyConvertedCode(TerraformStack): The following arguments are optional: +* `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). * `logging_configuration_identifiers` - (Optional) List of Logging Configuration ARNs to attach to the room. * `maximum_message_length` - (Optional) Maximum number of characters in a single @@ -139,4 +140,4 @@ Using `terraform import`, import IVS (Interactive Video) Chat Room using the ARN % terraform import aws_ivschat_room.example arn:aws:ivschat:us-west-2:326937407773:room/GoXEXyB4VwHb ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/kendra_data_source.html.markdown b/website/docs/cdktf/python/r/kendra_data_source.html.markdown index 0f2f57f9dba5..6d836be64d8a 100644 --- a/website/docs/cdktf/python/r/kendra_data_source.html.markdown +++ b/website/docs/cdktf/python/r/kendra_data_source.html.markdown @@ -490,6 +490,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `configuration` - (Optional) A block with the configuration information to connect to your Data Source repository. You can't specify the `configuration` block when the `type` parameter is set to `CUSTOM`. [Detailed below](#configuration-block). * `custom_document_enrichment_configuration` - (Optional) A block with the configuration information for altering document metadata and content during the document ingestion process. For more information on how to create, modify and delete document metadata, or make other content alterations when you ingest documents into Amazon Kendra, see [Customizing document metadata during the ingestion process](https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html). [Detailed below](#custom_document_enrichment_configuration-block). * `description` - (Optional) A description for the Data Source connector. @@ -537,7 +538,7 @@ The `documents_metadata_configuration` configuration block supports the followin The `web_crawler_configuration` configuration block supports the following arguments: * `authentication_configuration` - (Optional) A block with the configuration information required to connect to websites using authentication. You can connect to websites using basic authentication of user name and password. You use a secret in AWS Secrets Manager to store your authentication credentials. You must provide the website host name and port number. For example, the host name of `https://a.example.com/page1.html` is `"a.example.com"` and the port is `443`, the standard port for HTTPS. [Detailed below](#authentication_configuration-block). -* `crawl_depth` - (Optional) Specifies the number of levels in a website that you want to crawl. The first level begins from the website seed or starting point URL. For example, if a website has 3 levels – index level (i.e. seed in this example), sections level, and subsections level – and you are only interested in crawling information up to the sections level (i.e. levels 0-1), you can set your depth to 1. The default crawl depth is set to `2`. Minimum value of `0`. Maximum value of `10`. +* `crawl_depth` - (Optional) Specifies the number of levels in a website that you want to crawl. The first level begins from the website seed or starting point URL. For example, if a website has 3 levels - index level (i.e. seed in this example), sections level, and subsections level - and you are only interested in crawling information up to the sections level (i.e. levels 0-1), you can set your depth to 1. The default crawl depth is set to `2`. Minimum value of `0`. Maximum value of `10`. * `max_content_size_per_page_in_mega_bytes` - (Optional) The maximum size (in MB) of a webpage or attachment to crawl. Files larger than this size (in MB) are skipped/not crawled. The default maximum size of a webpage or attachment is set to `50` MB. Minimum value of `1.0e-06`. Maximum value of `50`. * `max_links_per_page` - (Optional) The maximum number of URLs on a webpage to include when crawling a website. This number is per webpage. As a website’s webpages are crawled, any URLs the webpages link to are also crawled. URLs on a webpage are crawled in order of appearance. The default maximum links per page is `100`. Minimum value of `1`. Maximum value of `1000`. * `max_urls_per_minute_crawl_rate` - (Optional) The maximum number of URLs crawled per website host per minute. The default maximum number of URLs crawled per website host per minute is `300`. Minimum value of `1`. Maximum value of `300`. @@ -587,9 +588,9 @@ The `seed_url_configuration` configuration block supports the following argument * `seed_urls` - (Required) The list of seed or starting point URLs of the websites you want to crawl. The list can include a maximum of `100` seed URLs. Array Members: Minimum number of `0` items. Maximum number of `100` items. Length Constraints: Minimum length of `1`. Maximum length of `2048`. * `web_crawler_mode` - (Optional) The default mode is set to `HOST_ONLY`. You can choose one of the following modes: - * `HOST_ONLY` – crawl only the website host names. For example, if the seed URL is `"abc.example.com"`, then only URLs with host name `"abc.example.com"` are crawled. - * `SUBDOMAINS` – crawl the website host names with subdomains. For example, if the seed URL is `"abc.example.com"`, then `"a.abc.example.com"` and `"b.abc.example.com"` are also crawled. - * `EVERYTHING` – crawl the website host names with subdomains and other domains that the webpages link to. + * `HOST_ONLY` - crawl only the website host names. For example, if the seed URL is `"abc.example.com"`, then only URLs with host name `"abc.example.com"` are crawled. + * `SUBDOMAINS` - crawl the website host names with subdomains. For example, if the seed URL is `"abc.example.com"`, then `"a.abc.example.com"` and `"b.abc.example.com"` are also crawled. + * `EVERYTHING` - crawl the website host names with subdomains and other domains that the webpages link to. ### site_maps_configuration Block @@ -710,4 +711,4 @@ Using `terraform import`, import Kendra Data Source using the unique identifiers % terraform import aws_kendra_data_source.example 1045d08d-66ef-4882-b3ed-dfb7df183e90/b34dfdf7-1f2b-4704-9581-79e00296845f ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/kendra_experience.html.markdown b/website/docs/cdktf/python/r/kendra_experience.html.markdown index 857275051704..0013d041dcbb 100644 --- a/website/docs/cdktf/python/r/kendra_experience.html.markdown +++ b/website/docs/cdktf/python/r/kendra_experience.html.markdown @@ -55,6 +55,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `description` - (Optional, Forces new resource if removed) A description for your Amazon Kendra experience. * `configuration` - (Optional) Configuration information for your Amazon Kendra experience. Terraform will only perform drift detection of its value when present in a configuration. [Detailed below](#configuration). @@ -128,4 +129,4 @@ Using `terraform import`, import Kendra Experience using the unique identifiers % terraform import aws_kendra_experience.example 1045d08d-66ef-4882-b3ed-dfb7df183e90/b34dfdf7-1f2b-4704-9581-79e00296845f ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/kendra_faq.html.markdown b/website/docs/cdktf/python/r/kendra_faq.html.markdown index e482064fa4b5..e35d0957a4f1 100644 --- a/website/docs/cdktf/python/r/kendra_faq.html.markdown +++ b/website/docs/cdktf/python/r/kendra_faq.html.markdown @@ -110,6 +110,7 @@ The `s3_path` configuration block supports the following arguments: The following arguments are optional: +* `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). * `description` - (Optional, Forces new resource) The description for a FAQ. * `file_format` - (Optional, Forces new resource) The file format used by the input files for the FAQ. Valid Values are `CSV`, `CSV_WITH_HEADER`, `JSON`. * `language_code` - (Optional, Forces new resource) The code for a language. This shows a supported language for the FAQ document. English is supported by default. For more information on supported languages, including their codes, see [Adding documents in languages other than English](https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html). @@ -160,4 +161,4 @@ Using `terraform import`, import `aws_kendra_faq` using the unique identifiers o % terraform import aws_kendra_faq.example faq-123456780/idx-8012925589 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/kendra_index.html.markdown b/website/docs/cdktf/python/r/kendra_index.html.markdown index ba64cb21f670..75d2ae5e906f 100644 --- a/website/docs/cdktf/python/r/kendra_index.html.markdown +++ b/website/docs/cdktf/python/r/kendra_index.html.markdown @@ -613,6 +613,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `capacity_units` - (Optional) A block that sets the number of additional document storage and query capacity units that should be used by the index. [Detailed below](#capacity_units). * `description` - (Optional) The description of the Index. * `document_metadata_configuration_updates` - (Optional) One or more blocks that specify the configuration settings for any metadata applied to the documents in the index. Minimum number of 0 items. Maximum number of 500 items. If specified, you must define all elements, including those that are provided by default. These index fields are documented at [Amazon Kendra Index documentation](https://docs.aws.amazon.com/kendra/latest/dg/hiw-index.html). For an example resource that defines these default index fields, refer to the [default example above](#specifying-the-predefined-elements). For an example resource that appends additional index fields, refer to the [append example above](#appending-additional-elements). All arguments for each block must be specified. Note that blocks cannot be removed since index fields cannot be deleted. This argument is [detailed below](#document_metadata_configuration_updates). @@ -765,4 +766,4 @@ Using `terraform import`, import Amazon Kendra Indexes using its `id`. For examp % terraform import aws_kendra_index.example 12345678-1234-5678-9123-123456789123 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/kendra_query_suggestions_block_list.html.markdown b/website/docs/cdktf/python/r/kendra_query_suggestions_block_list.html.markdown index 2aae76aee6ab..7496323b2da8 100644 --- a/website/docs/cdktf/python/r/kendra_query_suggestions_block_list.html.markdown +++ b/website/docs/cdktf/python/r/kendra_query_suggestions_block_list.html.markdown @@ -58,6 +58,7 @@ The `source_s3_path` configuration block supports the following arguments: The following arguments are optional: +* `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). * `description` - (Optional) Description for a block list. * `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), tags with matching keys will overwrite those defined at the provider-level. @@ -102,4 +103,4 @@ Using `terraform import`, import the `aws_kendra_query_suggestions_block_list` r % terraform import aws_kendra_query_suggestions_block_list.example blocklist-123456780/idx-8012925589 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/kendra_thesaurus.html.markdown b/website/docs/cdktf/python/r/kendra_thesaurus.html.markdown index 238ed3df7523..2a227ad87692 100644 --- a/website/docs/cdktf/python/r/kendra_thesaurus.html.markdown +++ b/website/docs/cdktf/python/r/kendra_thesaurus.html.markdown @@ -56,6 +56,7 @@ The `source_s3_path` configuration block supports the following arguments: The following arguments are optional: +* `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). * `description` - (Optional) The description for a thesaurus. * `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. @@ -101,4 +102,4 @@ Using `terraform import`, import `aws_kendra_thesaurus` using the unique identif % terraform import aws_kendra_thesaurus.example thesaurus-123456780/idx-8012925589 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/key_pair.html.markdown b/website/docs/cdktf/python/r/key_pair.html.markdown index 9bf43a805e9a..03b518abcd56 100644 --- a/website/docs/cdktf/python/r/key_pair.html.markdown +++ b/website/docs/cdktf/python/r/key_pair.html.markdown @@ -44,6 +44,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `key_name` - (Optional) The name for the key pair. If neither `key_name` nor `key_name_prefix` is provided, Terraform will create a unique key name using the prefix `terraform-`. * `key_name_prefix` - (Optional) Creates a unique name beginning with the specified prefix. Conflicts with `key_name`. If neither `key_name` nor `key_name_prefix` is provided, Terraform will create a unique key name using the prefix `terraform-`. * `public_key` - (Required) The public key material. @@ -88,4 +89,4 @@ Using `terraform import`, import Key Pairs using the `key_name`. For example: ~> **NOTE:** The AWS API does not include the public key in the response, so `terraform apply` will attempt to replace the key pair. There is currently no supported workaround for this limitation. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/keyspaces_keyspace.html.markdown b/website/docs/cdktf/python/r/keyspaces_keyspace.html.markdown index b12d2ddc4166..e67428116aef 100644 --- a/website/docs/cdktf/python/r/keyspaces_keyspace.html.markdown +++ b/website/docs/cdktf/python/r/keyspaces_keyspace.html.markdown @@ -37,6 +37,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required, Forces new resource) The name of the keyspace to be created. * `replication_specification` - (Optional) The replication specification of the keyspace. * `region_list` - (Optional) Replication regions. If `replication_strategy` is `MULTI_REGION`, `region_list` requires the current Region and at least one additional AWS Region where the keyspace is going to be replicated in. @@ -83,4 +84,4 @@ Using `terraform import`, import a keyspace using the `name`. For example: % terraform import aws_keyspaces_keyspace.example my_keyspace ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/keyspaces_table.html.markdown b/website/docs/cdktf/python/r/keyspaces_table.html.markdown index d56a4680c816..e53db91bf22f 100644 --- a/website/docs/cdktf/python/r/keyspaces_table.html.markdown +++ b/website/docs/cdktf/python/r/keyspaces_table.html.markdown @@ -54,6 +54,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `capacity_specification` - (Optional) Specifies the read/write throughput capacity mode for the table. * `client_side_timestamps` - (Optional) Enables client-side timestamps for the table. By default, the setting is disabled. * `comment` - (Optional) A description of the table. @@ -156,4 +157,4 @@ Using `terraform import`, import a table using the `keyspace_name` and `table_na % terraform import aws_keyspaces_table.example my_keyspace/my_table ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/kinesis_analytics_application.html.markdown b/website/docs/cdktf/python/r/kinesis_analytics_application.html.markdown index 9651856c6330..6c30de264571 100644 --- a/website/docs/cdktf/python/r/kinesis_analytics_application.html.markdown +++ b/website/docs/cdktf/python/r/kinesis_analytics_application.html.markdown @@ -15,6 +15,8 @@ allows processing and analyzing streaming data using standard SQL. For more details, see the [Amazon Kinesis Analytics Documentation][1]. +!> **WARNING:** _This resource is deprecated and will be removed in a future version._ [Effective January 27, 2026](https://aws.amazon.com/blogs/big-data/migrate-from-amazon-kinesis-data-analytics-for-sql-to-amazon-managed-service-for-apache-flink-and-amazon-managed-service-for-apache-flink-studio/), AWS will [no longer support](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/discontinuation.html) Amazon Kinesis Data Analytics for SQL. Use the `aws_kinesisanalyticsv2_application` resource instead to manage Amazon Kinesis Data Analytics for Apache Flink applications. AWS provides guidance for migrating from [Amazon Kinesis Data Analytics for SQL Applications to Amazon Managed Service for Apache Flink Studio](https://aws.amazon.com/blogs/big-data/migrate-from-amazon-kinesis-data-analytics-for-sql-applications-to-amazon-managed-service-for-apache-flink-studio/) including [examples](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/migrating-to-kda-studio-overview.html). + -> **Note:** To manage Amazon Kinesis Data Analytics for Apache Flink applications, use the [`aws_kinesisanalyticsv2_application`](/docs/providers/aws/r/kinesisanalyticsv2_application.html) resource. ## Example Usage @@ -164,6 +166,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) Name of the Kinesis Analytics Application. * `code` - (Optional) SQL Code to transform input data, and generate output. * `description` - (Optional) Description of the application. @@ -397,4 +400,4 @@ Using `terraform import`, import Kinesis Analytics Application using ARN. For ex % terraform import aws_kinesis_analytics_application.example arn:aws:kinesisanalytics:us-west-2:1234567890:application/example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/kinesis_firehose_delivery_stream.html.markdown b/website/docs/cdktf/python/r/kinesis_firehose_delivery_stream.html.markdown index 96c76b84de77..eda29fafc239 100644 --- a/website/docs/cdktf/python/r/kinesis_firehose_delivery_stream.html.markdown +++ b/website/docs/cdktf/python/r/kinesis_firehose_delivery_stream.html.markdown @@ -600,7 +600,7 @@ class MyConvertedCode(TerraformStack): iceberg_configuration=KinesisFirehoseDeliveryStreamIcebergConfiguration( buffering_interval=400, buffering_size=10, - catalog_arn="arn:${" + data_aws_partition_current.partition + "}:glue:${" + data_aws_region_current.name + "}:${" + current.account_id + "}:catalog", + catalog_arn="arn:${" + data_aws_partition_current.partition + "}:glue:${" + data_aws_region_current.region + "}:${" + current.account_id + "}:catalog", destination_table_configuration=[KinesisFirehoseDeliveryStreamIcebergConfigurationDestinationTableConfiguration( database_name=test.name, table_name=Token.as_string(aws_glue_catalog_table_test.name) @@ -751,14 +751,13 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) A name to identify the stream. This is unique to the AWS account and region the Stream is created in. When using for WAF logging, name must be prefixed with `aws-waf-logs-`. See [AWS Documentation](https://docs.aws.amazon.com/waf/latest/developerguide/waf-policies.html#waf-policies-logging-config) for more details. * `tags` - (Optional) A 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. * `kinesis_source_configuration` - (Optional) The stream and role Amazon Resource Names (ARNs) for a Kinesis data stream used as the source for a delivery stream. See [`kinesis_source_configuration` block](#kinesis_source_configuration-block) below for details. * `msk_source_configuration` - (Optional) The configuration for the Amazon MSK cluster to be used as the source for a delivery stream. See [`msk_source_configuration` block](#msk_source_configuration-block) below for details. * `server_side_encryption` - (Optional) Encrypt at rest options. See [`server_side_encryption` block](#server_side_encryption-block) below for details. - - **NOTE:** Server-side encryption should not be enabled when a kinesis stream is configured as the source of the firehose delivery stream. -* `destination` – (Required) This is the destination to where the data is delivered. The only options are `s3` (Deprecated, use `extended_s3` instead), `extended_s3`, `redshift`, `elasticsearch`, `splunk`, `http_endpoint`, `opensearch`, `opensearchserverless` and `snowflake`. +* `destination` - (Required) This is the destination to where the data is delivered. The only options are `s3` (Deprecated, use `extended_s3` instead), `extended_s3`, `redshift`, `elasticsearch`, `splunk`, `http_endpoint`, `opensearch`, `opensearchserverless` and `snowflake`. * `elasticsearch_configuration` - (Optional) Configuration options when `destination` is `elasticsearch`. See [`elasticsearch_configuration` block](#elasticsearch_configuration-block) below for details. * `extended_s3_configuration` - (Optional, only Required when `destination` is `extended_s3`) Enhanced configuration options for the s3 destination. See [`extended_s3_configuration` block](#extended_s3_configuration-block) below for details. * `http_endpoint_configuration` - (Optional) Configuration options when `destination` is `http_endpoint`. Requires the user to also specify an `s3_configuration` block. See [`http_endpoint_configuration` block](#http_endpoint_configuration-block) below for details. @@ -769,6 +768,8 @@ This resource supports the following arguments: * `snowflake_configuration` - (Optional) Configuration options when `destination` is `snowflake`. See [`snowflake_configuration` block](#snowflake_configuration-block) below for details. * `splunk_configuration` - (Optional) Configuration options when `destination` is `splunk`. See [`splunk_configuration` block](#splunk_configuration-block) below for details. +**NOTE:** Server-side encryption should not be enabled when a kinesis stream is configured as the source of the firehose delivery stream. + ### `kinesis_source_configuration` block The `kinesis_source_configuration` configuration block supports the following arguments: @@ -1243,4 +1244,4 @@ Using `terraform import`, import Kinesis Firehose Delivery streams using the str Note: Import does not work for stream destination `s3`. Consider using `extended_s3` since `s3` destination is deprecated. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/kinesis_resource_policy.html.markdown b/website/docs/cdktf/python/r/kinesis_resource_policy.html.markdown index 0124300f3f95..9ca33e78aa14 100644 --- a/website/docs/cdktf/python/r/kinesis_resource_policy.html.markdown +++ b/website/docs/cdktf/python/r/kinesis_resource_policy.html.markdown @@ -37,6 +37,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `policy` - (Required) The policy document. * `resource_arn` - (Required) The Amazon Resource Name (ARN) of the data stream or consumer. @@ -69,4 +70,4 @@ Using `terraform import`, import Kinesis resource policies using the `resource_a % terraform import aws_kinesis_resource_policy.example arn:aws:kinesis:us-west-2:123456789012:stream/example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/kinesis_stream.html.markdown b/website/docs/cdktf/python/r/kinesis_stream.html.markdown index bf09b95179ca..df69dd99206c 100644 --- a/website/docs/cdktf/python/r/kinesis_stream.html.markdown +++ b/website/docs/cdktf/python/r/kinesis_stream.html.markdown @@ -47,8 +47,9 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) A name to identify the stream. This is unique to the AWS account and region the Stream is created in. -* `shard_count` – (Optional) The number of shards that the stream will use. If the `stream_mode` is `PROVISIONED`, this field is required. +* `shard_count` - (Optional) The number of shards that the stream will use. If the `stream_mode` is `PROVISIONED`, this field is required. Amazon has guidelines for specifying the Stream size that should be referenced when creating a Kinesis stream. See [Amazon Kinesis Streams][2] for more. * `retention_period` - (Optional) Length of time data records are accessible after they are added to the stream. The maximum value of a stream's retention period is 8760 hours. Minimum value is 24. Default is 24. * `shard_level_metrics` - (Optional) A list of shard-level CloudWatch metrics which can be enabled for the stream. See [Monitoring with CloudWatch][3] for more. Note that the value ALL should not be used; instead you should provide an explicit list of metrics you wish to enable. @@ -109,4 +110,4 @@ Using `terraform import`, import Kinesis Streams using the `name`. For example: [2]: https://docs.aws.amazon.com/kinesis/latest/dev/amazon-kinesis-streams.html [3]: https://docs.aws.amazon.com/streams/latest/dev/monitoring-with-cloudwatch.html - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/kinesis_stream_consumer.html.markdown b/website/docs/cdktf/python/r/kinesis_stream_consumer.html.markdown index 7f2d5fa74c01..38649b038a13 100644 --- a/website/docs/cdktf/python/r/kinesis_stream_consumer.html.markdown +++ b/website/docs/cdktf/python/r/kinesis_stream_consumer.html.markdown @@ -47,8 +47,9 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required, Forces new resource) Name of the stream consumer. -* `stream_arn` – (Required, Forces new resource) Amazon Resource Name (ARN) of the data stream the consumer is registered with. +* `stream_arn` - (Required, Forces new resource) Amazon Resource Name (ARN) of the data stream the consumer is registered with. ## Attribute Reference @@ -85,4 +86,4 @@ Using `terraform import`, import Kinesis Stream Consumers using the Amazon Resou [1]: https://docs.aws.amazon.com/streams/latest/dev/amazon-kinesis-consumers.html - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/kinesis_video_stream.html.markdown b/website/docs/cdktf/python/r/kinesis_video_stream.html.markdown index e8769c584beb..d81742b21541 100644 --- a/website/docs/cdktf/python/r/kinesis_video_stream.html.markdown +++ b/website/docs/cdktf/python/r/kinesis_video_stream.html.markdown @@ -43,9 +43,10 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) A name to identify the stream. This is unique to the AWS account and region the Stream is created in. -* `data_retention_in_hours` – (Optional) The number of hours that you want to retain the data in the stream. Kinesis Video Streams retains the data in a data store that is associated with the stream. The default value is `0`, indicating that the stream does not persist data. +* `data_retention_in_hours` - (Optional) The number of hours that you want to retain the data in the stream. Kinesis Video Streams retains the data in a data store that is associated with the stream. The default value is `0`, indicating that the stream does not persist data. * `device_name` - (Optional) The name of the device that is writing to the stream. **In the current implementation, Kinesis Video Streams does not use this name.** * `kms_key_id` - (Optional) The ID of the AWS Key Management Service (AWS KMS) key that you want Kinesis Video Streams to use to encrypt stream data. If no key ID is specified, the default, Kinesis Video-managed key (`aws/kinesisvideo`) is used. * `media_type` - (Optional) The media type of the stream. Consumers of the stream can use this information when processing the stream. For more information about media types, see [Media Types][2]. If you choose to specify the MediaType, see [Naming Requirements][3] for guidelines. @@ -98,4 +99,4 @@ Using `terraform import`, import Kinesis Streams using the `arn`. For example: [2]: http://www.iana.org/assignments/media-types/media-types.xhtml [3]: https://tools.ietf.org/html/rfc6838#section-4.2 - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/kinesisanalyticsv2_application.html.markdown b/website/docs/cdktf/python/r/kinesisanalyticsv2_application.html.markdown index f8f1b5bd8e83..1ed1105e9d2b 100644 --- a/website/docs/cdktf/python/r/kinesisanalyticsv2_application.html.markdown +++ b/website/docs/cdktf/python/r/kinesisanalyticsv2_application.html.markdown @@ -276,6 +276,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) The name of the application. * `runtime_environment` - (Required) The runtime environment for the application. Valid values: `SQL-1_0`, `FLINK-1_6`, `FLINK-1_8`, `FLINK-1_11`, `FLINK-1_13`, `FLINK-1_15`, `FLINK-1_18`, `FLINK-1_19`. * `service_execution_role` - (Required) The ARN of the [IAM role](/docs/providers/aws/r/iam_role.html) used by the application to access Kinesis data streams, Kinesis Data Firehose delivery streams, Amazon S3 objects, and other external resources. @@ -538,4 +539,4 @@ Using `terraform import`, import `aws_kinesisanalyticsv2_application` using the % terraform import aws_kinesisanalyticsv2_application.example arn:aws:kinesisanalytics:us-west-2:123456789012:application/example-sql-application ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/kinesisanalyticsv2_application_snapshot.html.markdown b/website/docs/cdktf/python/r/kinesisanalyticsv2_application_snapshot.html.markdown index e773df0d84d4..32b52daabf83 100644 --- a/website/docs/cdktf/python/r/kinesisanalyticsv2_application_snapshot.html.markdown +++ b/website/docs/cdktf/python/r/kinesisanalyticsv2_application_snapshot.html.markdown @@ -37,6 +37,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `application_name` - (Required) The name of an existing [Kinesis Analytics v2 Application](/docs/providers/aws/r/kinesisanalyticsv2_application.html). Note that the application must be running for a snapshot to be created. * `snapshot_name` - (Required) The name of the application snapshot. @@ -80,4 +81,4 @@ Using `terraform import`, import `aws_kinesisanalyticsv2_application` using `app % terraform import aws_kinesisanalyticsv2_application_snapshot.example example-application/example-snapshot ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/kms_alias.html.markdown b/website/docs/cdktf/python/r/kms_alias.html.markdown index 72c7f863e8d3..6a75c5a9e5a7 100644 --- a/website/docs/cdktf/python/r/kms_alias.html.markdown +++ b/website/docs/cdktf/python/r/kms_alias.html.markdown @@ -42,6 +42,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Optional) The display name of the alias. The name must start with the word "alias" followed by a forward slash (alias/) * `name_prefix` - (Optional) Creates an unique alias beginning with the specified prefix. The name must start with the word "alias" followed by a forward slash (alias/). Conflicts with `name`. @@ -56,6 +57,32 @@ This resource exports the following attributes in addition to the arguments abov ## Import +In Terraform v1.12.0 and later, the [`import` block](https://developer.hashicorp.com/terraform/language/import) can be used with the `identity` attribute. For example: + +```terraform +import { + to = aws_kms_alias.example + identity = { + name = "alias/my-key-alias" + } +} + +resource "aws_kms_alias" "example" { + ### Configuration omitted for brevity ### +} +``` + +### Identity Schema + +#### Required + +* `name` - (String) Name of the KMS key alias. + +#### Optional + +- `account_id` (String) AWS Account where this resource is managed. +- `region` (String) Region where this resource is managed. + In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import KMS aliases using the `name`. For example: ```python @@ -79,4 +106,4 @@ Using `terraform import`, import KMS aliases using the `name`. For example: % terraform import aws_kms_alias.a alias/my-key-alias ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/kms_ciphertext.html.markdown b/website/docs/cdktf/python/r/kms_ciphertext.html.markdown index 627cff6d6029..aa9ba0522286 100644 --- a/website/docs/cdktf/python/r/kms_ciphertext.html.markdown +++ b/website/docs/cdktf/python/r/kms_ciphertext.html.markdown @@ -47,6 +47,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `plaintext` - (Required) Data to be encrypted. Note that this may show up in logs, and it will be stored in the state file. * `key_id` - (Required) Globally unique key ID for the customer master key. * `context` - (Optional) An optional mapping that makes up the encryption context. @@ -57,4 +58,4 @@ This resource exports the following attributes in addition to the arguments abov * `ciphertext_blob` - Base64 encoded ciphertext - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/kms_custom_key_store.html.markdown b/website/docs/cdktf/python/r/kms_custom_key_store.html.markdown index 501049d7a85a..a0f90e2dc224 100644 --- a/website/docs/cdktf/python/r/kms_custom_key_store.html.markdown +++ b/website/docs/cdktf/python/r/kms_custom_key_store.html.markdown @@ -99,6 +99,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `custom_key_store_type` - (Optional, ForceNew) Specifies the type of key store to create. Valid values are `AWS_CLOUDHSM` and `EXTERNAL_KEY_STORE`. If omitted, AWS will default the value to `AWS_CLOUDHSM`. If `custom_key_store_type` is `AWS_CLOUDHSM`, the following optional arguments must be set: @@ -159,4 +160,4 @@ Using `terraform import`, import KMS (Key Management) Custom Key Store using the % terraform import aws_kms_custom_key_store.example cks-5ebd4ef395a96288e ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/kms_external_key.html.markdown b/website/docs/cdktf/python/r/kms_external_key.html.markdown index edbe83a95236..f524a97fd055 100644 --- a/website/docs/cdktf/python/r/kms_external_key.html.markdown +++ b/website/docs/cdktf/python/r/kms_external_key.html.markdown @@ -43,8 +43,11 @@ This resource supports the following arguments: * `description` - (Optional) Description of the key. * `enabled` - (Optional) Specifies whether the key is enabled. Keys pending import can only be `false`. Imported keys default to `true` unless expired. * `key_material_base64` - (Optional) Base64 encoded 256-bit symmetric encryption key material to import. The CMK is permanently associated with this key material. The same key material can be reimported, but you cannot import different key material. +* `key_spec` - (Optional) Specifies whether the key contains a symmetric key or an asymmetric key pair and the encryption algorithms or signing algorithms that the key supports. Valid values: `SYMMETRIC_DEFAULT`, `RSA_2048`, `RSA_3072`, `RSA_4096`, `HMAC_224`, `HMAC_256`, `HMAC_384`, `HMAC_512`, `ECC_NIST_P256`, `ECC_NIST_P384`, `ECC_NIST_P521`, `ECC_SECG_P256K1`, `ML_DSA_44`, `ML_DSA_65`, `ML_DSA_87`, or `SM2` (China Regions only). Defaults to `SYMMETRIC_DEFAULT`. For help with choosing a key spec, see the [AWS KMS Developer Guide](https://docs.aws.amazon.com/kms/latest/developerguide/symm-asymm-choose.html). +* `key_usage` - (Optional) Specifies the intended use of the key. Valid values: `ENCRYPT_DECRYPT`, `SIGN_VERIFY`, or `GENERATE_VERIFY_MAC`. Defaults to `ENCRYPT_DECRYPT`. * `multi_region` - (Optional) Indicates whether the KMS key is a multi-Region (`true`) or regional (`false`) key. Defaults to `false`. * `policy` - (Optional) A key policy JSON document. If you do not provide a key policy, AWS KMS attaches a default key policy to the CMK. +* `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). * `tags` - (Optional) A key-value map of tags to assign to the key. 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. * `valid_to` - (Optional) Time at which the imported key material expires. When the key material expires, AWS KMS deletes the key material and the CMK becomes unusable. If not specified, key material does not expire. Valid values: [RFC3339 time string](https://tools.ietf.org/html/rfc3339#section-5.8) (`YYYY-MM-DDTHH:MM:SSZ`) @@ -56,7 +59,6 @@ This resource exports the following attributes in addition to the arguments abov * `expiration_model` - Whether the key material expires. Empty when pending key material import, otherwise `KEY_MATERIAL_EXPIRES` or `KEY_MATERIAL_DOES_NOT_EXPIRE`. * `id` - The unique identifier for the key. * `key_state` - The state of the CMK. -* `key_usage` - The cryptographic operations for which you can use the CMK. * `tags_all` - A map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). ## Import @@ -84,4 +86,4 @@ Using `terraform import`, import KMS External Keys using the `id`. For example: % terraform import aws_kms_external_key.a arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/kms_grant.html.markdown b/website/docs/cdktf/python/r/kms_grant.html.markdown index 8120069b4a2d..023c19a5031d 100644 --- a/website/docs/cdktf/python/r/kms_grant.html.markdown +++ b/website/docs/cdktf/python/r/kms_grant.html.markdown @@ -71,6 +71,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Optional, Forces new resources) A friendly name for identifying the grant. * `key_id` - (Required, Forces new resources) The unique identifier for the customer master key (CMK) that the grant applies to. Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS account, you must use the key ARN. * `grantee_principal` - (Required, Forces new resources) The principal that is given permission to perform the operations that the grant permits in ARN format. Note that due to eventual consistency issues around IAM principals, terraform's state may not always be refreshed to reflect what is true in AWS. @@ -118,4 +119,4 @@ Using `terraform import`, import KMS Grants using the Key ID and Grant ID separa % terraform import aws_kms_grant.test 1234abcd-12ab-34cd-56ef-1234567890ab:abcde1237f76e4ba7987489ac329fbfba6ad343d6f7075dbd1ef191f0120514 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/kms_key.html.markdown b/website/docs/cdktf/python/r/kms_key.html.markdown index 1b7e5291975c..e0ff2bf232da 100644 --- a/website/docs/cdktf/python/r/kms_key.html.markdown +++ b/website/docs/cdktf/python/r/kms_key.html.markdown @@ -291,12 +291,13 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `description` - (Optional) The description of the key as viewed in AWS console. * `key_usage` - (Optional) Specifies the intended use of the key. Valid values: `ENCRYPT_DECRYPT`, `SIGN_VERIFY`, or `GENERATE_VERIFY_MAC`. Defaults to `ENCRYPT_DECRYPT`. * `custom_key_store_id` - (Optional) ID of the KMS [Custom Key Store](https://docs.aws.amazon.com/kms/latest/developerguide/create-cmk-keystore.html) where the key will be stored instead of KMS (eg CloudHSM). * `customer_master_key_spec` - (Optional) Specifies whether the key contains a symmetric key or an asymmetric key pair and the encryption algorithms or signing algorithms that the key supports. -Valid values: `SYMMETRIC_DEFAULT`, `RSA_2048`, `RSA_3072`, `RSA_4096`, `HMAC_256`, `ECC_NIST_P256`, `ECC_NIST_P384`, `ECC_NIST_P521`, or `ECC_SECG_P256K1`. Defaults to `SYMMETRIC_DEFAULT`. For help with choosing a key spec, see the [AWS KMS Developer Guide](https://docs.aws.amazon.com/kms/latest/developerguide/symm-asymm-choose.html). +Valid values: `SYMMETRIC_DEFAULT`, `RSA_2048`, `RSA_3072`, `RSA_4096`, `HMAC_224`, `HMAC_256`, `HMAC_384`, `HMAC_512`, `ECC_NIST_P256`, `ECC_NIST_P384`, `ECC_NIST_P521`, `ECC_SECG_P256K1`, `ML_DSA_44`, `ML_DSA_65`, `ML_DSA_87`, or `SM2` (China Regions only). Defaults to `SYMMETRIC_DEFAULT`. For help with choosing a key spec, see the [AWS KMS Developer Guide](https://docs.aws.amazon.com/kms/latest/developerguide/symm-asymm-choose.html). * `policy` - (Optional) A valid policy JSON document. Although this is a key policy, not an IAM policy, an [`aws_iam_policy_document`](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document), in the form that designates a principal, can be used. For more information about building policy documents with Terraform, see the [AWS IAM Policy Document Guide](https://learn.hashicorp.com/terraform/aws/iam-policy). ~> **NOTE:** Note: All KMS keys must have a key policy. If a key policy is not specified, AWS gives the KMS key a [default key policy](https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default) that gives all principals in the owning account unlimited access to all KMS operations for the key. This default key policy effectively delegates all access control to IAM policies and KMS grants. @@ -333,6 +334,32 @@ This resource exports the following attributes in addition to the arguments abov ## Import +In Terraform v1.12.0 and later, the [`import` block](https://developer.hashicorp.com/terraform/language/import) can be used with the `identity` attribute. For example: + +```terraform +import { + to = aws_kms_key.example + identity = { + id = "1234abcd-12ab-34cd-56ef-1234567890ab" + } +} + +resource "aws_kms_key" "example" { + ### Configuration omitted for brevity ### +} +``` + +### Identity Schema + +#### Required + +* `id` - (String) ID of the KMS key. + +#### Optional + +- `account_id` (String) AWS Account where this resource is managed. +- `region` (String) Region where this resource is managed. + In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import KMS Keys using the `id`. For example: ```python @@ -356,4 +383,4 @@ Using `terraform import`, import KMS Keys using the `id`. For example: % terraform import aws_kms_key.a 1234abcd-12ab-34cd-56ef-1234567890ab ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/kms_key_policy.html.markdown b/website/docs/cdktf/python/r/kms_key_policy.html.markdown index 06fb6a455986..182c7034042e 100644 --- a/website/docs/cdktf/python/r/kms_key_policy.html.markdown +++ b/website/docs/cdktf/python/r/kms_key_policy.html.markdown @@ -56,6 +56,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `key_id` - (Required) The ID of the KMS Key to attach the policy. * `policy` - (Required) A valid policy JSON document. Although this is a key policy, not an IAM policy, an [`aws_iam_policy_document`](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document), in the form that designates a principal, can be used. For more information about building policy documents with Terraform, see the [AWS IAM Policy Document Guide](https://learn.hashicorp.com/terraform/aws/iam-policy). @@ -94,4 +95,4 @@ Using `terraform import`, import KMS Key Policies using the `key_id`. For exampl % terraform import aws_kms_key_policy.a 1234abcd-12ab-34cd-56ef-1234567890ab ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/kms_replica_external_key.html.markdown b/website/docs/cdktf/python/r/kms_replica_external_key.html.markdown index 2ad19e9c7f91..9c85dd1663e2 100644 --- a/website/docs/cdktf/python/r/kms_replica_external_key.html.markdown +++ b/website/docs/cdktf/python/r/kms_replica_external_key.html.markdown @@ -56,6 +56,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `bypass_policy_lockout_safety_check` - (Optional) A flag to indicate whether to bypass the key policy lockout safety check. Setting this value to true increases the risk that the KMS key becomes unmanageable. Do not set this value to true indiscriminately. For more information, refer to the scenario in the [Default Key Policy](https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam) section in the _AWS Key Management Service Developer Guide_. @@ -107,4 +108,4 @@ Using `terraform import`, import KMS multi-Region replica keys using the `id`. F % terraform import aws_kms_replica_external_key.example 1234abcd-12ab-34cd-56ef-1234567890ab ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/kms_replica_key.html.markdown b/website/docs/cdktf/python/r/kms_replica_key.html.markdown index 66d54564279c..489d8da84736 100644 --- a/website/docs/cdktf/python/r/kms_replica_key.html.markdown +++ b/website/docs/cdktf/python/r/kms_replica_key.html.markdown @@ -14,6 +14,8 @@ Manages a KMS multi-Region replica key. ## Example Usage +### Terraform AWS Provider v5 (and below) + ```python # DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug from constructs import Construct @@ -48,10 +50,43 @@ class MyConvertedCode(TerraformStack): ) ``` +### Terraform AWS Provider v6 (and above) + +```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.kms_key import KmsKey +from imports.aws.kms_replica_key import KmsReplicaKey +from imports.aws.provider import AwsProvider +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + AwsProvider(self, "aws", + region="us-west-2" + ) + primary = KmsKey(self, "primary", + deletion_window_in_days=30, + description="Multi-Region primary key", + multi_region=True, + region="us-east-1" + ) + KmsReplicaKey(self, "replica", + deletion_window_in_days=7, + description="Multi-Region replica key", + primary_key_arn=primary.arn + ) +``` + ## Argument Reference This resource supports the following arguments: +* `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). * `bypass_policy_lockout_safety_check` - (Optional) A flag to indicate whether to bypass the key policy lockout safety check. Setting this value to true increases the risk that the KMS key becomes unmanageable. Do not set this value to true indiscriminately. For more information, refer to the scenario in the [Default Key Policy](https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam) section in the _AWS Key Management Service Developer Guide_. @@ -101,4 +136,4 @@ Using `terraform import`, import KMS multi-Region replica keys using the `id`. F % terraform import aws_kms_replica_key.example 1234abcd-12ab-34cd-56ef-1234567890ab ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/lakeformation_data_cells_filter.html.markdown b/website/docs/cdktf/python/r/lakeformation_data_cells_filter.html.markdown index 0980a1aceaab..ef9fc9253af4 100644 --- a/website/docs/cdktf/python/r/lakeformation_data_cells_filter.html.markdown +++ b/website/docs/cdktf/python/r/lakeformation_data_cells_filter.html.markdown @@ -45,8 +45,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `table_data` - (Required) Information about the data cells filter. See [Table Data](#table-data) below for details. ### Table Data @@ -83,7 +84,7 @@ This resource exports the following attributes in addition to the arguments abov ## Import -In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import Lake Formation Data Cells Filter using the `example_id_arg`. For example: +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import Lake Formation Data Cells Filter using the `database_name`, `name`, `table_catalog_id`, and `table_name` separated by `,`. For example: ```python # DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -100,10 +101,10 @@ class MyConvertedCode(TerraformStack): LakeformationDataCellsFilter.generate_config_for_import(self, "example", "database_name,name,table_catalog_id,table_name") ``` -Using `terraform import`, import Lake Formation Data Cells Filter using the `id`. For example: +Using `terraform import`, import Lake Formation Data Cells Filter using the `database_name`, `name`, `table_catalog_id`, and `table_name` separated by `,`. For example: ```console % terraform import aws_lakeformation_data_cells_filter.example database_name,name,table_catalog_id,table_name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/lakeformation_data_lake_settings.html.markdown b/website/docs/cdktf/python/r/lakeformation_data_lake_settings.html.markdown index 936d660f155a..f273430becd2 100644 --- a/website/docs/cdktf/python/r/lakeformation_data_lake_settings.html.markdown +++ b/website/docs/cdktf/python/r/lakeformation_data_lake_settings.html.markdown @@ -125,17 +125,18 @@ class MyConvertedCode(TerraformStack): The following arguments are optional: -* `admins` – (Optional) Set of ARNs of AWS Lake Formation principals (IAM users or roles). +* `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). +* `admins` - (Optional) Set of ARNs of AWS Lake Formation principals (IAM users or roles). * `allow_external_data_filtering` - (Optional) Whether to allow Amazon EMR clusters to access data managed by Lake Formation. * `allow_full_table_external_data_access` - (Optional) Whether to allow a third-party query engine to get data access credentials without session tags when a caller has full data access permissions. * `authorized_session_tag_value_list` - (Optional) Lake Formation relies on a privileged process secured by Amazon EMR or the third party integrator to tag the user's role while assuming it. -* `catalog_id` – (Optional) Identifier for the Data Catalog. By default, the account ID. +* `catalog_id` - (Optional) Identifier for the Data Catalog. By default, the account ID. * `create_database_default_permissions` - (Optional) Up to three configuration blocks of principal permissions for default create database permissions. Detailed below. * `create_table_default_permissions` - (Optional) Up to three configuration blocks of principal permissions for default create table permissions. Detailed below. * `external_data_filtering_allow_list` - (Optional) A list of the account IDs of Amazon Web Services accounts with Amazon EMR clusters that are to perform data filtering. * `parameters` - Key-value map of additional configuration. Valid values for the `CROSS_ACCOUNT_VERSION` key are `"1"`, `"2"`, `"3"`, or `"4"`. `SET_CONTEXT` is also returned with a value of `TRUE`. In a fresh account, prior to configuring, `CROSS_ACCOUNT_VERSION` is `"1"`. Destroying this resource sets the `CROSS_ACCOUNT_VERSION` to `"1"`. -* `read_only_admins` – (Optional) Set of ARNs of AWS Lake Formation principals (IAM users or roles) with only view access to the resources. -* `trusted_resource_owners` – (Optional) List of the resource-owning account IDs that the caller's account can use to share their user access details (user ARNs). +* `read_only_admins` - (Optional) Set of ARNs of AWS Lake Formation principals (IAM users or roles) with only view access to the resources. +* `trusted_resource_owners` - (Optional) List of the resource-owning account IDs that the caller's account can use to share their user access details (user ARNs). ~> **NOTE:** Although optional, not including `admins`, `create_database_default_permissions`, `create_table_default_permissions`, `parameters`, and/or `trusted_resource_owners` results in the setting being cleared. @@ -143,6 +144,7 @@ The following arguments are optional: The following arguments are optional: +* `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). * `permissions` - (Optional) List of permissions that are granted to the principal. Valid values may include `ALL`, `SELECT`, `ALTER`, `DROP`, `DELETE`, `INSERT`, `DESCRIBE`, and `CREATE_TABLE`. For more details, see [Lake Formation Permissions Reference](https://docs.aws.amazon.com/lake-formation/latest/dg/lf-permissions-reference.html). * `principal` - (Optional) Principal who is granted permissions. To enforce metadata and underlying data access control only by IAM on new databases and tables set `principal` to `IAM_ALLOWED_PRINCIPALS` and `permissions` to `["ALL"]`. @@ -150,6 +152,7 @@ The following arguments are optional: The following arguments are optional: +* `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). * `permissions` - (Optional) List of permissions that are granted to the principal. Valid values may include `ALL`, `SELECT`, `ALTER`, `DROP`, `DELETE`, `INSERT`, and `DESCRIBE`. For more details, see [Lake Formation Permissions Reference](https://docs.aws.amazon.com/lake-formation/latest/dg/lf-permissions-reference.html). * `principal` - (Optional) Principal who is granted permissions. To enforce metadata and underlying data access control only by IAM on new databases and tables set `principal` to `IAM_ALLOWED_PRINCIPALS` and `permissions` to `["ALL"]`. @@ -157,4 +160,4 @@ The following arguments are optional: This resource exports no additional attributes. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/lakeformation_lf_tag.html.markdown b/website/docs/cdktf/python/r/lakeformation_lf_tag.html.markdown index 6240f78472aa..4cf207a0fd40 100644 --- a/website/docs/cdktf/python/r/lakeformation_lf_tag.html.markdown +++ b/website/docs/cdktf/python/r/lakeformation_lf_tag.html.markdown @@ -36,6 +36,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `catalog_id` - (Optional) ID of the Data Catalog to create the tag in. If omitted, this defaults to the AWS Account ID. * `key` - (Required) Key-name for the tag. * `values` - (Required) List of possible values an attribute can take. @@ -71,4 +72,4 @@ Using `terraform import`, import Lake Formation LF-Tags using the `catalog_id:ke % terraform import aws_lakeformation_lf_tag.example 123456789012:some_key ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/lakeformation_opt_in.html.markdown b/website/docs/cdktf/python/r/lakeformation_opt_in.html.markdown index d265636818dd..f013e6dc04f9 100644 --- a/website/docs/cdktf/python/r/lakeformation_opt_in.html.markdown +++ b/website/docs/cdktf/python/r/lakeformation_opt_in.html.markdown @@ -33,8 +33,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `principal` - (Required) Lake Formation principal. Supported principals are IAM users or IAM roles. See [Principal](#principal) for more details. * `resource_data` - (Required) Structure for the resource. See [Resource](#resource) for more details. @@ -118,4 +119,4 @@ This resource exports the following attributes in addition to the arguments abov * `update` - (Default `180m`) * `delete` - (Default `90m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/lakeformation_permissions.html.markdown b/website/docs/cdktf/python/r/lakeformation_permissions.html.markdown index 8ac2b724eb30..750de3ea90c0 100644 --- a/website/docs/cdktf/python/r/lakeformation_permissions.html.markdown +++ b/website/docs/cdktf/python/r/lakeformation_permissions.html.markdown @@ -223,8 +223,8 @@ class MyConvertedCode(TerraformStack): The following arguments are required: -* `permissions` – (Required) List of permissions granted to the principal. Valid values may include `ALL`, `ALTER`, `ASSOCIATE`, `CREATE_DATABASE`, `CREATE_TABLE`, `DATA_LOCATION_ACCESS`, `DELETE`, `DESCRIBE`, `DROP`, `INSERT`, and `SELECT`. For details on each permission, see [Lake Formation Permissions Reference](https://docs.aws.amazon.com/lake-formation/latest/dg/lf-permissions-reference.html). -* `principal` – (Required) Principal to be granted the permissions on the resource. Supported principals include `IAM_ALLOWED_PRINCIPALS` (see [Default Behavior and `IAMAllowedPrincipals`](#default-behavior-and-iamallowedprincipals) above), IAM roles, users, groups, Federated Users, SAML groups and users, QuickSight groups, OUs, and organizations as well as AWS account IDs for cross-account permissions. For more information, see [Lake Formation Permissions Reference](https://docs.aws.amazon.com/lake-formation/latest/dg/lf-permissions-reference.html). +* `permissions` - (Required) List of permissions granted to the principal. Valid values may include `ALL`, `ALTER`, `ASSOCIATE`, `CREATE_DATABASE`, `CREATE_TABLE`, `DATA_LOCATION_ACCESS`, `DELETE`, `DESCRIBE`, `DROP`, `INSERT`, and `SELECT`. For details on each permission, see [Lake Formation Permissions Reference](https://docs.aws.amazon.com/lake-formation/latest/dg/lf-permissions-reference.html). +* `principal` - (Required) Principal to be granted the permissions on the resource. Supported principals include `IAM_ALLOWED_PRINCIPALS` (see [Default Behavior and `IAMAllowedPrincipals`](#default-behavior-and-iamallowedprincipals) above), IAM roles, users, groups, Federated Users, SAML groups and users, QuickSight groups, OUs, and organizations as well as AWS account IDs for cross-account permissions. For more information, see [Lake Formation Permissions Reference](https://docs.aws.amazon.com/lake-formation/latest/dg/lf-permissions-reference.html). ~> **NOTE:** We highly recommend that the `principal` _NOT_ be a Lake Formation administrator (granted using `aws_lakeformation_data_lake_settings`). The entity (e.g., IAM role) running Terraform will most likely need to be a Lake Formation administrator. As such, the entity will have implicit permissions and does not need permissions granted through this resource. @@ -241,7 +241,8 @@ One of the following is required: The following arguments are optional: -* `catalog_id` – (Optional) Identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment. +* `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). +* `catalog_id` - (Optional) Identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment. * `permissions_with_grant_option` - (Optional) Subset of `permissions` which the principal can pass. ### data_cells_filter @@ -255,7 +256,7 @@ The following arguments are optional: The following argument is required: -* `arn` – (Required) Amazon Resource Name (ARN) that uniquely identifies the data location resource. +* `arn` - (Required) Amazon Resource Name (ARN) that uniquely identifies the data location resource. The following argument is optional: @@ -265,7 +266,7 @@ The following argument is optional: The following argument is required: -* `name` – (Required) Name of the database resource. Unique to the Data Catalog. +* `name` - (Required) Name of the database resource. Unique to the Data Catalog. The following argument is optional: @@ -275,7 +276,7 @@ The following argument is optional: The following arguments are required: -* `key` – (Required) The key-name for the tag. +* `key` - (Required) The key-name for the tag. * `values` - (Required) A list of possible values an attribute can take. The following argument is optional: @@ -286,7 +287,7 @@ The following argument is optional: The following arguments are required: -* `resource_type` – (Required) The resource type for which the tag policy applies. Valid values are `DATABASE` and `TABLE`. +* `resource_type` - (Required) The resource type for which the tag policy applies. Valid values are `DATABASE` and `TABLE`. * `expression` - (Required) A list of tag conditions that apply to the resource's tag policy. Configuration block for tag conditions that apply to the policy. See [`expression`](#expression) below. The following argument is optional: @@ -295,19 +296,20 @@ The following argument is optional: #### expression -* `key` – (Required) The key-name of an LF-Tag. +* `key` - (Required) The key-name of an LF-Tag. * `values` - (Required) A list of possible values of an LF-Tag. ### table The following argument is required: -* `database_name` – (Required) Name of the database for the table. Unique to a Data Catalog. +* `database_name` - (Required) Name of the database for the table. Unique to a Data Catalog. * `name` - (Required, at least one of `name` or `wildcard`) Name of the table. * `wildcard` - (Required, at least one of `name` or `wildcard`) Whether to use a wildcard representing every table under a database. Defaults to `false`. The following arguments are optional: +* `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). * `catalog_id` - (Optional) Identifier for the Data Catalog. By default, it is the account ID of the caller. ### table_with_columns @@ -315,12 +317,13 @@ The following arguments are optional: The following arguments are required: * `column_names` - (Required, at least one of `column_names` or `wildcard`) Set of column names for the table. -* `database_name` – (Required) Name of the database for the table with columns resource. Unique to the Data Catalog. -* `name` – (Required) Name of the table resource. +* `database_name` - (Required) Name of the database for the table with columns resource. Unique to the Data Catalog. +* `name` - (Required) Name of the table resource. * `wildcard` - (Required, at least one of `column_names` or `wildcard`) Whether to use a column wildcard. If `excluded_column_names` is included, `wildcard` must be set to `true` to avoid Terraform reporting a difference. The following arguments are optional: +* `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). * `catalog_id` - (Optional) Identifier for the Data Catalog. By default, it is the account ID of the caller. * `excluded_column_names` - (Optional) Set of column names for the table to exclude. If `excluded_column_names` is included, `wildcard` must be set to `true` to avoid Terraform reporting a difference. @@ -328,4 +331,4 @@ The following arguments are optional: This resource exports no additional attributes. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/lakeformation_resource.html.markdown b/website/docs/cdktf/python/r/lakeformation_resource.html.markdown index b9d3f010b7be..8835cf424322 100644 --- a/website/docs/cdktf/python/r/lakeformation_resource.html.markdown +++ b/website/docs/cdktf/python/r/lakeformation_resource.html.markdown @@ -46,13 +46,16 @@ class MyConvertedCode(TerraformStack): The following arguments are required: -* `arn` – (Required) Amazon Resource Name (ARN) of the resource. +* `arn` - (Required) Amazon Resource Name (ARN) of the resource. The following arguments are optional: -* `role_arn` – (Optional) Role that has read/write access to the resource. +* `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). +* `role_arn` - (Optional) Role that has read/write access to the resource. * `use_service_linked_role` - (Optional) Designates an AWS Identity and Access Management (IAM) service-linked role by registering this role with the Data Catalog. * `hybrid_access_enabled` - (Optional) Flag to enable AWS LakeFormation hybrid access permission mode. +* `with_federation`- (Optional) Whether or not the resource is a federated resource. Set to true when registering AWS Glue connections for federated catalog functionality. +* `with_privileged_access` - (Optional) Boolean to grant the calling principal the permissions to perform all supported Lake Formation operations on the registered data location. ~> **NOTE:** AWS does not support registering an S3 location with an IAM role and subsequently updating the S3 location registration to a service-linked role. @@ -62,4 +65,4 @@ This resource exports the following attributes in addition to the arguments abov * `last_modified` - Date and time the resource was last modified in [RFC 3339 format](https://tools.ietf.org/html/rfc3339#section-5.8). - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/lakeformation_resource_lf_tag.html.markdown b/website/docs/cdktf/python/r/lakeformation_resource_lf_tag.html.markdown index 4051c10258d7..61e54efabbda 100644 --- a/website/docs/cdktf/python/r/lakeformation_resource_lf_tag.html.markdown +++ b/website/docs/cdktf/python/r/lakeformation_resource_lf_tag.html.markdown @@ -44,7 +44,7 @@ class MyConvertedCode(TerraformStack): The following arguments are required: -* `lf_tag` – (Required) Set of LF-tags to attach to the resource. See [LF Tag](#lf-tag) for more details. +* `lf_tag` - (Required) Set of LF-tags to attach to the resource. See [LF Tag](#lf-tag) for more details. Exactly one of the following is required: @@ -54,13 +54,14 @@ Exactly one of the following is required: The following arguments are optional: -* `catalog_id` – (Optional) Identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment. +* `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). +* `catalog_id` - (Optional) Identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment. ### LF Tag The following arguments are required: -* `key` – (Required) Key name for an existing LF-tag. +* `key` - (Required) Key name for an existing LF-tag. * `value` - (Required) Value from the possible values for the LF-tag. The following argument is optional: @@ -71,7 +72,7 @@ The following argument is optional: The following argument is required: -* `name` – (Required) Name of the database resource. Unique to the Data Catalog. +* `name` - (Required) Name of the database resource. Unique to the Data Catalog. The following argument is optional: @@ -81,12 +82,13 @@ The following argument is optional: The following argument is required: -* `database_name` – (Required) Name of the database for the table. Unique to a Data Catalog. +* `database_name` - (Required) Name of the database for the table. Unique to a Data Catalog. * `name` - (Required, at least one of `name` or `wildcard`) Name of the table. * `wildcard` - (Required, at least one of `name` or `wildcard`) Whether to use a wildcard representing every table under a database. Defaults to `false`. The following arguments are optional: +* `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). * `catalog_id` - (Optional) Identifier for the Data Catalog. By default, it is the account ID of the caller. ### Table With Columns @@ -94,11 +96,12 @@ The following arguments are optional: The following arguments are required: * `column_names` - (Required, at least one of `column_names` or `wildcard`) Set of column names for the table. -* `database_name` – (Required) Name of the database for the table with columns resource. Unique to the Data Catalog. -* `name` – (Required) Name of the table resource. +* `database_name` - (Required) Name of the database for the table with columns resource. Unique to the Data Catalog. +* `name` - (Required) Name of the table resource. The following arguments are optional: +* `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). * `catalog_id` - (Optional) Identifier for the Data Catalog. By default, it is the account ID of the caller. * `column_wildcard` - (Optional) Option to add column wildcard. See [Column Wildcard](#column-wildcard) for more details. @@ -121,4 +124,4 @@ This resource exports no additional attributes. You cannot import this resource. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/lakeformation_resource_lf_tags.html.markdown b/website/docs/cdktf/python/r/lakeformation_resource_lf_tags.html.markdown index 2e3e239a3f8c..14118acdfcef 100644 --- a/website/docs/cdktf/python/r/lakeformation_resource_lf_tags.html.markdown +++ b/website/docs/cdktf/python/r/lakeformation_resource_lf_tags.html.markdown @@ -96,7 +96,7 @@ class MyConvertedCode(TerraformStack): The following arguments are required: -* `lf_tag` – (Required) Set of LF-tags to attach to the resource. See below. +* `lf_tag` - (Required) Set of LF-tags to attach to the resource. See below. Exactly one of the following is required: @@ -106,13 +106,14 @@ Exactly one of the following is required: The following arguments are optional: -* `catalog_id` – (Optional) Identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment. +* `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). +* `catalog_id` - (Optional) Identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment. ### lf_tag The following arguments are required: -* `key` – (Required) Key name for an existing LF-tag. +* `key` - (Required) Key name for an existing LF-tag. * `value` - (Required) Value from the possible values for the LF-tag. The following argument is optional: @@ -123,7 +124,7 @@ The following argument is optional: The following argument is required: -* `name` – (Required) Name of the database resource. Unique to the Data Catalog. +* `name` - (Required) Name of the database resource. Unique to the Data Catalog. The following argument is optional: @@ -133,12 +134,13 @@ The following argument is optional: The following argument is required: -* `database_name` – (Required) Name of the database for the table. Unique to a Data Catalog. +* `database_name` - (Required) Name of the database for the table. Unique to a Data Catalog. * `name` - (Required, at least one of `name` or `wildcard`) Name of the table. * `wildcard` - (Required, at least one of `name` or `wildcard`) Whether to use a wildcard representing every table under a database. Defaults to `false`. The following arguments are optional: +* `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). * `catalog_id` - (Optional) Identifier for the Data Catalog. By default, it is the account ID of the caller. ### table_with_columns @@ -146,12 +148,13 @@ The following arguments are optional: The following arguments are required: * `column_names` - (Required, at least one of `column_names` or `wildcard`) Set of column names for the table. -* `database_name` – (Required) Name of the database for the table with columns resource. Unique to the Data Catalog. -* `name` – (Required) Name of the table resource. +* `database_name` - (Required) Name of the database for the table with columns resource. Unique to the Data Catalog. +* `name` - (Required) Name of the table resource. * `wildcard` - (Required, at least one of `column_names` or `wildcard`) Whether to use a column wildcard. If `excluded_column_names` is included, `wildcard` must be set to `true` to avoid Terraform reporting a difference. The following arguments are optional: +* `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). * `catalog_id` - (Optional) Identifier for the Data Catalog. By default, it is the account ID of the caller. * `excluded_column_names` - (Optional) Set of column names for the table to exclude. If `excluded_column_names` is included, `wildcard` must be set to `true` to avoid Terraform reporting a difference. @@ -159,4 +162,4 @@ The following arguments are optional: This resource exports no additional attributes. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/lambda_alias.html.markdown b/website/docs/cdktf/python/r/lambda_alias.html.markdown index 48f9dca8ccb9..1bbbc5de260a 100644 --- a/website/docs/cdktf/python/r/lambda_alias.html.markdown +++ b/website/docs/cdktf/python/r/lambda_alias.html.markdown @@ -3,24 +3,25 @@ subcategory: "Lambda" layout: "aws" page_title: "AWS: aws_lambda_alias" description: |- - Creates a Lambda function alias. + Manages an AWS Lambda Alias. --- # Resource: aws_lambda_alias -Creates a Lambda function alias. Creates an alias that points to the specified Lambda function version. +Manages an AWS Lambda Alias. Use this resource to create an alias that points to a specific Lambda function version for traffic management and deployment strategies. -For information about Lambda and how to use it, see [What is AWS Lambda?][1] -For information about function aliases, see [CreateAlias][2] and [AliasRoutingConfiguration][3] in the API docs. +For information about Lambda and how to use it, see [What is AWS Lambda?](http://docs.aws.amazon.com/lambda/latest/dg/welcome.html). For information about function aliases, see [CreateAlias](http://docs.aws.amazon.com/lambda/latest/dg/API_CreateAlias.html) and [AliasRoutingConfiguration](https://docs.aws.amazon.com/lambda/latest/dg/API_AliasRoutingConfiguration.html) in the API docs. ## Example Usage +### Basic Alias + ```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 +from cdktf import Token, TerraformStack # # Provider bindings are generated by running `cdktf get`. # See https://cdk.tf/provider-generation for more details. @@ -29,43 +30,115 @@ from imports.aws.lambda_alias import LambdaAlias class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) - LambdaAlias(self, "test_lambda_alias", - description="a sample description", - function_name=lambda_function_test.arn, + LambdaAlias(self, "example", + description="Production environment alias", + function_name=Token.as_string(aws_lambda_function_example.arn), function_version="1", - name="my_alias", + name="production" + ) +``` + +### Alias with Traffic Splitting + +```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.lambda_alias import LambdaAlias +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + LambdaAlias(self, "example", + description="Staging environment with traffic splitting", + function_name=Token.as_string(aws_lambda_function_example.function_name), + function_version="2", + name="staging", + routing_config=LambdaAliasRoutingConfig( + additional_version_weights={ + "1": 0.1, + "3": 0.2 + } + ) + ) +``` + +### Blue-Green Deployment Alias + +```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.lambda_alias import LambdaAlias +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + LambdaAlias(self, "example", + description="Live traffic with gradual rollout to new version", + function_name=Token.as_string(aws_lambda_function_example.function_name), + function_version="5", + name="live", routing_config=LambdaAliasRoutingConfig( additional_version_weights={ - "2": 0.5 + "6": 0.05 } ) ) ``` +### Development Alias + +```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.lambda_alias import LambdaAlias +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + LambdaAlias(self, "example", + description="Development environment - always points to latest", + function_name=Token.as_string(aws_lambda_function_example.function_name), + function_version="$LATEST", + name="dev" + ) +``` + ## Argument Reference -This resource supports the following arguments: +The following arguments are required: -* `name` - (Required) Name for the alias you are creating. Pattern: `(?!^[0-9]+$)([a-zA-Z0-9-_]+)` -* `description` - (Optional) Description of the alias. -* `function_name` - (Required) Lambda Function name or ARN. +* `function_name` - (Required) Name or ARN of the Lambda function. * `function_version` - (Required) Lambda function version for which you are creating the alias. Pattern: `(\$LATEST|[0-9]+)`. -* `routing_config` - (Optional) The Lambda alias' route configuration settings. Fields documented below +* `name` - (Required) Name for the alias. Pattern: `(?!^[0-9]+$)([a-zA-Z0-9-_]+)`. -`routing_config` supports the following arguments: +The following arguments are optional: -* `additional_version_weights` - (Optional) A map that defines the proportion of events that should be sent to different versions of a lambda function. +* `description` - (Optional) Description of the alias. +* `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). +* `routing_config` - (Optional) Lambda alias' route configuration settings. [See below](#routing_config-configuration-block). + +### routing_config Configuration Block + +* `additional_version_weights` - (Optional) Map that defines the proportion of events that should be sent to different versions of a Lambda function. ## Attribute Reference This resource exports the following attributes in addition to the arguments above: -* `arn` - The Amazon Resource Name (ARN) identifying your Lambda function alias. -* `invoke_arn` - The ARN to be used for invoking Lambda Function from API Gateway - to be used in [`aws_api_gateway_integration`](/docs/providers/aws/r/api_gateway_integration.html)'s `uri` - -[1]: http://docs.aws.amazon.com/lambda/latest/dg/welcome.html -[2]: http://docs.aws.amazon.com/lambda/latest/dg/API_CreateAlias.html -[3]: https://docs.aws.amazon.com/lambda/latest/dg/API_AliasRoutingConfiguration.html +* `arn` - ARN identifying your Lambda function alias. +* `invoke_arn` - ARN to be used for invoking Lambda Function from API Gateway - to be used in [`aws_api_gateway_integration`](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/api_gateway_integration)'s `uri`. ## Import @@ -83,13 +156,13 @@ from imports.aws.lambda_alias import LambdaAlias class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) - LambdaAlias.generate_config_for_import(self, "testLambdaAlias", "my_test_lambda_function/my_alias") + LambdaAlias.generate_config_for_import(self, "example", "example/production") ``` -Using `terraform import`, import Lambda Function Aliases using the `function_name/alias`. For example: +For backwards compatibility, the following legacy `terraform import` command is also supported: ```console -% terraform import aws_lambda_alias.test_lambda_alias my_test_lambda_function/my_alias +% terraform import aws_lambda_alias.example example/production ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/lambda_code_signing_config.html.markdown b/website/docs/cdktf/python/r/lambda_code_signing_config.html.markdown index 42c6bff03ef1..9bb9672679dd 100644 --- a/website/docs/cdktf/python/r/lambda_code_signing_config.html.markdown +++ b/website/docs/cdktf/python/r/lambda_code_signing_config.html.markdown @@ -3,19 +3,21 @@ subcategory: "Lambda" layout: "aws" page_title: "AWS: aws_lambda_code_signing_config" description: |- - Provides a Lambda Code Signing Config resource. + Manages an AWS Lambda Code Signing Config. --- # Resource: aws_lambda_code_signing_config -Provides a Lambda Code Signing Config resource. A code signing configuration defines a list of allowed signing profiles and defines the code-signing validation policy (action to be taken if deployment validation checks fail). +Manages an AWS Lambda Code Signing Config. Use this resource to define allowed signing profiles and code-signing validation policies for Lambda functions to ensure code integrity and authenticity. -For information about Lambda code signing configurations and how to use them, see [configuring code signing for Lambda functions][1] +For information about Lambda code signing configurations and how to use them, see [configuring code signing for Lambda functions](https://docs.aws.amazon.com/lambda/latest/dg/configuration-codesigning.html). ## 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 @@ -25,50 +27,143 @@ from cdktf import TerraformStack # See https://cdk.tf/provider-generation for more details. # from imports.aws.lambda_code_signing_config import LambdaCodeSigningConfig +from imports.aws.signer_signing_profile import SignerSigningProfile class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) - LambdaCodeSigningConfig(self, "new_csc", + dev = SignerSigningProfile(self, "dev", + name_prefix="dev_lambda_", + platform_id="AWSLambda-SHA384-ECDSA", + tags={ + "Environment": "development" + } + ) + prod = SignerSigningProfile(self, "prod", + name_prefix="prod_lambda_", + platform_id="AWSLambda-SHA384-ECDSA", + tags={ + "Environment": "production" + } + ) + LambdaCodeSigningConfig(self, "example", allowed_publishers=LambdaCodeSigningConfigAllowedPublishers( - signing_profile_version_arns=[example1.version_arn, example2.version_arn] + signing_profile_version_arns=[prod.version_arn, dev.version_arn] ), - description="My awesome code signing config.", + description="Code signing configuration for Lambda functions", + policies=LambdaCodeSigningConfigPolicies( + untrusted_artifact_on_deployment="Enforce" + ), + tags={ + "Environment": "production", + "Purpose": "code-signing" + } + ) +``` + +### Warning Only Configuration + +```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.lambda_code_signing_config import LambdaCodeSigningConfig +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + LambdaCodeSigningConfig(self, "example", + allowed_publishers=LambdaCodeSigningConfigAllowedPublishers( + signing_profile_version_arns=[dev.version_arn] + ), + description="Development code signing configuration", policies=LambdaCodeSigningConfigPolicies( untrusted_artifact_on_deployment="Warn" ), tags={ - "Name": "dynamodb" + "Environment": "development", + "Purpose": "code-signing" + } + ) +``` + +### Multiple Environment Configuration + +```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.lambda_code_signing_config import LambdaCodeSigningConfig +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + LambdaCodeSigningConfig(self, "dev", + allowed_publishers=LambdaCodeSigningConfigAllowedPublishers( + signing_profile_version_arns=[ + Token.as_string(aws_signer_signing_profile_dev.version_arn), test.version_arn + ] + ), + description="Development code signing configuration with warnings", + policies=LambdaCodeSigningConfigPolicies( + untrusted_artifact_on_deployment="Warn" + ), + tags={ + "Environment": "development", + "Security": "flexible" + } + ) + LambdaCodeSigningConfig(self, "prod", + allowed_publishers=LambdaCodeSigningConfigAllowedPublishers( + signing_profile_version_arns=[ + Token.as_string(aws_signer_signing_profile_prod.version_arn) + ] + ), + description="Production code signing configuration with strict enforcement", + policies=LambdaCodeSigningConfigPolicies( + untrusted_artifact_on_deployment="Enforce" + ), + tags={ + "Environment": "production", + "Security": "strict" } ) ``` ## Argument Reference -This resource supports the following arguments: +The following arguments are required: + +* `allowed_publishers` - (Required) Configuration block of allowed publishers as signing profiles for this code signing configuration. [See below](#allowed_publishers-configuration-block). + +The following arguments are optional: -* `allowed_publishers` (Required) A configuration block of allowed publishers as signing profiles for this code signing configuration. Detailed below. -* `policies` (Optional) A configuration block of code signing policies that define the actions to take if the validation checks fail. Detailed below. * `description` - (Optional) Descriptive name for this code signing configuration. +* `policies` - (Optional) Configuration block of code signing policies that define the actions to take if the validation checks fail. [See below](#policies-configuration-block). +* `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). * `tags` - (Optional) Map of tags to assign to the object. 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 `allowed_publishers` block supports the following argument: +### allowed_publishers Configuration Block -* `signing_profile_version_arns` - (Required) The Amazon Resource Name (ARN) for each of the signing profiles. A signing profile defines a trusted user who can sign a code package. +* `signing_profile_version_arns` - (Required) Set of ARNs for each of the signing profiles. A signing profile defines a trusted user who can sign a code package. Maximum of 20 signing profiles. -The `policies` block supports the following argument: +### policies Configuration Block -* `untrusted_artifact_on_deployment` - (Required) Code signing configuration policy for deployment validation failure. If you set the policy to Enforce, Lambda blocks the deployment request if code-signing validation checks fail. If you set the policy to Warn, Lambda allows the deployment and creates a CloudWatch log. Valid values: `Warn`, `Enforce`. Default value: `Warn`. +* `untrusted_artifact_on_deployment` - (Required) Code signing configuration policy for deployment validation failure. If you set the policy to `Enforce`, Lambda blocks the deployment request if code-signing validation checks fail. If you set the policy to `Warn`, Lambda allows the deployment and creates a CloudWatch log. Valid values: `Warn`, `Enforce`. Default value: `Warn`. ## Attribute Reference This resource exports the following attributes in addition to the arguments above: -* `arn` - The Amazon Resource Name (ARN) of the code signing configuration. +* `arn` - ARN of the code signing configuration. * `config_id` - Unique identifier for the code signing configuration. -* `last_modified` - The date and time that the code signing configuration was last modified. -* `tags_all` - A map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). - -[1]: https://docs.aws.amazon.com/lambda/latest/dg/configuration-codesigning.html +* `last_modified` - Date and time that the code signing configuration was last modified. +* `tags_all` - Map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). ## Import @@ -86,13 +181,13 @@ from imports.aws.lambda_code_signing_config import LambdaCodeSigningConfig class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) - LambdaCodeSigningConfig.generate_config_for_import(self, "importedCsc", "arn:aws:lambda:us-west-2:123456789012:code-signing-config:csc-0f6c334abcdea4d8b") + LambdaCodeSigningConfig.generate_config_for_import(self, "example", "arn:aws:lambda:us-west-2:123456789012:code-signing-config:csc-0f6c334abcdea4d8b") ``` -Using `terraform import`, import Code Signing Configs using their ARN. For example: +For backwards compatibility, the following legacy `terraform import` command is also supported: ```console -% terraform import aws_lambda_code_signing_config.imported_csc arn:aws:lambda:us-west-2:123456789012:code-signing-config:csc-0f6c334abcdea4d8b +% terraform import aws_lambda_code_signing_config.example arn:aws:lambda:us-west-2:123456789012:code-signing-config:csc-0f6c334abcdea4d8b ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/lambda_event_source_mapping.html.markdown b/website/docs/cdktf/python/r/lambda_event_source_mapping.html.markdown index ca2c7f80f9c2..c8ef7e0d37db 100644 --- a/website/docs/cdktf/python/r/lambda_event_source_mapping.html.markdown +++ b/website/docs/cdktf/python/r/lambda_event_source_mapping.html.markdown @@ -3,21 +3,20 @@ subcategory: "Lambda" layout: "aws" page_title: "AWS: aws_lambda_event_source_mapping" description: |- - Provides a Lambda event source mapping. This allows Lambda functions to get events from Kinesis, DynamoDB, SQS, Amazon MQ and Managed Streaming for Apache Kafka (MSK). + Manages an AWS Lambda Event Source Mapping. --- # Resource: aws_lambda_event_source_mapping -Provides a Lambda event source mapping. This allows Lambda functions to get events from Kinesis, DynamoDB, SQS, Amazon MQ and Managed Streaming for Apache Kafka (MSK). +Manages an AWS Lambda Event Source Mapping. Use this resource to connect Lambda functions to event sources like Kinesis, DynamoDB, SQS, Amazon MQ, and Managed Streaming for Apache Kafka (MSK). -For information about Lambda and how to use it, see [What is AWS Lambda?][1]. -For information about event source mappings, see [CreateEventSourceMapping][2] in the API docs. +For information about Lambda and how to use it, see [What is AWS Lambda?](http://docs.aws.amazon.com/lambda/latest/dg/welcome.html). For information about event source mappings, see [CreateEventSourceMapping](http://docs.aws.amazon.com/lambda/latest/dg/API_CreateEventSourceMapping.html) in the API docs. ## Example Usage -### DynamoDB +### DynamoDB Stream ```python # DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -36,12 +35,12 @@ class MyConvertedCode(TerraformStack): function_name=Token.as_string(aws_lambda_function_example.arn), starting_position="LATEST", tags={ - "Name": "dynamodb" + "Name": "dynamodb-stream-mapping" } ) ``` -### Kinesis +### Kinesis Stream ```python # DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -56,13 +55,21 @@ class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) LambdaEventSourceMapping(self, "example", + batch_size=100, + destination_config=LambdaEventSourceMappingDestinationConfig( + on_failure=LambdaEventSourceMappingDestinationConfigOnFailure( + destination_arn=dlq.arn + ) + ), event_source_arn=Token.as_string(aws_kinesis_stream_example.arn), function_name=Token.as_string(aws_lambda_function_example.arn), + maximum_batching_window_in_seconds=5, + parallelization_factor=2, starting_position="LATEST" ) ``` -### Managed Streaming for Apache Kafka (MSK) +### SQS Queue ```python # DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -77,19 +84,21 @@ class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) LambdaEventSourceMapping(self, "example", - event_source_arn=Token.as_string(aws_msk_cluster_example.arn), + batch_size=10, + event_source_arn=Token.as_string(aws_sqs_queue_example.arn), function_name=Token.as_string(aws_lambda_function_example.arn), - starting_position="TRIM_HORIZON", - topics=["Example"] + scaling_config=LambdaEventSourceMappingScalingConfig( + maximum_concurrency=100 + ) ) ``` -### Self Managed Apache Kafka +### SQS with Event Filtering ```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 Token, Fn, TerraformStack # # Provider bindings are generated by running `cdktf get`. # See https://cdk.tf/provider-generation for more details. @@ -99,33 +108,27 @@ class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) LambdaEventSourceMapping(self, "example", - function_name=Token.as_string(aws_lambda_function_example.arn), - provisioned_poller_config=LambdaEventSourceMappingProvisionedPollerConfig( - maximum_pollers=80, - minimum_pollers=10 - ), - self_managed_event_source=LambdaEventSourceMappingSelfManagedEventSource( - endpoints={ - "KAFKA_BOOTSTRAP_SERVERS": "kafka1.example.com:9092,kafka2.example.com:9092" - } + event_source_arn=Token.as_string(aws_sqs_queue_example.arn), + filter_criteria=LambdaEventSourceMappingFilterCriteria( + filter=[LambdaEventSourceMappingFilterCriteriaFilter( + pattern=Token.as_string( + Fn.jsonencode({ + "body": { + "Location": ["New York"], + "Temperature": [{ + "numeric": [">", 0, "<=", 100] + } + ] + } + })) + ) + ] ), - source_access_configuration=[LambdaEventSourceMappingSourceAccessConfiguration( - type="VPC_SUBNET", - uri="subnet:subnet-example1" - ), LambdaEventSourceMappingSourceAccessConfiguration( - type="VPC_SUBNET", - uri="subnet:subnet-example2" - ), LambdaEventSourceMappingSourceAccessConfiguration( - type="VPC_SECURITY_GROUP", - uri="security_group:sg-example" - ) - ], - starting_position="TRIM_HORIZON", - topics=["Example"] + function_name=Token.as_string(aws_lambda_function_example.arn) ) ``` -### SQS +### Amazon MSK ```python # DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -140,17 +143,23 @@ class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) LambdaEventSourceMapping(self, "example", - event_source_arn=sqs_queue_test.arn, - function_name=Token.as_string(aws_lambda_function_example.arn) + amazon_managed_kafka_event_source_config=LambdaEventSourceMappingAmazonManagedKafkaEventSourceConfig( + consumer_group_id="lambda-consumer-group" + ), + batch_size=100, + event_source_arn=Token.as_string(aws_msk_cluster_example.arn), + function_name=Token.as_string(aws_lambda_function_example.arn), + starting_position="TRIM_HORIZON", + topics=["orders", "inventory"] ) ``` -### SQS with event filter +### Self-Managed Apache Kafka ```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 +from cdktf import Token, TerraformStack # # Provider bindings are generated by running `cdktf get`. # See https://cdk.tf/provider-generation for more details. @@ -160,23 +169,32 @@ class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) LambdaEventSourceMapping(self, "example", - event_source_arn=sqs_queue_test.arn, - filter_criteria=LambdaEventSourceMappingFilterCriteria( - filter=[LambdaEventSourceMappingFilterCriteriaFilter( - pattern=Token.as_string( - Fn.jsonencode({ - "body": { - "Location": ["New York"], - "Temperature": [{ - "numeric": [">", 0, "<=", 100] - } - ] - } - })) - ) - ] + function_name=Token.as_string(aws_lambda_function_example.arn), + provisioned_poller_config=LambdaEventSourceMappingProvisionedPollerConfig( + maximum_pollers=100, + minimum_pollers=10 ), - function_name=Token.as_string(aws_lambda_function_example.arn) + self_managed_event_source=LambdaEventSourceMappingSelfManagedEventSource( + endpoints={ + "KAFKA_BOOTSTRAP_SERVERS": "kafka1.example.com:9092,kafka2.example.com:9092" + } + ), + self_managed_kafka_event_source_config=LambdaEventSourceMappingSelfManagedKafkaEventSourceConfig( + consumer_group_id="lambda-consumer-group" + ), + source_access_configuration=[LambdaEventSourceMappingSourceAccessConfiguration( + type="VPC_SUBNET", + uri="subnet:${" + example1.id + "}" + ), LambdaEventSourceMappingSourceAccessConfiguration( + type="VPC_SUBNET", + uri="subnet:${" + example2.id + "}" + ), LambdaEventSourceMappingSourceAccessConfiguration( + type="VPC_SECURITY_GROUP", + uri="security_group:${" + aws_security_group_example.id + "}" + ) + ], + starting_position="TRIM_HORIZON", + topics=["orders"] ) ``` @@ -196,10 +214,9 @@ class MyConvertedCode(TerraformStack): super().__init__(scope, name) LambdaEventSourceMapping(self, "example", batch_size=10, - enabled=True, event_source_arn=Token.as_string(aws_mq_broker_example.arn), function_name=Token.as_string(aws_lambda_function_example.arn), - queues=["example"], + queues=["orders"], source_access_configuration=[LambdaEventSourceMappingSourceAccessConfiguration( type="BASIC_AUTH", uri=Token.as_string(aws_secretsmanager_secret_version_example.arn) @@ -224,13 +241,12 @@ class MyConvertedCode(TerraformStack): super().__init__(scope, name) LambdaEventSourceMapping(self, "example", batch_size=1, - enabled=True, event_source_arn=Token.as_string(aws_mq_broker_example.arn), function_name=Token.as_string(aws_lambda_function_example.arn), - queues=["example"], + queues=["orders"], source_access_configuration=[LambdaEventSourceMappingSourceAccessConfiguration( type="VIRTUAL_HOST", - uri="/example" + uri="/production" ), LambdaEventSourceMappingSourceAccessConfiguration( type="BASIC_AUTH", uri=Token.as_string(aws_secretsmanager_secret_version_example.arn) @@ -239,105 +255,137 @@ class MyConvertedCode(TerraformStack): ) ``` +### DocumentDB Change Stream + +```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.lambda_event_source_mapping import LambdaEventSourceMapping +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + LambdaEventSourceMapping(self, "example", + document_db_event_source_config=LambdaEventSourceMappingDocumentDbEventSourceConfig( + collection_name="transactions", + database_name="orders", + full_document="UpdateLookup" + ), + event_source_arn=Token.as_string(aws_docdb_cluster_example.arn), + function_name=Token.as_string(aws_lambda_function_example.arn), + source_access_configuration=[LambdaEventSourceMappingSourceAccessConfiguration( + type="BASIC_AUTH", + uri=Token.as_string(aws_secretsmanager_secret_version_example.arn) + ) + ], + starting_position="LATEST" + ) +``` + ## Argument Reference -This resource supports the following arguments: - -* `amazon_managed_kafka_event_source_config` - (Optional) Additional configuration block for Amazon Managed Kafka sources. Incompatible with "self_managed_event_source" and "self_managed_kafka_event_source_config". Detailed below. -* `batch_size` - (Optional) The largest number of records that Lambda will retrieve from your event source at the time of invocation. Defaults to `100` for DynamoDB, Kinesis, MQ and MSK, `10` for SQS. -* `bisect_batch_on_function_error`: - (Optional) If the function returns an error, split the batch in two and retry. Only available for stream sources (DynamoDB and Kinesis). Defaults to `false`. -* `destination_config`: - (Optional) An Amazon SQS queue, Amazon SNS topic or Amazon S3 bucket (only available for Kafka sources) destination for failed records. Only available for stream sources (DynamoDB and Kinesis) and Kafka sources (Amazon MSK and Self-managed Apache Kafka). Detailed below. -* `document_db_event_source_config`: - (Optional) Configuration settings for a DocumentDB event source. Detailed below. -* `enabled` - (Optional) Determines if the mapping is enabled. This parameter can be used to enable or disable the mapping, both during resource creation and for already created resources. Defaults to `true`. -* `event_source_arn` - (Optional) The event source ARN - this is required for Kinesis stream, DynamoDB stream, SQS queue, MQ broker, MSK cluster or DocumentDB change stream. It is incompatible with a Self Managed Kafka source. -* `filter_criteria` - (Optional) The criteria to use for [event filtering](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html) Kinesis stream, DynamoDB stream, SQS queue event sources. Detailed below. -* `function_name` - (Required) The name or the ARN of the Lambda function that will be subscribing to events. -* `function_response_types` - (Optional) A list of current response type enums applied to the event source mapping for [AWS Lambda checkpointing](https://docs.aws.amazon.com/lambda/latest/dg/with-ddb.html#services-ddb-batchfailurereporting). Only available for SQS and stream sources (DynamoDB and Kinesis). Valid values: `ReportBatchItemFailures`. -* `kms_key_arn` - (Optional) The ARN of the Key Management Service (KMS) customer managed key that Lambda uses to encrypt your function's filter criteria. -* `maximum_batching_window_in_seconds` - (Optional) The maximum amount of time to gather records before invoking the function, in seconds (between 0 and 300). Records will continue to buffer (or accumulate in the case of an SQS queue event source) until either `maximum_batching_window_in_seconds` expires or `batch_size` has been met. For streaming event sources, defaults to as soon as records are available in the stream. If the batch it reads from the stream/queue only has one record in it, Lambda only sends one record to the function. Only available for stream sources (DynamoDB and Kinesis) and SQS standard queues. -* `maximum_record_age_in_seconds`: - (Optional) The maximum age of a record that Lambda sends to a function for processing. Only available for stream sources (DynamoDB and Kinesis). Must be either -1 (forever, and the default value) or between 60 and 604800 (inclusive). -* `maximum_retry_attempts`: - (Optional) The maximum number of times to retry when the function returns an error. Only available for stream sources (DynamoDB and Kinesis). Minimum and default of -1 (forever), maximum of 10000. -* `metrics_config`: - (Optional) CloudWatch metrics configuration of the event source. Only available for stream sources (DynamoDB and Kinesis) and SQS queues. Detailed below. -* `parallelization_factor`: - (Optional) The number of batches to process from each shard concurrently. Only available for stream sources (DynamoDB and Kinesis). Minimum and default of 1, maximum of 10. -* `provisioned_poller_config`: - (Optional) Event poller configuration for the event source. Only valid for Amazon MSK or self-managed Apache Kafka sources. Detailed below. -* `queues` - (Optional) The name of the Amazon MQ broker destination queue to consume. Only available for MQ sources. The list must contain exactly one queue name. -* `scaling_config` - (Optional) Scaling configuration of the event source. Only available for SQS queues. Detailed below. -* `self_managed_event_source`: - (Optional) For Self Managed Kafka sources, the location of the self managed cluster. If set, configuration must also include `source_access_configuration`. Detailed below. -* `self_managed_kafka_event_source_config` - (Optional) Additional configuration block for Self Managed Kafka sources. Incompatible with "event_source_arn" and "amazon_managed_kafka_event_source_config". Detailed below. -* `source_access_configuration`: (Optional) For Self Managed Kafka sources, the access configuration for the source. If set, configuration must also include `self_managed_event_source`. Detailed below. -* `starting_position` - (Optional) The position in the stream where AWS Lambda should start reading. Must be one of `AT_TIMESTAMP` (Kinesis only), `LATEST` or `TRIM_HORIZON` if getting events from Kinesis, DynamoDB, MSK or Self Managed Apache Kafka. Must not be provided if getting events from SQS. More information about these positions can be found in the [AWS DynamoDB Streams API Reference](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_streams_GetShardIterator.html) and [AWS Kinesis API Reference](https://docs.aws.amazon.com/kinesis/latest/APIReference/API_GetShardIterator.html#Kinesis-GetShardIterator-request-ShardIteratorType). -* `starting_position_timestamp` - (Optional) A timestamp in [RFC3339 format](https://tools.ietf.org/html/rfc3339#section-5.8) of the data record which to start reading when using `starting_position` set to `AT_TIMESTAMP`. If a record with this exact timestamp does not exist, the next later record is chosen. If the timestamp is older than the current trim horizon, the oldest available record is chosen. +The following arguments are required: + +* `function_name` - (Required) Name or ARN of the Lambda function that will be subscribing to events. + +The following arguments are optional: + +* `amazon_managed_kafka_event_source_config` - (Optional) Additional configuration block for Amazon Managed Kafka sources. Incompatible with `self_managed_event_source` and `self_managed_kafka_event_source_config`. [See below](#amazon_managed_kafka_event_source_config-configuration-block). +* `batch_size` - (Optional) Largest number of records that Lambda will retrieve from your event source at the time of invocation. Defaults to `100` for DynamoDB, Kinesis, MQ and MSK, `10` for SQS. +* `bisect_batch_on_function_error` - (Optional) Whether to split the batch in two and retry if the function returns an error. Only available for stream sources (DynamoDB and Kinesis). Defaults to `false`. +* `destination_config` - (Optional) Amazon SQS queue, Amazon SNS topic or Amazon S3 bucket (only available for Kafka sources) destination for failed records. Only available for stream sources (DynamoDB and Kinesis) and Kafka sources (Amazon MSK and Self-managed Apache Kafka). [See below](#destination_config-configuration-block). +* `document_db_event_source_config` - (Optional) Configuration settings for a DocumentDB event source. [See below](#document_db_event_source_config-configuration-block). +* `enabled` - (Optional) Whether the mapping is enabled. Defaults to `true`. +* `event_source_arn` - (Optional) Event source ARN - required for Kinesis stream, DynamoDB stream, SQS queue, MQ broker, MSK cluster or DocumentDB change stream. Incompatible with Self Managed Kafka source. +* `filter_criteria` - (Optional) Criteria to use for [event filtering](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html) Kinesis stream, DynamoDB stream, SQS queue event sources. [See below](#filter_criteria-configuration-block). +* `function_response_types` - (Optional) List of current response type enums applied to the event source mapping for [AWS Lambda checkpointing](https://docs.aws.amazon.com/lambda/latest/dg/with-ddb.html#services-ddb-batchfailurereporting). Only available for SQS and stream sources (DynamoDB and Kinesis). Valid values: `ReportBatchItemFailures`. +* `kms_key_arn` - (Optional) ARN of the Key Management Service (KMS) customer managed key that Lambda uses to encrypt your function's filter criteria. +* `maximum_batching_window_in_seconds` - (Optional) Maximum amount of time to gather records before invoking the function, in seconds (between 0 and 300). Records will continue to buffer until either `maximum_batching_window_in_seconds` expires or `batch_size` has been met. For streaming event sources, defaults to as soon as records are available in the stream. Only available for stream sources (DynamoDB and Kinesis) and SQS standard queues. +* `maximum_record_age_in_seconds` - (Optional) Maximum age of a record that Lambda sends to a function for processing. Only available for stream sources (DynamoDB and Kinesis). Must be either -1 (forever, and the default value) or between 60 and 604800 (inclusive). +* `maximum_retry_attempts` - (Optional) Maximum number of times to retry when the function returns an error. Only available for stream sources (DynamoDB and Kinesis). Minimum and default of -1 (forever), maximum of 10000. +* `metrics_config` - (Optional) CloudWatch metrics configuration of the event source. Only available for stream sources (DynamoDB and Kinesis) and SQS queues. [See below](#metrics_config-configuration-block). +* `parallelization_factor` - (Optional) Number of batches to process from each shard concurrently. Only available for stream sources (DynamoDB and Kinesis). Minimum and default of 1, maximum of 10. +* `provisioned_poller_config` - (Optional) Event poller configuration for the event source. Only valid for Amazon MSK or self-managed Apache Kafka sources. [See below](#provisioned_poller_config-configuration-block). +* `queues` - (Optional) Name of the Amazon MQ broker destination queue to consume. Only available for MQ sources. The list must contain exactly one queue name. +* `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). +* `scaling_config` - (Optional) Scaling configuration of the event source. Only available for SQS queues. [See below](#scaling_config-configuration-block). +* `self_managed_event_source` - (Optional) For Self Managed Kafka sources, the location of the self managed cluster. If set, configuration must also include `source_access_configuration`. [See below](#self_managed_event_source-configuration-block). +* `self_managed_kafka_event_source_config` - (Optional) Additional configuration block for Self Managed Kafka sources. Incompatible with `event_source_arn` and `amazon_managed_kafka_event_source_config`. [See below](#self_managed_kafka_event_source_config-configuration-block). +* `source_access_configuration` - (Optional) For Self Managed Kafka sources, the access configuration for the source. If set, configuration must also include `self_managed_event_source`. [See below](#source_access_configuration-configuration-block). +* `starting_position` - (Optional) Position in the stream where AWS Lambda should start reading. Must be one of `AT_TIMESTAMP` (Kinesis only), `LATEST` or `TRIM_HORIZON` if getting events from Kinesis, DynamoDB, MSK or Self Managed Apache Kafka. Must not be provided if getting events from SQS. More information about these positions can be found in the [AWS DynamoDB Streams API Reference](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_streams_GetShardIterator.html) and [AWS Kinesis API Reference](https://docs.aws.amazon.com/kinesis/latest/APIReference/API_GetShardIterator.html#Kinesis-GetShardIterator-request-ShardIteratorType). +* `starting_position_timestamp` - (Optional) Timestamp in [RFC3339 format](https://tools.ietf.org/html/rfc3339#section-5.8) of the data record which to start reading when using `starting_position` set to `AT_TIMESTAMP`. If a record with this exact timestamp does not exist, the next later record is chosen. If the timestamp is older than the current trim horizon, the oldest available record is chosen. * `tags` - (Optional) Map of tags to assign to the object. 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. -* `topics` - (Optional) The name of the Kafka topics. Only available for MSK sources. A single topic name must be specified. -* `tumbling_window_in_seconds` - (Optional) The duration in seconds of a processing window for [AWS Lambda streaming analytics](https://docs.aws.amazon.com/lambda/latest/dg/with-kinesis.html#services-kinesis-windows). The range is between 1 second up to 900 seconds. Only available for stream sources (DynamoDB and Kinesis). +* `topics` - (Optional) Name of the Kafka topics. Only available for MSK sources. A single topic name must be specified. +* `tumbling_window_in_seconds` - (Optional) Duration in seconds of a processing window for [AWS Lambda streaming analytics](https://docs.aws.amazon.com/lambda/latest/dg/with-kinesis.html#services-kinesis-windows). The range is between 1 second up to 900 seconds. Only available for stream sources (DynamoDB and Kinesis). ### amazon_managed_kafka_event_source_config Configuration Block -* `consumer_group_id` - (Optional) A Kafka consumer group ID between 1 and 200 characters for use when creating this event source mapping. If one is not specified, this value will be automatically generated. See [AmazonManagedKafkaEventSourceConfig Syntax](https://docs.aws.amazon.com/lambda/latest/dg/API_AmazonManagedKafkaEventSourceConfig.html). +* `consumer_group_id` - (Optional) Kafka consumer group ID between 1 and 200 characters for use when creating this event source mapping. If one is not specified, this value will be automatically generated. See [AmazonManagedKafkaEventSourceConfig Syntax](https://docs.aws.amazon.com/lambda/latest/dg/API_AmazonManagedKafkaEventSourceConfig.html). ### destination_config Configuration Block -* `on_failure` - (Optional) The destination configuration for failed invocations. Detailed below. +* `on_failure` - (Optional) Destination configuration for failed invocations. [See below](#destination_config-on_failure-configuration-block). #### destination_config on_failure Configuration Block -* `destination_arn` - (Required) The Amazon Resource Name (ARN) of the destination resource. +* `destination_arn` - (Required) ARN of the destination resource. ### document_db_event_source_config Configuration Block -* `collection_name` - (Optional) The name of the collection to consume within the database. If you do not specify a collection, Lambda consumes all collections. -* `database_name` - (Required) The name of the database to consume within the DocumentDB cluster. +* `collection_name` - (Optional) Name of the collection to consume within the database. If you do not specify a collection, Lambda consumes all collections. +* `database_name` - (Required) Name of the database to consume within the DocumentDB cluster. * `full_document` - (Optional) Determines what DocumentDB sends to your event stream during document update operations. If set to `UpdateLookup`, DocumentDB sends a delta describing the changes, along with a copy of the entire document. Otherwise, DocumentDB sends only a partial document that contains the changes. Valid values: `UpdateLookup`, `Default`. ### filter_criteria Configuration Block -* `filter` - (Optional) A set of up to 5 filter. If an event satisfies at least one, Lambda sends the event to the function or adds it to the next batch. Detailed below. +* `filter` - (Optional) Set of up to 5 filter. If an event satisfies at least one, Lambda sends the event to the function or adds it to the next batch. [See below](#filter_criteria-filter-configuration-block). #### filter_criteria filter Configuration Block -* `pattern` - (Optional) A filter pattern up to 4096 characters. See [Filter Rule Syntax](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html#filtering-syntax). +* `pattern` - (Optional) Filter pattern up to 4096 characters. See [Filter Rule Syntax](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html#filtering-syntax). ### metrics_config Configuration Block -* `metrics` - (Required) A list containing the metrics to be produced by the event source mapping. Valid values: `EventCount`. +* `metrics` - (Required) List containing the metrics to be produced by the event source mapping. Valid values: `EventCount`. ### provisioned_poller_config Configuration Block -* `maximum_pollers` - (Optional) The maximum number of event pollers this event source can scale up to. The range is between 1 and 2000. -* `minimum_pollers` - (Optional) The minimum number of event pollers this event source can scale down to. The range is between 1 and 200. +* `maximum_pollers` - (Optional) Maximum number of event pollers this event source can scale up to. The range is between 1 and 2000. +* `minimum_pollers` - (Optional) Minimum number of event pollers this event source can scale down to. The range is between 1 and 200. ### scaling_config Configuration Block -* `maximum_concurrency` - (Optional) Limits the number of concurrent instances that the Amazon SQS event source can invoke. Must be greater than or equal to `2`. See [Configuring maximum concurrency for Amazon SQS event sources](https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html#events-sqs-max-concurrency). You need to raise a [Service Quota Ticket](https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html) to increase the concurrency beyond 1000. +* `maximum_concurrency` - (Optional) Limits the number of concurrent instances that the Amazon SQS event source can invoke. Must be greater than or equal to 2. See [Configuring maximum concurrency for Amazon SQS event sources](https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html#events-sqs-max-concurrency). You need to raise a [Service Quota Ticket](https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html) to increase the concurrency beyond 1000. ### self_managed_event_source Configuration Block -* `endpoints` - (Required) A map of endpoints for the self managed source. For Kafka self-managed sources, the key should be `KAFKA_BOOTSTRAP_SERVERS` and the value should be a string with a comma separated list of broker endpoints. +* `endpoints` - (Required) Map of endpoints for the self managed source. For Kafka self-managed sources, the key should be `KAFKA_BOOTSTRAP_SERVERS` and the value should be a string with a comma separated list of broker endpoints. ### self_managed_kafka_event_source_config Configuration Block -* `consumer_group_id` - (Optional) A Kafka consumer group ID between 1 and 200 characters for use when creating this event source mapping. If one is not specified, this value will be automatically generated. See [SelfManagedKafkaEventSourceConfig Syntax](https://docs.aws.amazon.com/lambda/latest/dg/API_SelfManagedKafkaEventSourceConfig.html). +* `consumer_group_id` - (Optional) Kafka consumer group ID between 1 and 200 characters for use when creating this event source mapping. If one is not specified, this value will be automatically generated. See [SelfManagedKafkaEventSourceConfig Syntax](https://docs.aws.amazon.com/lambda/latest/dg/API_SelfManagedKafkaEventSourceConfig.html). ### source_access_configuration Configuration Block -* `type` - (Required) The type of authentication protocol, VPC components, or virtual host for your event source. For valid values, refer to the [AWS documentation](https://docs.aws.amazon.com/lambda/latest/api/API_SourceAccessConfiguration.html). -* `uri` - (Required) The URI for this configuration. For type `VPC_SUBNET` the value should be `subnet:subnet_id` where `subnet_id` is the value you would find in an aws_subnet resource's id attribute. For type `VPC_SECURITY_GROUP` the value should be `security_group:security_group_id` where `security_group_id` is the value you would find in an aws_security_group resource's id attribute. +* `type` - (Required) Type of authentication protocol, VPC components, or virtual host for your event source. For valid values, refer to the [AWS documentation](https://docs.aws.amazon.com/lambda/latest/api/API_SourceAccessConfiguration.html). +* `uri` - (Required) URI for this configuration. For type `VPC_SUBNET` the value should be `subnet:subnet_id` where `subnet_id` is the value you would find in an aws_subnet resource's id attribute. For type `VPC_SECURITY_GROUP` the value should be `security_group:security_group_id` where `security_group_id` is the value you would find in an aws_security_group resource's id attribute. ## Attribute Reference This resource exports the following attributes in addition to the arguments above: -* `arn` - The event source mapping ARN. -* `function_arn` - The ARN of the Lambda function the event source mapping is sending events to. (Note: this is a computed value that differs from `function_name` above.) -* `last_modified` - The date this resource was last modified. -* `last_processing_result` - The result of the last AWS Lambda invocation of your Lambda function. -* `state` - The state of the event source mapping. -* `state_transition_reason` - The reason the event source mapping is in its current state. -* `tags_all` - A map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). -* `uuid` - The UUID of the created event source mapping. - -[1]: http://docs.aws.amazon.com/lambda/latest/dg/welcome.html -[2]: http://docs.aws.amazon.com/lambda/latest/dg/API_CreateEventSourceMapping.html +* `arn` - Event source mapping ARN. +* `function_arn` - ARN of the Lambda function the event source mapping is sending events to. (Note: this is a computed value that differs from `function_name` above.) +* `last_modified` - Date this resource was last modified. +* `last_processing_result` - Result of the last AWS Lambda invocation of your Lambda function. +* `state` - State of the event source mapping. +* `state_transition_reason` - Reason the event source mapping is in its current state. +* `tags_all` - Map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). +* `uuid` - UUID of the created event source mapping. ## Import @@ -355,13 +403,13 @@ from imports.aws.lambda_event_source_mapping import LambdaEventSourceMapping class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) - LambdaEventSourceMapping.generate_config_for_import(self, "eventSourceMapping", "12345kxodurf3443") + LambdaEventSourceMapping.generate_config_for_import(self, "example", "12345kxodurf3443") ``` Using `terraform import`, import Lambda event source mappings using the `UUID` (event source mapping identifier). For example: ```console -% terraform import aws_lambda_event_source_mapping.event_source_mapping 12345kxodurf3443 +% terraform import aws_lambda_event_source_mapping.example 12345kxodurf3443 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/lambda_function.html.markdown b/website/docs/cdktf/python/r/lambda_function.html.markdown index 753e39b2f7c1..21800fc84325 100644 --- a/website/docs/cdktf/python/r/lambda_function.html.markdown +++ b/website/docs/cdktf/python/r/lambda_function.html.markdown @@ -3,28 +3,26 @@ subcategory: "Lambda" layout: "aws" page_title: "AWS: aws_lambda_function" description: |- - Provides a Lambda Function resource. Lambda allows you to trigger execution of code in response to events in AWS, enabling serverless backend solutions. The Lambda Function itself includes source code and runtime configuration. + Manages an AWS Lambda Function. --- # Resource: aws_lambda_function -Provides a Lambda Function resource. Lambda allows you to trigger execution of code in response to events in AWS, enabling serverless backend solutions. The Lambda Function itself includes source code and runtime configuration. +Manages an AWS Lambda Function. Use this resource to create serverless functions that run code in response to events without provisioning or managing servers. -For information about Lambda and how to use it, see [What is AWS Lambda?][1] +For information about Lambda and how to use it, see [What is AWS Lambda?](https://docs.aws.amazon.com/lambda/latest/dg/welcome.html). For a detailed example of setting up Lambda and API Gateway, see [Serverless Applications with AWS Lambda and API Gateway](https://learn.hashicorp.com/terraform/aws/lambda-api-gateway). -For a detailed example of setting up Lambda and API Gateway, see [Serverless Applications with AWS Lambda and API Gateway.][11] +~> **Note:** Due to [AWS Lambda improved VPC networking changes that began deploying in September 2019](https://aws.amazon.com/blogs/compute/announcing-improved-vpc-networking-for-aws-lambda-functions/), EC2 subnets and security groups associated with Lambda Functions can take up to 45 minutes to successfully delete. Terraform AWS Provider version 2.31.0 and later automatically handles this increased timeout, however prior versions require setting the customizable deletion timeouts of those Terraform resources to 45 minutes (`delete = "45m"`). AWS and HashiCorp are working together to reduce the amount of time required for resource deletion and updates can be tracked in this [GitHub issue](https://github.com/hashicorp/terraform-provider-aws/issues/10329). -~> **NOTE:** Due to [AWS Lambda improved VPC networking changes that began deploying in September 2019](https://aws.amazon.com/blogs/compute/announcing-improved-vpc-networking-for-aws-lambda-functions/), EC2 subnets and security groups associated with Lambda Functions can take up to 45 minutes to successfully delete. Terraform AWS Provider version 2.31.0 and later automatically handles this increased timeout, however prior versions require setting the customizable deletion timeouts of those Terraform resources to 45 minutes (`delete = "45m"`). AWS and HashiCorp are working together to reduce the amount of time required for resource deletion and updates can be tracked in this [GitHub issue](https://github.com/hashicorp/terraform-provider-aws/issues/10329). +~> **Note:** If you get a `KMSAccessDeniedException: Lambda was unable to decrypt the environment variables because KMS access was denied` error when invoking an `aws_lambda_function` with environment variables, the IAM role associated with the function may have been deleted and recreated after the function was created. You can fix the problem two ways: 1) updating the function's role to another role and then updating it back again to the recreated role, or 2) by using Terraform to `taint` the function and `apply` your configuration again to recreate the function. (When you create a function, Lambda grants permissions on the KMS key to the function's IAM role. If the IAM role is recreated, the grant is no longer valid. Changing the function's role or recreating the function causes Lambda to update the grant.) -~> **NOTE:** If you get a `KMSAccessDeniedException: Lambda was unable to decrypt the environment variables because KMS access was denied` error when invoking an [`aws_lambda_function`](/docs/providers/aws/r/lambda_function.html) with environment variables, the IAM role associated with the function may have been deleted and recreated _after_ the function was created. You can fix the problem two ways: 1) updating the function's role to another role and then updating it back again to the recreated role, or 2) by using Terraform to `taint` the function and `apply` your configuration again to recreate the function. (When you create a function, Lambda grants permissions on the KMS key to the function's IAM role. If the IAM role is recreated, the grant is no longer valid. Changing the function's role or recreating the function causes Lambda to update the grant.) - --> To give an external source (like an EventBridge Rule, SNS, or S3) permission to access the Lambda function, use the [`aws_lambda_permission`](lambda_permission.html) resource. See [Lambda Permission Model][4] for more details. On the other hand, the `role` argument of this resource is the function's execution role for identity and access to AWS services and resources. +-> **Tip:** To give an external source (like an EventBridge Rule, SNS, or S3) permission to access the Lambda function, use the [`aws_lambda_permission`](lambda_permission.html) resource. See [Lambda Permission Model](https://docs.aws.amazon.com/lambda/latest/dg/intro-permission-model.html) for more details. On the other hand, the `role` argument of this resource is the function's execution role for identity and access to AWS services and resources. ## Example Usage -### Basic Example +### Basic Function with Node.js ```python # DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -43,9 +41,9 @@ class MyConvertedCode(TerraformStack): super().__init__(scope, name) # The following providers are missing schema information and might need manual adjustments to synthesize correctly: archive. # For a more precise conversion please use the --provider flag in convert. - lambda_ = DataArchiveFile(self, "lambda", - output_path="lambda_function_payload.zip", - source_file="lambda.js", + example = DataArchiveFile(self, "example", + output_path="${path.module}/lambda/function.zip", + source_file="${path.module}/lambda/index.js", type="zip" ) assume_role = DataAwsIamPolicyDocument(self, "assume_role", @@ -60,33 +58,71 @@ class MyConvertedCode(TerraformStack): ) ] ) - iam_for_lambda = IamRole(self, "iam_for_lambda", + aws_iam_role_example = IamRole(self, "example_2", assume_role_policy=Token.as_string(assume_role.json), - name="iam_for_lambda" + name="lambda_execution_role" ) - LambdaFunction(self, "test_lambda", + # 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_iam_role_example.override_logical_id("example") + aws_lambda_function_example = LambdaFunction(self, "example_3", environment=LambdaFunctionEnvironment( variables={ - "foo": "bar" + "ENVIRONMENT": "production", + "LOG_LEVEL": "info" } ), - filename="lambda_function_payload.zip", - function_name="lambda_function_name", - handler="index.test", - role=iam_for_lambda.arn, - runtime="nodejs18.x", - source_code_hash=Token.as_string(lambda_.output_base64_sha256) + filename=Token.as_string(example.output_path), + function_name="example_lambda_function", + handler="index.handler", + role=Token.as_string(aws_iam_role_example.arn), + runtime="nodejs20.x", + source_code_hash=Token.as_string(example.output_base64_sha256), + tags={ + "Application": "example", + "Environment": "production" + } ) + # 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_lambda_function_example.override_logical_id("example") ``` -### Lambda Layers +### Container Image Function + +```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.lambda_function import LambdaFunction +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + LambdaFunction(self, "example", + architectures=["arm64"], + function_name="example_container_function", + image_config=LambdaFunctionImageConfig( + command=["app.handler"], + entry_point=["/lambda-entrypoint.sh"] + ), + image_uri="${" + aws_ecr_repository_example.repository_url + "}:latest", + memory_size=512, + package_type="Image", + role=Token.as_string(aws_iam_role_example.arn), + timeout=30 + ) +``` -~> **NOTE:** The `aws_lambda_layer_version` attribute values for `arn` and `layer_arn` were swapped in version 2.0.0 of the Terraform AWS Provider. For version 1.x, use `layer_arn` references. For version 2.x, use `arn` references. +### Function with Lambda Layers + +~> **Note:** The `aws_lambda_layer_version` attribute values for `arn` and `layer_arn` were swapped in version 2.0.0 of the Terraform AWS Provider. For version 2.x, use `arn` references. ```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 +from cdktf import Token, TerraformStack # # Provider bindings are generated by running `cdktf get`. # See https://cdk.tf/provider-generation for more details. @@ -94,23 +130,31 @@ from cdktf import TerraformStack from imports.aws.lambda_function import LambdaFunction from imports.aws.lambda_layer_version import LambdaLayerVersion class MyConvertedCode(TerraformStack): - def __init__(self, scope, name, *, layerName, functionName, role): + def __init__(self, scope, name): super().__init__(scope, name) example = LambdaLayerVersion(self, "example", - layer_name=layer_name + compatible_architectures=["x86_64", "arm64"], + compatible_runtimes=["nodejs20.x", "python3.12"], + description="Common dependencies for Lambda functions", + filename="layer.zip", + layer_name="example_dependencies_layer" ) aws_lambda_function_example = LambdaFunction(self, "example_1", + filename="function.zip", + function_name="example_layered_function", + handler="index.handler", layers=[example.arn], - function_name=function_name, - role=role + role=Token.as_string(aws_iam_role_example.arn), + runtime="nodejs20.x", + tracing_config=LambdaFunctionTracingConfig( + mode="Active" + ) ) # 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_lambda_function_example.override_logical_id("example") ``` -### Lambda Ephemeral Storage - -Lambda Function Ephemeral Storage(`/tmp`) allows you to configure the storage upto `10` GB. The default value set to `512` MB. +### VPC Function with Enhanced Networking ```python # DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -120,48 +164,38 @@ 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.data_aws_iam_policy_document import DataAwsIamPolicyDocument -from imports.aws.iam_role import IamRole from imports.aws.lambda_function import LambdaFunction class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) - assume_role = DataAwsIamPolicyDocument(self, "assume_role", - statement=[DataAwsIamPolicyDocumentStatement( - actions=["sts:AssumeRole"], - effect="Allow", - principals=[DataAwsIamPolicyDocumentStatementPrincipals( - identifiers=["lambda.amazonaws.com"], - type="Service" - ) - ] - ) - ] - ) - iam_for_lambda = IamRole(self, "iam_for_lambda", - assume_role_policy=Token.as_string(assume_role.json), - name="iam_for_lambda" - ) - LambdaFunction(self, "test_lambda", + LambdaFunction(self, "example", ephemeral_storage=LambdaFunctionEphemeralStorage( - size=10240 + size=5120 + ), + filename="function.zip", + function_name="example_vpc_function", + handler="app.handler", + memory_size=1024, + role=Token.as_string(aws_iam_role_example.arn), + runtime="python3.12", + snap_start=LambdaFunctionSnapStart( + apply_on="PublishedVersions" ), - filename="lambda_function_payload.zip", - function_name="lambda_function_name", - handler="index.test", - role=iam_for_lambda.arn, - runtime="nodejs18.x" + timeout=30, + vpc_config=LambdaFunctionVpcConfig( + ipv6_allowed_for_dual_stack=True, + security_group_ids=[example_lambda.id], + subnet_ids=[example_private1.id, example_private2.id] + ) ) ``` -### Lambda File Systems - -Lambda File Systems allow you to connect an Amazon Elastic File System (EFS) file system to a Lambda function to share data across function invocations, access existing data including large files, and save function state. +### Function with EFS Integration ```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 +from cdktf import VariableType, TerraformVariable, Fn, Token, TerraformCount, TerraformStack # # Provider bindings are generated by running `cdktf get`. # See https://cdk.tf/provider-generation for more details. @@ -171,20 +205,38 @@ from imports.aws.efs_file_system import EfsFileSystem from imports.aws.efs_mount_target import EfsMountTarget from imports.aws.lambda_function import LambdaFunction class MyConvertedCode(TerraformStack): - def __init__(self, scope, name, *, functionName, role): + def __init__(self, scope, name): super().__init__(scope, name) - efs_for_lambda = EfsFileSystem(self, "efs_for_lambda", + # Terraform Variables are not always the best fit for getting inputs in the context of Terraform CDK. + # You can read more about this at https://cdk.tf/variables + subnet_ids = TerraformVariable(self, "subnet_ids", + default=["subnet-12345678", "subnet-87654321"], + description="List of subnet IDs for EFS mount targets", + type=VariableType.list(VariableType.STRING) + ) + example = EfsFileSystem(self, "example", + encrypted=True, tags={ - "Name": "efs_for_lambda" + "Name": "lambda-efs" } ) - alpha = EfsMountTarget(self, "alpha", - file_system_id=efs_for_lambda.id, - security_groups=[sg_for_lambda.id], - subnet_id=subnet_for_lambda.id + # In most cases loops should be handled in the programming language context and + # not inside of the Terraform context. If you are looping over something external, e.g. a variable or a file input + # you should consider using a for loop. If you are looping over something only known to Terraform, e.g. a result of a data source + # you need to keep this like it is. + example_count = TerraformCount.of( + Token.as_number(Fn.length_of(subnet_ids.value))) + aws_efs_mount_target_example = EfsMountTarget(self, "example_2", + file_system_id=example.id, + security_groups=[efs.id], + subnet_id=Token.as_string( + Fn.lookup_nested(subnet_ids.value, [example_count.index])), + count=example_count ) - access_point_for_lambda = EfsAccessPoint(self, "access_point_for_lambda", - file_system_id=efs_for_lambda.id, + # 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_efs_mount_target_example.override_logical_id("example") + aws_efs_access_point_example = EfsAccessPoint(self, "example_3", + file_system_id=example.id, posix_user=EfsAccessPointPosixUser( gid=1000, uid=1000 @@ -193,93 +245,313 @@ class MyConvertedCode(TerraformStack): creation_info=EfsAccessPointRootDirectoryCreationInfo( owner_gid=1000, owner_uid=1000, - permissions="777" + permissions="755" ), path="/lambda" ) ) - LambdaFunction(self, "example", - depends_on=[alpha], + # 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_efs_access_point_example.override_logical_id("example") + aws_lambda_function_example = LambdaFunction(self, "example_4", + depends_on=[aws_efs_mount_target_example], file_system_config=LambdaFunctionFileSystemConfig( - arn=access_point_for_lambda.arn, - local_mount_path="/mnt/efs" + arn=Token.as_string(aws_efs_access_point_example.arn), + local_mount_path="/mnt/data" ), + filename="function.zip", + function_name="example_efs_function", + handler="index.handler", + role=Token.as_string(aws_iam_role_example.arn), + runtime="nodejs20.x", vpc_config=LambdaFunctionVpcConfig( - security_group_ids=[sg_for_lambda.id], - subnet_ids=[subnet_for_lambda.id] + security_group_ids=[lambda_.id], + subnet_ids=subnet_ids.list_value + ) + ) + # 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_lambda_function_example.override_logical_id("example") +``` + +### Function with Advanced Logging + +```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.cloudwatch_log_group import CloudwatchLogGroup +from imports.aws.lambda_function import LambdaFunction +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + example = CloudwatchLogGroup(self, "example", + name="/aws/lambda/example_function", + retention_in_days=14, + tags={ + "Application": "example", + "Environment": "production" + } + ) + aws_lambda_function_example = LambdaFunction(self, "example_1", + depends_on=[example], + filename="function.zip", + function_name="example_function", + handler="index.handler", + logging_config=LambdaFunctionLoggingConfig( + application_log_level="INFO", + log_format="JSON", + system_log_level="WARN" ), - function_name=function_name, - role=role + role=Token.as_string(aws_iam_role_example.arn), + runtime="nodejs20.x" ) + # 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_lambda_function_example.override_logical_id("example") ``` -### Lambda retries +### Function with logging to S3 or Data Firehose + +#### Required Resources + +* An S3 bucket or Data Firehose delivery stream to store the logs. +* A CloudWatch Log Group with: + + * `log_group_class = "DELIVERY"` + * A subscription filter whose `destination_arn` points to the S3 bucket or the Data Firehose delivery stream. -Lambda Functions allow you to configure error handling for asynchronous invocation. The settings that it supports are `Maximum age of event` and `Retry attempts` as stated in [Lambda documentation for Configuring error handling for asynchronous invocation](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#invocation-async-errors). To configure these settings, refer to the [aws_lambda_function_event_invoke_config resource](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/lambda_function_event_invoke_config). +* IAM roles: -## CloudWatch Logging and Permissions + * Assumed by the `logs.amazonaws.com` service to deliver logs to the S3 bucket or Data Firehose delivery stream. + * Assumed by the `lambda.amazonaws.com` service to send logs to CloudWatch Logs -For more information about CloudWatch Logs for Lambda, see the [Lambda User Guide](https://docs.aws.amazon.com/lambda/latest/dg/monitoring-functions-logs.html). +* A Lambda function: + + * In the `logging_configuration`, specify the name of the Log Group created above using the `log_group` field + * No special configuration is required to use S3 or Firehose as the log destination + +For more details, see [Sending Lambda function logs to Amazon S3](https://docs.aws.amazon.com/lambda/latest/dg/logging-with-s3.html). + +#### Example: Exporting Lambda Logs to S3 Bucket ```python # DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug from constructs import Construct -from cdktf import TerraformVariable, Token, TerraformStack +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.cloudwatch_log_group import CloudwatchLogGroup +from imports.aws.cloudwatch_log_subscription_filter import CloudwatchLogSubscriptionFilter from imports.aws.data_aws_iam_policy_document import DataAwsIamPolicyDocument -from imports.aws.iam_policy import IamPolicy -from imports.aws.iam_role_policy_attachment import IamRolePolicyAttachment +from imports.aws.iam_role import IamRole +from imports.aws.iam_role_policy import IamRolePolicy from imports.aws.lambda_function import LambdaFunction +from imports.aws.s3_bucket import S3Bucket class MyConvertedCode(TerraformStack): - def __init__(self, scope, name, *, role): + def __init__(self, scope, name): super().__init__(scope, name) - # Terraform Variables are not always the best fit for getting inputs in the context of Terraform CDK. - # You can read more about this at https://cdk.tf/variables - lambda_function_name = TerraformVariable(self, "lambda_function_name", - default="lambda_function_name" + lambda_function_name = "lambda-log-export-example" + export_var = CloudwatchLogGroup(self, "export", + log_group_class="DELIVERY", + name="/aws/lambda/${" + lambda_function_name + "}" ) - example = CloudwatchLogGroup(self, "example", - name="/aws/lambda/${" + lambda_function_name.value + "}", - retention_in_days=14 + LambdaFunction(self, "log_export", + depends_on=[export_var], + filename="function.zip", + function_name=lambda_function_name, + handler="index.lambda_handler", + logging_config=LambdaFunctionLoggingConfig( + log_format="Text", + log_group=export_var.name + ), + role=example.arn, + runtime="python3.13" + ) + lambda_log_export = S3Bucket(self, "lambda_log_export", + bucket="${" + lambda_function_name + "}-bucket" ) - lambda_logging = DataAwsIamPolicyDocument(self, "lambda_logging", + data_aws_iam_policy_document_lambda_log_export = + DataAwsIamPolicyDocument(self, "lambda_log_export_3", statement=[DataAwsIamPolicyDocumentStatement( - actions=["logs:CreateLogGroup", "logs:CreateLogStream", "logs:PutLogEvents" - ], + actions=["s3:PutObject"], effect="Allow", - resources=["arn:aws:logs:*:*:*"] + resources=["${" + lambda_log_export.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. + data_aws_iam_policy_document_lambda_log_export.override_logical_id("lambda_log_export") + logs_assume_role = DataAwsIamPolicyDocument(self, "logs_assume_role", + statement=[DataAwsIamPolicyDocumentStatement( + actions=["sts:AssumeRole"], + effect="Allow", + principals=[DataAwsIamPolicyDocumentStatementPrincipals( + identifiers=["logs.amazonaws.com"], + type="Service" + ) + ] ) ] ) - aws_iam_policy_lambda_logging = IamPolicy(self, "lambda_logging_3", - description="IAM policy for logging from a lambda", + logs_log_export = IamRole(self, "logs_log_export", + assume_role_policy=Token.as_string(logs_assume_role.json), + name="${" + lambda_function_name + "}-lambda-log-export-role" + ) + aws_iam_role_policy_lambda_log_export = IamRolePolicy(self, "lambda_log_export_6", + policy=Token.as_string(data_aws_iam_policy_document_lambda_log_export.json), + role=logs_log_export.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. + aws_iam_role_policy_lambda_log_export.override_logical_id("lambda_log_export") + aws_cloudwatch_log_subscription_filter_lambda_log_export = + CloudwatchLogSubscriptionFilter(self, "lambda_log_export_7", + destination_arn=lambda_log_export.arn, + filter_pattern="", + log_group_name=export_var.name, + name="${" + lambda_function_name + "}-filter", + role_arn=logs_log_export.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_cloudwatch_log_subscription_filter_lambda_log_export.override_logical_id("lambda_log_export") +``` + +### Function with Error Handling + +```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.lambda_function import LambdaFunction +from imports.aws.lambda_function_event_invoke_config import LambdaFunctionEventInvokeConfig +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + example = LambdaFunction(self, "example", + dead_letter_config=LambdaFunctionDeadLetterConfig( + target_arn=dlq.arn + ), + filename="function.zip", + function_name="example_function", + handler="index.handler", + role=Token.as_string(aws_iam_role_example.arn), + runtime="nodejs20.x" + ) + aws_lambda_function_event_invoke_config_example = + LambdaFunctionEventInvokeConfig(self, "example_1", + destination_config=LambdaFunctionEventInvokeConfigDestinationConfig( + on_failure=LambdaFunctionEventInvokeConfigDestinationConfigOnFailure( + destination=dlq.arn + ), + on_success=LambdaFunctionEventInvokeConfigDestinationConfigOnSuccess( + destination=success.arn + ) + ), + function_name=example.function_name, + maximum_event_age_in_seconds=60, + maximum_retry_attempts=2 + ) + # 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_lambda_function_event_invoke_config_example.override_logical_id("example") +``` + +### CloudWatch Logging and Permissions + +```python +# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +from constructs import Construct +from cdktf import VariableType, TerraformVariable, Fn, Token, TerraformStack +# +# Provider bindings are generated by running `cdktf get`. +# See https://cdk.tf/provider-generation for more details. +# +from imports.aws.cloudwatch_log_group import CloudwatchLogGroup +from imports.aws.iam_policy import IamPolicy +from imports.aws.iam_role import IamRole +from imports.aws.iam_role_policy_attachment import IamRolePolicyAttachment +from imports.aws.lambda_function import LambdaFunction +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + # Terraform Variables are not always the best fit for getting inputs in the context of Terraform CDK. + # You can read more about this at https://cdk.tf/variables + function_name = TerraformVariable(self, "function_name", + default="example_function", + description="Name of the Lambda function", + type=VariableType.STRING + ) + example = CloudwatchLogGroup(self, "example", + name="/aws/lambda/${" + function_name.value + "}", + retention_in_days=14, + tags={ + "Environment": "production", + "Function": function_name.string_value + } + ) + lambda_logging = IamPolicy(self, "lambda_logging", + description="IAM policy for logging from Lambda", name="lambda_logging", path="/", - policy=Token.as_string(lambda_logging.json) + policy=Token.as_string( + Fn.jsonencode({ + "Statement": [{ + "Action": ["logs:CreateLogGroup", "logs:CreateLogStream", "logs:PutLogEvents" + ], + "Effect": "Allow", + "Resource": ["arn:aws:logs:*:*:*"] + } + ], + "Version": "2012-10-17" + })) + ) + aws_iam_role_example = IamRole(self, "example_3", + assume_role_policy=Token.as_string( + Fn.jsonencode({ + "Statement": [{ + "Action": "sts:AssumeRole", + "Effect": "Allow", + "Principal": { + "Service": "lambda.amazonaws.com" + } + } + ], + "Version": "2012-10-17" + })), + name="lambda_execution_role" ) # 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_iam_policy_lambda_logging.override_logical_id("lambda_logging") + aws_iam_role_example.override_logical_id("example") lambda_logs = IamRolePolicyAttachment(self, "lambda_logs", - policy_arn=Token.as_string(aws_iam_policy_lambda_logging.arn), - role=iam_for_lambda.name + policy_arn=lambda_logging.arn, + role=Token.as_string(aws_iam_role_example.name) ) - LambdaFunction(self, "test_lambda", + aws_lambda_function_example = LambdaFunction(self, "example_5", depends_on=[lambda_logs, example], - function_name=lambda_function_name.string_value, + filename="function.zip", + function_name=function_name.string_value, + handler="index.handler", logging_config=LambdaFunctionLoggingConfig( - log_format="Text" + application_log_level="INFO", + log_format="JSON", + system_log_level="WARN" ), - role=role + role=Token.as_string(aws_iam_role_example.arn), + runtime="nodejs20.x" ) + # 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_lambda_function_example.override_logical_id("example") ``` ## Specifying the Deployment Package -AWS Lambda expects source code to be provided as a deployment package whose structure varies depending on which `runtime` is in use. See [Runtimes][6] for the valid values of `runtime`. The expected structure of the deployment package can be found in [the AWS Lambda documentation for each runtime][8]. +AWS Lambda expects source code to be provided as a deployment package whose structure varies depending on which `runtime` is in use. See [Runtimes](https://docs.aws.amazon.com/lambda/latest/dg/API_CreateFunction.html#SSS-CreateFunction-request-Runtime) for the valid values of `runtime`. The expected structure of the deployment package can be found in [the AWS Lambda documentation for each runtime](https://docs.aws.amazon.com/lambda/latest/dg/deployment-package-v2.html). Once you have created your deployment package you can specify it either directly as a local file (using the `filename` argument) or indirectly via Amazon S3 (using the `s3_bucket`, `s3_key` and `s3_object_version` arguments). When providing the deployment package via S3 it may be useful to use [the `aws_s3_object` resource](s3_object.html) to upload it. @@ -290,102 +562,85 @@ For larger deployment packages it is recommended by Amazon to upload via S3, sin The following arguments are required: * `function_name` - (Required) Unique name for your Lambda Function. -* `role` - (Required) Amazon Resource Name (ARN) of the function's execution role. The role provides the function's identity and access to AWS services and resources. +* `role` - (Required) ARN of the function's execution role. The role provides the function's identity and access to AWS services and resources. The following arguments are optional: -* `architectures` - (Optional) Instruction set architecture for your Lambda function. Valid values are `["x86_64"]` and `["arm64"]`. Default is `["x86_64"]`. Removing this attribute, function's architecture stay the same. -* `code_signing_config_arn` - (Optional) To enable code signing for this function, specify the ARN of a code-signing configuration. A code-signing configuration includes a set of signing profiles, which define the trusted publishers for this function. -* `dead_letter_config` - (Optional) Configuration block. Detailed below. +* `architectures` - (Optional) Instruction set architecture for your Lambda function. Valid values are `["x86_64"]` and `["arm64"]`. Default is `["x86_64"]`. Removing this attribute, function's architecture stays the same. +* `code_signing_config_arn` - (Optional) ARN of a code-signing configuration to enable code signing for this function. +* `dead_letter_config` - (Optional) Configuration block for dead letter queue. [See below](#dead_letter_config-configuration-block). * `description` - (Optional) Description of what your Lambda Function does. -* `environment` - (Optional) Configuration block. Detailed below. -* `ephemeral_storage` - (Optional) The amount of Ephemeral storage(`/tmp`) to allocate for the Lambda Function in MB. This parameter is used to expand the total amount of Ephemeral storage available, beyond the default amount of `512`MB. Detailed below. -* `file_system_config` - (Optional) Configuration block. Detailed below. -* `filename` - (Optional) Path to the function's deployment package within the local filesystem. Exactly one of `filename`, `image_uri`, or `s3_bucket` must be specified. -* `handler` - (Optional) Function [entrypoint][3] in your code. -* `image_config` - (Optional) Configuration block. Detailed below. -* `image_uri` - (Optional) ECR image URI containing the function's deployment package. Exactly one of `filename`, `image_uri`, or `s3_bucket` must be specified. -* `kms_key_arn` - (Optional) Amazon Resource Name (ARN) of the AWS Key Management Service (KMS) key that is used to encrypt environment variables. If this configuration is not provided when environment variables are in use, AWS Lambda uses a default service key. If this configuration is provided when environment variables are not in use, the AWS Lambda API does not save this configuration and Terraform will show a perpetual difference of adding the key. To fix the perpetual difference, remove this configuration. -* `layers` - (Optional) List of Lambda Layer Version ARNs (maximum of 5) to attach to your Lambda Function. See [Lambda Layers][10] -* `logging_config` - (Optional) Configuration block used to specify advanced logging settings. Detailed below. -* `memory_size` - (Optional) Amount of memory in MB your Lambda Function can use at runtime. Defaults to `128`. See [Limits][5] +* `environment` - (Optional) Configuration block for environment variables. [See below](#environment-configuration-block). +* `ephemeral_storage` - (Optional) Amount of ephemeral storage (`/tmp`) to allocate for the Lambda Function. [See below](#ephemeral_storage-configuration-block). +* `file_system_config` - (Optional) Configuration block for EFS file system. [See below](#file_system_config-configuration-block). +* `filename` - (Optional) Path to the function's deployment package within the local filesystem. Conflicts with `image_uri` and `s3_bucket`. One of `filename`, `image_uri`, or `s3_bucket` must be specified. +* `handler` - (Optional) Function entry point in your code. Required if `package_type` is `Zip`. +* `image_config` - (Optional) Container image configuration values. [See below](#image_config-configuration-block). +* `image_uri` - (Optional) ECR image URI containing the function's deployment package. Conflicts with `filename` and `s3_bucket`. One of `filename`, `image_uri`, or `s3_bucket` must be specified. +* `kms_key_arn` - (Optional) ARN of the AWS Key Management Service key used to encrypt environment variables. If not provided when environment variables are in use, AWS Lambda uses a default service key. If provided when environment variables are not in use, the AWS Lambda API does not save this configuration. +* `layers` - (Optional) List of Lambda Layer Version ARNs (maximum of 5) to attach to your Lambda Function. +* `logging_config` - (Optional) Configuration block for advanced logging settings. [See below](#logging_config-configuration-block). +* `memory_size` - (Optional) Amount of memory in MB your Lambda Function can use at runtime. Valid value between 128 MB to 10,240 MB (10 GB), in 1 MB increments. Defaults to 128. * `package_type` - (Optional) Lambda deployment package type. Valid values are `Zip` and `Image`. Defaults to `Zip`. * `publish` - (Optional) Whether to publish creation/change as new Lambda Function Version. Defaults to `false`. -* `reserved_concurrent_executions` - (Optional) Amount of reserved concurrent executions for this lambda function. A value of `0` disables lambda from being triggered and `-1` removes any concurrency limitations. Defaults to Unreserved Concurrency Limits `-1`. See [Managing Concurrency][9] -* `replace_security_groups_on_destroy` - (Optional) Whether to replace the security groups on the function's VPC configuration prior to destruction. -Removing these security group associations prior to function destruction can speed up security group deletion times of AWS's internal cleanup operations. -By default, the security groups will be replaced with the `default` security group in the function's configured VPC. -Set the `replacement_security_group_ids` attribute to use a custom list of security groups for replacement. -* `replacement_security_group_ids` - (Optional) List of security group IDs to assign to the function's VPC configuration prior to destruction. -`replace_security_groups_on_destroy` must be set to `true` to use this attribute. -* `runtime` - (Optional) Identifier of the function's runtime. See [Runtimes][6] for valid values. -* `s3_bucket` - (Optional) S3 bucket location containing the function's deployment package. This bucket must reside in the same AWS region where you are creating the Lambda function. Exactly one of `filename`, `image_uri`, or `s3_bucket` must be specified. When `s3_bucket` is set, `s3_key` is required. -* `s3_key` - (Optional) S3 key of an object containing the function's deployment package. When `s3_bucket` is set, `s3_key` is required. +* `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). +* `replace_security_groups_on_destroy` - (Optional) Whether to replace the security groups on the function's VPC configuration prior to destruction. Default is `false`. +* `replacement_security_group_ids` - (Optional) List of security group IDs to assign to the function's VPC configuration prior to destruction. Required if `replace_security_groups_on_destroy` is `true`. +* `reserved_concurrent_executions` - (Optional) Amount of reserved concurrent executions for this lambda function. A value of `0` disables lambda from being triggered and `-1` removes any concurrency limitations. Defaults to Unreserved Concurrency Limits `-1`. +* `runtime` - (Optional) Identifier of the function's runtime. Required if `package_type` is `Zip`. See [Runtimes](https://docs.aws.amazon.com/lambda/latest/dg/API_CreateFunction.html#SSS-CreateFunction-request-Runtime) for valid values. +* `s3_bucket` - (Optional) S3 bucket location containing the function's deployment package. Conflicts with `filename` and `image_uri`. One of `filename`, `image_uri`, or `s3_bucket` must be specified. +* `s3_key` - (Optional) S3 key of an object containing the function's deployment package. Required if `s3_bucket` is set. * `s3_object_version` - (Optional) Object version containing the function's deployment package. Conflicts with `filename` and `image_uri`. -* `skip_destroy` - (Optional) Set to true if you do not wish the function to be deleted at destroy time, and instead just remove the function from the Terraform state. -* `source_code_hash` - (Optional) Virtual attribute used to trigger replacement when source code changes. Must be set to a base64-encoded SHA256 hash of the package file specified with either `filename` or `s3_key`. The usual way to set this is `filebase64sha256("file.zip")` (Terraform 0.11.12 and later) or `base64sha256(file("file.zip"))` (Terraform 0.11.11 and earlier), where "file.zip" is the local filename of the lambda function source archive. -* `snap_start` - (Optional) Snap start settings block. Detailed below. -* `tags` - (Optional) Map of tags to assign to the object. 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) Amount of time your Lambda Function has to run in seconds. Defaults to `3`. See [Limits][5]. -* `tracing_config` - (Optional) Configuration block. Detailed below. -* `vpc_config` - (Optional) Configuration block. Detailed below. - -### dead_letter_config - -Dead letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing. For more information, see [Dead Letter Queues](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#dlq). - -* `target_arn` - (Required) ARN of an SNS topic or SQS queue to notify when an invocation fails. If this option is used, the function's IAM role must be granted suitable access to write to the target object, which means allowing either the `sns:Publish` or `sqs:SendMessage` action on this ARN, depending on which service is targeted. +* `skip_destroy` - (Optional) Whether to retain the old version of a previously deployed Lambda Layer. Default is `false`. +* `snap_start` - (Optional) Configuration block for snap start settings. [See below](#snap_start-configuration-block). +* `source_code_hash` - (Optional) Base64-encoded SHA256 hash of the package file. Used to trigger updates when source code changes. +* `source_kms_key_arn` - (Optional) ARN of the AWS Key Management Service key used to encrypt the function's `.zip` deployment package. Conflicts with `image_uri`. +* `tags` - (Optional) Key-value map of tags for the Lambda function. 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) Amount of time your Lambda Function has to run in seconds. Defaults to 3. Valid between 1 and 900. +* `tracing_config` - (Optional) Configuration block for X-Ray tracing. [See below](#tracing_config-configuration-block). +* `vpc_config` - (Optional) Configuration block for VPC. [See below](#vpc_config-configuration-block). -### environment +### dead_letter_config Configuration Block -* `variables` - (Optional) Map of environment variables that are accessible from the function code during execution. If provided at least one key must be present. +* `target_arn` - (Required) ARN of an SNS topic or SQS queue to notify when an invocation fails. -### ephemeral_storage +### environment Configuration Block -* `size` - (Required) The size of the Lambda function Ephemeral storage(`/tmp`) represented in MB. The minimum supported `ephemeral_storage` value defaults to `512`MB and the maximum supported value is `10240`MB. +* `variables` - (Optional) Map of environment variables available to your Lambda function during execution. -### file_system_config +### ephemeral_storage Configuration Block -Connection settings for an EFS file system. Before creating or updating Lambda functions with `file_system_config`, EFS mount targets must be in available lifecycle state. Use `depends_on` to explicitly declare this dependency. See [Using Amazon EFS with Lambda][12]. +* `size` - (Required) Amount of ephemeral storage (`/tmp`) in MB. Valid between 512 MB and 10,240 MB (10 GB). -* `arn` - (Required) Amazon Resource Name (ARN) of the Amazon EFS Access Point that provides access to the file system. -* `local_mount_path` - (Required) Path where the function can access the file system, starting with /mnt/. +### file_system_config Configuration Block -### image_config +* `arn` - (Required) ARN of the Amazon EFS Access Point. +* `local_mount_path` - (Required) Path where the function can access the file system. Must start with `/mnt/`. -Container image configuration values that override the values in the container image Dockerfile. +### image_config Configuration Block -* `command` - (Optional) Parameters that you want to pass in with `entry_point`. -* `entry_point` - (Optional) Entry point to your application, which is typically the location of the runtime executable. -* `working_directory` - (Optional) Working directory. +* `command` - (Optional) Parameters to pass to the container image. +* `entry_point` - (Optional) Entry point to your application. +* `working_directory` - (Optional) Working directory for the container image. -### logging_config +### logging_config Configuration Block -Advanced logging settings. See [Configuring advanced logging controls for your Lambda function][13]. +* `application_log_level` - (Optional) Detail level of application logs. Valid values: `TRACE`, `DEBUG`, `INFO`, `WARN`, `ERROR`, `FATAL`. +* `log_format` - (Required) Log format. Valid values: `Text`, `JSON`. +* `log_group` - (Optional) CloudWatch log group where logs are sent. +* `system_log_level` - (Optional) Detail level of Lambda platform logs. Valid values: `DEBUG`, `INFO`, `WARN`. -* `application_log_level` - (Optional) for JSON structured logs, choose the detail level of the logs your application sends to CloudWatch when using supported logging libraries. -* `log_format` - (Required) select between `Text` and structured `JSON` format for your function's logs. -* `log_group` - (Optional) the CloudWatch log group your function sends logs to. -* `system_log_level` - (optional) for JSON structured logs, choose the detail level of the Lambda platform event logs sent to CloudWatch, such as `WARN`, `DEBUG`, or `INFO`. +### snap_start Configuration Block -### snap_start +* `apply_on` - (Required) When to apply snap start optimization. Valid value: `PublishedVersions`. -Snap start settings for low-latency startups. This feature is currently only supported for specific runtimes, see [Supported features and limitations][14]. -Remove this block to delete the associated settings (rather than setting `apply_on = "None"`). +### tracing_config Configuration Block -* `apply_on` - (Required) Conditions where snap start is enabled. Valid values are `PublishedVersions`. +* `mode` - (Required) X-Ray tracing mode. Valid values: `Active`, `PassThrough`. -### tracing_config +### vpc_config Configuration Block -* `mode` - (Required) Whether to sample and trace a subset of incoming requests with AWS X-Ray. Valid values are `PassThrough` and `Active`. If `PassThrough`, Lambda will only trace the request from an upstream service if it contains a tracing header with "sampled=1". If `Active`, Lambda will respect any tracing header it receives from an upstream service. If no tracing header is received, Lambda will call X-Ray for a tracing decision. - -### vpc_config - -For network connectivity to AWS resources in a VPC, specify a list of security groups and subnets in the VPC. When you connect a function to a VPC, it can only access resources and the internet through that VPC. See [VPC Settings][7]. - -~> **NOTE:** If `subnet_ids`, `security_group_ids` and `ipv6_allowed_for_dual_stack` are empty then `vpc_config` is considered to be empty or unset. - -* `ipv6_allowed_for_dual_stack` - (Optional) Allows outbound IPv6 traffic on VPC functions that are connected to dual-stack subnets. Default is `false`. +* `ipv6_allowed_for_dual_stack` - (Optional) Whether to allow outbound IPv6 traffic on VPC functions connected to dual-stack subnets. Default: `false`. * `security_group_ids` - (Required) List of security group IDs associated with the Lambda function. * `subnet_ids` - (Required) List of subnet IDs associated with the Lambda function. @@ -393,34 +648,20 @@ For network connectivity to AWS resources in a VPC, specify a list of security g This resource exports the following attributes in addition to the arguments above: -* `arn` - Amazon Resource Name (ARN) identifying your Lambda Function. +* `arn` - ARN identifying your Lambda Function. * `code_sha256` - Base64-encoded representation of raw SHA-256 sum of the zip file. -* `invoke_arn` - ARN to be used for invoking Lambda Function from API Gateway - to be used in [`aws_api_gateway_integration`](/docs/providers/aws/r/api_gateway_integration.html)'s `uri`. +* `invoke_arn` - ARN to be used for invoking Lambda Function from API Gateway - to be used in [`aws_api_gateway_integration`](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/api_gateway_integration)'s `uri`. * `last_modified` - Date this resource was last modified. * `qualified_arn` - ARN identifying your Lambda Function Version (if versioning is enabled via `publish = true`). -* `qualified_invoke_arn` - Qualified ARN (ARN with lambda version number) to be used for invoking Lambda Function from API Gateway - to be used in [`aws_api_gateway_integration`](/docs/providers/aws/r/api_gateway_integration.html)'s `uri`. +* `qualified_invoke_arn` - Qualified ARN (ARN with lambda version number) to be used for invoking Lambda Function from API Gateway - to be used in [`aws_api_gateway_integration`](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/api_gateway_integration)'s `uri`. * `signing_job_arn` - ARN of the signing job. * `signing_profile_version_arn` - ARN of the signing profile version. * `snap_start.optimization_status` - Optimization status of the snap start configuration. Valid values are `On` and `Off`. * `source_code_size` - Size in bytes of the function .zip file. -* `tags_all` - A map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). +* `tags_all` - Map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). * `version` - Latest published version of your Lambda Function. * `vpc_config.vpc_id` - ID of the VPC. -[1]: https://docs.aws.amazon.com/lambda/latest/dg/welcome.html -[3]: https://docs.aws.amazon.com/lambda/latest/dg/walkthrough-custom-events-create-test-function.html -[4]: https://docs.aws.amazon.com/lambda/latest/dg/intro-permission-model.html -[5]: https://docs.aws.amazon.com/lambda/latest/dg/limits.html -[6]: https://docs.aws.amazon.com/lambda/latest/dg/API_CreateFunction.html#SSS-CreateFunction-request-Runtime -[7]: https://docs.aws.amazon.com/lambda/latest/dg/configuration-vpc.html -[8]: https://docs.aws.amazon.com/lambda/latest/dg/deployment-package-v2.html -[9]: https://docs.aws.amazon.com/lambda/latest/dg/concurrent-executions.html -[10]: https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html -[11]: https://learn.hashicorp.com/terraform/aws/lambda-api-gateway -[12]: https://docs.aws.amazon.com/lambda/latest/dg/services-efs.html -[13]: https://docs.aws.amazon.com/lambda/latest/dg/monitoring-cloudwatchlogs.html#monitoring-cloudwatchlogs-advanced -[14]: https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html#snapstart-runtimes - ## Timeouts [Configuration options](https://developer.hashicorp.com/terraform/language/resources/syntax#operation-timeouts): @@ -445,13 +686,13 @@ from imports.aws.lambda_function import LambdaFunction class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) - LambdaFunction.generate_config_for_import(self, "testLambda", "my_test_lambda_function") + LambdaFunction.generate_config_for_import(self, "example", "example") ``` Using `terraform import`, import Lambda Functions using the `function_name`. For example: ```console -% terraform import aws_lambda_function.test_lambda my_test_lambda_function +% terraform import aws_lambda_function.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/lambda_function_event_invoke_config.html.markdown b/website/docs/cdktf/python/r/lambda_function_event_invoke_config.html.markdown index df585ea7f62d..350db990c417 100644 --- a/website/docs/cdktf/python/r/lambda_function_event_invoke_config.html.markdown +++ b/website/docs/cdktf/python/r/lambda_function_event_invoke_config.html.markdown @@ -3,20 +3,22 @@ subcategory: "Lambda" layout: "aws" page_title: "AWS: aws_lambda_function_event_invoke_config" description: |- - Manages an asynchronous invocation configuration for a Lambda Function or Alias. + Manages an AWS Lambda Function Event Invoke Config. --- # Resource: aws_lambda_function_event_invoke_config -Manages an asynchronous invocation configuration for a Lambda Function or Alias. More information about asynchronous invocations and the configurable values can be found in the [Lambda Developer Guide](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html). +Manages an AWS Lambda Function Event Invoke Config. Use this resource to configure error handling and destinations for asynchronous Lambda function invocations. + +More information about asynchronous invocations and the configurable values can be found in the [Lambda Developer Guide](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html). ## Example Usage -### Destination Configuration +### Complete Error Handling and Destinations -~> **NOTE:** Ensure the Lambda Function IAM Role has necessary permissions for the destination, such as `sqs:SendMessage` or `sns:Publish`, otherwise the API will return a generic `InvalidParameterValueException: The destination ARN arn:PARTITION:SERVICE:REGION:ACCOUNT:RESOURCE is invalid.` error. +~> **Note:** Ensure the Lambda Function IAM Role has necessary permissions for the destination, such as `sqs:SendMessage` or `sns:Publish`, otherwise the API will return a generic `InvalidParameterValueException: The destination ARN arn:PARTITION:SERVICE:REGION:ACCOUNT:RESOURCE is invalid.` error. ```python # DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -27,23 +29,41 @@ from cdktf import Token, TerraformStack # See https://cdk.tf/provider-generation for more details. # from imports.aws.lambda_function_event_invoke_config import LambdaFunctionEventInvokeConfig +from imports.aws.sns_topic import SnsTopic +from imports.aws.sqs_queue import SqsQueue class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) + success = SnsTopic(self, "success", + name="lambda-success-notifications", + tags={ + "Environment": "production", + "Purpose": "lambda-success-notifications" + } + ) + dlq = SqsQueue(self, "dlq", + name="lambda-dlq", + tags={ + "Environment": "production", + "Purpose": "lambda-error-handling" + } + ) LambdaFunctionEventInvokeConfig(self, "example", destination_config=LambdaFunctionEventInvokeConfigDestinationConfig( on_failure=LambdaFunctionEventInvokeConfigDestinationConfigOnFailure( - destination=Token.as_string(aws_sqs_queue_example.arn) + destination=dlq.arn ), on_success=LambdaFunctionEventInvokeConfigDestinationConfigOnSuccess( - destination=Token.as_string(aws_sns_topic_example.arn) + destination=success.arn ) ), - function_name=Token.as_string(aws_lambda_alias_example.function_name) + function_name=Token.as_string(aws_lambda_function_example.function_name), + maximum_event_age_in_seconds=300, + maximum_retry_attempts=1 ) ``` -### Error Handling Configuration +### Error Handling Only ```python # DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -58,13 +78,50 @@ class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) LambdaFunctionEventInvokeConfig(self, "example", - function_name=Token.as_string(aws_lambda_alias_example.function_name), + function_name=Token.as_string(aws_lambda_function_example.function_name), maximum_event_age_in_seconds=60, maximum_retry_attempts=0 ) ``` -### Configuration for Alias Name +### Configuration for Lambda Alias + +```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.lambda_alias import LambdaAlias +from imports.aws.lambda_function_event_invoke_config import LambdaFunctionEventInvokeConfig +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + example = LambdaAlias(self, "example", + description="Production alias", + function_name=Token.as_string(aws_lambda_function_example.function_name), + function_version=Token.as_string(aws_lambda_function_example.version), + name="production" + ) + aws_lambda_function_event_invoke_config_example = + LambdaFunctionEventInvokeConfig(self, "example_1", + destination_config=LambdaFunctionEventInvokeConfigDestinationConfig( + on_failure=LambdaFunctionEventInvokeConfigDestinationConfigOnFailure( + destination=production_dlq.arn + ) + ), + function_name=Token.as_string(aws_lambda_function_example.function_name), + maximum_event_age_in_seconds=1800, + maximum_retry_attempts=2, + qualifier=example.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. + aws_lambda_function_event_invoke_config_example.override_logical_id("example") +``` + +### Configuration for Published Version ```python # DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -79,12 +136,22 @@ class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) LambdaFunctionEventInvokeConfig(self, "example", - function_name=Token.as_string(aws_lambda_alias_example.function_name), - qualifier=Token.as_string(aws_lambda_alias_example.name) + destination_config=LambdaFunctionEventInvokeConfigDestinationConfig( + on_failure=LambdaFunctionEventInvokeConfigDestinationConfigOnFailure( + destination=version_dlq.arn + ), + on_success=LambdaFunctionEventInvokeConfigDestinationConfigOnSuccess( + destination=version_success.arn + ) + ), + function_name=Token.as_string(aws_lambda_function_example.function_name), + maximum_event_age_in_seconds=21600, + maximum_retry_attempts=2, + qualifier=Token.as_string(aws_lambda_function_example.version) ) ``` -### Configuration for Function Latest Unpublished Version +### Configuration for Latest Version ```python # DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -99,12 +166,19 @@ class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) LambdaFunctionEventInvokeConfig(self, "example", + destination_config=LambdaFunctionEventInvokeConfigDestinationConfig( + on_failure=LambdaFunctionEventInvokeConfigDestinationConfigOnFailure( + destination=dev_dlq.arn + ) + ), function_name=Token.as_string(aws_lambda_function_example.function_name), + maximum_event_age_in_seconds=120, + maximum_retry_attempts=0, qualifier="$LATEST" ) ``` -### Configuration for Function Published Version +### Multiple Destination Types ```python # DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -114,13 +188,28 @@ 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.cloudwatch_event_bus import CloudwatchEventBus from imports.aws.lambda_function_event_invoke_config import LambdaFunctionEventInvokeConfig +from imports.aws.s3_bucket import S3Bucket class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) + lambda_failures = CloudwatchEventBus(self, "lambda_failures", + name="lambda-failure-events" + ) + lambda_success_archive = S3Bucket(self, "lambda_success_archive", + bucket="lambda-success-archive-${" + bucket_suffix.hex + "}" + ) LambdaFunctionEventInvokeConfig(self, "example", - function_name=Token.as_string(aws_lambda_function_example.function_name), - qualifier=Token.as_string(aws_lambda_function_example.version) + destination_config=LambdaFunctionEventInvokeConfigDestinationConfig( + on_failure=LambdaFunctionEventInvokeConfigDestinationConfigOnFailure( + destination=lambda_failures.arn + ), + on_success=LambdaFunctionEventInvokeConfigDestinationConfigOnSuccess( + destination=lambda_success_archive.arn + ) + ), + function_name=Token.as_string(aws_lambda_function_example.function_name) ) ``` @@ -128,45 +217,40 @@ class MyConvertedCode(TerraformStack): The following arguments are required: -* `function_name` - (Required) Name or Amazon Resource Name (ARN) of the Lambda Function, omitting any version or alias qualifier. +* `function_name` - (Required) Name or ARN of the Lambda Function, omitting any version or alias qualifier. The following arguments are optional: -* `destination_config` - (Optional) Configuration block with destination configuration. See below for details. +* `destination_config` - (Optional) Configuration block with destination configuration. [See below](#destination_config-configuration-block). * `maximum_event_age_in_seconds` - (Optional) Maximum age of a request that Lambda sends to a function for processing in seconds. Valid values between 60 and 21600. * `maximum_retry_attempts` - (Optional) Maximum number of times to retry when the function returns an error. Valid values between 0 and 2. Defaults to 2. * `qualifier` - (Optional) Lambda Function published version, `$LATEST`, or Lambda Alias name. +* `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). ### destination_config Configuration Block -~> **NOTE:** At least one of `on_failure` or `on_success` must be configured when using this configuration block, otherwise remove it completely to prevent perpetual differences in Terraform runs. - -The following arguments are optional: +~> **Note:** At least one of `on_failure` or `on_success` must be configured when using this configuration block, otherwise remove it completely to prevent perpetual differences in Terraform runs. -* `on_failure` - (Optional) Configuration block with destination configuration for failed asynchronous invocations. See below for details. -* `on_success` - (Optional) Configuration block with destination configuration for successful asynchronous invocations. See below for details. +* `on_failure` - (Optional) Configuration block with destination configuration for failed asynchronous invocations. [See below](#destination_config-on_failure-configuration-block). +* `on_success` - (Optional) Configuration block with destination configuration for successful asynchronous invocations. [See below](#destination_config-on_success-configuration-block). #### destination_config on_failure Configuration Block -The following arguments are required: - -* `destination` - (Required) Amazon Resource Name (ARN) of the destination resource. See the [Lambda Developer Guide](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#invocation-async-destinations) for acceptable resource types and associated IAM permissions. +* `destination` - (Required) ARN of the destination resource. See the [Lambda Developer Guide](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#invocation-async-destinations) for acceptable resource types and associated IAM permissions. #### destination_config on_success Configuration Block -The following arguments are required: - -* `destination` - (Required) Amazon Resource Name (ARN) of the destination resource. See the [Lambda Developer Guide](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#invocation-async-destinations) for acceptable resource types and associated IAM permissions. +* `destination` - (Required) ARN of the destination resource. See the [Lambda Developer Guide](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#invocation-async-destinations) for acceptable resource types and associated IAM permissions. ## Attribute Reference This resource exports the following attributes in addition to the arguments above: -* `id` - Fully qualified Lambda Function name or Amazon Resource Name (ARN) +* `id` - Fully qualified Lambda Function name or ARN. ## Import -In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import Lambda Function Event Invoke Configs using the fully qualified Function name or Amazon Resource Name (ARN). For example: +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import Lambda Function Event Invoke Configs using the fully qualified Function name or ARN. For example: ARN without qualifier (all versions and aliases): @@ -182,7 +266,7 @@ from imports.aws.lambda_function_event_invoke_config import LambdaFunctionEventI class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) - LambdaFunctionEventInvokeConfig.generate_config_for_import(self, "example", "arn:aws:us-east-1:123456789012:function:my_function") + LambdaFunctionEventInvokeConfig.generate_config_for_import(self, "example", "arn:aws:lambda:us-east-1:123456789012:function:example") ``` ARN with qualifier: @@ -199,7 +283,7 @@ from imports.aws.lambda_function_event_invoke_config import LambdaFunctionEventI class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) - LambdaFunctionEventInvokeConfig.generate_config_for_import(self, "example", "arn:aws:us-east-1:123456789012:function:my_function:production") + LambdaFunctionEventInvokeConfig.generate_config_for_import(self, "example", "arn:aws:lambda:us-east-1:123456789012:function:example:production") ``` Name without qualifier (all versions and aliases): @@ -216,7 +300,7 @@ from imports.aws.lambda_function_event_invoke_config import LambdaFunctionEventI class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) - LambdaFunctionEventInvokeConfig.generate_config_for_import(self, "example", "my_function") + LambdaFunctionEventInvokeConfig.generate_config_for_import(self, "example", "example") ``` Name with qualifier: @@ -233,33 +317,33 @@ from imports.aws.lambda_function_event_invoke_config import LambdaFunctionEventI class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) - LambdaFunctionEventInvokeConfig.generate_config_for_import(self, "example", "my_function:production") + LambdaFunctionEventInvokeConfig.generate_config_for_import(self, "example", "example:production") ``` -**Using `terraform import` to import** Lambda Function Event Invoke Configs using the fully qualified Function name or Amazon Resource Name (ARN). For example: +For backwards compatibility, the following legacy `terraform import` commands are also supported: -ARN without qualifier (all versions and aliases): +Using ARN without qualifier: ```console -% terraform import aws_lambda_function_event_invoke_config.example arn:aws:us-east-1:123456789012:function:my_function +% terraform import aws_lambda_function_event_invoke_config.example arn:aws:lambda:us-east-1:123456789012:function:example ``` -ARN with qualifier: +Using ARN with qualifier: ```console -% terraform import aws_lambda_function_event_invoke_config.example arn:aws:us-east-1:123456789012:function:my_function:production +% terraform import aws_lambda_function_event_invoke_config.example arn:aws:lambda:us-east-1:123456789012:function:example:production ``` Name without qualifier (all versions and aliases): ```console -% terraform import aws_lambda_function_event_invoke_config.example my_function +% terraform import aws_lambda_function_event_invoke_config.example example ``` Name with qualifier: ```console -% terraform import aws_lambda_function_event_invoke_config.example my_function:production +% terraform import aws_lambda_function_event_invoke_config.example example:production ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/lambda_function_recursion_config.html.markdown b/website/docs/cdktf/python/r/lambda_function_recursion_config.html.markdown index 25745a7b68f6..3b68084c67ea 100644 --- a/website/docs/cdktf/python/r/lambda_function_recursion_config.html.markdown +++ b/website/docs/cdktf/python/r/lambda_function_recursion_config.html.markdown @@ -3,19 +3,21 @@ subcategory: "Lambda" layout: "aws" page_title: "AWS: aws_lambda_function_recursion_config" description: |- - Terraform resource for managing an AWS Lambda Function Recursion Config. + Manages an AWS Lambda Function Recursion Config. --- # Resource: aws_lambda_function_recursion_config -Terraform resource for managing an AWS Lambda Function Recursion Config. +Manages an AWS Lambda Function Recursion Config. Use this resource to control how Lambda handles recursive function invocations to prevent infinite loops. -~> Destruction of this resource will return the `recursive_loop` configuration back to the default value of `Terminate`. +~> **Note:** Destruction of this resource will return the `recursive_loop` configuration back to the default value of `Terminate`. ## Example Usage +### Allow Recursive Invocations + ```python # DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug from constructs import Construct @@ -24,30 +26,77 @@ from cdktf import TerraformStack # Provider bindings are generated by running `cdktf get`. # See https://cdk.tf/provider-generation for more details. # +from imports.aws.lambda_function import LambdaFunction from imports.aws.lambda_function_recursion_config import LambdaFunctionRecursionConfig class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) - LambdaFunctionRecursionConfig(self, "example", - function_name="SomeFunction", + example = LambdaFunction(self, "example", + filename="function.zip", + function_name="recursive_processor", + handler="index.handler", + role=lambda_role.arn, + runtime="python3.12" + ) + aws_lambda_function_recursion_config_example = + LambdaFunctionRecursionConfig(self, "example_1", + function_name=example.function_name, recursive_loop="Allow" ) + # 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_lambda_function_recursion_config_example.override_logical_id("example") +``` + +### Production Safety Configuration + +```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.lambda_function import LambdaFunction +from imports.aws.lambda_function_recursion_config import LambdaFunctionRecursionConfig +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + production_processor = LambdaFunction(self, "production_processor", + filename="processor.zip", + function_name="production-data-processor", + handler="app.handler", + role=lambda_role.arn, + runtime="nodejs20.x", + tags={ + "Environment": "production", + "Purpose": "data-processing" + } + ) + LambdaFunctionRecursionConfig(self, "example", + function_name=production_processor.function_name, + recursive_loop="Terminate" + ) ``` ## Argument Reference The following arguments are required: -* `function_name` - (Required) Lambda function name. +* `function_name` - (Required) Name of the Lambda function. * `recursive_loop` - (Required) Lambda function recursion configuration. Valid values are `Allow` or `Terminate`. +The following arguments are optional: + +* `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). + ## 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 AWS Lambda Function Recursion Config using the `function_name`. For example: +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import Lambda Function Recursion Config using the `function_name`. For example: ```python # DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -61,13 +110,13 @@ from imports.aws.lambda_function_recursion_config import LambdaFunctionRecursion class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) - LambdaFunctionRecursionConfig.generate_config_for_import(self, "example", "SomeFunction") + LambdaFunctionRecursionConfig.generate_config_for_import(self, "example", "recursive_processor") ``` -Using `terraform import`, import AWS Lambda Function Recursion Config using the `function_name`. For example: +For backwards compatibility, the following legacy `terraform import` command is also supported: ```console -% terraform import aws_lambda_function_recursion_config.example SomeFunction +% terraform import aws_lambda_function_recursion_config.example recursive_processor ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/lambda_function_url.html.markdown b/website/docs/cdktf/python/r/lambda_function_url.html.markdown index 7cbc1b450f90..3a47d0c31526 100644 --- a/website/docs/cdktf/python/r/lambda_function_url.html.markdown +++ b/website/docs/cdktf/python/r/lambda_function_url.html.markdown @@ -2,24 +2,23 @@ subcategory: "Lambda" layout: "aws" page_title: "AWS: aws_lambda_function_url" -description: |- - Provides a Lambda function URL resource. +description: Manages a Lambda function URL. --- # Resource: aws_lambda_function_url -Provides a Lambda function URL resource. A function URL is a dedicated HTTP(S) endpoint for a Lambda function. - -See the [AWS Lambda documentation](https://docs.aws.amazon.com/lambda/latest/dg/lambda-urls.html) for more information. +Manages a Lambda function URL. Creates a dedicated HTTP(S) endpoint for a Lambda function to enable direct invocation via HTTP requests. ## Example Usage +### Basic Function URL with No Authentication + ```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 +from cdktf import Token, TerraformStack # # Provider bindings are generated by running `cdktf get`. # See https://cdk.tf/provider-generation for more details. @@ -28,53 +27,78 @@ from imports.aws.lambda_function_url import LambdaFunctionUrl class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) - LambdaFunctionUrl(self, "test_latest", + LambdaFunctionUrl(self, "example", authorization_type="NONE", - function_name=test.function_name + function_name=Token.as_string(aws_lambda_function_example.function_name) ) - LambdaFunctionUrl(self, "test_live", +``` + +### Function URL with IAM Authentication and CORS Configuration + +```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.lambda_function_url import LambdaFunctionUrl +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + LambdaFunctionUrl(self, "example", authorization_type="AWS_IAM", cors=LambdaFunctionUrlCors( allow_credentials=True, allow_headers=["date", "keep-alive"], - allow_methods=["*"], - allow_origins=["*"], + allow_methods=["GET", "POST"], + allow_origins=["https://example.com"], expose_headers=["keep-alive", "date"], max_age=86400 ), - function_name=test.function_name, + function_name=Token.as_string(aws_lambda_function_example.function_name), + invoke_mode="RESPONSE_STREAM", qualifier="my_alias" ) ``` ## Argument Reference -This resource supports the following arguments: +The following arguments are required: + +* `authorization_type` - (Required) Type of authentication that the function URL uses. Valid values are `AWS_IAM` and `NONE`. +* `function_name` - (Required) Name or ARN of the Lambda function. -* `authorization_type` - (Required) The type of authentication that the function URL uses. Set to `"AWS_IAM"` to restrict access to authenticated IAM users only. Set to `"NONE"` to bypass IAM authentication and create a public endpoint. See the [AWS documentation](https://docs.aws.amazon.com/lambda/latest/dg/urls-auth.html) for more details. -* `cors` - (Optional) The [cross-origin resource sharing (CORS)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) settings for the function URL. Documented below. -* `function_name` - (Required) The name (or ARN) of the Lambda function. -* `invoke_mode` - (Optional) Determines how the Lambda function responds to an invocation. Valid values are `BUFFERED` (default) and `RESPONSE_STREAM`. See more in [Configuring a Lambda function to stream responses](https://docs.aws.amazon.com/lambda/latest/dg/configuration-response-streaming.html). -* `qualifier` - (Optional) The alias name or `"$LATEST"`. +The following arguments are optional: -### cors +* `cors` - (Optional) Cross-origin resource sharing (CORS) settings for the function URL. [See below](#cors). +* `invoke_mode` - (Optional) How the Lambda function responds to an invocation. Valid values are `BUFFERED` (default) and `RESPONSE_STREAM`. +* `qualifier` - (Optional) Alias name or `$LATEST`. +* `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). -This configuration block supports the following attributes: +### CORS -* `allow_credentials` - (Optional) Whether to allow cookies or other credentials in requests to the function URL. The default is `false`. -* `allow_headers` - (Optional) The HTTP headers that origins can include in requests to the function URL. For example: `["date", "keep-alive", "x-custom-header"]`. -* `allow_methods` - (Optional) The HTTP methods that are allowed when calling the function URL. For example: `["GET", "POST", "DELETE"]`, or the wildcard character (`["*"]`). -* `allow_origins` - (Optional) The origins that can access the function URL. You can list any number of specific origins (or the wildcard character (`"*"`)), separated by a comma. For example: `["https://www.example.com", "http://localhost:60905"]`. -* `expose_headers` - (Optional) The HTTP headers in your function response that you want to expose to origins that call the function URL. -* `max_age` - (Optional) The maximum amount of time, in seconds, that web browsers can cache results of a preflight request. By default, this is set to `0`, which means that the browser doesn't cache results. The maximum value is `86400`. +* `allow_credentials` - (Optional) Whether to allow cookies or other credentials in requests to the function URL. +* `allow_headers` - (Optional) HTTP headers that origins can include in requests to the function URL. +* `allow_methods` - (Optional) HTTP methods that are allowed when calling the function URL. +* `allow_origins` - (Optional) Origins that can access the function URL. +* `expose_headers` - (Optional) HTTP headers in your function response that you want to expose to origins that call the function URL. +* `max_age` - (Optional) Maximum amount of time, in seconds, that web browsers can cache results of a preflight request. Maximum value is `86400`. ## Attribute Reference This resource exports the following attributes in addition to the arguments above: -* `function_arn` - The Amazon Resource Name (ARN) of the function. -* `function_url` - The HTTP URL endpoint for the function in the format `https://.lambda-url..on.aws/`. -* `url_id` - A generated ID for the endpoint. +* `function_arn` - ARN of the Lambda function. +* `function_url` - HTTP URL endpoint for the function in the format `https://.lambda-url..on.aws/`. +* `url_id` - Generated ID for the endpoint. + +## Timeouts + +[Configuration options](https://developer.hashicorp.com/terraform/language/resources/syntax#operation-timeouts): + +* `create` - (Default `10m`) ## Import @@ -92,13 +116,13 @@ from imports.aws.lambda_function_url import LambdaFunctionUrl class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) - LambdaFunctionUrl.generate_config_for_import(self, "testLambdaUrl", "my_test_lambda_function") + LambdaFunctionUrl.generate_config_for_import(self, "example", "example") ``` Using `terraform import`, import Lambda function URLs using the `function_name` or `function_name/qualifier`. For example: ```console -% terraform import aws_lambda_function_url.test_lambda_url my_test_lambda_function +% terraform import aws_lambda_function_url.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/lambda_invocation.html.markdown b/website/docs/cdktf/python/r/lambda_invocation.html.markdown index df1300b2d2cb..f7e6fd6b556f 100644 --- a/website/docs/cdktf/python/r/lambda_invocation.html.markdown +++ b/website/docs/cdktf/python/r/lambda_invocation.html.markdown @@ -3,22 +3,22 @@ subcategory: "Lambda" layout: "aws" page_title: "AWS: aws_lambda_invocation" description: |- - Invoke AWS Lambda Function + Manages an AWS Lambda Function invocation. --- # Resource: aws_lambda_invocation -Use this resource to invoke a lambda function. The lambda function is invoked with the [RequestResponse](https://docs.aws.amazon.com/lambda/latest/dg/API_Invoke.html#API_Invoke_RequestSyntax) invocation type. +Manages an AWS Lambda Function invocation. Use this resource to invoke a Lambda function with the [RequestResponse](https://docs.aws.amazon.com/lambda/latest/dg/API_Invoke.html#API_Invoke_RequestSyntax) invocation type. -~> **NOTE:** By default this resource _only_ invokes the function when the arguments call for a create or replace. In other words, after an initial invocation on _apply_, if the arguments do not change, a subsequent _apply_ does not invoke the function again. To dynamically invoke the function, see the `triggers` example below. To always invoke a function on each _apply_, see the [`aws_lambda_invocation`](/docs/providers/aws/d/lambda_invocation.html) data source. To invoke the lambda function when the terraform resource is updated and deleted, see the [CRUD Lifecycle Scope](#crud-lifecycle-scope) example below. +~> **Note:** By default this resource _only_ invokes the function when the arguments call for a create or replace. After an initial invocation on _apply_, if the arguments do not change, a subsequent _apply_ does not invoke the function again. To dynamically invoke the function, see the `triggers` example below. To always invoke a function on each _apply_, see the [`aws_lambda_invocation` data source](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/lambda_invocation). To invoke the Lambda function when the Terraform resource is updated and deleted, see the [CRUD Lifecycle Management](#crud-lifecycle-management) example below. -~> **NOTE:** If you get a `KMSAccessDeniedException: Lambda was unable to decrypt the environment variables because KMS access was denied` error when invoking an [`aws_lambda_function`](/docs/providers/aws/r/lambda_function.html) with environment variables, the IAM role associated with the function may have been deleted and recreated _after_ the function was created. You can fix the problem two ways: 1) updating the function's role to another role and then updating it back again to the recreated role, or 2) by using Terraform to `taint` the function and `apply` your configuration again to recreate the function. (When you create a function, Lambda grants permissions on the KMS key to the function's IAM role. If the IAM role is recreated, the grant is no longer valid. Changing the function's role or recreating the function causes Lambda to update the grant.) +~> **Note:** If you get a `KMSAccessDeniedException: Lambda was unable to decrypt the environment variables because KMS access was denied` error when invoking a Lambda function with environment variables, the IAM role associated with the function may have been deleted and recreated after the function was created. You can fix the problem two ways: 1) updating the function's role to another role and then updating it back again to the recreated role, or 2) by using Terraform to `taint` the function and `apply` your configuration again to recreate the function. (When you create a function, Lambda grants permissions on the KMS key to the function's IAM role. If the IAM role is recreated, the grant is no longer valid. Changing the function's role or recreating the function causes Lambda to update the grant.) ## Example Usage -### Basic Example +### Basic Invocation ```python # DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -28,29 +28,43 @@ from cdktf import Fn, Token, TerraformOutput, TerraformStack # Provider bindings are generated by running `cdktf get`. # See https://cdk.tf/provider-generation for more details. # +from imports.aws.lambda_function import LambdaFunction from imports.aws.lambda_invocation import LambdaInvocation class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) - example = LambdaInvocation(self, "example", - function_name=lambda_function_test.function_name, + example = LambdaFunction(self, "example", + filename="function.zip", + function_name="data_processor", + handler="index.handler", + role=lambda_role.arn, + runtime="python3.12" + ) + aws_lambda_invocation_example = LambdaInvocation(self, "example_1", + function_name=example.function_name, input=Token.as_string( Fn.jsonencode({ - "key1": "value1", - "key2": "value2" + "config": { + "debug": False, + "environment": "production" + }, + "operation": "initialize" })) ) - TerraformOutput(self, "result_entry", - value=Fn.lookup_nested(Fn.jsondecode(example.result), ["\"key1\""]) + # 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_lambda_invocation_example.override_logical_id("example") + TerraformOutput(self, "initialization_result", + value=Fn.lookup_nested( + Fn.jsondecode(Token.as_string(aws_lambda_invocation_example.result)), ["\"status\""]) ) ``` -### Dynamic Invocation Example Using Triggers +### Dynamic Invocation with Triggers ```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 +from cdktf import Token, Fn, TerraformStack # # Provider bindings are generated by running `cdktf get`. # See https://cdk.tf/provider-generation for more details. @@ -60,27 +74,32 @@ class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) LambdaInvocation(self, "example", - function_name=lambda_function_test.function_name, + function_name=Token.as_string(aws_lambda_function_example.function_name), input=Token.as_string( Fn.jsonencode({ - "key1": "value1", - "key2": "value2" + "batch_id": batch_id.result, + "environment": environment.value, + "operation": "process_data" })), triggers={ - "redeployment": Token.as_string( - Fn.sha1( + "config_hash": Token.as_string( + Fn.sha256( Token.as_string( - Fn.jsonencode([aws_lambda_function_example.environment])))) + Fn.jsonencode({ + "environment": environment.value, + "timestamp": Fn.timestamp() + })))), + "function_version": Token.as_string(aws_lambda_function_example.version) } ) ``` -### CRUD Lifecycle Scope +### CRUD Lifecycle Management ```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 +from cdktf import Token, Fn, TerraformStack # # Provider bindings are generated by running `cdktf get`. # See https://cdk.tf/provider-generation for more details. @@ -90,29 +109,37 @@ class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) LambdaInvocation(self, "example", - function_name=lambda_function_test.function_name, + function_name=Token.as_string(aws_lambda_function_example.function_name), input=Token.as_string( Fn.jsonencode({ - "key1": "value1", - "key2": "value2" + "credentials": { + "password": db_password.value, + "username": db_username.value + }, + "database_url": aws_db_instance_example.endpoint, + "resource_name": "database_setup" })), lifecycle_scope="CRUD" ) ``` -~> **NOTE:** `lifecycle_scope = "CRUD"` will inject a key `tf` in the input event to pass lifecycle information! This allows the lambda function to handle different lifecycle transitions uniquely. If you need to use a key `tf` in your own input JSON, the default key name can be overridden with the `terraform_key` argument. +~> **Note:** `lifecycle_scope = "CRUD"` will inject a key `tf` in the input event to pass lifecycle information! This allows the Lambda function to handle different lifecycle transitions uniquely. If you need to use a key `tf` in your own input JSON, the default key name can be overridden with the `terraform_key` argument. -The key `tf` gets added with subkeys: +The lifecycle key gets added with subkeys: * `action` - Action Terraform performs on the resource. Values are `create`, `update`, or `delete`. * `prev_input` - Input JSON payload from the previous invocation. This can be used to handle update and delete events. -When the resource from the example above is created, the Lambda will get following JSON payload: +When the resource from the CRUD example above is created, the Lambda will receive the following JSON payload: ```json { - "key1": "value1", - "key2": "value2", + "resource_name": "database_setup", + "database_url": "mydb.cluster-xyz.us-west-2.rds.amazonaws.com:5432", + "credentials": { + "username": "admin", + "password": "secret123" + }, "tf": { "action": "create", "prev_input": null @@ -120,33 +147,49 @@ When the resource from the example above is created, the Lambda will get followi } ``` -If the input value of `key1` changes to "valueB", then the lambda will be invoked again with the following JSON payload: +If the `database_url` changes, the Lambda will be invoked again with: ```json { - "key1": "valueB", - "key2": "value2", + "resource_name": "database_setup", + "database_url": "mydb-new.cluster-abc.us-west-2.rds.amazonaws.com:5432", + "credentials": { + "username": "admin", + "password": "secret123" + }, "tf": { "action": "update", "prev_input": { - "key1": "value1", - "key2": "value2" + "resource_name": "database_setup", + "database_url": "mydb.cluster-xyz.us-west-2.rds.amazonaws.com:5432", + "credentials": { + "username": "admin", + "password": "secret123" + } } } } ``` -When the invocation resource is removed, the final invocation will have the following JSON payload: +When the invocation resource is removed, the final invocation will have: ```json { - "key1": "valueB", - "key2": "value2", + "resource_name": "database_setup", + "database_url": "mydb-new.cluster-abc.us-west-2.rds.amazonaws.com:5432", + "credentials": { + "username": "admin", + "password": "secret123" + }, "tf": { "action": "delete", "prev_input": { - "key1": "valueB", - "key2": "value2" + "resource_name": "database_setup", + "database_url": "mydb-new.cluster-abc.us-west-2.rds.amazonaws.com:5432", + "credentials": { + "username": "admin", + "password": "secret123" + } } } } @@ -156,20 +199,21 @@ When the invocation resource is removed, the final invocation will have the foll The following arguments are required: -* `function_name` - (Required) Name of the lambda function. -* `input` - (Required) JSON payload to the lambda function. +* `function_name` - (Required) Name of the Lambda function. +* `input` - (Required) JSON payload to the Lambda function. The following arguments are optional: * `lifecycle_scope` - (Optional) Lifecycle scope of the resource to manage. Valid values are `CREATE_ONLY` and `CRUD`. Defaults to `CREATE_ONLY`. `CREATE_ONLY` will invoke the function only on creation or replacement. `CRUD` will invoke the function on each lifecycle event, and augment the input JSON payload with additional lifecycle information. -* `qualifier` - (Optional) Qualifier (i.e., version) of the lambda function. Defaults to `$LATEST`. -* `terraform_key` - (Optional) The JSON key used to store lifecycle information in the input JSON payload. Defaults to `tf`. This additional key is only included when `lifecycle_scope` is set to `CRUD`. -* `triggers` - (Optional) Map of arbitrary keys and values that, when changed, will trigger a re-invocation. To force a re-invocation without changing these keys/values, use the [`terraform taint` command](https://www.terraform.io/docs/commands/taint.html). +* `qualifier` - (Optional) Qualifier (i.e., version) of the Lambda function. Defaults to `$LATEST`. +* `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). +* `terraform_key` - (Optional) JSON key used to store lifecycle information in the input JSON payload. Defaults to `tf`. This additional key is only included when `lifecycle_scope` is set to `CRUD`. +* `triggers` - (Optional) Map of arbitrary keys and values that, when changed, will trigger a re-invocation. To force a re-invocation without changing these keys/values, use the [`terraform taint` command](https://developer.hashicorp.com/terraform/cli/commands/taint). ## Attribute Reference This resource exports the following attributes in addition to the arguments above: -* `result` - String result of the lambda function invocation. +* `result` - String result of the Lambda function invocation. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/lambda_layer_version.html.markdown b/website/docs/cdktf/python/r/lambda_layer_version.html.markdown index 8a7bd9a8f25b..827bee23a26b 100644 --- a/website/docs/cdktf/python/r/lambda_layer_version.html.markdown +++ b/website/docs/cdktf/python/r/lambda_layer_version.html.markdown @@ -3,21 +3,23 @@ subcategory: "Lambda" layout: "aws" page_title: "AWS: aws_lambda_layer_version" description: |- - Provides a Lambda Layer Version resource. Lambda Layers allow you to reuse shared bits of code across multiple lambda functions. + Manages an AWS Lambda Layer Version. --- # Resource: aws_lambda_layer_version -Provides a Lambda Layer Version resource. Lambda Layers allow you to reuse shared bits of code across multiple lambda functions. +Manages an AWS Lambda Layer Version. Use this resource to share code and dependencies across multiple Lambda functions. -For information about Lambda Layers and how to use them, see [AWS Lambda Layers][1]. +For information about Lambda Layers and how to use them, see [AWS Lambda Layers](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html). -~> **NOTE:** Setting `skip_destroy` to `true` means that the AWS Provider will _not_ destroy any layer version, even when running `terraform destroy`. Layer versions are thus intentional dangling resources that are _not_ managed by Terraform and may incur extra expense in your AWS account. +~> **Note:** Setting `skip_destroy` to `true` means that the AWS Provider will not destroy any layer version, even when running `terraform destroy`. Layer versions are thus intentional dangling resources that are not managed by Terraform and may incur extra expense in your AWS account. ## Example Usage +### Basic Layer + ```python # DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug from constructs import Construct @@ -30,21 +32,68 @@ from imports.aws.lambda_layer_version import LambdaLayerVersion class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) - LambdaLayerVersion(self, "lambda_layer", + LambdaLayerVersion(self, "example", compatible_runtimes=["nodejs20.x"], filename="lambda_layer_payload.zip", layer_name="lambda_layer_name" ) ``` +### Layer with S3 Source + +```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.lambda_layer_version import LambdaLayerVersion +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + LambdaLayerVersion(self, "example", + compatible_architectures=["x86_64", "arm64"], + compatible_runtimes=["nodejs20.x", "python3.12"], + layer_name="lambda_layer_name", + s3_bucket=lambda_layer_zip.bucket, + s3_key=lambda_layer_zip.key + ) +``` + +### Layer with Multiple Runtimes and Architectures + +```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.lambda_layer_version import LambdaLayerVersion +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + LambdaLayerVersion(self, "example", + compatible_architectures=["x86_64", "arm64"], + compatible_runtimes=["nodejs18.x", "nodejs20.x", "python3.11", "python3.12" + ], + description="Shared utilities for Lambda functions", + filename="lambda_layer_payload.zip", + layer_name="multi_runtime_layer", + license_info="MIT", + source_code_hash=Token.as_string( + Fn.filebase64sha256("lambda_layer_payload.zip")) + ) +``` + ## Specifying the Deployment Package -AWS Lambda Layers expect source code to be provided as a deployment package whose structure varies depending on which `compatible_runtimes` this layer specifies. -See [Runtimes][2] for the valid values of `compatible_runtimes`. +AWS Lambda Layers expect source code to be provided as a deployment package whose structure varies depending on which `compatible_runtimes` this layer specifies. See [Runtimes](https://docs.aws.amazon.com/lambda/latest/dg/API_PublishLayerVersion.html#SSS-PublishLayerVersion-request-CompatibleRuntimes) for the valid values of `compatible_runtimes`. -Once you have created your deployment package you can specify it either directly as a local file (using the `filename` argument) or -indirectly via Amazon S3 (using the `s3_bucket`, `s3_key` and `s3_object_version` arguments). When providing the deployment -package via S3 it may be useful to use [the `aws_s3_object` resource](s3_object.html) to upload it. +Once you have created your deployment package you can specify it either directly as a local file (using the `filename` argument) or indirectly via Amazon S3 (using the `s3_bucket`, `s3_key` and `s3_object_version` arguments). When providing the deployment package via S3 it may be useful to use [the `aws_s3_object` resource](s3_object.html) to upload it. For larger deployment packages it is recommended by Amazon to upload via S3, since the S3 API has better support for uploading large files efficiently. @@ -52,20 +101,21 @@ For larger deployment packages it is recommended by Amazon to upload via S3, sin The following arguments are required: -* `layer_name` - (Required) Unique name for your Lambda Layer +* `layer_name` - (Required) Unique name for your Lambda Layer. The following arguments are optional: -* `compatible_architectures` - (Optional) List of [Architectures][4] this layer is compatible with. Currently `x86_64` and `arm64` can be specified. -* `compatible_runtimes` - (Optional) List of [Runtimes][2] this layer is compatible with. Up to 15 runtimes can be specified. +* `compatible_architectures` - (Optional) List of [Architectures](https://docs.aws.amazon.com/lambda/latest/dg/API_PublishLayerVersion.html#SSS-PublishLayerVersion-request-CompatibleArchitectures) this layer is compatible with. Currently `x86_64` and `arm64` can be specified. +* `compatible_runtimes` - (Optional) List of [Runtimes](https://docs.aws.amazon.com/lambda/latest/dg/API_PublishLayerVersion.html#SSS-PublishLayerVersion-request-CompatibleRuntimes) this layer is compatible with. Up to 15 runtimes can be specified. * `description` - (Optional) Description of what your Lambda Layer does. -* `filename` (Optional) Path to the function's deployment package within the local filesystem. If defined, The `s3_`-prefixed options cannot be used. -* `license_info` - (Optional) License info for your Lambda Layer. See [License Info][3]. +* `filename` - (Optional) Path to the function's deployment package within the local filesystem. If defined, The `s3_`-prefixed options cannot be used. +* `license_info` - (Optional) License info for your Lambda Layer. See [License Info](https://docs.aws.amazon.com/lambda/latest/dg/API_PublishLayerVersion.html#SSS-PublishLayerVersion-request-LicenseInfo). +* `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). * `s3_bucket` - (Optional) S3 bucket location containing the function's deployment package. Conflicts with `filename`. This bucket must reside in the same AWS region where you are creating the Lambda function. * `s3_key` - (Optional) S3 key of an object containing the function's deployment package. Conflicts with `filename`. * `s3_object_version` - (Optional) Object version containing the function's deployment package. Conflicts with `filename`. * `skip_destroy` - (Optional) Whether to retain the old version of a previously deployed Lambda Layer. Default is `false`. When this is not set to `true`, changing any of `compatible_architectures`, `compatible_runtimes`, `description`, `filename`, `layer_name`, `license_info`, `s3_bucket`, `s3_key`, `s3_object_version`, or `source_code_hash` forces deletion of the existing layer version and creation of a new layer version. -* `source_code_hash` - (Optional) Virtual attribute used to trigger replacement when source code changes. Must be set to a base64-encoded SHA256 hash of the package file specified with either `filename` or `s3_key`. The usual way to set this is `${filebase64sha256("file.zip")}` (Terraform 0.11.12 or later) or `${base64sha256(file("file.zip"))}` (Terraform 0.11.11 and earlier), where "file.zip" is the local filename of the lambda layer source archive. +* `source_code_hash` - (Optional) Virtual attribute used to trigger replacement when source code changes. Must be set to a base64-encoded SHA256 hash of the package file specified with either `filename` or `s3_key`. The usual way to set this is `filebase64sha256("file.zip")` (Terraform 0.11.12 or later) or `base64sha256(file("file.zip"))` (Terraform 0.11.11 and earlier), where "file.zip" is the local filename of the lambda layer source archive. ## Attribute Reference @@ -80,11 +130,6 @@ This resource exports the following attributes in addition to the arguments abov * `source_code_size` - Size in bytes of the function .zip file. * `version` - Lambda Layer version. -[1]: https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html -[2]: https://docs.aws.amazon.com/lambda/latest/dg/API_PublishLayerVersion.html#SSS-PublishLayerVersion-request-CompatibleRuntimes -[3]: https://docs.aws.amazon.com/lambda/latest/dg/API_PublishLayerVersion.html#SSS-PublishLayerVersion-request-LicenseInfo -[4]: https://docs.aws.amazon.com/lambda/latest/dg/API_PublishLayerVersion.html#SSS-PublishLayerVersion-request-CompatibleArchitectures - ## Import In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import Lambda Layers using `arn`. For example: @@ -101,15 +146,13 @@ from imports.aws.lambda_layer_version import LambdaLayerVersion class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) - LambdaLayerVersion.generate_config_for_import(self, "testLayer", "arn:aws:lambda:_REGION_:_ACCOUNT_ID_:layer:_LAYER_NAME_:_LAYER_VERSION_") + LambdaLayerVersion.generate_config_for_import(self, "example", "arn:aws:lambda:us-west-2:123456789012:layer:example:1") ``` Using `terraform import`, import Lambda Layers using `arn`. For example: ```console -% terraform import \ - aws_lambda_layer_version.test_layer \ - arn:aws:lambda:_REGION_:_ACCOUNT_ID_:layer:_LAYER_NAME_:_LAYER_VERSION_ +% terraform import aws_lambda_layer_version.example arn:aws:lambda:us-west-2:123456789012:layer:example:1 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/lambda_layer_version_permission.html.markdown b/website/docs/cdktf/python/r/lambda_layer_version_permission.html.markdown index 622e9af5b6d6..7868d9a80c51 100644 --- a/website/docs/cdktf/python/r/lambda_layer_version_permission.html.markdown +++ b/website/docs/cdktf/python/r/lambda_layer_version_permission.html.markdown @@ -3,25 +3,84 @@ subcategory: "Lambda" layout: "aws" page_title: "AWS: aws_lambda_layer_version_permission" description: |- - Provides a Lambda Layer Version Permission resource. + Manages an AWS Lambda Layer Version Permission. --- # Resource: aws_lambda_layer_version_permission -Provides a Lambda Layer Version Permission resource. It allows you to share you own Lambda Layers to another account by account ID, to all accounts in AWS organization or even to all AWS accounts. +Manages an AWS Lambda Layer Version Permission. Use this resource to share Lambda Layers with other AWS accounts, organizations, or make them publicly accessible. -For information about Lambda Layer Permissions and how to use them, see [Using Resource-based Policies for AWS Lambda][1] +For information about Lambda Layer Permissions and how to use them, see [Using Resource-based Policies for AWS Lambda](https://docs.aws.amazon.com/lambda/latest/dg/access-control-resource-based.html#permissions-resource-xaccountlayer). -~> **NOTE:** Setting `skip_destroy` to `true` means that the AWS Provider will _not_ destroy any layer version permission, even when running `terraform destroy`. Layer version permissions are thus intentional dangling resources that are _not_ managed by Terraform and may incur extra expense in your AWS account. +~> **Note:** Setting `skip_destroy` to `true` means that the AWS Provider will not destroy any layer version permission, even when running `terraform destroy`. Layer version permissions are thus intentional dangling resources that are not managed by Terraform and may incur extra expense in your AWS account. ## Example Usage +### Share Layer with Specific Account + ```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 +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.lambda_layer_version import LambdaLayerVersion +from imports.aws.lambda_layer_version_permission import LambdaLayerVersionPermission +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + example = LambdaLayerVersion(self, "example", + compatible_runtimes=["nodejs20.x", "python3.12"], + description="Common utilities for Lambda functions", + filename="layer.zip", + layer_name="shared_utilities" + ) + aws_lambda_layer_version_permission_example = + LambdaLayerVersionPermission(self, "example_1", + action="lambda:GetLayerVersion", + layer_name=example.layer_name, + principal="123456789012", + statement_id="dev-account-access", + version_number=Token.as_number(example.version) + ) + # 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_lambda_layer_version_permission_example.override_logical_id("example") +``` + +### Share Layer with Organization + +```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.lambda_layer_version_permission import LambdaLayerVersionPermission +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + LambdaLayerVersionPermission(self, "example", + action="lambda:GetLayerVersion", + layer_name=Token.as_string(aws_lambda_layer_version_example.layer_name), + organization_id="o-1234567890", + principal="*", + statement_id="org-wide-access", + version_number=Token.as_number(aws_lambda_layer_version_example.version) + ) +``` + +### Share Layer Publicly + +```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. @@ -30,34 +89,75 @@ from imports.aws.lambda_layer_version_permission import LambdaLayerVersionPermis class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) - LambdaLayerVersionPermission(self, "lambda_layer_permission", + LambdaLayerVersionPermission(self, "example", action="lambda:GetLayerVersion", - layer_name="arn:aws:lambda:us-west-2:123456654321:layer:test_layer1", + layer_name=Token.as_string(aws_lambda_layer_version_example.layer_name), + principal="*", + statement_id="public-access", + version_number=Token.as_number(aws_lambda_layer_version_example.version) + ) +``` + +### Multiple Account Access + +```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.lambda_layer_version_permission import LambdaLayerVersionPermission +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + LambdaLayerVersionPermission(self, "dev_account", + action="lambda:GetLayerVersion", + layer_name=example.layer_name, principal="111111111111", statement_id="dev-account", - version_number=1 + version_number=Token.as_number(example.version) + ) + LambdaLayerVersionPermission(self, "prod_account", + action="lambda:GetLayerVersion", + layer_name=example.layer_name, + principal="333333333333", + statement_id="prod-account", + version_number=Token.as_number(example.version) + ) + LambdaLayerVersionPermission(self, "staging_account", + action="lambda:GetLayerVersion", + layer_name=example.layer_name, + principal="222222222222", + statement_id="staging-account", + version_number=Token.as_number(example.version) ) ``` ## Argument Reference -This resource supports the following arguments: +The following arguments are required: -* `action` - (Required) Action, which will be allowed. `lambda:GetLayerVersion` value is suggested by AWS documantation. -* `layer_name` (Required) The name or ARN of the Lambda Layer, which you want to grant access to. -* `organization_id` - (Optional) An identifier of AWS Organization, which should be able to use your Lambda Layer. `principal` should be equal to `*` if `organization_id` provided. -* `principal` - (Required) AWS account ID which should be able to use your Lambda Layer. `*` can be used here, if you want to share your Lambda Layer widely. -* `statement_id` - (Required) The name of Lambda Layer Permission, for example `dev-account` - human readable note about what is this permission for. -* `version_number` (Required) Version of Lambda Layer, which you want to grant access to. Note: permissions only apply to a single version of a layer. -* `skip_destroy` - (Optional) Whether to retain the old version of a previously deployed Lambda Layer. Default is `false`. When this is not set to `true`, changing any of `compatible_architectures`, `compatible_runtimes`, `description`, `filename`, `layer_name`, `license_info`, `s3_bucket`, `s3_key`, `s3_object_version`, or `source_code_hash` forces deletion of the existing layer version and creation of a new layer version. +* `action` - (Required) Action that will be allowed. `lambda:GetLayerVersion` is the standard value for layer access. +* `layer_name` - (Required) Name or ARN of the Lambda Layer. +* `principal` - (Required) AWS account ID that should be able to use your Lambda Layer. Use `*` to share with all AWS accounts. +* `statement_id` - (Required) Unique identifier for the permission statement. +* `version_number` - (Required) Version of Lambda Layer to grant access to. Note: permissions only apply to a single version of a layer. + +The following arguments are optional: + +* `organization_id` - (Optional) AWS Organization ID that should be able to use your Lambda Layer. `principal` should be set to `*` when `organization_id` is provided. +* `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). +* `skip_destroy` - (Optional) Whether to retain the permission when the resource is destroyed. Default is `false`. ## Attribute Reference This resource exports the following attributes in addition to the arguments above: -* `id` - The `layer_name` and `version_number`, separated by a comma (`,`). -* `revision_id` - A unique identifier for the current revision of the policy. +* `id` - Layer name and version number, separated by a comma (`,`). * `policy` - Full Lambda Layer Permission policy. +* `revision_id` - Unique identifier for the current revision of the policy. ## Import @@ -75,15 +175,13 @@ from imports.aws.lambda_layer_version_permission import LambdaLayerVersionPermis class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) - LambdaLayerVersionPermission.generate_config_for_import(self, "example", "arn:aws:lambda:us-west-2:123456654321:layer:test_layer1,1") + LambdaLayerVersionPermission.generate_config_for_import(self, "example", "arn:aws:lambda:us-west-2:123456789012:layer:shared_utilities,1") ``` -Using `terraform import`, import Lambda Layer Permissions using `layer_name` and `version_number`, separated by a comma (`,`). For example: +For backwards compatibility, the following legacy `terraform import` command is also supported: ```console -% terraform import aws_lambda_layer_version_permission.example arn:aws:lambda:us-west-2:123456654321:layer:test_layer1,1 +% terraform import aws_lambda_layer_version_permission.example arn:aws:lambda:us-west-2:123456789012:layer:shared_utilities,1 ``` -[1]: https://docs.aws.amazon.com/lambda/latest/dg/access-control-resource-based.html#permissions-resource-xaccountlayer - - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/lambda_permission.html.markdown b/website/docs/cdktf/python/r/lambda_permission.html.markdown index fcc60a252f96..2c995eb515db 100644 --- a/website/docs/cdktf/python/r/lambda_permission.html.markdown +++ b/website/docs/cdktf/python/r/lambda_permission.html.markdown @@ -3,18 +3,18 @@ subcategory: "Lambda" layout: "aws" page_title: "AWS: aws_lambda_permission" description: |- - Creates a Lambda function permission. + Manages an AWS Lambda permission. --- # Resource: aws_lambda_permission -Gives an external source (like an EventBridge Rule, SNS, or S3) permission to access the Lambda function. +Manages an AWS Lambda permission. Use this resource to grant external sources (e.g., EventBridge Rules, SNS, or S3) permission to invoke Lambda functions. ## Example Usage -### Basic Usage +### Basic Usage with EventBridge ```python # DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -70,7 +70,7 @@ class MyConvertedCode(TerraformStack): ) ``` -### With SNS +### SNS Integration ```python # DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -130,7 +130,7 @@ class MyConvertedCode(TerraformStack): ) ``` -### With API Gateway REST API +### API Gateway REST API Integration ```python # DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -158,7 +158,7 @@ class MyConvertedCode(TerraformStack): ) ``` -### With CloudWatch Log Group +### CloudWatch Log Group Integration ```python # DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -225,7 +225,7 @@ class MyConvertedCode(TerraformStack): aws_cloudwatch_log_subscription_filter_logging.override_logical_id("logging") ``` -### With Cross-Account Invocation Policy +### Cross-Account Function URL Access ```python # DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -255,9 +255,7 @@ class MyConvertedCode(TerraformStack): aws_lambda_permission_url.override_logical_id("url") ``` -### With `replace_triggered_by` Lifecycle Configuration - -If omitting the `qualifier` argument (which forces re-creation each time a function version is published), a `lifecycle` block can be used to ensure permissions are re-applied on any change to the underlying function. +### Automatic Permission Updates with Function Changes ```python # DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -285,27 +283,23 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -This resource supports the following arguments: +The following arguments are required: + +* `action` - (Required) Lambda action to allow in this statement (e.g., `lambda:InvokeFunction`) +* `function_name` - (Required) Name or ARN of the Lambda function +* `principal` - (Required) AWS service or account that invokes the function (e.g., `s3.amazonaws.com`, `sns.amazonaws.com`, AWS account ID, or AWS IAM principal) -* `action` - (Required) The AWS Lambda action you want to allow in this statement. (e.g., `lambda:InvokeFunction`) -* `event_source_token` - (Optional) The Event Source Token to validate. Used with [Alexa Skills][1]. -* `function_name` - (Required) Name of the Lambda function whose resource policy you are updating -* `function_url_auth_type` - (Optional) Lambda Function URLs [authentication type][3]. Valid values are: `AWS_IAM` or `NONE`. Only supported for `lambda:InvokeFunctionUrl` action. -* `principal` - (Required) The principal who is getting this permission e.g., `s3.amazonaws.com`, an AWS account ID, or AWS IAM principal, or AWS service principal such as `events.amazonaws.com` or `sns.amazonaws.com`. -* `qualifier` - (Optional) Query parameter to specify function version or alias name. The permission will then apply to the specific qualified ARN e.g., `arn:aws:lambda:aws-region:acct-id:function:function-name:2` -* `source_account` - (Optional) This parameter is used when allowing cross-account access, or for S3 and SES. The AWS account ID (without a hyphen) of the source owner. -* `source_arn` - (Optional) When the principal is an AWS service, the ARN of the specific resource within that service to grant permission to. - Without this, any resource from `principal` will be granted permission – even if that resource is from another account. - For S3, this should be the ARN of the S3 Bucket. - For EventBridge events, this should be the ARN of the EventBridge Rule. - For API Gateway, this should be the ARN of the API, as described [here][2]. -* `statement_id` - (Optional) A unique statement identifier. By default generated by Terraform. -* `statement_id_prefix` - (Optional) A statement identifier prefix. Terraform will generate a unique suffix. Conflicts with `statement_id`. -* `principal_org_id` - (Optional) The identifier for your organization in AWS Organizations. Use this to grant permissions to all the AWS accounts under this organization. +The following arguments are optional: -[1]: https://developer.amazon.com/docs/custom-skills/host-a-custom-skill-as-an-aws-lambda-function.html#use-aws-cli -[2]: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-control-access-using-iam-policies-to-invoke-api.html -[3]: https://docs.aws.amazon.com/lambda/latest/dg/urls-auth.html +* `event_source_token` - (Optional) Event Source Token for Alexa Skills +* `function_url_auth_type` - (Optional) Lambda Function URL authentication type. Valid values: `AWS_IAM` or `NONE`. Only valid with `lambda:InvokeFunctionUrl` action +* `principal_org_id` - (Optional) AWS Organizations ID to grant permission to all accounts under this organization +* `qualifier` - (Optional) Lambda function version or alias name +* `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) +* `source_account` - (Optional) AWS account ID of the source owner for cross-account access, S3, or SES +* `source_arn` - (Optional) ARN of the source resource granting permission to invoke the Lambda function +* `statement_id` - (Optional) Statement identifier. Generated by Terraform if not provided +* `statement_id_prefix` - (Optional) Statement identifier prefix. Conflicts with `statement_id` ## Attribute Reference @@ -330,6 +324,8 @@ class MyConvertedCode(TerraformStack): LambdaPermission.generate_config_for_import(self, "testLambdaPermission", "my_test_lambda_function/AllowExecutionFromCloudWatch") ``` +Using `qualifier`: + ```python # DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug from constructs import Construct @@ -345,14 +341,11 @@ class MyConvertedCode(TerraformStack): LambdaPermission.generate_config_for_import(self, "testLambdaPermission", "my_test_lambda_function:qualifier_name/AllowExecutionFromCloudWatch") ``` -Using `terraform import`, import Lambda permission statements using function_name/statement_id with an optional qualifier. For example: - -```console -% terraform import aws_lambda_permission.test_lambda_permission my_test_lambda_function/AllowExecutionFromCloudWatch -``` +For backwards compatibility, the following legacy `terraform import` commands are also supported: ```console +% terraform import aws_lambda_permission.example my_test_lambda_function/AllowExecutionFromCloudWatch % terraform import aws_lambda_permission.test_lambda_permission my_test_lambda_function:qualifier_name/AllowExecutionFromCloudWatch ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/lambda_provisioned_concurrency_config.html.markdown b/website/docs/cdktf/python/r/lambda_provisioned_concurrency_config.html.markdown index 1eb748e29b96..beeba2796252 100644 --- a/website/docs/cdktf/python/r/lambda_provisioned_concurrency_config.html.markdown +++ b/website/docs/cdktf/python/r/lambda_provisioned_concurrency_config.html.markdown @@ -3,16 +3,16 @@ subcategory: "Lambda" layout: "aws" page_title: "AWS: aws_lambda_provisioned_concurrency_config" description: |- - Manages a Lambda Provisioned Concurrency Configuration + Manages an AWS Lambda Provisioned Concurrency Configuration. --- # Resource: aws_lambda_provisioned_concurrency_config -Manages a Lambda Provisioned Concurrency Configuration. +Manages an AWS Lambda Provisioned Concurrency Configuration. Use this resource to configure provisioned concurrency for Lambda functions. -~> **NOTE:** Setting `skip_destroy` to `true` means that the AWS Provider will _not_ destroy a provisioned concurrency configuration, even when running `terraform destroy`. The configuration is thus an intentional dangling resource that is _not_ managed by Terraform and may incur extra expense in your AWS account. +~> **Note:** Setting `skip_destroy` to `true` means that the AWS Provider will not destroy a provisioned concurrency configuration, even when running `terraform destroy`. The configuration is thus an intentional dangling resource that is not managed by Terraform and may incur extra expense in your AWS account. ## Example Usage @@ -63,12 +63,13 @@ class MyConvertedCode(TerraformStack): The following arguments are required: * `function_name` - (Required) Name or Amazon Resource Name (ARN) of the Lambda Function. -* `provisioned_concurrent_executions` - (Required) Amount of capacity to allocate. Must be greater than or equal to `1`. +* `provisioned_concurrent_executions` - (Required) Amount of capacity to allocate. Must be greater than or equal to 1. * `qualifier` - (Required) Lambda Function version or Lambda Alias name. The following arguments are optional: -* `skip_destroy` - (Optional) Whether to retain the provisoned concurrency configuration upon destruction. Defaults to `false`. If set to `true`, the resource in simply removed from state instead. +* `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). +* `skip_destroy` - (Optional) Whether to retain the provisioned concurrency configuration upon destruction. Defaults to `false`. If set to `true`, the resource is simply removed from state instead. ## Attribute Reference @@ -99,13 +100,13 @@ from imports.aws.lambda_provisioned_concurrency_config import LambdaProvisionedC class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) - LambdaProvisionedConcurrencyConfig.generate_config_for_import(self, "example", "my_function,production") + LambdaProvisionedConcurrencyConfig.generate_config_for_import(self, "example", "example,production") ``` Using `terraform import`, import a Lambda Provisioned Concurrency Configuration using the `function_name` and `qualifier` separated by a comma (`,`). For example: ```console -% terraform import aws_lambda_provisioned_concurrency_config.example my_function,production +% terraform import aws_lambda_provisioned_concurrency_config.example example,production ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/lambda_runtime_management_config.html.markdown b/website/docs/cdktf/python/r/lambda_runtime_management_config.html.markdown index 445ffe7520e3..0724c40b7bad 100644 --- a/website/docs/cdktf/python/r/lambda_runtime_management_config.html.markdown +++ b/website/docs/cdktf/python/r/lambda_runtime_management_config.html.markdown @@ -3,18 +3,17 @@ subcategory: "Lambda" layout: "aws" page_title: "AWS: aws_lambda_runtime_management_config" description: |- - Terraform resource for managing an AWS Lambda Runtime Management Config. + Manages an AWS Lambda Runtime Management Config. --- # Resource: aws_lambda_runtime_management_config -Terraform resource for managing an AWS Lambda Runtime Management Config. +Manages an AWS Lambda Runtime Management Config. Use this resource to control how Lambda updates the runtime for your function. Refer to the [AWS Lambda documentation](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html) for supported runtimes. -~> Deletion of this resource returns the runtime update mode to `Auto` (the default behavior). -To leave the configured runtime management options in-place, use a [`removed` block](https://developer.hashicorp.com/terraform/language/resources/syntax#removing-resources) with the destroy lifecycle set to `false`. +~> **Note:** Deletion of this resource returns the runtime update mode to `Auto` (the default behavior). To leave the configured runtime management options in-place, use a [`removed` block](https://developer.hashicorp.com/terraform/language/resources/syntax#removing-resources) with the destroy lifecycle set to `false`. ## Example Usage @@ -23,7 +22,7 @@ To leave the configured runtime management options in-place, use a [`removed` bl ```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 +from cdktf import Token, TerraformStack # # Provider bindings are generated by running `cdktf get`. # See https://cdk.tf/provider-generation for more details. @@ -33,17 +32,17 @@ class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) LambdaRuntimeManagementConfig(self, "example", - function_name=test.function_name, + function_name=Token.as_string(aws_lambda_function_example.function_name), update_runtime_on="FunctionUpdate" ) ``` -### `Manual` Update +### Manual Update ```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 +from cdktf import Token, TerraformStack # # Provider bindings are generated by running `cdktf get`. # See https://cdk.tf/provider-generation for more details. @@ -53,13 +52,13 @@ class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) LambdaRuntimeManagementConfig(self, "example", - function_name=test.function_name, + function_name=Token.as_string(aws_lambda_function_example.function_name), runtime_version_arn="arn:aws:lambda:us-east-1::runtime:abcd1234", update_runtime_on="Manual" ) ``` -~> Once the runtime update mode is set to `Manual`, the `aws_lambda_function` `runtime` cannot be updated. To upgrade a runtime, the `update_runtime_on` argument must be set to `Auto` or `FunctionUpdate` prior to changing the function's `runtime` argument. +~> **Note:** Once the runtime update mode is set to `Manual`, the `aws_lambda_function` `runtime` cannot be updated. To upgrade a runtime, the `update_runtime_on` argument must be set to `Auto` or `FunctionUpdate` prior to changing the function's `runtime` argument. ## Argument Reference @@ -70,6 +69,7 @@ The following arguments are required: The following arguments are optional: * `qualifier` - (Optional) Version of the function. This can be `$LATEST` or a published version number. If omitted, this resource will manage the runtime configuration for `$LATEST`. +* `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). * `runtime_version_arn` - (Optional) ARN of the runtime version. Only required when `update_runtime_on` is `Manual`. * `update_runtime_on` - (Optional) Runtime update mode. Valid values are `Auto`, `FunctionUpdate`, and `Manual`. When a function is created, the default mode is `Auto`. @@ -95,13 +95,13 @@ from imports.aws.lambda_runtime_management_config import LambdaRuntimeManagement class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) - LambdaRuntimeManagementConfig.generate_config_for_import(self, "example", "my-function,$LATEST") + LambdaRuntimeManagementConfig.generate_config_for_import(self, "example", "example,$LATEST") ``` Using `terraform import`, import Lambda Runtime Management Config using a comma-delimited string combining `function_name` and `qualifier`. For example: ```console -% terraform import aws_lambda_runtime_management_config.example my-function,$LATEST +% terraform import aws_lambda_runtime_management_config.example example,$LATEST ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/launch_configuration.html.markdown b/website/docs/cdktf/python/r/launch_configuration.html.markdown index a41f0ce1fe4c..1045c112123c 100644 --- a/website/docs/cdktf/python/r/launch_configuration.html.markdown +++ b/website/docs/cdktf/python/r/launch_configuration.html.markdown @@ -171,6 +171,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `associate_public_ip_address` - (Optional) Associate a public ip address with an instance in a VPC. * `ebs_block_device` - (Optional) Additional EBS block devices to attach to the instance. See [Block Devices](#block-devices) below for details. * `ebs_optimized` - (Optional) If true, the launched EC2 instance will be EBS-optimized. @@ -280,4 +281,4 @@ Using `terraform import`, import launch configurations using the `name`. For exa % terraform import aws_launch_configuration.as_conf terraform-lg-123456 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/launch_template.html.markdown b/website/docs/cdktf/python/r/launch_template.html.markdown index a03b4e91e437..25aaf3ad98ea 100644 --- a/website/docs/cdktf/python/r/launch_template.html.markdown +++ b/website/docs/cdktf/python/r/launch_template.html.markdown @@ -47,13 +47,6 @@ class MyConvertedCode(TerraformStack): disable_api_stop=True, disable_api_termination=True, ebs_optimized=Token.as_string(True), - elastic_gpu_specifications=[LaunchTemplateElasticGpuSpecifications( - type="test" - ) - ], - elastic_inference_accelerator=LaunchTemplateElasticInferenceAccelerator( - type="eia1.medium" - ), iam_instance_profile=LaunchTemplateIamInstanceProfile( name="test" ), @@ -103,6 +96,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `block_device_mappings` - (Optional) Specify volumes to attach to the instance besides the volumes specified by the AMI. See [Block Devices](#block-devices) below for details. * `capacity_reservation_specification` - (Optional) Targeting for EC2 capacity reservations. See [Capacity Reservation Specification](#capacity-reservation-specification) below for more details. @@ -115,9 +109,6 @@ This resource supports the following arguments: * `disable_api_termination` - (Optional) If `true`, enables [EC2 Instance Termination Protection](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_ChangingDisableAPITermination.html) * `ebs_optimized` - (Optional) If `true`, the launched EC2 instance will be EBS-optimized. -* `elastic_gpu_specifications` - (Optional) **DEPRECATED** The elastic GPU to attach to the instance. See [Elastic GPU](#elastic-gpu) - below for more details. -* `elastic_inference_accelerator` - (Optional) **DEPRECATED** Configuration block containing an Elastic Inference Accelerator to attach to the instance. See [Elastic Inference Accelerator](#elastic-inference-accelerator) below for more details. * `enclave_options` - (Optional) Enable Nitro Enclaves on launched instances. See [Enclave Options](#enclave-options) below for more details. * `hibernation_options` - (Optional) The hibernation options for the instance. See [Hibernation Options](#hibernation-options) below for more details. * `iam_instance_profile` - (Optional) The IAM Instance Profile to launch the instance with. See [Instance Profile](#instance-profile) @@ -188,7 +179,7 @@ The `ebs` block supports the following: The `capacity_reservation_specification` block supports the following: -* `capacity_reservation_preference` - Indicates the instance's Capacity Reservation preferences. Can be `open` or `none`. (Default `none`). +* `capacity_reservation_preference` - Indicates the instance's Capacity Reservation preferences. Can be `capacity-reservations-only`, `open` or `none`. If `capacity_reservation_id` or `capacity_reservation_resource_group_arn` is specified in `capacity_reservation_target` block, either omit `capacity_reservation_preference` or set it to `capacity-reservations-only`. * `capacity_reservation_target` - Used to target a specific Capacity Reservation: The `capacity_reservation_target` block supports the following: @@ -219,22 +210,6 @@ The `credit_specification` block supports the following: T3 instances are launched as `unlimited` by default. T2 instances are launched as `standard` by default. -### Elastic GPU - -Attach an elastic GPU the instance. - -The `elastic_gpu_specifications` block supports the following: - -* `type` - The [Elastic GPU Type](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-graphics.html#elastic-graphics-basics) - -### Elastic Inference Accelerator - -**DEPRECATED** Attach an Elastic Inference Accelerator to the instance. Additional information about Elastic Inference in EC2 can be found in the [EC2 User Guide](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-inference.html). - -The `elastic_inference_accelerator` configuration block supports the following: - -* `type` - (Required) Accelerator type. - ### Enclave Options The `enclave_options` block supports the following: @@ -537,4 +512,4 @@ Using `terraform import`, import Launch Templates using the `id`. For example: % terraform import aws_launch_template.web lt-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/lb.html.markdown b/website/docs/cdktf/python/r/lb.html.markdown index 8ecf692e1e9d..d7290adf910b 100644 --- a/website/docs/cdktf/python/r/lb.html.markdown +++ b/website/docs/cdktf/python/r/lb.html.markdown @@ -134,6 +134,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `access_logs` - (Optional) Access Logs block. See below. * `connection_logs` - (Optional) Connection Logs block. See below. Only valid for Load Balancers of type `application`. * `client_keep_alive` - (Optional) Client keep alive value in seconds. The valid range is 60-604800 seconds. The default is 3600 seconds. @@ -159,6 +160,7 @@ This resource supports the following arguments: * `name_prefix` - (Optional) Creates a unique name beginning with the specified prefix. Conflicts with `name`. * `security_groups` - (Optional) List of security group IDs to assign to the LB. Only valid for Load Balancers of type `application` or `network`. For load balancers of type `network` security groups cannot be added if none are currently present, and cannot all be removed once added. If either of these conditions are met, this will force a recreation of the resource. * `preserve_host_header` - (Optional) Whether the Application Load Balancer should preserve the Host header in the HTTP request and send it to the target without any change. Defaults to `false`. +* `secondary_ips_auto_assigned_per_subnet` - (Optional) The number of secondary IP addresses to configure for your load balancer nodes. Only valid for Load Balancers of type `network`. The valid range is 0-7. When decreased, this will force a recreation of the resource. Default: `0`. * `subnet_mapping` - (Optional) Subnet mapping block. See below. For Load Balancers of type `network` subnet mappings can only be added. * `subnets` - (Optional) List of subnet IDs to attach to the LB. For Load Balancers of type `network` subnets can only be added (see [Availability Zones](https://docs.aws.amazon.com/elasticloadbalancing/latest/network/network-load-balancers.html#availability-zones)), deleting a subnet for load balancers of type `network` will force a recreation of the resource. * `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. @@ -199,10 +201,9 @@ This resource supports the following arguments: This resource exports the following attributes in addition to the arguments above: -* `arn` - ARN of the load balancer (matches `id`). +* `arn` - ARN of the load balancer. * `arn_suffix` - ARN suffix for use with CloudWatch Metrics. * `dns_name` - DNS name of the load balancer. -* `id` - ARN of the load balancer (matches `arn`). * `subnet_mapping.*.outpost_id` - ID of the Outpost containing the load balancer. * `tags_all` - Map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). * `zone_id` - Canonical hosted zone ID of the load balancer (to be used in a Route 53 Alias record). @@ -240,4 +241,4 @@ Using `terraform import`, import LBs using their ARN. For example: % terraform import aws_lb.bar arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/lb_cookie_stickiness_policy.html.markdown b/website/docs/cdktf/python/r/lb_cookie_stickiness_policy.html.markdown index 99953e28fb27..e9007ddb74f5 100644 --- a/website/docs/cdktf/python/r/lb_cookie_stickiness_policy.html.markdown +++ b/website/docs/cdktf/python/r/lb_cookie_stickiness_policy.html.markdown @@ -50,6 +50,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) The name of the stickiness policy. * `load_balancer` - (Required) The load balancer to which the policy should be attached. @@ -69,4 +70,4 @@ This resource exports the following attributes in addition to the arguments abov * `lb_port` - The load balancer port to which the policy is applied. * `cookie_expiration_period` - The time period after which the session cookie is considered stale, expressed in seconds. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/lb_listener.html.markdown b/website/docs/cdktf/python/r/lb_listener.html.markdown index 477f3d3c5611..06503762c98a 100644 --- a/website/docs/cdktf/python/r/lb_listener.html.markdown +++ b/website/docs/cdktf/python/r/lb_listener.html.markdown @@ -52,6 +52,50 @@ class MyConvertedCode(TerraformStack): aws_lb_listener_front_end.override_logical_id("front_end") ``` +With weighted target groups: + +```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.lb import Lb +from imports.aws.lb_listener import LbListener +from imports.aws.lb_target_group import LbTargetGroup +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + front_end = Lb(self, "front_end") + front_end_blue = LbTargetGroup(self, "front_end_blue") + front_end_green = LbTargetGroup(self, "front_end_green") + aws_lb_listener_front_end = LbListener(self, "front_end_3", + certificate_arn="arn:aws:iam::187416307283:server-certificate/test_cert_rab3wuqwgja25ct3n4jdj2tzu4", + default_action=[LbListenerDefaultAction( + forward=LbListenerDefaultActionForward( + target_group=[LbListenerDefaultActionForwardTargetGroup( + arn=front_end_blue.arn, + weight=100 + ), LbListenerDefaultActionForwardTargetGroup( + arn=front_end_green.arn, + weight=0 + ) + ] + ), + type="forward" + ) + ], + load_balancer_arn=front_end.arn, + port=Token.as_number("443"), + protocol="HTTPS", + ssl_policy="ELBSecurityPolicy-2016-08" + ) + # 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_lb_listener_front_end.override_logical_id("front_end") +``` + To a NLB: ```python @@ -343,6 +387,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `alpn_policy` - (Optional) Name of the Application-Layer Protocol Negotiation (ALPN) policy. Can be set if `protocol` is `TLS`. Valid values are `HTTP1Only`, `HTTP2Only`, `HTTP2Optional`, `HTTP2Preferred`, and `None`. * `certificate_arn` - (Optional) ARN of the default SSL server certificate. Exactly one certificate is required if the protocol is HTTPS. For adding additional SSL certificates, see the [`aws_lb_listener_certificate` resource](/docs/providers/aws/r/lb_listener_certificate.html). * `mutual_authentication` - (Optional) The mutual authentication configuration information. See below. @@ -381,6 +426,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `authenticate_cognito` - (Optional) Configuration block for using Amazon Cognito to authenticate users. Specify only when `type` is `authenticate-cognito`. See below. * `authenticate_oidc` - (Optional) Configuration block for an identity provider that is compliant with OpenID Connect (OIDC). Specify only when `type` is `authenticate-oidc`. See below. * `fixed_response` - (Optional) Information for creating an action that returns a custom HTTP response. Required if `type` is `fixed-response`. @@ -399,6 +445,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `authentication_request_extra_params` - (Optional) Query parameters to include in the redirect request to the authorization endpoint. Max: 10. See below. * `on_unauthenticated_request` - (Optional) Behavior if the user is not authenticated. Valid values are `deny`, `allow` and `authenticate`. * `scope` - (Optional) Set of user claims to be requested from the IdP. @@ -423,6 +470,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `authentication_request_extra_params` - (Optional) Query parameters to include in the redirect request to the authorization endpoint. Max: 10. * `on_unauthenticated_request` - (Optional) Behavior if the user is not authenticated. Valid values: `deny`, `allow` and `authenticate` * `scope` - (Optional) Set of user claims to be requested from the IdP. @@ -437,6 +485,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `message_body` - (Optional) Message body. * `status_code` - (Optional) HTTP response code. Valid values are `2XX`, `4XX`, or `5XX`. @@ -448,6 +497,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `stickiness` - (Optional) Configuration block for target group stickiness for the rule. See below. ##### target_group @@ -458,6 +508,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `weight` - (Optional) Weight. The range is 0 to 999. ##### stickiness @@ -468,6 +519,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `enabled` - (Optional) Whether target group stickiness is enabled. Default is `false`. #### redirect @@ -480,6 +532,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `host` - (Optional) Hostname. This component is not percent-encoded. The hostname can contain `#{host}`. Defaults to `#{host}`. * `path` - (Optional) Absolute path, starting with the leading "/". This component is not percent-encoded. The path can contain #{host}, #{path}, and #{port}. Defaults to `/#{path}`. * `port` - (Optional) Port. Specify a value from `1` to `65535` or `#{port}`. Defaults to `#{port}`. @@ -488,17 +541,17 @@ The following arguments are optional: ### mutual_authentication -* `advertise_trust_store_ca_names` - (Optional) Valid values are `off` and `on`. -* `ignore_client_certificate_expiry` - (Optional) Whether client certificate expiry is ignored. Default is `false`. -* `mode` - (Required) Valid values are `off`, `verify` and `passthrough`. -* `trust_store_arn` - (Required) ARN of the elbv2 Trust Store. +* `advertise_trust_store_ca_names` - (Optional when `mode` is `verify`, invalid otherwise) Valid values are `off` and `on`. +* `ignore_client_certificate_expiry` - (Optional when `mode` is `verify`, invalid otherwise) Whether client certificate expiry is ignored. + Default is `false`. +* `mode` - (Required) Valid values are `off`, `passthrough`, and `verify`. +* `trust_store_arn` - (Required when `mode` is `verify`, invalid otherwise) ARN of the elbv2 Trust Store. ## Attribute Reference This resource exports the following attributes in addition to the arguments above: -* `arn` - ARN of the listener (matches `id`). -* `id` - ARN of the listener (matches `arn`). +* `arn` - ARN of the listener. * `tags_all` - A map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). ~> **Note:** When importing a listener with a forward-type default action, you must include both a top-level target group ARN and a `forward` block with a `target_group` and `arn` to avoid import differences. @@ -528,4 +581,4 @@ Using `terraform import`, import listeners using their ARN. For example: % terraform import aws_lb_listener.front_end arn:aws:elasticloadbalancing:us-west-2:187416307283:listener/app/front-end-alb/8e4497da625e2d8a/9ab28ade35828f96 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/lb_listener_certificate.html.markdown b/website/docs/cdktf/python/r/lb_listener_certificate.html.markdown index 1c89e679c909..98d922c4c6c0 100644 --- a/website/docs/cdktf/python/r/lb_listener_certificate.html.markdown +++ b/website/docs/cdktf/python/r/lb_listener_certificate.html.markdown @@ -53,6 +53,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `listener_arn` - (Required, Forces New Resource) The ARN of the listener to which to attach the certificate. * `certificate_arn` - (Required, Forces New Resource) The ARN of the certificate to attach to the listener. @@ -87,4 +88,4 @@ Using `terraform import`, import Listener Certificates using the listener arn an % terraform import aws_lb_listener_certificate.example arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/test/8e4497da625e2d8a/9ab28ade35828f96/67b3d2d36dd7c26b_arn:aws:iam::123456789012:server-certificate/tf-acc-test-6453083910015726063 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/lb_listener_rule.html.markdown b/website/docs/cdktf/python/r/lb_listener_rule.html.markdown index b03a7efc7750..362dd6fb6f92 100644 --- a/website/docs/cdktf/python/r/lb_listener_rule.html.markdown +++ b/website/docs/cdktf/python/r/lb_listener_rule.html.markdown @@ -195,6 +195,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `listener_arn` - (Required, Forces New Resource) The ARN of the listener to which to attach the rule. * `priority` - (Optional) The priority for the rule between `1` and `50000`. Leaving it unset will automatically set the rule with next available priority after currently existing highest rule. A listener can't have multiple rules with the same priority. * `action` - (Required) An Action block. Action blocks are documented below. @@ -350,4 +351,4 @@ Using `terraform import`, import rules using their ARN. For example: % terraform import aws_lb_listener_rule.front_end arn:aws:elasticloadbalancing:us-west-2:187416307283:listener-rule/app/test/8e4497da625e2d8a/9ab28ade35828f96/67b3d2d36dd7c26b ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/lb_ssl_negotiation_policy.html.markdown b/website/docs/cdktf/python/r/lb_ssl_negotiation_policy.html.markdown index 2ae0327cb70b..c00a5951328d 100644 --- a/website/docs/cdktf/python/r/lb_ssl_negotiation_policy.html.markdown +++ b/website/docs/cdktf/python/r/lb_ssl_negotiation_policy.html.markdown @@ -73,6 +73,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) The name of the SSL negotiation policy. * `load_balancer` - (Required) The load balancer to which the policy should be attached. @@ -98,4 +99,4 @@ This resource exports the following attributes in addition to the arguments abov * `lb_port` - The load balancer port to which the policy is applied. * `attribute` - The SSL Negotiation policy attributes. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/lb_target_group.html.markdown b/website/docs/cdktf/python/r/lb_target_group.html.markdown index 573aa0e34926..c2c1f700b976 100644 --- a/website/docs/cdktf/python/r/lb_target_group.html.markdown +++ b/website/docs/cdktf/python/r/lb_target_group.html.markdown @@ -174,6 +174,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `connection_termination` - (Optional) Whether to terminate connections at the end of the deregistration timeout on Network Load Balancers. See [doc](https://docs.aws.amazon.com/elasticloadbalancing/latest/network/load-balancer-target-groups.html#deregistration-delay) for more information. Default is `false`. * `deregistration_delay` - (Optional) Amount time for Elastic Load Balancing to wait before changing the state of a deregistering target from draining to unused. The range is 0-3600 seconds. The default value is 300 seconds. * `health_check` - (Optional, Maximum of 1) Health Check configuration block. Detailed below. @@ -321,4 +322,4 @@ Using `terraform import`, import Target Groups using their ARN. For example: % terraform import aws_lb_target_group.app_front_end arn:aws:elasticloadbalancing:us-west-2:187416307283:targetgroup/app-front-end/20cfe21448b66314 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/lb_target_group_attachment.html.markdown b/website/docs/cdktf/python/r/lb_target_group_attachment.html.markdown index adcd0f7fc78a..2eba5778f52a 100644 --- a/website/docs/cdktf/python/r/lb_target_group_attachment.html.markdown +++ b/website/docs/cdktf/python/r/lb_target_group_attachment.html.markdown @@ -142,6 +142,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `availability_zone` - (Optional) The Availability Zone where the IP address of the target is to be registered. If the private IP address is outside of the VPC scope, this value must be set to `all`. * `port` - (Optional) The port on which targets receive traffic. @@ -155,4 +156,4 @@ This resource exports the following attributes in addition to the arguments abov You cannot import Target Group Attachments. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/lb_trust_store.html.markdown b/website/docs/cdktf/python/r/lb_trust_store.html.markdown index 9ba204d7b2ca..0347882ecb51 100644 --- a/website/docs/cdktf/python/r/lb_trust_store.html.markdown +++ b/website/docs/cdktf/python/r/lb_trust_store.html.markdown @@ -52,10 +52,10 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `ca_certificates_bundle_s3_bucket` - (Required) S3 Bucket name holding the client certificate CA bundle. * `ca_certificates_bundle_s3_key` - (Required) S3 object key holding the client certificate CA bundle. * `ca_certificates_bundle_s3_object_version` - (Optional) Version Id of CA bundle S3 bucket object, if versioned, defaults to latest if omitted. - * `name_prefix` - (Optional, Forces new resource) Creates a unique name beginning with the specified prefix. Conflicts with `name`. Cannot be longer than 6 characters. * `name` - (Optional, Forces new resource) Name of the Trust Store. If omitted, Terraform will assign a random, unique name. This name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, and must not begin or end with a hyphen. * `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. @@ -95,4 +95,4 @@ Using `terraform import`, import Target Groups using their ARN. For example: % terraform import aws_lb_trust_store.example arn:aws:elasticloadbalancing:us-west-2:187416307283:truststore/my-trust-store/20cfe21448b66314 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/lb_trust_store_revocation.html.markdown b/website/docs/cdktf/python/r/lb_trust_store_revocation.html.markdown index 1cc3bc33e19f..368118ec5c24 100644 --- a/website/docs/cdktf/python/r/lb_trust_store_revocation.html.markdown +++ b/website/docs/cdktf/python/r/lb_trust_store_revocation.html.markdown @@ -47,6 +47,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `trust_store_arn` - (Required) Trust Store ARN. * `revocations_s3_bucket` - (Required) S3 Bucket name holding the client certificate CA bundle. * `revocations_s3_key` - (Required) S3 object key holding the client certificate CA bundle. @@ -84,4 +85,4 @@ Using `terraform import`, import Trust Store Revocations using their ARN. For ex % terraform import aws_lb_trust_store_revocation.example arn:aws:elasticloadbalancing:us-west-2:187416307283:truststore/my-trust-store/20cfe21448b66314,6 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/lex_bot.html.markdown b/website/docs/cdktf/python/r/lex_bot.html.markdown index fa5a08d3678d..ad6abc384850 100644 --- a/website/docs/cdktf/python/r/lex_bot.html.markdown +++ b/website/docs/cdktf/python/r/lex_bot.html.markdown @@ -63,6 +63,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `abort_statement` - (Required) The message that Amazon Lex uses to abort a conversation. Attributes are documented under [statement](#statement). * `child_directed` - (Required) By specifying true, you confirm that your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. For more information see the [Amazon Lex FAQ](https://aws.amazon.com/lex/faqs#data-security) and the [Amazon Lex PutBot API Docs](https://docs.aws.amazon.com/lex/latest/dg/API_PutBot.html#lex-PutBot-request-childDirected). * `clarification_prompt` - (Required) The message that Amazon Lex uses when it doesn't understand the user's request. Attributes are documented under [prompt](#prompt). @@ -168,4 +169,4 @@ Using `terraform import`, import bots using their name. For example: % terraform import aws_lex_bot.order_flowers_bot OrderFlowers ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/lex_bot_alias.html.markdown b/website/docs/cdktf/python/r/lex_bot_alias.html.markdown index 95889e506f00..73aa0e3a2688 100644 --- a/website/docs/cdktf/python/r/lex_bot_alias.html.markdown +++ b/website/docs/cdktf/python/r/lex_bot_alias.html.markdown @@ -39,6 +39,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `bot_name` - (Required) The name of the bot. * `bot_version` - (Required) The version of the bot. * `conversation_logs` - (Optional) The settings that determine how Amazon Lex uses conversation logs for the alias. Attributes are documented under [conversation_logs](#conversation_logs). @@ -104,4 +105,4 @@ Using `terraform import`, import bot aliases using an ID with the format `bot_na % terraform import aws_lex_bot_alias.order_flowers_prod OrderFlowers:OrderFlowersProd ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/lex_intent.html.markdown b/website/docs/cdktf/python/r/lex_intent.html.markdown index 2940ee007145..81602e2810e3 100644 --- a/website/docs/cdktf/python/r/lex_intent.html.markdown +++ b/website/docs/cdktf/python/r/lex_intent.html.markdown @@ -108,6 +108,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `conclusion_statement` - (Optional) The statement that you want Amazon Lex to convey to the user after the intent is successfully fulfilled by the Lambda function. This element is relevant only if you provide a Lambda function in the `fulfillment_activity`. If you return the intent to the client @@ -273,4 +274,4 @@ Using `terraform import`, import intents using their name. For example: % terraform import aws_lex_intent.order_flowers_intent OrderFlowers ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/lex_slot_type.html.markdown b/website/docs/cdktf/python/r/lex_slot_type.html.markdown index f434c6485a7d..a46268452b9a 100644 --- a/website/docs/cdktf/python/r/lex_slot_type.html.markdown +++ b/website/docs/cdktf/python/r/lex_slot_type.html.markdown @@ -47,6 +47,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `enumeration_value` - (Required) A list of EnumerationValue objects that defines the values that the slot type can take. Each value can have a list of synonyms, which are additional values that help train the machine learning model about the values that it resolves for a slot. Attributes are @@ -115,4 +116,4 @@ Using `terraform import`, import slot types using their name. For example: % terraform import aws_lex_slot_type.flower_types FlowerTypes ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/lexv2models_bot.html.markdown b/website/docs/cdktf/python/r/lexv2models_bot.html.markdown index d2875bcdc579..df4a1ece2b07 100644 --- a/website/docs/cdktf/python/r/lexv2models_bot.html.markdown +++ b/website/docs/cdktf/python/r/lexv2models_bot.html.markdown @@ -77,6 +77,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `members` - List of bot members in a network to be created. See [`bot_members`](#bot-members). * `tags` - List of tags to add to the bot. You can only add tags when you create a bot. * `type` - Type of a bot to create. Possible values are `"Bot"` and `"BotNetwork"`. @@ -134,4 +135,4 @@ Using `terraform import`, import Lex V2 Models Bot using the `id`. For example: % terraform import aws_lexv2models_bot.example bot-id-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/lexv2models_bot_locale.html.markdown b/website/docs/cdktf/python/r/lexv2models_bot_locale.html.markdown index 06cc6b0f0c79..6d47b6fd0a24 100644 --- a/website/docs/cdktf/python/r/lexv2models_bot_locale.html.markdown +++ b/website/docs/cdktf/python/r/lexv2models_bot_locale.html.markdown @@ -74,6 +74,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `description` - Description of the bot locale. Use this to help identify the bot locale in lists. * `voice_settings` - Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user. See [`voice_settings`](#voice-settings). @@ -122,4 +123,4 @@ Using `terraform import`, import Lex V2 Models Bot Locale using the `id`. For ex % terraform import aws_lexv2models_bot_locale.example en_US,abcd-12345678,1 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/lexv2models_bot_version.html.markdown b/website/docs/cdktf/python/r/lexv2models_bot_version.html.markdown index 8100b67a327f..48eb911d5b39 100644 --- a/website/docs/cdktf/python/r/lexv2models_bot_version.html.markdown +++ b/website/docs/cdktf/python/r/lexv2models_bot_version.html.markdown @@ -43,12 +43,13 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `bot_id` - (Required) Idientifier of the bot to create the version for. * `locale_specification` - (Required) Specifies the locales that Amazon Lex adds to this version. You can choose the draft version or any other previously published version for each locale. When you specify a source version, the locale data is copied from the source version to the new version. - - The attribute value is a map with one or more entries, each of which has a locale name as the key and an object with the following attribute as the value: - * `sourceBotVersion` - (Required) The version of a bot used for a bot locale. Valid values: `DRAFT`, a numeric version. * `description` - (Optional) A description of the version. Use the description to help identify the version in lists. +* `sourceBotVersion` - (Required) The version of a bot used for a bot locale. Valid values: `DRAFT`, a numeric version. + +The `locale_specification` attribute value is a map with one or more entries, each of which has a locale name as the key and an object with the following attribute as the value: ## Attribute Reference @@ -89,4 +90,4 @@ Using `terraform import`, import Lex V2 Models Bot Version using the `id`. For e % terraform import aws_lexv2models_bot_version.example id-12345678,1 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/lexv2models_intent.html.markdown b/website/docs/cdktf/python/r/lexv2models_intent.html.markdown index 4d1d52637d5f..43bdeb7d8d64 100644 --- a/website/docs/cdktf/python/r/lexv2models_intent.html.markdown +++ b/website/docs/cdktf/python/r/lexv2models_intent.html.markdown @@ -178,6 +178,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `closing_setting` - (Optional) Configuration block for the response that Amazon Lex sends to the user when the intent is closed. See [`closing_setting`](#closing_setting). * `confirmation_setting` - (Optional) Configuration block for prompts that Amazon Lex sends to the user to confirm the completion of an intent. If the user answers "no," the settings contain a statement that is sent to the user to end the intent. If you configure this block without `prompt_specification.*.prompt_attempts_specification`, AWS will provide default configurations for `Initial` and `Retry1` `prompt_attempts_specification`s. This will cause Terraform to report differences. Use the `confirmation_setting` configuration above in the [Basic Usage](#basic-usage) example to avoid differences resulting from AWS default configuration. See [`confirmation_setting`](#confirmation_setting). * `description` - (Optional) Description of the intent. Use the description to help identify the intent in lists. @@ -582,4 +583,4 @@ Using `terraform import`, import Lex V2 Models Intent using the `intent_id:bot_i % terraform import aws_lexv2models_intent.example intent-42874:bot-11376:DRAFT:en_US ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/lexv2models_slot.html.markdown b/website/docs/cdktf/python/r/lexv2models_slot.html.markdown index 0520b2ed3389..5a56f411377f 100644 --- a/website/docs/cdktf/python/r/lexv2models_slot.html.markdown +++ b/website/docs/cdktf/python/r/lexv2models_slot.html.markdown @@ -159,6 +159,7 @@ See the [`value_elicitation_setting` argument reference](#value_elicitation_sett The following arguments are optional: +* `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). * `description` - (Optional) Description of the slot. * `multiple_values_setting` - (Optional) Whether the slot returns multiple values in one response. See the [`multiple_values_setting` argument reference](#multiple_values_setting-argument-reference) below. @@ -305,4 +306,4 @@ Using `terraform import`, import Lex V2 Models Slot using the `id`. For example: % terraform import aws_lexv2models_slot.example bot-1234,1,intent-5678,en-US,slot-9012 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/lexv2models_slot_type.html.markdown b/website/docs/cdktf/python/r/lexv2models_slot_type.html.markdown index 8981c3b9829b..a20736ddb734 100644 --- a/website/docs/cdktf/python/r/lexv2models_slot_type.html.markdown +++ b/website/docs/cdktf/python/r/lexv2models_slot_type.html.markdown @@ -100,6 +100,7 @@ All of the bots, slot types, and slots used by the intent must have the same loc The following arguments are optional: +* `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). * `description` - (Optional) Description of the slot type. * `composite_slot_type_setting` - (Optional) Specifications for a composite slot type. See [`composite_slot_type_setting` argument reference](#composite_slot_type_setting-argument-reference) below. @@ -215,4 +216,4 @@ Using `terraform import`, import Lex V2 Models Slot Type using using a comma-del % terraform import aws_lexv2models_slot_type.example bot-1234,DRAFT,en_US,slot_type-id-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/licensemanager_association.html.markdown b/website/docs/cdktf/python/r/licensemanager_association.html.markdown index 8d6642bc9eb5..78a09326339f 100644 --- a/website/docs/cdktf/python/r/licensemanager_association.html.markdown +++ b/website/docs/cdktf/python/r/licensemanager_association.html.markdown @@ -64,6 +64,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `license_configuration_arn` - (Required) ARN of the license configuration. * `resource_arn` - (Required) ARN of the resource associated with the license configuration. @@ -98,4 +99,4 @@ Using `terraform import`, import license configurations using `resource_arn,lice % terraform import aws_licensemanager_association.example arn:aws:ec2:eu-west-1:123456789012:image/ami-123456789abcdef01,arn:aws:license-manager:eu-west-1:123456789012:license-configuration:lic-0123456789abcdef0123456789abcdef ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/licensemanager_grant.html.markdown b/website/docs/cdktf/python/r/licensemanager_grant.html.markdown index 0ee9118a3c02..ea521d734b35 100644 --- a/website/docs/cdktf/python/r/licensemanager_grant.html.markdown +++ b/website/docs/cdktf/python/r/licensemanager_grant.html.markdown @@ -40,6 +40,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) The Name of the grant. * `allowed_operations` - (Required) A list of the allowed operations for the grant. This is a subset of the allowed operations on the license. * `license_arn` - (Required) The ARN of the license to grant. @@ -81,4 +82,4 @@ Using `terraform import`, import `aws_licensemanager_grant` using the grant arn. % terraform import aws_licensemanager_grant.test arn:aws:license-manager::123456789011:grant:g-01d313393d9e443d8664cc054db1e089 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/licensemanager_grant_accepter.html.markdown b/website/docs/cdktf/python/r/licensemanager_grant_accepter.html.markdown index 2143d7c801cb..26c248fba940 100644 --- a/website/docs/cdktf/python/r/licensemanager_grant_accepter.html.markdown +++ b/website/docs/cdktf/python/r/licensemanager_grant_accepter.html.markdown @@ -35,6 +35,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `grant_arn` - (Required) The ARN of the grant to accept. ## Attribute Reference @@ -77,4 +78,4 @@ Using `terraform import`, import `aws_licensemanager_grant_accepter` using the g % terraform import aws_licensemanager_grant_accepter.test arn:aws:license-manager::123456789012:grant:g-1cf9fba4ba2f42dcab11c686c4b4d329 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/licensemanager_license_configuration.html.markdown b/website/docs/cdktf/python/r/licensemanager_license_configuration.html.markdown index d6f48e935537..88a3bbc3f653 100644 --- a/website/docs/cdktf/python/r/licensemanager_license_configuration.html.markdown +++ b/website/docs/cdktf/python/r/licensemanager_license_configuration.html.markdown @@ -45,6 +45,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) Name of the license configuration. * `description` - (Optional) Description of the license configuration. * `license_count` - (Optional) Number of licenses managed by the license configuration. @@ -99,4 +100,4 @@ Using `terraform import`, import license configurations using the `id`. For exam % terraform import aws_licensemanager_license_configuration.example arn:aws:license-manager:eu-west-1:123456789012:license-configuration:lic-0123456789abcdef0123456789abcdef ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/lightsail_bucket.html.markdown b/website/docs/cdktf/python/r/lightsail_bucket.html.markdown index 008c57dd849b..f25c0705ecd2 100644 --- a/website/docs/cdktf/python/r/lightsail_bucket.html.markdown +++ b/website/docs/cdktf/python/r/lightsail_bucket.html.markdown @@ -42,6 +42,7 @@ The following arguments are required: The following arguments are optional: * `force_delete` - (Optional) Whether to force delete non-empty buckets using `terraform destroy`. AWS by default will not delete a bucket which is not empty, to prevent losing bucket data and affecting other resources in Lightsail. If `force_delete` is set to `true` the bucket will be deleted even when not empty. +* `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). * `tags` - (Optional) Map of tags to assign to the resource. To create a key-only tag, use an empty string as the value. If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level. ## Attribute Reference @@ -52,7 +53,6 @@ This resource exports the following attributes in addition to the arguments abov * `availability_zone` - Availability Zone. Follows the format us-east-2a (case-sensitive). * `created_at` - Date and time when the bucket was created. * `id` - Name used for this bucket (matches `name`). -* `region` - AWS Region name. * `support_code` - Support code for the resource. Include this code in your email to support when you have questions about a resource in Lightsail. This code enables our support team to look up your Lightsail information more easily. * `tags_all` - Map of tags assigned to the resource, including those inherited from the provider `default_tags` configuration block. * `url` - URL of the bucket. @@ -82,4 +82,4 @@ Using `terraform import`, import `aws_lightsail_bucket` using the `name` attribu % terraform import aws_lightsail_bucket.example example-bucket ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/lightsail_bucket_access_key.html.markdown b/website/docs/cdktf/python/r/lightsail_bucket_access_key.html.markdown index df2382598d58..621896977839 100644 --- a/website/docs/cdktf/python/r/lightsail_bucket_access_key.html.markdown +++ b/website/docs/cdktf/python/r/lightsail_bucket_access_key.html.markdown @@ -43,6 +43,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: * `bucket_name` - (Required) Name of the bucket that the access key will belong to and grant access to. +* `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). ## Attribute Reference @@ -79,4 +80,4 @@ Using `terraform import`, import `aws_lightsail_bucket_access_key` using the `id % terraform import aws_lightsail_bucket_access_key.example example-bucket,AKIAIOSFODNN7EXAMPLE ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/lightsail_bucket_resource_access.html.markdown b/website/docs/cdktf/python/r/lightsail_bucket_resource_access.html.markdown index b39ee8e13b43..d08cd607d682 100644 --- a/website/docs/cdktf/python/r/lightsail_bucket_resource_access.html.markdown +++ b/website/docs/cdktf/python/r/lightsail_bucket_resource_access.html.markdown @@ -54,6 +54,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: * `bucket_name` - (Required) Name of the bucket to grant access to. +* `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). * `resource_name` - (Required) Name of the resource to grant bucket access. ## Attribute Reference @@ -87,4 +88,4 @@ Using `terraform import`, import `aws_lightsail_bucket_resource_access` using th % terraform import aws_lightsail_bucket_resource_access.example example-bucket,example-instance ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/lightsail_certificate.html.markdown b/website/docs/cdktf/python/r/lightsail_certificate.html.markdown index adac4f2c59dc..860197df8f35 100644 --- a/website/docs/cdktf/python/r/lightsail_certificate.html.markdown +++ b/website/docs/cdktf/python/r/lightsail_certificate.html.markdown @@ -42,6 +42,7 @@ The following arguments are required: The following arguments are optional: * `domain_name` - (Optional) Domain name for which the certificate should be issued. +* `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). * `subject_alternative_names` - (Optional) Set of domains that should be SANs in the issued certificate. `domain_name` attribute is automatically added as a Subject Alternative Name. * `tags` - (Optional) Map of tags to assign to the resource. To create a key-only tag, use an empty string as the value. If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level. @@ -84,4 +85,4 @@ Using `terraform import`, import `aws_lightsail_certificate` using the certifica % terraform import aws_lightsail_certificate.example example-certificate ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/lightsail_container_service.html.markdown b/website/docs/cdktf/python/r/lightsail_container_service.html.markdown index c5bf77ef2523..a5eb60f61cd9 100644 --- a/website/docs/cdktf/python/r/lightsail_container_service.html.markdown +++ b/website/docs/cdktf/python/r/lightsail_container_service.html.markdown @@ -137,6 +137,7 @@ The following arguments are optional: * `is_disabled` - (Optional) Whether to disable the container service. Defaults to `false`. * `private_registry_access` - (Optional) Configuration for the container service to access private container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private repositories. [See below](#private-registry-access). * `public_domain_names` - (Optional) Public domain names to use with the container service, such as example.com and www.example.com. You can specify up to four public domain names for a container service. The domain names that you specify are used when you create a deployment with a container configured as the public endpoint of your container service. If you don't specify public domain names, then you can use the default domain of the container service. [See below](#public-domain-names). +* `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). * `tags` - (Optional) Map of tags to assign to the resource. To create a key-only tag, use an empty string as the value. If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level. ### Private Registry Access @@ -212,4 +213,4 @@ Using `terraform import`, import Lightsail Container Service using the `name`. F % terraform import aws_lightsail_container_service.example container-service-1 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/lightsail_container_service_deployment_version.html.markdown b/website/docs/cdktf/python/r/lightsail_container_service_deployment_version.html.markdown index a3f7d6141788..0fcfcc4fb004 100644 --- a/website/docs/cdktf/python/r/lightsail_container_service_deployment_version.html.markdown +++ b/website/docs/cdktf/python/r/lightsail_container_service_deployment_version.html.markdown @@ -71,6 +71,7 @@ The following arguments are required: The following arguments are optional: * `public_endpoint` - (Optional) Configuration block that describes the settings of the public endpoint for the container service. [See below](#public_endpoint). +* `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). ### `container` @@ -141,4 +142,4 @@ Using `terraform import`, import Lightsail Container Service Deployment Version % terraform import aws_lightsail_container_service_deployment_version.example container-service-1/1 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/lightsail_database.html.markdown b/website/docs/cdktf/python/r/lightsail_database.html.markdown index 498afd49e24c..878babfdbfb1 100644 --- a/website/docs/cdktf/python/r/lightsail_database.html.markdown +++ b/website/docs/cdktf/python/r/lightsail_database.html.markdown @@ -173,6 +173,7 @@ The following arguments are optional: * `preferred_backup_window` - (Optional) Daily time range during which automated backups are created for your database if automated backups are enabled. Must be in the hh24:mi-hh24:mi format. Example: `16:00-16:30`. Specified in Coordinated Universal Time (UTC). * `preferred_maintenance_window` - (Optional) Weekly time range during which system maintenance can occur on your database. Must be in the ddd:hh24:mi-ddd:hh24:mi format. Specified in Coordinated Universal Time (UTC). Example: `Tue:17:00-Tue:17:30` * `publicly_accessible` - (Optional) Whether the database is accessible to resources outside of your Lightsail account. A value of true specifies a database that is available to resources outside of your Lightsail account. A value of false specifies a database that is available only to your Lightsail resources in the same region as your database. +* `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). * `skip_final_snapshot` - (Optional) Whether a final database snapshot is created before your database is deleted. If true is specified, no database snapshot is created. If false is specified, a database snapshot is created before your database is deleted. You must specify the final relational database snapshot name parameter if the skip final snapshot parameter is false. * `tags` - (Optional) Map of tags to assign to the resource. To create a key-only tag, use an empty string as the value. If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level. @@ -267,4 +268,4 @@ Using `terraform import`, import Lightsail Databases using their name. For examp % terraform import aws_lightsail_database.example example-database ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/lightsail_disk.html.markdown b/website/docs/cdktf/python/r/lightsail_disk.html.markdown index 98c89be0ac60..ed2dd904170e 100644 --- a/website/docs/cdktf/python/r/lightsail_disk.html.markdown +++ b/website/docs/cdktf/python/r/lightsail_disk.html.markdown @@ -52,6 +52,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `tags` - (Optional) Map of tags to assign to the resource. To create a key-only tag, use an empty string as the value. If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level. ## Attribute Reference @@ -89,4 +90,4 @@ Using `terraform import`, import `aws_lightsail_disk` using the name attribute. % terraform import aws_lightsail_disk.example example-disk ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/lightsail_disk_attachment.html.markdown b/website/docs/cdktf/python/r/lightsail_disk_attachment.html.markdown index 16f64e3c1c2b..1341b25bec8f 100644 --- a/website/docs/cdktf/python/r/lightsail_disk_attachment.html.markdown +++ b/website/docs/cdktf/python/r/lightsail_disk_attachment.html.markdown @@ -67,6 +67,7 @@ This resource supports the following arguments: * `disk_name` - (Required) Name of the Lightsail disk. * `disk_path` - (Required) Disk path to expose to the instance. * `instance_name` - (Required) Name of the Lightsail instance to attach to. +* `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). ## Attribute Reference @@ -99,4 +100,4 @@ Using `terraform import`, import `aws_lightsail_disk_attachment` using the id at % terraform import aws_lightsail_disk_attachment.example example-disk,example-instance ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/lightsail_distribution.html.markdown b/website/docs/cdktf/python/r/lightsail_distribution.html.markdown index bd3259dcef6b..d210573aa2cb 100644 --- a/website/docs/cdktf/python/r/lightsail_distribution.html.markdown +++ b/website/docs/cdktf/python/r/lightsail_distribution.html.markdown @@ -206,6 +206,7 @@ The following arguments are optional: * `certificate_name` - (Optional) Name of the SSL/TLS certificate attached to the distribution. * `ip_address_type` - (Optional) IP address type of the distribution. Valid values: `dualstack`, `ipv4`. Default: `dualstack`. * `is_enabled` - (Optional) Whether the distribution is enabled. Default: `true`. +* `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). * `tags` - (Optional) Map of tags for the Lightsail Distribution. 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. ### cache_behavior @@ -303,4 +304,4 @@ Using `terraform import`, import Lightsail Distribution using the `name`. For ex % terraform import aws_lightsail_distribution.example example-distribution ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/lightsail_domain.html.markdown b/website/docs/cdktf/python/r/lightsail_domain.html.markdown index 61854ac0f835..016e67ac4eed 100644 --- a/website/docs/cdktf/python/r/lightsail_domain.html.markdown +++ b/website/docs/cdktf/python/r/lightsail_domain.html.markdown @@ -41,6 +41,10 @@ The following arguments are required: * `domain_name` - (Required) Name of the Lightsail domain to manage. +The following arguments are optional: + +* `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). + ## Attribute Reference This resource exports the following attributes in addition to the arguments above: @@ -48,4 +52,4 @@ This resource exports the following attributes in addition to the arguments abov * `arn` - ARN of the Lightsail domain. * `id` - Name used for this domain. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/lightsail_domain_entry.html.markdown b/website/docs/cdktf/python/r/lightsail_domain_entry.html.markdown index 1fd814b1217b..2776a8bca1b3 100644 --- a/website/docs/cdktf/python/r/lightsail_domain_entry.html.markdown +++ b/website/docs/cdktf/python/r/lightsail_domain_entry.html.markdown @@ -54,6 +54,7 @@ The following arguments are required: The following arguments are optional: * `is_alias` - (Optional) Whether the entry should be an alias. Default: `false`. +* `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). ## Attribute Reference @@ -86,4 +87,4 @@ Using `terraform import`, import Lightsail Domain Entry using the id attribute. % terraform import aws_lightsail_domain_entry.example www,example.com,A,127.0.0.1 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/lightsail_instance.html.markdown b/website/docs/cdktf/python/r/lightsail_instance.html.markdown index b60293009144..328a0d1abd6b 100644 --- a/website/docs/cdktf/python/r/lightsail_instance.html.markdown +++ b/website/docs/cdktf/python/r/lightsail_instance.html.markdown @@ -111,6 +111,7 @@ The following arguments are optional: * `add_on` - (Optional) Add-on configuration for the instance. [See below](#add_on). * `ip_address_type` - (Optional) IP address type of the Lightsail Instance. Valid values: `dualstack`, `ipv4`, `ipv6`. Default: `dualstack`. * `key_pair_name` - (Optional) Name of your key pair. Created in the Lightsail console (cannot use `aws_key_pair` at this time). +* `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). * `tags` - (Optional) Map of tags to assign to the resource. To create a key-only tag, use an empty string as the value. 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. * `user_data` - (Optional) Single lined launch script as a string to configure server with additional user data. @@ -163,4 +164,4 @@ Using `terraform import`, import Lightsail Instances using their name. For examp % terraform import aws_lightsail_instance.example 'example' ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/lightsail_instance_public_ports.html.markdown b/website/docs/cdktf/python/r/lightsail_instance_public_ports.html.markdown index 604e9ffd7da7..c092e9c58a57 100644 --- a/website/docs/cdktf/python/r/lightsail_instance_public_ports.html.markdown +++ b/website/docs/cdktf/python/r/lightsail_instance_public_ports.html.markdown @@ -69,22 +69,23 @@ class MyConvertedCode(TerraformStack): The following arguments are required: -* `instance_name` - (Required) Name of the Lightsail Instance. -* `port_info` - (Required) Configuration block with port information. AWS closes all currently open ports that are not included in the `port_info`. [See below](#port_info). +* `instance_name` - (Required) Name of the instance for which to open ports. +* `port_info` - (Required) Descriptor of the ports to open for the specified instance. AWS closes all currently open ports that are not included in this argument. See [`port_info` Block](#port_info-block) for details. -### port_info +The following arguments are optional: -The following arguments are required: +* `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). -* `from_port` - (Required) First port in a range of open ports on an instance. -* `protocol` - (Required) IP protocol name. Valid values: `tcp`, `all`, `udp`, `icmp`. -* `to_port` - (Required) Last port in a range of open ports on an instance. +### `port_info` Block -The following arguments are optional: +The `port_info` configuration block supports the following arguments: +* `from_port` - (Required) First port in a range of open ports on an instance. See [PortInfo](https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_PortInfo.html) for details. +* `protocol` - (Required) IP protocol name. Valid values: `tcp`, `all`, `udp`, `icmp`, `icmpv6`. See [PortInfo](https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_PortInfo.html) for details. +* `to_port` - (Required) Last port in a range of open ports on an instance. See [PortInfo](https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_PortInfo.html) for details. * `cidr_list_aliases` - (Optional) Set of CIDR aliases that define access for a preconfigured range of IP addresses. -* `cidrs` - (Optional) Set of CIDR blocks. -* `ipv6_cidrs` - (Optional) Set of IPv6 CIDR blocks. +* `cidrs` - (Optional) Set of IPv4 addresses or ranges of IPv4 addresses (in CIDR notation) that are allowed to connect to an instance through the ports, and the protocol. +* `ipv6_cidrs` - (Optional) Set of IPv6 addresses or ranges of IPv6 addresses (in CIDR notation) that are allowed to connect to an instance through the ports, and the protocol. ## Attribute Reference @@ -92,4 +93,4 @@ This resource exports the following attributes in addition to the arguments abov * `id` - ID of the resource. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/lightsail_key_pair.html.markdown b/website/docs/cdktf/python/r/lightsail_key_pair.html.markdown index fcf3439dca85..e8b497435700 100644 --- a/website/docs/cdktf/python/r/lightsail_key_pair.html.markdown +++ b/website/docs/cdktf/python/r/lightsail_key_pair.html.markdown @@ -83,6 +83,7 @@ The following arguments are optional: * `name_prefix` - (Optional) Creates a unique name beginning with the specified prefix. Conflicts with `name`. * `pgp_key` - (Optional) PGP key to encrypt the resulting private key material. Only used when creating a new key pair. * `public_key` - (Optional) Public key material. This public key will be imported into Lightsail. +* `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). * `tags` - (Optional) Map of tags to assign to the resource. To create a key-only tag, use an empty string as the value. 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. ~> **Note:** A PGP key is not required, however it is strongly encouraged. Without a PGP key, the private key material will be stored in state unencrypted. `pgp_key` is ignored if `public_key` is supplied. @@ -104,4 +105,4 @@ This resource exports the following attributes in addition to the arguments abov You cannot import Lightsail Key Pairs because the private and public key are only available on initial creation. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/lightsail_lb.html.markdown b/website/docs/cdktf/python/r/lightsail_lb.html.markdown index f8c2e2f22e3a..bc1f7de6b80d 100644 --- a/website/docs/cdktf/python/r/lightsail_lb.html.markdown +++ b/website/docs/cdktf/python/r/lightsail_lb.html.markdown @@ -49,6 +49,7 @@ The following arguments are optional: * `health_check_path` - (Optional) Health check path of the load balancer. Default value `/`. * `ip_address_type` - (Optional) IP address type of the load balancer. Valid values: `dualstack`, `ipv4`. Default value `dualstack`. +* `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). * `tags` - (Optional) Map of tags to assign to the resource. To create a key-only tag, use an empty string as the value. If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level. ## Attribute Reference @@ -89,4 +90,4 @@ Using `terraform import`, import `aws_lightsail_lb` using the name attribute. Fo % terraform import aws_lightsail_lb.example example-load-balancer ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/lightsail_lb_attachment.html.markdown b/website/docs/cdktf/python/r/lightsail_lb_attachment.html.markdown index 490e66f68acf..0c8004338507 100644 --- a/website/docs/cdktf/python/r/lightsail_lb_attachment.html.markdown +++ b/website/docs/cdktf/python/r/lightsail_lb_attachment.html.markdown @@ -69,6 +69,10 @@ The following arguments are required: * `instance_name` - (Required) Name of the instance to attach to the load balancer. * `lb_name` - (Required) Name of the Lightsail load balancer. +The following arguments are optional: + +* `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). + ## Attribute Reference This resource exports the following attributes in addition to the arguments above: @@ -100,4 +104,4 @@ Using `terraform import`, import `aws_lightsail_lb_attachment` using the name at % terraform import aws_lightsail_lb_attachment.example example-load-balancer,example-instance ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/lightsail_lb_certificate.html.markdown b/website/docs/cdktf/python/r/lightsail_lb_certificate.html.markdown index ed5bf25db4ae..5b89394de721 100644 --- a/website/docs/cdktf/python/r/lightsail_lb_certificate.html.markdown +++ b/website/docs/cdktf/python/r/lightsail_lb_certificate.html.markdown @@ -56,6 +56,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `subject_alternative_names` - (Optional) Set of domains that should be SANs in the issued certificate. `domain_name` attribute is automatically added as a Subject Alternative Name. ## Attribute Reference @@ -93,4 +94,4 @@ Using `terraform import`, import `aws_lightsail_lb_certificate` using the id att % terraform import aws_lightsail_lb_certificate.example example-load-balancer,example-load-balancer-certificate ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/lightsail_lb_certificate_attachment.html.markdown b/website/docs/cdktf/python/r/lightsail_lb_certificate_attachment.html.markdown index bb75e898fe70..4c2d6e030ed4 100644 --- a/website/docs/cdktf/python/r/lightsail_lb_certificate_attachment.html.markdown +++ b/website/docs/cdktf/python/r/lightsail_lb_certificate_attachment.html.markdown @@ -61,6 +61,10 @@ The following arguments are required: * `certificate_name` - (Required) Name of your SSL/TLS certificate. * `lb_name` - (Required) Name of the load balancer to which you want to associate the SSL/TLS certificate. +The following arguments are optional: + +* `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). + ## Attribute Reference This resource exports the following attributes in addition to the arguments above: @@ -92,4 +96,4 @@ Using `terraform import`, import `aws_lightsail_lb_certificate_attachment` using % terraform import aws_lightsail_lb_certificate_attachment.example example-load-balancer,example-certificate ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/lightsail_lb_https_redirection_policy.html.markdown b/website/docs/cdktf/python/r/lightsail_lb_https_redirection_policy.html.markdown index 784522065e80..c7bef610992c 100644 --- a/website/docs/cdktf/python/r/lightsail_lb_https_redirection_policy.html.markdown +++ b/website/docs/cdktf/python/r/lightsail_lb_https_redirection_policy.html.markdown @@ -69,6 +69,10 @@ The following arguments are required: * `enabled` - (Required) Whether to enable HTTP to HTTPS redirection. `true` to activate HTTP to HTTPS redirection or `false` to deactivate HTTP to HTTPS redirection. * `lb_name` - (Required) Name of the load balancer to which you want to enable HTTP to HTTPS redirection. +The following arguments are optional: + +* `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). + ## Attribute Reference This resource exports the following attributes in addition to the arguments above: @@ -100,4 +104,4 @@ Using `terraform import`, import `aws_lightsail_lb_https_redirection_policy` usi % terraform import aws_lightsail_lb_https_redirection_policy.example example-load-balancer ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/lightsail_lb_stickiness_policy.html.markdown b/website/docs/cdktf/python/r/lightsail_lb_stickiness_policy.html.markdown index ccd419f7bf7b..cbc679e49083 100644 --- a/website/docs/cdktf/python/r/lightsail_lb_stickiness_policy.html.markdown +++ b/website/docs/cdktf/python/r/lightsail_lb_stickiness_policy.html.markdown @@ -55,6 +55,10 @@ The following arguments are required: * `enabled` - (Required) Whether to enable session stickiness for the load balancer. * `lb_name` - (Required) Name of the load balancer to which you want to enable session stickiness. +The following arguments are optional: + +* `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). + ## Attribute Reference This resource exports the following attributes in addition to the arguments above: @@ -86,4 +90,4 @@ Using `terraform import`, import `aws_lightsail_lb_stickiness_policy` using the % terraform import aws_lightsail_lb_stickiness_policy.example example-load-balancer ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/lightsail_static_ip.html.markdown b/website/docs/cdktf/python/r/lightsail_static_ip.html.markdown index 872168f578ec..73e8d96057c8 100644 --- a/website/docs/cdktf/python/r/lightsail_static_ip.html.markdown +++ b/website/docs/cdktf/python/r/lightsail_static_ip.html.markdown @@ -41,6 +41,10 @@ The following arguments are required: * `name` - (Required) Name for the allocated static IP. +The following arguments are optional: + +* `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). + ## Attribute Reference This resource exports the following attributes in addition to the arguments above: @@ -74,4 +78,4 @@ Using `terraform import`, import `aws_lightsail_static_ip` using the name attrib % terraform import aws_lightsail_static_ip.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/lightsail_static_ip_attachment.html.markdown b/website/docs/cdktf/python/r/lightsail_static_ip_attachment.html.markdown index e0e6b4b19c30..ef6261004876 100644 --- a/website/docs/cdktf/python/r/lightsail_static_ip_attachment.html.markdown +++ b/website/docs/cdktf/python/r/lightsail_static_ip_attachment.html.markdown @@ -59,6 +59,10 @@ The following arguments are required: * `instance_name` - (Required) Name of the Lightsail instance to attach the IP to. * `static_ip_name` - (Required) Name of the allocated static IP. +The following arguments are optional: + +* `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). + ## Attribute Reference This resource exports the following attributes in addition to the arguments above: @@ -90,4 +94,4 @@ Using `terraform import`, import `aws_lightsail_static_ip_attachment` using the % terraform import aws_lightsail_static_ip_attachment.example example-static-ip ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/load_balancer_backend_server_policy.html.markdown b/website/docs/cdktf/python/r/load_balancer_backend_server_policy.html.markdown index a26752a00a90..7f32eb5316ac 100644 --- a/website/docs/cdktf/python/r/load_balancer_backend_server_policy.html.markdown +++ b/website/docs/cdktf/python/r/load_balancer_backend_server_policy.html.markdown @@ -74,6 +74,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `load_balancer_name` - (Required) The load balancer to attach the policy to. * `policy_names` - (Required) List of Policy Names to apply to the backend server. * `instance_port` - (Required) The instance port to apply the policy to. @@ -86,4 +87,4 @@ This resource exports the following attributes in addition to the arguments abov * `load_balancer_name` - The load balancer on which the policy is defined. * `instance_port` - The backend port the policies are applied to - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/load_balancer_listener_policy.html.markdown b/website/docs/cdktf/python/r/load_balancer_listener_policy.html.markdown index b0dae15f47fd..ddd4b3c1bcad 100644 --- a/website/docs/cdktf/python/r/load_balancer_listener_policy.html.markdown +++ b/website/docs/cdktf/python/r/load_balancer_listener_policy.html.markdown @@ -121,6 +121,7 @@ This example shows how to add a [Predefined Security Policy for ELBs](https://do This resource supports the following arguments: +* `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). * `load_balancer_name` - (Required) The load balancer to attach the policy to. * `load_balancer_port` - (Required) The load balancer listener port to apply the policy to. * `policy_names` - (Required) List of Policy Names to apply to the backend server. @@ -134,4 +135,4 @@ This resource exports the following attributes in addition to the arguments abov * `load_balancer_name` - The load balancer on which the policy is defined. * `load_balancer_port` - The load balancer listener port the policies are applied to - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/load_balancer_policy.html.markdown b/website/docs/cdktf/python/r/load_balancer_policy.html.markdown index 86eae0fc813b..0f6c2d835dba 100644 --- a/website/docs/cdktf/python/r/load_balancer_policy.html.markdown +++ b/website/docs/cdktf/python/r/load_balancer_policy.html.markdown @@ -103,6 +103,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `load_balancer_name` - (Required) The load balancer on which the policy is defined. * `policy_name` - (Required) The name of the load balancer policy. * `policy_type_name` - (Required) The policy type. @@ -117,4 +118,4 @@ This resource exports the following attributes in addition to the arguments abov * `policy_type_name` - The policy type of the policy. * `load_balancer_name` - The load balancer on which the policy is defined. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/location_geofence_collection.html.markdown b/website/docs/cdktf/python/r/location_geofence_collection.html.markdown index 1f53b36b1b03..eadfba5f7f67 100644 --- a/website/docs/cdktf/python/r/location_geofence_collection.html.markdown +++ b/website/docs/cdktf/python/r/location_geofence_collection.html.markdown @@ -39,6 +39,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `description` - (Optional) The optional description for the geofence collection. * `kms_key_id` - (Optional) A key identifier for an AWS KMS customer managed key assigned to the Amazon Location resource. * `tags` - (Optional) Key-value tags for the geofence collection. 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. @@ -84,4 +85,4 @@ Using `terraform import`, import Location Geofence Collection using the `collect % terraform import aws_location_geofence_collection.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/location_map.html.markdown b/website/docs/cdktf/python/r/location_map.html.markdown index 2c65e37b7b36..fd99d8636431 100644 --- a/website/docs/cdktf/python/r/location_map.html.markdown +++ b/website/docs/cdktf/python/r/location_map.html.markdown @@ -43,6 +43,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `description` - (Optional) An optional description for the map resource. * `tags` - (Optional) Key-value tags for the map. 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. @@ -86,4 +87,4 @@ Using `terraform import`, import `aws_location_map` resources using the map name % terraform import aws_location_map.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/location_place_index.html.markdown b/website/docs/cdktf/python/r/location_place_index.html.markdown index 5e2f98089741..aec94e64ee85 100644 --- a/website/docs/cdktf/python/r/location_place_index.html.markdown +++ b/website/docs/cdktf/python/r/location_place_index.html.markdown @@ -41,6 +41,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `data_source_configuration` - (Optional) Configuration block with the data storage option chosen for requesting Places. Detailed below. * `description` - (Optional) The optional description for the place index resource. * `tags` - (Optional) Key-value tags for the place index. 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. @@ -49,6 +50,7 @@ The following arguments are optional: The following arguments are optional: +* `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). * `intended_use` - (Optional) Specifies how the results of an operation will be stored by the caller. Valid values: `SingleUse`, `Storage`. Default: `SingleUse`. ## Attribute Reference @@ -85,4 +87,4 @@ Using `terraform import`, import `aws_location_place_index` resources using the % terraform import aws_location_place_index.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/location_route_calculator.html.markdown b/website/docs/cdktf/python/r/location_route_calculator.html.markdown index 6d55917a862e..7bf6204be6f0 100644 --- a/website/docs/cdktf/python/r/location_route_calculator.html.markdown +++ b/website/docs/cdktf/python/r/location_route_calculator.html.markdown @@ -41,6 +41,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `description` - (Optional) The optional description for the route calculator resource. * `tags` - (Optional) Key-value tags for the route calculator. 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. @@ -86,4 +87,4 @@ Using `terraform import`, import `aws_location_route_calculator` using the route % terraform import aws_location_route_calculator.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/location_tracker.html.markdown b/website/docs/cdktf/python/r/location_tracker.html.markdown index 6a56e5131b2f..2e9e22e9edae 100644 --- a/website/docs/cdktf/python/r/location_tracker.html.markdown +++ b/website/docs/cdktf/python/r/location_tracker.html.markdown @@ -39,6 +39,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `description` - (Optional) The optional description for the tracker resource. * `kms_key_id` - (Optional) A key identifier for an AWS KMS customer managed key assigned to the Amazon Location resource. * `position_filtering` - (Optional) The position filtering method of the tracker resource. Valid values: `TimeBased`, `DistanceBased`, `AccuracyBased`. Default: `TimeBased`. @@ -78,4 +79,4 @@ Using `terraform import`, import `aws_location_tracker` resources using the trac % terraform import aws_location_tracker.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/location_tracker_association.html.markdown b/website/docs/cdktf/python/r/location_tracker_association.html.markdown index 537707c041c9..bf7fc7642e6e 100644 --- a/website/docs/cdktf/python/r/location_tracker_association.html.markdown +++ b/website/docs/cdktf/python/r/location_tracker_association.html.markdown @@ -46,8 +46,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `consumer_arn` - (Required) The Amazon Resource Name (ARN) for the geofence collection to be associated to tracker resource. Used when you need to specify a resource across all AWS. * `tracker_name` - (Required) The name of the tracker resource to be associated with a geofence collection. @@ -87,4 +88,4 @@ Using `terraform import`, import Location Tracker Association using the `tracker % terraform import aws_location_tracker_association.example "tracker_name|consumer_arn" ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/m2_application.html.markdown b/website/docs/cdktf/python/r/m2_application.html.markdown index 059f3cc8f507..38cac3ba5acd 100644 --- a/website/docs/cdktf/python/r/m2_application.html.markdown +++ b/website/docs/cdktf/python/r/m2_application.html.markdown @@ -47,6 +47,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `definition` - (Optional) The application definition for this application. You can specify either inline JSON or an S3 bucket location. * `kms_key_id` - (Optional) KMS Key to use for the Application. * `role_arn` - (Optional) ARN of role for application to use to access AWS resources. @@ -58,6 +59,7 @@ This argument is processed in [attribute-as-blocks mode](https://www.terraform.i The following arguments are optional: +* `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). * `content` - (Optional) JSON application definition. Either this or `s3_location` must be specified. * `s3_location` - (Optional) Location of the application definition in S3. Either this or `content` must be specified. @@ -103,4 +105,4 @@ Using `terraform import`, import Mainframe Modernization Application using the ` % terraform import aws_m2_application.example 01234567890abcdef012345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/m2_deployment.html.markdown b/website/docs/cdktf/python/r/m2_deployment.html.markdown index 33164e22af2b..699aafd1674c 100644 --- a/website/docs/cdktf/python/r/m2_deployment.html.markdown +++ b/website/docs/cdktf/python/r/m2_deployment.html.markdown @@ -37,8 +37,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `environment_id` - (Required) Environment to deploy application to. * `application_id` - (Required) Application to deploy. * `application_version` - (Required) Version to application to deploy @@ -81,4 +82,4 @@ Using `terraform import`, import Mainframe Modernization Deployment using the `A % terraform import aws_m2_deployment.example APPLICATION-ID,DEPLOYMENT-ID ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/m2_environment.html.markdown b/website/docs/cdktf/python/r/m2_environment.html.markdown index c40a7ed0263f..d16c2b71eb83 100644 --- a/website/docs/cdktf/python/r/m2_environment.html.markdown +++ b/website/docs/cdktf/python/r/m2_environment.html.markdown @@ -135,6 +135,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `engine_version` - (Optional) The specific version of the engine for the Environment. * `force_update` - (Optional) Force update the environment even if applications are running. * `kms_key_id` - (Optional) ARN of the KMS key to use for the Environment. @@ -214,4 +215,4 @@ Using `terraform import`, import Mainframe Modernization Environment using the ` % terraform import aws_m2_environment.example 01234567890abcdef012345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/macie2_account.html.markdown b/website/docs/cdktf/python/r/macie2_account.html.markdown index 9574d1b3adf1..24dff81653f8 100644 --- a/website/docs/cdktf/python/r/macie2_account.html.markdown +++ b/website/docs/cdktf/python/r/macie2_account.html.markdown @@ -36,6 +36,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `finding_publishing_frequency` - (Optional) Specifies how often to publish updates to policy findings for the account. This includes publishing updates to AWS Security Hub and Amazon EventBridge (formerly called Amazon CloudWatch Events). Valid values are `FIFTEEN_MINUTES`, `ONE_HOUR` or `SIX_HOURS`. * `status` - (Optional) Specifies the status for the account. To enable Amazon Macie and start all Macie activities for the account, set this value to `ENABLED`. Valid values are `ENABLED` or `PAUSED`. @@ -73,4 +74,4 @@ Using `terraform import`, import `aws_macie2_account` using the id. For example: % terraform import aws_macie2_account.example abcd1 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/macie2_classification_export_configuration.html.markdown b/website/docs/cdktf/python/r/macie2_classification_export_configuration.html.markdown index b429705aece0..ad31f68a90fe 100644 --- a/website/docs/cdktf/python/r/macie2_classification_export_configuration.html.markdown +++ b/website/docs/cdktf/python/r/macie2_classification_export_configuration.html.markdown @@ -45,6 +45,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `s3_destination` - (Required) Configuration block for a S3 Destination. Defined below ### s3_destination Configuration Block @@ -65,7 +66,7 @@ This resource exports the following attributes in addition to the arguments abov ## Import -In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import `aws_macie2_classification_export_configuration` using the account ID and region. For example: +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import `aws_macie2_classification_export_configuration` using the region. For example: ```python # DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -79,13 +80,13 @@ from imports.aws.macie2_classification_export_configuration import Macie2Classif class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) - Macie2ClassificationExportConfiguration.generate_config_for_import(self, "example", "123456789012:us-west-2") + Macie2ClassificationExportConfiguration.generate_config_for_import(self, "example", "us-west-2") ``` -Using `terraform import`, import `aws_macie2_classification_export_configuration` using the account ID and region. For example: +Using `terraform import`, import `aws_macie2_classification_export_configuration` using the region. For example: ```console -% terraform import aws_macie2_classification_export_configuration.example 123456789012:us-west-2 +% terraform import aws_macie2_classification_export_configuration.example us-west-2 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/macie2_classification_job.html.markdown b/website/docs/cdktf/python/r/macie2_classification_job.html.markdown index 6dd86a8f28e3..c5db339ddf0f 100644 --- a/website/docs/cdktf/python/r/macie2_classification_job.html.markdown +++ b/website/docs/cdktf/python/r/macie2_classification_job.html.markdown @@ -48,6 +48,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `schedule_frequency` - (Optional) The recurrence pattern for running the job. To run the job only once, don't specify a value for this property and set the value for the `job_type` property to `ONE_TIME`. (documented below) * `custom_data_identifier_ids` - (Optional) The custom data identifiers to use for data analysis and classification. * `sampling_percentage` - (Optional) The sampling depth, as a percentage, to apply when processing objects. This value determines the percentage of eligible objects that the job analyzes. If this value is less than 100, Amazon Macie selects the objects to analyze at random, up to the specified percentage, and analyzes all the data in those objects. @@ -174,4 +175,4 @@ Using `terraform import`, import `aws_macie2_classification_job` using the id. F % terraform import aws_macie2_classification_job.example abcd1 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/macie2_custom_data_identifier.html.markdown b/website/docs/cdktf/python/r/macie2_custom_data_identifier.html.markdown index 3e04e8295bb4..2ea73d4d07d9 100644 --- a/website/docs/cdktf/python/r/macie2_custom_data_identifier.html.markdown +++ b/website/docs/cdktf/python/r/macie2_custom_data_identifier.html.markdown @@ -45,6 +45,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `regex` - (Optional) The regular expression (regex) that defines the pattern to match. The expression can contain as many as 512 characters. * `keywords` - (Optional) An array that lists specific character sequences (keywords), one of which must be within proximity (`maximum_match_distance`) of the regular expression to match. The array can contain as many as 50 keywords. Each keyword can contain 3 - 90 characters. Keywords aren't case sensitive. * `ignore_words` - (Optional) An array that lists specific character sequences (ignore words) to exclude from the results. If the text matched by the regular expression is the same as any string in this array, Amazon Macie ignores it. The array can contain as many as 10 ignore words. Each ignore word can contain 4 - 90 characters. Ignore words are case sensitive. @@ -89,4 +90,4 @@ Using `terraform import`, import `aws_macie2_custom_data_identifier` using the i % terraform import aws_macie2_custom_data_identifier.example abcd1 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/macie2_findings_filter.html.markdown b/website/docs/cdktf/python/r/macie2_findings_filter.html.markdown index a85810c05c84..6212a99ff759 100644 --- a/website/docs/cdktf/python/r/macie2_findings_filter.html.markdown +++ b/website/docs/cdktf/python/r/macie2_findings_filter.html.markdown @@ -34,7 +34,7 @@ class MyConvertedCode(TerraformStack): description="DESCRIPTION", finding_criteria=Macie2FindingsFilterFindingCriteria( criterion=[Macie2FindingsFilterFindingCriteriaCriterion( - eq=[Token.as_string(current.name)], + eq=[Token.as_string(current.region)], field="region" ) ] @@ -48,6 +48,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `finding_criteria` - (Required) The criteria to use to filter findings. * `name` - (Optional) A custom name for the filter. The name must contain at least 3 characters and can contain as many as 64 characters. If omitted, Terraform will assign a random, unique name. Conflicts with `name_prefix`. * `name_prefix` - (Optional) Creates a unique name beginning with the specified prefix. Conflicts with `name`. @@ -104,4 +105,4 @@ Using `terraform import`, import `aws_macie2_findings_filter` using the id. For % terraform import aws_macie2_findings_filter.example abcd1 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/macie2_invitation_accepter.html.markdown b/website/docs/cdktf/python/r/macie2_invitation_accepter.html.markdown index d61dea55adc7..c1dbab36635a 100644 --- a/website/docs/cdktf/python/r/macie2_invitation_accepter.html.markdown +++ b/website/docs/cdktf/python/r/macie2_invitation_accepter.html.markdown @@ -54,6 +54,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `administrator_account_id` - (Required) The AWS account ID for the account that sent the invitation. ## Attribute Reference @@ -88,4 +89,4 @@ Using `terraform import`, import `aws_macie2_invitation_accepter` using the admi % terraform import aws_macie2_invitation_accepter.example 123456789012 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/macie2_member.html.markdown b/website/docs/cdktf/python/r/macie2_member.html.markdown index a161b4e233cc..9c028a070092 100644 --- a/website/docs/cdktf/python/r/macie2_member.html.markdown +++ b/website/docs/cdktf/python/r/macie2_member.html.markdown @@ -44,6 +44,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `account_id` - (Required) The AWS account ID for the account. * `email` - (Required) The email address for the account. * `tags` - (Optional) A map of key-value pairs that specifies the tags to associate with the account in Amazon Macie. @@ -90,4 +91,4 @@ Using `terraform import`, import `aws_macie2_member` using the account ID of the % terraform import aws_macie2_member.example 123456789012 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/macie2_organization_admin_account.html.markdown b/website/docs/cdktf/python/r/macie2_organization_admin_account.html.markdown index 0c330da5ab1f..4460e0cf2acd 100644 --- a/website/docs/cdktf/python/r/macie2_organization_admin_account.html.markdown +++ b/website/docs/cdktf/python/r/macie2_organization_admin_account.html.markdown @@ -41,6 +41,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `admin_account_id` - (Required) The AWS account ID for the account to designate as the delegated Amazon Macie administrator account for the organization. ## Attribute Reference @@ -74,4 +75,4 @@ Using `terraform import`, import `aws_macie2_organization_admin_account` using t % terraform import aws_macie2_organization_admin_account.example abcd1 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/macie2_organization_configuration.html.markdown b/website/docs/cdktf/python/r/macie2_organization_configuration.html.markdown index cfcd155b976a..1e663d19fc6d 100644 --- a/website/docs/cdktf/python/r/macie2_organization_configuration.html.markdown +++ b/website/docs/cdktf/python/r/macie2_organization_configuration.html.markdown @@ -35,10 +35,11 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `auto_enable` - (Required) Whether to enable Amazon Macie automatically for accounts that are added to the organization in AWS Organizations. ## Attribute Reference This resource exports no additional attributes. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/main_route_table_association.html.markdown b/website/docs/cdktf/python/r/main_route_table_association.html.markdown index b4f8e093b58f..216854163e59 100644 --- a/website/docs/cdktf/python/r/main_route_table_association.html.markdown +++ b/website/docs/cdktf/python/r/main_route_table_association.html.markdown @@ -39,6 +39,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `vpc_id` - (Required) The ID of the VPC whose main route table should be set * `route_table_id` - (Required) The ID of the Route Table to set as the new main route table for the target VPC @@ -71,4 +72,4 @@ the `main_route_table_association` delete to work properly. [tf-route-tables]: /docs/providers/aws/r/route_table.html [tf-default-route-table]: /docs/providers/aws/r/default_route_table.html - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/media_convert_queue.html.markdown b/website/docs/cdktf/python/r/media_convert_queue.html.markdown index 0d6154f0949f..ff6299eeb5d6 100644 --- a/website/docs/cdktf/python/r/media_convert_queue.html.markdown +++ b/website/docs/cdktf/python/r/media_convert_queue.html.markdown @@ -35,6 +35,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) A unique identifier describing the queue * `concurrent_jobs` - (Optional) The maximum number of jobs your queue can process concurrently. For on-demand queues, the value you enter is constrained by your service quotas for Maximum concurrent jobs, per on-demand queue and Maximum concurrent jobs, per account. For reserved queues, specify the number of jobs you can process concurrently in your reservation plan instead. * `description` - (Optional) A description of the queue @@ -84,4 +85,4 @@ Using `terraform import`, import Media Convert Queue using the queue name. For e % terraform import aws_media_convert_queue.test tf-test-queue ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/media_package_channel.html.markdown b/website/docs/cdktf/python/r/media_package_channel.html.markdown index 8a1be78053bc..f2f9e7a4e4eb 100644 --- a/website/docs/cdktf/python/r/media_package_channel.html.markdown +++ b/website/docs/cdktf/python/r/media_package_channel.html.markdown @@ -36,6 +36,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `channel_id` - (Required) A unique identifier describing the channel * `description` - (Optional) A description of the channel * `tags` - (Optional) A 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. @@ -78,4 +79,4 @@ Using `terraform import`, import Media Package Channels using the channel ID. Fo % terraform import aws_media_package_channel.kittens kittens-channel ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/media_packagev2_channel_group.html.markdown b/website/docs/cdktf/python/r/media_packagev2_channel_group.html.markdown index 4f9f52198ebb..3e7ce43a5190 100644 --- a/website/docs/cdktf/python/r/media_packagev2_channel_group.html.markdown +++ b/website/docs/cdktf/python/r/media_packagev2_channel_group.html.markdown @@ -22,7 +22,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 MediaPackagev2ChannelGroup +from imports.aws.media_packagev2_channel_group import MediaPackagev2ChannelGroup class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) @@ -36,6 +36,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) A unique identifier naming the channel group * `description` - (Optional) A description of the channel group * `tags` - (Optional) A 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. @@ -61,7 +62,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 MediaPackagev2ChannelGroup +from imports.aws.media_packagev2_channel_group import MediaPackagev2ChannelGroup class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) @@ -74,4 +75,4 @@ Using `terraform import`, import Elemental MediaPackage Version 2 Channel Group % terraform import aws_media_packagev2_channel_group.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/media_store_container.html.markdown b/website/docs/cdktf/python/r/media_store_container.html.markdown index 87b79dad2fc6..ab8f0affa3ed 100644 --- a/website/docs/cdktf/python/r/media_store_container.html.markdown +++ b/website/docs/cdktf/python/r/media_store_container.html.markdown @@ -12,6 +12,8 @@ description: |- Provides a MediaStore Container. +!> **WARNING:** _This resource is deprecated and will be removed in a future version._ AWS has [announced](https://aws.amazon.com/blogs/media/support-for-aws-elemental-mediastore-ending-soon/) the discontinuation of AWS Elemental MediaStore, effective **November 13, 2025**. Users should begin transitioning to alternative solutions as soon as possible. For **simple live streaming workflows**, AWS recommends migrating to **Amazon S3**. For **advanced use cases** that require features such as packaging, DRM, or cross-region redundancy, consider using **AWS Elemental MediaPackage**. + ## Example Usage ```python @@ -35,6 +37,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) The name of the container. Must contain alphanumeric characters or underscores. * `tags` - (Optional) A 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. @@ -71,4 +74,4 @@ Using `terraform import`, import MediaStore Container using the MediaStore Conta % terraform import aws_media_store_container.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/media_store_container_policy.html.markdown b/website/docs/cdktf/python/r/media_store_container_policy.html.markdown index d7172a2232de..d63c38d4fdc4 100644 --- a/website/docs/cdktf/python/r/media_store_container_policy.html.markdown +++ b/website/docs/cdktf/python/r/media_store_container_policy.html.markdown @@ -12,6 +12,8 @@ description: |- Provides a MediaStore Container Policy. +!> **WARNING:** _This resource is deprecated and will be removed in a future version._ AWS has [announced](https://aws.amazon.com/blogs/media/support-for-aws-elemental-mediastore-ending-soon/) the discontinuation of AWS Elemental MediaStore, effective **November 13, 2025**. Users should begin transitioning to alternative solutions as soon as possible. For **simple live streaming workflows**, AWS recommends migrating to **Amazon S3**. For **advanced use cases** that require features such as packaging, DRM, or cross-region redundancy, consider using **AWS Elemental MediaPackage**. + ~> **NOTE:** We suggest using [`jsonencode()`](https://developer.hashicorp.com/terraform/language/functions/jsonencode) or [`aws_iam_policy_document`](/docs/providers/aws/d/iam_policy_document.html) when assigning a value to `policy`. They seamlessly translate Terraform language into JSON, enabling you to maintain consistency within your configuration without the need for context switches. Also, you can sidestep potential complications arising from formatting discrepancies, whitespace inconsistencies, and other nuances inherent to JSON. ## Example Usage @@ -54,7 +56,7 @@ class MyConvertedCode(TerraformStack): type="AWS" ) ], - resources=["arn:aws:mediastore:${" + data_aws_region_current.name + "}:${" + current.account_id + "}:container/${" + example.name + "}/*" + resources=["arn:aws:mediastore:${" + data_aws_region_current.region + "}:${" + current.account_id + "}:container/${" + example.name + "}/*" ], sid="MediaStoreFullAccess" ) @@ -74,6 +76,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `container_name` - (Required) The name of the container. * `policy` - (Required) The contents of the policy. For more information about building AWS IAM policy documents with Terraform, see the [AWS IAM Policy Document Guide](https://learn.hashicorp.com/terraform/aws/iam-policy). @@ -106,4 +109,4 @@ Using `terraform import`, import MediaStore Container Policy using the MediaStor % terraform import aws_media_store_container_policy.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/medialive_channel.html.markdown b/website/docs/cdktf/python/r/medialive_channel.html.markdown index 442022b114ee..e4a87a8850a2 100644 --- a/website/docs/cdktf/python/r/medialive_channel.html.markdown +++ b/website/docs/cdktf/python/r/medialive_channel.html.markdown @@ -111,6 +111,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `cdi_input_specification` - (Optional) Specification of CDI inputs for this channel. See [CDI Input Specification](#cdi-input-specification) for more details. * `input_attachments` - (Optional) Input attachments for the channel. See [Input Attachments](#input-attachments) for more details. * `log_level` - (Optional) The log level to write to Cloudwatch logs. @@ -235,7 +236,7 @@ The following arguments are optional: ### SCTE 20 Source Settings -* `convert_608_to_708` – (Optional) If upconvert, 608 data is both passed through via the “608 compatibility bytes” fields of the 708 wrapper as well as translated into 708. 708 data present in the source content will be discarded. +* `convert_608_to_708` - (Optional) If upconvert, 608 data is both passed through via the “608 compatibility bytes” fields of the 708 wrapper as well as translated into 708. 708 data present in the source content will be discarded. * `source_608_channel_number` - (Optional) Specifies the 608/708 channel number within the video track from which to extract captions. Unused for passthrough. ### SCTE 27 Source Settings @@ -584,62 +585,62 @@ The following arguments are optional: * `embedded_plus_scte20_destination_settings` - (Optional) Embedded Plus SCTE20 Destination Settings. * `rtmp_caption_info_destination_settings` - (Optional) RTMP Caption Info Destination Settings. * `scte20_plus_embedded_destination_settings` - (Optional) SCTE20 Plus Embedded Destination Settings. -* `scte27_destination_settings` – (Optional) SCTE27 Destination Settings. -* `smpte_tt_destination_settings` – (Optional) SMPTE TT Destination Settings. -* `teletext_destination_settings` – (Optional) Teletext Destination Settings. -* `ttml_destination_settings` – (Optional) TTML Destination Settings. See [TTML Destination Settings](#ttml-destination-settings) for more details. +* `scte27_destination_settings` - (Optional) SCTE27 Destination Settings. +* `smpte_tt_destination_settings` - (Optional) SMPTE TT Destination Settings. +* `teletext_destination_settings` - (Optional) Teletext Destination Settings. +* `ttml_destination_settings` - (Optional) TTML Destination Settings. See [TTML Destination Settings](#ttml-destination-settings) for more details. * `webvtt_destination_settings` - (Optional) WebVTT Destination Settings. See [WebVTT Destination Settings](#webvtt-destination-settings) for more details. ### Burn In Destination Settings -* `alignment` – (Optional) If no explicit xPosition or yPosition is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. Selecting “smart” justification will left-justify live subtitles and center-justify pre-recorded subtitles. All burn-in and DVB-Sub font settings must match. -* `background_color` – (Optional) Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match. -* `background_opacity` – (Optional) Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter out is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match. -* `font` – (Optional) External font file used for caption burn-in. File extension must be ‘ttf’ or ‘tte’. Although the user can select output fonts for many different types of input captions, embedded, STL and teletext sources use a strict grid system. Using external fonts with these caption sources could cause unexpected display of proportional fonts. All burn-in and DVB-Sub font settings must match. See [Font](#font) for more details. -* `font_color` – (Optional) Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. -* `font_opacity` – (Optional) Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent. All burn-in and DVB-Sub font settings must match. -* `font_resolution` – (Optional) Font resolution in DPI (dots per inch); default is 96 dpi. All burn-in and DVB-Sub font settings must match. -* `font_size` – (Optional) When set to ‘auto’ fontSize will scale depending on the size of the output. Giving a positive integer will specify the exact font size in points. All burn-in and DVB-Sub font settings must match. -* `outline_color` – (Optional) Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. -* `outline_size` – (Optional) Specifies font outline size in pixels. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. -* `shadow_color` – (Optional) Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match. -* `shadow_opacity` – (Optional) Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter out is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match. -* `shadow_x_offset` – (Optional) Specifies the horizontal offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match. -* `shadow_y_offset` – (Optional) Specifies the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match. -* `teletext_grid_control` – (Optional) Controls whether a fixed grid size will be used to generate the output subtitles bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in outputs. -* `x_position` – (Optional) Specifies the horizontal position of the caption relative to the left side of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit xPosition is provided, the horizontal caption position will be determined by the alignment parameter. All burn-in and DVB-Sub font settings must match. -* `y_position` – (Optional) Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit yPosition is provided, the caption will be positioned towards the bottom of the output. All burn-in and DVB-Sub font settings must match. +* `alignment` - (Optional) If no explicit xPosition or yPosition is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. Selecting “smart” justification will left-justify live subtitles and center-justify pre-recorded subtitles. All burn-in and DVB-Sub font settings must match. +* `background_color` - (Optional) Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match. +* `background_opacity` - (Optional) Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter out is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match. +* `font` - (Optional) External font file used for caption burn-in. File extension must be ‘ttf’ or ‘tte’. Although the user can select output fonts for many different types of input captions, embedded, STL and teletext sources use a strict grid system. Using external fonts with these caption sources could cause unexpected display of proportional fonts. All burn-in and DVB-Sub font settings must match. See [Font](#font) for more details. +* `font_color` - (Optional) Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. +* `font_opacity` - (Optional) Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent. All burn-in and DVB-Sub font settings must match. +* `font_resolution` - (Optional) Font resolution in DPI (dots per inch); default is 96 dpi. All burn-in and DVB-Sub font settings must match. +* `font_size` - (Optional) When set to ‘auto’ fontSize will scale depending on the size of the output. Giving a positive integer will specify the exact font size in points. All burn-in and DVB-Sub font settings must match. +* `outline_color` - (Optional) Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. +* `outline_size` - (Optional) Specifies font outline size in pixels. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. +* `shadow_color` - (Optional) Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match. +* `shadow_opacity` - (Optional) Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter out is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match. +* `shadow_x_offset` - (Optional) Specifies the horizontal offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match. +* `shadow_y_offset` - (Optional) Specifies the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match. +* `teletext_grid_control` - (Optional) Controls whether a fixed grid size will be used to generate the output subtitles bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in outputs. +* `x_position` - (Optional) Specifies the horizontal position of the caption relative to the left side of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit xPosition is provided, the horizontal caption position will be determined by the alignment parameter. All burn-in and DVB-Sub font settings must match. +* `y_position` - (Optional) Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit yPosition is provided, the caption will be positioned towards the bottom of the output. All burn-in and DVB-Sub font settings must match. ### DVB Sub Destination Settings -* `alignment` – (Optional) If no explicit xPosition or yPosition is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. Selecting “smart” justification will left-justify live subtitles and center-justify pre-recorded subtitles. This option is not valid for source captions that are STL or 608/embedded. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. -* `background_color` – (Optional) Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match. -* `background_opacity` – (Optional) Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match. -* `font` – (Optional) External font file used for caption burn-in. File extension must be ‘ttf’ or ‘tte’. Although the user can select output fonts for many different types of input captions, embedded, STL and teletext sources use a strict grid system. Using external fonts with these caption sources could cause unexpected display of proportional fonts. All burn-in and DVB-Sub font settings must match. See [Font](#font) for more details. -* `font_color` – (Optional) Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. -* `font_opacity` – (Optional) Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent. All burn-in and DVB-Sub font settings must match. -* `font_resolution` – (Optional) Font resolution in DPI (dots per inch); default is 96 dpi. All burn-in and DVB-Sub font settings must match. -* `font_size` – (Optional) When set to auto fontSize will scale depending on the size of the output. Giving a positive integer will specify the exact font size in points. All burn-in and DVB-Sub font settings must match. -* `outline_color` – (Optional) Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. -* `outline_size` – (Optional) Specifies font outline size in pixels. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. -* `shadow_color` – (Optional) Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match. -* `shadow_opacity` – (Optional) Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match. -* `shadow_x_offset` – (Optional) Specifies the horizontal offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match. -* `shadow_y_offset` – (Optional) Specifies the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match. -* `teletext_grid_control` – (Optional) Controls whether a fixed grid size will be used to generate the output subtitles bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in outputs. -* `x_position` – (Optional) Specifies the horizontal position of the caption relative to the left side of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit xPosition is provided, the horizontal caption position will be determined by the alignment parameter. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. -* `y_position` – (Optional) Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit yPosition is provided, the caption will be positioned towards the bottom of the output. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. +* `alignment` - (Optional) If no explicit xPosition or yPosition is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. Selecting “smart” justification will left-justify live subtitles and center-justify pre-recorded subtitles. This option is not valid for source captions that are STL or 608/embedded. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. +* `background_color` - (Optional) Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match. +* `background_opacity` - (Optional) Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match. +* `font` - (Optional) External font file used for caption burn-in. File extension must be ‘ttf’ or ‘tte’. Although the user can select output fonts for many different types of input captions, embedded, STL and teletext sources use a strict grid system. Using external fonts with these caption sources could cause unexpected display of proportional fonts. All burn-in and DVB-Sub font settings must match. See [Font](#font) for more details. +* `font_color` - (Optional) Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. +* `font_opacity` - (Optional) Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent. All burn-in and DVB-Sub font settings must match. +* `font_resolution` - (Optional) Font resolution in DPI (dots per inch); default is 96 dpi. All burn-in and DVB-Sub font settings must match. +* `font_size` - (Optional) When set to auto fontSize will scale depending on the size of the output. Giving a positive integer will specify the exact font size in points. All burn-in and DVB-Sub font settings must match. +* `outline_color` - (Optional) Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. +* `outline_size` - (Optional) Specifies font outline size in pixels. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. +* `shadow_color` - (Optional) Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match. +* `shadow_opacity` - (Optional) Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match. +* `shadow_x_offset` - (Optional) Specifies the horizontal offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match. +* `shadow_y_offset` - (Optional) Specifies the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match. +* `teletext_grid_control` - (Optional) Controls whether a fixed grid size will be used to generate the output subtitles bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in outputs. +* `x_position` - (Optional) Specifies the horizontal position of the caption relative to the left side of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit xPosition is provided, the horizontal caption position will be determined by the alignment parameter. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. +* `y_position` - (Optional) Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit yPosition is provided, the caption will be positioned towards the bottom of the output. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. ### EBU TT D Destination Settings -* `copyright_holder` – (Optional) Complete this field if you want to include the name of the copyright holder in the copyright tag in the captions metadata. -* `fill_line_gap` – (Optional) Specifies how to handle the gap between the lines (in multi-line captions). - enabled: Fill with the captions background color (as specified in the input captions). - disabled: Leave the gap unfilled. -* `font_family` – (Optional) Specifies the font family to include in the font data attached to the EBU-TT captions. Valid only if styleControl is set to include. If you leave this field empty, the font family is set to “monospaced”. (If styleControl is set to exclude, the font family is always set to “monospaced”.) You specify only the font family. All other style information (color, bold, position and so on) is copied from the input captions. The size is always set to 100% to allow the downstream player to choose the size. - Enter a list of font families, as a comma-separated list of font names, in order of preference. The name can be a font family (such as “Arial”), or a generic font family (such as “serif”), or “default” (to let the downstream player choose the font). - Leave blank to set the family to “monospace”. -* `style_control` – (Optional) Specifies the style information (font color, font position, and so on) to include in the font data that is attached to the EBU-TT captions. - include: Take the style information (font color, font position, and so on) from the source captions and include that information in the font data attached to the EBU-TT captions. This option is valid only if the source captions are Embedded or Teletext. - exclude: In the font data attached to the EBU-TT captions, set the font family to “monospaced”. Do not include any other style information. +* `copyright_holder` - (Optional) Complete this field if you want to include the name of the copyright holder in the copyright tag in the captions metadata. +* `fill_line_gap` - (Optional) Specifies how to handle the gap between the lines (in multi-line captions). - enabled: Fill with the captions background color (as specified in the input captions). - disabled: Leave the gap unfilled. +* `font_family` - (Optional) Specifies the font family to include in the font data attached to the EBU-TT captions. Valid only if styleControl is set to include. If you leave this field empty, the font family is set to “monospaced”. (If styleControl is set to exclude, the font family is always set to “monospaced”.) You specify only the font family. All other style information (color, bold, position and so on) is copied from the input captions. The size is always set to 100% to allow the downstream player to choose the size. - Enter a list of font families, as a comma-separated list of font names, in order of preference. The name can be a font family (such as “Arial”), or a generic font family (such as “serif”), or “default” (to let the downstream player choose the font). - Leave blank to set the family to “monospace”. +* `style_control` - (Optional) Specifies the style information (font color, font position, and so on) to include in the font data that is attached to the EBU-TT captions. - include: Take the style information (font color, font position, and so on) from the source captions and include that information in the font data attached to the EBU-TT captions. This option is valid only if the source captions are Embedded or Teletext. - exclude: In the font data attached to the EBU-TT captions, set the font family to “monospaced”. Do not include any other style information. ### TTML Destination Settings -* `style_control` – (Optional) This field is not currently supported and will not affect the output styling. Leave the default value. +* `style_control` - (Optional) This field is not currently supported and will not affect the output styling. Leave the default value. ### WebVTT Destination Settings @@ -647,38 +648,38 @@ The following arguments are optional: ### Font -* `password_param` – (Optional) Key used to extract the password from EC2 Parameter store. -* `uri` – (Required) Path to a file accessible to the live stream. -* `username` – (Optional) Username to be used. +* `password_param` - (Optional) Key used to extract the password from EC2 Parameter store. +* `uri` - (Required) Path to a file accessible to the live stream. +* `username` - (Optional) Username to be used. ### Global Configuration -* `initial_audio_gain` – (Optional) Value to set the initial audio gain for the Live Event. -* `input_end_action` – (Optional) Indicates the action to take when the current input completes (e.g. end-of-file). When switchAndLoopInputs is configured the encoder will restart at the beginning of the first input. When “none” is configured the encoder will transcode either black, a solid color, or a user specified slate images per the “Input Loss Behavior” configuration until the next input switch occurs (which is controlled through the Channel Schedule API). +* `initial_audio_gain` - (Optional) Value to set the initial audio gain for the Live Event. +* `input_end_action` - (Optional) Indicates the action to take when the current input completes (e.g. end-of-file). When switchAndLoopInputs is configured the encoder will restart at the beginning of the first input. When “none” is configured the encoder will transcode either black, a solid color, or a user specified slate images per the “Input Loss Behavior” configuration until the next input switch occurs (which is controlled through the Channel Schedule API). * `input_loss_behavior` - (Optional) Settings for system actions when input is lost. See [Input Loss Behavior](#input-loss-behavior) for more details. -* `output_locking_mode` – (Optional) Indicates how MediaLive pipelines are synchronized. PIPELINE\_LOCKING - MediaLive will attempt to synchronize the output of each pipeline to the other. EPOCH\_LOCKING - MediaLive will attempt to synchronize the output of each pipeline to the Unix epoch. -* `output_timing_source` – (Optional) Indicates whether the rate of frames emitted by the Live encoder should be paced by its system clock (which optionally may be locked to another source via NTP) or should be locked to the clock of the source that is providing the input stream. -* `support_low_framerate_inputs` – (Optional) Adjusts video input buffer for streams with very low video framerates. This is commonly set to enabled for music channels with less than one video frame per second. +* `output_locking_mode` - (Optional) Indicates how MediaLive pipelines are synchronized. PIPELINE\_LOCKING - MediaLive will attempt to synchronize the output of each pipeline to the other. EPOCH\_LOCKING - MediaLive will attempt to synchronize the output of each pipeline to the Unix epoch. +* `output_timing_source` - (Optional) Indicates whether the rate of frames emitted by the Live encoder should be paced by its system clock (which optionally may be locked to another source via NTP) or should be locked to the clock of the source that is providing the input stream. +* `support_low_framerate_inputs` - (Optional) Adjusts video input buffer for streams with very low video framerates. This is commonly set to enabled for music channels with less than one video frame per second. ### Input Loss Behavior -* `password_param` – (Optional) Key used to extract the password from EC2 Parameter store. -* `uri` – (Required) Path to a file accessible to the live stream. -* `username` – (Optional) Username to be used. +* `password_param` - (Optional) Key used to extract the password from EC2 Parameter store. +* `uri` - (Required) Path to a file accessible to the live stream. +* `username` - (Optional) Username to be used. ### Motion Graphics Configuration -* `motion_graphics_insertion` – (Optional) Motion Graphics Insertion. +* `motion_graphics_insertion` - (Optional) Motion Graphics Insertion. * `motion_graphics_settings`– (Required) Motion Graphics Settings. See [Motion Graphics Settings](#motion-graphics-settings) for more details. ### Motion Graphics Settings -* `html_motion_graphics_settings` – (Optional) Html Motion Graphics Settings. +* `html_motion_graphics_settings` - (Optional) Html Motion Graphics Settings. ### Nielsen Configuration -* `distributor_id` – (Optional) Enter the Distributor ID assigned to your organization by Nielsen. -* `nielsen_pcm_to_id3_tagging` – (Optional) Enables Nielsen PCM to ID3 tagging. +* `distributor_id` - (Optional) Enter the Distributor ID assigned to your organization by Nielsen. +* `nielsen_pcm_to_id3_tagging` - (Optional) Enables Nielsen PCM to ID3 tagging. ### Avail Blanking @@ -818,4 +819,4 @@ Using `terraform import`, import MediaLive Channel using the `channel_id`. For e % terraform import aws_medialive_channel.example 1234567 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/medialive_input.html.markdown b/website/docs/cdktf/python/r/medialive_input.html.markdown index 5077ef92e891..b5d71c8b0a0b 100644 --- a/website/docs/cdktf/python/r/medialive_input.html.markdown +++ b/website/docs/cdktf/python/r/medialive_input.html.markdown @@ -60,6 +60,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `destinations` - (Optional) Destination settings for PUSH type inputs. See [Destinations](#destinations) for more details. * `input_devices` - (Optional) Settings for the devices. See [Input Devices](#input-devices) for more details. * `media_connect_flows` - (Optional) A list of the MediaConnect Flows. See [Media Connect Flows](#media-connect-flows) for more details. @@ -134,4 +135,4 @@ Using `terraform import`, import MediaLive Input using the `id`. For example: % terraform import aws_medialive_input.example 12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/medialive_input_security_group.html.markdown b/website/docs/cdktf/python/r/medialive_input_security_group.html.markdown index fc9f5341f2d2..9d798094707d 100644 --- a/website/docs/cdktf/python/r/medialive_input_security_group.html.markdown +++ b/website/docs/cdktf/python/r/medialive_input_security_group.html.markdown @@ -47,6 +47,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `tags` - (Optional) A map of tags to assign to the InputSecurityGroup. If configured with a provider [`default_tags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. ### Whitelist Rules @@ -94,4 +95,4 @@ Using `terraform import`, import MediaLive InputSecurityGroup using the `id`. Fo % terraform import aws_medialive_input_security_group.example 123456 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/medialive_multiplex.html.markdown b/website/docs/cdktf/python/r/medialive_multiplex.html.markdown index ba18a8fdf91b..2fb822077a4c 100644 --- a/website/docs/cdktf/python/r/medialive_multiplex.html.markdown +++ b/website/docs/cdktf/python/r/medialive_multiplex.html.markdown @@ -61,6 +61,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `start_multiplex` - (Optional) Whether to start the Multiplex. Defaults to `false`. * `tags` - (Optional) A map of tags to assign to the Multiplex. If configured with a provider [`default_tags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. @@ -110,4 +111,4 @@ Using `terraform import`, import MediaLive Multiplex using the `id`. For example % terraform import aws_medialive_multiplex.example 12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/medialive_multiplex_program.html.markdown b/website/docs/cdktf/python/r/medialive_multiplex_program.html.markdown index 5bba5f1cf9a2..8f18afce69d3 100644 --- a/website/docs/cdktf/python/r/medialive_multiplex_program.html.markdown +++ b/website/docs/cdktf/python/r/medialive_multiplex_program.html.markdown @@ -77,6 +77,8 @@ The following arguments are required: The following arguments are optional: +* `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). + ### Multiple Program Settings * `program_number` - (Required) Unique program number. @@ -138,4 +140,4 @@ Using `terraform import`, import MediaLive MultiplexProgram using the `id`, or a % terraform import aws_medialive_multiplex_program.example example_program/1234567 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/memorydb_acl.html.markdown b/website/docs/cdktf/python/r/memorydb_acl.html.markdown index 75ccda8d6837..4cc5e67eeb8a 100644 --- a/website/docs/cdktf/python/r/memorydb_acl.html.markdown +++ b/website/docs/cdktf/python/r/memorydb_acl.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode(TerraformStack): The following arguments are optional: +* `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). * `name` - (Optional, Forces new resource) Name of the ACL. If omitted, Terraform will assign a random, unique name. Conflicts with `name_prefix`. * `name_prefix` - (Optional, Forces new resource) Creates a unique name beginning with the specified prefix. Conflicts with `name`. * `user_names` - (Optional) Set of MemoryDB user names to be included in this ACL. @@ -77,4 +78,4 @@ Using `terraform import`, import an ACL using the `name`. For example: % terraform import aws_memorydb_acl.example my-acl ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/memorydb_cluster.html.markdown b/website/docs/cdktf/python/r/memorydb_cluster.html.markdown index d730d2a779db..67807372d999 100644 --- a/website/docs/cdktf/python/r/memorydb_cluster.html.markdown +++ b/website/docs/cdktf/python/r/memorydb_cluster.html.markdown @@ -50,6 +50,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `auto_minor_version_upgrade` - (Optional, Forces new resource) When set to `true`, the cluster will automatically receive minor engine version upgrades after launch. Defaults to `true`. * `data_tiering` - (Optional, Forces new resource) Enables data tiering. This option is not supported by all instance types. For more information, see [Data tiering](https://docs.aws.amazon.com/memorydb/latest/devguide/data-tiering.html). * `description` - (Optional) Description for the cluster. Defaults to `"Managed by Terraform"`. @@ -131,4 +132,4 @@ Using `terraform import`, import a cluster using the `name`. For example: % terraform import aws_memorydb_cluster.example my-cluster ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/memorydb_multi_region_cluster.html.markdown b/website/docs/cdktf/python/r/memorydb_multi_region_cluster.html.markdown index c08924f324be..80ff1132864a 100644 --- a/website/docs/cdktf/python/r/memorydb_multi_region_cluster.html.markdown +++ b/website/docs/cdktf/python/r/memorydb_multi_region_cluster.html.markdown @@ -57,6 +57,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `description` - (Optional) description for the multi-region cluster. * `engine` - (Optional) The name of the engine to be used for the multi-region cluster. Valid values are `redis` and `valkey`. * `engine_version` - (Optional) The version of the engine to be used for the multi-region cluster. Downgrades are not supported. @@ -106,4 +107,4 @@ Using `terraform import`, import a cluster using the `multi_region_cluster_name` % terraform import aws_memorydb_multi_region_cluster.example virxk-example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/memorydb_parameter_group.html.markdown b/website/docs/cdktf/python/r/memorydb_parameter_group.html.markdown index d0eb498fbaea..3144167fdf11 100644 --- a/website/docs/cdktf/python/r/memorydb_parameter_group.html.markdown +++ b/website/docs/cdktf/python/r/memorydb_parameter_group.html.markdown @@ -47,6 +47,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `name` - (Optional, Forces new resource) Name of the parameter group. If omitted, Terraform will assign a random, unique name. Conflicts with `name_prefix`. * `name_prefix` - (Optional, Forces new resource) Creates a unique name beginning with the specified prefix. Conflicts with `name`. * `description` - (Optional, Forces new resource) Description for the parameter group. Defaults to `"Managed by Terraform"`. @@ -91,4 +92,4 @@ Using `terraform import`, import a parameter group using the `name`. For example % terraform import aws_memorydb_parameter_group.example my-parameter-group ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/memorydb_snapshot.html.markdown b/website/docs/cdktf/python/r/memorydb_snapshot.html.markdown index 8a355bf357e4..697a063e27b7 100644 --- a/website/docs/cdktf/python/r/memorydb_snapshot.html.markdown +++ b/website/docs/cdktf/python/r/memorydb_snapshot.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `cluster_name` - (Required, Forces new resource) Name of the MemoryDB cluster to take a snapshot of. * `name` - (Optional, Forces new resource) Name of the snapshot. If omitted, Terraform will assign a random, unique name. Conflicts with `name_prefix`. * `name_prefix` - (Optional, Forces new resource) Creates a unique name beginning with the specified prefix. Conflicts with `name`. @@ -100,4 +101,4 @@ Using `terraform import`, import a snapshot using the `name`. For example: % terraform import aws_memorydb_snapshot.example my-snapshot ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/memorydb_subnet_group.html.markdown b/website/docs/cdktf/python/r/memorydb_subnet_group.html.markdown index 16ac724c4baf..edcf26fb26b3 100644 --- a/website/docs/cdktf/python/r/memorydb_subnet_group.html.markdown +++ b/website/docs/cdktf/python/r/memorydb_subnet_group.html.markdown @@ -56,6 +56,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `name` - (Optional, Forces new resource) Name of the subnet group. If omitted, Terraform will assign a random, unique name. Conflicts with `name_prefix`. * `name_prefix` - (Optional, Forces new resource) Creates a unique name beginning with the specified prefix. Conflicts with `name`. * `description` - (Optional) Description for the subnet group. Defaults to `"Managed by Terraform"`. @@ -95,4 +96,4 @@ Using `terraform import`, import a subnet group using its `name`. For example: % terraform import aws_memorydb_subnet_group.example my-subnet-group ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/memorydb_user.html.markdown b/website/docs/cdktf/python/r/memorydb_user.html.markdown index 9e25ee0e6780..b635a08fa0df 100644 --- a/website/docs/cdktf/python/r/memorydb_user.html.markdown +++ b/website/docs/cdktf/python/r/memorydb_user.html.markdown @@ -57,6 +57,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `tags` - (Optional) A 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. ### authentication_mode Configuration Block @@ -102,4 +103,4 @@ Using `terraform import`, import a user using the `user_name`. For example: The `passwords` are not available for imported resources, as this information cannot be read back from the MemoryDB API. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/mq_broker.html.markdown b/website/docs/cdktf/python/r/mq_broker.html.markdown index e250d145429c..38d86cc0772b 100644 --- a/website/docs/cdktf/python/r/mq_broker.html.markdown +++ b/website/docs/cdktf/python/r/mq_broker.html.markdown @@ -3,22 +3,22 @@ subcategory: "MQ" layout: "aws" page_title: "AWS: aws_mq_broker" description: |- - Provides an MQ Broker Resource + Manages an AWS MQ broker --- # Resource: aws_mq_broker -Provides an Amazon MQ broker resource. This resources also manages users for the broker. +Manages an AWS MQ broker. Use to create and manage message brokers for ActiveMQ and RabbitMQ engines. -> For more information on Amazon MQ, see [Amazon MQ documentation](https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/welcome.html). -~> **NOTE:** Amazon MQ currently places limits on **RabbitMQ** brokers. For example, a RabbitMQ broker cannot have: instances with an associated IP address of an ENI attached to the broker, an associated LDAP server to authenticate and authorize broker connections, storage type `EFS`, or audit logging. Although this resource allows you to create RabbitMQ users, RabbitMQ users cannot have console access or groups. Also, Amazon MQ does not return information about RabbitMQ users so drift detection is not possible. +!> **Warning:** Amazon MQ currently places limits on **RabbitMQ** brokers. For example, a RabbitMQ broker cannot have: instances with an associated IP address of an ENI attached to the broker, an associated LDAP server to authenticate and authorize broker connections, storage type `EFS`, or audit logging. Although this resource allows you to create RabbitMQ users, RabbitMQ users cannot have console access or groups. Also, Amazon MQ does not return information about RabbitMQ users so drift detection is not possible. -~> **NOTE:** Changes to an MQ Broker can occur when you change a parameter, such as `configuration` or `user`, and are reflected in the next maintenance window. Because of this, Terraform may report a difference in its planning phase because a modification has not yet taken place. You can use the `apply_immediately` flag to instruct the service to apply the change immediately (see documentation below). Using `apply_immediately` can result in a brief downtime as the broker reboots. +!> **Warning:** All arguments including the username and password will be stored in the raw state as plain-text. [Read more about sensitive data in state](https://www.terraform.io/docs/state/sensitive-data.html). -~> **NOTE:** All arguments including the username and password will be stored in the raw state as plain-text. [Read more about sensitive data in state](https://www.terraform.io/docs/state/sensitive-data.html). +~> **Note:** Changes to an MQ Broker can occur when you change a parameter, such as `configuration` or `user`, and are reflected in the next maintenance window. Because of this, Terraform may report a difference in its planning phase because a modification has not yet taken place. You can use the `apply_immediately` flag to instruct the service to apply the change immediately (see documentation below). Using `apply_immediately` can result in a brief downtime as the broker reboots. ## Example Usage @@ -47,8 +47,8 @@ class MyConvertedCode(TerraformStack): host_instance_type="mq.t2.micro", security_groups=[Token.as_string(aws_security_group_test.id)], user=[MqBrokerUser( - password="MindTheGap", - username="ExampleUser" + password="", + username="example_user" ) ] ) @@ -56,8 +56,6 @@ class MyConvertedCode(TerraformStack): ### High-throughput Optimized Example -This example shows the use of EBS storage for high-throughput optimized performance. - ```python # DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug from constructs import Construct @@ -82,8 +80,8 @@ class MyConvertedCode(TerraformStack): security_groups=[Token.as_string(aws_security_group_test.id)], storage_type="ebs", user=[MqBrokerUser( - password="MindTheGap", - username="ExampleUser" + password="", + username="example_user" ) ] ) @@ -114,12 +112,12 @@ class MyConvertedCode(TerraformStack): host_instance_type="mq.m5.large", security_groups=[Token.as_string(aws_security_group_example.id)], user=[MqBrokerUser( - password="MindTheGap", - username="ExampleUser" + password="", + username="example_user" ), MqBrokerUser( - password="Example12345", + password="", replication_user=True, - username="ExampleReplicationUser" + username="example_replication_user" ) ] ) @@ -133,12 +131,12 @@ class MyConvertedCode(TerraformStack): provider=awsalternate, security_groups=[Token.as_string(aws_security_group_example_primary.id)], user=[MqBrokerUser( - password="MindTheGap", - username="ExampleUser" + password="", + username="example_user" ), MqBrokerUser( - password="Example12345", + password="", replication_user=True, - username="ExampleReplicationUser" + username="example_replication_user" ) ] ) @@ -152,26 +150,27 @@ The following arguments are required: * `broker_name` - (Required) Name of the broker. * `engine_type` - (Required) Type of broker engine. Valid values are `ActiveMQ` and `RabbitMQ`. -* `engine_version` - (Required) Version of the broker engine. See the [AmazonMQ Broker Engine docs](https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html) for supported versions. For example, `5.17.6`. +* `engine_version` - (Required) Version of the broker engine. * `host_instance_type` - (Required) Broker's instance type. For example, `mq.t3.micro`, `mq.m5.large`. * `user` - (Required) Configuration block for broker users. For `engine_type` of `RabbitMQ`, Amazon MQ does not return broker users preventing this resource from making user updates and drift detection. Detailed below. The following arguments are optional: -* `apply_immediately` - (Optional) Specifies whether any broker modifications are applied immediately, or during the next maintenance window. Default is `false`. +* `apply_immediately` - (Optional) Whether to apply broker modifications immediately. Default is `false`. * `authentication_strategy` - (Optional) Authentication strategy used to secure the broker. Valid values are `simple` and `ldap`. `ldap` is not supported for `engine_type` `RabbitMQ`. * `auto_minor_version_upgrade` - (Optional) Whether to automatically upgrade to new minor versions of brokers as Amazon MQ makes releases available. * `configuration` - (Optional) Configuration block for broker configuration. Applies to `engine_type` of `ActiveMQ` and `RabbitMQ` only. Detailed below. -* `data_replication_mode` - (Optional) Defines whether this broker is a part of a data replication pair. Valid values are `CRDR` and `NONE`. -* `data_replication_primary_broker_arn` - (Optional) The Amazon Resource Name (ARN) of the primary broker that is used to replicate data from in a data replication pair, and is applied to the replica broker. Must be set when `data_replication_mode` is `CRDR`. +* `data_replication_mode` - (Optional) Whether this broker is part of a data replication pair. Valid values are `CRDR` and `NONE`. +* `data_replication_primary_broker_arn` - (Optional) ARN of the primary broker used to replicate data in a data replication pair. Required when `data_replication_mode` is `CRDR`. * `deployment_mode` - (Optional) Deployment mode of the broker. Valid values are `SINGLE_INSTANCE`, `ACTIVE_STANDBY_MULTI_AZ`, and `CLUSTER_MULTI_AZ`. Default is `SINGLE_INSTANCE`. * `encryption_options` - (Optional) Configuration block containing encryption options. Detailed below. -* `ldap_server_metadata` - (Optional) Configuration block for the LDAP server used to authenticate and authorize connections to the broker. Not supported for `engine_type` `RabbitMQ`. Detailed below. (Currently, AWS may not process changes to LDAP server metadata.) -* `logs` - (Optional) Configuration block for the logging configuration of the broker. Detailed below. +* `ldap_server_metadata` - (Optional) Configuration block for the LDAP server used to authenticate and authorize connections. Not supported for `engine_type` `RabbitMQ`. Detailed below. +* `logs` - (Optional) Configuration block for the logging configuration. Detailed below. * `maintenance_window_start_time` - (Optional) Configuration block for the maintenance window start time. Detailed below. * `publicly_accessible` - (Optional) Whether to enable connections from applications outside of the VPC that hosts the broker's subnets. +* `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). * `security_groups` - (Optional) List of security group IDs assigned to the broker. -* `storage_type` - (Optional) Storage type of the broker. For `engine_type` `ActiveMQ`, the valid values are `efs` and `ebs`, and the AWS-default is `efs`. For `engine_type` `RabbitMQ`, only `ebs` is supported. When using `ebs`, only the `mq.m5` broker instance type family is supported. +* `storage_type` - (Optional) Storage type of the broker. For `engine_type` `ActiveMQ`, valid values are `efs` and `ebs` (AWS-default is `efs`). For `engine_type` `RabbitMQ`, only `ebs` is supported. When using `ebs`, only the `mq.m5` broker instance type family is supported. * `subnet_ids` - (Optional) List of subnet IDs in which to launch the broker. A `SINGLE_INSTANCE` deployment requires one subnet. An `ACTIVE_STANDBY_MULTI_AZ` deployment requires multiple subnets. * `tags` - (Optional) Map of tags to assign to the broker. 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. @@ -179,29 +178,29 @@ The following arguments are optional: The following arguments are optional: -* `id` - (Optional) The Configuration ID. +* `id` - (Optional) Configuration ID. * `revision` - (Optional) Revision of the Configuration. ### encryption_options The following arguments are optional: -* `kms_key_id` - (Optional) Amazon Resource Name (ARN) of Key Management Service (KMS) Customer Master Key (CMK) to use for encryption at rest. Requires setting `use_aws_owned_key` to `false`. To perform drift detection when AWS-managed CMKs or customer-managed CMKs are in use, this value must be configured. -* `use_aws_owned_key` - (Optional) Whether to enable an AWS-owned KMS CMK that is not in your account. Defaults to `true`. Setting to `false` without configuring `kms_key_id` will create an AWS-managed CMK aliased to `aws/mq` in your account. +* `kms_key_id` - (Optional) ARN of KMS CMK to use for encryption at rest. Requires setting `use_aws_owned_key` to `false`. To perform drift detection when AWS-managed CMKs or customer-managed CMKs are in use, this value must be configured. +* `use_aws_owned_key` - (Optional) Whether to enable an AWS-owned KMS CMK not in your account. Defaults to `true`. Setting to `false` without configuring `kms_key_id` creates an AWS-managed CMK aliased to `aws/mq` in your account. ### ldap_server_metadata The following arguments are optional: -* `hosts` - (Optional) List of a fully qualified domain name of the LDAP server and an optional failover server. -* `role_base` - (Optional) Fully qualified name of the directory to search for a user’s groups. -* `role_name` - (Optional) Specifies the LDAP attribute that identifies the group name attribute in the object returned from the group membership query. +* `hosts` - (Optional) List of fully qualified domain names of the LDAP server and optional failover server. +* `role_base` - (Optional) Fully qualified name of the directory to search for a user's groups. +* `role_name` - (Optional) LDAP attribute that identifies the group name attribute in the object returned from the group membership query. * `role_search_matching` - (Optional) Search criteria for groups. * `role_search_subtree` - (Optional) Whether the directory search scope is the entire sub-tree. * `service_account_password` - (Optional) Service account password. * `service_account_username` - (Optional) Service account username. * `user_base` - (Optional) Fully qualified name of the directory where you want to search for users. -* `user_role_name` - (Optional) Specifies the name of the LDAP attribute for the user group membership. +* `user_role_name` - (Optional) Name of the LDAP attribute for the user group membership. * `user_search_matching` - (Optional) Search criteria for users. * `user_search_subtree` - (Optional) Whether the directory search scope is the entire sub-tree. @@ -209,8 +208,8 @@ The following arguments are optional: The following arguments are optional: -* `audit` - (Optional) Enables audit logging. Auditing is only possible for `engine_type` of `ActiveMQ`. User management action made using JMX or the ActiveMQ Web Console is logged. Defaults to `false`. -* `general` - (Optional) Enables general logging via CloudWatch. Defaults to `false`. +* `audit` - (Optional) Whether to enable audit logging. Only possible for `engine_type` of `ActiveMQ`. Logs user management actions via JMX or ActiveMQ Web Console. Defaults to `false`. +* `general` - (Optional) Whether to enable general logging via CloudWatch. Defaults to `false`. ### maintenance_window_start_time @@ -222,11 +221,16 @@ The following arguments are required: ### user +The following arguments are required: + +* `password` - (Required) Password of the user. Must be 12 to 250 characters long, contain at least 4 unique characters, and must not contain commas. +* `username` - (Required) Username of the user. + +The following arguments are optional: + * `console_access` - (Optional) Whether to enable access to the [ActiveMQ Web Console](http://activemq.apache.org/web-console.html) for the user. Applies to `engine_type` of `ActiveMQ` only. * `groups` - (Optional) List of groups (20 maximum) to which the ActiveMQ user belongs. Applies to `engine_type` of `ActiveMQ` only. -* `password` - (Required) Password of the user. It must be 12 to 250 characters long, at least 4 unique characters, and must not contain commas. -* `replication_user` - (Optional) Whether to set set replication user. Defaults to `false`. -* `username` - (Required) Username of the user. +* `replication_user` - (Optional) Whether to set replication user. Defaults to `false`. ~> **NOTE:** AWS currently does not support updating RabbitMQ users. Updates to users can only be in the RabbitMQ UI. @@ -237,7 +241,7 @@ This resource exports the following attributes in addition to the arguments abov * `arn` - ARN of the broker. * `id` - Unique ID that Amazon MQ generates for the broker. * `instances` - List of information about allocated brokers (both active & standby). - * `instances.0.console_url` - The URL of the [ActiveMQ Web Console](http://activemq.apache.org/web-console.html) or the [RabbitMQ Management UI](https://www.rabbitmq.com/management.html#external-monitoring) depending on `engine_type`. + * `instances.0.console_url` - URL of the [ActiveMQ Web Console](http://activemq.apache.org/web-console.html) or the [RabbitMQ Management UI](https://www.rabbitmq.com/management.html#external-monitoring) depending on `engine_type`. * `instances.0.ip_address` - IP Address of the broker. * `instances.0.endpoints` - Broker's wire-level protocol endpoints in the following order & format referenceable e.g., as `instances.0.endpoints.0` (SSL): * For `ActiveMQ`: @@ -248,8 +252,8 @@ This resource exports the following attributes in addition to the arguments abov * `wss://broker-id.mq.us-west-2.amazonaws.com:61619` * For `RabbitMQ`: * `amqps://broker-id.mq.us-west-2.amazonaws.com:5671` -* `pending_data_replication_mode` - (Optional) The data replication mode that will be applied after reboot. -* `tags_all` - A map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). +* `pending_data_replication_mode` - Data replication mode that will be applied after reboot. +* `tags_all` - Map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). ## Timeouts @@ -284,4 +288,4 @@ Using `terraform import`, import MQ Brokers using their broker id. For example: % terraform import aws_mq_broker.example a1b2c3d4-d5f6-7777-8888-9999aaaabbbbcccc ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/mq_configuration.html.markdown b/website/docs/cdktf/python/r/mq_configuration.html.markdown index 383efe4545d2..3242c06b335a 100644 --- a/website/docs/cdktf/python/r/mq_configuration.html.markdown +++ b/website/docs/cdktf/python/r/mq_configuration.html.markdown @@ -2,17 +2,14 @@ subcategory: "MQ" layout: "aws" page_title: "AWS: aws_mq_configuration" -description: |- - Provides an MQ configuration Resource +description: "Manages an Amazon MQ configuration" --- # Resource: aws_mq_configuration -Provides an MQ Configuration Resource. - -For more information on Amazon MQ, see [Amazon MQ documentation](https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/welcome.html). +Manages an Amazon MQ configuration. Use this resource to create and manage broker configurations for ActiveMQ and RabbitMQ brokers. ## Example Usage @@ -66,16 +63,17 @@ class MyConvertedCode(TerraformStack): The following arguments are required: -* `data` - (Required) Broker configuration in XML format for `ActiveMQ` or [Cuttlefish](https://github.com/Kyorai/cuttlefish) format for `RabbitMQ`. See [official docs](https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/amazon-mq-broker-configuration-parameters.html) for supported parameters and format of the XML. +* `data` - (Required) Broker configuration in XML format for ActiveMQ or Cuttlefish format for RabbitMQ. See [AWS documentation](https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/amazon-mq-broker-configuration-parameters.html) for supported parameters and format of the XML. * `engine_type` - (Required) Type of broker engine. Valid values are `ActiveMQ` and `RabbitMQ`. * `engine_version` - (Required) Version of the broker engine. * `name` - (Required) Name of the configuration. The following arguments are optional: -* `authentication_strategy` - (Optional) Authentication strategy associated with the configuration. Valid values are `simple` and `ldap`. `ldap` is not supported for `engine_type` `RabbitMQ`. +* `authentication_strategy` - (Optional) Authentication strategy associated with the configuration. Valid values are `simple` and `ldap`. `ldap` is not supported for RabbitMQ engine type. * `description` - (Optional) Description of the configuration. -* `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. +* `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). +* `tags` - (Optional) Key-value 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. ## Attribute Reference @@ -84,7 +82,7 @@ This resource exports the following attributes in addition to the arguments abov * `arn` - ARN of the configuration. * `id` - Unique ID that Amazon MQ generates for the configuration. * `latest_revision` - Latest revision of the configuration. -* `tags_all` - A map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). +* `tags_all` - Map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). ## Import @@ -111,4 +109,4 @@ Using `terraform import`, import MQ Configurations using the configuration ID. F % terraform import aws_mq_configuration.example c-0187d1eb-88c8-475a-9b79-16ef5a10c94f ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/msk_cluster.html.markdown b/website/docs/cdktf/python/r/msk_cluster.html.markdown index 1a42d28b4153..ff4ac13840c6 100644 --- a/website/docs/cdktf/python/r/msk_cluster.html.markdown +++ b/website/docs/cdktf/python/r/msk_cluster.html.markdown @@ -205,16 +205,17 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: -* `broker_node_group_info` - (Required) Configuration block for the broker nodes of the Kafka cluster. +* `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). +* `broker_node_group_info` - (Required) Configuration block for the broker nodes of the Kafka cluster. See [broker_node_group_info Argument Reference](#broker_node_group_info-argument-reference) below. * `cluster_name` - (Required) Name of the MSK cluster. * `kafka_version` - (Required) Specify the desired Kafka software version. * `number_of_broker_nodes` - (Required) The desired total number of broker nodes in the kafka cluster. It must be a multiple of the number of specified client subnets. -* `client_authentication` - (Optional) Configuration block for specifying a client authentication. See below. -* `configuration_info` - (Optional) Configuration block for specifying a MSK Configuration to attach to Kafka brokers. See below. -* `encryption_info` - (Optional) Configuration block for specifying encryption. See below. +* `client_authentication` - (Optional) Configuration block for specifying a client authentication. See [client_authentication Argument Reference](#client_authentication-argument-reference) below. +* `configuration_info` - (Optional) Configuration block for specifying an MSK Configuration to attach to Kafka brokers. See [configuration_info Argument Reference](#configuration_info-argument-reference) below. +* `encryption_info` - (Optional) Configuration block for specifying encryption. See [encryption_info Argument Reference](#encryption_info-argument-reference) below. * `enhanced_monitoring` - (Optional) Specify the desired enhanced MSK CloudWatch monitoring level. See [Monitoring Amazon MSK with Amazon CloudWatch](https://docs.aws.amazon.com/msk/latest/developerguide/monitoring.html) -* `open_monitoring` - (Optional) Configuration block for JMX and Node monitoring for the MSK cluster. See below. -* `logging_info` - (Optional) Configuration block for streaming broker logs to Cloudwatch/S3/Kinesis Firehose. See below. +* `open_monitoring` - (Optional) Configuration block for JMX and Node monitoring for the MSK cluster. See [open_monitoring Argument Reference](#open_monitoring-argument-reference) below. +* `logging_info` - (Optional) Configuration block for streaming broker logs to Cloudwatch/S3/Kinesis Firehose. See [logging_info Argument Reference](#logging_info-argument-reference) below. * `storage_mode` - (Optional) Controls storage mode for supported storage tiers. Valid values are: `LOCAL` or `TIERED`. * `tags` - (Optional) A 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. @@ -223,14 +224,14 @@ This resource supports the following arguments: * `client_subnets` - (Required) A list of subnets to connect to in client VPC ([documentation](https://docs.aws.amazon.com/msk/1.0/apireference/clusters.html#clusters-prop-brokernodegroupinfo-clientsubnets)). * `instance_type` - (Required) Specify the instance type to use for the kafka brokersE.g., kafka.m5.large. ([Pricing info](https://aws.amazon.com/msk/pricing/)) * `security_groups` - (Required) A list of the security groups to associate with the elastic network interfaces to control who can communicate with the cluster. -* `az_distribution` - (Optional) The distribution of broker nodes across availability zones ([documentation](https://docs.aws.amazon.com/msk/1.0/apireference/clusters.html#clusters-model-brokerazdistribution)). Currently the only valid value is `DEFAULT`. -* `connectivity_info` - (Optional) Information about the cluster access configuration. See below. For security reasons, you can't turn on public access while creating an MSK cluster. However, you can update an existing cluster to make it publicly accessible. You can also create a new cluster and then update it to make it publicly accessible ([documentation](https://docs.aws.amazon.com/msk/latest/developerguide/public-access.html)). -* `storage_info` - (Optional) A block that contains information about storage volumes attached to MSK broker nodes. See below. +* `az_distribution` - (Optional) The distribution of broker nodes across availability zones ([documentation](https://docs.aws.amazon.com/msk/1.0/apireference/clusters.html#clusters-model-brokerazdistribution)). Currently, the only valid value is `DEFAULT`. +* `connectivity_info` - (Optional) Information about the cluster access configuration. See [broker_node_group_info connectivity_info Argument Reference](#broker_node_group_info-connectivity_info-argument-reference) below. For security reasons, you can't turn on public access while creating an MSK cluster. However, you can update an existing cluster to make it publicly accessible. You can also create a new cluster and then update it to make it publicly accessible ([documentation](https://docs.aws.amazon.com/msk/latest/developerguide/public-access.html)). +* `storage_info` - (Optional) A block that contains information about storage volumes attached to MSK broker nodes. See [broker_node_group_info storage_info Argument Reference](#broker_node_group_info-storage_info-argument-reference) below. ### broker_node_group_info connectivity_info Argument Reference -* `public_access` - (Optional) Access control settings for brokers. See below. -* `vpc_connectivity` - (Optional) VPC connectivity access control for brokers. See below. +* `public_access` - (Optional) Access control settings for brokers. See [connectivity_info public_access Argument Reference](#connectivity_info-public_access-argument-reference) below. +* `vpc_connectivity` - (Optional) VPC connectivity access control for brokers. See [connectivity_info vpc_connectivity Argument Reference](#connectivity_info-vpc_connectivity-argument-reference) below. ### connectivity_info public_access Argument Reference @@ -238,11 +239,11 @@ This resource supports the following arguments: ### connectivity_info vpc_connectivity Argument Reference -* `client_authentication` - (Optional) Includes all client authentication information for VPC connectivity. See below. +* `client_authentication` - (Optional) Includes all client authentication information for VPC connectivity. See [vpc_connectivity client_authentication Argument Reference](#vpc_connectivity-client_authentication-argument-reference) below. ### vpc_connectivity client_authentication Argument Reference -* `sasl` - (Optional) SASL authentication type details for VPC connectivity. See below. +* `sasl` - (Optional) SASL authentication type details for VPC connectivity. See [vpc_connectivity client_authentication sasl Argument Reference](#vpc_connectivity-client_authentication-sasl-argument-reference) below. * `tls` - (Optional) Enables TLS authentication for VPC connectivity. ### vpc_connectivity client_authentication sasl Argument Reference @@ -252,11 +253,11 @@ This resource supports the following arguments: ### broker_node_group_info storage_info Argument Reference -* `ebs_storage_info` - (Optional) A block that contains EBS volume information. See below. +* `ebs_storage_info` - (Optional) A block that contains EBS volume information. See [storage_info ebs_storage_info Argument Reference](#storage_info-ebs_storage_info-argument-reference) below. ### storage_info ebs_storage_info Argument Reference -* `provisioned_throughput` - (Optional) A block that contains EBS volume provisioned throughput information. To provision storage throughput, you must choose broker type kafka.m5.4xlarge or larger. See below. +* `provisioned_throughput` - (Optional) A block that contains EBS volume provisioned throughput information. To provision storage throughput, you must choose broker type kafka.m5.4xlarge or larger. See [ebs_storage_info provisioned_throughput Argument Reference](#ebs_storage_info-provisioned_throughput-argument-reference) below. * `volume_size` - (Optional) The size in GiB of the EBS volume for the data drive on each broker node. Minimum value of `1` and maximum value of `16384`. ### ebs_storage_info provisioned_throughput Argument Reference @@ -266,8 +267,8 @@ This resource supports the following arguments: ### client_authentication Argument Reference -* `sasl` - (Optional) Configuration block for specifying SASL client authentication. See below. -* `tls` - (Optional) Configuration block for specifying TLS client authentication. See below. +* `sasl` - (Optional) Configuration block for specifying SASL client authentication. See [client_authentication sasl Argument Reference](#client_authentication-sasl-argument-reference) below. +* `tls` - (Optional) Configuration block for specifying TLS client authentication. See [client_authentication tls Argument Reference](#client_authentication-tls-argument-reference) below. * `unauthenticated` - (Optional) Enables unauthenticated access. #### client_authentication sasl Argument Reference @@ -286,7 +287,7 @@ This resource supports the following arguments: ### encryption_info Argument Reference -* `encryption_in_transit` - (Optional) Configuration block to specify encryption in transit. See below. +* `encryption_in_transit` - (Optional) Configuration block to specify encryption in transit. See [encryption_info encryption_in_transit Argument Reference](#encryption_info-encryption_in_transit-argument-reference) below. * `encryption_at_rest_kms_key_arn` - (Optional) You may specify a KMS key short ID or ARN (it will always output an ARN) to use for encrypting your data at rest. If no key is specified, an AWS managed KMS ('aws/msk' managed service) key will be used for encrypting the data at rest. #### encryption_info encryption_in_transit Argument Reference @@ -296,12 +297,12 @@ This resource supports the following arguments: #### open_monitoring Argument Reference -* `prometheus` - (Required) Configuration block for Prometheus settings for open monitoring. See below. +* `prometheus` - (Required) Configuration block for Prometheus settings for open monitoring. See [open_monitoring prometheus Argument Reference](#open_monitoring-prometheus-argument-reference) below. #### open_monitoring prometheus Argument Reference -* `jmx_exporter` - (Optional) Configuration block for JMX Exporter. See below. -* `node_exporter` - (Optional) Configuration block for Node Exporter. See below. +* `jmx_exporter` - (Optional) Configuration block for JMX Exporter. See [open_monitoring prometheus jmx_exporter Argument Reference](#open_monitoring-prometheus-jmx_exporter-argument-reference) below. +* `node_exporter` - (Optional) Configuration block for Node Exporter. See [open_monitoring prometheus node_exporter Argument Reference](#open_monitoring-prometheus-node_exporter-argument-reference) below. #### open_monitoring prometheus jmx_exporter Argument Reference @@ -313,7 +314,13 @@ This resource supports the following arguments: #### logging_info Argument Reference -* `broker_logs` - (Required) Configuration block for Broker Logs settings for logging info. See below. +* `broker_logs` - (Required) Configuration block for Broker Logs settings for logging info. See [logging_info broker_logs Argument Reference](#logging_info-broker_logs-argument-reference) below. + +#### logging_info broker_logs Argument Reference + +* `cloudwatch_logs` - (Optional) Configuration block for Cloudwatch Logs settings. See [logging_info broker_logs cloudwatch_logs Argument Reference](#logging_info-broker_logs-cloudwatch_logs-argument-reference) below. +* `firehose` - (Optional) Configuration block for Kinesis Data Firehose settings. See [logging_info broker_logs firehose Argument Reference](#logging_info-broker_logs-firehose-argument-reference) below. +* `s3` - (Optional) Configuration block for S3 settings. See [logging_info broker_logs s3 Argument Reference](#logging_info-broker_logs-s3-argument-reference) below. #### logging_info broker_logs cloudwatch_logs Argument Reference @@ -387,4 +394,4 @@ Using `terraform import`, import MSK clusters using the cluster `arn`. For examp % terraform import aws_msk_cluster.example arn:aws:kafka:us-west-2:123456789012:cluster/example/279c0212-d057-4dba-9aa9-1c4e5a25bfc7-3 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/msk_cluster_policy.html.markdown b/website/docs/cdktf/python/r/msk_cluster_policy.html.markdown index 398acf88dad7..af9e94207243 100644 --- a/website/docs/cdktf/python/r/msk_cluster_policy.html.markdown +++ b/website/docs/cdktf/python/r/msk_cluster_policy.html.markdown @@ -55,8 +55,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `cluster_arn` - (Required) The Amazon Resource Name (ARN) that uniquely identifies the cluster. * `policy` - (Required) Resource policy for cluster. @@ -91,4 +92,4 @@ Using `terraform import`, import Managed Streaming for Kafka Cluster Policy usin % terraform import aws_msk_cluster_policy.example arn:aws:kafka:us-west-2:123456789012:cluster/example/279c0212-d057-4dba-9aa9-1c4e5a25bfc7-3 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/msk_configuration.html.markdown b/website/docs/cdktf/python/r/msk_configuration.html.markdown index 990ad3e2028f..40ab7f602d22 100644 --- a/website/docs/cdktf/python/r/msk_configuration.html.markdown +++ b/website/docs/cdktf/python/r/msk_configuration.html.markdown @@ -37,6 +37,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `server_properties` - (Required) Contents of the server.properties file. Supported properties are documented in the [MSK Developer Guide](https://docs.aws.amazon.com/msk/latest/developerguide/msk-configuration-properties.html). * `kafka_versions` - (Optional) List of Apache Kafka versions which can use this configuration. * `name` - (Required) Name of the configuration. @@ -74,4 +75,4 @@ Using `terraform import`, import MSK configurations using the configuration ARN. % terraform import aws_msk_configuration.example arn:aws:kafka:us-west-2:123456789012:configuration/example/279c0212-d057-4dba-9aa9-1c4e5a25bfc7-3 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/msk_replicator.html.markdown b/website/docs/cdktf/python/r/msk_replicator.html.markdown index 53f2844e6d27..d0a46236b34f 100644 --- a/website/docs/cdktf/python/r/msk_replicator.html.markdown +++ b/website/docs/cdktf/python/r/msk_replicator.html.markdown @@ -78,6 +78,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `replicator_name` - (Required) The name of the replicator. * `kafka_cluster` - (Required) A list of Kafka clusters which are targets of the replicator. * `service_execution_role_arn` - (Required) The ARN of the IAM role used by the replicator to access resources in the customer's account (e.g source and target clusters). @@ -172,4 +173,4 @@ Using `terraform import`, import MSK replicators using the replicator ARN. For e % terraform import aws_msk_replicator.example arn:aws:kafka:us-west-2:123456789012:configuration/example/279c0212-d057-4dba-9aa9-1c4e5a25bfc7-3 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/msk_scram_secret_association.html.markdown b/website/docs/cdktf/python/r/msk_scram_secret_association.html.markdown index 3b7a25670c9f..c1aaf71728cf 100644 --- a/website/docs/cdktf/python/r/msk_scram_secret_association.html.markdown +++ b/website/docs/cdktf/python/r/msk_scram_secret_association.html.markdown @@ -112,6 +112,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `cluster_arn` - (Required, Forces new resource) Amazon Resource Name (ARN) of the MSK cluster. * `secret_arn_list` - (Required) List of AWS Secrets Manager secret ARNs. @@ -146,4 +147,4 @@ Using `terraform import`, import MSK SCRAM Secret Associations using the `id`. F % terraform import aws_msk_scram_secret_association.example arn:aws:kafka:us-west-2:123456789012:cluster/example/279c0212-d057-4dba-9aa9-1c4e5a25bfc7-3 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/msk_serverless_cluster.html.markdown b/website/docs/cdktf/python/r/msk_serverless_cluster.html.markdown index 017cd7ee8bbb..918e6b0dbf80 100644 --- a/website/docs/cdktf/python/r/msk_serverless_cluster.html.markdown +++ b/website/docs/cdktf/python/r/msk_serverless_cluster.html.markdown @@ -50,6 +50,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `client_authentication` - (Required) Specifies client authentication information for the serverless cluster. See below. * `cluster_name` - (Required) The name of the serverless cluster. * `tags` - (Optional) A 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. @@ -113,4 +114,4 @@ Using `terraform import`, import MSK serverless clusters using the cluster `arn` % terraform import aws_msk_serverless_cluster.example arn:aws:kafka:us-west-2:123456789012:cluster/example/279c0212-d057-4dba-9aa9-1c4e5a25bfc7-3 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/msk_single_scram_secret_association.html.markdown b/website/docs/cdktf/python/r/msk_single_scram_secret_association.html.markdown index 9dc8f078e6a3..3bc6e6ff7586 100644 --- a/website/docs/cdktf/python/r/msk_single_scram_secret_association.html.markdown +++ b/website/docs/cdktf/python/r/msk_single_scram_secret_association.html.markdown @@ -36,6 +36,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `cluster_arn` - (Required, Forces new resource) Amazon Resource Name (ARN) of the MSK cluster. * `secret_arn` - (Required, Forces new resource) AWS Secrets Manager secret ARN. @@ -68,4 +69,4 @@ Using `terraform import`, import an MSK SCRAM Secret Association using the `clus % terraform import aws_msk_single_scram_secret_association.example arn:aws:kafka:us-west-2:123456789012:cluster/example/279c0212-d057-4dba-9aa9-1c4e5a25bfc7-3,arn:aws:secretsmanager:us-east-1:123456789012:secret:example-123456 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/msk_vpc_connection.html.markdown b/website/docs/cdktf/python/r/msk_vpc_connection.html.markdown index 477a788dbe42..aac1ca8fc4ab 100644 --- a/website/docs/cdktf/python/r/msk_vpc_connection.html.markdown +++ b/website/docs/cdktf/python/r/msk_vpc_connection.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `authentication` - (Required) The authentication type for the client VPC connection. Specify one of these auth type strings: SASL_IAM, SASL_SCRAM, or TLS. * `client_subnets` - (Required) The list of subnets in the client VPC to connect to. * `security_groups` - (Required) The security groups to attach to the ENIs for the broker nodes. @@ -85,4 +86,4 @@ Using `terraform import`, import MSK configurations using the configuration ARN. % terraform import aws_msk_vpc_connection.example arn:aws:kafka:eu-west-2:123456789012:vpc-connection/123456789012/example/38173259-79cd-4ee8-87f3-682ea6023f48-2 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/mskconnect_connector.html.markdown b/website/docs/cdktf/python/r/mskconnect_connector.html.markdown index b72ffc1d5e48..faaa6fdfe4d2 100644 --- a/website/docs/cdktf/python/r/mskconnect_connector.html.markdown +++ b/website/docs/cdktf/python/r/mskconnect_connector.html.markdown @@ -91,6 +91,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `description` - (Optional) A summary description of the connector. * `log_delivery` - (Optional) Details about log delivery. See [`log_delivery` Block](#log_delivery-block) for details. * `tags` - (Optional) A 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. @@ -261,4 +262,4 @@ Using `terraform import`, import MSK Connect Connector using the connector's `ar % terraform import aws_mskconnect_connector.example 'arn:aws:kafkaconnect:eu-central-1:123456789012:connector/example/264edee4-17a3-412e-bd76-6681cfc93805-3' ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/mskconnect_custom_plugin.html.markdown b/website/docs/cdktf/python/r/mskconnect_custom_plugin.html.markdown index dbb1f8eb0586..d79e1309f834 100644 --- a/website/docs/cdktf/python/r/mskconnect_custom_plugin.html.markdown +++ b/website/docs/cdktf/python/r/mskconnect_custom_plugin.html.markdown @@ -58,6 +58,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required, Forces new resource) The name of the custom plugin.. * `content_type` - (Required, Forces new resource) The type of the plugin file. Allowed values are `ZIP` and `JAR`. * `description` - (Optional, Forces new resource) A summary description of the custom plugin. @@ -119,4 +120,4 @@ Using `terraform import`, import MSK Connect Custom Plugin using the plugin's `a % terraform import aws_mskconnect_custom_plugin.example 'arn:aws:kafkaconnect:eu-central-1:123456789012:custom-plugin/debezium-example/abcdefgh-1234-5678-9abc-defghijklmno-4' ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/mskconnect_worker_configuration.html.markdown b/website/docs/cdktf/python/r/mskconnect_worker_configuration.html.markdown index 87e6a56955ff..9e29e2f581c1 100644 --- a/website/docs/cdktf/python/r/mskconnect_worker_configuration.html.markdown +++ b/website/docs/cdktf/python/r/mskconnect_worker_configuration.html.markdown @@ -43,6 +43,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `description` - (Optional, Forces new resource) A summary description of the worker configuration. * `tags` - (Optional) A 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. @@ -85,4 +86,4 @@ Using `terraform import`, import MSK Connect Worker Configuration using the plug % terraform import aws_mskconnect_worker_configuration.example 'arn:aws:kafkaconnect:eu-central-1:123456789012:worker-configuration/example/8848493b-7fcc-478c-a646-4a52634e3378-4' ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/mwaa_environment.html.markdown b/website/docs/cdktf/python/r/mwaa_environment.html.markdown index ce7a09f71634..74332ce7d3ad 100644 --- a/website/docs/cdktf/python/r/mwaa_environment.html.markdown +++ b/website/docs/cdktf/python/r/mwaa_environment.html.markdown @@ -172,15 +172,17 @@ This resource supports the following arguments: * `network_configuration` - (Required) Specifies the network configuration for your Apache Airflow Environment. This includes two private subnets as well as security groups for the Airflow environment. Each subnet requires internet connection, otherwise the deployment will fail. See [`network_configuration` Block](#network_configuration-block) for details. * `plugins_s3_object_version` - (Optional) The plugins.zip file version you want to use. * `plugins_s3_path` - (Optional) The relative path to the plugins.zip file on your Amazon S3 storage bucket. For example, plugins.zip. If a relative path is provided in the request, then plugins_s3_object_version is required. For more information, see [Importing DAGs on Amazon MWAA](https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-import.html). +* `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). * `requirements_s3_object_version` - (Optional) The requirements.txt file version you want to use. * `requirements_s3_path` - (Optional) The relative path to the requirements.txt file on your Amazon S3 storage bucket. For example, requirements.txt. If a relative path is provided in the request, then requirements_s3_object_version is required. For more information, see [Importing DAGs on Amazon MWAA](https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-import.html). * `schedulers` - (Optional) The number of schedulers that you want to run in your environment. v2.0.2 and above accepts `2` - `5`, default `2`. v1.10.12 accepts `1`. * `source_bucket_arn` - (Required) The Amazon Resource Name (ARN) of your Amazon S3 storage bucket. For example, arn:aws:s3:::airflow-mybucketname. * `startup_script_s3_object_version` - (Optional) The version of the startup shell script you want to use. You must specify the version ID that Amazon S3 assigns to the file every time you update the script. * `startup_script_s3_path` - (Optional) The relative path to the script hosted in your bucket. The script runs as your environment starts before starting the Apache Airflow process. Use this script to install dependencies, modify configuration options, and set environment variables. See [Using a startup script](https://docs.aws.amazon.com/mwaa/latest/userguide/using-startup-script.html). Supported for environment versions 2.x and later. +* `tags` - (Optional) A map of resource tags to associate with 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. * `webserver_access_mode` - (Optional) Specifies whether the webserver should be accessible over the internet or via your specified VPC. Possible options: `PRIVATE_ONLY` (default) and `PUBLIC_ONLY`. * `weekly_maintenance_window_start` - (Optional) Specifies the start date for the weekly maintenance window. -* `tags` - (Optional) A map of resource tags to associate with 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. +* `worker_replacement_strategy` - (Optional) Worker replacement strategy. Valid values: `FORCED`, `GRACEFUL`. ### `logging_configuration` Block @@ -253,4 +255,4 @@ Using `terraform import`, import MWAA Environment using `Name`. For example: % terraform import aws_mwaa_environment.example MyAirflowEnvironment ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/nat_gateway.html.markdown b/website/docs/cdktf/python/r/nat_gateway.html.markdown index a4e0361a6729..6f2822d88229 100644 --- a/website/docs/cdktf/python/r/nat_gateway.html.markdown +++ b/website/docs/cdktf/python/r/nat_gateway.html.markdown @@ -12,6 +12,8 @@ description: |- Provides a resource to create a VPC NAT Gateway. +!> **WARNING:** You should not use the `aws_nat_gateway` resource that has `secondary_allocation_ids` in conjunction with an [`aws_nat_gateway_eip_association`](nat_gateway_eip_association.html) resource. Doing so may cause perpetual differences, and result in associations being overwritten. + ## Example Usage ### Public NAT @@ -108,10 +110,11 @@ This resource supports the following arguments: * `allocation_id` - (Optional) The Allocation ID of the Elastic IP address for the NAT Gateway. Required for `connectivity_type` of `public`. * `connectivity_type` - (Optional) Connectivity type for the NAT Gateway. Valid values are `private` and `public`. Defaults to `public`. * `private_ip` - (Optional) The private IPv4 address to assign to the NAT Gateway. If you don't provide an address, a private IPv4 address will be automatically assigned. +* `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). * `subnet_id` - (Required) The Subnet ID of the subnet in which to place the NAT Gateway. -* `secondary_allocation_ids` - (Optional) A list of secondary allocation EIP IDs for this NAT Gateway. +* `secondary_allocation_ids` - (Optional) A list of secondary allocation EIP IDs for this NAT Gateway. To remove all secondary allocations an empty list should be specified. * `secondary_private_ip_address_count` - (Optional) [Private NAT Gateway only] The number of secondary private IPv4 addresses you want to assign to the NAT Gateway. -* `secondary_private_ip_addresses` - (Optional) A list of secondary private IPv4 addresses to assign to the NAT Gateway. +* `secondary_private_ip_addresses` - (Optional) A list of secondary private IPv4 addresses to assign to the NAT Gateway. To remove all secondary private addresses an empty list should be specified. * `tags` - (Optional) A 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. ## Attribute Reference @@ -157,4 +160,4 @@ Using `terraform import`, import NAT Gateways using the `id`. For example: % terraform import aws_nat_gateway.private_gw nat-05dba92075d71c408 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/nat_gateway_eip_association.html.markdown b/website/docs/cdktf/python/r/nat_gateway_eip_association.html.markdown new file mode 100644 index 000000000000..07ee3b389720 --- /dev/null +++ b/website/docs/cdktf/python/r/nat_gateway_eip_association.html.markdown @@ -0,0 +1,85 @@ +--- +subcategory: "VPC (Virtual Private Cloud)" +layout: "aws" +page_title: "AWS: aws_nat_gateway_eip_association" +description: |- + Terraform resource for managing an AWS VPC NAT Gateway EIP Association. +--- + + +# Resource: aws_nat_gateway_eip_association + +Terraform resource for managing an AWS VPC NAT Gateway EIP Association. + +!> **WARNING:** You should not use the `aws_nat_gateway_eip_association` resource in conjunction with an [`aws_nat_gateway`](aws_nat_gateway.html) resource that has `secondary_allocation_ids` configured. Doing so may cause perpetual differences, and result in associations being overwritten. + +## 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. import NatGatewayEipAssociation +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + NatGatewayEipAssociation(self, "example", + allocation_id=aws_eip_example.id, + nat_gateway_id=aws_nat_gateway_example.id + ) +``` + +## Argument Reference + +The following arguments are required: + +* `allocation_id` - (Required) The ID of the Elastic IP Allocation to associate with the NAT Gateway. +* `nat_gateway_id` - (Required) The ID of the NAT Gateway to associate the Elastic IP Allocation to. + +The following arguments are optional: + +* `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). + +## Attribute Reference + +This resource exports no additional attributes. + +## Timeouts + +[Configuration options](https://developer.hashicorp.com/terraform/language/resources/syntax#operation-timeouts): + +* `create` - (Default `10m`) +* `delete` - (Default `30m`) + +## Import + +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import VPC NAT Gateway EIP Association using the `nat_gateway_id,allocation_id`. 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. import NatGatewayEipAssociation +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + NatGatewayEipAssociation.generate_config_for_import(self, "example", "nat-1234567890abcdef1,eipalloc-1234567890abcdef1") +``` + +Using `terraform import`, import VPC NAT Gateway EIP Association using the `nat_gateway_id,allocation_id`. For example: + +```console +% terraform import aws_nat_gateway_eip_association.example nat-1234567890abcdef1,eipalloc-1234567890abcdef1 +``` + + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/neptune_cluster.html.markdown b/website/docs/cdktf/python/r/neptune_cluster.html.markdown index aa1638c8a7f4..e742020c8ed6 100644 --- a/website/docs/cdktf/python/r/neptune_cluster.html.markdown +++ b/website/docs/cdktf/python/r/neptune_cluster.html.markdown @@ -59,6 +59,7 @@ This resource supports the following arguments: * `cluster_identifier` - (Optional, Forces new resources) Cluster identifier. If omitted, Terraform will assign a random, unique identifier. * `cluster_identifier_prefix` - (Optional, Forces new resource) Creates a unique cluster identifier beginning with the specified prefix. Conflicts with `cluster_identifier`. * `copy_tags_to_snapshot` - (Optional) If set to true, tags are copied to any snapshot of the DB cluster that is created. +* `deletion_protection` - (Optional) Value that indicates whether the DB cluster has deletion protection enabled.The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. * `enable_cloudwatch_logs_exports` - (Optional) List of the log types this DB cluster is configured to export to Cloudwatch Logs. Currently only supports `audit` and `slowquery`. * `engine` - (Optional) Name of the database engine to be used for this Neptune cluster. Defaults to `neptune`. * `engine_version` - (Optional) Database engine version. @@ -67,21 +68,21 @@ This resource supports the following arguments: * `iam_roles` - (Optional) List of ARNs for the IAM roles to associate to the Neptune Cluster. * `iam_database_authentication_enabled` - (Optional) Whether or not mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled. * `kms_key_arn` - (Optional) ARN for the KMS encryption key. When specifying `kms_key_arn`, `storage_encrypted` needs to be set to true. -* `neptune_subnet_group_name` - (Optional) Neptune subnet group to associate with this Neptune instance. * `neptune_cluster_parameter_group_name` - (Optional) Cluster parameter group to associate with the cluster. * `neptune_instance_parameter_group_name` – (Optional) Name of DB parameter group to apply to all instances in the cluster. When upgrading, AWS does not return this value, so do not reference it in other arguments—either leave it unset, configure each instance directly, or ensure it matches the `engine_version`. -* `storage_type` - (Optional) Storage type associated with the cluster `standard/iopt1`. Default: `standard` +* `neptune_subnet_group_name` - (Optional) Neptune subnet group to associate with this Neptune instance. +* `port` - (Optional) Port on which the Neptune accepts connections. Default is `8182`. * `preferred_backup_window` - (Optional) Daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter. Time in UTC. Default: A 30-minute window selected at random from an 8-hour block of time per regionE.g., 04:00-09:00 * `preferred_maintenance_window` - (Optional) Weekly time range during which system maintenance can occur, in (UTC) e.g., wed:04:00-wed:04:30 -* `port` - (Optional) Port on which the Neptune accepts connections. Default is `8182`. +* `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). * `replication_source_identifier` - (Optional) ARN of a source Neptune cluster or Neptune instance if this Neptune cluster is to be created as a Read Replica. +* `serverless_v2_scaling_configuration` - (Optional) If set, create the Neptune cluster as a serverless one. See [Serverless](#serverless) for example block attributes. * `skip_final_snapshot` - (Optional) Whether a final Neptune snapshot is created before the Neptune cluster is deleted. If true is specified, no Neptune snapshot is created. If false is specified, a Neptune snapshot is created before the Neptune cluster is deleted, using the value from `final_snapshot_identifier`. Default is `false`. * `snapshot_identifier` - (Optional) Whether or not to create this cluster from a snapshot. You can use either the name or ARN when specifying a Neptune cluster snapshot, or the ARN when specifying a Neptune snapshot. Automated snapshots **should not** be used for this attribute, unless from a different cluster. Automated snapshots are deleted as part of cluster destruction when the resource is replaced. * `storage_encrypted` - (Optional) Whether the Neptune cluster is encrypted. The default is `false` if not specified. +* `storage_type` - (Optional) Storage type associated with the cluster `standard/iopt1`. Default: `standard`. * `tags` - (Optional) Map of tags to assign to the Neptune cluster. 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. * `vpc_security_group_ids` - (Optional) List of VPC security groups to associate with the Cluster -* `deletion_protection` - (Optional) Value that indicates whether the DB cluster has deletion protection enabled.The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. -* `serverless_v2_scaling_configuration` - (Optional) If set, create the Neptune cluster as a serverless one. See [Serverless](#serverless) for example block attributes. ### Serverless @@ -170,4 +171,4 @@ Using `terraform import`, import `aws_neptune_cluster` using the cluster identif % terraform import aws_neptune_cluster.example my-cluster ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/neptune_cluster_endpoint.html.markdown b/website/docs/cdktf/python/r/neptune_cluster_endpoint.html.markdown index 49f567244f75..5fd36cf376a7 100644 --- a/website/docs/cdktf/python/r/neptune_cluster_endpoint.html.markdown +++ b/website/docs/cdktf/python/r/neptune_cluster_endpoint.html.markdown @@ -37,6 +37,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `cluster_identifier` - (Required, Forces new resources) The DB cluster identifier of the DB cluster associated with the endpoint. * `cluster_endpoint_identifier` - (Required, Forces new resources) The identifier of the endpoint. * `endpoint_type` - (Required) The type of the endpoint. One of: `READER`, `WRITER`, `ANY`. @@ -78,4 +79,4 @@ Using `terraform import`, import `aws_neptune_cluster_endpoint` using the `clust % terraform import aws_neptune_cluster_endpoint.example my-cluster:my-endpoint ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/neptune_cluster_instance.html.markdown b/website/docs/cdktf/python/r/neptune_cluster_instance.html.markdown index e4ccc01c855b..aa89eff2e70f 100644 --- a/website/docs/cdktf/python/r/neptune_cluster_instance.html.markdown +++ b/website/docs/cdktf/python/r/neptune_cluster_instance.html.markdown @@ -59,6 +59,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `apply_immediately` - (Optional) Specifies whether any instance modifications are applied immediately, or during the next maintenance window. Default is`false`. * `auto_minor_version_upgrade` - (Optional) Indicates that minor engine upgrades will be applied automatically to the instance during the maintenance window. Default is `true`. @@ -93,7 +94,7 @@ This resource exports the following attributes in addition to the arguments abov * `storage_encrypted` - Specifies whether the neptune cluster is encrypted. * `storage_type` - Storage type associated with the cluster `standard/iopt1`. * `tags_all` - A map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). -* `writer` – Boolean indicating if this instance is writable. `False` indicates this instance is a read replica. +* `writer` - Boolean indicating if this instance is writable. `False` indicates this instance is a read replica. [1]: https://www.terraform.io/docs/configuration/meta-arguments/count.html @@ -130,4 +131,4 @@ Using `terraform import`, import `aws_neptune_cluster_instance` using the instan % terraform import aws_neptune_cluster_instance.example my-instance ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/neptune_cluster_parameter_group.html.markdown b/website/docs/cdktf/python/r/neptune_cluster_parameter_group.html.markdown index 59e30665486a..6b57aa0701aa 100644 --- a/website/docs/cdktf/python/r/neptune_cluster_parameter_group.html.markdown +++ b/website/docs/cdktf/python/r/neptune_cluster_parameter_group.html.markdown @@ -42,6 +42,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Optional, Forces new resource) The name of the neptune cluster parameter group. If omitted, Terraform will assign a random, unique name. * `name_prefix` - (Optional, Forces new resource) Creates a unique name beginning with the specified prefix. Conflicts with `name`. * `family` - (Required) The family of the neptune cluster parameter group. @@ -88,4 +89,4 @@ Using `terraform import`, import Neptune Cluster Parameter Groups using the `nam % terraform import aws_neptune_cluster_parameter_group.cluster_pg production-pg-1 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/neptune_cluster_snapshot.html.markdown b/website/docs/cdktf/python/r/neptune_cluster_snapshot.html.markdown index 43dad961eed4..b9a9e3332a65 100644 --- a/website/docs/cdktf/python/r/neptune_cluster_snapshot.html.markdown +++ b/website/docs/cdktf/python/r/neptune_cluster_snapshot.html.markdown @@ -36,6 +36,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `db_cluster_identifier` - (Required) The DB Cluster Identifier from which to take the snapshot. * `db_cluster_snapshot_identifier` - (Required) The Identifier for the snapshot. @@ -87,4 +88,4 @@ Using `terraform import`, import `aws_neptune_cluster_snapshot` using the cluste % terraform import aws_neptune_cluster_snapshot.example my-cluster-snapshot ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/neptune_event_subscription.html.markdown b/website/docs/cdktf/python/r/neptune_event_subscription.html.markdown index 0a7aef9cb0d5..f518f338d3fd 100644 --- a/website/docs/cdktf/python/r/neptune_event_subscription.html.markdown +++ b/website/docs/cdktf/python/r/neptune_event_subscription.html.markdown @@ -66,6 +66,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `enabled` - (Optional) A boolean flag to enable/disable the subscription. Defaults to true. * `event_categories` - (Optional) A list of event categories for a `source_type` that you want to subscribe to. Run `aws neptune describe-event-categories` to find all the event categories. * `name` - (Optional) The name of the Neptune event subscription. By default generated by Terraform. @@ -117,4 +118,4 @@ Using `terraform import`, import `aws_neptune_event_subscription` using the even % terraform import aws_neptune_event_subscription.example my-event-subscription ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/neptune_global_cluster.html.markdown b/website/docs/cdktf/python/r/neptune_global_cluster.html.markdown index e0017918b84b..59203fe52eac 100644 --- a/website/docs/cdktf/python/r/neptune_global_cluster.html.markdown +++ b/website/docs/cdktf/python/r/neptune_global_cluster.html.markdown @@ -124,6 +124,7 @@ This resource supports the following arguments: * `deletion_protection` - (Optional) If the Global Cluster should have deletion protection enabled. The database can't be deleted when this value is set to `true`. The default is `false`. * `engine` - (Optional, Forces new resources) Name of the database engine to be used for this DB cluster. Terraform will only perform drift detection if a configuration value is provided. Current Valid values: `neptune`. Conflicts with `source_db_cluster_identifier`. * `engine_version` - (Optional) Engine version of the global database. Upgrading the engine version will result in all cluster members being immediately updated and will. +* `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). * `source_db_cluster_identifier` - (Optional) ARN to use as the primary DB Cluster of the Global Cluster on creation. Terraform cannot perform drift detection of this value. * `storage_encrypted` - (Optional, Forces new resources) Whether the DB cluster is encrypted. The default is `false` unless `source_db_cluster_identifier` is specified and encrypted. Terraform will only perform drift detection if a configuration value is provided. @@ -194,4 +195,4 @@ class MyConvertedCode(TerraformStack): ) ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/neptune_parameter_group.html.markdown b/website/docs/cdktf/python/r/neptune_parameter_group.html.markdown index 4a191f274183..f1315688f3eb 100644 --- a/website/docs/cdktf/python/r/neptune_parameter_group.html.markdown +++ b/website/docs/cdktf/python/r/neptune_parameter_group.html.markdown @@ -41,6 +41,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Optional, Forces new resource) The name of the Neptune parameter group. * `name_prefix` - (Optional, Forces new resource) Creates a unique name beginning with the specified prefix. Conflicts with `name`. * `family` - (Required) The family of the Neptune parameter group. @@ -87,4 +88,4 @@ Using `terraform import`, import Neptune Parameter Groups using the `name`. For % terraform import aws_neptune_parameter_group.some_pg some-pg ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/neptune_subnet_group.html.markdown b/website/docs/cdktf/python/r/neptune_subnet_group.html.markdown index 59f01fd13fe5..ad0644d0bcfb 100644 --- a/website/docs/cdktf/python/r/neptune_subnet_group.html.markdown +++ b/website/docs/cdktf/python/r/neptune_subnet_group.html.markdown @@ -39,6 +39,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Optional, Forces new resource) The name of the neptune subnet group. If omitted, Terraform will assign a random, unique name. * `name_prefix` - (Optional, Forces new resource) Creates a unique name beginning with the specified prefix. Conflicts with `name`. * `description` - (Optional) The description of the neptune subnet group. Defaults to "Managed by Terraform". @@ -78,4 +79,4 @@ Using `terraform import`, import Neptune Subnet groups using the `name`. For exa % terraform import aws_neptune_subnet_group.default production-subnet-group ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/neptunegraph_graph.html.markdown b/website/docs/cdktf/python/r/neptunegraph_graph.html.markdown index 7dd4e529b747..264197ac1506 100644 --- a/website/docs/cdktf/python/r/neptunegraph_graph.html.markdown +++ b/website/docs/cdktf/python/r/neptunegraph_graph.html.markdown @@ -10,7 +10,7 @@ description: |- # Resource: aws_neptunegraph_graph -The aws_neptunegraph_graph resource creates an Amazon Analytics Graph. +The `aws_neptunegraph_graph` resource creates an Amazon Analytics Graph. ## Example Usage @@ -56,19 +56,14 @@ The following arguments are required: The following arguments are optional: +- `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). - `deletion_protection` (Boolean, Default: `true`) Value that indicates whether the Graph has deletion protection enabled. The graph can't be deleted when deletion protection is enabled. - - `graph_name` (String, Forces new resource) Contains a user-supplied name for the Graph. If omitted, Terraform will assign a random, unique identifier. - - `public_connectivity` (Boolean, Default: `false`) Specifies whether the Graph can be reached over the internet. Access to all graphs requires IAM authentication. When the Graph is publicly reachable, its Domain Name System (DNS) endpoint resolves to the public IP address from the internet. When the Graph isn't publicly reachable, you need to create a PrivateGraphEndpoint in a given VPC to ensure the DNS name resolves to a private IP address that is reachable from the VPC. - - `replica_count` (Number, Default: `1`, Forces new resource) Specifies the number of replicas you want when finished. All replicas will be provisioned in different availability zones. Replica Count should always be less than or equal to 2. - - `kms_key_identifier` (String) The ARN for the KMS encryption key. By Default, Neptune Analytics will use an AWS provided key ("AWS_OWNED_KEY"). This parameter is used if you want to encrypt the graph using a KMS Customer Managed Key (CMK). - - `vector_search_configuration` (Block, Forces new resource) Vector Search Configuration (see below for nested schema of vector_search_configuration) - -- `tags` (Attributes Set) The tags associated with this graph. (see below for nested schema of tags) +- `tags` - (Optional) Key-value tags for the graph. 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. ## Attribute Reference @@ -77,6 +72,7 @@ This resource exports the following attributes in addition to the arguments abov - `endpoint` (String) The connection endpoint for the graph. For example: `g-12a3bcdef4.us-east-1.neptune-graph.amazonaws.com` - `arn` (String) Graph resource ARN - `id` (String) The auto-generated id assigned by the service. +- `tags_all` - A map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). ## Timeouts @@ -124,4 +120,4 @@ Using `terraform import`, import `aws_neptunegraph_graph` using the graph identi % terraform import aws_neptunegraph_graph.example "graph_id" ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/network_acl.html.markdown b/website/docs/cdktf/python/r/network_acl.html.markdown index f271200174a5..0e4ff591b159 100644 --- a/website/docs/cdktf/python/r/network_acl.html.markdown +++ b/website/docs/cdktf/python/r/network_acl.html.markdown @@ -67,6 +67,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `vpc_id` - (Required) The ID of the associated VPC. * `subnet_ids` - (Optional) A list of Subnet IDs to apply the ACL to * `ingress` - (Optional) Specifies an ingress rule. Parameters defined below. @@ -129,4 +130,4 @@ Using `terraform import`, import Network ACLs using the `id`. For example: % terraform import aws_network_acl.main acl-7aaabd18 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/network_acl_association.html.markdown b/website/docs/cdktf/python/r/network_acl_association.html.markdown index 6c2509fe5046..6a3d6ed6023a 100644 --- a/website/docs/cdktf/python/r/network_acl_association.html.markdown +++ b/website/docs/cdktf/python/r/network_acl_association.html.markdown @@ -40,6 +40,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `network_acl_id` - (Required) The ID of the network ACL. * `subnet_id` - (Required) The ID of the associated Subnet. @@ -74,4 +75,4 @@ Using `terraform import`, import Network ACL associations using the `id`. For ex % terraform import aws_network_acl_association.main aclassoc-02baf37f20966b3e6 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/network_acl_rule.html.markdown b/website/docs/cdktf/python/r/network_acl_rule.html.markdown index 502ef58d53f1..02ff73371b96 100644 --- a/website/docs/cdktf/python/r/network_acl_rule.html.markdown +++ b/website/docs/cdktf/python/r/network_acl_rule.html.markdown @@ -56,6 +56,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `network_acl_id` - (Required) The ID of the network ACL. * `rule_number` - (Required) The rule number for the entry (for example, 100). ACL entries are processed in ascending order by rule number. * `egress` - (Optional, bool) Indicates whether this is an egress rule (rule is applied to traffic leaving the subnet). Default `false`. @@ -134,4 +135,4 @@ Using the procotol's decimal value: % terraform import aws_network_acl_rule.my_rule acl-7aaabd18:100:6:false ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/network_interface.html.markdown b/website/docs/cdktf/python/r/network_interface.html.markdown index ff179583962e..634677475b53 100644 --- a/website/docs/cdktf/python/r/network_interface.html.markdown +++ b/website/docs/cdktf/python/r/network_interface.html.markdown @@ -63,6 +63,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `attachment` - (Optional) Configuration block to define the attachment of the ENI. See [Attachment](#attachment) below for more details! * `description` - (Optional) Description for the network interface. * `enable_primary_ipv6` - (Optional) Enables assigning a primary IPv6 Global Unicast Address (GUA) to the network interface (ENI) in dual-stack or IPv6-only subnets. This ensures the instance attached to the ENI retains a consistent IPv6 address. Once enabled, the first IPv6 GUA becomes the primary IPv6 address and cannot be disabled. The primary IPv6 address remains assigned until the instance is terminated or the ENI is detached. Enabling and subsequent disabling forces recreation of the ENI. @@ -89,6 +90,7 @@ The `attachment` block supports the following: * `instance` - (Required) ID of the instance to attach to. * `device_index` - (Required) Integer to define the devices index. +* `network_card_index` - (Optional) Index of the network card. Specify a value greater than 0 when using multiple network cards, which are supported by [some instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-eni.html#network-cards). The default is 0. ## Attribute Reference @@ -126,4 +128,4 @@ Using `terraform import`, import Network Interfaces using the `id`. For example: % terraform import aws_network_interface.test eni-e5aa89a3 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/network_interface_attachment.html.markdown b/website/docs/cdktf/python/r/network_interface_attachment.html.markdown index 31072f6de8fe..60b2870fe38d 100644 --- a/website/docs/cdktf/python/r/network_interface_attachment.html.markdown +++ b/website/docs/cdktf/python/r/network_interface_attachment.html.markdown @@ -37,9 +37,11 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `instance_id` - (Required) Instance ID to attach. * `network_interface_id` - (Required) ENI ID to attach. * `device_index` - (Required) Network interface index (int). +* `network_card_index` - (Optional) Index of the network card. Specify a value greater than 0 when using multiple network cards, which are supported by [some instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-eni.html#network-cards). The default is 0. ## Attribute Reference @@ -75,4 +77,4 @@ Using `terraform import`, import Elastic network interface (ENI) Attachments usi % terraform import aws_network_interface_attachment.secondary_nic eni-attach-0a33842b4ec347c4c ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/network_interface_permission.html.markdown b/website/docs/cdktf/python/r/network_interface_permission.html.markdown index b1dc7503ca39..d7a1c2a83674 100644 --- a/website/docs/cdktf/python/r/network_interface_permission.html.markdown +++ b/website/docs/cdktf/python/r/network_interface_permission.html.markdown @@ -48,8 +48,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `network_interface_id` - (Required) The ID of the network interface. * `aws_account_id` - (Required) The Amazon Web Services account ID. * `permission` - (Required) The type of permission to grant. Valid values are `INSTANCE-ATTACH` or `EIP-ASSOCIATE`. @@ -85,4 +86,4 @@ Using `terraform import`, import Network Interface Permissions using the `networ % terraform import aws_network_interface_permission.example eni-perm-056ad97ce2ac377ed ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/network_interface_sg_attachment.html.markdown b/website/docs/cdktf/python/r/network_interface_sg_attachment.html.markdown index db48f5f66830..8bc8aeb495f1 100644 --- a/website/docs/cdktf/python/r/network_interface_sg_attachment.html.markdown +++ b/website/docs/cdktf/python/r/network_interface_sg_attachment.html.markdown @@ -110,6 +110,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `security_group_id` - (Required) The ID of the security group. * `network_interface_id` - (Required) The ID of the network interface to attach to. @@ -150,4 +151,4 @@ Using `terraform import`, import Network Interface Security Group attachments us % terraform import aws_network_interface_sg_attachment.sg_attachment eni-1234567890abcdef0_sg-1234567890abcdef0 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/networkfirewall_firewall.html.markdown b/website/docs/cdktf/python/r/networkfirewall_firewall.html.markdown index 103ad7a18238..d89eb49ebc7c 100644 --- a/website/docs/cdktf/python/r/networkfirewall_firewall.html.markdown +++ b/website/docs/cdktf/python/r/networkfirewall_firewall.html.markdown @@ -48,10 +48,52 @@ class MyConvertedCode(TerraformStack): ) ``` +### Transit Gateway Attached Firewall + +```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.data_aws_availability_zones import DataAwsAvailabilityZones +from imports.aws.networkfirewall_firewall import NetworkfirewallFirewall +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + example = DataAwsAvailabilityZones(self, "example", + state="available" + ) + aws_networkfirewall_firewall_example = NetworkfirewallFirewall(self, "example_1", + availability_zone_mapping=[NetworkfirewallFirewallAvailabilityZoneMapping( + availability_zone_id=Token.as_string( + Fn.lookup_nested(example.zone_ids, ["0"])) + ), NetworkfirewallFirewallAvailabilityZoneMapping( + availability_zone_id=Token.as_string( + Fn.lookup_nested(example.zone_ids, ["1"])) + ) + ], + firewall_policy_arn=Token.as_string(aws_networkfirewall_firewall_policy_example.arn), + name="example", + transit_gateway_id=Token.as_string(aws_ec2_transit_gateway_example.id) + ) + # 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_networkfirewall_firewall_example.override_logical_id("example") +``` + +### Transit Gateway Attached Firewall (Cross Account) + +A full example of how to create a Transit Gateway in one AWS account, share it with a second AWS account, and create Network Firewall in the second account to the Transit Gateway via the `aws_networkfirewall_firewall` and [`aws_networkfirewall_network_firewall_transit_gateway_attachment_accepter`](/docs/providers/aws/r/networkfirewall_network_firewall_transit_gateway_attachment_accepter.html) resources can be found in [the `./examples/network-firewall-cross-account-transit-gateway` directory within the Github Repository](https://github.com/hashicorp/terraform-provider-aws/tree/main/examples/network-firewall-cross-account-transit-gateway) + ## Argument Reference This resource supports the following arguments: +* `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). +* `availability_zone_change_protection` - (Optional) A setting indicating whether the firewall is protected against changes to its Availability Zone configuration. When set to `true`, you must first disable this protection before adding or removing Availability Zones. +* `availability_zone_mapping` - (Optional) Required when creating a transit gateway-attached firewall. Set of configuration blocks describing the avaiability availability where you want to create firewall endpoints for a transit gateway-attached firewall. * `delete_protection` - (Optional) A flag indicating whether the firewall is protected against deletion. Use this setting to protect against accidentally deleting a firewall that is in use. Defaults to `false`. * `description` - (Optional) A friendly description of the firewall. * `enabled_analysis_types` - (Optional) Set of types for which to collect analysis metrics. See [Reporting on network traffic in Network Firewall](https://docs.aws.amazon.com/network-firewall/latest/developerguide/reporting.html) for details on how to use the data. Valid values: `TLS_SNI`, `HTTP_HOST`. Defaults to `[]`. @@ -60,9 +102,16 @@ This resource supports the following arguments: * `firewall_policy_change_protection` - (Optional) A flag indicating whether the firewall is protected against a change to the firewall policy association. Use this setting to protect against accidentally modifying the firewall policy for a firewall that is in use. Defaults to `false`. * `name` - (Required, Forces new resource) A friendly name of the firewall. * `subnet_change_protection` - (Optional) A flag indicating whether the firewall is protected against changes to the subnet associations. Use this setting to protect against accidentally modifying the subnet associations for a firewall that is in use. Defaults to `false`. -* `subnet_mapping` - (Required) Set of configuration blocks describing the public subnets. Each subnet must belong to a different Availability Zone in the VPC. AWS Network Firewall creates a firewall endpoint in each subnet. See [Subnet Mapping](#subnet-mapping) below for details. +* `subnet_mapping` - (Optional) Required when creating a VPC attached firewall. Set of configuration blocks describing the public subnets. Each subnet must belong to a different Availability Zone in the VPC. AWS Network Firewall creates a firewall endpoint in each subnet. See [Subnet Mapping](#subnet-mapping) below for details. * `tags` - (Optional) Map of resource tags to associate with 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. -* `vpc_id` - (Required, Forces new resource) The unique identifier of the VPC where AWS Network Firewall should create the firewall. +* `transit_gateway_id` - (Optional, Forces new resource). Required when creating a transit gateway-attached firewall. The unique identifier of the transit gateway to attach to this firewall. You can provide either a transit gateway from your account or one that has been shared with you through AWS Resource Access Manager +* `vpc_id` - (Optional, Forces new resource) Required when creating a VPC attached firewall. The unique identifier of the VPC where AWS Network Firewall should create the firewall. + +### Availability Zone Mapping + +The `availability_zone_mapping` block supports the following arguments: + +* `availability_zone_id` - (Required)The ID of the Availability Zone where the firewall endpoint is located.. ### Encryption Configuration @@ -90,16 +139,19 @@ This resource exports the following attributes in addition to the arguments abov * `endpoint_id` - The identifier of the firewall endpoint that AWS Network Firewall has instantiated in the subnet. You use this to identify the firewall endpoint in the VPC route tables, when you redirect the VPC traffic through the endpoint. * `subnet_id` - The unique identifier of the subnet that you've specified to be used for a firewall endpoint. * `availability_zone` - The Availability Zone where the subnet is configured. + * `transit_gateway_attachment_sync_states` - Set of transit gateway configured for use by the firewall. + * `attachment_id` - The unique identifier of the transit gateway attachment. * `tags_all` - A map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). +* `transit_gateway_owner_account_id` - The AWS account ID that owns the transit gateway. * `update_token` - A string token used when updating a firewall. ## Timeouts [Configuration options](https://developer.hashicorp.com/terraform/language/resources/syntax#operation-timeouts): -- `create` - (Default `30m`) -- `update` - (Default `30m`) -- `delete` - (Default `30m`) +- `create` - (Default `60m`) +- `update` - (Default `60m`) +- `delete` - (Default `60m`) ## Import @@ -126,4 +178,4 @@ Using `terraform import`, import Network Firewall Firewalls using their `arn`. F % terraform import aws_networkfirewall_firewall.example arn:aws:network-firewall:us-west-1:123456789012:firewall/example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/networkfirewall_firewall_policy.html.markdown b/website/docs/cdktf/python/r/networkfirewall_firewall_policy.html.markdown index 8cabf3c60649..dd39fc5542dd 100644 --- a/website/docs/cdktf/python/r/networkfirewall_firewall_policy.html.markdown +++ b/website/docs/cdktf/python/r/networkfirewall_firewall_policy.html.markdown @@ -22,10 +22,20 @@ 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.data_aws_caller_identity import DataAwsCallerIdentity +from imports.aws.data_aws_partition import DataAwsPartition +from imports.aws.data_aws_region import DataAwsRegion from imports.aws.networkfirewall_firewall_policy import NetworkfirewallFirewallPolicy class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) + current = DataAwsCallerIdentity(self, "current") + data_aws_partition_current = DataAwsPartition(self, "current_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_partition_current.override_logical_id("current") + data_aws_region_current = DataAwsRegion(self, "current_2") + # 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_region_current.override_logical_id("current") NetworkfirewallFirewallPolicy(self, "example", firewall_policy=NetworkfirewallFirewallPolicyFirewallPolicy( stateless_default_actions=["aws:pass"], @@ -35,7 +45,7 @@ class MyConvertedCode(TerraformStack): resource_arn=Token.as_string(aws_networkfirewall_rule_group_example.arn) ) ], - tls_inspection_configuration_arn="arn:aws:network-firewall:REGION:ACCT:tls-configuration/example" + tls_inspection_configuration_arn="arn:${" + data_aws_partition_current.partition + "}:network-firewall:${" + data_aws_region_current.region + "}:${" + current.account_id + "}:tls-configuration/example" ), name="example", tags={ @@ -100,7 +110,7 @@ from imports.aws.networkfirewall_firewall_policy import NetworkfirewallFirewallP class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) - NetworkfirewallFirewallPolicy(self, "test", + NetworkfirewallFirewallPolicy(self, "example", firewall_policy=NetworkfirewallFirewallPolicyFirewallPolicy( stateless_custom_action=[NetworkfirewallFirewallPolicyFirewallPolicyStatelessCustomAction( action_definition=NetworkfirewallFirewallPolicyFirewallPolicyStatelessCustomActionActionDefinition( @@ -121,18 +131,87 @@ class MyConvertedCode(TerraformStack): ) ``` +## Policy with Active Threat Defense in Action Order + +```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.data_aws_partition import DataAwsPartition +from imports.aws.data_aws_region import DataAwsRegion +from imports.aws.networkfirewall_firewall_policy import NetworkfirewallFirewallPolicy +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + current = DataAwsPartition(self, "current") + data_aws_region_current = DataAwsRegion(self, "current_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_region_current.override_logical_id("current") + NetworkfirewallFirewallPolicy(self, "example", + firewall_policy=NetworkfirewallFirewallPolicyFirewallPolicy( + stateful_rule_group_reference=[NetworkfirewallFirewallPolicyFirewallPolicyStatefulRuleGroupReference( + deep_threat_inspection=Token.as_string(True), + resource_arn="arn:${" + current.partition + "}:network-firewall:${" + data_aws_region_current.region + "}:aws-managed:stateful-rulegroup/AttackInfrastructureActionOrder" + ) + ], + stateless_default_actions=["aws:pass"], + stateless_fragment_default_actions=["aws:drop"] + ), + name="example" + ) +``` + +## Policy with Active Threat Defense in Strict Order + +```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.data_aws_partition import DataAwsPartition +from imports.aws.data_aws_region import DataAwsRegion +from imports.aws.networkfirewall_firewall_policy import NetworkfirewallFirewallPolicy +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + current = DataAwsPartition(self, "current") + data_aws_region_current = DataAwsRegion(self, "current_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_region_current.override_logical_id("current") + NetworkfirewallFirewallPolicy(self, "example", + firewall_policy=NetworkfirewallFirewallPolicyFirewallPolicy( + stateful_engine_options=NetworkfirewallFirewallPolicyFirewallPolicyStatefulEngineOptions( + rule_order="STRICT_ORDER" + ), + stateful_rule_group_reference=[NetworkfirewallFirewallPolicyFirewallPolicyStatefulRuleGroupReference( + deep_threat_inspection=Token.as_string(False), + priority=1, + resource_arn="arn:${" + current.partition + "}:network-firewall:${" + data_aws_region_current.region + "}:aws-managed:stateful-rulegroup/AttackInfrastructureStrictOrder" + ) + ], + stateless_default_actions=["aws:pass"], + stateless_fragment_default_actions=["aws:drop"] + ), + name="example" + ) +``` + ## Argument Reference This resource supports the following arguments: +* `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). * `description` - (Optional) A friendly description of the firewall policy. - * `encryption_configuration` - (Optional) KMS encryption configuration settings. See [Encryption Configuration](#encryption-configuration) below for details. - * `firewall_policy` - (Required) A configuration block describing the rule groups and policy actions to use in the firewall policy. See [Firewall Policy](#firewall-policy) below for details. - * `name` - (Required, Forces new resource) A friendly name of the firewall policy. - * `tags` - (Optional) Map of resource tags to associate with 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. ### Encryption Configuration @@ -202,6 +281,9 @@ The `flow_timeouts` block supports the following argument: The `stateful_rule_group_reference` block supports the following arguments: +* `deep_threat_inspection` - (Optional) Whether to enable deep threat inspection, which allows AWS to analyze service logs of network traffic processed by these rule groups to identify threat indicators across customers. AWS will use these threat indicators to improve the active threat defense managed rule groups and protect the security of AWS customers and services. This only applies to active threat defense maanaged rule groups. + + For details, refer to [AWS active threat defense for AWS Network Firewall](https://docs.aws.amazon.com/network-firewall/latest/developerguide/aws-managed-rule-groups-atd.html) in the AWS Network Firewall Developer Guide. * `priority` - (Optional) An integer setting that indicates the order in which to apply the stateful rule groups in a single policy. This argument must be specified if the policy has a `stateful_engine_options` block with a `rule_order` value of `STRICT_ORDER`. AWS Network Firewall applies each stateful rule group to a packet starting with the group that has the lowest priority setting. * `resource_arn` - (Required) The Amazon Resource Name (ARN) of the stateful rule group. @@ -283,4 +365,4 @@ Using `terraform import`, import Network Firewall Policies using their `arn`. Fo % terraform import aws_networkfirewall_firewall_policy.example arn:aws:network-firewall:us-west-1:123456789012:firewall-policy/example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/networkfirewall_firewall_transit_gateway_attachment_accepter.html.markdown b/website/docs/cdktf/python/r/networkfirewall_firewall_transit_gateway_attachment_accepter.html.markdown new file mode 100644 index 000000000000..255ad28791a4 --- /dev/null +++ b/website/docs/cdktf/python/r/networkfirewall_firewall_transit_gateway_attachment_accepter.html.markdown @@ -0,0 +1,88 @@ +--- +subcategory: "Network Firewall" +layout: "aws" +page_title: "AWS: aws_networkfirewall_firewall_transit_gateway_attachment_accepter" +description: |- + Manages an AWS Network Firewall Firewall Transit Gateway Attachment Accepter. +--- + + + +# Resource: aws_networkfirewall_firewall_transit_gateway_attachment_accepter + +Manages an AWS Network Firewall Firewall Transit Gateway Attachment Accepter. + +When a cross-account (requester's AWS account differs from the accepter's AWS account) requester creates a Network Firewall with Transit Gateway ID using `aws_networkfirewall_firewall`. Then an EC2 Transit Gateway VPC Attachment resource is automatically created in the accepter's account. +The accepter can use the `aws_networkfirewall_firewall_transit_gateway_attachment_accepter` resource to "adopt" its side of the connection into management. + +~> **NOTE:** If the `transit_gateway_id` argument in the `aws_networkfirewall_firewall` resource is used to attach a firewall to a transit gateway in a cross-account setup (where **Auto accept shared attachments** is disabled), the resource will be considered created when the transit gateway attachment is in the *Pending Acceptance* state and the firewall is in the *Provisioning* status. At this point, you can use the `aws_networkfirewall_firewall_transit_gateway_attachment_accepter` resource to finalize the network firewall deployment. Once the transit gateway attachment reaches the *Available* state, the firewall status *Ready*. + +## 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.networkfirewall_firewall_transit_gateway_attachment_accepter import NetworkfirewallFirewallTransitGatewayAttachmentAccepter +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + NetworkfirewallFirewallTransitGatewayAttachmentAccepter(self, "example", + transit_gateway_attachment_id=Token.as_string( + Fn.lookup_nested(aws_networkfirewall_firewall_example.firewall_status, ["0", "transit_gateway_attachment_sync_state", "0", "attachment_id" + ])) + ) +``` + +A full example of how to create a Transit Gateway in one AWS account, share it with a second AWS account, and create Network Firewall in the second account to the Transit Gateway via the `aws_networkfirewall_firewall` and `aws_networkfirewall_firewall_transit_gateway_attachment_accepter` resources can be found in [the `./examples/network-firewall-cross-account-transit-gateway` directory within the Github Repository](https://github.com/hashicorp/terraform-provider-aws/tree/main/examples/network-firewall-cross-account-transit-gateway) + +## Argument Reference + +This resource supports the following arguments: + +* `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). +* `transit_gateway_attachment_id` - (Required) The unique identifier of the transit gateway attachment to accept. This ID is returned in the response when creating a transit gateway-attached firewall. + +## Attribute Reference + +This resource exports no additional attributes. + +## Timeouts + +[Configuration options](https://developer.hashicorp.com/terraform/language/resources/syntax#operation-timeouts): + +* `create` - (Default `60m`) +* `delete` - (Default `60m`) + +## Import + +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import Network Firewall Firewall Transit Gateway Attachment Accepter using the `transit_gateway_attachment_id`. 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.networkfirewall_firewall_transit_gateway_attachment_accepter import NetworkfirewallFirewallTransitGatewayAttachmentAccepter +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + NetworkfirewallFirewallTransitGatewayAttachmentAccepter.generate_config_for_import(self, "example", "tgw-attach-0c3b7e9570eee089c") +``` + +Using `terraform import`, import Network Firewall Firewall Transit Gateway Attachment Accepter using the `transit_gateway_attachment_id`. For example: + +```console +% terraform import aws_networkfirewall_firewall_transit_gateway_attachment_accepter.example tgw-attach-0c3b7e9570eee089c +``` + + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/networkfirewall_logging_configuration.html.markdown b/website/docs/cdktf/python/r/networkfirewall_logging_configuration.html.markdown index dca822729081..6576c3c43fff 100644 --- a/website/docs/cdktf/python/r/networkfirewall_logging_configuration.html.markdown +++ b/website/docs/cdktf/python/r/networkfirewall_logging_configuration.html.markdown @@ -106,8 +106,8 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `firewall_arn` - (Required, Forces new resource) The Amazon Resource Name (ARN) of the Network Firewall firewall. - * `logging_configuration` - (Required) A configuration block describing how AWS Network Firewall performs logging for a firewall. See [Logging Configuration](#logging-configuration) below for details. ### Logging Configuration @@ -160,4 +160,4 @@ Using `terraform import`, import Network Firewall Logging Configurations using t % terraform import aws_networkfirewall_logging_configuration.example arn:aws:network-firewall:us-west-1:123456789012:firewall/example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/networkfirewall_resource_policy.html.markdown b/website/docs/cdktf/python/r/networkfirewall_resource_policy.html.markdown index 6e44105ce45c..abae219039f6 100644 --- a/website/docs/cdktf/python/r/networkfirewall_resource_policy.html.markdown +++ b/website/docs/cdktf/python/r/networkfirewall_resource_policy.html.markdown @@ -84,8 +84,8 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `policy` - (Required) JSON formatted policy document that controls access to the Network Firewall resource. The policy must be provided **without whitespaces**. We recommend using [jsonencode](https://www.terraform.io/docs/configuration/functions/jsonencode.html) for formatting as seen in the examples above. For more details, including available policy statement Actions, see the [Policy](https://docs.aws.amazon.com/network-firewall/latest/APIReference/API_PutResourcePolicy.html#API_PutResourcePolicy_RequestSyntax) parameter in the AWS API documentation. - * `resource_arn` - (Required, Forces new resource) The Amazon Resource Name (ARN) of the rule group or firewall policy. ## Attribute Reference @@ -119,4 +119,4 @@ Using `terraform import`, import Network Firewall Resource Policies using the `r % terraform import aws_networkfirewall_resource_policy.example aws_networkfirewall_rule_group.example arn:aws:network-firewall:us-west-1:123456789012:stateful-rulegroup/example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/networkfirewall_rule_group.html.markdown b/website/docs/cdktf/python/r/networkfirewall_rule_group.html.markdown index aa026c1ea0b4..b052c450a7b7 100644 --- a/website/docs/cdktf/python/r/networkfirewall_rule_group.html.markdown +++ b/website/docs/cdktf/python/r/networkfirewall_rule_group.html.markdown @@ -399,20 +399,14 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `capacity` - (Required, Forces new resource) The maximum number of operating resources that this rule group can use. For a stateless rule group, the capacity required is the sum of the capacity requirements of the individual rules. For a stateful rule group, the minimum capacity required is the number of individual rules. - * `description` - (Optional) A friendly description of the rule group. - * `encryption_configuration` - (Optional) KMS encryption configuration settings. See [Encryption Configuration](#encryption-configuration) below for details. - * `name` - (Required, Forces new resource) A friendly name of the rule group. - * `rule_group` - (Optional) A configuration block that defines the rule group rules. Required unless `rules` is specified. See [Rule Group](#rule-group) below for details. - * `rules` - (Optional) The stateful rule group rules specifications in Suricata file format, with one rule per line. Use this to import your existing Suricata compatible rule groups. Required unless `rule_group` is specified. - * `tags` - (Optional) A map of key:value pairs to associate with 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. - * `type` - (Required) Whether the rule group is stateless (containing stateless rules) or stateful (containing stateful rules). Valid values include: `STATEFUL` or `STATELESS`. ### Encryption Configuration @@ -691,4 +685,4 @@ Using `terraform import`, import Network Firewall Rule Groups using their `arn`. % terraform import aws_networkfirewall_rule_group.example arn:aws:network-firewall:us-west-1:123456789012:stateful-rulegroup/example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/networkfirewall_tls_inspection_configuration.html.markdown b/website/docs/cdktf/python/r/networkfirewall_tls_inspection_configuration.html.markdown index 3918975efbe8..5288bba05535 100644 --- a/website/docs/cdktf/python/r/networkfirewall_tls_inspection_configuration.html.markdown +++ b/website/docs/cdktf/python/r/networkfirewall_tls_inspection_configuration.html.markdown @@ -336,6 +336,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `description` - (Optional) Description of the TLS inspection configuration. * `encryption_configuration` - (Optional) Encryption configuration block. Detailed below. @@ -470,4 +471,4 @@ Using `terraform import`, import Network Firewall TLS Inspection Configuration u % terraform import aws_networkfirewall_tls_inspection_configuration.example arn:aws:network-firewall::::tls-configuration/example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/networkfirewall_vpc_endpoint_association.html.markdown b/website/docs/cdktf/python/r/networkfirewall_vpc_endpoint_association.html.markdown new file mode 100644 index 000000000000..e8b928fe5482 --- /dev/null +++ b/website/docs/cdktf/python/r/networkfirewall_vpc_endpoint_association.html.markdown @@ -0,0 +1,112 @@ +--- +subcategory: "Network Firewall" +layout: "aws" +page_title: "AWS: aws_networkfirewall_vpc_endpoint_association" +description: |- + Manages a firewall endpoint for an AWS Network Firewall firewall. +--- + + + +# Resource: aws_networkfirewall_vpc_endpoint_association + +Manages a firewall endpoint for an AWS Network Firewall firewall. + +Use `aws_networkfirewall_vpc_endpoint_association` to establish new firewall endpoints in any Availability Zone where the firewall is already being used. The first use of a firewall in an Availability Zone must be defined by `aws_networkfirewall_firewall` resource and `subnet_mapping` argument. + +## 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.networkfirewall_vpc_endpoint_association import NetworkfirewallVpcEndpointAssociation +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + NetworkfirewallVpcEndpointAssociation(self, "example", + firewall_arn=Token.as_string(aws_networkfirewall_firewall_example.arn), + subnet_mapping=[NetworkfirewallVpcEndpointAssociationSubnetMapping( + subnet_id=Token.as_string(aws_subnet_example.id) + ), NetworkfirewallVpcEndpointAssociationSubnetMapping( + subnet_id=example_two.id + ) + ], + tags={ + "Name": "example endpoint" + }, + vpc_id=Token.as_string(aws_vpc_example.id) + ) +``` + +## Argument Reference + +This resource supports the following arguments: + +* `description` (Optional) - A description of the VPC endpoint association. +* `firewall_arn` (Required) - The Amazon Resource Name (ARN) that identifies the firewall. +* `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). +* `subnet_mapping` (Required) - The ID for a subnet that's used in an association with a firewall. See [Subnet Mapping](#subnet-mapping) below for details. +* `tags` - (Optional) Map of resource tags to associate with 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. +* `vpc_id` (Required) - The unique identifier of the VPC for the endpoint association. + +### Subnet Mapping + +The `subnet_mapping` block supports the following arguments: + +* `ip_address_type` - (Optional) The subnet's IP address type. Valid values: `"DUALSTACK"`, `"IPV4"`. +* `subnet_id` - (Required) The unique identifier for the subnet. + +## Attribute Reference + +This resource exports the following attributes in addition to the arguments above: + +* `tags_all` - A map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). +* `vpc_endpoint_association_arn` - ARN of the VPC Endpoint Association. +* `vpc_endpoint_association_id` - The unique identifier of the VPC endpoint association. +* `vpc_endpoint_association_status` - Nested list of information about the current status of the VPC Endpoint Association. + * `association_sync_states` - Set of subnets configured for use by the VPC Endpoint Association. + * `attachment` - Nested list describing the attachment status of the firewall's VPC Endpoint Association with a single VPC subnet. + * `endpoint_id` - The identifier of the VPC endpoint that AWS Network Firewall has instantiated in the subnet. You use this to identify the firewall endpoint in the VPC route tables, when you redirect the VPC traffic through the endpoint. + * `subnet_id` - The unique identifier of the subnet that you've specified to be used for a VPC Endpoint Association endpoint. + * `availability_zone` - The Availability Zone where the subnet is configured. + +## Timeouts + +[Configuration options](https://developer.hashicorp.com/terraform/language/resources/syntax#operation-timeouts): + +* `create` - (Default `30m`) +* `delete` - (Default `30m`) + +## Import + +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import Network Firewall VPC Endpoint Association using the `vpc_endpoint_association_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.networkfirewall_vpc_endpoint_association import NetworkfirewallVpcEndpointAssociation +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + NetworkfirewallVpcEndpointAssociation.generate_config_for_import(self, "example", "arn:aws:network-firewall:us-west-1:123456789012:vpc-endpoint-association/example") +``` + +Using `terraform import`, import Network Firewall VPC Endpoint Association using the `vpc_endpoint_association_arn`. For example: + +```console +% terraform import aws_networkfirewall_vpc_endpoint_association.example arn:aws:network-firewall:us-west-1:123456789012:vpc-endpoint-association/example +``` + + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/networkmanager_attachment_accepter.html.markdown b/website/docs/cdktf/python/r/networkmanager_attachment_accepter.html.markdown index 4a5cc7a808f9..dcce762e060c 100644 --- a/website/docs/cdktf/python/r/networkmanager_attachment_accepter.html.markdown +++ b/website/docs/cdktf/python/r/networkmanager_attachment_accepter.html.markdown @@ -3,23 +3,65 @@ subcategory: "Network Manager" layout: "aws" page_title: "AWS: aws_networkmanager_attachment_accepter" description: |- - Terraform resource for managing an AWS Network Manager Attachment Accepter. + Manages an AWS Network Manager Attachment Accepter. --- # Resource: aws_networkmanager_attachment_accepter -Terraform resource for managing an AWS Network Manager Attachment Accepter. +Manages an AWS Network Manager Attachment Accepter. + +Use this resource to accept cross-account attachments in AWS Network Manager. When an attachment is created in one account and needs to be accepted by another account that owns the core network, this resource handles the acceptance process. ## Example Usage -### Example with VPC attachment +### VPC Attachment + +```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.networkmanager_attachment_accepter import NetworkmanagerAttachmentAccepter +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + NetworkmanagerAttachmentAccepter(self, "example", + attachment_id=Token.as_string(aws_networkmanager_vpc_attachment_example.id), + attachment_type=Token.as_string(aws_networkmanager_vpc_attachment_example.attachment_type) + ) +``` + +### Site-to-Site VPN Attachment + +```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.networkmanager_attachment_accepter import NetworkmanagerAttachmentAccepter +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + NetworkmanagerAttachmentAccepter(self, "example", + attachment_id=Token.as_string(aws_networkmanager_site_to_site_vpn_attachment_example.id), + attachment_type=Token.as_string(aws_networkmanager_site_to_site_vpn_attachment_example.attachment_type) + ) +``` + +### Connect Attachment ```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 +from cdktf import Token, TerraformStack # # Provider bindings are generated by running `cdktf get`. # See https://cdk.tf/provider-generation for more details. @@ -28,18 +70,18 @@ from imports.aws.networkmanager_attachment_accepter import NetworkmanagerAttachm class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) - NetworkmanagerAttachmentAccepter(self, "test", - attachment_id=vpc.id, - attachment_type=vpc.attachment_type + NetworkmanagerAttachmentAccepter(self, "example", + attachment_id=Token.as_string(aws_networkmanager_connect_attachment_example.id), + attachment_type=Token.as_string(aws_networkmanager_connect_attachment_example.attachment_type) ) ``` -### Example with site-to-site VPN attachment +### Transit Gateway Route Table Attachment ```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 +from cdktf import Token, TerraformStack # # Provider bindings are generated by running `cdktf get`. # See https://cdk.tf/provider-generation for more details. @@ -48,9 +90,29 @@ from imports.aws.networkmanager_attachment_accepter import NetworkmanagerAttachm class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) - NetworkmanagerAttachmentAccepter(self, "test", - attachment_id=vpn.id, - attachment_type=vpn.attachment_type + NetworkmanagerAttachmentAccepter(self, "example", + attachment_id=Token.as_string(aws_networkmanager_transit_gateway_route_table_attachment_example.id), + attachment_type=Token.as_string(aws_networkmanager_transit_gateway_route_table_attachment_example.attachment_type) + ) +``` + +### Direct Connect Gateway Attachment + +```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.networkmanager_attachment_accepter import NetworkmanagerAttachmentAccepter +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + NetworkmanagerAttachmentAccepter(self, "example", + attachment_id=Token.as_string(aws_networkmanager_dx_gateway_attachment_example.id), + attachment_type=Token.as_string(aws_networkmanager_dx_gateway_attachment_example.attachment_type) ) ``` @@ -58,21 +120,27 @@ class MyConvertedCode(TerraformStack): The following arguments are required: -- `attachment_id` - (Required) The ID of the attachment. -- `attachment_type` - (Required) The type of attachment. Valid values can be found in the [AWS Documentation](https://docs.aws.amazon.com/networkmanager/latest/APIReference/API_ListAttachments.html#API_ListAttachments_RequestSyntax) +* `attachment_id` - (Required) ID of the attachment. +* `attachment_type` - (Required) Type of attachment. Valid values: `CONNECT`, `DIRECT_CONNECT_GATEWAY`, `SITE_TO_SITE_VPN`, `TRANSIT_GATEWAY_ROUTE_TABLE`, `VPC`. ## Attribute Reference This resource exports the following attributes in addition to the arguments above: -- `attachment_policy_rule_number` - The policy rule number associated with the attachment. -- `core_network_arn` - The ARN of a core network. -- `core_network_id` - The id of a core network. -- `edge_location` - The Region where the edge is located. This is returned for all attachment types except a Direct Connect gateway attachment, which instead returns `edge_locations`. -- `edge_locations` - The edge locations that the Direct Connect gateway is associated with. This is returned only for Direct Connect gateway attachments. All other attachment types return `edge_location` -- `owner_account_id` - The ID of the attachment account owner. -- `resource_arn` - The attachment resource ARN. -- `segment_name` - The name of the segment attachment. -- `state` - The state of the attachment. - - \ No newline at end of file +* `attachment_policy_rule_number` - Policy rule number associated with the attachment. +* `core_network_arn` - ARN of the core network. +* `core_network_id` - ID of the core network. +* `edge_location` - Region where the edge is located. This is returned for all attachment types except Direct Connect gateway attachments, which instead return `edge_locations`. +* `edge_locations` - Edge locations that the Direct Connect gateway is associated with. This is returned only for Direct Connect gateway attachments. All other attachment types return `edge_location`. +* `owner_account_id` - ID of the attachment account owner. +* `resource_arn` - Attachment resource ARN. +* `segment_name` - Name of the segment attachment. +* `state` - State of the attachment. + +## Timeouts + +[Configuration options](https://developer.hashicorp.com/terraform/language/resources/syntax#operation-timeouts): + +* `create` - (Default `15m`) + + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/networkmanager_connect_attachment.html.markdown b/website/docs/cdktf/python/r/networkmanager_connect_attachment.html.markdown index 7887602fbad2..2ea6879c0fab 100644 --- a/website/docs/cdktf/python/r/networkmanager_connect_attachment.html.markdown +++ b/website/docs/cdktf/python/r/networkmanager_connect_attachment.html.markdown @@ -3,14 +3,16 @@ subcategory: "Network Manager" layout: "aws" page_title: "AWS: aws_networkmanager_connect_attachment" description: |- - Terraform resource for managing an AWS Network Manager ConnectAttachment. + Manages an AWS Network Manager Connect Attachment. --- # Resource: aws_networkmanager_connect_attachment -Terraform resource for managing an AWS Network Manager ConnectAttachment. +Manages an AWS Network Manager Connect Attachment. + +Use this resource to create a Connect attachment in AWS Network Manager. Connect attachments enable you to connect your on-premises networks to your core network through a VPC or Transit Gateway attachment. ## Example Usage @@ -78,7 +80,7 @@ class MyConvertedCode(TerraformStack): aws_networkmanager_connect_attachment_example = NetworkmanagerConnectAttachment(self, "example_2", core_network_id=Token.as_string(awscc_networkmanager_core_network_example.id), - depends_on=["aws_networkmanager_attachment_accepter.test"], + depends_on=[aws_networkmanager_attachment_accepter_example], edge_location=example.edge_location, options=NetworkmanagerConnectAttachmentOptions( protocol="GRE" @@ -97,35 +99,40 @@ class MyConvertedCode(TerraformStack): The following arguments are required: -- `core_network_id` - (Required) The ID of a core network where you want to create the attachment. -- `transport_attachment_id` - (Required) The ID of the attachment between the two connections. -- `edge_location` - (Required) The Region where the edge is located. -- `options` - (Required) Options block. See [options](#options) for more information. +* `core_network_id` - (Required) ID of a core network where you want to create the attachment. +* `edge_location` - (Required) Region where the edge is located. +* `options` - (Required) Options block. See [options](#options) for more information. +* `transport_attachment_id` - (Required) ID of the attachment between the two connections. The following arguments are optional: -- `tags` - (Optional) Key-value tags for the attachment. 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. +* `tags` - (Optional) Key-value tags for the attachment. 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. ### options -* `protocol` - (Required) The protocol used for the attachment connection. Possible values are `GRE` and `NO_ENCAP`. +* `protocol` - (Optional) Protocol used for the attachment connection. Valid values: `GRE`, `NO_ENCAP`. ## Attribute Reference This resource exports the following attributes in addition to the arguments above: -- `arn` - The ARN of the attachment. -- `attachment_policy_rule_number` - The policy rule number associated with the attachment. -- `attachment_type` - The type of attachment. -- `core_network_arn` - The ARN of a core network. -- `core_network_id` - The ID of a core network -- `edge_location` - The Region where the edge is located. -- `id` - The ID of the attachment. -- `owner_account_id` - The ID of the attachment account owner. -- `resource_arn` - The attachment resource ARN. -- `segment_name` - The name of the segment attachment. -- `state` - The state of the attachment. -- `tags_all` - A map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). +* `arn` - ARN of the attachment. +* `attachment_id` - ID of the attachment. +* `attachment_policy_rule_number` - Policy rule number associated with the attachment. +* `attachment_type` - Type of attachment. +* `core_network_arn` - ARN of a core network. +* `owner_account_id` - ID of the attachment account owner. +* `resource_arn` - Attachment resource ARN. +* `segment_name` - Name of the segment attachment. +* `state` - State of the attachment. +* `tags_all` - Map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). + +## Timeouts + +[Configuration options](https://developer.hashicorp.com/terraform/language/resources/syntax#operation-timeouts): + +* `create` - (Default `10m`) +* `delete` - (Default `10m`) ## Import @@ -152,4 +159,4 @@ Using `terraform import`, import `aws_networkmanager_connect_attachment` using t % terraform import aws_networkmanager_connect_attachment.example attachment-0f8fa60d2238d1bd8 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/networkmanager_connect_peer.html.markdown b/website/docs/cdktf/python/r/networkmanager_connect_peer.html.markdown index 922408acdc98..4afd42327941 100644 --- a/website/docs/cdktf/python/r/networkmanager_connect_peer.html.markdown +++ b/website/docs/cdktf/python/r/networkmanager_connect_peer.html.markdown @@ -3,14 +3,16 @@ subcategory: "Network Manager" layout: "aws" page_title: "AWS: aws_networkmanager_connect_peer" description: |- - Terraform resource for managing an AWS Network Manager Connect Peer. + Manages an AWS Network Manager Connect Peer. --- # Resource: aws_networkmanager_connect_peer -Terraform resource for managing an AWS Network Manager Connect Peer. +Manages an AWS Network Manager Connect Peer. + +Use this resource to create a Connect peer in AWS Network Manager. Connect peers establish BGP sessions with your on-premises networks through Connect attachments, enabling dynamic routing between your core network and external networks. ## Example Usage @@ -90,7 +92,7 @@ class MyConvertedCode(TerraformStack): aws_networkmanager_connect_attachment_example = NetworkmanagerConnectAttachment(self, "example_2", core_network_id=Token.as_string(awscc_networkmanager_core_network_example.id), - depends_on=["aws_networkmanager_attachment_accepter.test"], + depends_on=[aws_networkmanager_attachment_accepter_example], edge_location=example.edge_location, options=NetworkmanagerConnectAttachmentOptions( protocol="GRE" @@ -99,21 +101,21 @@ class MyConvertedCode(TerraformStack): ) # 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_networkmanager_connect_attachment_example.override_logical_id("example") - aws_networkmanager_connect_peer_example = NetworkmanagerConnectPeer(self, "example_3", + example2 = NetworkmanagerAttachmentAccepter(self, "example2", + attachment_id=Token.as_string(aws_networkmanager_connect_attachment_example.id), + attachment_type=Token.as_string(aws_networkmanager_connect_attachment_example.attachment_type) + ) + aws_networkmanager_connect_peer_example = NetworkmanagerConnectPeer(self, "example_4", bgp_options=NetworkmanagerConnectPeerBgpOptions( peer_asn=65500 ), connect_attachment_id=Token.as_string(aws_networkmanager_connect_attachment_example.id), - depends_on=["aws_networkmanager_attachment_accepter.example2"], + depends_on=[example2], inside_cidr_blocks=["172.16.0.0/16"], peer_address="127.0.0.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. aws_networkmanager_connect_peer_example.override_logical_id("example") - NetworkmanagerAttachmentAccepter(self, "example2", - attachment_id=Token.as_string(aws_networkmanager_connect_attachment_example.id), - attachment_type=Token.as_string(aws_networkmanager_connect_attachment_example.attachment_type) - ) ``` ### Usage with a Tunnel-less Connect attachment @@ -154,7 +156,7 @@ class MyConvertedCode(TerraformStack): ), connect_attachment_id=Token.as_string(aws_networkmanager_connect_attachment_example.id), peer_address="127.0.0.1", - subnet_arn=test2.arn + subnet_arn=example2.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_networkmanager_connect_peer_example.override_logical_id("example") @@ -164,28 +166,40 @@ class MyConvertedCode(TerraformStack): The following arguments are required: -- `connect_attachment_id` - (Required) The ID of the connection attachment. -- `peer_address` - (Required) The Connect peer address. +* `connect_attachment_id` - (Required) ID of the connection attachment. +* `peer_address` - (Required) Connect peer address. The following arguments are optional: -- `bgp_options` (Optional) The Connect peer BGP options. -- `core_network_address` (Optional) A Connect peer core network address. -- `inside_cidr_blocks` - (Optional) The inside IP addresses used for BGP peering. Required when the Connect attachment protocol is `GRE`. See [`aws_networkmanager_connect_attachment`](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/networkmanager_connect_attachment) for details. -- `subnet_arn` - (Optional) The subnet ARN for the Connect peer. Required when the Connect attachment protocol is `NO_ENCAP`. See [`aws_networkmanager_connect_attachment`](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/networkmanager_connect_attachment) for details. -- `tags` - (Optional) Key-value tags for the attachment. 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. +* `bgp_options` - (Optional) Connect peer BGP options. See [bgp_options](#bgp_options) for more information. +* `core_network_address` - (Optional) Connect peer core network address. +* `inside_cidr_blocks` - (Optional) Inside IP addresses used for BGP peering. Required when the Connect attachment protocol is `GRE`. See [`aws_networkmanager_connect_attachment`](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/networkmanager_connect_attachment) for details. +* `subnet_arn` - (Optional) Subnet ARN for the Connect peer. Required when the Connect attachment protocol is `NO_ENCAP`. See [`aws_networkmanager_connect_attachment`](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/networkmanager_connect_attachment) for details. +* `tags` - (Optional) Key-value tags for the attachment. 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. + +### bgp_options + +* `peer_asn` - (Optional) Peer ASN. ## Attribute Reference This resource exports the following attributes in addition to the arguments above: -- `arn` - The ARN of the attachment. -- `configuration` - The configuration of the Connect peer. -- `core_network_id` - The ID of a core network. -- `edge_location` - The Region where the peer is located. -- `id` - The ID of the Connect peer. -- `state` - The state of the Connect peer. -- `tags_all` - A map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). +* `arn` - ARN of the Connect peer. +* `configuration` - Configuration of the Connect peer. +* `connect_peer_id` - ID of the Connect peer. +* `core_network_id` - ID of a core network. +* `created_at` - Timestamp when the Connect peer was created. +* `edge_location` - Region where the peer is located. +* `state` - State of the Connect peer. +* `tags_all` - Map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). + +## Timeouts + +[Configuration options](https://developer.hashicorp.com/terraform/language/resources/syntax#operation-timeouts): + +* `create` - (Default `10m`) +* `delete` - (Default `15m`) ## Import @@ -212,4 +226,4 @@ Using `terraform import`, import `aws_networkmanager_connect_peer` using the con % terraform import aws_networkmanager_connect_peer.example connect-peer-061f3e96275db1acc ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/networkmanager_connection.html.markdown b/website/docs/cdktf/python/r/networkmanager_connection.html.markdown index 87d38d6390c6..78664516abcc 100644 --- a/website/docs/cdktf/python/r/networkmanager_connection.html.markdown +++ b/website/docs/cdktf/python/r/networkmanager_connection.html.markdown @@ -3,15 +3,16 @@ subcategory: "Network Manager" layout: "aws" page_title: "AWS: aws_networkmanager_connection" description: |- - Creates a connection between two devices. + Manages a Network Manager Connection. --- # Resource: aws_networkmanager_connection -Creates a connection between two devices. -The devices can be a physical or virtual appliance that connects to a third-party appliance in a VPC, or a physical appliance that connects to another physical appliance in an on-premises network. +Manages a Network Manager Connection. + +Use this resource to create a connection between two devices in your global network. ## Example Usage @@ -36,22 +37,33 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -This resource supports the following arguments: +The following arguments are required: + +* `connected_device_id` - (Required) ID of the second device in the connection. +* `device_id` - (Required) ID of the first device in the connection. +* `global_network_id` - (Required) ID of the global network. + +The following arguments are optional: -* `connected_device_id` - (Required) The ID of the second device in the connection. -* `connected_link_id` - (Optional) The ID of the link for the second device. -* `description` - (Optional) A description of the connection. -* `device_id` - (Required) The ID of the first device in the connection. -* `global_network_id` - (Required) The ID of the global network. -* `link_id` - (Optional) The ID of the link for the first device. +* `connected_link_id` - (Optional) ID of the link for the second device. +* `description` - (Optional) Description of the connection. +* `link_id` - (Optional) ID of the link for the first device. * `tags` - (Optional) Key-value tags for the connection. 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. ## Attribute Reference This resource exports the following attributes in addition to the arguments above: -* `arn` - The Amazon Resource Name (ARN) of the connection. -* `tags_all` - A map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). +* `arn` - ARN of the connection. +* `tags_all` - Map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). + +## Timeouts + +[Configuration options](https://developer.hashicorp.com/terraform/language/resources/syntax#operation-timeouts): + +* `create` - (Default `10m`) +* `delete` - (Default `10m`) +* `update` - (Default `10m`) ## Import @@ -78,4 +90,4 @@ Using `terraform import`, import `aws_networkmanager_connection` using the conne % terraform import aws_networkmanager_connection.example arn:aws:networkmanager::123456789012:device/global-network-0d47f6t230mz46dy4/connection-07f6fd08867abc123 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/networkmanager_core_network.html.markdown b/website/docs/cdktf/python/r/networkmanager_core_network.html.markdown index 34016bb4dbe6..7b5cbac21f02 100644 --- a/website/docs/cdktf/python/r/networkmanager_core_network.html.markdown +++ b/website/docs/cdktf/python/r/networkmanager_core_network.html.markdown @@ -3,14 +3,16 @@ subcategory: "Network Manager" layout: "aws" page_title: "AWS: aws_networkmanager_core_network" description: |- - Provides a core network resource. + Manages a Network Manager Core Network. --- # Resource: aws_networkmanager_core_network -Provides a core network resource. +Manages a Network Manager Core Network. + +Use this resource to create and manage a core network within a global network. ## Example Usage @@ -430,13 +432,15 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -This resource supports the following arguments: +The following arguments are required: -* `description` - (Optional) Description of the Core Network. -* `base_policy_document` - (Optional, conflicts with `base_policy_region`, `base_policy_regions`) Sets the base policy document for the core network. Refer to the [Core network policies documentation](https://docs.aws.amazon.com/network-manager/latest/cloudwan/cloudwan-policy-change-sets.html) for more information. -* `base_policy_region` - (Optional, **Deprecated** use the `base_policy_regions` or `base_policy_document` argument instead) The base policy created by setting the `create_base_policy` argument to `true` requires a region to be set in the `edge-locations`, `location` key. If `base_policy_region` is not specified, the region used in the base policy defaults to the region specified in the `provider` block. -* `base_policy_regions` - (Optional, conflicts with `base_policy_region`, `base_policy_document`) A list of regions to add to the base policy. The base policy created by setting the `create_base_policy` argument to `true` requires one or more regions to be set in the `edge-locations`, `location` key. If `base_policy_regions` is not specified, the region used in the base policy defaults to the region specified in the `provider` block. -* `create_base_policy` - (Optional) Specifies whether to create a base policy when a core network is created or updated. A base policy is created and set to `LIVE` to allow attachments to the core network (e.g. VPC Attachments) before applying a policy document provided using the [`aws_networkmanager_core_network_policy_attachment` resource](/docs/providers/aws/r/networkmanager_core_network_policy_attachment.html). This base policy is needed if your core network does not have any `LIVE` policies and your policy document has static routes pointing to VPC attachments and you want to attach your VPCs to the core network before applying the desired policy document. Valid values are `true` or `false`. An example of this Terraform snippet can be found above [for VPC Attachment in a single region](#with-vpc-attachment-single-region) and [for VPC Attachment multi-region](#with-vpc-attachment-multi-region). An example base policy is shown below. This base policy is overridden with the policy that you specify in the [`aws_networkmanager_core_network_policy_attachment` resource](/docs/providers/aws/r/networkmanager_core_network_policy_attachment.html). +* `global_network_id` - (Required) ID of the global network that a core network will be a part of. + +The following arguments are optional: + +* `base_policy_document` - (Optional, conflicts with `base_policy_regions`) Sets the base policy document for the core network. Refer to the [Core network policies documentation](https://docs.aws.amazon.com/network-manager/latest/cloudwan/cloudwan-policy-change-sets.html) for more information. +* `base_policy_regions` - (Optional, conflicts with `base_policy_document`) List of regions to add to the base policy. The base policy created by setting the `create_base_policy` argument to `true` requires one or more regions to be set in the `edge-locations`, `location` key. If `base_policy_regions` is not specified, the region used in the base policy defaults to the region specified in the `provider` block. +* `create_base_policy` - (Optional) Whether to create a base policy when a core network is created or updated. A base policy is created and set to `LIVE` to allow attachments to the core network (e.g. VPC Attachments) before applying a policy document provided using the [`aws_networkmanager_core_network_policy_attachment` resource](/docs/providers/aws/r/networkmanager_core_network_policy_attachment.html). This base policy is needed if your core network does not have any `LIVE` policies and your policy document has static routes pointing to VPC attachments and you want to attach your VPCs to the core network before applying the desired policy document. Valid values are `true` or `false`. An example of this Terraform snippet can be found above [for VPC Attachment in a single region](#with-vpc-attachment-single-region) and [for VPC Attachment multi-region](#with-vpc-attachment-multi-region). An example base policy is shown below. This base policy is overridden with the policy that you specify in the [`aws_networkmanager_core_network_policy_attachment` resource](/docs/providers/aws/r/networkmanager_core_network_policy_attachment.html). ```json { @@ -463,28 +467,20 @@ This resource supports the following arguments: } ``` -* `global_network_id` - (Required) The ID of the global network that a core network will be a part of. +* `description` - (Optional) Description of the Core Network. * `tags` - (Optional) Key-value tags for the Core Network. 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. -## Timeouts - -[Configuration options](https://developer.hashicorp.com/terraform/language/resources/syntax#operation-timeouts): - -* `create` - (Default `30m`) -* `delete` - (Default `30m`) -* `update` - (Default `30m`) - ## Attribute Reference This resource exports the following attributes in addition to the arguments above: -* `arn` - Core Network Amazon Resource Name (ARN). +* `arn` - Core Network ARN. * `created_at` - Timestamp when a core network was created. * `edges` - One or more blocks detailing the edges within a core network. [Detailed below](#edges). * `id` - Core Network ID. * `segments` - One or more blocks detailing the segments within a core network. [Detailed below](#segments). * `state` - Current state of a core network. -* `tags_all` - A map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). +* `tags_all` - Map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). ### `edges` @@ -502,6 +498,14 @@ The `segments` configuration block supports the following arguments: * `name` - Name of a core network segment. * `shared_segments` - Shared segments of a core network. +## Timeouts + +[Configuration options](https://developer.hashicorp.com/terraform/language/resources/syntax#operation-timeouts): + +* `create` - (Default `30m`) +* `delete` - (Default `30m`) +* `update` - (Default `30m`) + ## Import In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import `aws_networkmanager_core_network` using the core network ID. For example: @@ -527,4 +531,4 @@ Using `terraform import`, import `aws_networkmanager_core_network` using the cor % terraform import aws_networkmanager_core_network.example core-network-0d47f6t230mz46dy4 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/networkmanager_core_network_policy_attachment.html.markdown b/website/docs/cdktf/python/r/networkmanager_core_network_policy_attachment.html.markdown index 72a893464f1d..517e75a84374 100644 --- a/website/docs/cdktf/python/r/networkmanager_core_network_policy_attachment.html.markdown +++ b/website/docs/cdktf/python/r/networkmanager_core_network_policy_attachment.html.markdown @@ -3,14 +3,16 @@ subcategory: "Network Manager" layout: "aws" page_title: "AWS: aws_networkmanager_core_network_policy_attachment" description: |- - Provides a Core Network Policy Attachment resource. + Manages a Network Manager Core Network Policy Attachment. --- # Resource: aws_networkmanager_core_network_policy_attachment -Provides a Core Network Policy Attachment resource. This puts a Core Network Policy to an existing Core Network and executes the change set, which deploys changes globally based on the policy submitted (Sets the policy to `LIVE`). +Manages a Network Manager Core Network Policy Attachment. + +Use this resource to attach a Core Network Policy to an existing Core Network and execute the change set, which deploys changes globally based on the policy submitted (sets the policy to `LIVE`). ~> **NOTE:** Deleting this resource will not delete the current policy defined in this resource. Deleting this resource will also not revert the current `LIVE` policy to the previous version. @@ -396,23 +398,23 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -This resource supports the following arguments: +The following arguments are required: -* `core_network_id` - (Required) The ID of the core network that a policy will be attached to and made `LIVE`. +* `core_network_id` - (Required) ID of the core network that a policy will be attached to and made `LIVE`. * `policy_document` - (Required) Policy document for creating a core network. Note that updating this argument will result in the new policy document version being set as the `LATEST` and `LIVE` policy document. Refer to the [Core network policies documentation](https://docs.aws.amazon.com/network-manager/latest/cloudwan/cloudwan-policy-change-sets.html) for more information. -## Timeouts - -[Configuration options](https://developer.hashicorp.com/terraform/language/resources/syntax#operation-timeouts): - -* `update` - (Default `30m`). If this is the first time attaching a policy to a core network then this timeout value is also used as the `create` timeout value. - ## Attribute Reference This resource exports the following attributes in addition to the arguments above: * `state` - Current state of a core network. +## Timeouts + +[Configuration options](https://developer.hashicorp.com/terraform/language/resources/syntax#operation-timeouts): + +* `update` - (Default `30m`). If this is the first time attaching a policy to a core network then this timeout value is also used as the `create` timeout value. + ## Import In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import `aws_networkmanager_core_network_policy_attachment` using the core network ID. For example: @@ -438,4 +440,4 @@ Using `terraform import`, import `aws_networkmanager_core_network_policy_attachm % terraform import aws_networkmanager_core_network_policy_attachment.example core-network-0d47f6t230mz46dy4 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/networkmanager_customer_gateway_association.html.markdown b/website/docs/cdktf/python/r/networkmanager_customer_gateway_association.html.markdown index 2bd1ffb0d551..2bd836dcda96 100644 --- a/website/docs/cdktf/python/r/networkmanager_customer_gateway_association.html.markdown +++ b/website/docs/cdktf/python/r/networkmanager_customer_gateway_association.html.markdown @@ -3,15 +3,16 @@ subcategory: "Network Manager" layout: "aws" page_title: "AWS: aws_networkmanager_customer_gateway_association" description: |- - Associates a customer gateway with a device and optionally, with a link. + Manages a Network Manager Customer Gateway Association. --- # Resource: aws_networkmanager_customer_gateway_association -Associates a customer gateway with a device and optionally, with a link. -If you specify a link, it must be associated with the specified device. +Manages a Network Manager Customer Gateway Association. + +Use this resource to associate a customer gateway with a device and optionally, with a link. If you specify a link, it must be associated with the specified device. ## Example Usage @@ -88,17 +89,27 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -This resource supports the following arguments: +The following arguments are required: + +* `customer_gateway_arn` - (Required) ARN of the customer gateway. +* `device_id` - (Required) ID of the device. +* `global_network_id` - (Required) ID of the global network. + +The following arguments are optional: -* `customer_gateway_arn` - (Required) The Amazon Resource Name (ARN) of the customer gateway. -* `device_id` - (Required) The ID of the device. -* `global_network_id` - (Required) The ID of the global network. -* `link_id` - (Optional) The ID of the link. +* `link_id` - (Optional) ID of the link. ## Attribute Reference This resource exports no additional attributes. +## Timeouts + +[Configuration options](https://developer.hashicorp.com/terraform/language/resources/syntax#operation-timeouts): + +* `create` - (Default `10m`) +* `delete` - (Default `10m`) + ## Import In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import `aws_networkmanager_customer_gateway_association` using the global network ID and customer gateway ARN. For example: @@ -124,4 +135,4 @@ Using `terraform import`, import `aws_networkmanager_customer_gateway_associatio % terraform import aws_networkmanager_customer_gateway_association.example global-network-0d47f6t230mz46dy4,arn:aws:ec2:us-west-2:123456789012:customer-gateway/cgw-123abc05e04123abc ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/networkmanager_device.html.markdown b/website/docs/cdktf/python/r/networkmanager_device.html.markdown index a77789f45c85..5bc14402a5d5 100644 --- a/website/docs/cdktf/python/r/networkmanager_device.html.markdown +++ b/website/docs/cdktf/python/r/networkmanager_device.html.markdown @@ -3,15 +3,16 @@ subcategory: "Network Manager" layout: "aws" page_title: "AWS: aws_networkmanager_device" description: |- - Creates a device in a global network. + Manages a Network Manager Device. --- # Resource: aws_networkmanager_device -Creates a device in a global network. If you specify both a site ID and a location, -the location of the site is used for visualization in the Network Manager console. +Manages a Network Manager Device. + +Use this resource to create a device in a global network. If you specify both a site ID and a location, the location of the site is used for visualization in the Network Manager console. ## Example Usage @@ -35,36 +36,47 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -This resource supports the following arguments: +The following arguments are required: + +* `global_network_id` - (Required) ID of the global network. + +The following arguments are optional: -* `aws_location` - (Optional) The AWS location of the device. Documented below. -* `description` - (Optional) A description of the device. -* `global_network_id` - (Required) The ID of the global network. -* `location` - (Optional) The location of the device. Documented below. -* `model` - (Optional) The model of device. -* `serial_number` - (Optional) The serial number of the device. -* `site_id` - (Optional) The ID of the site. +* `aws_location` - (Optional) AWS location of the device. Documented below. +* `description` - (Optional) Description of the device. +* `location` - (Optional) Location of the device. Documented below. +* `model` - (Optional) Model of device. +* `serial_number` - (Optional) Serial number of the device. +* `site_id` - (Optional) ID of the site. * `tags` - (Optional) Key-value tags for the device. 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. -* `type` - (Optional) The type of device. -* `vendor` - (Optional) The vendor of the device. +* `type` - (Optional) Type of device. +* `vendor` - (Optional) Vendor of the device. The `aws_location` object supports the following: -* `subnet_arn` - (Optional) The Amazon Resource Name (ARN) of the subnet that the device is located in. -* `zone` - (Optional) The Zone that the device is located in. Specify the ID of an Availability Zone, Local Zone, Wavelength Zone, or an Outpost. +* `subnet_arn` - (Optional) ARN of the subnet that the device is located in. +* `zone` - (Optional) Zone that the device is located in. Specify the ID of an Availability Zone, Local Zone, Wavelength Zone, or an Outpost. The `location` object supports the following: -* `address` - (Optional) The physical address. -* `latitude` - (Optional) The latitude. -* `longitude` - (Optional) The longitude. +* `address` - (Optional) Physical address. +* `latitude` - (Optional) Latitude. +* `longitude` - (Optional) Longitude. ## Attribute Reference This resource exports the following attributes in addition to the arguments above: -* `arn` - The Amazon Resource Name (ARN) of the device. -* `tags_all` - A map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). +* `arn` - ARN of the device. +* `tags_all` - Map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). + +## Timeouts + +[Configuration options](https://developer.hashicorp.com/terraform/language/resources/syntax#operation-timeouts): + +* `create` - (Default `10m`) +* `delete` - (Default `10m`) +* `update` - (Default `10m`) ## Import @@ -91,4 +103,4 @@ Using `terraform import`, import `aws_networkmanager_device` using the device AR % terraform import aws_networkmanager_device.example arn:aws:networkmanager::123456789012:device/global-network-0d47f6t230mz46dy4/device-07f6fd08867abc123 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/networkmanager_dx_gateway_attachment.html.markdown b/website/docs/cdktf/python/r/networkmanager_dx_gateway_attachment.html.markdown index 37a8b6e58df9..e8c80e24cdb2 100644 --- a/website/docs/cdktf/python/r/networkmanager_dx_gateway_attachment.html.markdown +++ b/website/docs/cdktf/python/r/networkmanager_dx_gateway_attachment.html.markdown @@ -3,13 +3,15 @@ subcategory: "Network Manager" layout: "aws" page_title: "AWS: aws_networkmanager_dx_gateway_attachment" description: |- - Terraform resource for managing an AWS Network Manager Direct Connect Gateway Attachment. + Manages a Network Manager Direct Connect Gateway Attachment. --- # Resource: aws_networkmanager_dx_gateway_attachment -Terraform resource for managing an AWS Network Manager Direct Connect (DX) Gateway Attachment. +Manages a Network Manager Direct Connect Gateway Attachment. + +Use this resource to create and manage a Direct Connect Gateway attachment to a Cloud WAN core network. ## Example Usage @@ -30,7 +32,7 @@ class MyConvertedCode(TerraformStack): NetworkmanagerDxGatewayAttachment(self, "test", core_network_id=Token.as_string(aws_networkmanager_core_network_policy_attachment_test.core_network_id), direct_connect_gateway_arn="arn:aws:directconnect::${" + current.account_id + "}:dx-gateway/${" + aws_dx_gateway_test.id + "}", - edge_locations=[Token.as_string(data_aws_region_current.name)] + edge_locations=[Token.as_string(data_aws_region_current.region)] ) ``` @@ -50,14 +52,15 @@ The following arguments are optional: This resource exports the following attributes in addition to the arguments above: +* `arn` - ARN of the attachment. * `attachment_policy_rule_number` - Policy rule number associated with the attachment. * `attachment_type` - Type of attachment. * `core_network_arn` - ARN of the core network for the attachment. -* `id` - The ID of the attachment. +* `id` - ID of the attachment. * `owner_account_id` - ID of the attachment account owner. * `segment_name` - Name of the segment attachment. * `state` - State of the attachment. -* `tags_all` - A map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). +* `tags_all` - Map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). ## Timeouts @@ -92,4 +95,4 @@ Using `terraform import`, import Network Manager DX Gateway Attachment using the % terraform import aws_networkmanager_dx_gateway_attachment.example attachment-1a2b3c4d5e6f7g ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/networkmanager_global_network.html.markdown b/website/docs/cdktf/python/r/networkmanager_global_network.html.markdown index d191b4252fb3..78e15a7b13c7 100644 --- a/website/docs/cdktf/python/r/networkmanager_global_network.html.markdown +++ b/website/docs/cdktf/python/r/networkmanager_global_network.html.markdown @@ -3,14 +3,16 @@ subcategory: "Network Manager" layout: "aws" page_title: "AWS: aws_networkmanager_global_network" description: |- - Provides a global network resource. + Manages a Network Manager Global Network. --- # Resource: aws_networkmanager_global_network -Provides a global network resource. +Manages a Network Manager Global Network. + +Use this resource to create and manage a global network, which is a single private network that acts as the high-level container for your network objects. ## Example Usage @@ -33,7 +35,7 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -This resource supports the following arguments: +The following arguments are optional: * `description` - (Optional) Description of the Global Network. * `tags` - (Optional) Key-value tags for the Global Network. 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. @@ -42,8 +44,16 @@ This resource supports the following arguments: This resource exports the following attributes in addition to the arguments above: -* `arn` - Global Network Amazon Resource Name (ARN) -* `tags_all` - A map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). +* `arn` - Global Network ARN. +* `tags_all` - Map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). + +## Timeouts + +[Configuration options](https://developer.hashicorp.com/terraform/language/resources/syntax#operation-timeouts): + +* `create` - (Default `10m`) +* `delete` - (Default `10m`) +* `update` - (Default `10m`) ## Import @@ -70,4 +80,4 @@ Using `terraform import`, import `aws_networkmanager_global_network` using the g % terraform import aws_networkmanager_global_network.example global-network-0d47f6t230mz46dy4 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/networkmanager_link.html.markdown b/website/docs/cdktf/python/r/networkmanager_link.html.markdown index 5b069484bd30..c7305cfa15ce 100644 --- a/website/docs/cdktf/python/r/networkmanager_link.html.markdown +++ b/website/docs/cdktf/python/r/networkmanager_link.html.markdown @@ -3,14 +3,14 @@ subcategory: "Network Manager" layout: "aws" page_title: "AWS: aws_networkmanager_link" description: |- - Creates a link for a site. + Manages a Network Manager link. --- # Resource: aws_networkmanager_link -Creates a link for a site. +Manages a Network Manager link. Use this resource to create a link for a site. ## Example Usage @@ -39,17 +39,20 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -This resource supports the following arguments: +The following arguments are required: -* `bandwidth` - (Required) The upload speed and download speed in Mbps. Documented below. -* `description` - (Optional) A description of the link. -* `global_network_id` - (Required) The ID of the global network. -* `provider_name` - (Optional) The provider of the link. -* `site_id` - (Required) The ID of the site. +* `bandwidth` - (Required) Upload speed and download speed in Mbps. [See below](#bandwidth). +* `global_network_id` - (Required) ID of the global network. +* `site_id` - (Required) ID of the site. + +The following arguments are optional: + +* `description` - (Optional) Description of the link. +* `provider_name` - (Optional) Provider of the link. * `tags` - (Optional) Key-value tags for the link. 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. -* `type` - (Optional) The type of the link. +* `type` - (Optional) Type of the link. -The `bandwidth` object supports the following: +### bandwidth * `download_speed` - (Optional) Download speed in Mbps. * `upload_speed` - (Optional) Upload speed in Mbps. @@ -58,8 +61,16 @@ The `bandwidth` object supports the following: This resource exports the following attributes in addition to the arguments above: -* `arn` - Link Amazon Resource Name (ARN). -* `tags_all` - A map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). +* `arn` - Link ARN. +* `tags_all` - Map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). + +## Timeouts + +[Configuration options](https://developer.hashicorp.com/terraform/language/resources/syntax#operation-timeouts): + +* `create` - (Default `10m`) +* `delete` - (Default `10m`) +* `update` - (Default `10m`) ## Import @@ -86,4 +97,4 @@ Using `terraform import`, import `aws_networkmanager_link` using the link ARN. F % terraform import aws_networkmanager_link.example arn:aws:networkmanager::123456789012:link/global-network-0d47f6t230mz46dy4/link-444555aaabbb11223 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/networkmanager_link_association.html.markdown b/website/docs/cdktf/python/r/networkmanager_link_association.html.markdown index 8c87b5ecaeb1..e19036418809 100644 --- a/website/docs/cdktf/python/r/networkmanager_link_association.html.markdown +++ b/website/docs/cdktf/python/r/networkmanager_link_association.html.markdown @@ -3,16 +3,14 @@ subcategory: "Network Manager" layout: "aws" page_title: "AWS: aws_networkmanager_link_association" description: |- - Associates a link to a device. + Manages a Network Manager link association. --- # Resource: aws_networkmanager_link_association -Associates a link to a device. -A device can be associated to multiple links and a link can be associated to multiple devices. -The device and link must be in the same global network and the same site. +Manages a Network Manager link association. Associates a link to a device. A device can be associated to multiple links and a link can be associated to multiple devices. The device and link must be in the same global network and the same site. ## Example Usage @@ -37,16 +35,23 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -This resource supports the following arguments: +The following arguments are required: -* `device_id` - (Required) The ID of the device. -* `global_network_id` - (Required) The ID of the global network. -* `link_id` - (Required) The ID of the link. +* `device_id` - (Required) ID of the device. +* `global_network_id` - (Required) ID of the global network. +* `link_id` - (Required) ID of the link. ## Attribute Reference This resource exports no additional attributes. +## Timeouts + +[Configuration options](https://developer.hashicorp.com/terraform/language/resources/syntax#operation-timeouts): + +* `create` - (Default `10m`) +* `delete` - (Default `10m`) + ## Import In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import `aws_networkmanager_link_association` using the global network ID, link ID and device ID. For example: @@ -72,4 +77,4 @@ Using `terraform import`, import `aws_networkmanager_link_association` using the % terraform import aws_networkmanager_link_association.example global-network-0d47f6t230mz46dy4,link-444555aaabbb11223,device-07f6fd08867abc123 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/networkmanager_site.html.markdown b/website/docs/cdktf/python/r/networkmanager_site.html.markdown index dc17f22fc57b..527f4c3d2941 100644 --- a/website/docs/cdktf/python/r/networkmanager_site.html.markdown +++ b/website/docs/cdktf/python/r/networkmanager_site.html.markdown @@ -3,14 +3,14 @@ subcategory: "Network Manager" layout: "aws" page_title: "AWS: aws_networkmanager_site" description: |- - Creates a site in a global network. + Manages a Network Manager site. --- # Resource: aws_networkmanager_site -Creates a site in a global network. +Manages a Network Manager site. Use this resource to create a site in a global network. ## Example Usage @@ -37,14 +37,17 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -This resource supports the following arguments: +The following arguments are required: + +* `global_network_id` - (Required) ID of the Global Network to create the site in. + +The following arguments are optional: -* `global_network_id` - (Required) The ID of the Global Network to create the site in. * `description` - (Optional) Description of the Site. -* `location` - (Optional) The site location as documented below. +* `location` - (Optional) Site location. [See below](#location). * `tags` - (Optional) Key-value tags for the Site. 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 `location` object supports the following: +### location * `address` - (Optional) Address of the location. * `latitude` - (Optional) Latitude of the location. @@ -54,8 +57,16 @@ The `location` object supports the following: This resource exports the following attributes in addition to the arguments above: -* `arn` - Site Amazon Resource Name (ARN) -* `tags_all` - A map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). +* `arn` - Site ARN. +* `tags_all` - Map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). + +## Timeouts + +[Configuration options](https://developer.hashicorp.com/terraform/language/resources/syntax#operation-timeouts): + +* `create` - (Default `10m`) +* `delete` - (Default `10m`) +* `update` - (Default `10m`) ## Import @@ -82,4 +93,4 @@ Using `terraform import`, import `aws_networkmanager_site` using the site ARN. F % terraform import aws_networkmanager_site.example arn:aws:networkmanager::123456789012:site/global-network-0d47f6t230mz46dy4/site-444555aaabbb11223 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/networkmanager_site_to_site_vpn_attachment.html.markdown b/website/docs/cdktf/python/r/networkmanager_site_to_site_vpn_attachment.html.markdown index 2c33e704612d..529874781497 100644 --- a/website/docs/cdktf/python/r/networkmanager_site_to_site_vpn_attachment.html.markdown +++ b/website/docs/cdktf/python/r/networkmanager_site_to_site_vpn_attachment.html.markdown @@ -3,14 +3,14 @@ subcategory: "Network Manager" layout: "aws" page_title: "AWS: aws_networkmanager_site_to_site_vpn_attachment" description: |- - Terraform resource for managing an AWS Network Manager SiteToSiteAttachment. + Manages a Network Manager site-to-site VPN attachment. --- # Resource: aws_networkmanager_site_to_site_vpn_attachment -Terraform resource for managing an AWS Network Manager SiteToSiteAttachment. +Manages a Network Manager site-to-site VPN attachment. ## Example Usage @@ -99,7 +99,7 @@ class MyConvertedCode(TerraformStack): asn_ranges=["64512-64555"], edge_locations=[DataAwsNetworkmanagerCoreNetworkPolicyDocumentCoreNetworkConfigurationEdgeLocations( asn=Token.as_string(64512), - location=Token.as_string(current.name) + location=Token.as_string(current.region) ) ], vpn_ecmp_support=False @@ -152,29 +152,36 @@ class MyConvertedCode(TerraformStack): The following arguments are required: -- `core_network_id` - (Required) The ID of a core network for the VPN attachment. -- `vpn_connection_arn` - (Required) The ARN of the site-to-site VPN connection. +* `core_network_id` - (Required) ID of a core network for the VPN attachment. +* `vpn_connection_arn` - (Required) ARN of the site-to-site VPN connection. The following arguments are optional: -- `tags` - (Optional) Key-value tags for the attachment. 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. +* `tags` - (Optional) Key-value tags for the attachment. 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. ## Attribute Reference This resource exports the following attributes in addition to the arguments above: -- `arn` - The ARN of the attachment. -- `attachment_policy_rule_number` - The policy rule number associated with the attachment. -- `attachment_type` - The type of attachment. -- `core_network_arn` - The ARN of a core network. -- `core_network_id` - The ID of a core network -- `edge_location` - The Region where the edge is located. -- `id` - The ID of the attachment. -- `owner_account_id` - The ID of the attachment account owner. -- `resource_arn` - The attachment resource ARN. -- `segment_name` - The name of the segment attachment. -- `state` - The state of the attachment. -- `tags_all` - A map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). +* `arn` - ARN of the attachment. +* `attachment_policy_rule_number` - Policy rule number associated with the attachment. +* `attachment_type` - Type of attachment. +* `core_network_arn` - ARN of a core network. +* `edge_location` - Region where the edge is located. +* `id` - ID of the attachment. +* `owner_account_id` - ID of the attachment account owner. +* `resource_arn` - Attachment resource ARN. +* `segment_name` - Name of the segment attachment. +* `state` - State of the attachment. +* `tags_all` - Map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). + +## Timeouts + +[Configuration options](https://developer.hashicorp.com/terraform/language/resources/syntax#operation-timeouts): + +* `create` - (Default `10m`) +* `delete` - (Default `10m`) +* `update` - (Default `10m`) ## Import @@ -201,4 +208,4 @@ Using `terraform import`, import `aws_networkmanager_site_to_site_vpn_attachment % terraform import aws_networkmanager_site_to_site_vpn_attachment.example attachment-0f8fa60d2238d1bd8 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/networkmanager_transit_gateway_connect_peer_association.html.markdown b/website/docs/cdktf/python/r/networkmanager_transit_gateway_connect_peer_association.html.markdown index 29794094d607..865aa7472d43 100644 --- a/website/docs/cdktf/python/r/networkmanager_transit_gateway_connect_peer_association.html.markdown +++ b/website/docs/cdktf/python/r/networkmanager_transit_gateway_connect_peer_association.html.markdown @@ -3,15 +3,14 @@ subcategory: "Network Manager" layout: "aws" page_title: "AWS: aws_networkmanager_transit_gateway_connect_peer_association" description: |- - Associates a transit gateway Connect peer with a device, and optionally, with a link. + Manages a Network Manager transit gateway Connect peer association. --- # Resource: aws_networkmanager_transit_gateway_connect_peer_association -Associates a transit gateway Connect peer with a device, and optionally, with a link. -If you specify a link, it must be associated with the specified device. +Manages a Network Manager transit gateway Connect peer association. Associates a transit gateway Connect peer with a device, and optionally, with a link. If you specify a link, it must be associated with the specified device. ## Example Usage @@ -36,20 +35,30 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -This resource supports the following arguments: +The following arguments are required: -* `device_id` - (Required) The ID of the device. -* `global_network_id` - (Required) The ID of the global network. -* `link_id` - (Optional) The ID of the link. -* `transit_gateway_connect_peer_arn` - (Required) The Amazon Resource Name (ARN) of the Connect peer. +* `device_id` - (Required) ID of the device. +* `global_network_id` - (Required) ID of the global network. +* `transit_gateway_connect_peer_arn` - (Required) ARN of the Connect peer. + +The following arguments are optional: + +* `link_id` - (Optional) ID of the link. ## Attribute Reference This resource exports no additional attributes. +## Timeouts + +[Configuration options](https://developer.hashicorp.com/terraform/language/resources/syntax#operation-timeouts): + +* `create` - (Default `10m`) +* `delete` - (Default `10m`) + ## Import -In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import `aws_networkmanager_transit_gateway_connect_peer_association` using the global network ID and customer gateway ARN. For example: +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import `aws_networkmanager_transit_gateway_connect_peer_association` using the global network ID and Connect peer ARN. For example: ```python # DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -66,10 +75,10 @@ class MyConvertedCode(TerraformStack): NetworkmanagerTransitGatewayConnectPeerAssociation.generate_config_for_import(self, "example", "global-network-0d47f6t230mz46dy4,arn:aws:ec2:us-west-2:123456789012:transit-gateway-connect-peer/tgw-connect-peer-12345678") ``` -Using `terraform import`, import `aws_networkmanager_transit_gateway_connect_peer_association` using the global network ID and customer gateway ARN. For example: +Using `terraform import`, import `aws_networkmanager_transit_gateway_connect_peer_association` using the global network ID and Connect peer ARN. For example: ```console % terraform import aws_networkmanager_transit_gateway_connect_peer_association.example global-network-0d47f6t230mz46dy4,arn:aws:ec2:us-west-2:123456789012:transit-gateway-connect-peer/tgw-connect-peer-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/networkmanager_transit_gateway_peering.html.markdown b/website/docs/cdktf/python/r/networkmanager_transit_gateway_peering.html.markdown index 258020a4685b..3c00cef2c8f6 100644 --- a/website/docs/cdktf/python/r/networkmanager_transit_gateway_peering.html.markdown +++ b/website/docs/cdktf/python/r/networkmanager_transit_gateway_peering.html.markdown @@ -3,14 +3,14 @@ subcategory: "Network Manager" layout: "aws" page_title: "AWS: aws_networkmanager_transit_gateway_peering" description: |- - Creates a peering connection between an AWS Cloud WAN core network and an AWS Transit Gateway. + Manages a Network Manager transit gateway peering connection. --- # Resource: aws_networkmanager_transit_gateway_peering -Creates a peering connection between an AWS Cloud WAN core network and an AWS Transit Gateway. +Manages a Network Manager transit gateway peering connection. Creates a peering connection between an AWS Cloud WAN core network and an AWS Transit Gateway. ## Example Usage @@ -28,31 +28,43 @@ class MyConvertedCode(TerraformStack): super().__init__(scope, name) NetworkmanagerTransitGatewayPeering(self, "example", core_network_id=Token.as_string(awscc_networkmanager_core_network_example.id), + depends_on=[aws_ec2_transit_gateway_policy_table_example, aws_networkmanager_core_network_policy_attachment_example + ], transit_gateway_arn=Token.as_string(aws_ec2_transit_gateway_example.arn) ) ``` ## Argument Reference -This resource supports the following arguments: +The following arguments are required: + +* `core_network_id` - (Required) ID of a core network. +* `transit_gateway_arn` - (Required) ARN of the transit gateway for the peering request. + +The following arguments are optional: -* `core_network_id` - (Required) The ID of a core network. * `tags` - (Optional) Key-value tags for the peering. 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. -* `transit_gateway_arn` - (Required) The ARN of the transit gateway for the peering request. ## Attribute Reference This resource exports the following attributes in addition to the arguments above: -* `arn` - Peering Amazon Resource Name (ARN). -* `core_network_arn` - The ARN of the core network. -* `edge_location` - The edge location for the peer. +* `arn` - Peering ARN. +* `core_network_arn` - ARN of the core network. +* `edge_location` - Edge location for the peer. * `id` - Peering ID. -* `owner_account_id` - The ID of the account owner. -* `peering_type` - The type of peering. This will be `TRANSIT_GATEWAY`. -* `resource_arn` - The resource ARN of the peer. -* `tags_all` - A map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). -* `transit_gateway_peering_attachment_id` - The ID of the transit gateway peering attachment. +* `owner_account_id` - ID of the account owner. +* `peering_type` - Type of peering. This will be `TRANSIT_GATEWAY`. +* `resource_arn` - Resource ARN of the peer. +* `tags_all` - Map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). +* `transit_gateway_peering_attachment_id` - ID of the transit gateway peering attachment. + +## Timeouts + +[Configuration options](https://developer.hashicorp.com/terraform/language/resources/syntax#operation-timeouts): + +* `create` - (Default `20m`) +* `delete` - (Default `20m`) ## Import @@ -79,4 +91,4 @@ Using `terraform import`, import `aws_networkmanager_transit_gateway_peering` us % terraform import aws_networkmanager_transit_gateway_peering.example peering-444555aaabbb11223 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/networkmanager_transit_gateway_registration.html.markdown b/website/docs/cdktf/python/r/networkmanager_transit_gateway_registration.html.markdown index 177fd941fec6..51845f63b648 100644 --- a/website/docs/cdktf/python/r/networkmanager_transit_gateway_registration.html.markdown +++ b/website/docs/cdktf/python/r/networkmanager_transit_gateway_registration.html.markdown @@ -3,16 +3,14 @@ subcategory: "Network Manager" layout: "aws" page_title: "AWS: aws_networkmanager_transit_gateway_registration" description: |- - Registers a transit gateway to a global network. + Manages a Network Manager transit gateway registration. --- # Resource: aws_networkmanager_transit_gateway_registration -Registers a transit gateway to a global network. The transit gateway can be in any AWS Region, -but it must be owned by the same AWS account that owns the global network. -You cannot register a transit gateway in more than one global network. +Manages a Network Manager transit gateway registration. Registers a transit gateway to a global network. The transit gateway can be in any AWS Region, but it must be owned by the same AWS account that owns the global network. You cannot register a transit gateway in more than one global network. ## Example Usage @@ -48,15 +46,22 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -This resource supports the following arguments: +The following arguments are required: -* `global_network_id` - (Required) The ID of the Global Network to register to. -* `transit_gateway_arn` - (Required) The ARN of the Transit Gateway to register. +* `global_network_id` - (Required) ID of the Global Network to register to. +* `transit_gateway_arn` - (Required) ARN of the Transit Gateway to register. ## Attribute Reference This resource exports no additional attributes. +## Timeouts + +[Configuration options](https://developer.hashicorp.com/terraform/language/resources/syntax#operation-timeouts): + +* `create` - (Default `10m`) +* `delete` - (Default `10m`) + ## Import In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import `aws_networkmanager_transit_gateway_registration` using the global network ID and transit gateway ARN. For example: @@ -82,4 +87,4 @@ Using `terraform import`, import `aws_networkmanager_transit_gateway_registratio % terraform import aws_networkmanager_transit_gateway_registration.example global-network-0d47f6t230mz46dy4,arn:aws:ec2:us-west-2:123456789012:transit-gateway/tgw-123abc05e04123abc ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/networkmanager_transit_gateway_route_table_attachment.html.markdown b/website/docs/cdktf/python/r/networkmanager_transit_gateway_route_table_attachment.html.markdown index 8b5561409e6b..c807b9afa9d9 100644 --- a/website/docs/cdktf/python/r/networkmanager_transit_gateway_route_table_attachment.html.markdown +++ b/website/docs/cdktf/python/r/networkmanager_transit_gateway_route_table_attachment.html.markdown @@ -3,14 +3,14 @@ subcategory: "Network Manager" layout: "aws" page_title: "AWS: aws_networkmanager_transit_gateway_route_table_attachment" description: |- - Creates a transit gateway route table attachment. + Manages a Network Manager transit gateway route table attachment. --- # Resource: aws_networkmanager_transit_gateway_route_table_attachment -Creates a transit gateway route table attachment. +Manages a Network Manager transit gateway route table attachment. ## Example Usage @@ -34,28 +34,38 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -This resource supports the following arguments: +The following arguments are required: + +* `peering_id` - (Required) ID of the peer for the attachment. +* `transit_gateway_route_table_arn` - (Required) ARN of the transit gateway route table for the attachment. + +The following arguments are optional: -* `peering_id` - (Required) The ID of the peer for the attachment. * `tags` - (Optional) Key-value tags for the attachment. 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. -* `transit_gateway_route_table_arn` - (Required) The ARN of the transit gateway route table for the attachment. ## Attribute Reference This resource exports the following attributes in addition to the arguments above: -* `arn` - Attachment Amazon Resource Name (ARN). -* `attachment_policy_rule_number` - The policy rule number associated with the attachment. -* `attachment_type` - The type of attachment. -* `core_network_arn` - The ARN of the core network. -* `core_network_id` - The ID of the core network. -* `edge_location` - The edge location for the peer. -* `id` - The ID of the attachment. -* `owner_account_id` - The ID of the attachment account owner. -* `resource_arn` - The attachment resource ARN. -* `segment_name` - The name of the segment attachment. -* `state` - The state of the attachment. -* `tags_all` - A map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). +* `arn` - Attachment ARN. +* `attachment_policy_rule_number` - Policy rule number associated with the attachment. +* `attachment_type` - Type of attachment. +* `core_network_arn` - ARN of the core network. +* `core_network_id` - ID of the core network. +* `edge_location` - Edge location for the peer. +* `id` - ID of the attachment. +* `owner_account_id` - ID of the attachment account owner. +* `resource_arn` - Attachment resource ARN. +* `segment_name` - Name of the segment attachment. +* `state` - State of the attachment. +* `tags_all` - Map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). + +## Timeouts + +[Configuration options](https://developer.hashicorp.com/terraform/language/resources/syntax#operation-timeouts): + +* `create` - (Default `10m`) +* `delete` - (Default `10m`) ## Import @@ -82,4 +92,4 @@ Using `terraform import`, import `aws_networkmanager_transit_gateway_route_table % terraform import aws_networkmanager_transit_gateway_route_table_attachment.example attachment-0f8fa60d2238d1bd8 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/networkmanager_vpc_attachment.html.markdown b/website/docs/cdktf/python/r/networkmanager_vpc_attachment.html.markdown index f5b7a105ac2f..4c1fd6dbb3dc 100644 --- a/website/docs/cdktf/python/r/networkmanager_vpc_attachment.html.markdown +++ b/website/docs/cdktf/python/r/networkmanager_vpc_attachment.html.markdown @@ -3,14 +3,14 @@ subcategory: "Network Manager" layout: "aws" page_title: "AWS: aws_networkmanager_vpc_attachment" description: |- - Terraform resource for managing an AWS Network Manager VPC Attachment. + Manages a Network Manager VPC attachment. --- # Resource: aws_networkmanager_vpc_attachment -Terraform resource for managing an AWS Network Manager VPC Attachment. +Manages a Network Manager VPC attachment. ## Example Usage @@ -39,38 +39,43 @@ class MyConvertedCode(TerraformStack): The following arguments are required: -* `core_network_id` - (Required) The ID of a core network for the VPC attachment. -* `subnet_arns` - (Required) The subnet ARN of the VPC attachment. -* `vpc_arn` - (Required) The ARN of the VPC. +* `core_network_id` - (Required) ID of a core network for the VPC attachment. +* `subnet_arns` - (Required) Subnet ARNs of the VPC attachment. +* `vpc_arn` - (Required) ARN of the VPC. The following arguments are optional: -* `options` - (Optional) Options for the VPC attachment. +* `options` - (Optional) Options for the VPC attachment. [See below](#options). * `tags` - (Optional) Key-value tags for the attachment. 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. ### options -* `appliance_mode_support` - (Optional) Indicates whether appliance mode is supported. - If enabled, traffic flow between a source and destination use the same Availability Zone for the VPC attachment for the lifetime of that flow. - If the VPC attachment is pending acceptance, changing this value will recreate the resource. -* `ipv6_support` - (Optional) Indicates whether IPv6 is supported. - If the VPC attachment is pending acceptance, changing this value will recreate the resource. +* `appliance_mode_support` - (Optional) Whether to enable appliance mode support. If enabled, traffic flow between a source and destination use the same Availability Zone for the VPC attachment for the lifetime of that flow. If the VPC attachment is pending acceptance, changing this value will recreate the resource. +* `ipv6_support` - (Optional) Whether to enable IPv6 support. If the VPC attachment is pending acceptance, changing this value will recreate the resource. ## Attribute Reference This resource exports the following attributes in addition to the arguments above: -* `arn` - The ARN of the attachment. -* `attachment_policy_rule_number` - The policy rule number associated with the attachment. -* `attachment_type` - The type of attachment. -* `core_network_arn` - The ARN of a core network. -* `edge_location` - The Region where the edge is located. -* `id` - The ID of the attachment. -* `owner_account_id` - The ID of the attachment account owner. -* `resource_arn` - The attachment resource ARN. -* `segment_name` - The name of the segment attachment. -* `state` - The state of the attachment. -* `tags_all` - A map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). +* `arn` - ARN of the attachment. +* `attachment_policy_rule_number` - Policy rule number associated with the attachment. +* `attachment_type` - Type of attachment. +* `core_network_arn` - ARN of a core network. +* `edge_location` - Region where the edge is located. +* `id` - ID of the attachment. +* `owner_account_id` - ID of the attachment account owner. +* `resource_arn` - Attachment resource ARN. +* `segment_name` - Name of the segment attachment. +* `state` - State of the attachment. +* `tags_all` - Map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). + +## Timeouts + +[Configuration options](https://developer.hashicorp.com/terraform/language/resources/syntax#operation-timeouts): + +* `create` - (Default `15m`) +* `delete` - (Default `10m`) +* `update` - (Default `10m`) ## Import @@ -97,4 +102,4 @@ Using `terraform import`, import `aws_networkmanager_vpc_attachment` using the a % terraform import aws_networkmanager_vpc_attachment.example attachment-0f8fa60d2238d1bd8 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/networkmonitor_monitor.html.markdown b/website/docs/cdktf/python/r/networkmonitor_monitor.html.markdown index 0cb4bf9569ba..328c719c05b1 100644 --- a/website/docs/cdktf/python/r/networkmonitor_monitor.html.markdown +++ b/website/docs/cdktf/python/r/networkmonitor_monitor.html.markdown @@ -42,6 +42,7 @@ The following arguments are required: The following arguments are optional: +- `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). - `aggregation_period` - (Optional) The time, in seconds, that metrics are aggregated and sent to Amazon CloudWatch. Valid values are either 30 or 60. - `tags` - (Optional) Key-value tags for the monitor. 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. @@ -77,4 +78,4 @@ Using `terraform import`, import `aws_networkmonitor_monitor` using the monitor % terraform import aws_networkmonitor_monitor.example monitor-7786087912324693644 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/networkmonitor_probe.html.markdown b/website/docs/cdktf/python/r/networkmonitor_probe.html.markdown index e867ff3f580b..be661a4df70a 100644 --- a/website/docs/cdktf/python/r/networkmonitor_probe.html.markdown +++ b/website/docs/cdktf/python/r/networkmonitor_probe.html.markdown @@ -49,6 +49,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +- `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). - `destination` - (Required) The destination IP address. This must be either IPV4 or IPV6. - `destination_port` - (Optional) The port associated with the destination. This is required only if the protocol is TCP and must be a number between 1 and 65536. - `monitor_name` - (Required) The name of the monitor. @@ -90,4 +91,4 @@ Using `terraform import`, import `aws_networkmonitor_probe` using the monitor na % terraform import aws_networkmonitor_probe.example monitor-7786087912324693644,probe-3qm8p693i4fi1h8lqylzkbp42e ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/oam_link.html.markdown b/website/docs/cdktf/python/r/oam_link.html.markdown index 347d9af054ee..93d6b199e7ae 100644 --- a/website/docs/cdktf/python/r/oam_link.html.markdown +++ b/website/docs/cdktf/python/r/oam_link.html.markdown @@ -118,6 +118,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `link_configuration` - (Optional) Configuration for creating filters that specify that only some metric namespaces or log groups are to be shared from the source account to the monitoring account. See [`link_configuration` Block](#link_configuration-block) for details. * `tags` - (Optional) A 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. @@ -183,4 +184,4 @@ Using `terraform import`, import CloudWatch Observability Access Manager Link us % terraform import aws_oam_link.example arn:aws:oam:us-west-2:123456789012:link/link-id ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/oam_sink.html.markdown b/website/docs/cdktf/python/r/oam_sink.html.markdown index 89f0a06302e0..79cc3cbf9e51 100644 --- a/website/docs/cdktf/python/r/oam_sink.html.markdown +++ b/website/docs/cdktf/python/r/oam_sink.html.markdown @@ -44,6 +44,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `tags` - (Optional) A 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. ## Attribute Reference @@ -87,4 +88,4 @@ Using `terraform import`, import CloudWatch Observability Access Manager Sink us % terraform import aws_oam_sink.example arn:aws:oam:us-west-2:123456789012:sink/sink-id ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/oam_sink_policy.html.markdown b/website/docs/cdktf/python/r/oam_sink_policy.html.markdown index 153777b7b564..9432b90255ef 100644 --- a/website/docs/cdktf/python/r/oam_sink_policy.html.markdown +++ b/website/docs/cdktf/python/r/oam_sink_policy.html.markdown @@ -60,8 +60,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `sink_identifier` - (Required) ARN of the sink to attach this policy to. * `policy` - (Required) JSON policy to use. If you are updating an existing policy, the entire existing policy is replaced by what you specify here. @@ -104,4 +105,4 @@ Using `terraform import`, import CloudWatch Observability Access Manager Sink Po % terraform import aws_oam_sink_policy.example arn:aws:oam:us-west-2:123456789012:sink/sink-id ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/opensearch_authorize_vpc_endpoint_access.html.markdown b/website/docs/cdktf/python/r/opensearch_authorize_vpc_endpoint_access.html.markdown index b023b46d6db4..b8cdb5fcd97e 100644 --- a/website/docs/cdktf/python/r/opensearch_authorize_vpc_endpoint_access.html.markdown +++ b/website/docs/cdktf/python/r/opensearch_authorize_vpc_endpoint_access.html.markdown @@ -38,8 +38,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `account` - (Required) AWS account ID to grant access to. * `domain_name` - (Required) Name of OpenSearch Service domain to provide access to. @@ -56,7 +57,7 @@ This resource exports the following attributes in addition to the arguments abov ## Import -In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import OpenSearch Authorize Vpc Endpoint Access using the `example_id_arg`. For example: +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import OpenSearch Authorize Vpc Endpoint Access using the `domain_name`. For example: ```python # DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -73,10 +74,10 @@ class MyConvertedCode(TerraformStack): OpensearchAuthorizeVpcEndpointAccess.generate_config_for_import(self, "example", "authorize_vpc_endpoint_access-id-12345678") ``` -Using `terraform import`, import OpenSearch Authorize Vpc Endpoint Access using the `example_id_arg`. For example: +Using `terraform import`, import OpenSearch Authorize Vpc Endpoint Access using the `domain_name`. For example: ```console % terraform import aws_opensearch_authorize_vpc_endpoint_access.example authorize_vpc_endpoint_access-id-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/opensearch_domain.html.markdown b/website/docs/cdktf/python/r/opensearch_domain.html.markdown index 62467c2bf4c5..2fa176a18ac4 100644 --- a/website/docs/cdktf/python/r/opensearch_domain.html.markdown +++ b/website/docs/cdktf/python/r/opensearch_domain.html.markdown @@ -100,7 +100,7 @@ class MyConvertedCode(TerraformStack): type="*" ) ], - resources=["arn:aws:es:${" + data_aws_region_current.name + "}:${" + current.account_id + "}:domain/${" + domain.value + "}/*" + resources=["arn:aws:es:${" + data_aws_region_current.region + "}:${" + current.account_id + "}:domain/${" + domain.value + "}/*" ] ) ] @@ -232,7 +232,7 @@ class MyConvertedCode(TerraformStack): type="*" ) ], - resources=["arn:aws:es:${" + data_aws_region_current.name + "}:${" + current.account_id + "}:domain/${" + domain.value + "}/*" + resources=["arn:aws:es:${" + data_aws_region_current.region + "}:${" + current.account_id + "}:domain/${" + domain.value + "}/*" ] ) ] @@ -384,6 +384,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `access_policies` - (Optional) IAM policy document specifying the access policies for the domain. * `advanced_options` - (Optional) Key-value string pairs to specify advanced configuration options. Note that the values for these configuration options must be strings (wrapped in quotes) or they may be wrong and cause a perpetual diff, causing Terraform to want to recreate your OpenSearch domain on every apply. * `advanced_security_options` - (Optional) Configuration block for [fine-grained access control](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/fgac.html). Detailed below. @@ -560,7 +561,6 @@ This resource exports the following attributes in addition to the arguments abov * `endpoint_v2` - V2 domain endpoint that works with both IPv4 and IPv6 addresses, used to submit index, search, and data upload requests. * `dashboard_endpoint` - Domain-specific endpoint for Dashboard without https scheme. * `dashboard_endpoint_v2` - V2 domain endpoint for Dashboard that works with both IPv4 and IPv6 addresses, without https scheme. -* `kibana_endpoint` - (**Deprecated**) Domain-specific endpoint for kibana without https scheme. Use the `dashboard_endpoint` attribute instead. * `tags_all` - Map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). * `vpc_options.0.availability_zones` - If the domain was created inside a VPC, the names of the availability zones the configured `subnet_ids` were created inside. * `vpc_options.0.vpc_id` - If the domain was created inside a VPC, the ID of the VPC. @@ -598,4 +598,4 @@ Using `terraform import`, import OpenSearch domains using the `domain_name`. For % terraform import aws_opensearch_domain.example domain_name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/opensearch_domain_policy.html.markdown b/website/docs/cdktf/python/r/opensearch_domain_policy.html.markdown index d04774b90f04..3c1a585ae676 100644 --- a/website/docs/cdktf/python/r/opensearch_domain_policy.html.markdown +++ b/website/docs/cdktf/python/r/opensearch_domain_policy.html.markdown @@ -63,6 +63,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `access_policies` - (Optional) IAM policy document specifying the access policies for the domain * `domain_name` - (Required) Name of the domain. @@ -77,4 +78,29 @@ This resource exports no additional attributes. * `update` - (Default `180m`) * `delete` - (Default `90m`) - \ No newline at end of file +## Import + +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import OpenSearch Domain Policy using `domain_name` prefixed with `esd-policy-`. 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.opensearch_domain_policy import OpensearchDomainPolicy +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + OpensearchDomainPolicy.generate_config_for_import(self, "example", "esd-policy-tf-test") +``` + +Using `terraform import`, import OpenSearch Domain Policy using `domain_name` prefixed with `esd-policy-`. For example: + +```console +% terraform import aws_opensearch_domain_policy.example esd-policy-tf-test +``` + + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/opensearch_domain_saml_options.html.markdown b/website/docs/cdktf/python/r/opensearch_domain_saml_options.html.markdown index 93214f58b809..e72084abb4c1 100644 --- a/website/docs/cdktf/python/r/opensearch_domain_saml_options.html.markdown +++ b/website/docs/cdktf/python/r/opensearch_domain_saml_options.html.markdown @@ -65,6 +65,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `saml_options` - (Optional) SAML authentication options for an AWS OpenSearch Domain. ### saml_options @@ -120,4 +121,4 @@ Using `terraform import`, import OpenSearch domains using the `domain_name`. For % terraform import aws_opensearch_domain_saml_options.example domain_name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/opensearch_inbound_connection_accepter.html.markdown b/website/docs/cdktf/python/r/opensearch_inbound_connection_accepter.html.markdown index 1a707d150580..a962446bd529 100644 --- a/website/docs/cdktf/python/r/opensearch_inbound_connection_accepter.html.markdown +++ b/website/docs/cdktf/python/r/opensearch_inbound_connection_accepter.html.markdown @@ -40,12 +40,12 @@ class MyConvertedCode(TerraformStack): local_domain_info=OpensearchOutboundConnectionLocalDomainInfo( domain_name=local_domain.domain_name, owner_id=Token.as_string(current.account_id), - region=Token.as_string(data_aws_region_current.name) + region=Token.as_string(data_aws_region_current.region) ), remote_domain_info=OpensearchOutboundConnectionRemoteDomainInfo( domain_name=remote_domain.domain_name, owner_id=Token.as_string(current.account_id), - region=Token.as_string(data_aws_region_current.name) + region=Token.as_string(data_aws_region_current.region) ) ) aws_opensearch_inbound_connection_accepter_foo = @@ -60,6 +60,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `connection_id` - (Required, Forces new resource) Specifies the ID of the connection to accept. ## Attribute Reference @@ -101,4 +102,4 @@ Using `terraform import`, import AWS Opensearch Inbound Connection Accepters usi % terraform import aws_opensearch_inbound_connection_accepter.foo connection-id ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/opensearch_outbound_connection.html.markdown b/website/docs/cdktf/python/r/opensearch_outbound_connection.html.markdown index 719b4814e384..ade86f7f69b1 100644 --- a/website/docs/cdktf/python/r/opensearch_outbound_connection.html.markdown +++ b/website/docs/cdktf/python/r/opensearch_outbound_connection.html.markdown @@ -40,12 +40,12 @@ class MyConvertedCode(TerraformStack): local_domain_info=OpensearchOutboundConnectionLocalDomainInfo( domain_name=local_domain.domain_name, owner_id=Token.as_string(current.account_id), - region=Token.as_string(data_aws_region_current.name) + region=Token.as_string(data_aws_region_current.region) ), remote_domain_info=OpensearchOutboundConnectionRemoteDomainInfo( domain_name=remote_domain.domain_name, owner_id=Token.as_string(current.account_id), - region=Token.as_string(data_aws_region_current.name) + region=Token.as_string(data_aws_region_current.region) ) ) ``` @@ -54,6 +54,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `connection_alias` - (Required, Forces new resource) Specifies the connection alias that will be used by the customer for this connection. * `connection_mode` - (Required, Forces new resource) Specifies the connection mode. Accepted values are `DIRECT` or `VPC_ENDPOINT`. * `accept_connection` - (Optional, Forces new resource) Accepts the connection. @@ -124,4 +125,4 @@ Using `terraform import`, import AWS Opensearch Outbound Connections using the O % terraform import aws_opensearch_outbound_connection.foo connection-id ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/opensearch_package.html.markdown b/website/docs/cdktf/python/r/opensearch_package.html.markdown index a6b15fc99394..24c380dc71cc 100644 --- a/website/docs/cdktf/python/r/opensearch_package.html.markdown +++ b/website/docs/cdktf/python/r/opensearch_package.html.markdown @@ -55,6 +55,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `package_name` - (Required, Forces new resource) Unique name for the package. * `package_type` - (Required, Forces new resource) The type of package. * `package_source` - (Required, Forces new resource) Configuration block for the package source options. @@ -97,4 +98,4 @@ Using `terraform import`, import AWS Opensearch Packages using the Package ID. F % terraform import aws_opensearch_package.example package-id ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/opensearch_package_association.html.markdown b/website/docs/cdktf/python/r/opensearch_package_association.html.markdown index 36de19e85cf8..dee936418ce0 100644 --- a/website/docs/cdktf/python/r/opensearch_package_association.html.markdown +++ b/website/docs/cdktf/python/r/opensearch_package_association.html.markdown @@ -58,6 +58,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `package_id` - (Required, Forces new resource) Internal ID of the package to associate with a domain. * `domain_name` - (Required, Forces new resource) Name of the domain to associate the package with. @@ -74,4 +75,4 @@ This resource exports the following attributes in addition to the arguments abov * `create` - (Default `10m`) * `delete` - (Default `10m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/opensearch_vpc_endpoint.html.markdown b/website/docs/cdktf/python/r/opensearch_vpc_endpoint.html.markdown index 4fd2cba9cab4..8cb629b18df4 100644 --- a/website/docs/cdktf/python/r/opensearch_vpc_endpoint.html.markdown +++ b/website/docs/cdktf/python/r/opensearch_vpc_endpoint.html.markdown @@ -44,6 +44,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `domain_arn` - (Required, Forces new resource) Specifies the Amazon Resource Name (ARN) of the domain to create the endpoint for * `vpc_options` - (Required) Options to specify the subnets and security groups for the endpoint. @@ -92,4 +93,4 @@ Using `terraform import`, import OpenSearch VPC endpoint connections using the ` % terraform import aws_opensearch_vpc_endpoint_connection.example endpoint-id ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/opensearchserverless_access_policy.html.markdown b/website/docs/cdktf/python/r/opensearchserverless_access_policy.html.markdown index 8d63b2599708..f76ffac6b45c 100644 --- a/website/docs/cdktf/python/r/opensearchserverless_access_policy.html.markdown +++ b/website/docs/cdktf/python/r/opensearchserverless_access_policy.html.markdown @@ -137,6 +137,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `description` - (Optional) Description of the policy. Typically used to store information about the permissions defined in the policy. ## Attribute Reference @@ -170,4 +171,4 @@ Using `terraform import`, import OpenSearchServerless Access Policy using the `n % terraform import aws_opensearchserverless_access_policy.example example/data ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/opensearchserverless_collection.html.markdown b/website/docs/cdktf/python/r/opensearchserverless_collection.html.markdown index 2739d3bfca7d..c4de1ba9d9a2 100644 --- a/website/docs/cdktf/python/r/opensearchserverless_collection.html.markdown +++ b/website/docs/cdktf/python/r/opensearchserverless_collection.html.markdown @@ -63,6 +63,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `description` - (Optional) Description of the collection. * `standby_replicas` - (Optional) Indicates whether standby replicas should be used for a collection. One of `ENABLED` or `DISABLED`. Defaults to `ENABLED`. * `tags` - (Optional) A map of tags to assign to the collection. 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. @@ -110,4 +111,4 @@ Using `terraform import`, import OpenSearchServerless Collection using the `id`. % terraform import aws_opensearchserverless_collection.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/opensearchserverless_lifecycle_policy.html.markdown b/website/docs/cdktf/python/r/opensearchserverless_lifecycle_policy.html.markdown index 03031d9b2a7b..6f9c7c7db752 100644 --- a/website/docs/cdktf/python/r/opensearchserverless_lifecycle_policy.html.markdown +++ b/website/docs/cdktf/python/r/opensearchserverless_lifecycle_policy.html.markdown @@ -57,6 +57,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `description` - (Optional) Description of the policy. ## Attribute Reference @@ -90,4 +91,4 @@ Using `terraform import`, import OpenSearch Serverless Lifecycle Policy using th % terraform import aws_opensearchserverless_lifecycle_policy.example example/retention ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/opensearchserverless_security_config.html.markdown b/website/docs/cdktf/python/r/opensearchserverless_security_config.html.markdown index 198ceecbd995..29af069fb485 100644 --- a/website/docs/cdktf/python/r/opensearchserverless_security_config.html.markdown +++ b/website/docs/cdktf/python/r/opensearchserverless_security_config.html.markdown @@ -30,9 +30,9 @@ class MyConvertedCode(TerraformStack): super().__init__(scope, name) OpensearchserverlessSecurityConfig(self, "example", name="example", - saml_options=[{ - "metadata": Token.as_string(Fn.file("${path.module}/idp-metadata.xml")) - } + saml_options=[OpensearchserverlessSecurityConfigSamlOptions( + metadata=Token.as_string(Fn.file("${path.module}/idp-metadata.xml")) + ) ], type="saml" ) @@ -48,6 +48,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `description` - (Optional) Description of the security configuration. ### saml_options @@ -88,4 +89,4 @@ Using `terraform import`, import OpenSearchServerless Access Policy using the `n % terraform import aws_opensearchserverless_security_config.example saml/123456789012/example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/opensearchserverless_security_policy.html.markdown b/website/docs/cdktf/python/r/opensearchserverless_security_policy.html.markdown index fa249a08e948..c7036ddfed73 100644 --- a/website/docs/cdktf/python/r/opensearchserverless_security_policy.html.markdown +++ b/website/docs/cdktf/python/r/opensearchserverless_security_policy.html.markdown @@ -234,6 +234,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `description` - (Optional) Description of the policy. Typically used to store information about the permissions defined in the policy. ## Attribute Reference @@ -267,4 +268,4 @@ Using `terraform import`, import OpenSearchServerless Security Policy using the % terraform import aws_opensearchserverless_security_policy.example example/encryption ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/opensearchserverless_vpc_endpoint.html.markdown b/website/docs/cdktf/python/r/opensearchserverless_vpc_endpoint.html.markdown index ee381da9caa8..5998c1f069fb 100644 --- a/website/docs/cdktf/python/r/opensearchserverless_vpc_endpoint.html.markdown +++ b/website/docs/cdktf/python/r/opensearchserverless_vpc_endpoint.html.markdown @@ -45,6 +45,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `security_group_ids` - (Optional) One or more security groups that define the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint. Up to 5 security groups can be provided. ## Attribute Reference @@ -86,4 +87,4 @@ Using `terraform import`, import OpenSearchServerless Vpc Endpointa using the `i % terraform import aws_opensearchserverless_vpc_endpoint.example vpce-8012925589 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/osis_pipeline.html.markdown b/website/docs/cdktf/python/r/osis_pipeline.html.markdown index 72846bdeaaa3..73129822c045 100644 --- a/website/docs/cdktf/python/r/osis_pipeline.html.markdown +++ b/website/docs/cdktf/python/r/osis_pipeline.html.markdown @@ -49,7 +49,7 @@ class MyConvertedCode(TerraformStack): aws_osis_pipeline_example = OsisPipeline(self, "example_2", max_units=1, min_units=1, - pipeline_configuration_body="version: \"2\"\nexample-pipeline:\n source:\n http:\n path: \"/example\"\n sink:\n - s3:\n aws:\n sts_role_arn: \"${" + example.arn + "}\"\n region: \"${" + current.name + "}\"\n bucket: \"example\"\n threshold:\n event_collect_timeout: \"60s\"\n codec:\n ndjson:\n\n", + pipeline_configuration_body="version: \"2\"\nexample-pipeline:\n source:\n http:\n path: \"/example\"\n sink:\n - s3:\n aws:\n sts_role_arn: \"${" + example.arn + "}\"\n region: \"${" + current.region + "}\"\n bucket: \"example\"\n threshold:\n event_collect_timeout: \"60s\"\n codec:\n ndjson:\n\n", pipeline_name="example" ) # This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match. @@ -89,6 +89,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `buffer_options` - (Optional) Key-value pairs to configure persistent buffering for the pipeline. See [`buffer_options`](#buffer_options) below. * `encryption_at_rest_options` - (Optional) Key-value pairs to configure encryption for data that is written to a persistent buffer. See [`encryption_at_rest_options`](#encryption_at_rest_options) below. * `log_publishing_options` - (Optional) Key-value pairs to configure log publishing. See [`log_publishing_options`](#log_publishing_options) below. @@ -159,4 +160,4 @@ Using `terraform import`, import OpenSearch Ingestion Pipeline using the `id`. F % terraform import aws_osis_pipeline.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/paymentcryptography_key.html.markdown b/website/docs/cdktf/python/r/paymentcryptography_key.html.markdown index 106b8d9acbe2..2ffe096ca303 100644 --- a/website/docs/cdktf/python/r/paymentcryptography_key.html.markdown +++ b/website/docs/cdktf/python/r/paymentcryptography_key.html.markdown @@ -29,18 +29,18 @@ class MyConvertedCode(TerraformStack): super().__init__(scope, name) PaymentcryptographyKey(self, "test", exportable=True, - key_attributes=[{ - "key_algorithm": "TDES_3KEY", - "key_class": "SYMMETRIC_KEY", - "key_modes_of_use": [{ - "decrypt": True, - "encrypt": True, - "unwrap": True, - "wrap": True - } + key_attributes=[PaymentcryptographyKeyKeyAttributes( + key_algorithm="TDES_3KEY", + key_class="SYMMETRIC_KEY", + key_modes_of_use=[PaymentcryptographyKeyKeyAttributesKeyModesOfUse( + decrypt=True, + encrypt=True, + unwrap=True, + wrap=True + ) ], - "key_usage": "TR31_P0_PIN_ENCRYPTION_KEY" - } + key_usage="TR31_P0_PIN_ENCRYPTION_KEY" + ) ] ) ``` @@ -54,6 +54,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `enabled` - (Optional) Whether to enable the key. * `key_check_value_algorithm` - (Optional) Algorithm that AWS Payment Cryptography uses to calculate the key check value (KCV). * `tags` - (Optional) Map of tags assigned to the WorkSpaces Connection Alias. 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. @@ -71,6 +72,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `decrypt` - (Optional) Whether an AWS Payment Cryptography key can be used to decrypt data. * `derive_key` - (Optional) Whether an AWS Payment Cryptography key can be used to derive new keys. * `encrypt` - (Optional) Whether an AWS Payment Cryptography key can be used to encrypt data. @@ -124,4 +126,4 @@ Using `terraform import`, import Payment Cryptography Control Plane Key using th % terraform import aws_paymentcryptography_key.example arn:aws:payment-cryptography:us-east-1:123456789012:key/qtbojf64yshyvyzf ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/paymentcryptography_key_alias.html.markdown b/website/docs/cdktf/python/r/paymentcryptography_key_alias.html.markdown index 98f5b4cb8e3e..a4383ea8a40d 100644 --- a/website/docs/cdktf/python/r/paymentcryptography_key_alias.html.markdown +++ b/website/docs/cdktf/python/r/paymentcryptography_key_alias.html.markdown @@ -30,18 +30,18 @@ class MyConvertedCode(TerraformStack): super().__init__(scope, name) test = PaymentcryptographyKey(self, "test", exportable=True, - key_attributes=[{ - "key_algorithm": "TDES_3KEY", - "key_class": "SYMMETRIC_KEY", - "key_modes_of_use": [{ - "decrypt": True, - "encrypt": True, - "unwrap": True, - "wrap": True - } + key_attributes=[PaymentcryptographyKeyKeyAttributes( + key_algorithm="TDES_3KEY", + key_class="SYMMETRIC_KEY", + key_modes_of_use=[PaymentcryptographyKeyKeyAttributesKeyModesOfUse( + decrypt=True, + encrypt=True, + unwrap=True, + wrap=True + ) ], - "key_usage": "TR31_P0_PIN_ENCRYPTION_KEY" - } + key_usage="TR31_P0_PIN_ENCRYPTION_KEY" + ) ] ) aws_paymentcryptography_key_alias_test = PaymentcryptographyKeyAlias(self, "test_1", @@ -60,6 +60,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `key_arn` - (Optional) ARN of the key. ## Attribute Reference @@ -91,4 +92,4 @@ Using `terraform import`, import Payment Cryptography Control Plane Key Alias us % terraform import aws_paymentcryptography_key_alias.example alias/4681482429376900170 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/pinpoint_adm_channel.html.markdown b/website/docs/cdktf/python/r/pinpoint_adm_channel.html.markdown index 8190d1489860..2eaed1930b75 100644 --- a/website/docs/cdktf/python/r/pinpoint_adm_channel.html.markdown +++ b/website/docs/cdktf/python/r/pinpoint_adm_channel.html.markdown @@ -43,6 +43,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `application_id` - (Required) The application ID. * `client_id` - (Required) Client ID (part of OAuth Credentials) obtained via Amazon Developer Account. * `client_secret` - (Required) Client Secret (part of OAuth Credentials) obtained via Amazon Developer Account. @@ -77,4 +78,4 @@ Using `terraform import`, import Pinpoint ADM Channel using the `application-id` % terraform import aws_pinpoint_adm_channel.channel application-id ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/pinpoint_apns_channel.html.markdown b/website/docs/cdktf/python/r/pinpoint_apns_channel.html.markdown index aa83950a652e..dc4ce9fd49fc 100644 --- a/website/docs/cdktf/python/r/pinpoint_apns_channel.html.markdown +++ b/website/docs/cdktf/python/r/pinpoint_apns_channel.html.markdown @@ -42,6 +42,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `application_id` - (Required) The application ID. * `enabled` - (Optional) Whether the channel is enabled or disabled. Defaults to `true`. * `default_authentication_method` - (Optional) The default authentication method used for APNs. @@ -92,4 +93,4 @@ Using `terraform import`, import Pinpoint APNs Channel using the `application-id % terraform import aws_pinpoint_apns_channel.apns application-id ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/pinpoint_apns_sandbox_channel.html.markdown b/website/docs/cdktf/python/r/pinpoint_apns_sandbox_channel.html.markdown index 9fe79ab19c2f..a3ee9b6c5500 100644 --- a/website/docs/cdktf/python/r/pinpoint_apns_sandbox_channel.html.markdown +++ b/website/docs/cdktf/python/r/pinpoint_apns_sandbox_channel.html.markdown @@ -42,6 +42,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `application_id` - (Required) The application ID. * `enabled` - (Optional) Whether the channel is enabled or disabled. Defaults to `true`. * `default_authentication_method` - (Optional) The default authentication method used for APNs Sandbox. @@ -92,4 +93,4 @@ Using `terraform import`, import Pinpoint APNs Sandbox Channel using the `applic % terraform import aws_pinpoint_apns_sandbox_channel.apns_sandbox application-id ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/pinpoint_apns_voip_channel.html.markdown b/website/docs/cdktf/python/r/pinpoint_apns_voip_channel.html.markdown index 6b0550a5465e..92cf41bfcdcf 100644 --- a/website/docs/cdktf/python/r/pinpoint_apns_voip_channel.html.markdown +++ b/website/docs/cdktf/python/r/pinpoint_apns_voip_channel.html.markdown @@ -42,6 +42,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `application_id` - (Required) The application ID. * `enabled` - (Optional) Whether the channel is enabled or disabled. Defaults to `true`. * `default_authentication_method` - (Optional) The default authentication method used for APNs. @@ -92,4 +93,4 @@ Using `terraform import`, import Pinpoint APNs VoIP Channel using the `applicati % terraform import aws_pinpoint_apns_voip_channel.apns_voip application-id ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/pinpoint_apns_voip_sandbox_channel.html.markdown b/website/docs/cdktf/python/r/pinpoint_apns_voip_sandbox_channel.html.markdown index 238d15274cfd..f2c3ccafc0b3 100644 --- a/website/docs/cdktf/python/r/pinpoint_apns_voip_sandbox_channel.html.markdown +++ b/website/docs/cdktf/python/r/pinpoint_apns_voip_sandbox_channel.html.markdown @@ -42,6 +42,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `application_id` - (Required) The application ID. * `enabled` - (Optional) Whether the channel is enabled or disabled. Defaults to `true`. * `default_authentication_method` - (Optional) The default authentication method used for APNs. @@ -92,4 +93,4 @@ Using `terraform import`, import Pinpoint APNs VoIP Sandbox Channel using the `a % terraform import aws_pinpoint_apns_voip_sandbox_channel.apns_voip_sandbox application-id ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/pinpoint_app.html.markdown b/website/docs/cdktf/python/r/pinpoint_app.html.markdown index b6dffcfc02ae..4216adfda428 100644 --- a/website/docs/cdktf/python/r/pinpoint_app.html.markdown +++ b/website/docs/cdktf/python/r/pinpoint_app.html.markdown @@ -42,6 +42,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Optional) The application name. By default generated by Terraform * `name_prefix` - (Optional) The name of the Pinpoint application. Conflicts with `name` * `campaign_hook` - (Optional) Specifies settings for invoking an AWS Lambda function that customizes a segment for a campaign @@ -100,4 +101,4 @@ Using `terraform import`, import Pinpoint App using the `application-id`. For ex % terraform import aws_pinpoint_app.name application-id ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/pinpoint_baidu_channel.html.markdown b/website/docs/cdktf/python/r/pinpoint_baidu_channel.html.markdown index 20f3dc7b4757..c5f60b3a496c 100644 --- a/website/docs/cdktf/python/r/pinpoint_baidu_channel.html.markdown +++ b/website/docs/cdktf/python/r/pinpoint_baidu_channel.html.markdown @@ -42,6 +42,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `application_id` - (Required) The application ID. * `enabled` - (Optional) Specifies whether to enable the channel. Defaults to `true`. * `api_key` - (Required) Platform credential API key from Baidu. @@ -76,4 +77,4 @@ Using `terraform import`, import Pinpoint Baidu Channel using the `application-i % terraform import aws_pinpoint_baidu_channel.channel application-id ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/pinpoint_email_channel.html.markdown b/website/docs/cdktf/python/r/pinpoint_email_channel.html.markdown index 9339a950267d..94aad11c656f 100644 --- a/website/docs/cdktf/python/r/pinpoint_email_channel.html.markdown +++ b/website/docs/cdktf/python/r/pinpoint_email_channel.html.markdown @@ -77,6 +77,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `application_id` - (Required) The application ID. * `enabled` - (Optional) Whether the channel is enabled or disabled. Defaults to `true`. * `configuration_set` - (Optional) The ARN of the Amazon SES configuration set that you want to apply to messages that you send through the channel. @@ -116,4 +117,4 @@ Using `terraform import`, import Pinpoint Email Channel using the `application-i % terraform import aws_pinpoint_email_channel.email application-id ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/pinpoint_email_template.markdown b/website/docs/cdktf/python/r/pinpoint_email_template.markdown index f93943f01a2f..0a8b74bc392e 100644 --- a/website/docs/cdktf/python/r/pinpoint_email_template.markdown +++ b/website/docs/cdktf/python/r/pinpoint_email_template.markdown @@ -43,8 +43,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `template_name` - (Required) name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive. * `email_template` - (Required) Specifies the content and settings for a message template that can be used in messages that are sent through the email channel. See [Email Template](#email-template) @@ -95,4 +96,4 @@ Using `terraform import`, import Pinpoint Email Template using the `template_nam % terraform import aws_pinpoint_email_template.reset template_name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/pinpoint_event_stream.html.markdown b/website/docs/cdktf/python/r/pinpoint_event_stream.html.markdown index 9e9bff797f9b..1d02d40a7ab5 100644 --- a/website/docs/cdktf/python/r/pinpoint_event_stream.html.markdown +++ b/website/docs/cdktf/python/r/pinpoint_event_stream.html.markdown @@ -77,6 +77,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `application_id` - (Required) The application ID. * `destination_stream_arn` - (Required) The Amazon Resource Name (ARN) of the Amazon Kinesis stream or Firehose delivery stream to which you want to publish events. * `role_arn` - (Required) The IAM role that authorizes Amazon Pinpoint to publish events to the stream in your account. @@ -110,4 +111,4 @@ Using `terraform import`, import Pinpoint Event Stream using the `application-id % terraform import aws_pinpoint_event_stream.stream application-id ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/pinpoint_gcm_channel.html.markdown b/website/docs/cdktf/python/r/pinpoint_gcm_channel.html.markdown index 52afba56e800..7ea6e9936593 100644 --- a/website/docs/cdktf/python/r/pinpoint_gcm_channel.html.markdown +++ b/website/docs/cdktf/python/r/pinpoint_gcm_channel.html.markdown @@ -42,6 +42,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `application_id` - (Required) The application ID. * `api_key` - (Required) Platform credential API key from Google. * `enabled` - (Optional) Whether the channel is enabled or disabled. Defaults to `true`. @@ -75,4 +76,4 @@ Using `terraform import`, import Pinpoint GCM Channel using the `application-id` % terraform import aws_pinpoint_gcm_channel.gcm application-id ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/pinpoint_sms_channel.html.markdown b/website/docs/cdktf/python/r/pinpoint_sms_channel.html.markdown index 9f846be149ef..0699feac387d 100644 --- a/website/docs/cdktf/python/r/pinpoint_sms_channel.html.markdown +++ b/website/docs/cdktf/python/r/pinpoint_sms_channel.html.markdown @@ -37,6 +37,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `application_id` - (Required) ID of the application. * `enabled` - (Optional) Whether the channel is enabled or disabled. By default, it is set to `true`. * `sender_id` - (Optional) Identifier of the sender for your messages. @@ -74,4 +75,4 @@ Using `terraform import`, import the Pinpoint SMS Channel using the `application % terraform import aws_pinpoint_sms_channel.sms application-id ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/pinpointsmsvoicev2_configuration_set.html.markdown b/website/docs/cdktf/python/r/pinpointsmsvoicev2_configuration_set.html.markdown index c30e15475cd4..49f1c37da50a 100644 --- a/website/docs/cdktf/python/r/pinpointsmsvoicev2_configuration_set.html.markdown +++ b/website/docs/cdktf/python/r/pinpointsmsvoicev2_configuration_set.html.markdown @@ -37,6 +37,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) The name of the configuration set. * `default_sender_id` - (Optional) The default sender ID to use for this configuration set. * `default_message_type` - (Optional) The default message type. Must either be "TRANSACTIONAL" or "PROMOTIONAL" @@ -74,4 +75,4 @@ Using `terraform import`, import configuration sets using the `name`. For exampl % terraform import aws_pinpointsmsvoicev2_configuration_set.example example-configuration-set ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/pinpointsmsvoicev2_opt_out_list.html.markdown b/website/docs/cdktf/python/r/pinpointsmsvoicev2_opt_out_list.html.markdown index 321dd9d65118..b91136b6124e 100644 --- a/website/docs/cdktf/python/r/pinpointsmsvoicev2_opt_out_list.html.markdown +++ b/website/docs/cdktf/python/r/pinpointsmsvoicev2_opt_out_list.html.markdown @@ -35,6 +35,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) The name of the opt-out list. * `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. @@ -70,4 +71,4 @@ Using `terraform import`, import opt-out lists using the `name`. For example: % terraform import aws_pinpointsmsvoicev2_opt_out_list.example example-opt-out-list ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/pinpointsmsvoicev2_phone_number.html.markdown b/website/docs/cdktf/python/r/pinpointsmsvoicev2_phone_number.html.markdown index 681b5994fbf4..3b69c0170229 100644 --- a/website/docs/cdktf/python/r/pinpointsmsvoicev2_phone_number.html.markdown +++ b/website/docs/cdktf/python/r/pinpointsmsvoicev2_phone_number.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `deletion_protection_enabled` - (Optional) By default this is set to `false`. When set to true the phone number can’t be deleted. * `iso_country_code` - (Required) The two-character code, in ISO 3166-1 alpha-2 format, for the country or region. * `message_type` - (Required) The type of message. Valid values are `TRANSACTIONAL` for messages that are critical or time-sensitive and `PROMOTIONAL` for messages that aren’t critical or time-sensitive. @@ -85,4 +86,4 @@ Using `terraform import`, import phone numbers using the `id`. For example: % terraform import aws_pinpointsmsvoicev2_phone_number.example phone-abcdef0123456789abcdef0123456789 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/pipes_pipe.html.markdown b/website/docs/cdktf/python/r/pipes_pipe.html.markdown index 6154d2055528..affbe8d49046 100644 --- a/website/docs/cdktf/python/r/pipes_pipe.html.markdown +++ b/website/docs/cdktf/python/r/pipes_pipe.html.markdown @@ -250,6 +250,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `description` - (Optional) A description of the pipe. At most 512 characters. * `desired_state` - (Optional) The state the pipe should be in. One of: `RUNNING`, `STOPPED`. * `enrichment` - (Optional) Enrichment resource of the pipe (typically an ARN). Read more about enrichment in the [User Guide](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes.html#pipes-enrichment). @@ -659,4 +660,4 @@ Using `terraform import`, import pipes using the `name`. For example: % terraform import aws_pipes_pipe.example my-pipe ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/placement_group.html.markdown b/website/docs/cdktf/python/r/placement_group.html.markdown index c7667cf11714..341d077dfccc 100644 --- a/website/docs/cdktf/python/r/placement_group.html.markdown +++ b/website/docs/cdktf/python/r/placement_group.html.markdown @@ -37,6 +37,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) The name of the placement group. * `partition_count` - (Optional) The number of partitions to create in the placement group. Can only be specified when the `strategy` is set to @@ -80,4 +81,4 @@ Using `terraform import`, import placement groups using the `name`. For example: % terraform import aws_placement_group.prod_pg production-placement-group ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/prometheus_alert_manager_definition.html.markdown b/website/docs/cdktf/python/r/prometheus_alert_manager_definition.html.markdown index 3d549dcb218a..c3664b58e966 100644 --- a/website/docs/cdktf/python/r/prometheus_alert_manager_definition.html.markdown +++ b/website/docs/cdktf/python/r/prometheus_alert_manager_definition.html.markdown @@ -41,6 +41,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `workspace_id` - (Required) ID of the prometheus workspace the alert manager definition should be linked to * `definition` - (Required) the alert manager definition that you want to be applied. See more [in AWS Docs](https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-alert-manager.html). @@ -73,4 +74,4 @@ Using `terraform import`, import the prometheus alert manager definition using t % terraform import aws_prometheus_alert_manager_definition.demo ws-C6DCB907-F2D7-4D96-957B-66691F865D8B ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/prometheus_query_logging_configuration.html.markdown b/website/docs/cdktf/python/r/prometheus_query_logging_configuration.html.markdown new file mode 100644 index 000000000000..6dee0decf14c --- /dev/null +++ b/website/docs/cdktf/python/r/prometheus_query_logging_configuration.html.markdown @@ -0,0 +1,113 @@ +--- +subcategory: "AMP (Managed Prometheus)" +layout: "aws" +page_title: "AWS: aws_prometheus_query_logging_configuration" +description: |- + Manages an Amazon Managed Service for Prometheus (AMP) Query Logging Configuration. +--- + + + +# Resource: aws_prometheus_query_logging_configuration + +Manages an Amazon Managed Service for Prometheus (AMP) Query Logging Configuration. + +## 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 Token, TerraformStack +# +# Provider bindings are generated by running `cdktf get`. +# See https://cdk.tf/provider-generation for more details. +# +from imports.aws.cloudwatch_log_group import CloudwatchLogGroup +from imports.aws.prometheus_query_logging_configuration import PrometheusQueryLoggingConfiguration +from imports.aws.prometheus_workspace import PrometheusWorkspace +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + example = CloudwatchLogGroup(self, "example", + name="/aws/prometheus/query-logs/example" + ) + aws_prometheus_workspace_example = PrometheusWorkspace(self, "example_1", + alias="example" + ) + # 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_prometheus_workspace_example.override_logical_id("example") + aws_prometheus_query_logging_configuration_example = + PrometheusQueryLoggingConfiguration(self, "example_2", + destination=[PrometheusQueryLoggingConfigurationDestination( + cloudwatch_logs=[PrometheusQueryLoggingConfigurationDestinationCloudwatchLogs( + log_group_arn="${" + example.arn + "}:*" + ) + ], + filters=[PrometheusQueryLoggingConfigurationDestinationFilters( + qsp_threshold=1000 + ) + ] + ) + ], + workspace_id=Token.as_string(aws_prometheus_workspace_example.id) + ) + # 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_prometheus_query_logging_configuration_example.override_logical_id("example") +``` + +## Argument Reference + +This resource supports the following arguments: + +* `destination` - (Required) Configuration block for the logging destinations. See [`destinations`](#destinations). +* `workspace_id` - (Required) The ID of the AMP workspace for which to configure query logging. + +The following arguments are optional: + +* `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). + +### `destination` + +* `cloudwatch_logs` - (Required) Configuration block for CloudWatch Logs destination. See [`cloudwatch_logs`](#cloudwatch_logs). +* `filters` - (Required) A list of filter configurations that specify which logs should be sent to the destination. See [`filters`](#filters). + +#### `cloudwatch_logs` + +* `log_group_arn` - (Required) The ARN of the CloudWatch log group to which query logs will be sent. + +#### `filters` + +* `qsp_threshold` - (Required) The Query Samples Processed (QSP) threshold above which queries will be logged. Queries processing more samples than this threshold will be captured in logs. + +## 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 the Query Logging Configuration using the workspace ID. 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.prometheus_query_logging_configuration import PrometheusQueryLoggingConfiguration +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + PrometheusQueryLoggingConfiguration.generate_config_for_import(self, "example", "ws-12345678-90ab-cdef-1234-567890abcdef") +``` + +## Timeouts + +[Configuration options](https://developer.hashicorp.com/terraform/language/resources/syntax#operation-timeouts): + +- `create` - (Default `5m`) +- `update` - (Default `5m`) +- `delete` - (Default `5m`) + + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/prometheus_rule_group_namespace.html.markdown b/website/docs/cdktf/python/r/prometheus_rule_group_namespace.html.markdown index e8369598f0a8..df2ec79e03b0 100644 --- a/website/docs/cdktf/python/r/prometheus_rule_group_namespace.html.markdown +++ b/website/docs/cdktf/python/r/prometheus_rule_group_namespace.html.markdown @@ -42,6 +42,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `data` - (Required) the rule group namespace data that you want to be applied. See more [in AWS Docs](https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-Ruler.html). * `name` - (Required) The name of the rule group namespace. * `tags` - (Optional) Map of tags assigned to the resource. If configured with a provider [`default_tags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. @@ -79,4 +80,4 @@ Using `terraform import`, import the prometheus rule group namespace using the a % terraform import aws_prometheus_rule_group_namespace.demo arn:aws:aps:us-west-2:123456789012:rulegroupsnamespace/IDstring/namespace_name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/prometheus_scraper.html.markdown b/website/docs/cdktf/python/r/prometheus_scraper.html.markdown index f17e92fd2920..1b475a239037 100644 --- a/website/docs/cdktf/python/r/prometheus_scraper.html.markdown +++ b/website/docs/cdktf/python/r/prometheus_scraper.html.markdown @@ -209,14 +209,16 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `destination` - (Required) Configuration block for the managed scraper to send metrics to. See [`destination`](#destination). * `scrape_configuration` - (Required) The configuration file to use in the new scraper. For more information, see [Scraper configuration](https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-collector-how-to.html#AMP-collector-configuration). * `source` - (Required) Configuration block to specify where the managed scraper will collect metrics from. See [`source`](#source). The following arguments are optional: +* `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). * `alias` - (Optional) a name to associate with the managed scraper. This is for your use, and does not need to be unique. * `role_configuration` - (Optional) Configuration block to enable writing to an Amazon Managed Service for Prometheus workspace in a different account. See [`role_configuration`](#role_configuration) below. @@ -287,4 +289,4 @@ For example: % terraform import aws_prometheus_scraper.example s-0123abc-0000-0123-a000-000000000000 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/prometheus_workspace.html.markdown b/website/docs/cdktf/python/r/prometheus_workspace.html.markdown index 43529f9aa0c5..fa31c9703383 100644 --- a/website/docs/cdktf/python/r/prometheus_workspace.html.markdown +++ b/website/docs/cdktf/python/r/prometheus_workspace.html.markdown @@ -92,6 +92,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `alias` - (Optional) The alias of the prometheus workspace. See more [in AWS Docs](https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-onboard-create-workspace.html). * `kms_key_arn` - (Optional) The ARN for the KMS encryption key. If this argument is not provided, then the AWS owned encryption key will be used to encrypt the data in the workspace. See more [in AWS Docs](https://docs.aws.amazon.com/prometheus/latest/userguide/encryption-at-rest-Amazon-Service-Prometheus.html) * `logging_configuration` - (Optional) Logging configuration for the workspace. See [Logging Configuration](#logging-configuration) below for details. @@ -137,4 +138,4 @@ Using `terraform import`, import AMP Workspaces using the identifier. For exampl % terraform import aws_prometheus_workspace.demo ws-C6DCB907-F2D7-4D96-957B-66691F865D8B ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/prometheus_workspace_configuration.html.markdown b/website/docs/cdktf/python/r/prometheus_workspace_configuration.html.markdown index 03b6bddcd64b..44dd8a0464bf 100644 --- a/website/docs/cdktf/python/r/prometheus_workspace_configuration.html.markdown +++ b/website/docs/cdktf/python/r/prometheus_workspace_configuration.html.markdown @@ -23,33 +23,31 @@ 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 PrometheusWorkspaceConfiguration from imports.aws.prometheus_workspace import PrometheusWorkspace +from imports.aws.prometheus_workspace_configuration import PrometheusWorkspaceConfiguration class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) example = PrometheusWorkspace(self, "example") aws_prometheus_workspace_configuration_example = PrometheusWorkspaceConfiguration(self, "example_1", - limits_per_label_set=[{ - "label_set": [{ + limits_per_label_set=[PrometheusWorkspaceConfigurationLimitsPerLabelSet( + label_set={ "env": "dev" - } - ], - "limits": [{ - "max_series": 100000 - } + }, + limits=[PrometheusWorkspaceConfigurationLimitsPerLabelSetLimits( + max_series=100000 + ) ] - }, { - "label_set": [{ + ), PrometheusWorkspaceConfigurationLimitsPerLabelSet( + label_set={ "env": "prod" - } - ], - "limits": [{ - "max_series": 400000 - } + }, + limits=[PrometheusWorkspaceConfigurationLimitsPerLabelSetLimits( + max_series=400000 + ) ] - } + ) ], retention_period_in_days=60, workspace_id=example.id @@ -72,21 +70,21 @@ 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 PrometheusWorkspaceConfiguration from imports.aws.prometheus_workspace import PrometheusWorkspace +from imports.aws.prometheus_workspace_configuration import PrometheusWorkspaceConfiguration class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) example = PrometheusWorkspace(self, "example") aws_prometheus_workspace_configuration_example = PrometheusWorkspaceConfiguration(self, "example_1", - limits_per_label_set=[{ - "label_set": [{}], - "limits": [{ - "max_series": 50000 - } + limits_per_label_set=[PrometheusWorkspaceConfigurationLimitsPerLabelSet( + label_set={}, + limits=[PrometheusWorkspaceConfigurationLimitsPerLabelSetLimits( + max_series=50000 + ) ] - } + ) ], workspace_id=example.id ) @@ -102,15 +100,15 @@ The following arguments are required: The following arguments are optional: -* `retention_period_in_days` - (Optional) Number of days to retain metric data in the workspace. * `limits_per_label_set` - (Optional) Configuration block for setting limits on metrics with specific label sets. Detailed below. +* `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). +* `retention_period_in_days` - (Optional) Number of days to retain metric data in the workspace. ### `limits_per_label_set` The `limits_per_label_set` configuration block supports the following arguments: * `label_set` - (Required) Map of label key-value pairs that identify the metrics to which the limits apply. An empty map represents the default bucket for metrics that don't match any other label set. - * `limits` - (Required) Configuration block for the limits to apply to the specified label set. Detailed below. #### `limits` @@ -142,7 +140,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 PrometheusWorkspaceConfiguration +from imports.aws.prometheus_workspace_configuration import PrometheusWorkspaceConfiguration class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) @@ -155,4 +153,4 @@ Using `terraform import`, import AMP (Managed Prometheus) Workspace Configuratio % terraform import aws_prometheus_workspace_configuration.example ws-12345678-abcd-1234-abcd-123456789012 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/proxy_protocol_policy.html.markdown b/website/docs/cdktf/python/r/proxy_protocol_policy.html.markdown index 0154d645efbf..f83c8707c75d 100644 --- a/website/docs/cdktf/python/r/proxy_protocol_policy.html.markdown +++ b/website/docs/cdktf/python/r/proxy_protocol_policy.html.markdown @@ -53,6 +53,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `load_balancer` - (Required) The load balancer to which the policy should be attached. * `instance_ports` - (Required) List of instance ports to which the policy @@ -65,4 +66,4 @@ This resource exports the following attributes in addition to the arguments abov * `id` - The ID of the policy. * `load_balancer` - The load balancer to which the policy is attached. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/qbusiness_application.html.markdown b/website/docs/cdktf/python/r/qbusiness_application.html.markdown index 10f7ad931355..a4b871820907 100644 --- a/website/docs/cdktf/python/r/qbusiness_application.html.markdown +++ b/website/docs/cdktf/python/r/qbusiness_application.html.markdown @@ -49,6 +49,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `description` - (Optional) Description of the Amazon Q application. * `encryption_configuration` - (Optional) Information about encryption configuration. See [`encryption_configuration`](#encryption_configuration) below. @@ -102,4 +103,4 @@ Using `terraform import`, import a Q Business Application using the `id`. For ex % terraform import aws_qbusiness_application.example id-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/qldb_ledger.html.markdown b/website/docs/cdktf/python/r/qldb_ledger.html.markdown index 57cb44dca132..1c4741adc655 100644 --- a/website/docs/cdktf/python/r/qldb_ledger.html.markdown +++ b/website/docs/cdktf/python/r/qldb_ledger.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `deletion_protection` - (Optional) The deletion protection for the QLDB Ledger instance. By default it is `true`. To delete this resource via Terraform, this value must be configured to `false` and applied first before attempting deletion. * `kms_key` - (Optional) The key in AWS Key Management Service (AWS KMS) to use for encryption of data at rest in the ledger. For more information, see the [AWS documentation](https://docs.aws.amazon.com/qldb/latest/developerguide/encryption-at-rest.html). Valid values are `"AWS_OWNED_KMS_KEY"` to use an AWS KMS key that is owned and managed by AWS on your behalf, or the ARN of a valid symmetric customer managed KMS key. * `name` - (Optional) The friendly name for the QLDB Ledger instance. By default generated by Terraform. @@ -84,4 +85,4 @@ Using `terraform import`, import QLDB Ledgers using the `name`. For example: % terraform import aws_qldb_ledger.sample-ledger sample-ledger ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/qldb_stream.html.markdown b/website/docs/cdktf/python/r/qldb_stream.html.markdown index beac25f14243..2c1788cfebea 100644 --- a/website/docs/cdktf/python/r/qldb_stream.html.markdown +++ b/website/docs/cdktf/python/r/qldb_stream.html.markdown @@ -45,6 +45,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `exclusive_end_time` - (Optional) The exclusive date and time that specifies when the stream ends. If you don't define this parameter, the stream runs indefinitely until you cancel it. It must be in ISO 8601 date and time format and in Universal Coordinated Time (UTC). For example: `"2019-06-13T21:36:34Z"`. * `inclusive_start_time` - (Required) The inclusive start date and time from which to start streaming journal data. This parameter must be in ISO 8601 date and time format and in Universal Coordinated Time (UTC). For example: `"2019-06-13T21:36:34Z"`. This cannot be in the future and must be before `exclusive_end_time`. If you provide a value that is before the ledger's `CreationDateTime`, QLDB effectively defaults it to the ledger's `CreationDateTime`. * `kinesis_configuration` - (Required) The configuration settings of the Kinesis Data Streams destination for your stream request. Documented below. @@ -75,4 +76,4 @@ This resource exports the following attributes in addition to the arguments abov - `create` - (Default `8m`) - `delete` - (Default `5m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/quicksight_account_settings.html.markdown b/website/docs/cdktf/python/r/quicksight_account_settings.html.markdown index e55a31958322..96b64ff74f5c 100644 --- a/website/docs/cdktf/python/r/quicksight_account_settings.html.markdown +++ b/website/docs/cdktf/python/r/quicksight_account_settings.html.markdown @@ -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 QuicksightAccountSettings +from imports.aws.quicksight_account_settings import QuicksightAccountSettings from imports.aws.quicksight_account_subscription import QuicksightAccountSubscription class MyConvertedCode(TerraformStack): def __init__(self, scope, name): @@ -45,14 +45,13 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `aws_account_id` - (Optional, Forces new resource) AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider. * `default_namespace` - (Optional) The default namespace for this Amazon Web Services account. Currently, the default is `default`. * `termination_protection_enabled` - (Optional) A boolean value that determines whether or not an Amazon QuickSight account can be deleted. If `true`, it does not allow the account to be deleted and results in an error message if a user tries to make a DeleteAccountSubscription request. If `false`, it will allow the account to be deleted. ## Attribute Reference -This resource exports the following attributes in addition to the arguments above: - -* `aws_account_id` - The ID for the AWS account that contains the settings. +This resource exports no additional attributes. ## Import @@ -66,7 +65,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 QuicksightAccountSettings +from imports.aws.quicksight_account_settings import QuicksightAccountSettings class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) @@ -79,4 +78,4 @@ Using `terraform import`, import QuickSight Account Settings using the AWS accou % terraform import aws_quicksight_account_settings.example "012345678901" ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/quicksight_account_subscription.html.markdown b/website/docs/cdktf/python/r/quicksight_account_subscription.html.markdown index 6c09d2d9b4c7..3dae325d6e27 100644 --- a/website/docs/cdktf/python/r/quicksight_account_subscription.html.markdown +++ b/website/docs/cdktf/python/r/quicksight_account_subscription.html.markdown @@ -50,7 +50,7 @@ The following arguments are optional: * `active_directory_name` - (Optional) Name of your Active Directory. This field is required if `ACTIVE_DIRECTORY` is the selected authentication method of the new Amazon QuickSight account. * `admin_group` - (Optional) Admin group associated with your Active Directory or IAM Identity Center account. This field is required if `ACTIVE_DIRECTORY` or `IAM_IDENTITY_CENTER` is the selected authentication method of the new Amazon QuickSight account. * `author_group` - (Optional) Author group associated with your Active Directory or IAM Identity Center account. -* `aws_account_id` - (Optional) AWS account ID hosting the QuickSight account. Default to provider account. +* `aws_account_id` - (Optional, Forces new resource) AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider. * `contact_number` - (Optional) A 10-digit phone number for the author of the Amazon QuickSight account to use for future communications. This field is required if `ENTERPPRISE_AND_Q` is the selected edition of the new Amazon QuickSight account. * `directory_id` - (Optional) Active Directory ID that is associated with your Amazon QuickSight account. * `email_address` - (Optional) Email address of the author of the Amazon QuickSight account to use for future communications. This field is required if `ENTERPPRISE_AND_Q` is the selected edition of the new Amazon QuickSight account. @@ -59,6 +59,7 @@ The following arguments are optional: * `last_name` - (Optional) Last name of the author of the Amazon QuickSight account to use for future communications. This field is required if `ENTERPPRISE_AND_Q` is the selected edition of the new Amazon QuickSight account. * `reader_group` - (Optional) Reader group associated with your Active Directory or IAM Identity Center account. * `realm` - (Optional) Realm of the Active Directory that is associated with your Amazon QuickSight account. +* `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). ## Attribute Reference @@ -75,6 +76,29 @@ This resource exports the following attributes in addition to the arguments abov ## Import -You cannot import this resource. +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import a QuickSight Account Subscription using `aws_account_id`. For example: - \ No newline at end of file +~> Due to the absence of required arguments in the [`DescribeAccountSettings`](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_DescribeAccountSettings.html) API response, importing an existing account subscription will result in a planned replacement on the subsequent `apply` operation. Until the Describe API response in extended to include all configurable arguments, an [`ignore_changes` lifecycle argument](https://developer.hashicorp.com/terraform/language/meta-arguments/lifecycle#ignore_changes) can be used to suppress differences on arguments not read into state. + +```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.quicksight_account_subscription import QuicksightAccountSubscription +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + QuicksightAccountSubscription.generate_config_for_import(self, "example", "012345678901") +``` + +Using `terraform import`, import a QuickSight Account Subscription using `aws_account_id`. For example: + +```console +% terraform import aws_quicksight_account_subscription.example "012345678901" +``` + + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/quicksight_analysis.html.markdown b/website/docs/cdktf/python/r/quicksight_analysis.html.markdown index acef620b66bb..0e88108c0247 100644 --- a/website/docs/cdktf/python/r/quicksight_analysis.html.markdown +++ b/website/docs/cdktf/python/r/quicksight_analysis.html.markdown @@ -123,11 +123,12 @@ The following arguments are required: The following arguments are optional: -* `aws_account_id` - (Optional, Forces new resource) AWS account ID. +* `aws_account_id` - (Optional, Forces new resource) AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider. * `definition` - (Optional) A detailed analysis definition. Only one of `definition` or `source_entity` should be configured. See [definition](#definition). * `parameters` - (Optional) The parameters for the creation of the analysis, which you want to use to override the default settings. An analysis can have any type of parameters, and some parameters might accept multiple values. See [parameters](#parameters). * `permissions` - (Optional) A set of resource permissions on the analysis. Maximum of 64 items. See [permissions](#permissions). * `recovery_window_in_days` - (Optional) A value that specifies the number of days that Amazon QuickSight waits before it deletes the analysis. Use `0` to force deletion without recovery. Minimum value of `7`. Maximum value of `30`. Default to `30`. +* `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). * `source_entity` - (Optional) The entity that you are using as a source when you create the analysis (template). Only one of `definition` or `source_entity` should be configured. See [source_entity](#source_entity). * `tags` - (Optional) Key-value map of resource tags. If configured with a provider [`default_tags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. * `theme_arn` - (Optional) The Amazon Resource Name (ARN) of the theme that is being used for this analysis. The theme ARN must exist in the same AWS account where you create the analysis. @@ -212,4 +213,4 @@ Using `terraform import`, import a QuickSight Analysis using the AWS account ID % terraform import aws_quicksight_analysis.example 123456789012,example-id ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/quicksight_custom_permissions.html.markdown b/website/docs/cdktf/python/r/quicksight_custom_permissions.html.markdown new file mode 100644 index 000000000000..9ed22be4c9f8 --- /dev/null +++ b/website/docs/cdktf/python/r/quicksight_custom_permissions.html.markdown @@ -0,0 +1,97 @@ +--- +subcategory: "QuickSight" +layout: "aws" +page_title: "AWS: aws_quicksight_custom_permissions" +description: |- + Manages a QuickSight custom permissions profile. +--- + + + +# Resource: aws_quicksight_custom_permissions + +Manages a QuickSight custom permissions profile. + +## Example Usage + +resource "aws_quicksight_custom_permissions" "example" { + custom_permissions_name = "example-permissions" + + capabilities { + print_reports = "DENY" + share_dashboards = "DENY" + } +} + +## Argument Reference + +The following arguments are required: + +* `capabilities` - (Required) Actions to include in the custom permissions profile. See [capabilities](#capabilities). +* `custom_permissions_name` - (Required, Forces new resource) Custom permissions profile name. + +The following arguments are optional: + +* `aws_account_id` - (Optional, Forces new resource) AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider. +* `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). +* `tags` - (Optional) Key-value map of resource tags. If configured with a provider [`default_tags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. + +### capabilities + +* `add_or_run_anomaly_detection_for_analyses` - (Optional) The ability to add or run anomaly detection. Valid values: `DENY`. +* `create_and_update_dashboard_email_reports` - (Optional) The ability to create and update email reports. Valid values: `DENY`. +* `create_and_update_datasets` - (Optional) The ability to create and update datasets. Valid values: `DENY`. +* `create_and_update_data_sources` - (Optional) The ability to create and update data sources. Valid values: `DENY`. +* `create_and_update_themes` - (Optional) The ability to export to create and update themes. Valid values: `DENY`. +* `create_and_update_threshold_alerts` - (Optional) The ability to create and update threshold alerts. Valid values: `DENY`. +* `create_shared_folders` - (Optional) The ability to create shared folders. Valid values: `DENY`. +* `create_spice_dataset` - (Optional) The ability to create a SPICE dataset. Valid values: `DENY`. +* `export_to_csv` - (Optional) The ability to export to CSV files from the UI. Valid values: `DENY`. +* `export_to_csv_in_scheduled_reports` - (Optional) The ability to export to CSV files in scheduled email reports. Valid values: `DENY`. +* `export_to_excel` - (Optional) The ability to export to Excel files from the UI. Valid values: `DENY`. +* `export_to_excel_in_scheduled_reports` - (Optional) The ability to export to Excel files in scheduled email reports. Valid values: `DENY`. +* `export_to_pdf` - (Optional) The ability to export to PDF files from the UI. Valid values: `DENY`. +* `export_to_pdf_in_scheduled_reports` - (Optional) The ability to export to PDF files in scheduled email reports. Valid values: `DENY`. +* `include_content_in_scheduled_reports_email` - (Optional) The ability to include content in scheduled email reports. Valid values: `DENY`. +* `print_reports` - (Optional) The ability to print reports. Valid values: `DENY`. +* `rename_shared_folders` - (Optional) The ability to rename shared folders. Valid values: `DENY`. +* `share_analyses` - (Optional) The ability to share analyses. Valid values: `DENY`. +* `share_dashboards` - (Optional) The ability to share dashboards. Valid values: `DENY`. +* `share_datasets` - (Optional) The ability to share datasets. Valid values: `DENY`. +* `share_data_sources` - (Optional) The ability to share data sources. Valid values: `DENY`. +* `subscribe_dashboard_email_reports` - (Optional) The ability to subscribe to email reports. Valid values: `DENY`. +* `view_account_spice_capacity` - (Optional) The ability to view account SPICE capacity. Valid values: `DENY`. + +## Attribute Reference + +This resource exports the following attributes in addition to the arguments above: + +* `arn` - ARN of the custom permissions profile. +* `tags_all` - A map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block). + +## Import + +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import a QuickSight custom permissions profile using the AWS account ID and custom permissions profile name separated by a comma (`,`). 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.quicksight_custom_permissions import QuicksightCustomPermissions +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + QuicksightCustomPermissions.generate_config_for_import(self, "example", "123456789012,example-permissions") +``` + +Using `terraform import`, import a QuickSight custom permissions profile using the AWS account ID and custom permissions profile name separated by a comma (`,`). For example: + +```console +% terraform import aws_quicksight_custom_permissions.example 123456789012,example-permissions +``` + + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/quicksight_dashboard.html.markdown b/website/docs/cdktf/python/r/quicksight_dashboard.html.markdown index b006d30008d0..0ea64949e47a 100644 --- a/website/docs/cdktf/python/r/quicksight_dashboard.html.markdown +++ b/website/docs/cdktf/python/r/quicksight_dashboard.html.markdown @@ -126,11 +126,12 @@ The following arguments are required: The following arguments are optional: -* `aws_account_id` - (Optional, Forces new resource) AWS account ID. +* `aws_account_id` - (Optional, Forces new resource) AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider. * `dashboard_publish_options` - (Optional) Options for publishing the dashboard. See [dashboard_publish_options](#dashboard_publish_options). * `definition` - (Optional) A detailed dashboard definition. Only one of `definition` or `source_entity` should be configured. See [definition](#definition). * `parameters` - (Optional) The parameters for the creation of the dashboard, which you want to use to override the default settings. A dashboard can have any type of parameters, and some parameters might accept multiple values. See [parameters](#parameters). * `permissions` - (Optional) A set of resource permissions on the dashboard. Maximum of 64 items. See [permissions](#permissions). +* `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). * `source_entity` - (Optional) The entity that you are using as a source when you create the dashboard (template). Only one of `definition` or `source_entity` should be configured. See [source_entity](#source_entity). * `tags` - (Optional) Key-value map of resource tags. If configured with a provider [`default_tags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. * `theme_arn` - (Optional) The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. The theme ARN must exist in the same AWS account where you create the dashboard. @@ -270,4 +271,4 @@ Using `terraform import`, import a QuickSight Dashboard using the AWS account ID % terraform import aws_quicksight_dashboard.example 123456789012,example-id ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/quicksight_data_set.html.markdown b/website/docs/cdktf/python/r/quicksight_data_set.html.markdown index dd387cfc248d..4e7b255e6772 100644 --- a/website/docs/cdktf/python/r/quicksight_data_set.html.markdown +++ b/website/docs/cdktf/python/r/quicksight_data_set.html.markdown @@ -231,7 +231,7 @@ The following arguments are required: The following arguments are optional: -* `aws_account_id` - (Optional, Forces new resource) AWS account ID. +* `aws_account_id` - (Optional, Forces new resource) AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider. * `column_groups` - (Optional) Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported. See [column_groups](#column_groups). * `column_level_permission_rules` - (Optional) A set of 1 or more definitions of a [ColumnLevelPermissionRule](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_ColumnLevelPermissionRule.html). See [column_level_permission_rules](#column_level_permission_rules). * `data_set_usage_configuration` - (Optional) The usage configuration to apply to child datasets that reference this dataset as a source. See [data_set_usage_configuration](#data_set_usage_configuration). @@ -239,6 +239,7 @@ The following arguments are optional: * `logical_table_map` - (Optional) Configures the combination and transformation of the data from the physical tables. Maximum of 1 entry. See [logical_table_map](#logical_table_map). * `permissions` - (Optional) A set of resource permissions on the data source. Maximum of 64 items. See [permissions](#permissions). * `physical_table_map` - (Optional) Declares the physical tables that are available in the underlying data sources. See [physical_table_map](#physical_table_map). +* `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). * `row_level_permission_data_set` - (Optional) The row-level security configuration for the data that you want to create. See [row_level_permission_data_set](#row_level_permission_data_set). * `row_level_permission_tag_configuration` - (Optional) The configuration of tags on a dataset to set row-level security. Row-level security tags are currently supported for anonymous embedding only. See [row_level_permission_tag_configuration](#row_level_permission_tag_configuration). * `refresh_properties` - (Optional) The refresh properties for the data set. **NOTE**: Only valid when `import_mode` is set to `SPICE`. See [refresh_properties](#refresh_properties). @@ -482,4 +483,4 @@ Using `terraform import`, import a QuickSight Data Set using the AWS account ID % terraform import aws_quicksight_data_set.example 123456789012,example-id ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/quicksight_data_source.html.markdown b/website/docs/cdktf/python/r/quicksight_data_source.html.markdown index 55b88d99790c..1e26c37ce24a 100644 --- a/website/docs/cdktf/python/r/quicksight_data_source.html.markdown +++ b/website/docs/cdktf/python/r/quicksight_data_source.html.markdown @@ -100,7 +100,7 @@ class MyConvertedCode(TerraformStack): content=Token.as_string( Fn.jsonencode({ "file_locations": [{ - "URIPrefixes": ["https://${" + example.id + "}.s3-${" + data_aws_region_current.name + "}.${" + data_aws_partition_current.dns_suffix + "}" + "URIPrefixes": ["https://${" + example.id + "}.s3-${" + data_aws_region_current.region + "}.${" + data_aws_partition_current.dns_suffix + "}" ] } ], @@ -170,9 +170,10 @@ The following arguments are required: The following arguments are optional: -* `aws_account_id` - (Optional, Forces new resource) The ID for the AWS account that the data source is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account. +* `aws_account_id` - (Optional, Forces new resource) AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider. * `credentials` - (Optional) The credentials Amazon QuickSight uses to connect to your underlying source. See [Credentials](#credentials-argument-reference) below for more details. * `permission` - (Optional) A set of resource permissions on the data source. Maximum of 64 items. See [Permission](#permission-argument-reference) below for more details. +* `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). * `ssl_properties` - (Optional) Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source. See [SSL Properties](#ssl_properties-argument-reference) below for more details. * `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. * `vpc_connection_properties`- (Optional) Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source. See [VPC Connection Properties](#vpc_connection_properties-argument-reference) below for more details. @@ -378,4 +379,4 @@ Using `terraform import`, import a QuickSight data source using the AWS account % terraform import aws_quicksight_data_source.example 123456789123/my-data-source-id ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/quicksight_folder.html.markdown b/website/docs/cdktf/python/r/quicksight_folder.html.markdown index 7d1773d5c2bd..9c8ce641b7a3 100644 --- a/website/docs/cdktf/python/r/quicksight_folder.html.markdown +++ b/website/docs/cdktf/python/r/quicksight_folder.html.markdown @@ -94,10 +94,11 @@ The following arguments are required: The following arguments are optional: -* `aws_account_id` - (Optional, Forces new resource) AWS account ID. +* `aws_account_id` - (Optional, Forces new resource) AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider. * `folder_type` - (Optional) The type of folder. By default, it is `SHARED`. Valid values are: `SHARED`. * `parent_folder_arn` - (Optional) The Amazon Resource Name (ARN) for the parent folder. If not set, creates a root-level folder. * `permissions` - (Optional) A set of resource permissions on the folder. Maximum of 64 items. See [permissions](#permissions). +* `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). * `tags` - (Optional) Key-value map of resource tags. If configured with a provider [`default_tags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. ### permissions @@ -150,4 +151,4 @@ Using `terraform import`, import a QuickSight folder using the AWS account ID an % terraform import aws_quicksight_folder.example 123456789012,example-id ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/quicksight_folder_membership.html.markdown b/website/docs/cdktf/python/r/quicksight_folder_membership.html.markdown index e2e6899e5d58..dabf195d29b2 100644 --- a/website/docs/cdktf/python/r/quicksight_folder_membership.html.markdown +++ b/website/docs/cdktf/python/r/quicksight_folder_membership.html.markdown @@ -45,7 +45,8 @@ The following arguments are required: The following arguments are optional: -* `aws_account_id` - (Optional, Forces new resource) AWS account ID. +* `aws_account_id` - (Optional, Forces new resource) AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider. +* `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). ## Attribute Reference @@ -78,4 +79,4 @@ Using `terraform import`, import QuickSight Folder Membership using the AWS acco % terraform import aws_quicksight_folder_membership.example 123456789012,example-folder,DATASET,example-dataset ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/quicksight_group.html.markdown b/website/docs/cdktf/python/r/quicksight_group.html.markdown index 99139cda655c..7944a054e65f 100644 --- a/website/docs/cdktf/python/r/quicksight_group.html.markdown +++ b/website/docs/cdktf/python/r/quicksight_group.html.markdown @@ -35,10 +35,11 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: -* `group_name` - (Required) A name for the group. -* `aws_account_id` - (Optional) The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account. +* `aws_account_id` - (Optional, Forces new resource) AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider. * `description` - (Optional) A description for the group. +* `group_name` - (Required) A name for the group. * `namespace` - (Optional) The namespace. Currently, you should set this to `default`. +* `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). ## Attribute Reference @@ -71,4 +72,4 @@ Using `terraform import`, import QuickSight Group using the aws account id, name % terraform import aws_quicksight_group.example 123456789123/default/tf-example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/quicksight_group_membership.html.markdown b/website/docs/cdktf/python/r/quicksight_group_membership.html.markdown index 7dbf78f47a60..9eca7dc749e5 100644 --- a/website/docs/cdktf/python/r/quicksight_group_membership.html.markdown +++ b/website/docs/cdktf/python/r/quicksight_group_membership.html.markdown @@ -36,10 +36,11 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `aws_account_id` - (Optional, Forces new resource) AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider. * `group_name` - (Required) The name of the group in which the member will be added. * `member_name` - (Required) The name of the member to add to the group. -* `aws_account_id` - (Optional) The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account. -* `namespace` - (Required) The namespace that you want the user to be a part of. Defaults to `default`. +* `namespace` - (Optional) The namespace that you want the user to be a part of. Defaults to `default`. +* `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). ## Attribute Reference @@ -70,4 +71,4 @@ Using `terraform import`, import QuickSight Group membership using the AWS accou % terraform import aws_quicksight_group_membership.example 123456789123/default/all-access-users/john_smith ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/quicksight_iam_policy_assignment.html.markdown b/website/docs/cdktf/python/r/quicksight_iam_policy_assignment.html.markdown index 64936554084f..14d1177aa30f 100644 --- a/website/docs/cdktf/python/r/quicksight_iam_policy_assignment.html.markdown +++ b/website/docs/cdktf/python/r/quicksight_iam_policy_assignment.html.markdown @@ -48,10 +48,11 @@ The following arguments are required: The following arguments are optional: -* `aws_account_id` - (Optional) AWS account ID. +* `aws_account_id` - (Optional, Forces new resource) AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider. * `identities` - (Optional) Amazon QuickSight users, groups, or both to assign the policy to. See [`identities` block](#identities-block). * `namespace` - (Optional) Namespace that contains the assignment. Defaults to `default`. * `policy_arn` - (Optional) ARN of the IAM policy to apply to the Amazon QuickSight users and groups specified in this assignment. +* `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). ### `identities` block @@ -90,4 +91,4 @@ Using `terraform import`, import QuickSight IAM Policy Assignment using the AWS % terraform import aws_quicksight_iam_policy_assignment.example 123456789012,default,example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/quicksight_ingestion.html.markdown b/website/docs/cdktf/python/r/quicksight_ingestion.html.markdown index 0a5d8bf9370b..659a03a9d5ca 100644 --- a/website/docs/cdktf/python/r/quicksight_ingestion.html.markdown +++ b/website/docs/cdktf/python/r/quicksight_ingestion.html.markdown @@ -45,7 +45,8 @@ The following arguments are required: The following arguments are optional: -* `aws_account_id` - (Optional) AWS account ID. +* `aws_account_id` - (Optional, Forces new resource) AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider. +* `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). ## Attribute Reference @@ -80,4 +81,4 @@ Using `terraform import`, import QuickSight Ingestion using the AWS account ID, % terraform import aws_quicksight_ingestion.example 123456789012,example-dataset-id,example-ingestion-id ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/quicksight_ip_restriction.html.markdown b/website/docs/cdktf/python/r/quicksight_ip_restriction.html.markdown new file mode 100644 index 000000000000..07a3b9f82972 --- /dev/null +++ b/website/docs/cdktf/python/r/quicksight_ip_restriction.html.markdown @@ -0,0 +1,82 @@ +--- +subcategory: "QuickSight" +layout: "aws" +page_title: "AWS: aws_quicksight_ip_restriction" +description: |- + Manages the content and status of IP rules. +--- + + + +# Resource: aws_quicksight_ip_restriction + +Manages the content and status of IP rules. + +~> Deletion of this resource clears all IP restrictions from a QuickSight account. + +## 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.quicksight_ip_restriction import QuicksightIpRestriction +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + QuicksightIpRestriction(self, "example", + enabled=True, + ip_restriction_rule_map={ + "108.56.166.202/32": "Allow self" + }, + vpc_id_restriction_rule_map={ + "${(aws_vpc.example.id)}": "Main VPC" + } + ) +``` + +## Argument Reference + +This resource supports the following arguments: + +* `aws_account_id` - (Optional, Forces new resource) AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider. +* `enabled` - (Required) Whether IP rules are turned on. +* `ip_restriction_rule_map` - (Optional) Map of allowed IPv4 CIDR ranges and descriptions. +* `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). +* `vpc_endpoint_id_restriction_rule_map` - (Optional) Map of allowed VPC endpoint IDs and descriptions. +* `vpc_id_restriction_rule_map` - (Optional) Map of VPC IDs and descriptions. Traffic from all VPC endpoints that are present in the specified VPC is allowed. + +## 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 QuickSight IP restriction using the AWS account ID. 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.quicksight_ip_restriction import QuicksightIpRestriction +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + QuicksightIpRestriction.generate_config_for_import(self, "example", "012345678901") +``` + +Using `terraform import`, import QuickSight IP restriction using the AWS account ID. For example: + +```console +% terraform import aws_quicksight_ip_restriction.example "012345678901" +``` + + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/quicksight_key_registration.html.markdown b/website/docs/cdktf/python/r/quicksight_key_registration.html.markdown new file mode 100644 index 000000000000..5b5adb8a0fb0 --- /dev/null +++ b/website/docs/cdktf/python/r/quicksight_key_registration.html.markdown @@ -0,0 +1,84 @@ +--- +subcategory: "QuickSight" +layout: "aws" +page_title: "AWS: aws_quicksight_key_registration" +description: |- + Registers customer managed keys in a Amazon QuickSight account. +--- + + + +# Resource: aws_quicksight_key_registration + +Registers customer managed keys in a Amazon QuickSight account. + +~> Deletion of this resource clears all CMK registrations from a QuickSight account. QuickSight then uses AWS owned keys to encrypt your resources. + +## 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.quicksight_key_registration import QuicksightKeyRegistration +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + QuicksightKeyRegistration(self, "example", + key_registration=[QuicksightKeyRegistrationKeyRegistration( + key_arn=example1.arn + ), QuicksightKeyRegistrationKeyRegistration( + default_key=True, + key_arn=example2.arn + ) + ] + ) +``` + +## Argument Reference + +This resource supports the following arguments: + +* `aws_account_id` - (Optional, Forces new resource) AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider. +* `key_registration` - (Required) Registered keys. See [key_registration](#key_registration). +* `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). + +### key_registration + +* `default_key` - (Optional) Whether the key is set as the default key for encryption and decryption use. +* `key_arn` - (Required) ARN of the AWS KMS key that is registered for encryption and decryption use. + +## 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 QuickSight key registration using the AWS account ID. 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.quicksight_key_registration import QuicksightKeyRegistration +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + QuicksightKeyRegistration.generate_config_for_import(self, "example", "012345678901") +``` + +Using `terraform import`, import QuickSight key registration using the AWS account ID. For example: + +```console +% terraform import aws_quicksight_key_registration.example "012345678901" +``` + + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/quicksight_namespace.html.markdown b/website/docs/cdktf/python/r/quicksight_namespace.html.markdown index 883e63e56cec..df951990c582 100644 --- a/website/docs/cdktf/python/r/quicksight_namespace.html.markdown +++ b/website/docs/cdktf/python/r/quicksight_namespace.html.markdown @@ -41,8 +41,9 @@ The following arguments are required: The following arguments are optional: -* `aws_account_id` - (Optional) AWS account ID. +* `aws_account_id` - (Optional, Forces new resource) AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider. * `identity_store` - (Optional) User identity directory type. Defaults to `QUICKSIGHT`, the only current valid value. +* `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). * `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. ## Attribute Reference @@ -87,4 +88,4 @@ Using `terraform import`, import QuickSight Namespace using the AWS account ID a % terraform import aws_quicksight_namespace.example 123456789012,example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/quicksight_refresh_schedule.html.markdown b/website/docs/cdktf/python/r/quicksight_refresh_schedule.html.markdown index ab1332da7285..6f15aca1a8ae 100644 --- a/website/docs/cdktf/python/r/quicksight_refresh_schedule.html.markdown +++ b/website/docs/cdktf/python/r/quicksight_refresh_schedule.html.markdown @@ -120,7 +120,8 @@ The following arguments are required: The following arguments are optional: -* `aws_account_id` - (Optional, Forces new resource) AWS account ID. +* `aws_account_id` - (Optional, Forces new resource) AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider. +* `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). ### schedule @@ -172,4 +173,4 @@ Using `terraform import`, import a QuickSight Refresh Schedule using the AWS acc % terraform import aws_quicksight_refresh_schedule.example 123456789012,dataset-id,schedule-id ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/quicksight_role_custom_permission.html.markdown b/website/docs/cdktf/python/r/quicksight_role_custom_permission.html.markdown new file mode 100644 index 000000000000..d390fd77d247 --- /dev/null +++ b/website/docs/cdktf/python/r/quicksight_role_custom_permission.html.markdown @@ -0,0 +1,77 @@ +--- +subcategory: "QuickSight" +layout: "aws" +page_title: "AWS: aws_quicksight_role_custom_permission" +description: |- + Manages the custom permissions that are associated with a role. +--- + + + +# Resource: aws_quicksight_role_custom_permission + +Manages the custom permissions that are associated with a role. + +## 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 Token, TerraformStack +# +# Provider bindings are generated by running `cdktf get`. +# See https://cdk.tf/provider-generation for more details. +# +from imports.aws.quicksight_role_custom_permission import QuicksightRoleCustomPermission +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + QuicksightRoleCustomPermission(self, "example", + custom_permissions_name=Token.as_string(aws_quicksight_custom_permissions_example.custom_permissions_name), + role="READER" + ) +``` + +## Argument Reference + +The following arguments are required: + +* `custom_permissions_name` - (Required, Forces new resource) Custom permissions profile name. +* `role` - (Required, Forces new resource) Role. Valid values are `ADMIN`, `AUTHOR`, `READER`, `ADMIN_PRO`, `AUTHOR_PRO`, and `READER_PRO`. + +The following arguments are optional: + +* `aws_account_id` - (Optional, Forces new resource) AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider. +* `namespace` - (Optional, Forces new resource) Namespace containing the role. Defaults to `default`. +* `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). + +## 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 QuickSight role custom permissions using a comma-delimited string combining the `aws_account_id`, `namespace` and `role`. 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.quicksight_role_custom_permission import QuicksightRoleCustomPermission +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + QuicksightRoleCustomPermission.generate_config_for_import(self, "example", "012345678901,default,READER") +``` + +Using `terraform import`, import QuickSight role custom permissions using a comma-delimited string combining the `aws_account_id`, `namespace`, and `role`. For example: + +```console +% terraform import aws_quicksight_role_custom_permission.example 012345678901,default,READER +``` + + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/quicksight_role_membership.html.markdown b/website/docs/cdktf/python/r/quicksight_role_membership.html.markdown index b53b6a1dfd19..5b65d264d0f7 100644 --- a/website/docs/cdktf/python/r/quicksight_role_membership.html.markdown +++ b/website/docs/cdktf/python/r/quicksight_role_membership.html.markdown @@ -44,8 +44,9 @@ The following arguments are required: The following arguments are optional: -* `aws_account_id` - (Optional) AWS account ID. Defaults to the account of the caller identity if not configured. +* `aws_account_id` - (Optional, Forces new resource) AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider. * `namespace` - (Optional) Name of the namespace. Defaults to `default`. +* `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). ## Attribute Reference @@ -76,4 +77,4 @@ Using `terraform import`, import QuickSight Role Membership using a comma-delimi % terraform import aws_quicksight_role_membership.example 012345678901,default,READER,example-group ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/quicksight_template.html.markdown b/website/docs/cdktf/python/r/quicksight_template.html.markdown index 7dbce283bd3e..cc07d9577ae9 100644 --- a/website/docs/cdktf/python/r/quicksight_template.html.markdown +++ b/website/docs/cdktf/python/r/quicksight_template.html.markdown @@ -127,9 +127,10 @@ The following arguments are required: The following arguments are optional: -* `aws_account_id` - (Optional, Forces new resource) AWS account ID. +* `aws_account_id` - (Optional, Forces new resource) AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider. * `definition` - (Optional) A detailed template definition. Only one of `definition` or `source_entity` should be configured. See [definition](#definition). * `permissions` - (Optional) A set of resource permissions on the template. Maximum of 64 items. See [permissions](#permissions). +* `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). * `source_entity` - (Optional) The entity that you are using as a source when you create the template (analysis or template). Only one of `definition` or `source_entity` should be configured. See [source_entity](#source_entity). * `tags` - (Optional) Key-value map of resource tags. If configured with a provider [`default_tags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. @@ -213,4 +214,4 @@ Using `terraform import`, import a QuickSight Template using the AWS account ID % terraform import aws_quicksight_template.example 123456789012,example-id ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/quicksight_template_alias.html.markdown b/website/docs/cdktf/python/r/quicksight_template_alias.html.markdown index 4edcef96c85b..6da15ab2cb54 100644 --- a/website/docs/cdktf/python/r/quicksight_template_alias.html.markdown +++ b/website/docs/cdktf/python/r/quicksight_template_alias.html.markdown @@ -45,7 +45,8 @@ The following arguments are required: The following arguments are optional: -* `aws_account_id` - (Optional, Forces new resource) AWS account ID. +* `aws_account_id` - (Optional, Forces new resource) AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider. +* `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). ## Attribute Reference @@ -79,4 +80,4 @@ Using `terraform import`, import QuickSight Template Alias using the AWS account % terraform import aws_quicksight_template_alias.example 123456789012,example-id,example-alias ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/quicksight_theme.html.markdown b/website/docs/cdktf/python/r/quicksight_theme.html.markdown index 982bedd40454..8e7b214825a4 100644 --- a/website/docs/cdktf/python/r/quicksight_theme.html.markdown +++ b/website/docs/cdktf/python/r/quicksight_theme.html.markdown @@ -47,15 +47,16 @@ class MyConvertedCode(TerraformStack): The following arguments are required: -* `theme_id` - (Required, Forces new resource) Identifier of the theme. * `base_theme_id` - (Required) The ID of the theme that a custom theme will inherit from. All themes inherit from one of the starting themes defined by Amazon QuickSight. For a list of the starting themes, use ListThemes or choose Themes from within an analysis. -* `name` - (Required) Display name of the theme. * `configuration` - (Required) The theme configuration, which contains the theme display properties. See [configuration](#configuration). +* `name` - (Required) Display name of the theme. +* `theme_id` - (Required, Forces new resource) Identifier of the theme. The following arguments are optional: -* `aws_account_id` - (Optional, Forces new resource) AWS account ID. +* `aws_account_id` - (Optional, Forces new resource) AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider. * `permissions` - (Optional) A set of resource permissions on the theme. Maximum of 64 items. See [permissions](#permissions). +* `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). * `tags` - (Optional) Key-value map of resource tags. If configured with a provider [`default_tags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. * `version_description` - (Optional) A description of the current theme version being created/updated. @@ -175,4 +176,4 @@ Using `terraform import`, import a QuickSight Theme using the AWS account ID and % terraform import aws_quicksight_theme.example 123456789012,example-id ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/quicksight_user.html.markdown b/website/docs/cdktf/python/r/quicksight_user.html.markdown index 8a33fb414e16..26d3f61a1eb7 100644 --- a/website/docs/cdktf/python/r/quicksight_user.html.markdown +++ b/website/docs/cdktf/python/r/quicksight_user.html.markdown @@ -87,14 +87,15 @@ class MyConvertedCode(TerraformStack): The following arguments are required: * `email` - (Required) Email address of the user that you want to register. -* `identity_type` - (Required) Identity type that your Amazon QuickSight account uses to manage the identity of users. Valid values: `IAM`, `QUICKSIGHT`. -* `user_role` - (Required) Amazon QuickSight role for the user. Value values: `READER`, `AUTHOR`, `ADMIN`, `READER_PRO`, `AUTHOR_PRO`, `ADMIN_PRO`. +* `identity_type` - (Required) Identity type that your Amazon QuickSight account uses to manage the identity of users. Valid values: `IAM`, `QUICKSIGHT`, `IAM_IDENTITY_CENTER`. +* `user_role` - (Required) Amazon QuickSight role for the user. Valid values: `READER`, `AUTHOR`, `ADMIN`, `READER_PRO`, `AUTHOR_PRO`, `ADMIN_PRO`, `RESTRICTED_AUTHOR`, `RESTRICTED_READER`. The following arguments are optional: -* `aws_account_id` - (Optional) ID for the AWS account that the user is in. Use the ID for the AWS account that contains your Amazon QuickSight account. +* `aws_account_id` - (Optional, Forces new resource) AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider. * `iam_arn` - (Optional) ARN of the IAM user or role that you are registering with Amazon QuickSight. Required only for users with an identity type of `IAM`. * `namespace` - (Optional) The Amazon Quicksight namespace to create the user in. Defaults to `default`. +* `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). * `session_name` - (Optional) Name of the IAM session to use when assuming roles that can embed QuickSight dashboards. Only valid for registering users using an assumed IAM role. Additionally, if registering multiple users using the same IAM role, each user needs to have a unique session name. * `user_name` - (Optional) Amazon QuickSight user name that you want to create for the user you are registering. Required only for users with an identity type of `QUICKSIGHT`. @@ -110,4 +111,4 @@ This resource exports the following attributes in addition to the arguments abov You cannot import this resource. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/quicksight_user_custom_permission.html.markdown b/website/docs/cdktf/python/r/quicksight_user_custom_permission.html.markdown new file mode 100644 index 000000000000..06d134ee8c3e --- /dev/null +++ b/website/docs/cdktf/python/r/quicksight_user_custom_permission.html.markdown @@ -0,0 +1,77 @@ +--- +subcategory: "QuickSight" +layout: "aws" +page_title: "AWS: aws_quicksight_user_custom_permission" +description: |- + Manages the custom permissions profile for a user. +--- + + + +# Resource: aws_quicksight_user_custom_permission + +Manages the custom permissions profile for a user. + +## 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 Token, TerraformStack +# +# Provider bindings are generated by running `cdktf get`. +# See https://cdk.tf/provider-generation for more details. +# +from imports.aws.quicksight_user_custom_permission import QuicksightUserCustomPermission +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + QuicksightUserCustomPermission(self, "example", + custom_permissions_name=Token.as_string(aws_quicksight_custom_permissions_example.custom_permissions_name), + user_name=Token.as_string(aws_quicksight_user_example.user_name) + ) +``` + +## Argument Reference + +The following arguments are required: + +* `custom_permissions_name` - (Required, Forces new resource) Custom permissions profile name. +* `user_name` - (Required, Forces new resource) Username of the user. + +The following arguments are optional: + +* `aws_account_id` - (Optional, Forces new resource) AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider. +* `namespace` - (Optional, Forces new resource) Namespace that the user belongs to. Defaults to `default`. +* `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). + +## 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 QuickSight user custom permissions using a comma-delimited string combining the `aws_account_id`, `namespace` and `user_name`. 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.quicksight_user_custom_permission import QuicksightUserCustomPermission +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + QuicksightUserCustomPermission.generate_config_for_import(self, "example", "012345678901,default,user1") +``` + +Using `terraform import`, import QuickSight user custom permissions using a comma-delimited string combining the `aws_account_id`, `namespace`, and `user_name`. For example: + +```console +% terraform import aws_quicksight_user_custom_permission.example 012345678901,default,user1 +``` + + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/quicksight_vpc_connection.html.markdown b/website/docs/cdktf/python/r/quicksight_vpc_connection.html.markdown index 1a18193f601d..735ecb4c90bb 100644 --- a/website/docs/cdktf/python/r/quicksight_vpc_connection.html.markdown +++ b/website/docs/cdktf/python/r/quicksight_vpc_connection.html.markdown @@ -79,8 +79,9 @@ The following arguments are required: The following arguments are optional: -* `aws_account_id` - (Optional) AWS account ID. +* `aws_account_id` - (Optional, Forces new resource) AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider. * `dns_resolvers` - (Optional) A list of IP addresses of DNS resolver endpoints for the VPC connection. +* `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). * `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. ## Attribute Reference @@ -125,4 +126,4 @@ Using `terraform import`, import QuickSight VPC connection using the AWS account % terraform import aws_quicksight_vpc_connection.example 123456789012,example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ram_principal_association.html.markdown b/website/docs/cdktf/python/r/ram_principal_association.html.markdown index 906d8ce5557a..2c7161faa975 100644 --- a/website/docs/cdktf/python/r/ram_principal_association.html.markdown +++ b/website/docs/cdktf/python/r/ram_principal_association.html.markdown @@ -75,6 +75,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `principal` - (Required) The principal to associate with the resource share. Possible values are an AWS account ID, an AWS Organizations Organization ARN, or an AWS Organizations Organization Unit ARN. * `resource_share_arn` - (Required) The Amazon Resource Name (ARN) of the resource share. @@ -109,4 +110,4 @@ Using `terraform import`, import RAM Principal Associations using their Resource % terraform import aws_ram_principal_association.example arn:aws:ram:eu-west-1:123456789012:resource-share/73da1ab9-b94a-4ba3-8eb4-45917f7f4b12,123456789012 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ram_resource_association.html.markdown b/website/docs/cdktf/python/r/ram_resource_association.html.markdown index b25aadd668f6..90073897d80f 100644 --- a/website/docs/cdktf/python/r/ram_resource_association.html.markdown +++ b/website/docs/cdktf/python/r/ram_resource_association.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `resource_arn` - (Required) Amazon Resource Name (ARN) of the resource to associate with the RAM Resource Share. * `resource_share_arn` - (Required) Amazon Resource Name (ARN) of the RAM Resource Share. @@ -72,4 +73,4 @@ Using `terraform import`, import RAM Resource Associations using their Resource % terraform import aws_ram_resource_association.example arn:aws:ram:eu-west-1:123456789012:resource-share/73da1ab9-b94a-4ba3-8eb4-45917f7f4b12,arn:aws:ec2:eu-west-1:123456789012:subnet/subnet-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ram_resource_share.html.markdown b/website/docs/cdktf/python/r/ram_resource_share.html.markdown index 8ff3a86440d9..07a518e6ab26 100644 --- a/website/docs/cdktf/python/r/ram_resource_share.html.markdown +++ b/website/docs/cdktf/python/r/ram_resource_share.html.markdown @@ -39,6 +39,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) The name of the resource share. * `allow_external_principals` - (Optional) Indicates whether principals outside your organization can be associated with a resource share. * `permission_arns` - (Optional) Specifies the Amazon Resource Names (ARNs) of the RAM permission to associate with the resource share. If you do not specify an ARN for the permission, RAM automatically attaches the default version of the permission for each resource type. You can associate only one permission with each resource type included in the resource share. @@ -77,4 +78,4 @@ Using `terraform import`, import resource shares using the `arn` of the resource % terraform import aws_ram_resource_share.example arn:aws:ram:eu-west-1:123456789012:resource-share/73da1ab9-b94a-4ba3-8eb4-45917f7f4b12 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ram_resource_share_accepter.html.markdown b/website/docs/cdktf/python/r/ram_resource_share_accepter.html.markdown index 2283c8ab57e9..153f43572cc7 100644 --- a/website/docs/cdktf/python/r/ram_resource_share_accepter.html.markdown +++ b/website/docs/cdktf/python/r/ram_resource_share_accepter.html.markdown @@ -64,6 +64,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `share_arn` - (Required) The ARN of the resource share. ## Attribute Reference @@ -103,4 +104,4 @@ Using `terraform import`, import resource share accepters using the resource sha % terraform import aws_ram_resource_share_accepter.example arn:aws:ram:us-east-1:123456789012:resource-share/c4b56393-e8d9-89d9-6dc9-883752de4767 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/rbin_rule.html.markdown b/website/docs/cdktf/python/r/rbin_rule.html.markdown index 191aab55bcaa..3f70a33447e2 100644 --- a/website/docs/cdktf/python/r/rbin_rule.html.markdown +++ b/website/docs/cdktf/python/r/rbin_rule.html.markdown @@ -29,7 +29,7 @@ class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) RbinRule(self, "example", - description="example_rule", + description="Example tag-level retention rule", resource_tags=[RbinRuleResourceTags( resource_tag_key="tag_key", resource_tag_value="tag_value" @@ -46,35 +46,69 @@ class MyConvertedCode(TerraformStack): ) ``` +### Region-Level Retention Rule + +```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.rbin_rule import RbinRule +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + RbinRule(self, "example", + description="Example region-level retention rule with exclusion tags", + exclude_resource_tags=[RbinRuleExcludeResourceTags( + resource_tag_key="tag_key", + resource_tag_value="tag_value" + ) + ], + resource_type="EC2_IMAGE", + retention_period=RbinRuleRetentionPeriod( + retention_period_unit="DAYS", + retention_period_value=10 + ), + tags={ + "test_tag_key": "test_tag_value" + } + ) +``` + ## Argument Reference The following arguments are required: -* `resource_type` - (Required) The resource type to be retained by the retention rule. Valid values are `EBS_SNAPSHOT` and `EC2_IMAGE`. +* `resource_type` - (Required) Resource type to be retained by the retention rule. Valid values are `EBS_SNAPSHOT` and `EC2_IMAGE`. * `retention_period` - (Required) Information about the retention period for which the retention rule is to retain resources. See [`retention_period`](#retention_period) below. The following arguments are optional: -* `description` - (Optional) The retention rule description. -* `resource_tags` - (Optional) Specifies the resource tags to use to identify resources that are to be retained by a tag-level retention rule. See [`resource_tags`](#resource_tags) below. +* `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). +* `description` - (Optional) Retention rule description. +* `exclude_resource_tags` - (Optional) Exclusion tags to use to identify resources that are to be excluded, or ignored, by a Region-level retention rule. See [`exclude_resource_tags`](#exclude_resource_tags) below. * `lock_configuration` - (Optional) Information about the retention rule lock configuration. See [`lock_configuration`](#lock_configuration) below. +* `resource_tags` - (Optional) Resource tags to use to identify resources that are to be retained by a tag-level retention rule. See [`resource_tags`](#resource_tags) below. ### retention_period The following arguments are required: -* `retention_period_unit` - (Required) The unit of time in which the retention period is measured. Currently, only DAYS is supported. -* `retention_period_value` - (Required) The period value for which the retention rule is to retain resources. The period is measured using the unit specified for RetentionPeriodUnit. +* `retention_period_unit` - (Required) Unit of time in which the retention period is measured. Currently, only DAYS is supported. +* `retention_period_value` - (Required) Period value for which the retention rule is to retain resources. The period is measured using the unit specified for RetentionPeriodUnit. -### resource_tags +### exclude_resource_tags The following argument is required: -* `resource_tag_key` - (Required) The tag key. +* `resource_tag_key` - (Required) Tag key. The following argument is optional: -* `resource_tag_value` - (Optional) The tag value. +* `resource_tag_value` - (Optional) Tag value. ### lock_configuration @@ -86,17 +120,27 @@ The following argument is required: The following arguments are required: -* `unlock_delay_unit` - (Required) The unit of time in which to measure the unlock delay. Currently, the unlock delay can be measure only in days. -* `unlock_delay_value` - (Required) The unlock delay period, measured in the unit specified for UnlockDelayUnit. +* `unlock_delay_unit` - (Required) Unit of time in which to measure the unlock delay. Currently, the unlock delay can be measure only in days. +* `unlock_delay_value` - (Required) Unlock delay period, measured in the unit specified for UnlockDelayUnit. + +### resource_tags + +The following argument is required: + +* `resource_tag_key` - (Required) Tag key. + +The following argument is optional: + +* `resource_tag_value` - (Optional) Tag value. ## Attribute Reference This resource exports the following attributes in addition to the arguments above: * `id` - (String) ID of the Rule. -* `lock_end_time` - (Timestamp) The date and time at which the unlock delay is set to expire. Only returned for retention rules that have been unlocked and that are still within the unlock delay period. -* `lock_state` - (Optional) The lock state of the retention rules to list. Only retention rules with the specified lock state are returned. Valid values are `locked`, `pending_unlock`, `unlocked`. -* `status` - (String) The state of the retention rule. Only retention rules that are in the `available` state retain resources. Valid values include `pending` and `available`. +* `lock_end_time` - (Timestamp) Date and time at which the unlock delay is set to expire. Only returned for retention rules that have been unlocked and that are still within the unlock delay period. +* `lock_state` - (Optional) Lock state of the retention rules to list. Only retention rules with the specified lock state are returned. Valid values are `locked`, `pending_unlock`, `unlocked`. +* `status` - (String) State of the retention rule. Only retention rules that are in the `available` state retain resources. Valid values include `pending` and `available`. ## Import @@ -123,4 +167,4 @@ Using `terraform import`, import RBin Rule using the `id`. For example: % terraform import aws_rbin_rule.example examplerule ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/rds_certificate.html.markdown b/website/docs/cdktf/python/r/rds_certificate.html.markdown index 7701765edca2..222a30510ae2 100644 --- a/website/docs/cdktf/python/r/rds_certificate.html.markdown +++ b/website/docs/cdktf/python/r/rds_certificate.html.markdown @@ -35,8 +35,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `certificate_identifier` - (Required) Certificate identifier. For example, `rds-ca-rsa4096-g1`. Refer to [AWS RDS (Relational Database) Certificate Identifier](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html#UsingWithRDS.SSL.CertificateIdentifier) for more information. ## Attribute Reference @@ -68,4 +69,4 @@ Using `terraform import`, import the RDS certificate override using the `region` % terraform import aws_rds_certificate.example us-west-2 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/rds_cluster.html.markdown b/website/docs/cdktf/python/r/rds_cluster.html.markdown index 64f4bfb8f8f0..560215104279 100644 --- a/website/docs/cdktf/python/r/rds_cluster.html.markdown +++ b/website/docs/cdktf/python/r/rds_cluster.html.markdown @@ -27,7 +27,7 @@ Changes to an RDS Cluster can occur when you manually change a parameter, such a ~> **NOTE on RDS Clusters and RDS Cluster Role Associations:** Terraform provides both a standalone [RDS Cluster Role Association](rds_cluster_role_association.html) - (an association between an RDS Cluster and a single IAM Role) and an RDS Cluster resource with `iam_roles` attributes. Use one resource or the other to associate IAM Roles and RDS Clusters. Not doing so will cause a conflict of associations and will result in the association being overwritten. --> **Note:** Write-Only argument `master_password_wo` is available to use in place of `master_password`. Write-Only arguments are supported in HashiCorp Terraform 1.11.0 and later. [Learn more](https://developer.hashicorp.com/terraform/language/v1.11.x/resources/ephemeral#write-only-arguments). +-> **Note:** Write-Only argument `master_password_wo` is available to use in place of `master_password`. Write-Only arguments are supported in HashiCorp Terraform 1.11.0 and later. [Learn more](https://developer.hashicorp.com/terraform/language/resources/ephemeral#write-only-arguments). ## Example Usage @@ -292,6 +292,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `allocated_storage` - (Optional, Required for Multi-AZ DB cluster) The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster. * `allow_major_version_upgrade` - (Optional) Enable to allow major engine version upgrades when changing engine versions. Defaults to `false`. * `apply_immediately` - (Optional) Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is `false`. See [Amazon RDS Documentation for more information.](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.DBInstance.Modifying.html) @@ -305,7 +306,7 @@ This resource supports the following arguments: * `cluster_identifier` - (Optional, Forces new resources) The cluster identifier. If omitted, Terraform will assign a random, unique identifier. * `cluster_identifier_prefix` - (Optional, Forces new resource) Creates a unique cluster identifier beginning with the specified prefix. Conflicts with `cluster_identifier`. * `cluster_scalability_type` - (Optional, Forces new resources) Specifies the scalability mode of the Aurora DB cluster. When set to `limitless`, the cluster operates as an Aurora Limitless Database. When set to `standard` (the default), the cluster uses normal DB instance creation. Valid values: `limitless`, `standard`. -* `copy_tags_to_snapshot` – (Optional, boolean) Copy all Cluster `tags` to snapshots. Default is `false`. +* `copy_tags_to_snapshot` - (Optional, boolean) Copy all Cluster `tags` to snapshots. Default is `false`. * `database_insights_mode` - (Optional) The mode of Database Insights to enable for the DB cluster. Valid values: `standard`, `advanced`. * `database_name` - (Optional) Name for an automatically created database on cluster creation. There are different naming restrictions per database engine: [RDS Naming Constraints][5] * `db_cluster_instance_class` - (Optional, Required for Multi-AZ DB cluster) The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example `db.m6g.xlarge`. Not all DB instance classes are available in all AWS Regions, or for all database engines. For the full list of DB instance classes and availability for your engine, see [DB instance class](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) in the Amazon RDS User Guide. @@ -323,7 +324,7 @@ This resource supports the following arguments: * `enable_global_write_forwarding` - (Optional) Whether cluster should forward writes to an associated global cluster. Applied to secondary clusters to enable them to forward writes to an [`aws_rds_global_cluster`](/docs/providers/aws/r/rds_global_cluster.html)'s primary cluster. See the [User Guide for Aurora](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database-write-forwarding.html) for more information. * `enable_http_endpoint` - (Optional) Enable HTTP endpoint (data API). Only valid for some combinations of `engine_mode`, `engine` and `engine_version` and only available in some regions. See the [Region and version availability](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html#data-api.regions) section of the documentation. This option also does not work with any of these options specified: `snapshot_identifier`, `replication_source_identifier`, `s3_import`. * `enable_local_write_forwarding` - (Optional) Whether read replicas can forward write operations to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.. See the [User Guide for Aurora](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-mysql-write-forwarding.html) for more information. **NOTE:** Local write forwarding requires Aurora MySQL version 3.04 or higher. -* `enabled_cloudwatch_logs_exports` - (Optional) Set of log types to export to cloudwatch. If omitted, no logs will be exported. The following log types are supported: `audit`, `error`, `general`, `slowquery`, `iam-db-auth-error`, `postgresql` (PostgreSQL). +* `enabled_cloudwatch_logs_exports` - (Optional) Set of log types to export to cloudwatch. If omitted, no logs will be exported. The following log types are supported: `audit`, `error`, `general`, `iam-db-auth-error`, `instance`, `postgresql` (PostgreSQL), `slowquery`. * `engine_mode` - (Optional) Database engine mode. Valid values: `global` (only valid for Aurora MySQL 1.21 and earlier), `parallelquery`, `provisioned`, `serverless`. Defaults to: `provisioned`. Specify an empty value (`""`) for no engine mode. See the [RDS User Guide](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html) for limitations when using `serverless`. * `engine_lifecycle_support` - (Optional) The life cycle type for this DB instance. This setting is valid for cluster types Aurora DB clusters and Multi-AZ DB clusters. Valid values are `open-source-rds-extended-support`, `open-source-rds-extended-support-disabled`. Default value is `open-source-rds-extended-support`. [Using Amazon RDS Extended Support]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/extended-support.html * `engine_version` - (Optional) Database engine version. Updating this argument results in an outage. See the [Aurora MySQL](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Updates.html) and [Aurora Postgres](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraPostgreSQL.Updates.html) documentation for your configured engine to determine this value, or by running `aws rds describe-db-engine-versions`. For example with Aurora MySQL 2, a potential value for this argument is `5.7.mysql_aurora.2.03.2`. The value can contain a partial version where supported by the API. The actual engine version used is returned in the attribute `engine_version_actual`, , see [Attribute Reference](#attribute-reference) below. @@ -521,7 +522,7 @@ This resource exports the following attributes in addition to the arguments abov * `id` - RDS Cluster Identifier * `cluster_identifier` - RDS Cluster Identifier * `cluster_resource_id` - RDS Cluster Resource ID -* `cluster_members` – List of RDS Instances that are a part of this cluster +* `cluster_members` - List of RDS Instances that are a part of this cluster * `availability_zones` - Availability zone of the instance * `backup_retention_period` - Backup retention period * `ca_certificate_identifier` - CA identifier of the CA certificate used for the DB instance's server certificate @@ -593,4 +594,4 @@ Using `terraform import`, import RDS Clusters using the `cluster_identifier`. Fo % terraform import aws_rds_cluster.aurora_cluster aurora-prod-cluster ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/rds_cluster_activity_stream.html.markdown b/website/docs/cdktf/python/r/rds_cluster_activity_stream.html.markdown index 54497df9c11c..8399ab48b5c5 100644 --- a/website/docs/cdktf/python/r/rds_cluster_activity_stream.html.markdown +++ b/website/docs/cdktf/python/r/rds_cluster_activity_stream.html.markdown @@ -73,6 +73,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `resource_arn` - (Required, Forces new resources) The Amazon Resource Name (ARN) of the DB cluster. * `mode` - (Required, Forces new resources) Specifies the mode of the database activity stream. Database events such as a change or access generate an activity stream event. The database session can handle these events either synchronously or asynchronously. One of: `sync`, `async`. * `kms_key_id` - (Required, Forces new resources) The AWS KMS key identifier for encrypting messages in the database activity stream. The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. @@ -117,4 +118,4 @@ Using `terraform import`, import RDS Aurora Cluster Database Activity Streams us [2]: https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_StartActivityStream.html [3]: https://docs.aws.amazon.com/cli/latest/reference/rds/start-activity-stream.html - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/rds_cluster_endpoint.html.markdown b/website/docs/cdktf/python/r/rds_cluster_endpoint.html.markdown index 948d56993e13..9b042216cf95 100644 --- a/website/docs/cdktf/python/r/rds_cluster_endpoint.html.markdown +++ b/website/docs/cdktf/python/r/rds_cluster_endpoint.html.markdown @@ -81,6 +81,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `cluster_identifier` - (Required, Forces new resources) The cluster identifier. * `cluster_endpoint_identifier` - (Required, Forces new resources) The identifier to use for the new endpoint. This parameter is stored as a lowercase string. * `custom_endpoint_type` - (Required) The type of the endpoint. One of: READER , ANY . @@ -127,4 +128,4 @@ Using `terraform import`, import RDS Clusters Endpoint using the `cluster_endpoi [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Overview.Endpoints.html#Aurora.Endpoints.Cluster - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/rds_cluster_instance.html.markdown b/website/docs/cdktf/python/r/rds_cluster_instance.html.markdown index 002bd0d0078c..4ac2a7d76c93 100644 --- a/website/docs/cdktf/python/r/rds_cluster_instance.html.markdown +++ b/website/docs/cdktf/python/r/rds_cluster_instance.html.markdown @@ -69,12 +69,13 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `apply_immediately` - (Optional) Specifies whether any database modifications are applied immediately, or during the next maintenance window. Default is`false`. * `auto_minor_version_upgrade` - (Optional) Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window. Default `true`. * `availability_zone` - (Optional, Computed, Forces new resource) EC2 Availability Zone that the DB instance is created in. See [docs](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html) about the details. * `ca_cert_identifier` - (Optional) Identifier of the CA certificate for the DB instance. * `cluster_identifier` - (Required, Forces new resource) Identifier of the [`aws_rds_cluster`](/docs/providers/aws/r/rds_cluster.html) in which to launch this instance. -* `copy_tags_to_snapshot` – (Optional, boolean) Indicates whether to copy all of the user-defined tags from the DB instance to snapshots of the DB instance. Default `false`. +* `copy_tags_to_snapshot` - (Optional, boolean) Indicates whether to copy all of the user-defined tags from the DB instance to snapshots of the DB instance. Default `false`. * `custom_iam_instance_profile` - (Optional) Instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. * `db_parameter_group_name` - (Optional) Name of the DB parameter group to associate with this instance. * `db_subnet_group_name` - (Optional, Forces new resource) Specifies the DB subnet group to associate with this DB instance. The default behavior varies depending on whether `db_subnet_group_name` is specified. Please refer to official [AWS documentation](https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-instance.html) to understand how `db_subnet_group_name` and `publicly_accessible` parameters affect DB instance behaviour. **NOTE:** This must match the `db_subnet_group_name` of the attached [`aws_rds_cluster`](/docs/providers/aws/r/rds_cluster.html). @@ -107,7 +108,7 @@ This resource exports the following attributes in addition to the arguments abov * `cluster_identifier` - RDS Cluster Identifier * `identifier` - Instance identifier * `id` - Instance identifier -* `writer` – Boolean indicating if this instance is writable. `False` indicates this instance is a read replica. +* `writer` - Boolean indicating if this instance is writable. `False` indicates this instance is a read replica. * `availability_zone` - Availability zone of the instance * `endpoint` - DNS address for this instance. May not be writable * `engine` - Database engine @@ -161,4 +162,4 @@ Using `terraform import`, import RDS Cluster Instances using the `identifier`. F % terraform import aws_rds_cluster_instance.prod_instance_1 aurora-cluster-instance-1 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/rds_cluster_parameter_group.html.markdown b/website/docs/cdktf/python/r/rds_cluster_parameter_group.html.markdown index 4d7c3bee161c..1d0d0f779bd6 100644 --- a/website/docs/cdktf/python/r/rds_cluster_parameter_group.html.markdown +++ b/website/docs/cdktf/python/r/rds_cluster_parameter_group.html.markdown @@ -48,6 +48,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Optional, Forces new resource) The name of the DB cluster parameter group. If omitted, Terraform will assign a random, unique name. * `name_prefix` - (Optional, Forces new resource) Creates a unique name beginning with the specified prefix. Conflicts with `name`. * `family` - (Required) The family of the DB cluster parameter group. @@ -96,4 +97,4 @@ Using `terraform import`, import RDS Cluster Parameter Groups using the `name`. % terraform import aws_rds_cluster_parameter_group.cluster_pg production-pg-1 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/rds_cluster_role_association.html.markdown b/website/docs/cdktf/python/r/rds_cluster_role_association.html.markdown index d5fede3e6a4b..d1eaa65764ff 100644 --- a/website/docs/cdktf/python/r/rds_cluster_role_association.html.markdown +++ b/website/docs/cdktf/python/r/rds_cluster_role_association.html.markdown @@ -40,6 +40,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `db_cluster_identifier` - (Required) DB Cluster Identifier to associate with the IAM Role. * `feature_name` - (Required) Name of the feature for association. This can be found in the AWS documentation relevant to the integration or a full list is available in the `SupportedFeatureNames` list returned by [AWS CLI rds describe-db-engine-versions](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-engine-versions.html). * `role_arn` - (Required) Amazon Resource Name (ARN) of the IAM Role to associate with the DB Cluster. @@ -82,4 +83,4 @@ Using `terraform import`, import `aws_rds_cluster_role_association` using the DB % terraform import aws_rds_cluster_role_association.example my-db-cluster,arn:aws:iam::123456789012:role/my-role ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/rds_cluster_snapshot_copy.html.markdown b/website/docs/cdktf/python/r/rds_cluster_snapshot_copy.html.markdown index 5ca53e2bd810..67bb3ec8d16c 100644 --- a/website/docs/cdktf/python/r/rds_cluster_snapshot_copy.html.markdown +++ b/website/docs/cdktf/python/r/rds_cluster_snapshot_copy.html.markdown @@ -17,14 +17,14 @@ Manages an RDS database cluster snapshot copy. For managing RDS database instanc ```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 +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. import RdsClusterSnapshotCopy from imports.aws.db_cluster_snapshot import DbClusterSnapshot from imports.aws.rds_cluster import RdsCluster +from imports.aws.rds_cluster_snapshot_copy import RdsClusterSnapshotCopy class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) @@ -43,7 +43,7 @@ class MyConvertedCode(TerraformStack): # 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_db_cluster_snapshot_example.override_logical_id("example") aws_rds_cluster_snapshot_copy_example = RdsClusterSnapshotCopy(self, "example_2", - source_db_cluster_snapshot_identifier=aws_db_cluster_snapshot_example.db_cluster_snapshot_arn, + source_db_cluster_snapshot_identifier=Token.as_string(aws_db_cluster_snapshot_example.db_cluster_snapshot_arn), target_db_cluster_snapshot_identifier="example-copy" ) # This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match. @@ -59,6 +59,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `copy_tags` - (Optional) Whether to copy existing tags. Defaults to `false`. * `destination_region` - (Optional) The Destination region to place snapshot copy. * `kms_key_id` - (Optional) KMS key ID. @@ -103,7 +104,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 RdsClusterSnapshotCopy +from imports.aws.rds_cluster_snapshot_copy import RdsClusterSnapshotCopy class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) @@ -116,4 +117,4 @@ Using `terraform import`, import `aws_rds_cluster_snapshot_copy` using the `id`. % terraform import aws_rds_cluster_snapshot_copy.example my-snapshot ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/rds_custom_db_engine_version.markdown b/website/docs/cdktf/python/r/rds_custom_db_engine_version.markdown index 9afc7ff88398..028367cd818d 100644 --- a/website/docs/cdktf/python/r/rds_custom_db_engine_version.markdown +++ b/website/docs/cdktf/python/r/rds_custom_db_engine_version.markdown @@ -136,6 +136,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `database_installation_files_s3_bucket_name` - (Required) The name of the Amazon S3 bucket that contains the database installation files. * `database_installation_files_s3_prefix` - (Required) The prefix for the Amazon S3 bucket that contains the database installation files. * `description` - (Optional) The description of the CEV. @@ -194,4 +195,4 @@ Using `terraform import`, import custom engine versions for Amazon RDS custom us % terraform import aws_rds_custom_db_engine_version.example custom-oracle-ee-cdb:19.cdb_cev1 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/rds_export_task.html.markdown b/website/docs/cdktf/python/r/rds_export_task.html.markdown index f330a762c638..8c36b5bd0c61 100644 --- a/website/docs/cdktf/python/r/rds_export_task.html.markdown +++ b/website/docs/cdktf/python/r/rds_export_task.html.markdown @@ -165,6 +165,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `export_only` - (Optional) Data to be exported from the snapshot. If this parameter is not provided, all the snapshot data is exported. Valid values are documented in the [AWS StartExportTask API documentation](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_StartExportTask.html#API_StartExportTask_RequestParameters). * `s3_prefix` - (Optional) Amazon S3 bucket prefix to use as the file name and path of the exported snapshot. @@ -207,4 +208,4 @@ Using `terraform import`, import a RDS (Relational Database) Export Task using t % terraform import aws_rds_export_task.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/rds_global_cluster.html.markdown b/website/docs/cdktf/python/r/rds_global_cluster.html.markdown index 18724e5525a6..8478d14fc0d2 100644 --- a/website/docs/cdktf/python/r/rds_global_cluster.html.markdown +++ b/website/docs/cdktf/python/r/rds_global_cluster.html.markdown @@ -252,6 +252,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `global_cluster_identifier` - (Required, Forces new resources) Global cluster identifier. * `database_name` - (Optional, Forces new resources) Name for an automatically created database on cluster creation. Terraform will only perform drift detection if a configuration value is provided. * `deletion_protection` - (Optional) If the Global Cluster should have deletion protection enabled. The database can't be deleted when this value is set to `true`. The default is `false`. @@ -334,4 +335,4 @@ class MyConvertedCode(TerraformStack): ) ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/rds_instance_state.html.markdown b/website/docs/cdktf/python/r/rds_instance_state.html.markdown index 1cb55266e45b..d43e47dfeace 100644 --- a/website/docs/cdktf/python/r/rds_instance_state.html.markdown +++ b/website/docs/cdktf/python/r/rds_instance_state.html.markdown @@ -38,16 +38,15 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `identifier` - (Required) DB Instance Identifier * `state` - (Required) Configured state of the DB Instance. Valid values are `available` and `stopped`. ## Attribute Reference -This resource exports the following attributes in addition to the arguments above: - -* `identifier` - DB Instance Identifier +This resource exports no additional attributes. ## Timeouts @@ -58,7 +57,7 @@ This resource exports the following attributes in addition to the arguments abov ## Import -In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import RDS (Relational Database) RDS Instance State using the `example_id_arg`. For example: +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import RDS (Relational Database) RDS Instance State using the `identifier`. For example: ```python # DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -75,10 +74,10 @@ class MyConvertedCode(TerraformStack): RdsInstanceState.generate_config_for_import(self, "example", "db-L72FUFBZX2RRXT3HOJSIUQVOKE") ``` -Using `terraform import`, import RDS (Relational Database) RDS Instance State using the `example_id_arg`. For example: +Using `terraform import`, import RDS (Relational Database) RDS Instance State using the `identifier`. For example: ```console % terraform import aws_rds_instance_state.example rds_instance_state-id-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/rds_integration.html.markdown b/website/docs/cdktf/python/r/rds_integration.html.markdown index 2d3ad6da5285..312d9393faac 100644 --- a/website/docs/cdktf/python/r/rds_integration.html.markdown +++ b/website/docs/cdktf/python/r/rds_integration.html.markdown @@ -126,6 +126,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `additional_encryption_context` - (Optional, Forces new resources) Set of non-secret key–value pairs that contains additional contextual information about the data. For more information, see the [User Guide](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context). You can only include this parameter if you specify the `kms_key_id` parameter. @@ -146,7 +147,7 @@ For more detailed documentation about each argument, refer to the [AWS official This resource exports the following attributes in addition to the arguments above: * `arn` - ARN of the Integration. -* `id` - ID of the Integration. +* `id` - (**Deprecated**, use `arn` instead) ARN of the Integration. * `tags_all` - A map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). ## Timeouts @@ -182,4 +183,4 @@ Using `terraform import`, import RDS (Relational Database) Integration using the % terraform import aws_rds_integration.example arn:aws:rds:us-west-2:123456789012:integration:abcdefgh-0000-1111-2222-123456789012 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/rds_reserved_instance.html.markdown b/website/docs/cdktf/python/r/rds_reserved_instance.html.markdown index ba02ea32fe51..22509f18ef81 100644 --- a/website/docs/cdktf/python/r/rds_reserved_instance.html.markdown +++ b/website/docs/cdktf/python/r/rds_reserved_instance.html.markdown @@ -53,6 +53,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `instance_count` - (Optional) Number of instances to reserve. Default value is `1`. * `reservation_id` - (Optional) Customer-specified identifier to track this reservation. * `tags` - (Optional) Map of tags to assign to the DB reservation. If configured with a provider [`default_tags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. @@ -65,7 +66,7 @@ This resource exports the following attributes in addition to the arguments abov * `id` - Unique identifier for the reservation. same as `reservation_id`. * `currency_code` - Currency code for the reserved DB instance. * `duration` - Duration of the reservation in seconds. -* `fixed_price` – Fixed price charged for this reserved DB instance. +* `fixed_price` - Fixed price charged for this reserved DB instance. * `db_instance_class` - DB instance class for the reserved DB instance. * `lease_id` - Unique identifier for the lease associated with the reserved DB instance. Amazon Web Services Support might request the lease ID for an issue related to a reserved DB instance. * `multi_az` - Whether the reservation applies to Multi-AZ deployments. @@ -110,4 +111,4 @@ Using `terraform import`, import RDS DB Instance Reservations using the `instanc % terraform import aws_rds_reserved_instance.reservation_instance CustomReservationID ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/rds_shard_group.html.markdown b/website/docs/cdktf/python/r/rds_shard_group.html.markdown index 6e7c505fd05c..4236effb29a3 100644 --- a/website/docs/cdktf/python/r/rds_shard_group.html.markdown +++ b/website/docs/cdktf/python/r/rds_shard_group.html.markdown @@ -57,6 +57,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `compute_redundancy` - (Optional) Specifies whether to create standby DB shard groups for the DB shard group. Valid values are: * `0` - Creates a DB shard group without a standby DB shard group. This is the default value. * `1` - Creates a DB shard group with a standby DB shard group in a different Availability Zone (AZ). @@ -112,4 +113,4 @@ Using `terraform import`, import shard group using the `db_shard_group_identifie % terraform import aws_rds_shard_group.example example-shard-group ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/redshift_authentication_profile.html.markdown b/website/docs/cdktf/python/r/redshift_authentication_profile.html.markdown index 23b2e15ede5c..248b22f4e575 100644 --- a/website/docs/cdktf/python/r/redshift_authentication_profile.html.markdown +++ b/website/docs/cdktf/python/r/redshift_authentication_profile.html.markdown @@ -41,6 +41,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `authentication_profile_name` - (Required, Forces new resource) The name of the authentication profile. * `authentication_profile_content` - (Required) The content of the authentication profile in JSON format. The maximum length of the JSON string is determined by a quota for your account. @@ -75,4 +76,4 @@ Using `terraform import`, import Redshift Authentication by `authentication_prof % terraform import aws_redshift_authentication_profile.test example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/redshift_cluster.html.markdown b/website/docs/cdktf/python/r/redshift_cluster.html.markdown index 223f2eeec455..9ee6682e740b 100644 --- a/website/docs/cdktf/python/r/redshift_cluster.html.markdown +++ b/website/docs/cdktf/python/r/redshift_cluster.html.markdown @@ -17,7 +17,7 @@ Provides a Redshift Cluster Resource. ~> **NOTE:** A Redshift cluster's default IAM role can be managed both by this resource's `default_iam_role_arn` argument and the [`aws_redshift_cluster_iam_roles`](redshift_cluster_iam_roles.html) resource's `default_iam_role_arn` argument. Do not configure different values for both arguments. Doing so will cause a conflict of default IAM roles. --> **Note:** Write-Only argument `master_password_wo` is available to use in place of `master_password`. Write-Only arguments are supported in HashiCorp Terraform 1.11.0 and later. [Learn more](https://developer.hashicorp.com/terraform/language/v1.11.x/resources/ephemeral#write-only-arguments). +-> **Note:** Write-Only argument `master_password_wo` is available to use in place of `master_password`. Write-Only arguments are supported in HashiCorp Terraform 1.11.0 and later. [Learn more](https://developer.hashicorp.com/terraform/language/resources/ephemeral#write-only-arguments). ## Example Usage @@ -73,6 +73,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `cluster_identifier` - (Required) The Cluster Identifier. Must be a lower case string. * `database_name` - (Optional) The name of the first database to be created when the cluster is created. If you do not provide a name, Amazon Redshift will create a default database called `dev`. @@ -116,8 +117,9 @@ This resource supports the following arguments: No longer supported by the AWS API. Always returns `auto`. * `number_of_nodes` - (Optional) The number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as multi-node. Default is 1. -* `publicly_accessible` - (Optional) If true, the cluster can be accessed from a public network. Default is `true`. +* `publicly_accessible` - (Optional) If true, the cluster can be accessed from a public network. Default is `false`. * `encrypted` - (Optional) If true , the data in the cluster is encrypted at rest. + Default is `true`. * `enhanced_vpc_routing` - (Optional) If true , enhanced VPC routing is enabled. * `kms_key_id` - (Optional) The ARN for the KMS encryption key. When specifying `kms_key_id`, `encrypted` needs to be set to true. * `elastic_ip` - (Optional) The Elastic IP (EIP) address for the cluster. @@ -128,36 +130,13 @@ This resource supports the following arguments: * `snapshot_cluster_identifier` - (Optional) The name of the cluster the source snapshot was created from. * `owner_account` - (Optional) The AWS customer account used to create or copy the snapshot. Required if you are restoring a snapshot you do not own, optional if you own the snapshot. * `iam_roles` - (Optional) A list of IAM Role ARNs to associate with the cluster. A Maximum of 10 can be associated to the cluster at any time. -* `logging` - (Optional, **Deprecated**) Logging, documented below. * `maintenance_track_name` - (Optional) The name of the maintenance track for the restored cluster. When you take a snapshot, the snapshot inherits the MaintenanceTrack value from the cluster. The snapshot might be on a different track than the cluster that was the source for the snapshot. For example, suppose that you take a snapshot of a cluster that is on the current track and then change the cluster to be on the trailing track. In this case, the snapshot and the source cluster are on different tracks. Default value is `current`. * `manual_snapshot_retention_period` - (Optional) The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots. Valid values are between `-1` and `3653`. Default value is `-1`. -* `snapshot_copy` - (Optional, **Deprecated**) Configuration of automatic copy of snapshots from one region to another. Documented below. * `tags` - (Optional) A 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. For more detailed documentation about each argument, refer to the [AWS official documentation](http://docs.aws.amazon.com/cli/latest/reference/redshift/index.html#cli-aws-redshift). -### Nested Blocks - -#### `logging` - -~> The `logging` argument is deprecated. Use the [`aws_redshift_logging`](./redshift_logging.html.markdown) resource instead. This argument will be removed in a future major version. - -* `enable` - (Required) Enables logging information such as queries and connection attempts, for the specified Amazon Redshift cluster. -* `bucket_name` - (Optional, required when `enable` is `true` and `log_destination_type` is `s3`) The name of an existing S3 bucket where the log files are to be stored. Must be in the same region as the cluster and the cluster must have read bucket and put object permissions. -For more information on the permissions required for the bucket, please read the AWS [documentation](http://docs.aws.amazon.com/redshift/latest/mgmt/db-auditing.html#db-auditing-enable-logging) -* `s3_key_prefix` - (Optional) The prefix applied to the log file names. -* `log_destination_type` - (Optional) The log destination type. An enum with possible values of `s3` and `cloudwatch`. -* `log_exports` - (Optional) The collection of exported log types. Log types include the connection log, user log and user activity log. Required when `log_destination_type` is `cloudwatch`. Valid log types are `connectionlog`, `userlog`, and `useractivitylog`. - -#### `snapshot_copy` - -~> The `snapshot_copy` argument is deprecated. Use the [`aws_redshift_snapshot_copy`](./redshift_snapshot_copy.html.markdown) resource instead. This argument will be removed in a future major version. - -* `destination_region` - (Required) The destination region that you want to copy snapshots to. -* `retention_period` - (Optional) The number of days to retain automated snapshots in the destination region after they are copied from the source region. Defaults to `7`. -* `grant_name` - (Optional) The name of the snapshot copy grant to use when snapshots of an AWS KMS-encrypted cluster are copied to the destination region. - ## Attribute Reference This resource exports the following attributes in addition to the arguments above: @@ -225,4 +204,4 @@ Using `terraform import`, import Redshift Clusters using the `cluster_identifier % terraform import aws_redshift_cluster.myprodcluster tf-redshift-cluster-12345 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/redshift_cluster_iam_roles.html.markdown b/website/docs/cdktf/python/r/redshift_cluster_iam_roles.html.markdown index 269c1b0b4d20..0dca3d4864fb 100644 --- a/website/docs/cdktf/python/r/redshift_cluster_iam_roles.html.markdown +++ b/website/docs/cdktf/python/r/redshift_cluster_iam_roles.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `cluster_identifier` - (Required) The name of the Redshift Cluster IAM Roles. * `iam_role_arns` - (Optional) A list of IAM Role ARNs to associate with the cluster. A Maximum of 10 can be associated to the cluster at any time. * `default_iam_role_arn` - (Optional) The Amazon Resource Name (ARN) for the IAM role that was set as default for the cluster when the cluster was created. @@ -73,4 +74,4 @@ Using `terraform import`, import Redshift Cluster IAM Roless using the `cluster_ % terraform import aws_redshift_cluster_iam_roles.examplegroup1 example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/redshift_cluster_snapshot.html.markdown b/website/docs/cdktf/python/r/redshift_cluster_snapshot.html.markdown index f99a2f11fb9e..974a7afce269 100644 --- a/website/docs/cdktf/python/r/redshift_cluster_snapshot.html.markdown +++ b/website/docs/cdktf/python/r/redshift_cluster_snapshot.html.markdown @@ -42,6 +42,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `cluster_identifier` - (Required, Forces new resource) The cluster identifier for which you want a snapshot. * `snapshot_identifier` - (Required, Forces new resource) A unique identifier for the snapshot that you are requesting. This identifier must be unique for all snapshots within the Amazon Web Services account. * `manual_snapshot_retention_period` - (Optional) The number of days that a manual snapshot is retained. If the value is `-1`, the manual snapshot is retained indefinitely. Valid values are -1 and between `1` and `3653`. @@ -82,4 +83,4 @@ Using `terraform import`, import Redshift Cluster Snapshots using `snapshot_iden % terraform import aws_redshift_cluster_snapshot.test example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/redshift_data_share_authorization.html.markdown b/website/docs/cdktf/python/r/redshift_data_share_authorization.html.markdown index d7d048b55958..c742621a29cb 100644 --- a/website/docs/cdktf/python/r/redshift_data_share_authorization.html.markdown +++ b/website/docs/cdktf/python/r/redshift_data_share_authorization.html.markdown @@ -42,6 +42,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `allow_writes` - (Optional) Whether to allow write operations for a datashare. ## Attribute Reference @@ -77,4 +78,4 @@ Using `terraform import`, import Redshift Data Share Authorization using the `id % terraform import aws_redshift_data_share_authorization.example arn:aws:redshift:us-west-2:123456789012:datashare:3072dae5-022b-4d45-9cd3-01f010aae4b2/example_share,123456789012 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/redshift_data_share_consumer_association.html.markdown b/website/docs/cdktf/python/r/redshift_data_share_consumer_association.html.markdown index 37638683a100..92d61a467117 100644 --- a/website/docs/cdktf/python/r/redshift_data_share_consumer_association.html.markdown +++ b/website/docs/cdktf/python/r/redshift_data_share_consumer_association.html.markdown @@ -61,6 +61,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `allow_writes` - (Optional) Whether to allow write operations for a datashare. * `associate_entire_account` - (Optional) Whether the datashare is associated with the entire account. Conflicts with `consumer_arn` and `consumer_region`. * `consumer_arn` - (Optional) Amazon Resource Name (ARN) of the consumer that is associated with the datashare. Conflicts with `associate_entire_account` and `consumer_region`. @@ -99,4 +100,4 @@ Using `terraform import`, import Redshift Data Share Consumer Association using % terraform import aws_redshift_data_share_consumer_association.example arn:aws:redshift:us-west-2:123456789012:datashare:b3bfde75-73fd-408b-9086-d6fccfd6d588/example,,,us-west-2 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/redshift_endpoint_access.html.markdown b/website/docs/cdktf/python/r/redshift_endpoint_access.html.markdown index 096c76763f98..d3aaaa24a601 100644 --- a/website/docs/cdktf/python/r/redshift_endpoint_access.html.markdown +++ b/website/docs/cdktf/python/r/redshift_endpoint_access.html.markdown @@ -37,6 +37,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `cluster_identifier` - (Required) The cluster identifier of the cluster to access. * `endpoint_name` - (Required) The Redshift-managed VPC endpoint name. * `resource_owner` - (Optional) The Amazon Web Services account ID of the owner of the cluster. This is only required if the cluster is in another Amazon Web Services account. @@ -90,4 +91,4 @@ Using `terraform import`, import Redshift endpoint access using the `name`. For % terraform import aws_redshift_endpoint_access.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/redshift_endpoint_authorization.html.markdown b/website/docs/cdktf/python/r/redshift_endpoint_authorization.html.markdown index b4167f0ce9d6..2f3c52ef17e3 100644 --- a/website/docs/cdktf/python/r/redshift_endpoint_authorization.html.markdown +++ b/website/docs/cdktf/python/r/redshift_endpoint_authorization.html.markdown @@ -36,6 +36,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `account` - (Required) The Amazon Web Services account ID to grant access to. * `cluster_identifier` - (Required) The cluster identifier of the cluster to grant access to. * `force_delete` - (Optional) Indicates whether to force the revoke action. If true, the Redshift-managed VPC endpoints associated with the endpoint authorization are also deleted. Default value is `false`. @@ -76,4 +77,4 @@ Using `terraform import`, import Redshift endpoint authorization using the `id`. % terraform import aws_redshift_endpoint_authorization.example 01234567910:cluster-example-id ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/redshift_event_subscription.html.markdown b/website/docs/cdktf/python/r/redshift_event_subscription.html.markdown index 221b0e29a759..8449c648389a 100644 --- a/website/docs/cdktf/python/r/redshift_event_subscription.html.markdown +++ b/website/docs/cdktf/python/r/redshift_event_subscription.html.markdown @@ -58,6 +58,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) The name of the Redshift event subscription. * `sns_topic_arn` - (Required) The ARN of the SNS topic to send events to. * `source_ids` - (Optional) A list of identifiers of the event sources for which events will be returned. If not specified, then all sources are included in the response. If specified, a `source_type` must also be specified. @@ -101,4 +102,4 @@ Using `terraform import`, import Redshift Event Subscriptions using the `name`. % terraform import aws_redshift_event_subscription.default redshift-event-sub ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/redshift_hsm_client_certificate.html.markdown b/website/docs/cdktf/python/r/redshift_hsm_client_certificate.html.markdown index 8c071c7ca097..99d6741ffa5a 100644 --- a/website/docs/cdktf/python/r/redshift_hsm_client_certificate.html.markdown +++ b/website/docs/cdktf/python/r/redshift_hsm_client_certificate.html.markdown @@ -35,6 +35,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `hsm_client_certificate_identifier` - (Required, Forces new resource) The identifier of the HSM client certificate. * `tags` - (Optional) A 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. @@ -71,4 +72,4 @@ Using `terraform import`, import Redshift HSM Client Certificates using `hsm_cli % terraform import aws_redshift_hsm_client_certificate.test example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/redshift_hsm_configuration.html.markdown b/website/docs/cdktf/python/r/redshift_hsm_configuration.html.markdown index 324d54a21d41..5fc98cfadcd7 100644 --- a/website/docs/cdktf/python/r/redshift_hsm_configuration.html.markdown +++ b/website/docs/cdktf/python/r/redshift_hsm_configuration.html.markdown @@ -40,6 +40,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `description` - (Required, Forces new resource) A text description of the HSM configuration to be created. * `hsm_configuration_identifier` - (Required, Forces new resource) The identifier to be assigned to the new Amazon Redshift HSM configuration. * `hsm_ip_address` - (Required, Forces new resource) The IP address that the Amazon Redshift cluster must use to access the HSM. @@ -81,4 +82,4 @@ Using `terraform import`, import Redshift HSM Client Certificates using `hsm_con % terraform import aws_redshift_hsm_configuration.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/redshift_integration.html.markdown b/website/docs/cdktf/python/r/redshift_integration.html.markdown index a0f413381006..2ace33141d20 100644 --- a/website/docs/cdktf/python/r/redshift_integration.html.markdown +++ b/website/docs/cdktf/python/r/redshift_integration.html.markdown @@ -153,6 +153,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `additional_encryption_context` - (Optional, Forces new resources) Set of non-secret key–value pairs that contains additional contextual information about the data. For more information, see the [User Guide](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context). You can only include this parameter if you specify the `kms_key_id` parameter. @@ -204,4 +205,4 @@ Using `terraform import`, import Redshift Integration using the `arn`. For examp % terraform import aws_redshift_integration.example arn:aws:redshift:us-west-2:123456789012:integration:abcdefgh-0000-1111-2222-123456789012 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/redshift_logging.html.markdown b/website/docs/cdktf/python/r/redshift_logging.html.markdown index ea5f0afdde7f..85d68792e164 100644 --- a/website/docs/cdktf/python/r/redshift_logging.html.markdown +++ b/website/docs/cdktf/python/r/redshift_logging.html.markdown @@ -64,6 +64,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `bucket_name` - (Optional) Name of an existing S3 bucket where the log files are to be stored. Required when `log_destination_type` is `s3`. Must be in the same region as the cluster and the cluster must have read bucket and put object permissions. For more information on the permissions required for the bucket, please read the AWS [documentation](http://docs.aws.amazon.com/redshift/latest/mgmt/db-auditing.html#db-auditing-enable-logging) * `log_destination_type` - (Optional) Log destination type. Valid values are `s3` and `cloudwatch`. * `log_exports` - (Optional) Collection of exported log types. Required when `log_destination_type` is `cloudwatch`. Valid values are `connectionlog`, `useractivitylog`, and `userlog`. @@ -73,7 +74,7 @@ The following arguments are optional: This resource exports the following attributes in addition to the arguments above: -* `id` - Identifier of the source cluster. +* `id` - (**Deprecated**, use `cluster_identifier` instead) Identifier of the source cluster. ## Import @@ -100,4 +101,4 @@ Using `terraform import`, import Redshift Logging using the `id`. For example: % terraform import aws_redshift_logging.example cluster-id-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/redshift_parameter_group.html.markdown b/website/docs/cdktf/python/r/redshift_parameter_group.html.markdown index 8336e634cebd..c442e7094b5e 100644 --- a/website/docs/cdktf/python/r/redshift_parameter_group.html.markdown +++ b/website/docs/cdktf/python/r/redshift_parameter_group.html.markdown @@ -47,6 +47,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) The name of the Redshift parameter group. * `family` - (Required) The family of the Redshift parameter group. * `description` - (Optional) The description of the Redshift parameter group. Defaults to "Managed by Terraform". @@ -93,4 +94,4 @@ Using `terraform import`, import Redshift Parameter Groups using the `name`. For % terraform import aws_redshift_parameter_group.paramgroup1 parameter-group-test-terraform ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/redshift_partner.html.markdown b/website/docs/cdktf/python/r/redshift_partner.html.markdown index 62cd986322d0..400fa7174440 100644 --- a/website/docs/cdktf/python/r/redshift_partner.html.markdown +++ b/website/docs/cdktf/python/r/redshift_partner.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `account_id` - (Required) The Amazon Web Services account ID that owns the cluster. * `cluster_identifier` - (Required) The cluster identifier of the cluster that receives data from the partner. * `database_name` - (Required) The name of the database that receives data from the partner. @@ -76,4 +77,4 @@ Using `terraform import`, import Redshift usage limits using the `id`. For examp % terraform import aws_redshift_partner.example 01234567910:cluster-example-id:example:example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/redshift_resource_policy.html.markdown b/website/docs/cdktf/python/r/redshift_resource_policy.html.markdown index 84bc2daacdae..649ad8faa906 100644 --- a/website/docs/cdktf/python/r/redshift_resource_policy.html.markdown +++ b/website/docs/cdktf/python/r/redshift_resource_policy.html.markdown @@ -49,6 +49,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `resource_arn` - (Required) The Amazon Resource Name (ARN) of the account to create or update a resource policy for. * `policy` - (Required) The content of the resource policy being updated. @@ -83,4 +84,4 @@ Using `terraform import`, import Redshift Resource Policies using the `resource_ % terraform import aws_redshift_resource_policy.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/redshift_scheduled_action.html.markdown b/website/docs/cdktf/python/r/redshift_scheduled_action.html.markdown index 376c8109f2d4..906f53c4d42d 100644 --- a/website/docs/cdktf/python/r/redshift_scheduled_action.html.markdown +++ b/website/docs/cdktf/python/r/redshift_scheduled_action.html.markdown @@ -116,6 +116,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) The scheduled action name. * `description` - (Optional) The description of the scheduled action. * `enable` - (Optional) Whether to enable the scheduled action. Default is `true` . @@ -180,4 +181,4 @@ Using `terraform import`, import Redshift Scheduled Action using the `name`. For % terraform import aws_redshift_scheduled_action.example tf-redshift-scheduled-action ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/redshift_snapshot_copy.html.markdown b/website/docs/cdktf/python/r/redshift_snapshot_copy.html.markdown index 952f6bd0d010..70dc9ef979a3 100644 --- a/website/docs/cdktf/python/r/redshift_snapshot_copy.html.markdown +++ b/website/docs/cdktf/python/r/redshift_snapshot_copy.html.markdown @@ -42,6 +42,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `manual_snapshot_retention_period` - (Optional) Number of days to retain newly copied snapshots in the destination AWS Region after they are copied from the source AWS Region. If the value is `-1`, the manual snapshot is retained indefinitely. * `retention_period` - (Optional) Number of days to retain automated snapshots in the destination region after they are copied from the source region. * `snapshot_copy_grant_name` - (Optional) Name of the snapshot copy grant to use when snapshots of an AWS KMS-encrypted cluster are copied to the destination region. @@ -77,4 +78,4 @@ Using `terraform import`, import Redshift Snapshot Copy using the `id`. For exam % terraform import aws_redshift_snapshot_copy.example cluster-id-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/redshift_snapshot_copy_grant.html.markdown b/website/docs/cdktf/python/r/redshift_snapshot_copy_grant.html.markdown index 6b298bb18d61..d20f1a19a147 100644 --- a/website/docs/cdktf/python/r/redshift_snapshot_copy_grant.html.markdown +++ b/website/docs/cdktf/python/r/redshift_snapshot_copy_grant.html.markdown @@ -33,10 +33,11 @@ class MyConvertedCode(TerraformStack): snapshot_copy_grant_name="my-grant" ) aws_redshift_cluster_test = RedshiftCluster(self, "test_1", - snapshot_copy=RedshiftClusterSnapshotCopy( - destination_region="us-east-2", - grant_name=test.snapshot_copy_grant_name - ), + snapshot_copy=[{ + "destination_region": "us-east-2", + "grant_name": test.snapshot_copy_grant_name + } + ], cluster_identifier=cluster_identifier, node_type=node_type ) @@ -48,6 +49,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `snapshot_copy_grant_name` - (Required, Forces new resource) A friendly name for identifying the grant. * `kms_key_id` - (Optional, Forces new resource) The unique identifier for the customer master key (CMK) that the grant applies to. Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS account, you must use the key ARN. If not specified, the default key is used. * `tags` - (Optional) A 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. @@ -84,4 +86,4 @@ Using `terraform import`, import Redshift Snapshot Copy Grants by name. For exam % terraform import aws_redshift_snapshot_copy_grant.test my-grant ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/redshift_snapshot_schedule.html.markdown b/website/docs/cdktf/python/r/redshift_snapshot_schedule.html.markdown index 35fd25ea9f5a..83064f8515be 100644 --- a/website/docs/cdktf/python/r/redshift_snapshot_schedule.html.markdown +++ b/website/docs/cdktf/python/r/redshift_snapshot_schedule.html.markdown @@ -34,6 +34,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `identifier` - (Optional, Forces new resource) The snapshot schedule identifier. If omitted, Terraform will assign a random, unique identifier. * `identifier_prefix` - (Optional, Forces new resource) Creates a unique identifier beginning with the specified prefix. Conflicts with `identifier`. @@ -74,4 +75,4 @@ Using `terraform import`, import Redshift Snapshot Schedule using the `identifie % terraform import aws_redshift_snapshot_schedule.default tf-redshift-snapshot-schedule ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/redshift_snapshot_schedule_association.html.markdown b/website/docs/cdktf/python/r/redshift_snapshot_schedule_association.html.markdown index 7f79ccd8b9db..e9b098843b7a 100644 --- a/website/docs/cdktf/python/r/redshift_snapshot_schedule_association.html.markdown +++ b/website/docs/cdktf/python/r/redshift_snapshot_schedule_association.html.markdown @@ -53,6 +53,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `cluster_identifier` - (Required, Forces new resource) The cluster identifier. * `schedule_identifier` - (Required, Forces new resource) The snapshot schedule identifier. @@ -85,4 +86,4 @@ Using `terraform import`, import Redshift Snapshot Schedule Association using th % terraform import aws_redshift_snapshot_schedule_association.default tf-redshift-cluster/tf-redshift-snapshot-schedule ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/redshift_subnet_group.html.markdown b/website/docs/cdktf/python/r/redshift_subnet_group.html.markdown index e7a42d979a7a..9263c35c6319 100644 --- a/website/docs/cdktf/python/r/redshift_subnet_group.html.markdown +++ b/website/docs/cdktf/python/r/redshift_subnet_group.html.markdown @@ -64,6 +64,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) The name of the Redshift Subnet group. * `description` - (Optional) The description of the Redshift Subnet group. Defaults to "Managed by Terraform". * `subnet_ids` - (Required) An array of VPC subnet IDs. @@ -102,4 +103,4 @@ Using `terraform import`, import Redshift subnet groups using the `name`. For ex % terraform import aws_redshift_subnet_group.testgroup1 test-cluster-subnet-group ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/redshift_usage_limit.html.markdown b/website/docs/cdktf/python/r/redshift_usage_limit.html.markdown index 656abdd43e21..99867a7c1ac8 100644 --- a/website/docs/cdktf/python/r/redshift_usage_limit.html.markdown +++ b/website/docs/cdktf/python/r/redshift_usage_limit.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `amount` - (Required) The limit amount. If time-based, this amount is in minutes. If data-based, this amount is in terabytes (TB). The value must be a positive number. * `breach_action` - (Optional) The action that Amazon Redshift takes when the limit is reached. The default is `log`. Valid values are `log`, `emit-metric`, and `disable`. * `cluster_identifier` - (Required) The identifier of the cluster that you want to limit usage. @@ -79,4 +80,4 @@ Using `terraform import`, import Redshift usage limits using the `id`. For examp % terraform import aws_redshift_usage_limit.example example-id ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/redshiftdata_statement.html.markdown b/website/docs/cdktf/python/r/redshiftdata_statement.html.markdown index ca5c9c5700f9..f7dfa663a01d 100644 --- a/website/docs/cdktf/python/r/redshiftdata_statement.html.markdown +++ b/website/docs/cdktf/python/r/redshiftdata_statement.html.markdown @@ -66,6 +66,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `cluster_identifier` - (Optional) The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials. * `db_user` - (Optional) The database user name. * `secret_arn` - (Optional) The name or ARN of the secret that enables access to the database. @@ -104,4 +105,4 @@ Using `terraform import`, import Redshift Data Statements using the `id`. For ex % terraform import aws_redshiftdata_statement.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/redshiftserverless_custom_domain_association.html.markdown b/website/docs/cdktf/python/r/redshiftserverless_custom_domain_association.html.markdown index f3a906c49215..3c2256bacce2 100644 --- a/website/docs/cdktf/python/r/redshiftserverless_custom_domain_association.html.markdown +++ b/website/docs/cdktf/python/r/redshiftserverless_custom_domain_association.html.markdown @@ -56,8 +56,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `workgroup_name` - (Required) Name of the workgroup. * `custom_domain_name` - (Required) Custom domain to associate with the workgroup. * `custom_domain_certificate_arn` - (Required) ARN of the certificate for the custom domain association. @@ -93,4 +94,4 @@ Using `terraform import`, import Redshift Serverless Custom Domain Association u % terraform import aws_redshiftserverless_custom_domain_association.example example-workgroup,example.com ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/redshiftserverless_endpoint_access.html.markdown b/website/docs/cdktf/python/r/redshiftserverless_endpoint_access.html.markdown index f22a76699701..071bf6069001 100644 --- a/website/docs/cdktf/python/r/redshiftserverless_endpoint_access.html.markdown +++ b/website/docs/cdktf/python/r/redshiftserverless_endpoint_access.html.markdown @@ -37,6 +37,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `endpoint_name` - (Required) The name of the endpoint. * `owner_account` - (Optional) The owner Amazon Web Services account for the Amazon Redshift Serverless workgroup. * `subnet_ids` - (Required) An array of VPC subnet IDs to associate with the endpoint. @@ -91,4 +92,4 @@ Using `terraform import`, import Redshift Serverless Endpoint Access using the ` % terraform import aws_redshiftserverless_endpoint_access.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/redshiftserverless_namespace.html.markdown b/website/docs/cdktf/python/r/redshiftserverless_namespace.html.markdown index 83f956cab14f..6be99cc98574 100644 --- a/website/docs/cdktf/python/r/redshiftserverless_namespace.html.markdown +++ b/website/docs/cdktf/python/r/redshiftserverless_namespace.html.markdown @@ -12,7 +12,7 @@ description: |- Creates a new Amazon Redshift Serverless Namespace. --> **Note:** Write-Only argument `admin_password_wo` is available to use in place of `admin_password`. Write-Only arguments are supported in HashiCorp Terraform 1.11.0 and later. [Learn more](https://developer.hashicorp.com/terraform/language/v1.11.x/resources/ephemeral#write-only-arguments). +-> **Note:** Write-Only argument `admin_password_wo` is available to use in place of `admin_password`. Write-Only arguments are supported in HashiCorp Terraform 1.11.0 and later. [Learn more](https://developer.hashicorp.com/terraform/language/resources/ephemeral#write-only-arguments). ## Example Usage @@ -37,6 +37,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `admin_password_secret_kms_key_id` - (Optional) ID of the KMS key used to encrypt the namespace's admin credentials secret. * `admin_user_password` - (Optional) The password of the administrator for the first database created in the namespace. Conflicts with `manage_admin_password` and `admin_user_password_wo`. @@ -89,4 +90,4 @@ Using `terraform import`, import Redshift Serverless Namespaces using the `names % terraform import aws_redshiftserverless_namespace.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/redshiftserverless_resource_policy.html.markdown b/website/docs/cdktf/python/r/redshiftserverless_resource_policy.html.markdown index 5f73a6baa3cd..3ecf0413e818 100644 --- a/website/docs/cdktf/python/r/redshiftserverless_resource_policy.html.markdown +++ b/website/docs/cdktf/python/r/redshiftserverless_resource_policy.html.markdown @@ -48,6 +48,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `resource_arn` - (Required) The Amazon Resource Name (ARN) of the account to create or update a resource policy for. * `policy` - (Required) The policy to create or update. For example, the following policy grants a user authorization to restore a snapshot. @@ -82,4 +83,4 @@ Using `terraform import`, import Redshift Serverless Resource Policies using the % terraform import aws_redshiftserverless_resource_policy.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/redshiftserverless_snapshot.html.markdown b/website/docs/cdktf/python/r/redshiftserverless_snapshot.html.markdown index c3b3cceebb3e..91665e59c00e 100644 --- a/website/docs/cdktf/python/r/redshiftserverless_snapshot.html.markdown +++ b/website/docs/cdktf/python/r/redshiftserverless_snapshot.html.markdown @@ -36,6 +36,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `namespace_name` - (Required) The namespace to create a snapshot for. * `snapshot_name` - (Required) The name of the snapshot. * `retention_period` - (Optional) How long to retain the created snapshot. Default value is `-1`. @@ -78,4 +79,4 @@ Using `terraform import`, import Redshift Serverless Snapshots using the `snapsh % terraform import aws_redshiftserverless_snapshot.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/redshiftserverless_usage_limit.html.markdown b/website/docs/cdktf/python/r/redshiftserverless_usage_limit.html.markdown index 79f890e4339e..d3b2bc9fbe77 100644 --- a/website/docs/cdktf/python/r/redshiftserverless_usage_limit.html.markdown +++ b/website/docs/cdktf/python/r/redshiftserverless_usage_limit.html.markdown @@ -45,6 +45,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `amount` - (Required) The limit amount. If time-based, this amount is in Redshift Processing Units (RPU) consumed per hour. If data-based, this amount is in terabytes (TB) of data transferred between Regions in cross-account sharing. The value must be a positive number. * `breach_action` - (Optional) The action that Amazon Redshift Serverless takes when the limit is reached. Valid values are `log`, `emit-metric`, and `deactivate`. The default is `log`. * `period` - (Optional) The time period that the amount applies to. A weekly period begins on Sunday. Valid values are `daily`, `weekly`, and `monthly`. The default is `monthly`. @@ -83,4 +84,4 @@ Using `terraform import`, import Redshift Serverless Usage Limits using the `id` % terraform import aws_redshiftserverless_usage_limit.example example-id ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/redshiftserverless_workgroup.html.markdown b/website/docs/cdktf/python/r/redshiftserverless_workgroup.html.markdown index ae01db334173..9f49abf1bee5 100644 --- a/website/docs/cdktf/python/r/redshiftserverless_workgroup.html.markdown +++ b/website/docs/cdktf/python/r/redshiftserverless_workgroup.html.markdown @@ -41,6 +41,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `base_capacity` - (Optional) The base data warehouse capacity of the workgroup in Redshift Processing Units (RPUs). * `price_performance_target` - (Optional) Price-performance scaling for the workgroup. See `Price Performance Target` below. * `config_parameter` - (Optional) An array of parameters to set for more control over a serverless database. See `Config Parameter` below. @@ -125,4 +126,4 @@ Using `terraform import`, import Redshift Serverless Workgroups using the `workg % terraform import aws_redshiftserverless_workgroup.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/rekognition_collection.html.markdown b/website/docs/cdktf/python/r/rekognition_collection.html.markdown index ec87ee60849a..4f69883b9775 100644 --- a/website/docs/cdktf/python/r/rekognition_collection.html.markdown +++ b/website/docs/cdktf/python/r/rekognition_collection.html.markdown @@ -42,6 +42,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `tags` - (Optional) Map of tags assigned to the resource. If configured with a provider [`default_tags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. ## Attribute Reference @@ -60,7 +61,7 @@ This resource exports the following attributes in addition to the arguments abov ## Import -In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import Rekognition Collection using the `example_id_arg`. For example: +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import Rekognition Collection using the `collection_id`. For example: ```python # DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -77,10 +78,10 @@ class MyConvertedCode(TerraformStack): RekognitionCollection.generate_config_for_import(self, "example", "collection-id-12345678") ``` -Using `terraform import`, import Rekognition Collection using the `example_id_arg`. For example: +Using `terraform import`, import Rekognition Collection using the `collection_id`. For example: ```console % terraform import aws_rekognition_collection.example collection-id-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/rekognition_project.html.markdown b/website/docs/cdktf/python/r/rekognition_project.html.markdown index df905a7cf54a..2b65556f292f 100644 --- a/website/docs/cdktf/python/r/rekognition_project.html.markdown +++ b/website/docs/cdktf/python/r/rekognition_project.html.markdown @@ -14,6 +14,8 @@ Terraform resource for managing an AWS Rekognition Project. ## Example Usage +### Content Moderation + ```python # DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug from constructs import Construct @@ -33,6 +35,26 @@ class MyConvertedCode(TerraformStack): ) ``` +### Custom Labels + +```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.rekognition_project import RekognitionProject +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + RekognitionProject(self, "example", + feature="CUSTOM_LABELS", + name="example-project" + ) +``` + ## Argument Reference The following arguments are required: @@ -41,7 +63,8 @@ The following arguments are required: The following arguments are optional: -* `auto_update` - (Optional) Specify if automatic retraining should occur. Valid values are `ENABLED` or `DISABLED`. Defaults to `DISABLED`. +* `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). +* `auto_update` - (Optional) Specify if automatic retraining should occur. Valid values are `ENABLED` or `DISABLED`. Must be set when `feature` is `CONTENT_MODERATION`, but do not set otherwise. * `feature` - (Optional) Specify the feature being customized. Valid values are `CONTENT_MODERATION` or `CUSTOM_LABELS`. Defaults to `CUSTOM_LABELS`. * `tags` - (Optional) Map of tags assigned to the resource. If configured with a provider [`default_tags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. @@ -61,7 +84,7 @@ This resource exports the following attributes in addition to the arguments abov ## Import -In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import Rekognition Project using the `example_id_arg`. For example: +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import Rekognition Project using the `name`. For example: ```python # DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -84,4 +107,4 @@ Using `terraform import`, import Rekognition Project using the `name`. For examp % terraform import aws_rekognition_project.example project-id-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/rekognition_stream_processor.html.markdown b/website/docs/cdktf/python/r/rekognition_stream_processor.html.markdown index a7054f922035..3863627aa762 100644 --- a/website/docs/cdktf/python/r/rekognition_stream_processor.html.markdown +++ b/website/docs/cdktf/python/r/rekognition_stream_processor.html.markdown @@ -257,6 +257,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `data_sharing_preference` - (Optional) See [`data_sharing_preference`](#data_sharing_preference). * `kms_key_id` - (Optional) Optional parameter for label detection stream processors. * `notification_channel` - (Optional) The Amazon Simple Notification Service topic to which Amazon Rekognition publishes the completion status. See [`notification_channel`](#notification_channel). @@ -371,4 +372,4 @@ Using `terraform import`, import Rekognition Stream Processor using the `name`. % terraform import aws_rekognition_stream_processor.example my-stream ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/resiliencehub_resiliency_policy.html.markdown b/website/docs/cdktf/python/r/resiliencehub_resiliency_policy.html.markdown index d32cef3f3fd7..beca9672fdc3 100644 --- a/website/docs/cdktf/python/r/resiliencehub_resiliency_policy.html.markdown +++ b/website/docs/cdktf/python/r/resiliencehub_resiliency_policy.html.markdown @@ -30,28 +30,28 @@ class MyConvertedCode(TerraformStack): data_location_constraint="AnyLocation", description="testexample", name="testexample", - policy=[{ - "az": [{ - "rpo": "24h", - "rto": "24h" - } + policy=[ResiliencehubResiliencyPolicyPolicy( + az=[ResiliencehubResiliencyPolicyPolicyAz( + rpo="24h", + rto="24h" + ) ], - "hardware": [{ - "rpo": "24h", - "rto": "24h" - } + hardware=[ResiliencehubResiliencyPolicyPolicyHardware( + rpo="24h", + rto="24h" + ) ], - "region": [{ - "rpo": "24h", - "rto": "24h" - } + region=[ResiliencehubResiliencyPolicyPolicyRegion( + rpo="24h", + rto="24h" + ) ], - "software_attribute": [{ - "rpo": "24h", - "rto": "24h" - } + software_attribute=[ResiliencehubResiliencyPolicyPolicySoftware( + rpo="24h", + rto="24h" + ) ] - } + ) ], tier="NonCritical" ) @@ -70,6 +70,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `description` (String) Description of Resiliency Policy. * `data_location_constraint` (String) Data Location Constraint of the Policy. Valid values are `AnyLocation`, `SameContinent`, and `SameCountry`. @@ -85,6 +86,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `region` - (Attributes) Specifies Region failure policy. [`policy.region`](#policyregion) ### `policy.az` @@ -164,4 +166,4 @@ Using `terraform import`, import Resilience Hub Resiliency Policy using the `arn % terraform import aws_resiliencehub_resiliency_policy.example arn:aws:resiliencehub:us-east-1:123456789012:resiliency-policy/8c1cfa29-d1dd-4421-aa68-c9f64cced4c2 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/resourceexplorer2_index.html.markdown b/website/docs/cdktf/python/r/resourceexplorer2_index.html.markdown index c1512149ae8e..a5f2c0e8d50a 100644 --- a/website/docs/cdktf/python/r/resourceexplorer2_index.html.markdown +++ b/website/docs/cdktf/python/r/resourceexplorer2_index.html.markdown @@ -35,6 +35,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `type` - (Required) The type of the index. Valid values: `AGGREGATOR`, `LOCAL`. To understand the difference between `LOCAL` and `AGGREGATOR`, see the [_AWS Resource Explorer User Guide_](https://docs.aws.amazon.com/resource-explorer/latest/userguide/manage-aggregator-region.html). * `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. @@ -78,4 +79,4 @@ Using `terraform import`, import Resource Explorer indexes using the `arn`. For % terraform import aws_resourceexplorer2_index.example arn:aws:resource-explorer-2:us-east-1:123456789012:index/6047ac4e-207e-4487-9bcf-cb53bb0ff5cc ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/resourceexplorer2_view.html.markdown b/website/docs/cdktf/python/r/resourceexplorer2_view.html.markdown index 4f5af2bf1d68..00636e897a43 100644 --- a/website/docs/cdktf/python/r/resourceexplorer2_view.html.markdown +++ b/website/docs/cdktf/python/r/resourceexplorer2_view.html.markdown @@ -50,6 +50,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `default_view` - (Optional) Specifies whether the view is the [_default view_](https://docs.aws.amazon.com/resource-explorer/latest/userguide/manage-views-about.html#manage-views-about-default) for the AWS Region. Default: `false`. * `filters` - (Optional) Specifies which resources are included in the results of queries made using this view. See [Filters](#filters) below for more details. * `included_property` - (Optional) Optional fields to be included in search results from this view. See [Included Properties](#included-properties) below for more details. @@ -101,4 +102,4 @@ Using `terraform import`, import Resource Explorer views using the `arn`. For ex % terraform import aws_resourceexplorer2_view.example arn:aws:resource-explorer-2:us-west-2:123456789012:view/exampleview/e0914f6c-6c27-4b47-b5d4-6b28381a2421 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/resourcegroups_group.html.markdown b/website/docs/cdktf/python/r/resourcegroups_group.html.markdown index c6777a484369..7eb1c38c362c 100644 --- a/website/docs/cdktf/python/r/resourcegroups_group.html.markdown +++ b/website/docs/cdktf/python/r/resourcegroups_group.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) The resource group's name. A resource group name can have a maximum of 127 characters, including letters, numbers, hyphens, dots, and underscores. The name cannot start with `AWS` or `aws`. * `configuration` - (Optional) A configuration associates the resource group with an AWS service and specifies how the service can interact with the resources in the group. See below for details. * `description` - (Optional) A description of the resource group. @@ -91,4 +92,4 @@ Using `terraform import`, import resource groups using the `name`. For example: % terraform import aws_resourcegroups_group.foo resource-group-name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/resourcegroups_resource.html.markdown b/website/docs/cdktf/python/r/resourcegroups_resource.html.markdown index baa6da89b3f4..ec67152fd639 100644 --- a/website/docs/cdktf/python/r/resourcegroups_resource.html.markdown +++ b/website/docs/cdktf/python/r/resourcegroups_resource.html.markdown @@ -51,8 +51,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `group_arn` - (Required) Name or ARN of the resource group to add resources to. * `resource_arn` - (Required) ARN of the resource to be added to the group. @@ -95,4 +96,4 @@ Using `terraform import`, import an AWS Resource Groups Resource using `group_ar % terraform import aws_resourcegroups_resource.example arn:aws:resource-groups:us-west-2:012345678901:group/example,arn:aws:lambda:us-west-2:012345678901:function:example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/route.html.markdown b/website/docs/cdktf/python/r/route.html.markdown index cd7681e9749a..5ec8e2a985c0 100644 --- a/website/docs/cdktf/python/r/route.html.markdown +++ b/website/docs/cdktf/python/r/route.html.markdown @@ -73,6 +73,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `route_table_id` - (Required) The ID of the routing table. One of the following destination arguments must be supplied: @@ -118,6 +119,46 @@ This resource exports the following attributes in addition to the arguments abov ## Import +In Terraform v1.12.0 and later, the [`import` block](https://developer.hashicorp.com/terraform/language/import) can be used with the `identity` attribute. For example: + +```terraform +import { + to = aws_route.example + identity = { + route_table_id = "rtb-656C65616E6F72" + destination_cidr_block = "10.42.0.0/16" + + ### OR by IPv6 CIDR block + # destination_ipv6_cidr_block = "10.42.0.0/16" + + ### OR by prefix list ID + # destination_prefix_list_id = "pl-0570a1d2d725c16be" + } +} + +resource "aws_route" "example" { + route_table_id = "rtb-656C65616E6F72" + destination_cidr_block = "10.42.0.0/16" + vpc_peering_connection_id = "pcx-45ff3dc1" +} +``` + +### Identity Schema + +#### Required + +- `route_table_id` - (String) ID of the route table. + +#### Optional + +~> Exactly one of of `destination_cidr_block`, `destination_ipv6_cidr_block`, or `destination_prefix_list_id` is required. + +- `account_id` (String) AWS Account where this resource is managed. +- `destination_cidr_block` - (String) Destination IPv4 CIDR block. +- `destination_ipv6_cidr_block` - (String) Destination IPv6 CIDR block. +- `destination_prefix_list_id` - (String) Destination IPv6 CIDR block. +- `region` (String) Region where this resource is managed. + In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import individual routes using `ROUTETABLEID_DESTINATION`. Import [local routes](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Route_Tables.html#RouteTables) using the VPC's IPv4 or IPv6 CIDR blocks. For example: Import a route in route table `rtb-656C65616E6F72` with an IPv4 destination CIDR of `10.42.0.0/16`: @@ -191,4 +232,4 @@ Import a route in route table `rtb-656C65616E6F72` with a managed prefix list de % terraform import aws_route.my_route rtb-656C65616E6F72_pl-0570a1d2d725c16be ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/route53_resolver_config.html.markdown b/website/docs/cdktf/python/r/route53_resolver_config.html.markdown index a5583b43f6fb..ceaec0cf67d1 100644 --- a/website/docs/cdktf/python/r/route53_resolver_config.html.markdown +++ b/website/docs/cdktf/python/r/route53_resolver_config.html.markdown @@ -44,6 +44,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `resource_id` - (Required) The ID of the VPC that the configuration is for. * `autodefined_reverse_flag` - (Required) Indicates whether or not the Resolver will create autodefined rules for reverse DNS lookups. Valid values: `ENABLE`, `DISABLE`. @@ -79,4 +80,4 @@ Using `terraform import`, import Route 53 Resolver configs using the Route 53 Re % terraform import aws_route53_resolver_config.example rslvr-rc-715aa20c73a23da7 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/route53_resolver_dnssec_config.html.markdown b/website/docs/cdktf/python/r/route53_resolver_dnssec_config.html.markdown index 538711ea2b5d..c62486399b9c 100644 --- a/website/docs/cdktf/python/r/route53_resolver_dnssec_config.html.markdown +++ b/website/docs/cdktf/python/r/route53_resolver_dnssec_config.html.markdown @@ -44,6 +44,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `resource_id` - (Required) The ID of the virtual private cloud (VPC) that you're updating the DNSSEC validation status for. ## Attribute Reference @@ -80,4 +81,4 @@ Using `terraform import`, import Route 53 Resolver DNSSEC configs using the Rou % terraform import aws_route53_resolver_dnssec_config.example rdsc-be1866ecc1683e95 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/route53_resolver_endpoint.html.markdown b/website/docs/cdktf/python/r/route53_resolver_endpoint.html.markdown index 915afaa68dbd..0d63497a34c6 100644 --- a/website/docs/cdktf/python/r/route53_resolver_endpoint.html.markdown +++ b/website/docs/cdktf/python/r/route53_resolver_endpoint.html.markdown @@ -49,9 +49,9 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `direction` - (Required) Direction of DNS queries to or from the Route 53 Resolver endpoint. -Valid values are `INBOUND` (resolver forwards DNS queries to the DNS service for a VPC from your network or another VPC) -or `OUTBOUND` (resolver forwards DNS queries from the DNS service for a VPC to your network or another VPC). +Valid values are `INBOUND` (resolver forwards DNS queries to the DNS service for a VPC from your network or another VPC), `OUTBOUND` (resolver forwards DNS queries from the DNS service for a VPC to your network or another VPC) or `INBOUND_DELEGATION` (resolver delegates queries to Route 53 private hosted zones from your network). * `ip_address` - (Required) Subnets and IP addresses in your VPC that you want DNS queries to pass through on the way from your VPCs to your network (for outbound endpoints) or on the way from your network to your VPCs (for inbound endpoints). Described below. * `name` - (Optional) Friendly name of the Route 53 Resolver endpoint. @@ -110,4 +110,4 @@ Using `terraform import`, import Route 53 Resolver endpoints using the Route 53 % terraform import aws_route53_resolver_endpoint.foo rslvr-in-abcdef01234567890 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/route53_resolver_firewall_config.html.markdown b/website/docs/cdktf/python/r/route53_resolver_firewall_config.html.markdown index b6c5f4c2da09..5522280e11f4 100644 --- a/website/docs/cdktf/python/r/route53_resolver_firewall_config.html.markdown +++ b/website/docs/cdktf/python/r/route53_resolver_firewall_config.html.markdown @@ -45,6 +45,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `resource_id` - (Required) The ID of the VPC that the configuration is for. * `firewall_fail_open` - (Required) Determines how Route 53 Resolver handles queries during failures, for example when all traffic that is sent to DNS Firewall fails to receive a reply. By default, fail open is disabled, which means the failure mode is closed. This approach favors security over availability. DNS Firewall blocks queries that it is unable to evaluate properly. If you enable this option, the failure mode is open. This approach favors availability over security. DNS Firewall allows queries to proceed if it is unable to properly evaluate them. Valid values: `ENABLED`, `DISABLED`. @@ -80,4 +81,4 @@ Using `terraform import`, import Route 53 Resolver DNS Firewall configs using th % terraform import aws_route53_resolver_firewall_config.example rdsc-be1866ecc1683e95 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/route53_resolver_firewall_domain_list.html.markdown b/website/docs/cdktf/python/r/route53_resolver_firewall_domain_list.html.markdown index 052144b381e1..37f63f0ebff5 100644 --- a/website/docs/cdktf/python/r/route53_resolver_firewall_domain_list.html.markdown +++ b/website/docs/cdktf/python/r/route53_resolver_firewall_domain_list.html.markdown @@ -35,6 +35,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) A name that lets you identify the domain list, to manage and use it. * `domains` - (Optional) A array of domains for the firewall domain list. * `tags` - (Optional) A map of tags to assign to the resource. f 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. @@ -72,4 +73,4 @@ Using `terraform import`, import Route 53 Resolver DNS Firewall domain lists us % terraform import aws_route53_resolver_firewall_domain_list.example rslvr-fdl-0123456789abcdef ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/route53_resolver_firewall_rule.html.markdown b/website/docs/cdktf/python/r/route53_resolver_firewall_rule.html.markdown index e4c32de9aa43..c732e862b709 100644 --- a/website/docs/cdktf/python/r/route53_resolver_firewall_rule.html.markdown +++ b/website/docs/cdktf/python/r/route53_resolver_firewall_rule.html.markdown @@ -60,6 +60,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) A name that lets you identify the rule, to manage and use it. * `action` - (Required) The action that DNS Firewall should take on a DNS query when it matches one of the domains in the rule's domain list. Valid values: `ALLOW`, `BLOCK`, `ALERT`. * `block_override_dns_type` - (Required if `block_response` is `OVERRIDE`) The DNS record's type. This determines the format of the record value that you provided in BlockOverrideDomain. Value values: `CNAME`. @@ -103,4 +104,4 @@ Using `terraform import`, import Route 53 Resolver DNS Firewall rules using the % terraform import aws_route53_resolver_firewall_rule.example rslvr-frg-0123456789abcdef:rslvr-fdl-0123456789abcdef ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/route53_resolver_firewall_rule_group.html.markdown b/website/docs/cdktf/python/r/route53_resolver_firewall_rule_group.html.markdown index 3edffd4506d1..2b9450c0d3dc 100644 --- a/website/docs/cdktf/python/r/route53_resolver_firewall_rule_group.html.markdown +++ b/website/docs/cdktf/python/r/route53_resolver_firewall_rule_group.html.markdown @@ -35,6 +35,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) A name that lets you identify the rule group, to manage and use it. * `tags` - (Optional) A 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. @@ -73,4 +74,4 @@ Using `terraform import`, import Route 53 Resolver DNS Firewall rule groups usi % terraform import aws_route53_resolver_firewall_rule_group.example rslvr-frg-0123456789abcdef ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/route53_resolver_firewall_rule_group_association.html.markdown b/website/docs/cdktf/python/r/route53_resolver_firewall_rule_group_association.html.markdown index f13fd9bc34d7..8a492e67aa17 100644 --- a/website/docs/cdktf/python/r/route53_resolver_firewall_rule_group_association.html.markdown +++ b/website/docs/cdktf/python/r/route53_resolver_firewall_rule_group_association.html.markdown @@ -45,6 +45,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) A name that lets you identify the rule group association, to manage and use it. * `firewall_rule_group_id` - (Required) The unique identifier of the firewall rule group. * `mutation_protection` - (Optional) If enabled, this setting disallows modification or removal of the association, to help prevent against accidentally altering DNS firewall protections. Valid values: `ENABLED`, `DISABLED`. @@ -85,4 +86,4 @@ Using `terraform import`, import Route 53 Resolver DNS Firewall rule group assoc % terraform import aws_route53_resolver_firewall_rule_group_association.example rslvr-frgassoc-0123456789abcdef ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/route53_resolver_query_log_config.html.markdown b/website/docs/cdktf/python/r/route53_resolver_query_log_config.html.markdown index 1e82117b1d47..875bd201e81e 100644 --- a/website/docs/cdktf/python/r/route53_resolver_query_log_config.html.markdown +++ b/website/docs/cdktf/python/r/route53_resolver_query_log_config.html.markdown @@ -39,6 +39,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `destination_arn` - (Required) The ARN of the resource that you want Route 53 Resolver to send query logs. You can send query logs to an [S3 bucket](s3_bucket.html), a [CloudWatch Logs log group](cloudwatch_log_group.html), or a [Kinesis Data Firehose delivery stream](kinesis_firehose_delivery_stream.html). * `name` - (Required) The name of the Route 53 Resolver query logging configuration. @@ -81,4 +82,4 @@ Using `terraform import`, import Route 53 Resolver query logging configurations % terraform import aws_route53_resolver_query_log_config.example rqlc-92edc3b1838248bf ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/route53_resolver_query_log_config_association.html.markdown b/website/docs/cdktf/python/r/route53_resolver_query_log_config_association.html.markdown index e8d20d1d03d7..83c0cfff1a55 100644 --- a/website/docs/cdktf/python/r/route53_resolver_query_log_config_association.html.markdown +++ b/website/docs/cdktf/python/r/route53_resolver_query_log_config_association.html.markdown @@ -36,6 +36,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `resolver_query_log_config_id` - (Required) The ID of the [Route 53 Resolver query logging configuration](route53_resolver_query_log_config.html) that you want to associate a VPC with. * `resource_id` - (Required) The ID of a VPC that you want this query logging configuration to log queries for. @@ -70,4 +71,4 @@ Using `terraform import`, import Route 53 Resolver query logging configuration % terraform import aws_route53_resolver_query_log_config_association.example rqlca-b320624fef3c4d70 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/route53_resolver_rule.html.markdown b/website/docs/cdktf/python/r/route53_resolver_rule.html.markdown index fa392a671702..2773b8ce6c43 100644 --- a/website/docs/cdktf/python/r/route53_resolver_rule.html.markdown +++ b/website/docs/cdktf/python/r/route53_resolver_rule.html.markdown @@ -96,6 +96,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `domain_name` - (Required) DNS queries for this domain name are forwarded to the IP addresses that are specified using `target_ip`. * `rule_type` - (Required) Rule type. Valid values are `FORWARD`, `SYSTEM` and `RECURSIVE`. * `name` - (Optional) Friendly name that lets you easily find a rule in the Resolver dashboard in the Route 53 console. @@ -125,6 +126,32 @@ Values are `NOT_SHARED`, `SHARED_BY_ME` or `SHARED_WITH_ME` ## Import +In Terraform v1.12.0 and later, the [`import` block](https://developer.hashicorp.com/terraform/language/import) can be used with the `identity` attribute. For example: + +```terraform +import { + to = aws_route53_resolver_rule.example + identity = { + id = "rslvr-rr-0123456789abcdef0" + } +} + +resource "aws_route53_resolver_rule" "example" { + ### Configuration omitted for brevity ### +} +``` + +### Identity Schema + +#### Required + +* `id` - (String) ID of the Route53 Resolver rule. + +#### Optional + +- `account_id` (String) AWS Account where this resource is managed. +- `region` (String) Region where this resource is managed. + In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import Route53 Resolver rules using the `id`. For example: ```python @@ -139,13 +166,13 @@ from imports.aws.route53_resolver_rule import Route53ResolverRule class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) - Route53ResolverRule.generate_config_for_import(self, "sys", "rslvr-rr-0123456789abcdef0") + Route53ResolverRule.generate_config_for_import(self, "example", "rslvr-rr-0123456789abcdef0") ``` Using `terraform import`, import Route53 Resolver rules using the `id`. For example: ```console -% terraform import aws_route53_resolver_rule.sys rslvr-rr-0123456789abcdef0 +% terraform import aws_route53_resolver_rule.example rslvr-rr-0123456789abcdef0 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/route53_resolver_rule_association.html.markdown b/website/docs/cdktf/python/r/route53_resolver_rule_association.html.markdown index 96881904f96c..23034e692b0f 100644 --- a/website/docs/cdktf/python/r/route53_resolver_rule_association.html.markdown +++ b/website/docs/cdktf/python/r/route53_resolver_rule_association.html.markdown @@ -36,6 +36,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `resolver_rule_id` - (Required) The ID of the resolver rule that you want to associate with the VPC. * `vpc_id` - (Required) The ID of the VPC that you want to associate the resolver rule with. * `name` - (Optional) A name for the association that you're creating between a resolver rule and a VPC. @@ -48,6 +49,32 @@ This resource exports the following attributes in addition to the arguments abov ## Import +In Terraform v1.12.0 and later, the [`import` block](https://developer.hashicorp.com/terraform/language/import) can be used with the `identity` attribute. For example: + +```terraform +import { + to = aws_route53_resolver_rule_association.example + identity = { + id = "rslvr-rrassoc-97242eaf88example" + } +} + +resource "aws_route53_resolver_rule_association" "example" { + ### Configuration omitted for brevity ### +} +``` + +### Identity Schema + +#### Required + +* `id` - (String) ID of the Route53 Resolver rule association. + +#### Optional + +- `account_id` (String) AWS Account where this resource is managed. +- `region` (String) Region where this resource is managed. + In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import Route53 Resolver rule associations using the `id`. For example: ```python @@ -71,4 +98,4 @@ Using `terraform import`, import Route53 Resolver rule associations using the `i % terraform import aws_route53_resolver_rule_association.example rslvr-rrassoc-97242eaf88example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/route53profiles_association.html.markdown b/website/docs/cdktf/python/r/route53profiles_association.html.markdown index cfcc1757b28c..21c96be48f07 100644 --- a/website/docs/cdktf/python/r/route53profiles_association.html.markdown +++ b/website/docs/cdktf/python/r/route53profiles_association.html.markdown @@ -54,6 +54,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) Name of the Profile Association. Must match a regex of `(?!^[0-9]+$)([a-zA-Z0-9\\-_' ']+)`. * `profile_id` - (Required) ID of the profile associated with the VPC. * `resource_id` - (Required) Resource ID of the VPC the profile to be associated with. @@ -95,10 +96,10 @@ class MyConvertedCode(TerraformStack): Route53ProfilesAssociation.generate_config_for_import(self, "example", "rpa-id-12345678") ``` -Using `terraform import`, import Route 53 Profiles Association using the `example_id_arg`. For example: +Using `terraform import`, import Route 53 Profiles Association using the `id`. For example: ```console % terraform import aws_route53profiles_association.example rpa-id-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/route53profiles_profile.html.markdown b/website/docs/cdktf/python/r/route53profiles_profile.html.markdown index 109444782213..b4b594e80304 100644 --- a/website/docs/cdktf/python/r/route53profiles_profile.html.markdown +++ b/website/docs/cdktf/python/r/route53profiles_profile.html.markdown @@ -40,6 +40,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) Name of the Profile. * `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. @@ -66,7 +67,7 @@ This resource exports the following attributes in addition to the arguments abov ## Import -In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import Route 53 Profiles Profile using the `example_id_arg`. For example: +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import Route 53 Profiles Profile using the `id`. For example: ```python # DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -83,10 +84,10 @@ class MyConvertedCode(TerraformStack): Route53ProfilesProfile.generate_config_for_import(self, "example", "rp-12345678") ``` -Using `terraform import`, import Route 53 Profiles Profile using the `example`. For example: +Using `terraform import`, import Route 53 Profiles Profile using the `id`. For example: ```console % terraform import aws_route53profiles_profile.example rp-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/route53profiles_resource_association.html.markdown b/website/docs/cdktf/python/r/route53profiles_resource_association.html.markdown index 7ec2e257754c..c48027791bad 100644 --- a/website/docs/cdktf/python/r/route53profiles_resource_association.html.markdown +++ b/website/docs/cdktf/python/r/route53profiles_resource_association.html.markdown @@ -62,6 +62,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) Name of the Profile Resource Association. * `profile_id` - (Required) ID of the profile associated with the VPC. * `resource_arn` - (Required) Resource ID of the resource to be associated with the profile. @@ -104,10 +105,10 @@ class MyConvertedCode(TerraformStack): Route53ProfilesResourceAssociation.generate_config_for_import(self, "example", "rpa-id-12345678") ``` -Using `terraform import`, import Route 53 Profiles Resource Association using the `example_id_arg`. For example: +Using `terraform import`, import Route 53 Profiles Resource Association using the `id`. For example: ```console % terraform import aws_route53profiles_resource_association.example rpa-id-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/route_table.html.markdown b/website/docs/cdktf/python/r/route_table.html.markdown index a1a4151a21a5..a45ebb7325eb 100644 --- a/website/docs/cdktf/python/r/route_table.html.markdown +++ b/website/docs/cdktf/python/r/route_table.html.markdown @@ -169,6 +169,7 @@ The target could then be updated again back to `local`. This resource supports the following arguments: +* `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). * `vpc_id` - (Required) The VPC ID. * `route` - (Optional) A list of route objects. Their keys are documented below. This argument is processed in [attribute-as-blocks mode](https://www.terraform.io/docs/configuration/attr-as-blocks.html). This means that omitting this argument is interpreted as ignoring any existing routes. To remove all managed routes an empty list should be specified. See the example above. @@ -222,6 +223,32 @@ attribute once the route resource is created. ## Import +In Terraform v1.12.0 and later, the [`import` block](https://developer.hashicorp.com/terraform/language/import) can be used with the `identity` attribute. For example: + +```terraform +import { + to = aws_route_table.example + identity = { + id = "rtb-4e616f6d69" + } +} + +resource "aws_route_table" "example" { + ### Configuration omitted for brevity ### +} +``` + +### Identity Schema + +#### Required + +* `id` - (String) ID of the routing table. + +#### Optional + +- `account_id` (String) AWS Account where this resource is managed. +- `region` (String) Region where this resource is managed. + In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import Route Tables using the route table `id`. For example: ```python @@ -245,4 +272,4 @@ Using `terraform import`, import Route Tables using the route table `id`. For ex % terraform import aws_route_table.public_rt rtb-4e616f6d69 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/route_table_association.html.markdown b/website/docs/cdktf/python/r/route_table_association.html.markdown index 07d8c005653c..2ec8b26d8c3e 100644 --- a/website/docs/cdktf/python/r/route_table_association.html.markdown +++ b/website/docs/cdktf/python/r/route_table_association.html.markdown @@ -55,6 +55,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `subnet_id` - (Optional) The subnet ID to create an association. Conflicts with `gateway_id`. * `gateway_id` - (Optional) The gateway ID to create an association. Conflicts with `subnet_id`. * `route_table_id` - (Required) The ID of the routing table to associate with. @@ -129,4 +130,4 @@ With EC2 Internet Gateways: % terraform import aws_route_table_association.assoc igw-01b3a60780f8d034a/rtb-656c65616e6f72 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/rum_app_monitor.html.markdown b/website/docs/cdktf/python/r/rum_app_monitor.html.markdown index b75ea55ded6b..ad3285ab79b4 100644 --- a/website/docs/cdktf/python/r/rum_app_monitor.html.markdown +++ b/website/docs/cdktf/python/r/rum_app_monitor.html.markdown @@ -36,6 +36,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) The name of the log stream. * `app_monitor_configuration` - (Optional) configuration data for the app monitor. See [app_monitor_configuration](#app_monitor_configuration) below. * `cw_log_enabled` - (Optional) Data collected by RUM is kept by RUM for 30 days and then deleted. This parameter specifies whether RUM sends a copy of this telemetry data to Amazon CloudWatch Logs in your account. This enables you to keep the telemetry data for more than 30 days, but it does incur Amazon CloudWatch Logs charges. Default value is `false`. @@ -95,4 +96,4 @@ Using `terraform import`, import Cloudwatch RUM App Monitor using the `name`. Fo % terraform import aws_rum_app_monitor.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/rum_metrics_destination.html.markdown b/website/docs/cdktf/python/r/rum_metrics_destination.html.markdown index 21cd2b0e7828..a34c65ee3b1a 100644 --- a/website/docs/cdktf/python/r/rum_metrics_destination.html.markdown +++ b/website/docs/cdktf/python/r/rum_metrics_destination.html.markdown @@ -36,6 +36,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `app_monitor_name` - (Required) The name of the CloudWatch RUM app monitor that will send the metrics. * `destination` - (Required) Defines the destination to send the metrics to. Valid values are `CloudWatch` and `Evidently`. If you specify `Evidently`, you must also specify the ARN of the CloudWatchEvidently experiment that is to be the destination and an IAM role that has permission to write to the experiment. * `destination_arn` - (Optional) Use this parameter only if Destination is Evidently. This parameter specifies the ARN of the Evidently experiment that will receive the extended metrics. @@ -72,4 +73,4 @@ Using `terraform import`, import Cloudwatch RUM Metrics Destination using the `i % terraform import aws_rum_metrics_destination.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/s3_access_point.html.markdown b/website/docs/cdktf/python/r/s3_access_point.html.markdown index 4da83865fa89..bb02d3c099f8 100644 --- a/website/docs/cdktf/python/r/s3_access_point.html.markdown +++ b/website/docs/cdktf/python/r/s3_access_point.html.markdown @@ -129,6 +129,8 @@ The following arguments are optional: * `bucket_account_id` - (Optional) AWS account ID associated with the S3 bucket associated with this access point. * `policy` - (Optional) Valid JSON document that specifies the policy that you want to apply to this access point. Removing `policy` from your configuration or setting `policy` to null or an empty string (i.e., `policy = ""`) _will not_ delete the policy since it could have been set by `aws_s3control_access_point_policy`. To remove the `policy`, set it to `"{}"` (an empty JSON document). * `public_access_block_configuration` - (Optional) Configuration block to manage the `PublicAccessBlock` configuration that you want to apply to this Amazon S3 bucket. You can enable the configuration options in any combination. Detailed below. +* `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). +* `tags` - (Optional) Map of tags to assign to the bucket. 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. * `vpc_configuration` - (Optional) Configuration block to restrict access to this access point to requests from the specified Virtual Private Cloud (VPC). Required for S3 on Outposts. Detailed below. ### public_access_block_configuration Configuration Block @@ -164,6 +166,7 @@ Note: S3 access points only support secure access by HTTPS. HTTP isn't supported * `has_public_access_policy` - Indicates whether this access point currently has a policy that allows public access. * `id` - For Access Point of an AWS Partition S3 Bucket, the AWS account ID and access point name separated by a colon (`:`). For S3 on Outposts Bucket, the ARN of the Access Point. * `network_origin` - Indicates whether this access point allows access from the public Internet. Values are `VPC` (the access point doesn't allow access from the public Internet) and `Internet` (the access point allows access from the public Internet, subject to the access point and bucket access policies). +* `tags_all` - Map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). ## Import @@ -217,4 +220,4 @@ Import using the ARN for Access Points associated with an S3 on Outposts Bucket: % terraform import aws_s3_access_point.example arn:aws:s3-outposts:us-east-1:123456789012:outpost/op-1234567890123456/accesspoint/example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/s3_bucket.html.markdown b/website/docs/cdktf/python/r/s3_bucket.html.markdown index 1d1551ab6a84..97ce198af4df 100644 --- a/website/docs/cdktf/python/r/s3_bucket.html.markdown +++ b/website/docs/cdktf/python/r/s3_bucket.html.markdown @@ -45,6 +45,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `bucket` - (Optional, Forces new resource) Name of the bucket. If omitted, Terraform will assign a random, unique name. Must be lowercase and less than or equal to 63 characters in length. A full list of bucket naming rules [may be found here](https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html). The name must not be in the format `[bucket_name]--[azid]--x-s3`. Use the [`aws_s3_directory_bucket`](s3_directory_bucket.html) resource to manage S3 Express buckets. * `bucket_prefix` - (Optional, Forces new resource) Creates a unique bucket name beginning with the specified prefix. Conflicts with `bucket`. Must be lowercase and less than or equal to 37 characters in length. A full list of bucket naming rules [may be found here](https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html). * `force_destroy` - (Optional, Default:`false`) Boolean that indicates all objects (including any [locked objects](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock-overview.html)) should be deleted from the bucket *when the bucket is destroyed* so that the bucket can be destroyed without error. These objects are *not* recoverable. This only deletes objects when the bucket is destroyed, *not* when setting this parameter to `true`. Once this parameter is set to `true`, there must be a successful `terraform apply` run before a destroy is required to update this value in the resource state. Without a successful `terraform apply` after this parameter is set, this flag will have no effect. If setting this field in the same operation that would require replacing the bucket or destroying the bucket, this flag will not work. Additionally when importing a bucket, a successful `terraform apply` is required to set this value in state before it will take effect on a destroy operation. @@ -318,9 +319,9 @@ This resource exports the following attributes in addition to the arguments abov * `id` - Name of the bucket. * `arn` - ARN of the bucket. Will be of format `arn:aws:s3:::bucketname`. * `bucket_domain_name` - Bucket domain name. Will be of format `bucketname.s3.amazonaws.com`. +* `bucket_region` - AWS region this bucket resides in. * `bucket_regional_domain_name` - The bucket region-specific domain name. The bucket domain name including the region name. Please refer to the [S3 endpoints reference](https://docs.aws.amazon.com/general/latest/gr/s3.html#s3_region) for format. Note: AWS CloudFront allows specifying an S3 region-specific endpoint when creating an S3 origin. This will prevent redirect issues from CloudFront to the S3 Origin URL. For more information, see the [Virtual Hosted-Style Requests for Other Regions](https://docs.aws.amazon.com/AmazonS3/latest/userguide/VirtualHosting.html#deprecated-global-endpoint) section in the AWS S3 User Guide. * `hosted_zone_id` - [Route 53 Hosted Zone ID](https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_website_region_endpoints) for this bucket's region. -* `region` - AWS region this bucket resides in. * `tags_all` - Map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). * `website_endpoint` - (**Deprecated**) Website endpoint, if the bucket is configured with a website. If not, this will be an empty string. Use the resource [`aws_s3_bucket_website_configuration`](s3_bucket_website_configuration.html.markdown) instead. * `website_domain` - (**Deprecated**) Domain of the website endpoint, if the bucket is configured with a website. If not, this will be an empty string. This is used to create Route 53 alias records. Use the resource [`aws_s3_bucket_website_configuration`](s3_bucket_website_configuration.html.markdown) instead. @@ -359,4 +360,4 @@ Using `terraform import`, import S3 bucket using the `bucket`. For example: % terraform import aws_s3_bucket.bucket bucket-name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/s3_bucket_accelerate_configuration.html.markdown b/website/docs/cdktf/python/r/s3_bucket_accelerate_configuration.html.markdown index 72337434564f..3c7eaea6cf81 100644 --- a/website/docs/cdktf/python/r/s3_bucket_accelerate_configuration.html.markdown +++ b/website/docs/cdktf/python/r/s3_bucket_accelerate_configuration.html.markdown @@ -42,6 +42,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `bucket` - (Required, Forces new resource) Name of the bucket. * `expected_bucket_owner` - (Optional, Forces new resource) Account ID of the expected bucket owner. * `status` - (Required) Transfer acceleration state of the bucket. Valid values: `Enabled`, `Suspended`. @@ -104,4 +105,4 @@ If the owner (account ID) of the source bucket differs from the account used to % terraform import aws_s3_bucket_accelerate_configuration.example bucket-name,123456789012 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/s3_bucket_acl.html.markdown b/website/docs/cdktf/python/r/s3_bucket_acl.html.markdown index f121968f4f6a..acd82afd964a 100644 --- a/website/docs/cdktf/python/r/s3_bucket_acl.html.markdown +++ b/website/docs/cdktf/python/r/s3_bucket_acl.html.markdown @@ -164,6 +164,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `acl` - (Optional, either `access_control_policy` or `acl` is required) Specifies the Canned ACL to apply to the bucket. Valid values: `private`, `public-read`, `public-read-write`, `aws-exec-read`, `authenticated-read`, `bucket-owner-read`, `bucket-owner-full-control`, `log-delivery-write`. Full details are available on the [AWS documentation](https://docs.aws.amazon.com/AmazonS3/latest/userguide/acl-overview.html#canned-acl). * `access_control_policy` - (Optional, either `access_control_policy` or `acl` is required) Configuration block that sets the ACL permissions for an object per grantee. [See below](#access_control_policy). * `bucket` - (Required, Forces new resource) Bucket to which to apply the ACL. @@ -309,4 +310,4 @@ If the owner (account ID) of the source bucket _differs_ from the account used t [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/acl-overview.html#canned-acl - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/s3_bucket_analytics_configuration.html.markdown b/website/docs/cdktf/python/r/s3_bucket_analytics_configuration.html.markdown index 54040cdb06f4..771d06be68f5 100644 --- a/website/docs/cdktf/python/r/s3_bucket_analytics_configuration.html.markdown +++ b/website/docs/cdktf/python/r/s3_bucket_analytics_configuration.html.markdown @@ -87,6 +87,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `bucket` - (Required) Name of the bucket this analytics configuration is associated with. * `name` - (Required) Unique identifier of the analytics configuration for the bucket. * `filter` - (Optional) Object filtering that accepts a prefix, tags, or a logical AND of prefix and tags (documented below). @@ -146,4 +147,4 @@ Using `terraform import`, import S3 bucket analytics configurations using `bucke % terraform import aws_s3_bucket_analytics_configuration.my-bucket-entire-bucket my-bucket:EntireBucket ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/s3_bucket_cors_configuration.html.markdown b/website/docs/cdktf/python/r/s3_bucket_cors_configuration.html.markdown index df35013780de..58d91af634fe 100644 --- a/website/docs/cdktf/python/r/s3_bucket_cors_configuration.html.markdown +++ b/website/docs/cdktf/python/r/s3_bucket_cors_configuration.html.markdown @@ -56,6 +56,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `bucket` - (Required, Forces new resource) Name of the bucket. * `expected_bucket_owner` - (Optional, Forces new resource) Account ID of the expected bucket owner. * `cors_rule` - (Required) Set of origins and methods (cross-origin access that you want to allow). [See below](#cors_rule). You can configure up to 100 rules. @@ -129,4 +130,4 @@ If the owner (account ID) of the source bucket differs from the account used to % terraform import aws_s3_bucket_cors_configuration.example bucket-name,123456789012 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/s3_bucket_intelligent_tiering_configuration.html.markdown b/website/docs/cdktf/python/r/s3_bucket_intelligent_tiering_configuration.html.markdown index 21ab6e128a26..208a02db7697 100644 --- a/website/docs/cdktf/python/r/s3_bucket_intelligent_tiering_configuration.html.markdown +++ b/website/docs/cdktf/python/r/s3_bucket_intelligent_tiering_configuration.html.markdown @@ -89,6 +89,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `bucket` - (Required) Name of the bucket this intelligent tiering configuration is associated with. * `name` - (Required) Unique name used to identify the S3 Intelligent-Tiering configuration for the bucket. * `status` - (Optional) Specifies the status of the configuration. Valid values: `Enabled`, `Disabled`. @@ -134,4 +135,4 @@ Using `terraform import`, import S3 bucket intelligent tiering configurations us % terraform import aws_s3_bucket_intelligent_tiering_configuration.my-bucket-entire-bucket my-bucket:EntireBucket ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/s3_bucket_inventory.html.markdown b/website/docs/cdktf/python/r/s3_bucket_inventory.html.markdown index 80cc1ea9ffb7..5c5d1ee162c6 100644 --- a/website/docs/cdktf/python/r/s3_bucket_inventory.html.markdown +++ b/website/docs/cdktf/python/r/s3_bucket_inventory.html.markdown @@ -100,6 +100,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `bucket` - (Required) Name of the source bucket that inventory lists the objects for. * `name` - (Required) Unique identifier of the inventory configuration for the bucket. * `included_object_versions` - (Required) Object versions to include in the inventory list. Valid values: `All`, `Current`. @@ -167,4 +168,4 @@ Using `terraform import`, import S3 bucket inventory configurations using `bucke % terraform import aws_s3_bucket_inventory.my-bucket-entire-bucket my-bucket:EntireBucket ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/s3_bucket_lifecycle_configuration.html.markdown b/website/docs/cdktf/python/r/s3_bucket_lifecycle_configuration.html.markdown index eb73fbe544b3..5aa5180e4af3 100644 --- a/website/docs/cdktf/python/r/s3_bucket_lifecycle_configuration.html.markdown +++ b/website/docs/cdktf/python/r/s3_bucket_lifecycle_configuration.html.markdown @@ -436,6 +436,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `bucket` - (Required) Name of the source S3 bucket you want Amazon S3 to monitor. * `expected_bucket_owner` - (Optional) Account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error. * `rule` - (Required) List of configuration blocks describing the rules managing the replication. [See below](#rule). @@ -594,4 +595,4 @@ If the owner (account ID) of the source bucket differs from the account used to % terraform import aws_s3_bucket_lifecycle_configuration.example bucket-name,123456789012 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/s3_bucket_logging.html.markdown b/website/docs/cdktf/python/r/s3_bucket_logging.html.markdown index 2b233a21506c..602752399c3a 100644 --- a/website/docs/cdktf/python/r/s3_bucket_logging.html.markdown +++ b/website/docs/cdktf/python/r/s3_bucket_logging.html.markdown @@ -20,6 +20,73 @@ to decide which method meets your requirements. ## Example Usage +### Grant permission by using bucket policy + +```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.data_aws_caller_identity import DataAwsCallerIdentity +from imports.aws.data_aws_iam_policy_document import DataAwsIamPolicyDocument +from imports.aws.s3_bucket import S3Bucket +from imports.aws.s3_bucket_logging import S3BucketLoggingA +from imports.aws.s3_bucket_policy import S3BucketPolicy +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + example = S3Bucket(self, "example", + bucket="example-bucket" + ) + logging = S3Bucket(self, "logging", + bucket="access-logging-bucket" + ) + aws_s3_bucket_logging_example = S3BucketLoggingA(self, "example_2", + bucket=example.bucket, + target_bucket=logging.bucket, + target_object_key_format=S3BucketLoggingTargetObjectKeyFormat( + partitioned_prefix=S3BucketLoggingTargetObjectKeyFormatPartitionedPrefix( + partition_date_source="EventTime" + ) + ), + target_prefix="log/" + ) + # 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_s3_bucket_logging_example.override_logical_id("example") + current = DataAwsCallerIdentity(self, "current") + logging_bucket_policy = DataAwsIamPolicyDocument(self, "logging_bucket_policy", + statement=[DataAwsIamPolicyDocumentStatement( + actions=["s3:PutObject"], + condition=[DataAwsIamPolicyDocumentStatementCondition( + test="StringEquals", + values=[Token.as_string(current.account_id)], + variable="aws:SourceAccount" + ) + ], + principals=[DataAwsIamPolicyDocumentStatementPrincipals( + identifiers=["logging.s3.amazonaws.com"], + type="Service" + ) + ], + resources=["${" + logging.arn + "}/*"] + ) + ] + ) + aws_s3_bucket_policy_logging = S3BucketPolicy(self, "logging_5", + bucket=logging.bucket, + policy=Token.as_string(logging_bucket_policy.json) + ) + # 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_s3_bucket_policy_logging.override_logical_id("logging") +``` + +### Grant permission by using bucket ACL + +The [AWS Documentation](https://docs.aws.amazon.com/AmazonS3/latest/userguide/enable-server-access-logging.html) does not recommend using the ACL. + ```python # DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug from constructs import Construct @@ -63,6 +130,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `bucket` - (Required, Forces new resource) Name of the bucket. * `expected_bucket_owner` - (Optional, Forces new resource) Account ID of the expected bucket owner. * `target_bucket` - (Required) Name of the bucket where you want Amazon S3 to store server access logs. @@ -90,8 +158,8 @@ The `grantee` configuration block supports the following arguments: The `target_object_key_format` configuration block supports the following arguments: -* `partitioned_prefix` - (Optional) Partitioned S3 key for log objects. [See below](#partitioned_prefix). -* `simple_prefix` - (Optional) Use the simple format for S3 keys for log objects. To use, set `simple_prefix {}`. +* `partitioned_prefix` - (Optional) Partitioned S3 key for log objects, in the form `[target_prefix][SourceAccountId]/[SourceRegion]/[SourceBucket]/[YYYY]/[MM]/[DD]/[YYYY]-[MM]-[DD]-[hh]-[mm]-[ss]-[UniqueString]`. Conflicts with `simple_prefix`. [See below](#partitioned_prefix). +* `simple_prefix` - (Optional) Use the simple format for S3 keys for log objects, in the form `[target_prefix][YYYY]-[MM]-[DD]-[hh]-[mm]-[ss]-[UniqueString]`. To use, set `simple_prefix {}`. Conflicts with `partitioned_prefix`. ### partitioned_prefix @@ -157,4 +225,4 @@ If the owner (account ID) of the source bucket differs from the account used to % terraform import aws_s3_bucket_logging.example bucket-name,123456789012 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/s3_bucket_metadata_configuration.html.markdown b/website/docs/cdktf/python/r/s3_bucket_metadata_configuration.html.markdown new file mode 100644 index 000000000000..bb5fa4c1dc75 --- /dev/null +++ b/website/docs/cdktf/python/r/s3_bucket_metadata_configuration.html.markdown @@ -0,0 +1,168 @@ +--- +subcategory: "S3 (Simple Storage)" +layout: "aws" +page_title: "AWS: aws_s3_bucket_metadata_configuration" +description: |- + Manages Amazon S3 Metadata for a bucket. +--- + + + +# Resource: aws_s3_bucket_metadata_configuration + +Manages Amazon S3 Metadata for a bucket. + +## 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.s3_bucket_metadata_configuration import S3BucketMetadataConfiguration +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + S3BucketMetadataConfiguration(self, "example", + bucket=Token.as_string(aws_s3_bucket_example.bucket), + metadata_configuration=[S3BucketMetadataConfigurationMetadataConfiguration( + inventory_table_configuration=[S3BucketMetadataConfigurationMetadataConfigurationInventoryTableConfiguration( + configuration_state="ENABLED" + ) + ], + journal_table_configuration=[S3BucketMetadataConfigurationMetadataConfigurationJournalTableConfiguration( + record_expiration=[S3BucketMetadataConfigurationMetadataConfigurationJournalTableConfigurationRecordExpiration( + days=7, + expiration="ENABLED" + ) + ] + ) + ] + ) + ] + ) +``` + +## Argument Reference + +The following arguments are required: + +* `bucket` - (Required) General purpose bucket that you want to create the metadata configuration for. +* `metadata_configuration` - (Required) Metadata configuration. See [`metadata_configuration` Block](#metadata_configuration-block) for details. + +The following arguments are optional: + +* `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). + +### `metadata_configuration` Block + +The `metadata_configuration` configuration block supports the following arguments: + +* `inventory_table_configuration` - (Required) Inventory table configuration. See [`inventory_table_configuration` Block](#inventory_table_configuration-block) for details. +* `journal_table_configuration` - (Required) Journal table configuration. See [`journal_table_configuration` Block](#journal_table_configuration-block) for details. + +### `inventory_table_configuration` Block + +The `inventory_table_configuration` configuration block supports the following arguments: + +* `configuration_state` - (Required) Configuration state of the inventory table, indicating whether the inventory table is enabled or disabled. Valid values: `ENABLED`, `DISABLED`. +* `encryption_configuration` - (Optional) Encryption configuration for the inventory table. See [`encryption_configuration` Block](#encryption_configuration-block) for details. + +### `journal_table_configuration` Block + +The `journal_table_configuration` configuration block supports the following arguments: + +* `encryption_configuration` - (Optional) Encryption configuration for the journal table. See [`encryption_configuration` Block](#encryption_configuration-block) for details. +* `record_expiration` - (Required) Journal table record expiration settings. See [`record_expiration` Block](#record_expiration-block) for details. + +### `encryption_configuration` Block + +The `encryption_configuration` configuration block supports the following arguments: + +* `kms_key_arn` - (Optional) KMS key ARN when `sse_algorithm` is `aws:kms`. +* `sse_algorithm` - (Required) Encryption type for the metadata table. Valid values: `aws:kms`, `AES256`. + +### `record_expiration` Block + +The `record_expiration` configuration block supports the following arguments: + +* `days` - (Optional) Number of days to retain journal table records. +* `expiration` - (Required) Whether journal table record expiration is enabled or disabled. Valid values: `ENABLED`, `DISABLED`. + +## Attribute Reference + +This resource exports the following attributes in addition to the arguments above: + +* `metadata_configuration.0.destination` - Destination information for the S3 Metadata configuration. + * `table_bucket_arn` - ARN of the table bucket where the metadata configuration is stored. + * `table_bucket_type` - Type of the table bucket where the metadata configuration is stored. + * `table_namespace` - Namespace in the table bucket where the metadata tables for the metadata configuration are stored. +* `metadata_configuration.0.inventory_table_configuration.0.table_arn` - Inventory table ARN. +* `metadata_configuration.0.inventory_table_configuration.0.table_name` - Inventory table name. +* `metadata_configuration.0.journal_table_configuration.0.table_arn` - Journal table ARN. +* `metadata_configuration.0.journal_table_configuration.0.table_name` - Journal table name. + +## Timeouts + +[Configuration options](https://developer.hashicorp.com/terraform/language/resources/syntax#operation-timeouts): + +* `create` - (Default `30m`) + +## Import + +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import S3 bucket metadata configuration using the `bucket` or using the `bucket` and `expected_bucket_owner` separated by a comma (`,`). For example: + +If the owner (account ID) of the source bucket is the same account used to configure the Terraform AWS Provider, import using the `bucket`: + +```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.s3_bucket_metadata_configuration import S3BucketMetadataConfiguration +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + S3BucketMetadataConfiguration.generate_config_for_import(self, "example", "bucket-name") +``` + +If the owner (account ID) of the source bucket differs from the account used to configure the Terraform AWS Provider, import using the `bucket` and `expected_bucket_owner` separated by a comma (`,`): + +```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.s3_bucket_metadata_configuration import S3BucketMetadataConfiguration +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + S3BucketMetadataConfiguration.generate_config_for_import(self, "example", "bucket-name,123456789012") +``` + +**Using `terraform import` to import** S3 bucket metadata configuration using the `bucket` or using the `bucket` and `expected_bucket_owner` separated by a comma (`,`). For example: + +If the owner (account ID) of the source bucket is the same account used to configure the Terraform AWS Provider, import using the `bucket`: + +```console +% terraform import aws_s3_bucket_metadata_configuration.example bucket-name +``` + +If the owner (account ID) of the source bucket differs from the account used to configure the Terraform AWS Provider, import using the `bucket` and `expected_bucket_owner` separated by a comma (`,`): + +```console +% terraform import aws_s3_bucket_metadata_configuration.example bucket-name,123456789012 +``` + + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/s3_bucket_metric.html.markdown b/website/docs/cdktf/python/r/s3_bucket_metric.html.markdown index 58d63ba4c7ac..91c3ae4b855b 100644 --- a/website/docs/cdktf/python/r/s3_bucket_metric.html.markdown +++ b/website/docs/cdktf/python/r/s3_bucket_metric.html.markdown @@ -111,6 +111,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `bucket` - (Required) Name of the bucket to put metric configuration. * `name` - (Required) Unique identifier of the metrics configuration for the bucket. Must be less than or equal to 64 characters in length. * `filter` - (Optional) [Object filtering](http://docs.aws.amazon.com/AmazonS3/latest/dev/metrics-configurations.html#metrics-configurations-filter) that accepts a prefix, tags, or a logical AND of prefix and tags (documented below). @@ -152,4 +153,4 @@ Using `terraform import`, import S3 bucket metric configurations using `bucket:m % terraform import aws_s3_bucket_metric.my-bucket-entire-bucket my-bucket:EntireBucket ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/s3_bucket_notification.html.markdown b/website/docs/cdktf/python/r/s3_bucket_notification.html.markdown index a307f3e0ae66..53c69279320c 100644 --- a/website/docs/cdktf/python/r/s3_bucket_notification.html.markdown +++ b/website/docs/cdktf/python/r/s3_bucket_notification.html.markdown @@ -394,6 +394,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `eventbridge` - (Optional) Whether to enable Amazon EventBridge notifications. Defaults to `false`. * `lambda_function` - (Optional, Multiple) Used to configure notifications to a Lambda Function. See below. * `queue` - (Optional) Notification configuration to SQS Queue. See below. @@ -452,4 +453,4 @@ Using `terraform import`, import S3 bucket notification using the `bucket`. For % terraform import aws_s3_bucket_notification.bucket_notification bucket-name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/s3_bucket_object.html.markdown b/website/docs/cdktf/python/r/s3_bucket_object.html.markdown index 38993b7d74ee..9fca9e8de640 100644 --- a/website/docs/cdktf/python/r/s3_bucket_object.html.markdown +++ b/website/docs/cdktf/python/r/s3_bucket_object.html.markdown @@ -198,6 +198,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `acl` - (Optional) [Canned ACL](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl) to apply. Valid values are `private`, `public-read`, `public-read-write`, `aws-exec-read`, `authenticated-read`, `bucket-owner-read`, and `bucket-owner-full-control`. Defaults to `private`. * `bucket_key_enabled` - (Optional) Whether or not to use [Amazon S3 Bucket Keys](https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-key.html) for SSE-KMS. * `cache_control` - (Optional) Caching behavior along the request/reply chain Read [w3c cache_control](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9) for further details. @@ -288,4 +289,4 @@ Import using S3 URL syntax: % terraform import aws_s3_bucket_object.example s3://some-bucket-name/some/key.txt ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/s3_bucket_object_lock_configuration.html.markdown b/website/docs/cdktf/python/r/s3_bucket_object_lock_configuration.html.markdown index 9eac40bb479c..ae4f5ef6edb5 100644 --- a/website/docs/cdktf/python/r/s3_bucket_object_lock_configuration.html.markdown +++ b/website/docs/cdktf/python/r/s3_bucket_object_lock_configuration.html.markdown @@ -63,6 +63,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `bucket` - (Required, Forces new resource) Name of the bucket. * `expected_bucket_owner` - (Optional, Forces new resource) Account ID of the expected bucket owner. * `object_lock_enabled` - (Optional, Forces new resource) Indicates whether this bucket has an Object Lock configuration enabled. Defaults to `Enabled`. Valid values: `Enabled`. @@ -138,4 +139,4 @@ If the owner (account ID) of the source bucket differs from the account used to % terraform import aws_s3_bucket_object_lock_configuration.example bucket-name,123456789012 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/s3_bucket_ownership_controls.html.markdown b/website/docs/cdktf/python/r/s3_bucket_ownership_controls.html.markdown index 743ae02fabbf..751d0c6c7a0f 100644 --- a/website/docs/cdktf/python/r/s3_bucket_ownership_controls.html.markdown +++ b/website/docs/cdktf/python/r/s3_bucket_ownership_controls.html.markdown @@ -44,15 +44,17 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `bucket` - (Required) Name of the bucket that you want to associate this access point with. * `rule` - (Required) Configuration block(s) with Ownership Controls rules. Detailed below. ### rule Configuration Block -The following arguments are required: +This resource supports the following arguments: +* `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). * `object_ownership` - (Required) Object ownership. Valid values: `BucketOwnerPreferred`, `ObjectWriter` or `BucketOwnerEnforced` * `BucketOwnerPreferred` - Objects uploaded to the bucket change ownership to the bucket owner if the objects are uploaded with the `bucket-owner-full-control` canned ACL. * `ObjectWriter` - Uploading account will own the object if the object is uploaded with the `bucket-owner-full-control` canned ACL. @@ -89,4 +91,4 @@ Using `terraform import`, import S3 Bucket Ownership Controls using S3 Bucket na % terraform import aws_s3_bucket_ownership_controls.example my-bucket ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/s3_bucket_policy.html.markdown b/website/docs/cdktf/python/r/s3_bucket_policy.html.markdown index a129865bd7bc..e2b059fc1664 100644 --- a/website/docs/cdktf/python/r/s3_bucket_policy.html.markdown +++ b/website/docs/cdktf/python/r/s3_bucket_policy.html.markdown @@ -55,10 +55,13 @@ class MyConvertedCode(TerraformStack): aws_s3_bucket_policy_allow_access_from_another_account.override_logical_id("allow_access_from_another_account") ``` +-> Only one `aws_s3_bucket_policy` resource should be defined per S3 bucket. Defining multiple `aws_s3_bucket_policy` resources with different Terraform names but the same `bucket` value may result in unexpected policy overwrites. Each resource uses the `PutBucketPolicy` API, which replaces the entire existing policy without error or warning. Because Terraform treats each resource independently, the policy applied last will silently override any previously applied policy. + ## Argument Reference This resource supports the following arguments: +* `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). * `bucket` - (Required) Name of the bucket to which to apply the policy. * `policy` - (Required) Text of the policy. Although this is a bucket policy rather than an IAM policy, the [`aws_iam_policy_document`](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) data source may be used, so long as it specifies a principal. For more information about building AWS IAM policy documents with Terraform, see the [AWS IAM Policy Document Guide](https://learn.hashicorp.com/terraform/aws/iam-policy). Note: Bucket policies are limited to 20 KB in size. @@ -91,4 +94,4 @@ Using `terraform import`, import S3 bucket policies using the bucket name. For e % terraform import aws_s3_bucket_policy.allow_access_from_another_account my-tf-test-bucket ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/s3_bucket_public_access_block.html.markdown b/website/docs/cdktf/python/r/s3_bucket_public_access_block.html.markdown index a7b4a78b94a2..280a966bc99c 100644 --- a/website/docs/cdktf/python/r/s3_bucket_public_access_block.html.markdown +++ b/website/docs/cdktf/python/r/s3_bucket_public_access_block.html.markdown @@ -14,6 +14,8 @@ Manages S3 bucket-level Public Access Block configuration. For more information -> This resource cannot be used with S3 directory buckets. +~> Setting `skip_destroy` to `true` means that the AWS Provider will not destroy a public access block, even when running `terraform destroy`. The configuration is thus an intentional dangling resource that is not managed by Terraform and will remain in-place in your AWS account. + ## Example Usage ```python @@ -47,9 +49,10 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `bucket` - (Required) S3 Bucket to which this Public Access Block configuration should be applied. * `block_public_acls` - (Optional) Whether Amazon S3 should block public ACLs for this bucket. Defaults to `false`. Enabling this setting does not affect existing policies or ACLs. When set to `true` causes the following behavior: - * PUT Bucket acl and PUT Object acl calls will fail if the specified ACL allows public access. + * PUT Bucket ACL and PUT Object ACL calls will fail if the specified ACL allows public access. * PUT Object calls will fail if the request includes an object ACL. * `block_public_policy` - (Optional) Whether Amazon S3 should block public bucket policies for this bucket. Defaults to `false`. Enabling this setting does not affect the existing bucket policy. When set to `true` causes Amazon S3 to: * Reject calls to PUT Bucket policy if the specified bucket policy allows public access. @@ -57,6 +60,7 @@ This resource supports the following arguments: * Ignore public ACLs on this bucket and any objects that it contains. * `restrict_public_buckets` - (Optional) Whether Amazon S3 should restrict public bucket policies for this bucket. Defaults to `false`. Enabling this setting does not affect the previously stored bucket policy, except that public and cross-account access within the public bucket policy, including non-public delegation to specific accounts, is blocked. When set to `true`: * Only the bucket owner and AWS Services can access this buckets if it has a public policy. +* `skip_destroy` - (Optional) Whether to retain the public access block upon destruction. If set to `true`, the resource is simply removed from state instead. This may be desirable in certain scenarios to prevent the removal of a public access block before deletion of the associated bucket. ## Attribute Reference @@ -89,4 +93,4 @@ Using `terraform import`, import `aws_s3_bucket_public_access_block` using the b % terraform import aws_s3_bucket_public_access_block.example my-bucket ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/s3_bucket_replication_configuration.html.markdown b/website/docs/cdktf/python/r/s3_bucket_replication_configuration.html.markdown index e86b6a9acead..cbf9d26f49f1 100644 --- a/website/docs/cdktf/python/r/s3_bucket_replication_configuration.html.markdown +++ b/website/docs/cdktf/python/r/s3_bucket_replication_configuration.html.markdown @@ -20,6 +20,8 @@ Provides an independent configuration resource for S3 bucket [replication config ### Using replication configuration +#### Terraform AWS Provider v5 (and below) + ```python # DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug from constructs import Construct @@ -136,9 +138,134 @@ class MyConvertedCode(TerraformStack): storage_class="STANDARD" ), filter=S3BucketReplicationConfigurationRuleFilter( - prefix="foo" + prefix="example" ), - id="foobar", + id="examplerule", + status="Enabled" + ) + ] + ) + # 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_s3_bucket_replication_configuration_replication.override_logical_id("replication") +``` + +#### Terraform AWS Provider v6 (and above) + +```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.data_aws_iam_policy_document import DataAwsIamPolicyDocument +from imports.aws.iam_policy import IamPolicy +from imports.aws.iam_role import IamRole +from imports.aws.iam_role_policy_attachment import IamRolePolicyAttachment +from imports.aws.provider import AwsProvider +from imports.aws.s3_bucket import S3Bucket +from imports.aws.s3_bucket_acl import S3BucketAcl +from imports.aws.s3_bucket_replication_configuration import S3BucketReplicationConfigurationA +from imports.aws.s3_bucket_versioning import S3BucketVersioningA +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + AwsProvider(self, "aws", + region="eu-west-1" + ) + destination = S3Bucket(self, "destination", + bucket="tf-test-bucket-destination-12345" + ) + source = S3Bucket(self, "source", + bucket="tf-test-bucket-source-12345", + region="eu-central-1" + ) + S3BucketAcl(self, "source_bucket_acl", + acl="private", + bucket=source.id, + region="eu-central-1" + ) + aws_s3_bucket_versioning_destination = S3BucketVersioningA(self, "destination_4", + bucket=destination.id, + versioning_configuration=S3BucketVersioningVersioningConfiguration( + status="Enabled" + ) + ) + # 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_s3_bucket_versioning_destination.override_logical_id("destination") + aws_s3_bucket_versioning_source = S3BucketVersioningA(self, "source_5", + bucket=source.id, + region="eu-central-1", + versioning_configuration=S3BucketVersioningVersioningConfiguration( + status="Enabled" + ) + ) + # 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_s3_bucket_versioning_source.override_logical_id("source") + assume_role = DataAwsIamPolicyDocument(self, "assume_role", + statement=[DataAwsIamPolicyDocumentStatement( + actions=["sts:AssumeRole"], + effect="Allow", + principals=[DataAwsIamPolicyDocumentStatementPrincipals( + identifiers=["s3.amazonaws.com"], + type="Service" + ) + ] + ) + ] + ) + replication = DataAwsIamPolicyDocument(self, "replication", + statement=[DataAwsIamPolicyDocumentStatement( + actions=["s3:GetReplicationConfiguration", "s3:ListBucket"], + effect="Allow", + resources=[source.arn] + ), DataAwsIamPolicyDocumentStatement( + actions=["s3:GetObjectVersionForReplication", "s3:GetObjectVersionAcl", "s3:GetObjectVersionTagging" + ], + effect="Allow", + resources=["${" + source.arn + "}/*"] + ), DataAwsIamPolicyDocumentStatement( + actions=["s3:ReplicateObject", "s3:ReplicateDelete", "s3:ReplicateTags" + ], + effect="Allow", + resources=["${" + destination.arn + "}/*"] + ) + ] + ) + aws_iam_policy_replication = IamPolicy(self, "replication_8", + name="tf-iam-role-policy-replication-12345", + policy=Token.as_string(replication.json) + ) + # 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_iam_policy_replication.override_logical_id("replication") + aws_iam_role_replication = IamRole(self, "replication_9", + assume_role_policy=Token.as_string(assume_role.json), + name="tf-iam-role-replication-12345" + ) + # 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_iam_role_replication.override_logical_id("replication") + aws_iam_role_policy_attachment_replication = IamRolePolicyAttachment(self, "replication_10", + policy_arn=Token.as_string(aws_iam_policy_replication.arn), + role=Token.as_string(aws_iam_role_replication.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. + aws_iam_role_policy_attachment_replication.override_logical_id("replication") + aws_s3_bucket_replication_configuration_replication = + S3BucketReplicationConfigurationA(self, "replication_11", + bucket=source.id, + depends_on=[aws_s3_bucket_versioning_source], + region="eu-central-1", + role=Token.as_string(aws_iam_role_replication.arn), + rule=[S3BucketReplicationConfigurationRule( + destination=S3BucketReplicationConfigurationRuleDestination( + bucket=destination.arn, + storage_class="STANDARD" + ), + filter=S3BucketReplicationConfigurationRuleFilter( + prefix="example" + ), + id="examplerule", status="Enabled" ) ] @@ -228,6 +355,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `bucket` - (Required) Name of the source S3 bucket you want Amazon S3 to monitor. * `role` - (Required) ARN of the IAM role for Amazon S3 to assume when replicating the objects. * `rule` - (Required) List of configuration blocks describing the rules managing the replication. [See below](#rule). @@ -460,4 +588,4 @@ Using `terraform import`, import S3 bucket replication configuration using the ` % terraform import aws_s3_bucket_replication_configuration.replication bucket-name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/s3_bucket_request_payment_configuration.html.markdown b/website/docs/cdktf/python/r/s3_bucket_request_payment_configuration.html.markdown index 186506ecf8fc..1e89e5e1354d 100644 --- a/website/docs/cdktf/python/r/s3_bucket_request_payment_configuration.html.markdown +++ b/website/docs/cdktf/python/r/s3_bucket_request_payment_configuration.html.markdown @@ -40,6 +40,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `bucket` - (Required, Forces new resource) Name of the bucket. * `expected_bucket_owner` - (Optional, Forces new resource) Account ID of the expected bucket owner. * `payer` - (Required) Specifies who pays for the download and request fees. Valid values: `BucketOwner`, `Requester`. @@ -102,4 +103,4 @@ If the owner (account ID) of the source bucket differs from the account used to % terraform import aws_s3_bucket_request_payment_configuration.example bucket-name,123456789012 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/s3_bucket_server_side_encryption_configuration.html.markdown b/website/docs/cdktf/python/r/s3_bucket_server_side_encryption_configuration.html.markdown index 28be4ce9646c..713cd8909197 100644 --- a/website/docs/cdktf/python/r/s3_bucket_server_side_encryption_configuration.html.markdown +++ b/website/docs/cdktf/python/r/s3_bucket_server_side_encryption_configuration.html.markdown @@ -53,6 +53,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `bucket` - (Required, Forces new resource) ID (name) of the bucket. * `expected_bucket_owner` - (Optional, Forces new resource) Account ID of the expected bucket owner. * `rule` - (Required) Set of server-side encryption configuration rules. [See below](#rule). Currently, only a single rule is supported. @@ -129,4 +130,4 @@ If the owner (account ID) of the source bucket differs from the account used to % terraform import aws_s3_bucket_server_side_encryption_configuration.example bucket-name,123456789012 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/s3_bucket_versioning.html.markdown b/website/docs/cdktf/python/r/s3_bucket_versioning.html.markdown index ca95d6853440..72e69465f540 100644 --- a/website/docs/cdktf/python/r/s3_bucket_versioning.html.markdown +++ b/website/docs/cdktf/python/r/s3_bucket_versioning.html.markdown @@ -134,6 +134,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `bucket` - (Required, Forces new resource) Name of the S3 bucket. * `versioning_configuration` - (Required) Configuration block for the versioning parameters. [See below](#versioning_configuration). * `expected_bucket_owner` - (Optional, Forces new resource) Account ID of the expected bucket owner. @@ -207,4 +208,4 @@ If the owner (account ID) of the source bucket differs from the account used to % terraform import aws_s3_bucket_versioning.example bucket-name,123456789012 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/s3_bucket_website_configuration.html.markdown b/website/docs/cdktf/python/r/s3_bucket_website_configuration.html.markdown index e929cf5331a0..903a440417d6 100644 --- a/website/docs/cdktf/python/r/s3_bucket_website_configuration.html.markdown +++ b/website/docs/cdktf/python/r/s3_bucket_website_configuration.html.markdown @@ -80,6 +80,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `bucket` - (Required, Forces new resource) Name of the bucket. * `error_document` - (Optional, Conflicts with `redirect_all_requests_to`) Name of the error document for the website. [See below](#error_document). * `expected_bucket_owner` - (Optional, Forces new resource) Account ID of the expected bucket owner. @@ -194,4 +195,4 @@ If the owner (account ID) of the source bucket differs from the account used to % terraform import aws_s3_bucket_website_configuration.example bucket-name,123456789012 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/s3_directory_bucket.html.markdown b/website/docs/cdktf/python/r/s3_directory_bucket.html.markdown index 2b07e4f7cf4b..3444465c144f 100644 --- a/website/docs/cdktf/python/r/s3_directory_bucket.html.markdown +++ b/website/docs/cdktf/python/r/s3_directory_bucket.html.markdown @@ -65,10 +65,12 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `bucket` - (Required) Name of the bucket. The name must be in the format `[bucket_name]--[azid]--x-s3`. Use the [`aws_s3_bucket`](s3_bucket.html) resource to manage general purpose buckets. * `data_redundancy` - (Optional) Data redundancy. Valid values: `SingleAvailabilityZone`, `SingleLocalZone`. The default value depends on the value of the `location.type` attribute. * `force_destroy` - (Optional, Default:`false`) Boolean that indicates all objects should be deleted from the bucket *when the bucket is destroyed* so that the bucket can be destroyed without error. These objects are *not* recoverable. This only deletes objects when the bucket is destroyed, *not* when setting this parameter to `true`. Once this parameter is set to `true`, there must be a successful `terraform apply` run before a destroy is required to update this value in the resource state. Without a successful `terraform apply` after this parameter is set, this flag will have no effect. If setting this field in the same operation that would require replacing the bucket or destroying the bucket, this flag will not work. Additionally when importing a bucket, a successful `terraform apply` is required to set this value in state before it will take effect on a destroy operation. * `location` - (Required) Bucket location. See [Location](#location) below for more details. +* `tags` - (Optional) Map of tags to assign to the bucket. 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. * `type` - (Optional, Default:`Directory`) Bucket type. Valid values: `Directory`. ### Location @@ -84,6 +86,7 @@ This resource exports the following attributes in addition to the arguments abov * `id` - (**Deprecated**, use `bucket` instead) Name of the bucket. * `arn` - ARN of the bucket. +* `tags_all` - Map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). ## Import @@ -110,4 +113,4 @@ Using `terraform import`, import S3 bucket using `bucket`. For example: % terraform import aws_s3_directory_bucket.example example--usw2-az1--x-s3 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/s3_object.html.markdown b/website/docs/cdktf/python/r/s3_object.html.markdown index 942157bc0160..a2c3f4e7b700 100644 --- a/website/docs/cdktf/python/r/s3_object.html.markdown +++ b/website/docs/cdktf/python/r/s3_object.html.markdown @@ -250,10 +250,11 @@ The following arguments are optional: * `object_lock_mode` - (Optional) Object lock [retention mode](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock-overview.html#object-lock-retention-modes) that you want to apply to this object. Valid values are `GOVERNANCE` and `COMPLIANCE`. * `object_lock_retain_until_date` - (Optional) Date and time, in [RFC3339 format](https://tools.ietf.org/html/rfc3339#section-5.8), when this object's object lock will [expire](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock-overview.html#object-lock-retention-periods). * `override_provider` - (Optional) Override provider-level configuration options. See [Override Provider](#override-provider) below for more details. -* `server_side_encryption` - (Optional) Server-side encryption of the object in S3. Valid values are "`AES256`" and "`aws:kms`". +* `server_side_encryption` - (Optional) Server-side encryption of the object in S3. Valid values are `"AES256"`, `"aws:kms"`, `"aws:kms:dsse"`, and `"aws:fsx"`. * `source_hash` - (Optional) Triggers updates like `etag` but useful to address `etag` encryption limitations. Set using `filemd5("path/to/source")` (Terraform 0.11.12 or later). (The value is only stored in state and not saved by AWS.) * `source` - (Optional, conflicts with `content` and `content_base64`) Path to a file that will be read and uploaded as raw bytes for the object content. * `storage_class` - (Optional) [Storage Class](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html#AmazonS3-PutObject-request-header-StorageClass) for the object. Defaults to "`STANDARD`". +* `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). * `tags` - (Optional) Map of tags to assign to the object. 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. * `website_redirect` - (Optional) Target URL for [website redirect](http://docs.aws.amazon.com/AmazonS3/latest/dev/how-to-page-redirect.html). @@ -335,4 +336,4 @@ Import using S3 URL syntax: % terraform import aws_s3_object.example s3://some-bucket-name/some/key.txt ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/s3_object_copy.html.markdown b/website/docs/cdktf/python/r/s3_object_copy.html.markdown index 4b2ec862b6ee..5bce0ca6b81f 100644 --- a/website/docs/cdktf/python/r/s3_object_copy.html.markdown +++ b/website/docs/cdktf/python/r/s3_object_copy.html.markdown @@ -78,6 +78,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `acl` - (Optional) [Canned ACL](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl) to apply. Valid values are `private`, `public-read`, `public-read-write`, `authenticated-read`, `aws-exec-read`, `bucket-owner-read`, and `bucket-owner-full-control`. Conflicts with `grant`. * `cache_control` - (Optional) Specifies caching behavior along the request/reply chain Read [w3c cache_control](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9) for further details. * `checksum_algorithm` - (Optional) Indicates the algorithm used to create the checksum for the object. If a value is specified and the object is encrypted with KMS, you must have permission to use the `kms:Decrypt` action. Valid values: `CRC32`, `CRC32C`, `CRC64NVME` `SHA1`, `SHA256`. @@ -155,4 +156,4 @@ This resource exports the following attributes in addition to the arguments abov * `tags_all` - Map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). * `version_id` - Version ID of the newly created copy. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/s3control_access_grant.html.markdown b/website/docs/cdktf/python/r/s3control_access_grant.html.markdown index 0d1e2993af24..012d72cd971d 100644 --- a/website/docs/cdktf/python/r/s3control_access_grant.html.markdown +++ b/website/docs/cdktf/python/r/s3control_access_grant.html.markdown @@ -60,6 +60,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `access_grants_location_configuration` - (Optional) See [Location Configuration](#location-configuration) below for more details. * `access_grants_location_id` - (Required) The ID of the S3 Access Grants location to with the access grant is giving access. * `account_id` - (Optional) The AWS account ID for the S3 Access Grants location. Defaults to automatically determined account ID of the Terraform AWS provider. @@ -115,4 +116,4 @@ Using `terraform import`, import S3 Access Grants using the `account_id` and `ac % terraform import aws_s3control_access_grants_location.example 123456789012,04549c5e-2f3c-4a07-824d-2cafe720aa22 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/s3control_access_grants_instance.html.markdown b/website/docs/cdktf/python/r/s3control_access_grants_instance.html.markdown index 2e8844aadd43..bacb8b54cfa8 100644 --- a/website/docs/cdktf/python/r/s3control_access_grants_instance.html.markdown +++ b/website/docs/cdktf/python/r/s3control_access_grants_instance.html.markdown @@ -55,6 +55,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `account_id` - (Optional) The AWS account ID for the S3 Access Grants instance. Defaults to automatically determined account ID of the Terraform AWS provider. * `identity_center_arn` - (Optional) The ARN of the AWS IAM Identity Center instance associated with the S3 Access Grants instance. * `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. @@ -93,4 +94,4 @@ Using `terraform import`, import S3 Access Grants instances using the `account_i % terraform import aws_s3control_access_grants_instance.example 123456789012 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/s3control_access_grants_instance_resource_policy.html.markdown b/website/docs/cdktf/python/r/s3control_access_grants_instance_resource_policy.html.markdown index 001d449775ad..4eb30f834b74 100644 --- a/website/docs/cdktf/python/r/s3control_access_grants_instance_resource_policy.html.markdown +++ b/website/docs/cdktf/python/r/s3control_access_grants_instance_resource_policy.html.markdown @@ -41,6 +41,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `account_id` - (Optional) The AWS account ID for the S3 Access Grants instance. Defaults to automatically determined account ID of the Terraform AWS provider. * `policy` - (Optional) The policy document. @@ -73,4 +74,4 @@ Using `terraform import`, import S3 Access Grants instance resource policies usi % terraform import aws_s3control_access_grants_instance_resource_policy.example 123456789012 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/s3control_access_grants_location.html.markdown b/website/docs/cdktf/python/r/s3control_access_grants_location.html.markdown index b3fa8db202b5..acefa4659866 100644 --- a/website/docs/cdktf/python/r/s3control_access_grants_location.html.markdown +++ b/website/docs/cdktf/python/r/s3control_access_grants_location.html.markdown @@ -45,6 +45,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `account_id` - (Optional) The AWS account ID for the S3 Access Grants location. Defaults to automatically determined account ID of the Terraform AWS provider. * `iam_role_arn` - (Required) The ARN of the IAM role that S3 Access Grants should use when fulfilling runtime access requests to the location. @@ -84,4 +85,4 @@ Using `terraform import`, import S3 Access Grants locations using the `account_i % terraform import aws_s3control_access_grants_location.example 123456789012,default ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/s3control_access_point_policy.html.markdown b/website/docs/cdktf/python/r/s3control_access_point_policy.html.markdown index c0926b341279..a429da6afa09 100644 --- a/website/docs/cdktf/python/r/s3control_access_point_policy.html.markdown +++ b/website/docs/cdktf/python/r/s3control_access_point_policy.html.markdown @@ -73,6 +73,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `access_point_arn` - (Required) The ARN of the access point that you want to associate with the specified policy. * `policy` - (Required) The policy that you want to apply to the specified access point. @@ -108,4 +109,4 @@ Using `terraform import`, import Access Point policies using the `access_point_a % terraform import aws_s3control_access_point_policy.example arn:aws:s3:us-west-2:123456789012:accesspoint/example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/s3control_bucket.html.markdown b/website/docs/cdktf/python/r/s3control_bucket.html.markdown index e50983e2cb23..f4dea44747ee 100644 --- a/website/docs/cdktf/python/r/s3control_bucket.html.markdown +++ b/website/docs/cdktf/python/r/s3control_bucket.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `bucket` - (Required) Name of the bucket. * `outpost_id` - (Required) Identifier of the Outpost to contain this bucket. * `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. @@ -77,4 +78,4 @@ Using `terraform import`, import S3 Control Buckets using Amazon Resource Name ( % terraform import aws_s3control_bucket.example arn:aws:s3-outposts:us-east-1:123456789012:outpost/op-12345678/bucket/example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/s3control_bucket_lifecycle_configuration.html.markdown b/website/docs/cdktf/python/r/s3control_bucket_lifecycle_configuration.html.markdown index 12225a6f63d5..21f318ff368e 100644 --- a/website/docs/cdktf/python/r/s3control_bucket_lifecycle_configuration.html.markdown +++ b/website/docs/cdktf/python/r/s3control_bucket_lifecycle_configuration.html.markdown @@ -57,6 +57,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `bucket` - (Required) Amazon Resource Name (ARN) of the bucket. * `rule` - (Required) Configuration block(s) containing lifecycle rules for the bucket. * `abort_incomplete_multipart_upload` - (Optional) Configuration block containing settings for abort incomplete multipart upload. @@ -102,4 +103,4 @@ Using `terraform import`, import S3 Control Bucket Lifecycle Configurations usin % terraform import aws_s3control_bucket_lifecycle_configuration.example arn:aws:s3-outposts:us-east-1:123456789012:outpost/op-12345678/bucket/example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/s3control_bucket_policy.html.markdown b/website/docs/cdktf/python/r/s3control_bucket_policy.html.markdown index 84861ccebae2..8958901b27de 100644 --- a/website/docs/cdktf/python/r/s3control_bucket_policy.html.markdown +++ b/website/docs/cdktf/python/r/s3control_bucket_policy.html.markdown @@ -50,8 +50,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `bucket` - (Required) Amazon Resource Name (ARN) of the bucket. * `policy` - (Required) JSON string of the resource policy. For more information about building AWS IAM policy documents with Terraform, see the [AWS IAM Policy Document Guide](https://learn.hashicorp.com/terraform/aws/iam-policy). @@ -86,4 +87,4 @@ Using `terraform import`, import S3 Control Bucket Policies using the Amazon Res % terraform import aws_s3control_bucket_policy.example arn:aws:s3-outposts:us-east-1:123456789012:outpost/op-12345678/bucket/example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/s3control_directory_bucket_access_point_scope.html.markdown b/website/docs/cdktf/python/r/s3control_directory_bucket_access_point_scope.html.markdown index 2ab63bfcb5f8..d5157c6e8401 100644 --- a/website/docs/cdktf/python/r/s3control_directory_bucket_access_point_scope.html.markdown +++ b/website/docs/cdktf/python/r/s3control_directory_bucket_access_point_scope.html.markdown @@ -30,9 +30,9 @@ 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. import S3ControlDirectoryBucketAccessPointScope from imports.aws.data_aws_availability_zones import DataAwsAvailabilityZones from imports.aws.s3_access_point import S3AccessPoint +from imports.aws.s3_control_directory_bucket_access_point_scope import S3ControlDirectoryBucketAccessPointScope from imports.aws.s3_directory_bucket import S3DirectoryBucket class MyConvertedCode(TerraformStack): def __init__(self, scope, name): @@ -70,8 +70,9 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: -* `name` - (Required) The name of the access point that you want to apply the scope to. * `account_id` - (Required) The AWS account ID that owns the specified access point. +* `name` - (Required) The name of the access point that you want to apply the scope to. +* `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). * `scope` - (Optional). Scope is used to restrict access to specific prefixes, API operations, or a combination of both. To remove the `scope`, set it to `{permissions=[] prefixes=[]}`. The default scope is `{permissions=[] prefixes=[]}`. ### Scope Configuration block @@ -99,7 +100,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 S3ControlDirectoryBucketAccessPointScope +from imports.aws.s3_control_directory_bucket_access_point_scope import S3ControlDirectoryBucketAccessPointScope class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) @@ -112,4 +113,4 @@ Using `terraform import`, import Access Point Scope using access point name and % terraform import aws_s3control_directory_bucket_access_point_scope.example example--zoneid--xa-s3,123456789012 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/s3control_multi_region_access_point.html.markdown b/website/docs/cdktf/python/r/s3control_multi_region_access_point.html.markdown index 4590d90188c9..8ad0f3c37ae1 100644 --- a/website/docs/cdktf/python/r/s3control_multi_region_access_point.html.markdown +++ b/website/docs/cdktf/python/r/s3control_multi_region_access_point.html.markdown @@ -65,6 +65,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `account_id` - (Optional) The AWS account ID for the owner of the buckets for which you want to create a Multi-Region Access Point. Defaults to automatically determined account ID of the Terraform AWS provider. * `details` - (Required) A configuration block containing details about the Multi-Region Access Point. See [Details Configuration Block](#details-configuration) below for more details @@ -142,4 +143,4 @@ Using `terraform import`, import Multi-Region Access Points using the `account_i % terraform import aws_s3control_multi_region_access_point.example 123456789012:example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/s3control_multi_region_access_point_policy.html.markdown b/website/docs/cdktf/python/r/s3control_multi_region_access_point_policy.html.markdown index 25a37781f3f5..06968b548fb3 100644 --- a/website/docs/cdktf/python/r/s3control_multi_region_access_point_policy.html.markdown +++ b/website/docs/cdktf/python/r/s3control_multi_region_access_point_policy.html.markdown @@ -76,6 +76,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `account_id` - (Optional) The AWS account ID for the owner of the Multi-Region Access Point. Defaults to automatically determined account ID of the Terraform AWS provider. * `details` - (Required) A configuration block containing details about the policy for the Multi-Region Access Point. See [Details Configuration Block](#details-configuration) below for more details @@ -128,4 +129,4 @@ Using `terraform import`, import Multi-Region Access Point Policies using the `a % terraform import aws_s3control_multi_region_access_point_policy.example 123456789012:example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/s3control_object_lambda_access_point.html.markdown b/website/docs/cdktf/python/r/s3control_object_lambda_access_point.html.markdown index 8414840a9dbe..a248165c14ec 100644 --- a/website/docs/cdktf/python/r/s3control_object_lambda_access_point.html.markdown +++ b/website/docs/cdktf/python/r/s3control_object_lambda_access_point.html.markdown @@ -62,6 +62,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `account_id` - (Optional) The AWS account ID for the owner of the bucket for which you want to create an Object Lambda Access Point. Defaults to automatically determined account ID of the Terraform AWS provider. * `configuration` - (Required) A configuration block containing details about the Object Lambda Access Point. See [Configuration](#configuration) below for more details. * `name` - (Required) The name for this Object Lambda Access Point. @@ -128,4 +129,4 @@ Using `terraform import`, import Object Lambda Access Points using the `account_ % terraform import aws_s3control_object_lambda_access_point.example 123456789012:example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/s3control_object_lambda_access_point_policy.html.markdown b/website/docs/cdktf/python/r/s3control_object_lambda_access_point_policy.html.markdown index 27cd0da09e16..860c2947cd66 100644 --- a/website/docs/cdktf/python/r/s3control_object_lambda_access_point_policy.html.markdown +++ b/website/docs/cdktf/python/r/s3control_object_lambda_access_point_policy.html.markdown @@ -81,6 +81,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `account_id` - (Optional) The AWS account ID for the account that owns the Object Lambda Access Point. Defaults to automatically determined account ID of the Terraform AWS provider. * `name` - (Required) The name of the Object Lambda Access Point. * `policy` - (Required) The Object Lambda Access Point resource policy document. @@ -117,4 +118,4 @@ Using `terraform import`, import Object Lambda Access Point policies using the ` % terraform import aws_s3control_object_lambda_access_point_policy.example 123456789012:example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/s3control_storage_lens_configuration.html.markdown b/website/docs/cdktf/python/r/s3control_storage_lens_configuration.html.markdown index f8c2a6ed8821..fd85ce90a4bb 100644 --- a/website/docs/cdktf/python/r/s3control_storage_lens_configuration.html.markdown +++ b/website/docs/cdktf/python/r/s3control_storage_lens_configuration.html.markdown @@ -68,6 +68,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `account_id` - (Optional) The AWS account ID for the S3 Storage Lens configuration. Defaults to automatically determined account ID of the Terraform AWS provider. * `config_id` - (Required) The ID of the S3 Storage Lens configuration. * `storage_lens_configuration` - (Required) The S3 Storage Lens configuration. See [Storage Lens Configuration](#storage-lens-configuration) below for more details. @@ -238,4 +239,4 @@ Using `terraform import`, import S3 Storage Lens configurations using the `accou % terraform import aws_s3control_storage_lens_configuration.example 123456789012:example-1 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/s3outposts_endpoint.html.markdown b/website/docs/cdktf/python/r/s3outposts_endpoint.html.markdown index c0b8a3de2fc7..4b6b7f758117 100644 --- a/website/docs/cdktf/python/r/s3outposts_endpoint.html.markdown +++ b/website/docs/cdktf/python/r/s3outposts_endpoint.html.markdown @@ -37,6 +37,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `outpost_id` - (Required) Identifier of the Outpost to contain this endpoint. * `security_group_id` - (Required) Identifier of the EC2 Security Group. * `subnet_id` - (Required) Identifier of the EC2 Subnet. @@ -79,4 +80,4 @@ Using `terraform import`, import S3 Outposts Endpoints using Amazon Resource Nam % terraform import aws_s3outposts_endpoint.example arn:aws:s3-outposts:us-east-1:123456789012:outpost/op-12345678/endpoint/0123456789abcdef,sg-12345678,subnet-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/s3tables_namespace.html.markdown b/website/docs/cdktf/python/r/s3tables_namespace.html.markdown index aaba98ae9b03..aae328c75347 100644 --- a/website/docs/cdktf/python/r/s3tables_namespace.html.markdown +++ b/website/docs/cdktf/python/r/s3tables_namespace.html.markdown @@ -42,8 +42,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `namespace` - (Required, Forces new resource) Name of the namespace. Must be between 1 and 255 characters in length. Can consist of lowercase letters, numbers, and underscores, and must begin and end with a lowercase letter or number. @@ -82,4 +83,4 @@ Using `terraform import`, import S3 Tables Namespace using the `table_bucket_arn % terraform import aws_s3tables_namespace.example 'arn:aws:s3tables:us-west-2:123456789012:bucket/example-bucket;example-namespace' ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/s3tables_table.html.markdown b/website/docs/cdktf/python/r/s3tables_table.html.markdown index e6523fb1dae4..10c499af59ba 100644 --- a/website/docs/cdktf/python/r/s3tables_table.html.markdown +++ b/website/docs/cdktf/python/r/s3tables_table.html.markdown @@ -49,6 +49,68 @@ class MyConvertedCode(TerraformStack): aws_s3_tables_table_example.override_logical_id("example") ``` +### With Metadata Schema + +```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.s3_tables_namespace import S3TablesNamespace +from imports.aws.s3_tables_table import S3TablesTable +from imports.aws.s3_tables_table_bucket import S3TablesTableBucket +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + example = S3TablesTableBucket(self, "example", + name="example-bucket" + ) + aws_s3_tables_namespace_example = S3TablesNamespace(self, "example_1", + namespace="example_namespace", + table_bucket_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_s3_tables_namespace_example.override_logical_id("example") + aws_s3_tables_table_example = S3TablesTable(self, "example_2", + format="ICEBERG", + metadata=[{ + "iceberg": [{ + "schema": [{ + "field": [{ + "name": "id", + "required": True, + "type": "long" + }, { + "name": "name", + "required": True, + "type": "string" + }, { + "name": "created_at", + "required": False, + "type": "timestamp" + }, { + "name": "price", + "required": False, + "type": "decimal(10,2)" + } + ] + } + ] + } + ] + } + ], + name="example_table", + namespace=Token.as_string(aws_s3_tables_namespace_example.namespace), + table_bucket_arn=Token.as_string(aws_s3_tables_namespace_example.table_bucket_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_s3_tables_table_example.override_logical_id("example") +``` + ## Argument Reference The following arguments are required: @@ -66,10 +128,13 @@ The following arguments are required: The following arguments are optional: +* `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). * `encryption_configuration` - (Optional) A single table bucket encryption configuration object. [See `encryption_configuration` below](#encryption_configuration). * `maintenance_configuration` - (Optional) A single table bucket maintenance configuration object. [See `maintenance_configuration` below](#maintenance_configuration). +* `metadata` - (Optional) Contains details about the table metadata. This configuration specifies the metadata format and schema for the table. Currently only supports Iceberg format. + [See `metadata` below](#metadata). ### `encryption_configuration` @@ -121,6 +186,35 @@ The `iceberg_snapshot_management.settings` object supports the following argumen * `min_snapshots_to_keep` - (Required) Minimum number of snapshots to keep. Must be at least `1`. +### `metadata` + +The `metadata` configuration block supports the following argument: + +* `iceberg` - (Optional) Contains details about the metadata for an Iceberg table. This block defines the schema structure for the Apache Iceberg table format. + [See `iceberg` below](#iceberg). + +### `iceberg` + +The `iceberg` configuration block supports the following argument: + +* `schema` - (Required) Schema configuration for the Iceberg table. + [See `schema` below](#schema). + +### `schema` + +The `schema` configuration block supports the following argument: + +* `field` - (Required) List of schema fields for the Iceberg table. Each field defines a column in the table schema. + [See `field` below](#field). + +### `field` + +The `field` configuration block supports the following arguments: + +* `name` - (Required) The name of the field. +* `type` - (Required) The field type. S3 Tables supports all Apache Iceberg primitive types including: `boolean`, `int`, `long`, `float`, `double`, `decimal(precision,scale)`, `date`, `time`, `timestamp`, `timestamptz`, `string`, `uuid`, `fixed(length)`, `binary`. +* `required` - (Optional) A Boolean value that specifies whether values are required for each row in this field. Defaults to `false`. + ## Attribute Reference This resource exports the following attributes in addition to the arguments above: @@ -162,4 +256,4 @@ Using `terraform import`, import S3 Tables Table using the `table_bucket_arn`, t % terraform import aws_s3tables_table.example 'arn:aws:s3tables:us-west-2:123456789012:bucket/example-bucket;example-namespace;example-table' ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/s3tables_table_bucket.html.markdown b/website/docs/cdktf/python/r/s3tables_table_bucket.html.markdown index 550aa4cacbca..f59b45a208dc 100644 --- a/website/docs/cdktf/python/r/s3tables_table_bucket.html.markdown +++ b/website/docs/cdktf/python/r/s3tables_table_bucket.html.markdown @@ -46,8 +46,10 @@ The following arguments are optional: * `encryption_configuration` - (Optional) A single table bucket encryption configuration object. [See `encryption_configuration` below](#encryption_configuration). +* `force_destroy` - (Optional, Default:`false`) Whether all tables and namespaces within the table bucket should be deleted *when the table bucket is destroyed* so that the table bucket can be destroyed without error. These tables and namespaces are *not* recoverable. This only deletes tables and namespaces when the table bucket is destroyed, *not* when setting this parameter to `true`. Once this parameter is set to `true`, there must be a successful `terraform apply` run before a destroy is required to update this value in the resource state. Without a successful `terraform apply` after this parameter is set, this flag will have no effect. If setting this field in the same operation that would require replacing the table bucket or destroying the table bucket, this flag will not work. Additionally when importing a table bucket, a successful `terraform apply` is required to set this value in state before it will take effect on a destroy operation. * `maintenance_configuration` - (Optional) A single table bucket maintenance configuration object. [See `maintenance_configuration` below](#maintenance_configuration). +* `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). ### `encryption_configuration` @@ -114,4 +116,4 @@ Using `terraform import`, import S3 Tables Table Bucket using the `arn`. For exa % terraform import aws_s3tables_table_bucket.example arn:aws:s3tables:us-west-2:123456789012:bucket/example-bucket ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/s3tables_table_bucket_policy.html.markdown b/website/docs/cdktf/python/r/s3tables_table_bucket_policy.html.markdown index 4435176493c7..5a00f4100da8 100644 --- a/website/docs/cdktf/python/r/s3tables_table_bucket_policy.html.markdown +++ b/website/docs/cdktf/python/r/s3tables_table_bucket_policy.html.markdown @@ -46,8 +46,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `resource_policy` - (Required) Amazon Web Services resource-based policy document in JSON format. * `table_bucket_arn` - (Required, Forces new resource) ARN referencing the Table Bucket that owns this policy. @@ -80,4 +81,4 @@ Using `terraform import`, import S3 Tables Table Bucket Policy using the `table_ % terraform import aws_s3tables_table_bucket_policy.example 'arn:aws:s3tables:us-west-2:123456789012:bucket/example-bucket;example-namespace' ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/s3tables_table_policy.html.markdown b/website/docs/cdktf/python/r/s3tables_table_policy.html.markdown index 5de88b7bdcc8..52a45b5a2bab 100644 --- a/website/docs/cdktf/python/r/s3tables_table_policy.html.markdown +++ b/website/docs/cdktf/python/r/s3tables_table_policy.html.markdown @@ -66,8 +66,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `resource_policy` - (Required) Amazon Web Services resource-based policy document in JSON format. * `name` - (Required, Forces new resource) Name of the table. Must be between 1 and 255 characters in length. @@ -106,4 +107,4 @@ Using `terraform import`, import S3 Tables Table Policy using the `table_bucket_ % terraform import aws_s3tables_table_policy.example 'arn:aws:s3tables:us-west-2:123456789012:bucket/example-bucket;example-namespace;example-table' ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/sagemaker_app.html.markdown b/website/docs/cdktf/python/r/sagemaker_app.html.markdown index e440054b66d5..b5113f753547 100644 --- a/website/docs/cdktf/python/r/sagemaker_app.html.markdown +++ b/website/docs/cdktf/python/r/sagemaker_app.html.markdown @@ -40,6 +40,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `app_name` - (Required) The name of the app. * `app_type` - (Required) The type of app. Valid values are `JupyterServer`, `KernelGateway`, `RStudioServerPro`, `RSessionGateway`, `TensorBoard`, `CodeEditor`, `JupyterLab`, `DetailedProfiler`, and `Canvas`. * `domain_id` - (Required) The domain ID. @@ -89,4 +90,4 @@ Using `terraform import`, import SageMaker AI Apps using the `id`. For example: % terraform import aws_sagemaker_app.example arn:aws:sagemaker:us-west-2:012345678912:app/domain-id/user-profile-name/app-type/app-name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/sagemaker_app_image_config.html.markdown b/website/docs/cdktf/python/r/sagemaker_app_image_config.html.markdown index 84ac493154fe..41f9bac056bd 100644 --- a/website/docs/cdktf/python/r/sagemaker_app_image_config.html.markdown +++ b/website/docs/cdktf/python/r/sagemaker_app_image_config.html.markdown @@ -39,6 +39,26 @@ class MyConvertedCode(TerraformStack): ) ``` +### Using Code Editor with empty configuration + +```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.sagemaker_app_image_config import SagemakerAppImageConfig +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + SagemakerAppImageConfig(self, "test", + app_image_config_name="example", + code_editor_app_image_config=SagemakerAppImageConfigCodeEditorAppImageConfig() + ) +``` + ### Default File System Config ```python @@ -69,12 +89,15 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `app_image_config_name` - (Required) The name of the App Image Config. -* `code_editor_app_image_config` - (Optional) The CodeEditorAppImageConfig. You can only specify one image kernel in the AppImageConfig API. This kernel is shown to users before the image starts. After the image runs, all kernels are visible in Code Editor. See [Code Editor App Image Config](#code-editor-app-image-config) details below. -* `jupyter_lab_image_config` - (Optional) The JupyterLabAppImageConfig. You can only specify one image kernel in the AppImageConfig API. This kernel is shown to users before the image starts. After the image runs, all kernels are visible in JupyterLab. See [Jupyter Lab Image Config](#jupyter-lab-image-config) details below. +* `code_editor_app_image_config` - (Optional) The CodeEditorAppImageConfig. See [Code Editor App Image Config](#code-editor-app-image-config) details below. +* `jupyter_lab_image_config` - (Optional) The JupyterLabAppImageConfig. See [Jupyter Lab Image Config](#jupyter-lab-image-config) details below. * `kernel_gateway_image_config` - (Optional) The configuration for the file system and kernels in a SageMaker AI image running as a KernelGateway app. See [Kernel Gateway Image Config](#kernel-gateway-image-config) details below. * `tags` - (Optional) A 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. +~> **NOTE:** Exactly one of `code_editor_app_image_config`, `jupyter_lab_image_config`, or `kernel_gateway_image_config` must be configured. Empty blocks (e.g., `code_editor_app_image_config {}`) are valid configurations. + ### Code Editor App Image Config * `container_config` - (Optional) The configuration used to run the application image container. See [Container Config](#container-config) details below. @@ -142,4 +165,4 @@ Using `terraform import`, import SageMaker AI App Image Configs using the `name` % terraform import aws_sagemaker_app_image_config.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/sagemaker_code_repository.html.markdown b/website/docs/cdktf/python/r/sagemaker_code_repository.html.markdown index b74f4fc0ec75..367bb9f22646 100644 --- a/website/docs/cdktf/python/r/sagemaker_code_repository.html.markdown +++ b/website/docs/cdktf/python/r/sagemaker_code_repository.html.markdown @@ -82,6 +82,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `code_repository_name` - (Required) The name of the Code Repository (must be unique). * `git_config` - (Required) Specifies details about the repository. see [Git Config](#git-config) details below. * `tags` - (Optional) A 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. @@ -125,4 +126,4 @@ Using `terraform import`, import SageMaker AI Code Repositories using the `name` % terraform import aws_sagemaker_code_repository.test_code_repository my-code-repo ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/sagemaker_data_quality_job_definition.html.markdown b/website/docs/cdktf/python/r/sagemaker_data_quality_job_definition.html.markdown index 7b0d8da11438..392ff5d772a8 100644 --- a/website/docs/cdktf/python/r/sagemaker_data_quality_job_definition.html.markdown +++ b/website/docs/cdktf/python/r/sagemaker_data_quality_job_definition.html.markdown @@ -60,6 +60,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `data_quality_app_specification` - (Required) Specifies the container that runs the monitoring job. Fields are documented below. * `data_quality_baseline_config` - (Optional) Configures the constraints and baselines for the monitoring job. Fields are documented below. * `data_quality_job_input` - (Required) A list of inputs for the monitoring job. Fields are documented below. @@ -198,4 +199,4 @@ Using `terraform import`, import data quality job definitions using the `name`. % terraform import aws_sagemaker_data_quality_job_definition.test_data_quality_job_definition data-quality-job-definition-foo ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/sagemaker_device.html.markdown b/website/docs/cdktf/python/r/sagemaker_device.html.markdown index aa9e7ae17f03..12f317ed6e2a 100644 --- a/website/docs/cdktf/python/r/sagemaker_device.html.markdown +++ b/website/docs/cdktf/python/r/sagemaker_device.html.markdown @@ -40,6 +40,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `device_fleet_name` - (Required) The name of the Device Fleet. * `device` - (Required) The device to register with SageMaker AI Edge Manager. See [Device](#device) details below. @@ -81,4 +82,4 @@ Using `terraform import`, import SageMaker AI Devices using the `device-fleet-na % terraform import aws_sagemaker_device.example my-fleet/my-device ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/sagemaker_device_fleet.html.markdown b/website/docs/cdktf/python/r/sagemaker_device_fleet.html.markdown index 4be5e25975a0..78fbb1d2c00e 100644 --- a/website/docs/cdktf/python/r/sagemaker_device_fleet.html.markdown +++ b/website/docs/cdktf/python/r/sagemaker_device_fleet.html.markdown @@ -41,6 +41,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `device_fleet_name` - (Required) The name of the Device Fleet (must be unique). * `role_arn` - (Required) The Amazon Resource Name (ARN) that has access to AWS Internet of Things (IoT). * `output_config` - (Required) Specifies details about the repository. see [Output Config](#output-config) details below. @@ -86,4 +87,4 @@ Using `terraform import`, import SageMaker AI Device Fleets using the `name`. Fo % terraform import aws_sagemaker_device_fleet.example my-fleet ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/sagemaker_domain.html.markdown b/website/docs/cdktf/python/r/sagemaker_domain.html.markdown index f4c1c54ade52..a7133b3a73f8 100644 --- a/website/docs/cdktf/python/r/sagemaker_domain.html.markdown +++ b/website/docs/cdktf/python/r/sagemaker_domain.html.markdown @@ -132,6 +132,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `app_network_access_type` - (Optional) Specifies the VPC used for non-EFS traffic. The default value is `PublicInternetOnly`. Valid values are `PublicInternetOnly` and `VpcOnly`. * `app_security_group_management` - (Optional) The entity that creates and manages the required security groups for inter-app communication in `VPCOnly` mode. Valid values are `Service` and `Customer`. * `domain_settings` - (Optional) The domain settings. See [`domain_settings` Block](#domain_settings-block) below. @@ -390,4 +391,4 @@ Using `terraform import`, import SageMaker AI Domains using the `id`. For exampl % terraform import aws_sagemaker_domain.test_domain d-8jgsjtilstu8 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/sagemaker_endpoint.html.markdown b/website/docs/cdktf/python/r/sagemaker_endpoint.html.markdown index 7629af2d71b5..ca4b34029d42 100644 --- a/website/docs/cdktf/python/r/sagemaker_endpoint.html.markdown +++ b/website/docs/cdktf/python/r/sagemaker_endpoint.html.markdown @@ -41,6 +41,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `endpoint_config_name` - (Required) The name of the endpoint configuration to use. * `deployment_config` - (Optional) The deployment configuration for an endpoint, which contains the desired deployment strategy and rollback configurations. See [Deployment Config](#deployment-config). * `name` - (Optional) The name of the endpoint. If omitted, Terraform will assign a random, unique name. @@ -133,4 +134,4 @@ Using `terraform import`, import endpoints using the `name`. For example: % terraform import aws_sagemaker_endpoint.test_endpoint my-endpoint ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/sagemaker_endpoint_configuration.html.markdown b/website/docs/cdktf/python/r/sagemaker_endpoint_configuration.html.markdown index f3a426c57b31..bc4ea07e722e 100644 --- a/website/docs/cdktf/python/r/sagemaker_endpoint_configuration.html.markdown +++ b/website/docs/cdktf/python/r/sagemaker_endpoint_configuration.html.markdown @@ -47,6 +47,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `production_variants` - (Required) An list of ProductionVariant objects, one for each model that you want to host at this endpoint. Fields are documented below. * `kms_key_arn` - (Optional) Amazon Resource Name (ARN) of a AWS Key Management Service key that Amazon SageMaker AI uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint. * `name` - (Optional) The name of the endpoint configuration. If omitted, Terraform will assign a random, unique name. Conflicts with `name_prefix`. @@ -171,4 +172,4 @@ Using `terraform import`, import endpoint configurations using the `name`. For e % terraform import aws_sagemaker_endpoint_configuration.test_endpoint_config endpoint-config-foo ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/sagemaker_feature_group.html.markdown b/website/docs/cdktf/python/r/sagemaker_feature_group.html.markdown index d271aff0bc94..31fdabce00ab 100644 --- a/website/docs/cdktf/python/r/sagemaker_feature_group.html.markdown +++ b/website/docs/cdktf/python/r/sagemaker_feature_group.html.markdown @@ -48,6 +48,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `feature_group_name` - (Required) The name of the Feature Group. The name must be unique within an AWS Region in an AWS account. * `record_identifier_feature_name` - (Required) The name of the Feature whose value uniquely identifies a Record defined in the Feature Store. Only the latest record per identifier value will be stored in the Online Store. * `event_time_feature_name` - (Required) The name of the feature that stores the EventTime of a Record in a Feature Group. @@ -131,4 +132,4 @@ Using `terraform import`, import Feature Groups using the `name`. For example: % terraform import aws_sagemaker_feature_group.test_feature_group feature_group-foo ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/sagemaker_flow_definition.html.markdown b/website/docs/cdktf/python/r/sagemaker_flow_definition.html.markdown index da2e3415b4f3..ba9a0c151d1a 100644 --- a/website/docs/cdktf/python/r/sagemaker_flow_definition.html.markdown +++ b/website/docs/cdktf/python/r/sagemaker_flow_definition.html.markdown @@ -73,7 +73,7 @@ class MyConvertedCode(TerraformStack): task_count=1, task_description="example", task_title="example", - workteam_arn="arn:aws:sagemaker:${" + current.name + "}:394669845002:workteam/public-crowd/default" + workteam_arn="arn:aws:sagemaker:${" + current.region + "}:394669845002:workteam/public-crowd/default" ), output_config=SagemakerFlowDefinitionOutputConfig( s3_output_path="s3://${" + aws_s3_bucket_example.bucket + "}/" @@ -125,6 +125,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `flow_definition_name` - (Required) The name of your flow definition. * `human_loop_config` - (Required) An object containing information about the tasks the human reviewers will perform. See [Human Loop Config](#human-loop-config) details below. * `role_arn` - (Required) The Amazon Resource Name (ARN) of the role needed to call other services on your behalf. @@ -205,4 +206,4 @@ Using `terraform import`, import SageMaker AI Flow Definitions using the `flow_d % terraform import aws_sagemaker_flow_definition.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/sagemaker_hub.html.markdown b/website/docs/cdktf/python/r/sagemaker_hub.html.markdown index 22f863e8c95b..18ec76eb27cf 100644 --- a/website/docs/cdktf/python/r/sagemaker_hub.html.markdown +++ b/website/docs/cdktf/python/r/sagemaker_hub.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `hub_name` - (Required) The name of the hub. * `hub_description` - (Required) A description of the hub. * `hub_display_name` - (Optional) The display name of the hub. @@ -82,4 +83,4 @@ Using `terraform import`, import SageMaker AI Hubs using the `name`. For example % terraform import aws_sagemaker_hub.test_hub my-code-repo ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/sagemaker_human_task_ui.html.markdown b/website/docs/cdktf/python/r/sagemaker_human_task_ui.html.markdown index 98f285ade838..65b79b3dc6f7 100644 --- a/website/docs/cdktf/python/r/sagemaker_human_task_ui.html.markdown +++ b/website/docs/cdktf/python/r/sagemaker_human_task_ui.html.markdown @@ -39,6 +39,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `human_task_ui_name` - (Required) The name of the Human Task UI. * `tags` - (Optional) A 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. * `ui_template` - (Required) The Liquid template for the worker user interface. See [UI Template](#ui-template) below. @@ -86,4 +87,4 @@ Using `terraform import`, import SageMaker AI Human Task UIs using the `human_ta % terraform import aws_sagemaker_human_task_ui.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/sagemaker_image.html.markdown b/website/docs/cdktf/python/r/sagemaker_image.html.markdown index 82b5b189df3a..9cba4c043c18 100644 --- a/website/docs/cdktf/python/r/sagemaker_image.html.markdown +++ b/website/docs/cdktf/python/r/sagemaker_image.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `image_name` - (Required) The name of the image. Must be unique to your account. * `role_arn` - (Required) The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker AI to perform tasks on your behalf. * `display_name` - (Optional) The display name of the image. When the image is added to a domain (must be unique to the domain). @@ -77,4 +78,4 @@ Using `terraform import`, import SageMaker AI Code Images using the `name`. For % terraform import aws_sagemaker_image.test_image my-code-repo ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/sagemaker_image_version.html.markdown b/website/docs/cdktf/python/r/sagemaker_image_version.html.markdown index de3ba91f55d1..3251aadee3ff 100644 --- a/website/docs/cdktf/python/r/sagemaker_image_version.html.markdown +++ b/website/docs/cdktf/python/r/sagemaker_image_version.html.markdown @@ -16,6 +16,26 @@ Provides a SageMaker AI Image Version resource. ### 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.sagemaker_image_version import SagemakerImageVersion +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + SagemakerImageVersion(self, "example", + base_image="012345678912.dkr.ecr.us-west-2.amazonaws.com/image:latest", + image_name=test.id + ) +``` + +### With Aliases + ```python # DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug from constructs import Construct @@ -29,6 +49,7 @@ class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) SagemakerImageVersion(self, "test", + aliases=["latest", "stable"], base_image="012345678912.dkr.ecr.us-west-2.amazonaws.com/image:latest", image_name=Token.as_string(aws_sagemaker_image_test.id) ) @@ -38,8 +59,10 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `image_name` - (Required) The name of the image. Must be unique to your account. * `base_image` - (Required) The registry path of the container image on which this image version is based. +* `aliases` - (Optional) A list of aliases for the image version. * `horovod` - (Optional) Indicates Horovod compatibility. * `job_type` - (Optional) Indicates SageMaker AI job type compatibility. Valid values are: `TRAINING`, `INFERENCE`, and `NOTEBOOK_KERNEL`. * `ml_framework` - (Optional) The machine learning framework vended in the image version. @@ -52,14 +75,13 @@ This resource supports the following arguments: This resource exports the following attributes in addition to the arguments above: -* `id` - The name of the Image. * `arn` - The Amazon Resource Name (ARN) assigned by AWS to this Image Version. * `version`- The version of the image. If not specified, the latest version is described. * `container_image` - The registry path of the container image that contains this image version. ## Import -In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import SageMaker AI Image Versions using the `name`. For example: +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import SageMaker AI Image Versions using a comma-delimited string concatenating `image_name` and `version`. For example: ```python # DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -73,13 +95,13 @@ from imports.aws.sagemaker_image_version import SagemakerImageVersion class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) - SagemakerImageVersion.generate_config_for_import(self, "testImage", "my-code-repo") + SagemakerImageVersion.generate_config_for_import(self, "example", "example-name,1") ``` -Using `terraform import`, import SageMaker AI Image Versions using the `name`. For example: +Using `terraform import`, import SageMaker AI Image Versions using a comma-delimited string concatenating `image_name` and `version`. For example: ```console -% terraform import aws_sagemaker_image_version.test_image my-code-repo +% terraform import aws_sagemaker_image_version.example example-name,1 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/sagemaker_mlflow_tracking_server.html.markdown b/website/docs/cdktf/python/r/sagemaker_mlflow_tracking_server.html.markdown index e34b44884daa..b970e5ba73f3 100644 --- a/website/docs/cdktf/python/r/sagemaker_mlflow_tracking_server.html.markdown +++ b/website/docs/cdktf/python/r/sagemaker_mlflow_tracking_server.html.markdown @@ -39,6 +39,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `artifact_store_uri` - (Required) The S3 URI for a general purpose bucket to use as the MLflow Tracking Server artifact store. * `role_arn` - (Required) The Amazon Resource Name (ARN) for an IAM role in your account that the MLflow Tracking Server uses to access the artifact store in Amazon S3. The role should have AmazonS3FullAccess permissions. For more information on IAM permissions for tracking server creation, see [Set up IAM permissions for MLflow](https://docs.aws.amazon.com/sagemaker/latest/dg/mlflow-create-tracking-server-iam.html). * `tracking_server_name` - (Required) A unique string identifying the tracking server name. This string is part of the tracking server ARN. @@ -82,4 +83,4 @@ Using `terraform import`, import SageMaker AI MLFlow Tracking Servers using the % terraform import aws_sagemaker_mlflow_tracking_server.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/sagemaker_model.html.markdown b/website/docs/cdktf/python/r/sagemaker_model.html.markdown index c8b9ec17068f..3c48ae9a8e1c 100644 --- a/website/docs/cdktf/python/r/sagemaker_model.html.markdown +++ b/website/docs/cdktf/python/r/sagemaker_model.html.markdown @@ -63,6 +63,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Optional) The name of the model (must be unique). If omitted, Terraform will assign a random, unique name. * `primary_container` - (Optional) The primary docker image containing inference code that is used when the model is deployed for predictions. If not specified, the `container` argument is required. Fields are documented below. * `execution_role_arn` - (Required) A role that SageMaker AI can assume to access model artifacts and docker images for deployment. @@ -151,4 +152,4 @@ Using `terraform import`, import models using the `name`. For example: % terraform import aws_sagemaker_model.test_model model-foo ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/sagemaker_model_package_group.html.markdown b/website/docs/cdktf/python/r/sagemaker_model_package_group.html.markdown index 84bfd746d567..f97d20e88fb4 100644 --- a/website/docs/cdktf/python/r/sagemaker_model_package_group.html.markdown +++ b/website/docs/cdktf/python/r/sagemaker_model_package_group.html.markdown @@ -37,6 +37,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `model_package_group_name` - (Required) The name of the model group. * `model_package_group_description` - (Optional) A description for the model group. * `tags` - (Optional) A 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. @@ -74,4 +75,4 @@ Using `terraform import`, import SageMaker AI Model Package Groups using the `na % terraform import aws_sagemaker_model_package_group.test_model_package_group my-code-repo ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/sagemaker_model_package_group_policy.html.markdown b/website/docs/cdktf/python/r/sagemaker_model_package_group_policy.html.markdown index 5c84b94437c2..8619d8da0424 100644 --- a/website/docs/cdktf/python/r/sagemaker_model_package_group_policy.html.markdown +++ b/website/docs/cdktf/python/r/sagemaker_model_package_group_policy.html.markdown @@ -66,6 +66,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `model_package_group_name` - (Required) The name of the model package group. ## Attribute Reference @@ -99,4 +100,4 @@ Using `terraform import`, import SageMaker AI Model Package Groups using the `na % terraform import aws_sagemaker_model_package_group_policy.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/sagemaker_monitoring_schedule.html.markdown b/website/docs/cdktf/python/r/sagemaker_monitoring_schedule.html.markdown index a484274bfe75..3b57cd70258a 100644 --- a/website/docs/cdktf/python/r/sagemaker_monitoring_schedule.html.markdown +++ b/website/docs/cdktf/python/r/sagemaker_monitoring_schedule.html.markdown @@ -41,6 +41,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `monitoring_schedule_config` - (Required) The configuration object that specifies the monitoring schedule and defines the monitoring job. Fields are documented below. * `name` - (Optional) The name of the monitoring schedule. The name must be unique within an AWS Region within an AWS account. If omitted, Terraform will assign a random, unique name. * `tags` - (Optional) A mapping 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. @@ -88,4 +89,4 @@ Using `terraform import`, import monitoring schedules using the `name`. For exam % terraform import aws_sagemaker_monitoring_schedule.test_monitoring_schedule monitoring-schedule-foo ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/sagemaker_notebook_instance.html.markdown b/website/docs/cdktf/python/r/sagemaker_notebook_instance.html.markdown index 54dff2031a60..6f7fe35ddff1 100644 --- a/website/docs/cdktf/python/r/sagemaker_notebook_instance.html.markdown +++ b/website/docs/cdktf/python/r/sagemaker_notebook_instance.html.markdown @@ -74,6 +74,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) The name of the notebook instance (must be unique). * `role_arn` - (Required) The ARN of the IAM role to be used by the notebook instance which allows SageMaker AI to call other services on your behalf. * `instance_type` - (Required) The name of ML compute instance type. @@ -81,7 +82,6 @@ This resource supports the following arguments: * `volume_size` - (Optional) The size, in GB, of the ML storage volume to attach to the notebook instance. The default value is 5 GB. * `subnet_id` - (Optional) The VPC subnet ID. * `security_groups` - (Optional) The associated security groups. -* `accelerator_types` - (Optional, Deprecated) A list of Elastic Inference (EI) instance types to associate with this notebook instance. See [Elastic Inference Accelerator](https://docs.aws.amazon.com/sagemaker/latest/dg/ei.html) for more details. Valid values: `ml.eia1.medium`, `ml.eia1.large`, `ml.eia1.xlarge`, `ml.eia2.medium`, `ml.eia2.large`, `ml.eia2.xlarge`. * `additional_code_repositories` - (Optional) An array of up to three Git repositories to associate with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in [AWS CodeCommit](https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html) or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. * `default_code_repository` - (Optional) The Git repository associated with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in [AWS CodeCommit](https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html) or in any other Git repository. @@ -131,4 +131,4 @@ Using `terraform import`, import SageMaker AI Notebook Instances using the `name % terraform import aws_sagemaker_notebook_instance.test_notebook_instance my-notebook-instance ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/sagemaker_notebook_instance_lifecycle_configuration.html.markdown b/website/docs/cdktf/python/r/sagemaker_notebook_instance_lifecycle_configuration.html.markdown index 092f2c95f87b..4a44b67ba8fa 100644 --- a/website/docs/cdktf/python/r/sagemaker_notebook_instance_lifecycle_configuration.html.markdown +++ b/website/docs/cdktf/python/r/sagemaker_notebook_instance_lifecycle_configuration.html.markdown @@ -39,6 +39,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Optional) The name of the lifecycle configuration (must be unique). If omitted, Terraform will assign a random, unique name. * `on_create` - (Optional) A shell script (base64-encoded) that runs only once when the SageMaker AI Notebook Instance is created. * `on_start` - (Optional) A shell script (base64-encoded) that runs every time the SageMaker AI Notebook Instance is started including the time it's created. @@ -76,4 +77,4 @@ Using `terraform import`, import models using the `name`. For example: % terraform import aws_sagemaker_notebook_instance_lifecycle_configuration.lc foo ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/sagemaker_pipeline.html.markdown b/website/docs/cdktf/python/r/sagemaker_pipeline.html.markdown index f807b2fe2578..b816f4c47a9f 100644 --- a/website/docs/cdktf/python/r/sagemaker_pipeline.html.markdown +++ b/website/docs/cdktf/python/r/sagemaker_pipeline.html.markdown @@ -51,6 +51,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `pipeline_name` - (Required) The name of the pipeline. * `pipeline_description` - (Optional) A description of the pipeline. * `pipeline_display_name` - (Required) The display name of the pipeline. @@ -103,4 +104,4 @@ Using `terraform import`, import pipelines using the `pipeline_name`. For exampl % terraform import aws_sagemaker_pipeline.test_pipeline pipeline ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/sagemaker_project.html.markdown b/website/docs/cdktf/python/r/sagemaker_project.html.markdown index 040b93e94965..50e5ce604d00 100644 --- a/website/docs/cdktf/python/r/sagemaker_project.html.markdown +++ b/website/docs/cdktf/python/r/sagemaker_project.html.markdown @@ -40,6 +40,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `project_name` - (Required) The name of the Project. * `project_description` - (Optional) A description for the project. * `service_catalog_provisioning_details` - (Required) The product ID and provisioning artifact ID to provision a service catalog. See [Service Catalog Provisioning Details](#service-catalog-provisioning-details) below. @@ -91,4 +92,4 @@ Using `terraform import`, import SageMaker AI Projects using the `project_name`. % terraform import aws_sagemaker_project.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/sagemaker_servicecatalog_portfolio_status.html.markdown b/website/docs/cdktf/python/r/sagemaker_servicecatalog_portfolio_status.html.markdown index 75b373547dd0..0338f3d30b37 100644 --- a/website/docs/cdktf/python/r/sagemaker_servicecatalog_portfolio_status.html.markdown +++ b/website/docs/cdktf/python/r/sagemaker_servicecatalog_portfolio_status.html.markdown @@ -37,6 +37,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `status` - (Required) Whether Service Catalog is enabled or disabled in SageMaker. Valid values are `Enabled` and `Disabled`. ## Attribute Reference @@ -70,4 +71,4 @@ Using `terraform import`, import models using the `id`. For example: % terraform import aws_sagemaker_servicecatalog_portfolio_status.example us-east-1 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/sagemaker_space.html.markdown b/website/docs/cdktf/python/r/sagemaker_space.html.markdown index c392c7a3c687..cf83546d5fa6 100644 --- a/website/docs/cdktf/python/r/sagemaker_space.html.markdown +++ b/website/docs/cdktf/python/r/sagemaker_space.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `domain_id` - (Required) The ID of the associated Domain. * `ownership_settings` - (Optional) A collection of ownership settings. Required if `space_sharing_settings` is set. See [`ownership_settings` Block](#ownership_settings-block) below. * `space_display_name` - (Optional) The name of the space that appears in the SageMaker AI Studio UI. @@ -196,4 +197,4 @@ Using `terraform import`, import SageMaker AI Spaces using the `id`. For example % terraform import aws_sagemaker_space.test_space arn:aws:sagemaker:us-west-2:123456789012:space/domain-id/space-name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/sagemaker_studio_lifecycle_config.html.markdown b/website/docs/cdktf/python/r/sagemaker_studio_lifecycle_config.html.markdown index c9f45a8f84f2..d146ecb14550 100644 --- a/website/docs/cdktf/python/r/sagemaker_studio_lifecycle_config.html.markdown +++ b/website/docs/cdktf/python/r/sagemaker_studio_lifecycle_config.html.markdown @@ -40,6 +40,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +- `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). - `studio_lifecycle_config_name` - (Required) The name of the Studio Lifecycle Configuration to create. - `studio_lifecycle_config_app_type` - (Required) The App type that the Lifecycle Configuration is attached to. Valid values are `JupyterServer`, `JupyterLab`, `CodeEditor` and `KernelGateway`. - `studio_lifecycle_config_content` - (Required) The content of your Studio Lifecycle Configuration script. This content must be base64 encoded. @@ -78,4 +79,4 @@ Using `terraform import`, import SageMaker AI Studio Lifecycle Configs using the % terraform import aws_sagemaker_studio_lifecycle_config.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/sagemaker_user_profile.html.markdown b/website/docs/cdktf/python/r/sagemaker_user_profile.html.markdown index d689fd1d95d1..1626a33a7543 100644 --- a/website/docs/cdktf/python/r/sagemaker_user_profile.html.markdown +++ b/website/docs/cdktf/python/r/sagemaker_user_profile.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `domain_id` - (Required) The ID of the associated Domain. * `single_sign_on_user_identifier` - (Optional) A specifier for the type of value specified in `single_sign_on_user_value`. Currently, the only supported value is `UserName`. If the Domain's AuthMode is SSO, this field is required. If the Domain's AuthMode is not SSO, this field cannot be specified. * `single_sign_on_user_value` - (Required) The username of the associated AWS Single Sign-On User for this User Profile. If the Domain's AuthMode is SSO, this field is required, and must match a valid username of a user in your directory. If the Domain's AuthMode is not SSO, this field cannot be specified. @@ -236,7 +237,6 @@ This resource supports the following arguments: This resource exports the following attributes in addition to the arguments above: -* `id` - The user profile Amazon Resource Name (ARN). * `arn` - The user profile Amazon Resource Name (ARN). * `home_efs_file_system_uid` - The ID of the user's profile in the Amazon Elastic File System (EFS) volume. * `tags_all` - A map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). @@ -266,4 +266,4 @@ Using `terraform import`, import SageMaker AI User Profiles using the `arn`. For % terraform import aws_sagemaker_user_profile.test_user_profile arn:aws:sagemaker:us-west-2:123456789012:user-profile/domain-id/profile-name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/sagemaker_workforce.html.markdown b/website/docs/cdktf/python/r/sagemaker_workforce.html.markdown index 7eb8ac6c3ae5..bfeb6a8228c5 100644 --- a/website/docs/cdktf/python/r/sagemaker_workforce.html.markdown +++ b/website/docs/cdktf/python/r/sagemaker_workforce.html.markdown @@ -91,6 +91,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `workforce_name` - (Required) The name of the Workforce (must be unique). * `cognito_config` - (Optional) Use this parameter to configure an Amazon Cognito private workforce. A single Cognito workforce is created using and corresponds to a single Amazon Cognito user pool. Conflicts with `oidc_config`. see [Cognito Config](#cognito-config) details below. * `oidc_config` - (Optional) Use this parameter to configure a private workforce using your own OIDC Identity Provider. Conflicts with `cognito_config`. see [OIDC Config](#oidc-config) details below. @@ -159,4 +160,4 @@ Using `terraform import`, import SageMaker AI Workforces using the `workforce_na % terraform import aws_sagemaker_workforce.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/sagemaker_workteam.html.markdown b/website/docs/cdktf/python/r/sagemaker_workteam.html.markdown index 9491c5b6748b..0b4a1f53f810 100644 --- a/website/docs/cdktf/python/r/sagemaker_workteam.html.markdown +++ b/website/docs/cdktf/python/r/sagemaker_workteam.html.markdown @@ -74,6 +74,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `description` - (Required) A description of the work team. * `workforce_name` - (Optional) The name of the workforce. * `workteam_name` - (Required) The name of the Workteam (must be unique). @@ -148,4 +149,4 @@ Using `terraform import`, import SageMaker AI Workteams using the `workteam_name % terraform import aws_sagemaker_workteam.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/scheduler_schedule.html.markdown b/website/docs/cdktf/python/r/scheduler_schedule.html.markdown index c392683f79ca..686f98af1556 100644 --- a/website/docs/cdktf/python/r/scheduler_schedule.html.markdown +++ b/website/docs/cdktf/python/r/scheduler_schedule.html.markdown @@ -92,6 +92,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `description` - (Optional) Brief description of the schedule. * `end_date` - (Optional) The date, in UTC, before which the schedule can invoke its target. Depending on the schedule's recurrence expression, invocations might stop on, or before, the end date you specify. EventBridge Scheduler ignores the end date for one-time schedules. Example: `2030-01-01T01:00:00Z`. * `group_name` - (Optional, Forces new resource) Name of the schedule group to associate with this schedule. When omitted, the `default` schedule group is used. @@ -116,6 +117,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `dead_letter_config` - (Optional) Information about an Amazon SQS queue that EventBridge Scheduler uses as a dead-letter queue for your schedule. If specified, EventBridge Scheduler delivers failed events that could not be successfully delivered to a target to the queue. Detailed below. * `ecs_parameters` - (Optional) Templated target type for the Amazon ECS [`RunTask`](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html) API operation. Detailed below. * `eventbridge_parameters` - (Optional) Templated target type for the EventBridge [`PutEvents`](https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutEvents.html) API operation. Detailed below. @@ -137,6 +139,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `capacity_provider_strategy` - (Optional) Up to `6` capacity provider strategies to use for the task. Detailed below. * `enable_ecs_managed_tags` - (Optional) Specifies whether to enable Amazon ECS managed tags for the task. For more information, see [Tagging Your Amazon ECS Resources](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html) in the Amazon ECS Developer Guide. * `enable_execute_command` - (Optional) Specifies whether to enable the execute command functionality for the containers in this task. @@ -232,4 +235,4 @@ Using `terraform import`, import schedules using the combination `group_name/nam % terraform import aws_scheduler_schedule.example my-schedule-group/my-schedule ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/scheduler_schedule_group.html.markdown b/website/docs/cdktf/python/r/scheduler_schedule_group.html.markdown index 8f410eae1c02..bce49b81e6b7 100644 --- a/website/docs/cdktf/python/r/scheduler_schedule_group.html.markdown +++ b/website/docs/cdktf/python/r/scheduler_schedule_group.html.markdown @@ -39,6 +39,7 @@ class MyConvertedCode(TerraformStack): The following arguments are optional: +* `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). * `name` - (Optional, Forces new resource) Name of the schedule group. If omitted, Terraform will assign a random, unique name. Conflicts with `name_prefix`. * `name_prefix` - (Optional, Forces new resource) Creates a unique name beginning with the specified prefix. Conflicts with `name`. * `tags` - (Optional) Key-value mapping of resource tags. If configured with a provider [`default_tags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. @@ -86,4 +87,4 @@ Using `terraform import`, import schedule groups using the `name`. For example: % terraform import aws_scheduler_schedule_group.example my-schedule-group ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/schemas_discoverer.html.markdown b/website/docs/cdktf/python/r/schemas_discoverer.html.markdown index f14fc070caac..4126161f27c6 100644 --- a/website/docs/cdktf/python/r/schemas_discoverer.html.markdown +++ b/website/docs/cdktf/python/r/schemas_discoverer.html.markdown @@ -42,6 +42,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `source_arn` - (Required) The ARN of the event bus to discover event schemas on. * `description` - (Optional) The description of the discoverer. Maximum of 256 characters. * `tags` - (Optional) A 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. @@ -79,4 +80,4 @@ Using `terraform import`, import EventBridge discoverers using the `id`. For exa % terraform import aws_schemas_discoverer.test 123 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/schemas_registry.html.markdown b/website/docs/cdktf/python/r/schemas_registry.html.markdown index 85fa26279864..50d6f2706fe7 100644 --- a/website/docs/cdktf/python/r/schemas_registry.html.markdown +++ b/website/docs/cdktf/python/r/schemas_registry.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) The name of the custom event schema registry. Maximum of 64 characters consisting of lower case letters, upper case letters, 0-9, ., -, _. * `description` - (Optional) The description of the discoverer. Maximum of 256 characters. * `tags` - (Optional) A 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. @@ -74,4 +75,4 @@ Using `terraform import`, import EventBridge schema registries using the `name`. % terraform import aws_schemas_registry.test my_own_registry ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/schemas_registry_policy.html.markdown b/website/docs/cdktf/python/r/schemas_registry_policy.html.markdown index 5c454aac87f3..81fd11ddcfbe 100644 --- a/website/docs/cdktf/python/r/schemas_registry_policy.html.markdown +++ b/website/docs/cdktf/python/r/schemas_registry_policy.html.markdown @@ -54,8 +54,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `registry_name` - (Required) Name of EventBridge Schema Registry * `policy` - (Required) Resource Policy for EventBridge Schema Registry @@ -96,4 +97,4 @@ Using `terraform import`, import EventBridge Schema Registry Policy using the `r % terraform import aws_schemas_registry_policy.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/schemas_schema.html.markdown b/website/docs/cdktf/python/r/schemas_schema.html.markdown index c3e7f98359ae..41fb64832834 100644 --- a/website/docs/cdktf/python/r/schemas_schema.html.markdown +++ b/website/docs/cdktf/python/r/schemas_schema.html.markdown @@ -67,6 +67,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) The name of the schema. Maximum of 385 characters consisting of lower case letters, upper case letters, ., -, _, @. * `content` - (Required) The schema specification. Must be a valid Open API 3.0 spec. * `registry_name` - (Required) The name of the registry in which this schema belongs. @@ -109,4 +110,4 @@ Using `terraform import`, import EventBridge schema using the `name` and `regist % terraform import aws_schemas_schema.test name/registry ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/secretsmanager_secret.html.markdown b/website/docs/cdktf/python/r/secretsmanager_secret.html.markdown index 008ed004bc7b..1c8a37cfd694 100644 --- a/website/docs/cdktf/python/r/secretsmanager_secret.html.markdown +++ b/website/docs/cdktf/python/r/secretsmanager_secret.html.markdown @@ -37,6 +37,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `description` - (Optional) Description of the secret. * `kms_key_id` - (Optional) ARN or Id of the AWS KMS key to be used to encrypt the secret values in the versions stored in this secret. If you need to reference a CMK in a different account, you can use only the key ARN. If you don't specify this value, then Secrets Manager defaults to using the AWS account's default KMS key (the one named `aws/secretsmanager`). If the default KMS key with that name doesn't yet exist, then AWS Secrets Manager creates it for you automatically the first time. * `name_prefix` - (Optional) Creates a unique name beginning with the specified prefix. Conflicts with `name`. @@ -92,4 +93,4 @@ Using `terraform import`, import `aws_secretsmanager_secret` using the secret Am % terraform import aws_secretsmanager_secret.example arn:aws:secretsmanager:us-east-1:123456789012:secret:example-123456 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/secretsmanager_secret_policy.html.markdown b/website/docs/cdktf/python/r/secretsmanager_secret_policy.html.markdown index 6853d8bb82a9..835b76cddf27 100644 --- a/website/docs/cdktf/python/r/secretsmanager_secret_policy.html.markdown +++ b/website/docs/cdktf/python/r/secretsmanager_secret_policy.html.markdown @@ -66,6 +66,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `block_public_policy` - (Optional) Makes an optional API call to Zelkova to validate the Resource Policy to prevent broad access to your secret. ## Attribute Reference @@ -99,4 +100,4 @@ Using `terraform import`, import `aws_secretsmanager_secret_policy` using the se % terraform import aws_secretsmanager_secret_policy.example arn:aws:secretsmanager:us-east-1:123456789012:secret:example-123456 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/secretsmanager_secret_rotation.html.markdown b/website/docs/cdktf/python/r/secretsmanager_secret_rotation.html.markdown index 8b8d36751454..1311c34b9577 100644 --- a/website/docs/cdktf/python/r/secretsmanager_secret_rotation.html.markdown +++ b/website/docs/cdktf/python/r/secretsmanager_secret_rotation.html.markdown @@ -49,6 +49,7 @@ To enable automatic secret rotation, the Secrets Manager service requires usage This resource supports the following arguments: +* `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). * `secret_id` - (Required) Specifies the secret to which you want to add a new version. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret. The secret must already exist. * `rotate_immediately` - (Optional) Specifies whether to rotate the secret immediately or wait until the next scheduled rotation window. The rotation schedule is defined in `rotation_rules`. For secrets that use a Lambda rotation function to rotate, if you don't immediately rotate the secret, Secrets Manager tests the rotation configuration by running the testSecret step (https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotate-secrets_how.html) of the Lambda rotation function. The test creates an AWSPENDING version of the secret and then removes it. Defaults to `true`. * `rotation_lambda_arn` - (Optional) Specifies the ARN of the Lambda function that can rotate the secret. Must be supplied if the secret is not managed by AWS. @@ -93,4 +94,4 @@ Using `terraform import`, import `aws_secretsmanager_secret_rotation` using the % terraform import aws_secretsmanager_secret_rotation.example arn:aws:secretsmanager:us-east-1:123456789012:secret:example-123456 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/secretsmanager_secret_version.html.markdown b/website/docs/cdktf/python/r/secretsmanager_secret_version.html.markdown index 29e826076303..b8a7830ee648 100644 --- a/website/docs/cdktf/python/r/secretsmanager_secret_version.html.markdown +++ b/website/docs/cdktf/python/r/secretsmanager_secret_version.html.markdown @@ -14,7 +14,7 @@ Provides a resource to manage AWS Secrets Manager secret version including its s ~> **NOTE:** If the `AWSCURRENT` staging label is present on this version during resource deletion, that label cannot be removed and will be skipped to prevent errors when fully deleting the secret. That label will leave this secret version active even after the resource is deleted from Terraform unless the secret itself is deleted. Move the `AWSCURRENT` staging label before or after deleting this resource from Terraform to fully trigger version deprecation if necessary. --> **Note:** Write-Only argument `secret_string_wo` is available to use in place of `secret_string`. Write-Only argumentss are supported in HashiCorp Terraform 1.11.0 and later. [Learn more](https://developer.hashicorp.com/terraform/language/v1.11.x/resources/ephemeral#write-only-arguments). +-> **Note:** Write-Only argument `secret_string_wo` is available to use in place of `secret_string`. Write-Only argumentss are supported in HashiCorp Terraform 1.11.0 and later. [Learn more](https://developer.hashicorp.com/terraform/language/resources/ephemeral#write-only-arguments). ## Example Usage @@ -93,6 +93,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `secret_id` - (Required) Specifies the secret to which you want to add a new version. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret. The secret must already exist. * `secret_string` - (Optional) Specifies text data that you want to encrypt and store in this version of the secret. This is required if `secret_binary` or `secret_string_wo` is not set. * `secret_string_wo` - (Optional) Specifies text data that you want to encrypt and store in this version of the secret. This is required if `secret_binary` or `secret_string` is not set. @@ -112,6 +113,34 @@ This resource exports the following attributes in addition to the arguments abov ## Import +In Terraform v1.12.0 and later, the [`import` block](https://developer.hashicorp.com/terraform/language/import) can be used with the `identity` attribute. For example: + +```terraform +import { + to = aws_secretsmanager_secret_version.example + identity = { + secret_id = "arn:aws:secretsmanager:us-east-1:123456789012:secret:example-123456" + version_id = "xxxxx-xxxxxxx-xxxxxxx-xxxxx" + } +} + +resource "aws_secretsmanager_secret_version" "example" { + ### Configuration omitted for brevity ### +} +``` + +### Identity Schema + +#### Required + +* `secret_id` - (String) ID of the secret. +* `version_id` - (String) ID of the secret version. + +#### Optional + +- `account_id` (String) AWS Account where this resource is managed. +- `region` (String) Region where this resource is managed. + In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import `aws_secretsmanager_secret_version` using the secret ID and version ID. For example: ```python @@ -135,4 +164,4 @@ Using `terraform import`, import `aws_secretsmanager_secret_version` using the s % terraform import aws_secretsmanager_secret_version.example 'arn:aws:secretsmanager:us-east-1:123456789012:secret:example-123456|xxxxx-xxxxxxx-xxxxxxx-xxxxx' ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/security_group.html.markdown b/website/docs/cdktf/python/r/security_group.html.markdown index 1b7e21a58359..3185ca257f8c 100644 --- a/website/docs/cdktf/python/r/security_group.html.markdown +++ b/website/docs/cdktf/python/r/security_group.html.markdown @@ -118,10 +118,9 @@ from cdktf import TerraformStack from imports.aws.security_group import SecurityGroup from imports.aws.vpc_endpoint import VpcEndpoint class MyConvertedCode(TerraformStack): - def __init__(self, scope, name, *, serviceName, vpcId): + def __init__(self, scope, name, *, vpcId): super().__init__(scope, name) my_endpoint = VpcEndpoint(self, "my_endpoint", - service_name=service_name, vpc_id=vpc_id ) SecurityGroup(self, "example", @@ -312,6 +311,7 @@ resource "null_resource" "example" { This resource supports the following arguments: +* `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). * `description` - (Optional, Forces new resource) Security group description. Defaults to `Managed by Terraform`. Cannot be `""`. **NOTE**: This field maps to the AWS `GroupDescription` attribute, for which there is no Update API. If you'd like to classify your security groups in a way that can be updated, use `tags`. * `egress` - (Optional, VPC only) Configuration block for egress rules. Can be specified multiple times for each egress rule. Each egress block supports fields documented below. This argument is processed in [attribute-as-blocks mode](https://www.terraform.io/docs/configuration/attr-as-blocks.html). * `ingress` - (Optional) Configuration block for ingress rules. Can be specified multiple times for each ingress rule. Each ingress block supports fields documented below. This argument is processed in [attribute-as-blocks mode](https://www.terraform.io/docs/configuration/attr-as-blocks.html). @@ -404,4 +404,4 @@ Using `terraform import`, import Security Groups using the security group `id`. % terraform import aws_security_group.elb_sg sg-903004f8 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/security_group_rule.html.markdown b/website/docs/cdktf/python/r/security_group_rule.html.markdown index 87b1070979e0..20a22bbb20e9 100644 --- a/website/docs/cdktf/python/r/security_group_rule.html.markdown +++ b/website/docs/cdktf/python/r/security_group_rule.html.markdown @@ -66,10 +66,9 @@ from cdktf import TerraformStack from imports.aws.security_group_rule import SecurityGroupRule from imports.aws.vpc_endpoint import VpcEndpoint class MyConvertedCode(TerraformStack): - def __init__(self, scope, name, *, serviceName, vpcId): + def __init__(self, scope, name, *, vpcId): super().__init__(scope, name) my_endpoint = VpcEndpoint(self, "my_endpoint", - service_name=service_name, vpc_id=vpc_id ) SecurityGroupRule(self, "allow_all", @@ -101,7 +100,7 @@ class MyConvertedCode(TerraformStack): super().__init__(scope, name) current = DataAwsRegion(self, "current") s3 = DataAwsPrefixList(self, "s3", - name="com.amazonaws.${" + current.name + "}.s3" + name="com.amazonaws.${" + current.region + "}.s3" ) SecurityGroupRule(self, "s3_gateway_egress", description="S3 Gateway Egress", @@ -116,8 +115,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `from_port` - (Required) Start port (or ICMP type number if protocol is "icmp" or "icmpv6"). * `protocol` - (Required) Protocol. If not icmp, icmpv6, tcp, udp, or all use the [protocol number](https://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml) * `security_group_id` - (Required) Security group to apply this rule to. @@ -127,6 +127,7 @@ or `egress` (outbound). The following arguments are optional: +* `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). ~> **Note** Although `cidr_blocks`, `ipv6_cidr_blocks`, `prefix_list_ids`, and `source_security_group_id` are all marked as optional, you _must_ provide one of them in order to configure the source of the traffic. * `cidr_blocks` - (Optional) List of CIDR blocks. Cannot be specified with `source_security_group_id` or `self`. @@ -320,4 +321,4 @@ Import a rule that has itself and an IPv6 CIDR block as sources: % terraform import aws_security_group_rule.rule_name sg-656c65616e6f72_ingress_tcp_80_80_self_2001:db8::/48 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/securityhub_account.html.markdown b/website/docs/cdktf/python/r/securityhub_account.html.markdown index 3b04d2b5dd51..976ed1006a11 100644 --- a/website/docs/cdktf/python/r/securityhub_account.html.markdown +++ b/website/docs/cdktf/python/r/securityhub_account.html.markdown @@ -35,6 +35,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `enable_default_standards` - (Optional) Whether to enable the security standards that Security Hub has designated as automatically enabled including: ` AWS Foundational Security Best Practices v1.0.0` and `CIS AWS Foundations Benchmark v1.2.0`. Defaults to `true`. * `control_finding_generator` - (Optional) Updates whether the calling account has consolidated control findings turned on. If the value for this field is set to `SECURITY_CONTROL`, Security Hub generates a single finding for a control check even when the check applies to multiple enabled standards. If the value for this field is set to `STANDARD_CONTROL`, Security Hub generates separate findings for a control check when the check applies to multiple enabled standards. For accounts that are part of an organization, this value can only be updated in the administrator account. * `auto_enable_controls` - (Optional) Whether to automatically enable new controls when they are added to standards that are enabled. By default, this is set to true, and new controls are enabled automatically. To not automatically enable new controls, set this to false. @@ -71,4 +72,4 @@ Using `terraform import`, import an existing Security Hub enabled account using % terraform import aws_securityhub_account.example 123456789012 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/securityhub_action_target.html.markdown b/website/docs/cdktf/python/r/securityhub_action_target.html.markdown index a40353f78bf9..b62b2d408bed 100644 --- a/website/docs/cdktf/python/r/securityhub_action_target.html.markdown +++ b/website/docs/cdktf/python/r/securityhub_action_target.html.markdown @@ -42,6 +42,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) The description for the custom action target. * `identifier` - (Required) The ID for the custom action target. * `description` - (Required) The name of the custom action target. @@ -77,4 +78,4 @@ Using `terraform import`, import Security Hub custom action using the action tar % terraform import aws_securityhub_action_target.example arn:aws:securityhub:eu-west-1:312940875350:action/custom/a ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/securityhub_automation_rule.html.markdown b/website/docs/cdktf/python/r/securityhub_automation_rule.html.markdown index 57481b553f4c..401bb04a92e9 100644 --- a/website/docs/cdktf/python/r/securityhub_automation_rule.html.markdown +++ b/website/docs/cdktf/python/r/securityhub_automation_rule.html.markdown @@ -69,6 +69,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `actions` - (Required) A block that specifies one or more actions to update finding fields if a finding matches the conditions specified in `Criteria`. [Documented below](#actions). * `criteria` - (Required) A block that specifies a set of ASFF finding field attributes and corresponding expected values that Security Hub uses to filter findings. [Documented below](#criteria). * `description` - (Required) The description of the rule. @@ -240,4 +241,4 @@ Using `terraform import`, import Security Hub automation rule using their ARN. F % terraform import aws_securityhub_automation_rule.example arn:aws:securityhub:us-west-2:123456789012:automation-rule/473eddde-f5c4-4ae5-85c7-e922f271fffc ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/securityhub_configuration_policy.html.markdown b/website/docs/cdktf/python/r/securityhub_configuration_policy.html.markdown index 8969afa26673..3910ca9e9791 100644 --- a/website/docs/cdktf/python/r/securityhub_configuration_policy.html.markdown +++ b/website/docs/cdktf/python/r/securityhub_configuration_policy.html.markdown @@ -149,6 +149,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `configuration_policy` - (Required) Defines how Security Hub is configured. See [below](#configuration_policy). * `description` - (Optional) The description of the configuration policy. * `name` - (Required) The name of the configuration policy. @@ -224,4 +225,4 @@ Using `terraform import`, import an existing Security Hub enabled account using % terraform import aws_securityhub_configuration_policy.example "00000000-1111-2222-3333-444444444444" ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/securityhub_configuration_policy_association.markdown b/website/docs/cdktf/python/r/securityhub_configuration_policy_association.markdown index 938cd37bc3a1..bfe650b84dc1 100644 --- a/website/docs/cdktf/python/r/securityhub_configuration_policy_association.markdown +++ b/website/docs/cdktf/python/r/securityhub_configuration_policy_association.markdown @@ -79,6 +79,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `policy_id` - (Required) The universally unique identifier (UUID) of the configuration policy. * `target_id` - (Required, Forces new resource) The identifier of the target account, organizational unit, or the root to associate with the specified configuration. @@ -120,4 +121,4 @@ Using `terraform import`, import an existing Security Hub enabled account using % terraform import aws_securityhub_configuration_policy_association.example_account_association 123456789012 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/securityhub_finding_aggregator.html.markdown b/website/docs/cdktf/python/r/securityhub_finding_aggregator.html.markdown index 5bb2c7defb57..d29ae9bb0738 100644 --- a/website/docs/cdktf/python/r/securityhub_finding_aggregator.html.markdown +++ b/website/docs/cdktf/python/r/securityhub_finding_aggregator.html.markdown @@ -128,6 +128,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +- `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). - `linking_mode` - (Required) Indicates whether to aggregate findings from all of the available Regions or from a specified list. The options are `ALL_REGIONS`, `ALL_REGIONS_EXCEPT_SPECIFIED`, `SPECIFIED_REGIONS` or `NO_REGIONS`. When `ALL_REGIONS` or `ALL_REGIONS_EXCEPT_SPECIFIED` are used, Security Hub will automatically aggregate findings from new Regions as Security Hub supports them and you opt into them. - `specified_regions` - (Optional) List of regions to include or exclude (required if `linking_mode` is set to `ALL_REGIONS_EXCEPT_SPECIFIED` or `SPECIFIED_REGIONS`) @@ -162,4 +163,4 @@ Using `terraform import`, import an existing Security Hub finding aggregator usi % terraform import aws_securityhub_finding_aggregator.example arn:aws:securityhub:eu-west-1:123456789098:finding-aggregator/abcd1234-abcd-1234-1234-abcdef123456 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/securityhub_insight.html.markdown b/website/docs/cdktf/python/r/securityhub_insight.html.markdown index f768ddba2005..7279d81db5a2 100644 --- a/website/docs/cdktf/python/r/securityhub_insight.html.markdown +++ b/website/docs/cdktf/python/r/securityhub_insight.html.markdown @@ -180,8 +180,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `filters` - (Required) A configuration block including one or more (up to 10 distinct) attributes used to filter the findings included in the insight. The insight only includes findings that match criteria defined in the filters. See [filters](#filters) below for more details. * `group_by_attribute` - (Required) The attribute used to group the findings for the insight e.g., if an insight is grouped by `ResourceId`, then the insight produces a list of resource identifiers. * `name` - (Required) The name of the custom insight. @@ -372,4 +373,4 @@ Using `terraform import`, import Security Hub insights using the ARN. For exampl % terraform import aws_securityhub_insight.example arn:aws:securityhub:us-west-2:1234567890:insight/1234567890/custom/91299ed7-abd0-4e44-a858-d0b15e37141a ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/securityhub_invite_accepter.html.markdown b/website/docs/cdktf/python/r/securityhub_invite_accepter.html.markdown index e829add482a7..9a9842e3672d 100644 --- a/website/docs/cdktf/python/r/securityhub_invite_accepter.html.markdown +++ b/website/docs/cdktf/python/r/securityhub_invite_accepter.html.markdown @@ -54,6 +54,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `master_id` - (Required) The account ID of the master Security Hub account whose invitation you're accepting. ## Attribute Reference @@ -87,4 +88,4 @@ Using `terraform import`, import Security Hub invite acceptance using the accoun % terraform import aws_securityhub_invite_accepter.example 123456789012 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/securityhub_member.html.markdown b/website/docs/cdktf/python/r/securityhub_member.html.markdown index ad430dc1ab2a..48a71ed8b391 100644 --- a/website/docs/cdktf/python/r/securityhub_member.html.markdown +++ b/website/docs/cdktf/python/r/securityhub_member.html.markdown @@ -42,6 +42,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `account_id` - (Required) The ID of the member AWS account. * `email` - (Optional) The email of the member AWS account. * `invite` - (Optional) Boolean whether to invite the account to Security Hub as a member. Defaults to `false`. @@ -79,4 +80,4 @@ Using `terraform import`, import Security Hub members using their account ID. Fo % terraform import aws_securityhub_member.example 123456789012 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/securityhub_organization_admin_account.html.markdown b/website/docs/cdktf/python/r/securityhub_organization_admin_account.html.markdown index 3a7645e500d9..adf97b7bf6ee 100644 --- a/website/docs/cdktf/python/r/securityhub_organization_admin_account.html.markdown +++ b/website/docs/cdktf/python/r/securityhub_organization_admin_account.html.markdown @@ -55,6 +55,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `admin_account_id` - (Required) The AWS account identifier of the account to designate as the Security Hub administrator account. ## Attribute Reference @@ -88,4 +89,4 @@ Using `terraform import`, import Security Hub Organization Admin Accounts using % terraform import aws_securityhub_organization_admin_account.example 123456789012 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/securityhub_organization_configuration.html.markdown b/website/docs/cdktf/python/r/securityhub_organization_configuration.html.markdown index 960bd2d39272..e629b2314654 100644 --- a/website/docs/cdktf/python/r/securityhub_organization_configuration.html.markdown +++ b/website/docs/cdktf/python/r/securityhub_organization_configuration.html.markdown @@ -101,6 +101,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `auto_enable` - (Required) Whether to automatically enable Security Hub for new accounts in the organization. * `auto_enable_standards` - (Optional) Whether to automatically enable Security Hub default standards for new member accounts in the organization. By default, this parameter is equal to `DEFAULT`, and new member accounts are automatically enabled with default Security Hub standards. To opt out of enabling default standards for new member accounts, set this parameter equal to `NONE`. * `organization_configuration` - (Optional) Provides information about the way an organization is configured in Security Hub. @@ -148,4 +149,4 @@ Using `terraform import`, import an existing Security Hub enabled account using % terraform import aws_securityhub_organization_configuration.example 123456789012 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/securityhub_product_subscription.html.markdown b/website/docs/cdktf/python/r/securityhub_product_subscription.html.markdown index 41a5aebc9b88..9064e155871e 100644 --- a/website/docs/cdktf/python/r/securityhub_product_subscription.html.markdown +++ b/website/docs/cdktf/python/r/securityhub_product_subscription.html.markdown @@ -33,7 +33,7 @@ class MyConvertedCode(TerraformStack): aws_securityhub_product_subscription_example = SecurityhubProductSubscription(self, "example_2", depends_on=[example], - product_arn="arn:aws:securityhub:${" + current.name + "}:733251395267:product/alertlogic/althreatmanagement" + product_arn="arn:aws:securityhub:${" + current.region + "}:733251395267:product/alertlogic/althreatmanagement" ) # 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_securityhub_product_subscription_example.override_logical_id("example") @@ -43,6 +43,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `product_arn` - (Required) The ARN of the product that generates findings that you want to import into Security Hub - see below. Amazon maintains a list of [Product integrations in AWS Security Hub](https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-findings-providers.html) that changes over time. Any of the products on the linked [Available AWS service integrations](https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-internal-providers.html) or [Available third-party partner product integrations](https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-partner-providers.html) can be configured using `aws_securityhub_product_subscription`. @@ -114,4 +115,4 @@ Using `terraform import`, import Security Hub product subscriptions using `produ % terraform import aws_securityhub_product_subscription.example arn:aws:securityhub:eu-west-1:733251395267:product/alertlogic/althreatmanagement,arn:aws:securityhub:eu-west-1:123456789012:product-subscription/alertlogic/althreatmanagement ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/securityhub_standards_control.html.markdown b/website/docs/cdktf/python/r/securityhub_standards_control.html.markdown index 1bef812fefdb..e859988b0f23 100644 --- a/website/docs/cdktf/python/r/securityhub_standards_control.html.markdown +++ b/website/docs/cdktf/python/r/securityhub_standards_control.html.markdown @@ -49,21 +49,22 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `standards_control_arn` - (Required) The standards control ARN. See the AWS documentation for how to list existing controls using [`get-enabled-standards`](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/securityhub/get-enabled-standards.html) and [`describe-standards-controls`](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/securityhub/describe-standards-controls.html). -* `control_status` – (Required) The control status could be `ENABLED` or `DISABLED`. You have to specify `disabled_reason` argument for `DISABLED` control status. -* `disabled_reason` – (Optional) A description of the reason why you are disabling a security standard control. If you specify this attribute, `control_status` will be set to `DISABLED` automatically. +* `control_status` - (Required) The control status could be `ENABLED` or `DISABLED`. You have to specify `disabled_reason` argument for `DISABLED` control status. +* `disabled_reason` - (Optional) A description of the reason why you are disabling a security standard control. If you specify this attribute, `control_status` will be set to `DISABLED` automatically. ## Attribute Reference This resource exports the following attributes in addition to the arguments above: * `id` - The standard control ARN. -* `control_id` – The identifier of the security standard control. -* `control_status_updated_at` – The date and time that the status of the security standard control was most recently updated. -* `description` – The standard control longer description. Provides information about what the control is checking for. -* `related_requirements` – The list of requirements that are related to this control. -* `remediation_url` – A link to remediation information for the control in the Security Hub user documentation. -* `severity_rating` – The severity of findings generated from this security standard control. -* `title` – The standard control title. +* `control_id` - The identifier of the security standard control. +* `control_status_updated_at` - The date and time that the status of the security standard control was most recently updated. +* `description` - The standard control longer description. Provides information about what the control is checking for. +* `related_requirements` - The list of requirements that are related to this control. +* `remediation_url` - A link to remediation information for the control in the Security Hub user documentation. +* `severity_rating` - The severity of findings generated from this security standard control. +* `title` - The standard control title. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/securityhub_standards_control_association.html.markdown b/website/docs/cdktf/python/r/securityhub_standards_control_association.html.markdown index e19e84f7c16c..0bc47490b7f0 100644 --- a/website/docs/cdktf/python/r/securityhub_standards_control_association.html.markdown +++ b/website/docs/cdktf/python/r/securityhub_standards_control_association.html.markdown @@ -101,10 +101,11 @@ The following arguments are required: The following arguments are optional: +* `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). * `updated_reason` - (Optional) The reason for updating the control's enablement status in the standard. Required when `association_status` is `DISABLED`. ## Attribute Reference This resource exports no additional attributes. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/securityhub_standards_subscription.html.markdown b/website/docs/cdktf/python/r/securityhub_standards_subscription.html.markdown index 2bc0ba7121f7..0ed47a76ee2b 100644 --- a/website/docs/cdktf/python/r/securityhub_standards_subscription.html.markdown +++ b/website/docs/cdktf/python/r/securityhub_standards_subscription.html.markdown @@ -36,7 +36,7 @@ class MyConvertedCode(TerraformStack): current = DataAwsRegion(self, "current") SecurityhubStandardsSubscription(self, "pci_321", depends_on=[example], - standards_arn="arn:aws:securityhub:${" + current.name + "}::standards/pci-dss/v/3.2.1" + standards_arn="arn:aws:securityhub:${" + current.region + "}::standards/pci-dss/v/3.2.1" ) ``` @@ -44,6 +44,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `standards_arn` - (Required) The ARN of a standard - see below. Currently available standards (remember to replace `${var.partition}` and `${var.region}` as appropriate): @@ -56,7 +57,9 @@ Currently available standards (remember to replace `${var.partition}` and `${var | CIS AWS Foundations Benchmark v1.4.0 | `arn:${var.partition}:securityhub:${var.region}::standards/cis-aws-foundations-benchmark/v/1.4.0` | | CIS AWS Foundations Benchmark v3.0.0 | `arn:${var.partition}:securityhub:${var.region}::standards/cis-aws-foundations-benchmark/v/3.0.0` | | NIST SP 800-53 Rev. 5 | `arn:${var.partition}:securityhub:${var.region}::standards/nist-800-53/v/5.0.0` | -| PCI DSS | `arn:${var.partition}:securityhub:${var.region}::standards/pci-dss/v/3.2.1` | +| NIST SP 800-171 Rev. 2 | `arn:${var.partition}:securityhub:${var.region}::standards/nist-800-171/v/2.0.0` | +| PCI DSS v3.2.1 | `arn:${var.partition}:securityhub:${var.region}::standards/pci-dss/v/3.2.1` | +| PCI DSS v4.0.1 | `arn:${var.partition}:securityhub:${var.region}::standards/pci-dss/v/4.0.1` | ## Attribute Reference @@ -134,4 +137,4 @@ Using `terraform import`, import Security Hub standards subscriptions using the % terraform import aws_securityhub_standards_subscription.nist_800_53_rev_5 arn:aws:securityhub:eu-west-1:123456789012:subscription/nist-800-53/v/5.0.0 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/securitylake_aws_log_source.html.markdown b/website/docs/cdktf/python/r/securitylake_aws_log_source.html.markdown index 2f8e6b03756b..a37559a65d23 100644 --- a/website/docs/cdktf/python/r/securitylake_aws_log_source.html.markdown +++ b/website/docs/cdktf/python/r/securitylake_aws_log_source.html.markdown @@ -47,6 +47,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `source` - (Required) Specify the natively-supported AWS service to add as a source in Security Lake. `source` supports the following: @@ -88,4 +89,4 @@ Using `terraform import`, import AWS log sources using the source name. For exam % terraform import aws_securitylake_aws_log_source.example ROUTE53 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/securitylake_custom_log_source.html.markdown b/website/docs/cdktf/python/r/securitylake_custom_log_source.html.markdown index d499260c9fb7..cf001115c1e5 100644 --- a/website/docs/cdktf/python/r/securitylake_custom_log_source.html.markdown +++ b/website/docs/cdktf/python/r/securitylake_custom_log_source.html.markdown @@ -54,6 +54,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `configuration` - (Required) The configuration for the third-party custom source. * `crawler_configuration` - (Required) The configuration for the Glue Crawler for the third-party custom source. * `role_arn` - (Required) The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role to be used by the AWS Glue crawler. @@ -103,4 +104,4 @@ Using `terraform import`, import Custom log sources using the source name. For e % terraform import aws_securitylake_custom_log_source.example example-name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/securitylake_data_lake.html.markdown b/website/docs/cdktf/python/r/securitylake_data_lake.html.markdown index da0d2881da43..1e9ac3d7808a 100644 --- a/website/docs/cdktf/python/r/securitylake_data_lake.html.markdown +++ b/website/docs/cdktf/python/r/securitylake_data_lake.html.markdown @@ -87,6 +87,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `meta_store_manager_role_arn` - (Required) The Amazon Resource Name (ARN) used to create and update the AWS Glue table. This table contains partitions generated by the ingestion and normalization of AWS log sources and custom sources. * `configuration` - (Required) Specify the Region or Regions that will contribute data to the rollup region. * `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. @@ -162,4 +163,4 @@ Using `terraform import`, import Security Hub standards subscriptions using the % terraform import aws_securitylake_data_lake.example arn:aws:securitylake:eu-west-1:123456789012:data-lake/default ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/securitylake_subscriber.html.markdown b/website/docs/cdktf/python/r/securitylake_subscriber.html.markdown index aad1e1180b23..b3296e13e50e 100644 --- a/website/docs/cdktf/python/r/securitylake_subscriber.html.markdown +++ b/website/docs/cdktf/python/r/securitylake_subscriber.html.markdown @@ -52,6 +52,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `access_type` - (Optional) The Amazon S3 or Lake Formation access type. * `source` - (Required) The supported AWS services from which logs and events are collected. Security Lake supports log and event collection for natively supported AWS services. See [`source` Blocks](#source-blocks) below. * `subscriber_identity` - (Required) The AWS identity used to access your data. See [`subscriber_identity` Block](#subscriber_identity-block) below. @@ -156,4 +157,4 @@ Using `terraform import`, import Security Lake subscriber using the subscriber I % terraform import aws_securitylake_subscriber.example 9f3bfe79-d543-474d-a93c-f3846805d208 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/securitylake_subscriber_notification.html.markdown b/website/docs/cdktf/python/r/securitylake_subscriber_notification.html.markdown index 652d9fc5e866..6efdfa8d6f6d 100644 --- a/website/docs/cdktf/python/r/securitylake_subscriber_notification.html.markdown +++ b/website/docs/cdktf/python/r/securitylake_subscriber_notification.html.markdown @@ -68,6 +68,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `subscriber_id` - (Required) The subscriber ID for the notification subscription. * `configuration` - (Required) Specify the configuration using which you want to create the subscriber notification.. @@ -103,4 +104,4 @@ This resource exports the following attributes in addition to the arguments abov * `update` - (Default `180m`) * `delete` - (Default `90m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/serverlessapplicationrepository_cloudformation_stack.html.markdown b/website/docs/cdktf/python/r/serverlessapplicationrepository_cloudformation_stack.html.markdown index e711114a5114..46baa56c80fd 100644 --- a/website/docs/cdktf/python/r/serverlessapplicationrepository_cloudformation_stack.html.markdown +++ b/website/docs/cdktf/python/r/serverlessapplicationrepository_cloudformation_stack.html.markdown @@ -37,7 +37,7 @@ class MyConvertedCode(TerraformStack): capabilities=["CAPABILITY_IAM", "CAPABILITY_RESOURCE_POLICY"], name="postgres-rotator", parameters={ - "endpoint": "secretsmanager.${" + data_aws_region_current.name + "}.${" + current.dns_suffix + "}", + "endpoint": "secretsmanager.${" + data_aws_region_current.region + "}.${" + current.dns_suffix + "}", "function_name": "func-postgres-rotator" } ) @@ -47,6 +47,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) The name of the stack to create. The resource deployed in AWS will be prefixed with `serverlessrepo-` * `application_id` - (Required) The ARN of the application from the Serverless Application Repository. * `capabilities` - (Required) A list of capabilities. Valid values are `CAPABILITY_IAM`, `CAPABILITY_NAMED_IAM`, `CAPABILITY_RESOURCE_POLICY`, or `CAPABILITY_AUTO_EXPAND` @@ -87,4 +88,4 @@ Using `terraform import`, import Serverless Application Repository Stack using t % terraform import aws_serverlessapplicationrepository_cloudformation_stack.example serverlessrepo-postgres-rotator ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/service_discovery_http_namespace.html.markdown b/website/docs/cdktf/python/r/service_discovery_http_namespace.html.markdown index bf281eac627e..72e2a363ae6d 100644 --- a/website/docs/cdktf/python/r/service_discovery_http_namespace.html.markdown +++ b/website/docs/cdktf/python/r/service_discovery_http_namespace.html.markdown @@ -34,6 +34,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) The name of the http namespace. * `description` - (Optional) The description that you specify for the namespace when you create it. * `tags` - (Optional) A map of tags to assign to the namespace. 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. @@ -72,4 +73,4 @@ Using `terraform import`, import Service Discovery HTTP Namespace using the name % terraform import aws_service_discovery_http_namespace.example ns-1234567890 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/service_discovery_instance.html.markdown b/website/docs/cdktf/python/r/service_discovery_instance.html.markdown index e5876f793817..d5ae2d1bb81f 100644 --- a/website/docs/cdktf/python/r/service_discovery_instance.html.markdown +++ b/website/docs/cdktf/python/r/service_discovery_instance.html.markdown @@ -110,6 +110,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `instance_id` - (Required, ForceNew) The ID of the service instance. * `service_id` - (Required, ForceNew) The ID of the service that you want to use to create the instance. * `attributes` - (Required) A map contains the attributes of the instance. Check the [doc](https://docs.aws.amazon.com/cloud-map/latest/api/API_RegisterInstance.html#API_RegisterInstance_RequestSyntax) for the supported attributes and syntax. @@ -145,4 +146,4 @@ Using `terraform import`, import Service Discovery Instance using the service ID % terraform import aws_service_discovery_instance.example 0123456789/i-0123 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/service_discovery_private_dns_namespace.html.markdown b/website/docs/cdktf/python/r/service_discovery_private_dns_namespace.html.markdown index 1b1fed9e6c06..95a21e94c641 100644 --- a/website/docs/cdktf/python/r/service_discovery_private_dns_namespace.html.markdown +++ b/website/docs/cdktf/python/r/service_discovery_private_dns_namespace.html.markdown @@ -44,6 +44,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) The name of the namespace. * `vpc` - (Required) The ID of VPC that you want to associate the namespace with. * `description` - (Optional) The description that you specify for the namespace when you create it. @@ -83,4 +84,4 @@ Using `terraform import`, import Service Discovery Private DNS Namespace using t % terraform import aws_service_discovery_private_dns_namespace.example 0123456789:vpc-123345 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/service_discovery_public_dns_namespace.html.markdown b/website/docs/cdktf/python/r/service_discovery_public_dns_namespace.html.markdown index 2a0b2a728ab4..3bacd8cbe802 100644 --- a/website/docs/cdktf/python/r/service_discovery_public_dns_namespace.html.markdown +++ b/website/docs/cdktf/python/r/service_discovery_public_dns_namespace.html.markdown @@ -36,6 +36,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) The name of the namespace. * `description` - (Optional) The description that you specify for the namespace when you create it. * `tags` - (Optional) A map of tags to assign to the namespace. 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. @@ -74,4 +75,4 @@ Using `terraform import`, import Service Discovery Public DNS Namespace using th % terraform import aws_service_discovery_public_dns_namespace.example 0123456789 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/service_discovery_service.html.markdown b/website/docs/cdktf/python/r/service_discovery_service.html.markdown index 641806946b56..6c8b7d619c81 100644 --- a/website/docs/cdktf/python/r/service_discovery_service.html.markdown +++ b/website/docs/cdktf/python/r/service_discovery_service.html.markdown @@ -101,6 +101,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required, Forces new resource) The name of the service. * `description` - (Optional) The description of the service. * `dns_config` - (Optional) A complex type that contains information about the resource record sets that you want Amazon Route 53 to create when you register an instance. See [`dns_config` Block](#dns_config-block) for details. @@ -138,7 +139,7 @@ The `health_check_config` configuration block supports the following arguments: The `health_check_custom_config` configuration block supports the following arguments: -* `failure_threshold` - (Optional, Forces new resource) The number of 30-second intervals that you want service discovery to wait before it changes the health status of a service instance. Maximum value of 10. +* `failure_threshold` - (Optional, **Deprecated** Forces new resource) The number of 30-second intervals that you want service discovery to wait before it changes the health status of a service instance. Value is always set to 1. ## Attribute Reference @@ -146,7 +147,6 @@ This resource exports the following attributes in addition to the arguments abov * `id` - The ID of the service. * `arn` - The ARN of the service. -* `tags_all` - A map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). ## Import @@ -173,4 +173,4 @@ Using `terraform import`, import Service Discovery Service using the service ID. % terraform import aws_service_discovery_service.example 0123456789 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/servicecatalog_budget_resource_association.html.markdown b/website/docs/cdktf/python/r/servicecatalog_budget_resource_association.html.markdown index 493afa3468c3..a3d8de890aea 100644 --- a/website/docs/cdktf/python/r/servicecatalog_budget_resource_association.html.markdown +++ b/website/docs/cdktf/python/r/servicecatalog_budget_resource_association.html.markdown @@ -38,8 +38,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `budget_name` - (Required) Budget name. * `resource_id` - (Required) Resource identifier. @@ -82,4 +83,4 @@ Using `terraform import`, import `aws_servicecatalog_budget_resource_association % terraform import aws_servicecatalog_budget_resource_association.example budget-pjtvyakdlyo3m:prod-dnigbtea24ste ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/servicecatalog_constraint.html.markdown b/website/docs/cdktf/python/r/servicecatalog_constraint.html.markdown index 4c252421e893..fe4ec5217d28 100644 --- a/website/docs/cdktf/python/r/servicecatalog_constraint.html.markdown +++ b/website/docs/cdktf/python/r/servicecatalog_constraint.html.markdown @@ -53,6 +53,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `accept_language` - (Optional) Language code. Valid values: `en` (English), `jp` (Japanese), `zh` (Chinese). Default value is `en`. * `description` - (Optional) Description of the constraint. @@ -131,4 +132,4 @@ Using `terraform import`, import `aws_servicecatalog_constraint` using the const % terraform import aws_servicecatalog_constraint.example cons-nmdkb6cgxfcrs ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/servicecatalog_portfolio.html.markdown b/website/docs/cdktf/python/r/servicecatalog_portfolio.html.markdown index 0fb1061c3459..46c0a41747e8 100644 --- a/website/docs/cdktf/python/r/servicecatalog_portfolio.html.markdown +++ b/website/docs/cdktf/python/r/servicecatalog_portfolio.html.markdown @@ -37,6 +37,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) The name of the portfolio. * `description` - (Required) Description of the portfolio * `provider_name` - (Required) Name of the person or organization who owns the portfolio. @@ -83,4 +84,4 @@ Using `terraform import`, import Service Catalog Portfolios using the Service Ca % terraform import aws_servicecatalog_portfolio.testfolio port-12344321 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/servicecatalog_portfolio_share.html.markdown b/website/docs/cdktf/python/r/servicecatalog_portfolio_share.html.markdown index 24510b1a77a2..e41db9d14104 100644 --- a/website/docs/cdktf/python/r/servicecatalog_portfolio_share.html.markdown +++ b/website/docs/cdktf/python/r/servicecatalog_portfolio_share.html.markdown @@ -53,6 +53,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `accept_language` - (Optional) Language code. Valid values: `en` (English), `jp` (Japanese), `zh` (Chinese). Default value is `en`. * `share_principals` - (Optional) Enables or disables Principal sharing when creating the portfolio share. If this flag is not provided, principal sharing is disabled. * `share_tag_options` - (Optional) Whether to enable sharing of `aws_servicecatalog_tag_option` resources when creating the portfolio share. @@ -98,4 +99,4 @@ Using `terraform import`, import `aws_servicecatalog_portfolio_share` using the % terraform import aws_servicecatalog_portfolio_share.example port-12344321:ACCOUNT:123456789012 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/servicecatalog_principal_portfolio_association.html.markdown b/website/docs/cdktf/python/r/servicecatalog_principal_portfolio_association.html.markdown index d540299cc9ff..9a3a0e6c1df6 100644 --- a/website/docs/cdktf/python/r/servicecatalog_principal_portfolio_association.html.markdown +++ b/website/docs/cdktf/python/r/servicecatalog_principal_portfolio_association.html.markdown @@ -43,6 +43,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `accept_language` - (Optional) Language code. Valid values: `en` (English), `jp` (Japanese), `zh` (Chinese). Default value is `en`. * `principal_type` - (Optional) Principal type. Setting this argument empty (e.g., `principal_type = ""`) will result in an error. Valid values are `IAM` and `IAM_PATTERN`. Default is `IAM`. @@ -85,4 +86,4 @@ Using `terraform import`, import `aws_servicecatalog_principal_portfolio_associa % terraform import aws_servicecatalog_principal_portfolio_association.example en,arn:aws:iam::123456789012:user/Eleanor,port-68656c6c6f,IAM ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/servicecatalog_product.html.markdown b/website/docs/cdktf/python/r/servicecatalog_product.html.markdown index ef8a6e7e5e45..b7f34f5b6944 100644 --- a/website/docs/cdktf/python/r/servicecatalog_product.html.markdown +++ b/website/docs/cdktf/python/r/servicecatalog_product.html.markdown @@ -56,6 +56,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `accept_language` - (Optional) Language code. Valid values: `en` (English), `jp` (Japanese), `zh` (Chinese). Default value is `en`. * `description` - (Optional) Description of the product. * `distributor` - (Optional) Distributor (i.e., vendor) of the product. @@ -120,4 +121,4 @@ Using `terraform import`, import `aws_servicecatalog_product` using the product % terraform import aws_servicecatalog_product.example prod-dnigbtea24ste ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/servicecatalog_product_portfolio_association.html.markdown b/website/docs/cdktf/python/r/servicecatalog_product_portfolio_association.html.markdown index 1257d32f30f0..16b9b31e7196 100644 --- a/website/docs/cdktf/python/r/servicecatalog_product_portfolio_association.html.markdown +++ b/website/docs/cdktf/python/r/servicecatalog_product_portfolio_association.html.markdown @@ -43,6 +43,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `accept_language` - (Optional) Language code. Valid values: `en` (English), `jp` (Japanese), `zh` (Chinese). Default value is `en`. * `source_portfolio_id` - (Optional) Identifier of the source portfolio. @@ -83,4 +84,4 @@ Using `terraform import`, import `aws_servicecatalog_product_portfolio_associati % terraform import aws_servicecatalog_product_portfolio_association.example en:port-68656c6c6f:prod-dnigbtea24ste ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/servicecatalog_provisioned_product.html.markdown b/website/docs/cdktf/python/r/servicecatalog_provisioned_product.html.markdown index aeaa4c856556..691c89e4c6d1 100644 --- a/website/docs/cdktf/python/r/servicecatalog_provisioned_product.html.markdown +++ b/website/docs/cdktf/python/r/servicecatalog_provisioned_product.html.markdown @@ -59,6 +59,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `accept_language` - (Optional) Language code. Valid values: `en` (English), `jp` (Japanese), `zh` (Chinese). Default value is `en`. * `ignore_errors` - (Optional) _Only applies to deleting._ If set to `true`, AWS Service Catalog stops managing the specified provisioned product even if it cannot delete the underlying resources. The default value is `false`. * `notification_arns` - (Optional) Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related events. @@ -157,4 +158,4 @@ Using `terraform import`, import `aws_servicecatalog_provisioned_product` using % terraform import aws_servicecatalog_provisioned_product.example pp-dnigbtea24ste ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/servicecatalog_provisioning_artifact.html.markdown b/website/docs/cdktf/python/r/servicecatalog_provisioning_artifact.html.markdown index cc1f1b1f798a..2f5000da3b49 100644 --- a/website/docs/cdktf/python/r/servicecatalog_provisioning_artifact.html.markdown +++ b/website/docs/cdktf/python/r/servicecatalog_provisioning_artifact.html.markdown @@ -52,6 +52,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `accept_language` - (Optional) Language code. Valid values: `en` (English), `jp` (Japanese), `zh` (Chinese). The default value is `en`. * `active` - (Optional) Whether the product version is active. Inactive provisioning artifacts are invisible to end users. End users cannot launch or update a provisioned product from an inactive provisioning artifact. Default is `true`. * `description` - (Optional) Description of the provisioning artifact (i.e., version), including how it differs from the previous provisioning artifact. @@ -103,4 +104,4 @@ Using `terraform import`, import `aws_servicecatalog_provisioning_artifact` usin % terraform import aws_servicecatalog_provisioning_artifact.example pa-ij2b6lusy6dec:prod-el3an0rma3 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/servicecatalog_service_action.html.markdown b/website/docs/cdktf/python/r/servicecatalog_service_action.html.markdown index fca69d5d1119..78ef4dddfa4e 100644 --- a/website/docs/cdktf/python/r/servicecatalog_service_action.html.markdown +++ b/website/docs/cdktf/python/r/servicecatalog_service_action.html.markdown @@ -47,6 +47,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `accept_language` - (Optional) Language code. Valid values are `en` (English), `jp` (Japanese), and `zh` (Chinese). Default is `en`. * `description` - (Optional) Self-service action description. @@ -100,4 +101,4 @@ Using `terraform import`, import `aws_servicecatalog_service_action` using the s % terraform import aws_servicecatalog_service_action.example act-f1w12eperfslh ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/servicecatalog_tag_option.html.markdown b/website/docs/cdktf/python/r/servicecatalog_tag_option.html.markdown index 74369525bfdb..cc5501d86757 100644 --- a/website/docs/cdktf/python/r/servicecatalog_tag_option.html.markdown +++ b/website/docs/cdktf/python/r/servicecatalog_tag_option.html.markdown @@ -43,6 +43,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `active` - (Optional) Whether tag option is active. Default is `true`. ## Attribute Reference @@ -86,4 +87,4 @@ Using `terraform import`, import `aws_servicecatalog_tag_option` using the tag o % terraform import aws_servicecatalog_tag_option.example tag-pjtvagohlyo3m ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/servicecatalog_tag_option_resource_association.html.markdown b/website/docs/cdktf/python/r/servicecatalog_tag_option_resource_association.html.markdown index b761f36ef788..6626197828b6 100644 --- a/website/docs/cdktf/python/r/servicecatalog_tag_option_resource_association.html.markdown +++ b/website/docs/cdktf/python/r/servicecatalog_tag_option_resource_association.html.markdown @@ -38,8 +38,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `resource_id` - (Required) Resource identifier. * `tag_option_id` - (Required) Tag Option identifier. @@ -86,4 +87,4 @@ Using `terraform import`, import `aws_servicecatalog_tag_option_resource_associa % terraform import aws_servicecatalog_tag_option_resource_association.example tag-pjtvyakdlyo3m:prod-dnigbtea24ste ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/servicecatalogappregistry_application.html.markdown b/website/docs/cdktf/python/r/servicecatalogappregistry_application.html.markdown index 9be28dffe543..972ba57cda82 100644 --- a/website/docs/cdktf/python/r/servicecatalogappregistry_application.html.markdown +++ b/website/docs/cdktf/python/r/servicecatalogappregistry_application.html.markdown @@ -66,6 +66,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `description` - (Optional) Description of the application. * `tags` - (Optional) A map of tags assigned to the Application. 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. @@ -103,4 +104,4 @@ Using `terraform import`, import AWS Service Catalog AppRegistry Application usi % terraform import aws_servicecatalogappregistry_application.example application-id-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/servicecatalogappregistry_attribute_group.html.markdown b/website/docs/cdktf/python/r/servicecatalogappregistry_attribute_group.html.markdown index 08da9b88717c..033ae4b3b347 100644 --- a/website/docs/cdktf/python/r/servicecatalogappregistry_attribute_group.html.markdown +++ b/website/docs/cdktf/python/r/servicecatalogappregistry_attribute_group.html.markdown @@ -18,20 +18,21 @@ Terraform resource for managing an AWS Service Catalog AppRegistry Attribute Gro ```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, TerraformStack +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. import ServicecatalogappregistryAttributeGroup +from imports.aws.servicecatalogappregistry_attribute_group import ServicecatalogappregistryAttributeGroup class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) ServicecatalogappregistryAttributeGroup(self, "example", - attributes=Fn.jsonencode({ - "app": "exampleapp", - "group": "examplegroup" - }), + attributes=Token.as_string( + Fn.jsonencode({ + "app": "exampleapp", + "group": "examplegroup" + })), description="example description", name="example" ) @@ -46,6 +47,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `description` - (Optional) Description of the Attribute Group. * `tags` - (Optional) A map of tags assigned to the Attribute Group. 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. @@ -69,7 +71,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 ServicecatalogappregistryAttributeGroup +from imports.aws.servicecatalogappregistry_attribute_group import ServicecatalogappregistryAttributeGroup class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) @@ -82,4 +84,4 @@ Using `terraform import`, import Service Catalog AppRegistry Attribute Group usi % terraform import aws_servicecatalogappregistry_attribute_group.example 1234567890abcfedhijk09876s ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/servicecatalogappregistry_attribute_group_association.html.markdown b/website/docs/cdktf/python/r/servicecatalogappregistry_attribute_group_association.html.markdown index 178e95a8a910..0a06de408be1 100644 --- a/website/docs/cdktf/python/r/servicecatalogappregistry_attribute_group_association.html.markdown +++ b/website/docs/cdktf/python/r/servicecatalogappregistry_attribute_group_association.html.markdown @@ -55,8 +55,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `application_id` - (Required) ID of the application. * `attribute_group_id` - (Required) ID of the attribute group to associate with the application. @@ -89,4 +90,4 @@ Using `terraform import`, import Service Catalog AppRegistry Attribute Group Ass % terraform import aws_servicecatalogappregistry_attribute_group_association.example 12456778723424sdffsdfsdq34,12234t3564dsfsdf34asff4ww3 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/servicequotas_service_quota.html.markdown b/website/docs/cdktf/python/r/servicequotas_service_quota.html.markdown index 6a6ddbf8fc70..fdc7d6a0b022 100644 --- a/website/docs/cdktf/python/r/servicequotas_service_quota.html.markdown +++ b/website/docs/cdktf/python/r/servicequotas_service_quota.html.markdown @@ -39,6 +39,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `quota_code` - (Required) Code of the service quota to track. For example: `L-F678F1CE`. Available values can be found with the [AWS CLI service-quotas list-service-quotas command](https://docs.aws.amazon.com/cli/latest/reference/service-quotas/list-service-quotas.html). * `service_code` - (Required) Code of the service to track. For example: `vpc`. Available values can be found with the [AWS CLI service-quotas list-services command](https://docs.aws.amazon.com/cli/latest/reference/service-quotas/list-services.html). * `value` - (Required) Float specifying the desired value for the service quota. If the desired value is higher than the current value, a quota increase request is submitted. When a known request is submitted and pending, the value reflects the desired value of the pending request. @@ -92,4 +93,4 @@ Using `terraform import`, import `aws_servicequotas_service_quota` using the ser % terraform import aws_servicequotas_service_quota.example vpc/L-F678F1CE ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/servicequotas_template.html.markdown b/website/docs/cdktf/python/r/servicequotas_template.html.markdown index 7a4176386e5c..20dcdee8e361 100644 --- a/website/docs/cdktf/python/r/servicequotas_template.html.markdown +++ b/website/docs/cdktf/python/r/servicequotas_template.html.markdown @@ -6,6 +6,7 @@ description: |- Terraform resource for managing an AWS Service Quotas Template. --- + # Resource: aws_servicequotas_template @@ -30,8 +31,8 @@ class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) ServicequotasTemplate(self, "example", + aws_region="us-east-1", quota_code="L-2ACBD22F", - region="us-east-1", service_code="lambda", value=Token.as_number("80") ) @@ -39,9 +40,10 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This resource supports the following arguments: -* `region` - (Required) AWS Region to which the template applies. +* `aws_region` - (Optional) AWS Region to which the template applies. +* `region` - (Optional, **Deprecated**) AWS Region to which the template applies. Use `aws_region` instead. * `quota_code` - (Required) Quota identifier. To find the quota code for a specific quota, use the [aws_servicequotas_service_quota](../d/servicequotas_service_quota.html.markdown) data source. * `service_code` - (Required) Service identifier. To find the service code value for an AWS service, use the [aws_servicequotas_service](../d/servicequotas_service.html.markdown) data source. * `value` - (Required) The new, increased value for the quota. @@ -81,4 +83,4 @@ Using `terraform import`, import Service Quotas Template using the `id`. For exa % terraform import aws_servicequotas_template.example us-east-1,L-2ACBD22F,lambda ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/servicequotas_template_association.html.markdown b/website/docs/cdktf/python/r/servicequotas_template_association.html.markdown index 2e694773e280..f777fe96fe22 100644 --- a/website/docs/cdktf/python/r/servicequotas_template_association.html.markdown +++ b/website/docs/cdktf/python/r/servicequotas_template_association.html.markdown @@ -36,6 +36,7 @@ class MyConvertedCode(TerraformStack): The following arguments are optional: +* `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). * `skip_destroy` - (Optional) Skip disassociating the quota increase template upon destruction. This will remove the resource from Terraform state, but leave the remote association in place. ## Attribute Reference @@ -70,4 +71,4 @@ Using `terraform import`, import Service Quotas Template Association using the ` % terraform import aws_servicequotas_template_association.example 123456789012 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ses_active_receipt_rule_set.html.markdown b/website/docs/cdktf/python/r/ses_active_receipt_rule_set.html.markdown index b8e3244cb3c9..8e3ffdd687ea 100644 --- a/website/docs/cdktf/python/r/ses_active_receipt_rule_set.html.markdown +++ b/website/docs/cdktf/python/r/ses_active_receipt_rule_set.html.markdown @@ -35,6 +35,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `rule_set_name` - (Required) The name of the rule set ## Attribute Reference @@ -69,4 +70,4 @@ Using `terraform import`, import active SES receipt rule sets using the rule set % terraform import aws_ses_active_receipt_rule_set.my_rule_set my_rule_set_name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ses_configuration_set.html.markdown b/website/docs/cdktf/python/r/ses_configuration_set.html.markdown index c8804593611d..0df8b7ec5ec9 100644 --- a/website/docs/cdktf/python/r/ses_configuration_set.html.markdown +++ b/website/docs/cdktf/python/r/ses_configuration_set.html.markdown @@ -85,6 +85,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `delivery_options` - (Optional) Whether messages that use the configuration set are required to use TLS. See below. * `reputation_metrics_enabled` - (Optional) Whether or not Amazon SES publishes reputation metrics for the configuration set, such as bounce and complaint rates, to Amazon CloudWatch. The default value is `false`. * `sending_enabled` - (Optional) Whether email sending is enabled or disabled for the configuration set. The default value is `true`. @@ -131,4 +132,4 @@ Using `terraform import`, import SES Configuration Sets using their `name`. For % terraform import aws_ses_configuration_set.test some-configuration-set-test ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ses_domain_dkim.html.markdown b/website/docs/cdktf/python/r/ses_domain_dkim.html.markdown index a1e803ed6409..1da4f6b577b8 100644 --- a/website/docs/cdktf/python/r/ses_domain_dkim.html.markdown +++ b/website/docs/cdktf/python/r/ses_domain_dkim.html.markdown @@ -18,6 +18,7 @@ Domain ownership needs to be confirmed first using [ses_domain_identity Resource This resource supports the following arguments: +* `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). * `domain` - (Required) Verified domain name to generate DKIM tokens for. ## Attribute Reference @@ -103,4 +104,4 @@ Using `terraform import`, import DKIM tokens using the `domain` attribute. For e % terraform import aws_ses_domain_dkim.example example.com ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ses_domain_identity.html.markdown b/website/docs/cdktf/python/r/ses_domain_identity.html.markdown index c5163f6f7840..cfe415f0d1b1 100644 --- a/website/docs/cdktf/python/r/ses_domain_identity.html.markdown +++ b/website/docs/cdktf/python/r/ses_domain_identity.html.markdown @@ -64,6 +64,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `domain` - (Required) The domain name to assign to SES ## Attribute Reference @@ -98,4 +99,4 @@ Using `terraform import`, import SES domain identities using the domain name. Fo % terraform import aws_ses_domain_identity.example example.com ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ses_domain_identity_verification.html.markdown b/website/docs/cdktf/python/r/ses_domain_identity_verification.html.markdown index 0d9f29e08733..26be043e4ced 100644 --- a/website/docs/cdktf/python/r/ses_domain_identity_verification.html.markdown +++ b/website/docs/cdktf/python/r/ses_domain_identity_verification.html.markdown @@ -54,6 +54,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `domain` - (Required) The domain name of the SES domain identity to verify. ## Attribute Reference @@ -69,4 +70,4 @@ This resource exports the following attributes in addition to the arguments abov - `create` - (Default `45m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ses_domain_mail_from.html.markdown b/website/docs/cdktf/python/r/ses_domain_mail_from.html.markdown index d2ca1ed7e667..321973fad8a5 100644 --- a/website/docs/cdktf/python/r/ses_domain_mail_from.html.markdown +++ b/website/docs/cdktf/python/r/ses_domain_mail_from.html.markdown @@ -92,6 +92,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `behavior_on_mx_failure` - (Optional) The action that you want Amazon SES to take if it cannot successfully read the required MX record when you send an email. Defaults to `UseDefaultValue`. See the [SES API documentation](https://docs.aws.amazon.com/ses/latest/APIReference/API_SetIdentityMailFromDomain.html) for more information. ## Attribute Reference @@ -125,4 +126,4 @@ Using `terraform import`, import MAIL FROM domain using the `domain` attribute. % terraform import aws_ses_domain_mail_from.example example.com ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ses_email_identity.html.markdown b/website/docs/cdktf/python/r/ses_email_identity.html.markdown index bebe35ac4f57..cb1563822f2a 100644 --- a/website/docs/cdktf/python/r/ses_email_identity.html.markdown +++ b/website/docs/cdktf/python/r/ses_email_identity.html.markdown @@ -16,6 +16,7 @@ Provides an SES email identity resource This resource supports the following arguments: +* `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). * `email` - (Required) The email address to assign to SES. ## Attribute Reference @@ -68,4 +69,4 @@ Using `terraform import`, import SES email identities using the email address. F % terraform import aws_ses_email_identity.example email@example.com ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ses_event_destination.html.markdown b/website/docs/cdktf/python/r/ses_event_destination.html.markdown index dd76cb940bed..6364efad1914 100644 --- a/website/docs/cdktf/python/r/ses_event_destination.html.markdown +++ b/website/docs/cdktf/python/r/ses_event_destination.html.markdown @@ -97,6 +97,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) The name of the event destination * `configuration_set_name` - (Required) The name of the configuration set * `enabled` - (Optional) If true, the event destination will be enabled @@ -154,4 +155,4 @@ Using `terraform import`, import SES event destinations using `configuration_set % terraform import aws_ses_event_destination.sns some-configuration-set-test/event-destination-sns ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ses_identity_notification_topic.html.markdown b/website/docs/cdktf/python/r/ses_identity_notification_topic.html.markdown index db9c3ed8e2a4..5f2af7639a1d 100644 --- a/website/docs/cdktf/python/r/ses_identity_notification_topic.html.markdown +++ b/website/docs/cdktf/python/r/ses_identity_notification_topic.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `topic_arn` - (Optional) The Amazon Resource Name (ARN) of the Amazon SNS topic. Can be set to `""` (an empty string) to disable publishing. * `notification_type` - (Required) The type of notifications that will be published to the specified Amazon SNS topic. Valid Values: `Bounce`, `Complaint` or `Delivery`. * `identity` - (Required) The identity for which the Amazon SNS topic will be set. You can specify an identity by using its name or by using its Amazon Resource Name (ARN). @@ -72,4 +73,4 @@ Using `terraform import`, import Identity Notification Topics using the ID of th % terraform import aws_ses_identity_notification_topic.test 'example.com|Bounce' ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ses_identity_policy.html.markdown b/website/docs/cdktf/python/r/ses_identity_policy.html.markdown index 4406c20e2a1c..f99b15320d98 100644 --- a/website/docs/cdktf/python/r/ses_identity_policy.html.markdown +++ b/website/docs/cdktf/python/r/ses_identity_policy.html.markdown @@ -58,6 +58,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `identity` - (Required) Name or Amazon Resource Name (ARN) of the SES Identity. * `name` - (Required) Name of the policy. * `policy` - (Required) JSON string of the policy. For more information about building AWS IAM policy documents with Terraform, see the [AWS IAM Policy Document Guide](https://learn.hashicorp.com/terraform/aws/iam-policy). @@ -91,4 +92,4 @@ Using `terraform import`, import SES Identity Policies using the identity and po % terraform import aws_ses_identity_policy.example 'example.com|example' ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ses_receipt_filter.html.markdown b/website/docs/cdktf/python/r/ses_receipt_filter.html.markdown index 6b2c1de0128b..8f5451851b5d 100644 --- a/website/docs/cdktf/python/r/ses_receipt_filter.html.markdown +++ b/website/docs/cdktf/python/r/ses_receipt_filter.html.markdown @@ -37,6 +37,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) The name of the filter * `cidr` - (Required) The IP address or address range to filter, in CIDR notation * `policy` - (Required) Block or Allow @@ -73,4 +74,4 @@ Using `terraform import`, import SES Receipt Filter using their `name`. For exam % terraform import aws_ses_receipt_filter.test some-filter ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ses_receipt_rule.html.markdown b/website/docs/cdktf/python/r/ses_receipt_rule.html.markdown index af708609c7c5..10b534c36a8f 100644 --- a/website/docs/cdktf/python/r/ses_receipt_rule.html.markdown +++ b/website/docs/cdktf/python/r/ses_receipt_rule.html.markdown @@ -50,6 +50,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) The name of the rule * `rule_set_name` - (Required) The name of the rule set * `after` - (Optional) The name of the rule to place this rule after @@ -146,4 +147,4 @@ Using `terraform import`, import SES receipt rules using the ruleset name and ru % terraform import aws_ses_receipt_rule.my_rule my_rule_set:my_rule ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ses_receipt_rule_set.html.markdown b/website/docs/cdktf/python/r/ses_receipt_rule_set.html.markdown index aaa4892f38f8..310df0811f35 100644 --- a/website/docs/cdktf/python/r/ses_receipt_rule_set.html.markdown +++ b/website/docs/cdktf/python/r/ses_receipt_rule_set.html.markdown @@ -35,6 +35,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `rule_set_name` - (Required) Name of the rule set. ## Attribute Reference @@ -69,4 +70,4 @@ Using `terraform import`, import SES receipt rule sets using the rule set name. % terraform import aws_ses_receipt_rule_set.my_rule_set my_rule_set_name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ses_template.html.markdown b/website/docs/cdktf/python/r/ses_template.html.markdown index 78e00c95bf50..943699436129 100644 --- a/website/docs/cdktf/python/r/ses_template.html.markdown +++ b/website/docs/cdktf/python/r/ses_template.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) The name of the template. Cannot exceed 64 characters. You will refer to this name when you send email. * `html` - (Optional) The HTML body of the email. Must be less than 500KB in size, including both the text and HTML parts. * `subject` - (Optional) The subject line of the email. @@ -75,4 +76,4 @@ Using `terraform import`, import SES templates using the template name. For exam % terraform import aws_ses_template.MyTemplate MyTemplate ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/sesv2_account_suppression_attributes.html.markdown b/website/docs/cdktf/python/r/sesv2_account_suppression_attributes.html.markdown index c149df761333..44b8407c5b05 100644 --- a/website/docs/cdktf/python/r/sesv2_account_suppression_attributes.html.markdown +++ b/website/docs/cdktf/python/r/sesv2_account_suppression_attributes.html.markdown @@ -33,8 +33,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `suppressed_reasons` - (Required) A list that contains the reasons that email addresses will be automatically added to the suppression list for your account. Valid values: `COMPLAINT`, `BOUNCE`. ## Attribute Reference @@ -66,4 +67,4 @@ Using `terraform import`, import account-level suppression attributes using the % terraform import aws_sesv2_account_suppression_attributes.example 123456789012 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/sesv2_account_vdm_attributes.html.markdown b/website/docs/cdktf/python/r/sesv2_account_vdm_attributes.html.markdown index f0fc5a082565..420e16203594 100644 --- a/website/docs/cdktf/python/r/sesv2_account_vdm_attributes.html.markdown +++ b/website/docs/cdktf/python/r/sesv2_account_vdm_attributes.html.markdown @@ -47,6 +47,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `dashboard_attributes` - (Optional) Specifies additional settings for your VDM configuration as applicable to the Dashboard. * `guardian_attributes` - (Optional) Specifies additional settings for your VDM configuration as applicable to the Guardian. @@ -87,4 +88,4 @@ Using `terraform import`, import SESv2 (Simple Email V2) Account VDM Attributes % terraform import aws_sesv2_account_vdm_attributes.example ses-account-vdm-attributes ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/sesv2_configuration_set.html.markdown b/website/docs/cdktf/python/r/sesv2_configuration_set.html.markdown index 592b1461c185..8c0dda154cf8 100644 --- a/website/docs/cdktf/python/r/sesv2_configuration_set.html.markdown +++ b/website/docs/cdktf/python/r/sesv2_configuration_set.html.markdown @@ -54,6 +54,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `configuration_set_name` - (Required) The name of the configuration set. * `delivery_options` - (Optional) An object that defines the dedicated IP pool that is used to send emails that you send using the configuration set. See [`delivery_options` Block](#delivery_options-block) for details. * `reputation_options` - (Optional) An object that defines whether or not Amazon SES collects reputation metrics for the emails that you send that use the configuration set. See [`reputation_options` Block](#reputation_options-block) for details. @@ -148,4 +149,4 @@ Using `terraform import`, import SESv2 (Simple Email V2) Configuration Set using % terraform import aws_sesv2_configuration_set.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/sesv2_configuration_set_event_destination.html.markdown b/website/docs/cdktf/python/r/sesv2_configuration_set_event_destination.html.markdown index f26010fb6eaa..591104d87ead 100644 --- a/website/docs/cdktf/python/r/sesv2_configuration_set_event_destination.html.markdown +++ b/website/docs/cdktf/python/r/sesv2_configuration_set_event_destination.html.markdown @@ -189,8 +189,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `configuration_set_name` - (Required) The name of the configuration set. * `event_destination` - (Required) A name that identifies the event destination within the configuration set. * `event_destination_name` - (Required) An object that defines the event destination. See [`event_destination` Block](#event_destination-block) for details. @@ -202,7 +203,7 @@ The `event_destination` configuration block supports the following arguments: * `matching_event_types` - (Required) - An array that specifies which events the Amazon SES API v2 should send to the destinations. Valid values: `SEND`, `REJECT`, `BOUNCE`, `COMPLAINT`, `DELIVERY`, `OPEN`, `CLICK`, `RENDERING_FAILURE`, `DELIVERY_DELAY`, `SUBSCRIPTION`. * `cloud_watch_destination` - (Optional) An object that defines an Amazon CloudWatch destination for email events. See [`cloud_watch_destination` Block](#cloud_watch_destination-block) for details. * `enabled` - (Optional) When the event destination is enabled, the specified event types are sent to the destinations. Default: `false`. -* `event_bridge_configuration` - (Optional) An object that defines an Amazon EventBridge destination for email events. You can use Amazon EventBridge to send notifications when certain email events occur. See [`event_bridge_configuration` Block](#event_bridge_configuration-block) for details. +* `event_bridge_destination` - (Optional) An object that defines an Amazon EventBridge destination for email events. You can use Amazon EventBridge to send notifications when certain email events occur. See [`event_bridge_destination` Block](#event_bridge_destination-block) for details. * `kinesis_firehose_destination` - (Optional) An object that defines an Amazon Kinesis Data Firehose destination for email events. See [`kinesis_firehose_destination` Block](#kinesis_firehose_destination-block) for details. * `pinpoint_destination` - (Optional) An object that defines an Amazon Pinpoint project destination for email events. See [`pinpoint_destination` Block](#pinpoint_destination-block) for details. * `sns_destination` - (Optional) An object that defines an Amazon SNS destination for email events. See [`sns_destination` Block](#sns_destination-block) for details. @@ -221,9 +222,9 @@ The `dimension_configuration` configuration block supports the following argumen * `dimension_name` - (Required) The name of an Amazon CloudWatch dimension associated with an email sending metric. * `dimension_value_source` - (Required) The location where the Amazon SES API v2 finds the value of a dimension to publish to Amazon CloudWatch. Valid values: `MESSAGE_TAG`, `EMAIL_HEADER`, `LINK_TAG`. -### `event_bridge_configuration` Block +### `event_bridge_destination` Block -The `event_bridge_configuration` configuration block supports the following arguments: +The `event_bridge_destination` configuration block supports the following arguments: * `event_bus_arn` - (Required) The Amazon Resource Name (ARN) of the Amazon EventBridge bus to publish email events to. Only the default bus is supported. @@ -277,4 +278,4 @@ Using `terraform import`, import SESv2 (Simple Email V2) Configuration Set Event % terraform import aws_sesv2_configuration_set_event_destination.example example_configuration_set|example_event_destination ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/sesv2_contact_list.html.markdown b/website/docs/cdktf/python/r/sesv2_contact_list.html.markdown index 77f0498030b1..2651d862c563 100644 --- a/website/docs/cdktf/python/r/sesv2_contact_list.html.markdown +++ b/website/docs/cdktf/python/r/sesv2_contact_list.html.markdown @@ -68,6 +68,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `description` - (Optional) Description of what the contact list is about. * `tags` - (Optional) Key-value map of resource tags for the contact list. 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. * `topic` - (Optional) Configuration block(s) with topic for the contact list. Detailed below. @@ -82,6 +83,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `description` - (Optional) Description of what the topic is about, which the contact will see. ## Attribute Reference @@ -117,4 +119,4 @@ Using `terraform import`, import SESv2 (Simple Email V2) Contact List using the % terraform import aws_sesv2_contact_list.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/sesv2_dedicated_ip_assignment.html.markdown b/website/docs/cdktf/python/r/sesv2_dedicated_ip_assignment.html.markdown index f5ec5ee6d592..9c30b318b950 100644 --- a/website/docs/cdktf/python/r/sesv2_dedicated_ip_assignment.html.markdown +++ b/website/docs/cdktf/python/r/sesv2_dedicated_ip_assignment.html.markdown @@ -38,8 +38,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `ip` - (Required) Dedicated IP address. * `destination_pool_name` - (Required) Dedicated IP address. @@ -74,4 +75,4 @@ Using `terraform import`, import SESv2 (Simple Email V2) Dedicated IP Assignment % terraform import aws_sesv2_dedicated_ip_assignment.example "0.0.0.0,my-pool" ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/sesv2_dedicated_ip_pool.html.markdown b/website/docs/cdktf/python/r/sesv2_dedicated_ip_pool.html.markdown index b8de3a63d3ec..7dc2a35ec950 100644 --- a/website/docs/cdktf/python/r/sesv2_dedicated_ip_pool.html.markdown +++ b/website/docs/cdktf/python/r/sesv2_dedicated_ip_pool.html.markdown @@ -61,6 +61,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `scaling_mode` - (Optional) IP pool scaling mode. Valid values: `STANDARD`, `MANAGED`. If omitted, the AWS API will default to a standard pool. * `tags` - (Optional) A map of tags to assign to the pool. 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. @@ -95,4 +96,4 @@ Using `terraform import`, import SESv2 (Simple Email V2) Dedicated IP Pool using % terraform import aws_sesv2_dedicated_ip_pool.example my-pool ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/sesv2_email_identity.html.markdown b/website/docs/cdktf/python/r/sesv2_email_identity.html.markdown index 7fc58e9a1246..29695ce1546f 100644 --- a/website/docs/cdktf/python/r/sesv2_email_identity.html.markdown +++ b/website/docs/cdktf/python/r/sesv2_email_identity.html.markdown @@ -111,6 +111,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `configuration_set_name` - (Optional) The configuration set to use by default when sending from this identity. Note that any configuration set defined in the email sending request takes precedence. * `dkim_signing_attributes` - (Optional) The configuration of the DKIM authentication settings for an email domain identity. * `tags` - (Optional) Key-value mapping of resource tags. If configured with a provider [`default_tags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. @@ -138,6 +139,7 @@ This resource exports the following attributes in addition to the arguments abov * `tokens` - If you used Easy DKIM to configure DKIM authentication for the domain, then this object contains a set of unique strings that you use to create a set of CNAME records that you add to the DNS configuration for your domain. When Amazon SES detects these records in the DNS configuration for your domain, the DKIM authentication process is complete. If you configured DKIM authentication for the domain by providing your own public-private key pair, then this object contains the selector for the public key. * `identity_type` - The email identity type. Valid values: `EMAIL_ADDRESS`, `DOMAIN`. * `tags_all` - Map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block). +* `verification_status` - The verification status of the identity. The status can be one of the following: `PENDING`, `SUCCESS`, `FAILED`, `TEMPORARY_FAILURE`, and `NOT_STARTED`. * `verified_for_sending_status` - Specifies whether or not the identity is verified. ## Import @@ -165,4 +167,4 @@ Using `terraform import`, import SESv2 (Simple Email V2) Email Identity using th % terraform import aws_sesv2_email_identity.example example.com ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/sesv2_email_identity_feedback_attributes.html.markdown b/website/docs/cdktf/python/r/sesv2_email_identity_feedback_attributes.html.markdown index 5ea984cba80f..c601f2ef891b 100644 --- a/website/docs/cdktf/python/r/sesv2_email_identity_feedback_attributes.html.markdown +++ b/website/docs/cdktf/python/r/sesv2_email_identity_feedback_attributes.html.markdown @@ -45,6 +45,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `email_identity` - (Required) The email identity. * `email_forwarding_enabled` - (Optional) Sets the feedback forwarding configuration for the identity. @@ -77,4 +78,4 @@ Using `terraform import`, import SESv2 (Simple Email V2) Email Identity Feedback % terraform import aws_sesv2_email_identity_feedback_attributes.example example.com ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/sesv2_email_identity_mail_from_attributes.html.markdown b/website/docs/cdktf/python/r/sesv2_email_identity_mail_from_attributes.html.markdown index db5cf1dc248f..432df306e370 100644 --- a/website/docs/cdktf/python/r/sesv2_email_identity_mail_from_attributes.html.markdown +++ b/website/docs/cdktf/python/r/sesv2_email_identity_mail_from_attributes.html.markdown @@ -46,6 +46,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `email_identity` - (Required) The verified email identity. * `behavior_on_mx_failure` - (Optional) The action to take if the required MX record isn't found when you send an email. Valid values: `USE_DEFAULT_VALUE`, `REJECT_MESSAGE`. * `mail_from_domain` - (Optional) The custom MAIL FROM domain that you want the verified identity to use. Required if `behavior_on_mx_failure` is `REJECT_MESSAGE`. @@ -79,4 +80,4 @@ Using `terraform import`, import SESv2 (Simple Email V2) Email Identity Mail Fro % terraform import aws_sesv2_email_identity_mail_from_attributes.example example.com ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/sesv2_email_identity_policy.html.markdown b/website/docs/cdktf/python/r/sesv2_email_identity_policy.html.markdown index fa17a09ad09e..f5efc0286042 100644 --- a/website/docs/cdktf/python/r/sesv2_email_identity_policy.html.markdown +++ b/website/docs/cdktf/python/r/sesv2_email_identity_policy.html.markdown @@ -42,8 +42,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `email_identity` - (Required) The email identity. * `policy_name` - (Required) - The name of the policy. * `policy` - (Required) - The text of the policy in JSON format. @@ -54,7 +55,7 @@ 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 SESv2 (Simple Email V2) Email Identity Policy using the `id` (`email_identity|policy_name`). For example: +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import SESv2 (Simple Email V2) Email Identity Policy using the `email_identity` and `policy_name` separated by `|`. For example: ```python # DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -71,10 +72,10 @@ class MyConvertedCode(TerraformStack): Sesv2EmailIdentityPolicy.generate_config_for_import(self, "example", "example_email_identity|example_policy_name") ``` -Using `terraform import`, import SESv2 (Simple Email V2) Email Identity Policy using the `example_id_arg`. For example: +Using `terraform import`, import SESv2 (Simple Email V2) Email Identity Policy using the `email_identity` and `policy_name` separated by `|`. For example: ```console % terraform import aws_sesv2_email_identity_policy.example example_email_identity|example_policy_name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/sfn_activity.html.markdown b/website/docs/cdktf/python/r/sfn_activity.html.markdown index 16b3dfea811e..4b2fadbb228b 100644 --- a/website/docs/cdktf/python/r/sfn_activity.html.markdown +++ b/website/docs/cdktf/python/r/sfn_activity.html.markdown @@ -63,6 +63,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `encryption_configuration` - (Optional) Defines what encryption configuration is used to encrypt data in the Activity. For more information see the section [Data at rest encyption](https://docs.aws.amazon.com/step-functions/latest/dg/encryption-at-rest.html) in the AWS Step Functions User Guide. * `name` - (Required) The name of the activity to create. * `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. @@ -107,4 +108,4 @@ Using `terraform import`, import activities using the `arn`. For example: % terraform import aws_sfn_activity.foo arn:aws:states:eu-west-1:123456789098:activity:bar ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/sfn_alias.html.markdown b/website/docs/cdktf/python/r/sfn_alias.html.markdown index 2b6f80b5e0e6..9c0049885ebf 100644 --- a/website/docs/cdktf/python/r/sfn_alias.html.markdown +++ b/website/docs/cdktf/python/r/sfn_alias.html.markdown @@ -53,6 +53,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) Name for the alias you are creating. * `description` - (Optional) Description of the alias. * `routing_configuration` - (Required) The StateMachine alias' route configuration settings. Fields documented below @@ -94,4 +95,4 @@ Using `terraform import`, import SFN (Step Functions) Alias using the `arn`. For % terraform import aws_sfn_alias.foo arn:aws:states:us-east-1:123456789098:stateMachine:myStateMachine:foo ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/sfn_state_machine.html.markdown b/website/docs/cdktf/python/r/sfn_state_machine.html.markdown index cda5d2d48f01..17ff92d5b5c0 100644 --- a/website/docs/cdktf/python/r/sfn_state_machine.html.markdown +++ b/website/docs/cdktf/python/r/sfn_state_machine.html.markdown @@ -140,6 +140,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `definition` - (Required) The [Amazon States Language](https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html) definition of the state machine. * `encryption_configuration` - (Optional) Defines what encryption configuration is used to encrypt data in the State Machine. For more information see [TBD] in the AWS Step Functions User Guide. * `logging_configuration` - (Optional) Defines what execution history events are logged and where they are logged. The `logging_configuration` parameter is valid when `type` is set to `STANDARD` or `EXPRESS`. Defaults to `OFF`. For more information see [Logging Express Workflows](https://docs.aws.amazon.com/step-functions/latest/dg/cw-logs.html), [Log Levels](https://docs.aws.amazon.com/step-functions/latest/dg/cloudwatch-log-level.html) and [Logging Configuration](https://docs.aws.amazon.com/step-functions/latest/apireference/API_CreateStateMachine.html) in the AWS Step Functions User Guide. @@ -211,4 +212,4 @@ Using `terraform import`, import State Machines using the `arn`. For example: % terraform import aws_sfn_state_machine.foo arn:aws:states:eu-west-1:123456789098:stateMachine:bar ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/shield_drt_access_log_bucket_association.html.markdown b/website/docs/cdktf/python/r/shield_drt_access_log_bucket_association.html.markdown index f73cf79e58b3..e1854aabedc9 100644 --- a/website/docs/cdktf/python/r/shield_drt_access_log_bucket_association.html.markdown +++ b/website/docs/cdktf/python/r/shield_drt_access_log_bucket_association.html.markdown @@ -31,7 +31,7 @@ class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) test = ShieldDrtAccessRoleArnAssociation(self, "test", - role_arn="arn:aws:iam:${" + current.name + "}:${" + data_aws_caller_identity_current.account_id + "}:${" + shield_drt_access_role_name.value + "}" + role_arn="arn:aws:iam:${" + current.region + "}:${" + data_aws_caller_identity_current.account_id + "}:${" + shield_drt_access_role_name.value + "}" ) aws_shield_drt_access_log_bucket_association_test = ShieldDrtAccessLogBucketAssociation(self, "test_1", @@ -85,4 +85,4 @@ Using `terraform import`, import Shield DRT access log bucket associations using % terraform import aws_shield_drt_access_log_bucket_association.example example-bucket ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/shield_protection.html.markdown b/website/docs/cdktf/python/r/shield_protection.html.markdown index d2f38944ae22..9653fb29c763 100644 --- a/website/docs/cdktf/python/r/shield_protection.html.markdown +++ b/website/docs/cdktf/python/r/shield_protection.html.markdown @@ -43,7 +43,7 @@ class MyConvertedCode(TerraformStack): data_aws_region_current.override_logical_id("current") aws_shield_protection_example = ShieldProtection(self, "example_4", name="example", - resource_arn="arn:aws:ec2:${" + data_aws_region_current.name + "}:${" + current.account_id + "}:eip-allocation/${" + example.id + "}", + resource_arn="arn:aws:ec2:${" + data_aws_region_current.region + "}:${" + current.account_id + "}:eip-allocation/${" + example.id + "}", tags={ "Environment": "Dev" } @@ -93,4 +93,4 @@ Using `terraform import`, import Shield protection resources using specifying th % terraform import aws_shield_protection.example ff9592dc-22f3-4e88-afa1-7b29fde9669a ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/shield_protection_group.html.markdown b/website/docs/cdktf/python/r/shield_protection_group.html.markdown index 9cf2a057ba7a..6b1a4bae8223 100644 --- a/website/docs/cdktf/python/r/shield_protection_group.html.markdown +++ b/website/docs/cdktf/python/r/shield_protection_group.html.markdown @@ -64,14 +64,14 @@ class MyConvertedCode(TerraformStack): data_aws_region_current.override_logical_id("current") aws_shield_protection_example = ShieldProtection(self, "example_3", name="example", - resource_arn="arn:aws:ec2:${" + data_aws_region_current.name + "}:${" + current.account_id + "}:eip-allocation/${" + example.id + "}" + resource_arn="arn:aws:ec2:${" + data_aws_region_current.region + "}:${" + current.account_id + "}:eip-allocation/${" + example.id + "}" ) # 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_shield_protection_example.override_logical_id("example") aws_shield_protection_group_example = ShieldProtectionGroup(self, "example_4", aggregation="MEAN", depends_on=[aws_shield_protection_example], - members=["arn:aws:ec2:${" + data_aws_region_current.name + "}:${" + current.account_id + "}:eip-allocation/${" + example.id + "}" + members=["arn:aws:ec2:${" + data_aws_region_current.region + "}:${" + current.account_id + "}:eip-allocation/${" + example.id + "}" ], pattern="ARBITRARY", protection_group_id="example" @@ -145,4 +145,4 @@ Using `terraform import`, import Shield protection group resources using their p % terraform import aws_shield_protection_group.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/shield_protection_health_check_association.html.markdown b/website/docs/cdktf/python/r/shield_protection_health_check_association.html.markdown index 84fcd0be4b3b..703aa0adafd0 100644 --- a/website/docs/cdktf/python/r/shield_protection_health_check_association.html.markdown +++ b/website/docs/cdktf/python/r/shield_protection_health_check_association.html.markdown @@ -65,7 +65,7 @@ class MyConvertedCode(TerraformStack): data_aws_region_current.override_logical_id("current") aws_shield_protection_example = ShieldProtection(self, "example_5", name="example-protection", - resource_arn="arn:${" + data_aws_partition_current.partition + "}:ec2:${" + data_aws_region_current.name + "}:${" + current.account_id + "}:eip-allocation/${" + example.id + "}" + resource_arn="arn:${" + data_aws_partition_current.partition + "}:ec2:${" + data_aws_region_current.region + "}:${" + current.account_id + "}:eip-allocation/${" + example.id + "}" ) # 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_shield_protection_example.override_logical_id("example") @@ -116,4 +116,4 @@ Using `terraform import`, import Shield protection health check association reso % terraform import aws_shield_protection_health_check_association.example ff9592dc-22f3-4e88-afa1-7b29fde9669a+arn:aws:route53:::healthcheck/3742b175-edb9-46bc-9359-f53e3b794b1b ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/signer_signing_job.html.markdown b/website/docs/cdktf/python/r/signer_signing_job.html.markdown index e8dfafec32ba..84614407008a 100644 --- a/website/docs/cdktf/python/r/signer_signing_job.html.markdown +++ b/website/docs/cdktf/python/r/signer_signing_job.html.markdown @@ -53,6 +53,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `profile_name` - (Required) The name of the profile to initiate the signing operation. * `source` - (Required) The S3 bucket that contains the object to sign. See [Source](#source) below for details. * `destination` - (Required) The S3 bucket in which to save your signed object. See [Destination](#destination) below for details. @@ -129,4 +130,4 @@ Using `terraform import`, import Signer signing jobs using the `job_id`. For exa % terraform import aws_signer_signing_job.test_signer_signing_job 9ed7e5c3-b8d4-4da0-8459-44e0b068f7ee ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/signer_signing_profile.html.markdown b/website/docs/cdktf/python/r/signer_signing_profile.html.markdown index 3f74a0bc1c3b..28ade7df0776 100644 --- a/website/docs/cdktf/python/r/signer_signing_profile.html.markdown +++ b/website/docs/cdktf/python/r/signer_signing_profile.html.markdown @@ -47,11 +47,13 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `platform_id` - (Required, Forces new resource) The ID of the platform that is used by the target signing profile. * `name` - (Optional, Forces new resource) A unique signing profile name. By default generated by Terraform. Signing profile names are immutable and cannot be reused after canceled. * `name_prefix` - (Optional, Forces new resource) A signing profile name prefix. Terraform will generate a unique suffix. Conflicts with `name`. * `signature_validity_period` - (Optional, Forces new resource) The validity period for a signing job. See [`signature_validity_period` Block](#signature_validity_period-block) below for details. * `signing_material` - (Optional, Forces new resource) The AWS Certificate Manager certificate that will be used to sign code with the new signing profile. See [`signing_material` Block](#signing_material-block) below for details. +* `signing_parameters` - (Optional, Forces new resource) Map of key-value pairs for signing. These can include any information that you want to use during signing. * `tags` - (Optional) A list of tags associated with the signing profile. 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. ### `signature_validity_period` Block @@ -113,4 +115,4 @@ Using `terraform import`, import Signer signing profiles using the `name`. For e % terraform import aws_signer_signing_profile.test_signer_signing_profile test_sp_DdW3Mk1foYL88fajut4mTVFGpuwfd4ACO6ANL0D1uIj7lrn8adK ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/signer_signing_profile_permission.html.markdown b/website/docs/cdktf/python/r/signer_signing_profile_permission.html.markdown index e7ddf5b3005c..cb17b931bcf8 100644 --- a/website/docs/cdktf/python/r/signer_signing_profile_permission.html.markdown +++ b/website/docs/cdktf/python/r/signer_signing_profile_permission.html.markdown @@ -63,6 +63,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `profile_name` - (Required) Name of the signing profile to add the cross-account permissions. * `action` - (Required) An AWS Signer action permitted as part of cross-account permissions. Valid values: `signer:StartSigningJob`, `signer:GetSigningProfile`, `signer:RevokeSignature`, or `signer:SignPayload`. * `principal` - (Required) The AWS principal to be granted a cross-account permission. @@ -99,4 +100,4 @@ Using `terraform import`, import Signer signing profile permission statements us % terraform import aws_signer_signing_profile_permission.test_signer_signing_profile_permission prod_profile_DdW3Mk1foYL88fajut4mTVFGpuwfd4ACO6ANL0D1uIj7lrn8adK/ProdAccountStartSigningJobStatementId ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/snapshot_create_volume_permission.html.markdown b/website/docs/cdktf/python/r/snapshot_create_volume_permission.html.markdown index d68ddd947c90..bc704ca23735 100644 --- a/website/docs/cdktf/python/r/snapshot_create_volume_permission.html.markdown +++ b/website/docs/cdktf/python/r/snapshot_create_volume_permission.html.markdown @@ -45,6 +45,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `snapshot_id` - (Required) A snapshot ID * `account_id` - (Required) An AWS Account ID to add create volume permissions. The AWS Account cannot be the snapshot's owner @@ -54,4 +55,4 @@ This resource exports the following attributes in addition to the arguments abov * `id` - A combination of "`snapshot_id`-`account_id`". - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/sns_platform_application.html.markdown b/website/docs/cdktf/python/r/sns_platform_application.html.markdown index feea6c43aedc..b19371260864 100644 --- a/website/docs/cdktf/python/r/sns_platform_application.html.markdown +++ b/website/docs/cdktf/python/r/sns_platform_application.html.markdown @@ -85,6 +85,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) The friendly name for the SNS platform application * `platform` - (Required) The platform that the app is registered with. See [Platform][1] for supported platforms. * `platform_credential` - (Required) Application Platform credential. See [Credential][1] for type of credential required for platform. The value of this attribute when stored into the Terraform state is only a hash of the real value, so therefore it is not practical to use this as an attribute for other resources. @@ -137,4 +138,4 @@ Using `terraform import`, import SNS platform applications using the ARN. For ex % terraform import aws_sns_platform_application.gcm_application arn:aws:sns:us-west-2:123456789012:app/GCM/gcm_application ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/sns_sms_preferences.html.markdown b/website/docs/cdktf/python/r/sns_sms_preferences.html.markdown index 2b72ac88334c..2ea3d621a3be 100644 --- a/website/docs/cdktf/python/r/sns_sms_preferences.html.markdown +++ b/website/docs/cdktf/python/r/sns_sms_preferences.html.markdown @@ -33,6 +33,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `monthly_spend_limit` - (Optional) The maximum amount in USD that you are willing to spend each month to send SMS messages. * `delivery_status_iam_role_arn` - (Optional) The ARN of the IAM role that allows Amazon SNS to write logs about SMS deliveries in CloudWatch Logs. * `delivery_status_success_sampling_rate` - (Optional) The percentage of successful SMS deliveries for which Amazon SNS will write logs in CloudWatch Logs. The value must be between 0 and 100. @@ -48,4 +49,4 @@ This resource exports no additional attributes. You cannot import the SMS preferences. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/sns_topic.html.markdown b/website/docs/cdktf/python/r/sns_topic.html.markdown index 3fea5e9d130a..42525a232980 100644 --- a/website/docs/cdktf/python/r/sns_topic.html.markdown +++ b/website/docs/cdktf/python/r/sns_topic.html.markdown @@ -100,6 +100,7 @@ The `_success_feedback_role_arn` and `_failure_feedback_role This resource supports the following arguments: +* `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). * `name` - (Optional) The name of the topic. Topic names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long. For a FIFO (first-in-first-out) topic, the name must end with the `.fifo` suffix. If omitted, Terraform will assign a random, unique name. Conflicts with `name_prefix` * `name_prefix` - (Optional) Creates a unique name beginning with the specified prefix. Conflicts with `name` * `display_name` - (Optional) The display name for the topic @@ -164,4 +165,4 @@ Using `terraform import`, import SNS Topics using the topic `arn`. For example: % terraform import aws_sns_topic.user_updates arn:aws:sns:us-west-2:123456789012:my-topic ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/sns_topic_data_protection_policy.html.markdown b/website/docs/cdktf/python/r/sns_topic_data_protection_policy.html.markdown index 68f7963c5245..a782577f2aae 100644 --- a/website/docs/cdktf/python/r/sns_topic_data_protection_policy.html.markdown +++ b/website/docs/cdktf/python/r/sns_topic_data_protection_policy.html.markdown @@ -59,6 +59,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `arn` - (Required) The ARN of the SNS topic * `policy` - (Required) The fully-formed AWS policy as JSON. For more information about building AWS IAM policy documents with Terraform, see the [AWS IAM Policy Document Guide](https://learn.hashicorp.com/terraform/aws/iam-policy). @@ -91,4 +92,4 @@ Using `terraform import`, import SNS Data Protection Topic Policy using the topi % terraform import aws_sns_topic_data_protection_policy.example arn:aws:sns:us-west-2:123456789012:example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/sns_topic_policy.html.markdown b/website/docs/cdktf/python/r/sns_topic_policy.html.markdown index 953cd34ff9c9..c1767d7fa7c7 100644 --- a/website/docs/cdktf/python/r/sns_topic_policy.html.markdown +++ b/website/docs/cdktf/python/r/sns_topic_policy.html.markdown @@ -65,6 +65,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `arn` - (Required) The ARN of the SNS topic * `policy` - (Required) The fully-formed AWS policy as JSON. For more information about building AWS IAM policy documents with Terraform, see the [AWS IAM Policy Document Guide](https://learn.hashicorp.com/terraform/aws/iam-policy). @@ -99,4 +100,4 @@ Using `terraform import`, import SNS Topic Policy using the topic ARN. For examp % terraform import aws_sns_topic_policy.user_updates arn:aws:sns:us-west-2:123456789012:my-topic ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/sns_topic_subscription.html.markdown b/website/docs/cdktf/python/r/sns_topic_subscription.html.markdown index 39b41665d485..b5545f287cd4 100644 --- a/website/docs/cdktf/python/r/sns_topic_subscription.html.markdown +++ b/website/docs/cdktf/python/r/sns_topic_subscription.html.markdown @@ -296,6 +296,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `confirmation_timeout_in_minutes` - (Optional) Integer indicating number of minutes to wait in retrying mode for fetching subscription arn before marking it as failure. Only applicable for http and https protocols. Default is `1`. * `delivery_policy` - (Optional) JSON String with the delivery policy (retries, backoff, etc.) that will be used in the subscription - this only applies to HTTP/S subscriptions. Refer to the [SNS docs](https://docs.aws.amazon.com/sns/latest/dg/DeliveryPolicies.html) for more details. * `endpoint_auto_confirms` - (Optional) Whether the endpoint is capable of [auto confirming subscription](http://docs.aws.amazon.com/sns/latest/dg/SendMessageToHttp.html#SendMessageToHttp.prepare) (e.g., PagerDuty). Default is `false`. @@ -360,4 +361,4 @@ Using `terraform import`, import SNS Topic Subscriptions using the subscription % terraform import aws_sns_topic_subscription.user_updates_sqs_target arn:aws:sns:us-west-2:123456789012:my-topic:8a21d249-4329-4871-acc6-7be709c6ea7f ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/spot_datafeed_subscription.html.markdown b/website/docs/cdktf/python/r/spot_datafeed_subscription.html.markdown index bde9be0ae688..f6648145087b 100644 --- a/website/docs/cdktf/python/r/spot_datafeed_subscription.html.markdown +++ b/website/docs/cdktf/python/r/spot_datafeed_subscription.html.markdown @@ -45,6 +45,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `bucket` - (Required) The Amazon S3 bucket in which to store the Spot instance data feed. * `prefix` - (Optional) Path of folder inside bucket to place spot pricing data. @@ -77,4 +78,4 @@ Using `terraform import`, import a Spot Datafeed Subscription using the word `sp % terraform import aws_spot_datafeed_subscription.mysubscription spot-datafeed-subscription ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/spot_fleet_request.html.markdown b/website/docs/cdktf/python/r/spot_fleet_request.html.markdown index 405e68d7424d..5e512ceebb73 100644 --- a/website/docs/cdktf/python/r/spot_fleet_request.html.markdown +++ b/website/docs/cdktf/python/r/spot_fleet_request.html.markdown @@ -252,6 +252,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `iam_fleet_role` - (Required) Grants the Spot fleet permission to terminate Spot instances on your behalf when you cancel its Spot fleet request using CancelSpotFleetRequests or when the Spot fleet request expires, if you set @@ -492,4 +493,4 @@ Using `terraform import`, import Spot Fleet Requests using `id`. For example: % terraform import aws_spot_fleet_request.fleet sfr-005e9ec8-5546-4c31-b317-31a62325411e ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/spot_instance_request.html.markdown b/website/docs/cdktf/python/r/spot_instance_request.html.markdown index 53996a510d8f..a77eff1ea670 100644 --- a/website/docs/cdktf/python/r/spot_instance_request.html.markdown +++ b/website/docs/cdktf/python/r/spot_instance_request.html.markdown @@ -27,8 +27,8 @@ price availability or by a user. ~> **NOTE:** Because their behavior depends on the live status of the spot market, Spot Instance Requests have a unique lifecycle that makes them behave -differently than other Terraform resources. Most importantly: there is __no -guarantee__ that a Spot Instance exists to fulfill the request at any given +differently than other Terraform resources. Most importantly: there is **no +guarantee** that a Spot Instance exists to fulfill the request at any given point in time. See the [AWS Spot Instance documentation](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-spot-instances.html) for more information. @@ -64,6 +64,8 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). + Spot Instance Requests support all the same arguments as [`aws_instance`](instance.html), with the addition of: * `spot_price` - (Optional; Default: On-demand price) The maximum price to request on the spot market. @@ -74,9 +76,6 @@ Spot Instance Requests support all the same arguments as [`aws_instance`](instan the instance is terminated, the spot request will be closed. * `launch_group` - (Optional) A launch group is a group of spot instances that launch together and terminate together. If left empty instances are launched and terminated individually. -* `block_duration_minutes` - (Optional) The required duration for the Spot instances, in minutes. This value must be a multiple of 60 (60, 120, 180, 240, 300, or 360). - The duration period starts as soon as your Spot instance receives its instance ID. At the end of the duration period, Amazon EC2 marks the Spot instance for termination and provides a Spot instance termination notice, which gives the instance a two-minute warning before it terminates. - Note that you can't specify an Availability Zone group or a launch group if you specify a duration. * `instance_interruption_behavior` - (Optional) Indicates Spot instance behavior when it is interrupted. Valid values are `terminate`, `stop`, or `hibernate`. Default value is `terminate`. * `valid_until` - (Optional) The end date and time of the request, in UTC [RFC3339](https://tools.ietf.org/html/rfc3339#section-5.8) format(for example, YYYY-MM-DDTHH:MM:SSZ). At this point, no new Spot instance requests are placed or enabled to fulfill the request. The default end date is 7 days from the current date. * `valid_from` - (Optional) The start date and time of the request, in UTC [RFC3339](https://tools.ietf.org/html/rfc3339#section-5.8) format(for example, YYYY-MM-DDTHH:MM:SSZ). The default is to start fulfilling the request immediately. @@ -87,9 +86,9 @@ Spot Instance Requests support all the same arguments as [`aws_instance`](instan This resource exports the following attributes in addition to the arguments above: * `id` - The Spot Instance Request ID. +* `tags_all` - A map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). -These attributes are exported, but they are expected to change over time and so -should only be used for informational purposes, not for resource dependencies: +The following attributes are exported, but they are expected to change over time and so should only be used for informational purposes, not for resource dependencies: * `spot_bid_status` - The current [bid status](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-bid-status.html) @@ -106,7 +105,6 @@ should only be used for informational purposes, not for resource dependencies: used inside the Amazon EC2, and only available if you've enabled DNS hostnames for your VPC * `private_ip` - The private IP address assigned to the instance -* `tags_all` - A map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). ## Timeouts @@ -116,4 +114,4 @@ should only be used for informational purposes, not for resource dependencies: * `read` - (Default `15m`) * `delete` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/sqs_queue.html.markdown b/website/docs/cdktf/python/r/sqs_queue.html.markdown index 3f8b77ac028b..8de56e2c546a 100644 --- a/website/docs/cdktf/python/r/sqs_queue.html.markdown +++ b/website/docs/cdktf/python/r/sqs_queue.html.markdown @@ -171,6 +171,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `content_based_deduplication` - (Optional) Enables content-based deduplication for FIFO queues. For more information, see the [related documentation](http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-exactly-once-processing). * `deduplication_scope` - (Optional) Specifies whether message deduplication occurs at the message group or queue level. Valid values are `messageGroup` and `queue` (default). * `delay_seconds` - (Optional) Time in seconds that the delivery of all messages in the queue will be delayed. An integer from 0 to 900 (15 minutes). The default for this attribute is 0 seconds. @@ -178,7 +179,7 @@ This resource supports the following arguments: * `fifo_throughput_limit` - (Optional) Specifies whether the FIFO queue throughput quota applies to the entire queue or per message group. Valid values are `perQueue` (default) and `perMessageGroupId`. * `kms_data_key_reuse_period_seconds` - (Optional) Length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again. An integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). The default is 300 (5 minutes). * `kms_master_key_id` - (Optional) ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see [Key Terms](http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms). -* `max_message_size` - (Optional) Limit of how many bytes a message can contain before Amazon SQS rejects it. An integer from 1024 bytes (1 KiB) up to 262144 bytes (256 KiB). The default for this attribute is 262144 (256 KiB). +* `max_message_size` - (Optional) Limit of how many bytes a message can contain before Amazon SQS rejects it. An integer from 1024 bytes (1 KiB) up to 1048576 bytes (1024 KiB). The default for this attribute is 262144 (256 KiB). * `message_retention_seconds` - (Optional) Number of seconds Amazon SQS retains a message. Integer representing seconds, from 60 (1 minute) to 1209600 (14 days). The default for this attribute is 345600 (4 days). * `name` - (Optional) Name of the queue. Queue names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 80 characters long. For a FIFO (first-in-first-out) queue, the name must end with the `.fifo` suffix. If omitted, Terraform will assign a random, unique name. Conflicts with `name_prefix`. * `name_prefix` - (Optional) Creates a unique name beginning with the specified prefix. Conflicts with `name`. @@ -232,4 +233,4 @@ Using `terraform import`, import SQS Queues using the queue `url`. For example: % terraform import aws_sqs_queue.public_queue https://queue.amazonaws.com/80398EXAMPLE/MyQueue ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/sqs_queue_policy.html.markdown b/website/docs/cdktf/python/r/sqs_queue_policy.html.markdown index 8b53bf32535d..4a902f72e2da 100644 --- a/website/docs/cdktf/python/r/sqs_queue_policy.html.markdown +++ b/website/docs/cdktf/python/r/sqs_queue_policy.html.markdown @@ -119,6 +119,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `policy` - (Required) JSON policy for the SQS queue. For more information about building AWS IAM policy documents with Terraform, see the [AWS IAM Policy Document Guide](https://learn.hashicorp.com/terraform/aws/iam-policy). Ensure that `Version = "2012-10-17"` is set in the policy or AWS may hang in creating the queue. * `queue_url` - (Required) URL of the SQS Queue to which to attach the policy. @@ -151,4 +152,4 @@ Using `terraform import`, import SQS Queue Policies using the queue URL. For exa % terraform import aws_sqs_queue_policy.test https://queue.amazonaws.com/123456789012/myqueue ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/sqs_queue_redrive_allow_policy.html.markdown b/website/docs/cdktf/python/r/sqs_queue_redrive_allow_policy.html.markdown index 4f349de0b79b..e82ceeb234a6 100644 --- a/website/docs/cdktf/python/r/sqs_queue_redrive_allow_policy.html.markdown +++ b/website/docs/cdktf/python/r/sqs_queue_redrive_allow_policy.html.markdown @@ -54,6 +54,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `queue_url` - (Required) The URL of the SQS Queue to which to attach the policy * `redrive_allow_policy` - (Required) The JSON redrive allow policy for the SQS queue. Learn more in the [Amazon SQS dead-letter queues documentation](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html). @@ -86,4 +87,4 @@ Using `terraform import`, import SQS Queue Redrive Allow Policies using the queu % terraform import aws_sqs_queue_redrive_allow_policy.test https://queue.amazonaws.com/123456789012/myqueue ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/sqs_queue_redrive_policy.html.markdown b/website/docs/cdktf/python/r/sqs_queue_redrive_policy.html.markdown index d1360fa5d0bf..88eb9ad49dae 100644 --- a/website/docs/cdktf/python/r/sqs_queue_redrive_policy.html.markdown +++ b/website/docs/cdktf/python/r/sqs_queue_redrive_policy.html.markdown @@ -59,6 +59,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `queue_url` - (Required) The URL of the SQS Queue to which to attach the policy * `redrive_policy` - (Required) The JSON redrive policy for the SQS queue. Accepts two key/val pairs: `deadLetterTargetArn` and `maxReceiveCount`. Learn more in the [Amazon SQS dead-letter queues documentation](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html). @@ -91,4 +92,4 @@ Using `terraform import`, import SQS Queue Redrive Policies using the queue URL. % terraform import aws_sqs_queue_redrive_policy.test https://queue.amazonaws.com/123456789012/myqueue ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ssm_activation.html.markdown b/website/docs/cdktf/python/r/ssm_activation.html.markdown index 046ba4d223bf..d7bf261f5d31 100644 --- a/website/docs/cdktf/python/r/ssm_activation.html.markdown +++ b/website/docs/cdktf/python/r/ssm_activation.html.markdown @@ -62,6 +62,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Optional) The default name of the registered managed instance. * `description` - (Optional) The description of the resource that you want to register. * `expiration_date` - (Optional) UTC timestamp in [RFC3339 format](https://tools.ietf.org/html/rfc3339#section-5.8) by which this activation request should expire. The default value is 24 hours from resource creation time. Terraform will only perform drift detection of its value when present in a configuration. @@ -111,4 +112,4 @@ Using `terraform import`, import AWS SSM Activation using the `id`. For example: -> **Note:** The `activation_code` attribute cannot be imported. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ssm_association.html.markdown b/website/docs/cdktf/python/r/ssm_association.html.markdown index cef1c8349430..1c443ed2f59e 100644 --- a/website/docs/cdktf/python/r/ssm_association.html.markdown +++ b/website/docs/cdktf/python/r/ssm_association.html.markdown @@ -194,7 +194,7 @@ class MyConvertedCode(TerraformStack): Instance(self, "database_server", ami=Token.as_string(amazon_linux.id), iam_instance_profile=ec2_ssm_profile.name, - instance_type=instance_type.string_value, + instance_type="t3.micro", subnet_id=Token.as_string(default_var.id), tags={ "Environment": environment.string_value, @@ -209,7 +209,7 @@ class MyConvertedCode(TerraformStack): Instance(self, "web_server", ami=Token.as_string(amazon_linux.id), iam_instance_profile=ec2_ssm_profile.name, - instance_type=instance_type.string_value, + instance_type="t3.micro", subnet_id=Token.as_string(default_var.id), tags={ "Environment": environment.string_value, @@ -240,13 +240,13 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) The name of the SSM document to apply. * `apply_only_at_cron_interval` - (Optional) By default, when you create a new or update associations, the system runs it immediately and then according to the schedule you specified. Enable this option if you do not want an association to run immediately after you create or update it. This parameter is not supported for rate expressions. Default: `false`. * `association_name` - (Optional) The descriptive name for the association. * `automation_target_parameter_name` - (Optional) Specify the target for the association. This target is required for associations that use an `Automation` document and target resources by using rate controls. This should be set to the SSM document `parameter` that will define how your automation will branch out. * `compliance_severity` - (Optional) The compliance severity for the association. Can be one of the following: `UNSPECIFIED`, `LOW`, `MEDIUM`, `HIGH` or `CRITICAL` * `document_version` - (Optional) The document version you want to associate with the target(s). Can be a specific version or the default version. -* `instance_id` - (Optional, **Deprecated**) The instance ID to apply an SSM document to. Use `targets` with key `InstanceIds` for document schema versions 2.0 and above. Use the `targets` attribute instead. * `max_concurrency` - (Optional) The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%. * `max_errors` - (Optional) The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify a number, for example 10, or a percentage of the target set, for example 10%. If you specify a threshold of 3, the stop command is sent when the fourth error is returned. If you specify a threshold of 10% for 50 associations, the stop command is sent when the sixth error is returned. * `output_location` - (Optional) An output location block. Output Location is documented below. @@ -274,13 +274,38 @@ This resource exports the following attributes in addition to the arguments abov * `arn` - The ARN of the SSM association * `association_id` - The ID of the SSM association. -* `instance_id` - The instance id that the SSM document was applied to. * `name` - The name of the SSM document to apply. * `parameters` - Additional parameters passed to the SSM document. * `tags_all` - A map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). ## Import +In Terraform v1.12.0 and later, the [`import` block](https://developer.hashicorp.com/terraform/language/import) can be used with the `identity` attribute. For example: + +```terraform +import { + to = aws_ssm_association.example + identity = { + association_id = "10abcdef-0abc-1234-5678-90abcdef123456" + } +} + +resource "aws_ssm_association" "example" { + ### Configuration omitted for brevity ### +} +``` + +### Identity Schema + +#### Required + +* `association_id` - (String) ID of the SSM association. + +#### Optional + +- `account_id` (String) AWS Account where this resource is managed. +- `region` (String) Region where this resource is managed. + In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import SSM associations using the `association_id`. For example: ```python @@ -295,13 +320,13 @@ from imports.aws.ssm_association import SsmAssociation class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) - SsmAssociation.generate_config_for_import(self, "testAssociation", "10abcdef-0abc-1234-5678-90abcdef123456") + SsmAssociation.generate_config_for_import(self, "example", "10abcdef-0abc-1234-5678-90abcdef123456") ``` Using `terraform import`, import SSM associations using the `association_id`. For example: ```console -% terraform import aws_ssm_association.test-association 10abcdef-0abc-1234-5678-90abcdef123456 +% terraform import aws_ssm_association.example 10abcdef-0abc-1234-5678-90abcdef123456 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ssm_default_patch_baseline.html.markdown b/website/docs/cdktf/python/r/ssm_default_patch_baseline.html.markdown index b96b0f517cd6..6c40316a986b 100644 --- a/website/docs/cdktf/python/r/ssm_default_patch_baseline.html.markdown +++ b/website/docs/cdktf/python/r/ssm_default_patch_baseline.html.markdown @@ -43,8 +43,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `baseline_id` - (Required) ID of the patch baseline. Can be an ID or an ARN. When specifying an AWS-provided patch baseline, must be the ARN. @@ -143,4 +144,4 @@ Using the operating system value: % terraform import aws_ssm_default_patch_baseline.example CENTOS ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ssm_document.html.markdown b/website/docs/cdktf/python/r/ssm_document.html.markdown index 57ccfa08d940..eaa652400358 100644 --- a/website/docs/cdktf/python/r/ssm_document.html.markdown +++ b/website/docs/cdktf/python/r/ssm_document.html.markdown @@ -64,6 +64,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) The name of the document. * `attachments_source` - (Optional) One or more configuration blocks describing attachments sources to a version of a document. See [`attachments_source` block](#attachments_source-block) below for details. * `content` - (Required) The content for the SSM document in JSON or YAML format. The content of the document must not exceed 64KB. This quota also includes the content specified for input parameters at runtime. We recommend storing the contents for your new document in an external JSON or YAML file and referencing the file in a command. @@ -125,6 +126,32 @@ The `parameter` configuration block provides the following attributes: ## Import +In Terraform v1.12.0 and later, the [`import` block](https://developer.hashicorp.com/terraform/language/import) can be used with the `identity` attribute. For example: + +```terraform +import { + to = aws_ssm_document.example + identity = { + name = "example" + } +} + +resource "aws_ssm_document" "example" { + ### Configuration omitted for brevity ### +} +``` + +### Identity Schema + +#### Required + +* `name` - (String) Name of the SSM document. + +#### Optional + +- `account_id` (String) AWS Account where this resource is managed. +- `region` (String) Region where this resource is managed. + In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import SSM Documents using the name. For example: ```python @@ -178,4 +205,4 @@ class MyConvertedCode(TerraformStack): ) ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ssm_maintenance_window.html.markdown b/website/docs/cdktf/python/r/ssm_maintenance_window.html.markdown index 6ab9249f5860..dda8fa2b4d29 100644 --- a/website/docs/cdktf/python/r/ssm_maintenance_window.html.markdown +++ b/website/docs/cdktf/python/r/ssm_maintenance_window.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) The name of the maintenance window. * `schedule` - (Required) The schedule of the Maintenance Window in the form of a [cron or rate expression](https://docs.aws.amazon.com/systems-manager/latest/userguide/reference-cron-and-rate-expressions.html). * `cutoff` - (Required) The number of hours before the end of the Maintenance Window that Systems Manager stops scheduling new tasks for execution. @@ -60,6 +61,32 @@ This resource exports the following attributes in addition to the arguments abov ## Import +In Terraform v1.12.0 and later, the [`import` block](https://developer.hashicorp.com/terraform/language/import) can be used with the `identity` attribute. For example: + +```terraform +import { + to = aws_ssm_maintenance_window.example + identity = { + id = "mw-0123456789" + } +} + +resource "aws_ssm_maintenance_window" "example" { + ### Configuration omitted for brevity ### +} +``` + +### Identity Schema + +#### Required + +* `id` - (String) ID of the maintenance window. + +#### Optional + +- `account_id` (String) AWS Account where this resource is managed. +- `region` (String) Region where this resource is managed. + In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import SSM Maintenance Windows using the maintenance window `id`. For example: ```python @@ -74,13 +101,13 @@ from imports.aws.ssm_maintenance_window import SsmMaintenanceWindow class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) - SsmMaintenanceWindow.generate_config_for_import(self, "importedWindow", "mw-0123456789") + SsmMaintenanceWindow.generate_config_for_import(self, "example", "mw-0123456789") ``` Using `terraform import`, import SSM Maintenance Windows using the maintenance window `id`. For example: ```console -% terraform import aws_ssm_maintenance_window.imported-window mw-0123456789 +% terraform import aws_ssm_maintenance_window.example mw-0123456789 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ssm_maintenance_window_target.html.markdown b/website/docs/cdktf/python/r/ssm_maintenance_window_target.html.markdown index 140a4ac1abc9..d1e2e7005830 100644 --- a/website/docs/cdktf/python/r/ssm_maintenance_window_target.html.markdown +++ b/website/docs/cdktf/python/r/ssm_maintenance_window_target.html.markdown @@ -86,6 +86,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `window_id` - (Required) The Id of the maintenance window to register the target with. * `name` - (Optional) The name of the maintenance window target. * `description` - (Optional) The description of the maintenance window target. @@ -102,6 +103,34 @@ This resource exports the following attributes in addition to the arguments abov ## Import +In Terraform v1.12.0 and later, the [`import` block](https://developer.hashicorp.com/terraform/language/import) can be used with the `identity` attribute. For example: + +```terraform +import { + to = aws_ssm_maintenance_window_target.example + identity = { + window_id = "mw-0c50858d01EXAMPLE" + id = "23639a0b-ddbc-4bca-9e72-78d96EXAMPLE" + } +} + +resource "aws_ssm_maintenance_window_target" "example" { + ### Configuration omitted for brevity ### +} +``` + +### Identity Schema + +#### Required + +* `window_id` - (String) ID of the maintenance window. +* `id` - (String) ID of the maintenance window target. + +#### Optional + +- `account_id` (String) AWS Account where this resource is managed. +- `region` (String) Region where this resource is managed. + In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import SSM Maintenance Window targets using `WINDOW_ID/WINDOW_TARGET_ID`. For example: ```python @@ -125,4 +154,4 @@ Using `terraform import`, import SSM Maintenance Window targets using `WINDOW_ID % terraform import aws_ssm_maintenance_window_target.example mw-0c50858d01EXAMPLE/23639a0b-ddbc-4bca-9e72-78d96EXAMPLE ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ssm_maintenance_window_task.html.markdown b/website/docs/cdktf/python/r/ssm_maintenance_window_task.html.markdown index cefe0e2b5a9b..edb5324ee6ba 100644 --- a/website/docs/cdktf/python/r/ssm_maintenance_window_task.html.markdown +++ b/website/docs/cdktf/python/r/ssm_maintenance_window_task.html.markdown @@ -175,6 +175,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `window_id` - (Required) The Id of the maintenance window to register the task with. * `max_concurrency` - (Optional) The maximum number of targets this task can be run for in parallel. * `max_errors` - (Optional) The maximum number of errors allowed before this task stops being scheduled. @@ -250,6 +251,34 @@ This resource exports the following attributes in addition to the arguments abov ## Import +In Terraform v1.12.0 and later, the [`import` block](https://developer.hashicorp.com/terraform/language/import) can be used with the `identity` attribute. For example: + +```terraform +import { + to = aws_ssm_maintenance_window_task.example + identity = { + window_id = "mw-0c50858d01EXAMPLE" + id = "4f7ca192-7e9a-40fe-9192-5cb15EXAMPLE" + } +} + +resource "aws_ssm_maintenance_window_task" "example" { + ### Configuration omitted for brevity ### +} +``` + +### Identity Schema + +#### Required + +* `window_id` - (String) ID of the maintenance window. +* `id` - (String) ID of the maintenance window task. + +#### Optional + +- `account_id` (String) AWS Account where this resource is managed. +- `region` (String) Region where this resource is managed. + In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import AWS Maintenance Window Task using the `window_id` and `window_task_id` separated by `/`. For example: ```python @@ -264,13 +293,13 @@ from imports.aws.ssm_maintenance_window_task import SsmMaintenanceWindowTask class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) - SsmMaintenanceWindowTask.generate_config_for_import(self, "task", "/") + SsmMaintenanceWindowTask.generate_config_for_import(self, "example", "/") ``` Using `terraform import`, import AWS Maintenance Window Task using the `window_id` and `window_task_id` separated by `/`. For example: ```console -% terraform import aws_ssm_maintenance_window_task.task / +% terraform import aws_ssm_maintenance_window_task.example / ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ssm_parameter.html.markdown b/website/docs/cdktf/python/r/ssm_parameter.html.markdown index b8bb77ca8d3c..e0f4e3bb5743 100644 --- a/website/docs/cdktf/python/r/ssm_parameter.html.markdown +++ b/website/docs/cdktf/python/r/ssm_parameter.html.markdown @@ -14,7 +14,7 @@ Provides an SSM Parameter resource. ~> **Note:** The `overwrite` argument makes it possible to overwrite an existing SSM Parameter created outside of Terraform. --> **Note:** Write-Only argument `value_wo` is available to use in place of `value`. Write-Only arguments are supported in HashiCorp Terraform 1.11.0 and later. [Learn more](https://developer.hashicorp.com/terraform/language/v1.11.x/resources/ephemeral#write-only-arguments). +-> **Note:** Write-Only argument `value_wo` is available to use in place of `value`. Write-Only arguments are supported in HashiCorp Terraform 1.11.0 and later. [Learn more](https://developer.hashicorp.com/terraform/language/resources/ephemeral#write-only-arguments). ## Example Usage @@ -89,6 +89,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `allowed_pattern` - (Optional) Regular expression used to validate the parameter value. * `data_type` - (Optional) Data type of the parameter. Valid values: `text`, `aws:ssm:integration` and `aws:ec2:image` for AMI format, see the [Native parameter support for Amazon Machine Image IDs](https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-ec2-aliases.html). * `description` - (Optional) Description of the parameter. @@ -114,6 +115,32 @@ This resource exports the following attributes in addition to the arguments abov ## Import +In Terraform v1.12.0 and later, the [`import` block](https://developer.hashicorp.com/terraform/language/import) can be used with the `identity` attribute. For example: + +```terraform +import { + to = aws_ssm_parameter.example + identity = { + name = "/my_path/my_paramname" + } +} + +resource "aws_ssm_parameter" "example" { + ### Configuration omitted for brevity ### +} +``` + +### Identity Schema + +#### Required + +* `name` - (String) Name of the parameter. + +#### Optional + +- `account_id` (String) AWS Account where this resource is managed. +- `region` (String) Region where this resource is managed. + In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import SSM Parameters using the parameter store `name`. For example: ```python @@ -128,13 +155,13 @@ from imports.aws.ssm_parameter import SsmParameter class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) - SsmParameter.generate_config_for_import(self, "myParam", "/my_path/my_paramname") + SsmParameter.generate_config_for_import(self, "example", "/my_path/my_paramname") ``` Using `terraform import`, import SSM Parameters using the parameter store `name`. For example: ```console -% terraform import aws_ssm_parameter.my_param /my_path/my_paramname +% terraform import aws_ssm_parameter.example /my_path/my_paramname ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ssm_patch_baseline.html.markdown b/website/docs/cdktf/python/r/ssm_patch_baseline.html.markdown index d45bcb545ae3..0fc03e9d60ed 100644 --- a/website/docs/cdktf/python/r/ssm_patch_baseline.html.markdown +++ b/website/docs/cdktf/python/r/ssm_patch_baseline.html.markdown @@ -178,10 +178,12 @@ The following arguments are required: The following arguments are optional: +* `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). * `approval_rule` - (Optional) Set of rules used to include patches in the baseline. Up to 10 approval rules can be specified. See [`approval_rule`](#approval_rule-block) below. * `approved_patches_compliance_level` - (Optional) Compliance level for approved patches. This means that if an approved patch is reported as missing, this is the severity of the compliance violation. Valid values are `CRITICAL`, `HIGH`, `MEDIUM`, `LOW`, `INFORMATIONAL`, `UNSPECIFIED`. The default value is `UNSPECIFIED`. * `approved_patches_enable_non_security` - (Optional) Whether the list of approved patches includes non-security updates that should be applied to the instances. Applies to Linux instances only. * `approved_patches` - (Optional) List of explicitly approved patches for the baseline. Cannot be specified with `approval_rule`. +* `available_security_updates_compliance_status` - (Optional) Indicates the compliance status of managed nodes for which security-related patches are available but were not approved. Supported for Windows Server managed nodes only. Valid values are `COMPLIANT`, `NON_COMPLIANT`. * `description` - (Optional) Description of the patch baseline. * `global_filter` - (Optional) Set of global filters used to exclude patches from the baseline. Up to 4 global filters can be specified using Key/Value pairs. Valid Keys are `PRODUCT`, `CLASSIFICATION`, `MSRC_SEVERITY`, and `PATCH_ID`. * `operating_system` - (Optional) Operating system the patch baseline applies to. Valid values are `ALMA_LINUX`, `AMAZON_LINUX`, `AMAZON_LINUX_2`, `AMAZON_LINUX_2022`, `AMAZON_LINUX_2023`, `CENTOS`, `DEBIAN`, `MACOS`, `ORACLE_LINUX`, `RASPBIAN`, `REDHAT_ENTERPRISE_LINUX`, `ROCKY_LINUX`, `SUSE`, `UBUNTU`, and `WINDOWS`. The default value is `WINDOWS`. @@ -219,6 +221,32 @@ This resource exports the following attributes in addition to the arguments abov ## Import +In Terraform v1.12.0 and later, the [`import` block](https://developer.hashicorp.com/terraform/language/import) can be used with the `identity` attribute. For example: + +```terraform +import { + to = aws_ssm_patch_baseline.example + identity = { + id = "pb-12345678" + } +} + +resource "aws_ssm_patch_baseline" "example" { + ### Configuration omitted for brevity ### +} +``` + +### Identity Schema + +#### Required + +* `id` - (String) ID of the patch baseline. + +#### Optional + +- `account_id` (String) AWS Account where this resource is managed. +- `region` (String) Region where this resource is managed. + In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import SSM Patch Baselines using their baseline ID. For example: ```python @@ -242,4 +270,4 @@ Using `terraform import`, import SSM Patch Baselines using their baseline ID. Fo % terraform import aws_ssm_patch_baseline.example pb-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ssm_patch_group.html.markdown b/website/docs/cdktf/python/r/ssm_patch_group.html.markdown index a5cd4adf3cad..14cd119c0dcc 100644 --- a/website/docs/cdktf/python/r/ssm_patch_group.html.markdown +++ b/website/docs/cdktf/python/r/ssm_patch_group.html.markdown @@ -41,6 +41,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `baseline_id` - (Required) The ID of the patch baseline to register the patch group with. * `patch_group` - (Required) The name of the patch group that should be registered with the patch baseline. @@ -50,4 +51,4 @@ This resource exports the following attributes in addition to the arguments abov * `id` - The name of the patch group and ID of the patch baseline separated by a comma (`,`). - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ssm_resource_data_sync.html.markdown b/website/docs/cdktf/python/r/ssm_resource_data_sync.html.markdown index 37679013c0c1..3d1b152ede9c 100644 --- a/website/docs/cdktf/python/r/ssm_resource_data_sync.html.markdown +++ b/website/docs/cdktf/python/r/ssm_resource_data_sync.html.markdown @@ -83,6 +83,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) Name for the configuration. * `s3_destination` - (Required) Amazon S3 configuration details for the sync. @@ -125,4 +126,4 @@ Using `terraform import`, import SSM resource data sync using the `name`. For ex % terraform import aws_ssm_resource_data_sync.example example-name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ssm_service_setting.html.markdown b/website/docs/cdktf/python/r/ssm_service_setting.html.markdown index 2efdf572a782..bc41a89934f7 100644 --- a/website/docs/cdktf/python/r/ssm_service_setting.html.markdown +++ b/website/docs/cdktf/python/r/ssm_service_setting.html.markdown @@ -36,7 +36,8 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: -* `setting_id` - (Required) ID of the service setting. +* `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). +* `setting_id` - (Required) ID of the service setting. Valid values are shown in the [AWS documentation](https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_GetServiceSetting.html#API_GetServiceSetting_RequestSyntax). * `setting_value` - (Required) Value of the service setting. ## Attribute Reference @@ -71,4 +72,4 @@ Using `terraform import`, import AWS SSM Service Setting using the `setting_id`. % terraform import aws_ssm_service_setting.example arn:aws:ssm:us-east-1:123456789012:servicesetting/ssm/parameter-store/high-throughput-enabled ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ssmcontacts_contact.html.markdown b/website/docs/cdktf/python/r/ssmcontacts_contact.html.markdown index ea4387a63ae0..df3b7551d629 100644 --- a/website/docs/cdktf/python/r/ssmcontacts_contact.html.markdown +++ b/website/docs/cdktf/python/r/ssmcontacts_contact.html.markdown @@ -72,8 +72,9 @@ The following arguments are required: The following arguments are optional: +- `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). - `display_name` - (Optional) Full friendly name of the contact or escalation plan. If set, must be between 1 and 255 characters, and may contain alphanumerics, underscores (`_`), hyphens (`-`), periods (`.`), and spaces. -- `tags` - (Optional) Map of tags to assign to the resource. +- `tags` - (Optional) Key-value tags for the monitor. 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. ## Attribute Reference @@ -107,4 +108,4 @@ Using `terraform import`, import SSM Contact using the `ARN`. For example: % terraform import aws_ssmcontacts_contact.example {ARNValue} ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ssmcontacts_contact_channel.html.markdown b/website/docs/cdktf/python/r/ssmcontacts_contact_channel.html.markdown index 8c587e304180..a92192cb6878 100644 --- a/website/docs/cdktf/python/r/ssmcontacts_contact_channel.html.markdown +++ b/website/docs/cdktf/python/r/ssmcontacts_contact_channel.html.markdown @@ -71,8 +71,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +- `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). - `contact_id` - (Required) Amazon Resource Name (ARN) of the AWS SSM Contact that the contact channel belongs to. - `delivery_address` - (Required) Block that contains contact engagement details. See details below. - `name` - (Required) Name of the contact channel. Must be between 1 and 255 characters, and may contain alphanumerics, underscores (`_`), hyphens (`-`), periods (`.`), and spaces. @@ -114,4 +115,4 @@ Using `terraform import`, import SSM Contact Channel using the `ARN`. For exampl % terraform import aws_ssmcontacts_contact_channel.example arn:aws:ssm-contacts:us-west-2:123456789012:contact-channel/example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ssmcontacts_plan.html.markdown b/website/docs/cdktf/python/r/ssmcontacts_plan.html.markdown index 8c3992534c68..b00cba30f7b8 100644 --- a/website/docs/cdktf/python/r/ssmcontacts_plan.html.markdown +++ b/website/docs/cdktf/python/r/ssmcontacts_plan.html.markdown @@ -120,8 +120,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +- `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). - `contact_id` - (Required) The Amazon Resource Name (ARN) of the contact or escalation plan. - `stage` - (Required) One or more configuration blocks for specifying a list of stages that the escalation plan or engagement plan uses to engage contacts and contact methods. See [Stage](#stage) below for more details. @@ -190,4 +191,4 @@ Using `terraform import`, import SSM Contact Plan using the Contact ARN. For exa % terraform import aws_ssmcontacts_plan.example {ARNValue} ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ssmcontacts_rotation.html.markdown b/website/docs/cdktf/python/r/ssmcontacts_rotation.html.markdown index 72049238aa7f..4229669f7798 100644 --- a/website/docs/cdktf/python/r/ssmcontacts_rotation.html.markdown +++ b/website/docs/cdktf/python/r/ssmcontacts_rotation.html.markdown @@ -167,6 +167,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `start_time` - (Optional) The date and time, in RFC 3339 format, that the rotation goes into effect. * `tags` - (Optional) A 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. @@ -241,4 +242,4 @@ Using `terraform import`, import CodeGuru Profiler Profiling Group using the `ar % terraform import aws_ssmcontacts_rotation.example arn:aws:ssm-contacts:us-east-1:012345678910:rotation/example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ssmincidents_replication_set.html.markdown b/website/docs/cdktf/python/r/ssmincidents_replication_set.html.markdown index 18079f9b56e0..f3d0c2344124 100644 --- a/website/docs/cdktf/python/r/ssmincidents_replication_set.html.markdown +++ b/website/docs/cdktf/python/r/ssmincidents_replication_set.html.markdown @@ -33,7 +33,7 @@ class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) SsmincidentsReplicationSet(self, "replicationSetName", - region=[SsmincidentsReplicationSetRegion( + regions=[SsmincidentsReplicationSetRegions( name="us-west-2" ) ], @@ -58,9 +58,9 @@ class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) SsmincidentsReplicationSet(self, "replicationSetName", - region=[SsmincidentsReplicationSetRegion( + regions=[SsmincidentsReplicationSetRegions( name="us-west-2" - ), SsmincidentsReplicationSetRegion( + ), SsmincidentsReplicationSetRegions( name="ap-southeast-2" ) ] @@ -82,7 +82,7 @@ class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) SsmincidentsReplicationSet(self, "replicationSetName", - region=[SsmincidentsReplicationSetRegion( + regions=[SsmincidentsReplicationSetRegions( name="us-west-2" ) ] @@ -108,7 +108,7 @@ class MyConvertedCode(TerraformStack): super().__init__(scope, name) example_key = KmsKey(self, "example_key") SsmincidentsReplicationSet(self, "replicationSetName", - region=[SsmincidentsReplicationSetRegion( + regions=[SsmincidentsReplicationSetRegions( kms_key_arn=example_key.arn, name="us-west-2" ) @@ -123,7 +123,8 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: -* `region` - (Required) The Regions that Incident Manager replicates your data to. You can have up to three Regions in your replication set. +* `region` - (Optional, **Deprecated**) The replication set's Regions. Use `regions` instead. +* `regions` - (Optional) The replication set's Regions. * `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. For information about the maximum allowed number of Regions and tag value constraints, see [CreateReplicationSet in the *AWS Systems Manager Incident Manager API Reference*](https://docs.aws.amazon.com/incident-manager/latest/APIReference/API_CreateReplicationSet.html). @@ -138,7 +139,7 @@ For information about the maximum allowed number of Regions and tag value constr ~> **NOTE:** If possible, create all the customer managed keys you need (using the `terraform apply` command) before you create the replication set, or create the keys and replication set in the same `terraform apply` command. Otherwise, to delete a replication set, you must run one `terraform apply` command to delete the replication set and another to delete the AWS KMS keys used by the replication set. Deleting the AWS KMS keys before deleting the replication set results in an error. In that case, you must manually reenable the deleted key using the AWS Management Console before you can delete the replication set. -The `region` configuration block supports the following arguments: +The `regions` configuration block supports the following arguments: * `name` - (Required) The name of the Region, such as `ap-southeast-2`. * `kms_key_arn` - (Optional) The Amazon Resource name (ARN) of the customer managed key. If omitted, AWS manages the AWS KMS keys for you, using an AWS owned key, as indicated by a default value of `DefaultKey`. @@ -157,7 +158,7 @@ This resource exports the following attributes in addition to the arguments abov * `status` - The overall status of a replication set. * Valid Values: `ACTIVE` | `CREATING` | `UPDATING` | `DELETING` | `FAILED` -In addition to the preceding arguments, the `region` configuration block exports the following attributes for each Region: +In addition to the preceding arguments, the `regions` configuration block exports the following attributes for each Region: * `status` - The current status of the Region. * Valid Values: `ACTIVE` | `CREATING` | `UPDATING` | `DELETING` | `FAILED` @@ -201,4 +202,4 @@ Using `terraform import`, import an Incident Manager replication. For example: % terraform import aws_ssmincidents_replication_set.replicationSetName import ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ssmincidents_response_plan.html.markdown b/website/docs/cdktf/python/r/ssmincidents_response_plan.html.markdown index e0aeae054af8..7f8014199a5e 100644 --- a/website/docs/cdktf/python/r/ssmincidents_response_plan.html.markdown +++ b/website/docs/cdktf/python/r/ssmincidents_response_plan.html.markdown @@ -118,6 +118,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) The name of the response plan. * `incident_template` - (Required) The `incident_template` configuration block is required and supports the following arguments: * `title` - (Required) The title of a generated incident. @@ -186,4 +187,4 @@ Using `terraform import`, import an Incident Manager response plan using the res % terraform import aws_ssmincidents_response_plan.responsePlanName ARNValue ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ssmquicksetup_configuration_manager.html.markdown b/website/docs/cdktf/python/r/ssmquicksetup_configuration_manager.html.markdown index 157bd38cfadc..1e0dab28847a 100644 --- a/website/docs/cdktf/python/r/ssmquicksetup_configuration_manager.html.markdown +++ b/website/docs/cdktf/python/r/ssmquicksetup_configuration_manager.html.markdown @@ -53,14 +53,14 @@ class MyConvertedCode(TerraformStack): "ConfigurationOptionsScanValue": "cron(0 1 * * ? *)", "IsPolicyAttachAllowed": "false", "OutputLogEnableS3": "false", - "PatchBaselineRegion": Token.as_string(data_aws_region_current.name), + "PatchBaselineRegion": Token.as_string(data_aws_region_current.region), "PatchBaselineUseDefault": "default", "PatchPolicyName": "example", "RateControlConcurrency": "10%", "RateControlErrorThreshold": "2%", "SelectedPatchBaselines": selected_patch_baselines, "TargetAccounts": Token.as_string(current.account_id), - "TargetRegions": Token.as_string(data_aws_region_current.name), + "TargetRegions": Token.as_string(data_aws_region_current.region), "TargetType": "*" }, type="AWSQuickSetupType-PatchPolicy" @@ -81,6 +81,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `description` - (Optional) Description of the configuration manager. * `tags` - (Optional) Map of tags assigned to the resource. If configured with a provider [`default_tags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. @@ -139,4 +140,4 @@ Using `terraform import`, import SSM Quick Setup Configuration Manager using the % terraform import aws_ssmquicksetup_configuration_manager.example arn:aws:ssm-quicksetup:us-east-1:012345678901:configuration-manager/abcd-1234 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ssoadmin_account_assignment.html.markdown b/website/docs/cdktf/python/r/ssoadmin_account_assignment.html.markdown index d4cc06175b4b..f93c2275e42c 100644 --- a/website/docs/cdktf/python/r/ssoadmin_account_assignment.html.markdown +++ b/website/docs/cdktf/python/r/ssoadmin_account_assignment.html.markdown @@ -126,6 +126,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `instance_arn` - (Required, Forces new resource) The Amazon Resource Name (ARN) of the SSO Instance. * `permission_set_arn` - (Required, Forces new resource) The Amazon Resource Name (ARN) of the Permission Set that the admin wants to grant the principal access to. * `principal_id` - (Required, Forces new resource) An identifier for an object in SSO, such as a user or group. PrincipalIds are GUIDs (For example, `f81d4fae-7dec-11d0-a765-00a0c91e6bf6`). @@ -171,4 +172,4 @@ Using `terraform import`, import SSO Account Assignments using the `principal_id % terraform import aws_ssoadmin_account_assignment.example f81d4fae-7dec-11d0-a765-00a0c91e6bf6,GROUP,1234567890,AWS_ACCOUNT,arn:aws:sso:::permissionSet/ssoins-0123456789abcdef/ps-0123456789abcdef,arn:aws:sso:::instance/ssoins-0123456789abcdef ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ssoadmin_application.html.markdown b/website/docs/cdktf/python/r/ssoadmin_application.html.markdown index aeca43b1434b..2eee1be1c042 100644 --- a/website/docs/cdktf/python/r/ssoadmin_application.html.markdown +++ b/website/docs/cdktf/python/r/ssoadmin_application.html.markdown @@ -88,6 +88,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `client_token` - (Optional) A unique, case-sensitive ID that you provide to ensure the idempotency of the request. AWS generates a random value when not provided. * `description` - (Optional) Description of the application. * `portal_options` - (Optional) Options for the portal associated with an application. See [`portal_options`](#portal_options-argument-reference) below. @@ -112,8 +113,9 @@ If `IDENTITY_CENTER` is set, IAM Identity Center uses SAML identity-provider ini This resource exports the following attributes in addition to the arguments above: * `application_account` - AWS account ID. -* `application_arn` - ARN of the application. -* `id` - ARN of the application. +* `application_arn` - (**Deprecated** Reference `arn` instead) ARN of the application. +* `arn` - ARN of the application. +* `id` - (**Deprecated** Reference `arn` instead) ARN of the application. * `tags_all` - Map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block). ## Import @@ -141,4 +143,4 @@ Using `terraform import`, import SSO Admin Application using the `id`. For examp % terraform import aws_ssoadmin_application.example arn:aws:sso::123456789012:application/id-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ssoadmin_application_access_scope.html.markdown b/website/docs/cdktf/python/r/ssoadmin_application_access_scope.html.markdown index c7b36e531e3b..dd178f911775 100644 --- a/website/docs/cdktf/python/r/ssoadmin_application_access_scope.html.markdown +++ b/website/docs/cdktf/python/r/ssoadmin_application_access_scope.html.markdown @@ -40,7 +40,7 @@ class MyConvertedCode(TerraformStack): aws_ssoadmin_application_example.override_logical_id("example") aws_ssoadmin_application_access_scope_example = SsoadminApplicationAccessScope(self, "example_2", - application_arn=Token.as_string(aws_ssoadmin_application_example.application_arn), + application_arn=Token.as_string(aws_ssoadmin_application_example.arn), authorized_targets=["arn:aws:sso::123456789012:application/ssoins-123456789012/apl-123456789012" ], scope="sso:account:access" @@ -58,6 +58,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `authorized_targets` - (Optional) Specifies an array list of ARNs that represent the authorized targets for this access scope. ## Attribute Reference @@ -91,4 +92,4 @@ Using `terraform import`, import SSO Admin Application Access Scope using the `i % terraform import aws_ssoadmin_application_access_scope.example arn:aws:sso::123456789012:application/ssoins-123456789012/apl-123456789012,sso:account:access ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ssoadmin_application_assignment.html.markdown b/website/docs/cdktf/python/r/ssoadmin_application_assignment.html.markdown index 528ee1479eca..63a86b99f903 100644 --- a/website/docs/cdktf/python/r/ssoadmin_application_assignment.html.markdown +++ b/website/docs/cdktf/python/r/ssoadmin_application_assignment.html.markdown @@ -28,7 +28,7 @@ class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) SsoadminApplicationAssignment(self, "example", - application_arn=Token.as_string(aws_ssoadmin_application_example.application_arn), + application_arn=Token.as_string(aws_ssoadmin_application_example.arn), principal_id=Token.as_string(aws_identitystore_user_example.user_id), principal_type="USER" ) @@ -49,7 +49,7 @@ class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) SsoadminApplicationAssignment(self, "example", - application_arn=Token.as_string(aws_ssoadmin_application_example.application_arn), + application_arn=Token.as_string(aws_ssoadmin_application_example.arn), principal_id=Token.as_string(aws_identitystore_group_example.group_id), principal_type="GROUP" ) @@ -57,8 +57,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `application_arn` - (Required) ARN of the application. * `principal_id` - (Required) An identifier for an object in IAM Identity Center, such as a user or group. * `principal_type` - (Required) Entity type for which the assignment will be created. Valid values are `USER` or `GROUP`. @@ -94,4 +95,4 @@ Using `terraform import`, import SSO Admin Application Assignment using the `id` % terraform import aws_ssoadmin_application_assignment.example arn:aws:sso::123456789012:application/id-12345678,abcd1234,USER ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ssoadmin_application_assignment_configuration.html.markdown b/website/docs/cdktf/python/r/ssoadmin_application_assignment_configuration.html.markdown index eeb35f51d8f0..0d773abc3df4 100644 --- a/website/docs/cdktf/python/r/ssoadmin_application_assignment_configuration.html.markdown +++ b/website/docs/cdktf/python/r/ssoadmin_application_assignment_configuration.html.markdown @@ -33,15 +33,16 @@ class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) SsoadminApplicationAssignmentConfiguration(self, "example", - application_arn=Token.as_string(aws_ssoadmin_application_example.application_arn), + application_arn=Token.as_string(aws_ssoadmin_application_example.arn), assignment_required=True ) ``` ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `application_arn` - (Required) ARN of the application. * `assignment_required` - (Required) Indicates whether users must have an explicit assignment to access the application. If `false`, all users have access to the application. @@ -76,4 +77,4 @@ Using `terraform import`, import SSO Admin Application Assignment Configuration % terraform import aws_ssoadmin_application_assignment_configuration.example arn:aws:sso::123456789012:application/id-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ssoadmin_customer_managed_policy_attachment.html.markdown b/website/docs/cdktf/python/r/ssoadmin_customer_managed_policy_attachment.html.markdown index 2771400ad4c8..36d66c175889 100644 --- a/website/docs/cdktf/python/r/ssoadmin_customer_managed_policy_attachment.html.markdown +++ b/website/docs/cdktf/python/r/ssoadmin_customer_managed_policy_attachment.html.markdown @@ -73,6 +73,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `instance_arn` - (Required, Forces new resource) The Amazon Resource Name (ARN) of the SSO Instance under which the operation will be executed. * `permission_set_arn` - (Required, Forces new resource) The Amazon Resource Name (ARN) of the Permission Set. * `customer_managed_policy_reference` - (Required, Forces new resource) Specifies the name and path of a customer managed policy. See below. @@ -122,4 +123,4 @@ Using `terraform import`, import SSO Managed Policy Attachments using the `name` % terraform import aws_ssoadmin_customer_managed_policy_attachment.example TestPolicy,/,arn:aws:sso:::permissionSet/ssoins-2938j0x8920sbj72/ps-80383020jr9302rk,arn:aws:sso:::instance/ssoins-2938j0x8920sbj72 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ssoadmin_instance_access_control_attributes.html.markdown b/website/docs/cdktf/python/r/ssoadmin_instance_access_control_attributes.html.markdown index 953dbe619120..89fe84309ab3 100644 --- a/website/docs/cdktf/python/r/ssoadmin_instance_access_control_attributes.html.markdown +++ b/website/docs/cdktf/python/r/ssoadmin_instance_access_control_attributes.html.markdown @@ -55,6 +55,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `instance_arn` - (Required, Forces new resource) The Amazon Resource Name (ARN) of the SSO Instance. * `attribute` - (Required) See [AccessControlAttribute](#accesscontrolattribute) for more details. @@ -98,4 +99,4 @@ Using `terraform import`, import SSO Account Assignments using the `instance_arn % terraform import aws_ssoadmin_instance_access_control_attributes.example arn:aws:sso:::instance/ssoins-0123456789abcdef ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ssoadmin_managed_policy_attachment.html.markdown b/website/docs/cdktf/python/r/ssoadmin_managed_policy_attachment.html.markdown index b1294b521e56..d332cb026b62 100644 --- a/website/docs/cdktf/python/r/ssoadmin_managed_policy_attachment.html.markdown +++ b/website/docs/cdktf/python/r/ssoadmin_managed_policy_attachment.html.markdown @@ -114,6 +114,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `instance_arn` - (Required, Forces new resource) The Amazon Resource Name (ARN) of the SSO Instance under which the operation will be executed. * `managed_policy_arn` - (Required, Forces new resource) The IAM managed policy Amazon Resource Name (ARN) to be attached to the Permission Set. * `permission_set_arn` - (Required, Forces new resource) The Amazon Resource Name (ARN) of the Permission Set. @@ -157,4 +158,4 @@ Using `terraform import`, import SSO Managed Policy Attachments using the `manag % terraform import aws_ssoadmin_managed_policy_attachment.example arn:aws:iam::aws:policy/AlexaForBusinessDeviceSetup,arn:aws:sso:::permissionSet/ssoins-2938j0x8920sbj72/ps-80383020jr9302rk,arn:aws:sso:::instance/ssoins-2938j0x8920sbj72 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ssoadmin_permission_set.html.markdown b/website/docs/cdktf/python/r/ssoadmin_permission_set.html.markdown index 8e03a04b3487..1831655d829c 100644 --- a/website/docs/cdktf/python/r/ssoadmin_permission_set.html.markdown +++ b/website/docs/cdktf/python/r/ssoadmin_permission_set.html.markdown @@ -46,6 +46,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `description` - (Optional) The description of the Permission Set. * `instance_arn` - (Required, Forces new resource) The Amazon Resource Name (ARN) of the SSO Instance under which the operation will be executed. * `name` - (Required, Forces new resource) The name of the Permission Set. @@ -93,4 +94,4 @@ Using `terraform import`, import SSO Permission Sets using the `arn` and `instan % terraform import aws_ssoadmin_permission_set.example arn:aws:sso:::permissionSet/ssoins-2938j0x8920sbj72/ps-80383020jr9302rk,arn:aws:sso:::instance/ssoins-2938j0x8920sbj72 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ssoadmin_permission_set_inline_policy.html.markdown b/website/docs/cdktf/python/r/ssoadmin_permission_set_inline_policy.html.markdown index 3f15670a25db..565bff3c3619 100644 --- a/website/docs/cdktf/python/r/ssoadmin_permission_set_inline_policy.html.markdown +++ b/website/docs/cdktf/python/r/ssoadmin_permission_set_inline_policy.html.markdown @@ -69,6 +69,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `inline_policy` - (Required) The IAM inline policy to attach to a Permission Set. * `instance_arn` - (Required, Forces new resource) The Amazon Resource Name (ARN) of the SSO Instance under which the operation will be executed. * `permission_set_arn` - (Required, Forces new resource) The Amazon Resource Name (ARN) of the Permission Set. @@ -111,4 +112,4 @@ Using `terraform import`, import SSO Permission Set Inline Policies using the `p % terraform import aws_ssoadmin_permission_set_inline_policy.example arn:aws:sso:::permissionSet/ssoins-2938j0x8920sbj72/ps-80383020jr9302rk,arn:aws:sso:::instance/ssoins-2938j0x8920sbj72 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ssoadmin_permissions_boundary_attachment.html.markdown b/website/docs/cdktf/python/r/ssoadmin_permissions_boundary_attachment.html.markdown index e6a62dd53a1c..d90143033467 100644 --- a/website/docs/cdktf/python/r/ssoadmin_permissions_boundary_attachment.html.markdown +++ b/website/docs/cdktf/python/r/ssoadmin_permissions_boundary_attachment.html.markdown @@ -98,8 +98,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `instance_arn` - (Required, Forces new resource) The Amazon Resource Name (ARN) of the SSO Instance under which the operation will be executed. * `permission_set_arn` - (Required, Forces new resource) The Amazon Resource Name (ARN) of the Permission Set. * `permissions_boundary` - (Required, Forces new resource) The permissions boundary policy. See below. @@ -156,4 +157,4 @@ Using `terraform import`, import SSO Admin Permissions Boundary Attachments usin % terraform import aws_ssoadmin_permissions_boundary_attachment.example arn:aws:sso:::permissionSet/ssoins-2938j0x8920sbj72/ps-80383020jr9302rk,arn:aws:sso:::instance/ssoins-2938j0x8920sbj72 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/ssoadmin_trusted_token_issuer.html.markdown b/website/docs/cdktf/python/r/ssoadmin_trusted_token_issuer.html.markdown index 2dfd66e46e69..213efe759f76 100644 --- a/website/docs/cdktf/python/r/ssoadmin_trusted_token_issuer.html.markdown +++ b/website/docs/cdktf/python/r/ssoadmin_trusted_token_issuer.html.markdown @@ -60,6 +60,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `client_token` - (Optional) A unique, case-sensitive ID that you provide to ensure the idempotency of the request. AWS generates a random value when not provided. * `tags` - (Optional) Key-value mapping of resource tags. If configured with a provider [`default_tags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. @@ -107,4 +108,4 @@ Using `terraform import`, import SSO Admin Trusted Token Issuer using the `id`. % terraform import aws_ssoadmin_trusted_token_issuer.example arn:aws:sso::123456789012:trustedTokenIssuer/ssoins-lu1ye3gew4mbc7ju/tti-2657c556-9707-11ee-b9d1-0242ac120002 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/storagegateway_cache.html.markdown b/website/docs/cdktf/python/r/storagegateway_cache.html.markdown index cfcd704c4f48..7d2cee0e5316 100644 --- a/website/docs/cdktf/python/r/storagegateway_cache.html.markdown +++ b/website/docs/cdktf/python/r/storagegateway_cache.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `disk_id` - (Required) Local disk identifier. For example, `pci-0000:03:00.0-scsi-0:0:0:0`. * `gateway_arn` - (Required) The Amazon Resource Name (ARN) of the gateway. @@ -72,4 +73,4 @@ Using `terraform import`, import `aws_storagegateway_cache` using the gateway Am % terraform import aws_storagegateway_cache.example arn:aws:storagegateway:us-east-1:123456789012:gateway/sgw-12345678:pci-0000:03:00.0-scsi-0:0:0:0 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/storagegateway_cached_iscsi_volume.html.markdown b/website/docs/cdktf/python/r/storagegateway_cached_iscsi_volume.html.markdown index 23237a0a3514..5a81fea8662b 100644 --- a/website/docs/cdktf/python/r/storagegateway_cached_iscsi_volume.html.markdown +++ b/website/docs/cdktf/python/r/storagegateway_cached_iscsi_volume.html.markdown @@ -94,6 +94,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `gateway_arn` - (Required) The Amazon Resource Name (ARN) of the gateway. * `network_interface_id` - (Required) The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted. * `target_name` - (Required) The name of the iSCSI target used by initiators to connect to the target and as a suffix for the target ARN. The target name must be unique across all volumes of a gateway. @@ -143,4 +144,4 @@ Using `terraform import`, import `aws_storagegateway_cached_iscsi_volume` using % terraform import aws_storagegateway_cached_iscsi_volume.example arn:aws:storagegateway:us-east-1:123456789012:gateway/sgw-12345678/volume/vol-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/storagegateway_file_system_association.html.markdown b/website/docs/cdktf/python/r/storagegateway_file_system_association.html.markdown index cc0606a39a66..75d8bc8b9dd4 100644 --- a/website/docs/cdktf/python/r/storagegateway_file_system_association.html.markdown +++ b/website/docs/cdktf/python/r/storagegateway_file_system_association.html.markdown @@ -105,6 +105,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `gateway_arn` - (Required) The Amazon Resource Name (ARN) of the gateway. * `location_arn` - (Required) The Amazon Resource Name (ARN) of the Amazon FSx file system to associate with the FSx File Gateway. * `username` - (Required) The user name of the user credential that has permission to access the root share of the Amazon FSx file system. The user account must belong to the Amazon FSx delegated admin user group. @@ -160,4 +161,4 @@ Using `terraform import`, import `aws_storagegateway_file_system_association` us % terraform import aws_storagegateway_file_system_association.example arn:aws:storagegateway:us-east-1:123456789012:fs-association/fsa-0DA347732FDB40125 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/storagegateway_gateway.html.markdown b/website/docs/cdktf/python/r/storagegateway_gateway.html.markdown index 28f8cc497edf..a22dff633716 100644 --- a/website/docs/cdktf/python/r/storagegateway_gateway.html.markdown +++ b/website/docs/cdktf/python/r/storagegateway_gateway.html.markdown @@ -173,6 +173,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `gateway_name` - (Required) Name of the gateway. * `gateway_timezone` - (Required) Time zone for the gateway. The time zone is of the format "GMT", "GMT-hr:mm", or "GMT+hr:mm". For example, `GMT-4:00` indicates the time is 4 hours behind GMT. The time zone is used, for example, for scheduling snapshots and your gateway's maintenance schedule. * `activation_key` - (Optional) Gateway activation key during resource creation. Conflicts with `gateway_ip_address`. Additional information is available in the [Storage Gateway User Guide](https://docs.aws.amazon.com/storagegateway/latest/userguide/get-activation-key.html). @@ -290,4 +291,4 @@ class MyConvertedCode(TerraformStack): ) ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/storagegateway_nfs_file_share.html.markdown b/website/docs/cdktf/python/r/storagegateway_nfs_file_share.html.markdown index 2f3374e871a9..235b40963140 100644 --- a/website/docs/cdktf/python/r/storagegateway_nfs_file_share.html.markdown +++ b/website/docs/cdktf/python/r/storagegateway_nfs_file_share.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `client_list` - (Required) The list of clients that are allowed to access the file gateway. The list must contain either valid IP addresses or valid CIDR blocks. Set to `["0.0.0.0/0"]` to not limit access. Minimum 1 item. Maximum 100 items. * `gateway_arn` - (Required) Amazon Resource Name (ARN) of the file gateway. * `location_arn` - (Required) The ARN of the backed storage used for storing file data. @@ -117,4 +118,4 @@ Using `terraform import`, import `aws_storagegateway_nfs_file_share` using the N % terraform import aws_storagegateway_nfs_file_share.example arn:aws:storagegateway:us-east-1:123456789012:share/share-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/storagegateway_smb_file_share.html.markdown b/website/docs/cdktf/python/r/storagegateway_smb_file_share.html.markdown index bc05b5d90f64..d13537517e0a 100644 --- a/website/docs/cdktf/python/r/storagegateway_smb_file_share.html.markdown +++ b/website/docs/cdktf/python/r/storagegateway_smb_file_share.html.markdown @@ -66,6 +66,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `gateway_arn` - (Required) Amazon Resource Name (ARN) of the file gateway. * `location_arn` - (Required) The ARN of the backed storage used for storing file data. * `vpc_endpoint_dns_name` - (Optional) The DNS name of the VPC endpoint for S3 private link. @@ -83,8 +84,6 @@ This resource supports the following arguments: * `object_acl` - (Optional) Access Control List permission for S3 objects. Defaults to `private`. * `oplocks_enabled` - (Optional) Boolean to indicate Opportunistic lock (oplock) status. Defaults to `true`. * `cache_attributes` - (Optional) Refresh cache information. see [`cache_attributes` Block](#cache_attributes-block) for more details. - - **Note:** If you have previously included a `cache_attributes` block in your configuration, removing it will not reset the refresh cache value and the previous value will remain. You must explicitly set a new value to change it. * `read_only` - (Optional) Boolean to indicate write status of file share. File share does not accept writes if `true`. Defaults to `false`. * `requester_pays` - (Optional) Boolean who pays the cost of the request and the data download from the Amazon S3 bucket. Set this value to `true` if you want the requester to pay instead of the bucket owner. Defaults to `false`. * `smb_acl_enabled` - (Optional) Set this value to `true` to enable ACL (access control list) on the SMB fileshare. Set it to `false` to map file and directory permissions to the POSIX permissions. This setting applies only to `ActiveDirectory` authentication type. @@ -94,6 +93,8 @@ This resource supports the following arguments: * `notification_policy` - (Optional) The notification policy of the file share. For more information see the [AWS Documentation](https://docs.aws.amazon.com/storagegateway/latest/APIReference/API_CreateNFSFileShare.html#StorageGateway-CreateNFSFileShare-request-NotificationPolicy). Default value is `{}`. * `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. +**Note:** If you have previously included a `cache_attributes` block in your configuration, removing it will not reset the refresh cache value and the previous value will remain. You must explicitly set a new value to change it. + ### `cache_attributes` Block The `cache_attributes` configuration block supports the following arguments: @@ -145,4 +146,4 @@ Using `terraform import`, import `aws_storagegateway_smb_file_share` using the S % terraform import aws_storagegateway_smb_file_share.example arn:aws:storagegateway:us-east-1:123456789012:share/share-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/storagegateway_stored_iscsi_volume.html.markdown b/website/docs/cdktf/python/r/storagegateway_stored_iscsi_volume.html.markdown index 60c5982852ae..1e023ab4f20f 100644 --- a/website/docs/cdktf/python/r/storagegateway_stored_iscsi_volume.html.markdown +++ b/website/docs/cdktf/python/r/storagegateway_stored_iscsi_volume.html.markdown @@ -67,6 +67,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `gateway_arn` - (Required) The Amazon Resource Name (ARN) of the gateway. * `network_interface_id` - (Required) The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted. * `target_name` - (Required) The name of the iSCSI target used by initiators to connect to the target and as a suffix for the target ARN. The target name must be unique across all volumes of a gateway. @@ -120,4 +121,4 @@ Using `terraform import`, import `aws_storagegateway_stored_iscsi_volume` using % terraform import aws_storagegateway_stored_iscsi_volume.example arn:aws:storagegateway:us-east-1:123456789012:gateway/sgw-12345678/volume/vol-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/storagegateway_tape_pool.html.markdown b/website/docs/cdktf/python/r/storagegateway_tape_pool.html.markdown index 06476d8f7ac6..459b187b3eb4 100644 --- a/website/docs/cdktf/python/r/storagegateway_tape_pool.html.markdown +++ b/website/docs/cdktf/python/r/storagegateway_tape_pool.html.markdown @@ -36,6 +36,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `pool_name` - (Required) The name of the new custom tape pool. * `storage_class` - (Required) The storage class that is associated with the new custom pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class that corresponds to the pool. Possible values are `DEEP_ARCHIVE` or `GLACIER`. * `retention_lock_type` - (Required) Tape retention lock can be configured in two modes. When configured in governance mode, AWS accounts with specific IAM permissions are authorized to remove the tape retention lock from archived virtual tapes. When configured in compliance mode, the tape retention lock cannot be removed by any user, including the root AWS account. Possible values are `COMPLIANCE`, `GOVERNANCE`, and `NONE`. Default value is `NONE`. @@ -74,4 +75,4 @@ Using `terraform import`, import `aws_storagegateway_tape_pool` using the volume % terraform import aws_storagegateway_tape_pool.example arn:aws:storagegateway:us-east-1:123456789012:tapepool/pool-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/storagegateway_upload_buffer.html.markdown b/website/docs/cdktf/python/r/storagegateway_upload_buffer.html.markdown index 9c381c4640d0..ceda66589ecb 100644 --- a/website/docs/cdktf/python/r/storagegateway_upload_buffer.html.markdown +++ b/website/docs/cdktf/python/r/storagegateway_upload_buffer.html.markdown @@ -72,6 +72,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `disk_id` - (Optional) Local disk identifier. For example, `pci-0000:03:00.0-scsi-0:0:0:0`. * `disk_path` - (Optional) Local disk path. For example, `/dev/nvme1n1`. * `gateway_arn` - (Required) The Amazon Resource Name (ARN) of the gateway. @@ -107,4 +108,4 @@ Using `terraform import`, import `aws_storagegateway_upload_buffer` using the ga % terraform import aws_storagegateway_upload_buffer.example arn:aws:storagegateway:us-east-1:123456789012:gateway/sgw-12345678:pci-0000:03:00.0-scsi-0:0:0:0 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/storagegateway_working_storage.html.markdown b/website/docs/cdktf/python/r/storagegateway_working_storage.html.markdown index 5a47e361ff48..09bfe6ceefdc 100644 --- a/website/docs/cdktf/python/r/storagegateway_working_storage.html.markdown +++ b/website/docs/cdktf/python/r/storagegateway_working_storage.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `disk_id` - (Required) Local disk identifier. For example, `pci-0000:03:00.0-scsi-0:0:0:0`. * `gateway_arn` - (Required) The Amazon Resource Name (ARN) of the gateway. @@ -72,4 +73,4 @@ Using `terraform import`, import `aws_storagegateway_working_storage` using the % terraform import aws_storagegateway_working_storage.example arn:aws:storagegateway:us-east-1:123456789012:gateway/sgw-12345678:pci-0000:03:00.0-scsi-0:0:0:0 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/subnet.html.markdown b/website/docs/cdktf/python/r/subnet.html.markdown index 8ae6e12007cd..d6a442c355e5 100644 --- a/website/docs/cdktf/python/r/subnet.html.markdown +++ b/website/docs/cdktf/python/r/subnet.html.markdown @@ -71,6 +71,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `assign_ipv6_address_on_creation` - (Optional) Specify true to indicate that network interfaces created in the specified subnet should be assigned an IPv6 address. Default is `false` @@ -136,4 +137,4 @@ Using `terraform import`, import subnets using the subnet `id`. For example: % terraform import aws_subnet.public_subnet subnet-9d4a7b6c ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/swf_domain.html.markdown b/website/docs/cdktf/python/r/swf_domain.html.markdown index ab0146afbf8f..d5ef460c4505 100644 --- a/website/docs/cdktf/python/r/swf_domain.html.markdown +++ b/website/docs/cdktf/python/r/swf_domain.html.markdown @@ -39,6 +39,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Optional, Forces new resource) The name of the domain. If omitted, Terraform will assign a random, unique name. * `name_prefix` - (Optional, Forces new resource) Creates a unique name beginning with the specified prefix. Conflicts with `name`. * `description` - (Optional, Forces new resource) The domain description. @@ -78,4 +79,4 @@ Using `terraform import`, import SWF Domains using the `name`. For example: % terraform import aws_swf_domain.foo test-domain ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/synthetics_canary.html.markdown b/website/docs/cdktf/python/r/synthetics_canary.html.markdown index ac60329110b6..ad6638d66db4 100644 --- a/website/docs/cdktf/python/r/synthetics_canary.html.markdown +++ b/website/docs/cdktf/python/r/synthetics_canary.html.markdown @@ -48,12 +48,13 @@ The following arguments are required: * `artifact_s3_location` - (Required) Location in Amazon S3 where Synthetics stores artifacts from the test runs of this canary. * `execution_role_arn` - (Required) ARN of the IAM role to be used to run the canary. see [AWS Docs](https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_CreateCanary.html#API_CreateCanary_RequestSyntax) for permissions needs for IAM Role. * `handler` - (Required) Entry point to use for the source code when running the canary. This value must end with the string `.handler` . -* `name` - (Required) Name for this canary. Has a maximum length of 21 characters. Valid characters are lowercase alphanumeric, hyphen, or underscore. +* `name` - (Required) Name for this canary. Has a maximum length of 255 characters. Valid characters are lowercase alphanumeric, hyphen, or underscore. * `runtime_version` - (Required) Runtime version to use for the canary. Versions change often so consult the [Amazon CloudWatch documentation](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Library.html) for the latest valid versions. Values include `syn-python-selenium-1.0`, `syn-nodejs-puppeteer-3.0`, `syn-nodejs-2.2`, `syn-nodejs-2.1`, `syn-nodejs-2.0`, and `syn-1.0`. * `schedule` - (Required) Configuration block providing how often the canary is to run and when these test runs are to stop. Detailed below. The following arguments are optional: +* `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). * `delete_lambda` - (Optional) Specifies whether to also delete the Lambda functions and layers used by this canary. The default is `false`. * `vpc_config` - (Optional) Configuration block. Detailed below. * `failure_retention_period` - (Optional) Number of days to retain data about failed runs of this canary. If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days. @@ -94,6 +95,7 @@ If this canary tests an endpoint in a VPC, this structure contains information a * `subnet_ids` - (Required) IDs of the subnets where this canary is to run. * `security_group_ids` - (Required) IDs of the security groups for this canary. +* `ipv6_allowed_for_dual_stack` - (Optional) If `true`, allow outbound IPv6 traffic on VPC canaries that are connected to dual-stack subnets. The default is `false`. ## Attribute Reference @@ -143,4 +145,4 @@ Using `terraform import`, import Synthetics Canaries using the `name`. For examp % terraform import aws_synthetics_canary.some some-canary ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/synthetics_group.html.markdown b/website/docs/cdktf/python/r/synthetics_group.html.markdown index e5fd6d118be0..5dec96d88c3a 100644 --- a/website/docs/cdktf/python/r/synthetics_group.html.markdown +++ b/website/docs/cdktf/python/r/synthetics_group.html.markdown @@ -41,6 +41,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `tags` - (Optional) Key-value mapping of resource tags. If configured with a provider [`default_tags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. ## Attribute Reference @@ -76,4 +77,4 @@ Using `terraform import`, import CloudWatch Synthetics Group using the `name`. F % terraform import aws_synthetics_group.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/synthetics_group_association.html.markdown b/website/docs/cdktf/python/r/synthetics_group_association.html.markdown index 410990dde4df..9198b637984c 100644 --- a/website/docs/cdktf/python/r/synthetics_group_association.html.markdown +++ b/website/docs/cdktf/python/r/synthetics_group_association.html.markdown @@ -36,8 +36,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `group_name` - (Required) Name of the group that the canary will be associated with. * `canary_arn` - (Required) ARN of the canary. @@ -73,4 +74,4 @@ Using `terraform import`, import CloudWatch Synthetics Group Association using t % terraform import aws_synthetics_group_association.example arn:aws:synthetics:us-west-2:123456789012:canary:tf-acc-test-abcd1234,examplename ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/timestreaminfluxdb_db_cluster.html.markdown b/website/docs/cdktf/python/r/timestreaminfluxdb_db_cluster.html.markdown new file mode 100644 index 000000000000..9abbd2045726 --- /dev/null +++ b/website/docs/cdktf/python/r/timestreaminfluxdb_db_cluster.html.markdown @@ -0,0 +1,337 @@ +--- +subcategory: "Timestream for InfluxDB" +layout: "aws" +page_title: "AWS: aws_timestreaminfluxdb_db_cluster" +description: |- + Terraform resource for managing an Amazon Timestream for InfluxDB read-replica cluster. +--- + + + +# Resource: aws_timestreaminfluxdb_db_cluster + +Terraform resource for managing an Amazon Timestream for InfluxDB read-replica cluster. + +~> **NOTE:** This resource requires a subscription to [Timestream for InfluxDB Read Replicas (Add-On) on the AWS Marketplace](https://aws.amazon.com/marketplace/pp/prodview-lftzfxtb5xlv4?applicationId=AWS-Marketplace-Console&ref_=beagle&sr=0-2). + +## 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.timestreaminfluxdb_db_cluster import TimestreaminfluxdbDbCluster +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + TimestreaminfluxdbDbCluster(self, "example", + allocated_storage=20, + bucket="example-bucket-name", + db_instance_type="db.influx.medium", + failover_mode="AUTOMATIC", + name="example-db-cluster", + organization="organization", + password="example-password", + port=8086, + username="admin", + vpc_security_group_ids=[Token.as_string(aws_security_group_example.id)], + vpc_subnet_ids=[example1.id, example2.id] + ) +``` + +### Usage with Prerequisite Resources + +All Timestream for InfluxDB clusters require a VPC, at least two subnets, and a security group. The following example shows how these prerequisite resources can be created and used with `aws_timestreaminfluxdb_db_cluster`. + +```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.security_group import SecurityGroup +from imports.aws.subnet import Subnet +from imports.aws.timestreaminfluxdb_db_cluster import TimestreaminfluxdbDbCluster +from imports.aws.vpc import Vpc +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + example = Vpc(self, "example", + cidr_block="10.0.0.0/16" + ) + aws_security_group_example = SecurityGroup(self, "example_1", + name="example", + vpc_id=example.id + ) + # 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_security_group_example.override_logical_id("example") + example1 = Subnet(self, "example_1_2", + cidr_block="10.0.1.0/24", + vpc_id=example.id + ) + # This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match. + example1.override_logical_id("example_1") + example2 = Subnet(self, "example_2", + cidr_block="10.0.2.0/24", + vpc_id=example.id + ) + aws_timestreaminfluxdb_db_cluster_example = + TimestreaminfluxdbDbCluster(self, "example_4", + allocated_storage=20, + bucket="example-bucket-name", + db_instance_type="db.influx.medium", + name="example-db-cluster", + organization="organization", + password="example-password", + username="admin", + vpc_security_group_ids=[Token.as_string(aws_security_group_example.id)], + vpc_subnet_ids=[example1.id, example2.id] + ) + # 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_timestreaminfluxdb_db_cluster_example.override_logical_id("example") +``` + +### Usage with Public Internet Access Enabled + +The following configuration shows how to define the necessary resources and arguments to allow public internet access on your Timestream for InfluxDB read-replica cluster's primary endpoint (simply referred to as "endpoint") and read endpoint on port `8086`. After applying this configuration, the cluster's InfluxDB UI can be accessed by visiting your cluster's primary endpoint at port `8086`. + +```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, Op, TerraformStack +# +# Provider bindings are generated by running `cdktf get`. +# See https://cdk.tf/provider-generation for more details. +# +from imports.aws.internet_gateway import InternetGateway +from imports.aws.route import Route +from imports.aws.route_table_association import RouteTableAssociation +from imports.aws.security_group import SecurityGroup +from imports.aws.subnet import Subnet +from imports.aws.timestreaminfluxdb_db_cluster import TimestreaminfluxdbDbCluster +from imports.aws.vpc import Vpc +from imports.aws.vpc_security_group_ingress_rule import VpcSecurityGroupIngressRule +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + example = Vpc(self, "example", + cidr_block="10.0.0.0/16" + ) + aws_internet_gateway_example = InternetGateway(self, "example_1", + tags={ + "Name": "example" + }, + vpc_id=example.id + ) + # 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_internet_gateway_example.override_logical_id("example") + Route(self, "test_route", + destination_cidr_block="0.0.0.0/0", + gateway_id=Token.as_string(aws_internet_gateway_example.id), + route_table_id=example.main_route_table_id + ) + RouteTableAssociation(self, "test_route_table_association", + route_table_id=example.main_route_table_id, + subnet_id=test_subnet.id + ) + aws_security_group_example = SecurityGroup(self, "example_4", + name="example", + vpc_id=example.id + ) + # 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_security_group_example.override_logical_id("example") + example1 = Subnet(self, "example_1_5", + cidr_block="10.0.1.0/24", + vpc_id=example.id + ) + # This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match. + example1.override_logical_id("example_1") + example2 = Subnet(self, "example_2", + cidr_block="10.0.2.0/24", + vpc_id=example.id + ) + aws_timestreaminfluxdb_db_cluster_example = + TimestreaminfluxdbDbCluster(self, "example_7", + allocated_storage=20, + bucket="example-bucket-name", + db_instance_type="db.influx.medium", + name="example-db-cluster", + organization="organization", + password="example-password", + publicly_accessible=True, + username="admin", + vpc_security_group_ids=[Token.as_string(aws_security_group_example.id)], + vpc_subnet_ids=[example1.id, example2.id] + ) + # 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_timestreaminfluxdb_db_cluster_example.override_logical_id("example") + aws_vpc_security_group_ingress_rule_example = + VpcSecurityGroupIngressRule(self, "example_8", + ip_protocol=Token.as_string(Op.negate(1)), + referenced_security_group_id=Token.as_string(aws_security_group_example.id), + security_group_id=Token.as_string(aws_security_group_example.id) + ) + # 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_vpc_security_group_ingress_rule_example.override_logical_id("example") +``` + +### Usage with S3 Log Delivery Enabled + +You can use an S3 bucket to store logs generated by your Timestream for InfluxDB cluster. The following example shows what resources and arguments are required to configure an S3 bucket for logging, including the IAM policy that needs to be set in order to allow Timestream for InfluxDB to place logs in your S3 bucket. The configuration of the required VPC, security group, and subnets have been left out of the example for brevity. + +```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.data_aws_iam_policy_document import DataAwsIamPolicyDocument +from imports.aws.s3_bucket import S3Bucket +from imports.aws.s3_bucket_policy import S3BucketPolicy +from imports.aws.timestreaminfluxdb_db_cluster import TimestreaminfluxdbDbCluster +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + example = S3Bucket(self, "example", + bucket="example-s3-bucket", + force_destroy=True + ) + aws_timestreaminfluxdb_db_cluster_example = + TimestreaminfluxdbDbCluster(self, "example_1", + allocated_storage=20, + bucket="example-bucket-name", + db_instance_type="db.influx.medium", + log_delivery_configuration=[TimestreaminfluxdbDbClusterLogDeliveryConfiguration( + s3_configuration=[TimestreaminfluxdbDbClusterLogDeliveryConfigurationS3Configuration( + bucket_name=example.bucket, + enabled=True + ) + ] + ) + ], + name="example-db-cluster", + organization="organization", + password="example-password", + username="admin", + vpc_security_group_ids=[Token.as_string(aws_security_group_example.id)], + vpc_subnet_ids=[example1.id, example2.id] + ) + # 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_timestreaminfluxdb_db_cluster_example.override_logical_id("example") + data_aws_iam_policy_document_example = DataAwsIamPolicyDocument(self, "example_2", + statement=[DataAwsIamPolicyDocumentStatement( + actions=["s3:PutObject"], + principals=[DataAwsIamPolicyDocumentStatementPrincipals( + identifiers=["timestream-influxdb.amazonaws.com"], + type="Service" + ) + ], + resources=["${" + 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. + data_aws_iam_policy_document_example.override_logical_id("example") + aws_s3_bucket_policy_example = S3BucketPolicy(self, "example_3", + bucket=example.id, + policy=Token.as_string(data_aws_iam_policy_document_example.json) + ) + # 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_s3_bucket_policy_example.override_logical_id("example") +``` + +## Argument Reference + +The following arguments are required: + +* `allocated_storage` - (Required) Amount of storage in GiB (gibibytes). The minimum value is `20`, the maximum value is `16384`. The argument `db_storage_type` places restrictions on this argument's minimum value. The following is a list of `db_storage_type` values and the corresponding minimum value for `allocated_storage`: `"InfluxIOIncludedT1": `20`, `"InfluxIOIncludedT2" and `"InfluxIOIncludedT3": `400`. +* `bucket` - (Required) Name of the initial InfluxDB bucket. All InfluxDB data is stored in a bucket. A bucket combines the concept of a database and a retention period (the duration of time that each data point persists). A bucket belongs to an organization. Along with `organization`, `username`, and `password`, this argument will be stored in the secret referred to by the `influx_auth_parameters_secret_arn` attribute. +* `db_instance_type` - (Required) Timestream for InfluxDB DB instance type to run InfluxDB on. Valid options are: `"db.influx.medium"`, `"db.influx.large"`, `"db.influx.xlarge"`, `"db.influx.2xlarge"`, `"db.influx.4xlarge"`, `"db.influx.8xlarge"`, `"db.influx.12xlarge"`, and `"db.influx.16xlarge"`. This argument is updatable. +* `name` - (Required) Name that uniquely identifies the DB cluster when interacting with the Amazon Timestream for InfluxDB API and CLI commands. This name will also be a prefix included in the endpoint. Cluster names must be unique per customer and per region. The argument must start with a letter, cannot contain consecutive hyphens (`-`) and cannot end with a hyphen. +* `password` - (Required) Password of the initial admin user created in InfluxDB. This password will allow you to access the InfluxDB UI to perform various administrative tasks and also use the InfluxDB CLI to create an operator token. Along with `bucket`, `username`, and `organization`, this argument will be stored in the secret referred to by the `influx_auth_parameters_secret_arn` attribute. +* `organization` - (Required) Name of the initial organization for the initial admin user in InfluxDB. An InfluxDB organization is a workspace for a group of users. Along with `bucket`, `username`, and `password`, this argument will be stored in the secret referred to by the `influx_auth_parameters_secret_arn` attribute. +* `username` - (Required) Username of the initial admin user created in InfluxDB. Must start with a letter and can't end with a hyphen or contain two consecutive hyphens. This username will allow you to access the InfluxDB UI to perform various administrative tasks and also use the InfluxDB CLI to create an operator token. Along with `bucket`, `organization`, and `password`, this argument will be stored in the secret referred to by the `influx_auth_parameters_secret_arn` attribute. +* `vpc_security_group_ids` - (Required) List of VPC security group IDs to associate with the cluster. +* `vpc_subnet_ids` - (Required) List of VPC subnet IDs to associate with the cluster. Provide at least two VPC subnet IDs in different availability zones when deploying with a Multi-AZ standby. + +The following arguments are optional: + +* `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). +* `db_parameter_group_identifier` - (Optional) ID of the DB parameter group assigned to your cluster. This argument is updatable. If added to an existing Timestream for InfluxDB cluster or given a new value, will cause an in-place update to the cluster. However, if a cluster already has a value for `db_parameter_group_identifier`, removing `db_parameter_group_identifier` will cause the cluster to be destroyed and recreated. +* `db_storage_type` - (Default `"InfluxIOIncludedT1"`) Timestream for InfluxDB DB storage type to read and write InfluxDB data. You can choose between 3 different types of provisioned Influx IOPS included storage according to your workloads requirements: Influx IO Included 3000 IOPS, Influx IO Included 12000 IOPS, Influx IO Included 16000 IOPS. Valid options are: `"InfluxIOIncludedT1"`, `"InfluxIOIncludedT2"`, and `"InfluxIOIncludedT3"`. If you use `"InfluxIOIncludedT2" or "InfluxIOIncludedT3", the minimum value for `allocated_storage` is 400. +* `deployment_type` - (Default `"MULTI_NODE_READ_REPLICAS"`) Specifies the type of cluster to create. Valid options are: `"MULTI_NODE_READ_REPLICAS"`. +* `failover_mode` - (Default `"AUTOMATIC"`) Specifies the behavior of failure recovery when the primary node of the cluster fails. Valid options are: `"AUTOMATIC"` and `"NO_FAILOVER"`. +* `log_delivery_configuration` - (Optional) Configuration for sending InfluxDB engine logs to a specified S3 bucket. This argument is updatable. +* `network_type` - (Optional) Specifies whether the network type of the Timestream for InfluxDB cluster is IPV4, which can communicate over IPv4 protocol only, or DUAL, which can communicate over both IPv4 and IPv6 protocols. +* `port` - (Default `8086`) The port on which the cluster accepts connections. Valid values: `1024`-`65535`. Cannot be `2375`-`2376`, `7788`-`7799`, `8090`, or `51678`-`51680`. This argument is updatable. +* `publicly_accessible` - (Default `false`) Configures the DB cluster with a public IP to facilitate access. Other resources, such as a VPC, a subnet, an internet gateway, and a route table with routes, are also required to enabled public access, in addition to this argument. See "[Usage with Public Internet Access Enabled](#usage-with-public-internet-access-enabled)" for an example configuration with all required resources for public internet access. +* `tags` - (Optional) Map of tags assigned to the resource. If configured with a provider [`default_tags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. + +### Nested Fields + +#### `log_delivery_configuration` + +* `s3_configuration` - (Required) Configuration for S3 bucket log delivery. + +#### `s3_configuration` + +* `bucket_name` - (Required) Name of the S3 bucket to deliver logs to. +* `enabled` - (Required) Indicates whether log delivery to the S3 bucket is enabled. + +**Note**: The following arguments do updates in-place: `db_parameter_group_identifier`, `log_delivery_configuration`, `port`, `db_instance_type`, `failover_mode`, and `tags`. Changes to any other argument after a cluster has been deployed will cause destruction and re-creation of the cluster. Additionally, when `db_parameter_group_identifier` is added to a cluster or modified, the cluster will be updated in-place but if `db_parameter_group_identifier` is removed from a cluster, the cluster will be destroyed and re-created. + +## Attribute Reference + +This resource exports the following attributes in addition to the arguments above: + +* `arn` - ARN of the Timestream for InfluxDB cluster. +* `endpoint` - Endpoint used to connect to InfluxDB. The default InfluxDB port is 8086. +* `id` - ID of the Timestream for InfluxDB cluster. +* `influx_auth_parameters_secret_arn` - ARN of the AWS Secrets Manager secret containing the initial InfluxDB authorization parameters. The secret value is a JSON formatted key-value pair holding InfluxDB authorization values: organization, bucket, username, and password. +* `reader_endpoint` - The endpoint used to connect to the Timestream for InfluxDB cluster for read-only operations. +* `tags_all` - Map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). + +## Timeouts + +[Configuration options](https://developer.hashicorp.com/terraform/language/resources/syntax#operation-timeouts): + +* `create` - (Default `30m`) +* `update` - (Default `30m`) +* `delete` - (Default `30m`) + +## Import + +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import Timestream for InfluxDB cluster using its identifier. 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.timestreaminfluxdb_db_cluster import TimestreaminfluxdbDbCluster +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + TimestreaminfluxdbDbCluster.generate_config_for_import(self, "example", "12345abcde") +``` + +Using `terraform import`, import Timestream for InfluxDB cluster using its identifier. For example: + +```console +% terraform import aws_timestreaminfluxdb_db_cluster.example 12345abcde +``` + + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/timestreaminfluxdb_db_instance.html.markdown b/website/docs/cdktf/python/r/timestreaminfluxdb_db_instance.html.markdown index 256ca914fde4..fa9ad680d46c 100644 --- a/website/docs/cdktf/python/r/timestreaminfluxdb_db_instance.html.markdown +++ b/website/docs/cdktf/python/r/timestreaminfluxdb_db_instance.html.markdown @@ -296,6 +296,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `db_parameter_group_identifier` - (Optional) ID of the DB parameter group assigned to your DB instance. This argument is updatable. If added to an existing Timestream for InfluxDB instance or given a new value, will cause an in-place update to the instance. However, if an instance already has a value for `db_parameter_group_identifier`, removing `db_parameter_group_identifier` will cause the instance to be destroyed and recreated. * `db_storage_type` - (Default `"InfluxIOIncludedT1"`) Timestream for InfluxDB DB storage type to read and write InfluxDB data. You can choose between 3 different types of provisioned Influx IOPS included storage according to your workloads requirements: Influx IO Included 3000 IOPS, Influx IO Included 12000 IOPS, Influx IO Included 16000 IOPS. Valid options are: `"InfluxIOIncludedT1"`, `"InfluxIOIncludedT2"`, and `"InfluxIOIncludedT3"`. If you use `"InfluxIOIncludedT2" or "InfluxIOIncludedT3", the minimum value for `allocated_storage` is 400. This argument is updatable. For a single instance, after this argument has been updated once, it can only be updated again after 6 hours have passed. * `deployment_type` - (Default `"SINGLE_AZ"`) Specifies whether the DB instance will be deployed as a standalone instance or with a Multi-AZ standby for high availability. Valid options are: `"SINGLE_AZ"`, `"WITH_MULTIAZ_STANDBY"`. This argument is updatable. @@ -326,7 +327,7 @@ This resource exports the following attributes in addition to the arguments abov * `availability_zone` - Availability Zone in which the DB instance resides. * `endpoint` - Endpoint used to connect to InfluxDB. The default InfluxDB port is 8086. * `id` - ID of the Timestream for InfluxDB instance. -* `influx_auth_parameters_secret_arn` - ARN of the AWS Secrets Manager secret containing the initial InfluxDB authorization parameters. The secret value is a JSON formatted key-value pair holding InfluxDB authorization values: organization, bucket, username, and password. This secret will be read by the `aws_timestreaminfluxdb_db_instance` resource in order to support importing: deleting the secret or secret values can cause errors. +* `influx_auth_parameters_secret_arn` - ARN of the AWS Secrets Manager secret containing the initial InfluxDB authorization parameters. The secret value is a JSON formatted key-value pair holding InfluxDB authorization values: organization, bucket, username, and password. * `secondary_availability_zone` - Availability Zone in which the standby instance is located when deploying with a MultiAZ standby instance. * `tags_all` - Map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). @@ -363,4 +364,4 @@ Using `terraform import`, import Timestream for InfluxDB Db Instance using its i % terraform import aws_timestreaminfluxdb_db_instance.example 12345abcde ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/timestreamquery_scheduled_query.html.markdown b/website/docs/cdktf/python/r/timestreamquery_scheduled_query.html.markdown index ee01e37e61a3..fa5a2a417e0e 100644 --- a/website/docs/cdktf/python/r/timestreamquery_scheduled_query.html.markdown +++ b/website/docs/cdktf/python/r/timestreamquery_scheduled_query.html.markdown @@ -23,74 +23,74 @@ If your infrastructure is already set up—including the source database and tab ```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 +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. import TimestreamqueryScheduledQuery +from imports.aws.timestreamquery_scheduled_query import TimestreamqueryScheduledQuery class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) TimestreamqueryScheduledQuery(self, "example", - error_report_configuration=[{ - "s3_configuration": [{ - "bucket_name": aws_s3_bucket_example.bucket - } + error_report_configuration=[TimestreamqueryScheduledQueryErrorReportConfiguration( + s3_configuration=[TimestreamqueryScheduledQueryErrorReportConfigurationS3Configuration( + bucket_name=Token.as_string(aws_s3_bucket_example.bucket) + ) ] - } + ) ], - execution_role_arn=aws_iam_role_example.arn, - name=aws_timestreamwrite_table_example.table_name, - notification_configuration=[{ - "sns_configuration": [{ - "topic_arn": aws_sns_topic_example.arn - } + execution_role_arn=Token.as_string(aws_iam_role_example.arn), + name=Token.as_string(aws_timestreamwrite_table_example.table_name), + notification_configuration=[TimestreamqueryScheduledQueryNotificationConfiguration( + sns_configuration=[TimestreamqueryScheduledQueryNotificationConfigurationSnsConfiguration( + topic_arn=Token.as_string(aws_sns_topic_example.arn) + ) ] - } + ) ], query_string="SELECT region, az, hostname, BIN(time, 15s) AS binned_timestamp,\n\tROUND(AVG(cpu_utilization), 2) AS avg_cpu_utilization,\n\tROUND(APPROX_PERCENTILE(cpu_utilization, 0.9), 2) AS p90_cpu_utilization,\n\tROUND(APPROX_PERCENTILE(cpu_utilization, 0.95), 2) AS p95_cpu_utilization,\n\tROUND(APPROX_PERCENTILE(cpu_utilization, 0.99), 2) AS p99_cpu_utilization\nFROM exampledatabase.exampletable\nWHERE measure_name = 'metrics' AND time > ago(2h)\nGROUP BY region, hostname, az, BIN(time, 15s)\nORDER BY binned_timestamp ASC\nLIMIT 5\n\n", - schedule_configuration=[{ - "schedule_expression": "rate(1 hour)" - } + schedule_configuration=[TimestreamqueryScheduledQueryScheduleConfiguration( + schedule_expression="rate(1 hour)" + ) ], - target_configuration=[{ - "timestream_configuration": [{ - "database_name": results.database_name, - "dimension_mapping": [{ - "dimension_value_type": "VARCHAR", - "name": "az" - }, { - "dimension_value_type": "VARCHAR", - "name": "region" - }, { - "dimension_value_type": "VARCHAR", - "name": "hostname" - } + target_configuration=[TimestreamqueryScheduledQueryTargetConfiguration( + timestream_configuration=[TimestreamqueryScheduledQueryTargetConfigurationTimestreamConfiguration( + database_name=results.database_name, + dimension_mapping=[TimestreamqueryScheduledQueryTargetConfigurationTimestreamConfigurationDimensionMapping( + dimension_value_type="VARCHAR", + name="az" + ), TimestreamqueryScheduledQueryTargetConfigurationTimestreamConfigurationDimensionMapping( + dimension_value_type="VARCHAR", + name="region" + ), TimestreamqueryScheduledQueryTargetConfigurationTimestreamConfigurationDimensionMapping( + dimension_value_type="VARCHAR", + name="hostname" + ) ], - "multi_measure_mappings": [{ - "multi_measure_attribute_mapping": [{ - "measure_value_type": "DOUBLE", - "source_column": "avg_cpu_utilization" - }, { - "measure_value_type": "DOUBLE", - "source_column": "p90_cpu_utilization" - }, { - "measure_value_type": "DOUBLE", - "source_column": "p95_cpu_utilization" - }, { - "measure_value_type": "DOUBLE", - "source_column": "p99_cpu_utilization" - } + multi_measure_mappings=[TimestreamqueryScheduledQueryTargetConfigurationTimestreamConfigurationMultiMeasureMappings( + multi_measure_attribute_mapping=[TimestreamqueryScheduledQueryTargetConfigurationTimestreamConfigurationMultiMeasureMappingsMultiMeasureAttributeMapping( + measure_value_type="DOUBLE", + source_column="avg_cpu_utilization" + ), TimestreamqueryScheduledQueryTargetConfigurationTimestreamConfigurationMultiMeasureMappingsMultiMeasureAttributeMapping( + measure_value_type="DOUBLE", + source_column="p90_cpu_utilization" + ), TimestreamqueryScheduledQueryTargetConfigurationTimestreamConfigurationMultiMeasureMappingsMultiMeasureAttributeMapping( + measure_value_type="DOUBLE", + source_column="p95_cpu_utilization" + ), TimestreamqueryScheduledQueryTargetConfigurationTimestreamConfigurationMultiMeasureMappingsMultiMeasureAttributeMapping( + measure_value_type="DOUBLE", + source_column="p99_cpu_utilization" + ) ], - "target_multi_measure_name": "multi-metrics" - } + target_multi_measure_name="multi-metrics" + ) ], - "table_name": aws_timestreamwrite_table_results.table_name, - "time_column": "binned_timestamp" - } + table_name=Token.as_string(aws_timestreamwrite_table_results.table_name), + time_column="binned_timestamp" + ) ] - } + ) ] ) ``` @@ -252,74 +252,74 @@ This is done with Amazon Timestream Write [WriteRecords](https://docs.aws.amazon ```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 +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. import TimestreamqueryScheduledQuery +from imports.aws.timestreamquery_scheduled_query import TimestreamqueryScheduledQuery class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) TimestreamqueryScheduledQuery(self, "example", - error_report_configuration=[{ - "s3_configuration": [{ - "bucket_name": aws_s3_bucket_example.bucket - } + error_report_configuration=[TimestreamqueryScheduledQueryErrorReportConfiguration( + s3_configuration=[TimestreamqueryScheduledQueryErrorReportConfigurationS3Configuration( + bucket_name=Token.as_string(aws_s3_bucket_example.bucket) + ) ] - } + ) ], - execution_role_arn=aws_iam_role_example.arn, - name=aws_timestreamwrite_table_example.table_name, - notification_configuration=[{ - "sns_configuration": [{ - "topic_arn": aws_sns_topic_example.arn - } + execution_role_arn=Token.as_string(aws_iam_role_example.arn), + name=Token.as_string(aws_timestreamwrite_table_example.table_name), + notification_configuration=[TimestreamqueryScheduledQueryNotificationConfiguration( + sns_configuration=[TimestreamqueryScheduledQueryNotificationConfigurationSnsConfiguration( + topic_arn=Token.as_string(aws_sns_topic_example.arn) + ) ] - } + ) ], query_string="SELECT region, az, hostname, BIN(time, 15s) AS binned_timestamp,\n\tROUND(AVG(cpu_utilization), 2) AS avg_cpu_utilization,\n\tROUND(APPROX_PERCENTILE(cpu_utilization, 0.9), 2) AS p90_cpu_utilization,\n\tROUND(APPROX_PERCENTILE(cpu_utilization, 0.95), 2) AS p95_cpu_utilization,\n\tROUND(APPROX_PERCENTILE(cpu_utilization, 0.99), 2) AS p99_cpu_utilization\nFROM exampledatabase.exampletable\nWHERE measure_name = 'metrics' AND time > ago(2h)\nGROUP BY region, hostname, az, BIN(time, 15s)\nORDER BY binned_timestamp ASC\nLIMIT 5\n\n", - schedule_configuration=[{ - "schedule_expression": "rate(1 hour)" - } + schedule_configuration=[TimestreamqueryScheduledQueryScheduleConfiguration( + schedule_expression="rate(1 hour)" + ) ], - target_configuration=[{ - "timestream_configuration": [{ - "database_name": results.database_name, - "dimension_mapping": [{ - "dimension_value_type": "VARCHAR", - "name": "az" - }, { - "dimension_value_type": "VARCHAR", - "name": "region" - }, { - "dimension_value_type": "VARCHAR", - "name": "hostname" - } + target_configuration=[TimestreamqueryScheduledQueryTargetConfiguration( + timestream_configuration=[TimestreamqueryScheduledQueryTargetConfigurationTimestreamConfiguration( + database_name=results.database_name, + dimension_mapping=[TimestreamqueryScheduledQueryTargetConfigurationTimestreamConfigurationDimensionMapping( + dimension_value_type="VARCHAR", + name="az" + ), TimestreamqueryScheduledQueryTargetConfigurationTimestreamConfigurationDimensionMapping( + dimension_value_type="VARCHAR", + name="region" + ), TimestreamqueryScheduledQueryTargetConfigurationTimestreamConfigurationDimensionMapping( + dimension_value_type="VARCHAR", + name="hostname" + ) ], - "multi_measure_mappings": [{ - "multi_measure_attribute_mapping": [{ - "measure_value_type": "DOUBLE", - "source_column": "avg_cpu_utilization" - }, { - "measure_value_type": "DOUBLE", - "source_column": "p90_cpu_utilization" - }, { - "measure_value_type": "DOUBLE", - "source_column": "p95_cpu_utilization" - }, { - "measure_value_type": "DOUBLE", - "source_column": "p99_cpu_utilization" - } + multi_measure_mappings=[TimestreamqueryScheduledQueryTargetConfigurationTimestreamConfigurationMultiMeasureMappings( + multi_measure_attribute_mapping=[TimestreamqueryScheduledQueryTargetConfigurationTimestreamConfigurationMultiMeasureMappingsMultiMeasureAttributeMapping( + measure_value_type="DOUBLE", + source_column="avg_cpu_utilization" + ), TimestreamqueryScheduledQueryTargetConfigurationTimestreamConfigurationMultiMeasureMappingsMultiMeasureAttributeMapping( + measure_value_type="DOUBLE", + source_column="p90_cpu_utilization" + ), TimestreamqueryScheduledQueryTargetConfigurationTimestreamConfigurationMultiMeasureMappingsMultiMeasureAttributeMapping( + measure_value_type="DOUBLE", + source_column="p95_cpu_utilization" + ), TimestreamqueryScheduledQueryTargetConfigurationTimestreamConfigurationMultiMeasureMappingsMultiMeasureAttributeMapping( + measure_value_type="DOUBLE", + source_column="p99_cpu_utilization" + ) ], - "target_multi_measure_name": "multi-metrics" - } + target_multi_measure_name="multi-metrics" + ) ], - "table_name": aws_timestreamwrite_table_results.table_name, - "time_column": "binned_timestamp" - } + table_name=Token.as_string(aws_timestreamwrite_table_results.table_name), + time_column="binned_timestamp" + ) ] - } + ) ] ) ``` @@ -338,6 +338,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `kms_key_id` - (Optional) Amazon KMS key used to encrypt the scheduled query resource, at-rest. If not specified, the scheduled query resource will be encrypted with a Timestream owned Amazon KMS key. To specify a KMS key, use the key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix the name with "alias/". If `error_report_configuration` uses `SSE_KMS` as the encryption type, the same `kms_key_id` is used to encrypt the error report at rest. * `tags` - (Optional) Map of tags assigned to the resource. If configured with a provider [`default_tags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. @@ -490,7 +491,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 TimestreamqueryScheduledQuery +from imports.aws.timestreamquery_scheduled_query import TimestreamqueryScheduledQuery class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) @@ -503,4 +504,4 @@ Using `terraform import`, import Timestream Query Scheduled Query using the `arn % terraform import aws_timestreamquery_scheduled_query.example arn:aws:timestream:us-west-2:012345678901:scheduled-query/tf-acc-test-7774188528604787105-e13659544fe66c8d ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/timestreamwrite_database.html.markdown b/website/docs/cdktf/python/r/timestreamwrite_database.html.markdown index a017643d28e0..b71f050bb27c 100644 --- a/website/docs/cdktf/python/r/timestreamwrite_database.html.markdown +++ b/website/docs/cdktf/python/r/timestreamwrite_database.html.markdown @@ -60,7 +60,8 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: -* `database_name` – (Required) The name of the Timestream database. Minimum length of 3. Maximum length of 64. +* `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). +* `database_name` - (Required) The name of the Timestream database. Minimum length of 3. Maximum length of 64. * `kms_key_id` - (Optional) The ARN (not Alias ARN) of the KMS key to be used to encrypt the data stored in the database. If the KMS key is not specified, the database will be encrypted with a Timestream managed KMS key located in your account. Refer to [AWS managed KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk) for more info. * `tags` - (Optional) Map of tags to assign to this 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. @@ -99,4 +100,4 @@ Using `terraform import`, import Timestream databases using the `database_name`. % terraform import aws_timestreamwrite_database.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/timestreamwrite_table.html.markdown b/website/docs/cdktf/python/r/timestreamwrite_table.html.markdown index f4a30b62e07f..efd3aae798c7 100644 --- a/website/docs/cdktf/python/r/timestreamwrite_table.html.markdown +++ b/website/docs/cdktf/python/r/timestreamwrite_table.html.markdown @@ -92,7 +92,8 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: -* `database_name` – (Required) The name of the Timestream database. +* `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). +* `database_name` - (Required) The name of the Timestream database. * `magnetic_store_write_properties` - (Optional) Contains properties to set on the table when enabling magnetic store writes. See [Magnetic Store Write Properties](#magnetic-store-write-properties) below for more details. * `retention_properties` - (Optional) The retention duration for the memory store and magnetic store. See [Retention Properties](#retention-properties) below for more details. If not provided, `magnetic_store_retention_period_in_days` default to 73000 and `memory_store_retention_period_in_hours` defaults to 6. * `schema` - (Optional) The schema of the table. See [Schema](#schema) below for more details. @@ -175,4 +176,4 @@ Using `terraform import`, import Timestream tables using the `table_name` and `d % terraform import aws_timestreamwrite_table.example ExampleTable:ExampleDatabase ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/transcribe_language_model.html.markdown b/website/docs/cdktf/python/r/transcribe_language_model.html.markdown index bfbf158b9a2e..e532b474c702 100644 --- a/website/docs/cdktf/python/r/transcribe_language_model.html.markdown +++ b/website/docs/cdktf/python/r/transcribe_language_model.html.markdown @@ -95,8 +95,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `base_model_name` - (Required) Name of reference base model. * `input_data_config` - (Required) The input data config for the LanguageModel. See [Input Data Config](#input-data-config) for more details. * `language_code` - (Required) The language code you selected for your language model. Refer to the [supported languages](https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html) page for accepted codes. @@ -150,4 +151,4 @@ Using `terraform import`, import Transcribe LanguageModel using the `model_name` % terraform import aws_transcribe_language_model.example example-name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/transcribe_medical_vocabulary.html.markdown b/website/docs/cdktf/python/r/transcribe_medical_vocabulary.html.markdown index ec0f1d94a726..e5cf34fe4516 100644 --- a/website/docs/cdktf/python/r/transcribe_medical_vocabulary.html.markdown +++ b/website/docs/cdktf/python/r/transcribe_medical_vocabulary.html.markdown @@ -64,6 +64,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `tags` - (Optional) A map of tags to assign to the MedicalVocabulary. 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. ## Attribute Reference @@ -107,4 +108,4 @@ Using `terraform import`, import Transcribe MedicalVocabulary using the `vocabul % terraform import aws_transcribe_medical_vocabulary.example example-name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/transcribe_vocabulary.html.markdown b/website/docs/cdktf/python/r/transcribe_vocabulary.html.markdown index 7321d39d1da1..a94284b3a491 100644 --- a/website/docs/cdktf/python/r/transcribe_vocabulary.html.markdown +++ b/website/docs/cdktf/python/r/transcribe_vocabulary.html.markdown @@ -58,11 +58,11 @@ class MyConvertedCode(TerraformStack): The following arguments are required: * `language_code` - (Required) The language code you selected for your vocabulary. -* `vocabulary_file_uri` - (Required) The Amazon S3 location (URI) of the text file that contains your custom vocabulary. * `vocabulary_name` - (Required) The name of the Vocabulary. The following arguments are optional: +* `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). * `phrases` - (Optional) - A list of terms to include in the vocabulary. Conflicts with `vocabulary_file_uri` * `vocabulary_file_uri` - (Optional) The Amazon S3 location (URI) of the text file that contains your custom vocabulary. Conflicts wth `phrases`. * `tags` - (Optional) A map of tags to assign to the Vocabulary. 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. @@ -108,4 +108,4 @@ Using `terraform import`, import Transcribe Vocabulary using the `vocabulary_nam % terraform import aws_transcribe_vocabulary.example example-name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/transcribe_vocabulary_filter.html.markdown b/website/docs/cdktf/python/r/transcribe_vocabulary_filter.html.markdown index bf6bf06b10bd..234d0a557e29 100644 --- a/website/docs/cdktf/python/r/transcribe_vocabulary_filter.html.markdown +++ b/website/docs/cdktf/python/r/transcribe_vocabulary_filter.html.markdown @@ -48,6 +48,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `vocabulary_filter_file_uri` - (Optional) The Amazon S3 location (URI) of the text file that contains your custom VocabularyFilter. Conflicts with `words` argument. * `tags` - (Optional) A map of tags to assign to the VocabularyFilter. 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. * `words` - (Optional) - A list of terms to include in the vocabulary. Conflicts with `vocabulary_filter_file_uri` argument. @@ -85,4 +86,4 @@ Using `terraform import`, import Transcribe VocabularyFilter using the `vocabula % terraform import aws_transcribe_vocabulary_filter.example example-name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/transfer_access.html.markdown b/website/docs/cdktf/python/r/transfer_access.html.markdown index f5694822d660..2b2d0cdfe09d 100644 --- a/website/docs/cdktf/python/r/transfer_access.html.markdown +++ b/website/docs/cdktf/python/r/transfer_access.html.markdown @@ -68,6 +68,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `external_id` - (Required) The SID of a group in the directory connected to the Transfer Server (e.g., `S-1-1-12-1234567890-123456789-1234567890-1234`) * `server_id` - (Required) The Server ID of the Transfer Server (e.g., `s-12345678`) * `home_directory` - (Optional) The landing directory (folder) for a user when they log in to the server using their SFTP client. It should begin with a `/`. The first item in the path is the name of the home bucket (accessible as `${Transfer:HomeBucket}` in the policy) and the rest is the home directory (accessible as `${Transfer:HomeDirectory}` in the policy). For example, `/example-bucket-1234/username` would set the home bucket to `example-bucket-1234` and the home directory to `username`. @@ -119,4 +120,4 @@ Using `terraform import`, import Transfer Accesses using the `server_id` and `ex % terraform import aws_transfer_access.example s-12345678/S-1-1-12-1234567890-123456789-1234567890-1234 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/transfer_agreement.html.markdown b/website/docs/cdktf/python/r/transfer_agreement.html.markdown index 93e2e01c2a69..d161a8100dce 100644 --- a/website/docs/cdktf/python/r/transfer_agreement.html.markdown +++ b/website/docs/cdktf/python/r/transfer_agreement.html.markdown @@ -42,6 +42,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `access_role` - (Required) The IAM Role which provides read and write access to the parent directory of the file location mentioned in the StartFileTransfer request. * `base_directory` - (Required) The landing directory for the files transferred by using the AS2 protocol. * `description` - (Optional) The Optional description of the transdfer. @@ -83,4 +84,4 @@ Using `terraform import`, import Transfer AS2 Agreement using the `server_id/agr % terraform import aws_transfer_agreement.example s-4221a88afd5f4362a/a-4221a88afd5f4362a ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/transfer_certificate.html.markdown b/website/docs/cdktf/python/r/transfer_certificate.html.markdown index 0f54594da399..6a36f51ef591 100644 --- a/website/docs/cdktf/python/r/transfer_certificate.html.markdown +++ b/website/docs/cdktf/python/r/transfer_certificate.html.markdown @@ -44,6 +44,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `certificate` - (Required) The valid certificate file required for the transfer. * `certificate_chain` - (Optional) The optional list of certificate that make up the chain for the certificate that is being imported. * `description` - (Optional) A short description that helps identify the certificate. @@ -85,4 +86,4 @@ Using `terraform import`, import Transfer AS2 Certificate using the `certificate % terraform import aws_transfer_certificate.example c-4221a88afd5f4362a ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/transfer_connector.html.markdown b/website/docs/cdktf/python/r/transfer_connector.html.markdown index aa58953fc05d..84a9a2e19788 100644 --- a/website/docs/cdktf/python/r/transfer_connector.html.markdown +++ b/website/docs/cdktf/python/r/transfer_connector.html.markdown @@ -72,6 +72,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `access_role` - (Required) The IAM Role which provides read and write access to the parent directory of the file location mentioned in the StartFileTransfer request. * `as2_config` - (Optional) Either SFTP or AS2 is configured.The parameters to configure for the connector object. Fields documented below. * `logging_role` - (Optional) The IAM Role which is required for allowing the connector to turn on CloudWatch logging for Amazon S3 events. @@ -128,4 +129,4 @@ Using `terraform import`, import Transfer AS2 Connector using the `connector_id` % terraform import aws_transfer_connector.example c-4221a88afd5f4362a ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/transfer_profile.html.markdown b/website/docs/cdktf/python/r/transfer_profile.html.markdown index 3c603586ef14..556c9f93151d 100644 --- a/website/docs/cdktf/python/r/transfer_profile.html.markdown +++ b/website/docs/cdktf/python/r/transfer_profile.html.markdown @@ -42,6 +42,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `as2_id` - (Required) The As2Id is the AS2 name as defined in the RFC 4130. For inbound ttransfers this is the AS2 From Header for the AS2 messages sent from the partner. For Outbound messages this is the AS2 To Header for the AS2 messages sent to the partner. his ID cannot include spaces. * `certificate_ids` - (Optional) The list of certificate Ids from the imported certificate operation. * `profile_type` - (Required) The profile type should be LOCAL or PARTNER. @@ -79,4 +80,4 @@ Using `terraform import`, import Transfer AS2 Profile using the `profile_id`. Fo % terraform import aws_transfer_profile.example p-4221a88afd5f4362a ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/transfer_server.html.markdown b/website/docs/cdktf/python/r/transfer_server.html.markdown index c50178e0780b..cec60f0a6998 100644 --- a/website/docs/cdktf/python/r/transfer_server.html.markdown +++ b/website/docs/cdktf/python/r/transfer_server.html.markdown @@ -201,6 +201,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `certificate` - (Optional) The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) certificate. This is required when `protocols` is set to `FTPS` * `domain` - (Optional) The domain of the storage system that is used for file transfers. Valid values are: `S3` and `EFS`. The default value is `S3`. * `protocols` - (Optional) Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. This defaults to `SFTP` . The available protocols are: @@ -332,4 +333,4 @@ Using `terraform import`, import Transfer Servers using the server `id`. For exa Certain resource arguments, such as `host_key`, cannot be read via the API and imported into Terraform. Terraform will display a difference for these arguments the first run after import if declared in the Terraform configuration for an imported resource. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/transfer_ssh_key.html.markdown b/website/docs/cdktf/python/r/transfer_ssh_key.html.markdown index 66d38f2560e2..ce701a62e2e5 100644 --- a/website/docs/cdktf/python/r/transfer_ssh_key.html.markdown +++ b/website/docs/cdktf/python/r/transfer_ssh_key.html.markdown @@ -106,6 +106,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `server_id` - (Requirement) The Server ID of the Transfer Server (e.g., `s-12345678`) * `user_name` - (Requirement) The name of the user account that is assigned to one or more servers. * `body` - (Requirement) The public key portion of an SSH key pair. @@ -139,4 +140,4 @@ Using `terraform import`, import Transfer SSH Public Key using the `server_id` a % terraform import aws_transfer_ssh_key.bar s-12345678/test-username/key-12345 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/transfer_tag.html.markdown b/website/docs/cdktf/python/r/transfer_tag.html.markdown index e058213b0dae..a15e162eab08 100644 --- a/website/docs/cdktf/python/r/transfer_tag.html.markdown +++ b/website/docs/cdktf/python/r/transfer_tag.html.markdown @@ -50,6 +50,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `resource_arn` - (Required) Amazon Resource Name (ARN) of the Transfer Family resource to tag. * `key` - (Required) Tag name. * `value` - (Required) Tag value. @@ -85,4 +86,4 @@ Using `terraform import`, import `aws_transfer_tag` using the Transfer Family re % terraform import aws_transfer_tag.example arn:aws:transfer:us-east-1:123456789012:server/s-1234567890abcdef0,Name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/transfer_user.html.markdown b/website/docs/cdktf/python/r/transfer_user.html.markdown index 90191629b2b5..1adf2a8ccd7d 100644 --- a/website/docs/cdktf/python/r/transfer_user.html.markdown +++ b/website/docs/cdktf/python/r/transfer_user.html.markdown @@ -93,6 +93,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `server_id` - (Required) The Server ID of the Transfer Server (e.g., `s-12345678`) * `user_name` - (Required) The name used for log in to your SFTP server. * `home_directory` - (Optional) The landing directory (folder) for a user when they log in to the server using their SFTP client. It should begin with a `/`. The first item in the path is the name of the home bucket (accessible as `${Transfer:HomeBucket}` in the policy) and the rest is the home directory (accessible as `${Transfer:HomeDirectory}` in the policy). For example, `/example-bucket-1234/username` would set the home bucket to `example-bucket-1234` and the home directory to `username`. @@ -163,4 +164,4 @@ Using `terraform import`, import Transfer Users using the `server_id` and `user_ % terraform import aws_transfer_user.bar s-12345678/test-username ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/transfer_workflow.html.markdown b/website/docs/cdktf/python/r/transfer_workflow.html.markdown index 391d21b5c70b..8c5ad4c35481 100644 --- a/website/docs/cdktf/python/r/transfer_workflow.html.markdown +++ b/website/docs/cdktf/python/r/transfer_workflow.html.markdown @@ -83,6 +83,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `description` - (Optional) A textual description for the workflow. * `on_exception_steps` - (Optional) Specifies the steps (actions) to take if errors are encountered during execution of the workflow. See Workflow Steps below. * `steps` - (Required) Specifies the details for the steps that are in the specified workflow. See Workflow Steps below. @@ -183,4 +184,4 @@ Using `terraform import`, import Transfer Workflows using the `worflow_id`. For % terraform import aws_transfer_workflow.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/verifiedaccess_endpoint.html.markdown b/website/docs/cdktf/python/r/verifiedaccess_endpoint.html.markdown index fbd6376c432e..2defd8d2a6b8 100644 --- a/website/docs/cdktf/python/r/verifiedaccess_endpoint.html.markdown +++ b/website/docs/cdktf/python/r/verifiedaccess_endpoint.html.markdown @@ -121,6 +121,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `application_domain` - (Optional) The DNS name for users to reach your application. This parameter is required if the endpoint type is `load-balancer` or `network-interface`. * `description` - (Optional) A description for the Verified Access endpoint. * `domain_certificate_arn` - (Optional) - The ARN of the public TLS/SSL certificate in AWS Certificate Manager to associate with the endpoint. The CN in the certificate must match the DNS name your end users will use to reach your application. This parameter is required if the endpoint type is `load-balancer` or `network-interface`. @@ -173,4 +174,4 @@ Using `terraform import`, import Verified Access Instances using the `id`. For % terraform import aws_verifiedaccess_endpoint.example vae-8012925589 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/verifiedaccess_group.html.markdown b/website/docs/cdktf/python/r/verifiedaccess_group.html.markdown index 50612ee19672..2b1ff404f87f 100644 --- a/website/docs/cdktf/python/r/verifiedaccess_group.html.markdown +++ b/website/docs/cdktf/python/r/verifiedaccess_group.html.markdown @@ -67,6 +67,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `description` - (Optional) Description of the verified access group. * `policy_document` - (Optional) The policy document that is associated with this resource. * `sse_configuration` - (Optional) Configuration block to use KMS keys for server-side encryption. @@ -93,4 +94,4 @@ This resource exports the following attributes in addition to the arguments abov * `update` - (Default `180m`) * `delete` - (Default `90m`) - + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/verifiedaccess_instance.html.markdown b/website/docs/cdktf/python/r/verifiedaccess_instance.html.markdown index ac6e701e1877..49617530261e 100644 --- a/website/docs/cdktf/python/r/verifiedaccess_instance.html.markdown +++ b/website/docs/cdktf/python/r/verifiedaccess_instance.html.markdown @@ -78,6 +78,7 @@ class MyConvertedCode(TerraformStack): The following arguments are optional: +* `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). * `description` - (Optional) A description for the AWS Verified Access Instance. * `fips_enabled` - (Optional, Forces new resource) Enable or disable support for Federal Information Processing Standards (FIPS) on the AWS Verified Access Instance. * `cidr_endpoints_custom_subdomain` - (Optional) The custom subdomain for the CIDR endpoints. @@ -127,4 +128,4 @@ Using `terraform import`, import Verified Access Instances using the `id`. For % terraform import aws_verifiedaccess_instance.example vai-1234567890abcdef0 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/verifiedaccess_instance_logging_configuration.html.markdown b/website/docs/cdktf/python/r/verifiedaccess_instance_logging_configuration.html.markdown index a1c312a95a1a..1ccfba5527ff 100644 --- a/website/docs/cdktf/python/r/verifiedaccess_instance_logging_configuration.html.markdown +++ b/website/docs/cdktf/python/r/verifiedaccess_instance_logging_configuration.html.markdown @@ -171,6 +171,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `access_logs` - (Required) A block that specifies the configuration options for Verified Access instances. [Detailed below](#access_logs). * `verifiedaccess_instance_id` - (Required - Forces New resource) The ID of the Verified Access instance. @@ -236,4 +237,4 @@ Using `terraform import`, import Verified Access Logging Configuration using the % terraform import aws_verifiedaccess_instance_logging_configuration.example vai-1234567890abcdef0 ``` - + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/verifiedaccess_instance_trust_provider_attachment.html.markdown b/website/docs/cdktf/python/r/verifiedaccess_instance_trust_provider_attachment.html.markdown index 4b81e97ad698..e90fafee6f7f 100644 --- a/website/docs/cdktf/python/r/verifiedaccess_instance_trust_provider_attachment.html.markdown +++ b/website/docs/cdktf/python/r/verifiedaccess_instance_trust_provider_attachment.html.markdown @@ -51,8 +51,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `verifiedaccess_instance_id` - (Required) The ID of the Verified Access instance to attach the Trust Provider to. * `verifiedaccess_trust_provider_id` - (Required) The ID of the Verified Access trust provider. @@ -87,4 +88,4 @@ Using `terraform import`, import Verified Access Instance Trust Provider Attachm % terraform import aws_verifiedaccess_instance_trust_provider_attachment.example vai-1234567890abcdef0/vatp-8012925589 ``` - + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/verifiedaccess_trust_provider.html.markdown b/website/docs/cdktf/python/r/verifiedaccess_trust_provider.html.markdown index 8ddedf49877a..7a36701e5457 100644 --- a/website/docs/cdktf/python/r/verifiedaccess_trust_provider.html.markdown +++ b/website/docs/cdktf/python/r/verifiedaccess_trust_provider.html.markdown @@ -42,6 +42,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `description` - (Optional) A description for the AWS Verified Access trust provider. * `device_options` - (Optional) A block of options for device identity based trust providers. * `device_trust_provider_type` (Optional) The type of device-based trust provider. @@ -89,4 +90,4 @@ Using `terraform import`, import Transfer Workflows using the `id`. For example % terraform import aws_verifiedaccess_trust_provider.example vatp-8012925589 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/verifiedpermissions_identity_source.html.markdown b/website/docs/cdktf/python/r/verifiedpermissions_identity_source.html.markdown index 5f639c8075f7..868489eddb85 100644 --- a/website/docs/cdktf/python/r/verifiedpermissions_identity_source.html.markdown +++ b/website/docs/cdktf/python/r/verifiedpermissions_identity_source.html.markdown @@ -121,6 +121,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `policy_store_id` - (Required) Specifies the ID of the policy store in which you want to store this identity source. * `configuration`- (Required) Specifies the details required to communicate with the identity provider (IdP) associated with this identity source. See [Configuration](#configuration) below. * `principal_entity_type`- (Optional) Specifies the namespace and data type of the principals generated for identities authenticated by the new identity source. @@ -198,4 +199,4 @@ Using `terraform import`, import Verified Permissions Identity Source using the % terraform import aws_verifiedpermissions_identity_source.example policy-store-id-12345678:identity-source-id-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/verifiedpermissions_policy.html.markdown b/website/docs/cdktf/python/r/verifiedpermissions_policy.html.markdown index 818b771ee54a..aa097be166b5 100644 --- a/website/docs/cdktf/python/r/verifiedpermissions_policy.html.markdown +++ b/website/docs/cdktf/python/r/verifiedpermissions_policy.html.markdown @@ -42,8 +42,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `policy_store_id` - (Required) The Policy Store ID of the policy store. * `definition`- (Required) The definition of the policy. See [Definition](#definition) below. @@ -99,4 +100,4 @@ Using `terraform import`, import Verified Permissions Policy using the `policy_i % terraform import aws_verifiedpermissions_policy.example policy-id-12345678,policy-store-id-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/verifiedpermissions_policy_store.html.markdown b/website/docs/cdktf/python/r/verifiedpermissions_policy_store.html.markdown index a17d493610fd..a0796fe741fb 100644 --- a/website/docs/cdktf/python/r/verifiedpermissions_policy_store.html.markdown +++ b/website/docs/cdktf/python/r/verifiedpermissions_policy_store.html.markdown @@ -45,6 +45,8 @@ The following arguments are required: The following arguments are optional: +* `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). +* `deletion_protection` - (Optional) Specifies whether the policy store can be deleted. If enabled, the policy store can't be deleted. Valid Values: `ENABLED`, `DISABLED`. Default value: `DISABLED`. * `description` - (Optional) A description of the Policy Store. * `tags` - (Optional) Key-value mapping of resource tags. If configured with a provider [`default_tags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. @@ -81,4 +83,4 @@ Using `terraform import`, import Verified Permissions Policy Store using the `po % terraform import aws_verifiedpermissions_policy_store.example DxQg2j8xvXJQ1tQCYNWj9T ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/verifiedpermissions_policy_template.html.markdown b/website/docs/cdktf/python/r/verifiedpermissions_policy_template.html.markdown index 4f70103610dd..3cdb22347606 100644 --- a/website/docs/cdktf/python/r/verifiedpermissions_policy_template.html.markdown +++ b/website/docs/cdktf/python/r/verifiedpermissions_policy_template.html.markdown @@ -42,6 +42,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `description` - (Optional) Provides a description for the policy template. ## Attribute Reference @@ -76,4 +77,4 @@ Using `terraform import`, import Verified Permissions Policy Store using the `po % terraform import aws_verifiedpermissions_policy_template.example policyStoreId:policyTemplateId ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/verifiedpermissions_schema.html.markdown b/website/docs/cdktf/python/r/verifiedpermissions_schema.html.markdown index 619ee0a779f5..1a18b7c7126c 100644 --- a/website/docs/cdktf/python/r/verifiedpermissions_schema.html.markdown +++ b/website/docs/cdktf/python/r/verifiedpermissions_schema.html.markdown @@ -29,15 +29,15 @@ class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) VerifiedpermissionsSchema(self, "example", - definition=[{ - "value": Token.as_string( + definition=[VerifiedpermissionsSchemaDefinition( + value=Token.as_string( Fn.jsonencode({ "Namespace": { "actions": {}, "entity_types": {} } })) - } + ) ], policy_store_id=Token.as_string(aws_verifiedpermissions_policy_store_example.policy_store_id) ) @@ -45,8 +45,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `policy_store_id` - (Required) The ID of the Policy Store. * `definition` - (Required) The definition of the schema. * `value` - (Required) A JSON string representation of the schema. @@ -82,4 +83,4 @@ Using `terraform import`, import Verified Permissions Policy Store Schema using % terraform import aws_verifiedpermissions_schema.example DxQg2j8xvXJQ1tQCYNWj9T ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/volume_attachment.html.markdown b/website/docs/cdktf/python/r/volume_attachment.html.markdown index e4415a7865a3..3b248d737c57 100644 --- a/website/docs/cdktf/python/r/volume_attachment.html.markdown +++ b/website/docs/cdktf/python/r/volume_attachment.html.markdown @@ -54,6 +54,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `device_name` - (Required) The device name to expose to the instance (for example, `/dev/sdh` or `xvdh`). See [Device Naming on Linux Instances][1] and [Device Naming on Windows Instances][2] for more information. * `instance_id` - (Required) ID of the Instance to attach to @@ -107,4 +108,4 @@ Using `terraform import`, import EBS Volume Attachments using `DEVICE_NAME:VOLUM [2]: https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/device_naming.html#available-ec2-device-names [3]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-detaching-volume.html - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/vpc.html.markdown b/website/docs/cdktf/python/r/vpc.html.markdown index 9039000889bc..c32007558b57 100644 --- a/website/docs/cdktf/python/r/vpc.html.markdown +++ b/website/docs/cdktf/python/r/vpc.html.markdown @@ -77,14 +77,14 @@ class MyConvertedCode(TerraformStack): current = DataAwsRegion(self, "current") test = VpcIpam(self, "test", operating_regions=[VpcIpamOperatingRegions( - region_name=Token.as_string(current.name) + region_name=Token.as_string(current.region) ) ] ) aws_vpc_ipam_pool_test = VpcIpamPool(self, "test_2", address_family="ipv4", ipam_scope_id=test.private_default_scope_id, - locale=Token.as_string(current.name) + locale=Token.as_string(current.region) ) # 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_vpc_ipam_pool_test.override_logical_id("test") @@ -107,6 +107,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `cidr_block` - (Optional) The IPv4 CIDR block for the VPC. CIDR can be explicitly set or it can be derived from IPAM using `ipv4_netmask_length`. * `instance_tenancy` - (Optional) A tenancy option for instances launched into the VPC. Default is `default`, which ensures that EC2 instances launched in this VPC use the EC2 instance tenancy attribute specified when the EC2 instance is launched. The only other option is `dedicated`, which ensures that EC2 instances launched in this VPC are run on dedicated tenancy instances regardless of the tenancy attribute specified at launch. This has a dedicated per region fee of $2 per hour, plus an hourly per instance usage fee. * `ipv4_ipam_pool_id` - (Optional) The ID of an IPv4 IPAM pool you want to use for allocating this VPC's CIDR. IPAM is a VPC feature that you can use to automate your IP address management workflows including assigning, tracking, troubleshooting, and auditing IP addresses across AWS Regions and accounts. Using IPAM you can monitor IP address usage throughout your AWS Organization. @@ -168,4 +169,4 @@ Using `terraform import`, import VPCs using the VPC `id`. For example: % terraform import aws_vpc.test_vpc vpc-a01106c2 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/vpc_block_public_access_exclusion.html.markdown b/website/docs/cdktf/python/r/vpc_block_public_access_exclusion.html.markdown index 747143f85bc7..8da1547957c5 100644 --- a/website/docs/cdktf/python/r/vpc_block_public_access_exclusion.html.markdown +++ b/website/docs/cdktf/python/r/vpc_block_public_access_exclusion.html.markdown @@ -24,8 +24,8 @@ 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 VpcBlockPublicAccessExclusion from imports.aws.vpc import Vpc +from imports.aws.vpc_block_public_access_exclusion import VpcBlockPublicAccessExclusion class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) @@ -46,14 +46,14 @@ class MyConvertedCode(TerraformStack): ```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 +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. import VpcBlockPublicAccessExclusion from imports.aws.subnet import Subnet from imports.aws.vpc import Vpc +from imports.aws.vpc_block_public_access_exclusion import VpcBlockPublicAccessExclusion class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) @@ -69,7 +69,7 @@ class MyConvertedCode(TerraformStack): aws_vpc_block_public_access_exclusion_test = VpcBlockPublicAccessExclusion(self, "test_2", internet_gateway_exclusion_mode="allow-egress", - subnet_id=aws_subnet_test.id + subnet_id=Token.as_string(aws_subnet_test.id) ) # 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_vpc_block_public_access_exclusion_test.override_logical_id("test") @@ -83,6 +83,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `vpc_id` - (Optional) Id of the VPC to which this exclusion applies. Either this or the subnet_id needs to be provided. * `subnet_id` - (Optional) Id of the subnet to which this exclusion applies. Either this or the vpc_id needs to be provided. * `tags` - (Optional) A map of tags to assign to the exclusion. 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. @@ -115,7 +116,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 VpcBlockPublicAccessExclusion +from imports.aws.vpc_block_public_access_exclusion import VpcBlockPublicAccessExclusion class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) @@ -128,4 +129,4 @@ Using `terraform import`, import EC2 (Elastic Compute Cloud) VPC Block Public Ac % terraform import aws_vpc_block_public_access_exclusion.example vpcbpa-exclude-1234abcd ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/vpc_block_public_access_options.html.markdown b/website/docs/cdktf/python/r/vpc_block_public_access_options.html.markdown index 6da3706e92a9..899ace4e153b 100644 --- a/website/docs/cdktf/python/r/vpc_block_public_access_options.html.markdown +++ b/website/docs/cdktf/python/r/vpc_block_public_access_options.html.markdown @@ -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 VpcBlockPublicAccessOptions +from imports.aws.vpc_block_public_access_options import VpcBlockPublicAccessOptions class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) @@ -35,8 +35,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `internet_gateway_block_mode` - (Required) Block mode. Needs to be one of `block-bidirectional`, `block-ingress`, `off`. If this resource is deleted, then this value will be set to `off` in the AWS account and region. ## Attribute Reference @@ -66,7 +67,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 VpcBlockPublicAccessOptions +from imports.aws.vpc_block_public_access_options import VpcBlockPublicAccessOptions class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) @@ -79,4 +80,4 @@ Using `terraform import`, import VPC Block Public Access Options using the `aws_ % terraform import aws_vpc_block_public_access_options.example us-east-1 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/vpc_dhcp_options.html.markdown b/website/docs/cdktf/python/r/vpc_dhcp_options.html.markdown index 2ce8b3c111ac..3805e8449149 100644 --- a/website/docs/cdktf/python/r/vpc_dhcp_options.html.markdown +++ b/website/docs/cdktf/python/r/vpc_dhcp_options.html.markdown @@ -64,6 +64,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `domain_name` - (Optional) the suffix domain name to use by default when resolving non Fully Qualified Domain Names. In other words, this is what ends up being the `search` value in the `/etc/resolv.conf` file. * `domain_name_servers` - (Optional) List of name servers to configure in `/etc/resolv.conf`. If you want to use the default AWS nameservers you should set this to `AmazonProvidedDNS`. * `ipv6_address_preferred_lease_time` - (Optional) How frequently, in seconds, a running instance with an IPv6 assigned to it goes through DHCPv6 lease renewal. Acceptable values are between 140 and 2147483647 (approximately 68 years). If no value is entered, the default lease time is 140 seconds. If you use long-term addressing for EC2 instances, you can increase the lease time and avoid frequent lease renewal requests. Lease renewal typically occurs when half of the lease time has elapsed. @@ -117,4 +118,4 @@ Using `terraform import`, import VPC DHCP Options using the DHCP Options `id`. F % terraform import aws_vpc_dhcp_options.my_options dopt-d9070ebb ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/vpc_dhcp_options_association.html.markdown b/website/docs/cdktf/python/r/vpc_dhcp_options_association.html.markdown index c4892e12bbb5..db18115db32b 100644 --- a/website/docs/cdktf/python/r/vpc_dhcp_options_association.html.markdown +++ b/website/docs/cdktf/python/r/vpc_dhcp_options_association.html.markdown @@ -36,6 +36,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `vpc_id` - (Required) The ID of the VPC to which we would like to associate a DHCP Options Set. * `dhcp_options_id` - (Required) The ID of the DHCP Options Set to associate to the VPC. @@ -75,4 +76,4 @@ Using `terraform import`, import DHCP associations using the VPC ID associated w % terraform import aws_vpc_dhcp_options_association.imported vpc-0f001273ec18911b1 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/vpc_endpoint.html.markdown b/website/docs/cdktf/python/r/vpc_endpoint.html.markdown index d0c5e226e6f4..d25851cae1e1 100644 --- a/website/docs/cdktf/python/r/vpc_endpoint.html.markdown +++ b/website/docs/cdktf/python/r/vpc_endpoint.html.markdown @@ -243,6 +243,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `vpc_id` - (Required) The ID of the VPC in which the endpoint will be used. * `auto_accept` - (Optional) Accept the VPC endpoint (the VPC endpoint and service need to be in the same AWS account). * `policy` - (Optional) A policy to attach to the endpoint that controls access to the service. This is a JSON formatted string. Defaults to full access. All `Gateway` and some `Interface` endpoints support policies - see the [relevant AWS documentation](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-endpoints-access.html) for more details. For more information about building AWS IAM policy documents with Terraform, see the [AWS IAM Policy Document Guide](https://learn.hashicorp.com/terraform/aws/iam-policy). @@ -271,7 +272,7 @@ If no security groups are specified, the VPC's [default security group](https:// * `ipv4` - (Optional) The IPv4 address to assign to the endpoint network interface in the subnet. You must provide an IPv4 address if the VPC endpoint supports IPv4. * `ipv6` - (Optional) The IPv6 address to assign to the endpoint network interface in the subnet. You must provide an IPv6 address if the VPC endpoint supports IPv6. -* `subnet` - (Optional) The ID of the subnet. Must have a corresponding subnet in the `subnet_ids` argument. +* `subnet_id` - (Optional) The ID of the subnet. Must have a corresponding subnet in the `subnet_ids` argument. ## Timeouts @@ -326,4 +327,4 @@ Using `terraform import`, import VPC Endpoints using the VPC endpoint `id`. For % terraform import aws_vpc_endpoint.endpoint1 vpce-3ecf2a57 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/vpc_endpoint_connection_accepter.html.markdown b/website/docs/cdktf/python/r/vpc_endpoint_connection_accepter.html.markdown index 368feae950a2..5392b6f5b695 100644 --- a/website/docs/cdktf/python/r/vpc_endpoint_connection_accepter.html.markdown +++ b/website/docs/cdktf/python/r/vpc_endpoint_connection_accepter.html.markdown @@ -57,6 +57,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `vpc_endpoint_id` - (Required) AWS VPC Endpoint ID. * `vpc_endpoint_service_id` - (Required) AWS VPC Endpoint Service ID. @@ -92,4 +93,4 @@ Using `terraform import`, import VPC Endpoint Services using ID of the connectio % terraform import aws_vpc_endpoint_connection_accepter.foo vpce-svc-0f97a19d3fa8220bc_vpce-010601a6db371e263 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/vpc_endpoint_connection_notification.html.markdown b/website/docs/cdktf/python/r/vpc_endpoint_connection_notification.html.markdown index 3745cd9d5ec5..63e77f93b96b 100644 --- a/website/docs/cdktf/python/r/vpc_endpoint_connection_notification.html.markdown +++ b/website/docs/cdktf/python/r/vpc_endpoint_connection_notification.html.markdown @@ -67,6 +67,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `vpc_endpoint_service_id` - (Optional) The ID of the VPC Endpoint Service to receive notifications for. * `vpc_endpoint_id` - (Optional) The ID of the VPC Endpoint to receive notifications for. * `connection_notification_arn` - (Required) The ARN of the SNS topic for the notifications. @@ -107,4 +108,4 @@ Using `terraform import`, import VPC Endpoint connection notifications using the % terraform import aws_vpc_endpoint_connection_notification.foo vpce-nfn-09e6ed3b4efba2263 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/vpc_endpoint_policy.html.markdown b/website/docs/cdktf/python/r/vpc_endpoint_policy.html.markdown index c307dd5c70d3..d1993f6a4a8f 100644 --- a/website/docs/cdktf/python/r/vpc_endpoint_policy.html.markdown +++ b/website/docs/cdktf/python/r/vpc_endpoint_policy.html.markdown @@ -68,6 +68,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `vpc_endpoint_id` - (Required) The VPC Endpoint ID. * `policy` - (Optional) A policy to attach to the endpoint that controls access to the service. Defaults to full access. All `Gateway` and some `Interface` endpoints support policies - see the [relevant AWS documentation](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-endpoints-access.html) for more details. For more information about building AWS IAM policy documents with Terraform, see the [AWS IAM Policy Document Guide](https://learn.hashicorp.com/terraform/aws/iam-policy). @@ -102,4 +103,4 @@ Using `terraform import`, import VPC Endpoint Policies using the `id`. For examp % terraform import aws_vpc_endpoint_policy.example vpce-3ecf2a57 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/vpc_endpoint_private_dns.html.markdown b/website/docs/cdktf/python/r/vpc_endpoint_private_dns.html.markdown index 0198a1c9ed5b..f8b176cee954 100644 --- a/website/docs/cdktf/python/r/vpc_endpoint_private_dns.html.markdown +++ b/website/docs/cdktf/python/r/vpc_endpoint_private_dns.html.markdown @@ -38,8 +38,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `private_dns_enabled` - (Required) Indicates whether a private hosted zone is associated with the VPC. Only applicable for `Interface` endpoints. * `vpc_endpoint_id` - (Required) VPC endpoint identifier. @@ -72,4 +73,4 @@ Using `terraform import`, import a VPC (Virtual Private Cloud) Endpoint Private % terraform import aws_vpc_endpoint_private_dns.example vpce-abcd-1234 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/vpc_endpoint_route_table_association.html.markdown b/website/docs/cdktf/python/r/vpc_endpoint_route_table_association.html.markdown index 954572009b36..478215e2744c 100644 --- a/website/docs/cdktf/python/r/vpc_endpoint_route_table_association.html.markdown +++ b/website/docs/cdktf/python/r/vpc_endpoint_route_table_association.html.markdown @@ -36,6 +36,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `route_table_id` - (Required) Identifier of the EC2 Route Table to be associated with the VPC Endpoint. * `vpc_endpoint_id` - (Required) Identifier of the VPC Endpoint with which the EC2 Route Table will be associated. @@ -70,4 +71,4 @@ Using `terraform import`, import VPC Endpoint Route Table Associations using `vp % terraform import aws_vpc_endpoint_route_table_association.example vpce-aaaaaaaa/rtb-bbbbbbbb ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/vpc_endpoint_security_group_association.html.markdown b/website/docs/cdktf/python/r/vpc_endpoint_security_group_association.html.markdown index b65d8f13b10d..037aaf76e593 100644 --- a/website/docs/cdktf/python/r/vpc_endpoint_security_group_association.html.markdown +++ b/website/docs/cdktf/python/r/vpc_endpoint_security_group_association.html.markdown @@ -44,6 +44,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `security_group_id` - (Required) The ID of the security group to be associated with the VPC endpoint. * `vpc_endpoint_id` - (Required) The ID of the VPC endpoint with which the security group will be associated. * `replace_default_association` - (Optional) Whether this association should replace the association with the VPC's default security group that is created when no security groups are specified during VPC endpoint creation. At most 1 association per-VPC endpoint should be configured with `replace_default_association = true`. `false` should be used when importing resources. @@ -79,4 +80,4 @@ Using `terraform import`, import VPC Endpoint Security Group Associations using % terraform import aws_vpc_endpoint_security_group_association.example vpce-aaaaaaaa/sg-bbbbbbbbbbbbbbbbb ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/vpc_endpoint_service.html.markdown b/website/docs/cdktf/python/r/vpc_endpoint_service.html.markdown index eef130bd24a8..6713e800ecd4 100644 --- a/website/docs/cdktf/python/r/vpc_endpoint_service.html.markdown +++ b/website/docs/cdktf/python/r/vpc_endpoint_service.html.markdown @@ -65,6 +65,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `acceptance_required` - (Required) Whether or not VPC endpoint connection requests to the service must be accepted by the service owner - `true` or `false`. * `allowed_principals` - (Optional) The ARNs of one or more principals allowed to discover the endpoint service. * `gateway_load_balancer_arns` - (Optional) Amazon Resource Names (ARNs) of one or more Gateway Load Balancers for the endpoint service. @@ -118,4 +119,4 @@ Using `terraform import`, import VPC Endpoint Services using the VPC endpoint se % terraform import aws_vpc_endpoint_service.foo vpce-svc-0f97a19d3fa8220bc ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/vpc_endpoint_service_allowed_principal.html.markdown b/website/docs/cdktf/python/r/vpc_endpoint_service_allowed_principal.html.markdown index 67ae977ebbef..1a15f4f2866e 100644 --- a/website/docs/cdktf/python/r/vpc_endpoint_service_allowed_principal.html.markdown +++ b/website/docs/cdktf/python/r/vpc_endpoint_service_allowed_principal.html.markdown @@ -46,6 +46,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `vpc_endpoint_service_id` - (Required) The ID of the VPC endpoint service to allow permission. * `principal_arn` - (Required) The ARN of the principal to allow permissions. @@ -55,4 +56,4 @@ This resource exports the following attributes in addition to the arguments abov * `id` - The ID of the association. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/vpc_endpoint_service_private_dns_verification.html.markdown b/website/docs/cdktf/python/r/vpc_endpoint_service_private_dns_verification.html.markdown index a63467298a59..08b20768a823 100644 --- a/website/docs/cdktf/python/r/vpc_endpoint_service_private_dns_verification.html.markdown +++ b/website/docs/cdktf/python/r/vpc_endpoint_service_private_dns_verification.html.markdown @@ -46,6 +46,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `wait_for_verification` - (Optional) Whether to wait until the endpoint service returns a `Verified` status for the configured private DNS name. ## Attribute Reference @@ -62,4 +63,4 @@ This resource exports no additional attributes. You cannot import this resource. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/vpc_endpoint_subnet_association.html.markdown b/website/docs/cdktf/python/r/vpc_endpoint_subnet_association.html.markdown index 4c527d37fdf0..a44d50b03e4f 100644 --- a/website/docs/cdktf/python/r/vpc_endpoint_subnet_association.html.markdown +++ b/website/docs/cdktf/python/r/vpc_endpoint_subnet_association.html.markdown @@ -44,6 +44,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `vpc_endpoint_id` - (Required) The ID of the VPC endpoint with which the subnet will be associated. * `subnet_id` - (Required) The ID of the subnet to be associated with the VPC endpoint. @@ -85,4 +86,4 @@ Using `terraform import`, import VPC Endpoint Subnet Associations using `vpc_end % terraform import aws_vpc_endpoint_subnet_association.example vpce-aaaaaaaa/subnet-bbbbbbbbbbbbbbbbb ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/vpc_ipam.html.markdown b/website/docs/cdktf/python/r/vpc_ipam.html.markdown index 419e7b09aa16..00fd402e2f96 100644 --- a/website/docs/cdktf/python/r/vpc_ipam.html.markdown +++ b/website/docs/cdktf/python/r/vpc_ipam.html.markdown @@ -33,7 +33,7 @@ class MyConvertedCode(TerraformStack): VpcIpam(self, "main", description="My IPAM", operating_regions=[VpcIpamOperatingRegions( - region_name=Token.as_string(current.name) + region_name=Token.as_string(current.region) ) ], tags={ @@ -65,7 +65,7 @@ class MyConvertedCode(TerraformStack): ) current = DataAwsRegion(self, "current") all_ipam_regions = Fn.distinct( - Token.as_any(Fn.concat([[current.name], ipam_regions.value]))) + Token.as_any(Fn.concat([[current.region], ipam_regions.value]))) # In most cases loops should be handled in the programming language context and # not inside of the Terraform context. If you are looping over something external, e.g. a variable or a file input # you should consider using a for loop. If you are looping over something only known to Terraform, e.g. a result of a data source @@ -84,9 +84,11 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `cascade` - (Optional) Enables you to quickly delete an IPAM, private scopes, pools in private scopes, and any allocations in the pools in private scopes. * `description` - (Optional) A description for the IPAM. * `enable_private_gua` - (Optional) Enable this option to use your own GUA ranges as private IPv6 addresses. Default: `false`. +* `metered_account` - (Optional) AWS account that is charged for active IP addresses managed in IPAM. Valid values are `ipam-owner` (default) and `resource-owner`. * `operating_regions` - (Required) Determines which locales can be chosen when you create pools. Locale is the Region where you want to make an IPAM pool available for allocations. You can only create pools with locales that match the operating Regions of the IPAM. You can only create VPCs from a pool whose locale matches the VPC's Region. You specify a region using the [region_name](#operating_regions) parameter. You **must** set your provider block region as an operating_region. * `tier` - (Optional) specifies the IPAM tier. Valid options include `free` and `advanced`. Default is `advanced`. * `tags` - (Optional) A 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. @@ -134,4 +136,4 @@ Using `terraform import`, import IPAMs using the IPAM `id`. For example: % terraform import aws_vpc_ipam.example ipam-0178368ad2146a492 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/vpc_ipam_pool.html.markdown b/website/docs/cdktf/python/r/vpc_ipam_pool.html.markdown index fc158d2bb4cb..492b4db5511b 100644 --- a/website/docs/cdktf/python/r/vpc_ipam_pool.html.markdown +++ b/website/docs/cdktf/python/r/vpc_ipam_pool.html.markdown @@ -33,14 +33,14 @@ class MyConvertedCode(TerraformStack): current = DataAwsRegion(self, "current") example = VpcIpam(self, "example", operating_regions=[VpcIpamOperatingRegions( - region_name=Token.as_string(current.name) + region_name=Token.as_string(current.region) ) ] ) aws_vpc_ipam_pool_example = VpcIpamPool(self, "example_2", address_family="ipv4", ipam_scope_id=example.private_default_scope_id, - locale=Token.as_string(current.name) + locale=Token.as_string(current.region) ) # 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_vpc_ipam_pool_example.override_logical_id("example") @@ -66,7 +66,7 @@ class MyConvertedCode(TerraformStack): current = DataAwsRegion(self, "current") example = VpcIpam(self, "example", operating_regions=[VpcIpamOperatingRegions( - region_name=Token.as_string(current.name) + region_name=Token.as_string(current.region) ) ] ) @@ -81,7 +81,7 @@ class MyConvertedCode(TerraformStack): child = VpcIpamPool(self, "child", address_family="ipv4", ipam_scope_id=example.private_default_scope_id, - locale=Token.as_string(current.name), + locale=Token.as_string(current.region), source_ipam_pool_id=parent.id ) VpcIpamPoolCidr(self, "child_test", @@ -94,6 +94,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `address_family` - (Required) The IP protocol assigned to this pool. You must choose either IPv4 or IPv6 protocol for a pool. * `allocation_default_netmask_length` - (Optional) A default netmask length for allocations added to this pool. If, for example, the CIDR assigned to this pool is 10.0.0.0/8 and you enter 16 here, new allocations will default to 10.0.0.0/16 (unless you provide a different netmask value when you create the new allocation). * `allocation_max_netmask_length` - (Optional) The maximum netmask length that will be required for CIDR allocations in this pool. @@ -145,4 +146,4 @@ Using `terraform import`, import IPAMs using the IPAM pool `id`. For example: % terraform import aws_vpc_ipam_pool.example ipam-pool-0958f95207d978e1e ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/vpc_ipam_pool_cidr.html.markdown b/website/docs/cdktf/python/r/vpc_ipam_pool_cidr.html.markdown index 727d1c93a566..b26c90d34d4c 100644 --- a/website/docs/cdktf/python/r/vpc_ipam_pool_cidr.html.markdown +++ b/website/docs/cdktf/python/r/vpc_ipam_pool_cidr.html.markdown @@ -39,14 +39,14 @@ class MyConvertedCode(TerraformStack): current = DataAwsRegion(self, "current") example = VpcIpam(self, "example", operating_regions=[VpcIpamOperatingRegions( - region_name=Token.as_string(current.name) + region_name=Token.as_string(current.region) ) ] ) aws_vpc_ipam_pool_example = VpcIpamPool(self, "example_2", address_family="ipv4", ipam_scope_id=example.private_default_scope_id, - locale=Token.as_string(current.name) + locale=Token.as_string(current.region) ) # 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_vpc_ipam_pool_example.override_logical_id("example") @@ -78,7 +78,7 @@ class MyConvertedCode(TerraformStack): current = DataAwsRegion(self, "current") example = VpcIpam(self, "example", operating_regions=[VpcIpamOperatingRegions( - region_name=Token.as_string(current.name) + region_name=Token.as_string(current.region) ) ] ) @@ -103,6 +103,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `cidr` - (Optional) The CIDR you want to assign to the pool. Conflicts with `netmask_length`. * `cidr_authorization_context` - (Optional) A signed document that proves that you are authorized to bring the specified IP address range to Amazon using BYOIP. This is not stored in the state file. See [cidr_authorization_context](#cidr_authorization_context) for more information. * `ipam_pool_id` - (Required) The ID of the pool to which you want to assign a CIDR. @@ -149,4 +150,4 @@ Using `terraform import`, import IPAMs using the `_`. For ex % terraform import aws_vpc_ipam_pool_cidr.example 172.20.0.0/24_ipam-pool-0e634f5a1517cccdc ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/vpc_ipam_pool_cidr_allocation.html.markdown b/website/docs/cdktf/python/r/vpc_ipam_pool_cidr_allocation.html.markdown index f5d60b72f802..30adb5a40a43 100644 --- a/website/docs/cdktf/python/r/vpc_ipam_pool_cidr_allocation.html.markdown +++ b/website/docs/cdktf/python/r/vpc_ipam_pool_cidr_allocation.html.markdown @@ -35,14 +35,14 @@ class MyConvertedCode(TerraformStack): current = DataAwsRegion(self, "current") example = VpcIpam(self, "example", operating_regions=[VpcIpamOperatingRegions( - region_name=Token.as_string(current.name) + region_name=Token.as_string(current.region) ) ] ) aws_vpc_ipam_pool_example = VpcIpamPool(self, "example_2", address_family="ipv4", ipam_scope_id=example.private_default_scope_id, - locale=Token.as_string(current.name) + locale=Token.as_string(current.region) ) # 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_vpc_ipam_pool_example.override_logical_id("example") @@ -82,14 +82,14 @@ class MyConvertedCode(TerraformStack): current = DataAwsRegion(self, "current") example = VpcIpam(self, "example", operating_regions=[VpcIpamOperatingRegions( - region_name=Token.as_string(current.name) + region_name=Token.as_string(current.region) ) ] ) aws_vpc_ipam_pool_example = VpcIpamPool(self, "example_2", address_family="ipv4", ipam_scope_id=example.private_default_scope_id, - locale=Token.as_string(current.name) + locale=Token.as_string(current.region) ) # 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_vpc_ipam_pool_example.override_logical_id("example") @@ -113,6 +113,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `cidr` - (Optional, Forces new resource) The CIDR you want to assign to the pool. * `description` - (Optional, Forces new resource) The description for the allocation. * `disallowed_cidrs` - (Optional, Forces new resource) Exclude a particular CIDR range from being returned by the pool. @@ -153,4 +154,4 @@ Using `terraform import`, import IPAM allocations using the allocation `id` and % terraform import aws_vpc_ipam_pool_cidr_allocation.example ipam-pool-alloc-0dc6d196509c049ba8b549ff99f639736_ipam-pool-07cfb559e0921fcbe ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/vpc_ipam_preview_next_cidr.html.markdown b/website/docs/cdktf/python/r/vpc_ipam_preview_next_cidr.html.markdown index f17617595c98..df49970c71af 100644 --- a/website/docs/cdktf/python/r/vpc_ipam_preview_next_cidr.html.markdown +++ b/website/docs/cdktf/python/r/vpc_ipam_preview_next_cidr.html.markdown @@ -35,14 +35,14 @@ class MyConvertedCode(TerraformStack): current = DataAwsRegion(self, "current") example = VpcIpam(self, "example", operating_regions=[VpcIpamOperatingRegions( - region_name=Token.as_string(current.name) + region_name=Token.as_string(current.region) ) ] ) aws_vpc_ipam_pool_example = VpcIpamPool(self, "example_2", address_family="ipv4", ipam_scope_id=example.private_default_scope_id, - locale=Token.as_string(current.name) + locale=Token.as_string(current.region) ) # 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_vpc_ipam_pool_example.override_logical_id("example") @@ -66,6 +66,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `disallowed_cidrs` - (Optional) Exclude a particular CIDR range from being returned by the pool. * `ipam_pool_id` - (Required) The ID of the pool to which you want to assign a CIDR. * `netmask_length` - (Optional) The netmask length of the CIDR you would like to preview from the IPAM pool. @@ -77,4 +78,4 @@ This resource exports the following attributes in addition to the arguments abov * `cidr` - The previewed CIDR from the pool. * `id` - The ID of the preview. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/vpc_ipam_resource_discovery.html.markdown b/website/docs/cdktf/python/r/vpc_ipam_resource_discovery.html.markdown index a64ee5041907..53864b273937 100644 --- a/website/docs/cdktf/python/r/vpc_ipam_resource_discovery.html.markdown +++ b/website/docs/cdktf/python/r/vpc_ipam_resource_discovery.html.markdown @@ -33,7 +33,7 @@ class MyConvertedCode(TerraformStack): VpcIpamResourceDiscovery(self, "main", description="My IPAM Resource Discovery", operating_regions=[VpcIpamResourceDiscoveryOperatingRegions( - region_name=Token.as_string(current.name) + region_name=Token.as_string(current.region) ) ], tags={ @@ -46,6 +46,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `description` - (Optional) A description for the IPAM Resource Discovery. * `operating_regions` - (Required) Determines which regions the Resource Discovery will enable IPAM features for usage and monitoring. Locale is the Region where you want to make an IPAM pool available for allocations. You can only create pools with locales that match the operating Regions of the IPAM Resource Discovery. You can only create VPCs from a pool whose locale matches the VPC's Region. You specify a region using the [region_name](#operating_regions) parameter. **You must set your provider block region as an operating_region.** * `tags` - (Optional) A 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. @@ -90,4 +91,4 @@ Using `terraform import`, import IPAMs using the IPAM resource discovery `id`. F % terraform import aws_vpc_ipam_resource_discovery.example ipam-res-disco-0178368ad2146a492 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/vpc_ipam_resource_discovery_association.html.markdown b/website/docs/cdktf/python/r/vpc_ipam_resource_discovery_association.html.markdown index 41504a91f2c4..60b5eff869ff 100644 --- a/website/docs/cdktf/python/r/vpc_ipam_resource_discovery_association.html.markdown +++ b/website/docs/cdktf/python/r/vpc_ipam_resource_discovery_association.html.markdown @@ -43,6 +43,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `ipam_id` - (Required) The ID of the IPAM to associate. * `ipam_resource_discovery_id` - (Required) The ID of the Resource Discovery to associate. * `tags` - (Optional) A map of tags to add to the IPAM resource discovery association resource. @@ -85,4 +86,4 @@ Using `terraform import`, import IPAMs using the IPAM resource discovery associa % terraform import aws_vpc_ipam_resource_discovery_association.example ipam-res-disco-assoc-0178368ad2146a492 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/vpc_ipam_scope.html.markdown b/website/docs/cdktf/python/r/vpc_ipam_scope.html.markdown index cee84178e91b..fba2a4a9b2fd 100644 --- a/website/docs/cdktf/python/r/vpc_ipam_scope.html.markdown +++ b/website/docs/cdktf/python/r/vpc_ipam_scope.html.markdown @@ -33,7 +33,7 @@ class MyConvertedCode(TerraformStack): current = DataAwsRegion(self, "current") example = VpcIpam(self, "example", operating_regions=[VpcIpamOperatingRegions( - region_name=Token.as_string(current.name) + region_name=Token.as_string(current.region) ) ] ) @@ -49,6 +49,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `ipam_id` - The ID of the IPAM for which you're creating this scope. * `description` - (Optional) A description for the scope you're creating. * `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. @@ -89,4 +90,4 @@ Using `terraform import`, import IPAMs using the `scope_id`. For example: % terraform import aws_vpc_ipam_scope.example ipam-scope-0513c69f283d11dfb ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/vpc_ipv4_cidr_block_association.html.markdown b/website/docs/cdktf/python/r/vpc_ipv4_cidr_block_association.html.markdown index c90d90bc2720..f861ad79fe70 100644 --- a/website/docs/cdktf/python/r/vpc_ipv4_cidr_block_association.html.markdown +++ b/website/docs/cdktf/python/r/vpc_ipv4_cidr_block_association.html.markdown @@ -43,6 +43,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `cidr_block` - (Optional) The IPv4 CIDR block for the VPC. CIDR can be explicitly set or it can be derived from IPAM using `ipv4_netmask_length`. * `ipv4_ipam_pool_id` - (Optional) The ID of an IPv4 IPAM pool you want to use for allocating this VPC's CIDR. IPAM is a VPC feature that you can use to automate your IP address management workflows including assigning, tracking, troubleshooting, and auditing IP addresses across AWS Regions and accounts. Using IPAM you can monitor IP address usage throughout your AWS Organization. * `ipv4_netmask_length` - (Optional) The netmask length of the IPv4 CIDR you want to allocate to this VPC. Requires specifying a `ipv4_ipam_pool_id`. @@ -132,4 +133,4 @@ or % terraform import aws_vpc_ipv4_cidr_block_association.example vpc-cidr-assoc-021e8461d70ed08be,ipam-pool-0a07c432810393463,28 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/vpc_ipv6_cidr_block_association.html.markdown b/website/docs/cdktf/python/r/vpc_ipv6_cidr_block_association.html.markdown index 0b9897557e80..4f6f1439e363 100644 --- a/website/docs/cdktf/python/r/vpc_ipv6_cidr_block_association.html.markdown +++ b/website/docs/cdktf/python/r/vpc_ipv6_cidr_block_association.html.markdown @@ -44,6 +44,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `assign_generated_ipv6_cidr_block` - (Optional) Requests an Amazon-provided IPv6 CIDR block with a /56 prefix length for the VPC. You cannot specify the range of IPv6 addresses, or the size of the CIDR block. Default is `false`. Conflicts with `ipv6_ipam_pool_id`, `ipv6_pool`, `ipv6_cidr_block` and `ipv6_netmask_length`. * `ipv6_cidr_block` - (Optional) The IPv6 CIDR block for the VPC. CIDR can be explicitly set or it can be derived from IPAM using `ipv6_netmask_length`. This parameter is required if `ipv6_netmask_length` is not set and the IPAM pool does not have `allocation_default_netmask` set. Conflicts with `assign_generated_ipv6_cidr_block`. * `ipv6_ipam_pool_id` - (Optional) The ID of an IPv6 IPAM pool you want to use for allocating this VPC's CIDR. IPAM is a VPC feature that you can use to automate your IP address management workflows including assigning, tracking, troubleshooting, and auditing IP addresses across AWS Regions and accounts. Conflict with `assign_generated_ipv6_cidr_block` and `ipv6_pool`. @@ -137,4 +138,4 @@ or % terraform import aws_vpc_ipv6_cidr_block_association.example vpc-cidr-assoc-0754129087e149dcd,ipam-pool-0611d1d6bbc05ce60,56 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/vpc_network_performance_metric_subscription.html.markdown b/website/docs/cdktf/python/r/vpc_network_performance_metric_subscription.html.markdown index 6b670385da9e..b66797841e5f 100644 --- a/website/docs/cdktf/python/r/vpc_network_performance_metric_subscription.html.markdown +++ b/website/docs/cdktf/python/r/vpc_network_performance_metric_subscription.html.markdown @@ -36,6 +36,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `destination` - (Required) The target Region or Availability Zone that the metric subscription is enabled for. For example, `eu-west-1`. * `metric` - (Optional) The metric used for the enabled subscription. Valid values: `aggregate-latency`. Default: `aggregate-latency`. * `source` - (Required) The source Region or Availability Zone that the metric subscription is enabled for. For example, `us-east-1`. @@ -47,4 +48,4 @@ This resource exports the following attributes in addition to the arguments abov * `period` - The data aggregation time for the subscription. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/vpc_peering_connection.html.markdown b/website/docs/cdktf/python/r/vpc_peering_connection.html.markdown index ba7a8a81df62..9670276f6e31 100644 --- a/website/docs/cdktf/python/r/vpc_peering_connection.html.markdown +++ b/website/docs/cdktf/python/r/vpc_peering_connection.html.markdown @@ -150,6 +150,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `peer_owner_id` - (Optional) The AWS account ID of the target peer VPC. Defaults to the account ID the [AWS provider][1] is currently connected to, so must be managed if connecting cross-account. * `peer_vpc_id` - (Required) The ID of the target VPC with which you are creating the VPC Peering Connection. @@ -220,4 +221,4 @@ Using `terraform import`, import VPC Peering resources using the VPC peering `id [1]: /docs/providers/aws/index.html - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/vpc_peering_connection_accepter.html.markdown b/website/docs/cdktf/python/r/vpc_peering_connection_accepter.html.markdown index 5c6853b9fa66..3ec8d278d17e 100644 --- a/website/docs/cdktf/python/r/vpc_peering_connection_accepter.html.markdown +++ b/website/docs/cdktf/python/r/vpc_peering_connection_accepter.html.markdown @@ -21,6 +21,8 @@ connection into management. ## Example Usage +### Cross-Account Peering Or Cross-Region Peering Terraform AWS Provider v5 (and below) + ```python # DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug from constructs import Construct @@ -81,10 +83,62 @@ class MyConvertedCode(TerraformStack): aws_vpc_peering_connection_accepter_peer.override_logical_id("peer") ``` +### Cross-Region Peering (Same Account) Terraform AWS Provider v6 (and above) + +```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.provider import AwsProvider +from imports.aws.vpc import Vpc +from imports.aws.vpc_peering_connection import VpcPeeringConnection +from imports.aws.vpc_peering_connection_accepter import VpcPeeringConnectionAccepterA +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + AwsProvider(self, "aws", + region="us-east-1" + ) + main = Vpc(self, "main", + cidr_block="10.0.0.0/16" + ) + peer = Vpc(self, "peer", + cidr_block="10.1.0.0/16", + region="us-west-2" + ) + aws_vpc_peering_connection_peer = VpcPeeringConnection(self, "peer_3", + auto_accept=False, + peer_region="us-west-2", + peer_vpc_id=peer.id, + tags={ + "Side": "Requester" + }, + vpc_id=main.id + ) + # 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_vpc_peering_connection_peer.override_logical_id("peer") + aws_vpc_peering_connection_accepter_peer = + VpcPeeringConnectionAccepterA(self, "peer_4", + auto_accept=True, + region="us-west-2", + tags={ + "Side": "Accepter" + }, + vpc_peering_connection_id=Token.as_string(aws_vpc_peering_connection_peer.id) + ) + # 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_vpc_peering_connection_accepter_peer.override_logical_id("peer") +``` + ## Argument Reference This resource supports the following arguments: +* `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). * `vpc_peering_connection_id` - (Required) The VPC Peering Connection ID to manage. * `auto_accept` - (Optional) Whether or not to accept the peering request. Defaults to `false`. * `tags` - (Optional) A 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. @@ -166,4 +220,4 @@ class MyConvertedCode(TerraformStack): ) ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/vpc_peering_connection_options.html.markdown b/website/docs/cdktf/python/r/vpc_peering_connection_options.html.markdown index 85d583808019..2d629399bbc0 100644 --- a/website/docs/cdktf/python/r/vpc_peering_connection_options.html.markdown +++ b/website/docs/cdktf/python/r/vpc_peering_connection_options.html.markdown @@ -147,6 +147,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `vpc_peering_connection_id` - (Required) The ID of the requester VPC peering connection. * `accepter` (Optional) - An optional configuration block that allows for [VPC Peering Connection](https://docs.aws.amazon.com/vpc/latest/peering/what-is-vpc-peering.html) options to be set for the VPC that accepts the peering connection (a maximum of one). * `requester` (Optional) - A optional configuration block that allows for [VPC Peering Connection](https://docs.aws.amazon.com/vpc/latest/peering/what-is-vpc-peering.html) options to be set for the VPC that requests the peering connection (a maximum of one). @@ -188,4 +189,4 @@ Using `terraform import`, import VPC Peering Connection Options using the VPC pe % terraform import aws_vpc_peering_connection_options.foo pcx-111aaa111 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/vpc_route_server.html.markdown b/website/docs/cdktf/python/r/vpc_route_server.html.markdown index 0cd4bd6b6987..69692b3a5317 100644 --- a/website/docs/cdktf/python/r/vpc_route_server.html.markdown +++ b/website/docs/cdktf/python/r/vpc_route_server.html.markdown @@ -23,7 +23,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 VpcRouteServer +from imports.aws.vpc_route_server import VpcRouteServer class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) @@ -45,7 +45,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 VpcRouteServer +from imports.aws.vpc_route_server import VpcRouteServer class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) @@ -70,6 +70,7 @@ The following arguments are optional: * `persist_routes` - (Optional) Indicates whether routes should be persisted after all BGP sessions are terminated. Valid values are `enable`, `disable`, `reset` * `persist_routes_duration` - (Optional) The number of minutes a route server will wait after BGP is re-established to unpersist the routes in the FIB and RIB. Value must be in the range of 1-5. Required if `persist_routes` is enabled. +* `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). * `sns_notifications_enabled` - (Optional) Indicates whether SNS notifications should be enabled for route server events. Enabling SNS notifications persists BGP status changes to an SNS topic provisioned by AWS`. * `tags` - (Optional) A 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. @@ -102,7 +103,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 VpcRouteServer +from imports.aws.vpc_route_server import VpcRouteServer class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) @@ -115,4 +116,4 @@ Using `terraform import`, import VPC (Virtual Private Cloud) Route Server using % terraform import aws_vpc_route_server.example rs-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/vpc_route_server_endpoint.html.markdown b/website/docs/cdktf/python/r/vpc_route_server_endpoint.html.markdown index 2697cbbed9ec..126c3b9ffbb5 100644 --- a/website/docs/cdktf/python/r/vpc_route_server_endpoint.html.markdown +++ b/website/docs/cdktf/python/r/vpc_route_server_endpoint.html.markdown @@ -23,7 +23,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 VpcRouteServerEndpoint +from imports.aws.vpc_route_server_endpoint import VpcRouteServerEndpoint class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) @@ -45,6 +45,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `tags` - (Optional) A 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. ## Attribute Reference @@ -77,7 +78,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 VpcRouteServerEndpoint +from imports.aws.vpc_route_server_endpoint import VpcRouteServerEndpoint class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) @@ -90,4 +91,4 @@ Using `terraform import`, import VPC (Virtual Private Cloud) Route Server Endpoi % terraform import aws_vpc_route_server_endpoint.example rse-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/vpc_route_server_peer.html.markdown b/website/docs/cdktf/python/r/vpc_route_server_peer.html.markdown index ae6f39a00f07..021104803280 100644 --- a/website/docs/cdktf/python/r/vpc_route_server_peer.html.markdown +++ b/website/docs/cdktf/python/r/vpc_route_server_peer.html.markdown @@ -23,14 +23,14 @@ 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 VpcRouteServerPeer +from imports.aws.vpc_route_server_peer import VpcRouteServerPeer class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) VpcRouteServerPeer(self, "test", - bgp_options=[{ - "peer_asn": 65200 - } + bgp_options=[VpcRouteServerPeerBgpOptions( + peer_asn=65200 + ) ], peer_address="10.0.1.250", route_server_endpoint_id=example.route_server_endpoint_id, @@ -45,12 +45,16 @@ class MyConvertedCode(TerraformStack): ```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 +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. import VpcRouteServer, VpcRouteServerAssociation, VpcRouteServerEndpoint, VpcRouteServerPeer, VpcRouteServerPropagation +from imports.aws. import VpcRouteServerAssociation +from imports.aws.vpc_route_server import VpcRouteServer +from imports.aws.vpc_route_server_endpoint import VpcRouteServerEndpoint +from imports.aws.vpc_route_server_peer import VpcRouteServerPeer +from imports.aws.vpc_route_server_propagation import VpcRouteServerPropagation class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) @@ -69,7 +73,7 @@ class MyConvertedCode(TerraformStack): aws_vpc_route_server_endpoint_test = VpcRouteServerEndpoint(self, "test_2", depends_on=[aws_vpc_route_server_association_test], route_server_id=test.route_server_id, - subnet_id=aws_subnet_test.id, + subnet_id=Token.as_string(aws_subnet_test.id), tags={ "Name": "Test Endpoint" } @@ -77,13 +81,13 @@ class MyConvertedCode(TerraformStack): # 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_vpc_route_server_endpoint_test.override_logical_id("test") aws_vpc_route_server_peer_test = VpcRouteServerPeer(self, "test_3", - bgp_options=[{ - "peer_asn": 65000, - "peer_liveness_detection": "bgp-keepalive" - } + bgp_options=[VpcRouteServerPeerBgpOptions( + peer_asn=65000, + peer_liveness_detection="bgp-keepalive" + ) ], peer_address="10.0.1.250", - route_server_endpoint_id=aws_vpc_route_server_endpoint_test.route_server_endpoint_id, + route_server_endpoint_id=Token.as_string(aws_vpc_route_server_endpoint_test.route_server_endpoint_id), tags={ "Name": "Test Appliance" } @@ -93,7 +97,7 @@ class MyConvertedCode(TerraformStack): aws_vpc_route_server_propagation_test = VpcRouteServerPropagation(self, "test_4", depends_on=[aws_vpc_route_server_association_test], route_server_id=test.route_server_id, - route_table_id=aws_route_table_test.id + route_table_id=Token.as_string(aws_route_table_test.id) ) # 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_vpc_route_server_propagation_test.override_logical_id("test") @@ -103,19 +107,20 @@ class MyConvertedCode(TerraformStack): The following arguments are required: -* `route_server_endpoint_id` - (Required) The ID of the route server endpoint for which to create a peer. +* `bgp_options` - (Required) The BGP options for the peer, including ASN (Autonomous System Number) and BFD (Bidrectional Forwarding Detection) settings. Configuration block with BGP Options configuration Detailed below * `peer_address` - (Required) The IPv4 address of the peer device. -* `bgp_options` - The BGP options for the peer, including ASN (Autonomous System Number) and BFD (Bidrectional Forwarding Detection) settings. Configuration block with BGP Options configuration Detailed below +* `route_server_endpoint_id` - (Required) The ID of the route server endpoint for which to create a peer. + +The following arguments are optional: + +* `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). +* `tags` - (Optional) A 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. ### bgp_options * `peer_asn` - (Required) The Border Gateway Protocol (BGP) Autonomous System Number (ASN) for the appliance. Valid values are from 1 to 4294967295. We recommend using a private ASN in the 64512–65534 (16-bit ASN) or 4200000000–4294967294 (32-bit ASN) range. * `peer_liveness_detection` (Optional) The requested liveness detection protocol for the BGP peer. Valid values are `bgp-keepalive` and `bfd`. Default value is `bgp-keepalive`. -The following arguments are optional: - -* `tags` - (Optional) A 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. - ## Attribute Reference This resource exports the following attributes in addition to the arguments above: @@ -148,7 +153,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 VpcRouteServerPeer +from imports.aws.vpc_route_server_peer import VpcRouteServerPeer class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) @@ -161,4 +166,4 @@ Using `terraform import`, import VPC (Virtual Private Cloud) Route Server using % terraform import aws_vpc_route_server_peer.example rsp-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/vpc_route_server_propagation.html.markdown b/website/docs/cdktf/python/r/vpc_route_server_propagation.html.markdown index a98adef3df6c..9bf657d71d4c 100644 --- a/website/docs/cdktf/python/r/vpc_route_server_propagation.html.markdown +++ b/website/docs/cdktf/python/r/vpc_route_server_propagation.html.markdown @@ -18,18 +18,18 @@ description: |- ```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 +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. import VpcRouteServerPropagation +from imports.aws.vpc_route_server_propagation import VpcRouteServerPropagation class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) VpcRouteServerPropagation(self, "example", - route_server_id=aws_vpc_route_server_example.route_server_id, - route_table_id=aws_route_table_example.id + route_server_id=Token.as_string(aws_vpc_route_server_example.route_server_id), + route_table_id=Token.as_string(aws_route_table_example.id) ) ``` @@ -40,6 +40,10 @@ The following arguments are required: * `route_server_id` - (Required) The unique identifier for the route server to be associated. * `route_table_id` - (Required) The ID of the route table to which route server will propagate routes. +The following arguments are optional: + +* `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). + ## Attribute Reference This resource exports no additional attributes. @@ -63,7 +67,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 VpcRouteServerPropagation +from imports.aws.vpc_route_server_propagation import VpcRouteServerPropagation class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) @@ -76,4 +80,4 @@ Using `terraform import`, to to import VPC (Virtual Private Cloud) Route Server % terraform import aws_vpc_route_server_propagation.example rs-12345678,rtb-656c65616e6f72 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/vpc_route_server_vpc_association.html.markdown b/website/docs/cdktf/python/r/vpc_route_server_vpc_association.html.markdown index ec7b50417f2c..350d82327841 100644 --- a/website/docs/cdktf/python/r/vpc_route_server_vpc_association.html.markdown +++ b/website/docs/cdktf/python/r/vpc_route_server_vpc_association.html.markdown @@ -18,18 +18,18 @@ description: |- ```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 +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. import VpcRouteServerVpcAssociation +from imports.aws.vpc_route_server_vpc_association import VpcRouteServerVpcAssociation class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) VpcRouteServerVpcAssociation(self, "example", - route_server_id=aws_vpc_route_server_example.route_server_id, - vpc_id=aws_vpc_example.id + route_server_id=Token.as_string(aws_vpc_route_server_example.route_server_id), + vpc_id=Token.as_string(aws_vpc_example.id) ) ``` @@ -40,6 +40,10 @@ The following arguments are required: * `route_server_id` - (Required) The unique identifier for the route server to be associated. * `vpc_id` - (Required) The ID of the VPC to associate with the route server. +The following arguments are optional: + +* `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). + ## Attribute Reference This resource exports no additional attributes. @@ -63,7 +67,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 VpcRouteServerVpcAssociation +from imports.aws.vpc_route_server_vpc_association import VpcRouteServerVpcAssociation class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) @@ -76,4 +80,4 @@ Using `terraform import`, to to import VPC (Virtual Private Cloud) Route Server % terraform import aws_vpc_route_server_vpc_association.example rs-12345678,vpc-0f001273ec18911b1 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/vpc_security_group_egress_rule.html.markdown b/website/docs/cdktf/python/r/vpc_security_group_egress_rule.html.markdown index aca0f83bff72..2222e2dffca0 100644 --- a/website/docs/cdktf/python/r/vpc_security_group_egress_rule.html.markdown +++ b/website/docs/cdktf/python/r/vpc_security_group_egress_rule.html.markdown @@ -45,6 +45,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `cidr_ipv4` - (Optional) The destination IPv4 CIDR range. * `cidr_ipv6` - (Optional) The destination IPv6 CIDR range. * `description` - (Optional) The security group rule description. @@ -91,4 +92,4 @@ Using `terraform import`, import security group egress rules using the `security % terraform import aws_vpc_security_group_egress_rule.example sgr-02108b27edd666983 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/vpc_security_group_ingress_rule.html.markdown b/website/docs/cdktf/python/r/vpc_security_group_ingress_rule.html.markdown index 4a7a663a2995..85e3609825db 100644 --- a/website/docs/cdktf/python/r/vpc_security_group_ingress_rule.html.markdown +++ b/website/docs/cdktf/python/r/vpc_security_group_ingress_rule.html.markdown @@ -57,8 +57,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: -~> **Note** Although `cidr_ipv4`, `cidr_ipv6`, `prefix_list_id`, and `referenced_security_group_id` are all marked as optional, you *must* provide one of them in order to configure the destination of the traffic. The `from_port` and `to_port` arguments are required unless `ip_protocol` is set to `-1` or `icmpv6`. - +* `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). * `cidr_ipv4` - (Optional) The source IPv4 CIDR range. * `cidr_ipv6` - (Optional) The source IPv6 CIDR range. * `description` - (Optional) The security group rule description. @@ -70,6 +69,8 @@ This resource supports the following arguments: * `tags` - (Optional) A 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. * `to_port` - (Optional) The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. +~> **Note** Although `cidr_ipv4`, `cidr_ipv6`, `prefix_list_id`, and `referenced_security_group_id` are all marked as optional, you *must* provide one of them in order to configure the destination of the traffic. The `from_port` and `to_port` arguments are required unless `ip_protocol` is set to `-1` or `icmpv6`. + ## Attribute Reference This resource exports the following attributes in addition to the arguments above: @@ -103,4 +104,4 @@ Using `terraform import`, import security group ingress rules using the `securit % terraform import aws_vpc_security_group_ingress_rule.example sgr-02108b27edd666983 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/vpc_security_group_vpc_association.html.markdown b/website/docs/cdktf/python/r/vpc_security_group_vpc_association.html.markdown index a5c75655985a..1c81c7fedd61 100644 --- a/website/docs/cdktf/python/r/vpc_security_group_vpc_association.html.markdown +++ b/website/docs/cdktf/python/r/vpc_security_group_vpc_association.html.markdown @@ -34,8 +34,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `security_group_id` - (Required) The ID of the security group. * `vpc_id` - (Required) The ID of the VPC to make the association with. @@ -77,4 +78,4 @@ Using `terraform import`, import a Security Group VPC Association using the `sec % terraform import aws_vpc_security_group_vpc_association.example sg-12345,vpc-67890 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/vpclattice_access_log_subscription.html.markdown b/website/docs/cdktf/python/r/vpclattice_access_log_subscription.html.markdown index a99470e22116..8753a17b2c6e 100644 --- a/website/docs/cdktf/python/r/vpclattice_access_log_subscription.html.markdown +++ b/website/docs/cdktf/python/r/vpclattice_access_log_subscription.html.markdown @@ -43,6 +43,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `service_network_log_type` - (Optional, Forces new resource) Type of log that monitors your Amazon VPC Lattice service networks. Valid values are: `SERVICE`, `RESOURCE`. Defaults to `SERVICE`. ## Attribute Reference @@ -78,4 +79,4 @@ Using `terraform import`, import VPC Lattice Access Log Subscription using the a % terraform import aws_vpclattice_access_log_subscription.example rft-8012925589 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/vpclattice_auth_policy.html.markdown b/website/docs/cdktf/python/r/vpclattice_auth_policy.html.markdown index ccbac1e12361..0b1748826615 100644 --- a/website/docs/cdktf/python/r/vpclattice_auth_policy.html.markdown +++ b/website/docs/cdktf/python/r/vpclattice_auth_policy.html.markdown @@ -59,8 +59,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `resource_identifier` - (Required) The ID or Amazon Resource Name (ARN) of the service network or service for which the policy is created. * `policy` - (Required) The auth policy. The policy string in JSON must not contain newlines or blank lines. @@ -105,4 +106,4 @@ Using `terraform import`, import VPC Lattice Auth Policy using the `id`. For exa % terraform import aws_vpclattice_auth_policy.example abcd-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/vpclattice_listener.html.markdown b/website/docs/cdktf/python/r/vpclattice_listener.html.markdown index 5739cf9191b9..072fa3161bea 100644 --- a/website/docs/cdktf/python/r/vpclattice_listener.html.markdown +++ b/website/docs/cdktf/python/r/vpclattice_listener.html.markdown @@ -157,6 +157,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `default_action` - (Required) Default action block for the default listener rule. Default action blocks are defined below. * `name` - (Required, Forces new resource) Name of the listener. A listener name must be unique within a service. Valid characters are a-z, 0-9, and hyphens (-). You can't use a hyphen as the first or last character, or immediately after another hyphen. * `port` - (Optional, Forces new resource) Listener port. You can specify a value from 1 to 65535. If `port` is not specified and `protocol` is HTTP, the value will default to 80. If `port` is not specified and `protocol` is HTTPS, the value will default to 443. @@ -229,4 +230,4 @@ Using `terraform import`, import VPC Lattice Listener using the `listener_id` of % terraform import aws_vpclattice_listener.example svc-1a2b3c4d/listener-987654321 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/vpclattice_listener_rule.html.markdown b/website/docs/cdktf/python/r/vpclattice_listener_rule.html.markdown index fa8eae422226..e986314199b8 100644 --- a/website/docs/cdktf/python/r/vpclattice_listener_rule.html.markdown +++ b/website/docs/cdktf/python/r/vpclattice_listener_rule.html.markdown @@ -116,6 +116,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `tags` - (Optional) Key-value mapping of resource tags. If configured with a provider [`default_tags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. ### `action` Block @@ -244,4 +245,4 @@ Using `terraform import`, import VPC Lattice Listener Rule using the `id`. For e % terraform import aws_vpclattice_listener_rule.example service123/listener456/rule789 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/vpclattice_resource_configuration.html.markdown b/website/docs/cdktf/python/r/vpclattice_resource_configuration.html.markdown index 523044d4650d..634ea482b4bf 100644 --- a/website/docs/cdktf/python/r/vpclattice_resource_configuration.html.markdown +++ b/website/docs/cdktf/python/r/vpclattice_resource_configuration.html.markdown @@ -116,6 +116,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `allow_association_to_shareable_service_network` (Optional) Allow or Deny the association of this resource to a shareable service network. * `protocol` - (Optional) Protocol for the Resource `TCP` is currently the only supported value. MUST be specified if `resource_configuration_group_id` is not. * `resource_configuration_group_id` (Optional) ID of Resource Configuration where `type` is `CHILD`. @@ -129,6 +130,7 @@ One of `dns_resource`, `ip_resource`, `arn_resource` must be specified. The following arguments are optional: +* `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). * `arn_resource` - (Optional) Resource DNS Configuration. See [`arn_resource` Block](#arn_resource-block) for details. * `dns_resource` - (Optional) Resource DNS Configuration. See [`dns_resource` Block](#dns_resource-block) for details. * `ip_resource` - (Optional) Resource DNS Configuration. See [`ip_resource` Block](#ip_resource-block) for details. @@ -193,4 +195,4 @@ Using `terraform import`, import VPC Lattice Resource Configuration using the `i % terraform import aws_vpclattice_resource_configuration.example rcfg-1234567890abcdef1 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/vpclattice_resource_gateway.html.markdown b/website/docs/cdktf/python/r/vpclattice_resource_gateway.html.markdown index 796a2c9083d7..98c706566683 100644 --- a/website/docs/cdktf/python/r/vpclattice_resource_gateway.html.markdown +++ b/website/docs/cdktf/python/r/vpclattice_resource_gateway.html.markdown @@ -94,6 +94,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `ip_address_type` - (Optional) IP address type used by the resource gateway. Valid values are `IPV4`, `IPV6`, and `DUALSTACK`. The IP address type of a resource gateway must be compatible with the subnets of the resource gateway and the IP address type of the resource. * `security_group_ids` - (Optional) Security group IDs associated with the resource gateway. The security groups must be in the same VPC. * `tags` - (Optional) Key-value mapping of resource tags. If configured with a provider [`default_tags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. @@ -132,4 +133,4 @@ Using `terraform import`, import VPC Lattice Resource Gateway using the `id`. Fo % terraform import aws_vpclattice_resource_gateway.example rgw-0a1b2c3d4e5f ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/vpclattice_resource_policy.html.markdown b/website/docs/cdktf/python/r/vpclattice_resource_policy.html.markdown index 93e1f5fcb3ff..617819afa62f 100644 --- a/website/docs/cdktf/python/r/vpclattice_resource_policy.html.markdown +++ b/website/docs/cdktf/python/r/vpclattice_resource_policy.html.markdown @@ -62,8 +62,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `resource_arn` - (Required) The ID or Amazon Resource Name (ARN) of the service network or service for which the policy is created. * `policy` - (Required) An IAM policy. The policy string in JSON must not contain newlines or blank lines. @@ -96,4 +97,4 @@ Using `terraform import`, import VPC Lattice Resource Policy using the `resource % terraform import aws_vpclattice_resource_policy.example rft-8012925589 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/vpclattice_service.html.markdown b/website/docs/cdktf/python/r/vpclattice_service.html.markdown index 2d364d45a33f..0249a239e22b 100644 --- a/website/docs/cdktf/python/r/vpclattice_service.html.markdown +++ b/website/docs/cdktf/python/r/vpclattice_service.html.markdown @@ -43,6 +43,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `auth_type` - (Optional) Type of IAM policy. Either `NONE` or `AWS_IAM`. * `certificate_arn` - (Optional) Amazon Resource Name (ARN) of the certificate. * `custom_domain_name` - (Optional) Custom domain name of the service. @@ -90,4 +91,4 @@ Using `terraform import`, import VPC Lattice Service using the `id`. For example % terraform import aws_vpclattice_service.example svc-06728e2357ea55f8a ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/vpclattice_service_network.html.markdown b/website/docs/cdktf/python/r/vpclattice_service_network.html.markdown index c5ceeb1aa4fe..533891b2b94a 100644 --- a/website/docs/cdktf/python/r/vpclattice_service_network.html.markdown +++ b/website/docs/cdktf/python/r/vpclattice_service_network.html.markdown @@ -42,6 +42,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `auth_type` - (Optional) Type of IAM policy. Either `NONE` or `AWS_IAM`. * `tags` - (Optional) Key-value mapping of resource tags. If configured with a provider [`default_tags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. @@ -77,4 +78,4 @@ Using `terraform import`, import VPC Lattice Service Network using the `id`. For % terraform import aws_vpclattice_service_network.example sn-0158f91c1e3358dba ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/vpclattice_service_network_resource_association.html.markdown b/website/docs/cdktf/python/r/vpclattice_service_network_resource_association.html.markdown index 5fe1d6a4df1d..a944eeeb9f4a 100644 --- a/website/docs/cdktf/python/r/vpclattice_service_network_resource_association.html.markdown +++ b/website/docs/cdktf/python/r/vpclattice_service_network_resource_association.html.markdown @@ -18,18 +18,18 @@ Terraform resource for managing an AWS VPC Lattice Service Network Resource Asso ```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 +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. import VpclatticeServiceNetworkResourceAssociation +from imports.aws.vpclattice_service_network_resource_association import VpclatticeServiceNetworkResourceAssociation class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) VpclatticeServiceNetworkResourceAssociation(self, "example", - resource_configuration_identifier=aws_vpclattice_resource_configuration_example.id, - service_network_identifier=aws_vpclattice_service_network_example.id, + resource_configuration_identifier=Token.as_string(aws_vpclattice_resource_configuration_example.id), + service_network_identifier=Token.as_string(aws_vpclattice_service_network_example.id), tags={ "Name": "Example" } @@ -45,6 +45,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `tags` - (Optional) Map of tags assigned to the resource. If configured with a provider [`default_tags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. ## Attribute Reference @@ -77,7 +78,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 VpclatticeServiceNetworkResourceAssociation +from imports.aws.vpclattice_service_network_resource_association import VpclatticeServiceNetworkResourceAssociation class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) @@ -90,4 +91,4 @@ Using `terraform import`, import VPC Lattice Service Network Resource Associatio % terraform import aws_vpclattice_service_network_resource_association.example snra-1234567890abcef12 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/vpclattice_service_network_service_association.html.markdown b/website/docs/cdktf/python/r/vpclattice_service_network_service_association.html.markdown index 008c1525a640..b4bc515d8b52 100644 --- a/website/docs/cdktf/python/r/vpclattice_service_network_service_association.html.markdown +++ b/website/docs/cdktf/python/r/vpclattice_service_network_service_association.html.markdown @@ -36,12 +36,11 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `service_identifier` - (Required) The ID or Amazon Resource Identifier (ARN) of the service. * `service_network_identifier` - (Required) The ID or Amazon Resource Identifier (ARN) of the service network. You must use the ARN if the resources specified in the operation are in different accounts. -The following arguments are optional: - * `tags` - (Optional) Key-value mapping of resource tags. If configured with a provider [`default_tags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. ## Attribute Reference @@ -90,4 +89,4 @@ Using `terraform import`, import VPC Lattice Service Network Service Association % terraform import aws_vpclattice_service_network_service_association.example snsa-05e2474658a88f6ba ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/vpclattice_service_network_vpc_association.html.markdown b/website/docs/cdktf/python/r/vpclattice_service_network_vpc_association.html.markdown index dccafa45cc10..99ad35cdc8a3 100644 --- a/website/docs/cdktf/python/r/vpclattice_service_network_vpc_association.html.markdown +++ b/website/docs/cdktf/python/r/vpclattice_service_network_vpc_association.html.markdown @@ -37,12 +37,12 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `vpc_identifier` - (Required) The ID of the VPC. * `service_network_identifier` - (Required) The ID or Amazon Resource Identifier (ARN) of the service network. You must use the ARN if the resources specified in the operation are in different accounts. The following arguments are optional: - * `tags` - (Optional) Key-value mapping of resource tags. If configured with a provider [`default_tags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. * `security_group_ids` - (Optional) The IDs of the security groups. @@ -88,4 +88,4 @@ Using `terraform import`, import VPC Lattice Service Network VPC Association usi % terraform import aws_vpclattice_service_network_vpc_association.example snsa-05e2474658a88f6ba ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/vpclattice_target_group.html.markdown b/website/docs/cdktf/python/r/vpclattice_target_group.html.markdown index 1972234c7dd0..22e3a6ba39f4 100644 --- a/website/docs/cdktf/python/r/vpclattice_target_group.html.markdown +++ b/website/docs/cdktf/python/r/vpclattice_target_group.html.markdown @@ -139,6 +139,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `config` - (Optional) The target group configuration. * `tags` - (Optional) Key-value mapping of resource tags. If configured with a provider [`default_tags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. @@ -207,4 +208,4 @@ Using `terraform import`, import VPC Lattice Target Group using the `id`. For ex % terraform import aws_vpclattice_target_group.example tg-0c11d4dc16ed96bdb ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/vpclattice_target_group_attachment.html.markdown b/website/docs/cdktf/python/r/vpclattice_target_group_attachment.html.markdown index 6f553400ca22..d21b1d9e6151 100644 --- a/website/docs/cdktf/python/r/vpclattice_target_group_attachment.html.markdown +++ b/website/docs/cdktf/python/r/vpclattice_target_group_attachment.html.markdown @@ -41,6 +41,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +- `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). - `target_group_identifier` - (Required) The ID or Amazon Resource Name (ARN) of the target group. - `target` - (Required) The target. @@ -53,4 +54,4 @@ This resource supports the following arguments: This resource exports no additional attributes. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/vpn_connection.html.markdown b/website/docs/cdktf/python/r/vpn_connection.html.markdown index f7adda6e5a4d..819cf86c7108 100644 --- a/website/docs/cdktf/python/r/vpn_connection.html.markdown +++ b/website/docs/cdktf/python/r/vpn_connection.html.markdown @@ -163,6 +163,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `customer_gateway_id` - (Required) The ID of the customer gateway. * `type` - (Required) The type of VPN connection. The only type AWS supports at this time is "ipsec.1". * `transit_gateway_id` - (Optional) The ID of the EC2 Transit Gateway. @@ -303,4 +304,4 @@ Using `terraform import`, import VPN Connections using the VPN connection `id`. % terraform import aws_vpn_connection.testvpnconnection vpn-40f41529 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/vpn_connection_route.html.markdown b/website/docs/cdktf/python/r/vpn_connection_route.html.markdown index cccd82b3da02..c58abe9689c5 100644 --- a/website/docs/cdktf/python/r/vpn_connection_route.html.markdown +++ b/website/docs/cdktf/python/r/vpn_connection_route.html.markdown @@ -57,6 +57,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `destination_cidr_block` - (Required) The CIDR block associated with the local subnet of the customer network. * `vpn_connection_id` - (Required) The ID of the VPN connection. @@ -67,4 +68,4 @@ This resource exports the following attributes in addition to the arguments abov * `destination_cidr_block` - The CIDR block associated with the local subnet of the customer network. * `vpn_connection_id` - The ID of the VPN connection. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/vpn_gateway.html.markdown b/website/docs/cdktf/python/r/vpn_gateway.html.markdown index ab14d19b2fb6..9e73fd7beb34 100644 --- a/website/docs/cdktf/python/r/vpn_gateway.html.markdown +++ b/website/docs/cdktf/python/r/vpn_gateway.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `vpc_id` - (Optional) The VPC ID to create in. * `availability_zone` - (Optional) The Availability Zone for the virtual private gateway. * `tags` - (Optional) A 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. @@ -76,4 +77,4 @@ Using `terraform import`, import VPN Gateways using the VPN gateway `id`. For ex % terraform import aws_vpn_gateway.testvpngateway vgw-9a4cacf3 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/vpn_gateway_attachment.html.markdown b/website/docs/cdktf/python/r/vpn_gateway_attachment.html.markdown index 3ca29c3378c4..866783848cfa 100644 --- a/website/docs/cdktf/python/r/vpn_gateway_attachment.html.markdown +++ b/website/docs/cdktf/python/r/vpn_gateway_attachment.html.markdown @@ -55,6 +55,7 @@ guides for more information. This resource supports the following arguments: +* `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). * `vpc_id` - (Required) The ID of the VPC. * `vpn_gateway_id` - (Required) The ID of the Virtual Private Gateway. @@ -69,4 +70,4 @@ This resource exports the following attributes in addition to the arguments abov You cannot import this resource. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/vpn_gateway_route_propagation.html.markdown b/website/docs/cdktf/python/r/vpn_gateway_route_propagation.html.markdown index ff7442778308..1cb0a7db36c4 100644 --- a/website/docs/cdktf/python/r/vpn_gateway_route_propagation.html.markdown +++ b/website/docs/cdktf/python/r/vpn_gateway_route_propagation.html.markdown @@ -38,8 +38,9 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `vpn_gateway_id` - The id of the `aws_vpn_gateway` to propagate routes from. * `route_table_id` - The id of the `aws_route_table` to propagate routes into. @@ -54,4 +55,4 @@ This resource exports no additional attributes. - `create` - (Default `2m`) - `delete` - (Default `2m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/wafregional_byte_match_set.html.markdown b/website/docs/cdktf/python/r/wafregional_byte_match_set.html.markdown index bcf370ce49aa..4328115b7eb1 100644 --- a/website/docs/cdktf/python/r/wafregional_byte_match_set.html.markdown +++ b/website/docs/cdktf/python/r/wafregional_byte_match_set.html.markdown @@ -45,6 +45,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) The name or description of the ByteMatchSet. * `byte_match_tuples` - (Optional)Settings for the ByteMatchSet, such as the bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to search for in web requests. ByteMatchTuple documented below. @@ -93,4 +94,4 @@ Using `terraform import`, import WAF Regional Byte Match Set using the id. For e % terraform import aws_wafregional_byte_match_set.byte_set a1b2c3d4-d5f6-7777-8888-9999aaaabbbbcccc ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/wafregional_geo_match_set.html.markdown b/website/docs/cdktf/python/r/wafregional_geo_match_set.html.markdown index 6b944821069b..7611dfc86ccf 100644 --- a/website/docs/cdktf/python/r/wafregional_geo_match_set.html.markdown +++ b/website/docs/cdktf/python/r/wafregional_geo_match_set.html.markdown @@ -43,6 +43,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) The name or description of the Geo Match Set. * `geo_match_constraint` - (Optional) The Geo Match Constraint objects which contain the country that you want AWS WAF to search for. @@ -88,4 +89,4 @@ Using `terraform import`, import WAF Regional Geo Match Set using the id. For ex % terraform import aws_wafregional_geo_match_set.geo_match_set a1b2c3d4-d5f6-7777-8888-9999aaaabbbbcccc ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/wafregional_ipset.html.markdown b/website/docs/cdktf/python/r/wafregional_ipset.html.markdown index 6a3be69510d1..bba26b30c6b8 100644 --- a/website/docs/cdktf/python/r/wafregional_ipset.html.markdown +++ b/website/docs/cdktf/python/r/wafregional_ipset.html.markdown @@ -43,6 +43,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) The name or description of the IPSet. * `ip_set_descriptor` - (Optional) One or more pairs specifying the IP address type (IPV4 or IPV6) and the IP address range (in CIDR notation) from which web requests originate. @@ -89,4 +90,4 @@ Using `terraform import`, import WAF Regional IPSets using their ID. For example % terraform import aws_wafregional_ipset.example a1b2c3d4-d5f6-7777-8888-9999aaaabbbbcccc ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/wafregional_rate_based_rule.html.markdown b/website/docs/cdktf/python/r/wafregional_rate_based_rule.html.markdown index 24e52629853e..fa1adaf56f3b 100644 --- a/website/docs/cdktf/python/r/wafregional_rate_based_rule.html.markdown +++ b/website/docs/cdktf/python/r/wafregional_rate_based_rule.html.markdown @@ -54,6 +54,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `metric_name` - (Required) The name or description for the Amazon CloudWatch metric of this rule. * `name` - (Required) The name or description of the rule. * `rate_key` - (Required) Valid value is IP. @@ -109,4 +110,4 @@ Using `terraform import`, import WAF Regional Rate Based Rule using the id. For % terraform import aws_wafregional_rate_based_rule.wafrule a1b2c3d4-d5f6-7777-8888-9999aaaabbbbcccc ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/wafregional_regex_match_set.html.markdown b/website/docs/cdktf/python/r/wafregional_regex_match_set.html.markdown index 50375775463b..6df1f73b39b0 100644 --- a/website/docs/cdktf/python/r/wafregional_regex_match_set.html.markdown +++ b/website/docs/cdktf/python/r/wafregional_regex_match_set.html.markdown @@ -51,6 +51,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) The name or description of the Regex Match Set. * `regex_match_tuple` - (Required) The regular expression pattern that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings. See below. @@ -105,4 +106,4 @@ Using `terraform import`, import WAF Regional Regex Match Set using the id. For % terraform import aws_wafregional_regex_match_set.example a1b2c3d4-d5f6-7777-8888-9999aaaabbbbcccc ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/wafregional_regex_pattern_set.html.markdown b/website/docs/cdktf/python/r/wafregional_regex_pattern_set.html.markdown index 90ee9ee1093f..0cbfab8fc04b 100644 --- a/website/docs/cdktf/python/r/wafregional_regex_pattern_set.html.markdown +++ b/website/docs/cdktf/python/r/wafregional_regex_pattern_set.html.markdown @@ -36,6 +36,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) The name or description of the Regex Pattern Set. * `regex_pattern_strings` - (Optional) A list of regular expression (regex) patterns that you want AWS WAF to search for, such as `B[a@]dB[o0]t`. @@ -70,4 +71,4 @@ Using `terraform import`, import WAF Regional Regex Pattern Set using the id. Fo % terraform import aws_wafregional_regex_pattern_set.example a1b2c3d4-d5f6-7777-8888-9999aaaabbbbcccc ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/wafregional_rule.html.markdown b/website/docs/cdktf/python/r/wafregional_rule.html.markdown index b1caf3d68537..bc2bb2b7b084 100644 --- a/website/docs/cdktf/python/r/wafregional_rule.html.markdown +++ b/website/docs/cdktf/python/r/wafregional_rule.html.markdown @@ -51,6 +51,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) The name or description of the rule. * `metric_name` - (Required) The name or description for the Amazon CloudWatch metric of this rule. * `predicate` - (Optional) The objects to include in a rule (documented below). @@ -103,4 +104,4 @@ Using `terraform import`, import WAF Regional Rule using the id. For example: % terraform import aws_wafregional_rule.wafrule a1b2c3d4-d5f6-7777-8888-9999aaaabbbbcccc ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/wafregional_rule_group.html.markdown b/website/docs/cdktf/python/r/wafregional_rule_group.html.markdown index b867e5cbe308..d5dae9215c7a 100644 --- a/website/docs/cdktf/python/r/wafregional_rule_group.html.markdown +++ b/website/docs/cdktf/python/r/wafregional_rule_group.html.markdown @@ -51,6 +51,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) A friendly name of the rule group * `metric_name` - (Required) A friendly name for the metrics from the rule group * `activated_rule` - (Optional) A list of activated rules, see below @@ -101,4 +102,4 @@ Using `terraform import`, import WAF Regional Rule Group using the id. For examp % terraform import aws_wafregional_rule_group.example a1b2c3d4-d5f6-7777-8888-9999aaaabbbbcccc ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/wafregional_size_constraint_set.html.markdown b/website/docs/cdktf/python/r/wafregional_size_constraint_set.html.markdown index edea36234e4f..9d6fdec3b7da 100644 --- a/website/docs/cdktf/python/r/wafregional_size_constraint_set.html.markdown +++ b/website/docs/cdktf/python/r/wafregional_size_constraint_set.html.markdown @@ -44,6 +44,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) The name or description of the Size Constraint Set. * `size_constraints` - (Optional) Specifies the parts of web requests that you want to inspect the size of. @@ -108,4 +109,4 @@ Using `terraform import`, import WAF Size Constraint Set using the id. For examp % terraform import aws_wafregional_size_constraint_set.size_constraint_set a1b2c3d4-d5f6-7777-8888-9999aaaabbbbcccc ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/wafregional_sql_injection_match_set.html.markdown b/website/docs/cdktf/python/r/wafregional_sql_injection_match_set.html.markdown index 30ba50677344..b7e953427aba 100644 --- a/website/docs/cdktf/python/r/wafregional_sql_injection_match_set.html.markdown +++ b/website/docs/cdktf/python/r/wafregional_sql_injection_match_set.html.markdown @@ -42,6 +42,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) The name or description of the SizeConstraintSet. * `sql_injection_match_tuple` - (Optional) The parts of web requests that you want AWS WAF to inspect for malicious SQL code and, if you want AWS WAF to inspect a header, the name of the header. @@ -96,4 +97,4 @@ Using `terraform import`, import WAF Regional Sql Injection Match Set using the % terraform import aws_wafregional_sql_injection_match_set.sql_injection_match_set a1b2c3d4-d5f6-7777-8888-9999aaaabbbbcccc ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/wafregional_web_acl.html.markdown b/website/docs/cdktf/python/r/wafregional_web_acl.html.markdown index 20add098263a..15ee679ea405 100644 --- a/website/docs/cdktf/python/r/wafregional_web_acl.html.markdown +++ b/website/docs/cdktf/python/r/wafregional_web_acl.html.markdown @@ -137,6 +137,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `default_action` - (Required) The action that you want AWS WAF Regional to take when a request doesn't match the criteria in any of the rules that are associated with the web ACL. * `metric_name` - (Required) The name or description for the Amazon CloudWatch metric of this web ACL. * `name` - (Required) The name or description of the web ACL. @@ -212,4 +213,4 @@ Using `terraform import`, import WAF Regional Web ACL using the id. For example: % terraform import aws_wafregional_web_acl.wafacl a1b2c3d4-d5f6-7777-8888-9999aaaabbbbcccc ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/wafregional_web_acl_association.html.markdown b/website/docs/cdktf/python/r/wafregional_web_acl_association.html.markdown index cc66ad809a35..6b8420162844 100644 --- a/website/docs/cdktf/python/r/wafregional_web_acl_association.html.markdown +++ b/website/docs/cdktf/python/r/wafregional_web_acl_association.html.markdown @@ -197,6 +197,7 @@ resource "aws_wafregional_web_acl_association" "association" { This resource supports the following arguments: +* `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). * `web_acl_id` - (Required) The ID of the WAF Regional WebACL to create an association. * `resource_arn` - (Required) ARN of the resource to associate with. For example, an Application Load Balancer or API Gateway Stage. @@ -237,4 +238,4 @@ Using `terraform import`, import WAF Regional Web ACL Association using their `w % terraform import aws_wafregional_web_acl_association.foo web_acl_id:resource_arn ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/wafregional_xss_match_set.html.markdown b/website/docs/cdktf/python/r/wafregional_xss_match_set.html.markdown index 765b8acd25fd..e334bb9115bb 100644 --- a/website/docs/cdktf/python/r/wafregional_xss_match_set.html.markdown +++ b/website/docs/cdktf/python/r/wafregional_xss_match_set.html.markdown @@ -47,6 +47,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) The name of the set * `xss_match_tuple` - (Optional) The parts of web requests that you want to inspect for cross-site scripting attacks. @@ -93,4 +94,4 @@ Using `terraform import`, import AWS WAF Regional XSS Match using the `id`. For % terraform import aws_wafregional_xss_match_set.example 12345abcde ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/wafv2_api_key.html.markdown b/website/docs/cdktf/python/r/wafv2_api_key.html.markdown index 12f85718818d..3497c915d493 100644 --- a/website/docs/cdktf/python/r/wafv2_api_key.html.markdown +++ b/website/docs/cdktf/python/r/wafv2_api_key.html.markdown @@ -36,6 +36,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +- `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). - `scope` - (Required) Specifies whether this is for an AWS CloudFront distribution or for a regional application. Valid values are `CLOUDFRONT` or `REGIONAL`. Changing this forces a new resource to be created. **NOTE:** WAFv2 API Keys deployed for `CLOUDFRONT` must be created within the `us-east-1` region. - `token_domains` - (Required) The domains that you want to be able to use the API key with, for example `example.com`. You can specify up to 5 domains. Changing this forces a new resource to be created. @@ -70,4 +71,4 @@ Using `terraform import`, import WAFv2 API Key using `api_key,scope`. For exampl % terraform import aws_wafv2_api_key.example a1b2c3d4-5678-90ab-cdef-EXAMPLE11111,REGIONAL ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/wafv2_ip_set.html.markdown b/website/docs/cdktf/python/r/wafv2_ip_set.html.markdown index 9de8e6498e20..b5d998855101 100644 --- a/website/docs/cdktf/python/r/wafv2_ip_set.html.markdown +++ b/website/docs/cdktf/python/r/wafv2_ip_set.html.markdown @@ -43,6 +43,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Optional, Forces new resource) A friendly name of the IP set. If omitted, Terraform will assign a random, unique name. Conflicts with `name_prefix`. * `name_prefix` - (Optional) Creates a unique name beginning with the specified prefix. Conflicts with `name`. * `description` - (Optional) A friendly description of the IP set. @@ -84,4 +85,4 @@ Using `terraform import`, import WAFv2 IP Sets using `ID/name/scope`. For exampl % terraform import aws_wafv2_ip_set.example a1b2c3d4-d5f6-7777-8888-9999aaaabbbbcccc/example/REGIONAL ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/wafv2_regex_pattern_set.html.markdown b/website/docs/cdktf/python/r/wafv2_regex_pattern_set.html.markdown index 110467157f03..87757331a268 100644 --- a/website/docs/cdktf/python/r/wafv2_regex_pattern_set.html.markdown +++ b/website/docs/cdktf/python/r/wafv2_regex_pattern_set.html.markdown @@ -47,11 +47,12 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Optional, Forces new resource) A friendly name of the regular expression pattern set. If omitted, Terraform will assign a random, unique name. Conflicts with `name_prefix`. * `name_prefix` - (Optional) Creates a unique name beginning with the specified prefix. Conflicts with `name`. * `description` - (Optional) A friendly description of the regular expression pattern set. * `scope` - (Required) Specifies whether this is for an AWS CloudFront distribution or for a regional application. Valid values are `CLOUDFRONT` or `REGIONAL`. To work with CloudFront, you must also specify the region `us-east-1` (N. Virginia) on the AWS provider. -* `regular_expression` - (Optional) One or more blocks of regular expression patterns that you want AWS WAF to search for, such as `B[a@]dB[o0]t`. See [Regular Expression](#regular-expression) below for details. A maximum of 10 `regular_expression` blocks may be specified. +* `regular_expression` - (Optional) One or more blocks of regular expression patterns that you want AWS WAF to search for, such as `B[a@]dB[o0]t`. See [Regular Expression](#regular-expression) below for details. * `tags` - (Optional) An array of key:value pairs to associate with 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. ### Regular Expression @@ -91,4 +92,4 @@ Using `terraform import`, import WAFv2 Regex Pattern Sets using `ID/name/scope`. % terraform import aws_wafv2_regex_pattern_set.example a1b2c3d4-d5f6-7777-8888-9999aaaabbbbcccc/example/REGIONAL ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/wafv2_rule_group.html.markdown b/website/docs/cdktf/python/r/wafv2_rule_group.html.markdown index f7e201a5596a..93c04df6453c 100644 --- a/website/docs/cdktf/python/r/wafv2_rule_group.html.markdown +++ b/website/docs/cdktf/python/r/wafv2_rule_group.html.markdown @@ -284,16 +284,71 @@ class MyConvertedCode(TerraformStack): ) ``` +### Using rule_json + +```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, TerraformStack +# +# Provider bindings are generated by running `cdktf get`. +# See https://cdk.tf/provider-generation for more details. +# +from imports.aws.wafv2_rule_group import Wafv2RuleGroup +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + Wafv2RuleGroup(self, "example", + capacity=100, + name="example-rule-group", + rule_json=Fn.jsonencode([{ + "Action": { + "Count": {} + }, + "Name": "rule-1", + "Priority": 1, + "Statement": { + "ByteMatchStatement": { + "FieldToMatch": { + "UriPath": {} + }, + "PositionalConstraint": "CONTAINS", + "SearchString": "badbot", + "TextTransformations": [{ + "Priority": 1, + "Type": "NONE" + } + ] + } + }, + "VisibilityConfig": { + "CloudwatchMetricsEnabled": False, + "MetricName": "friendly-rule-metric-name", + "SampledRequestsEnabled": False + } + } + ]), + scope="REGIONAL", + visibility_config=Wafv2RuleGroupVisibilityConfig( + cloudwatch_metrics_enabled=False, + metric_name="friendly-metric-name", + sampled_requests_enabled=False + ) + ) +``` + ## Argument Reference This resource supports the following arguments: +* `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). * `capacity` - (Required, Forces new resource) The web ACL capacity units (WCUs) required for this rule group. See [here](https://docs.aws.amazon.com/waf/latest/APIReference/API_CreateRuleGroup.html#API_CreateRuleGroup_RequestSyntax) for general information and [here](https://docs.aws.amazon.com/waf/latest/developerguide/waf-rule-statements-list.html) for capacity specific information. * `custom_response_body` - (Optional) Defines custom response bodies that can be referenced by `custom_response` actions. See [Custom Response Body](#custom-response-body) below for details. * `description` - (Optional) A friendly description of the rule group. * `name` - (Required, Forces new resource) A friendly name of the rule group. * `name_prefix` - (Optional) Creates a unique name beginning with the specified prefix. Conflicts with `name`. * `rule` - (Optional) The rule blocks used to identify the web requests that you want to `allow`, `block`, or `count`. See [Rules](#rules) below for details. +* `rule_json` - (Optional) Raw JSON string to allow more than three nested statements. Conflicts with `rule` attribute. This is for advanced use cases where more than 3 levels of nested statements are required. **There is no drift detection at this time**. If you use this attribute instead of `rule`, you will be foregoing drift detection. Additionally, importing an existing rule group into a configuration with `rule_json` set will result in a one time in-place update as the remote rule configuration is initially written to the `rule` attribute. See the AWS [documentation](https://docs.aws.amazon.com/waf/latest/APIReference/API_CreateRuleGroup.html) for the JSON structure. * `scope` - (Required, Forces new resource) Specifies whether this is for an AWS CloudFront distribution or for a regional application. Valid values are `CLOUDFRONT` or `REGIONAL`. To work with CloudFront, you must also specify the region `us-east-1` (N. Virginia) on the AWS provider. * `tags` - (Optional) An array of key:value pairs to associate with 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. * `visibility_config` - (Required) Defines and enables Amazon CloudWatch metrics and web request sample collection. See [Visibility Configuration](#visibility-configuration) below for details. @@ -842,4 +897,4 @@ Using `terraform import`, import WAFv2 Rule Group using `ID/name/scope`. For exa % terraform import aws_wafv2_rule_group.example a1b2c3d4-d5f6-7777-8888-9999aaaabbbbcccc/example/REGIONAL ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/wafv2_web_acl.html.markdown b/website/docs/cdktf/python/r/wafv2_web_acl.html.markdown index db805753b597..9ed6dcda4dcb 100644 --- a/website/docs/cdktf/python/r/wafv2_web_acl.html.markdown +++ b/website/docs/cdktf/python/r/wafv2_web_acl.html.markdown @@ -14,6 +14,8 @@ Creates a WAFv2 Web ACL resource. ~> **Note** In `field_to_match` blocks, _e.g._, in `byte_match_statement`, the `body` block includes an optional argument `oversize_handling`. AWS indicates this argument will be required starting February 2023. To avoid configurations breaking when that change happens, treat the `oversize_handling` argument as **required** as soon as possible. +!> **Warning:** If you use the `aws_wafv2_web_acl_rule_group_association` resource to associate rule groups with this Web ACL, you must add `lifecycle { ignore_changes = [rule] }` to this resource to prevent configuration drift. The association resource modifies the Web ACL's rules outside of this resource's direct management. + ## Example Usage This resource is based on `aws_wafv2_rule_group`, check the documentation of the `aws_wafv2_rule_group` resource to see examples of the various available statements. @@ -461,6 +463,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `association_config` - (Optional) Specifies custom configurations for the associations between the web ACL and protected resources. See [`association_config`](#association_config-block) below for details. * `captcha_config` - (Optional) Specifies how AWS WAF should handle CAPTCHA evaluations on the ACL level (used by [AWS Bot Control](https://docs.aws.amazon.com/waf/latest/developerguide/aws-managed-rule-groups-bot.html)). See [`captcha_config`](#captcha_config-block) below for details. * `challenge_config` - (Optional) Specifies how AWS WAF should handle Challenge evaluations on the ACL level (used by [AWS Bot Control](https://docs.aws.amazon.com/waf/latest/developerguide/aws-managed-rule-groups-bot.html)). See [`challenge_config`](#challenge_config-block) below for details. @@ -822,6 +825,7 @@ The `managed_rule_group_configs` block support the following arguments: * `aws_managed_rules_bot_control_rule_set` - (Optional) Additional configuration for using the Bot Control managed rule group. Use this to specify the inspection level that you want to use. See [`aws_managed_rules_bot_control_rule_set`](#aws_managed_rules_bot_control_rule_set-block) for more details * `aws_managed_rules_acfp_rule_set` - (Optional) Additional configuration for using the Account Creation Fraud Prevention managed rule group. Use this to specify information such as the registration page of your application and the type of content to accept or reject from the client. +* `aws_managed_rules_anti_ddos_rule_set` - (Optional) Configuration for using the anti-DDoS managed rule group. See [`aws_managed_rules_anti_ddos_rule_set`](#aws_managed_rules_anti_ddos_rule_set-block) for more details. * `aws_managed_rules_atp_rule_set` - (Optional) Additional configuration for using the Account Takeover Protection managed rule group. Use this to specify information such as the sign-in page of your application and the type of content to accept or reject from the client. * `login_path` - (Optional, **Deprecated**) The path of the login endpoint for your application. * `password_field` - (Optional, **Deprecated**) Details about your login page password field. See [`password_field`](#password_field-block) for more details. @@ -841,6 +845,19 @@ The `managed_rule_group_configs` block support the following arguments: * `request_inspection` - (Optional) The criteria for inspecting login requests, used by the ATP rule group to validate credentials usage. See [`request_inspection`](#request_inspection-block) for more details. * `response_inspection` - (Optional) The criteria for inspecting responses to login requests, used by the ATP rule group to track login failure rates. Note that Response Inspection is available only on web ACLs that protect CloudFront distributions. See [`response_inspection`](#response_inspection-block) for more details. +### `aws_managed_rules_anti_ddos_rule_set` Block + +* `client_side_action_config` - (Required) Configuration for the request handling that's applied by the managed rule group rules `ChallengeAllDuringEvent` and `ChallengeDDoSRequests` during a distributed denial of service (DDoS) attack. See [`client_side_action_config`](#client_side_action_config-block) for more details. +* `sensitivity_to_block` - (Optional) Sensitivity that the rule group rule DDoSRequests uses when matching against the DDoS suspicion labeling on a request. Valid values are `LOW` (Default), `MEDIUM`, and `HIGH`. + +### `client_side_action_config` Block + +* `challenge` - (Required) Configuration for the use of the `AWSManagedRulesAntiDDoSRuleSet` rules `ChallengeAllDuringEvent` and `ChallengeDDoSRequests`. + * `exempt_uri_regular_expression` - (Optional) Block for the list of the regular expressions to match against the web request URI, used to identify requests that can't handle a silent browser challenge. + * `regex_string` - (Optional) Regular expression string. + * `sensitivity` - (Optional) Sensitivity that the rule group rule ChallengeDDoSRequests uses when matching against the DDoS suspicion labeling on a request. Valid values are `LOW`, `MEDIUM` and `HIGH` (Default). + * `usage_of_action` - (Required) Configuration whether to use the `AWSManagedRulesAntiDDoSRuleSet` rules `ChallengeAllDuringEvent` and `ChallengeDDoSRequests` in the rule group evaluation. Valid values are `ENABLED` and `DISABLED`. + ### `aws_managed_rules_atp_rule_set` Block * `enable_regex_in_path` - (Optional) Whether or not to allow the use of regular expressions in the login page path. @@ -1109,6 +1126,7 @@ Aggregate the request counts using one or more web request components as the agg The `custom_key` block supports the following arguments: +* `asn` - (Optional) Use an Autonomous System Number (ASN) derived from the request's originating or forwarded IP address as an aggregate key. See [RateLimit `asn`](#ratelimit-asn-block) below for details. * `cookie` - (Optional) Use the value of a cookie in the request as an aggregate key. See [RateLimit `cookie`](#ratelimit-cookie-block) below for details. * `forwarded_ip` - (Optional) Use the first IP address in an HTTP header as an aggregate key. See [`forwarded_ip`](#ratelimit-forwarded_ip-block) below for details. * `http_method` - (Optional) Use the request's HTTP method as an aggregate key. See [RateLimit `http_method`](#ratelimit-http_method-block) below for details. @@ -1121,6 +1139,12 @@ The `custom_key` block supports the following arguments: * `query_string` - (Optional) Use the request's query string as an aggregate key. See [RateLimit `query_string`](#ratelimit-query_string-block) below for details. * `uri_path` - (Optional) Use the request's URI path as an aggregate key. See [RateLimit `uri_path`](#ratelimit-uri_path-block) below for details. +### RateLimit `asn` Block + +Use an Autonomous System Number (ASN) derived from the request's originating or forwarded IP address as an aggregate key. Each distinct ASN contributes to the aggregation instance. + +The `asn` block is configured as an empty block `{}`. + ### RateLimit `cookie` Block Use the value of a cookie in the request as an aggregate key. Each distinct value in the cookie contributes to the aggregation instance. If you use a single cookie as your custom key, then each value fully defines an aggregation instance. @@ -1241,4 +1265,4 @@ Using `terraform import`, import WAFv2 Web ACLs using `ID/Name/Scope`. For examp % terraform import aws_wafv2_web_acl.example a1b2c3d4-d5f6-7777-8888-9999aaaabbbbcccc/example/REGIONAL ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/wafv2_web_acl_association.html.markdown b/website/docs/cdktf/python/r/wafv2_web_acl_association.html.markdown index 8362b1dd6239..765bf0ad7e13 100644 --- a/website/docs/cdktf/python/r/wafv2_web_acl_association.html.markdown +++ b/website/docs/cdktf/python/r/wafv2_web_acl_association.html.markdown @@ -104,6 +104,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `resource_arn` - (Required) The Amazon Resource Name (ARN) of the resource to associate with the web ACL. This must be an ARN of an Application Load Balancer, an Amazon API Gateway stage (REST only, HTTP is unsupported), an Amazon Cognito User Pool, an Amazon AppSync GraphQL API, an Amazon App Runner service, or an Amazon Verified Access instance. * `web_acl_arn` - (Required) The Amazon Resource Name (ARN) of the Web ACL that you want to associate with the resource. @@ -142,4 +143,4 @@ Using `terraform import`, import WAFv2 Web ACL Association using `WEB_ACL_ARN,RE % terraform import aws_wafv2_web_acl_association.example arn:aws:wafv2:...7ce849ea,arn:aws:apigateway:...ages/name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/wafv2_web_acl_logging_configuration.html.markdown b/website/docs/cdktf/python/r/wafv2_web_acl_logging_configuration.html.markdown index 30711ccc84e3..ab229c870354 100644 --- a/website/docs/cdktf/python/r/wafv2_web_acl_logging_configuration.html.markdown +++ b/website/docs/cdktf/python/r/wafv2_web_acl_logging_configuration.html.markdown @@ -131,7 +131,7 @@ class MyConvertedCode(TerraformStack): actions=["logs:CreateLogStream", "logs:PutLogEvents"], condition=[DataAwsIamPolicyDocumentStatementCondition( test="ArnLike", - values=["arn:aws:logs:${" + data_aws_region_current.name + "}:${" + current.account_id + "}:*" + values=["arn:aws:logs:${" + data_aws_region_current.region + "}:${" + current.account_id + "}:*" ], variable="aws:SourceArn" ), DataAwsIamPolicyDocumentStatementCondition( @@ -166,6 +166,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `log_destination_configs` - (Required) Configuration block that allows you to associate Amazon Kinesis Data Firehose, Cloudwatch Log log group, or S3 bucket Amazon Resource Names (ARNs) with the web ACL. **Note:** data firehose, log group, or bucket name **must** be prefixed with `aws-waf-logs-`, e.g. `aws-waf-logs-example-firehose`, `aws-waf-logs-example-log-group`, or `aws-waf-logs-example-bucket`. * `logging_filter` - (Optional) Configuration block that specifies which web requests are kept in the logs and which are dropped. It allows filtering based on the rule action and the web request labels applied by matching rules during web ACL evaluation. For more details, refer to the [Logging Filter](#logging-filter) section below. * `redacted_fields` - (Optional) Configuration for parts of the request that you want to keep out of the logs. Up to 100 `redacted_fields` blocks are supported. See [Redacted Fields](#redacted-fields) below for more details. @@ -257,4 +258,4 @@ Using `terraform import`, import WAFv2 Web ACL Logging Configurations using the % terraform import aws_wafv2_web_acl_logging_configuration.example arn:aws:wafv2:us-west-2:123456789012:regional/webacl/test-logs/a1b2c3d4-5678-90ab-cdef ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/wafv2_web_acl_rule_group_association.html.markdown b/website/docs/cdktf/python/r/wafv2_web_acl_rule_group_association.html.markdown new file mode 100644 index 000000000000..676c41ab3e94 --- /dev/null +++ b/website/docs/cdktf/python/r/wafv2_web_acl_rule_group_association.html.markdown @@ -0,0 +1,598 @@ +--- +subcategory: "WAF" +layout: "aws" +page_title: "AWS: aws_wafv2_web_acl_rule_group_association" +description: |- + Associates a WAFv2 Rule Group with a Web ACL by adding a rule that references the Rule Group. +--- + + + +# Resource: aws_wafv2_web_acl_rule_group_association + +Associates a WAFv2 Rule Group (custom or managed) with a Web ACL by adding a rule that references the Rule Group. Use this resource to apply the rules defined in a Rule Group to a Web ACL without duplicating rule definitions. + +This resource supports both: + +- **Custom Rule Groups**: User-created rule groups that you manage within your AWS account +- **Managed Rule Groups**: Pre-configured rule groups provided by AWS or third-party vendors + +!> **Warning:** Verify the rule names in your `rule_action_override`s carefully. With managed rule groups, WAF silently ignores any override that uses an invalid rule name. With customer-owned rule groups, invalid rule names in your overrides will cause web ACL updates to fail. An invalid rule name is any name that doesn't exactly match the case-sensitive name of an existing rule in the rule group. + +!> **Warning:** Using this resource will cause the associated Web ACL resource to show configuration drift in the `rule` argument unless you add `lifecycle { ignore_changes = [rule] }` to the Web ACL resource configuration. This is because this resource modifies the Web ACL's rules outside of the Web ACL resource's direct management. + +~> **Note:** This resource creates a rule within the Web ACL that references the entire Rule Group. The rule group's individual rules are evaluated as a unit when requests are processed by the Web ACL. + +## Example Usage + +### Custom Rule Group - Basic Usage + +```python +# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +from cdktf import TerraformResourceLifecycle +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.wafv2_rule_group import Wafv2RuleGroup +from imports.aws.wafv2_web_acl import Wafv2WebAcl +from imports.aws.wafv2_web_acl_rule_group_association import Wafv2WebAclRuleGroupAssociation +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + example = Wafv2RuleGroup(self, "example", + capacity=10, + name="example-rule-group", + rule=[Wafv2RuleGroupRule( + action=Wafv2RuleGroupRuleAction( + block=Wafv2RuleGroupRuleActionBlock() + ), + name="block-suspicious-requests", + priority=1, + statement={ + "geo_match_statement": { + "country_codes": ["CN", "RU"] + } + }, + visibility_config=Wafv2RuleGroupRuleVisibilityConfig( + cloudwatch_metrics_enabled=True, + metric_name="block-suspicious-requests", + sampled_requests_enabled=True + ) + ) + ], + scope="REGIONAL", + visibility_config=Wafv2RuleGroupVisibilityConfig( + cloudwatch_metrics_enabled=True, + metric_name="example-rule-group", + sampled_requests_enabled=True + ) + ) + aws_wafv2_web_acl_example = Wafv2WebAcl(self, "example_1", + default_action=Wafv2WebAclDefaultAction( + allow=Wafv2WebAclDefaultActionAllow() + ), + lifecycle=TerraformResourceLifecycle( + ignore_changes=[rule] + ), + name="example-web-acl", + scope="REGIONAL", + visibility_config=Wafv2WebAclVisibilityConfig( + cloudwatch_metrics_enabled=True, + metric_name="example-web-acl", + sampled_requests_enabled=True + ) + ) + # 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_wafv2_web_acl_example.override_logical_id("example") + aws_wafv2_web_acl_rule_group_association_example = + Wafv2WebAclRuleGroupAssociation(self, "example_2", + priority=100, + rule_group_reference=[Wafv2WebAclRuleGroupAssociationRuleGroupReference( + arn=example.arn + ) + ], + rule_name="example-rule-group-rule", + web_acl_arn=Token.as_string(aws_wafv2_web_acl_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_wafv2_web_acl_rule_group_association_example.override_logical_id("example") +``` + +### Managed Rule Group - Basic Usage + +```python +# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +from cdktf import TerraformResourceLifecycle +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.wafv2_web_acl import Wafv2WebAcl +from imports.aws.wafv2_web_acl_rule_group_association import Wafv2WebAclRuleGroupAssociation +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + example = Wafv2WebAcl(self, "example", + default_action=Wafv2WebAclDefaultAction( + allow=Wafv2WebAclDefaultActionAllow() + ), + lifecycle=TerraformResourceLifecycle( + ignore_changes=[rule] + ), + name="example-web-acl", + scope="REGIONAL", + visibility_config=Wafv2WebAclVisibilityConfig( + cloudwatch_metrics_enabled=True, + metric_name="example-web-acl", + sampled_requests_enabled=True + ) + ) + Wafv2WebAclRuleGroupAssociation(self, "managed_example", + managed_rule_group=[Wafv2WebAclRuleGroupAssociationManagedRuleGroup( + name="AWSManagedRulesCommonRuleSet", + vendor_name="AWS" + ) + ], + priority=50, + rule_name="aws-common-rule-set", + web_acl_arn=example.arn + ) +``` + +### Managed Rule Group - With 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.wafv2_web_acl_rule_group_association import Wafv2WebAclRuleGroupAssociation +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + Wafv2WebAclRuleGroupAssociation(self, "managed_versioned", + managed_rule_group=[Wafv2WebAclRuleGroupAssociationManagedRuleGroup( + name="AWSManagedRulesCommonRuleSet", + vendor_name="AWS", + version="Version_1.0" + ) + ], + priority=60, + rule_name="aws-common-rule-set-versioned", + web_acl_arn=example.arn + ) +``` + +### Managed Rule Group - With Rule Action Overrides + +```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.wafv2_web_acl_rule_group_association import Wafv2WebAclRuleGroupAssociation +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + Wafv2WebAclRuleGroupAssociation(self, "managed_with_overrides", + managed_rule_group=[Wafv2WebAclRuleGroupAssociationManagedRuleGroup( + name="AWSManagedRulesCommonRuleSet", + rule_action_override=[Wafv2WebAclRuleGroupAssociationManagedRuleGroupRuleActionOverride( + action_to_use=[Wafv2WebAclRuleGroupAssociationManagedRuleGroupRuleActionOverrideActionToUse( + count=[Wafv2WebAclRuleGroupAssociationManagedRuleGroupRuleActionOverrideActionToUseCount( + custom_request_handling=[Wafv2WebAclRuleGroupAssociationManagedRuleGroupRuleActionOverrideActionToUseCountCustomRequestHandling( + insert_header=[Wafv2WebAclRuleGroupAssociationManagedRuleGroupRuleActionOverrideActionToUseCountCustomRequestHandlingInsertHeader( + name="X-RFI-Override", + value="counted" + ) + ] + ) + ] + ) + ] + ) + ], + name="GenericRFI_BODY" + ), Wafv2WebAclRuleGroupAssociationManagedRuleGroupRuleActionOverride( + action_to_use=[Wafv2WebAclRuleGroupAssociationManagedRuleGroupRuleActionOverrideActionToUse( + captcha=[Wafv2WebAclRuleGroupAssociationManagedRuleGroupRuleActionOverrideActionToUseCaptcha()] + ) + ], + name="SizeRestrictions_BODY" + ) + ], + vendor_name="AWS" + ) + ], + priority=70, + rule_name="aws-common-rule-set-with-overrides", + web_acl_arn=example.arn + ) +``` + +### Custom Rule Group - With Override Action + +```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.wafv2_web_acl_rule_group_association import Wafv2WebAclRuleGroupAssociation +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + Wafv2WebAclRuleGroupAssociation(self, "example", + override_action="count", + priority=100, + rule_group_reference=[Wafv2WebAclRuleGroupAssociationRuleGroupReference( + arn=Token.as_string(aws_wafv2_rule_group_example.arn) + ) + ], + rule_name="example-rule-group-rule", + web_acl_arn=Token.as_string(aws_wafv2_web_acl_example.arn) + ) +``` + +### Custom Rule Group - With Rule Action Overrides + +```python +# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +from cdktf import TerraformResourceLifecycle +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.wafv2_rule_group import Wafv2RuleGroup +from imports.aws.wafv2_web_acl import Wafv2WebAcl +from imports.aws.wafv2_web_acl_rule_group_association import Wafv2WebAclRuleGroupAssociation +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + example = Wafv2RuleGroup(self, "example", + capacity=10, + name="example-rule-group", + rule=[Wafv2RuleGroupRule( + action=Wafv2RuleGroupRuleAction( + block=Wafv2RuleGroupRuleActionBlock() + ), + name="geo-block-rule", + priority=1, + statement={ + "geo_match_statement": { + "country_codes": ["CN", "RU"] + } + }, + visibility_config=Wafv2RuleGroupRuleVisibilityConfig( + cloudwatch_metrics_enabled=True, + metric_name="geo-block-rule", + sampled_requests_enabled=True + ) + ), Wafv2RuleGroupRule( + action=Wafv2RuleGroupRuleAction( + block=Wafv2RuleGroupRuleActionBlock() + ), + name="rate-limit-rule", + priority=2, + statement={ + "rate_based_statement": { + "aggregate_key_type": "IP", + "limit": 1000 + } + }, + visibility_config=Wafv2RuleGroupRuleVisibilityConfig( + cloudwatch_metrics_enabled=True, + metric_name="rate-limit-rule", + sampled_requests_enabled=True + ) + ) + ], + scope="REGIONAL", + visibility_config=Wafv2RuleGroupVisibilityConfig( + cloudwatch_metrics_enabled=True, + metric_name="example-rule-group", + sampled_requests_enabled=True + ) + ) + aws_wafv2_web_acl_example = Wafv2WebAcl(self, "example_1", + default_action=Wafv2WebAclDefaultAction( + allow=Wafv2WebAclDefaultActionAllow() + ), + lifecycle=TerraformResourceLifecycle( + ignore_changes=[rule] + ), + name="example-web-acl", + scope="REGIONAL", + visibility_config=Wafv2WebAclVisibilityConfig( + cloudwatch_metrics_enabled=True, + metric_name="example-web-acl", + sampled_requests_enabled=True + ) + ) + # 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_wafv2_web_acl_example.override_logical_id("example") + aws_wafv2_web_acl_rule_group_association_example = + Wafv2WebAclRuleGroupAssociation(self, "example_2", + priority=100, + rule_group_reference=[Wafv2WebAclRuleGroupAssociationRuleGroupReference( + arn=example.arn, + rule_action_override=[Wafv2WebAclRuleGroupAssociationRuleGroupReferenceRuleActionOverride( + action_to_use=[Wafv2WebAclRuleGroupAssociationRuleGroupReferenceRuleActionOverrideActionToUse( + count=[Wafv2WebAclRuleGroupAssociationRuleGroupReferenceRuleActionOverrideActionToUseCount( + custom_request_handling=[Wafv2WebAclRuleGroupAssociationRuleGroupReferenceRuleActionOverrideActionToUseCountCustomRequestHandling( + insert_header=[Wafv2WebAclRuleGroupAssociationRuleGroupReferenceRuleActionOverrideActionToUseCountCustomRequestHandlingInsertHeader( + name="X-Geo-Block-Override", + value="counted" + ) + ] + ) + ] + ) + ] + ) + ], + name="geo-block-rule" + ), Wafv2WebAclRuleGroupAssociationRuleGroupReferenceRuleActionOverride( + action_to_use=[Wafv2WebAclRuleGroupAssociationRuleGroupReferenceRuleActionOverrideActionToUse( + captcha=[Wafv2WebAclRuleGroupAssociationRuleGroupReferenceRuleActionOverrideActionToUseCaptcha( + custom_request_handling=[Wafv2WebAclRuleGroupAssociationRuleGroupReferenceRuleActionOverrideActionToUseCaptchaCustomRequestHandling( + insert_header=[Wafv2WebAclRuleGroupAssociationRuleGroupReferenceRuleActionOverrideActionToUseCaptchaCustomRequestHandlingInsertHeader( + name="X-Rate-Limit-Override", + value="captcha-required" + ) + ] + ) + ] + ) + ] + ) + ], + name="rate-limit-rule" + ) + ] + ) + ], + rule_name="example-rule-group-rule", + web_acl_arn=Token.as_string(aws_wafv2_web_acl_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_wafv2_web_acl_rule_group_association_example.override_logical_id("example") +``` + +### Custom Rule Group - CloudFront Web ACL + +```python +# DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +from cdktf import TerraformResourceLifecycle +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.wafv2_rule_group import Wafv2RuleGroup +from imports.aws.wafv2_web_acl import Wafv2WebAcl +from imports.aws.wafv2_web_acl_rule_group_association import Wafv2WebAclRuleGroupAssociation +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + cloudfront_example = Wafv2RuleGroup(self, "cloudfront_example", + capacity=10, + name="cloudfront-rule-group", + rule=[Wafv2RuleGroupRule( + action=Wafv2RuleGroupRuleAction( + block=Wafv2RuleGroupRuleActionBlock() + ), + name="rate-limit", + priority=1, + statement={ + "rate_based_statement": { + "aggregate_key_type": "IP", + "limit": 2000 + } + }, + visibility_config=Wafv2RuleGroupRuleVisibilityConfig( + cloudwatch_metrics_enabled=True, + metric_name="rate-limit", + sampled_requests_enabled=True + ) + ) + ], + scope="CLOUDFRONT", + visibility_config=Wafv2RuleGroupVisibilityConfig( + cloudwatch_metrics_enabled=True, + metric_name="cloudfront-rule-group", + sampled_requests_enabled=True + ) + ) + aws_wafv2_web_acl_cloudfront_example = Wafv2WebAcl(self, "cloudfront_example_1", + default_action=Wafv2WebAclDefaultAction( + allow=Wafv2WebAclDefaultActionAllow() + ), + lifecycle=TerraformResourceLifecycle( + ignore_changes=[rule] + ), + name="cloudfront-web-acl", + scope="CLOUDFRONT", + visibility_config=Wafv2WebAclVisibilityConfig( + cloudwatch_metrics_enabled=True, + metric_name="cloudfront-web-acl", + sampled_requests_enabled=True + ) + ) + # 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_wafv2_web_acl_cloudfront_example.override_logical_id("cloudfront_example") + aws_wafv2_web_acl_rule_group_association_cloudfront_example = + Wafv2WebAclRuleGroupAssociation(self, "cloudfront_example_2", + priority=50, + rule_group_reference=[Wafv2WebAclRuleGroupAssociationRuleGroupReference( + arn=cloudfront_example.arn + ) + ], + rule_name="cloudfront-rule-group-rule", + web_acl_arn=Token.as_string(aws_wafv2_web_acl_cloudfront_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_wafv2_web_acl_rule_group_association_cloudfront_example.override_logical_id("cloudfront_example") +``` + +## Argument Reference + +The following arguments are required: + +* `rule_name` - (Required) Name of the rule to create in the Web ACL that references the rule group. Must be between 1 and 128 characters. +* `priority` - (Required) Priority of the rule within the Web ACL. Rules are evaluated in order of priority, with lower numbers evaluated first. +* `web_acl_arn` - (Required) ARN of the Web ACL to associate the Rule Group with. + +The following arguments are optional: + +* `managed_rule_group` - (Optional) Managed Rule Group configuration. One of `rule_group_reference` or `managed_rule_group` is required. Conflicts with `rule_group_reference`. [See below](#managed_rule_group). +* `override_action` - (Optional) Override action for the rule group. Valid values are `none` and `count`. Defaults to `none`. When set to `count`, the actions defined in the rule group rules are overridden to count matches instead of blocking or allowing requests. +* `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). +* `rule_group_reference` - (Optional) Custom Rule Group reference configuration. One of `rule_group_reference` or `managed_rule_group` is required. Conflicts with `managed_rule_group`. [See below](#rule_group_reference). + +### rule_group_reference + +* `arn` - (Required) ARN of the Rule Group to associate with the Web ACL. +* `rule_action_override` - (Optional) Override actions for specific rules within the rule group. [See below](#rule_action_override). + +### managed_rule_group + +* `name` - (Required) Name of the managed rule group. +* `vendor_name` - (Required) Name of the managed rule group vendor. For AWS managed rule groups, this is `AWS`. +* `version` - (Optional) Version of the managed rule group. If not specified, the default version is used. +* `rule_action_override` - (Optional) Override actions for specific rules within the rule group. [See below](#rule_action_override). + +### rule_action_override + +* `name` - (Required) Name of the rule to override within the rule group. Verify the name carefully. With managed rule groups, WAF silently ignores any override that uses an invalid rule name. With customer-owned rule groups, invalid rule names in your overrides will cause web ACL updates to fail. An invalid rule name is any name that doesn't exactly match the case-sensitive name of an existing rule in the rule group. +* `action_to_use` - (Required) Action to use instead of the rule's original action. [See below](#action_to_use). + +### action_to_use + +Exactly one of the following action blocks must be specified: + +* `allow` - (Optional) Allow the request. [See below](#allow). +* `block` - (Optional) Block the request. [See below](#block). +* `captcha` - (Optional) Require CAPTCHA verification. [See below](#captcha). +* `challenge` - (Optional) Require challenge verification. [See below](#challenge). +* `count` - (Optional) Count the request without taking action. [See below](#count). + +### allow + +* `custom_request_handling` - (Optional) Custom handling for allowed requests. [See below](#custom_request_handling). + +### block + +* `custom_response` - (Optional) Custom response for blocked requests. [See below](#custom_response). + +### captcha + +* `custom_request_handling` - (Optional) Custom handling for CAPTCHA requests. [See below](#custom_request_handling). + +### challenge + +* `custom_request_handling` - (Optional) Custom handling for challenge requests. [See below](#custom_request_handling). + +### count + +* `custom_request_handling` - (Optional) Custom handling for counted requests. [See below](#custom_request_handling). + +### custom_request_handling + +* `insert_header` - (Required) Headers to insert into the request. [See below](#insert_header). + +### custom_response + +* `custom_response_body_key` - (Optional) Key of a custom response body to use. +* `response_code` - (Required) HTTP response code to return (200-599). +* `response_header` - (Optional) Headers to include in the response. [See below](#response_header). + +### insert_header + +* `name` - (Required) Name of the header to insert. +* `value` - (Required) Value of the header to insert. + +### response_header + +* `name` - (Required) Name of the response header. +* `value` - (Required) Value of the response header. + +## Attribute Reference + +This resource exports the following attributes in addition to the arguments above: + +None. + +## Timeouts + +[Configuration options](https://developer.hashicorp.com/terraform/language/resources/syntax#operation-timeouts): + +* `create` - (Default `30m`) +* `update` - (Default `30m`) +* `delete` - (Default `30m`) + +## Import + +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import WAFv2 web ACL custom rule group associations using `WebACLARN,RuleGroupARN,RuleName`. 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.wafv2_web_acl_rule_group_association import Wafv2WebAclRuleGroupAssociation +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + Wafv2WebAclRuleGroupAssociation.generate_config_for_import(self, "example", "arn:aws:wafv2:us-east-1:123456789012:regional/webacl/example-web-acl/12345678-1234-1234-1234-123456789012,arn:aws:wafv2:us-east-1:123456789012:regional/rulegroup/example-rule-group/87654321-4321-4321-4321-210987654321,example-rule-group-rule") +``` + +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import WAFv2 web ACL managed rule group associations using `WebACLARN,VendorName:RuleGroupName[:Version],RuleName`. 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.wafv2_web_acl_rule_group_association import Wafv2WebAclRuleGroupAssociation +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + Wafv2WebAclRuleGroupAssociation.generate_config_for_import(self, "managedExample", "arn:aws:wafv2:us-east-1:123456789012:regional/webacl/example-web-acl/12345678-1234-1234-1234-123456789012,AWS:AWSManagedRulesCommonRuleSet,aws-common-rule-set") +``` + +Using `terraform import`, import WAFv2 web ACL custom rule group associations using `WebACLARN,RuleGroupARN,RuleName`. For example: + +```console +% terraform import aws_wafv2_web_acl_rule_group_association.example "arn:aws:wafv2:us-east-1:123456789012:regional/webacl/example-web-acl/12345678-1234-1234-1234-123456789012,arn:aws:wafv2:us-east-1:123456789012:regional/rulegroup/example-rule-group/87654321-4321-4321-4321-210987654321,example-rule-group-rule" +``` + +Using `terraform import`, import WAFv2 web ACL managed rule group associations using `WebACLARN,VendorName:RuleGroupName[:Version],RuleName`. For example: + +```console +% terraform import aws_wafv2_web_acl_rule_group_association.managed_example "arn:aws:wafv2:us-east-1:123456789012:regional/webacl/example-web-acl/12345678-1234-1234-1234-123456789012,AWS:AWSManagedRulesCommonRuleSet,aws-common-rule-set" +``` + + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/workspaces_connection_alias.html.markdown b/website/docs/cdktf/python/r/workspaces_connection_alias.html.markdown index 18ed17822942..e9365629c041 100644 --- a/website/docs/cdktf/python/r/workspaces_connection_alias.html.markdown +++ b/website/docs/cdktf/python/r/workspaces_connection_alias.html.markdown @@ -35,10 +35,11 @@ class MyConvertedCode(TerraformStack): ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `connection_string` - (Required) The connection string specified for the connection alias. The connection string must be in the form of a fully qualified domain name (FQDN), such as www.example.com. -* `tags` – (Optional) A map of tags assigned to the WorkSpaces Connection Alias. 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. +* `tags` - (Optional) A map of tags assigned to the WorkSpaces Connection Alias. 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. ## Attribute Reference @@ -82,4 +83,4 @@ Using `terraform import`, import WorkSpaces Connection Alias using the connectio % terraform import aws_workspaces_connection_alias.example rft-8012925589 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/workspaces_directory.html.markdown b/website/docs/cdktf/python/r/workspaces_directory.html.markdown index 4477254294a9..b03fc6485b54 100644 --- a/website/docs/cdktf/python/r/workspaces_directory.html.markdown +++ b/website/docs/cdktf/python/r/workspaces_directory.html.markdown @@ -148,14 +148,13 @@ from cdktf import Token, TerraformStack # from imports.aws.workspaces_directory import WorkspacesDirectory class MyConvertedCode(TerraformStack): - def __init__(self, scope, name, *, directoryId): + def __init__(self, scope, name): super().__init__(scope, name) WorkspacesDirectory(self, "example", - active_directory_config=[{ - "domain_name": "example.internal", - "service_account_secret_arn": aws_secretsmanager_secret_example.arn - } - ], + active_directory_config=WorkspacesDirectoryActiveDirectoryConfig( + domain_name="example.internal", + service_account_secret_arn=Token.as_string(aws_secretsmanager_secret_example.arn) + ), saml_properties=WorkspacesDirectorySamlProperties( relay_state_parameter_name="RelayState", status="ENABLED", @@ -180,8 +179,7 @@ class MyConvertedCode(TerraformStack): ), workspace_directory_description="WorkSpaces Pools directory", workspace_directory_name="Pool directory", - workspace_type="POOLS", - directory_id=directory_id + workspace_type="POOLS" ) ``` @@ -215,17 +213,18 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `directory_id` - (Optional) The directory identifier for registration in WorkSpaces service. * `subnet_ids` - (Optional) The identifiers of the subnets where the directory resides. -* `ip_group_ids` – (Optional) The identifiers of the IP access control groups associated with the directory. -* `tags` – (Optional) A map of tags assigned to the WorkSpaces directory. 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. +* `ip_group_ids` - (Optional) The identifiers of the IP access control groups associated with the directory. +* `tags` - (Optional) A map of tags assigned to the WorkSpaces directory. 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. * `certificate_based_auth_properties` - (Optional) Configuration of certificate-based authentication (CBA) integration. Requires SAML authentication to be enabled. Defined below. -* `saml_properties` – (Optional) Configuration of SAML authentication integration. Defined below. -* `self_service_permissions` – (Optional) Permissions to enable or disable self-service capabilities when `workspace_type` is set to `PERSONAL`.. Defined below. -* `workspace_access_properties` – (Optional) Specifies which devices and operating systems users can use to access their WorkSpaces. Defined below. -* `workspace_creation_properties` – (Optional) Default properties that are used for creating WorkSpaces. Defined below. +* `saml_properties` - (Optional) Configuration of SAML authentication integration. Defined below. +* `self_service_permissions` - (Optional) Permissions to enable or disable self-service capabilities when `workspace_type` is set to `PERSONAL`.. Defined below. +* `workspace_access_properties` - (Optional) Specifies which devices and operating systems users can use to access their WorkSpaces. Defined below. +* `workspace_creation_properties` - (Optional) Default properties that are used for creating WorkSpaces. Defined below. * `workspace_type` - (Optional) Specifies the type of WorkSpaces directory. Valid values are `PERSONAL` and `POOLS`. Default is `PERSONAL`. -* `active_directory_config` – (Optional) Configuration for Active Directory integration when `workspace_type` is set to `POOLS`. Defined below. +* `active_directory_config` - (Optional) Configuration for Active Directory integration when `workspace_type` is set to `POOLS`. Defined below. * `workspace_directory_name` - (Required for `POOLS`) The name of the WorkSpaces directory when `workspace_type` is set to `POOLS`. * `workspace_directory_description` - (Required for `POOLS`) The description of the WorkSpaces directory when `workspace_type` is set to `POOLS`. * `user_identity_type` - (Required for `POOLS`) Specifies the user identity type for the WorkSpaces directory. Valid values are `CUSTOMER_MANAGED`, `AWS_DIRECTORY_SERVICE`, `AWS_IAM_IDENTITY_CENTER`. @@ -245,39 +244,39 @@ This resource supports the following arguments: ### self_service_permissions -* `change_compute_type` – (Optional) Whether WorkSpaces directory users can change the compute type (bundle) for their workspace. Default `false`. -* `increase_volume_size` – (Optional) Whether WorkSpaces directory users can increase the volume size of the drives on their workspace. Default `false`. -* `rebuild_workspace` – (Optional) Whether WorkSpaces directory users can rebuild the operating system of a workspace to its original state. Default `false`. -* `restart_workspace` – (Optional) Whether WorkSpaces directory users can restart their workspace. Default `true`. -* `switch_running_mode` – (Optional) Whether WorkSpaces directory users can switch the running mode of their workspace. Default `false`. +* `change_compute_type` - (Optional) Whether WorkSpaces directory users can change the compute type (bundle) for their workspace. Default `false`. +* `increase_volume_size` - (Optional) Whether WorkSpaces directory users can increase the volume size of the drives on their workspace. Default `false`. +* `rebuild_workspace` - (Optional) Whether WorkSpaces directory users can rebuild the operating system of a workspace to its original state. Default `false`. +* `restart_workspace` - (Optional) Whether WorkSpaces directory users can restart their workspace. Default `true`. +* `switch_running_mode` - (Optional) Whether WorkSpaces directory users can switch the running mode of their workspace. Default `false`. ### workspace_access_properties -* `device_type_android` – (Optional) Indicates whether users can use Android devices to access their WorkSpaces. -* `device_type_chromeos` – (Optional) Indicates whether users can use Chromebooks to access their WorkSpaces. -* `device_type_ios` – (Optional) Indicates whether users can use iOS devices to access their WorkSpaces. -* `device_type_linux` – (Optional) Indicates whether users can use Linux clients to access their WorkSpaces. -* `device_type_osx` – (Optional) Indicates whether users can use macOS clients to access their WorkSpaces. -* `device_type_web` – (Optional) Indicates whether users can access their WorkSpaces through a web browser. -* `device_type_windows` – (Optional) Indicates whether users can use Windows clients to access their WorkSpaces. -* `device_type_zeroclient` – (Optional) Indicates whether users can use zero client devices to access their WorkSpaces. +* `device_type_android` - (Optional) Indicates whether users can use Android devices to access their WorkSpaces. +* `device_type_chromeos` - (Optional) Indicates whether users can use Chromebooks to access their WorkSpaces. +* `device_type_ios` - (Optional) Indicates whether users can use iOS devices to access their WorkSpaces. +* `device_type_linux` - (Optional) Indicates whether users can use Linux clients to access their WorkSpaces. +* `device_type_osx` - (Optional) Indicates whether users can use macOS clients to access their WorkSpaces. +* `device_type_web` - (Optional) Indicates whether users can access their WorkSpaces through a web browser. +* `device_type_windows` - (Optional) Indicates whether users can use Windows clients to access their WorkSpaces. +* `device_type_zeroclient` - (Optional) Indicates whether users can use zero client devices to access their WorkSpaces. ### workspace_creation_properties -> **Note:** Once you specified `custom_security_group_id` or `default_ou`, there is no way to delete these attributes. If you cleanup them from the configuration, they still be present in state. -* `custom_security_group_id` – (Optional) The identifier of your custom security group. Should relate to the same VPC, where workspaces reside in. -* `default_ou` – (Optional) The default organizational unit (OU) for your WorkSpace directories. Should conform `"OU=,DC=,...,DC="` pattern. -* `enable_internet_access` – (Optional) Indicates whether internet access is enabled for your WorkSpaces. -* `enable_maintenance_mode` – (Optional) Indicates whether maintenance mode is enabled for your WorkSpaces. Valid only if `workspace_type` is set to `PERSONAL`. -* `user_enabled_as_local_administrator` – (Optional) Indicates whether users are local administrators of their WorkSpaces. Valid only if `workspace_type` is set to `PERSONAL`. +* `custom_security_group_id` - (Optional) The identifier of your custom security group. Should relate to the same VPC, where workspaces reside in. +* `default_ou` - (Optional) The default organizational unit (OU) for your WorkSpace directories. Should conform `"OU=,DC=,...,DC="` pattern. +* `enable_internet_access` - (Optional) Indicates whether internet access is enabled for your WorkSpaces. +* `enable_maintenance_mode` - (Optional) Indicates whether maintenance mode is enabled for your WorkSpaces. Valid only if `workspace_type` is set to `PERSONAL`. +* `user_enabled_as_local_administrator` - (Optional) Indicates whether users are local administrators of their WorkSpaces. Valid only if `workspace_type` is set to `PERSONAL`. ### active_directory_config -> **Note:** `active_directory_config` is only valid if `workspaces_type` is set to `POOLS`. -* `domain_name` – Fully qualified domain name of the AWS Directory Service directory. -* `service_account_secret_arn` – ARN of the Secrets Manager secret that contains the credentials for the service account. For more information, see [Service Account Details](https://docs.aws.amazon.com/workspaces/latest/adminguide/pools-service-account-details.html). +* `domain_name` - Fully qualified domain name of the AWS Directory Service directory. +* `service_account_secret_arn` - ARN of the Secrets Manager secret that contains the credentials for the service account. For more information, see [Service Account Details](https://docs.aws.amazon.com/workspaces/latest/adminguide/pools-service-account-details.html). ## Attribute Reference @@ -320,4 +319,4 @@ Using `terraform import`, import Workspaces directory using the directory ID. Fo % terraform import aws_workspaces_directory.main d-4444444444 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/workspaces_ip_group.html.markdown b/website/docs/cdktf/python/r/workspaces_ip_group.html.markdown index 83d2df265424..22331f8ec7cb 100644 --- a/website/docs/cdktf/python/r/workspaces_ip_group.html.markdown +++ b/website/docs/cdktf/python/r/workspaces_ip_group.html.markdown @@ -47,10 +47,11 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `name` - (Required) The name of the IP group. * `description` - (Optional) The description of the IP group. * `rules` - (Optional) One or more pairs specifying the IP group rule (in CIDR format) from which web requests originate. -* `tags` – (Optional) A map of tags assigned to the WorkSpaces directory. 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. +* `tags` - (Optional) A map of tags assigned to the WorkSpaces directory. 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. ## Nested Blocks @@ -93,4 +94,4 @@ Using `terraform import`, import WorkSpaces IP groups using their GroupID. For e % terraform import aws_workspaces_ip_group.example wsipg-488lrtl3k ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/workspaces_workspace.html.markdown b/website/docs/cdktf/python/r/workspaces_workspace.html.markdown index 3327a618ff55..dbd2f9259908 100644 --- a/website/docs/cdktf/python/r/workspaces_workspace.html.markdown +++ b/website/docs/cdktf/python/r/workspaces_workspace.html.markdown @@ -60,22 +60,23 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `directory_id` - (Required) The ID of the directory for the WorkSpace. * `bundle_id` - (Required) The ID of the bundle for the WorkSpace. -* `user_name` – (Required) The user name of the user for the WorkSpace. This user name must exist in the directory for the WorkSpace. +* `user_name` - (Required) The user name of the user for the WorkSpace. This user name must exist in the directory for the WorkSpace. * `root_volume_encryption_enabled` - (Optional) Indicates whether the data stored on the root volume is encrypted. -* `user_volume_encryption_enabled` – (Optional) Indicates whether the data stored on the user volume is encrypted. -* `volume_encryption_key` – (Optional) The ARN of a symmetric AWS KMS customer master key (CMK) used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric CMKs. +* `user_volume_encryption_enabled` - (Optional) Indicates whether the data stored on the user volume is encrypted. +* `volume_encryption_key` - (Optional) The ARN of a symmetric AWS KMS customer master key (CMK) used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric CMKs. * `tags` - (Optional) The tags for the WorkSpace. 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. -* `workspace_properties` – (Optional) The WorkSpace properties. +* `workspace_properties` - (Optional) The WorkSpace properties. `workspace_properties` supports the following: -* `compute_type_name` – (Optional) The compute type. For more information, see [Amazon WorkSpaces Bundles](http://aws.amazon.com/workspaces/details/#Amazon_WorkSpaces_Bundles). Valid values are `VALUE`, `STANDARD`, `PERFORMANCE`, `POWER`, `GRAPHICS`, `POWERPRO`, `GRAPHICSPRO`, `GRAPHICS_G4DN`, and `GRAPHICSPRO_G4DN`. -* `root_volume_size_gib` – (Optional) The size of the root volume. -* `running_mode` – (Optional) The running mode. For more information, see [Manage the WorkSpace Running Mode](https://docs.aws.amazon.com/workspaces/latest/adminguide/running-mode.html). Valid values are `AUTO_STOP` and `ALWAYS_ON`. -* `running_mode_auto_stop_timeout_in_minutes` – (Optional) The time after a user logs off when WorkSpaces are automatically stopped. Configured in 60-minute intervals. -* `user_volume_size_gib` – (Optional) The size of the user storage. +* `compute_type_name` - (Optional) The compute type. For more information, see [Amazon WorkSpaces Bundles](http://aws.amazon.com/workspaces/details/#Amazon_WorkSpaces_Bundles). Valid values are `VALUE`, `STANDARD`, `PERFORMANCE`, `POWER`, `GRAPHICS`, `POWERPRO`, `GRAPHICSPRO`, `GRAPHICS_G4DN`, and `GRAPHICSPRO_G4DN`. +* `root_volume_size_gib` - (Optional) The size of the root volume. +* `running_mode` - (Optional) The running mode. For more information, see [Manage the WorkSpace Running Mode](https://docs.aws.amazon.com/workspaces/latest/adminguide/running-mode.html). Valid values are `AUTO_STOP` and `ALWAYS_ON`. +* `running_mode_auto_stop_timeout_in_minutes` - (Optional) The time after a user logs off when WorkSpaces are automatically stopped. Configured in 60-minute intervals. +* `user_volume_size_gib` - (Optional) The size of the user storage. ## Attribute Reference @@ -120,4 +121,4 @@ Using `terraform import`, import Workspaces using their ID. For example: % terraform import aws_workspaces_workspace.example ws-9z9zmbkhv ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/workspacesweb_browser_settings.html.markdown b/website/docs/cdktf/python/r/workspacesweb_browser_settings.html.markdown index fcf50197dfc2..f03696db3da6 100644 --- a/website/docs/cdktf/python/r/workspacesweb_browser_settings.html.markdown +++ b/website/docs/cdktf/python/r/workspacesweb_browser_settings.html.markdown @@ -89,6 +89,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `additional_encryption_context` - (Optional) Additional encryption context for the browser settings. * `customer_managed_key` - (Optional) ARN of the customer managed KMS key. * `tags` - (Optional) Map of tags assigned to the resource. If configured with a provider [`default_tags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. @@ -126,4 +127,4 @@ Using `terraform import`, import WorkSpaces Web Browser Settings using the `brow % terraform import aws_workspacesweb_browser_settings.example arn:aws:workspacesweb:us-west-2:123456789012:browsersettings/abcdef12345 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/workspacesweb_browser_settings_association.html.markdown b/website/docs/cdktf/python/r/workspacesweb_browser_settings_association.html.markdown new file mode 100644 index 000000000000..fcc48ff95770 --- /dev/null +++ b/website/docs/cdktf/python/r/workspacesweb_browser_settings_association.html.markdown @@ -0,0 +1,97 @@ +--- +subcategory: "WorkSpaces Web" +layout: "aws" +page_title: "AWS: aws_workspacesweb_browser_settings_association" +description: |- + Terraform resource for managing an AWS WorkSpaces Web Browser Settings Association. +--- + + + +# Resource: aws_workspacesweb_browser_settings_association + +Terraform resource for managing an AWS WorkSpaces Web Browser Settings Association. + +## 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.workspacesweb_browser_settings import WorkspaceswebBrowserSettings +from imports.aws.workspacesweb_browser_settings_association import WorkspaceswebBrowserSettingsAssociation +from imports.aws.workspacesweb_portal import WorkspaceswebPortal +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + example = WorkspaceswebBrowserSettings(self, "example", + browser_policy=Token.as_string( + Fn.jsonencode({ + "chrome_policies": { + "DefaultDownloadDirectory": { + "value": "/home/as2-streaming-user/MyFiles/TemporaryFiles1" + } + } + })) + ) + aws_workspacesweb_portal_example = WorkspaceswebPortal(self, "example_1", + display_name="example" + ) + # 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_workspacesweb_portal_example.override_logical_id("example") + aws_workspacesweb_browser_settings_association_example = + WorkspaceswebBrowserSettingsAssociation(self, "example_2", + browser_settings_arn=example.browser_settings_arn, + portal_arn=Token.as_string(aws_workspacesweb_portal_example.portal_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_workspacesweb_browser_settings_association_example.override_logical_id("example") +``` + +## Argument Reference + +The following arguments are required: + +* `browser_settings_arn` - (Required) ARN of the browser settings to associate with the portal. Forces replacement if changed. +* `portal_arn` - (Required) ARN of the portal to associate with the browser settings. Forces replacement if changed. + +The following arguments are optional: + +* `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). + +## 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 WorkSpaces Web Browser Settings Association using the `browser_settings_arn,portal_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.workspacesweb_browser_settings_association import WorkspaceswebBrowserSettingsAssociation +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + WorkspaceswebBrowserSettingsAssociation.generate_config_for_import(self, "example", "arn:aws:workspaces-web:us-west-2:123456789012:browserSettings/browser_settings-id-12345678,arn:aws:workspaces-web:us-west-2:123456789012:portal/portal-id-12345678") +``` + +Using `terraform import`, import WorkSpaces Web Browser Settings Association using the `browser_settings_arn,portal_arn`. For example: + +```console +% terraform import aws_workspacesweb_browser_settings_association.example arn:aws:workspaces-web:us-west-2:123456789012:browserSettings/browser_settings-id-12345678,arn:aws:workspaces-web:us-west-2:123456789012:portal/portal-id-12345678 +``` + + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/workspacesweb_data_protection_settings.html.markdown b/website/docs/cdktf/python/r/workspacesweb_data_protection_settings.html.markdown index f19a86c2da67..fdec51e388ce 100644 --- a/website/docs/cdktf/python/r/workspacesweb_data_protection_settings.html.markdown +++ b/website/docs/cdktf/python/r/workspacesweb_data_protection_settings.html.markdown @@ -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 WorkspaceswebDataProtectionSettings +from imports.aws.workspacesweb_data_protection_settings import WorkspaceswebDataProtectionSettings class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) @@ -43,27 +43,27 @@ 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 WorkspaceswebDataProtectionSettings +from imports.aws.workspacesweb_data_protection_settings import WorkspaceswebDataProtectionSettings class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) WorkspaceswebDataProtectionSettings(self, "example", description="Example data protection settings", display_name="example", - inline_redaction_configuration=[{ - "global_confidence_level": 2, - "global_enforced_urls": ["https://example.com"], - "inline_redaction_pattern": [{ - "built_in_pattern_id": "ssn", - "confidence_level": 3, - "redaction_place_holder": [{ - "redaction_place_holder_text": "REDACTED", - "redaction_place_holder_type": "CustomText" - } + inline_redaction_configuration=[WorkspaceswebDataProtectionSettingsInlineRedactionConfiguration( + global_confidence_level=2, + global_enforced_urls=["https://example.com"], + inline_redaction_pattern=[WorkspaceswebDataProtectionSettingsInlineRedactionConfigurationInlineRedactionPattern( + built_in_pattern_id="ssn", + confidence_level=3, + redaction_place_holder=[WorkspaceswebDataProtectionSettingsInlineRedactionConfigurationInlineRedactionPatternRedactionPlaceHolder( + redaction_place_holder_text="REDACTED", + redaction_place_holder_type="CustomText" + ) ] - } + ) ] - } + ) ] ) ``` @@ -133,6 +133,7 @@ The following arguments are optional: * `customer_managed_key` - (Optional) ARN of the customer managed KMS key. * `description` - (Optional) The description of the data protection settings. * `inline_redaction_configuration` - (Optional) The inline redaction configuration of the data protection settings. Detailed below. +* `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). * `tags` - (Optional) Map of tags assigned to the resource. If configured with a provider [`default_tags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. ### inline_redaction_configuration @@ -183,7 +184,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 WorkspaceswebDataProtectionSettings +from imports.aws.workspacesweb_data_protection_settings import WorkspaceswebDataProtectionSettings class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) @@ -196,4 +197,4 @@ Using `terraform import`, import WorkSpaces Web Data Protection Settings using t % terraform import aws_workspacesweb_data_protection_settings.example arn:aws:workspaces-web:us-west-2:123456789012:dataprotectionsettings/abcdef12345 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/workspacesweb_data_protection_settings_association.html.markdown b/website/docs/cdktf/python/r/workspacesweb_data_protection_settings_association.html.markdown new file mode 100644 index 000000000000..ca3893e98f2d --- /dev/null +++ b/website/docs/cdktf/python/r/workspacesweb_data_protection_settings_association.html.markdown @@ -0,0 +1,84 @@ +--- +subcategory: "WorkSpaces Web" +layout: "aws" +page_title: "AWS: aws_workspacesweb_data_protection_settings_association" +description: |- + Terraform resource for managing an AWS WorkSpaces Web Data Protection Settings Association. +--- + + + +# Resource: aws_workspacesweb_data_protection_settings_association + +Terraform resource for managing an AWS WorkSpaces Web Data Protection Settings Association. + +## 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.workspacesweb_data_protection_settings import WorkspaceswebDataProtectionSettings +from imports.aws.workspacesweb_data_protection_settings_association import WorkspaceswebDataProtectionSettingsAssociation +from imports.aws.workspacesweb_portal import WorkspaceswebPortal +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + example = WorkspaceswebDataProtectionSettings(self, "example", + display_name="example" + ) + aws_workspacesweb_portal_example = WorkspaceswebPortal(self, "example_1", + display_name="example" + ) + # 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_workspacesweb_portal_example.override_logical_id("example") + aws_workspacesweb_data_protection_settings_association_example = + WorkspaceswebDataProtectionSettingsAssociation(self, "example_2", + data_protection_settings_arn=example.data_protection_settings_arn, + portal_arn=Token.as_string(aws_workspacesweb_portal_example.portal_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_workspacesweb_data_protection_settings_association_example.override_logical_id("example") +``` + +## Argument Reference + +The following arguments are required: + +* `data_protection_settings_arn` - (Required) ARN of the data protection settings to associate with the portal. Forces replacement if changed. +* `portal_arn` - (Required) ARN of the portal to associate with the data protection settings. Forces replacement if changed. + +The following arguments are optional: + +* `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). + +## 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 WorkSpaces Web Data Protection Settings Association using the `data_protection_settings_arn,portal_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.workspacesweb_data_protection_settings_association import WorkspaceswebDataProtectionSettingsAssociation +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + WorkspaceswebDataProtectionSettingsAssociation.generate_config_for_import(self, "example", "arn:aws:workspaces-web:us-west-2:123456789012:dataProtectionSettings/data_protection_settings-id-12345678,arn:aws:workspaces-web:us-west-2:123456789012:portal/portal-id-12345678") +``` + + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/workspacesweb_identity_provider.html.markdown b/website/docs/cdktf/python/r/workspacesweb_identity_provider.html.markdown new file mode 100644 index 000000000000..519b0331da90 --- /dev/null +++ b/website/docs/cdktf/python/r/workspacesweb_identity_provider.html.markdown @@ -0,0 +1,160 @@ +--- +subcategory: "WorkSpaces Web" +layout: "aws" +page_title: "AWS: aws_workspacesweb_identity_provider" +description: |- + Terraform resource for managing an AWS WorkSpaces Web Identity Provider. +--- + + + +# Resource: aws_workspacesweb_identity_provider + +Terraform resource for managing an AWS WorkSpaces Web Identity Provider. + +## Example Usage + +### Basic Usage with SAML + +```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.workspacesweb_identity_provider import WorkspaceswebIdentityProvider +from imports.aws.workspacesweb_portal import WorkspaceswebPortal +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + example = WorkspaceswebPortal(self, "example", + display_name="example" + ) + aws_workspacesweb_identity_provider_example = + WorkspaceswebIdentityProvider(self, "example_1", + identity_provider_details={ + "MetadataURL": "https://example.com/metadata" + }, + identity_provider_name="example-saml", + identity_provider_type="SAML", + portal_arn=example.portal_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_workspacesweb_identity_provider_example.override_logical_id("example") +``` + +### OIDC Identity Provider + +```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.workspacesweb_identity_provider import WorkspaceswebIdentityProvider +from imports.aws.workspacesweb_portal import WorkspaceswebPortal +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + test = WorkspaceswebPortal(self, "test", + display_name="test" + ) + aws_workspacesweb_identity_provider_test = + WorkspaceswebIdentityProvider(self, "test_1", + identity_provider_details={ + "attributes_request_method": "POST", + "authorize_scopes": "openid, email", + "client_id": "test-client-id", + "client_secret": "test-client-secret", + "oidc_issuer": "https://accounts.google.com" + }, + identity_provider_name="test-updated", + identity_provider_type="OIDC", + portal_arn=test.portal_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_workspacesweb_identity_provider_test.override_logical_id("test") +``` + +## Argument Reference + +The following arguments are required: + +* `identity_provider_details` - (Required) Identity provider details. The following list describes the provider detail keys for each identity provider type: + * For Google and Login with Amazon: + * `client_id` + * `client_secret` + * `authorize_scopes` + * For Facebook: + * `client_id` + * `client_secret` + * `authorize_scopes` + * `api_version` + * For Sign in with Apple: + * `client_id` + * `team_id` + * `key_id` + * `private_key` + * `authorize_scopes` + * For OIDC providers: + * `client_id` + * `client_secret` + * `attributes_request_method` + * `oidc_issuer` + * `authorize_scopes` + * `authorize_url` if not available from discovery URL specified by `oidc_issuer` key + * `token_url` if not available from discovery URL specified by `oidc_issuer` key + * `attributes_url` if not available from discovery URL specified by `oidc_issuer` key + * `jwks_uri` if not available from discovery URL specified by `oidc_issuer` key + * For SAML providers: + * `MetadataFile` OR `MetadataURL` + * `IDPSignout` (boolean) optional + * `IDPInit` (boolean) optional + * `RequestSigningAlgorithm` (string) optional - Only accepts rsa-sha256 + * `EncryptedResponses` (boolean) optional +* `identity_provider_name` - (Required) Identity provider name. +* `identity_provider_type` - (Required) Identity provider type. Valid values: `SAML`, `Facebook`, `Google`, `LoginWithAmazon`, `SignInWithApple`, `OIDC`. +* `portal_arn` - (Required) ARN of the web portal. Forces replacement if changed. + +The following arguments are optional: + +* `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). +* `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. + +## Attribute Reference + +This resource exports the following attributes in addition to the arguments above: + +* `identity_provider_arn` - ARN of the identity provider. +* `tags_all` - Map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). + +## Import + +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import WorkSpaces Web Identity Provider using the `identity_provider_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.workspacesweb_identity_provider import WorkspaceswebIdentityProvider +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + WorkspaceswebIdentityProvider.generate_config_for_import(self, "example", "arn:aws:workspaces-web:us-west-2:123456789012:identityprovider/abcdef12345678/12345678-1234-1234-1234-123456789012") +``` + +Using `terraform import`, import WorkSpaces Web Identity Provider using the `identity_provider_arn`. For example: + +```console +% terraform import aws_workspacesweb_identity_provider.example arn:aws:workspaces-web:us-west-2:123456789012:identityprovider/abcdef12345678/12345678-1234-1234-1234-123456789012 +``` + + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/workspacesweb_ip_access_settings.html.markdown b/website/docs/cdktf/python/r/workspacesweb_ip_access_settings.html.markdown index 15c6395509ce..4355d524f77c 100644 --- a/website/docs/cdktf/python/r/workspacesweb_ip_access_settings.html.markdown +++ b/website/docs/cdktf/python/r/workspacesweb_ip_access_settings.html.markdown @@ -24,15 +24,15 @@ 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 WorkspaceswebIpAccessSettings +from imports.aws.workspacesweb_ip_access_settings import WorkspaceswebIpAccessSettings class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) WorkspaceswebIpAccessSettings(self, "example", display_name="example", - ip_rule=[{ - "ip_range": "10.0.0.0/16" - } + ip_rule=[WorkspaceswebIpAccessSettingsIpRule( + ip_range="10.0.0.0/16" + ) ] ) ``` @@ -47,20 +47,20 @@ 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 WorkspaceswebIpAccessSettings +from imports.aws.workspacesweb_ip_access_settings import WorkspaceswebIpAccessSettings class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) WorkspaceswebIpAccessSettings(self, "example", description="Example IP access settings", display_name="example", - ip_rule=[{ - "description": "Main office", - "ip_range": "10.0.0.0/16" - }, { - "description": "Branch office", - "ip_range": "192.168.0.0/24" - } + ip_rule=[WorkspaceswebIpAccessSettingsIpRule( + description="Main office", + ip_range="10.0.0.0/16" + ), WorkspaceswebIpAccessSettingsIpRule( + description="Branch office", + ip_range="192.168.0.0/24" + ) ] ) ``` @@ -75,8 +75,8 @@ 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 WorkspaceswebIpAccessSettings from imports.aws.kms_key import KmsKey +from imports.aws.workspacesweb_ip_access_settings import WorkspaceswebIpAccessSettings class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) @@ -86,20 +86,19 @@ class MyConvertedCode(TerraformStack): ) aws_workspacesweb_ip_access_settings_example = WorkspaceswebIpAccessSettings(self, "example_1", - additional_encryption_context=[{ + additional_encryption_context={ "Environment": "Production" - } - ], + }, customer_managed_key=example.arn, description="Example IP access settings", display_name="example", - ip_rule=[{ - "description": "Main office", - "ip_range": "10.0.0.0/16" - }, { - "description": "Branch office", - "ip_range": "192.168.0.0/24" - } + ip_rule=[WorkspaceswebIpAccessSettingsIpRule( + description="Main office", + ip_range="10.0.0.0/16" + ), WorkspaceswebIpAccessSettingsIpRule( + description="Branch office", + ip_range="192.168.0.0/24" + ) ], tags={ "Name": "example-ip-access-settings" @@ -121,6 +120,7 @@ The following arguments are optional: * `additional_encryption_context` - (Optional) Additional encryption context for the IP access settings. * `customer_managed_key` - (Optional) ARN of the customer managed KMS key. * `description` - (Optional) The description of the IP access settings. +* `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). * `tags` - (Optional) Map of tags assigned to the resource. If configured with a provider [`default_tags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. ### IP Rules @@ -148,7 +148,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 WorkspaceswebIpAccessSettings +from imports.aws.workspacesweb_ip_access_settings import WorkspaceswebIpAccessSettings class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) @@ -161,4 +161,4 @@ Using `terraform import`, import WorkSpaces Web IP Access Settings using the `ip % terraform import aws_workspacesweb_ip_access_settings.example arn:aws:workspaces-web:us-west-2:123456789012:ipAccessSettings/abcdef12345 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/workspacesweb_ip_access_settings_association.html.markdown b/website/docs/cdktf/python/r/workspacesweb_ip_access_settings_association.html.markdown new file mode 100644 index 000000000000..aa5f06335720 --- /dev/null +++ b/website/docs/cdktf/python/r/workspacesweb_ip_access_settings_association.html.markdown @@ -0,0 +1,88 @@ +--- +subcategory: "WorkSpaces Web" +layout: "aws" +page_title: "AWS: aws_workspacesweb_ip_access_settings_association" +description: |- + Terraform resource for managing an AWS WorkSpaces Web IP Access Settings Association. +--- + + + +# Resource: aws_workspacesweb_ip_access_settings_association + +Terraform resource for managing an AWS WorkSpaces Web IP Access Settings Association. + +## 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.workspacesweb_ip_access_settings import WorkspaceswebIpAccessSettings +from imports.aws.workspacesweb_ip_access_settings_association import WorkspaceswebIpAccessSettingsAssociation +from imports.aws.workspacesweb_portal import WorkspaceswebPortal +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + example = WorkspaceswebIpAccessSettings(self, "example", + display_name="example", + ip_rule=[WorkspaceswebIpAccessSettingsIpRule( + ip_range="10.0.0.0/16" + ) + ] + ) + aws_workspacesweb_portal_example = WorkspaceswebPortal(self, "example_1", + display_name="example" + ) + # 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_workspacesweb_portal_example.override_logical_id("example") + aws_workspacesweb_ip_access_settings_association_example = + WorkspaceswebIpAccessSettingsAssociation(self, "example_2", + ip_access_settings_arn=example.ip_access_settings_arn, + portal_arn=Token.as_string(aws_workspacesweb_portal_example.portal_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_workspacesweb_ip_access_settings_association_example.override_logical_id("example") +``` + +## Argument Reference + +The following arguments are required: + +* `ip_access_settings_arn` - (Required) ARN of the IP access settings to associate with the portal. Forces replacement if changed. +* `portal_arn` - (Required) ARN of the portal to associate with the IP access settings. Forces replacement if changed. + +The following arguments are optional: + +* `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). + +## 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 WorkSpaces Web IP Access Settings Association using the `ip_access_settings_arn,portal_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.workspacesweb_ip_access_settings_association import WorkspaceswebIpAccessSettingsAssociation +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + WorkspaceswebIpAccessSettingsAssociation.generate_config_for_import(self, "example", "arn:aws:workspaces-web:us-west-2:123456789012:ipAccessSettings/ip_access_settings-id-12345678,arn:aws:workspaces-web:us-west-2:123456789012:portal/portal-id-12345678") +``` + + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/workspacesweb_network_settings.html.markdown b/website/docs/cdktf/python/r/workspacesweb_network_settings.html.markdown index c0147949db49..1089cb51b041 100644 --- a/website/docs/cdktf/python/r/workspacesweb_network_settings.html.markdown +++ b/website/docs/cdktf/python/r/workspacesweb_network_settings.html.markdown @@ -85,6 +85,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `tags` - (Optional) Map of tags assigned to the resource. If configured with a provider [`default_tags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. ## Attribute Reference @@ -120,4 +121,4 @@ Using `terraform import`, import WorkSpaces Web Network Settings using the `netw % terraform import aws_workspacesweb_network_settings.example arn:aws:workspacesweb:us-west-2:123456789012:networksettings/abcdef12345 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/workspacesweb_network_settings_association.html.markdown b/website/docs/cdktf/python/r/workspacesweb_network_settings_association.html.markdown new file mode 100644 index 000000000000..4404a406a105 --- /dev/null +++ b/website/docs/cdktf/python/r/workspacesweb_network_settings_association.html.markdown @@ -0,0 +1,147 @@ +--- +subcategory: "WorkSpaces Web" +layout: "aws" +page_title: "AWS: aws_workspacesweb_network_settings_association" +description: |- + Terraform resource for managing an AWS WorkSpaces Web Network Settings Association. +--- + + + +# Resource: aws_workspacesweb_network_settings_association + +Terraform resource for managing an AWS WorkSpaces Web Network Settings Association. + +## 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, TerraformCount, Fn, TerraformStack +# +# Provider bindings are generated by running `cdktf get`. +# See https://cdk.tf/provider-generation for more details. +# +from imports.aws.data_aws_availability_zones import DataAwsAvailabilityZones +from imports.aws.security_group import SecurityGroup +from imports.aws.subnet import Subnet +from imports.aws.vpc import Vpc +from imports.aws.workspacesweb_network_settings import WorkspaceswebNetworkSettings +from imports.aws.workspacesweb_network_settings_association import WorkspaceswebNetworkSettingsAssociation +from imports.aws.workspacesweb_portal import WorkspaceswebPortal +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + example = Vpc(self, "example", + cidr_block="10.0.0.0/16", + tags={ + "Name": "example" + } + ) + aws_workspacesweb_portal_example = WorkspaceswebPortal(self, "example_1", + display_name="example" + ) + # 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_workspacesweb_portal_example.override_logical_id("example") + available = DataAwsAvailabilityZones(self, "available", + filter=[DataAwsAvailabilityZonesFilter( + name="opt-in-status", + values=["opt-in-not-required"] + ) + ], + state="available" + ) + # In most cases loops should be handled in the programming language context and + # not inside of the Terraform context. If you are looping over something external, e.g. a variable or a file input + # you should consider using a for loop. If you are looping over something only known to Terraform, e.g. a result of a data source + # you need to keep this like it is. + example_count = TerraformCount.of(Token.as_number("2")) + aws_security_group_example = SecurityGroup(self, "example_3", + name="example-${" + example_count.index + "}", + tags={ + "Name": "example" + }, + vpc_id=example.id, + count=example_count + ) + # 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_security_group_example.override_logical_id("example") + # In most cases loops should be handled in the programming language context and + # not inside of the Terraform context. If you are looping over something external, e.g. a variable or a file input + # you should consider using a for loop. If you are looping over something only known to Terraform, e.g. a result of a data source + # you need to keep this like it is. + aws_subnet_example_count = TerraformCount.of(Token.as_number("2")) + aws_subnet_example = Subnet(self, "example_4", + availability_zone=Token.as_string( + Fn.lookup_nested(available.names, [aws_subnet_example_count.index])), + cidr_block=Token.as_string( + Fn.cidrsubnet(example.cidr_block, 8, + Token.as_number(aws_subnet_example_count.index))), + tags={ + "Name": "example" + }, + vpc_id=example.id, + count=aws_subnet_example_count + ) + # 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_subnet_example.override_logical_id("example") + aws_workspacesweb_network_settings_example = + WorkspaceswebNetworkSettings(self, "example_5", + security_group_ids=[ + Token.as_string(Fn.lookup_nested(aws_security_group_example, ["0", "id"])), + Token.as_string(Fn.lookup_nested(aws_security_group_example, ["1", "id"])) + ], + subnet_ids=[ + Token.as_string(Fn.lookup_nested(aws_subnet_example, ["0", "id"])), + Token.as_string(Fn.lookup_nested(aws_subnet_example, ["1", "id"])) + ], + vpc_id=example.id + ) + # 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_workspacesweb_network_settings_example.override_logical_id("example") + aws_workspacesweb_network_settings_association_example = + WorkspaceswebNetworkSettingsAssociation(self, "example_6", + network_settings_arn=Token.as_string(aws_workspacesweb_network_settings_example.network_settings_arn), + portal_arn=Token.as_string(aws_workspacesweb_portal_example.portal_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_workspacesweb_network_settings_association_example.override_logical_id("example") +``` + +## Argument Reference + +The following arguments are required: + +* `network_settings_arn` - (Required) ARN of the network settings to associate with the portal. Forces replacement if changed. +* `portal_arn` - (Required) ARN of the portal to associate with the network settings. Forces replacement if changed. + +The following arguments are optional: + +* `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). + +## 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 WorkSpaces Web Network Settings Association using the `network_settings_arn,portal_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.workspacesweb_network_settings_association import WorkspaceswebNetworkSettingsAssociation +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + WorkspaceswebNetworkSettingsAssociation.generate_config_for_import(self, "example", "arn:aws:workspaces-web:us-west-2:123456789012:networkSettings/network_settings-id-12345678,arn:aws:workspaces-web:us-west-2:123456789012:portal/portal-id-12345678") +``` + + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/workspacesweb_portal.html.markdown b/website/docs/cdktf/python/r/workspacesweb_portal.html.markdown new file mode 100644 index 000000000000..a2f54169625a --- /dev/null +++ b/website/docs/cdktf/python/r/workspacesweb_portal.html.markdown @@ -0,0 +1,146 @@ +--- +subcategory: "WorkSpaces Web" +layout: "aws" +page_title: "AWS: aws_workspacesweb_portal" +description: |- + Terraform resource for managing an AWS WorkSpaces Web Portal. +--- + + + +# Resource: aws_workspacesweb_portal + +Terraform resource for managing an AWS WorkSpaces Web Portal. + +## 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.workspacesweb_portal import WorkspaceswebPortal +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + WorkspaceswebPortal(self, "example", + display_name="example-portal", + instance_type="standard.regular" + ) +``` + +### Complete 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.kms_key import KmsKey +from imports.aws.workspacesweb_portal import WorkspaceswebPortal +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + example = KmsKey(self, "example", + deletion_window_in_days=7, + description="KMS key for WorkSpaces Web Portal" + ) + aws_workspacesweb_portal_example = WorkspaceswebPortal(self, "example_1", + additional_encryption_context={ + "Environment": "Production" + }, + authentication_type="IAM_Identity_Center", + customer_managed_key=example.arn, + display_name="example-portal", + instance_type="standard.large", + max_concurrent_sessions=10, + tags={ + "Name": "example-portal" + }, + timeouts=[{ + "create": "10m", + "delete": "10m", + "update": "10m" + } + ] + ) + # 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_workspacesweb_portal_example.override_logical_id("example") +``` + +## Argument Reference + +The following arguments are optional: + +* `additional_encryption_context` - (Optional) Additional encryption context for the customer managed key. Forces replacement if changed. +* `authentication_type` - (Optional) Authentication type for the portal. Valid values: `Standard`, `IAM_Identity_Center`. +* `browser_settings_arn` - (Optional) ARN of the browser settings to use for the portal. +* `customer_managed_key` - (Optional) ARN of the customer managed key. Forces replacement if changed. +* `display_name` - (Optional) Display name of the portal. +* `instance_type` - (Optional) Instance type for the portal. Valid values: `standard.regular`, `standard.large`. +* `max_concurrent_sessions` - (Optional) Maximum number of concurrent sessions for the portal. +* `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). +* `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. + +## Attribute Reference + +This resource exports the following attributes in addition to the arguments above: + +* `browser_type` - Browser type of the portal. +* `creation_date` - Creation date of the portal. +* `data_protection_settings_arn` - ARN of the data protection settings associated with the portal. +* `ip_access_settings_arn` - ARN of the IP access settings associated with the portal. +* `network_settings_arn` - ARN of the network settings associated with the portal. +* `portal_arn` - ARN of the portal. +* `portal_endpoint` - Endpoint URL of the portal. +* `portal_status` - Status of the portal. +* `renderer_type` - Renderer type of the portal. +* `session_logger_arn` - ARN of the session logger associated with the portal. +* `status_reason` - Reason for the current status of the portal. +* `tags_all` - Map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). +* `trust_store_arn` - ARN of the trust store associated with the portal. +* `user_access_logging_settings_arn` - ARN of the user access logging settings associated with the portal. +* `user_settings_arn` - ARN of the user settings associated with the portal. + +## Timeouts + +[Configuration options](https://developer.hashicorp.com/terraform/language/resources/syntax#operation-timeouts): + +* `create` - (Default `5m`) +* `update` - (Default `5m`) +* `delete` - (Default `5m`) + +## Import + +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import WorkSpaces Web Portal using the `portal_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.workspacesweb_portal import WorkspaceswebPortal +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + WorkspaceswebPortal.generate_config_for_import(self, "example", "arn:aws:workspaces-web:us-west-2:123456789012:portal/abcdef12345678") +``` + +Using `terraform import`, import WorkSpaces Web Portal using the `portal_arn`. For example: + +```console +% terraform import aws_workspacesweb_portal.example arn:aws:workspaces-web:us-west-2:123456789012:portal/abcdef12345678 +``` + + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/workspacesweb_session_logger.html.markdown b/website/docs/cdktf/python/r/workspacesweb_session_logger.html.markdown new file mode 100644 index 000000000000..753347c6b90f --- /dev/null +++ b/website/docs/cdktf/python/r/workspacesweb_session_logger.html.markdown @@ -0,0 +1,257 @@ +--- +subcategory: "WorkSpaces Web" +layout: "aws" +page_title: "AWS: aws_workspacesweb_session_logger" +description: |- + Terraform resource for managing an AWS WorkSpaces Web Session Logger. +--- + + + +# Resource: aws_workspacesweb_session_logger + +Terraform resource for managing an AWS WorkSpaces Web Session Logger. + +## 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.data_aws_iam_policy_document import DataAwsIamPolicyDocument +from imports.aws.s3_bucket import S3Bucket +from imports.aws.s3_bucket_policy import S3BucketPolicy +from imports.aws.workspacesweb_session_logger import WorkspaceswebSessionLogger +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + example = S3Bucket(self, "example", + bucket="example-session-logs" + ) + data_aws_iam_policy_document_example = DataAwsIamPolicyDocument(self, "example_1", + statement=[DataAwsIamPolicyDocumentStatement( + actions=["s3:PutObject"], + effect="Allow", + principals=[DataAwsIamPolicyDocumentStatementPrincipals( + identifiers=["workspaces-web.amazonaws.com"], + type="Service" + ) + ], + resources=["${" + 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. + data_aws_iam_policy_document_example.override_logical_id("example") + aws_s3_bucket_policy_example = S3BucketPolicy(self, "example_2", + bucket=example.id, + policy=Token.as_string(data_aws_iam_policy_document_example.json) + ) + # 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_s3_bucket_policy_example.override_logical_id("example") + aws_workspacesweb_session_logger_example = WorkspaceswebSessionLogger(self, "example_3", + depends_on=[aws_s3_bucket_policy_example], + display_name="example-session-logger", + event_filter=[WorkspaceswebSessionLoggerEventFilter( + all=[WorkspaceswebSessionLoggerEventFilterAll()] + ) + ], + log_configuration=[WorkspaceswebSessionLoggerLogConfiguration( + s3=[WorkspaceswebSessionLoggerLogConfigurationS3( + bucket=example.id, + folder_structure="Flat", + log_file_format="Json" + ) + ] + ) + ] + ) + # 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_workspacesweb_session_logger_example.override_logical_id("example") +``` + +### Complete Configuration with KMS Encryption + +```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.data_aws_caller_identity import DataAwsCallerIdentity +from imports.aws.data_aws_iam_policy_document import DataAwsIamPolicyDocument +from imports.aws.data_aws_partition import DataAwsPartition +from imports.aws.kms_key import KmsKey +from imports.aws.s3_bucket import S3Bucket +from imports.aws.s3_bucket_policy import S3BucketPolicy +from imports.aws.workspacesweb_session_logger import WorkspaceswebSessionLogger +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + example = S3Bucket(self, "example", + bucket="example-session-logs", + force_destroy=True + ) + current = DataAwsCallerIdentity(self, "current") + data_aws_iam_policy_document_example = DataAwsIamPolicyDocument(self, "example_2", + statement=[DataAwsIamPolicyDocumentStatement( + actions=["s3:PutObject"], + effect="Allow", + principals=[DataAwsIamPolicyDocumentStatementPrincipals( + identifiers=["workspaces-web.amazonaws.com"], + type="Service" + ) + ], + resources=[example.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. + data_aws_iam_policy_document_example.override_logical_id("example") + data_aws_partition_current = DataAwsPartition(self, "current_3") + # 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_partition_current.override_logical_id("current") + aws_s3_bucket_policy_example = S3BucketPolicy(self, "example_4", + bucket=example.id, + policy=Token.as_string(data_aws_iam_policy_document_example.json) + ) + # 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_s3_bucket_policy_example.override_logical_id("example") + kms_key_policy = DataAwsIamPolicyDocument(self, "kms_key_policy", + statement=[DataAwsIamPolicyDocumentStatement( + actions=["kms:*"], + principals=[DataAwsIamPolicyDocumentStatementPrincipals( + identifiers=["arn:${" + data_aws_partition_current.partition + "}:iam::${" + current.account_id + "}:root" + ], + type="AWS" + ) + ], + resources=["*"] + ), DataAwsIamPolicyDocumentStatement( + actions=["kms:Encrypt", "kms:GenerateDataKey*", "kms:ReEncrypt*", "kms:Decrypt" + ], + principals=[DataAwsIamPolicyDocumentStatementPrincipals( + identifiers=["workspaces-web.amazonaws.com"], + type="Service" + ) + ], + resources=["*"] + ) + ] + ) + aws_kms_key_example = KmsKey(self, "example_6", + description="KMS key for WorkSpaces Web Session Logger", + policy=Token.as_string(kms_key_policy.json) + ) + # 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_kms_key_example.override_logical_id("example") + aws_workspacesweb_session_logger_example = WorkspaceswebSessionLogger(self, "example_7", + additional_encryption_context={ + "Application": "WorkSpacesWeb", + "Environment": "Production" + }, + customer_managed_key=Token.as_string(aws_kms_key_example.arn), + depends_on=[aws_s3_bucket_policy_example, aws_kms_key_example], + display_name="example-session-logger", + event_filter=[WorkspaceswebSessionLoggerEventFilter( + include=["SessionStart", "SessionEnd"] + ) + ], + log_configuration=[WorkspaceswebSessionLoggerLogConfiguration( + s3=[WorkspaceswebSessionLoggerLogConfigurationS3( + bucket=example.id, + bucket_owner=Token.as_string(current.account_id), + folder_structure="NestedByDate", + key_prefix="workspaces-web-logs/", + log_file_format="JsonLines" + ) + ] + ) + ], + tags={ + "Environment": "Production", + "Name": "example-session-logger" + } + ) + # 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_workspacesweb_session_logger_example.override_logical_id("example") +``` + +## Argument Reference + +The following arguments are required: + +* `event_filter` - (Required) Event filter that determines which events are logged. See [Event Filter](#event-filter) below. +* `log_configuration` - (Required) Configuration block for specifying where logs are delivered. See [Log Configuration](#log-configuration) below. + +The following arguments are optional: + +* `additional_encryption_context` - (Optional) Map of additional encryption context key-value pairs. +* `customer_managed_key` - (Optional) ARN of the customer managed KMS key used to encrypt sensitive information. +* `display_name` - (Optional) Human-readable display name for the session logger resource. Forces replacement if changed. +* `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). +* `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. + +### Log Configuration + +* `s3` - (Required) Configuration block for S3 log delivery. See [S3 Configuration](#s3-configuration) below. + +### Event Filter + +Exactly one of the following must be specified: + +* `all` - (Optional) Block that specifies to monitor all events. Set to `{}` to monitor all events. +* `include` - (Optional) List of specific events to monitor. Valid values include session events like `SessionStart`, `SessionEnd`, etc. + +### S3 Configuration + +* `bucket` - (Required) S3 bucket name where logs are delivered. +* `folder_structure` - (Required) Folder structure that defines the organizational structure for log files in S3. Valid values: `FlatStructure`, `DateBasedStructure`. +* `log_file_format` - (Required) Format of the log file written to S3. Valid values: `Json`, `Parquet`. +* `bucket_owner` - (Optional) Expected bucket owner of the target S3 bucket. +* `key_prefix` - (Optional) S3 path prefix that determines where log files are stored. + +## Attribute Reference + +This resource exports the following attributes in addition to the arguments above: + +* `associated_portal_arns` - List of ARNs of the web portals associated with the session logger. +* `session_logger_arn` - ARN of the session logger. +* `tags_all` - Map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). + +~> **Note:** The `additional_encryption_context` and `customer_managed_key` attributes are computed when not specified and will be populated with values from the AWS API response. + +## Import + +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import WorkSpaces Web Session Logger using the `session_logger_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.workspacesweb_session_logger import WorkspaceswebSessionLogger +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + WorkspaceswebSessionLogger.generate_config_for_import(self, "example", "arn:aws:workspaces-web:us-west-2:123456789012:sessionLogger/session_logger-id-12345678") +``` + +Using `terraform import`, import WorkSpaces Web Session Logger using the `session_logger_arn`. For example: + +```console +% terraform import aws_workspacesweb_session_logger.example arn:aws:workspaces-web:us-west-2:123456789012:sessionLogger/session_logger-id-12345678 +``` + + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/workspacesweb_session_logger_association.html.markdown b/website/docs/cdktf/python/r/workspacesweb_session_logger_association.html.markdown new file mode 100644 index 000000000000..0d2b6467f87f --- /dev/null +++ b/website/docs/cdktf/python/r/workspacesweb_session_logger_association.html.markdown @@ -0,0 +1,134 @@ +--- +subcategory: "WorkSpaces Web" +layout: "aws" +page_title: "AWS: aws_workspacesweb_session_logger_association" +description: |- + Terraform resource for managing an AWS WorkSpaces Web Session Logger Association. +--- + + + +# Resource: aws_workspacesweb_session_logger_association + +Terraform resource for managing an AWS WorkSpaces Web Session Logger Association. + +## 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.data_aws_iam_policy_document import DataAwsIamPolicyDocument +from imports.aws.s3_bucket import S3Bucket +from imports.aws.s3_bucket_policy import S3BucketPolicy +from imports.aws.workspacesweb_portal import WorkspaceswebPortal +from imports.aws.workspacesweb_session_logger import WorkspaceswebSessionLogger +from imports.aws.workspacesweb_session_logger_association import WorkspaceswebSessionLoggerAssociation +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + example = S3Bucket(self, "example", + bucket="example-session-logs", + force_destroy=True + ) + aws_workspacesweb_portal_example = WorkspaceswebPortal(self, "example_1", + display_name="example" + ) + # 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_workspacesweb_portal_example.override_logical_id("example") + data_aws_iam_policy_document_example = DataAwsIamPolicyDocument(self, "example_2", + statement=[DataAwsIamPolicyDocumentStatement( + actions=["s3:PutObject"], + effect="Allow", + principals=[DataAwsIamPolicyDocumentStatementPrincipals( + identifiers=["workspaces-web.amazonaws.com"], + type="Service" + ) + ], + resources=["${" + 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. + data_aws_iam_policy_document_example.override_logical_id("example") + aws_s3_bucket_policy_example = S3BucketPolicy(self, "example_3", + bucket=example.id, + policy=Token.as_string(data_aws_iam_policy_document_example.json) + ) + # 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_s3_bucket_policy_example.override_logical_id("example") + aws_workspacesweb_session_logger_example = WorkspaceswebSessionLogger(self, "example_4", + depends_on=[aws_s3_bucket_policy_example], + display_name="example", + event_filter=[WorkspaceswebSessionLoggerEventFilter( + all=[WorkspaceswebSessionLoggerEventFilterAll()] + ) + ], + log_configuration=[WorkspaceswebSessionLoggerLogConfiguration( + s3=[WorkspaceswebSessionLoggerLogConfigurationS3( + bucket=example.id, + folder_structure="Flat", + log_file_format="Json" + ) + ] + ) + ] + ) + # 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_workspacesweb_session_logger_example.override_logical_id("example") + aws_workspacesweb_session_logger_association_example = + WorkspaceswebSessionLoggerAssociation(self, "example_5", + portal_arn=Token.as_string(aws_workspacesweb_portal_example.portal_arn), + session_logger_arn=Token.as_string(aws_workspacesweb_session_logger_example.session_logger_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_workspacesweb_session_logger_association_example.override_logical_id("example") +``` + +## Argument Reference + +The following arguments are required: + +* `portal_arn` - (Required) ARN of the web portal. +* `session_logger_arn` - (Required) ARN of the session logger. + +The following arguments are optional: + +* `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). + +## 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 WorkSpaces Web Session Logger Association using the `session_logger_arn,portal_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.workspacesweb_session_logger_association import WorkspaceswebSessionLoggerAssociation +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + WorkspaceswebSessionLoggerAssociation.generate_config_for_import(self, "example", "arn:aws:workspaces-web:us-west-2:123456789012:sessionLogger/session_logger-id-12345678,arn:aws:workspaces-web:us-west-2:123456789012:portal/portal-id-12345678") +``` + +Using `terraform import`, import WorkSpaces Web Session Logger Association using the `session_logger_arn,portal_arn`. For example: + +```console +% terraform import aws_workspacesweb_session_logger_association.example arn:aws:workspaces-web:us-west-2:123456789012:sessionLogger/session_logger-id-12345678,arn:aws:workspaces-web:us-west-2:123456789012:portal/portal-id-12345678 +``` + + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/workspacesweb_trust_store.html.markdown b/website/docs/cdktf/python/r/workspacesweb_trust_store.html.markdown new file mode 100644 index 000000000000..657699ad107f --- /dev/null +++ b/website/docs/cdktf/python/r/workspacesweb_trust_store.html.markdown @@ -0,0 +1,119 @@ +--- +subcategory: "WorkSpaces Web" +layout: "aws" +page_title: "AWS: aws_workspacesweb_trust_store" +description: |- + Terraform resource for managing an AWS WorkSpaces Web Trust Store. +--- + + + +# Resource: aws_workspacesweb_trust_store + +Terraform resource for managing an AWS WorkSpaces Web Trust Store. + +## 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.workspacesweb_trust_store import WorkspaceswebTrustStore +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + WorkspaceswebTrustStore(self, "example", + certificate=[WorkspaceswebTrustStoreCertificate( + body=Token.as_string(Fn.file("certificate.pem")) + ) + ] + ) +``` + +### Multiple Certificates + +```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.workspacesweb_trust_store import WorkspaceswebTrustStore +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + WorkspaceswebTrustStore(self, "example", + certificate=[WorkspaceswebTrustStoreCertificate( + body=Token.as_string(Fn.file("certificate1.pem")) + ), WorkspaceswebTrustStoreCertificate( + body=Token.as_string(Fn.file("certificate2.pem")) + ) + ], + tags={ + "Name": "example-trust-store" + } + ) +``` + +## Argument Reference + +The following arguments are optional: + +* `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). +* `certificate` - (Optional) Set of certificates to include in the trust store. See [Certificate](#certificate) below. +* `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. + +### Certificate + +* `body` - (Required) Certificate body in PEM format. + +## Attribute Reference + +This resource exports the following attributes in addition to the arguments above: + +* `associated_portal_arns` - List of ARNs of the web portals associated with the trust store. +* `trust_store_arn` - ARN of the trust store. +* `tags_all` - Map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). + +The `certificate` block exports the following additional attributes: + +* `issuer` - Certificate issuer. +* `not_valid_after` - Date and time when the certificate expires in RFC3339 format. +* `not_valid_before` - Date and time when the certificate becomes valid in RFC3339 format. +* `subject` - Certificate subject. +* `thumbprint` - Certificate thumbprint. + +## Import + +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import WorkSpaces Web Trust Store using the `trust_store_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.workspacesweb_trust_store import WorkspaceswebTrustStore +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + WorkspaceswebTrustStore.generate_config_for_import(self, "example", "arn:aws:workspaces-web:us-west-2:123456789012:trustStore/trust_store-id-12345678") +``` + +Using `terraform import`, import WorkSpaces Web Trust Store using the `trust_store_arn`. For example: + +```console +% terraform import aws_workspacesweb_trust_store.example arn:aws:workspaces-web:us-west-2:123456789012:trustStore/trust_store-id-12345678 +``` + + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/workspacesweb_trust_store_association.html.markdown b/website/docs/cdktf/python/r/workspacesweb_trust_store_association.html.markdown new file mode 100644 index 000000000000..202aaea43b42 --- /dev/null +++ b/website/docs/cdktf/python/r/workspacesweb_trust_store_association.html.markdown @@ -0,0 +1,92 @@ +--- +subcategory: "WorkSpaces Web" +layout: "aws" +page_title: "AWS: aws_workspacesweb_trust_store_association" +description: |- + Terraform resource for managing an AWS WorkSpaces Web Trust Store Association. +--- + + + +# Resource: aws_workspacesweb_trust_store_association + +Terraform resource for managing an AWS WorkSpaces Web Trust Store Association. + +## 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.workspacesweb_portal import WorkspaceswebPortal +from imports.aws.workspacesweb_trust_store import WorkspaceswebTrustStore +from imports.aws.workspacesweb_trust_store_association import WorkspaceswebTrustStoreAssociation +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + example = WorkspaceswebPortal(self, "example", + display_name="example" + ) + aws_workspacesweb_trust_store_example = WorkspaceswebTrustStore(self, "example_1", + certificate_list=[ + Fn.base64encode(Token.as_string(Fn.file("certificate.pem"))) + ] + ) + # 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_workspacesweb_trust_store_example.override_logical_id("example") + aws_workspacesweb_trust_store_association_example = + WorkspaceswebTrustStoreAssociation(self, "example_2", + portal_arn=example.portal_arn, + trust_store_arn=Token.as_string(aws_workspacesweb_trust_store_example.trust_store_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_workspacesweb_trust_store_association_example.override_logical_id("example") +``` + +## Argument Reference + +The following arguments are required: + +* `trust_store_arn` - (Required) ARN of the trust store to associate with the portal. Forces replacement if changed. +* `portal_arn` - (Required) ARN of the portal to associate with the trust store. Forces replacement if changed. + +The following arguments are optional: + +* `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). + +## 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 WorkSpaces Web Trust Store Association using the `trust_store_arn,portal_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.workspacesweb_trust_store_association import WorkspaceswebTrustStoreAssociation +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + WorkspaceswebTrustStoreAssociation.generate_config_for_import(self, "example", "arn:aws:workspaces-web:us-west-2:123456789012:trustStore/trust_store-id-12345678,arn:aws:workspaces-web:us-west-2:123456789012:portal/portal-id-12345678") +``` + +Using `terraform import`, import WorkSpaces Web Trust Store Association using the `trust_store_arn,portal_arn`. For example: + +```console +% terraform import aws_workspacesweb_trust_store_association.example arn:aws:workspaces-web:us-west-2:123456789012:trustStore/trust_store-id-12345678,arn:aws:workspaces-web:us-west-2:123456789012:portal/portal-id-12345678 +``` + + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/workspacesweb_user_access_logging_settings.html.markdown b/website/docs/cdktf/python/r/workspacesweb_user_access_logging_settings.html.markdown index faefa9b5fa91..8b85630b5579 100644 --- a/website/docs/cdktf/python/r/workspacesweb_user_access_logging_settings.html.markdown +++ b/website/docs/cdktf/python/r/workspacesweb_user_access_logging_settings.html.markdown @@ -24,8 +24,8 @@ 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 WorkspaceswebUserAccessLoggingSettings from imports.aws.kinesis_stream import KinesisStream +from imports.aws.workspacesweb_user_access_logging_settings import WorkspaceswebUserAccessLoggingSettings class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) @@ -51,8 +51,8 @@ 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 WorkspaceswebUserAccessLoggingSettings from imports.aws.kinesis_stream import KinesisStream +from imports.aws.workspacesweb_user_access_logging_settings import WorkspaceswebUserAccessLoggingSettings class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) @@ -80,6 +80,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `tags` - (Optional) Map of tags assigned to the resource. If configured with a provider [`default_tags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. ## Attribute Reference @@ -102,7 +103,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 WorkspaceswebUserAccessLoggingSettings +from imports.aws.workspacesweb_user_access_logging_settings import WorkspaceswebUserAccessLoggingSettings class MyConvertedCode(TerraformStack): def __init__(self, scope, name): super().__init__(scope, name) @@ -115,4 +116,4 @@ Using `terraform import`, import WorkSpaces Web User Access Logging Settings usi % terraform import aws_workspacesweb_user_access_logging_settings.example arn:aws:workspaces-web:us-west-2:123456789012:userAccessLoggingSettings/abcdef12345 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/workspacesweb_user_access_logging_settings_association.html.markdown b/website/docs/cdktf/python/r/workspacesweb_user_access_logging_settings_association.html.markdown new file mode 100644 index 000000000000..162c1c7c1d82 --- /dev/null +++ b/website/docs/cdktf/python/r/workspacesweb_user_access_logging_settings_association.html.markdown @@ -0,0 +1,92 @@ +--- +subcategory: "WorkSpaces Web" +layout: "aws" +page_title: "AWS: aws_workspacesweb_user_access_logging_settings_association" +description: |- + Terraform resource for managing an AWS WorkSpaces Web User Access Logging Settings Association. +--- + + + +# Resource: aws_workspacesweb_user_access_logging_settings_association + +Terraform resource for managing an AWS WorkSpaces Web User Access Logging Settings Association. + +## 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.kinesis_stream import KinesisStream +from imports.aws.workspacesweb_portal import WorkspaceswebPortal +from imports.aws.workspacesweb_user_access_logging_settings import WorkspaceswebUserAccessLoggingSettings +from imports.aws.workspacesweb_user_access_logging_settings_association import WorkspaceswebUserAccessLoggingSettingsAssociation +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + example = KinesisStream(self, "example", + name="amazon-workspaces-web-example", + shard_count=1 + ) + aws_workspacesweb_portal_example = WorkspaceswebPortal(self, "example_1", + display_name="example" + ) + # 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_workspacesweb_portal_example.override_logical_id("example") + aws_workspacesweb_user_access_logging_settings_example = + WorkspaceswebUserAccessLoggingSettings(self, "example_2", + kinesis_stream_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_workspacesweb_user_access_logging_settings_example.override_logical_id("example") + aws_workspacesweb_user_access_logging_settings_association_example = + WorkspaceswebUserAccessLoggingSettingsAssociation(self, "example_3", + portal_arn=Token.as_string(aws_workspacesweb_portal_example.portal_arn), + user_access_logging_settings_arn=Token.as_string(aws_workspacesweb_user_access_logging_settings_example.user_access_logging_settings_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_workspacesweb_user_access_logging_settings_association_example.override_logical_id("example") +``` + +## Argument Reference + +The following arguments are required: + +* `user_access_logging_settings_arn` - (Required) ARN of the user access logging settings to associate with the portal. Forces replacement if changed. +* `portal_arn` - (Required) ARN of the portal to associate with the user access logging settings. Forces replacement if changed. + +The following arguments are optional: + +* `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). + +## 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 WorkSpaces Web User Access Logging Settings Association using the `user_access_logging_settings_arn,portal_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.workspacesweb_user_access_logging_settings_association import WorkspaceswebUserAccessLoggingSettingsAssociation +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + WorkspaceswebUserAccessLoggingSettingsAssociation.generate_config_for_import(self, "example", "arn:aws:workspaces-web:us-west-2:123456789012:userAccessLoggingSettings/user_access_logging_settings-id-12345678,arn:aws:workspaces-web:us-west-2:123456789012:portal/portal-id-12345678") +``` + + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/workspacesweb_user_settings.html.markdown b/website/docs/cdktf/python/r/workspacesweb_user_settings.html.markdown index 455c5b1c77b2..5a8d23b2feb3 100644 --- a/website/docs/cdktf/python/r/workspacesweb_user_settings.html.markdown +++ b/website/docs/cdktf/python/r/workspacesweb_user_settings.html.markdown @@ -137,6 +137,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `additional_encryption_context` - (Optional) Additional encryption context for the user settings. * `associated_portal_arns` - (Optional) List of web portal ARNs to associate with the user settings. * `cookie_synchronization_configuration` - (Optional) Configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser. Detailed below. @@ -197,4 +198,4 @@ Using `terraform import`, import WorkSpaces Web User Settings using the `user_se % terraform import aws_workspacesweb_user_settings.example arn:aws:workspacesweb:us-west-2:123456789012:usersettings/abcdef12345 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/workspacesweb_user_settings_association.html.markdown b/website/docs/cdktf/python/r/workspacesweb_user_settings_association.html.markdown new file mode 100644 index 000000000000..45d78838da1e --- /dev/null +++ b/website/docs/cdktf/python/r/workspacesweb_user_settings_association.html.markdown @@ -0,0 +1,88 @@ +--- +subcategory: "WorkSpaces Web" +layout: "aws" +page_title: "AWS: aws_workspacesweb_user_settings_association" +description: |- + Terraform resource for managing an AWS WorkSpaces Web User Settings Association. +--- + + + +# Resource: aws_workspacesweb_user_settings_association + +Terraform resource for managing an AWS WorkSpaces Web User Settings Association. + +## 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.workspacesweb_portal import WorkspaceswebPortal +from imports.aws.workspacesweb_user_settings import WorkspaceswebUserSettings +from imports.aws.workspacesweb_user_settings_association import WorkspaceswebUserSettingsAssociation +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + example = WorkspaceswebPortal(self, "example", + display_name="example" + ) + aws_workspacesweb_user_settings_example = WorkspaceswebUserSettings(self, "example_1", + copy_allowed="Enabled", + download_allowed="Enabled", + paste_allowed="Enabled", + print_allowed="Enabled", + upload_allowed="Enabled" + ) + # 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_workspacesweb_user_settings_example.override_logical_id("example") + aws_workspacesweb_user_settings_association_example = + WorkspaceswebUserSettingsAssociation(self, "example_2", + portal_arn=example.portal_arn, + user_settings_arn=Token.as_string(aws_workspacesweb_user_settings_example.user_settings_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_workspacesweb_user_settings_association_example.override_logical_id("example") +``` + +## Argument Reference + +The following arguments are required: + +* `user_settings_arn` - (Required) ARN of the user settings to associate with the portal. Forces replacement if changed. +* `portal_arn` - (Required) ARN of the portal to associate with the user settings. Forces replacement if changed. + +The following arguments are optional: + +* `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). + +## 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 WorkSpaces Web User Settings Association using the `user_settings_arn,portal_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.workspacesweb_user_settings_association import WorkspaceswebUserSettingsAssociation +class MyConvertedCode(TerraformStack): + def __init__(self, scope, name): + super().__init__(scope, name) + WorkspaceswebUserSettingsAssociation.generate_config_for_import(self, "example", "arn:aws:workspaces-web:us-west-2:123456789012:userSettings/user_settings-id-12345678,arn:aws:workspaces-web:us-west-2:123456789012:portal/portal-id-12345678") +``` + + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/xray_encryption_config.html.markdown b/website/docs/cdktf/python/r/xray_encryption_config.html.markdown index 7e12414d4e29..722c12969f0b 100644 --- a/website/docs/cdktf/python/r/xray_encryption_config.html.markdown +++ b/website/docs/cdktf/python/r/xray_encryption_config.html.markdown @@ -84,6 +84,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `type` - (Required) The type of encryption. Set to `KMS` to use your own key for encryption. Set to `NONE` for default encryption. * `key_id` - (Optional) An AWS KMS customer master key (CMK) ARN. @@ -118,4 +119,4 @@ Using `terraform import`, import XRay Encryption Config using the region name. F % terraform import aws_xray_encryption_config.example us-west-2 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/xray_group.html.markdown b/website/docs/cdktf/python/r/xray_group.html.markdown index 74ab436ec7b6..432ba28befc6 100644 --- a/website/docs/cdktf/python/r/xray_group.html.markdown +++ b/website/docs/cdktf/python/r/xray_group.html.markdown @@ -40,6 +40,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `group_name` - (Required) The name of the group. * `filter_expression` - (Required) The filter expression defining criteria by which to group traces. more info can be found in official [docs](https://docs.aws.amazon.com/xray/latest/devguide/xray-console-filters.html). * `insights_configuration` - (Optional) Configuration options for enabling insights. @@ -85,4 +86,4 @@ Using `terraform import`, import XRay Groups using the ARN. For example: % terraform import aws_xray_group.example arn:aws:xray:us-west-2:1234567890:group/example-group/TNGX7SW5U6QY36T4ZMOUA3HVLBYCZTWDIOOXY3CJAXTHSS3YCWUA ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/xray_resource_policy.html.markdown b/website/docs/cdktf/python/r/xray_resource_policy.html.markdown index be92d1fe49d3..01550e785eb2 100644 --- a/website/docs/cdktf/python/r/xray_resource_policy.html.markdown +++ b/website/docs/cdktf/python/r/xray_resource_policy.html.markdown @@ -44,6 +44,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `policy_revision_id` - (Optional) Specifies a specific policy revision, to ensure an atomic create operation. By default the resource policy is created if it does not exist, or updated with an incremented revision id. The revision id is unique to each policy in the account. If the policy revision id does not match the latest revision id, the operation will fail with an InvalidPolicyRevisionIdException exception. You can also provide a PolicyRevisionId of 0. In this case, the operation will fail with an InvalidPolicyRevisionIdException exception if a resource policy with the same name already exists. * `bypass_policy_lockout_check` - (Optional) Flag to indicate whether to bypass the resource policy lockout safety check. Setting this value to true increases the risk that the policy becomes unmanageable. Do not set this value to true indiscriminately. Use this parameter only when you include a policy in the request and you intend to prevent the principal that is making the request from making a subsequent PutResourcePolicy request. The default value is `false`. @@ -79,4 +80,4 @@ Using `terraform import`, import X-Ray Resource Policy using the `policy_name`. % terraform import aws_xray_resource_policy.example resource_policy-name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/python/r/xray_sampling_rule.html.markdown b/website/docs/cdktf/python/r/xray_sampling_rule.html.markdown index 6f534b7cfe52..3a3a82f3d0b2 100644 --- a/website/docs/cdktf/python/r/xray_sampling_rule.html.markdown +++ b/website/docs/cdktf/python/r/xray_sampling_rule.html.markdown @@ -48,6 +48,7 @@ class MyConvertedCode(TerraformStack): This resource supports the following arguments: +* `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). * `rule_name` - (Required) The name of the sampling rule. * `resource_arn` - (Required) Matches the ARN of the AWS resource on which the service runs. * `priority` - (Required) The priority of the sampling rule. @@ -95,4 +96,4 @@ Using `terraform import`, import XRay Sampling Rules using the name. For example % terraform import aws_xray_sampling_rule.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/acm_certificate.html.markdown b/website/docs/cdktf/typescript/d/acm_certificate.html.markdown index 6077559594d4..792567b8989c 100644 --- a/website/docs/cdktf/typescript/d/acm_certificate.html.markdown +++ b/website/docs/cdktf/typescript/d/acm_certificate.html.markdown @@ -49,6 +49,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `domain` - (Optional) Domain of the certificate to look up. If set and no certificate is found with this name, an error will be returned. * `keyTypes` - (Optional) List of key algorithms to filter certificates. By default, ACM does not return all certificate types when searching. See the [ACM API Reference](https://docs.aws.amazon.com/acm/latest/APIReference/API_CertificateDetail.html#ACM-Type-CertificateDetail-KeyAlgorithm) for supported key algorithms. * `statuses` - (Optional) List of statuses on which to filter the returned list. Valid values are `PENDING_VALIDATION`, `ISSUED`, @@ -69,4 +70,4 @@ This data source exports the following attributes in addition to the arguments a * `certificateChain` - Certificates forming the requested ACM-issued certificate's chain of trust. The chain consists of the certificate of the issuing CA and the intermediate certificates of any other subordinate CAs. * `tags` - Mapping of tags for the resource. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/acmpca_certificate.html.markdown b/website/docs/cdktf/typescript/d/acmpca_certificate.html.markdown index 1d086995614b..6d2b1a02a0a7 100644 --- a/website/docs/cdktf/typescript/d/acmpca_certificate.html.markdown +++ b/website/docs/cdktf/typescript/d/acmpca_certificate.html.markdown @@ -40,6 +40,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `arn` - (Required) ARN of the certificate issued by the private certificate authority. * `certificateAuthorityArn` - (Required) ARN of the certificate authority. @@ -50,4 +51,4 @@ This data source exports the following attributes in addition to the arguments a * `certificate` - PEM-encoded certificate value. * `certificateChain` - PEM-encoded certificate chain that includes any intermediate certificates and chains up to root CA. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/acmpca_certificate_authority.html.markdown b/website/docs/cdktf/typescript/d/acmpca_certificate_authority.html.markdown index e4187d31c672..ed58e33f5c2d 100644 --- a/website/docs/cdktf/typescript/d/acmpca_certificate_authority.html.markdown +++ b/website/docs/cdktf/typescript/d/acmpca_certificate_authority.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `arn` - (Required) ARN of the certificate authority. ## Attribute Reference @@ -65,4 +66,4 @@ This data source exports the following attributes in addition to the arguments a * `tags` - Key-value map of user-defined tags that are attached to the certificate authority. * `type` - Type of the certificate authority. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/ami.html.markdown b/website/docs/cdktf/typescript/d/ami.html.markdown index 9b8768b8ee33..6436b261b289 100644 --- a/website/docs/cdktf/typescript/d/ami.html.markdown +++ b/website/docs/cdktf/typescript/d/ami.html.markdown @@ -56,6 +56,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `owners` - (Optional) List of AMI owners to limit search. Valid values: an AWS account ID, `self` (the current account), or an AWS owner alias (e.g., `amazon`, `aws-marketplace`, `microsoft`). * `mostRecent` - (Optional) If more than one result is returned, use the most recent AMI. @@ -65,6 +66,10 @@ recent AMI. * `filter` - (Optional) One or more name/value pairs to filter off of. There are several valid keys, for a full reference, check out [describe-images in the AWS CLI reference][1]. +* `allowUnsafeFilter` - (Optional) If true, allow unsafe filter values. With unsafe +filters and `mostRecent` set to `true`, a third party may introduce a new image which +will be returned by this data source. Consider filtering by owner or image ID rather +than setting this argument. * `nameRegex` - (Optional) Regex string to apply to the AMI list returned by AWS. This allows more advanced filtering not supported from the AWS API. This filtering is done locally on what AWS returns, and could have a performance @@ -152,4 +157,4 @@ interpolation. [1]: http://docs.aws.amazon.com/cli/latest/reference/ec2/describe-images.html - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/ami_ids.html.markdown b/website/docs/cdktf/typescript/d/ami_ids.html.markdown index 0024ac10169d..e4bab331aeee 100644 --- a/website/docs/cdktf/typescript/d/ami_ids.html.markdown +++ b/website/docs/cdktf/typescript/d/ami_ids.html.markdown @@ -44,6 +44,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `owners` - (Required) List of AMI owners to limit search. At least 1 value must be specified. Valid values: an AWS account ID, `self` (the current account), or an AWS owner alias (e.g., `amazon`, `aws-marketplace`, `microsoft`). * `executableUsers` - (Optional) Limit search to users with *explicit* launch permission on the image. Valid items are the numeric account ID or `self`. @@ -74,4 +75,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/api_gateway_api_key.html.markdown b/website/docs/cdktf/typescript/d/api_gateway_api_key.html.markdown index 33e68b249e4f..fb8846986268 100644 --- a/website/docs/cdktf/typescript/d/api_gateway_api_key.html.markdown +++ b/website/docs/cdktf/typescript/d/api_gateway_api_key.html.markdown @@ -39,6 +39,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `id` - (Required) ID of the API Key to look up. ## Attribute Reference @@ -55,4 +56,4 @@ This data source exports the following attributes in addition to the arguments a * `enabled` - Whether the API Key is enabled. * `tags` - Map of tags for the resource. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/api_gateway_api_keys.html.markdown b/website/docs/cdktf/typescript/d/api_gateway_api_keys.html.markdown index 61c28c07ced2..e704357de2c2 100644 --- a/website/docs/cdktf/typescript/d/api_gateway_api_keys.html.markdown +++ b/website/docs/cdktf/typescript/d/api_gateway_api_keys.html.markdown @@ -36,6 +36,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `customerId` - (Optional) Amazon Web Services Marketplace customer identifier, when integrating with the Amazon Web Services SaaS Marketplace. * `includeValues` - (Optional) Set this value to `true` if you wish the result contains the key value. Defaults to `false`. @@ -58,4 +59,4 @@ This data source exports the following attributes in addition to the arguments a * `enabled` - Whether the API Key is enabled. * `tags` - Map of tags for the resource. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/api_gateway_authorizer.html.markdown b/website/docs/cdktf/typescript/d/api_gateway_authorizer.html.markdown index a69aa9bcffe2..17e3a60956e4 100644 --- a/website/docs/cdktf/typescript/d/api_gateway_authorizer.html.markdown +++ b/website/docs/cdktf/typescript/d/api_gateway_authorizer.html.markdown @@ -41,6 +41,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `authorizerId` - (Required) Authorizer identifier. * `restApiId` - (Required) ID of the associated REST API. @@ -58,4 +59,4 @@ This data source exports the following attributes in addition to the arguments a * `providerArns` - List of the Amazon Cognito user pool ARNs. * `type` - Type of the authorizer. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/api_gateway_authorizers.html.markdown b/website/docs/cdktf/typescript/d/api_gateway_authorizers.html.markdown index 73942906e41b..bfd840cb1eca 100644 --- a/website/docs/cdktf/typescript/d/api_gateway_authorizers.html.markdown +++ b/website/docs/cdktf/typescript/d/api_gateway_authorizers.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `restApiId` - (Required) ID of the associated REST API. ## Attribute Reference @@ -46,4 +47,4 @@ This data source exports the following attributes in addition to the arguments a * `ids` - List of Authorizer identifiers. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/api_gateway_domain_name.html.markdown b/website/docs/cdktf/typescript/d/api_gateway_domain_name.html.markdown index 055f463c70b1..803bd8251ebd 100644 --- a/website/docs/cdktf/typescript/d/api_gateway_domain_name.html.markdown +++ b/website/docs/cdktf/typescript/d/api_gateway_domain_name.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `domainName` - (Required) Fully-qualified domain name to look up. If no domain name is found, an error will be returned. * `domainNameId` - (Optional) The identifier for the domain name resource. Supported only for private custom domain names. @@ -62,4 +63,4 @@ This data source exports the following attributes in addition to the arguments a * `securityPolicy` - Security policy for the domain name. * `tags` - Key-value map of tags for the resource. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/api_gateway_export.html.markdown b/website/docs/cdktf/typescript/d/api_gateway_export.html.markdown index 86466fc1c671..794025770b1f 100644 --- a/website/docs/cdktf/typescript/d/api_gateway_export.html.markdown +++ b/website/docs/cdktf/typescript/d/api_gateway_export.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `exportType` - (Required) Type of export. Acceptable values are `oas30` for OpenAPI 3.0.x and `swagger` for Swagger/OpenAPI 2.0. * `restApiId` - (Required) Identifier of the associated REST API. * `stageName` - (Required) Name of the Stage that will be exported. @@ -53,4 +54,4 @@ This data source exports the following attributes in addition to the arguments a * `contentType` - Content-type header value in the HTTP response. * `contentDisposition` - Content-disposition header value in the HTTP response. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/api_gateway_resource.html.markdown b/website/docs/cdktf/typescript/d/api_gateway_resource.html.markdown index 1ba8016d25a3..fbc3f25657fb 100644 --- a/website/docs/cdktf/typescript/d/api_gateway_resource.html.markdown +++ b/website/docs/cdktf/typescript/d/api_gateway_resource.html.markdown @@ -44,6 +44,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `restApiId` - (Required) REST API id that owns the resource. If no REST API is found, an error will be returned. * `path` - (Required) Full path of the resource. If no path is found, an error will be returned. @@ -55,4 +56,4 @@ This data source exports the following attributes in addition to the arguments a * `parentId` - Set to the ID of the parent Resource. * `pathPart` - Set to the path relative to the parent Resource. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/api_gateway_rest_api.html.markdown b/website/docs/cdktf/typescript/d/api_gateway_rest_api.html.markdown index c55477c41378..9933f91973e8 100644 --- a/website/docs/cdktf/typescript/d/api_gateway_rest_api.html.markdown +++ b/website/docs/cdktf/typescript/d/api_gateway_rest_api.html.markdown @@ -41,6 +41,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `name` - (Required) Name of the REST API to look up. If no REST API is found with this name, an error will be returned. If multiple REST APIs are found with this name, an error will be returned. ## Attribute Reference @@ -62,4 +63,4 @@ This data source exports the following attributes in addition to the arguments a * `rootResourceId` - Set to the ID of the API Gateway Resource on the found REST API where the route matches '/'. * `tags` - Key-value map of resource tags. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/api_gateway_sdk.html.markdown b/website/docs/cdktf/typescript/d/api_gateway_sdk.html.markdown index dc47571c70a8..44aa173a07b7 100644 --- a/website/docs/cdktf/typescript/d/api_gateway_sdk.html.markdown +++ b/website/docs/cdktf/typescript/d/api_gateway_sdk.html.markdown @@ -44,6 +44,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `restApiId` - (Required) Identifier of the associated REST API. * `stageName` - (Required) Name of the Stage that will be exported. * `sdkType` - (Required) Language for the generated SDK. Currently `java`, `javascript`, `android`, `objectivec` (for iOS), `swift` (for iOS), and `ruby` are supported. @@ -58,4 +59,4 @@ This data source exports the following attributes in addition to the arguments a * `contentType` - Content-type header value in the HTTP response. * `contentDisposition` - Content-disposition header value in the HTTP response. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/api_gateway_vpc_link.html.markdown b/website/docs/cdktf/typescript/d/api_gateway_vpc_link.html.markdown index ebb840c57a4f..b903cfb72c40 100644 --- a/website/docs/cdktf/typescript/d/api_gateway_vpc_link.html.markdown +++ b/website/docs/cdktf/typescript/d/api_gateway_vpc_link.html.markdown @@ -41,6 +41,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `name` - (Required) Name of the API Gateway VPC Link to look up. If no API Gateway VPC Link is found with this name, an error will be returned. If multiple API Gateway VPC Links are found with this name, an error will be returned. @@ -55,4 +56,4 @@ This data source exports the following attributes in addition to the arguments a * `targetArns` - List of network load balancer arns in the VPC targeted by the VPC link. Currently AWS only supports 1 target. * `tags` - Key-value map of resource tags - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/apigatewayv2_api.html.markdown b/website/docs/cdktf/typescript/d/apigatewayv2_api.html.markdown index 5da45a5ac4e0..c219461c9110 100644 --- a/website/docs/cdktf/typescript/d/apigatewayv2_api.html.markdown +++ b/website/docs/cdktf/typescript/d/apigatewayv2_api.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `apiId` - (Required) API identifier. ## Attribute Reference @@ -70,4 +71,4 @@ The `corsConfiguration` object supports the following: * `exposeHeaders` - Set of exposed HTTP headers. * `maxAge` - Number of seconds that the browser should cache preflight request results. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/apigatewayv2_apis.html.markdown b/website/docs/cdktf/typescript/d/apigatewayv2_apis.html.markdown index 92a585fc4960..842b54a99ef5 100644 --- a/website/docs/cdktf/typescript/d/apigatewayv2_apis.html.markdown +++ b/website/docs/cdktf/typescript/d/apigatewayv2_apis.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `name` - (Optional) API name. * `protocolType` - (Optional) API protocol. * `tags` - (Optional) Map of tags, each pair of which must exactly match @@ -49,4 +50,4 @@ This data source exports the following attributes in addition to the arguments a * `ids` - Set of API identifiers. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/apigatewayv2_export.html.markdown b/website/docs/cdktf/typescript/d/apigatewayv2_export.html.markdown index 19db33cf5c43..cdd7a61350e7 100644 --- a/website/docs/cdktf/typescript/d/apigatewayv2_export.html.markdown +++ b/website/docs/cdktf/typescript/d/apigatewayv2_export.html.markdown @@ -40,6 +40,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `apiId` - (Required) API identifier. * `specification` - (Required) Version of the API specification to use. `OAS30`, for OpenAPI 3.0, is the only supported value. * `outputType` - (Required) Output type of the exported definition file. Valid values are `JSON` and `YAML`. @@ -54,4 +55,4 @@ This data source exports the following attributes in addition to the arguments a * `id` - API identifier. * `body` - ID of the API. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/apigatewayv2_vpc_link.html.markdown b/website/docs/cdktf/typescript/d/apigatewayv2_vpc_link.html.markdown index 1d8e7ad0b775..9a9ba7f79cfa 100644 --- a/website/docs/cdktf/typescript/d/apigatewayv2_vpc_link.html.markdown +++ b/website/docs/cdktf/typescript/d/apigatewayv2_vpc_link.html.markdown @@ -38,8 +38,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `vpcLinkId` - (Required) VPC Link ID ## Attribute Reference @@ -53,4 +54,4 @@ This data source exports the following attributes in addition to the arguments a * `subnetIds` - List of subnets attached to the VPC Link. * `tags` - VPC Link Tags. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/appconfig_configuration_profile.html.markdown b/website/docs/cdktf/typescript/d/appconfig_configuration_profile.html.markdown index 5e82b714a038..28c175d88890 100644 --- a/website/docs/cdktf/typescript/d/appconfig_configuration_profile.html.markdown +++ b/website/docs/cdktf/typescript/d/appconfig_configuration_profile.html.markdown @@ -39,8 +39,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `applicationId` - (Required) ID of the AppConfig application to which this configuration profile belongs. * `configurationProfileId` - (Required) ID of the Configuration Profile. @@ -59,4 +60,4 @@ This data source exports the following attributes in addition to the arguments a * `content` - Either the JSON Schema content or the ARN of an AWS Lambda function. * `type` - Type of validator. Valid values: JSON_SCHEMA and LAMBDA. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/appconfig_configuration_profiles.html.markdown b/website/docs/cdktf/typescript/d/appconfig_configuration_profiles.html.markdown index 962bf0a3dc10..f595e23d2ab7 100644 --- a/website/docs/cdktf/typescript/d/appconfig_configuration_profiles.html.markdown +++ b/website/docs/cdktf/typescript/d/appconfig_configuration_profiles.html.markdown @@ -55,8 +55,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `applicationId` - (Required) ID of the AppConfig Application. ## Attribute Reference @@ -65,4 +66,4 @@ This data source exports the following attributes in addition to the arguments a * `configurationProfileIds` - Set of Configuration Profile IDs associated with the AppConfig Application. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/appconfig_environment.html.markdown b/website/docs/cdktf/typescript/d/appconfig_environment.html.markdown index d30c4ec45cf9..a919c8f61923 100644 --- a/website/docs/cdktf/typescript/d/appconfig_environment.html.markdown +++ b/website/docs/cdktf/typescript/d/appconfig_environment.html.markdown @@ -39,8 +39,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `applicationId` - (Required) ID of the AppConfig Application to which this Environment belongs. * `environmentId` - (Required) ID of the AppConfig Environment. @@ -58,4 +59,4 @@ This data source exports the following attributes in addition to the arguments a or `ROLLED_BACK`. * `tags` - Map of tags for the resource. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/appconfig_environments.html.markdown b/website/docs/cdktf/typescript/d/appconfig_environments.html.markdown index 789eb889fbe5..463ddeec31e4 100644 --- a/website/docs/cdktf/typescript/d/appconfig_environments.html.markdown +++ b/website/docs/cdktf/typescript/d/appconfig_environments.html.markdown @@ -39,8 +39,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `applicationId` - (Required) ID of the AppConfig Application. ## Attribute Reference @@ -49,4 +50,4 @@ This data source exports the following attributes in addition to the arguments a * `environmentIds` - Set of Environment IDs associated with this AppConfig Application. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/appintegrations_event_integration.html.markdown b/website/docs/cdktf/typescript/d/appintegrations_event_integration.html.markdown index 08665fb8ebd9..482673fbf548 100644 --- a/website/docs/cdktf/typescript/d/appintegrations_event_integration.html.markdown +++ b/website/docs/cdktf/typescript/d/appintegrations_event_integration.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `name` - (Required) The AppIntegrations Event Integration name. ## Attribute Reference @@ -57,4 +58,4 @@ This data source exports the following attributes in addition to the arguments a * `source` - The source of the events. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/appmesh_gateway_route.html.markdown b/website/docs/cdktf/typescript/d/appmesh_gateway_route.html.markdown index 41c050321b35..9a8e0fac84d0 100644 --- a/website/docs/cdktf/typescript/d/appmesh_gateway_route.html.markdown +++ b/website/docs/cdktf/typescript/d/appmesh_gateway_route.html.markdown @@ -40,6 +40,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `name` - (Required) Name of the gateway route. * `meshName` - (Required) Name of the service mesh in which the virtual gateway exists. * `virtualGatewayName` - (Required) Name of the virtual gateway in which the route exists. @@ -56,4 +57,4 @@ This data source exports the following attributes in addition to the arguments a * `spec` - Gateway route specification. See the [`aws_appmesh_gateway_route`](/docs/providers/aws/r/appmesh_gateway_route.html#spec) resource for details. * `tags` - Map of tags. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/appmesh_mesh.html.markdown b/website/docs/cdktf/typescript/d/appmesh_mesh.html.markdown index 73dab2c633a7..29b0ad67cfcd 100644 --- a/website/docs/cdktf/typescript/d/appmesh_mesh.html.markdown +++ b/website/docs/cdktf/typescript/d/appmesh_mesh.html.markdown @@ -61,6 +61,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `name` - (Required) Name of the service mesh. * `meshOwner` - (Optional) AWS account ID of the service mesh's owner. @@ -75,4 +76,4 @@ This data source exports the following attributes in addition to the arguments a * `spec` - Service mesh specification. See the [`aws_appmesh_mesh`](/docs/providers/aws/r/appmesh_mesh.html#spec) resource for details. * `tags` - Map of tags. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/appmesh_route.html.markdown b/website/docs/cdktf/typescript/d/appmesh_route.html.markdown index 2c32c5883b1b..77a47b96653a 100644 --- a/website/docs/cdktf/typescript/d/appmesh_route.html.markdown +++ b/website/docs/cdktf/typescript/d/appmesh_route.html.markdown @@ -40,6 +40,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `name` - (Required) Name of the route. * `meshName` - (Required) Name of the service mesh in which the virtual router exists. * `virtualRouterName` - (Required) Name of the virtual router in which the route exists. @@ -56,4 +57,4 @@ This data source exports the following attributes in addition to the arguments a * `spec` - Route specification. See the [`aws_appmesh_route`](/docs/providers/aws/r/appmesh_route.html#spec) resource for details. * `tags` - Map of tags. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/appmesh_virtual_gateway.html.markdown b/website/docs/cdktf/typescript/d/appmesh_virtual_gateway.html.markdown index e3d5fdb4fcc7..694acf558326 100644 --- a/website/docs/cdktf/typescript/d/appmesh_virtual_gateway.html.markdown +++ b/website/docs/cdktf/typescript/d/appmesh_virtual_gateway.html.markdown @@ -65,6 +65,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `name` - (Required) Name of the virtual gateway. * `meshName` - (Required) Name of the service mesh in which the virtual gateway exists. * `meshOwner` - (Optional) AWS account ID of the service mesh's owner. @@ -80,4 +81,4 @@ This data source exports the following attributes in addition to the arguments a * `spec` - Virtual gateway specification. See the [`aws_appmesh_virtual_gateway`](/docs/providers/aws/r/appmesh_virtual_gateway.html#spec) resource for details. * `tags` - Map of tags. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/appmesh_virtual_node.html.markdown b/website/docs/cdktf/typescript/d/appmesh_virtual_node.html.markdown index 850697cd8ea3..624e4f718096 100644 --- a/website/docs/cdktf/typescript/d/appmesh_virtual_node.html.markdown +++ b/website/docs/cdktf/typescript/d/appmesh_virtual_node.html.markdown @@ -39,6 +39,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `name` - (Required) Name of the virtual node. * `meshName` - (Required) Name of the service mesh in which the virtual node exists. * `meshOwner` - (Optional) AWS account ID of the service mesh's owner. @@ -54,4 +55,4 @@ This data source exports the following attributes in addition to the arguments a * `spec` - Virtual node specification. See the [`aws_appmesh_virtual_node`](/docs/providers/aws/r/appmesh_virtual_node.html#spec) resource for details. * `tags` - Map of tags. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/appmesh_virtual_router.html.markdown b/website/docs/cdktf/typescript/d/appmesh_virtual_router.html.markdown index 478a8c7c5e12..b277d82aab4f 100644 --- a/website/docs/cdktf/typescript/d/appmesh_virtual_router.html.markdown +++ b/website/docs/cdktf/typescript/d/appmesh_virtual_router.html.markdown @@ -39,6 +39,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `name` - (Required) Name of the virtual router. * `meshName` - (Required) Name of the mesh in which the virtual router exists @@ -53,4 +54,4 @@ This data source exports the following attributes in addition to the arguments a * `spec` - Virtual routers specification. See the [`aws_appmesh_virtual_router`](/docs/providers/aws/r/appmesh_virtual_router.html#spec) resource for details. * `tags` - Map of tags. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/appmesh_virtual_service.html.markdown b/website/docs/cdktf/typescript/d/appmesh_virtual_service.html.markdown index b1432c799819..7de99722a4a1 100644 --- a/website/docs/cdktf/typescript/d/appmesh_virtual_service.html.markdown +++ b/website/docs/cdktf/typescript/d/appmesh_virtual_service.html.markdown @@ -63,6 +63,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `name` - (Required) Name of the virtual service. * `meshName` - (Required) Name of the service mesh in which the virtual service exists. * `meshOwner` - (Optional) AWS account ID of the service mesh's owner. @@ -78,4 +79,4 @@ This data source exports the following attributes in addition to the arguments a * `spec` - Virtual service specification. See the [`aws_appmesh_virtual_service`](/docs/providers/aws/r/appmesh_virtual_service.html#spec) resource for details. * `tags` - Map of tags. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/apprunner_hosted_zone_id.html.markdown b/website/docs/cdktf/typescript/d/apprunner_hosted_zone_id.html.markdown index 2f3589da711d..6e7ccf7a99d6 100644 --- a/website/docs/cdktf/typescript/d/apprunner_hosted_zone_id.html.markdown +++ b/website/docs/cdktf/typescript/d/apprunner_hosted_zone_id.html.markdown @@ -48,13 +48,12 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: -* `region` - (Optional) Name of the region whose AWS App Runner service HostedZoneId is desired. - Defaults to the region from the AWS provider configuration. +* `region` - (Optional) Name of the Region whose AWS App Runner service HostedZoneId is desired. Defaults to the Region set in the [provider configuration](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#aws-configuration-reference). ## Attribute Reference This data source exports the following attributes in addition to the arguments above: -* `id` - ID of the AWS App Runner service HostedZoneId in the selected region. +* `id` - ID of the AWS App Runner service HostedZoneId in the selected Region. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/appstream_image.html.markdown b/website/docs/cdktf/typescript/d/appstream_image.html.markdown index 748e7ec34043..42fcea268e06 100644 --- a/website/docs/cdktf/typescript/d/appstream_image.html.markdown +++ b/website/docs/cdktf/typescript/d/appstream_image.html.markdown @@ -40,6 +40,7 @@ class MyConvertedCode extends TerraformStack { The following arguments are optional: +* `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). * `name` - Name of the image being searched for. Cannot be used with name_regex or arn. * `nameRegex` - Regular expression name of the image being searched for. Cannot be used with arn or name. * `arn` - Arn of the image being searched for. Cannot be used with name_regex or name. @@ -59,7 +60,7 @@ This data source exports the following attributes in addition to the arguments a * `icon_s3_location` - A list named icon_s3_location that contains the following: * `s3Bucket` - S3 bucket of the S3 object. * `s3Key` - S3 key of the S3 object. - * `iconUrl` - URL of the application icon. This URL may be time-limited. + * `icon_url` - URL of the application icon. This URL may be time-limited. * `instance_families` - List of the instance families of the application. * `launch_parameters` - Arguments that are passed to the application at it's launch. * `launchPath` - Path to the application's excecutable in the instance. @@ -88,4 +89,4 @@ This data source exports the following attributes in addition to the arguments a * `state` - Current state of image. Image starts in PENDING state which changes to AVAILABLE if creation passes and FAILED if it fails. Values will be from: PENDING | AVAILABLE | FAILED | COPYING | DELETING | CREATING | IMPORTING. * `visibility` - Visibility type enum indicating whether the image is PUBLIC, PRIVATE, or SHARED. Valid values include: PUBLIC | PRIVATE | SHARED. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/arn.html.markdown b/website/docs/cdktf/typescript/d/arn.html.markdown index c5ac7789ebd1..d77ee3b76dbc 100644 --- a/website/docs/cdktf/typescript/d/arn.html.markdown +++ b/website/docs/cdktf/typescript/d/arn.html.markdown @@ -45,15 +45,11 @@ This data source supports the following arguments: This data source exports the following attributes in addition to the arguments above: * `partition` - Partition that the resource is in. - * `service` - The [service namespace](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces) that identifies the AWS product. - * `region` - Region the resource resides in. -Note that the ARNs for some resources do not require a region, so this component might be omitted. - +Note that the ARNs for some resources do not include a Region, so this component might be omitted. * `account` - The [ID](https://docs.aws.amazon.com/general/latest/gr/acct-identifiers.html) of the AWS account that owns the resource, without the hyphens. - * `resource` - Content of this part of the ARN varies by service. It often includes an indicator of the type of resource—for example, an IAM user or Amazon RDS database —followed by a slash (/) or a colon (:), followed by the resource name itself. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/athena_named_query.html.markdown b/website/docs/cdktf/typescript/d/athena_named_query.html.markdown index 79262e3252bd..186265e7dbe7 100644 --- a/website/docs/cdktf/typescript/d/athena_named_query.html.markdown +++ b/website/docs/cdktf/typescript/d/athena_named_query.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `name` - (Required) The plain language name for the query. Maximum length of 128. * `workgroup` - (Optional) The workgroup to which the query belongs. Defaults to `primary`. @@ -50,4 +51,4 @@ This data source exports the following attributes in addition to the arguments a * `id` - The unique ID of the query. * `query` - Text of the query itself. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/auditmanager_control.html.markdown b/website/docs/cdktf/typescript/d/auditmanager_control.html.markdown index 176305ffa2d4..3e75d7f9238e 100644 --- a/website/docs/cdktf/typescript/d/auditmanager_control.html.markdown +++ b/website/docs/cdktf/typescript/d/auditmanager_control.html.markdown @@ -96,6 +96,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `name` - (Required) Name of the control. * `type` - (Required) Type of control. Valid values are `Custom` and `Standard`. @@ -105,4 +106,4 @@ This data source exports the following attributes in addition to the arguments a See the [`aws_auditmanager_control` resource](/docs/providers/aws/r/auditmanager_control.html) for details on the returned attributes - they are identical. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/auditmanager_framework.html.markdown b/website/docs/cdktf/typescript/d/auditmanager_framework.html.markdown index 7f35d6d762f5..f2ebb330ebd3 100644 --- a/website/docs/cdktf/typescript/d/auditmanager_framework.html.markdown +++ b/website/docs/cdktf/typescript/d/auditmanager_framework.html.markdown @@ -41,6 +41,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `name` - (Required) Name of the framework. * `type` - (Required) Type of framework. Valid values are `Custom` and `Standard`. @@ -50,4 +51,4 @@ This data source exports the following attributes in addition to the arguments a See the [`aws_auditmanager_framework` resource](/docs/providers/aws/r/auditmanager_framework.html) for details on the returned attributes - they are identical. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/autoscaling_group.html.markdown b/website/docs/cdktf/typescript/d/autoscaling_group.html.markdown index cc7ceff18573..d6cec26be213 100644 --- a/website/docs/cdktf/typescript/d/autoscaling_group.html.markdown +++ b/website/docs/cdktf/typescript/d/autoscaling_group.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `name` - Specify the exact name of the desired autoscaling group. ## Attribute Reference @@ -152,4 +153,4 @@ This data source exports the following attributes in addition to the arguments a ~> **NOTE:** Some values are not always set and may not be available for interpolation. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/autoscaling_groups.html.markdown b/website/docs/cdktf/typescript/d/autoscaling_groups.html.markdown index dc8ab9eaa409..14d7c64546d0 100644 --- a/website/docs/cdktf/typescript/d/autoscaling_groups.html.markdown +++ b/website/docs/cdktf/typescript/d/autoscaling_groups.html.markdown @@ -59,6 +59,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `names` - (Optional) List of autoscaling group names * `filter` - (Optional) Filter used to scope the list e.g., by tags. See [related docs](http://docs.aws.amazon.com/AutoScaling/latest/APIReference/API_Filter.html). * `name` - (Required) Name of the DescribeAutoScalingGroup filter. The recommended values are: `tag-key`, `tag-value`, and `tag:` @@ -72,4 +73,4 @@ This data source exports the following attributes in addition to the arguments a * `id` - AWS Region. * `names` - List of the Autoscaling Groups in the current region. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/availability_zone.html.markdown b/website/docs/cdktf/typescript/d/availability_zone.html.markdown index 80633fea9d17..d9a0c5a6b305 100644 --- a/website/docs/cdktf/typescript/d/availability_zone.html.markdown +++ b/website/docs/cdktf/typescript/d/availability_zone.html.markdown @@ -11,10 +11,10 @@ description: |- # Data Source: aws_availability_zone `aws_availability_zone` provides details about a specific availability zone (AZ) -in the current region. +in the current Region. This can be used both to validate an availability zone given in a variable -and to split the AZ name into its component parts of an AWS region and an +and to split the AZ name into its component parts of an AWS Region and an AZ identifier letter. The latter may be useful e.g., for implementing a consistent subnet numbering scheme across several regions by mapping both the region and the subnet letter to network numbers. @@ -101,6 +101,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `allAvailabilityZones` - (Optional) Set to `true` to include all Availability Zones and Local Zones regardless of your opt in status. * `filter` - (Optional) Configuration block(s) for filtering. Detailed below. * `name` - (Optional) Full name of the availability zone to select. @@ -122,7 +123,8 @@ The `filter` configuration block supports the following arguments: This data source exports the following attributes in addition to the arguments above: -* `groupName` - For Availability Zones, this is the same value as the Region name. For Local Zones, the name of the associated group, for example `us-west-2-lax-1`. +* `groupLongName` - The long name of the Availability Zone group, Local Zone group, or Wavelength Zone group. +* `groupName` - The name of the zone group. For example: `us-east-1-zg-1`, `us-west-2-lax-1`, or `us-east-1-wl1-bos-wlz-1`. * `nameSuffix` - Part of the AZ name that appears after the region name, uniquely identifying the AZ within its region. For Availability Zones this is usually a single letter, for example `a` for the `us-west-2a` zone. For Local and Wavelength Zones this is a longer string, for example `wl1-sfo-wlz-1` for the `us-west-2-wl1-sfo-wlz-1` zone. @@ -130,7 +132,6 @@ For Local and Wavelength Zones this is a longer string, for example `wl1-sfo-wlz * `optInStatus` - For Availability Zones, this always has the value of `opt-in-not-required`. For Local Zones, this is the opt in status. The possible values are `opted-in` and `not-opted-in`. * `parentZoneId` - ID of the zone that handles some of the Local Zone or Wavelength Zone control plane operations, such as API calls. * `parentZoneName` - Name of the zone that handles some of the Local Zone or Wavelength Zone control plane operations, such as API calls. -* `region` - Region where the selected availability zone resides. This is always the region selected on the provider, since this data source searches only within that region. * `zoneType` - Type of zone. Values are `availability-zone`, `local-zone`, and `wavelength-zone`. ## Timeouts @@ -139,4 +140,4 @@ For Local and Wavelength Zones this is a longer string, for example `wl1-sfo-wlz - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/availability_zones.html.markdown b/website/docs/cdktf/typescript/d/availability_zones.html.markdown index e0e026241dcf..edfc3d710266 100644 --- a/website/docs/cdktf/typescript/d/availability_zones.html.markdown +++ b/website/docs/cdktf/typescript/d/availability_zones.html.markdown @@ -117,6 +117,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `allAvailabilityZones` - (Optional) Set to `true` to include all Availability Zones and Local Zones regardless of your opt in status. * `filter` - (Optional) Configuration block(s) for filtering. Detailed below. * `excludeNames` - (Optional) List of Availability Zone names to exclude. @@ -150,4 +151,4 @@ Note that the indexes of Availability Zone names and IDs correspond. - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/backup_framework.html.markdown b/website/docs/cdktf/typescript/d/backup_framework.html.markdown index 1557c876849f..bb965735d387 100644 --- a/website/docs/cdktf/typescript/d/backup_framework.html.markdown +++ b/website/docs/cdktf/typescript/d/backup_framework.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `name` - (Required) Backup framework name. ## Attribute Reference @@ -76,4 +77,4 @@ This data source exports the following attributes in addition to the arguments a * `complianceResourceTypes` - Describes whether the control scope includes one or more types of resources, such as EFS or RDS. * `tags` - Tag key-value pair applied to those AWS resources that you want to trigger an evaluation for a rule. A maximum of one key-value pair can be provided. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/backup_plan.html.markdown b/website/docs/cdktf/typescript/d/backup_plan.html.markdown index 1d7f613682ea..c41f00013f0c 100644 --- a/website/docs/cdktf/typescript/d/backup_plan.html.markdown +++ b/website/docs/cdktf/typescript/d/backup_plan.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `planId` - (Required) Backup plan ID. ## Attribute Reference @@ -50,4 +51,4 @@ This data source exports the following attributes in addition to the arguments a * `tags` - Metadata that you can assign to help organize the plans you create. * `version` - Unique, randomly generated, Unicode, UTF-8 encoded string that serves as the version ID of the backup plan. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/backup_report_plan.html.markdown b/website/docs/cdktf/typescript/d/backup_report_plan.html.markdown index 412b3a17fc3a..17be0f324660 100644 --- a/website/docs/cdktf/typescript/d/backup_report_plan.html.markdown +++ b/website/docs/cdktf/typescript/d/backup_report_plan.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `name` - (Required) Backup report plan name. ## Attribute Reference @@ -72,4 +73,4 @@ This data source exports the following attributes in addition to the arguments a * `regions` - (Optional) Specifies the list of regions a report covers. * `reportTemplate` - Identifies the report template for the report. Reports are built using a report template. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/backup_selection.html.markdown b/website/docs/cdktf/typescript/d/backup_selection.html.markdown index fe22866b6a6e..05a4b0ad301e 100644 --- a/website/docs/cdktf/typescript/d/backup_selection.html.markdown +++ b/website/docs/cdktf/typescript/d/backup_selection.html.markdown @@ -39,6 +39,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `planId` - (Required) Backup plan ID associated with the selection of resources. * `selectionId` - (Required) Backup selection ID. @@ -50,4 +51,4 @@ This data source exports the following attributes in addition to the arguments a * `iamRoleArn` - ARN of the IAM role that AWS Backup uses to authenticate when restoring and backing up the target resource. See the [AWS Backup Developer Guide](https://docs.aws.amazon.com/aws-backup/latest/devguide/access-control.html#managed-policies) for additional information about using AWS managed policies or creating custom policies attached to the IAM role. * `resources` - An array of strings that either contain Amazon Resource Names (ARNs) or match patterns of resources to assign to a backup plan.. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/backup_vault.html.markdown b/website/docs/cdktf/typescript/d/backup_vault.html.markdown index 86fbcdc8f673..7646bb45b260 100644 --- a/website/docs/cdktf/typescript/d/backup_vault.html.markdown +++ b/website/docs/cdktf/typescript/d/backup_vault.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `name` - (Required) Name of the backup vault. ## Attribute Reference @@ -49,4 +50,4 @@ This data source exports the following attributes in addition to the arguments a * `recoveryPoints` - Number of recovery points that are stored in a backup vault. * `tags` - Metadata that you can assign to help organize the resources that you create. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/batch_compute_environment.html.markdown b/website/docs/cdktf/typescript/d/batch_compute_environment.html.markdown index 5fa24dbf8236..b0a3859feef1 100644 --- a/website/docs/cdktf/typescript/d/batch_compute_environment.html.markdown +++ b/website/docs/cdktf/typescript/d/batch_compute_environment.html.markdown @@ -28,7 +28,7 @@ class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); new DataAwsBatchComputeEnvironment(this, "batch-mongo", { - computeEnvironmentName: "batch-mongo-production", + name: "batch-mongo-production", }); } } @@ -39,7 +39,8 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: -* `computeEnvironmentName` - (Required) Name of the Batch Compute Environment +* `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). +* `name` - (Required) Name of the Batch Compute Environment ## Attribute Reference @@ -55,4 +56,4 @@ This data source exports the following attributes in addition to the arguments a * `updatePolicy` - Specifies the infrastructure update policy for the compute environment. * `tags` - Key-value map of resource tags - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/batch_job_definition.html.markdown b/website/docs/cdktf/typescript/d/batch_job_definition.html.markdown index 5a530a2f51cf..a3ae94230c34 100644 --- a/website/docs/cdktf/typescript/d/batch_job_definition.html.markdown +++ b/website/docs/cdktf/typescript/d/batch_job_definition.html.markdown @@ -63,6 +63,7 @@ class MyConvertedCode extends TerraformStack { The following arguments are optional: +* `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). * `arn` - ARN of the Job Definition. Do not begin the description with "An", "The", "Defines", "Indicates", or "Specifies," as these are verbose. In other words, "Indicates the amount of storage," can be rewritten as "Amount of storage," without losing any information. * `revision` - The revision of the job definition. * `name` - The name of the job definition to register. It can be up to 128 letters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_). @@ -305,4 +306,4 @@ This data source exports the following attributes in addition to the arguments a * `attemptDurationSeconds` - The job timeout time (in seconds) that's measured from the job attempt's startedAt timestamp. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/batch_job_queue.html.markdown b/website/docs/cdktf/typescript/d/batch_job_queue.html.markdown index 5585cccaf706..82cc454ef8a9 100644 --- a/website/docs/cdktf/typescript/d/batch_job_queue.html.markdown +++ b/website/docs/cdktf/typescript/d/batch_job_queue.html.markdown @@ -39,6 +39,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `name` - (Required) Name of the job queue. ## Attribute Reference @@ -64,4 +65,4 @@ This data source exports the following attributes in addition to the arguments a * `job_state_time_limit_action.#.reason` - The reason to log for the action being taken. * `job_state_time_limit_action.#.state` - The state of the job needed to trigger the action. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/batch_scheduling_policy.html.markdown b/website/docs/cdktf/typescript/d/batch_scheduling_policy.html.markdown index 67265bc0547b..51547598fad5 100644 --- a/website/docs/cdktf/typescript/d/batch_scheduling_policy.html.markdown +++ b/website/docs/cdktf/typescript/d/batch_scheduling_policy.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `arn` - (Required) ARN of the scheduling policy. ## Attribute Reference @@ -59,4 +60,4 @@ A `shareDistribution` block supports the following arguments: * `shareIdentifier` - Fair share identifier or fair share identifier prefix. For more information, see [ShareAttributes](https://docs.aws.amazon.com/batch/latest/APIReference/API_ShareAttributes.html). * `weightFactor` - Weight factor for the fair share identifier. For more information, see [ShareAttributes](https://docs.aws.amazon.com/batch/latest/APIReference/API_ShareAttributes.html). - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/bedrock_custom_model.html.markdown b/website/docs/cdktf/typescript/d/bedrock_custom_model.html.markdown index d85139ac6f23..e39b32654fb1 100644 --- a/website/docs/cdktf/typescript/d/bedrock_custom_model.html.markdown +++ b/website/docs/cdktf/typescript/d/bedrock_custom_model.html.markdown @@ -39,7 +39,8 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: -* `modelId` – (Required) Name or ARN of the custom model. +* `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). +* `modelId` - (Required) Name or ARN of the custom model. ## Attribute Reference @@ -66,5 +67,5 @@ This data source exports the following attributes in addition to the arguments a * `s3Uri` - The S3 URI where the validation data is stored.. * `validationMetrics` - The loss metric for each validator that you provided. * `validation_loss` - The validation loss associated with the validator. - - \ No newline at end of file + + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/bedrock_custom_models.html.markdown b/website/docs/cdktf/typescript/d/bedrock_custom_models.html.markdown index 735bbff74151..3826e1e9bd4a 100644 --- a/website/docs/cdktf/typescript/d/bedrock_custom_models.html.markdown +++ b/website/docs/cdktf/typescript/d/bedrock_custom_models.html.markdown @@ -34,7 +34,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -This data source does not support any arguments. +This data source supports the following arguments: + +* `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). ## Attribute Reference @@ -45,4 +47,4 @@ This data source exports the following attributes in addition to the arguments a * `modelArn` - The ARN of the custom model. * `modelName` - The name of the custom model. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/bedrock_foundation_model.html.markdown b/website/docs/cdktf/typescript/d/bedrock_foundation_model.html.markdown index 0a3a6a4321ad..ddd1afd4406d 100644 --- a/website/docs/cdktf/typescript/d/bedrock_foundation_model.html.markdown +++ b/website/docs/cdktf/typescript/d/bedrock_foundation_model.html.markdown @@ -50,7 +50,8 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: -* `modelId` – (Required) Model identifier. +* `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). +* `modelId` - (Required) Model identifier. ## Attribute Reference @@ -65,4 +66,4 @@ This data source exports the following attributes in addition to the arguments a * `providerName` - Model provider name. * `responseStreamingSupported` - Indicates whether the model supports streaming. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/bedrock_foundation_models.html.markdown b/website/docs/cdktf/typescript/d/bedrock_foundation_models.html.markdown index 42bcbad4575b..3df4a2152228 100644 --- a/website/docs/cdktf/typescript/d/bedrock_foundation_models.html.markdown +++ b/website/docs/cdktf/typescript/d/bedrock_foundation_models.html.markdown @@ -60,6 +60,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `byCustomizationType` - (Optional) Customization type to filter on. Valid values are `FINE_TUNING`. * `byInferenceType` - (Optional) Inference type to filter on. Valid values are `ON_DEMAND` and `PROVISIONED`. * `byOutputModality` - (Optional) Output modality to filter on. Valid values are `TEXT`, `IMAGE`, and `EMBEDDING`. @@ -84,4 +85,4 @@ This data source exports the following attributes in addition to the arguments a * `providerName` - Model provider name. * `responseStreamingSupported` - Indicates whether the model supports streaming. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/bedrock_inference_profile.html.markdown b/website/docs/cdktf/typescript/d/bedrock_inference_profile.html.markdown index e9bfc236fcb7..c2c483c7c162 100644 --- a/website/docs/cdktf/typescript/d/bedrock_inference_profile.html.markdown +++ b/website/docs/cdktf/typescript/d/bedrock_inference_profile.html.markdown @@ -50,7 +50,8 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: -- `inferenceProfileId` – (Required) Inference Profile identifier. +* `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). +* `inferenceProfileId` - (Required) Inference Profile identifier. ## Attribute Reference @@ -69,4 +70,4 @@ This data source exports the following attributes in addition to the arguments a - `modelArn` - The Amazon Resource Name (ARN) of the model. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/bedrock_inference_profiles.html.markdown b/website/docs/cdktf/typescript/d/bedrock_inference_profiles.html.markdown index 0fce6d6be27d..f14f28c76338 100644 --- a/website/docs/cdktf/typescript/d/bedrock_inference_profiles.html.markdown +++ b/website/docs/cdktf/typescript/d/bedrock_inference_profiles.html.markdown @@ -10,7 +10,7 @@ description: |- # Data Source: aws_bedrock_inference_profiles -Terraform data source for managing AWS Bedrock AWS Bedrock Inference Profiles. +Terraform data source for managing AWS Bedrock Inference Profiles. ## Example Usage @@ -34,9 +34,34 @@ class MyConvertedCode extends TerraformStack { ``` +### Filter by Type + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { DataAwsBedrockInferenceProfiles } from "./.gen/providers/aws/data-aws-bedrock-inference-profiles"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + new DataAwsBedrockInferenceProfiles(this, "test", { + type: "APPLICATION", + }); + } +} + +``` + ## Argument Reference -This data source does not support any arguments. +This data source supports the following arguments: + +* `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). +* `type` - (Optional) Filters for inference profiles that match the type you specify. Valid values are: `SYSTEM_DEFINED`, `APPLICATION`. ## Attribute Reference @@ -46,18 +71,18 @@ This data source exports the following attributes in addition to the arguments a ### `inferenceProfileSummaries` -- `createdAt` - The time at which the inference profile was created. -- `description` - The description of the inference profile. -- `inferenceProfileArn` - The Amazon Resource Name (ARN) of the inference profile. -- `inferenceProfileId` - The unique identifier of the inference profile. -- `inferenceProfileName` - The name of the inference profile. -- `models` - A list of information about each model in the inference profile. See [`models`](#models). -- `status` - The status of the inference profile. `ACTIVE` means that the inference profile is available to use. -- `type` - The type of the inference profile. `SYSTEM_DEFINED` means that the inference profile is defined by Amazon Bedrock. -- `updatedAt` - The time at which the inference profile was last updated. +- `createdAt` - Time at which the inference profile was created. +- `description` - Description of the inference profile. +- `inferenceProfileArn` - Amazon Resource Name (ARN) of the inference profile. +- `inferenceProfileId` - Unique identifier of the inference profile. +- `inferenceProfileName` - Name of the inference profile. +- `models` - List of information about each model in the inference profile. See [`models` Block](#models). +- `status` - Status of the inference profile. `ACTIVE` means that the inference profile is available to use. +- `type` - Type of the inference profile. `SYSTEM_DEFINED` means that the inference profile is defined by Amazon Bedrock. `APPLICATION` means the inference profile was created by a user. +- `updatedAt` - Time at which the inference profile was last updated. ### `models` -- `modelArn` - The Amazon Resource Name (ARN) of the model. +- `modelArn` - Amazon Resource Name (ARN) of the model. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/bedrockagent_agent_versions.html.markdown b/website/docs/cdktf/typescript/d/bedrockagent_agent_versions.html.markdown index 6f30b2ecff0d..4db0ef2a46cd 100644 --- a/website/docs/cdktf/typescript/d/bedrockagent_agent_versions.html.markdown +++ b/website/docs/cdktf/typescript/d/bedrockagent_agent_versions.html.markdown @@ -40,6 +40,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `agentId` - (Required) Unique identifier of the agent. ## Attribute Reference @@ -63,4 +64,4 @@ This data source exports the following attributes in addition to the arguments a * `guardrailIdentifier` - Unique identifier of the guardrail. * `guardrailVersion` - Version of the guardrail. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/chatbot_slack_workspace.html.markdown b/website/docs/cdktf/typescript/d/chatbot_slack_workspace.html.markdown index 25a5d5d51663..fb19aacb5bf7 100644 --- a/website/docs/cdktf/typescript/d/chatbot_slack_workspace.html.markdown +++ b/website/docs/cdktf/typescript/d/chatbot_slack_workspace.html.markdown @@ -38,8 +38,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `slackTeamName` - (Required) Slack workspace name configured with AWS Chatbot. ## Attribute Reference @@ -48,4 +49,4 @@ This data source exports the following attributes in addition to the arguments a * `slackTeamId` - ID of the Slack Workspace assigned by AWS Chatbot. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/cloudcontrolapi_resource.html.markdown b/website/docs/cdktf/typescript/d/cloudcontrolapi_resource.html.markdown index 3598f2be19a4..6bc1849d645d 100644 --- a/website/docs/cdktf/typescript/d/cloudcontrolapi_resource.html.markdown +++ b/website/docs/cdktf/typescript/d/cloudcontrolapi_resource.html.markdown @@ -44,6 +44,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `roleArn` - (Optional) ARN of the IAM Role to assume for operations. * `typeVersionId` - (Optional) Identifier of the CloudFormation resource type version. @@ -53,4 +54,4 @@ This data source exports the following attributes in addition to the arguments a * `properties` - JSON string matching the CloudFormation resource type schema with current configuration. Underlying attributes can be referenced via the [`jsondecode()` function](https://www.terraform.io/docs/language/functions/jsondecode.html), for example, `jsondecode(data.aws_cloudcontrolapi_resource.example.properties)["example"]`. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/cloudformation_export.html.markdown b/website/docs/cdktf/typescript/d/cloudformation_export.html.markdown index 368022e7e089..502aa9565de1 100644 --- a/website/docs/cdktf/typescript/d/cloudformation_export.html.markdown +++ b/website/docs/cdktf/typescript/d/cloudformation_export.html.markdown @@ -47,6 +47,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `name` - (Required) Name of the export as it appears in the console or from [list-exports](http://docs.aws.amazon.com/cli/latest/reference/cloudformation/list-exports.html) ## Attribute Reference @@ -56,4 +57,4 @@ This data source exports the following attributes in addition to the arguments a * `value` - Value from Cloudformation export identified by the export name found from [list-exports](http://docs.aws.amazon.com/cli/latest/reference/cloudformation/list-exports.html) * `exportingStackId` - ARN of stack that contains the exported output name and value. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/cloudformation_stack.html.markdown b/website/docs/cdktf/typescript/d/cloudformation_stack.html.markdown index 681e2234629d..f79a9e906615 100644 --- a/website/docs/cdktf/typescript/d/cloudformation_stack.html.markdown +++ b/website/docs/cdktf/typescript/d/cloudformation_stack.html.markdown @@ -50,6 +50,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `name` - (Required) Name of the stack ## Attribute Reference @@ -67,4 +68,4 @@ This data source exports the following attributes in addition to the arguments a * `iamRoleArn` - ARN of the IAM role used to create the stack. * `timeoutInMinutes` - Amount of time that can pass before the stack status becomes `CREATE_FAILED` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/cloudformation_type.html.markdown b/website/docs/cdktf/typescript/d/cloudformation_type.html.markdown index 57414ae27328..917b253e4f7d 100644 --- a/website/docs/cdktf/typescript/d/cloudformation_type.html.markdown +++ b/website/docs/cdktf/typescript/d/cloudformation_type.html.markdown @@ -39,6 +39,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `arn` - (Optional) ARN of the CloudFormation Type. For example, `arn:aws:cloudformation:us-west-2::type/resource/AWS-EC2-VPC`. * `type` - (Optional) CloudFormation Registry Type. For example, `RESOURCE`. * `typeName` - (Optional) CloudFormation Type name. For example, `AWS::EC2::VPC`. @@ -62,4 +63,4 @@ This data source exports the following attributes in addition to the arguments a * `sourceUrl` - URL of the source code for the CloudFormation Type. * `visibility` - Scope of the CloudFormation Type. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/cloudfront_distribution.html.markdown b/website/docs/cdktf/typescript/d/cloudfront_distribution.html.markdown index 107e91d454b9..59ad389cdffb 100644 --- a/website/docs/cdktf/typescript/d/cloudfront_distribution.html.markdown +++ b/website/docs/cdktf/typescript/d/cloudfront_distribution.html.markdown @@ -48,6 +48,8 @@ This data source exports the following attributes in addition to the arguments a * `aliases` - List that contains information about CNAMEs (alternate domain names), if any, for this distribution. +* `anycastIpListId` - ID of the Anycast static IP list that is associated with the distribution, if any. + * `arn` - ARN (Amazon Resource Name) for the distribution. For example: arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5, where 123456789012 is your AWS account ID. * `status` - Current status of the distribution. `Deployed` if the @@ -70,4 +72,4 @@ This data source exports the following attributes in addition to the arguments a alias for the zone ID `Z2FDTNDATAQYW2`. * `webAclId` AWS WAF web ACL associated with this distribution. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/cloudfront_log_delivery_canonical_user_id.html.markdown b/website/docs/cdktf/typescript/d/cloudfront_log_delivery_canonical_user_id.html.markdown index 0f91b4fb5d82..1a8e373a5640 100644 --- a/website/docs/cdktf/typescript/d/cloudfront_log_delivery_canonical_user_id.html.markdown +++ b/website/docs/cdktf/typescript/d/cloudfront_log_delivery_canonical_user_id.html.markdown @@ -84,12 +84,12 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: -* `region` - (Optional) Region you'd like the zone for. By default, fetches the current region. +* `region` - (Optional) Name of the Region whose canonical user ID is desired. Defaults to the Region set in the [provider configuration](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#aws-configuration-reference). ## Attribute Reference This data source exports the following attributes in addition to the arguments above: -* `id` - Canonical user ID for the AWS `awslogsdelivery` account in the region. +* `id` - Canonical user ID for the AWS `awslogsdelivery` account in the Region. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/cloudhsm_v2_cluster.html.markdown b/website/docs/cdktf/typescript/d/cloudhsm_v2_cluster.html.markdown index cfa7bc864015..6f4bba8dd702 100644 --- a/website/docs/cdktf/typescript/d/cloudhsm_v2_cluster.html.markdown +++ b/website/docs/cdktf/typescript/d/cloudhsm_v2_cluster.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `clusterId` - (Required) ID of Cloud HSM v2 cluster. * `clusterState` - (Optional) State of the cluster to be found. @@ -56,4 +57,4 @@ This data source exports the following attributes in addition to the arguments a * `cluster_certificates.0.manufacturer_hardware_certificate` - The HSM hardware certificate issued (signed) by the hardware manufacturer. The number of available cluster certificates may vary depending on state of the cluster. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/cloudtrail_service_account.html.markdown b/website/docs/cdktf/typescript/d/cloudtrail_service_account.html.markdown index edd6a924b973..a16d60b240f2 100644 --- a/website/docs/cdktf/typescript/d/cloudtrail_service_account.html.markdown +++ b/website/docs/cdktf/typescript/d/cloudtrail_service_account.html.markdown @@ -13,7 +13,7 @@ description: |- Use this data source to get the Account ID of the [AWS CloudTrail Service Account](http://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-supported-regions.html) in a given region for the purpose of allowing CloudTrail to store trail data in S3. -~> **Note:** AWS documentation [states that](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/create-s3-bucket-policy-for-cloudtrail.html#troubleshooting-s3-bucket-policy) a [service principal name](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html#principal-services) should be used instead of an AWS account ID in any relevant IAM policy. +~> **Warning:** This data source is deprecated. The AWS documentation [states that](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/create-s3-bucket-policy-for-cloudtrail.html#troubleshooting-s3-bucket-policy) a [service principal name](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html#principal-services) should be used instead of an AWS account ID in any relevant IAM policy. ## Example Usage @@ -90,14 +90,13 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: -* `region` - (Optional) Name of the region whose AWS CloudTrail account ID is desired. -Defaults to the region from the AWS provider configuration. +* `region` - (Optional) Name of the Region whose AWS CloudTrail account ID is desired. Defaults to the Region set in the [provider configuration](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#aws-configuration-reference). ## Attribute Reference This data source exports the following attributes in addition to the arguments above: -* `id` - ID of the AWS CloudTrail service account in the selected region. -* `arn` - ARN of the AWS CloudTrail service account in the selected region. +* `id` - ID of the AWS CloudTrail service account in the selected Region. +* `arn` - ARN of the AWS CloudTrail service account in the selected Region. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/cloudwatch_contributor_managed_insight_rules.html.markdown b/website/docs/cdktf/typescript/d/cloudwatch_contributor_managed_insight_rules.html.markdown index f7579d200cb8..a51f41f689de 100644 --- a/website/docs/cdktf/typescript/d/cloudwatch_contributor_managed_insight_rules.html.markdown +++ b/website/docs/cdktf/typescript/d/cloudwatch_contributor_managed_insight_rules.html.markdown @@ -41,6 +41,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `resourceArn` - (Required) ARN of an Amazon Web Services resource that has managed Contributor Insights rules. ## Attribute Reference @@ -60,4 +61,4 @@ This data source exports the following attributes in addition to the arguments a * `ruleName` - Name of the Contributor Insights rule that contains data for the specified Amazon Web Services resource. * `state` - Indicates whether the rule is enabled or disabled. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/cloudwatch_event_bus.html.markdown b/website/docs/cdktf/typescript/d/cloudwatch_event_bus.html.markdown index 0ab3622eb34f..8d57edbf8ac0 100644 --- a/website/docs/cdktf/typescript/d/cloudwatch_event_bus.html.markdown +++ b/website/docs/cdktf/typescript/d/cloudwatch_event_bus.html.markdown @@ -40,6 +40,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `name` - (Required) Name of the event bus. ## Attribute Reference @@ -52,5 +53,8 @@ This data source exports the following attributes in addition to the arguments a * `description` - Event bus description. * `id` - Name of the event bus. * `kmsKeyIdentifier` - Identifier of the AWS KMS customer managed key for EventBridge to use to encrypt events on this event bus, if one has been specified. +* `logConfig` - Block for logging configuration settings for the event bus. + * `includeDetail` - Whether EventBridge include detailed event information in the records it generates. + * `level` - Level of logging detail to include. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/cloudwatch_event_buses.html.markdown b/website/docs/cdktf/typescript/d/cloudwatch_event_buses.html.markdown index 10c04300b000..657da8f12b50 100644 --- a/website/docs/cdktf/typescript/d/cloudwatch_event_buses.html.markdown +++ b/website/docs/cdktf/typescript/d/cloudwatch_event_buses.html.markdown @@ -40,6 +40,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `namePrefix` - (Optional) Specifying this limits the results to only those event buses with names that start with the specified prefix. ## Attribute Reference @@ -57,4 +58,4 @@ This data source exports the following attributes in addition to the arguments a * `name` - The name of the event bus. * `policy` - The permissions policy of the event bus, describing which other AWS accounts can write events to this event bus. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/cloudwatch_event_connection.html.markdown b/website/docs/cdktf/typescript/d/cloudwatch_event_connection.html.markdown index 6e952667e5e4..014b48b8e90d 100644 --- a/website/docs/cdktf/typescript/d/cloudwatch_event_connection.html.markdown +++ b/website/docs/cdktf/typescript/d/cloudwatch_event_connection.html.markdown @@ -40,6 +40,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `name` - Name of the connection. ## Attribute Reference @@ -51,4 +52,4 @@ This data source exports the following attributes in addition to the arguments a * `kmsKeyIdentifier` - (Optional) Identifier of the AWS KMS customer managed key for EventBridge to use to encrypt the connection, if one has been specified. * `secretArn` - ARN of the secret created from the authorization parameters specified for the connection. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/cloudwatch_event_source.html.markdown b/website/docs/cdktf/typescript/d/cloudwatch_event_source.html.markdown index 4309cf9a7d34..29b9c2062aa9 100644 --- a/website/docs/cdktf/typescript/d/cloudwatch_event_source.html.markdown +++ b/website/docs/cdktf/typescript/d/cloudwatch_event_source.html.markdown @@ -40,6 +40,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `namePrefix` - (Optional) Specifying this limits the results to only those partner event sources with names that start with the specified prefix ## Attribute Reference @@ -51,4 +52,4 @@ This data source exports the following attributes in addition to the arguments a * `name` - Name of the event source * `state` - State of the event source (`ACTIVE` or `PENDING`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/cloudwatch_log_group.html.markdown b/website/docs/cdktf/typescript/d/cloudwatch_log_group.html.markdown index 10d3756e9597..5c10fdd97413 100644 --- a/website/docs/cdktf/typescript/d/cloudwatch_log_group.html.markdown +++ b/website/docs/cdktf/typescript/d/cloudwatch_log_group.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `name` - (Required) Name of the Cloudwatch log group ## Attribute Reference @@ -51,4 +52,4 @@ This data source exports the following attributes in addition to the arguments a * `retentionInDays` - Number of days log events retained in the specified log group. * `tags` - Map of tags to assign to the resource. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/cloudwatch_log_groups.html.markdown b/website/docs/cdktf/typescript/d/cloudwatch_log_groups.html.markdown index e6d08641f307..ab878c76d0e8 100644 --- a/website/docs/cdktf/typescript/d/cloudwatch_log_groups.html.markdown +++ b/website/docs/cdktf/typescript/d/cloudwatch_log_groups.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `logGroupNamePrefix` - (Optional) Group prefix of the Cloudwatch log groups to list ## Attribute Reference @@ -47,4 +48,4 @@ This data source exports the following attributes in addition to the arguments a * `arns` - Set of ARNs of the Cloudwatch log groups * `logGroupNames` - Set of names of the Cloudwatch log groups - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/codeartifact_authorization_token.html.markdown b/website/docs/cdktf/typescript/d/codeartifact_authorization_token.html.markdown index e253ce0ab604..35f242aec1d3 100644 --- a/website/docs/cdktf/typescript/d/codeartifact_authorization_token.html.markdown +++ b/website/docs/cdktf/typescript/d/codeartifact_authorization_token.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `domain` - (Required) Name of the domain that is in scope for the generated authorization token. * `domainOwner` - (Optional) Account number of the AWS account that owns the domain. * `durationSeconds` - (Optional) Time, in seconds, that the generated authorization token is valid. Valid values are `0` and between `900` and `43200`. @@ -49,4 +50,4 @@ This data source exports the following attributes in addition to the arguments a * `authorizationToken` - Temporary authorization token. * `expiration` - Time in UTC RFC3339 format when the authorization token expires. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/codeartifact_repository_endpoint.html.markdown b/website/docs/cdktf/typescript/d/codeartifact_repository_endpoint.html.markdown index ac7d17c10d26..97e7693e7944 100644 --- a/website/docs/cdktf/typescript/d/codeartifact_repository_endpoint.html.markdown +++ b/website/docs/cdktf/typescript/d/codeartifact_repository_endpoint.html.markdown @@ -40,6 +40,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `domain` - (Required) Name of the domain that contains the repository. * `repository` - (Required) Name of the repository. * `format` - (Required) Which endpoint of a repository to return. A repository has one endpoint for each package format: `npm`, `pypi`, `maven`, and `nuget`. @@ -51,4 +52,4 @@ This data source exports the following attributes in addition to the arguments a * `repositoryEndpoint` - URL of the returned endpoint. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/codebuild_fleet.html.markdown b/website/docs/cdktf/typescript/d/codebuild_fleet.html.markdown index 9df3c6125a17..349fc8d82fcc 100644 --- a/website/docs/cdktf/typescript/d/codebuild_fleet.html.markdown +++ b/website/docs/cdktf/typescript/d/codebuild_fleet.html.markdown @@ -82,8 +82,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `name` - (Required) Fleet name. ## Attribute Reference @@ -92,9 +93,10 @@ This data source exports the following attributes in addition to the arguments a * `arn` - ARN of the Fleet. * `baseCapacity` - Number of machines allocated to the fleet. -* `compute_configuration` - Compute configuration of the compute fleet. +* `computeConfiguration` - Compute configuration of the compute fleet. * `disk` - Amount of disk space of the instance type included in the fleet. - * `machine_type` - Machine type of the instance type included in the fleet. + * `instanceType` - EC2 instance type in the fleet. + * `machineType` - Machine type of the instance type included in the fleet. * `memory` - Amount of memory of the instance type included in the fleet. * `vcpu` - Number of vCPUs of the instance type included in the fleet. * `computeType` - Compute resources the compute fleet uses. @@ -122,4 +124,4 @@ This data source exports the following attributes in addition to the arguments a * `subnets` - A list of one or more subnet IDs in your Amazon VPC. * `vpcId` - The ID of the Amazon VPC. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/codecatalyst_dev_environment.html.markdown b/website/docs/cdktf/typescript/d/codecatalyst_dev_environment.html.markdown index da687dfcbfb6..c650180f712f 100644 --- a/website/docs/cdktf/typescript/d/codecatalyst_dev_environment.html.markdown +++ b/website/docs/cdktf/typescript/d/codecatalyst_dev_environment.html.markdown @@ -39,8 +39,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `envId` - - (Required) The system-generated unique ID of the Dev Environment for which you want to view information. To retrieve a list of Dev Environment IDs, use [ListDevEnvironments](https://docs.aws.amazon.com/codecatalyst/latest/APIReference/API_ListDevEnvironments.html). * `projectName` - (Required) The name of the project in the space. * `spaceName` - (Required) The name of the space. @@ -60,4 +61,4 @@ This data source exports the following attributes in addition to the arguments a * `status` - The current status of the Dev Environment. From: PENDING | RUNNING | STARTING | STOPPING | STOPPED | FAILED | DELETING | DELETED. * `statusReason` - The reason for the status. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/codecommit_approval_rule_template.html.markdown b/website/docs/cdktf/typescript/d/codecommit_approval_rule_template.html.markdown index b1f9586ededa..b24f4affbdf9 100644 --- a/website/docs/cdktf/typescript/d/codecommit_approval_rule_template.html.markdown +++ b/website/docs/cdktf/typescript/d/codecommit_approval_rule_template.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `name` - (Required) Name for the approval rule template. This needs to be less than 100 characters. ## Attribute Reference @@ -52,4 +53,4 @@ This data source exports the following attributes in addition to the arguments a * `lastModifiedUser` - ARN of the user who made the most recent changes to the approval rule template. * `ruleContentSha256` - SHA-256 hash signature for the content of the approval rule template. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/codecommit_repository.html.markdown b/website/docs/cdktf/typescript/d/codecommit_repository.html.markdown index fb68c5832e89..214fd757de00 100644 --- a/website/docs/cdktf/typescript/d/codecommit_repository.html.markdown +++ b/website/docs/cdktf/typescript/d/codecommit_repository.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `repositoryName` - (Required) Name for the repository. This needs to be less than 100 characters. ## Attribute Reference @@ -50,4 +51,4 @@ This data source exports the following attributes in addition to the arguments a * `cloneUrlHttp` - URL to use for cloning the repository over HTTPS. * `cloneUrlSsh` - URL to use for cloning the repository over SSH. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/codeguruprofiler_profiling_group.html.markdown b/website/docs/cdktf/typescript/d/codeguruprofiler_profiling_group.html.markdown index 5620caacf2bd..ec6d9d448c7f 100644 --- a/website/docs/cdktf/typescript/d/codeguruprofiler_profiling_group.html.markdown +++ b/website/docs/cdktf/typescript/d/codeguruprofiler_profiling_group.html.markdown @@ -38,8 +38,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `name` - (Required) The name of the profiling group. ## Attribute Reference @@ -54,4 +55,4 @@ This data source exports the following attributes in addition to the arguments a * `tags` - Mapping of Key-Value tags for the resource. * `updatedAt` - Timestamp when Profiling Group was updated. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/codestarconnections_connection.html.markdown b/website/docs/cdktf/typescript/d/codestarconnections_connection.html.markdown index 4243e9cdb946..a2de9d70d3fb 100644 --- a/website/docs/cdktf/typescript/d/codestarconnections_connection.html.markdown +++ b/website/docs/cdktf/typescript/d/codestarconnections_connection.html.markdown @@ -62,6 +62,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `arn` - (Optional) CodeStar Connection ARN. * `name` - (Optional) CodeStar Connection name. @@ -78,4 +79,4 @@ This data source exports the following attributes in addition to the arguments a * `providerType` - Name of the external provider where your third-party code repository is configured. Possible values are `Bitbucket`, `GitHub` and `GitLab`. For connections to GitHub Enterprise Server or GitLab Self-Managed instances, you must create an [aws_codestarconnections_host](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/codestarconnections_host) resource and use `hostArn` instead. * `tags` - Map of key-value resource tags to associate with the resource. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/cognito_identity_pool.html.markdown b/website/docs/cdktf/typescript/d/cognito_identity_pool.html.markdown index e2376f38ad58..f6a333f61d5c 100644 --- a/website/docs/cdktf/typescript/d/cognito_identity_pool.html.markdown +++ b/website/docs/cdktf/typescript/d/cognito_identity_pool.html.markdown @@ -40,6 +40,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `identityPoolName` - (Required) The Cognito Identity Pool name. ## Attribute Reference @@ -57,4 +58,4 @@ This data source exports the following attributes in addition to the arguments a * `supportedLoginProviders` - Key-Value pairs mapping provider names to provider app IDs. * `tags` - A map of tags to assigned to the Identity Pool. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/cognito_user_group.html.markdown b/website/docs/cdktf/typescript/d/cognito_user_group.html.markdown index dd04abce69bd..fa007d668f49 100644 --- a/website/docs/cdktf/typescript/d/cognito_user_group.html.markdown +++ b/website/docs/cdktf/typescript/d/cognito_user_group.html.markdown @@ -41,6 +41,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `name` - (Required) Name of the user group. * `userPoolId` - (Required) User pool the client belongs to. @@ -53,4 +54,4 @@ This data source exports the following attributes in addition to the arguments a * `precedence` - Precedence of the user group. * `roleArn` - ARN of the IAM role to be associated with the user group. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/cognito_user_groups.html.markdown b/website/docs/cdktf/typescript/d/cognito_user_groups.html.markdown index 9661e71dd229..cdfcd86c7671 100644 --- a/website/docs/cdktf/typescript/d/cognito_user_groups.html.markdown +++ b/website/docs/cdktf/typescript/d/cognito_user_groups.html.markdown @@ -40,6 +40,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `userPoolId` - (Required) User pool the client belongs to. ## Attribute Reference @@ -56,4 +57,4 @@ This data source exports the following attributes in addition to the arguments a * `precedence` - Precedence of the user group. * `roleArn` - ARN of the IAM role to be associated with the user group. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/cognito_user_pool.html.markdown b/website/docs/cdktf/typescript/d/cognito_user_pool.html.markdown index c0f465c4a7bf..91718f1e55a8 100644 --- a/website/docs/cdktf/typescript/d/cognito_user_pool.html.markdown +++ b/website/docs/cdktf/typescript/d/cognito_user_pool.html.markdown @@ -40,6 +40,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `userPoolId` - (Required) The cognito pool ID ## Attribute Reference @@ -137,11 +138,11 @@ This data source exports the following attributes in addition to the arguments a ### user pool add-ons -* `advanced_security_additional_flows` - A block of the threat protection configuration options for additional authentication types in your user pool, including custom authentication. [Detailed below](#advanced-security-additional-flows). +* `advancedSecurityAdditionalFlows` - A block of the threat protection configuration options for additional authentication types in your user pool, including custom authentication. [Detailed below](#advanced-security-additional-flows). * `advancedSecurityMode` - Mode for advanced security. ### advanced security additional flows -* `custom_auth_mode` - Mode of threat protection operation in custom authentication. +* `customAuthMode` - Mode of threat protection operation in custom authentication. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/cognito_user_pool_client.html.markdown b/website/docs/cdktf/typescript/d/cognito_user_pool_client.html.markdown index c3f1f8bfaabd..47585437f309 100644 --- a/website/docs/cdktf/typescript/d/cognito_user_pool_client.html.markdown +++ b/website/docs/cdktf/typescript/d/cognito_user_pool_client.html.markdown @@ -39,6 +39,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `clientId` - (Required) Client Id of the user pool. * `userPoolId` - (Required) User pool the client belongs to. @@ -61,7 +62,7 @@ This data source exports the following attributes in addition to the arguments a * `logoutUrls` - (Optional) List of allowed logout URLs for the identity providers. * `preventUserExistenceErrors` - (Optional) Choose which errors and responses are returned by Cognito APIs during authentication, account confirmation, and password recovery when the user does not exist in the user pool. When set to `ENABLED` and the user does not exist, authentication returns an error indicating either the username or password was incorrect, and account confirmation and password recovery return a response indicating a code was sent to a simulated destination. When set to `LEGACY`, those APIs will return a `UserNotFoundException` exception if the user does not exist in the user pool. * `readAttributes` - (Optional) List of user pool attributes the application client can read from. -* `refresh_token_rotation` - (Optional) A block that specifies the configuration of refresh token rotation. [Detailed below](#refresh_token_rotation). +* `refreshTokenRotation` - (Optional) A block that specifies the configuration of refresh token rotation. [Detailed below](#refresh_token_rotation). * `refreshTokenValidity` - (Optional) Time limit in days refresh tokens are valid for. * `supportedIdentityProviders` - (Optional) List of provider names for the identity providers that are supported on this client. Uses the `providerName` attribute of `aws_cognito_identity_provider` resource(s), or the equivalent string(s). * `tokenValidityUnits` - (Optional) Configuration block for units in which the validity times are represented in. [Detailed below](#token_validity_units). @@ -80,7 +81,7 @@ Either `applicationArn` or `applicationId` is required. ### refresh_token_rotation * `feature` - (Required) The state of refresh token rotation for the current app client. Valid values are `ENABLED` or `DISABLED`. -* `retry_grace_period_seconds` - (Optional) A period of time in seconds that the user has to use the old refresh token before it is invalidated. Valid values are between `0` and `60`. +* `retryGracePeriodSeconds` - (Optional) A period of time in seconds that the user has to use the old refresh token before it is invalidated. Valid values are between `0` and `60`. ### token_validity_units @@ -90,4 +91,4 @@ Valid values for the following arguments are: `seconds`, `minutes`, `hours` or ` * `idToken` - (Optional) Time unit in for the value in `idTokenValidity`, defaults to `hours`. * `refreshToken` - (Optional) Time unit in for the value in `refreshTokenValidity`, defaults to `days`. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/cognito_user_pool_clients.html.markdown b/website/docs/cdktf/typescript/d/cognito_user_pool_clients.html.markdown index f18cdb4e081f..815273aa428a 100644 --- a/website/docs/cdktf/typescript/d/cognito_user_pool_clients.html.markdown +++ b/website/docs/cdktf/typescript/d/cognito_user_pool_clients.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `userPoolId` - (Required) Cognito user pool ID. ## Attribute Reference @@ -47,4 +48,4 @@ This data source exports the following attributes in addition to the arguments a * `clientIds` - List of Cognito user pool client IDs. * `clientNames` - List of Cognito user pool client names. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/cognito_user_pool_signing_certificate.html.markdown b/website/docs/cdktf/typescript/d/cognito_user_pool_signing_certificate.html.markdown index 5ca148e3827b..861317adf028 100644 --- a/website/docs/cdktf/typescript/d/cognito_user_pool_signing_certificate.html.markdown +++ b/website/docs/cdktf/typescript/d/cognito_user_pool_signing_certificate.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `userPoolId` - (Required) Cognito user pool ID. ## Attribute Reference @@ -46,4 +47,4 @@ This data source exports the following attributes in addition to the arguments a * `certificate` - Certificate string - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/cognito_user_pools.html.markdown b/website/docs/cdktf/typescript/d/cognito_user_pools.html.markdown index f96917e5469b..61a7e5d8fb60 100644 --- a/website/docs/cdktf/typescript/d/cognito_user_pools.html.markdown +++ b/website/docs/cdktf/typescript/d/cognito_user_pools.html.markdown @@ -55,6 +55,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `name` - (Required) Name of the cognito user pools. Name is not a unique attribute for cognito user pool, so multiple pools might be returned with given name. If the pool name is expected to be unique, you can reference the pool id via ```tolist(data.aws_cognito_user_pools.selected.ids)[0]``` ## Attribute Reference @@ -64,4 +65,4 @@ This data source exports the following attributes in addition to the arguments a * `ids` - Set of cognito user pool ids. * `arns` - Set of cognito user pool Amazon Resource Names (ARNs). - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/connect_bot_association.html.markdown b/website/docs/cdktf/typescript/d/connect_bot_association.html.markdown index 99ad36f90a8c..467a5e8416b3 100644 --- a/website/docs/cdktf/typescript/d/connect_bot_association.html.markdown +++ b/website/docs/cdktf/typescript/d/connect_bot_association.html.markdown @@ -43,6 +43,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `instanceId` - (Required) Identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance. * `lexBot` - (Required) Configuration information of an Amazon Lex (V1) bot. Detailed below. @@ -57,4 +58,4 @@ The `lexBot` configuration block supports the following: This data source exports no additional attributes. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/connect_contact_flow.html.markdown b/website/docs/cdktf/typescript/d/connect_contact_flow.html.markdown index 6b0c54221406..e7a3a4f0bd21 100644 --- a/website/docs/cdktf/typescript/d/connect_contact_flow.html.markdown +++ b/website/docs/cdktf/typescript/d/connect_contact_flow.html.markdown @@ -64,6 +64,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `contactFlowId` - (Optional) Returns information on a specific Contact Flow by contact flow id * `instanceId` - (Required) Reference to the hosting Amazon Connect Instance * `name` - (Optional) Returns information on a specific Contact Flow by name @@ -80,4 +81,4 @@ This data source exports the following attributes in addition to the arguments a * `tags` - Tags to assign to the Contact Flow. * `type` - Type of Contact Flow. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/connect_contact_flow_module.html.markdown b/website/docs/cdktf/typescript/d/connect_contact_flow_module.html.markdown index 5223e72ab959..2e957c74b498 100644 --- a/website/docs/cdktf/typescript/d/connect_contact_flow_module.html.markdown +++ b/website/docs/cdktf/typescript/d/connect_contact_flow_module.html.markdown @@ -64,6 +64,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `contactFlowModuleId` - (Optional) Returns information on a specific Contact Flow Module by contact flow module id * `instanceId` - (Required) Reference to the hosting Amazon Connect Instance * `name` - (Optional) Returns information on a specific Contact Flow Module by name @@ -81,4 +82,4 @@ This data source exports the following attributes in addition to the arguments a * `state` - Type of Contact Flow Module Module. Values are either `ACTIVE` or `ARCHIVED`. * `status` - Status of the Contact Flow Module Module. Values are either `PUBLISHED` or `SAVED`. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/connect_hours_of_operation.html.markdown b/website/docs/cdktf/typescript/d/connect_hours_of_operation.html.markdown index bc099ba80a5a..f924a7e26d27 100644 --- a/website/docs/cdktf/typescript/d/connect_hours_of_operation.html.markdown +++ b/website/docs/cdktf/typescript/d/connect_hours_of_operation.html.markdown @@ -64,6 +64,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `hoursOfOperationId` - (Optional) Returns information on a specific Hours of Operation by hours of operation id * `instanceId` - (Required) Reference to the hosting Amazon Connect Instance * `name` - (Optional) Returns information on a specific Hours of Operation by name @@ -99,4 +100,4 @@ A `startTime` block supports the following arguments: * `hours` - Hour of opening. * `minutes` - Minute of opening. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/connect_instance.html.markdown b/website/docs/cdktf/typescript/d/connect_instance.html.markdown index 0e3d5462d191..0a806be3555d 100644 --- a/website/docs/cdktf/typescript/d/connect_instance.html.markdown +++ b/website/docs/cdktf/typescript/d/connect_instance.html.markdown @@ -62,6 +62,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `instanceId` - (Optional) Returns information on a specific connect instance by id * `instanceAlias` - (Optional) Returns information on a specific connect instance by alias @@ -86,4 +87,4 @@ This data source exports the following attributes in addition to the arguments a * `serviceRole` - Service role of the instance. * `tags` - A map of tags to assigned to the instance. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/connect_instance_storage_config.html.markdown b/website/docs/cdktf/typescript/d/connect_instance_storage_config.html.markdown index 955461b96e2d..f79eef26e2ce 100644 --- a/website/docs/cdktf/typescript/d/connect_instance_storage_config.html.markdown +++ b/website/docs/cdktf/typescript/d/connect_instance_storage_config.html.markdown @@ -41,6 +41,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `associationId` - (Required) The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID. * `instanceId` - (Required) Reference to the hosting Amazon Connect Instance * `resourceType` - (Required) A valid resource type. Valid Values: `AGENT_EVENTS` | `ATTACHMENTS` | `CALL_RECORDINGS` | `CHAT_TRANSCRIPTS` | `CONTACT_EVALUATIONS` | `CONTACT_TRACE_RECORDS` | `MEDIA_STREAMS` | `REAL_TIME_CONTACT_ANALYSIS_SEGMENTS` | `SCHEDULED_REPORTS` | `SCREEN_RECORDINGS`. @@ -97,4 +98,4 @@ The `encryptionConfig` configuration block supports the following arguments: * `encryptionType` - The type of encryption. Valid Values: `KMS`. * `keyId` - The full ARN of the encryption key. Be sure to provide the full ARN of the encryption key, not just the ID. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/connect_lambda_function_association.html.markdown b/website/docs/cdktf/typescript/d/connect_lambda_function_association.html.markdown index 6d84e1d89cbe..ad5d7ee5ef1e 100644 --- a/website/docs/cdktf/typescript/d/connect_lambda_function_association.html.markdown +++ b/website/docs/cdktf/typescript/d/connect_lambda_function_association.html.markdown @@ -39,6 +39,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `functionArn` - (Required) ARN of the Lambda Function, omitting any version or alias qualifier. * `instanceId` - (Required) Identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance. @@ -48,4 +49,4 @@ This data source exports the following attributes in addition to the arguments a * `id` - AWS Region. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/connect_prompt.html.markdown b/website/docs/cdktf/typescript/d/connect_prompt.html.markdown index cd4b88b53702..fbe88043d9a9 100644 --- a/website/docs/cdktf/typescript/d/connect_prompt.html.markdown +++ b/website/docs/cdktf/typescript/d/connect_prompt.html.markdown @@ -41,6 +41,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `instanceId` - (Required) Reference to the hosting Amazon Connect Instance * `name` - (Required) Returns information on a specific Prompt by name @@ -51,4 +52,4 @@ This data source exports the following attributes in addition to the arguments a * `arn` - ARN of the Prompt. * `promptId` - Identifier for the prompt. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/connect_queue.html.markdown b/website/docs/cdktf/typescript/d/connect_queue.html.markdown index ccc505981d59..592b812d7bdc 100644 --- a/website/docs/cdktf/typescript/d/connect_queue.html.markdown +++ b/website/docs/cdktf/typescript/d/connect_queue.html.markdown @@ -64,6 +64,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `queueId` - (Optional) Returns information on a specific Queue by Queue id * `instanceId` - (Required) Reference to the hosting Amazon Connect Instance * `name` - (Optional) Returns information on a specific Queue by name @@ -90,4 +91,4 @@ A `outboundCallerConfig` block supports the following arguments: * `outboundCallerIdNumberId` - Specifies the caller ID number. * `outboundFlowId` - Outbound whisper flow to be used during an outbound call. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/connect_quick_connect.html.markdown b/website/docs/cdktf/typescript/d/connect_quick_connect.html.markdown index 32bd487ea8ab..cee116cab2fd 100644 --- a/website/docs/cdktf/typescript/d/connect_quick_connect.html.markdown +++ b/website/docs/cdktf/typescript/d/connect_quick_connect.html.markdown @@ -64,6 +64,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `quickConnectId` - (Optional) Returns information on a specific Quick Connect by Quick Connect id * `instanceId` - (Required) Reference to the hosting Amazon Connect Instance * `name` - (Optional) Returns information on a specific Quick Connect by name @@ -102,4 +103,4 @@ A `userConfig` block contains the following arguments: * `contactFlowId` - Identifier of the contact flow. * `userId` - Identifier for the user. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/connect_routing_profile.html.markdown b/website/docs/cdktf/typescript/d/connect_routing_profile.html.markdown index 29c8a5ba3d26..bb7e1a9e5c9c 100644 --- a/website/docs/cdktf/typescript/d/connect_routing_profile.html.markdown +++ b/website/docs/cdktf/typescript/d/connect_routing_profile.html.markdown @@ -64,6 +64,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `instanceId` - Reference to the hosting Amazon Connect Instance * `name` - (Optional) Returns information on a specific Routing Profile by name * `routingProfileId` - (Optional) Returns information on a specific Routing Profile by Routing Profile id @@ -96,4 +97,4 @@ A `queueConfigs` block supports the following attributes: * `queueId` - Identifier for the queue. * `queueName` - Name for the queue. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/connect_security_profile.html.markdown b/website/docs/cdktf/typescript/d/connect_security_profile.html.markdown index 8fe60267e595..1ecc4a2b18a5 100644 --- a/website/docs/cdktf/typescript/d/connect_security_profile.html.markdown +++ b/website/docs/cdktf/typescript/d/connect_security_profile.html.markdown @@ -64,6 +64,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `securityProfileId` - (Optional) Returns information on a specific Security Profile by Security Profile id * `instanceId` - (Required) Reference to the hosting Amazon Connect Instance * `name` - (Optional) Returns information on a specific Security Profile by name @@ -81,4 +82,4 @@ This data source exports the following attributes in addition to the arguments a * `permissions` - List of permissions assigned to the security profile. * `tags` - Map of tags to assign to the Security Profile. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/connect_user.html.markdown b/website/docs/cdktf/typescript/d/connect_user.html.markdown index 9939ed7d08d6..613d4c9d0b2a 100644 --- a/website/docs/cdktf/typescript/d/connect_user.html.markdown +++ b/website/docs/cdktf/typescript/d/connect_user.html.markdown @@ -64,6 +64,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `instanceId` - (Required) Reference to the hosting Amazon Connect Instance * `name` - (Optional) Returns information on a specific User by name * `userId` - (Optional) Returns information on a specific User by User id @@ -103,4 +104,4 @@ A `phoneConfig` block supports the following attributes: * `deskPhoneNumber` - The phone number for the user's desk phone. * `phoneType` - The phone type. Valid values are `DESK_PHONE` and `SOFT_PHONE`. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/connect_user_hierarchy_group.html.markdown b/website/docs/cdktf/typescript/d/connect_user_hierarchy_group.html.markdown index 1a1d39ba208f..bdd441bc9e92 100644 --- a/website/docs/cdktf/typescript/d/connect_user_hierarchy_group.html.markdown +++ b/website/docs/cdktf/typescript/d/connect_user_hierarchy_group.html.markdown @@ -64,6 +64,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `hierarchyGroupId` - (Optional) Returns information on a specific hierarchy group by hierarchy group id * `instanceId` - (Required) Reference to the hosting Amazon Connect Instance * `name` - (Optional) Returns information on a specific hierarchy group by name @@ -94,4 +95,4 @@ A level block supports the following attributes: * `id` - The identifier of the hierarchy group. * `name` - Name of the hierarchy group. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/connect_user_hierarchy_structure.html.markdown b/website/docs/cdktf/typescript/d/connect_user_hierarchy_structure.html.markdown index 28bc6d27b58f..30581100ccc5 100644 --- a/website/docs/cdktf/typescript/d/connect_user_hierarchy_structure.html.markdown +++ b/website/docs/cdktf/typescript/d/connect_user_hierarchy_structure.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `instanceId` - (Required) Reference to the hosting Amazon Connect Instance ## Attribute Reference @@ -60,4 +61,4 @@ Each level block supports the following attributes: * `id` - The identifier of the hierarchy level. * `name` - Name of the user hierarchy level. Must not be more than 50 characters. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/connect_vocabulary.html.markdown b/website/docs/cdktf/typescript/d/connect_vocabulary.html.markdown index 6ec1d9971112..97fa3557a47a 100644 --- a/website/docs/cdktf/typescript/d/connect_vocabulary.html.markdown +++ b/website/docs/cdktf/typescript/d/connect_vocabulary.html.markdown @@ -64,6 +64,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `instanceId` - (Required) Reference to the hosting Amazon Connect Instance * `name` - (Optional) Returns information on a specific Vocabulary by name * `vocabularyId` - (Optional) Returns information on a specific Vocabulary by Vocabulary id @@ -85,4 +86,4 @@ separated by a colon (`:`). * `tags` - A map of tags to assign to the Vocabulary. * `vocabularyId` - The identifier of the custom vocabulary. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/controltower_controls.html.markdown b/website/docs/cdktf/typescript/d/controltower_controls.html.markdown index bd0e74f8118c..0db6c39efe3d 100644 --- a/website/docs/cdktf/typescript/d/controltower_controls.html.markdown +++ b/website/docs/cdktf/typescript/d/controltower_controls.html.markdown @@ -58,8 +58,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `targetIdentifier` - (Required) The ARN of the organizational unit. ## Attribute Reference @@ -68,4 +69,4 @@ This data source exports the following attributes in addition to the arguments a * `enabledControls` - List of all the ARNs for the controls applied to the `targetIdentifier`. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/customer_gateway.html.markdown b/website/docs/cdktf/typescript/d/customer_gateway.html.markdown index c9b0549d80e1..ded13d1b8237 100644 --- a/website/docs/cdktf/typescript/d/customer_gateway.html.markdown +++ b/website/docs/cdktf/typescript/d/customer_gateway.html.markdown @@ -55,6 +55,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `id` - (Optional) ID of the gateway. * `filter` - (Optional) One or more [name-value pairs][dcg-filters] to filter by. @@ -79,4 +80,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/datapipeline_pipeline.html.markdown b/website/docs/cdktf/typescript/d/datapipeline_pipeline.html.markdown index 945f385d76a2..667f2f4c500c 100644 --- a/website/docs/cdktf/typescript/d/datapipeline_pipeline.html.markdown +++ b/website/docs/cdktf/typescript/d/datapipeline_pipeline.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `pipelineId` - (Required) ID of the pipeline. ## Attribute Reference @@ -48,4 +49,4 @@ This data source exports the following attributes in addition to the arguments a * `description` - Description of Pipeline. * `tags` - Map of tags assigned to the resource. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/datapipeline_pipeline_definition.html.markdown b/website/docs/cdktf/typescript/d/datapipeline_pipeline_definition.html.markdown index e88255b9772b..4aa941e73074 100644 --- a/website/docs/cdktf/typescript/d/datapipeline_pipeline_definition.html.markdown +++ b/website/docs/cdktf/typescript/d/datapipeline_pipeline_definition.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `pipelineId` - (Required) ID of the pipeline. ## Attribute Reference @@ -75,4 +76,4 @@ This data source exports the following attributes in addition to the arguments a * `refValue` - Field value, expressed as the identifier of another object * `stringValue` - Field value, expressed as a String. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/datazone_domain.html.markdown b/website/docs/cdktf/typescript/d/datazone_domain.html.markdown index 6155143e07bc..22752736d93d 100644 --- a/website/docs/cdktf/typescript/d/datazone_domain.html.markdown +++ b/website/docs/cdktf/typescript/d/datazone_domain.html.markdown @@ -40,6 +40,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `name` - (Optional) Name of the Domain. One of `name` or `id` is required. * `id` - (Optional) ID of the Domain. One of `name` or `id` is required @@ -56,4 +57,4 @@ This data source exports the following attributes in addition to the arguments a * `portalUrl` - URL of the Domain. * `status` - Status of the Domain. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/datazone_environment_blueprint.html.markdown b/website/docs/cdktf/typescript/d/datazone_environment_blueprint.html.markdown index b8f3bc25c873..581a0e90ebc5 100644 --- a/website/docs/cdktf/typescript/d/datazone_environment_blueprint.html.markdown +++ b/website/docs/cdktf/typescript/d/datazone_environment_blueprint.html.markdown @@ -48,8 +48,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `domainId` - (Required) ID of the domain. * `name` - (Required) Name of the blueprint. * `managed` (Required) Whether the blueprint is managed by Amazon DataZone. @@ -62,4 +63,4 @@ This data source exports the following attributes in addition to the arguments a * `description` - Description of the blueprint * `blueprintProvider` - Provider of the blueprint - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/db_cluster_snapshot.html.markdown b/website/docs/cdktf/typescript/d/db_cluster_snapshot.html.markdown index 680c38053ff5..996e8c5985c6 100644 --- a/website/docs/cdktf/typescript/d/db_cluster_snapshot.html.markdown +++ b/website/docs/cdktf/typescript/d/db_cluster_snapshot.html.markdown @@ -73,6 +73,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `mostRecent` - (Optional) If more than one result is returned, use the most recent Snapshot. * `dbClusterIdentifier` - (Optional) Returns the list of snapshots created by the specific db_cluster * `dbClusterSnapshotIdentifier` - (Optional) Returns information on a specific snapshot_id. @@ -102,10 +103,10 @@ This data source exports the following attributes in addition to the arguments a * `licenseModel` - License model information for the restored DB cluster. * `port` - Port that the DB cluster was listening on at the time of the snapshot. * `snapshotCreateTime` - Time when the snapshot was taken, in Universal Coordinated Time (UTC). -* `source_db_cluster_snapshot_identifier` - DB Cluster Snapshot ARN that the DB Cluster Snapshot was copied from. It only has value in case of cross customer or cross region copy. +* `sourceDbClusterSnapshotIdentifier` - DB Cluster Snapshot ARN that the DB Cluster Snapshot was copied from. It only has value in case of cross customer or cross region copy. * `status` - Status of this DB Cluster Snapshot. * `storageEncrypted` - Whether the DB cluster snapshot is encrypted. * `vpcId` - VPC ID associated with the DB cluster snapshot. * `tags` - Map of tags for the resource. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/db_event_categories.html.markdown b/website/docs/cdktf/typescript/d/db_event_categories.html.markdown index 6aff4dcb625d..f57bf78bf385 100644 --- a/website/docs/cdktf/typescript/d/db_event_categories.html.markdown +++ b/website/docs/cdktf/typescript/d/db_event_categories.html.markdown @@ -68,6 +68,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `sourceType` - (Optional) Type of source that will be generating the events. Valid options are db-instance, db-security-group, db-parameter-group, db-snapshot, db-cluster or db-cluster-snapshot. ## Attribute Reference @@ -77,4 +78,4 @@ This data source exports the following attributes in addition to the arguments a * `eventCategories` - List of the event categories. * `id` - Region of the event categories. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/db_instance.html.markdown b/website/docs/cdktf/typescript/d/db_instance.html.markdown index cb60f9b966a7..961e7d1659c5 100644 --- a/website/docs/cdktf/typescript/d/db_instance.html.markdown +++ b/website/docs/cdktf/typescript/d/db_instance.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `dbInstanceIdentifier` - (Optional) Name of the RDS instance. * `tags` - (Optional) Map of tags, each pair of which must exactly match a pair on the desired instance. @@ -97,4 +98,4 @@ The `masterUserSecret` configuration block supports the following attributes: * `secretArn` - The Amazon Resource Name (ARN) of the secret. * `secret_status` - The status of the secret. Valid Values: `creating` | `active` | `rotating` | `impaired`. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/db_instances.html.markdown b/website/docs/cdktf/typescript/d/db_instances.html.markdown index ab96d605982c..d255cbbac4c3 100644 --- a/website/docs/cdktf/typescript/d/db_instances.html.markdown +++ b/website/docs/cdktf/typescript/d/db_instances.html.markdown @@ -69,6 +69,7 @@ class MyConvertedCode extends TerraformStack { The following arguments are optional: +* `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). * `filter` - (Optional) Configuration block(s) used to filter instances with AWS supported attributes, such as `engine`, `db-cluster-id` or `db-instance-id` for example. Detailed below. * `tags` - (Optional) Map of tags, each pair of which must exactly match a pair on the desired instances. @@ -86,4 +87,4 @@ This data source exports the following attributes in addition to the arguments a * `instanceArns` - ARNs of the matched RDS instances. * `instanceIdentifiers` - Identifiers of the matched RDS instances. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/db_parameter_group.html.markdown b/website/docs/cdktf/typescript/d/db_parameter_group.html.markdown new file mode 100644 index 000000000000..03e78ff4e96e --- /dev/null +++ b/website/docs/cdktf/typescript/d/db_parameter_group.html.markdown @@ -0,0 +1,52 @@ +--- +subcategory: "RDS (Relational Database)" +layout: "aws" +page_title: "AWS: aws_db_parameter_group" +description: |- + Information about a database parameter group. +--- + + + +# Data Source: aws_db_parameter_group + +Information about a database parameter group. + +## Example Usage + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { DataAwsDbParameterGroup } from "./.gen/providers/aws/data-aws-db-parameter-group"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + new DataAwsDbParameterGroup(this, "test", { + name: "default.postgres15", + }); + } +} + +``` + +## Argument Reference + +This data source supports the following arguments: + +* `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). +* `name` - (Required) DB parameter group name. + +## Attribute Reference + +This data source exports the following attributes in addition to the arguments above: + +* `arn` - ARN of the parameter group. +* `family` - Family of the parameter group. +* `description` - Description of the parameter group. + + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/db_proxy.html.markdown b/website/docs/cdktf/typescript/d/db_proxy.html.markdown index 94b8daf84f31..e7b9b23d886f 100644 --- a/website/docs/cdktf/typescript/d/db_proxy.html.markdown +++ b/website/docs/cdktf/typescript/d/db_proxy.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `name` - (Required) Name of the DB proxy. ## Attribute Reference @@ -56,4 +57,4 @@ This data source exports the following attributes in addition to the arguments a * `vpcSecurityGroupIds` - Provides a list of VPC security groups that the proxy belongs to. * `vpcSubnetIds` - EC2 subnet IDs for the proxy. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/db_snapshot.html.markdown b/website/docs/cdktf/typescript/d/db_snapshot.html.markdown index e23bff9a8fd6..120563f179ad 100644 --- a/website/docs/cdktf/typescript/d/db_snapshot.html.markdown +++ b/website/docs/cdktf/typescript/d/db_snapshot.html.markdown @@ -66,6 +66,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `mostRecent` - (Optional) If more than one result is returned, use the most recent Snapshot. * `dbInstanceIdentifier` - (Optional) Returns the list of snapshots created by the specific db_instance @@ -106,4 +107,4 @@ This data source exports the following attributes in addition to the arguments a * `snapshotCreateTime` - Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC). Changes for the copy when the snapshot is copied. * `originalSnapshotCreateTime` - Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC). Doesn't change when the snapshot is copied. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/db_subnet_group.html.markdown b/website/docs/cdktf/typescript/d/db_subnet_group.html.markdown index ce422409e42a..1018d0e28c95 100644 --- a/website/docs/cdktf/typescript/d/db_subnet_group.html.markdown +++ b/website/docs/cdktf/typescript/d/db_subnet_group.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `name` - (Required) Name of the RDS database subnet group. ## Attribute Reference @@ -51,4 +52,4 @@ This data source exports the following attributes in addition to the arguments a * `supportedNetworkTypes` - The network type of the DB subnet group. * `vpcId` - Provides the VPC ID of the DB subnet group. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/devopsguru_notification_channel.html.markdown b/website/docs/cdktf/typescript/d/devopsguru_notification_channel.html.markdown index f59d7c66dcbf..99ec401d0844 100644 --- a/website/docs/cdktf/typescript/d/devopsguru_notification_channel.html.markdown +++ b/website/docs/cdktf/typescript/d/devopsguru_notification_channel.html.markdown @@ -38,8 +38,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `id` - (Required) Unique identifier for the notification channel. ## Attribute Reference @@ -58,4 +59,4 @@ This data source exports the following attributes in addition to the arguments a * `messageTypes` - Events to receive notifications for. * `severities` - Severity levels to receive notifications for. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/devopsguru_resource_collection.html.markdown b/website/docs/cdktf/typescript/d/devopsguru_resource_collection.html.markdown index 61b59f928553..685517b4b7c6 100644 --- a/website/docs/cdktf/typescript/d/devopsguru_resource_collection.html.markdown +++ b/website/docs/cdktf/typescript/d/devopsguru_resource_collection.html.markdown @@ -38,8 +38,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `type` - (Required) Type of AWS resource collection to create. Valid values are `AWS_CLOUD_FORMATION`, `AWS_SERVICE`, and `AWS_TAGS`. ## Attribute Reference @@ -59,4 +60,4 @@ This data source exports the following attributes in addition to the arguments a * `appBoundaryKey` - An AWS tag key that is used to identify the AWS resources that DevOps Guru analyzes. * `tagValues` - Array of tag values. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/directory_service_directory.html.markdown b/website/docs/cdktf/typescript/d/directory_service_directory.html.markdown index 0c829c1f5dd6..5deb4c2f6316 100644 --- a/website/docs/cdktf/typescript/d/directory_service_directory.html.markdown +++ b/website/docs/cdktf/typescript/d/directory_service_directory.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `directoryId` - (Required) ID of the directory. ## Attribute Reference @@ -56,7 +57,7 @@ This data source exports the following attributes in addition to the arguments a * `accessUrl` - Access URL for the directory/connector, such as http://alias.awsapps.com. * `dnsIpAddresses` - List of IP addresses of the DNS servers for the directory/connector. * `securityGroupId` - ID of the security group created by the directory/connector. -* `tags` – A map of tags assigned to the directory/connector. +* `tags` - A map of tags assigned to the directory/connector. `vpcSettings` (for `SimpleAD` and `MicrosoftAD`) is also exported with the following attributes: @@ -81,4 +82,4 @@ This data source exports the following attributes in addition to the arguments a * `radiusTimeout` - Amount of time, in seconds, to wait for the RADIUS server to respond. * `useSameUsername` - Not currently used. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/dms_certificate.html.markdown b/website/docs/cdktf/typescript/d/dms_certificate.html.markdown index 4a176984db8b..81529eb724c5 100644 --- a/website/docs/cdktf/typescript/d/dms_certificate.html.markdown +++ b/website/docs/cdktf/typescript/d/dms_certificate.html.markdown @@ -38,8 +38,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `certificateId` - (Required) A customer-assigned name for the certificate. Identifiers must begin with a letter and must contain only ASCII letters, digits, and hyphens. They can't end with a hyphen or contain two consecutive hyphens. ## Attribute Reference @@ -56,4 +57,4 @@ This data source exports the following attributes in addition to the arguments a * `validFromDate` - The beginning date that the certificate is valid. * `validToDate` - The final date that the certificate is valid. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/dms_endpoint.html.markdown b/website/docs/cdktf/typescript/d/dms_endpoint.html.markdown index e17b80f3ffae..e8422d5a1371 100644 --- a/website/docs/cdktf/typescript/d/dms_endpoint.html.markdown +++ b/website/docs/cdktf/typescript/d/dms_endpoint.html.markdown @@ -40,6 +40,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `endpointId` - (Required) Database endpoint identifier. Identifiers must contain from 1 to 255 alphanumeric characters or hyphens, begin with a letter, contain only ASCII letters, digits, and hyphens, not end with a hyphen, and not contain two consecutive hyphens. ## Attribute Reference @@ -48,4 +49,4 @@ This data source exports the following attributes in addition to the arguments a See the [`aws_dms_endpoint` resource](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/dms_endpoint) for details on the returned attributes - they are identical. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/dms_replication_instance.html.markdown b/website/docs/cdktf/typescript/d/dms_replication_instance.html.markdown index cf56b9da98e4..1b5ebc42f5d5 100644 --- a/website/docs/cdktf/typescript/d/dms_replication_instance.html.markdown +++ b/website/docs/cdktf/typescript/d/dms_replication_instance.html.markdown @@ -38,8 +38,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `replicationInstanceId` - (Required) The replication instance identifier. ## Attribute Reference @@ -62,4 +63,4 @@ This data source exports the following attributes in addition to the arguments a * `replicationSubnetGroupId` - A subnet group to associate with the replication instance. * `vpcSecurityGroupIds` - A set of VPC security group IDs that are used with the replication instance. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/dms_replication_subnet_group.html.markdown b/website/docs/cdktf/typescript/d/dms_replication_subnet_group.html.markdown index 2317c544940b..c1c4b6854b44 100644 --- a/website/docs/cdktf/typescript/d/dms_replication_subnet_group.html.markdown +++ b/website/docs/cdktf/typescript/d/dms_replication_subnet_group.html.markdown @@ -40,8 +40,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `replicationSubnetGroupId` - (Required) Name for the replication subnet group. This value is stored as a lowercase string. It must contain no more than 255 alphanumeric characters, periods, spaces, underscores, or hyphens and cannot be `default`. ## Attribute Reference @@ -52,4 +53,4 @@ This data source exports the following attributes in addition to the arguments a * `subnetIds` - List of at least 2 EC2 subnet IDs for the subnet group. The subnets must cover at least 2 availability zones. * `vpcId` - The ID of the VPC the subnet group is in. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/dms_replication_task.html.markdown b/website/docs/cdktf/typescript/d/dms_replication_task.html.markdown index 4899af613a60..0aad240517f8 100644 --- a/website/docs/cdktf/typescript/d/dms_replication_task.html.markdown +++ b/website/docs/cdktf/typescript/d/dms_replication_task.html.markdown @@ -40,15 +40,11 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `replicationTaskId` - (Required) The replication task identifier. - - Must contain from 1 to 255 alphanumeric characters or hyphens. - - First character must be a letter. - - Cannot end with a hyphen. - - Cannot contain two consecutive hyphens. - ## Attribute Reference This data source exports the following attributes in addition to the arguments above: @@ -65,4 +61,4 @@ This data source exports the following attributes in addition to the arguments a * `targetEndpointArn` - The Amazon Resource Name (ARN) string that uniquely identifies the target endpoint. * `replicationTaskArn` - The Amazon Resource Name (ARN) for the replication task. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/docdb_engine_version.html.markdown b/website/docs/cdktf/typescript/d/docdb_engine_version.html.markdown index 5726e7912b87..10843df81cd8 100644 --- a/website/docs/cdktf/typescript/d/docdb_engine_version.html.markdown +++ b/website/docs/cdktf/typescript/d/docdb_engine_version.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `engine` - (Optional) DB engine. (Default: `docdb`) * `parameterGroupFamily` - (Optional) Name of a specific DB parameter group family. An example parameter group family is `docdb3.6`. * `preferredVersions` - (Optional) Ordered list of preferred engine versions. The first match in this list will be returned. If no preferred matches are found and the original search returned more than one result, an error is returned. If both the `version` and `preferredVersions` arguments are not configured, the data source will return the default version for the engine. @@ -53,4 +54,4 @@ This data source exports the following attributes in addition to the arguments a * `validUpgradeTargets` - A set of engine versions that this database engine version can be upgraded to. * `versionDescription` - Description of the database engine version. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/docdb_orderable_db_instance.html.markdown b/website/docs/cdktf/typescript/d/docdb_orderable_db_instance.html.markdown index b6b32ed926f5..35612fb12cc9 100644 --- a/website/docs/cdktf/typescript/d/docdb_orderable_db_instance.html.markdown +++ b/website/docs/cdktf/typescript/d/docdb_orderable_db_instance.html.markdown @@ -41,6 +41,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `engine` - (Optional) DB engine. Default: `docdb` * `engineVersion` - (Optional) Version of the DB engine. * `instanceClass` - (Optional) DB instance class. Examples of classes are `db.r5.12xlarge`, `db.r5.24xlarge`, `db.r5.2xlarge`, `db.r5.4xlarge`, `db.r5.large`, `db.r5.xlarge`, and `db.t3.medium`. (Conflicts with `preferredInstanceClasses`.) @@ -54,4 +55,4 @@ This data source exports the following attributes in addition to the arguments a * `availabilityZones` - Availability zones where the instance is available. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/dx_connection.html.markdown b/website/docs/cdktf/typescript/d/dx_connection.html.markdown index 1256563f1fd5..e6b3db8bab60 100644 --- a/website/docs/cdktf/typescript/d/dx_connection.html.markdown +++ b/website/docs/cdktf/typescript/d/dx_connection.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `name` - (Required) Name of the connection to retrieve. ## Attribute Reference @@ -56,4 +57,4 @@ This data source exports the following attributes in addition to the arguments a * `tags` - Map of tags for the resource. * `vlanId` - The VLAN ID. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/dx_location.html.markdown b/website/docs/cdktf/typescript/d/dx_location.html.markdown index 1df9a278acb1..d99746f29d42 100644 --- a/website/docs/cdktf/typescript/d/dx_location.html.markdown +++ b/website/docs/cdktf/typescript/d/dx_location.html.markdown @@ -41,6 +41,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `locationCode` - (Required) Code for the location to retrieve. ## Attribute Reference @@ -52,4 +53,4 @@ This data source exports the following attributes in addition to the arguments a * `availableProviders` - Names of the service providers for the location. * `locationName` - Name of the location. This includes the name of the colocation partner and the physical site of the building. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/dx_locations.html.markdown b/website/docs/cdktf/typescript/d/dx_locations.html.markdown index b5f429051739..f4ca25128717 100644 --- a/website/docs/cdktf/typescript/d/dx_locations.html.markdown +++ b/website/docs/cdktf/typescript/d/dx_locations.html.markdown @@ -37,7 +37,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -This data source does not support any arguments. +This data source supports the following arguments: + +* `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). ## Attribute Reference @@ -45,4 +47,4 @@ This data source exports the following attributes in addition to the arguments a * `locationCodes` - Code for the locations. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/dx_router_configuration.html.markdown b/website/docs/cdktf/typescript/d/dx_router_configuration.html.markdown index e8362f4963e2..696e1cbd9ac4 100644 --- a/website/docs/cdktf/typescript/d/dx_router_configuration.html.markdown +++ b/website/docs/cdktf/typescript/d/dx_router_configuration.html.markdown @@ -39,8 +39,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -This resource supports the following arguments: +This data source supports the following arguments: +* `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). * `virtualInterfaceId` - (Required) ID of the Direct Connect Virtual Interface * `routerTypeIdentifier` - (Required) ID of the Router Type. For example: `CiscoSystemsInc-2900SeriesRouters-IOS124` @@ -77,4 +78,4 @@ A `router` block supports the following attributes: * `xslt_template_name` - Router XSLT Template Name * `xslt_template_name_for_mac` - Router XSLT Template Name for MacSec - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/dynamodb_table.html.markdown b/website/docs/cdktf/typescript/d/dynamodb_table.html.markdown index 3d6f8916c3f6..292417872ccc 100644 --- a/website/docs/cdktf/typescript/d/dynamodb_table.html.markdown +++ b/website/docs/cdktf/typescript/d/dynamodb_table.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `name` - (Required) Name of the DynamoDB table. ## Attribute Reference @@ -47,4 +48,4 @@ This data source exports the following attributes in addition to the arguments a See the [DynamoDB Table Resource](/docs/providers/aws/r/dynamodb_table.html) for details on the returned attributes - they are identical. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/dynamodb_table_item.html.markdown b/website/docs/cdktf/typescript/d/dynamodb_table_item.html.markdown index e47c2e9596fc..79d9421c9c84 100644 --- a/website/docs/cdktf/typescript/d/dynamodb_table_item.html.markdown +++ b/website/docs/cdktf/typescript/d/dynamodb_table_item.html.markdown @@ -52,6 +52,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `expression_attribute_name` - (Optional) - One or more substitution tokens for attribute names in an expression. Use the `#` character in an expression to dereference an attribute name. * `projectionExpression` - (Optional) A string that identifies one or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas. If no attribute names are specified, then all attributes are returned. If any of the requested attributes are not found, they do not appear in the result. @@ -62,4 +63,4 @@ This data source exports the following attributes in addition to the arguments a * `item` - JSON representation of a map of attribute names to [AttributeValue](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_AttributeValue.html) objects, as specified by ProjectionExpression. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/dynamodb_tables.html.markdown b/website/docs/cdktf/typescript/d/dynamodb_tables.html.markdown index 4328a777faf1..8083e55eca12 100644 --- a/website/docs/cdktf/typescript/d/dynamodb_tables.html.markdown +++ b/website/docs/cdktf/typescript/d/dynamodb_tables.html.markdown @@ -24,7 +24,7 @@ import { TerraformOutput, TerraformStack } from "cdktf"; * Provider bindings are generated by running `cdktf get`. * See https://cdk.tf/provider-generation for more details. */ -import { DataAwsDynamodbTables } from "./.gen/providers/aws/"; +import { DataAwsDynamodbTables } from "./.gen/providers/aws/data-aws-dynamodb-tables"; class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); @@ -39,7 +39,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -This data source does not support any arguments. +This data source supports the following arguments: + +* `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). ## Attribute Reference @@ -47,4 +49,4 @@ This data source exports the following attributes in addition to the arguments a * `names` - A list of all the DynamoDB table names found. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/ebs_default_kms_key.html.markdown b/website/docs/cdktf/typescript/d/ebs_default_kms_key.html.markdown index 59376d5b4da0..e9f2c4acd054 100644 --- a/website/docs/cdktf/typescript/d/ebs_default_kms_key.html.markdown +++ b/website/docs/cdktf/typescript/d/ebs_default_kms_key.html.markdown @@ -40,7 +40,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -This data source does not support any arguments. +This data source supports the following arguments: + +* `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). ## Attribute Reference @@ -55,4 +57,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/ebs_encryption_by_default.html.markdown b/website/docs/cdktf/typescript/d/ebs_encryption_by_default.html.markdown index be85ec346b46..fbd26b6e8562 100644 --- a/website/docs/cdktf/typescript/d/ebs_encryption_by_default.html.markdown +++ b/website/docs/cdktf/typescript/d/ebs_encryption_by_default.html.markdown @@ -34,7 +34,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -This data source does not support any arguments. +This data source supports the following arguments: + +* `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). ## Attribute Reference @@ -49,4 +51,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/ebs_snapshot.html.markdown b/website/docs/cdktf/typescript/d/ebs_snapshot.html.markdown index 2bd9fd0a2e0d..75a78653a9e3 100644 --- a/website/docs/cdktf/typescript/d/ebs_snapshot.html.markdown +++ b/website/docs/cdktf/typescript/d/ebs_snapshot.html.markdown @@ -49,17 +49,12 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `mostRecent` - (Optional) If more than one result is returned, use the most recent snapshot. - * `owners` - (Optional) Returns the snapshots owned by the specified owner id. Multiple owners can be specified. - * `snapshotIds` - (Optional) Returns information on a specific snapshot_id. - * `restorableByUserIds` - (Optional) One or more AWS accounts IDs that can create volumes from the snapshot. - -* `filter` - (Optional) One or more name/value pairs to filter off of. There are -several valid keys, for a full reference, check out -[describe-snapshots in the AWS CLI reference][1]. +* `filter` - (Optional) One or more name/value pairs to filter off of. There are several valid keys, for a full reference, check out [describe-snapshots in the AWS CLI reference][1]. ## Attribute Reference @@ -90,4 +85,4 @@ This data source exports the following attributes in addition to the arguments a [1]: http://docs.aws.amazon.com/cli/latest/reference/ec2/describe-snapshots.html - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/ebs_snapshot_ids.html.markdown b/website/docs/cdktf/typescript/d/ebs_snapshot_ids.html.markdown index 809fe7045942..7ce1da3c8f23 100644 --- a/website/docs/cdktf/typescript/d/ebs_snapshot_ids.html.markdown +++ b/website/docs/cdktf/typescript/d/ebs_snapshot_ids.html.markdown @@ -49,13 +49,10 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `owners` - (Optional) Returns the snapshots owned by the specified owner id. Multiple owners can be specified. - * `restorableByUserIds` - (Optional) One or more AWS accounts IDs that can create volumes from the snapshot. - -* `filter` - (Optional) One or more name/value pairs to filter off of. There are -several valid keys, for a full reference, check out -[describe-volumes in the AWS CLI reference][1]. +* `filter` - (Optional) One or more name/value pairs to filter off of. There are several valid keys, for a full reference, check out [describe-volumes in the AWS CLI reference][1]. ## Attribute Reference @@ -72,4 +69,4 @@ This data source exports the following attributes in addition to the arguments a [1]: http://docs.aws.amazon.com/cli/latest/reference/ec2/describe-snapshots.html - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/ebs_volume.html.markdown b/website/docs/cdktf/typescript/d/ebs_volume.html.markdown index cdce1dbf8d4f..1af981dd7185 100644 --- a/website/docs/cdktf/typescript/d/ebs_volume.html.markdown +++ b/website/docs/cdktf/typescript/d/ebs_volume.html.markdown @@ -49,6 +49,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `filter` - (Optional) One or more name/value pairs to filter off of. There are several valid keys, for a full reference, check out [describe-volumes in the AWS CLI reference][1]. @@ -74,6 +75,7 @@ This data source exports the following attributes in addition to the arguments a * `throughput` - Throughput that the volume supports, in MiB/s. * `volumeId` - Volume ID (e.g., vol-59fcb34e). * `volumeType` - Type of EBS volume. +* `volumeInitializationRate` - EBS provisioned rate for volume initialization, in MiB/s, at which to download the snapshot blocks from Amazon S3 to the volume. ## Timeouts @@ -83,4 +85,4 @@ This data source exports the following attributes in addition to the arguments a [1]: http://docs.aws.amazon.com/cli/latest/reference/ec2/describe-volumes.html - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/ebs_volumes.html.markdown b/website/docs/cdktf/typescript/d/ebs_volumes.html.markdown index f5de1082c1f7..d2d074f55e2e 100644 --- a/website/docs/cdktf/typescript/d/ebs_volumes.html.markdown +++ b/website/docs/cdktf/typescript/d/ebs_volumes.html.markdown @@ -74,6 +74,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `filter` - (Optional) Custom filter block as described below. * `tags` - (Optional) Map of tags, each pair of which must exactly match a pair on the desired volumes. @@ -127,4 +128,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/ec2_capacity_block_offering.html.markdown b/website/docs/cdktf/typescript/d/ec2_capacity_block_offering.html.markdown index 3cbd69a840b0..46017c7da809 100644 --- a/website/docs/cdktf/typescript/d/ec2_capacity_block_offering.html.markdown +++ b/website/docs/cdktf/typescript/d/ec2_capacity_block_offering.html.markdown @@ -40,8 +40,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -This resource supports the following arguments: +This data source supports the following arguments: +* `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). * `capacityDurationHours` - (Required) The amount of time of the Capacity Block reservation in hours. * `endDateRange` - (Optional) The date and time at which the Capacity Block Reservation expires. When a Capacity Reservation expires, the reserved capacity is released and you can no longer launch instances into it. Valid values: [RFC3339 time string](https://tools.ietf.org/html/rfc3339#section-5.8) (`YYYY-MM-DDTHH:MM:SSZ`) * `instanceCount` - (Required) The number of instances for which to reserve capacity. @@ -58,4 +59,4 @@ This resource exports the following attributes in addition to the arguments abov * `upfrontFee` - The total price to be paid up front. * `tenancy` - Indicates the tenancy of the Capacity Reservation. Specify either `default` or `dedicated`. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/ec2_client_vpn_endpoint.html.markdown b/website/docs/cdktf/typescript/d/ec2_client_vpn_endpoint.html.markdown index 0d8989a23396..a7c961fd8a06 100644 --- a/website/docs/cdktf/typescript/d/ec2_client_vpn_endpoint.html.markdown +++ b/website/docs/cdktf/typescript/d/ec2_client_vpn_endpoint.html.markdown @@ -67,6 +67,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `clientVpnEndpointId` - (Optional) ID of the Client VPN endpoint. * `filter` - (Optional) One or more configuration blocks containing name-values filters. Detailed below. * `tags` - (Optional) Map of tags, each pair of which must exactly match a pair on the desired endpoint. @@ -89,17 +90,19 @@ This data source exports the following attributes in addition to the arguments a * `clientCidrBlock` - IPv4 address range, in CIDR notation, from which client IP addresses are assigned. * `clientConnectOptions` - The options for managing connection authorization for new client connections. * `clientLoginBannerOptions` - Options for enabling a customizable text banner that will be displayed on AWS provided clients when a VPN session is established. -* `client_route_enforcement_options` - Options for enforce administrator defined routes on devices connected through the VPN. +* `clientRouteEnforcementOptions` - Options for enforce administrator defined routes on devices connected through the VPN. * `connectionLogOptions` - Information about the client connection logging options for the Client VPN endpoint. * `description` - Brief description of the endpoint. * `dnsName` - DNS name to be used by clients when connecting to the Client VPN endpoint. * `dnsServers` - Information about the DNS servers to be used for DNS resolution. +* `endpointIpAddressType` - IP address type for the Client VPN endpoint. * `securityGroupIds` - IDs of the security groups for the target network associated with the Client VPN endpoint. * `selfServicePortal` - Whether the self-service portal for the Client VPN endpoint is enabled. * `selfServicePortalUrl` - The URL of the self-service portal. * `serverCertificateArn` - The ARN of the server certificate. * `sessionTimeoutHours` - The maximum VPN session duration time in hours. * `splitTunnel` - Whether split-tunnel is enabled in the AWS Client VPN endpoint. +* `trafficIpAddressType` - IP address type for traffic within the Client VPN tunnel. * `transportProtocol` - Transport protocol used by the Client VPN endpoint. * `vpcId` - ID of the VPC associated with the Client VPN endpoint. * `vpnPort` - Port number for the Client VPN endpoint. @@ -110,4 +113,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/ec2_coip_pool.html.markdown b/website/docs/cdktf/typescript/d/ec2_coip_pool.html.markdown index 2b55f3f31986..ab2b885d5296 100644 --- a/website/docs/cdktf/typescript/d/ec2_coip_pool.html.markdown +++ b/website/docs/cdktf/typescript/d/ec2_coip_pool.html.markdown @@ -47,6 +47,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `localGatewayRouteTableId` - (Optional) Local Gateway Route Table Id assigned to desired COIP Pool * `poolId` - (Optional) ID of the specific COIP Pool to retrieve. * `tags` - (Optional) Mapping of tags, each pair of which must exactly match @@ -78,4 +79,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/ec2_coip_pools.html.markdown b/website/docs/cdktf/typescript/d/ec2_coip_pools.html.markdown index cf307a905be1..9137915aa5b8 100644 --- a/website/docs/cdktf/typescript/d/ec2_coip_pools.html.markdown +++ b/website/docs/cdktf/typescript/d/ec2_coip_pools.html.markdown @@ -43,6 +43,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `tags` - (Optional) Mapping of tags, each pair of which must exactly match a pair on the desired aws_ec2_coip_pools. * `filter` - (Optional) Custom filter block as described below. @@ -68,4 +69,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/ec2_host.html.markdown b/website/docs/cdktf/typescript/d/ec2_host.html.markdown index 00df634a09b6..294c6a64a471 100644 --- a/website/docs/cdktf/typescript/d/ec2_host.html.markdown +++ b/website/docs/cdktf/typescript/d/ec2_host.html.markdown @@ -72,6 +72,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `filter` - (Optional) Configuration block. Detailed below. * `hostId` - (Optional) ID of the Dedicated Host. @@ -111,4 +112,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/ec2_instance_type.html.markdown b/website/docs/cdktf/typescript/d/ec2_instance_type.html.markdown index 43a134347998..a7e02ef4b8ca 100644 --- a/website/docs/cdktf/typescript/d/ec2_instance_type.html.markdown +++ b/website/docs/cdktf/typescript/d/ec2_instance_type.html.markdown @@ -39,6 +39,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `instanceType` - (Required) Instance ## Attribute Reference @@ -145,4 +146,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/ec2_instance_type_offering.html.markdown b/website/docs/cdktf/typescript/d/ec2_instance_type_offering.html.markdown index bb912dab8989..7521f1d1aac5 100644 --- a/website/docs/cdktf/typescript/d/ec2_instance_type_offering.html.markdown +++ b/website/docs/cdktf/typescript/d/ec2_instance_type_offering.html.markdown @@ -44,6 +44,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `filter` - (Optional) One or more configuration blocks containing name-values filters. See the [EC2 API Reference](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstanceTypeOfferings.html) for supported filters. Detailed below. * `locationType` - (Optional) Location type. Defaults to `region`. Valid values: `availability-zone`, `availability-zone-id`, and `region`. * `preferredInstanceTypes` - (Optional) Ordered list of preferred EC2 Instance Types. The first match in this list will be returned. If no preferred matches are found and the original search returned more than one result, an error is returned. @@ -66,4 +67,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/ec2_instance_type_offerings.html.markdown b/website/docs/cdktf/typescript/d/ec2_instance_type_offerings.html.markdown index 155e67a640bc..dad01857ac34 100644 --- a/website/docs/cdktf/typescript/d/ec2_instance_type_offerings.html.markdown +++ b/website/docs/cdktf/typescript/d/ec2_instance_type_offerings.html.markdown @@ -48,6 +48,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `filter` - (Optional) One or more configuration blocks containing name-values filters. See the [EC2 API Reference](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstanceTypeOfferings.html) for supported filters. Detailed below. * `locationType` - (Optional) Location type. Defaults to `region`. Valid values: `availability-zone`, `availability-zone-id`, and `region`. @@ -73,4 +74,4 @@ Note that the indexes of Instance Type Offering instance types, locations and lo - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/ec2_instance_types.html.markdown b/website/docs/cdktf/typescript/d/ec2_instance_types.html.markdown index 365a4a4ecda3..1e7c12f87ab8 100644 --- a/website/docs/cdktf/typescript/d/ec2_instance_types.html.markdown +++ b/website/docs/cdktf/typescript/d/ec2_instance_types.html.markdown @@ -55,6 +55,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `filter` - (Optional) One or more configuration blocks containing name-values filters. See the [EC2 API Reference](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstanceTypes.html) for supported filters. Detailed below. ### filter Argument Reference @@ -75,4 +76,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/ec2_local_gateway.html.markdown b/website/docs/cdktf/typescript/d/ec2_local_gateway.html.markdown index 1eaa40980bc7..95b39eea6ff1 100644 --- a/website/docs/cdktf/typescript/d/ec2_local_gateway.html.markdown +++ b/website/docs/cdktf/typescript/d/ec2_local_gateway.html.markdown @@ -43,6 +43,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `filter` - (Optional) Custom filter block as described below. * `id` - (Optional) Id of the specific Local Gateway to retrieve. * `state` - (Optional) Current state of the desired Local Gateway. @@ -82,4 +83,4 @@ The following attributes are additionally exported: - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/ec2_local_gateway_route_table.html.markdown b/website/docs/cdktf/typescript/d/ec2_local_gateway_route_table.html.markdown index 816f761a4ed7..6bc655f3e611 100644 --- a/website/docs/cdktf/typescript/d/ec2_local_gateway_route_table.html.markdown +++ b/website/docs/cdktf/typescript/d/ec2_local_gateway_route_table.html.markdown @@ -50,6 +50,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `localGatewayRouteTableId` - (Optional) Local Gateway Route Table Id assigned to desired local gateway route table * `localGatewayId` - (Optional) ID of the specific local gateway route table to retrieve. * `outpostArn` - (Optional) ARN of the Outpost the local gateway route table is associated with. @@ -80,4 +81,4 @@ This data source exports no additional attributes. - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/ec2_local_gateway_route_tables.html.markdown b/website/docs/cdktf/typescript/d/ec2_local_gateway_route_tables.html.markdown index aae6aede433b..af87db2962c1 100644 --- a/website/docs/cdktf/typescript/d/ec2_local_gateway_route_tables.html.markdown +++ b/website/docs/cdktf/typescript/d/ec2_local_gateway_route_tables.html.markdown @@ -43,6 +43,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `tags` - (Optional) Mapping of tags, each pair of which must exactly match a pair on the desired local gateway route table. * `filter` - (Optional) Custom filter block as described below. @@ -69,4 +70,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/ec2_local_gateway_virtual_interface.html.markdown b/website/docs/cdktf/typescript/d/ec2_local_gateway_virtual_interface.html.markdown index c6eae28a0aee..4a9e0d1ff641 100644 --- a/website/docs/cdktf/typescript/d/ec2_local_gateway_virtual_interface.html.markdown +++ b/website/docs/cdktf/typescript/d/ec2_local_gateway_virtual_interface.html.markdown @@ -48,6 +48,7 @@ class MyConvertedCode extends TerraformStack { The following arguments are optional: +* `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). * `filter` - (Optional) One or more configuration blocks containing name-values filters. See the [EC2 API Reference](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeLocalGatewayVirtualInterfaces.html) for supported filters. Detailed below. * `id` - (Optional) Identifier of EC2 Local Gateway Virtual Interface. * `tags` - (Optional) Key-value map of resource tags, each pair of which must exactly match a pair on the desired local gateway route table. @@ -76,4 +77,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/ec2_local_gateway_virtual_interface_group.html.markdown b/website/docs/cdktf/typescript/d/ec2_local_gateway_virtual_interface_group.html.markdown index 040c6727cd13..5da8180e4b68 100644 --- a/website/docs/cdktf/typescript/d/ec2_local_gateway_virtual_interface_group.html.markdown +++ b/website/docs/cdktf/typescript/d/ec2_local_gateway_virtual_interface_group.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode extends TerraformStack { The following arguments are optional: +* `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). * `filter` - (Optional) One or more configuration blocks containing name-values filters. See the [EC2 API Reference](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeLocalGatewayVirtualInterfaceGroups.html) for supported filters. Detailed below. * `id` - (Optional) Identifier of EC2 Local Gateway Virtual Interface Group. * `localGatewayId` - (Optional) Identifier of EC2 Local Gateway. @@ -62,4 +63,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/ec2_local_gateway_virtual_interface_groups.html.markdown b/website/docs/cdktf/typescript/d/ec2_local_gateway_virtual_interface_groups.html.markdown index cc8c1c8a6e16..4141d2a7397d 100644 --- a/website/docs/cdktf/typescript/d/ec2_local_gateway_virtual_interface_groups.html.markdown +++ b/website/docs/cdktf/typescript/d/ec2_local_gateway_virtual_interface_groups.html.markdown @@ -36,6 +36,7 @@ class MyConvertedCode extends TerraformStack { The following arguments are optional: +* `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). * `filter` - (Optional) One or more configuration blocks containing name-values filters. See the [EC2 API Reference](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeLocalGatewayVirtualInterfaceGroups.html) for supported filters. Detailed below. * `tags` - (Optional) Key-value map of resource tags, each pair of which must exactly match a pair on the desired local gateway route table. @@ -60,4 +61,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/ec2_local_gateways.html.markdown b/website/docs/cdktf/typescript/d/ec2_local_gateways.html.markdown index 16611097f6cc..c6edae3b245c 100644 --- a/website/docs/cdktf/typescript/d/ec2_local_gateways.html.markdown +++ b/website/docs/cdktf/typescript/d/ec2_local_gateways.html.markdown @@ -47,6 +47,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `tags` - (Optional) Mapping of tags, each pair of which must exactly match a pair on the desired local_gateways. * `filter` - (Optional) Custom filter block as described below. @@ -73,4 +74,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/ec2_managed_prefix_list.html.markdown b/website/docs/cdktf/typescript/d/ec2_managed_prefix_list.html.markdown index 26b58d7f3a29..8d2028d5880a 100644 --- a/website/docs/cdktf/typescript/d/ec2_managed_prefix_list.html.markdown +++ b/website/docs/cdktf/typescript/d/ec2_managed_prefix_list.html.markdown @@ -32,7 +32,7 @@ class MyConvertedCode extends TerraformStack { super(scope, name); const current = new DataAwsRegion(this, "current", {}); new DataAwsEc2ManagedPrefixList(this, "example", { - name: "com.amazonaws.${" + current.name + "}.dynamodb", + name: "com.amazonaws.${" + current.region + "}.dynamodb", }); } } @@ -70,6 +70,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `id` - (Optional) ID of the prefix list to select. * `name` - (Optional) Name of the prefix list to select. * `filter` - (Optional) Configuration block(s) for filtering. Detailed below. @@ -104,4 +105,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/ec2_managed_prefix_lists.html.markdown b/website/docs/cdktf/typescript/d/ec2_managed_prefix_lists.html.markdown index c8ac476b9e46..a496ae923e05 100644 --- a/website/docs/cdktf/typescript/d/ec2_managed_prefix_lists.html.markdown +++ b/website/docs/cdktf/typescript/d/ec2_managed_prefix_lists.html.markdown @@ -62,6 +62,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `filter` - (Optional) Custom filter block as described below. * `tags` - (Optional) Map of tags, each pair of which must exactly match a pair on the desired . @@ -87,4 +88,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/ec2_network_insights_analysis.html.markdown b/website/docs/cdktf/typescript/d/ec2_network_insights_analysis.html.markdown index d8346ff23d7e..a4111fea70c8 100644 --- a/website/docs/cdktf/typescript/d/ec2_network_insights_analysis.html.markdown +++ b/website/docs/cdktf/typescript/d/ec2_network_insights_analysis.html.markdown @@ -40,6 +40,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `networkInsightsAnalysisId` - (Optional) ID of the Network Insights Analysis to select. * `filter` - (Optional) Configuration block(s) for filtering. Detailed below. @@ -71,4 +72,4 @@ This data source exports the following attributes in addition to the arguments a * `statusMessage` - Message to provide more context when the `status` is `failed`. * `warningMessage` - Warning message. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/ec2_network_insights_path.html.markdown b/website/docs/cdktf/typescript/d/ec2_network_insights_path.html.markdown index fe204149f5d9..a72913a7a7cb 100644 --- a/website/docs/cdktf/typescript/d/ec2_network_insights_path.html.markdown +++ b/website/docs/cdktf/typescript/d/ec2_network_insights_path.html.markdown @@ -40,6 +40,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `networkInsightsPathId` - (Optional) ID of the Network Insights Path to select. * `filter` - (Optional) Configuration block(s) for filtering. Detailed below. @@ -71,4 +72,4 @@ This data source exports the following attributes in addition to the arguments a * `sourceIp` - IP address of the AWS resource that is the source of the path. * `tags` - Map of tags assigned to the resource. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/ec2_public_ipv4_pool.html.markdown b/website/docs/cdktf/typescript/d/ec2_public_ipv4_pool.html.markdown index 37272d3630ad..ab9d5041dadf 100644 --- a/website/docs/cdktf/typescript/d/ec2_public_ipv4_pool.html.markdown +++ b/website/docs/cdktf/typescript/d/ec2_public_ipv4_pool.html.markdown @@ -38,8 +38,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `poolId` - (Required) AWS resource IDs of a public IPv4 pool (as a string) for which this data source will fetch detailed information. ## Attribute Reference @@ -57,4 +58,4 @@ This data source exports the following attributes in addition to the arguments a * `totalAddressCount` - Total number of addresses in the pool. * `totalAvailableAddressCount` - Total number of available addresses in the pool. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/ec2_public_ipv4_pools.html.markdown b/website/docs/cdktf/typescript/d/ec2_public_ipv4_pools.html.markdown index dd116be1dd16..5acc0f8b050f 100644 --- a/website/docs/cdktf/typescript/d/ec2_public_ipv4_pools.html.markdown +++ b/website/docs/cdktf/typescript/d/ec2_public_ipv4_pools.html.markdown @@ -65,6 +65,7 @@ class MyConvertedCode extends TerraformStack { The following arguments are optional: +* `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). * `filter` - (Optional) Custom filter block as described below. * `tags` - (Optional) Map of tags, each pair of which must exactly match a pair on the desired pools. @@ -80,4 +81,4 @@ This data source exports the following attributes in addition to the arguments a * `poolIds` - List of all the pool IDs found. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/ec2_serial_console_access.html.markdown b/website/docs/cdktf/typescript/d/ec2_serial_console_access.html.markdown index 5fbcd9b2749d..01e476becc89 100644 --- a/website/docs/cdktf/typescript/d/ec2_serial_console_access.html.markdown +++ b/website/docs/cdktf/typescript/d/ec2_serial_console_access.html.markdown @@ -34,7 +34,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -This data source does not support any arguments. +This data source supports the following arguments: + +* `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). ## Attribute Reference @@ -49,4 +51,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/ec2_spot_price.html.markdown b/website/docs/cdktf/typescript/d/ec2_spot_price.html.markdown index fbcbaff9c257..0a1cd13a0b66 100644 --- a/website/docs/cdktf/typescript/d/ec2_spot_price.html.markdown +++ b/website/docs/cdktf/typescript/d/ec2_spot_price.html.markdown @@ -45,6 +45,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `instanceType` - (Optional) Type of instance for which to query Spot Price information. * `availabilityZone` - (Optional) Availability zone in which to query Spot price information. * `filter` - (Optional) One or more configuration blocks containing name-values filters. See the [EC2 API Reference](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeSpotPriceHistory.html) for supported filters. Detailed below. @@ -68,4 +69,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/ec2_transit_gateway.html.markdown b/website/docs/cdktf/typescript/d/ec2_transit_gateway.html.markdown index d9e809e9a1f5..3ac36bdc0d5a 100644 --- a/website/docs/cdktf/typescript/d/ec2_transit_gateway.html.markdown +++ b/website/docs/cdktf/typescript/d/ec2_transit_gateway.html.markdown @@ -67,6 +67,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `filter` - (Optional) One or more configuration blocks containing name-values filters. Detailed below. * `id` - (Optional) Identifier of the EC2 Transit Gateway. @@ -102,4 +103,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/ec2_transit_gateway_attachment.html.markdown b/website/docs/cdktf/typescript/d/ec2_transit_gateway_attachment.html.markdown index fab9d4abe37d..870179d1da29 100644 --- a/website/docs/cdktf/typescript/d/ec2_transit_gateway_attachment.html.markdown +++ b/website/docs/cdktf/typescript/d/ec2_transit_gateway_attachment.html.markdown @@ -47,6 +47,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `filter` - (Optional) One or more configuration blocks containing name-values filters. Detailed below. * `transitGatewayAttachmentId` - (Optional) ID of the attachment. @@ -70,4 +71,4 @@ This data source exports the following attributes in addition to the arguments a * `transitGatewayId` - ID of the transit gateway. * `transitGatewayOwnerId` - The ID of the AWS account that owns the transit gateway. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/ec2_transit_gateway_attachments.html.markdown b/website/docs/cdktf/typescript/d/ec2_transit_gateway_attachments.html.markdown index 249c9e6041f8..ec7ff825dbb1 100644 --- a/website/docs/cdktf/typescript/d/ec2_transit_gateway_attachments.html.markdown +++ b/website/docs/cdktf/typescript/d/ec2_transit_gateway_attachments.html.markdown @@ -63,6 +63,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `filter` - (Optional) One or more configuration blocks containing name-values filters. Detailed below. ### filter Argument Reference @@ -85,4 +86,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/ec2_transit_gateway_connect.html.markdown b/website/docs/cdktf/typescript/d/ec2_transit_gateway_connect.html.markdown index 24c3e638e629..5b4da5d2b782 100644 --- a/website/docs/cdktf/typescript/d/ec2_transit_gateway_connect.html.markdown +++ b/website/docs/cdktf/typescript/d/ec2_transit_gateway_connect.html.markdown @@ -67,6 +67,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `filter` - (Optional) One or more configuration blocks containing name-values filters. Detailed below. * `transitGatewayConnectId` - (Optional) Identifier of the EC2 Transit Gateway Connect. @@ -90,4 +91,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/ec2_transit_gateway_connect_peer.html.markdown b/website/docs/cdktf/typescript/d/ec2_transit_gateway_connect_peer.html.markdown index 7ef018d40c06..161b10f015b3 100644 --- a/website/docs/cdktf/typescript/d/ec2_transit_gateway_connect_peer.html.markdown +++ b/website/docs/cdktf/typescript/d/ec2_transit_gateway_connect_peer.html.markdown @@ -67,6 +67,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `filter` - (Optional) One or more configuration blocks containing name-values filters. Detailed below. * `transitGatewayConnectPeerId` - (Optional) Identifier of the EC2 Transit Gateway Connect Peer. @@ -95,4 +96,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/ec2_transit_gateway_dx_gateway_attachment.html.markdown b/website/docs/cdktf/typescript/d/ec2_transit_gateway_dx_gateway_attachment.html.markdown index e44ed9f44e16..d0796216b226 100644 --- a/website/docs/cdktf/typescript/d/ec2_transit_gateway_dx_gateway_attachment.html.markdown +++ b/website/docs/cdktf/typescript/d/ec2_transit_gateway_dx_gateway_attachment.html.markdown @@ -41,6 +41,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `transitGatewayId` - (Optional) Identifier of the EC2 Transit Gateway. * `dxGatewayId` - (Optional) Identifier of the Direct Connect Gateway. * `filter` - (Optional) Configuration block(s) for filtering. Detailed below. @@ -67,4 +68,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/ec2_transit_gateway_multicast_domain.html.markdown b/website/docs/cdktf/typescript/d/ec2_transit_gateway_multicast_domain.html.markdown index c6a2439e343e..657ba81ddb42 100644 --- a/website/docs/cdktf/typescript/d/ec2_transit_gateway_multicast_domain.html.markdown +++ b/website/docs/cdktf/typescript/d/ec2_transit_gateway_multicast_domain.html.markdown @@ -67,6 +67,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `filter` - (Optional) One or more configuration blocks containing name-values filters. Detailed below. * `transitGatewayMulticastDomainId` - (Optional) Identifier of the EC2 Transit Gateway Multicast Domain. @@ -107,4 +108,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/ec2_transit_gateway_peering_attachment.html.markdown b/website/docs/cdktf/typescript/d/ec2_transit_gateway_peering_attachment.html.markdown index c3428b59be12..f8e5947a68a4 100644 --- a/website/docs/cdktf/typescript/d/ec2_transit_gateway_peering_attachment.html.markdown +++ b/website/docs/cdktf/typescript/d/ec2_transit_gateway_peering_attachment.html.markdown @@ -67,6 +67,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `filter` - (Optional) One or more configuration blocks containing name-values filters. Detailed below. * `id` - (Optional) Identifier of the EC2 Transit Gateway Peering Attachment. * `tags` - (Optional) Mapping of tags, each pair of which must exactly match @@ -96,4 +97,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/ec2_transit_gateway_peering_attachments.html.markdown b/website/docs/cdktf/typescript/d/ec2_transit_gateway_peering_attachments.html.markdown index f1fa4464889e..109aa9f13cd7 100644 --- a/website/docs/cdktf/typescript/d/ec2_transit_gateway_peering_attachments.html.markdown +++ b/website/docs/cdktf/typescript/d/ec2_transit_gateway_peering_attachments.html.markdown @@ -81,6 +81,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `filter` - (Optional) One or more configuration blocks containing name-values filters. Detailed below. ### filter Argument Reference @@ -103,4 +104,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/ec2_transit_gateway_route_table.html.markdown b/website/docs/cdktf/typescript/d/ec2_transit_gateway_route_table.html.markdown index 33d769670361..a90a94191e0f 100644 --- a/website/docs/cdktf/typescript/d/ec2_transit_gateway_route_table.html.markdown +++ b/website/docs/cdktf/typescript/d/ec2_transit_gateway_route_table.html.markdown @@ -71,6 +71,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `filter` - (Optional) One or more configuration blocks containing name-values filters. Detailed below. * `id` - (Optional) Identifier of the EC2 Transit Gateway Route Table. @@ -96,4 +97,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/ec2_transit_gateway_route_table_associations.html.markdown b/website/docs/cdktf/typescript/d/ec2_transit_gateway_route_table_associations.html.markdown index d6f0c879d4fa..e7e3ef51a065 100644 --- a/website/docs/cdktf/typescript/d/ec2_transit_gateway_route_table_associations.html.markdown +++ b/website/docs/cdktf/typescript/d/ec2_transit_gateway_route_table_associations.html.markdown @@ -46,6 +46,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `filter` - (Optional) Custom filter block as described below. More complex filters can be expressed using one or more `filter` sub-blocks, @@ -64,4 +65,4 @@ This data source exports the following attributes in addition to the arguments a * `id` - AWS Region. * `ids` - Set of Transit Gateway Route Table Association identifiers. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/ec2_transit_gateway_route_table_propagations.html.markdown b/website/docs/cdktf/typescript/d/ec2_transit_gateway_route_table_propagations.html.markdown index 4970fcbc779d..cd1645be7ef2 100644 --- a/website/docs/cdktf/typescript/d/ec2_transit_gateway_route_table_propagations.html.markdown +++ b/website/docs/cdktf/typescript/d/ec2_transit_gateway_route_table_propagations.html.markdown @@ -42,6 +42,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `transitGatewayRouteTableId` - (Required) Identifier of EC2 Transit Gateway Route Table. * `filter` - (Optional) Custom filter block as described below. @@ -61,4 +62,4 @@ This data source exports the following attributes in addition to the arguments a * `id` - AWS Region. * `ids` - Set of Transit Gateway Route Table Association identifiers. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/ec2_transit_gateway_route_table_routes.html.markdown b/website/docs/cdktf/typescript/d/ec2_transit_gateway_route_table_routes.html.markdown index 528d9197bad2..d812bbfcc03a 100644 --- a/website/docs/cdktf/typescript/d/ec2_transit_gateway_route_table_routes.html.markdown +++ b/website/docs/cdktf/typescript/d/ec2_transit_gateway_route_table_routes.html.markdown @@ -357,6 +357,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `filter` - (Required) Custom filter block as described below. * `transitGatewayRouteTableId` - (Required) Identifier of EC2 Transit Gateway Route Table. @@ -382,4 +383,4 @@ This data source exports the following attributes in addition to the arguments a * `transit_gateway_route_table_announcement_id` - The id of the transit gateway route table announcement, most of the time it is an empty string. * `type` - The type of the route, can be `propagated` or `static`. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/ec2_transit_gateway_route_tables.html.markdown b/website/docs/cdktf/typescript/d/ec2_transit_gateway_route_tables.html.markdown index d1b4b7bc1081..10ba6ec95764 100644 --- a/website/docs/cdktf/typescript/d/ec2_transit_gateway_route_tables.html.markdown +++ b/website/docs/cdktf/typescript/d/ec2_transit_gateway_route_tables.html.markdown @@ -47,8 +47,8 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `filter` - (Optional) Custom filter block as described below. - * `tags` - (Optional) Mapping of tags, each pair of which must exactly match a pair on the desired transit gateway route table. @@ -57,7 +57,6 @@ which take the following arguments: * `name` - (Required) Name of the field to filter by, as defined by [the underlying AWS API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeTransitGatewayRouteTables.html). - * `values` - (Required) Set of values that are accepted for the given field. A Transit Gateway Route Table will be selected if any one of the given values matches. @@ -74,4 +73,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/ec2_transit_gateway_vpc_attachment.html.markdown b/website/docs/cdktf/typescript/d/ec2_transit_gateway_vpc_attachment.html.markdown index f815d9615b96..a16c7f7ba805 100644 --- a/website/docs/cdktf/typescript/d/ec2_transit_gateway_vpc_attachment.html.markdown +++ b/website/docs/cdktf/typescript/d/ec2_transit_gateway_vpc_attachment.html.markdown @@ -67,6 +67,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `filter` - (Optional) One or more configuration blocks containing name-values filters. Detailed below. * `id` - (Optional) Identifier of the EC2 Transit Gateway VPC Attachment. @@ -97,4 +98,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/ec2_transit_gateway_vpc_attachments.html.markdown b/website/docs/cdktf/typescript/d/ec2_transit_gateway_vpc_attachments.html.markdown index b159dfc0d111..034c2356e61e 100644 --- a/website/docs/cdktf/typescript/d/ec2_transit_gateway_vpc_attachments.html.markdown +++ b/website/docs/cdktf/typescript/d/ec2_transit_gateway_vpc_attachments.html.markdown @@ -61,6 +61,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `filter` - (Optional) One or more configuration blocks containing name-values filters. Detailed below. ### filter Argument Reference @@ -83,4 +84,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/ec2_transit_gateway_vpn_attachment.html.markdown b/website/docs/cdktf/typescript/d/ec2_transit_gateway_vpn_attachment.html.markdown index d736732e4d40..5dcc33d942d3 100644 --- a/website/docs/cdktf/typescript/d/ec2_transit_gateway_vpn_attachment.html.markdown +++ b/website/docs/cdktf/typescript/d/ec2_transit_gateway_vpn_attachment.html.markdown @@ -70,6 +70,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `transitGatewayId` - (Optional) Identifier of the EC2 Transit Gateway. * `vpnConnectionId` - (Optional) Identifier of the EC2 VPN Connection. * `filter` - (Optional) Configuration block(s) for filtering. Detailed below. @@ -95,4 +96,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/ecr_authorization_token.html.markdown b/website/docs/cdktf/typescript/d/ecr_authorization_token.html.markdown index 4e1abb896c7b..30b546027506 100644 --- a/website/docs/cdktf/typescript/d/ecr_authorization_token.html.markdown +++ b/website/docs/cdktf/typescript/d/ecr_authorization_token.html.markdown @@ -36,6 +36,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `registryId` - (Optional) AWS account ID of the ECR Repository. If not specified the default account is assumed. ## Attribute Reference @@ -49,4 +50,4 @@ This data source exports the following attributes in addition to the arguments a * `proxyEndpoint` - Registry URL to use in the docker login command. * `userName` - User name decoded from the authorization token. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/ecr_image.html.markdown b/website/docs/cdktf/typescript/d/ecr_image.html.markdown index f04232d798c4..3214bf8a4482 100644 --- a/website/docs/cdktf/typescript/d/ecr_image.html.markdown +++ b/website/docs/cdktf/typescript/d/ecr_image.html.markdown @@ -39,6 +39,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `registryId` - (Optional) ID of the Registry where the repository resides. * `repositoryName` - (Required) Name of the ECR Repository. * `imageDigest` - (Optional) Sha256 digest of the image manifest. At least one of `imageDigest`, `imageTag`, or `mostRecent` must be specified. @@ -55,4 +56,4 @@ This data source exports the following attributes in addition to the arguments a * `imageTags` - List of tags associated with this image. * `imageUri` - The URI for the specific image version specified by `imageTag` or `imageDigest`. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/ecr_images.html.markdown b/website/docs/cdktf/typescript/d/ecr_images.html.markdown new file mode 100644 index 000000000000..04e6841e80c8 --- /dev/null +++ b/website/docs/cdktf/typescript/d/ecr_images.html.markdown @@ -0,0 +1,65 @@ +--- +subcategory: "ECR (Elastic Container Registry)" +layout: "aws" +page_title: "AWS: aws_ecr_images" +description: |- + Provides a list of images for a specified ECR Repository +--- + + + +# Data Source: aws_ecr_images + +The ECR Images data source allows the list of images in a specified repository to be retrieved. + +## Example Usage + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { TerraformOutput, TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { DataAwsEcrImages } from "./.gen/providers/aws/data-aws-ecr-images"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + const example = new DataAwsEcrImages(this, "example", { + repositoryName: "my-repository", + }); + new TerraformOutput(this, "image_digests", { + value: + "${[ for img in ${" + + example.imageIds + + "} : img.image_digest if img.image_digest != null]}", + }); + new TerraformOutput(this, "image_tags", { + value: + "${[ for img in ${" + + example.imageIds + + "} : img.image_tag if img.image_tag != null]}", + }); + } +} + +``` + +## Argument Reference + +This data source supports the following arguments: + +* `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). +* `registryId` - (Optional) ID of the Registry where the repository resides. +* `repositoryName` - (Required) Name of the ECR Repository. + +## Attribute Reference + +This data source exports the following attributes in addition to the arguments above: + +* `imageIds` - List of image objects containing image digest and tags. Each object has the following attributes: + * `imageDigest` - The sha256 digest of the image manifest. + * `imageTag` - The tag associated with the image. + + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/ecr_pull_through_cache_rule.html.markdown b/website/docs/cdktf/typescript/d/ecr_pull_through_cache_rule.html.markdown index e718f9e541cf..3959136f1dc4 100644 --- a/website/docs/cdktf/typescript/d/ecr_pull_through_cache_rule.html.markdown +++ b/website/docs/cdktf/typescript/d/ecr_pull_through_cache_rule.html.markdown @@ -38,7 +38,8 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: -- `ecrRepositoryPrefix` - (Required) The repository name prefix to use when caching images from the source registry. +* `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). +* `ecrRepositoryPrefix` - (Required) The repository name prefix to use when caching images from the source registry. ## Attribute Reference @@ -51,4 +52,4 @@ This data source exports the following attributes in addition to the arguments a - `upstreamRegistryUrl` - The registry URL of the upstream registry to use as the source. - `upstreamRepositoryPrefix` - The upstream repository prefix associated with the pull through cache rule. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/ecr_repositories.html.markdown b/website/docs/cdktf/typescript/d/ecr_repositories.html.markdown index a0a0f04ad9ee..1fba28e55f56 100644 --- a/website/docs/cdktf/typescript/d/ecr_repositories.html.markdown +++ b/website/docs/cdktf/typescript/d/ecr_repositories.html.markdown @@ -36,7 +36,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -This data source does not support any arguments. +This data source supports the following arguments: + +* `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). ## Attribute Reference @@ -45,4 +47,4 @@ This data source exports the following attributes in addition to the arguments a * `id` - AWS Region. * `names` - A list if AWS Elastic Container Registries for the region. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/ecr_repository.html.markdown b/website/docs/cdktf/typescript/d/ecr_repository.html.markdown index 6273c622bd44..0142aaf4fb45 100644 --- a/website/docs/cdktf/typescript/d/ecr_repository.html.markdown +++ b/website/docs/cdktf/typescript/d/ecr_repository.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `name` - (Required) Name of the ECR Repository. * `registryId` - (Optional) Registry ID where the repository was created. @@ -49,6 +50,7 @@ This data source exports the following attributes in addition to the arguments a * `encryptionConfiguration` - Encryption configuration for the repository. See [Encryption Configuration](#encryption-configuration) below. * `imageScanningConfiguration` - Configuration block that defines image scanning configuration for the repository. See [Image Scanning Configuration](#image-scanning-configuration) below. * `imageTagMutability` - The tag mutability setting for the repository. +* `imageTagMutabilityExclusionFilter` - Block that defines filters to specify which image tags can override the default tag mutability setting. * `mostRecentImageTags` - List of image tags associated with the most recently pushed image in the repository. * `repositoryUrl` - URL of the repository (in the form `aws_account_id.dkr.ecr.region.amazonaws.com/repositoryName`). * `tags` - Map of tags assigned to the resource. @@ -58,8 +60,13 @@ This data source exports the following attributes in addition to the arguments a * `encryptionType` - Encryption type to use for the repository, either `AES256` or `KMS`. * `kmsKey` - If `encryptionType` is `KMS`, the ARN of the KMS key used. +### Image Tag Mutability Exclusion Filter + +* `filter` - The filter pattern to use for excluding image tags from the mutability setting. +* `filterType` - The type of filter to use. + ### Image Scanning Configuration * `scanOnPush` - Whether images are scanned after being pushed to the repository. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/ecr_repository_creation_template.html.markdown b/website/docs/cdktf/typescript/d/ecr_repository_creation_template.html.markdown index 9ac5dee157c8..85c04bdf4e8f 100644 --- a/website/docs/cdktf/typescript/d/ecr_repository_creation_template.html.markdown +++ b/website/docs/cdktf/typescript/d/ecr_repository_creation_template.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `prefix` - (Required) The repository name prefix that the template matches against. ## Attribute Reference @@ -49,6 +50,7 @@ This data source exports the following attributes in addition to the arguments a * `description` - The description for this template. * `encryptionConfiguration` - Encryption configuration for any created repositories. See [Encryption Configuration](#encryption-configuration) below. * `imageTagMutability` - The tag mutability setting for any created repositories. +* `imageTagMutabilityExclusionFilter` - Block that defines filters to specify which image tags can override the default tag mutability setting. * `lifecyclePolicy` - The lifecycle policy document to apply to any created repositories. * `registryId` - The registry ID the repository creation template applies to. * `repositoryPolicy` - The registry policy document to apply to any created repositories. @@ -59,4 +61,9 @@ This data source exports the following attributes in addition to the arguments a * `encryptionType` - Encryption type to use for any created repositories, either `AES256` or `KMS`. * `kmsKey` - If `encryptionType` is `KMS`, the ARN of the KMS key used. - \ No newline at end of file +### Image Tag Mutability Exclusion Filter + +* `filter` - The filter pattern to use for excluding image tags from the mutability setting. +* `filterType` - The type of filter to use. + + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/ecrpublic_authorization_token.html.markdown b/website/docs/cdktf/typescript/d/ecrpublic_authorization_token.html.markdown index 963adcd2ead4..f2e741f3471e 100644 --- a/website/docs/cdktf/typescript/d/ecrpublic_authorization_token.html.markdown +++ b/website/docs/cdktf/typescript/d/ecrpublic_authorization_token.html.markdown @@ -36,7 +36,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -This data source does not support any arguments. +This data source supports the following arguments: + +* `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). ## Attribute Reference @@ -48,4 +50,4 @@ This data source exports the following attributes in addition to the arguments a * `password` - Password decoded from the authorization token. * `userName` - User name decoded from the authorization token. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/ecs_cluster.html.markdown b/website/docs/cdktf/typescript/d/ecs_cluster.html.markdown index d8ae68422957..ac87180b25a2 100644 --- a/website/docs/cdktf/typescript/d/ecs_cluster.html.markdown +++ b/website/docs/cdktf/typescript/d/ecs_cluster.html.markdown @@ -39,6 +39,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `clusterName` - (Required) Name of the ECS Cluster ## Attribute Reference @@ -54,4 +55,4 @@ This data source exports the following attributes in addition to the arguments a * `setting` - Settings associated with the ECS Cluster * `tags` - Key-value map of resource tags - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/ecs_clusters.html.markdown b/website/docs/cdktf/typescript/d/ecs_clusters.html.markdown index b92a60a8bccb..b90e28324b53 100644 --- a/website/docs/cdktf/typescript/d/ecs_clusters.html.markdown +++ b/website/docs/cdktf/typescript/d/ecs_clusters.html.markdown @@ -36,7 +36,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -This data source does not support any arguments. +This data source supports the following arguments: + +* `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). ## Attribute Reference @@ -44,4 +46,4 @@ This data source exports the following attributes in addition to the arguments a * `clusterArns` - List of ECS cluster ARNs associated with the account. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/ecs_container_definition.html.markdown b/website/docs/cdktf/typescript/d/ecs_container_definition.html.markdown index bc0e2c2450e2..0e173a68d848 100644 --- a/website/docs/cdktf/typescript/d/ecs_container_definition.html.markdown +++ b/website/docs/cdktf/typescript/d/ecs_container_definition.html.markdown @@ -40,6 +40,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `taskDefinition` - (Required) ARN of the task definition which contains the container * `containerName` - (Required) Name of the container definition @@ -56,4 +57,4 @@ This data source exports the following attributes in addition to the arguments a * `disableNetworking` - Indicator if networking is disabled * `dockerLabels` - Set docker labels - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/ecs_service.html.markdown b/website/docs/cdktf/typescript/d/ecs_service.html.markdown index c067b82826e0..9634f745331f 100644 --- a/website/docs/cdktf/typescript/d/ecs_service.html.markdown +++ b/website/docs/cdktf/typescript/d/ecs_service.html.markdown @@ -40,6 +40,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `serviceName` - (Required) Name of the ECS Service * `clusterArn` - (Required) ARN of the ECS Cluster @@ -50,8 +51,28 @@ This data source exports the following attributes in addition to the arguments a * `arn` - ARN of the ECS Service * `desiredCount` - Number of tasks for the ECS Service * `launchType` - Launch type for the ECS Service +* `loadBalancer` - Load balancers for the ECS Service. See [`loadBalancer` Block](#load_balancer-block) for details. * `schedulingStrategy` - Scheduling strategy for the ECS Service * `taskDefinition` - Family for the latest ACTIVE revision or full ARN of the task definition. * `tags` - Resource tags. - \ No newline at end of file +### `loadBalancer` Block + +The `loadBalancer` block exports the following attributes: + +* `advancedConfiguration` - Settings for Blue/Green deployment. See [`advancedConfiguration` Block](#advanced_configuration-block) for details. +* `containerName` - Name of the container to associate with the load balancer. +* `containerPort` - Port on the container to associate with the load balancer. +* `elbName` - Name of the load balancer. +* `targetGroupArn` - ARN of the target group to associate with the load balancer. + +### `advancedConfiguration` Block + +The `advancedConfiguration` block exports the following attributes: + +* `alternateTargetGroupArn` - ARN of the alternate target group to use for Blue/Green deployments. +* `productionListenerRule` - ARN of the listener rule that routes production traffic. +* `roleArn` - ARN of the IAM role that allows ECS to manage the target groups. +* `testListenerRule` - ARN of the listener rule that routes test traffic. + + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/ecs_task_definition.html.markdown b/website/docs/cdktf/typescript/d/ecs_task_definition.html.markdown index e767db0a8cae..de7aa0d88d15 100644 --- a/website/docs/cdktf/typescript/d/ecs_task_definition.html.markdown +++ b/website/docs/cdktf/typescript/d/ecs_task_definition.html.markdown @@ -64,6 +64,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `taskDefinition` - (Required) Family for the latest ACTIVE revision, family and revision (family:revision) for a specific revision in the family, the ARN of the task definition to access to. ## Attribute Reference @@ -74,12 +75,11 @@ This data source exports the following attributes in addition to the arguments a * `arnWithoutRevision` - ARN of the Task Definition with the trailing `revision` removed. This may be useful for situations where the latest task definition is always desired. If a revision isn't specified, the latest ACTIVE revision is used. See the [AWS documentation](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_StartTask.html#ECS-StartTask-request-taskDefinition) for details. * `containerDefinitions` - A list of valid [container definitions](http://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ContainerDefinition.html) provided as a single valid JSON document. Please note that you should only provide values that are part of the container definition document. For a detailed description of what parameters are available, see the [Task Definition Parameters](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html) section from the official [Developer Guide](https://docs.aws.amazon.com/AmazonECS/latest/developerguide). * `cpu` - Number of cpu units used by the task. If the `requiresCompatibilities` is `FARGATE` this field is required. -* `enable_fault_injection` - Enables fault injection and allows for fault injection requests to be accepted from the task's containers. Default is `false`. +* `enableFaultInjection` - Enables fault injection and allows for fault injection requests to be accepted from the task's containers. Default is `false`. * `ephemeralStorage` - The amount of ephemeral storage to allocate for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on AWS Fargate. See [Ephemeral Storage](#ephemeral_storage). * `executionRoleArn` - ARN of the task execution role that the Amazon ECS container agent and the Docker daemon can assume. * `family` - A unique name for your task definition. The following arguments are optional: -* `inferenceAccelerator` - Configuration block(s) with Inference Accelerators settings. [Detailed below.](#inference_accelerator) * `ipcMode` - IPC resource namespace to be used for the containers in the task The valid values are `host`, `task`, and `none`. * `memory` - Amount (in MiB) of memory used by the task. If the `requiresCompatibilities` is `FARGATE` this field is required. * `networkMode` - Docker networking mode to use for the containers in the task. Valid values are `none`, `bridge`, `awsvpc`, and `host`. @@ -97,11 +97,6 @@ The following arguments are optional: * `sizeInGib` - The total amount, in GiB, of ephemeral storage to set for the task. The minimum supported value is `21` GiB and the maximum supported value is `200` GiB. -### inference_accelerator - -* `deviceName` - Elastic Inference accelerator device name. The deviceName must also be referenced in a container definition as a ResourceRequirement. -* `deviceType` - Elastic Inference accelerator type to use. - ### placement_constraints * `expression` - Cluster Query Language expression to apply to the constraint. For more information, see [Cluster Query Language in the Amazon EC2 Container Service Developer Guide](http://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html). @@ -166,4 +161,4 @@ For more information, see [Specifying an FSX Windows File Server volume in your * `credentialsParameter` - The authorization credential option to use. The authorization credential options can be provided using either the Amazon Resource Name (ARN) of an AWS Secrets Manager secret or AWS Systems Manager Parameter Store parameter. The ARNs refer to the stored credentials. * `domain` - A fully qualified domain name hosted by an AWS Directory Service Managed Microsoft AD (Active Directory) or self-hosted AD on Amazon EC2. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/ecs_task_execution.html.markdown b/website/docs/cdktf/typescript/d/ecs_task_execution.html.markdown index 921b60567621..5c6a96ae6b6a 100644 --- a/website/docs/cdktf/typescript/d/ecs_task_execution.html.markdown +++ b/website/docs/cdktf/typescript/d/ecs_task_execution.html.markdown @@ -55,6 +55,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `capacityProviderStrategy` - (Optional) Set of capacity provider strategies to use for the cluster. See below. * `clientToken` - (Optional) An identifier that you provide to ensure the idempotency of the request. It must be unique and is case sensitive. Up to 64 characters are allowed. The valid characters are characters in the range of 33-126, inclusive. For more information, see [Ensuring idempotency](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/ECS_Idempotency.html). * `desiredCount` - (Optional) Number of instantiations of the specified task to place on your cluster. You can specify up to 10 tasks for each call. @@ -91,7 +92,6 @@ For more information, see the [Task Networking](https://docs.aws.amazon.com/Amaz * `containerOverrides` - (Optional) One or more container overrides that are sent to a task. See below. * `cpu` - (Optional) The CPU override for the task. * `executionRoleArn` - (Optional) Amazon Resource Name (ARN) of the task execution role override for the task. -* `inferenceAcceleratorOverrides` - (Optional) **DEPRECATED** Elastic Inference accelerator override for the task. See below. * `memory` - (Optional) The memory override for the task. * `taskRoleArn` - (Optional) Amazon Resource Name (ARN) of the role that containers in this task can assume. @@ -112,13 +112,8 @@ For more information, see the [Task Networking](https://docs.aws.amazon.com/Amaz ### resource_requirements -* `type` - (Required) The type of resource to assign to a container. Valid values are `GPU` or `InferenceAccelerator`. -* `value` - (Required) The value for the specified resource type. If the `GPU` type is used, the value is the number of physical GPUs the Amazon ECS container agent reserves for the container. The number of GPUs that's reserved for all containers in a task can't exceed the number of available GPUs on the container instance that the task is launched on. If the `InferenceAccelerator` type is used, the value matches the `deviceName` for an InferenceAccelerator specified in a task definition. - -### inference_accelerator_overrides - -* `deviceName` - (Optional) The Elastic Inference accelerator device name to override for the task. This parameter must match a deviceName specified in the task definition. -* `deviceType` - (Optional) The Elastic Inference accelerator type to use. +* `type` - (Required) The type of resource to assign to a container. Valid values are `GPU`. +* `value` - (Required) The value for the specified resource type. If the `GPU` type is used, the value is the number of physical GPUs the Amazon ECS container agent reserves for the container. The number of GPUs that's reserved for all containers in a task can't exceed the number of available GPUs on the container instance that the task is launched on. ### placement_constraints @@ -139,4 +134,4 @@ This data source exports the following attributes in addition to the arguments a * `taskArns` - A list of the provisioned task ARNs. * `id` - The unique identifier, which is a comma-delimited string joining the `cluster` and `taskDefinition` attributes. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/efs_access_point.html.markdown b/website/docs/cdktf/typescript/d/efs_access_point.html.markdown index 9ba0fa7f7092..9f71d9e1ec50 100644 --- a/website/docs/cdktf/typescript/d/efs_access_point.html.markdown +++ b/website/docs/cdktf/typescript/d/efs_access_point.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `accessPointId` - (Required) ID that identifies the file system. ## Attribute Reference @@ -60,4 +61,4 @@ This data source exports the following attributes in addition to the arguments a * `path` - Path exposed as the root directory * `tags` - Key-value mapping of resource tags. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/efs_access_points.html.markdown b/website/docs/cdktf/typescript/d/efs_access_points.html.markdown index e91f42814bad..161de4ec196f 100644 --- a/website/docs/cdktf/typescript/d/efs_access_points.html.markdown +++ b/website/docs/cdktf/typescript/d/efs_access_points.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `fileSystemId` - (Required) EFS File System identifier. ## Attribute Reference @@ -48,4 +49,4 @@ This data source exports the following attributes in addition to the arguments a * `id` - EFS File System identifier. * `ids` - Set of identifiers. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/efs_file_system.html.markdown b/website/docs/cdktf/typescript/d/efs_file_system.html.markdown index c368f628a72b..5dc7e13a2338 100644 --- a/website/docs/cdktf/typescript/d/efs_file_system.html.markdown +++ b/website/docs/cdktf/typescript/d/efs_file_system.html.markdown @@ -49,6 +49,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `fileSystemId` - (Optional) ID that identifies the file system (e.g., fs-ccfc0d65). * `creationToken` - (Optional) Restricts the list to the file system with this creation token. * `tags` - (Optional) Restricts the list to the file system with these tags. @@ -71,4 +72,4 @@ This data source exports the following attributes in addition to the arguments a * `throughputMode` - Throughput mode for the file system. * `sizeInBytes` - Current byte count used by the file system. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/efs_mount_target.html.markdown b/website/docs/cdktf/typescript/d/efs_mount_target.html.markdown index 58942e20b336..dad7da845176 100644 --- a/website/docs/cdktf/typescript/d/efs_mount_target.html.markdown +++ b/website/docs/cdktf/typescript/d/efs_mount_target.html.markdown @@ -44,6 +44,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `accessPointId` - (Optional) ID or ARN of the access point whose mount target that you want to find. It must be included if a `fileSystemId` and `mountTargetId` are not included. * `fileSystemId` - (Optional) ID or ARN of the file system whose mount target that you want to find. It must be included if an `accessPointId` and `mountTargetId` are not included. * `mountTargetId` - (Optional) ID or ARN of the mount target that you want to find. It must be included in your request if an `accessPointId` and `fileSystemId` are not included. @@ -55,6 +56,8 @@ This data source exports the following attributes in addition to the arguments a * `fileSystemArn` - Amazon Resource Name of the file system for which the mount target is intended. * `subnetId` - ID of the mount target's subnet. * `ipAddress` - Address at which the file system may be mounted via the mount target. +* `ipAddressType` - IP address type for the mount target. +* `ipv6Address` - IPv6 address at which the file system may be mounted via the mount target. * `securityGroups` - List of VPC security group IDs attached to the mount target. * `dnsName` - DNS name for the EFS file system. * `mountTargetDnsName` - The DNS name for the given subnet/AZ per [documented convention](http://docs.aws.amazon.com/efs/latest/ug/mounting-fs-mount-cmd-dns-name.html). @@ -63,4 +66,4 @@ This data source exports the following attributes in addition to the arguments a * `availabilityZoneId` - The unique and consistent identifier of the Availability Zone (AZ) that the mount target resides in. * `ownerId` - AWS account ID that owns the resource. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/eip.html.markdown b/website/docs/cdktf/typescript/d/eip.html.markdown index 27c0f66e5af2..a869dacbdb3a 100644 --- a/website/docs/cdktf/typescript/d/eip.html.markdown +++ b/website/docs/cdktf/typescript/d/eip.html.markdown @@ -113,6 +113,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `filter` - (Optional) One or more name/value pairs to use as filters. There are several valid keys, for a full reference, check out the [EC2 API Reference](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeAddresses.html). * `id` - (Optional) Allocation ID of the specific VPC EIP to retrieve. If a classic EIP is required, do NOT set `id`, only set `publicIp` * `publicIp` - (Optional) Public IP of the specific EIP to retrieve. @@ -152,4 +153,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/eips.html.markdown b/website/docs/cdktf/typescript/d/eips.html.markdown index c8087eebaf55..4d8ca41a1e02 100644 --- a/website/docs/cdktf/typescript/d/eips.html.markdown +++ b/website/docs/cdktf/typescript/d/eips.html.markdown @@ -48,6 +48,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `filter` - (Optional) Custom filter block as described below. * `tags` - (Optional) Map of tags, each pair of which must exactly match a pair on the desired Elastic IPs. @@ -71,4 +72,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/eks_access_entry.html.markdown b/website/docs/cdktf/typescript/d/eks_access_entry.html.markdown index 7c371389f9a2..6b44fa0d9e2c 100644 --- a/website/docs/cdktf/typescript/d/eks_access_entry.html.markdown +++ b/website/docs/cdktf/typescript/d/eks_access_entry.html.markdown @@ -42,8 +42,9 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: -* `clusterName` – (Required) Name of the EKS Cluster. -* `principalArn` – (Required) The IAM Principal ARN which requires Authentication access to the EKS cluster. +* `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). +* `clusterName` - (Required) Name of the EKS Cluster. +* `principalArn` - (Required) The IAM Principal ARN which requires Authentication access to the EKS cluster. ## Attribute Reference @@ -51,10 +52,10 @@ This data source exports the following attributes in addition to the arguments a * `accessEntryArn` - Amazon Resource Name (ARN) of the Access Entry. * `createdAt` - Date and time in [RFC3339 format](https://tools.ietf.org/html/rfc3339#section-5.8) that the EKS add-on was created. -* `kubernetesGroups` – List of string which can optionally specify the Kubernetes groups the user would belong to when creating an access entry. +* `kubernetesGroups` - List of string which can optionally specify the Kubernetes groups the user would belong to when creating an access entry. * `modifiedAt` - Date and time in [RFC3339 format](https://tools.ietf.org/html/rfc3339#section-5.8) that the EKS add-on was updated. * `userName` - Defaults to principal ARN if user is principal else defaults to assume-role/session-name is role is used. * `type` - Defaults to STANDARD which provides the standard workflow. EC2_LINUX, EC2_WINDOWS, FARGATE_LINUX types disallow users to input a username or groups, and prevent associations. * `tagsAll` - (Optional) Key-value map of resource tags, including those inherited from the provider [`defaultTags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/eks_addon.html.markdown b/website/docs/cdktf/typescript/d/eks_addon.html.markdown index e3a9ff77ecad..8f3752e212dd 100644 --- a/website/docs/cdktf/typescript/d/eks_addon.html.markdown +++ b/website/docs/cdktf/typescript/d/eks_addon.html.markdown @@ -42,9 +42,10 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: -* `addonName` – (Required) Name of the EKS add-on. The name must match one of +* `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). +* `addonName` - (Required) Name of the EKS add-on. The name must match one of the names returned by [list-addon](https://docs.aws.amazon.com/cli/latest/reference/eks/list-addons.html). -* `clusterName` – (Required) Name of the EKS Cluster. +* `clusterName` - (Required) Name of the EKS Cluster. ## Attribute Reference @@ -62,4 +63,4 @@ This data source exports the following attributes in addition to the arguments a * `createdAt` - Date and time in [RFC3339 format](https://tools.ietf.org/html/rfc3339#section-5.8) that the EKS add-on was created. * `modifiedAt` - Date and time in [RFC3339 format](https://tools.ietf.org/html/rfc3339#section-5.8) that the EKS add-on was updated. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/eks_addon_version.html.markdown b/website/docs/cdktf/typescript/d/eks_addon_version.html.markdown index c2698731f741..528f9207509a 100644 --- a/website/docs/cdktf/typescript/d/eks_addon_version.html.markdown +++ b/website/docs/cdktf/typescript/d/eks_addon_version.html.markdown @@ -60,9 +60,10 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: -* `addonName` – (Required) Name of the EKS add-on. The name must match one of +* `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). +* `addonName` - (Required) Name of the EKS add-on. The name must match one of the names returned by [list-addon](https://docs.aws.amazon.com/cli/latest/reference/eks/list-addons.html). -* `kubernetesVersion` – (Required) Version of the EKS Cluster. Must be between 1-100 characters in length. Must begin with an alphanumeric character, and must only contain alphanumeric characters, dashes and underscores (`^[0-9A-Za-z][A-Za-z0-9\-_]+$`). +* `kubernetesVersion` - (Required) Version of the EKS Cluster. Must be between 1-100 characters in length. Must begin with an alphanumeric character, and must only contain alphanumeric characters, dashes and underscores (`^[0-9A-Za-z][A-Za-z0-9\-_]+$`). * `mostRecent` - (Optional) Determines if the most recent or default version of the addon should be returned. ## Attribute Reference @@ -72,4 +73,4 @@ This data source exports the following attributes in addition to the arguments a * `id` - Name of the add-on * `version` - Version of the EKS add-on. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/eks_cluster.html.markdown b/website/docs/cdktf/typescript/d/eks_cluster.html.markdown index 7217a0cb2b1a..b5c0f2b680a1 100644 --- a/website/docs/cdktf/typescript/d/eks_cluster.html.markdown +++ b/website/docs/cdktf/typescript/d/eks_cluster.html.markdown @@ -44,6 +44,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `name` - (Required) Name of the cluster. ## Attribute Reference @@ -63,6 +64,7 @@ This data source exports the following attributes in addition to the arguments a * `data` - The base64 encoded certificate data required to communicate with your cluster. Add this to the `certificate-authority-data` section of the `kubeconfig` file for your cluster. * `clusterId` - The ID of your local Amazon EKS cluster on the AWS Outpost. This attribute isn't available for an AWS EKS cluster on AWS cloud. * `createdAt` - Unix epoch time stamp in seconds for when the cluster was created. +* `deletionProtection` - Whether deletion protection for the cluster is enabled. * `enabledClusterLogTypes` - The enabled control plane logs. * `endpoint` - Endpoint for your Kubernetes API server. * `identity` - Nested attribute containing identity provider information for your cluster. Only available on Kubernetes version 1.13 and 1.14 clusters created or upgraded on or after September 3, 2019. For an example using this information to enable IAM Roles for Service Accounts, see the [`aws_eks_cluster` resource documentation](/docs/providers/aws/r/eks_cluster.html). @@ -99,10 +101,10 @@ This data source exports the following attributes in addition to the arguments a * `endpointPrivateAccess` - Indicates whether or not the Amazon EKS private API server endpoint is enabled. * `endpointPublicAccess` - Indicates whether or not the Amazon EKS public API server endpoint is enabled. * `publicAccessCidrs` - List of CIDR blocks. Indicates which CIDR blocks can access the Amazon EKS public API server endpoint. - * `securityGroupIds` – List of security group IDs - * `subnetIds` – List of subnet IDs - * `vpcId` – The VPC associated with your cluster. + * `securityGroupIds` - List of security group IDs + * `subnetIds` - List of subnet IDs + * `vpcId` - The VPC associated with your cluster. * `zonalShiftConfig` - Contains Zonal Shift Configuration. * `enabled` - Whether zonal shift is enabled. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/eks_cluster_auth.html.markdown b/website/docs/cdktf/typescript/d/eks_cluster_auth.html.markdown index 4345d61836be..3d43c4f33536 100644 --- a/website/docs/cdktf/typescript/d/eks_cluster_auth.html.markdown +++ b/website/docs/cdktf/typescript/d/eks_cluster_auth.html.markdown @@ -67,6 +67,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `name` - (Required) Name of the cluster ## Attribute Reference @@ -76,4 +77,4 @@ This data source exports the following attributes in addition to the arguments a * `id` - Name of the cluster. * `token` - Token to use to authenticate with the cluster. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/eks_cluster_versions.html.markdown b/website/docs/cdktf/typescript/d/eks_cluster_versions.html.markdown index f10d990f031e..c6e8f043daa4 100644 --- a/website/docs/cdktf/typescript/d/eks_cluster_versions.html.markdown +++ b/website/docs/cdktf/typescript/d/eks_cluster_versions.html.markdown @@ -19,7 +19,7 @@ Terraform data source for managing AWS EKS (Elastic Kubernetes) Cluster Versions ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug import { Construct } from "constructs"; -import { TerraformStack } from "cdktf"; +import { TerraformOutput, TerraformStack } from "cdktf"; /* * Provider bindings are generated by running `cdktf get`. * See https://cdk.tf/provider-generation for more details. @@ -28,7 +28,22 @@ import { DataAwsEksClusterVersions } from "./.gen/providers/aws/data-aws-eks-clu class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); - new DataAwsEksClusterVersions(this, "example", {}); + const example = new DataAwsEksClusterVersions(this, "example", {}); + new TerraformOutput(this, "eks_cluster_version_filtered", { + value: + "${[ for version in ${" + + example.clusterVersions + + '} : version if version.cluster_version == "1.33"]}', + }); + new TerraformOutput(this, "eks_cluster_version_list", { + value: + "${[ for version in ${" + + example.clusterVersions + + "} : version.cluster_version]}", + }); + new TerraformOutput(this, "eks_cluster_versions", { + value: example.clusterVersions, + }); } } @@ -82,9 +97,9 @@ class MyConvertedCode extends TerraformStack { The following arguments are optional: +* `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). * `clusterType` - (Optional) Type of clusters to filter by. Currently, the only valid value is `eks`. -* `clusterVersions` - (Optional) A list of Kubernetes versions that you can use to check if EKS supports it. * `defaultOnly` - (Optional) Whether to show only the default versions of Kubernetes supported by EKS. * `includeAll` - (Optional) Whether to include all kubernetes versions in the response. * `versionStatus` - (Optional) Status of the EKS cluster versions to list. @@ -94,14 +109,15 @@ Valid values are `STANDARD_SUPPORT` or `UNSUPPORTED` or `EXTENDED_SUPPORT`. This data source exports the following attributes in addition to the arguments above: -* `clusterType` - Type of cluster that the version belongs to. -* `clusterVersion` - Kubernetes version supported by EKS. -* `default_platform_version` - Default eks platform version for the cluster version. -* `defaultVersion` - Default Kubernetes version for the cluster version. -* `end_of_extended_support_date` - End of extended support date for the cluster version. -* `end_of_standard_support_date` - End of standard support date for the cluster version. -* `kubernetes_patch_version` - Kubernetes patch version for the cluster version. -* `releaseDate` - Release date of the cluster version. -* `versionStatus` - Status of the EKS cluster version. - - \ No newline at end of file +* `clusterVersions` - A list of Kubernetes version information. + * `clusterType` - Type of cluster that the version belongs to. + * `clusterVersion` - Kubernetes version supported by EKS. + * `default_platform_version` - Default eks platform version for the cluster version. + * `defaultVersion` - Default Kubernetes version for the cluster version. + * `end_of_extended_support_date` - End of extended support date for the cluster version. + * `end_of_standard_support_date` - End of standard support date for the cluster version. + * `kubernetes_patch_version` - Kubernetes patch version for the cluster version. + * `releaseDate` - Release date of the cluster version. + * `versionStatus` - Status of the EKS cluster version. + + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/eks_clusters.html.markdown b/website/docs/cdktf/typescript/d/eks_clusters.html.markdown index 513a0319e694..c4951cd4706d 100644 --- a/website/docs/cdktf/typescript/d/eks_clusters.html.markdown +++ b/website/docs/cdktf/typescript/d/eks_clusters.html.markdown @@ -48,7 +48,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -This data source does not support any arguments. +This data source supports the following arguments: + +* `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). ## Attribute Reference @@ -57,4 +59,4 @@ This data source exports the following attributes in addition to the arguments a * `id` - AWS Region. * `names` - Set of EKS clusters names - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/eks_node_group.html.markdown b/website/docs/cdktf/typescript/d/eks_node_group.html.markdown index 64219372eeb3..063074d9242e 100644 --- a/website/docs/cdktf/typescript/d/eks_node_group.html.markdown +++ b/website/docs/cdktf/typescript/d/eks_node_group.html.markdown @@ -39,6 +39,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `clusterName` - (Required) Name of the cluster. * `nodeGroupName` - (Required) Name of the node group. @@ -57,8 +58,8 @@ This data source exports the following attributes in addition to the arguments a * `id` - The ID of the launch template. * `name` - The name of the launch template. * `version` - The version number of the launch template. -* `nodeRoleArn` – ARN of the IAM Role that provides permissions for the EKS Node Group. -* `releaseVersion` – AMI version of the EKS Node Group. +* `nodeRoleArn` - ARN of the IAM Role that provides permissions for the EKS Node Group. +* `releaseVersion` - AMI version of the EKS Node Group. * `remoteAccess` - Configuration block with remote access settings. * `ec2SshKey` - EC2 Key Pair name that provides access for SSH communication with the worker nodes in the EKS Node Group. * `sourceSecurityGroupIds` - Set of EC2 Security Group IDs to allow SSH access (port 22) from on the worker nodes. @@ -71,12 +72,12 @@ This data source exports the following attributes in addition to the arguments a * `maxSize` - Maximum number of worker nodes. * `minSize` - Minimum number of worker nodes. * `status` - Status of the EKS Node Group. -* `subnetIds` – Identifiers of EC2 Subnets to associate with the EKS Node Group. +* `subnetIds` - Identifiers of EC2 Subnets to associate with the EKS Node Group. * `taints` - List of objects containing information about taints applied to the nodes in the EKS Node Group. * `key` - The key of the taint. * `value` - The value of the taint. * `effect` - The effect of the taint. * `tags` - Key-value map of resource tags. -* `version` – Kubernetes version. +* `version` - Kubernetes version. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/eks_node_groups.html.markdown b/website/docs/cdktf/typescript/d/eks_node_groups.html.markdown index 505c6892ff8d..51cb5e68caa5 100644 --- a/website/docs/cdktf/typescript/d/eks_node_groups.html.markdown +++ b/website/docs/cdktf/typescript/d/eks_node_groups.html.markdown @@ -57,6 +57,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `clusterName` - (Required) Name of the cluster. ## Attribute Reference @@ -66,4 +67,4 @@ This data source exports the following attributes in addition to the arguments a * `id` - Cluster name. * `names` - Set of all node group names in an EKS Cluster. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/elastic_beanstalk_application.html.markdown b/website/docs/cdktf/typescript/d/elastic_beanstalk_application.html.markdown index 168ed97487c6..5bff28b9c613 100644 --- a/website/docs/cdktf/typescript/d/elastic_beanstalk_application.html.markdown +++ b/website/docs/cdktf/typescript/d/elastic_beanstalk_application.html.markdown @@ -44,6 +44,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `name` - (Required) Name of the application ## Attribute Reference @@ -61,4 +62,4 @@ Application version lifecycle (`appversionLifecycle`) supports the nested attrib * `maxAgeInDays` - Number of days to retain an application version. * `deleteSourceFromS3` - Specifies whether delete a version's source bundle from S3 when the application version is deleted. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/elastic_beanstalk_hosted_zone.html.markdown b/website/docs/cdktf/typescript/d/elastic_beanstalk_hosted_zone.html.markdown index c8c2cef32c07..a4a68cc7cb50 100644 --- a/website/docs/cdktf/typescript/d/elastic_beanstalk_hosted_zone.html.markdown +++ b/website/docs/cdktf/typescript/d/elastic_beanstalk_hosted_zone.html.markdown @@ -36,7 +36,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: -* `region` - (Optional) Region you'd like the zone for. By default, fetches the current region. +* `region` - (Optional) Name of the Region whose hosted zone is desired. Defaults to the Region set in the [provider configuration](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#aws-configuration-reference). ## Attribute Reference @@ -44,6 +44,4 @@ This data source exports the following attributes in addition to the arguments a * `id` - ID of the hosted zone. -* `region` - Region of the hosted zone. - - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/elastic_beanstalk_solution_stack.html.markdown b/website/docs/cdktf/typescript/d/elastic_beanstalk_solution_stack.html.markdown index 6025e3c8802f..79c740ae85e7 100644 --- a/website/docs/cdktf/typescript/d/elastic_beanstalk_solution_stack.html.markdown +++ b/website/docs/cdktf/typescript/d/elastic_beanstalk_solution_stack.html.markdown @@ -39,6 +39,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `mostRecent` - (Optional) If more than one result is returned, use the most recent solution stack. * `nameRegex` - Regex string to apply to the solution stack list returned @@ -57,4 +58,4 @@ This data source exports the following attributes in addition to the arguments a [beanstalk-platforms]: http://docs.aws.amazon.com/elasticbeanstalk/latest/dg/concepts.platforms.html "AWS Elastic Beanstalk Supported Platforms documentation" - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/elasticache_cluster.html.markdown b/website/docs/cdktf/typescript/d/elasticache_cluster.html.markdown index 04e3573be8ff..4d43c0791589 100644 --- a/website/docs/cdktf/typescript/d/elasticache_cluster.html.markdown +++ b/website/docs/cdktf/typescript/d/elasticache_cluster.html.markdown @@ -38,33 +38,34 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: -* `clusterId` – (Required) Group identifier. +* `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). +* `clusterId` - (Required) Group identifier. ## Attribute Reference This data source exports the following attributes in addition to the arguments above: -* `nodeType` – The cluster node type. -* `numCacheNodes` – The number of cache nodes that the cache cluster has. -* `engine` – Name of the cache engine. -* `engineVersion` – Version number of the cache engine. +* `nodeType` - The cluster node type. +* `numCacheNodes` - The number of cache nodes that the cache cluster has. +* `engine` - Name of the cache engine. +* `engineVersion` - Version number of the cache engine. * `ipDiscovery` - The IP version advertised in the discovery protocol. * `networkType` - The IP versions for cache cluster connections. -* `subnetGroupName` – Name of the subnet group associated to the cache cluster. -* `securityGroupIds` – List VPC security groups associated with the cache cluster. -* `parameterGroupName` – Name of the parameter group associated with this cache cluster. +* `subnetGroupName` - Name of the subnet group associated to the cache cluster. +* `securityGroupIds` - List VPC security groups associated with the cache cluster. +* `parameterGroupName` - Name of the parameter group associated with this cache cluster. * `replicationGroupId` - The replication group to which this cache cluster belongs. * `logDeliveryConfiguration` - Redis [SLOWLOG](https://redis.io/commands/slowlog) or Redis [Engine Log](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Log_Delivery.html#Log_contents-engine-log) delivery settings. -* `maintenanceWindow` – Specifies the weekly time range for when maintenance +* `maintenanceWindow` - Specifies the weekly time range for when maintenance on the cache cluster is performed. * `snapshotWindow` - Daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of the cache cluster. * `snapshotRetentionLimit` - The number of days for which ElastiCache will retain automatic cache cluster snapshots before deleting them. * `availabilityZone` - Availability Zone for the cache cluster. -* `notificationTopicArn` – An ARN of an +* `notificationTopicArn` - An ARN of an SNS topic that ElastiCache notifications get sent to. -* `port` – The port number on which each of the cache nodes will +* `port` - The port number on which each of the cache nodes will accept connections. * `configurationEndpoint` - (Memcached only) Configuration endpoint to allow host discovery. * `clusterAddress` - (Memcached only) DNS name of the cache cluster without the port appended. @@ -73,4 +74,4 @@ accept connections. Referenceable e.g., as `${data.aws_elasticache_cluster.bar.cache_nodes.0.address}` * `tags` - Tags assigned to the resource - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/elasticache_replication_group.html.markdown b/website/docs/cdktf/typescript/d/elasticache_replication_group.html.markdown index 18c391fa8fac..10091cdd4ba4 100644 --- a/website/docs/cdktf/typescript/d/elasticache_replication_group.html.markdown +++ b/website/docs/cdktf/typescript/d/elasticache_replication_group.html.markdown @@ -38,7 +38,8 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: -* `replicationGroupId` – (Required) Identifier for the replication group. +* `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). +* `replicationGroupId` - (Required) Identifier for the replication group. ## Attribute Reference @@ -49,8 +50,8 @@ This data source exports the following attributes in addition to the arguments a * `authTokenEnabled` - Whether an AuthToken (password) is enabled. * `automaticFailoverEnabled` - A flag whether a read-only replica will be automatically promoted to read/write primary if the existing primary fails. * `clusterMode` - Whether cluster mode is enabled or disabled. -* `nodeType` – The cluster node type. -* `numCacheClusters` – The number of cache clusters that the replication group has. +* `nodeType` - The cluster node type. +* `numCacheClusters` - The number of cache clusters that the replication group has. * `numNodeGroups` - Number of node groups (shards) for the replication group. * `memberClusters` - Identifiers of all the nodes that are part of this replication group. * `multiAzEnabled` - Whether Multi-AZ Support is enabled for the replication group. @@ -58,9 +59,9 @@ This data source exports the following attributes in addition to the arguments a * `logDeliveryConfiguration` - Redis [SLOWLOG](https://redis.io/commands/slowlog) or Redis [Engine Log](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Log_Delivery.html#Log_contents-engine-log) delivery settings. * `snapshotWindow` - Daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard). * `snapshotRetentionLimit` - The number of days for which ElastiCache retains automatic cache cluster snapshots before deleting them. -* `port` – The port number on which the configuration endpoint will accept connections. +* `port` - The port number on which the configuration endpoint will accept connections. * `configurationEndpointAddress` - The configuration endpoint address to allow host discovery. * `primaryEndpointAddress` - The endpoint of the primary node in this node group (shard). * `readerEndpointAddress` - The endpoint of the reader node in this node group (shard). - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/elasticache_reserved_cache_node_offering.html.markdown b/website/docs/cdktf/typescript/d/elasticache_reserved_cache_node_offering.html.markdown index 9f8987b66a0d..996379d35e38 100644 --- a/website/docs/cdktf/typescript/d/elasticache_reserved_cache_node_offering.html.markdown +++ b/website/docs/cdktf/typescript/d/elasticache_reserved_cache_node_offering.html.markdown @@ -41,6 +41,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `cacheNodeType` - (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). @@ -61,4 +62,4 @@ This data source exports the following attributes in addition to the arguments a * `fixedPrice` - Fixed price charged for this reserved cache node. * `offeringId` - Unique identifier for the reservation. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/elasticache_serverless_cache.html.markdown b/website/docs/cdktf/typescript/d/elasticache_serverless_cache.html.markdown index 67b13574bdb5..b5efb09dc9aa 100644 --- a/website/docs/cdktf/typescript/d/elasticache_serverless_cache.html.markdown +++ b/website/docs/cdktf/typescript/d/elasticache_serverless_cache.html.markdown @@ -38,7 +38,8 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: -* `name` – (Required) Identifier for the serverless cache. +* `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). +* `name` - (Required) Identifier for the serverless cache. ## Attribute Reference @@ -50,7 +51,7 @@ This data source exports the following attributes in addition to the arguments a * `dailySnapshotTime` - The daily time that snapshots will be created from the new serverless cache. Only available for engine types `"redis"` and `"valkey"`. * `description` - Description of the serverless cache. * `endpoint` - Represents the information required for client programs to connect to the cache. See [`endpoint` Block](#endpoint-block) for details. -* `engine` – Name of the cache engine. +* `engine` - Name of the cache engine. * `fullEngineVersion` - The name and version number of the engine the serverless cache is compatible with. * `kmsKeyId` - ARN of the customer managed key for encrypting the data at rest. * `majorEngineVersion` - The version number of the engine the serverless cache is compatible with. @@ -58,7 +59,7 @@ This data source exports the following attributes in addition to the arguments a * `securityGroupIds` - A list of the one or more VPC security groups associated with the serverless cache. * `snapshotRetentionLimit` - The number of snapshots that will be retained for the serverless cache. Available for Redis only. * `status` - The current status of the serverless cache. -* `subnetIds` – A list of the identifiers of the subnets where the VPC endpoint for the serverless cache are deployed. +* `subnetIds` - A list of the identifiers of the subnets where the VPC endpoint for the serverless cache are deployed. * `userGroupId` - The identifier of the UserGroup associated with the serverless cache. Available for Redis only. ### `cacheUsageLimits` Block @@ -97,4 +98,4 @@ The `readerEndpoint` block exports the following attributes: * `address` - The DNS hostname of the cache node. * `port` - The port number that the cache engine is listening on. Set as integer. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/elasticache_subnet_group.html.markdown b/website/docs/cdktf/typescript/d/elasticache_subnet_group.html.markdown index 0ab460d16fe5..0e894e5feaf3 100644 --- a/website/docs/cdktf/typescript/d/elasticache_subnet_group.html.markdown +++ b/website/docs/cdktf/typescript/d/elasticache_subnet_group.html.markdown @@ -36,8 +36,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `name` - (Required) Name of the subnet group. ## Attribute Reference @@ -51,4 +52,4 @@ This data source exports the following attributes in addition to the arguments a * `tags` - Map of tags assigned to the subnet group. * `vpcId` - The Amazon Virtual Private Cloud identifier (VPC ID) of the cache subnet group. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/elasticache_user.html.markdown b/website/docs/cdktf/typescript/d/elasticache_user.html.markdown index 6536279ad89a..dd71ada136f3 100644 --- a/website/docs/cdktf/typescript/d/elasticache_user.html.markdown +++ b/website/docs/cdktf/typescript/d/elasticache_user.html.markdown @@ -38,7 +38,8 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: -* `userId` – (Required) Identifier for the user. +* `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). +* `userId` - (Required) Identifier for the user. ## Attribute Reference @@ -48,4 +49,4 @@ This data source exports the following attributes in addition to the arguments a * `userName` - User name of the user. * `accessString` - String for what access a user possesses within the associated ElastiCache replication groups or clusters. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/elasticsearch_domain.html.markdown b/website/docs/cdktf/typescript/d/elasticsearch_domain.html.markdown index 907b0f4b7d08..09afdac02cd1 100644 --- a/website/docs/cdktf/typescript/d/elasticsearch_domain.html.markdown +++ b/website/docs/cdktf/typescript/d/elasticsearch_domain.html.markdown @@ -38,18 +38,19 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: -* `domainName` – (Required) Name of the domain. +* `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). +* `domainName` - (Required) Name of the domain. ## Attribute Reference This data source exports the following attributes in addition to the arguments above: -* `accessPolicies` – The policy document attached to the domain. +* `accessPolicies` - The policy document attached to the domain. * `advancedOptions` - Key-value string pairs to specify advanced configuration options. * `advancedSecurityOptions` - Status of the Elasticsearch domain's advanced security options. The block consists of the following attributes: * `enabled` - Whether advanced security is enabled. * `internalUserDatabaseEnabled` - Whether the internal user database is enabled. -* `arn` – The ARN of the domain. +* `arn` - The ARN of the domain. * `autoTuneOptions` - Configuration of the Auto-Tune options of the domain. * `desiredState` - The Auto-Tune desired state for the domain. * `maintenanceSchedule` - A list of the nested configurations for the Auto-Tune maintenance windows of the domain. @@ -78,20 +79,20 @@ This data source exports the following attributes in addition to the arguments a * `userPoolId` - The Cognito User pool used by the domain. * `identityPoolId` - The Cognito Identity pool used by the domain. * `roleArn` - The IAM Role with the AmazonESCognitoAccess policy attached. -* `created` – Status of the creation of the domain. -* `deleted` – Status of the deletion of the domain. -* `domainId` – Unique identifier for the domain. +* `created` - Status of the creation of the domain. +* `deleted` - Status of the deletion of the domain. +* `domainId` - Unique identifier for the domain. * `ebsOptions` - EBS Options for the instances in the domain. * `ebsEnabled` - Whether EBS volumes are attached to data nodes in the domain. * `throughput` - The throughput (in MiB/s) of the EBS volumes attached to data nodes. * `volumeType` - The type of EBS volumes attached to data nodes. * `volumeSize` - The size of EBS volumes attached to data nodes (in GB). * `iops` - The baseline input/output (I/O) performance of EBS volumes attached to data nodes. -* `elasticsearchVersion` – Elasticsearch version for the domain. +* `elasticsearchVersion` - Elasticsearch version for the domain. * `encryptionAtRest` - Domain encryption at rest related options. * `enabled` - Whether encryption at rest is enabled in the domain. * `kmsKeyId` - The KMS key id used to encrypt data at rest. -* `endpoint` – Domain-specific endpoint used to submit index, search, and data upload requests. +* `endpoint` - Domain-specific endpoint used to submit index, search, and data upload requests. * `kibanaEndpoint` - Domain-specific endpoint used to access the Kibana application. * `logPublishingOptions` - Domain log publishing related options. * `logType` - The type of Elasticsearch log being published. @@ -99,7 +100,7 @@ This data source exports the following attributes in addition to the arguments a * `enabled` - Whether log publishing is enabled. * `nodeToNodeEncryption` - Domain in transit encryption related options. * `enabled` - Whether node to node encryption is enabled. -* `processing` – Status of a configuration change in the domain. +* `processing` - Status of a configuration change in the domain. * `snapshotOptions` – Domain snapshot related options. * `automatedSnapshotStartHour` - Hour during which the service takes an automated daily snapshot of the indices in the domain. * `tags` - Tags assigned to the domain. @@ -109,4 +110,4 @@ This data source exports the following attributes in addition to the arguments a * `subnetIds` - The subnets used by the domain. * `vpcId` - The VPC used by the domain. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/elb.html.markdown b/website/docs/cdktf/typescript/d/elb.html.markdown index dcd680f15ddc..fbe982d9c7e9 100644 --- a/website/docs/cdktf/typescript/d/elb.html.markdown +++ b/website/docs/cdktf/typescript/d/elb.html.markdown @@ -50,6 +50,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `name` - (Required) Unique name of the load balancer. ## Attribute Reference @@ -59,4 +60,4 @@ This data source exports the following attributes in addition to the arguments a See the [ELB Resource](/docs/providers/aws/r/elb.html) for details on the returned attributes - they are identical. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/elb_hosted_zone_id.html.markdown b/website/docs/cdktf/typescript/d/elb_hosted_zone_id.html.markdown index 153e0ab6e25b..9cca5f0d41de 100644 --- a/website/docs/cdktf/typescript/d/elb_hosted_zone_id.html.markdown +++ b/website/docs/cdktf/typescript/d/elb_hosted_zone_id.html.markdown @@ -48,13 +48,12 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: -* `region` - (Optional) Name of the region whose AWS ELB HostedZoneId is desired. - Defaults to the region from the AWS provider configuration. +* `region` - (Optional) Name of the Region whose AWS ELB HostedZoneId is desired. Defaults to the Region set in the [provider configuration](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#aws-configuration-reference). ## Attribute Reference This data source exports the following attributes in addition to the arguments above: -* `id` - ID of the AWS ELB HostedZoneId in the selected region. +* `id` - ID of the AWS ELB HostedZoneId in the selected Region. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/elb_service_account.html.markdown b/website/docs/cdktf/typescript/d/elb_service_account.html.markdown index 80d85ea3bc7e..0abed53bb106 100644 --- a/website/docs/cdktf/typescript/d/elb_service_account.html.markdown +++ b/website/docs/cdktf/typescript/d/elb_service_account.html.markdown @@ -96,14 +96,13 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: -* `region` - (Optional) Name of the region whose AWS ELB account ID is desired. - Defaults to the region from the AWS provider configuration. +* `region` - (Optional) Name of the Region whose AWS ELB account ID is desired. Defaults to the Region set in the [provider configuration](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#aws-configuration-reference). ## Attribute Reference This data source exports the following attributes in addition to the arguments above: -* `id` - ID of the AWS ELB service account in the selected region. -* `arn` - ARN of the AWS ELB service account in the selected region. +* `id` - ID of the AWS ELB service account in the selected Region. +* `arn` - ARN of the AWS ELB service account in the selected Region. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/emr_release_labels.html.markdown b/website/docs/cdktf/typescript/d/emr_release_labels.html.markdown index 7b8f355ee8f9..b29d19966df8 100644 --- a/website/docs/cdktf/typescript/d/emr_release_labels.html.markdown +++ b/website/docs/cdktf/typescript/d/emr_release_labels.html.markdown @@ -41,7 +41,8 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: -* `filters` – (Optional) Filters the results of the request. Prefix specifies the prefix of release labels to return. Application specifies the application (with/without version) of release labels to return. See [Filters](#filters). +* `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). +* `filters` - (Optional) Filters the results of the request. Prefix specifies the prefix of release labels to return. Application specifies the application (with/without version) of release labels to return. See [Filters](#filters). ### Filters @@ -54,4 +55,4 @@ This data source exports the following attributes in addition to the arguments a * `releaseLabels` - Returned release labels. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/emr_supported_instance_types.html.markdown b/website/docs/cdktf/typescript/d/emr_supported_instance_types.html.markdown index 348e521e674d..68f3be34ec2b 100644 --- a/website/docs/cdktf/typescript/d/emr_supported_instance_types.html.markdown +++ b/website/docs/cdktf/typescript/d/emr_supported_instance_types.html.markdown @@ -93,8 +93,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `releaseLabel` - (Required) Amazon EMR release label. For more information about Amazon EMR releases and their included application versions and features, see the [Amazon EMR Release Guide](https://docs.aws.amazon.com/emr/latest/ReleaseGuide/emr-release-components.html). ## Attribute Reference @@ -106,15 +107,15 @@ This data source exports the following attributes in addition to the arguments a ### `supportedInstanceTypes` Attribute Reference * `architecture` - CPU architecture. -* `ebsOptimizedAvailable` - Indicates whether the instance type supports Amazon EBS optimization. -* `ebsOptimizedByDefault` - Indicates whether the instance type uses Amazon EBS optimization by default. -* `ebsStorageOnly` - Indicates whether the instance type only supports Amazon EBS. -* `instanceFamilyId` - The Amazon EC2 family and generation for the instance type. -* `is64BitsOnly` - Indicates whether the instance type only supports 64-bit architecture. -* `memoryGb` - Memory that is available to Amazon EMR from the instance type. -* `numberOfDisks` - Number of disks for the instance type. -* `storageGb` - Storage capacity of the instance type. +* `ebs_optimized_available` - Indicates whether the instance type supports Amazon EBS optimization. +* `ebs_optimized_by_default` - Indicates whether the instance type uses Amazon EBS optimization by default. +* `ebs_storage_only` - Indicates whether the instance type only supports Amazon EBS. +* `instance_family_id` - The Amazon EC2 family and generation for the instance type. +* `is_64_bits_only` - Indicates whether the instance type only supports 64-bit architecture. +* `memory_gb` - Memory that is available to Amazon EMR from the instance type. +* `number_of_disks` - Number of disks for the instance type. +* `storage_gb` - Storage capacity of the instance type. * `type` - Amazon EC2 instance type. For example, `m5.xlarge`. * `vcpu` - The number of vCPUs available for the instance type. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/emrcontainers_virtual_cluster.html.markdown b/website/docs/cdktf/typescript/d/emrcontainers_virtual_cluster.html.markdown index 219caa278c57..1a495eeef1ae 100644 --- a/website/docs/cdktf/typescript/d/emrcontainers_virtual_cluster.html.markdown +++ b/website/docs/cdktf/typescript/d/emrcontainers_virtual_cluster.html.markdown @@ -44,6 +44,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `virtualClusterId` - (Required) ID of the cluster. ## Attribute Reference @@ -63,4 +64,4 @@ This data source exports the following attributes in addition to the arguments a * `state` - Status of the EKS cluster. One of `RUNNING`, `TERMINATING`, `TERMINATED`, `ARRESTED`. * `tags` - Key-value mapping of resource tags. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/fis_experiment_templates.html.markdown b/website/docs/cdktf/typescript/d/fis_experiment_templates.html.markdown index 7fe5f945a532..39221f3d81e8 100644 --- a/website/docs/cdktf/typescript/d/fis_experiment_templates.html.markdown +++ b/website/docs/cdktf/typescript/d/fis_experiment_templates.html.markdown @@ -89,6 +89,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `tags` - (Optional) Map of tags, each pair of which must exactly match a pair on the desired experiment templates. @@ -98,4 +99,4 @@ This data source exports the following attributes in addition to the arguments a * `ids` - List of all the experiment template ids found. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/fsx_ontap_file_system.html.markdown b/website/docs/cdktf/typescript/d/fsx_ontap_file_system.html.markdown index d57b5e9ab607..88bd05952eb7 100644 --- a/website/docs/cdktf/typescript/d/fsx_ontap_file_system.html.markdown +++ b/website/docs/cdktf/typescript/d/fsx_ontap_file_system.html.markdown @@ -40,6 +40,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `id` - (Required) Identifier of the file system (e.g. `fs-12345678`). ## Attribute Reference @@ -87,4 +88,4 @@ This data source exports the following attributes in addition to the arguments a * `DNSName` - The file system's DNS name. You can mount your file system using its DNS name. * `IpAddresses` - IP addresses of the file system endpoint. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/fsx_ontap_storage_virtual_machine.html.markdown b/website/docs/cdktf/typescript/d/fsx_ontap_storage_virtual_machine.html.markdown index 819c40567af9..01251938b94e 100644 --- a/website/docs/cdktf/typescript/d/fsx_ontap_storage_virtual_machine.html.markdown +++ b/website/docs/cdktf/typescript/d/fsx_ontap_storage_virtual_machine.html.markdown @@ -67,6 +67,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `filter` - (Optional) Configuration block. Detailed below. * `id` - (Optional) Identifier of the storage virtual machine (e.g. `svm-12345678`). @@ -128,4 +129,4 @@ The following arguments are supported for `activeDirectoryConfiguration` configu * `DNSName` - The file system's DNS name. You can mount your file system using its DNS name. * `IpAddresses` - The SVM endpoint's IP addresses. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/fsx_ontap_storage_virtual_machines.html.markdown b/website/docs/cdktf/typescript/d/fsx_ontap_storage_virtual_machines.html.markdown index 738ed1e5931e..990a14eb8a41 100644 --- a/website/docs/cdktf/typescript/d/fsx_ontap_storage_virtual_machines.html.markdown +++ b/website/docs/cdktf/typescript/d/fsx_ontap_storage_virtual_machines.html.markdown @@ -45,6 +45,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `filter` - (Optional) Configuration block. Detailed below. ### filter @@ -62,4 +63,4 @@ This data source exports the following attributes in addition to the arguments a * `ids` - List of all SVM IDs found. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/fsx_openzfs_snapshot.html.markdown b/website/docs/cdktf/typescript/d/fsx_openzfs_snapshot.html.markdown index 2d4be00d5442..b9f9c95f5d1c 100644 --- a/website/docs/cdktf/typescript/d/fsx_openzfs_snapshot.html.markdown +++ b/website/docs/cdktf/typescript/d/fsx_openzfs_snapshot.html.markdown @@ -46,10 +46,9 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `mostRecent` - (Optional) If more than one result is returned, use the most recent snapshot. - * `snapshotIds` - (Optional) Returns information on a specific snapshot_id. - * `filter` - (Optional) One or more name/value pairs to filter off of. The supported names are file-system-id or volume-id. @@ -65,4 +64,4 @@ This data source exports the following attributes in addition to the arguments a * `tags` - List of Tag values, with a maximum of 50 elements. * `volumeId` - ID of the volume that the snapshot is of. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/fsx_windows_file_system.html.markdown b/website/docs/cdktf/typescript/d/fsx_windows_file_system.html.markdown index 9f061150b215..6c0be774fc5a 100644 --- a/website/docs/cdktf/typescript/d/fsx_windows_file_system.html.markdown +++ b/website/docs/cdktf/typescript/d/fsx_windows_file_system.html.markdown @@ -38,8 +38,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `id` - (Required) Identifier of the file system (e.g. `fs-12345678`). ## Attribute Reference @@ -69,4 +70,4 @@ This data source exports the following attributes in addition to the arguments a * `vpcId` - The ID of the primary virtual private cloud (VPC) for the file system. * `weeklyMaintenanceStartTime` - The preferred start time (in `d:HH:MM` format) to perform weekly maintenance, in the UTC time zone. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/glue_catalog_table.html.markdown b/website/docs/cdktf/typescript/d/glue_catalog_table.html.markdown index 434d84e8dbcb..d9796b8fd2c1 100644 --- a/website/docs/cdktf/typescript/d/glue_catalog_table.html.markdown +++ b/website/docs/cdktf/typescript/d/glue_catalog_table.html.markdown @@ -39,6 +39,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `name` - (Required) Name of the table. * `databaseName` - (Required) Name of the metadata database where the table metadata resides. * `catalogId` - (Optional) ID of the Glue Catalog and database where the table metadata resides. If omitted, this defaults to the current AWS Account ID. @@ -72,6 +73,7 @@ This data source exports the following attributes in addition to the arguments a * `comment` - Free-form text comment. * `name` - Name of the Partition Key. +* `parameters` - Map of key-value pairs. * `type` - Datatype of data in the Partition Key. ### storage_descriptor @@ -134,4 +136,4 @@ This data source exports the following attributes in addition to the arguments a * `name` - Name of the target table. * `region` - Region of the target table. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/glue_connection.html.markdown b/website/docs/cdktf/typescript/d/glue_connection.html.markdown index 0824c1331c21..53ae13dfa30d 100644 --- a/website/docs/cdktf/typescript/d/glue_connection.html.markdown +++ b/website/docs/cdktf/typescript/d/glue_connection.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `id` - (Required) Concatenation of the catalog ID and connection name. For example, if your account ID is `123456789123` and the connection name is `conn` then the ID is `123456789123:conn`. @@ -50,10 +51,10 @@ This data source exports the following attributes in addition to the arguments a * `athenaProperties` - A map of connection properties specific to the Athena compute environment. * `connectionProperties` - A map of connection properties. * `connectionType` - Type of Glue Connection. -* `description` – Description of the connection. -* `matchCriteria` – A list of criteria that can be used in selecting this connection. +* `description` - Description of the connection. +* `matchCriteria` - A list of criteria that can be used in selecting this connection. * `name` - Name of the Glue Connection. * `physicalConnectionRequirements` - A map of physical connection requirements, such as VPC and SecurityGroup. * `tags` - Tags assigned to the resource - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/glue_data_catalog_encryption_settings.html.markdown b/website/docs/cdktf/typescript/d/glue_data_catalog_encryption_settings.html.markdown index 6f1d1ce1da7d..e58d841cf1dd 100644 --- a/website/docs/cdktf/typescript/d/glue_data_catalog_encryption_settings.html.markdown +++ b/website/docs/cdktf/typescript/d/glue_data_catalog_encryption_settings.html.markdown @@ -42,14 +42,15 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `catalogId` - (Required) ID of the Data Catalog. This is typically the AWS account ID. ## Attribute Reference This data source exports the following attributes in addition to the arguments above: -* `dataCatalogEncryptionSettings` – The security configuration to set. see [Data Catalog Encryption Settings](#data_catalog_encryption_settings). -* `id` – The ID of the Data Catalog to set the security configuration for. +* `dataCatalogEncryptionSettings` - The security configuration to set. see [Data Catalog Encryption Settings](#data_catalog_encryption_settings). +* `id` - The ID of the Data Catalog to set the security configuration for. ### data_catalog_encryption_settings @@ -67,4 +68,4 @@ This data source exports the following attributes in addition to the arguments a * `catalogEncryptionServiceRole` - The ARN of the AWS IAM role used for accessing encrypted Data Catalog data. * `sseAwsKmsKeyId` - ARN of the AWS KMS key to use for encryption at rest. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/glue_registry.html.markdown b/website/docs/cdktf/typescript/d/glue_registry.html.markdown index 0dda40d0e84f..3cdb116a2df7 100644 --- a/website/docs/cdktf/typescript/d/glue_registry.html.markdown +++ b/website/docs/cdktf/typescript/d/glue_registry.html.markdown @@ -38,8 +38,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `name` - (Required) Name of the Glue Registry. ## Attribute Reference @@ -49,4 +50,4 @@ This data source exports the following attributes in addition to the arguments a * `arn` - Amazon Resource Name (ARN) of Glue Registry. * `description` - A description of the registry. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/glue_script.html.markdown b/website/docs/cdktf/typescript/d/glue_script.html.markdown index fdc74e11dc1c..71532ff9a422 100644 --- a/website/docs/cdktf/typescript/d/glue_script.html.markdown +++ b/website/docs/cdktf/typescript/d/glue_script.html.markdown @@ -222,6 +222,7 @@ output "scala_code" { This data source supports the following arguments: +* `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). * `dagEdge` - (Required) List of the edges in the DAG. Defined below. * `dagNode` - (Required) List of the nodes in the DAG. Defined below. * `language` - (Optional) Programming language of the resulting code from the DAG. Defaults to `PYTHON`. Valid values are `PYTHON` and `SCALA`. @@ -253,4 +254,4 @@ This data source exports the following attributes in addition to the arguments a * `pythonScript` - Python script generated from the DAG when the `language` argument is set to `PYTHON`. * `scalaCode` - Scala code generated from the DAG when the `language` argument is set to `SCALA`. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/grafana_workspace.html.markdown b/website/docs/cdktf/typescript/d/grafana_workspace.html.markdown index db93249bcf49..395cb81c45ed 100644 --- a/website/docs/cdktf/typescript/d/grafana_workspace.html.markdown +++ b/website/docs/cdktf/typescript/d/grafana_workspace.html.markdown @@ -38,8 +38,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `workspaceId` - (Required) Grafana workspace ID. ## Attribute Reference @@ -65,4 +66,4 @@ This data source exports the following attributes in addition to the arguments a * `status` - Status of the Grafana workspace. * `tags` - Tags assigned to the resource - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/guardduty_detector.html.markdown b/website/docs/cdktf/typescript/d/guardduty_detector.html.markdown index a76c78f7c305..c57f5fd35f0f 100644 --- a/website/docs/cdktf/typescript/d/guardduty_detector.html.markdown +++ b/website/docs/cdktf/typescript/d/guardduty_detector.html.markdown @@ -36,6 +36,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `id` - (Optional) ID of the detector. ## Attribute Reference @@ -54,4 +55,4 @@ This data source exports the following attributes in addition to the arguments a * `status` - Current status of the detector. * `tags` - Map of tags for the resource. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/guardduty_finding_ids.html.markdown b/website/docs/cdktf/typescript/d/guardduty_finding_ids.html.markdown index 3abee28cf999..0c023e8b9463 100644 --- a/website/docs/cdktf/typescript/d/guardduty_finding_ids.html.markdown +++ b/website/docs/cdktf/typescript/d/guardduty_finding_ids.html.markdown @@ -38,8 +38,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `detectorId` - (Required) ID of the GuardDuty detector. ## Attribute Reference @@ -49,4 +50,4 @@ This data source exports the following attributes in addition to the arguments a * `hasFindings` - Indicates whether findings are present for the specified detector. * `findingIds` - A list of finding IDs for the specified detector. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/iam_principal_policy_simulation.html.markdown b/website/docs/cdktf/typescript/d/iam_principal_policy_simulation.html.markdown index ea55e392ad42..100286901ef4 100644 --- a/website/docs/cdktf/typescript/d/iam_principal_policy_simulation.html.markdown +++ b/website/docs/cdktf/typescript/d/iam_principal_policy_simulation.html.markdown @@ -73,14 +73,14 @@ import { TerraformStack } from "cdktf"; * Provider bindings are generated by running `cdktf get`. * See https://cdk.tf/provider-generation for more details. */ -import { S3BucketObject } from "./.gen/providers/aws/s3-bucket-object"; +import { S3Object } from "./.gen/providers/aws/s3-object"; interface MyConfig { key: any; } class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string, config: MyConfig) { super(scope, name); - new S3BucketObject(this, "example", { + new S3Object(this, "example", { bucket: "my-test-bucket", dependsOn: [s3ObjectAccess], key: config.key, @@ -265,4 +265,4 @@ This data source exports the following attributes in addition to the arguments a * `missing_context_keys` - A set of context keys (or condition keys) that were needed by some of the policies contributing to this result but not specified using a `context` block in the configuration. Missing or incorrect context keys will typically cause a simulated request to be disallowed. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/identitystore_group.html.markdown b/website/docs/cdktf/typescript/d/identitystore_group.html.markdown index c840bfd52ca1..112ae2ba81e5 100644 --- a/website/docs/cdktf/typescript/d/identitystore_group.html.markdown +++ b/website/docs/cdktf/typescript/d/identitystore_group.html.markdown @@ -61,8 +61,8 @@ The following arguments are required: The following arguments are optional: +* `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). * `alternateIdentifier` (Optional) A unique identifier for the group that is not the primary identifier. Conflicts with `groupId` and `filter`. Detailed below. -* `filter` - (Optional, **Deprecated** use the `alternateIdentifier` attribute instead) Configuration block for filtering by a unique attribute of the group. Detailed below. * `groupId` - (Optional) The identifier for a group in the Identity Store. -> Exactly one of the above arguments must be provided. Passing both `filter` and `groupId` is allowed for backwards compatibility. @@ -83,15 +83,6 @@ The `externalId` configuration block supports the following arguments: * `id` - (Required) The identifier issued to this resource by an external identity provider. * `issuer` - (Required) The issuer for an external identifier. -### `filter` Configuration Block - -~> The `filter` configuration block has been deprecated. Use `alternateIdentifier` instead. - -The following arguments are supported by the `filter` configuration block: - -* `attributePath` - (Required) Attribute path that is used to specify which attribute name to search. Currently, `DisplayName` is the only valid attribute path. -* `attributeValue` - (Required) Value for an attribute. - ### `uniqueAttribute` Configuration Block The `uniqueAttribute` configuration block supports the following arguments: @@ -110,4 +101,4 @@ This data source exports the following attributes in addition to the arguments a * `id` - The identifier issued to this resource by an external identity provider. * `issuer` - The issuer for an external identifier. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/identitystore_group_memberships.html.markdown b/website/docs/cdktf/typescript/d/identitystore_group_memberships.html.markdown index d42068a93803..1374291c28bb 100644 --- a/website/docs/cdktf/typescript/d/identitystore_group_memberships.html.markdown +++ b/website/docs/cdktf/typescript/d/identitystore_group_memberships.html.markdown @@ -66,6 +66,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `groupId` - (Required) The identifier for a group in the Identity Store. * `identityStoreId` - (Required) Identity Store ID associated with the Single Sign-On Instance. @@ -86,4 +87,4 @@ This data source exports the following attributes in addition to the arguments a * `userId` - User identifier of the group member. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/identitystore_groups.html.markdown b/website/docs/cdktf/typescript/d/identitystore_groups.html.markdown index 82953786b0d1..68a4550c9112 100644 --- a/website/docs/cdktf/typescript/d/identitystore_groups.html.markdown +++ b/website/docs/cdktf/typescript/d/identitystore_groups.html.markdown @@ -48,8 +48,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `identityStoreId` - (Required) Identity Store ID associated with the Single Sign-On (SSO) Instance. ## Attribute Reference @@ -64,4 +65,4 @@ This data source exports the following attributes in addition to the arguments a * `id` - Identifier issued to this resource by an external identity provider. * `issuer` - Issuer for an external identifier. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/identitystore_user.html.markdown b/website/docs/cdktf/typescript/d/identitystore_user.html.markdown index 163b81606ef2..7e023a1630fc 100644 --- a/website/docs/cdktf/typescript/d/identitystore_user.html.markdown +++ b/website/docs/cdktf/typescript/d/identitystore_user.html.markdown @@ -61,8 +61,8 @@ The following arguments are required: The following arguments are optional: +* `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). * `alternateIdentifier` (Optional) A unique identifier for a user or group that is not the primary identifier. Conflicts with `userId` and `filter`. Detailed below. -* `filter` - (Optional, **Deprecated** use the `alternateIdentifier` attribute instead) Configuration block for filtering by a unique attribute of the user. Detailed below. * `userId` - (Optional) The identifier for a user in the Identity Store. -> Exactly one of the above arguments must be provided. Passing both `filter` and `userId` is allowed for backwards compatibility. @@ -83,15 +83,6 @@ The `externalId` configuration block supports the following arguments: * `id` - (Required) The identifier issued to this resource by an external identity provider. * `issuer` - (Required) The issuer for an external identifier. -### `filter` Configuration Block - -~> The `filter` configuration block has been deprecated. Use `alternateIdentifier` instead. - -The following arguments are supported by the `filter` configuration block: - -* `attributePath` - (Required) Attribute path that is used to specify which attribute name to search. Currently, `UserName` is the only valid attribute path. -* `attributeValue` - (Required) Value for an attribute. - ### `uniqueAttribute` Configuration Block The `uniqueAttribute` configuration block supports the following arguments: @@ -141,4 +132,4 @@ This data source exports the following attributes in addition to the arguments a * `userName` - User's user name value. * `userType` - The user type. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/identitystore_users.html.markdown b/website/docs/cdktf/typescript/d/identitystore_users.html.markdown index 8f549c23de03..7eb63e525e10 100644 --- a/website/docs/cdktf/typescript/d/identitystore_users.html.markdown +++ b/website/docs/cdktf/typescript/d/identitystore_users.html.markdown @@ -50,6 +50,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `identityStoreId` - (Required) Identity Store ID associated with the Single Sign-On Instance. ## Attribute Reference @@ -95,4 +96,4 @@ This data source exports the following attributes in addition to the arguments a * `userName` - User's user name value. * `userType` - User type. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/imagebuilder_component.html.markdown b/website/docs/cdktf/typescript/d/imagebuilder_component.html.markdown index a1ae88bf3a8e..ae67886beb97 100644 --- a/website/docs/cdktf/typescript/d/imagebuilder_component.html.markdown +++ b/website/docs/cdktf/typescript/d/imagebuilder_component.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `arn` - (Required) ARN of the component. ## Attribute Reference @@ -58,4 +59,4 @@ This data source exports the following attributes in addition to the arguments a * `type` - Type of the component. * `version` - Version of the component. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/imagebuilder_components.html.markdown b/website/docs/cdktf/typescript/d/imagebuilder_components.html.markdown index 33f781a1f99b..d8e127249539 100644 --- a/website/docs/cdktf/typescript/d/imagebuilder_components.html.markdown +++ b/website/docs/cdktf/typescript/d/imagebuilder_components.html.markdown @@ -44,6 +44,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `owner` - (Optional) Owner of the image recipes. Valid values are `Self`, `Shared`, `Amazon` and `ThirdParty`. Defaults to `Self`. * `filter` - (Optional) Configuration block(s) for filtering. Detailed below. @@ -61,4 +62,4 @@ This data source exports the following attributes in addition to the arguments a * `arns` - Set of ARNs of the matched Image Builder Components. * `names` - Set of names of the matched Image Builder Components. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/imagebuilder_container_recipe.html.markdown b/website/docs/cdktf/typescript/d/imagebuilder_container_recipe.html.markdown index 6bec5520c725..926a3128e16a 100644 --- a/website/docs/cdktf/typescript/d/imagebuilder_container_recipe.html.markdown +++ b/website/docs/cdktf/typescript/d/imagebuilder_container_recipe.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `arn` - (Required) ARN of the container recipe. ## Attribute Reference @@ -81,4 +82,4 @@ This data source exports the following attributes in addition to the arguments a * `version` - Version of the container recipe. * `workingDirectory` - Working directory used during build and test workflows. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/imagebuilder_container_recipes.html.markdown b/website/docs/cdktf/typescript/d/imagebuilder_container_recipes.html.markdown index 103e08a6d963..f55706df3c8f 100644 --- a/website/docs/cdktf/typescript/d/imagebuilder_container_recipes.html.markdown +++ b/website/docs/cdktf/typescript/d/imagebuilder_container_recipes.html.markdown @@ -44,6 +44,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `owner` - (Optional) Owner of the container recipes. Valid values are `Self`, `Shared`, `Amazon` and `ThirdParty`. Defaults to `Self`. * `filter` - (Optional) Configuration block(s) for filtering. Detailed below. @@ -61,4 +62,4 @@ This data source exports the following attributes in addition to the arguments a * `arns` - Set of ARNs of the matched Image Builder Container Recipes. * `names` - Set of names of the matched Image Builder Container Recipes. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/imagebuilder_distribution_configuration.html.markdown b/website/docs/cdktf/typescript/d/imagebuilder_distribution_configuration.html.markdown index b8fd6eb1a1c4..98eccdc78b17 100644 --- a/website/docs/cdktf/typescript/d/imagebuilder_distribution_configuration.html.markdown +++ b/website/docs/cdktf/typescript/d/imagebuilder_distribution_configuration.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `arn` - (Required) ARN of the distribution configuration. ## Attribute Reference @@ -92,4 +93,4 @@ This data source exports the following attributes in addition to the arguments a * `name` - Name of the distribution configuration. * `tags` - Key-value map of resource tags for the distribution configuration. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/imagebuilder_distribution_configurations.html.markdown b/website/docs/cdktf/typescript/d/imagebuilder_distribution_configurations.html.markdown index aeacf1afb5ac..686237d552fa 100644 --- a/website/docs/cdktf/typescript/d/imagebuilder_distribution_configurations.html.markdown +++ b/website/docs/cdktf/typescript/d/imagebuilder_distribution_configurations.html.markdown @@ -43,6 +43,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `filter` - (Optional) Configuration block(s) for filtering. Detailed below. ## filter Configuration Block @@ -59,4 +60,4 @@ This data source exports the following attributes in addition to the arguments a * `arns` - Set of ARNs of the matched Image Builder Distribution Configurations. * `names` - Set of names of the matched Image Builder Distribution Configurations. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/imagebuilder_image.html.markdown b/website/docs/cdktf/typescript/d/imagebuilder_image.html.markdown index 4b015d6f48c4..9ef1c7a999d6 100644 --- a/website/docs/cdktf/typescript/d/imagebuilder_image.html.markdown +++ b/website/docs/cdktf/typescript/d/imagebuilder_image.html.markdown @@ -40,6 +40,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `arn` - (Required) ARN of the image. The suffix can either be specified with wildcards (`x.x.x`) to fetch the latest build version or a full build version (e.g., `2020.11.26/1`) to fetch an exact version. ## Attribute Reference @@ -77,4 +78,4 @@ This data source exports the following attributes in addition to the arguments a * `tags` - Key-value map of resource tags for the image. * `version` - Version of the image. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/imagebuilder_image_pipeline.html.markdown b/website/docs/cdktf/typescript/d/imagebuilder_image_pipeline.html.markdown index 67212ec12308..b75cf8861d6f 100644 --- a/website/docs/cdktf/typescript/d/imagebuilder_image_pipeline.html.markdown +++ b/website/docs/cdktf/typescript/d/imagebuilder_image_pipeline.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `arn` - (Required) ARN of the image pipeline. ## Attribute Reference @@ -70,4 +71,4 @@ This data source exports the following attributes in addition to the arguments a * `status` - Status of the image pipeline. * `tags` - Key-value map of resource tags for the image pipeline. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/imagebuilder_image_pipelines.html.markdown b/website/docs/cdktf/typescript/d/imagebuilder_image_pipelines.html.markdown index c132284508c0..a4b69414c4bf 100644 --- a/website/docs/cdktf/typescript/d/imagebuilder_image_pipelines.html.markdown +++ b/website/docs/cdktf/typescript/d/imagebuilder_image_pipelines.html.markdown @@ -43,6 +43,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `filter` - (Optional) Configuration block(s) for filtering. Detailed below. ### filter Configuration Block @@ -59,4 +60,4 @@ This data source exports the following attributes in addition to the arguments a * `arns` - Set of ARNs of the matched Image Builder Image Pipelines. * `names` - Set of names of the matched Image Builder Image Pipelines. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/imagebuilder_image_recipe.html.markdown b/website/docs/cdktf/typescript/d/imagebuilder_image_recipe.html.markdown index d5b06d925c6e..6a5080cda7b5 100644 --- a/website/docs/cdktf/typescript/d/imagebuilder_image_recipe.html.markdown +++ b/website/docs/cdktf/typescript/d/imagebuilder_image_recipe.html.markdown @@ -36,8 +36,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `arn` - (Required) ARN of the image recipe. ## Attribute Reference @@ -73,4 +74,4 @@ This data source exports the following attributes in addition to the arguments a * `version` - Version of the image recipe. * `workingDirectory` - Working directory used during build and test workflows. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/imagebuilder_image_recipes.html.markdown b/website/docs/cdktf/typescript/d/imagebuilder_image_recipes.html.markdown index 4a589b6ea59c..9ed831443872 100644 --- a/website/docs/cdktf/typescript/d/imagebuilder_image_recipes.html.markdown +++ b/website/docs/cdktf/typescript/d/imagebuilder_image_recipes.html.markdown @@ -44,6 +44,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `owner` - (Optional) Owner of the image recipes. Valid values are `Self`, `Shared`, `Amazon` and `ThirdParty`. Defaults to `Self`. * `filter` - (Optional) Configuration block(s) for filtering. Detailed below. @@ -61,4 +62,4 @@ This data source exports the following attributes in addition to the arguments a * `arns` - Set of ARNs of the matched Image Builder Image Recipes. * `names` - Set of names of the matched Image Builder Image Recipes. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/imagebuilder_infrastructure_configuration.html.markdown b/website/docs/cdktf/typescript/d/imagebuilder_infrastructure_configuration.html.markdown index 05e43b949865..a5e1c798c649 100644 --- a/website/docs/cdktf/typescript/d/imagebuilder_infrastructure_configuration.html.markdown +++ b/website/docs/cdktf/typescript/d/imagebuilder_infrastructure_configuration.html.markdown @@ -36,8 +36,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `arn` - (Required) ARN of the infrastructure configuration. ## Attribute Reference @@ -70,4 +71,4 @@ This data source exports the following attributes in addition to the arguments a * `tags` - Key-value map of resource tags for the infrastructure configuration. * `terminateInstanceOnFailure` - Whether instances are terminated on failure. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/imagebuilder_infrastructure_configurations.html.markdown b/website/docs/cdktf/typescript/d/imagebuilder_infrastructure_configurations.html.markdown index 6648173b677f..033f3505e0d7 100644 --- a/website/docs/cdktf/typescript/d/imagebuilder_infrastructure_configurations.html.markdown +++ b/website/docs/cdktf/typescript/d/imagebuilder_infrastructure_configurations.html.markdown @@ -43,6 +43,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `filter` - (Optional) Configuration block(s) for filtering. Detailed below. ## filter Configuration Block @@ -59,4 +60,4 @@ This data source exports the following attributes in addition to the arguments a * `arns` - Set of ARNs of the matched Image Builder Infrastructure Configurations. * `names` - Set of names of the matched Image Builder Infrastructure Configurations. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/inspector_rules_packages.html.markdown b/website/docs/cdktf/typescript/d/inspector_rules_packages.html.markdown index 73f9a322b111..992588dab104 100644 --- a/website/docs/cdktf/typescript/d/inspector_rules_packages.html.markdown +++ b/website/docs/cdktf/typescript/d/inspector_rules_packages.html.markdown @@ -57,7 +57,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -This data source does not support any arguments. +This data source supports the following arguments: + +* `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). ## Attribute Reference @@ -66,4 +68,4 @@ This data source exports the following attributes in addition to the arguments a * `id` - AWS Region. * `arns` - List of the Amazon Inspector Classic Rules Packages arns available in the AWS region. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/instance.html.markdown b/website/docs/cdktf/typescript/d/instance.html.markdown index 51b76d9fb54f..781e4e17f4af 100644 --- a/website/docs/cdktf/typescript/d/instance.html.markdown +++ b/website/docs/cdktf/typescript/d/instance.html.markdown @@ -48,6 +48,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `instanceId` - (Optional) Specify the exact Instance ID with which to populate the data source. * `instanceTags` - (Optional) Map of tags, each pair of which must exactly match a pair on the desired Instance. @@ -152,4 +153,4 @@ interpolation. [1]: http://docs.aws.amazon.com/cli/latest/reference/ec2/describe-instances.html - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/instances.html.markdown b/website/docs/cdktf/typescript/d/instances.html.markdown index f6984c420b35..311391a091bc 100644 --- a/website/docs/cdktf/typescript/d/instances.html.markdown +++ b/website/docs/cdktf/typescript/d/instances.html.markdown @@ -70,6 +70,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `instanceTags` - (Optional) Map of tags, each pair of which must exactly match a pair on desired instances. * `instanceStateNames` - (Optional) List of instance states that should be applicable to the desired instances. The permitted values are: `pending, running, shutting-down, stopped, stopping, terminated`. The default value is `running`. @@ -95,4 +96,4 @@ This data source exports the following attributes in addition to the arguments a [1]: http://docs.aws.amazon.com/cli/latest/reference/ec2/describe-instances.html - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/internet_gateway.html.markdown b/website/docs/cdktf/typescript/d/internet_gateway.html.markdown index 08dea1f49789..c98b52be0483 100644 --- a/website/docs/cdktf/typescript/d/internet_gateway.html.markdown +++ b/website/docs/cdktf/typescript/d/internet_gateway.html.markdown @@ -46,6 +46,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `internetGatewayId` - (Optional) ID of the specific Internet Gateway to retrieve. * `tags` - (Optional) Map of tags, each pair of which must exactly match a pair on the desired Internet Gateway. @@ -83,4 +84,4 @@ Each attachment supports the following: - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/iot_endpoint.html.markdown b/website/docs/cdktf/typescript/d/iot_endpoint.html.markdown index 6d507bfaac87..e23f5e72240a 100644 --- a/website/docs/cdktf/typescript/d/iot_endpoint.html.markdown +++ b/website/docs/cdktf/typescript/d/iot_endpoint.html.markdown @@ -62,6 +62,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `endpointType` - (Optional) Endpoint type. Valid values: `iot:CredentialProvider`, `iot:Data`, `iot:Data-ATS`, `iot:Jobs`. ## Attribute Reference @@ -75,4 +76,4 @@ This data source exports the following attributes in addition to the arguments a * `iot:Data-ATS`: `IDENTIFIER-ats.iot.REGION.amazonaws.com` * `iot:Jobs`: `IDENTIFIER.jobs.iot.REGION.amazonaws.com` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/iot_registration_code.html.markdown b/website/docs/cdktf/typescript/d/iot_registration_code.html.markdown index 51cf55b929a2..84bb850cbf15 100644 --- a/website/docs/cdktf/typescript/d/iot_registration_code.html.markdown +++ b/website/docs/cdktf/typescript/d/iot_registration_code.html.markdown @@ -52,7 +52,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -This data source does not support any arguments. +This data source supports the following arguments: + +* `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). ## Attribute Reference @@ -60,4 +62,4 @@ This data source exports the following attributes in addition to the arguments a * `registrationCode` - The CA certificate registration code. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/ivs_stream_key.html.markdown b/website/docs/cdktf/typescript/d/ivs_stream_key.html.markdown index 363a33503256..fe4d128c2a88 100644 --- a/website/docs/cdktf/typescript/d/ivs_stream_key.html.markdown +++ b/website/docs/cdktf/typescript/d/ivs_stream_key.html.markdown @@ -38,8 +38,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `channelArn` - (Required) ARN of the Channel. ## Attribute Reference @@ -50,4 +51,4 @@ This data source exports the following attributes in addition to the arguments a * `tags` - Map of tags assigned to the resource. * `value` - Stream Key value. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/kendra_experience.html.markdown b/website/docs/cdktf/typescript/d/kendra_experience.html.markdown index 954aee699be7..2d25c8dad9f4 100644 --- a/website/docs/cdktf/typescript/d/kendra_experience.html.markdown +++ b/website/docs/cdktf/typescript/d/kendra_experience.html.markdown @@ -39,6 +39,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `experienceId` - (Required) Identifier of the Experience. * `indexId` - (Required) Identifier of the index that contains the Experience. @@ -78,4 +79,4 @@ The `endpoints` block supports the following attributes: * `endpoint` - Endpoint of your Amazon Kendra Experience. * `endpointType` - Type of endpoint for your Amazon Kendra Experience. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/kendra_faq.html.markdown b/website/docs/cdktf/typescript/d/kendra_faq.html.markdown index a2e999e9a6fb..9f7b375b4487 100644 --- a/website/docs/cdktf/typescript/d/kendra_faq.html.markdown +++ b/website/docs/cdktf/typescript/d/kendra_faq.html.markdown @@ -39,6 +39,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `faqId` - (Required) Identifier of the FAQ. * `indexId` - (Required) Identifier of the index that contains the FAQ. @@ -65,4 +66,4 @@ The `s3Path` configuration block supports the following attributes: * `bucket` - Name of the S3 bucket that contains the file. * `key` - Name of the file. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/kendra_index.html.markdown b/website/docs/cdktf/typescript/d/kendra_index.html.markdown index cb64fd76baf0..f7cb9d083669 100644 --- a/website/docs/cdktf/typescript/d/kendra_index.html.markdown +++ b/website/docs/cdktf/typescript/d/kendra_index.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `id` - (Required) Returns information on a specific Index by id. ## Attribute Reference @@ -132,4 +133,4 @@ A `jwtTokenTypeConfiguration` block supports the following attributes: * `url` - Signing key URL. * `userNameAttributeField` - The user name attribute field. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/kendra_query_suggestions_block_list.html.markdown b/website/docs/cdktf/typescript/d/kendra_query_suggestions_block_list.html.markdown index fb3fa64bc98a..05005484b760 100644 --- a/website/docs/cdktf/typescript/d/kendra_query_suggestions_block_list.html.markdown +++ b/website/docs/cdktf/typescript/d/kendra_query_suggestions_block_list.html.markdown @@ -39,6 +39,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `indexId` - (Required) Identifier of the index that contains the block list. * `querySuggestionsBlockListId` - (Required) Identifier of the block list. @@ -65,4 +66,4 @@ The `sourceS3Path` configuration block supports the following attributes: * `bucket` - Name of the S3 bucket that contains the file. * `key` - Name of the file. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/kendra_thesaurus.html.markdown b/website/docs/cdktf/typescript/d/kendra_thesaurus.html.markdown index 5c9288c79b30..11411c4043ce 100644 --- a/website/docs/cdktf/typescript/d/kendra_thesaurus.html.markdown +++ b/website/docs/cdktf/typescript/d/kendra_thesaurus.html.markdown @@ -39,6 +39,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `indexId` - (Required) Identifier of the index that contains the Thesaurus. * `thesaurusId` - (Required) Identifier of the Thesaurus. @@ -66,4 +67,4 @@ The `sourceS3Path` configuration block supports the following attributes: * `bucket` - Name of the S3 bucket that contains the file. * `key` - Name of the file. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/key_pair.html.markdown b/website/docs/cdktf/typescript/d/key_pair.html.markdown index 12d0a84a98a5..764789bacdc2 100644 --- a/website/docs/cdktf/typescript/d/key_pair.html.markdown +++ b/website/docs/cdktf/typescript/d/key_pair.html.markdown @@ -56,6 +56,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `keyPairId` - (Optional) Key Pair ID. * `keyName` - (Optional) Key Pair name. * `includePublicKey` - (Optional) Whether to include the public key material in the response. @@ -90,4 +91,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/kinesis_firehose_delivery_stream.html.markdown b/website/docs/cdktf/typescript/d/kinesis_firehose_delivery_stream.html.markdown index eb5d7b6bc5c6..2fc685c3691c 100644 --- a/website/docs/cdktf/typescript/d/kinesis_firehose_delivery_stream.html.markdown +++ b/website/docs/cdktf/typescript/d/kinesis_firehose_delivery_stream.html.markdown @@ -40,6 +40,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `name` - (Required) Name of the Kinesis Firehose Delivery Stream. ## Attribute Reference @@ -51,4 +52,4 @@ This data source exports the following attributes in addition to the arguments a [1]: https://aws.amazon.com/documentation/firehose/ - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/kinesis_stream.html.markdown b/website/docs/cdktf/typescript/d/kinesis_stream.html.markdown index afa0a63794c5..b0ce3029fc73 100644 --- a/website/docs/cdktf/typescript/d/kinesis_stream.html.markdown +++ b/website/docs/cdktf/typescript/d/kinesis_stream.html.markdown @@ -41,6 +41,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `name` - (Required) Name of the Kinesis Stream. ## Attribute Reference @@ -70,4 +71,4 @@ This data source exports the following attributes in addition to the arguments a [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 - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/kinesis_stream_consumer.html.markdown b/website/docs/cdktf/typescript/d/kinesis_stream_consumer.html.markdown index 9200d1fcaac7..d0a2a007b45a 100644 --- a/website/docs/cdktf/typescript/d/kinesis_stream_consumer.html.markdown +++ b/website/docs/cdktf/typescript/d/kinesis_stream_consumer.html.markdown @@ -41,6 +41,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `arn` - (Optional) ARN of the stream consumer. * `name` - (Optional) Name of the stream consumer. * `streamArn` - (Required) ARN of the data stream the consumer is registered with. @@ -55,4 +56,4 @@ This data source exports the following attributes in addition to the arguments a [1]: https://docs.aws.amazon.com/streams/latest/dev/amazon-kinesis-consumers.html - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/kms_alias.html.markdown b/website/docs/cdktf/typescript/d/kms_alias.html.markdown index 04b9173aa156..ca8a18640263 100644 --- a/website/docs/cdktf/typescript/d/kms_alias.html.markdown +++ b/website/docs/cdktf/typescript/d/kms_alias.html.markdown @@ -40,6 +40,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `name` - (Required) Display name of the alias. The name must start with the word "alias" followed by a forward slash (alias/) ## Attribute Reference @@ -53,4 +54,4 @@ This data source exports the following attributes in addition to the arguments a * `name` - Name of the alias * `namePrefix` - Prefix of the alias - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/kms_ciphertext.html.markdown b/website/docs/cdktf/typescript/d/kms_ciphertext.html.markdown index 6d464884c3d0..db22ffaef3eb 100644 --- a/website/docs/cdktf/typescript/d/kms_ciphertext.html.markdown +++ b/website/docs/cdktf/typescript/d/kms_ciphertext.html.markdown @@ -51,6 +51,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `plaintext` - (Required) Data to be encrypted. Note that this may show up in logs, and it will be stored in the state file. * `keyId` - (Required) Globally unique key ID for the customer master key. * `context` - (Optional) An optional mapping that makes up the encryption context. @@ -62,4 +63,4 @@ This data source exports the following attributes in addition to the arguments a * `id` - Globally unique key ID for the customer master key. * `ciphertextBlob` - Base64 encoded ciphertext - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/kms_custom_key_store.html.markdown b/website/docs/cdktf/typescript/d/kms_custom_key_store.html.markdown index 10d336cd9d1a..3ee24c3c5d7b 100644 --- a/website/docs/cdktf/typescript/d/kms_custom_key_store.html.markdown +++ b/website/docs/cdktf/typescript/d/kms_custom_key_store.html.markdown @@ -40,6 +40,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `customKeyStoreId` - (Optional) The ID for the custom key store. * `customKeyStoreName` - (Optional) The user-specified friendly name for the custom key store. @@ -53,4 +54,4 @@ This data source exports the following attributes in addition to the arguments a * `creationDate` - The date and time when the custom key store was created. * `trustAnchorCertificate` - The trust anchor certificate of the associated CloudHSM cluster. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/kms_key.html.markdown b/website/docs/cdktf/typescript/d/kms_key.html.markdown index 3e0ef4a27189..64bb0aa4d3d0 100644 --- a/website/docs/cdktf/typescript/d/kms_key.html.markdown +++ b/website/docs/cdktf/typescript/d/kms_key.html.markdown @@ -51,6 +51,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `keyId` - (Required) Key identifier which can be one of the following format: * Key ID. E.g: `1234abcd-12ab-34cd-56ef-1234567890ab` * Key ARN. E.g.: `arn:aws:kms:us-east-1:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab` @@ -68,7 +69,7 @@ This data source exports the following attributes in addition to the arguments a * `cloudHsmClusterId`: The cluster ID of the AWS CloudHSM cluster that contains the key material for the KMS key. * `creationDate`: The date and time when the key was created * `customKeyStoreId`: A unique identifier for the custom key store that contains the KMS key. -* `customerMasterKeySpec`: Specifies whether the key contains a symmetric key or an asymmetric key pair and the encryption algorithms or signing algorithms that the key supports +* `customerMasterKeySpec`: See `keySpec`. * `deletionDate`: The date and time after which AWS KMS deletes the key. This value is present only when `keyState` is `PendingDeletion`, otherwise this value is 0 * `description`: The description of the key. * `enabled`: Specifies whether the key is enabled. When `keyState` is `Enabled` this value is true, otherwise it is false @@ -95,4 +96,4 @@ The `primary_key` and `replica_keys` objects support the following: * `arn`: The key ARN of a primary or replica key of a multi-Region key. * `region`: The AWS Region of a primary or replica key in a multi-Region key. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/kms_public_key.html.markdown b/website/docs/cdktf/typescript/d/kms_public_key.html.markdown index 23d67989f8c9..ae8b2a13e032 100644 --- a/website/docs/cdktf/typescript/d/kms_public_key.html.markdown +++ b/website/docs/cdktf/typescript/d/kms_public_key.html.markdown @@ -48,6 +48,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `keyId` - (Required) Key identifier which can be one of the following format: * Key ID. E.g - `1234abcd-12ab-34cd-56ef-1234567890ab` * Key ARN. E.g. - `arn:aws:kms:us-east-1:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab` @@ -68,4 +69,4 @@ This data source exports the following attributes in addition to the arguments a * `publicKeyPem` - Exported public key. The value is Privacy Enhanced Mail (PEM) encoded. * `signingAlgorithms` - Signing algorithms that AWS KMS supports for this key. Only set when the `keyUsage` of the public key is `SIGN_VERIFY`. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/kms_secret.html.markdown b/website/docs/cdktf/typescript/d/kms_secret.html.markdown index 9edd17eb485e..3a43919f211e 100644 --- a/website/docs/cdktf/typescript/d/kms_secret.html.markdown +++ b/website/docs/cdktf/typescript/d/kms_secret.html.markdown @@ -10,6 +10,6 @@ description: |- # Data Source: aws_kms_secret -!> **WARNING:** This data source was removed in version 2.0.0 of the Terraform AWS Provider. You can migrate existing configurations to the [`aws_kms_secrets` data source](/docs/providers/aws/d/kms_secrets.html) following instructions available in the [Version 2 Upgrade Guide](../guides/version-2-upgrade.html#data-source-aws_kms_secret). +!> **WARNING:** This data source's functionality was removed in version 2.0.0 of the Terraform AWS Provider. You can migrate existing configurations to the [`aws_kms_secrets` data source](/docs/providers/aws/d/kms_secrets.html) following instructions available in the [Version 2 Upgrade Guide](../guides/version-2-upgrade.html#data-source-aws_kms_secret). This data source will be removed in a future version. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/lakeformation_data_lake_settings.html.markdown b/website/docs/cdktf/typescript/d/lakeformation_data_lake_settings.html.markdown index 76fe890a0ecf..babf53e7bf7a 100644 --- a/website/docs/cdktf/typescript/d/lakeformation_data_lake_settings.html.markdown +++ b/website/docs/cdktf/typescript/d/lakeformation_data_lake_settings.html.markdown @@ -38,13 +38,14 @@ class MyConvertedCode extends TerraformStack { The following arguments are optional: -* `catalogId` – (Optional) Identifier for the Data Catalog. By default, the account ID. +* `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). +* `catalogId` - (Optional) Identifier for the Data Catalog. By default, the account ID. ## Attribute Reference This data source exports the following attributes in addition to the arguments above: -* `admins` – List of ARNs of AWS Lake Formation principals (IAM users or roles). +* `admins` - List of ARNs of AWS Lake Formation principals (IAM users or roles). * `allowExternalDataFiltering` - Whether to allow Amazon EMR clusters to access data managed by Lake Formation. * `allowFullTableExternalDataAccess` - Whether to allow a third-party query engine to get data access credentials without session tags when a caller has full data access permissions. * `authorizedSessionTagValueList` - Lake Formation relies on a privileged process secured by Amazon EMR or the third party integrator to tag the user's role while assuming it. @@ -52,8 +53,8 @@ This data source exports the following attributes in addition to the arguments a * `createTableDefaultPermissions` - Up to three configuration blocks of principal permissions for default create table permissions. Detailed below. * `externalDataFilteringAllowList` - A list of the account IDs of Amazon Web Services accounts with Amazon EMR clusters that are to perform data filtering. * `parameters` - Key-value map of additional configuration. `CROSS_ACCOUNT_VERSION` will be set to values `"1"`, `"2"`, `"3"`, or `"4"`. `SET_CONTEXT` will also be returned with a value of `TRUE`. In a fresh account, prior to configuring, `CROSS_ACCOUNT_VERSION` is `"1"`. -* `readOnlyAdmins` – List of ARNs of AWS Lake Formation principals (IAM users or roles) with only view access to the resources. -* `trustedResourceOwners` – List of the resource-owning account IDs that the caller's account can use to share their user access details (user ARNs). +* `readOnlyAdmins` - List of ARNs of AWS Lake Formation principals (IAM users or roles) with only view access to the resources. +* `trustedResourceOwners` - List of the resource-owning account IDs that the caller's account can use to share their user access details (user ARNs). ### create_database_default_permissions @@ -65,4 +66,4 @@ This data source exports the following attributes in addition to the arguments a * `permissions` - List of permissions granted to the principal. * `principal` - Principal who is granted permissions. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/lakeformation_permissions.html.markdown b/website/docs/cdktf/typescript/d/lakeformation_permissions.html.markdown index d2a9bf3602f2..ebffc1260a5d 100644 --- a/website/docs/cdktf/typescript/d/lakeformation_permissions.html.markdown +++ b/website/docs/cdktf/typescript/d/lakeformation_permissions.html.markdown @@ -106,7 +106,8 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: -* `principal` – (Required) Principal to be granted the permissions on the resource. Supported principals are IAM users or IAM roles. +* `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). +* `principal` - (Required) Principal to be granted the permissions on the resource. Supported principals are IAM users or IAM roles. One of the following is required: @@ -121,7 +122,8 @@ One of the following is required: The following arguments are optional: -* `catalogId` – (Optional) Identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment. +* `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). +* `catalogId` - (Optional) Identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment. ### data_cells_filter @@ -134,7 +136,7 @@ The following arguments are optional: The following argument is required: -* `arn` – (Required) ARN that uniquely identifies the data location resource. +* `arn` - (Required) ARN that uniquely identifies the data location resource. The following argument is optional: @@ -144,7 +146,7 @@ The following argument is optional: The following argument is required: -* `name` – (Required) Name of the database resource. Unique to the Data Catalog. +* `name` - (Required) Name of the database resource. Unique to the Data Catalog. The following argument is optional: @@ -154,7 +156,7 @@ The following argument is optional: The following arguments are required: -* `key` – (Required) Key-name for the tag. +* `key` - (Required) Key-name for the tag. * `values` - (Required) List of possible values an attribute can take. The following argument is optional: @@ -165,7 +167,7 @@ The following argument is optional: The following arguments are required: -* `resourceType` – (Required) Resource type for which the tag policy applies. Valid values are `DATABASE` and `TABLE`. +* `resourceType` - (Required) Resource type for which the tag policy applies. Valid values are `DATABASE` and `TABLE`. * `expression` - (Required) List of tag conditions that apply to the resource's tag policy. Configuration block for tag conditions that apply to the policy. See [`expression`](#expression) below. The following argument is optional: @@ -174,17 +176,18 @@ The following argument is optional: #### expression -* `key` – (Required) Key-name of an LF-Tag. +* `key` - (Required) Key-name of an LF-Tag. * `values` - (Required) List of possible values of an LF-Tag. ### table The following argument is required: -* `databaseName` – (Required) Name of the database for the table. Unique to a Data Catalog. +* `databaseName` - (Required) Name of the database for the table. Unique to a Data Catalog. The following arguments are optional: +* `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). * `catalogId` - (Optional) Identifier for the Data Catalog. By default, it is the account ID of the caller. * `name` - (Optional) Name of the table. At least one of `name` or `wildcard` is required. * `wildcard` - (Optional) Whether to use a wildcard representing every table under a database. At least one of `name` or `wildcard` is required. Defaults to `false`. @@ -193,11 +196,12 @@ The following arguments are optional: The following arguments are required: -* `databaseName` – (Required) Name of the database for the table with columns resource. Unique to the Data Catalog. -* `name` – (Required) Name of the table resource. +* `databaseName` - (Required) Name of the database for the table with columns resource. Unique to the Data Catalog. +* `name` - (Required) Name of the table resource. The following arguments are optional: +* `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). * `catalogId` - (Optional) Identifier for the Data Catalog. By default, it is the account ID of the caller. * `columnNames` - (Optional) Set of column names for the table. At least one of `columnNames` or `excludedColumnNames` is required. * `excludedColumnNames` - (Optional) Set of column names for the table to exclude. At least one of `columnNames` or `excludedColumnNames` is required. @@ -206,7 +210,7 @@ The following arguments are optional: This data source exports the following attributes in addition to the arguments above: -* `permissions` – List of permissions granted to the principal. For details on permissions, see [Lake Formation Permissions Reference](https://docs.aws.amazon.com/lake-formation/latest/dg/lf-permissions-reference.html). +* `permissions` - List of permissions granted to the principal. For details on permissions, see [Lake Formation Permissions Reference](https://docs.aws.amazon.com/lake-formation/latest/dg/lf-permissions-reference.html). * `permissionsWithGrantOption` - Subset of `permissions` which the principal can pass. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/lakeformation_resource.html.markdown b/website/docs/cdktf/typescript/d/lakeformation_resource.html.markdown index 1780ccf2190b..bfc53deadb98 100644 --- a/website/docs/cdktf/typescript/d/lakeformation_resource.html.markdown +++ b/website/docs/cdktf/typescript/d/lakeformation_resource.html.markdown @@ -38,13 +38,17 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: -* `arn` – (Required) ARN of the resource, an S3 path. +* `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). +* `arn` - (Required) ARN of the resource, an S3 path. ## Attribute Reference This data source exports the following attributes in addition to the arguments above: +* `hybridAccessEnabled` - Flag to enable AWS LakeFormation hybrid access permission mode. * `lastModified` - Date and time the resource was last modified in [RFC 3339 format](https://tools.ietf.org/html/rfc3339#section-5.8). -* `roleArn` – Role that the resource was registered with. +* `roleArn` - Role that the resource was registered with. +* `withFederation` - Whether the resource is a federated resource. +* `withPrivilegedAccess` - Boolean to grant the calling principal the permissions to perform all supported Lake Formation operations on the registered data location. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/lambda_alias.html.markdown b/website/docs/cdktf/typescript/d/lambda_alias.html.markdown index 75809b76d49d..771a08d9e079 100644 --- a/website/docs/cdktf/typescript/d/lambda_alias.html.markdown +++ b/website/docs/cdktf/typescript/d/lambda_alias.html.markdown @@ -3,21 +3,90 @@ subcategory: "Lambda" layout: "aws" page_title: "AWS: aws_lambda_alias" description: |- - Provides a Lambda Alias data source. + Provides details about an AWS Lambda Alias. --- # Data Source: aws_lambda_alias -Provides information about a Lambda Alias. +Provides details about an AWS Lambda Alias. Use this data source to retrieve information about an existing Lambda function alias for traffic management, deployment strategies, or API integrations. ## Example Usage +### Basic Usage + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { TerraformOutput, TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { DataAwsLambdaAlias } from "./.gen/providers/aws/data-aws-lambda-alias"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + const example = new DataAwsLambdaAlias(this, "example", { + functionName: "my-lambda-function", + name: "production", + }); + new TerraformOutput(this, "alias_arn", { + value: example.arn, + }); + } +} + +``` + +### API Gateway Integration + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { Token, TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { ApiGatewayIntegration } from "./.gen/providers/aws/api-gateway-integration"; +import { DataAwsLambdaAlias } from "./.gen/providers/aws/data-aws-lambda-alias"; +import { LambdaPermission } from "./.gen/providers/aws/lambda-permission"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + const apiHandler = new DataAwsLambdaAlias(this, "api_handler", { + functionName: "api-handler", + name: "live", + }); + new ApiGatewayIntegration(this, "example", { + httpMethod: Token.asString(awsApiGatewayMethodExample.httpMethod), + integrationHttpMethod: "POST", + resourceId: Token.asString(awsApiGatewayResourceExample.id), + restApiId: Token.asString(awsApiGatewayRestApiExample.id), + type: "AWS_PROXY", + uri: Token.asString(apiHandler.invokeArn), + }); + new LambdaPermission(this, "api_gateway", { + action: "lambda:InvokeFunction", + functionName: Token.asString(apiHandler.functionName), + principal: "apigateway.amazonaws.com", + qualifier: Token.asString(apiHandler.name), + sourceArn: "${" + awsApiGatewayRestApiExample.executionArn + "}/*/*", + statementId: "AllowExecutionFromAPIGateway", + }); + } +} + +``` + +### Deployment Version Tracking + ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug import { Construct } from "constructs"; -import { TerraformStack } from "cdktf"; +import { Op, TerraformOutput, TerraformStack } from "cdktf"; /* * Provider bindings are generated by running `cdktf get`. * See https://cdk.tf/provider-generation for more details. @@ -26,29 +95,85 @@ import { DataAwsLambdaAlias } from "./.gen/providers/aws/data-aws-lambda-alias"; class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); - new DataAwsLambdaAlias(this, "production", { - functionName: "my-lambda-func", + const production = new DataAwsLambdaAlias(this, "production", { + functionName: "payment-processor", name: "production", }); + const staging = new DataAwsLambdaAlias(this, "staging", { + functionName: "payment-processor", + name: "staging", + }); + const versionDrift = Op.neq( + production.functionVersion, + staging.functionVersion + ); + new TerraformOutput(this, "deployment_status", { + value: [ + { + production_version: production.functionVersion, + ready_for_promotion: Op.not(versionDrift), + staging_version: staging.functionVersion, + version_drift: versionDrift, + }, + ], + }); } } ``` +### EventBridge Rule Target + +```terraform +data "aws_lambda_alias" "event_processor" { + function_name = "event-processor" + name = "stable" +} + +resource "aws_cloudwatch_event_rule" "example" { + name = "capture-events" + description = "Capture events for processing" + + event_pattern = jsonencode({ + source = ["myapp.orders"] + detail-type = ["Order Placed"] + }) +} + +resource "aws_cloudwatch_event_target" "lambda" { + rule = aws_cloudwatch_event_rule.example.name + target_id = "SendToLambda" + arn = data.aws_lambda_alias.event_processor.arn +} + +resource "aws_lambda_permission" "allow_eventbridge" { + statement_id = "AllowExecutionFromEventBridge" + action = "lambda:InvokeFunction" + function_name = data.aws_lambda_alias.event_processor.function_name + principal = "events.amazonaws.com" + qualifier = data.aws_lambda_alias.event_processor.name + source_arn = aws_cloudwatch_event_rule.example.arn +} +``` + ## Argument Reference -This data source supports the following arguments: +The following arguments are required: * `functionName` - (Required) Name of the aliased Lambda function. * `name` - (Required) Name of the Lambda alias. +The following arguments are optional: + +* `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). + ## Attribute Reference This data source exports the following attributes in addition to the arguments above: * `arn` - ARN identifying the Lambda function alias. -* `description` - Description of alias. +* `description` - Description of the alias. * `functionVersion` - Lambda function version which the alias uses. -* `invokeArn` - ARN to be used for invoking Lambda Function from API Gateway - to be used in aws_api_gateway_integration's `uri`. +* `invokeArn` - ARN to be used for invoking Lambda Function from API Gateway - to be used in [`aws_api_gateway_integration`](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/api_gateway_integration)'s `uri`. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/lambda_code_signing_config.html.markdown b/website/docs/cdktf/typescript/d/lambda_code_signing_config.html.markdown index 97f0671ca2ad..0758d405ab86 100644 --- a/website/docs/cdktf/typescript/d/lambda_code_signing_config.html.markdown +++ b/website/docs/cdktf/typescript/d/lambda_code_signing_config.html.markdown @@ -3,38 +3,193 @@ subcategory: "Lambda" layout: "aws" page_title: "AWS: aws_lambda_code_signing_config" description: |- - Provides a Lambda Code Signing Config data source. + Provides details about an AWS Lambda Code Signing Config. --- # Data Source: aws_lambda_code_signing_config -Provides information about a Lambda Code Signing Config. A code signing configuration defines a list of allowed signing profiles and defines the code-signing validation policy (action to be taken if deployment validation checks fail). +Provides details about an AWS Lambda Code Signing Config. Use this data source to retrieve information about an existing code signing configuration for Lambda functions to ensure code integrity and authenticity. -For information about Lambda code signing configurations and how to use them, see [configuring code signing for Lambda functions][1] +For information about Lambda code signing configurations and how to use them, see [configuring code signing for Lambda functions](https://docs.aws.amazon.com/lambda/latest/dg/configuration-codesigning.html). ## Example Usage +### Basic Usage + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { TerraformOutput, Fn, TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { DataAwsLambdaCodeSigningConfig } from "./.gen/providers/aws/data-aws-lambda-code-signing-config"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + const example = new DataAwsLambdaCodeSigningConfig(this, "example", { + arn: "arn:aws:lambda:us-west-2:123456789012:code-signing-config:csc-0f6c334abcdea4d8b", + }); + new TerraformOutput(this, "config_details", { + value: [ + { + config_id: example.configId, + description: example.description, + policy: Fn.lookupNested(example.policies, [ + "0", + "untrusted_artifact_on_deployment", + ]), + }, + ], + }); + } +} + +``` + +### Use in Lambda Function + ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug import { Construct } from "constructs"; -import { TerraformStack } from "cdktf"; +import { Token, TerraformStack } from "cdktf"; /* * Provider bindings are generated by running `cdktf get`. * See https://cdk.tf/provider-generation for more details. */ import { DataAwsLambdaCodeSigningConfig } from "./.gen/providers/aws/data-aws-lambda-code-signing-config"; +import { LambdaFunction } from "./.gen/providers/aws/lambda-function"; class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); - new DataAwsLambdaCodeSigningConfig(this, "existing_csc", { - arn: - "arn:aws:lambda:${" + - awsRegion.value + - "}:${" + - awsAccount.value + - "}:code-signing-config:csc-0f6c334abcdea4d8b", + const securityConfig = new DataAwsLambdaCodeSigningConfig( + this, + "security_config", + { + arn: codeSigningConfigArn.stringValue, + } + ); + new LambdaFunction(this, "example", { + codeSigningConfigArn: Token.asString(securityConfig.arn), + filename: "function.zip", + functionName: "secure-function", + handler: "index.handler", + role: lambdaRole.arn, + runtime: "nodejs20.x", + tags: { + Environment: "production", + Security: "code-signed", + }, + }); + } +} + +``` + +### Validate Signing Profiles + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { + Fn, + TerraformOutput, + conditional, + Token, + TerraformCount, + TerraformStack, +} from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { DataAwsLambdaCodeSigningConfig } from "./.gen/providers/aws/data-aws-lambda-code-signing-config"; +import { LambdaFunction } from "./.gen/providers/aws/lambda-function"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + const requiredProfile = + "arn:aws:signer:us-west-2:123456789012:/signing-profiles/MyProfile"; + const example = new DataAwsLambdaCodeSigningConfig(this, "example", { + arn: codeSigningConfigArn.stringValue, + }); + const allowedProfiles = Fn.lookupNested(example.allowedPublishers, [ + "0", + "signing_profile_version_arns", + ]); + const profileAllowed = Fn.contains(allowedProfiles, requiredProfile); + new TerraformOutput(this, "deployment_status", { + value: [ + { + function_created: profileAllowed, + message: conditional( + profileAllowed, + "Function deployed with valid signing profile", + "Deployment blocked - signing profile not allowed" + ), + profile_allowed: profileAllowed, + }, + ], + }); + /*In most cases loops should be handled in the programming language context and + not inside of the Terraform context. If you are looping over something external, e.g. a variable or a file input + you should consider using a for loop. If you are looping over something only known to Terraform, e.g. a result of a data source + you need to keep this like it is.*/ + const conditionalCount = TerraformCount.of( + Token.asNumber(conditional(profileAllowed, 1, 0)) + ); + new LambdaFunction(this, "conditional", { + codeSigningConfigArn: Token.asString(example.arn), + filename: "function.zip", + functionName: "conditional-function", + handler: "index.handler", + role: lambdaRole.arn, + runtime: "python3.12", + count: conditionalCount, + }); + } +} + +``` + +### Multi-Environment Configuration + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { Fn, Op, TerraformOutput, TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { DataAwsLambdaCodeSigningConfig } from "./.gen/providers/aws/data-aws-lambda-code-signing-config"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + const dev = new DataAwsLambdaCodeSigningConfig(this, "dev", { + arn: "arn:aws:lambda:us-west-2:123456789012:code-signing-config:csc-dev-456", + }); + const prod = new DataAwsLambdaCodeSigningConfig(this, "prod", { + arn: "arn:aws:lambda:us-west-2:123456789012:code-signing-config:csc-prod-123", + }); + const devPolicy = Fn.lookupNested(dev.policies, [ + "0", + "untrusted_artifact_on_deployment", + ]); + const prodPolicy = Fn.lookupNested(prod.policies, [ + "0", + "untrusted_artifact_on_deployment", + ]); + const configComparison = { + dev_enforcement: devPolicy, + policies_match: Op.eq(prodPolicy, devPolicy), + prod_enforcement: prodPolicy, + }; + new TerraformOutput(this, "environment_comparison", { + value: configComparison, }); } } @@ -43,28 +198,30 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -This data source supports the following arguments: +The following arguments are required: * `arn` - (Required) ARN of the code signing configuration. +The following arguments are optional: + +* `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). + ## Attribute Reference This data source exports the following attributes in addition to the arguments above: -* `allowedPublishers` - List of allowed publishers as signing profiles for this code signing configuration. +* `allowedPublishers` - List of allowed publishers as signing profiles for this code signing configuration. [See below](#allowed_publishers-attribute-reference). * `configId` - Unique identifier for the code signing configuration. * `description` - Code signing configuration description. * `lastModified` - Date and time that the code signing configuration was last modified. -* `policies` - List of code signing policies that control the validation failure action for signature mismatch or expiry. - -`allowedPublishers` is exported with the following attribute: +* `policies` - List of code signing policies that control the validation failure action for signature mismatch or expiry. [See below](#policies-attribute-reference). -* `signingProfileVersionArns` - The ARN for each of the signing profiles. A signing profile defines a trusted user who can sign a code package. +### allowed_publishers Attribute Reference -`policies` is exported with the following attribute: +* `signingProfileVersionArns` - Set of ARNs for each of the signing profiles. A signing profile defines a trusted user who can sign a code package. -* `untrustedArtifactOnDeployment` - Code signing configuration policy for deployment validation failure. +### policies Attribute Reference -[1]: https://docs.aws.amazon.com/lambda/latest/dg/configuration-codesigning.html +* `untrustedArtifactOnDeployment` - Code signing configuration policy for deployment validation failure. Valid values: `Warn`, `Enforce`. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/lambda_function.html.markdown b/website/docs/cdktf/typescript/d/lambda_function.html.markdown index ce3979aa0692..71b9b0058a74 100644 --- a/website/docs/cdktf/typescript/d/lambda_function.html.markdown +++ b/website/docs/cdktf/typescript/d/lambda_function.html.markdown @@ -3,21 +3,25 @@ subcategory: "Lambda" layout: "aws" page_title: "AWS: aws_lambda_function" description: |- - Provides a Lambda Function data source. + Provides details about an AWS Lambda Function. --- # Data Source: aws_lambda_function -Provides information about a Lambda Function. +Provides details about an AWS Lambda Function. Use this data source to obtain information about an existing Lambda function for use in other resources or as a reference for function configurations. + +~> **Note:** This data source returns information about the latest version or alias specified by the `qualifier`. If no `qualifier` is provided, it returns information about the most recent published version, or `$LATEST` if no published version exists. ## Example Usage +### Basic Usage + ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug import { Construct } from "constructs"; -import { VariableType, TerraformVariable, TerraformStack } from "cdktf"; +import { TerraformOutput, TerraformStack } from "cdktf"; /* * Provider bindings are generated by running `cdktf get`. * See https://cdk.tf/provider-generation for more details. @@ -26,13 +30,131 @@ import { DataAwsLambdaFunction } from "./.gen/providers/aws/data-aws-lambda-func class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); - /*Terraform Variables are not always the best fit for getting inputs in the context of Terraform CDK. - You can read more about this at https://cdk.tf/variables*/ - const functionName = new TerraformVariable(this, "function_name", { - type: VariableType.STRING, + const example = new DataAwsLambdaFunction(this, "example", { + functionName: "my-lambda-function", + }); + new TerraformOutput(this, "function_arn", { + value: example.arn, }); - new DataAwsLambdaFunction(this, "existing", { - functionName: functionName.stringValue, + } +} + +``` + +### Using Function Alias + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { Token, TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { ApiGatewayIntegration } from "./.gen/providers/aws/api-gateway-integration"; +import { DataAwsLambdaFunction } from "./.gen/providers/aws/data-aws-lambda-function"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + const example = new DataAwsLambdaFunction(this, "example", { + functionName: "api-handler", + qualifier: "production", + }); + const awsApiGatewayIntegrationExample = new ApiGatewayIntegration( + this, + "example_1", + { + httpMethod: Token.asString(awsApiGatewayMethodExample.httpMethod), + integrationHttpMethod: "POST", + resourceId: Token.asString(awsApiGatewayResourceExample.id), + restApiId: Token.asString(awsApiGatewayRestApiExample.id), + type: "AWS_PROXY", + uri: Token.asString(example.invokeArn), + } + ); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + awsApiGatewayIntegrationExample.overrideLogicalId("example"); + } +} + +``` + +### Function Configuration Reference + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { Token, Fn, TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { DataAwsLambdaFunction } from "./.gen/providers/aws/data-aws-lambda-function"; +import { LambdaFunction } from "./.gen/providers/aws/lambda-function"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + const reference = new DataAwsLambdaFunction(this, "reference", { + functionName: "existing-function", + }); + new LambdaFunction(this, "example", { + architectures: Token.asList(reference.architectures), + environment: { + variables: Token.asStringMap( + Fn.lookupNested(reference.environment, ["0", "variables"]) + ), + }, + filename: "new-function.zip", + functionName: "new-function", + handler: Token.asString(reference.handler), + memorySize: Token.asNumber(reference.memorySize), + role: Token.asString(reference.role), + runtime: Token.asString(reference.runtime), + timeout: Token.asNumber(reference.timeout), + vpcConfig: { + securityGroupIds: Token.asList( + Fn.lookupNested(reference.vpcConfig, ["0", "security_group_ids"]) + ), + subnetIds: Token.asList( + Fn.lookupNested(reference.vpcConfig, ["0", "subnet_ids"]) + ), + }, + }); + } +} + +``` + +### Function Version Management + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { TerraformOutput, Op, TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { DataAwsLambdaFunction } from "./.gen/providers/aws/data-aws-lambda-function"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + const latest = new DataAwsLambdaFunction(this, "latest", { + functionName: "my-function", + qualifier: "$LATEST", + }); + const version = new DataAwsLambdaFunction(this, "version", { + functionName: "my-function", + qualifier: "3", + }); + new TerraformOutput(this, "version_comparison", { + value: [ + { + code_difference: Op.neq(version.codeSha256, latest.codeSha256), + latest_version: latest.version, + specific_version: version.version, + }, + ], }); } } @@ -41,10 +163,14 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -This data source supports the following arguments: +The following arguments are required: + +* `functionName` - (Required) Name of the Lambda function. -* `functionName` - (Required) Name of the lambda function. -* `qualifier` - (Optional) Alias name or version number of the lambda functionE.g., `$LATEST`, `my-alias`, or `1`. When not included: the data source resolves to the most recent published version; if no published version exists: it resolves to the most recent unpublished version. +The following arguments are optional: + +* `qualifier` - (Optional) Alias name or version number of the Lambda function. E.g., `$LATEST`, `my-alias`, or `1`. When not included: the data source resolves to the most recent published version; if no published version exists: it resolves to the most recent unpublished version. +* `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). ## Attribute Reference @@ -54,31 +180,67 @@ This data source exports the following attributes in addition to the arguments a * `arn` - Unqualified (no `:QUALIFIER` or `:VERSION` suffix) ARN identifying your Lambda Function. See also `qualifiedArn`. * `codeSha256` - Base64-encoded representation of raw SHA-256 sum of the zip file. * `codeSigningConfigArn` - ARN for a Code Signing Configuration. -* `deadLetterConfig` - Configure the function's *dead letter queue*. +* `deadLetterConfig` - Configuration for the function's dead letter queue. [See below](#dead_letter_config-attribute-reference). * `description` - Description of what your Lambda Function does. -* `environment` - Lambda environment's configuration settings. -* `ephemeralStorage` - Amount of Ephemeral storage(`/tmp`) allocated for the Lambda Function. -* `fileSystemConfig` - Connection settings for an Amazon EFS file system. +* `environment` - Lambda environment's configuration settings. [See below](#environment-attribute-reference). +* `ephemeralStorage` - Amount of ephemeral storage (`/tmp`) allocated for the Lambda Function. [See below](#ephemeral_storage-attribute-reference). +* `fileSystemConfig` - Connection settings for an Amazon EFS file system. [See below](#file_system_config-attribute-reference). * `handler` - Function entrypoint in your code. * `imageUri` - URI of the container image. -* `invokeArn` - ARN to be used for invoking Lambda Function from API Gateway. **NOTE:** Starting with `v4.51.0` of the provider, this will *not* include the qualifier. +* `invokeArn` - ARN to be used for invoking Lambda Function from API Gateway. **Note:** Starting with `v4.51.0` of the provider, this will not include the qualifier. * `kmsKeyArn` - ARN for the KMS encryption key. * `lastModified` - Date this resource was last modified. * `layers` - List of Lambda Layer ARNs attached to your Lambda Function. -* `loggingConfig` - Advanced logging settings. +* `loggingConfig` - Advanced logging settings. [See below](#logging_config-attribute-reference). * `memorySize` - Amount of memory in MB your Lambda Function can use at runtime. * `qualifiedArn` - Qualified (`:QUALIFIER` or `:VERSION` suffix) ARN identifying your Lambda Function. See also `arn`. * `qualifiedInvokeArn` - Qualified (`:QUALIFIER` or `:VERSION` suffix) ARN to be used for invoking Lambda Function from API Gateway. See also `invokeArn`. -* `reservedConcurrentExecutions` - The amount of reserved concurrent executions for this lambda function or `-1` if unreserved. +* `reservedConcurrentExecutions` - Amount of reserved concurrent executions for this Lambda function or `-1` if unreserved. * `role` - IAM role attached to the Lambda Function. * `runtime` - Runtime environment for the Lambda function. * `signingJobArn` - ARN of a signing job. -* `signingProfileVersionArn` - The ARN for a signing profile version. +* `signingProfileVersionArn` - ARN for a signing profile version. * `sourceCodeHash` - (**Deprecated** use `codeSha256` instead) Base64-encoded representation of raw SHA-256 sum of the zip file. * `sourceCodeSize` - Size in bytes of the function .zip file. +* `source_kms_key_arn` - ARN of the AWS Key Management Service key used to encrypt the function's `.zip` deployment package. +* `tags` - Map of tags assigned to the Lambda Function. * `timeout` - Function execution time at which Lambda should terminate the function. -* `tracingConfig` - Tracing settings of the function. -* `version` - The version of the Lambda function returned. If `qualifier` is not set, this will resolve to the most recent published version. If no published version of the function exists, `version` will resolve to `$LATEST`. -* `vpcConfig` - VPC configuration associated with your Lambda function. +* `tracingConfig` - Tracing settings of the function. [See below](#tracing_config-attribute-reference). +* `version` - Version of the Lambda function returned. If `qualifier` is not set, this will resolve to the most recent published version. If no published version of the function exists, `version` will resolve to `$LATEST`. +* `vpcConfig` - VPC configuration associated with your Lambda function. [See below](#vpc_config-attribute-reference). + +### dead_letter_config + +* `targetArn` - ARN of an SNS topic or SQS queue to notify when an invocation fails. + +### environment + +* `variables` - Map of environment variables that are accessible from the function code during execution. + +### ephemeral_storage + +* `size` - Size of the Lambda function ephemeral storage (`/tmp`) in MB. + +### file_system_config + +* `arn` - ARN of the Amazon EFS Access Point that provides access to the file system. +* `localMountPath` - Path where the function can access the file system, starting with `/mnt/`. + +### logging_config + +* `applicationLogLevel` - Detail level of the logs your application sends to CloudWatch when using supported logging libraries. +* `logFormat` - Format for your function's logs. Valid values: `Text`, `JSON`. +* `logGroup` - CloudWatch log group your function sends logs to. +* `systemLogLevel` - Detail level of the Lambda platform event logs sent to CloudWatch. + +### tracing_config + +* `mode` - Tracing mode. Valid values: `Active`, `PassThrough`. + +### vpc_config + +* `securityGroupIds` - List of security group IDs associated with the Lambda function. +* `subnetIds` - List of subnet IDs associated with the Lambda function. +* `vpcId` - ID of the VPC. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/lambda_function_url.html.markdown b/website/docs/cdktf/typescript/d/lambda_function_url.html.markdown index 8841a6ef06d4..6d566fec5a36 100644 --- a/website/docs/cdktf/typescript/d/lambda_function_url.html.markdown +++ b/website/docs/cdktf/typescript/d/lambda_function_url.html.markdown @@ -3,36 +3,106 @@ subcategory: "Lambda" layout: "aws" page_title: "AWS: aws_lambda_function_url" description: |- - Provides a Lambda function URL data source. + Provides details about an AWS Lambda Function URL. --- # Data Source: aws_lambda_function_url -Provides information about a Lambda function URL. +Provides details about an AWS Lambda Function URL. Use this data source to retrieve information about an existing function URL configuration. ## Example Usage +### Basic Usage + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { TerraformOutput, TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { DataAwsLambdaFunctionUrl } from "./.gen/providers/aws/data-aws-lambda-function-url"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + const example = new DataAwsLambdaFunctionUrl(this, "example", { + functionName: "my_lambda_function", + }); + new TerraformOutput(this, "function_url", { + value: example.functionUrl, + }); + } +} + +``` + +### With Qualifier + ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug import { Construct } from "constructs"; -import { VariableType, TerraformVariable, TerraformStack } from "cdktf"; +import { Token, Fn, TerraformStack } from "cdktf"; /* * Provider bindings are generated by running `cdktf get`. * See https://cdk.tf/provider-generation for more details. */ import { DataAwsLambdaFunctionUrl } from "./.gen/providers/aws/data-aws-lambda-function-url"; +import { Route53Record } from "./.gen/providers/aws/route53-record"; class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); - /*Terraform Variables are not always the best fit for getting inputs in the context of Terraform CDK. - You can read more about this at https://cdk.tf/variables*/ - const functionName = new TerraformVariable(this, "function_name", { - type: VariableType.STRING, + const example = new DataAwsLambdaFunctionUrl(this, "example", { + functionName: Token.asString(awsLambdaFunctionExample.functionName), + qualifier: "production", }); - new DataAwsLambdaFunctionUrl(this, "existing", { - functionName: functionName.stringValue, + new Route53Record(this, "lambda_alias", { + name: "api.example.com", + records: [ + Token.asString( + Fn.replace(Token.asString(example.functionUrl), "https://", "") + ), + ], + ttl: 300, + type: "CNAME", + zoneId: Token.asString(awsRoute53ZoneExample.zoneId), + }); + } +} + +``` + +### Retrieve CORS Configuration + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { Fn, Op, conditional, TerraformOutput, TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { DataAwsLambdaFunctionUrl } from "./.gen/providers/aws/data-aws-lambda-function-url"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + const example = new DataAwsLambdaFunctionUrl(this, "example", { + functionName: "api_function", + }); + const corsConfig = conditional( + Op.gt(Fn.lengthOf(example.cors), 0), + Fn.lookupNested(example.cors, ["0"]), + "null" + ); + const allowedOrigins = conditional( + Op.neq(corsConfig, "null"), + Fn.lookupNested(corsConfig, ["allow_origins"]), + [] + ); + new TerraformOutput(this, "cors_allowed_origins", { + value: allowedOrigins, }); } } @@ -41,17 +111,21 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -This data source supports the following arguments: +The following arguments are required: + +* `functionName` - (Required) Name or ARN of the Lambda function. + +The following arguments are optional: -* `functionName` - (Required) The name (or ARN) of the Lambda function. -* `qualifier` - (Optional) Alias name or `"$LATEST"`. +* `qualifier` - (Optional) Alias name or `$LATEST`. +* `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). ## Attribute Reference This data source exports the following attributes in addition to the arguments above: * `authorizationType` - Type of authentication that the function URL uses. -* `cors` - The [cross-origin resource sharing (CORS)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) settings for the function URL. See the [`aws_lambda_function_url` resource](/docs/providers/aws/r/lambda_function_url.html) documentation for more details. +* `cors` - Cross-origin resource sharing (CORS) settings for the function URL. [See below](#cors-attribute-reference). * `creationTime` - When the function URL was created, in [ISO-8601 format](https://www.w3.org/TR/NOTE-datetime). * `functionArn` - ARN of the function. * `functionUrl` - HTTP URL endpoint for the function in the format `https://.lambda-url..on.aws/`. @@ -59,4 +133,13 @@ This data source exports the following attributes in addition to the arguments a * `lastModifiedTime` - When the function URL configuration was last updated, in [ISO-8601 format](https://www.w3.org/TR/NOTE-datetime). * `urlId` - Generated ID for the endpoint. - \ No newline at end of file +### cors Attribute Reference + +* `allowCredentials` - Whether credentials are included in the CORS request. +* `allowHeaders` - List of headers that are specified in the Access-Control-Request-Headers header. +* `allowMethods` - List of HTTP methods that are allowed when calling the function URL. +* `allowOrigins` - List of origins that are allowed to make requests to the function URL. +* `exposeHeaders` - List of headers in the response that you want to expose to the origin that called the function URL. +* `maxAge` - Maximum amount of time, in seconds, that web browsers can cache results of a preflight request. + + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/lambda_functions.html.markdown b/website/docs/cdktf/typescript/d/lambda_functions.html.markdown index 8dc595ed0085..b3e89a7e6781 100644 --- a/website/docs/cdktf/typescript/d/lambda_functions.html.markdown +++ b/website/docs/cdktf/typescript/d/lambda_functions.html.markdown @@ -3,21 +3,23 @@ subcategory: "Lambda" layout: "aws" page_title: "AWS: aws_lambda_functions" description: |- - Terraform data resource to get a list of Lambda Functions. + Provides a list of AWS Lambda Functions. --- # Data Source: aws_lambda_functions -Terraform data resource to get a list of Lambda Functions. +Provides a list of AWS Lambda Functions in the current region. Use this data source to discover existing Lambda functions for inventory, monitoring, or bulk operations. ## Example Usage +### List All Functions + ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug import { Construct } from "constructs"; -import { TerraformStack } from "cdktf"; +import { TerraformOutput, Fn, TerraformStack } from "cdktf"; /* * Provider bindings are generated by running `cdktf get`. * See https://cdk.tf/provider-generation for more details. @@ -26,7 +28,146 @@ import { DataAwsLambdaFunctions } from "./.gen/providers/aws/data-aws-lambda-fun class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); - new DataAwsLambdaFunctions(this, "all", {}); + const all = new DataAwsLambdaFunctions(this, "all", {}); + new TerraformOutput(this, "all_function_names", { + value: all.functionNames, + }); + new TerraformOutput(this, "function_count", { + value: Fn.lengthOf(all.functionNames), + }); + } +} + +``` + +### Use Function List for Bulk Operations + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { Fn, Token, TerraformCount, TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { CloudwatchMetricAlarm } from "./.gen/providers/aws/cloudwatch-metric-alarm"; +import { DataAwsLambdaFunctions } from "./.gen/providers/aws/data-aws-lambda-functions"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + const all = new DataAwsLambdaFunctions(this, "all", {}); + /*In most cases loops should be handled in the programming language context and + not inside of the Terraform context. If you are looping over something external, e.g. a variable or a file input + you should consider using a for loop. If you are looping over something only known to Terraform, e.g. a result of a data source + you need to keep this like it is.*/ + const lambdaErrorsCount = TerraformCount.of( + Token.asNumber(Fn.lengthOf(all.functionNames)) + ); + new CloudwatchMetricAlarm(this, "lambda_errors", { + alarmDescription: "This metric monitors lambda errors", + alarmName: + Token.asString( + Fn.lookupNested(all.functionNames, [lambdaErrorsCount.index]) + ) + "-errors", + comparisonOperator: "GreaterThanThreshold", + dimensions: { + FunctionName: Token.asString( + Fn.lookupNested(all.functionNames, [lambdaErrorsCount.index]) + ), + }, + evaluationPeriods: Token.asNumber("2"), + metricName: "Errors", + namespace: "AWS/Lambda", + period: Token.asNumber("300"), + statistic: "Sum", + tags: { + Environment: "monitoring", + Purpose: "lambda-error-tracking", + }, + threshold: Token.asNumber("5"), + count: lambdaErrorsCount, + }); + } +} + +``` + +### Filter Functions by Name Pattern + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { TerraformOutput, TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { DataAwsLambdaFunctions } from "./.gen/providers/aws/data-aws-lambda-functions"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + const all = new DataAwsLambdaFunctions(this, "all", {}); + const apiFunctions = + "${[ for name in ${" + + all.functionNames + + '} : name if can(regex("^api-", name))]}'; + const workerFunctions = + "${[ for name in ${" + + all.functionNames + + '} : name if can(regex("^worker-", name))]}'; + new TerraformOutput(this, "api_functions", { + value: apiFunctions, + }); + new TerraformOutput(this, "worker_functions", { + value: workerFunctions, + }); + } +} + +``` + +### Create Function Inventory + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { + TerraformOutput, + Fn, + Token, + TerraformCount, + TerraformStack, +} from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { DataAwsLambdaFunction } from "./.gen/providers/aws/data-aws-lambda-function"; +import { DataAwsLambdaFunctions } from "./.gen/providers/aws/data-aws-lambda-functions"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + const all = new DataAwsLambdaFunctions(this, "all", {}); + const functionInventory = + "${[ for i, name in ${" + + all.functionNames + + "} : {\n name = name\n arn = data.aws_lambda_functions.all.function_arns[i]\n runtime = data.aws_lambda_function.details[i].runtime\n memory_size = data.aws_lambda_function.details[i].memory_size\n timeout = data.aws_lambda_function.details[i].timeout\n handler = data.aws_lambda_function.details[i].handler\n }]}"; + new TerraformOutput(this, "function_inventory", { + value: functionInventory, + }); + /*In most cases loops should be handled in the programming language context and + not inside of the Terraform context. If you are looping over something external, e.g. a variable or a file input + you should consider using a for loop. If you are looping over something only known to Terraform, e.g. a result of a data source + you need to keep this like it is.*/ + const detailsCount = TerraformCount.of( + Token.asNumber(Fn.lengthOf(all.functionNames)) + ); + new DataAwsLambdaFunction(this, "details", { + functionName: Token.asString( + Fn.lookupNested(all.functionNames, [detailsCount.index]) + ), + count: detailsCount, + }); } } @@ -34,13 +175,15 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -This data source does not support any arguments. +The following arguments are optional: + +* `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). ## Attribute Reference This data source exports the following attributes in addition to the arguments above: -* `functionNames` - A list of Lambda Function names. -* `functionArns` - A list of Lambda Function ARNs. +* `functionArns` - List of Lambda Function ARNs. +* `functionNames` - List of Lambda Function names. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/lambda_invocation.html.markdown b/website/docs/cdktf/typescript/d/lambda_invocation.html.markdown index e27d1fd552e8..15a229ecf2d3 100644 --- a/website/docs/cdktf/typescript/d/lambda_invocation.html.markdown +++ b/website/docs/cdktf/typescript/d/lambda_invocation.html.markdown @@ -3,43 +3,160 @@ subcategory: "Lambda" layout: "aws" page_title: "AWS: aws_lambda_invocation" description: |- - Invoke AWS Lambda Function as data source + Invokes an AWS Lambda Function and returns its results. --- # Data Source: aws_lambda_invocation -Use this data source to invoke custom lambda functions as data source. -The lambda function is invoked with [RequestResponse](https://docs.aws.amazon.com/lambda/latest/dg/API_Invoke.html#API_Invoke_RequestSyntax) -invocation type. +Invokes an AWS Lambda Function and returns its results. Use this data source to execute Lambda functions during Terraform operations and use their results in other resources or outputs. -~> **NOTE:** The `aws_lambda_invocation` data source invokes the function during the first `apply` and every subsequent `plan` when the function is known. +The Lambda function is invoked with [RequestResponse](https://docs.aws.amazon.com/lambda/latest/dg/API_Invoke.html#API_Invoke_RequestSyntax) invocation type. -~> **NOTE:** If you get a `KMSAccessDeniedException: Lambda was unable to decrypt the environment variables because KMS access was denied` error when invoking an [`aws_lambda_function`](/docs/providers/aws/r/lambda_function.html) with environment variables, the IAM role associated with the function may have been deleted and recreated _after_ the function was created. You can fix the problem two ways: 1) updating the function's role to another role and then updating it back again to the recreated role, or 2) by using Terraform to `taint` the function and `apply` your configuration again to recreate the function. (When you create a function, Lambda grants permissions on the KMS key to the function's IAM role. If the IAM role is recreated, the grant is no longer valid. Changing the function's role or recreating the function causes Lambda to update the grant.) +~> **Note:** The `aws_lambda_invocation` data source invokes the function during the first `apply` and every subsequent `plan` when the function is known. + +~> **Note:** If you get a `KMSAccessDeniedException: Lambda was unable to decrypt the environment variables because KMS access was denied` error when invoking a Lambda function with environment variables, the IAM role associated with the function may have been deleted and recreated after the function was created. You can fix the problem two ways: 1) updating the function's role to another role and then updating it back again to the recreated role, or 2) by using Terraform to `taint` the function and `apply` your configuration again to recreate the function. (When you create a function, Lambda grants permissions on the KMS key to the function's IAM role. If the IAM role is recreated, the grant is no longer valid. Changing the function's role or recreating the function causes Lambda to update the grant.) ## Example Usage +### Basic Invocation + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { Token, Fn, TerraformOutput, TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { DataAwsLambdaInvocation } from "./.gen/providers/aws/data-aws-lambda-invocation"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + const example = new DataAwsLambdaInvocation(this, "example", { + functionName: Token.asString(awsLambdaFunctionExample.functionName), + input: Token.asString( + Fn.jsonencode({ + id: "123456", + operation: "getStatus", + }) + ), + }); + new TerraformOutput(this, "result", { + value: Fn.jsondecode(Token.asString(example.result)), + }); + } +} + +``` + +### Dynamic Resource Configuration + ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug import { Construct } from "constructs"; -import { TerraformOutput, Fn, Token, TerraformStack } from "cdktf"; +import { Fn, Token, TerraformStack } from "cdktf"; /* * Provider bindings are generated by running `cdktf get`. * See https://cdk.tf/provider-generation for more details. */ import { DataAwsLambdaInvocation } from "./.gen/providers/aws/data-aws-lambda-invocation"; +import { ElasticacheCluster } from "./.gen/providers/aws/elasticache-cluster"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + const resourceConfig = new DataAwsLambdaInvocation( + this, + "resource_config", + { + functionName: "resource-config-generator", + input: Token.asString( + Fn.jsonencode({ + environment: environment.value, + region: current.region, + service: "api", + }) + ), + qualifier: "production", + } + ); + const config = Fn.jsondecode(Token.asString(resourceConfig.result)); + new ElasticacheCluster(this, "example", { + clusterId: Token.asString( + Fn.lookupNested(config, ["cache", "cluster_id"]) + ), + engine: Token.asString(Fn.lookupNested(config, ["cache", "engine"])), + nodeType: Token.asString(Fn.lookupNested(config, ["cache", "node_type"])), + numCacheNodes: Token.asNumber( + Fn.lookupNested(config, ["cache", "nodes"]) + ), + parameterGroupName: Token.asString( + Fn.lookupNested(config, ["cache", "parameter_group"]) + ), + tags: Token.asStringMap(Fn.lookupNested(config, ["tags"])), + }); + } +} + +``` + +### Error Handling + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { + Token, + Fn, + Op, + conditional, + TerraformCount, + TerraformStack, +} from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { Resource } from "./.gen/providers/null/resource"; +import { DataAwsLambdaInvocation } from "./.gen/providers/aws/data-aws-lambda-invocation"; class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); const example = new DataAwsLambdaInvocation(this, "example", { - functionName: lambdaFunctionTest.functionName, - input: '{\n "key1": "value1",\n "key2": "value2"\n}\n\n', + functionName: Token.asString(awsLambdaFunctionExample.functionName), + input: Token.asString( + Fn.jsonencode({ + action: "validate", + payload: configuration.value, + }) + ), }); - new TerraformOutput(this, "result_entry", { - value: Fn.lookupNested(Fn.jsondecode(Token.asString(example.result)), [ - '"key1"', - ]), + const result = Fn.jsondecode(Token.asString(example.result)); + const hasErrors = Fn.try([ + Op.neq(Fn.lookupNested(result, ["errors"]), "null"), + false, + ]); + const errorMessages = conditional( + hasErrors, + Fn.join(", ", Token.asList(Fn.lookupNested(result, ["errors"]))), + "null" + ); + /*In most cases loops should be handled in the programming language context and + not inside of the Terraform context. If you are looping over something external, e.g. a variable or a file input + you should consider using a for loop. If you are looping over something only known to Terraform, e.g. a result of a data source + you need to keep this like it is.*/ + const validationCheckCount = TerraformCount.of( + Token.asNumber( + conditional( + hasErrors, + fail("Configuration validation failed: ${" + errorMessages + "}"), + 0 + ) + ) + ); + new Resource(this, "validation_check", { + count: validationCheckCount, }); } } @@ -48,17 +165,20 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -This data source supports the following arguments: +The following arguments are required: + +* `functionName` - (Required) Name of the Lambda function. +* `input` - (Required) String in JSON format that is passed as payload to the Lambda function. + +The following arguments are optional: -* `functionName` - (Required) Name of the lambda function. -* `input` - (Required) String in JSON format that is passed as payload to the lambda function. -* `qualifier` - (Optional) Qualifier (a.k.a version) of the lambda function. Defaults - to `$LATEST`. +* `qualifier` - (Optional) Qualifier (a.k.a version) of the Lambda function. Defaults to `$LATEST`. +* `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). ## Attribute Reference This data source exports the following attributes in addition to the arguments above: -* `result` - String result of the lambda function invocation. +* `result` - String result of the Lambda function invocation. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/lambda_layer_version.html.markdown b/website/docs/cdktf/typescript/d/lambda_layer_version.html.markdown index 1daeb93679fd..4aa402fd793b 100644 --- a/website/docs/cdktf/typescript/d/lambda_layer_version.html.markdown +++ b/website/docs/cdktf/typescript/d/lambda_layer_version.html.markdown @@ -3,36 +3,143 @@ subcategory: "Lambda" layout: "aws" page_title: "AWS: aws_lambda_layer_version" description: |- - Provides a Lambda Layer Version data source. + Provides details about an AWS Lambda Layer Version. --- # Data Source: aws_lambda_layer_version -Provides information about a Lambda Layer Version. +Provides details about an AWS Lambda Layer Version. Use this data source to retrieve information about a specific layer version or find the latest version compatible with your runtime and architecture requirements. ## Example Usage +### Get Latest Layer Version + ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug import { Construct } from "constructs"; -import { VariableType, TerraformVariable, TerraformStack } from "cdktf"; +import { Token, TerraformStack } from "cdktf"; /* * Provider bindings are generated by running `cdktf get`. * See https://cdk.tf/provider-generation for more details. */ import { DataAwsLambdaLayerVersion } from "./.gen/providers/aws/data-aws-lambda-layer-version"; +import { LambdaFunction } from "./.gen/providers/aws/lambda-function"; class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); - /*Terraform Variables are not always the best fit for getting inputs in the context of Terraform CDK. - You can read more about this at https://cdk.tf/variables*/ - const layerName = new TerraformVariable(this, "layer_name", { - type: VariableType.STRING, + const example = new DataAwsLambdaLayerVersion(this, "example", { + layerName: "my-shared-utilities", }); - new DataAwsLambdaLayerVersion(this, "existing", { - layerName: layerName.stringValue, + const awsLambdaFunctionExample = new LambdaFunction(this, "example_1", { + filename: "function.zip", + functionName: "example_function", + handler: "index.handler", + layers: [Token.asString(example.arn)], + role: lambdaRole.arn, + runtime: "nodejs20.x", + }); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + awsLambdaFunctionExample.overrideLogicalId("example"); + } +} + +``` + +### Get Specific Layer Version + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { TerraformOutput, TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { DataAwsLambdaLayerVersion } from "./.gen/providers/aws/data-aws-lambda-layer-version"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + const example = new DataAwsLambdaLayerVersion(this, "example", { + layerName: "production-utilities", + version: 5, + }); + new TerraformOutput(this, "layer_info", { + value: [ + { + arn: example.arn, + description: example.description, + version: example.version, + }, + ], + }); + } +} + +``` + +### Get Latest Compatible Layer Version + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { Token, TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { DataAwsLambdaLayerVersion } from "./.gen/providers/aws/data-aws-lambda-layer-version"; +import { LambdaFunction } from "./.gen/providers/aws/lambda-function"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + const armLayer = new DataAwsLambdaLayerVersion(this, "arm_layer", { + compatibleArchitecture: "arm64", + layerName: "optimized-libraries", + }); + const pythonLayer = new DataAwsLambdaLayerVersion(this, "python_layer", { + compatibleRuntime: "python3.12", + layerName: "python-dependencies", + }); + new LambdaFunction(this, "example", { + architectures: ["arm64"], + filename: "function.zip", + functionName: "multi_layer_function", + handler: "app.handler", + layers: [Token.asString(pythonLayer.arn), Token.asString(armLayer.arn)], + role: lambdaRole.arn, + runtime: "python3.12", + }); + } +} + +``` + +### Compare Layer Versions + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { Op, TerraformOutput, conditional, TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { DataAwsLambdaLayerVersion } from "./.gen/providers/aws/data-aws-lambda-layer-version"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + const latest = new DataAwsLambdaLayerVersion(this, "latest", { + layerName: "shared-layer", + }); + const stable = new DataAwsLambdaLayerVersion(this, "stable", { + layerName: "shared-layer", + version: 3, + }); + const useLatestLayer = Op.gt(latest.version, 5); + new TerraformOutput(this, "selected_layer_version", { + value: conditional(useLatestLayer, latest.version, stable.version), }); } } @@ -41,32 +148,33 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -This data source supports the following arguments: +The following arguments are required: + +* `layerName` - (Required) Name of the Lambda layer. -* `layerName` - (Required) Name of the lambda layer. +The following arguments are optional: + +* `compatibleArchitecture` - (Optional) Specific architecture the layer version must support. Conflicts with `version`. If specified, the latest available layer version supporting the provided architecture will be used. +* `compatibleRuntime` - (Optional) Specific runtime the layer version must support. Conflicts with `version`. If specified, the latest available layer version supporting the provided runtime will be used. +* `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). * `version` - (Optional) Specific layer version. Conflicts with `compatibleRuntime` and `compatibleArchitecture`. If omitted, the latest available layer version will be used. -* `compatibleRuntime` (Optional) Specific runtime the layer version must support. Conflicts with `version`. If specified, the latest available layer version supporting the provided runtime will be used. -* `compatibleArchitecture` (Optional) Specific architecture the layer version could support. Conflicts with `version`. If specified, the latest available layer version supporting the provided architecture will be used. ## Attribute Reference This data source exports the following attributes in addition to the arguments above: +* `arn` - ARN of the Lambda Layer with version. * `codeSha256` - Base64-encoded representation of raw SHA-256 sum of the zip file. +* `compatibleArchitectures` - List of [Architectures](https://docs.aws.amazon.com/lambda/latest/dg/API_GetLayerVersion.html#SSS-GetLayerVersion-response-CompatibleArchitectures) the specific Lambda Layer version is compatible with. +* `compatibleRuntimes` - List of [Runtimes](https://docs.aws.amazon.com/lambda/latest/dg/API_GetLayerVersion.html#SSS-GetLayerVersion-response-CompatibleRuntimes) the specific Lambda Layer version is compatible with. +* `createdDate` - Date this resource was created. * `description` - Description of the specific Lambda Layer version. -* `licenseInfo` - License info associated with the specific Lambda Layer version. -* `compatibleRuntimes` - List of [Runtimes][1] the specific Lambda Layer version is compatible with. -* `compatibleArchitectures` - A list of [Architectures][2] the specific Lambda Layer version is compatible with. -* `arn` - ARN of the Lambda Layer with version. * `layerArn` - ARN of the Lambda Layer without version. -* `createdDate` - Date this resource was created. +* `licenseInfo` - License info associated with the specific Lambda Layer version. * `signingJobArn` - ARN of a signing job. -* `signingProfileVersionArn` - The ARN for a signing profile version. +* `signingProfileVersionArn` - ARN for a signing profile version. * `sourceCodeHash` - (**Deprecated** use `codeSha256` instead) Base64-encoded representation of raw SHA-256 sum of the zip file. * `sourceCodeSize` - Size in bytes of the function .zip file. -* `version` - This Lambda Layer version. - -[1]: https://docs.aws.amazon.com/lambda/latest/dg/API_GetLayerVersion.html#SSS-GetLayerVersion-response-CompatibleRuntimes -[2]: https://docs.aws.amazon.com/lambda/latest/dg/API_GetLayerVersion.html#SSS-GetLayerVersion-response-CompatibleArchitectures +* `version` - Lambda Layer version. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/launch_configuration.html.markdown b/website/docs/cdktf/typescript/d/launch_configuration.html.markdown index ca20c4968ae4..d0f3c2cf719d 100644 --- a/website/docs/cdktf/typescript/d/launch_configuration.html.markdown +++ b/website/docs/cdktf/typescript/d/launch_configuration.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `name` - (Required) Name of the launch configuration. ## Attribute Reference @@ -92,4 +93,4 @@ This data source exports the following attributes in addition to the arguments a * `deviceName` - Name of the device. * `virtualName` - Virtual Name of the device. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/launch_template.html.markdown b/website/docs/cdktf/typescript/d/launch_template.html.markdown index 94b4abfe5bd1..09a89e029d12 100644 --- a/website/docs/cdktf/typescript/d/launch_template.html.markdown +++ b/website/docs/cdktf/typescript/d/launch_template.html.markdown @@ -65,6 +65,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `filter` - (Optional) Configuration block(s) for filtering. Detailed below. * `id` - (Optional) ID of the specific launch template to retrieve. * `name` - (Optional) Name of the launch template. @@ -91,4 +92,4 @@ This resource also exports a full set of attributes corresponding to the argumen - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/lb.html.markdown b/website/docs/cdktf/typescript/d/lb.html.markdown index 69cf4d7ea1bb..d0f9b3e12230 100644 --- a/website/docs/cdktf/typescript/d/lb.html.markdown +++ b/website/docs/cdktf/typescript/d/lb.html.markdown @@ -55,6 +55,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `arn` - (Optional) Full ARN of the load balancer. * `name` - (Optional) Unique name of the load balancer. * `tags` - (Optional) Mapping of tags, each pair of which must exactly match a pair on the desired load balancer. @@ -74,4 +75,4 @@ returned attributes - they are identical. - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/lb_hosted_zone_id.html.markdown b/website/docs/cdktf/typescript/d/lb_hosted_zone_id.html.markdown index 5e3c244c0fec..3efa9c9e3559 100644 --- a/website/docs/cdktf/typescript/d/lb_hosted_zone_id.html.markdown +++ b/website/docs/cdktf/typescript/d/lb_hosted_zone_id.html.markdown @@ -47,14 +47,13 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: -* `region` - (Optional) Name of the region whose AWS ELB HostedZoneId is desired. - Defaults to the region from the AWS provider configuration. +* `region` - (Optional) Name of the Region whose AWS ELB HostedZoneId is desired. Defaults to the Region set in the [provider configuration](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#aws-configuration-reference). * `loadBalancerType` - (Optional) Type of load balancer to create. Possible values are `application` or `network`. The default value is `application`. ## Attribute Reference This data source exports the following attributes in addition to the arguments above: -* `id` - ID of the AWS ELB HostedZoneId in the selected region. +* `id` - ID of the AWS ELB HostedZoneId in the selected Region. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/lb_listener.html.markdown b/website/docs/cdktf/typescript/d/lb_listener.html.markdown index ab207ed4bee2..025f75d6126b 100644 --- a/website/docs/cdktf/typescript/d/lb_listener.html.markdown +++ b/website/docs/cdktf/typescript/d/lb_listener.html.markdown @@ -55,6 +55,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `arn` - (Optional) ARN of the listener. Required if `loadBalancerArn` and `port` is not set. * `loadBalancerArn` - (Optional) ARN of the load balancer. Required if `arn` is not set. * `port` - (Optional) Port of the listener. Required if `arn` is not set. @@ -71,4 +72,4 @@ See the [LB Listener Resource](/docs/providers/aws/r/lb_listener.html) for detai - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/lb_listener_rule.html.markdown b/website/docs/cdktf/typescript/d/lb_listener_rule.html.markdown index 7d05d4d7e5d3..2a6292c79587 100644 --- a/website/docs/cdktf/typescript/d/lb_listener_rule.html.markdown +++ b/website/docs/cdktf/typescript/d/lb_listener_rule.html.markdown @@ -24,7 +24,7 @@ import { VariableType, TerraformVariable, TerraformStack } from "cdktf"; * Provider bindings are generated by running `cdktf get`. * See https://cdk.tf/provider-generation for more details. */ -import { DataAwsLbListenerRule } from "./.gen/providers/aws/"; +import { DataAwsLbListenerRule } from "./.gen/providers/aws/data-aws-lb-listener-rule"; class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); @@ -34,7 +34,7 @@ class MyConvertedCode extends TerraformStack { type: VariableType.STRING, }); new DataAwsLbListenerRule(this, "example", { - arn: lbRuleArn.value, + arn: lbRuleArn.stringValue, }); } } @@ -51,7 +51,7 @@ import { VariableType, TerraformVariable, TerraformStack } from "cdktf"; * Provider bindings are generated by running `cdktf get`. * See https://cdk.tf/provider-generation for more details. */ -import { DataAwsLbListenerRule } from "./.gen/providers/aws/"; +import { DataAwsLbListenerRule } from "./.gen/providers/aws/data-aws-lb-listener-rule"; class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); @@ -64,8 +64,8 @@ class MyConvertedCode extends TerraformStack { type: VariableType.NUMBER, }); new DataAwsLbListenerRule(this, "example", { - listener_arn: lbListenerArn.value, - priority: lbRulePriority.value, + listenerArn: lbListenerArn.stringValue, + priority: lbRulePriority.numberValue, }); } } @@ -76,6 +76,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `arn` - (Optional) ARN of the Listener Rule. Either `arn` or `listenerArn` must be set. * `listenerArn` - (Optional) ARN of the associated Listener. @@ -191,4 +192,4 @@ This data source exports the following attributes in addition to the arguments a * `values` - Set of `key`-`value` pairs indicating the query string parameters to match. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/lb_target_group.html.markdown b/website/docs/cdktf/typescript/d/lb_target_group.html.markdown index 5dadbd1a89c5..25eb24ac2ad5 100644 --- a/website/docs/cdktf/typescript/d/lb_target_group.html.markdown +++ b/website/docs/cdktf/typescript/d/lb_target_group.html.markdown @@ -55,6 +55,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `arn` - (Optional) Full ARN of the target group. * `name` - (Optional) Unique name of the target group. * `tags` - (Optional) Mapping of tags, each pair of which must exactly match a pair on the desired target group. @@ -74,4 +75,4 @@ on the returned attributes - they are identical. - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/lb_trust_store.html.markdown b/website/docs/cdktf/typescript/d/lb_trust_store.html.markdown index 5b7bef22feaa..c92aa8a603c6 100644 --- a/website/docs/cdktf/typescript/d/lb_trust_store.html.markdown +++ b/website/docs/cdktf/typescript/d/lb_trust_store.html.markdown @@ -55,6 +55,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `arn` - (Optional) Full ARN of the trust store. * `name` - (Optional) Unique name of the trust store. @@ -73,4 +74,4 @@ on the returned attributes - they are identical. - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/lbs.html.markdown b/website/docs/cdktf/typescript/d/lbs.html.markdown index 81e7d37800b4..60d21a228d33 100644 --- a/website/docs/cdktf/typescript/d/lbs.html.markdown +++ b/website/docs/cdktf/typescript/d/lbs.html.markdown @@ -43,6 +43,7 @@ class MyConvertedCode extends TerraformStack { The following arguments are optional: +* `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). * `tags` - (Optional) Map of tags, each pair of which must exactly match a pair on the desired Load Balancers. @@ -52,4 +53,4 @@ This data source exports the following attributes in addition to the arguments a * `arns` - Set of Load Balancer ARNs. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/lex_bot.html.markdown b/website/docs/cdktf/typescript/d/lex_bot.html.markdown index 92222bffc443..4ed0139c75b0 100644 --- a/website/docs/cdktf/typescript/d/lex_bot.html.markdown +++ b/website/docs/cdktf/typescript/d/lex_bot.html.markdown @@ -39,6 +39,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `name` - (Required) Name of the bot. The name is case sensitive. * `version` - (Optional) Version or alias of the bot. @@ -63,4 +64,4 @@ This data source exports the following attributes in addition to the arguments a * `version` - Version of the bot. For a new bot, the version is always `$LATEST`. * `voiceId` - Amazon Polly voice ID that the Amazon Lex Bot uses for voice interactions with the user. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/lex_bot_alias.html.markdown b/website/docs/cdktf/typescript/d/lex_bot_alias.html.markdown index d0d1ca4cb158..d6225837b703 100644 --- a/website/docs/cdktf/typescript/d/lex_bot_alias.html.markdown +++ b/website/docs/cdktf/typescript/d/lex_bot_alias.html.markdown @@ -39,6 +39,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `botName` - (Required) Name of the bot. * `name` - (Required) Name of the bot alias. The name is case sensitive. @@ -55,4 +56,4 @@ This data source exports the following attributes in addition to the arguments a * `lastUpdatedDate` - Date that the bot alias was updated. When you create a resource, the creation date and the last updated date are the same. * `name` - Name of the alias. The name is not case sensitive. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/lex_intent.html.markdown b/website/docs/cdktf/typescript/d/lex_intent.html.markdown index 117d09ed3f9c..44b0a3dce047 100644 --- a/website/docs/cdktf/typescript/d/lex_intent.html.markdown +++ b/website/docs/cdktf/typescript/d/lex_intent.html.markdown @@ -39,6 +39,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `name` - (Required) Name of the intent. The name is case sensitive. * `version` - (Optional) Version of the intent. @@ -59,4 +60,4 @@ intent on. To find the signature for an intent, see in the Alexa Skills Kit. * `version` - Version of the bot. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/lex_slot_type.html.markdown b/website/docs/cdktf/typescript/d/lex_slot_type.html.markdown index 1cd09aa7faf3..b455220c2ef3 100644 --- a/website/docs/cdktf/typescript/d/lex_slot_type.html.markdown +++ b/website/docs/cdktf/typescript/d/lex_slot_type.html.markdown @@ -39,6 +39,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `name` - (Required) Name of the slot type. The name is case sensitive. * `version` - (Optional) Version of the slot type. @@ -61,4 +62,4 @@ value is similar to the slot value. `TOP_RESOLUTION` returns the first value in if there is a resolution list for the slot, otherwise null is returned. * `version` - Version of the slot type. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/licensemanager_grants.html.markdown b/website/docs/cdktf/typescript/d/licensemanager_grants.html.markdown index 65f82c43a93f..817ed7033534 100644 --- a/website/docs/cdktf/typescript/d/licensemanager_grants.html.markdown +++ b/website/docs/cdktf/typescript/d/licensemanager_grants.html.markdown @@ -47,6 +47,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `filter` - (Optional) Custom filter block as described below. ### `filter` @@ -90,4 +91,4 @@ This data source exports the following attributes in addition to the arguments a * `arns` - List of all the license grant ARNs found. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/licensemanager_received_license.html.markdown b/website/docs/cdktf/typescript/d/licensemanager_received_license.html.markdown index de4efe853a95..e70b0498b0be 100644 --- a/website/docs/cdktf/typescript/d/licensemanager_received_license.html.markdown +++ b/website/docs/cdktf/typescript/d/licensemanager_received_license.html.markdown @@ -41,6 +41,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `licenseArn` - (Required) The ARN of the received license you want data for. ## Attribute Reference @@ -124,4 +125,4 @@ A list with a single map. * `begin` - Start of the validity time range. * `end` - End of the validity time range. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/licensemanager_received_licenses.html.markdown b/website/docs/cdktf/typescript/d/licensemanager_received_licenses.html.markdown index 7166fef64ada..c3f6d1db1d8c 100644 --- a/website/docs/cdktf/typescript/d/licensemanager_received_licenses.html.markdown +++ b/website/docs/cdktf/typescript/d/licensemanager_received_licenses.html.markdown @@ -45,6 +45,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `filter` - (Optional) Custom filter block as described below. ### `filter` @@ -88,4 +89,4 @@ This data source exports the following attributes in addition to the arguments a * `arns` - List of all the license ARNs found. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/location_geofence_collection.html.markdown b/website/docs/cdktf/typescript/d/location_geofence_collection.html.markdown index 4b8d1653bd0b..0af877c90ced 100644 --- a/website/docs/cdktf/typescript/d/location_geofence_collection.html.markdown +++ b/website/docs/cdktf/typescript/d/location_geofence_collection.html.markdown @@ -38,8 +38,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `collectionName` - (Required) Name of the geofence collection. ## Attribute Reference @@ -53,4 +54,4 @@ This data source exports the following attributes in addition to the arguments a * `tags` - Key-value map of resource tags for the geofence collection. * `updateTime` - Timestamp for when the geofence collection resource was last updated in ISO 8601 format. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/location_map.html.markdown b/website/docs/cdktf/typescript/d/location_map.html.markdown index 8e2f61c001a2..cea5715bec59 100644 --- a/website/docs/cdktf/typescript/d/location_map.html.markdown +++ b/website/docs/cdktf/typescript/d/location_map.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `mapName` - (Required) Name of the map resource. ## Attribute Reference @@ -52,4 +53,4 @@ This data source exports the following attributes in addition to the arguments a * `tags` - Key-value map of resource tags for the map. * `updateTime` - Timestamp for when the map resource was last updated in ISO 8601 format. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/location_place_index.html.markdown b/website/docs/cdktf/typescript/d/location_place_index.html.markdown index 2198421097e8..a01ba4c13a6a 100644 --- a/website/docs/cdktf/typescript/d/location_place_index.html.markdown +++ b/website/docs/cdktf/typescript/d/location_place_index.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `indexName` - (Required) Name of the place index resource. ## Attribute Reference @@ -52,4 +53,4 @@ This data source exports the following attributes in addition to the arguments a * `tags` - Key-value map of resource tags for the place index. * `updateTime` - Timestamp for when the place index resource was last updated in ISO 8601 format. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/location_route_calculator.html.markdown b/website/docs/cdktf/typescript/d/location_route_calculator.html.markdown index 42cc65c2da40..84543aebc50f 100644 --- a/website/docs/cdktf/typescript/d/location_route_calculator.html.markdown +++ b/website/docs/cdktf/typescript/d/location_route_calculator.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `calculatorName` - (Required) Name of the route calculator resource. ## Attribute Reference @@ -51,4 +52,4 @@ This data source exports the following attributes in addition to the arguments a * `tags` - Key-value map of resource tags for the route calculator. * `updateTime` - Timestamp for when the route calculator resource was last updated in ISO 8601 format. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/location_tracker.html.markdown b/website/docs/cdktf/typescript/d/location_tracker.html.markdown index d870f5adc544..afe4908e1e18 100644 --- a/website/docs/cdktf/typescript/d/location_tracker.html.markdown +++ b/website/docs/cdktf/typescript/d/location_tracker.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `trackerName` - (Required) Name of the tracker resource. ## Attribute Reference @@ -52,4 +53,4 @@ This data source exports the following attributes in addition to the arguments a * `trackerArn` - ARN for the tracker resource. Used when you need to specify a resource across all AWS. * `updateTime` - Timestamp for when the tracker resource was last updated in ISO 8601 format. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/location_tracker_association.html.markdown b/website/docs/cdktf/typescript/d/location_tracker_association.html.markdown index d66adeb3b0bd..320e937c6f69 100644 --- a/website/docs/cdktf/typescript/d/location_tracker_association.html.markdown +++ b/website/docs/cdktf/typescript/d/location_tracker_association.html.markdown @@ -40,8 +40,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `consumerArn` - (Required) ARN of the geofence collection associated to tracker resource. * `trackerName` - (Required) Name of the tracker resource associated with a geofence collection. @@ -49,4 +50,4 @@ The following arguments are required: This data source exports no additional attributes. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/location_tracker_associations.html.markdown b/website/docs/cdktf/typescript/d/location_tracker_associations.html.markdown index 5d1f89cf24f3..a08dc69fd19d 100644 --- a/website/docs/cdktf/typescript/d/location_tracker_associations.html.markdown +++ b/website/docs/cdktf/typescript/d/location_tracker_associations.html.markdown @@ -38,8 +38,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `trackerName` - (Required) Name of the tracker resource associated with a geofence collection. ## Attribute Reference @@ -48,4 +49,4 @@ This data source exports the following attributes in addition to the arguments a * `consumerArns` - List of geofence collection ARNs associated to the tracker resource. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/media_convert_queue.html.markdown b/website/docs/cdktf/typescript/d/media_convert_queue.html.markdown index d9932473ced5..4c93d8608f3f 100644 --- a/website/docs/cdktf/typescript/d/media_convert_queue.html.markdown +++ b/website/docs/cdktf/typescript/d/media_convert_queue.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `id` - (Required) Unique identifier of the queue. The same as `name`. ## Attribute Reference @@ -49,4 +50,4 @@ This data source exports the following attributes in addition to the arguments a * `status` - The status of the queue. * `tags` - A map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/medialive_input.html.markdown b/website/docs/cdktf/typescript/d/medialive_input.html.markdown index 66c223a67bd8..95a80438da60 100644 --- a/website/docs/cdktf/typescript/d/medialive_input.html.markdown +++ b/website/docs/cdktf/typescript/d/medialive_input.html.markdown @@ -38,8 +38,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `id` - (Required) The ID of the Input. ## Attribute Reference @@ -62,4 +63,4 @@ This data source exports the following attributes in addition to the arguments a * `tags` - A map of tags assigned to the Input. * `type` - The type of the input. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/memorydb_acl.html.markdown b/website/docs/cdktf/typescript/d/memorydb_acl.html.markdown index 0b6a0b7e0c0f..9ec8cc2b7473 100644 --- a/website/docs/cdktf/typescript/d/memorydb_acl.html.markdown +++ b/website/docs/cdktf/typescript/d/memorydb_acl.html.markdown @@ -36,8 +36,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `name` - (Required) Name of the ACL. ## Attribute Reference @@ -50,4 +51,4 @@ This data source exports the following attributes in addition to the arguments a * `tags` - Map of tags assigned to the ACL. * `userNames` - Set of MemoryDB user names included in this ACL. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/memorydb_cluster.html.markdown b/website/docs/cdktf/typescript/d/memorydb_cluster.html.markdown index a33559895163..94436869d2de 100644 --- a/website/docs/cdktf/typescript/d/memorydb_cluster.html.markdown +++ b/website/docs/cdktf/typescript/d/memorydb_cluster.html.markdown @@ -36,8 +36,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `name` - (Required) Name of the cluster. ## Attribute Reference @@ -83,4 +84,4 @@ This data source exports the following attributes in addition to the arguments a * `tlsEnabled` - When true, in-transit encryption is enabled for the cluster. * `tags` - Map of tags assigned to the cluster. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/memorydb_parameter_group.html.markdown b/website/docs/cdktf/typescript/d/memorydb_parameter_group.html.markdown index 243fa9ca6b83..4712e7332d28 100644 --- a/website/docs/cdktf/typescript/d/memorydb_parameter_group.html.markdown +++ b/website/docs/cdktf/typescript/d/memorydb_parameter_group.html.markdown @@ -36,8 +36,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `name` - (Required) Name of the parameter group. ## Attribute Reference @@ -53,4 +54,4 @@ This data source exports the following attributes in addition to the arguments a * `value` - Value of the parameter. * `tags` - Map of tags assigned to the parameter group. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/memorydb_snapshot.html.markdown b/website/docs/cdktf/typescript/d/memorydb_snapshot.html.markdown index d49a15542593..c8ea14ebd1b5 100644 --- a/website/docs/cdktf/typescript/d/memorydb_snapshot.html.markdown +++ b/website/docs/cdktf/typescript/d/memorydb_snapshot.html.markdown @@ -36,8 +36,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `name` - (Required) Name of the snapshot. ## Attribute Reference @@ -66,4 +67,4 @@ This data source exports the following attributes in addition to the arguments a * `source` - Whether the snapshot is from an automatic backup (`automated`) or was created manually (`manual`). * `tags` - Map of tags assigned to the snapshot. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/memorydb_subnet_group.html.markdown b/website/docs/cdktf/typescript/d/memorydb_subnet_group.html.markdown index bbee78c67042..ed1cc2f7bec5 100644 --- a/website/docs/cdktf/typescript/d/memorydb_subnet_group.html.markdown +++ b/website/docs/cdktf/typescript/d/memorydb_subnet_group.html.markdown @@ -36,8 +36,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `name` - (Required) Name of the subnet group. ## Attribute Reference @@ -51,4 +52,4 @@ This data source exports the following attributes in addition to the arguments a * `vpcId` - VPC in which the subnet group exists. * `tags` - Map of tags assigned to the subnet group. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/memorydb_user.html.markdown b/website/docs/cdktf/typescript/d/memorydb_user.html.markdown index 57a0d5ee756e..2748ce11ce45 100644 --- a/website/docs/cdktf/typescript/d/memorydb_user.html.markdown +++ b/website/docs/cdktf/typescript/d/memorydb_user.html.markdown @@ -36,8 +36,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `userName` - (Required) Name of the user. ## Attribute Reference @@ -53,4 +54,4 @@ This data source exports the following attributes in addition to the arguments a * `minimumEngineVersion` - Minimum engine version supported for the user. * `tags` - Map of tags assigned to the user. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/mq_broker.html.markdown b/website/docs/cdktf/typescript/d/mq_broker.html.markdown index dd7619a93fae..fd9167b928fa 100644 --- a/website/docs/cdktf/typescript/d/mq_broker.html.markdown +++ b/website/docs/cdktf/typescript/d/mq_broker.html.markdown @@ -3,21 +3,21 @@ subcategory: "MQ" layout: "aws" page_title: "AWS: aws_mq_broker" description: |- - Provides a MQ Broker data source. + Provides details about an existing Amazon MQ broker. --- # Data Source: aws_mq_broker -Provides information about a MQ Broker. +Provides details about an existing Amazon MQ broker. Use this data source to retrieve configuration and metadata for an Amazon MQ broker by ID or name. ## Example Usage ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug import { Construct } from "constructs"; -import { VariableType, TerraformVariable, TerraformStack } from "cdktf"; +import { TerraformStack } from "cdktf"; /* * Provider bindings are generated by running `cdktf get`. * See https://cdk.tf/provider-generation for more details. @@ -26,21 +26,8 @@ import { DataAwsMqBroker } from "./.gen/providers/aws/data-aws-mq-broker"; class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); - /*Terraform Variables are not always the best fit for getting inputs in the context of Terraform CDK. - You can read more about this at https://cdk.tf/variables*/ - const brokerId = new TerraformVariable(this, "broker_id", { - default: "", - type: VariableType.STRING, - }); - const brokerName = new TerraformVariable(this, "broker_name", { - default: "", - type: VariableType.STRING, - }); - new DataAwsMqBroker(this, "by_id", { - brokerId: brokerId.stringValue, - }); - new DataAwsMqBroker(this, "by_name", { - brokerName: brokerName.stringValue, + new DataAwsMqBroker(this, "example", { + brokerId: "b-1234a5b6-78cd-901e-2fgh-3i45j6k178l9", }); } } @@ -49,16 +36,83 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -This data source supports the following arguments: +The following arguments are optional: -* `brokerId` - (Optional) Unique id of the mq broker. -* `brokerName` - (Optional) Unique name of the mq broker. +* `brokerId` - (Optional) Unique ID of the MQ broker. +* `brokerName` - (Optional) Unique name of the MQ broker. +* `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). +~> **Note:** Either `brokerId` or `brokerName` must be specified. ## Attribute Reference This data source exports the following attributes in addition to the arguments above: -See the [`aws_mq_broker` resource](/docs/providers/aws/r/mq_broker.html) for details on the returned attributes. -They are identical except for user password, which is not returned when describing broker. +* `arn` - ARN of the broker. +* `authenticationStrategy` - Authentication strategy used to secure the broker. +* `autoMinorVersionUpgrade` - Whether to automatically upgrade to new minor versions of brokers as Amazon MQ makes releases available. +* `configuration` - Configuration block for broker configuration. See [Configuration](#configuration) below. +* `deploymentMode` - Deployment mode of the broker. +* `encryptionOptions` - Configuration block containing encryption options. See [Encryption Options](#encryption-options) below. +* `engineType` - Type of broker engine. +* `engineVersion` - Version of the broker engine. +* `hostInstanceType` - Broker's instance type. +* `instances` - List of information about allocated brokers (both active & standby). See [Instances](#instances) below. +* `ldapServerMetadata` - Configuration block for the LDAP server used to authenticate and authorize connections to the broker. See [LDAP Server Metadata](#ldap-server-metadata) below. +* `logs` - Configuration block for the logging configuration of the broker. See [Logs](#logs) below. +* `maintenanceWindowStartTime` - Configuration block for the maintenance window start time. See [Maintenance Window Start Time](#maintenance-window-start-time) below. +* `publiclyAccessible` - Whether to enable connections from applications outside of the VPC that hosts the broker's subnets. +* `securityGroups` - List of security group IDs assigned to the broker. +* `storageType` - Storage type of the broker. +* `subnetIds` - List of subnet IDs in which to launch the broker. +* `tags` - Map of tags assigned to the broker. +* `user` - Configuration block for broker users. See [User](#user) below. + +### Configuration + +* `id` - Configuration ID. +* `revision` - Revision of the Configuration. + +### Encryption Options + +* `kmsKeyId` - Amazon Resource Name (ARN) of Key Management Service (KMS) Customer Master Key (CMK) to use for encryption at rest. +* `useAwsOwnedKey` - Whether to enable an AWS-owned KMS CMK that is not in your account. + +### Instances + +* `console_url` - URL of the ActiveMQ Web Console or the RabbitMQ Management UI depending on `engineType`. +* `endpoints` - Broker's wire-level protocol endpoints. +* `ipAddress` - IP Address of the broker. + +### LDAP Server Metadata + +* `hosts` - List of a fully qualified domain name of the LDAP server and an optional failover server. +* `roleBase` - Fully qualified name of the directory to search for a user's groups. +* `roleName` - LDAP attribute that identifies the group name attribute in the object returned from the group membership query. +* `roleSearchMatching` - Search criteria for groups. +* `roleSearchSubtree` - Whether the directory search scope is the entire sub-tree. +* `serviceAccountPassword` - Service account password. +* `serviceAccountUsername` - Service account username. +* `userBase` - Fully qualified name of the directory where you want to search for users. +* `userRoleName` - Name of the LDAP attribute for the user group membership. +* `userSearchMatching` - Search criteria for users. +* `userSearchSubtree` - Whether the directory search scope is the entire sub-tree. + +### Logs + +* `audit` - Whether audit logging is enabled. +* `general` - Whether general logging is enabled. + +### Maintenance Window Start Time + +* `dayOfWeek` - Day of the week. +* `timeOfDay` - Time, in 24-hour format. +* `timeZone` - Time zone in either the Country/City format or the UTC offset format. + +### User + +* `consoleAccess` - Whether to enable access to the ActiveMQ Web Console for the user. +* `groups` - List of groups to which the ActiveMQ user belongs. +* `replicationUser` - Whether to set replication user. +* `username` - Username of the user. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/mq_broker_engine_types.html.markdown b/website/docs/cdktf/typescript/d/mq_broker_engine_types.html.markdown index 5f906d14f89f..53188fba0d25 100644 --- a/website/docs/cdktf/typescript/d/mq_broker_engine_types.html.markdown +++ b/website/docs/cdktf/typescript/d/mq_broker_engine_types.html.markdown @@ -3,19 +3,17 @@ subcategory: "MQ" layout: "aws" page_title: "AWS: aws_mq_broker_engine_types" description: |- - Retrieve information about available broker engines. + Provides details about available MQ broker engine types. --- # Data Source: aws_mq_broker_engine_types -Retrieve information about available broker engines. +Provides details about available MQ broker engine types. Use this data source to retrieve supported engine types and their versions for Amazon MQ brokers. ## Example Usage -### Basic Usage - ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug import { Construct } from "constructs"; @@ -40,17 +38,22 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: -* `engineType` - (Optional) The MQ engine type to return version details for. +* `engineType` - (Optional) MQ engine type to return version details for. +* `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). ## Attribute Reference This data source exports the following attributes in addition to the arguments above: -* `brokerEngineTypes` - A list of available engine types and versions. See [Engine Types](#engine-types). +* `brokerEngineTypes` - List of available engine types and versions. See [Engine Types](#engine-types). + +### Engine Types + +* `engineType` - Broker's engine type. +* `engine_versions` - List of engine versions. See [Engine Versions](#engine-versions). -### engine-types +### Engine Versions -* `engineType` - The broker's engine type. -* `engine_versions` - The list of engine versions. +* `name` - Name of the engine version. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/mq_broker_instance_type_offerings.html.markdown b/website/docs/cdktf/typescript/d/mq_broker_instance_type_offerings.html.markdown index 34a2989ba538..d00ce8693165 100644 --- a/website/docs/cdktf/typescript/d/mq_broker_instance_type_offerings.html.markdown +++ b/website/docs/cdktf/typescript/d/mq_broker_instance_type_offerings.html.markdown @@ -3,14 +3,14 @@ subcategory: "MQ" layout: "aws" page_title: "AWS: aws_mq_broker_instance_type_offerings" description: |- - Provides a MQ Broker Instance Offerings data source. + Provides details about available MQ broker instance type offerings. --- # Data Source: aws_mq_broker_instance_type_offerings -Provides information about a MQ Broker Instance Offerings. +Provides details about available MQ broker instance type offerings. Use this data source to discover supported instance types, storage types, and deployment modes for Amazon MQ brokers. ## Example Usage @@ -26,21 +26,21 @@ import { DataAwsMqBrokerInstanceTypeOfferings } from "./.gen/providers/aws/data- class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); - new DataAwsMqBrokerInstanceTypeOfferings(this, "all", { + new DataAwsMqBrokerInstanceTypeOfferings(this, "activemq", { engineType: "ACTIVEMQ", - hostInstanceType: "mq.m5.large", + }); + new DataAwsMqBrokerInstanceTypeOfferings(this, "all", {}); + new DataAwsMqBrokerInstanceTypeOfferings(this, "ebs", { storageType: "EBS", }); - new DataAwsMqBrokerInstanceTypeOfferings(this, "empty", {}); - new DataAwsMqBrokerInstanceTypeOfferings(this, "engine", { + new DataAwsMqBrokerInstanceTypeOfferings(this, "filtered", { engineType: "ACTIVEMQ", - }); - new DataAwsMqBrokerInstanceTypeOfferings(this, "instance", { hostInstanceType: "mq.m5.large", - }); - new DataAwsMqBrokerInstanceTypeOfferings(this, "storage", { storageType: "EBS", }); + new DataAwsMqBrokerInstanceTypeOfferings(this, "m5", { + hostInstanceType: "mq.m5.large", + }); } } @@ -48,29 +48,30 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -This data source supports the following arguments: +The following arguments are optional: * `engineType` - (Optional) Filter response by engine type. * `hostInstanceType` - (Optional) Filter response by host instance type. +* `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). * `storageType` - (Optional) Filter response by storage type. ## Attribute Reference This data source exports the following attributes in addition to the arguments above: -* `brokerInstanceOptions` - Option for host instance type. See Broker Instance Options below. +* `brokerInstanceOptions` - List of broker instance options. See [Broker Instance Options](#broker-instance-options) below. ### Broker Instance Options -* `availabilityZones` - List of available AZs. See Availability Zones. below +* `availabilityZones` - List of available Availability Zones. See [Availability Zones](#availability-zones) below. * `engineType` - Broker's engine type. * `hostInstanceType` - Broker's instance type. * `storageType` - Broker's storage type. -* `supported_deployment_modes` - The list of supported deployment modes. -* `supported_engine_versions` - The list of supported engine versions. +* `supported_deployment_modes` - List of supported deployment modes. +* `supported_engine_versions` - List of supported engine versions. ### Availability Zones * `name` - Name of the Availability Zone. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/msk_bootstrap_brokers.html.markdown b/website/docs/cdktf/typescript/d/msk_bootstrap_brokers.html.markdown index f3a00a978aa3..d9fb9af0d35b 100644 --- a/website/docs/cdktf/typescript/d/msk_bootstrap_brokers.html.markdown +++ b/website/docs/cdktf/typescript/d/msk_bootstrap_brokers.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `clusterArn` - (Required) ARN of the cluster the nodes belong to. ## Attribute Reference @@ -55,4 +56,4 @@ This data source exports the following attributes in addition to the arguments a * `bootstrapBrokersVpcConnectivitySaslScram` - A string containing one or more DNS names (or IP addresses) and SASL SCRAM port pairs for VPC connectivity. * `bootstrapBrokersVpcConnectivityTls` - A string containing one or more DNS names (or IP addresses) and TLS port pairs for VPC connectivity. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/msk_broker_nodes.html.markdown b/website/docs/cdktf/typescript/d/msk_broker_nodes.html.markdown index aad3a12dc0d3..d46449dbab84 100644 --- a/website/docs/cdktf/typescript/d/msk_broker_nodes.html.markdown +++ b/website/docs/cdktf/typescript/d/msk_broker_nodes.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `clusterArn` - (Required) ARN of the cluster the nodes belong to. ## Attribute Reference @@ -55,4 +56,4 @@ This data source exports the following attributes in addition to the arguments a * `endpoints` - Set of endpoints for accessing the broker. This does not include ports * `node_arn` - ARN of the node - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/msk_cluster.html.markdown b/website/docs/cdktf/typescript/d/msk_cluster.html.markdown index 34dcb01c93d3..b5b8d0173d6c 100644 --- a/website/docs/cdktf/typescript/d/msk_cluster.html.markdown +++ b/website/docs/cdktf/typescript/d/msk_cluster.html.markdown @@ -40,6 +40,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `clusterName` - (Required) Name of the cluster. ## Attribute Reference @@ -62,4 +63,4 @@ This data source exports the following attributes in addition to the arguments a * `zookeeperConnectString` - A comma separated list of one or more hostname:port pairs to use to connect to the Apache Zookeeper cluster. The returned values are sorted alphbetically. The AWS API may not return all endpoints, so this value is not guaranteed to be stable across applies. * `zookeeperConnectStringTls` - A comma separated list of one or more hostname:port pairs to use to connect to the Apache Zookeeper cluster via TLS. The returned values are sorted alphabetically. The AWS API may not return all endpoints, so this value is not guaranteed to be stable across applies. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/msk_configuration.html.markdown b/website/docs/cdktf/typescript/d/msk_configuration.html.markdown index 5e908b57e605..183518d7f7ee 100644 --- a/website/docs/cdktf/typescript/d/msk_configuration.html.markdown +++ b/website/docs/cdktf/typescript/d/msk_configuration.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `name` - (Required) Name of the configuration. ## Attribute Reference @@ -50,4 +51,4 @@ This data source exports the following attributes in addition to the arguments a * `kafkaVersions` - List of Apache Kafka versions which can use this configuration. * `serverProperties` - Contents of the server.properties file. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/msk_kafka_version.html.markdown b/website/docs/cdktf/typescript/d/msk_kafka_version.html.markdown index 3cf231250754..4a2e7e57e96f 100644 --- a/website/docs/cdktf/typescript/d/msk_kafka_version.html.markdown +++ b/website/docs/cdktf/typescript/d/msk_kafka_version.html.markdown @@ -41,6 +41,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `preferredVersions` - (Optional) Ordered list of preferred Kafka versions. The first match in this list will be returned. Either `preferredVersions` or `version` must be set. * `version` - (Optional) Version of MSK Kafka. For example 2.4.1.1 or "2.2.1" etc. Either `preferredVersions` or `version` must be set. @@ -50,4 +51,4 @@ This data source exports the following attributes in addition to the arguments a * `status` - Status of the MSK Kafka version eg. `ACTIVE` or `DEPRECATED`. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/msk_vpc_connection.html.markdown b/website/docs/cdktf/typescript/d/msk_vpc_connection.html.markdown index 02e41d2795ab..322d5ac77d97 100644 --- a/website/docs/cdktf/typescript/d/msk_vpc_connection.html.markdown +++ b/website/docs/cdktf/typescript/d/msk_vpc_connection.html.markdown @@ -37,6 +37,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `arn` - (Required) ARN of the VPC Connection. ## Attribute Reference @@ -50,4 +51,4 @@ This data source exports the following attributes in addition to the arguments a * `targetClusterArn` - The Amazon Resource Name (ARN) of the cluster. * `vpcId` - The VPC ID of the remote client. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/mskconnect_connector.html.markdown b/website/docs/cdktf/typescript/d/mskconnect_connector.html.markdown index 9a9dbf0a9a3b..fc2a3805edca 100644 --- a/website/docs/cdktf/typescript/d/mskconnect_connector.html.markdown +++ b/website/docs/cdktf/typescript/d/mskconnect_connector.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `name` - (Required) Name of the connector. ## Attribute Reference @@ -49,4 +50,4 @@ This data source exports the following attributes in addition to the arguments a * `tags` - A map of tags assigned to the resource. * `version` - Current version of the connector. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/mskconnect_custom_plugin.html.markdown b/website/docs/cdktf/typescript/d/mskconnect_custom_plugin.html.markdown index 11fd019080a9..56fefeb446d1 100644 --- a/website/docs/cdktf/typescript/d/mskconnect_custom_plugin.html.markdown +++ b/website/docs/cdktf/typescript/d/mskconnect_custom_plugin.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `name` - (Required) Name of the custom plugin. ## Attribute Reference @@ -50,4 +51,4 @@ This data source exports the following attributes in addition to the arguments a * `state` - the state of the custom plugin. * `tags` - A map of tags assigned to the resource. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/mskconnect_worker_configuration.html.markdown b/website/docs/cdktf/typescript/d/mskconnect_worker_configuration.html.markdown index 505ad3f49e74..095b8bebd906 100644 --- a/website/docs/cdktf/typescript/d/mskconnect_worker_configuration.html.markdown +++ b/website/docs/cdktf/typescript/d/mskconnect_worker_configuration.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `name` - (Required) Name of the worker configuration. ## Attribute Reference @@ -50,4 +51,4 @@ This data source exports the following attributes in addition to the arguments a * `propertiesFileContent` - contents of connect-distributed.properties file. * `tags` - A map of tags assigned to the resource. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/nat_gateway.html.markdown b/website/docs/cdktf/typescript/d/nat_gateway.html.markdown index e88c167013b1..3c42c5ea60f1 100644 --- a/website/docs/cdktf/typescript/d/nat_gateway.html.markdown +++ b/website/docs/cdktf/typescript/d/nat_gateway.html.markdown @@ -63,6 +63,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `id` - (Optional) ID of the specific NAT Gateway to retrieve. * `subnetId` - (Optional) ID of subnet that the NAT Gateway resides in. * `vpcId` - (Optional) ID of the VPC that the NAT Gateway resides in. @@ -104,4 +105,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/nat_gateways.html.markdown b/website/docs/cdktf/typescript/d/nat_gateways.html.markdown index 9027fd836fe1..28caac7f343e 100644 --- a/website/docs/cdktf/typescript/d/nat_gateways.html.markdown +++ b/website/docs/cdktf/typescript/d/nat_gateways.html.markdown @@ -58,6 +58,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `filter` - (Optional) Custom filter block as described below. * `vpcId` - (Optional) VPC ID that you want to filter from. * `tags` - (Optional) Map of tags, each pair of which must exactly match @@ -85,4 +86,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/neptune_engine_version.html.markdown b/website/docs/cdktf/typescript/d/neptune_engine_version.html.markdown index 87686825b9c5..96d12236cff3 100644 --- a/website/docs/cdktf/typescript/d/neptune_engine_version.html.markdown +++ b/website/docs/cdktf/typescript/d/neptune_engine_version.html.markdown @@ -49,6 +49,7 @@ This data source supports the following arguments: * `preferredMajorTargets` - (Optional) Ordered list of preferred major engine versions. * `preferredUpgradeTargets` - (Optional) Ordered list of preferred upgrade engine versions. * `preferredVersions` - (Optional) Ordered list of preferred engine versions. The first match in this list will be returned. If no preferred matches are found and the original search returned more than one result, an error is returned. If both the `version` and `preferredVersions` arguments are not configured, the data source will return the default version for the engine. +* `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). * `version` - (Optional) Version of the DB engine. For example, `1.0.1.0`, `1.0.2.2`, and `1.0.3.0`. If both the `version` and `preferredVersions` arguments are not configured, the data source will return the default version for the engine. ## Attribute Reference @@ -69,4 +70,4 @@ This data source exports the following attributes in addition to the arguments a * `versionActual` - Actual engine version returned by the API. * `versionDescription` - Description of the database engine version. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/neptune_orderable_db_instance.html.markdown b/website/docs/cdktf/typescript/d/neptune_orderable_db_instance.html.markdown index 2c209737e56f..cf42478e1b87 100644 --- a/website/docs/cdktf/typescript/d/neptune_orderable_db_instance.html.markdown +++ b/website/docs/cdktf/typescript/d/neptune_orderable_db_instance.html.markdown @@ -39,6 +39,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `engine` - (Optional) DB engine. (Default: `neptune`) * `engineVersion` - (Optional) Version of the DB engine. For example, `1.0.1.0`, `1.0.1.2`, `1.0.2.2`, and `1.0.3.0`. * `instanceClass` - (Optional) DB instance class. Examples of classes are `db.r5.large`, `db.r5.xlarge`, `db.r4.large`, `db.r5.4xlarge`, `db.r5.12xlarge`, `db.r4.xlarge`, and `db.t3.medium`. @@ -66,4 +67,4 @@ This data source exports the following attributes in addition to the arguments a * `supportsPerformanceInsights` - Whether a DB instance supports Performance Insights. * `supportsStorageEncryption` - Whether a DB instance supports encrypted storage. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/network_acls.html.markdown b/website/docs/cdktf/typescript/d/network_acls.html.markdown index 877b2607df2e..3cfa48f18142 100644 --- a/website/docs/cdktf/typescript/d/network_acls.html.markdown +++ b/website/docs/cdktf/typescript/d/network_acls.html.markdown @@ -98,6 +98,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `vpcId` - (Optional) VPC ID that you want to filter from. * `tags` - (Optional) Map of tags, each pair of which must exactly match a pair on the desired network ACLs. @@ -125,4 +126,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/network_interface.html.markdown b/website/docs/cdktf/typescript/d/network_interface.html.markdown index fcf9282ae431..29bc6155f51d 100644 --- a/website/docs/cdktf/typescript/d/network_interface.html.markdown +++ b/website/docs/cdktf/typescript/d/network_interface.html.markdown @@ -38,15 +38,17 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: -* `id` – (Optional) Identifier for the network interface. -* `filter` – (Optional) One or more name/value pairs to filter off of. There are several valid keys, for a full reference, check out [describe-network-interfaces](https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-network-interfaces.html) in the AWS CLI reference. +* `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). +* `id` - (Optional) Identifier for the network interface. +* `filter` - (Optional) One or more name/value pairs to filter off of. There are several valid keys, for a full reference, check out [describe-network-interfaces](https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-network-interfaces.html) in the AWS CLI reference. ## Attribute Reference This data source exports the following attributes in addition to the arguments above: * `arn` - ARN of the network interface. -* `association` - Association information for an Elastic IP address (IPv4) associated with the network interface. See supported fields below. +* `association` - Association information for an Elastic IP address (IPv4) associated with the network interface. See [association](#association) below. +* `attachment` - Attachment of the ENI. See [attachment](#attachment) below. * `availabilityZone` - Availability Zone. * `description` - Description of the network interface. * `interfaceType` - Type of interface. @@ -73,10 +75,18 @@ This data source exports the following attributes in addition to the arguments a * `public_dns_name` - Public DNS name. * `publicIp` - Address of the Elastic IP address bound to the network interface. +### `attachment` + +* `attachmentId` - ID of the network interface attachment. +* `deviceIndex` - Device index of the network interface attachment on the instance. +* `instanceId` - ID of the instance. +* `instanceOwnerId` - AWS account ID of the owner of the instance. +* `networkCardIndex` - Index of the network card. + ## Timeouts [Configuration options](https://developer.hashicorp.com/terraform/language/resources/syntax#operation-timeouts): - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/network_interfaces.html.markdown b/website/docs/cdktf/typescript/d/network_interfaces.html.markdown index f2e299c08c4a..710f68318f54 100644 --- a/website/docs/cdktf/typescript/d/network_interfaces.html.markdown +++ b/website/docs/cdktf/typescript/d/network_interfaces.html.markdown @@ -101,6 +101,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `tags` - (Optional) Map of tags, each pair of which must exactly match a pair on the desired network interfaces. * `filter` - (Optional) Custom filter block as described below. @@ -126,4 +127,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/networkfirewall_firewall.html.markdown b/website/docs/cdktf/typescript/d/networkfirewall_firewall.html.markdown index 8bd2f0153b18..1fbe04ce7c81 100644 --- a/website/docs/cdktf/typescript/d/networkfirewall_firewall.html.markdown +++ b/website/docs/cdktf/typescript/d/networkfirewall_firewall.html.markdown @@ -85,6 +85,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `arn` - ARN of the firewall. * `name` - Descriptive name of the firewall. @@ -95,6 +96,9 @@ One or more of these arguments is required. This data source exports the following attributes in addition to the arguments above: * `arn` - ARN of the firewall. +* `availabilityZoneChangeProtection` - Indicates whether the firewall is protected against changes to its Availability Zone configuration. +* `availabilityZoneMapping` - Set of Availability Zones where the firewall endpoints are created for a transit gateway-attached firewall. + * `availabilityZoneId` - The ID of the Availability Zone where the firewall endpoint is located. * `deleteProtection` - A flag indicating whether the firewall is protected against deletion. * `description` - Description of the firewall. * `enabledAnalysisTypes` - Set of types for which to collect analysis metrics. @@ -107,6 +111,8 @@ This data source exports the following attributes in addition to the arguments a * `sync_states` - Set of subnets configured for use by the firewall. * `attachment` - Nested list describing the attachment status of the firewall's association with a single VPC subnet. * `endpointId` - The identifier of the firewall endpoint that AWS Network Firewall has instantiated in the subnet. You use this to identify the firewall endpoint in the VPC route tables, when you redirect the VPC traffic through the endpoint. + * `status` - The current status of the firewall endpoint instantiation in the subnet. + * `statusMessage` - It populates this with the reason for the error or failure and how to resolve it. A FAILED status indicates a non-recoverable state, and a ERROR status indicates an issue that you can fix. * `subnetId` - The unique identifier of the subnet that you've specified to be used for a firewall endpoint. * `availabilityZone` - The Availability Zone where the subnet is configured. * `capacity_usage_summary` - Aggregated count of all resources used by reference sets in a firewall. @@ -116,6 +122,10 @@ This data source exports the following attributes in addition to the arguments a * `resolved_cidr_count` - Total number of CIDR blocks used by the IP set references in a firewall. * `utilized_cidr_count` - Number of CIDR blocks used by the IP set references in a firewall. * `configuration_sync_state_summary` - Summary of sync states for all availability zones in which the firewall is configured. + * `transit_gateway_attachment_sync_states` - Set of transit gateway configured for use by the firewall. + * `attachmentId` - The unique identifier of the transit gateway attachment. + * `statusMessage` - A message providing additional information about the current status. + * `transit_gateway_attachment_status` - The current status of the transit gateway attachment. * `id` - ARN that identifies the firewall. * `name` - Descriptive name of the firewall. * `subnetChangeProtection` - A flag indicating whether the firewall is protected against changes to the subnet associations. @@ -123,6 +133,8 @@ This data source exports the following attributes in addition to the arguments a * `subnetId` - The unique identifier for the subnet. * `tags` - Map of resource tags to associate with the resource. If configured with a provider [`defaultTags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. * `updateToken` - String token used when updating a firewall. +* `transitGatewayId` - The unique identifier of the transit gateway associated with this firewall. +* `transitGatewayOwnerAccountId` - The AWS account ID that owns the transit gateway. * `vpcId` - Unique identifier of the VPC where AWS Network Firewall should create the firewall. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/networkfirewall_firewall_policy.html.markdown b/website/docs/cdktf/typescript/d/networkfirewall_firewall_policy.html.markdown index 4a50f0da34e8..5067b496f139 100644 --- a/website/docs/cdktf/typescript/d/networkfirewall_firewall_policy.html.markdown +++ b/website/docs/cdktf/typescript/d/networkfirewall_firewall_policy.html.markdown @@ -89,6 +89,7 @@ AWS Network Firewall does not allow multiple firewall policies with the same nam This data source supports the following arguments: +* `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). * `arn` - ARN of the firewall policy. * `name` - Descriptive name of the firewall policy. @@ -106,4 +107,4 @@ This data source exports the following attributes in addition to the arguments a [1]: https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/ram_resource_share [2]: https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/networkfirewall_firewall_policy - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/networkfirewall_resource_policy.html.markdown b/website/docs/cdktf/typescript/d/networkfirewall_resource_policy.html.markdown index be097d81d4af..88c5ef7eb99a 100644 --- a/website/docs/cdktf/typescript/d/networkfirewall_resource_policy.html.markdown +++ b/website/docs/cdktf/typescript/d/networkfirewall_resource_policy.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `resourceArn` - (Required) The Amazon Resource Name (ARN) that identifies the resource policy. ## Attribute Reference @@ -49,4 +50,4 @@ This data source exports the following attributes in addition to the arguments a [1]: https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/networkfirewall_resource_policy - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/networkmanager_connection.html.markdown b/website/docs/cdktf/typescript/d/networkmanager_connection.html.markdown index 4626888e65d0..9ff17841cfdc 100644 --- a/website/docs/cdktf/typescript/d/networkmanager_connection.html.markdown +++ b/website/docs/cdktf/typescript/d/networkmanager_connection.html.markdown @@ -3,14 +3,14 @@ subcategory: "Network Manager" layout: "aws" page_title: "AWS: aws_networkmanager_connection" description: |- - Retrieve information about a connection. + Provides details about an existing Network Manager connection. --- # Data Source: aws_networkmanager_connection -Retrieve information about a connection. +Provides details about an existing Network Manager connection. ## Example Usage @@ -54,4 +54,4 @@ This data source exports the following attributes in addition to the arguments a * `linkId` - ID of the link for the first device. * `tags` - Key-value tags for the connection. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/networkmanager_connections.html.markdown b/website/docs/cdktf/typescript/d/networkmanager_connections.html.markdown index 07f0fa7a750a..57ec6f23f9c3 100644 --- a/website/docs/cdktf/typescript/d/networkmanager_connections.html.markdown +++ b/website/docs/cdktf/typescript/d/networkmanager_connections.html.markdown @@ -3,14 +3,14 @@ subcategory: "Network Manager" layout: "aws" page_title: "AWS: aws_networkmanager_connections" description: |- - Retrieve information about connections. + Provides details about existing Network Manager connections. --- # Data Source: aws_networkmanager_connections -Retrieve information about connections. +Provides details about existing Network Manager connections. ## Example Usage @@ -51,4 +51,4 @@ This data source exports the following attributes in addition to the arguments a * `ids` - IDs of the connections. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/networkmanager_core_network_policy_document.html.markdown b/website/docs/cdktf/typescript/d/networkmanager_core_network_policy_document.html.markdown index 0f557d7e255f..0c6afdf6a325 100644 --- a/website/docs/cdktf/typescript/d/networkmanager_core_network_policy_document.html.markdown +++ b/website/docs/cdktf/typescript/d/networkmanager_core_network_policy_document.html.markdown @@ -3,7 +3,7 @@ subcategory: "Network Manager" layout: "aws" page_title: "AWS: aws_networkmanager_core_network_policy_document" description: |- - Generates an Core Network policy document in JSON format + Generates a Core Network policy document in JSON format --- @@ -236,6 +236,8 @@ The following arguments are available: * `insideCidrBlocks` (Optional) - The Classless Inter-Domain Routing (CIDR) block range used to create tunnels for AWS Transit Gateway Connect. The format is standard AWS CIDR range (for example, `10.0.1.0/24`). You can optionally define the inside CIDR in the Core Network Edges section per Region. The minimum is a `/24` for IPv4 or `/64` for IPv6. You can provide multiple `/24` subnets or a larger CIDR range. If you define a larger CIDR range, new Core Network Edges will be automatically assigned `/24` and `/64` subnets from the larger CIDR. an Inside CIDR block is required for attaching Connect attachments to a Core Network Edge. * `vpnEcmpSupport` (Optional) - Indicates whether the core network forwards traffic over multiple equal-cost routes using VPN. The value can be either `true` or `false`. The default is `true`. * `edgeLocations` (Required) - A block value of AWS Region locations where you're creating Core Network Edges. Detailed below. +* `dnsSupport` (Optional) - Indicates whether DNS resolution is enabled for the core network. The value can be either `true` or `false`. When set to `true`, DNS resolution is enabled for VPCs attached to the core network, allowing resources in different VPCs to resolve each other's domain names. The default is `true`. +* `securityGroupReferencingSupport` — (Optional) Indicates whether security group referencing is enabled for the core network. The value can be either `true` or `false`. When set to `true`, security groups in one VPC can reference security groups in another VPC attached to the core network, enabling more flexible security configurations across your network. The default is `false`. ### `edgeLocations` @@ -294,4 +296,4 @@ This data source exports the following attributes in addition to the arguments a * `json` - Standard JSON policy document rendered based on the arguments above. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/networkmanager_device.html.markdown b/website/docs/cdktf/typescript/d/networkmanager_device.html.markdown index d157faf584ff..cdb95dd4b80b 100644 --- a/website/docs/cdktf/typescript/d/networkmanager_device.html.markdown +++ b/website/docs/cdktf/typescript/d/networkmanager_device.html.markdown @@ -3,14 +3,14 @@ subcategory: "Network Manager" layout: "aws" page_title: "AWS: aws_networkmanager_device" description: |- - Retrieve information about a device. + Provides details about an existing Network Manager device. --- # Data Source: aws_networkmanager_device -Retrieve information about a device. +Provides details about an existing Network Manager device. ## Example Usage @@ -23,16 +23,12 @@ import { TerraformStack } from "cdktf"; * See https://cdk.tf/provider-generation for more details. */ import { DataAwsNetworkmanagerDevice } from "./.gen/providers/aws/data-aws-networkmanager-device"; -interface MyConfig { - globalNetworkId: any; -} class MyConvertedCode extends TerraformStack { - constructor(scope: Construct, name: string, config: MyConfig) { + constructor(scope: Construct, name: string) { super(scope, name); new DataAwsNetworkmanagerDevice(this, "example", { deviceId: deviceId.stringValue, - global_network_id_id: globalNetworkId.value, - globalNetworkId: config.globalNetworkId, + globalNetworkId: globalNetworkId.stringValue, }); } } @@ -72,4 +68,4 @@ The `location` object supports the following: * `latitude` - Latitude. * `longitude` - Longitude. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/networkmanager_devices.html.markdown b/website/docs/cdktf/typescript/d/networkmanager_devices.html.markdown index 0010398db32d..8ce2c5cf6595 100644 --- a/website/docs/cdktf/typescript/d/networkmanager_devices.html.markdown +++ b/website/docs/cdktf/typescript/d/networkmanager_devices.html.markdown @@ -3,14 +3,14 @@ subcategory: "Network Manager" layout: "aws" page_title: "AWS: aws_networkmanager_devices" description: |- - Retrieve information about devices. + Provides details about existing Network Manager devices. --- # Data Source: aws_networkmanager_devices -Retrieve information about devices. +Provides details about existing Network Manager devices. ## Example Usage @@ -51,4 +51,4 @@ This data source exports the following attributes in addition to the arguments a * `ids` - IDs of the devices. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/networkmanager_global_network.html.markdown b/website/docs/cdktf/typescript/d/networkmanager_global_network.html.markdown index d081abab2120..77dfb9e26d59 100644 --- a/website/docs/cdktf/typescript/d/networkmanager_global_network.html.markdown +++ b/website/docs/cdktf/typescript/d/networkmanager_global_network.html.markdown @@ -3,14 +3,14 @@ subcategory: "Network Manager" layout: "aws" page_title: "AWS: aws_networkmanager_global_network" description: |- - Retrieve information about a global network. + Provides details about an existing Network Manager global network. --- # Data Source: aws_networkmanager_global_network -Retrieve information about a global network. +Provides details about an existing Network Manager global network. ## Example Usage @@ -48,4 +48,4 @@ This data source exports the following attributes in addition to the arguments a * `description` - Description of the global network. * `tags` - Map of resource tags. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/networkmanager_global_networks.html.markdown b/website/docs/cdktf/typescript/d/networkmanager_global_networks.html.markdown index 2e3f65d7c131..639bae9c87ef 100644 --- a/website/docs/cdktf/typescript/d/networkmanager_global_networks.html.markdown +++ b/website/docs/cdktf/typescript/d/networkmanager_global_networks.html.markdown @@ -3,14 +3,14 @@ subcategory: "Network Manager" layout: "aws" page_title: "AWS: aws_networkmanager_global_networks" description: |- - Retrieve information about global networks. + Provides details about existing Network Manager global networks. --- # Data Source: aws_networkmanager_global_networks -Retrieve information about global networks. +Provides details about existing Network Manager global networks. ## Example Usage @@ -48,4 +48,4 @@ This data source exports the following attributes in addition to the arguments a * `ids` - IDs of the global networks. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/networkmanager_link.html.markdown b/website/docs/cdktf/typescript/d/networkmanager_link.html.markdown index b010d3c5e2bc..8ab16e354670 100644 --- a/website/docs/cdktf/typescript/d/networkmanager_link.html.markdown +++ b/website/docs/cdktf/typescript/d/networkmanager_link.html.markdown @@ -3,14 +3,14 @@ subcategory: "Network Manager" layout: "aws" page_title: "AWS: aws_networkmanager_link" description: |- - Retrieve information about a link. + Provides details about an existing Network Manager link. --- # Data Source: aws_networkmanager_link -Retrieve information about a link. +Provides details about an existing Network Manager link. ## Example Usage @@ -59,4 +59,4 @@ The `bandwidth` object supports the following: * `downloadSpeed` - Download speed in Mbps. * `uploadSpeed` - Upload speed in Mbps. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/networkmanager_links.html.markdown b/website/docs/cdktf/typescript/d/networkmanager_links.html.markdown index 48ff5bca3852..b4c3e02cfcaa 100644 --- a/website/docs/cdktf/typescript/d/networkmanager_links.html.markdown +++ b/website/docs/cdktf/typescript/d/networkmanager_links.html.markdown @@ -3,14 +3,14 @@ subcategory: "Network Manager" layout: "aws" page_title: "AWS: aws_networkmanager_links" description: |- - Retrieve information about links. + Provides details about existing Network Manager links. --- # Data Source: aws_networkmanager_links -Retrieve information about link. +Provides details about existing Network Manager links. ## Example Usage @@ -53,4 +53,4 @@ This data source exports the following attributes in addition to the arguments a * `ids` - IDs of the links. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/networkmanager_site.html.markdown b/website/docs/cdktf/typescript/d/networkmanager_site.html.markdown index 2f27dc3e4ad7..1121eb55f0aa 100644 --- a/website/docs/cdktf/typescript/d/networkmanager_site.html.markdown +++ b/website/docs/cdktf/typescript/d/networkmanager_site.html.markdown @@ -3,14 +3,14 @@ subcategory: "Network Manager" layout: "aws" page_title: "AWS: aws_networkmanager_site" description: |- - Retrieve information about a site. + Provides details about an existing Network Manager site. --- # Data Source: aws_networkmanager_site -Retrieve information about a site. +Provides details about an existing Network Manager site. ## Example Usage @@ -57,4 +57,4 @@ The `location` object supports the following: * `latitude` - Latitude of the location. * `longitude` - Longitude of the location. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/networkmanager_sites.html.markdown b/website/docs/cdktf/typescript/d/networkmanager_sites.html.markdown index 61d2cfe82e86..77a8d666c560 100644 --- a/website/docs/cdktf/typescript/d/networkmanager_sites.html.markdown +++ b/website/docs/cdktf/typescript/d/networkmanager_sites.html.markdown @@ -3,14 +3,14 @@ subcategory: "Network Manager" layout: "aws" page_title: "AWS: aws_networkmanager_sites" description: |- - Retrieve information about sites. + Provides details about existing Network Manager sites. --- # Data Source: aws_networkmanager_sites -Retrieve information about sites. +Provides details about existing Network Manager sites. ## Example Usage @@ -50,4 +50,4 @@ This data source exports the following attributes in addition to the arguments a * `ids` - IDs of the sites. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/oam_link.html.markdown b/website/docs/cdktf/typescript/d/oam_link.html.markdown index 9862f688d8b1..a51011a8ab31 100644 --- a/website/docs/cdktf/typescript/d/oam_link.html.markdown +++ b/website/docs/cdktf/typescript/d/oam_link.html.markdown @@ -39,8 +39,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `linkIdentifier` - (Required) ARN of the link. ## Attribute Reference @@ -75,4 +76,4 @@ The `metricConfiguration` configuration block supports the following arguments: * `filter` - Filter string that specifies which metrics are to be shared with the monitoring account. See [MetricConfiguration](https://docs.aws.amazon.com/OAM/latest/APIReference/API_MetricConfiguration.html) for details. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/oam_links.html.markdown b/website/docs/cdktf/typescript/d/oam_links.html.markdown index e457d4975e05..85f97167543d 100644 --- a/website/docs/cdktf/typescript/d/oam_links.html.markdown +++ b/website/docs/cdktf/typescript/d/oam_links.html.markdown @@ -36,7 +36,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -This data source does not support any arguments. +This data source supports the following arguments: + +* `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). ## Attribute Reference @@ -44,4 +46,4 @@ This data source exports the following attributes in addition to the arguments a * `arns` - Set of ARN of the Links. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/oam_sink.html.markdown b/website/docs/cdktf/typescript/d/oam_sink.html.markdown index fee859c980c0..3987c586892a 100644 --- a/website/docs/cdktf/typescript/d/oam_sink.html.markdown +++ b/website/docs/cdktf/typescript/d/oam_sink.html.markdown @@ -39,8 +39,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `sinkIdentifier` - (Required) ARN of the sink. ## Attribute Reference @@ -53,4 +54,4 @@ This data source exports the following attributes in addition to the arguments a * `sinkId` - Random ID string that AWS generated as part of the sink ARN. * `tags` - Tags assigned to the sink. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/oam_sinks.html.markdown b/website/docs/cdktf/typescript/d/oam_sinks.html.markdown index dae1238d4330..ea29d7347728 100644 --- a/website/docs/cdktf/typescript/d/oam_sinks.html.markdown +++ b/website/docs/cdktf/typescript/d/oam_sinks.html.markdown @@ -36,7 +36,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -This data source does not support any arguments. +This data source supports the following arguments: + +* `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). ## Attribute Reference @@ -44,4 +46,4 @@ This data source exports the following attributes in addition to the arguments a * `arns` - Set of ARN of the Sinks. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/opensearch_domain.html.markdown b/website/docs/cdktf/typescript/d/opensearch_domain.html.markdown index 0f41ffe6ffcb..b6fcb84c9001 100644 --- a/website/docs/cdktf/typescript/d/opensearch_domain.html.markdown +++ b/website/docs/cdktf/typescript/d/opensearch_domain.html.markdown @@ -38,18 +38,19 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: -* `domainName` – (Required) Name of the domain. +* `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). +* `domainName` - (Required) Name of the domain. ## Attribute Reference This data source exports the following attributes in addition to the arguments above: -* `accessPolicies` – Policy document attached to the domain. +* `accessPolicies` - Policy document attached to the domain. * `advancedOptions` - Key-value string pairs to specify advanced configuration options. * `advancedSecurityOptions` - Status of the OpenSearch domain's advanced security options. The block consists of the following attributes: * `enabled` - Whether advanced security is enabled. * `internalUserDatabaseEnabled` - Whether the internal user database is enabled. -* `arn` – ARN of the domain. +* `arn` - ARN of the domain. * `autoTuneOptions` - Configuration of the Auto-Tune options of the domain. * `desiredState` - Auto-Tune desired state for the domain. * `maintenanceSchedule` - A list of the nested configurations for the Auto-Tune maintenance windows of the domain. @@ -86,26 +87,25 @@ This data source exports the following attributes in addition to the arguments a * `userPoolId` - Cognito User pool used by the domain. * `identityPoolId` - Cognito Identity pool used by the domain. * `roleArn` - IAM Role with the AmazonOpenSearchServiceCognitoAccess policy attached. -* `created` – Status of the creation of the domain. +* `created` - Status of the creation of the domain. * `dashboardEndpoint` - Domain-specific endpoint used to access the [Dashboard application](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/dashboards.html). * `dashboardEndpointV2` - V2 domain-specific endpoint used to access the [Dashboard application](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/dashboards.html) -* `deleted` – Status of the deletion of the domain. +* `deleted` - Status of the deletion of the domain. * `domainEndpointV2HostedZoneId` - Dual stack hosted zone ID for the domain. -* `domainId` – Unique identifier for the domain. +* `domainId` - Unique identifier for the domain. * `ebsOptions` - EBS Options for the instances in the domain. * `ebsEnabled` - Whether EBS volumes are attached to data nodes in the domain. * `throughput` - The throughput (in MiB/s) of the EBS volumes attached to data nodes. * `volumeType` - Type of EBS volumes attached to data nodes. * `volumeSize` - Size of EBS volumes attached to data nodes (in GB). * `iops` - Baseline input/output (I/O) performance of EBS volumes attached to data nodes. -* `engineVersion` – OpenSearch version for the domain. +* `engineVersion` - OpenSearch version for the domain. * `encryptionAtRest` - Domain encryption at rest related options. * `enabled` - Whether encryption at rest is enabled in the domain. * `kmsKeyId` - KMS key id used to encrypt data at rest. -* `endpoint` – Domain-specific endpoint used to submit index, search, and data upload requests. +* `endpoint` - Domain-specific endpoint used to submit index, search, and data upload requests. * `endpointV2` - V2 domain-specific endpoint that works with both IPv4 and IPv6 addresses, used to submit index, search, and data upload requests. * `ipAddressType` - Type of IP addresses supported by the endpoint for the domain. -* `kibanaEndpoint` - (**Deprecated**) Domain-specific endpoint for kibana without https scheme. Use the `dashboardEndpoint` attribute instead. * `logPublishingOptions` - Domain log publishing related options. * `logType` - Type of OpenSearch log being published. * `cloudwatchLogGroupArn` - CloudWatch Log Group where the logs are published. @@ -118,7 +118,7 @@ This data source exports the following attributes in addition to the arguments a * `windowStartTime` - 10h window for updates * `hours` - Starting hour of the 10-hour window for updates * `minutes` - Starting minute of the 10-hour window for updates -* `processing` – Status of a configuration change in the domain. +* `processing` - Status of a configuration change in the domain. * `snapshotOptions` – Domain snapshot related options. * `automatedSnapshotStartHour` - Hour during which the service takes an automated daily snapshot of the indices in the domain. * `softwareUpdateOptions` - Software update options for the domain @@ -130,4 +130,4 @@ This data source exports the following attributes in addition to the arguments a * `subnetIds` - Subnets used by the domain. * `vpcId` - VPC used by the domain. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/opensearchserverless_access_policy.html.markdown b/website/docs/cdktf/typescript/d/opensearchserverless_access_policy.html.markdown index e6698520a81c..7a4404e080a3 100644 --- a/website/docs/cdktf/typescript/d/opensearchserverless_access_policy.html.markdown +++ b/website/docs/cdktf/typescript/d/opensearchserverless_access_policy.html.markdown @@ -39,8 +39,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `name` - (Required) Name of the policy. * `type` - (Required) Type of access policy. Must be `data`. @@ -52,4 +53,4 @@ This data source exports the following attributes in addition to the arguments a * `policy` - JSON policy document to use as the content for the new policy. * `policyVersion` - Version of the policy. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/opensearchserverless_collection.html.markdown b/website/docs/cdktf/typescript/d/opensearchserverless_collection.html.markdown index 84940dec6776..3c3d1dedd542 100644 --- a/website/docs/cdktf/typescript/d/opensearchserverless_collection.html.markdown +++ b/website/docs/cdktf/typescript/d/opensearchserverless_collection.html.markdown @@ -40,11 +40,12 @@ class MyConvertedCode extends TerraformStack { The following arguments are optional: -~> Exactly one of `id` or `name` is required. - +* `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). * `id` - (Optional) ID of the collection. * `name` - (Optional) Name of the collection. +~> Exactly one of `id` or `name` is required. + ## Attribute Reference This data source exports the following attributes in addition to the arguments above: @@ -62,4 +63,4 @@ This data source exports the following attributes in addition to the arguments a * `tags` - A map of tags to assign to the collection. * `type` - Type of collection. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/opensearchserverless_lifecycle_policy.html.markdown b/website/docs/cdktf/typescript/d/opensearchserverless_lifecycle_policy.html.markdown index 471169c17f3a..c715ad743d2b 100644 --- a/website/docs/cdktf/typescript/d/opensearchserverless_lifecycle_policy.html.markdown +++ b/website/docs/cdktf/typescript/d/opensearchserverless_lifecycle_policy.html.markdown @@ -39,8 +39,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `name` - (Required) Name of the policy * `type` - (Required) Type of lifecycle policy. Must be `retention`. @@ -54,4 +55,4 @@ This data source exports the following attributes in addition to the arguments a * `policy` - JSON policy document to use as the content for the new policy. * `policyVersion` - Version of the policy. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/opensearchserverless_security_config.html.markdown b/website/docs/cdktf/typescript/d/opensearchserverless_security_config.html.markdown index e600b93b85e2..7aec09afa82e 100644 --- a/website/docs/cdktf/typescript/d/opensearchserverless_security_config.html.markdown +++ b/website/docs/cdktf/typescript/d/opensearchserverless_security_config.html.markdown @@ -38,8 +38,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `id` - (Required) The unique identifier of the security configuration. ## Attribute Reference @@ -62,4 +63,4 @@ SAML options for the security configuration. * `sessionTimeout` - Session timeout, in minutes. Minimum is 5 minutes and maximum is 720 minutes (12 hours). Default is 60 minutes. * `userAttribute` - User attribute for this SAML integration. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/opensearchserverless_security_policy.html.markdown b/website/docs/cdktf/typescript/d/opensearchserverless_security_policy.html.markdown index 4679fdcea2d0..c5b16acfc939 100644 --- a/website/docs/cdktf/typescript/d/opensearchserverless_security_policy.html.markdown +++ b/website/docs/cdktf/typescript/d/opensearchserverless_security_policy.html.markdown @@ -39,6 +39,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `name` - (Required) Name of the policy * `type` - (Required) Type of security policy. One of `encryption` or `network`. @@ -52,4 +53,4 @@ This data source exports the following attributes in addition to the arguments a * `policy` - The JSON policy document without any whitespaces. * `policyVersion` - Version of the policy. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/opensearchserverless_vpc_endpoint.html.markdown b/website/docs/cdktf/typescript/d/opensearchserverless_vpc_endpoint.html.markdown index 3b5b6a51454f..3f1496e15a05 100644 --- a/website/docs/cdktf/typescript/d/opensearchserverless_vpc_endpoint.html.markdown +++ b/website/docs/cdktf/typescript/d/opensearchserverless_vpc_endpoint.html.markdown @@ -36,8 +36,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `vpcEndpointId` - (Required) The unique identifier of the endpoint. ## Attribute Reference @@ -50,4 +51,4 @@ This data source exports the following attributes in addition to the arguments a * `subnetIds` - The IDs of the subnets from which you access OpenSearch Serverless. * `vpcId` - The ID of the VPC from which you access OpenSearch Serverless. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/organizations_resource_tags.html.markdown b/website/docs/cdktf/typescript/d/organizations_resource_tags.html.markdown index 7f45d48bb128..825cb418a288 100644 --- a/website/docs/cdktf/typescript/d/organizations_resource_tags.html.markdown +++ b/website/docs/cdktf/typescript/d/organizations_resource_tags.html.markdown @@ -44,10 +44,10 @@ This data source supports the following arguments: You can specify any of the following taggable resources. -* AWS account – specify the account ID number. -* Organizational unit – specify the OU ID that begins with `ou-` and looks similar to: `ou-1a2b-34uvwxyz` -* Root – specify the root ID that begins with `r-` and looks similar to: `r-1a2b` -* Policy – specify the policy ID that begins with `p-` and looks similar to: `p-12abcdefg3` +* AWS account - specify the account ID number. +* Organizational unit - specify the OU ID that begins with `ou-` and looks similar to: `ou-1a2b-34uvwxyz` +* Root - specify the root ID that begins with `r-` and looks similar to: `r-1a2b` +* Policy - specify the policy ID that begins with `p-` and looks similar to: `p-12abcdefg3` ## Attribute Reference @@ -55,4 +55,4 @@ This data source exports the following attributes in addition to the arguments a * `tags` - Map of key=value pairs for each tag set on the resource. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/outposts_asset.html.markdown b/website/docs/cdktf/typescript/d/outposts_asset.html.markdown index cfd9f8e6fa61..b59e98718bae 100644 --- a/website/docs/cdktf/typescript/d/outposts_asset.html.markdown +++ b/website/docs/cdktf/typescript/d/outposts_asset.html.markdown @@ -57,8 +57,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `arn` - (Required) Outpost ARN. * `assetId` - (Required) ID of the asset. @@ -71,4 +72,4 @@ This data source exports the following attributes in addition to the arguments a * `rackElevation` - Position of an asset in a rack measured in rack units. * `rackId` - Rack ID of the asset. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/outposts_assets.html.markdown b/website/docs/cdktf/typescript/d/outposts_assets.html.markdown index 1ba8782eeb1f..8410abc56c63 100644 --- a/website/docs/cdktf/typescript/d/outposts_assets.html.markdown +++ b/website/docs/cdktf/typescript/d/outposts_assets.html.markdown @@ -86,6 +86,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `arn` - (Required) Outpost ARN. * `hostIdFilter` - (Optional) Filters by list of Host IDs of a Dedicated Host. * `statusIdFilter` - (Optional) Filters by list of state status. Valid values: "ACTIVE", "RETIRING". @@ -96,4 +97,4 @@ This data source exports the following attributes in addition to the arguments a * `assetIds` - List of all the asset ids found. This data source will fail if none are found. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/outposts_outpost.html.markdown b/website/docs/cdktf/typescript/d/outposts_outpost.html.markdown index 8b69cb01e6ea..1f4e66d2f2fb 100644 --- a/website/docs/cdktf/typescript/d/outposts_outpost.html.markdown +++ b/website/docs/cdktf/typescript/d/outposts_outpost.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `id` - (Optional) Identifier of the Outpost. * `name` - (Optional) Name of the Outpost. * `arn` - (Optional) ARN. @@ -56,4 +57,4 @@ This data source exports the following attributes in addition to the arguments a * `supportedHardwareType` - The hardware type. * `tags` - The Outpost tags. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/outposts_outpost_instance_type.html.markdown b/website/docs/cdktf/typescript/d/outposts_outpost_instance_type.html.markdown index fd7c40570364..df5b3f075cef 100644 --- a/website/docs/cdktf/typescript/d/outposts_outpost_instance_type.html.markdown +++ b/website/docs/cdktf/typescript/d/outposts_outpost_instance_type.html.markdown @@ -49,6 +49,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `instanceType` - (Optional) Desired instance type. Conflicts with `preferredInstanceTypes`. * `preferredInstanceTypes` - (Optional) Ordered list of preferred instance types. The first match in this list will be returned. If no preferred matches are found and the original search returned more than one result, an error is returned. Conflicts with `instanceType`. @@ -58,4 +59,4 @@ This data source exports the following attributes in addition to the arguments a * `id` - Outpost identifier. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/outposts_outpost_instance_types.html.markdown b/website/docs/cdktf/typescript/d/outposts_outpost_instance_types.html.markdown index 365d99b542a3..bd45cff50e76 100644 --- a/website/docs/cdktf/typescript/d/outposts_outpost_instance_types.html.markdown +++ b/website/docs/cdktf/typescript/d/outposts_outpost_instance_types.html.markdown @@ -36,8 +36,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `arn` - (Required) Outpost ARN. ## Attribute Reference @@ -46,4 +47,4 @@ This data source exports the following attributes in addition to the arguments a * `instanceTypes` - Set of instance types. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/outposts_outposts.html.markdown b/website/docs/cdktf/typescript/d/outposts_outposts.html.markdown index e50517cf4261..2f9509338da5 100644 --- a/website/docs/cdktf/typescript/d/outposts_outposts.html.markdown +++ b/website/docs/cdktf/typescript/d/outposts_outposts.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `availabilityZone` - (Optional) Availability Zone name. * `availabilityZoneId` - (Optional) Availability Zone identifier. * `siteId` - (Optional) Site identifier. @@ -51,4 +52,4 @@ This data source exports the following attributes in addition to the arguments a * `id` - AWS Region. * `ids` - Set of identifiers. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/outposts_site.html.markdown b/website/docs/cdktf/typescript/d/outposts_site.html.markdown index ec285f011d32..ad020f0f955b 100644 --- a/website/docs/cdktf/typescript/d/outposts_site.html.markdown +++ b/website/docs/cdktf/typescript/d/outposts_site.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `id` - (Optional) Identifier of the Site. * `name` - (Optional) Name of the Site. @@ -48,4 +49,4 @@ This data source exports the following attributes in addition to the arguments a * `accountId` - AWS Account identifier. * `description` - Description. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/outposts_sites.html.markdown b/website/docs/cdktf/typescript/d/outposts_sites.html.markdown index 3adb72ae6d08..3a2cd667644a 100644 --- a/website/docs/cdktf/typescript/d/outposts_sites.html.markdown +++ b/website/docs/cdktf/typescript/d/outposts_sites.html.markdown @@ -34,7 +34,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -This data source does not support any arguments. +This data source supports the following arguments: + +* `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). ## Attribute Reference @@ -43,4 +45,4 @@ This data source exports the following attributes in addition to the arguments a * `id` - AWS Region. * `ids` - Set of Outposts Site identifiers. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/polly_voices.html.markdown b/website/docs/cdktf/typescript/d/polly_voices.html.markdown index 02bf2fb3361b..ab0f7ccc6ef3 100644 --- a/website/docs/cdktf/typescript/d/polly_voices.html.markdown +++ b/website/docs/cdktf/typescript/d/polly_voices.html.markdown @@ -60,6 +60,7 @@ class MyConvertedCode extends TerraformStack { The following arguments are optional: +* `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). * `engine` - (Optional) Engine used by Amazon Polly when processing input text for speech synthesis. Valid values are `standard`, `neural`, and `long-form`. * `includeAdditionalLanguageCodes` - (Optional) Whether to return any bilingual voices that use the specified language as an additional language. * `languageCode` - (Optional) Language identification tag for filtering the list of voices returned. If not specified, all available voices are returned. @@ -83,4 +84,4 @@ See the [AWS Polly Voice documentation](https://docs.aws.amazon.com/polly/latest * `name` - Name of the voice. * `supportedEngines` - Specifies which engines are supported by a given voice. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/prefix_list.html.markdown b/website/docs/cdktf/typescript/d/prefix_list.html.markdown index 04d0fb540e27..b8c2ffffd8fb 100644 --- a/website/docs/cdktf/typescript/d/prefix_list.html.markdown +++ b/website/docs/cdktf/typescript/d/prefix_list.html.markdown @@ -107,6 +107,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `prefixListId` - (Optional) ID of the prefix list to select. * `name` - (Optional) Name of the prefix list to select. * `filter` - (Optional) Configuration block(s) for filtering. Detailed below. @@ -136,4 +137,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/prometheus_default_scraper_configuration.html.markdown b/website/docs/cdktf/typescript/d/prometheus_default_scraper_configuration.html.markdown index 9c742b377911..c104c71b27ff 100644 --- a/website/docs/cdktf/typescript/d/prometheus_default_scraper_configuration.html.markdown +++ b/website/docs/cdktf/typescript/d/prometheus_default_scraper_configuration.html.markdown @@ -35,7 +35,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -This data source does not support any arguments. +This data source supports the following arguments: + +* `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). ## Attribute Reference @@ -43,4 +45,4 @@ This data source exports the following attributes in addition to the arguments a * `configuration` - The configuration file. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/prometheus_workspace.html.markdown b/website/docs/cdktf/typescript/d/prometheus_workspace.html.markdown index 54bdf45b0879..831a51ffbf63 100644 --- a/website/docs/cdktf/typescript/d/prometheus_workspace.html.markdown +++ b/website/docs/cdktf/typescript/d/prometheus_workspace.html.markdown @@ -38,8 +38,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `workspaceId` - (Required) Prometheus workspace ID. ## Attribute Reference @@ -54,4 +55,4 @@ This data source exports the following attributes in addition to the arguments a * `status` - Status of the Prometheus workspace. * `tags` - Tags assigned to the resource. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/prometheus_workspaces.html.markdown b/website/docs/cdktf/typescript/d/prometheus_workspaces.html.markdown index 911fae473c51..738496c14f3f 100644 --- a/website/docs/cdktf/typescript/d/prometheus_workspaces.html.markdown +++ b/website/docs/cdktf/typescript/d/prometheus_workspaces.html.markdown @@ -61,6 +61,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `aliasPrefix` - (Optional) Limits results to workspaces with aliases that begin with this value. ## Attribute Reference @@ -71,4 +72,4 @@ This data source exports the following attributes in addition to the arguments a * `arns` - List of ARNs of the matched Prometheus workspaces. * `workspaceIds` - List of workspace IDs of the matched Prometheus workspaces. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/qldb_ledger.html.markdown b/website/docs/cdktf/typescript/d/qldb_ledger.html.markdown index 88e7bc9ba91c..e0ed3064b093 100644 --- a/website/docs/cdktf/typescript/d/qldb_ledger.html.markdown +++ b/website/docs/cdktf/typescript/d/qldb_ledger.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `name` - (Required) Friendly name of the ledger to match. ## Attribute Reference @@ -47,4 +48,4 @@ This data source exports the following attributes in addition to the arguments a See the [QLDB Ledger Resource](/docs/providers/aws/r/qldb_ledger.html) for details on the returned attributes - they are identical. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/quicksight_analysis.html.markdown b/website/docs/cdktf/typescript/d/quicksight_analysis.html.markdown index 2215024030c3..9ad535a35a9b 100644 --- a/website/docs/cdktf/typescript/d/quicksight_analysis.html.markdown +++ b/website/docs/cdktf/typescript/d/quicksight_analysis.html.markdown @@ -41,7 +41,8 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: * `analysisId` - (Required) Identifier for the analysis. -* `awsAccountId` - (Optional) AWS account ID. +* `awsAccountId` - (Optional) AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider. +* `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). ## Attribute Reference @@ -50,4 +51,4 @@ This data source exports the following attributes in addition to the arguments a See the [Analysis Resource](/docs/providers/aws/r/quicksight_analysis.html) for details on the returned attributes - they are identical. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/quicksight_data_set.html.markdown b/website/docs/cdktf/typescript/d/quicksight_data_set.html.markdown index 04b62150b855..9d747dfff658 100644 --- a/website/docs/cdktf/typescript/d/quicksight_data_set.html.markdown +++ b/website/docs/cdktf/typescript/d/quicksight_data_set.html.markdown @@ -40,8 +40,9 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `awsAccountId` - (Optional) AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider. * `dataSetId` - (Required) Identifier for the data set. -* `awsAccountId` - (Optional) AWS account ID. +* `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). ## Attribute Reference @@ -50,4 +51,4 @@ This data source exports the following attributes in addition to the arguments a See the [Data Set Resource](/docs/providers/aws/r/quicksight_data_set.html) for details on the returned attributes - they are identical. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/quicksight_group.html.markdown b/website/docs/cdktf/typescript/d/quicksight_group.html.markdown index 5a2e0c3612c6..0b1ec60aa7d6 100644 --- a/website/docs/cdktf/typescript/d/quicksight_group.html.markdown +++ b/website/docs/cdktf/typescript/d/quicksight_group.html.markdown @@ -46,8 +46,9 @@ The following arguments are required: The following arguments are optional: -* `awsAccountId` - (Optional) AWS account ID. +* `awsAccountId` - (Optional) AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider. * `namespace` - (Optional) QuickSight namespace. Defaults to `default`. +* `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). ## Attribute Reference @@ -57,4 +58,4 @@ This data source exports the following attributes in addition to the arguments a * `description` - The group description. * `principalId` - The principal ID of the group. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/quicksight_theme.html.markdown b/website/docs/cdktf/typescript/d/quicksight_theme.html.markdown index a2a27be9fb00..ddb1d4f36688 100644 --- a/website/docs/cdktf/typescript/d/quicksight_theme.html.markdown +++ b/website/docs/cdktf/typescript/d/quicksight_theme.html.markdown @@ -44,7 +44,8 @@ The following arguments are required: The following arguments are optional: -* `awsAccountId` - AWS account ID. +* `awsAccountId` - AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider. +* `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). ## Attribute Reference @@ -134,4 +135,4 @@ This data source exports the following attributes in addition to the arguments a * `warning` - Color (hexadecimal) that applies to warning and informational messages. * `warningForeground` - Color (hexadecimal) that applies to any text or other elements that appear over the warning color. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/quicksight_user.html.markdown b/website/docs/cdktf/typescript/d/quicksight_user.html.markdown index a11a4612ca13..e1339f352f15 100644 --- a/website/docs/cdktf/typescript/d/quicksight_user.html.markdown +++ b/website/docs/cdktf/typescript/d/quicksight_user.html.markdown @@ -46,8 +46,9 @@ The following arguments are required: The following arguments are optional: -* `awsAccountId` - (Optional) AWS account ID. +* `awsAccountId` - (Optional) AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider. * `namespace` - (Optional) QuickSight namespace. Defaults to `default`. +* `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). ## Attribute Reference @@ -55,6 +56,7 @@ This data source exports the following attributes in addition to the arguments a * `active` - The active status of user. When you create an Amazon QuickSight user that’s not an IAM user or an Active Directory user, that user is inactive until they sign in and provide a password. * `arn` - The Amazon Resource Name (ARN) for the user. +* `customPermissionsName` - The custom permissions profile associated with this user. * `email` - The user's email address. * `identityType` - The type of identity authentication used by the user. * `principalId` - The principal ID of the user. @@ -63,4 +65,4 @@ This data source exports the following attributes in addition to the arguments a - `AUTHOR`: A user who can create data sources, datasets, analyzes, and dashboards. - `ADMIN`: A user who is an author, who can also manage Amazon QuickSight settings. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/ram_resource_share.html.markdown b/website/docs/cdktf/typescript/d/ram_resource_share.html.markdown index 91bef7f5e8c5..654c92df3adc 100644 --- a/website/docs/cdktf/typescript/d/ram_resource_share.html.markdown +++ b/website/docs/cdktf/typescript/d/ram_resource_share.html.markdown @@ -67,10 +67,11 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `name` - (Optional) Name of the resource share to retrieve. * `resourceOwner` (Required) Owner of the resource share. Valid values are `SELF` or `OTHER-ACCOUNTS`. * `resourceShareStatus` (Optional) Specifies that you want to retrieve details of only those resource shares that have this status. Valid values are `PENDING`, `ACTIVE`, `FAILED`, `DELETING`, and `DELETED`. -* `filter` - (Optional) Filter used to scope the list e.g., by tags. See [related docs] (https://docs.aws.amazon.com/ram/latest/APIReference/API_TagFilter.html). +* `filter` - (Optional) Filter used to scope the list of owned shares e.g., by tags. See [related docs] (https://docs.aws.amazon.com/ram/latest/APIReference/API_TagFilter.html). * `name` - (Required) Name of the tag key to filter on. * `values` - (Required) Value of the tag key. @@ -85,4 +86,4 @@ This data source exports the following attributes in addition to the arguments a * `status` - Status of the resource share. * `tags` - Tags attached to the resource share. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/rds_certificate.html.markdown b/website/docs/cdktf/typescript/d/rds_certificate.html.markdown index b0a7cd810284..aa3003eff50a 100644 --- a/website/docs/cdktf/typescript/d/rds_certificate.html.markdown +++ b/website/docs/cdktf/typescript/d/rds_certificate.html.markdown @@ -38,8 +38,9 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `id` - (Optional) Certificate identifier. For example, `rds-ca-2019`. -* `default_for_new_launches` - (Optional) When enabled, returns the default certificate for new RDS instances. +* `defaultForNewLaunches` - (Optional) When enabled, returns the default certificate for new RDS instances. * `latestValidTill` - (Optional) When enabled, returns the certificate with the latest `ValidTill`. ## Attribute Reference @@ -54,4 +55,4 @@ This data source exports the following attributes in addition to the arguments a * `validFrom` - [RFC3339 format](https://tools.ietf.org/html/rfc3339#section-5.8) of certificate starting validity date. * `validTill` - [RFC3339 format](https://tools.ietf.org/html/rfc3339#section-5.8) of certificate ending validity date. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/rds_cluster.html.markdown b/website/docs/cdktf/typescript/d/rds_cluster.html.markdown index b75bb9368f60..c0e8f358b1bd 100644 --- a/website/docs/cdktf/typescript/d/rds_cluster.html.markdown +++ b/website/docs/cdktf/typescript/d/rds_cluster.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `clusterIdentifier` - (Required) Cluster identifier of the RDS cluster. ## Attribute Reference @@ -49,4 +50,4 @@ returned attributes - they are identical for all attributes, except the `tagsAll * `tags` - A map of tags assigned to the resource. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/rds_cluster_parameter_group.html.markdown b/website/docs/cdktf/typescript/d/rds_cluster_parameter_group.html.markdown index eb279846ebc3..1de260f8d71e 100644 --- a/website/docs/cdktf/typescript/d/rds_cluster_parameter_group.html.markdown +++ b/website/docs/cdktf/typescript/d/rds_cluster_parameter_group.html.markdown @@ -36,8 +36,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `name` - (Required) DB cluster parameter group name. ## Attribute Reference @@ -48,4 +49,4 @@ This data source exports the following attributes in addition to the arguments a * `family` - Family of the cluster parameter group. * `description` - Description of the cluster parameter group. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/rds_clusters.html.markdown b/website/docs/cdktf/typescript/d/rds_clusters.html.markdown index f276e6a00856..b717a29759f1 100644 --- a/website/docs/cdktf/typescript/d/rds_clusters.html.markdown +++ b/website/docs/cdktf/typescript/d/rds_clusters.html.markdown @@ -45,6 +45,7 @@ class MyConvertedCode extends TerraformStack { The following arguments are optional: +* `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). * `filter` - (Optional) Configuration block(s) for filtering. Detailed below. ### filter Configuration block @@ -61,4 +62,4 @@ This data source exports the following attributes in addition to the arguments a * `clusterArns` - Set of cluster ARNs of the matched RDS clusters. * `clusterIdentifiers` - Set of ARNs of cluster identifiers of the matched RDS clusters. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/rds_engine_version.html.markdown b/website/docs/cdktf/typescript/d/rds_engine_version.html.markdown index 99a1e76f8264..5500ca465ae4 100644 --- a/website/docs/cdktf/typescript/d/rds_engine_version.html.markdown +++ b/website/docs/cdktf/typescript/d/rds_engine_version.html.markdown @@ -75,6 +75,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `defaultOnly` - (Optional) Whether the engine version must be an AWS-defined default version. Some engines have multiple default versions, such as for each major version. Using `defaultOnly` may help avoid `multiple RDS engine versions` errors. See also `latest`. * `filter` - (Optional) One or more name/value pairs to use in filtering versions. There are several valid keys; for a full reference, check out [describe-db-engine-versions in the AWS CLI reference](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/describe-db-engine-versions.html). * `hasMajorTarget` - (Optional) Whether the engine version must have one or more major upgrade targets. Not including `hasMajorTarget` or setting it to `false` doesn't imply that there's no corresponding major upgrade target for the engine version. @@ -99,11 +100,11 @@ This data source exports the following attributes in addition to the arguments a * `supportedFeatureNames` - Set of features supported by the engine version. * `supportedModes` - Set of supported engine version modes. * `supportedTimezones` - Set of the time zones supported by the engine version. -* `supports_certificate_rotation_without_restart` - Whether the certificates can be rotated without restarting the Aurora instance. +* `supportsCertificateRotationWithoutRestart` - Whether the certificates can be rotated without restarting the Aurora instance. * `supportsGlobalDatabases` - Whether you can use Aurora global databases with the engine version. -* `supports_integrations` - Whether the engine version supports integrations with other AWS services. +* `supportsIntegrations` - Whether the engine version supports integrations with other AWS services. * `supportsLogExportsToCloudwatch` - Whether the engine version supports exporting the log types specified by `exportableLogTypes` to CloudWatch Logs. -* `supports_local_write_forwarding` - Whether the engine version supports local write forwarding or not. +* `supportsLocalWriteForwarding` - Whether the engine version supports local write forwarding or not. * `supportsLimitlessDatabase` - Whether the engine version supports Aurora Limitless Database. * `supportsParallelQuery` - Whether you can use Aurora parallel query with the engine version. * `supportsReadReplica` - Whether the engine version supports read replicas. @@ -113,4 +114,4 @@ This data source exports the following attributes in addition to the arguments a * `versionActual` - Complete engine version. * `versionDescription` - Description of the engine version. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/rds_orderable_db_instance.html.markdown b/website/docs/cdktf/typescript/d/rds_orderable_db_instance.html.markdown index eafd6fe07bc9..2a473c878ed1 100644 --- a/website/docs/cdktf/typescript/d/rds_orderable_db_instance.html.markdown +++ b/website/docs/cdktf/typescript/d/rds_orderable_db_instance.html.markdown @@ -67,6 +67,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `availabilityZoneGroup` - (Optional) Availability zone group. * `engineLatestVersion` - (Optional) When set to `true`, the data source attempts to return the most recent version matching the other criteria you provide. You must use `engineLatestVersion` with `preferredInstanceClasses` and/or `preferredEngineVersions`. Using `engineLatestVersion` will avoid `multiple RDS DB Instance Classes` errors. If you use `engineLatestVersion` with `preferredInstanceClasses`, the data source returns the latest version for the _first_ matching instance class (instance class priority). **Note:** The data source uses a best-effort approach at selecting the latest version but due to the complexity of version identifiers across engines, using `engineLatestVersion` may _not_ return the latest version in every situation. * `engineVersion` - (Optional) Version of the DB engine. If none is provided, the data source tries to use the AWS-defined default version that matches any other criteria. @@ -105,4 +106,4 @@ This data source exports the following attributes in addition to the arguments a * `multiAzCapable` - Whether a DB instance is Multi-AZ capable. * `outpostCapable` - Whether a DB instance supports RDS on Outposts. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/rds_reserved_instance_offering.html.markdown b/website/docs/cdktf/typescript/d/rds_reserved_instance_offering.html.markdown index 22ecfbe2db97..3b9265f4275c 100644 --- a/website/docs/cdktf/typescript/d/rds_reserved_instance_offering.html.markdown +++ b/website/docs/cdktf/typescript/d/rds_reserved_instance_offering.html.markdown @@ -42,11 +42,12 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `dbInstanceClass` - (Required) DB instance class for the reserved DB instance. * `duration` - (Required) Duration of the reservation in years or seconds. Valid values are `1`, `3`, `31536000`, `94608000` * `multiAz` - (Required) Whether the reservation applies to Multi-AZ deployments. * `offeringType` - (Required) Offering type of this reserved DB instance. Valid values are `No Upfront`, `Partial Upfront`, `All Upfront`. -* `productDescription` - (Required) Description of the reserved DB instance. +* `productDescription` - (Required) Description of the reserved DB instance. Example values are `postgresql`, `aurora-postgresql`, `mysql`, `aurora-mysql`, `mariadb`. ## Attribute Reference @@ -57,4 +58,4 @@ This data source exports the following attributes in addition to the arguments a * `fixedPrice` - Fixed price charged for this reserved DB instance. * `offeringId` - Unique identifier for the reservation. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/redshift_cluster.html.markdown b/website/docs/cdktf/typescript/d/redshift_cluster.html.markdown index 4832fe3a7865..970157af9c91 100644 --- a/website/docs/cdktf/typescript/d/redshift_cluster.html.markdown +++ b/website/docs/cdktf/typescript/d/redshift_cluster.html.markdown @@ -64,6 +64,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `clusterIdentifier` - (Required) Cluster identifier ## Attribute Reference @@ -116,4 +117,4 @@ Cluster nodes (for `clusterNodes`) support the following attributes: * `privateIpAddress` - Private IP address of a node within a cluster * `publicIpAddress` - Public IP address of a node within a cluster - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/redshift_cluster_credentials.html.markdown b/website/docs/cdktf/typescript/d/redshift_cluster_credentials.html.markdown index 7a86635b4ff1..2549a9531109 100644 --- a/website/docs/cdktf/typescript/d/redshift_cluster_credentials.html.markdown +++ b/website/docs/cdktf/typescript/d/redshift_cluster_credentials.html.markdown @@ -41,6 +41,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `autoCreate` - (Optional) Create a database user with the name specified for the user named in `dbUser` if one does not exist. * `clusterIdentifier` - (Required) Unique identifier of the cluster that contains the database for which your are requesting credentials. * `dbName` - (Optional) Name of a database that DbUser is authorized to log on to. If `dbName` is not specified, `dbUser` can log on to any existing database. @@ -55,4 +56,4 @@ This data source exports the following attributes in addition to the arguments a * `dbPassword` - Temporary password that authorizes the user name returned by `dbUser` to log on to the database `dbName`. * `expiration` - Date and time the password in `dbPassword` expires. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/redshift_data_shares.html.markdown b/website/docs/cdktf/typescript/d/redshift_data_shares.html.markdown index 5d4043fe33ca..8c6e41787c48 100644 --- a/website/docs/cdktf/typescript/d/redshift_data_shares.html.markdown +++ b/website/docs/cdktf/typescript/d/redshift_data_shares.html.markdown @@ -36,7 +36,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -This data source does not support any arguments. +This data source supports the following arguments: + +* `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). ## Attribute Reference @@ -51,4 +53,4 @@ This data source exports the following attributes in addition to the arguments a * `managedBy` - Identifier of a datashare to show its managing entity. * `producerArn` - ARN (Amazon Resource Name) of the producer. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/redshift_orderable_cluster.html.markdown b/website/docs/cdktf/typescript/d/redshift_orderable_cluster.html.markdown index 75d17f87c219..0669192ed20c 100644 --- a/website/docs/cdktf/typescript/d/redshift_orderable_cluster.html.markdown +++ b/website/docs/cdktf/typescript/d/redshift_orderable_cluster.html.markdown @@ -39,6 +39,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `clusterType` - (Optional) Reshift Cluster typeE.g., `multi-node` or `single-node` * `clusterVersion` - (Optional) Redshift Cluster versionE.g., `1.0` * `nodeType` - (Optional) Redshift Cluster node typeE.g., `dc2.8xlarge` @@ -50,4 +51,4 @@ This data source exports the following attributes in addition to the arguments a * `availabilityZones` - List of Availability Zone names where the Redshift Cluster is available. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/redshift_producer_data_shares.html.markdown b/website/docs/cdktf/typescript/d/redshift_producer_data_shares.html.markdown index 33b6fd97b1ec..d62d4d3d004a 100644 --- a/website/docs/cdktf/typescript/d/redshift_producer_data_shares.html.markdown +++ b/website/docs/cdktf/typescript/d/redshift_producer_data_shares.html.markdown @@ -44,6 +44,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `status` - (Optional) Status of a datashare in the producer. Valid values are `ACTIVE`, `AUTHORIZED`, `PENDING_AUTHORIZATION`, `DEAUTHORIZED`, and `REJECTED`. Omit this argument to return all statuses. ## Attribute Reference @@ -59,4 +60,4 @@ This data source exports the following attributes in addition to the arguments a * `managedBy` - Identifier of a datashare to show its managing entity. * `producerArn` - ARN (Amazon Resource Name) of the producer. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/redshift_subnet_group.html.markdown b/website/docs/cdktf/typescript/d/redshift_subnet_group.html.markdown index 66ad35a229e7..c9135a1bfba1 100644 --- a/website/docs/cdktf/typescript/d/redshift_subnet_group.html.markdown +++ b/website/docs/cdktf/typescript/d/redshift_subnet_group.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `name` - (Required) Name of the cluster subnet group for which information is requested. ## Attribute Reference @@ -50,4 +51,4 @@ This data source exports the following attributes in addition to the arguments a * `subnetIds` - An array of VPC subnet IDs. * `tags` - Tags associated to the Subnet Group - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/redshiftserverless_credentials.html.markdown b/website/docs/cdktf/typescript/d/redshiftserverless_credentials.html.markdown index 96342e92b1b3..09a86cdee0b4 100644 --- a/website/docs/cdktf/typescript/d/redshiftserverless_credentials.html.markdown +++ b/website/docs/cdktf/typescript/d/redshiftserverless_credentials.html.markdown @@ -40,6 +40,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `workgroupName` - (Required) The name of the workgroup associated with the database. * `dbName` - (Optional) The name of the database to get temporary authorization to log on to. * `durationSeconds` - (Optional) The number of seconds until the returned temporary password expires. The minimum is 900 seconds, and the maximum is 3600 seconds. @@ -52,4 +53,4 @@ This data source exports the following attributes in addition to the arguments a * `dbUser` - A database user name that is authorized to log on to the database `dbName` using the password `dbPassword` . If the specified `dbUser` exists in the database, the new user name has the same database privileges as the user named in `dbUser` . By default, the user is added to PUBLIC. the user doesn't exist in the database. * `expiration` - Date and time the password in `dbPassword` expires. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/redshiftserverless_namespace.html.markdown b/website/docs/cdktf/typescript/d/redshiftserverless_namespace.html.markdown index 5f9a97fdaf78..7a56665b434d 100644 --- a/website/docs/cdktf/typescript/d/redshiftserverless_namespace.html.markdown +++ b/website/docs/cdktf/typescript/d/redshiftserverless_namespace.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `namespaceName` - (Required) The name of the namespace. ## Attribute Reference @@ -53,4 +54,4 @@ This data source exports the following attributes in addition to the arguments a * `logExports` - The types of logs the namespace can export. Available export types are `userlog`, `connectionlog`, and `useractivitylog`. * `namespaceId` - The Redshift Namespace ID. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/redshiftserverless_workgroup.html.markdown b/website/docs/cdktf/typescript/d/redshiftserverless_workgroup.html.markdown index 439f9c3253b4..fb1857f1ed34 100644 --- a/website/docs/cdktf/typescript/d/redshiftserverless_workgroup.html.markdown +++ b/website/docs/cdktf/typescript/d/redshiftserverless_workgroup.html.markdown @@ -40,8 +40,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `workgroupName` - (Required) The name of the workgroup associated with the database. ## Attribute Reference @@ -55,7 +56,7 @@ This data source exports the following attributes in addition to the arguments a * `publiclyAccessible` - A value that specifies whether the workgroup can be accessed from a public network. * `securityGroupIds` - An array of security group IDs to associate with the workgroup. * `subnetIds` - An array of VPC subnet IDs to associate with the workgroup. When set, must contain at least three subnets spanning three Availability Zones. A minimum number of IP addresses is required and scales with the Base Capacity. For more information, see the following [AWS document](https://docs.aws.amazon.com/redshift/latest/mgmt/serverless-known-issues.html). -* `track_name` - The name of the track for the workgroup. +* `trackName` - The name of the track for the workgroup. * `workgroupId` - The Redshift Workgroup ID. ### Endpoint @@ -77,4 +78,4 @@ This data source exports the following attributes in addition to the arguments a * `privateIpAddress` - The IPv4 address of the network interface within the subnet. * `subnetId` - The unique identifier of the subnet. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/region.html.markdown b/website/docs/cdktf/typescript/d/region.html.markdown index ba6372c44c29..827b06006f01 100644 --- a/website/docs/cdktf/typescript/d/region.html.markdown +++ b/website/docs/cdktf/typescript/d/region.html.markdown @@ -3,24 +3,24 @@ subcategory: "Meta Data Sources" layout: "aws" page_title: "AWS: aws_region" description: |- - Provides details about a specific service region + Provides details about a specific AWS Region --- # Data Source: aws_region -`awsRegion` provides details about a specific AWS region. +`awsRegion` provides details about a specific AWS Region. -As well as validating a given region name this resource can be used to -discover the name of the region configured within the provider. The latter +As well as validating a given Region name this resource can be used to +discover the name of the Region configured within the provider. The latter can be useful in a child module which is inheriting an AWS provider configuration from its parent module. ## Example Usage The following example shows how the resource might be used to obtain -the name of the AWS region configured on the provider. +the name of the AWS Region configured on the provider. ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -44,8 +44,9 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: -* `name` - (Optional) Full name of the region to select. +* `region` - (Optional) Full name of the region to select (e.g. `us-east-1`), and the 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). * `endpoint` - (Optional) EC2 endpoint of the region to select. +* `name` - (Optional, **Deprecated**) Full name of the region to select. Use `region` instead. ## Attribute Reference @@ -53,4 +54,4 @@ This data source exports the following attributes in addition to the arguments a * `description` - Region's description in this format: "Location (Region name)". - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/resourceexplorer2_search.html.markdown b/website/docs/cdktf/typescript/d/resourceexplorer2_search.html.markdown index 514f3bcdef45..ee7cc6657718 100644 --- a/website/docs/cdktf/typescript/d/resourceexplorer2_search.html.markdown +++ b/website/docs/cdktf/typescript/d/resourceexplorer2_search.html.markdown @@ -44,6 +44,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `viewArn` - (Optional) Specifies the Amazon resource name (ARN) of the view to use for the query. If you don't specify a value for this parameter, then the operation automatically uses the default view for the AWS Region in which you called this operation. If the Region either doesn't have a default view or if you don't have permission to use the default view, then the operation fails with a `401 Unauthorized` exception. ## Attribute Reference @@ -75,4 +76,4 @@ This data source exports the following attributes in addition to the arguments a * `last_reported_at` - The date and time that the information about this resource property was last updated. * `name` - Name of this property of the resource. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/resourcegroupstaggingapi_resources.html.markdown b/website/docs/cdktf/typescript/d/resourcegroupstaggingapi_resources.html.markdown index 089ffc71535e..170a6a92488c 100644 --- a/website/docs/cdktf/typescript/d/resourcegroupstaggingapi_resources.html.markdown +++ b/website/docs/cdktf/typescript/d/resourcegroupstaggingapi_resources.html.markdown @@ -87,6 +87,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `excludeCompliantResources` - (Optional) Specifies whether to exclude resources that are compliant with the tag policy. You can use this parameter only if the `includeComplianceDetails` argument is also set to `true`. * `includeComplianceDetails` - (Optional) Specifies whether to include details regarding the compliance with the effective tag policy. * `tagFilter` - (Optional) Specifies a list of Tag Filters (keys and values) to restrict the output to only those resources that have the specified tag and, if included, the specified value. See [Tag Filter](#tag-filter) below. Conflicts with `resourceArnList`. @@ -115,4 +116,4 @@ This data source exports the following attributes in addition to the arguments a * `resourceArn` - ARN of the resource. * `tags` - Map of tags assigned to the resource. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/route.html.markdown b/website/docs/cdktf/typescript/d/route.html.markdown index 65d66737e2bf..e1c7212e91c0 100644 --- a/website/docs/cdktf/typescript/d/route.html.markdown +++ b/website/docs/cdktf/typescript/d/route.html.markdown @@ -54,6 +54,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `routeTableId` - (Required) ID of the specific Route Table containing the Route entry. * `carrierGatewayId` - (Optional) EC2 Carrier Gateway ID of the Route belonging to the Route Table. * `coreNetworkArn` - (Optional) Core network ARN of the Route belonging to the Route Table. @@ -81,4 +82,4 @@ This data source exports no additional attributes. - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/route53_resolver_endpoint.html.markdown b/website/docs/cdktf/typescript/d/route53_resolver_endpoint.html.markdown index bea51b59c538..04de2d49fdda 100644 --- a/website/docs/cdktf/typescript/d/route53_resolver_endpoint.html.markdown +++ b/website/docs/cdktf/typescript/d/route53_resolver_endpoint.html.markdown @@ -65,6 +65,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `resolverEndpointId` - (Optional) ID of the Route53 Resolver Endpoint. * `filter` - (Optional) One or more name/value pairs to use as filters. There are several valid keys, for a full reference, check out @@ -84,4 +85,4 @@ This data source exports the following attributes in addition to the arguments a [1]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_Filter.html - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/route53_resolver_firewall_config.html.markdown b/website/docs/cdktf/typescript/d/route53_resolver_firewall_config.html.markdown index 25cfaeee2858..5d5c33ba0cb5 100644 --- a/website/docs/cdktf/typescript/d/route53_resolver_firewall_config.html.markdown +++ b/website/docs/cdktf/typescript/d/route53_resolver_firewall_config.html.markdown @@ -42,6 +42,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `resourceId` - (Required) The ID of the VPC from Amazon VPC that the configuration is for. ## Attribute Reference @@ -52,4 +53,4 @@ This data source exports the following attributes in addition to the arguments a * `id` - The ID of the firewall configuration. * `ownerId` - The Amazon Web Services account ID of the owner of the VPC that this firewall configuration applies to. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/route53_resolver_firewall_domain_list.html.markdown b/website/docs/cdktf/typescript/d/route53_resolver_firewall_domain_list.html.markdown index a483662c7706..e307f3c465f9 100644 --- a/website/docs/cdktf/typescript/d/route53_resolver_firewall_domain_list.html.markdown +++ b/website/docs/cdktf/typescript/d/route53_resolver_firewall_domain_list.html.markdown @@ -42,6 +42,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `firewallDomainListId` - (Required) The ID of the domain list. ## Attribute Reference @@ -58,4 +59,4 @@ This data source exports the following attributes in addition to the arguments a * `status` - The status of the domain list. * `statusMessage` - Additional information about the status of the list, if available. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/route53_resolver_firewall_rule_group.html.markdown b/website/docs/cdktf/typescript/d/route53_resolver_firewall_rule_group.html.markdown index 336099f3a82c..2130f537b102 100644 --- a/website/docs/cdktf/typescript/d/route53_resolver_firewall_rule_group.html.markdown +++ b/website/docs/cdktf/typescript/d/route53_resolver_firewall_rule_group.html.markdown @@ -42,6 +42,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `firewallRuleGroupId` - (Required) The ID of the rule group. ## Attribute Reference @@ -59,4 +60,4 @@ This data source exports the following attributes in addition to the arguments a * `status` - The status of the rule group. * `statusMessage` - Additional information about the status of the rule group, if available. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/route53_resolver_firewall_rule_group_association.html.markdown b/website/docs/cdktf/typescript/d/route53_resolver_firewall_rule_group_association.html.markdown index 49a21e73c08b..f913acfce132 100644 --- a/website/docs/cdktf/typescript/d/route53_resolver_firewall_rule_group_association.html.markdown +++ b/website/docs/cdktf/typescript/d/route53_resolver_firewall_rule_group_association.html.markdown @@ -42,6 +42,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `firewallRuleGroupAssociationId` - (Required) The identifier for the association. ## Attribute Reference @@ -61,4 +62,4 @@ This data source exports the following attributes in addition to the arguments a * `statusMessage` - Additional information about the status of the response, if available. * `vpcId` - The unique identifier of the VPC that is associated with the rule group. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/route53_resolver_firewall_rules.html.markdown b/website/docs/cdktf/typescript/d/route53_resolver_firewall_rules.html.markdown index 03d9d3894cf3..b5d9462e292d 100644 --- a/website/docs/cdktf/typescript/d/route53_resolver_firewall_rules.html.markdown +++ b/website/docs/cdktf/typescript/d/route53_resolver_firewall_rules.html.markdown @@ -42,6 +42,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `firewallRuleGroupId` - (Required) The unique identifier of the firewall rule group that you want to retrieve the rules for. * `action` - (Optional) The action that DNS Firewall should take on a DNS query when it matches one of the domains in the rule's domain list. * `priority` - (Optional) The setting that determines the processing order of the rules in a rule group. @@ -64,4 +65,4 @@ This data source exports the following attributes in addition to the arguments a * `modificationTime` - The date and time that the rule was last modified, in Unix time format and Coordinated Universal Time (UTC). * `name` - The name of the rule. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/route53_resolver_query_log_config.html.markdown b/website/docs/cdktf/typescript/d/route53_resolver_query_log_config.html.markdown index c43c18b20b36..f33713f257aa 100644 --- a/website/docs/cdktf/typescript/d/route53_resolver_query_log_config.html.markdown +++ b/website/docs/cdktf/typescript/d/route53_resolver_query_log_config.html.markdown @@ -67,6 +67,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `resolverQueryLogConfigId` - (Optional) ID of the Route53 Resolver Query Logging Configuration. * `filter` - (Optional) One or more name/value pairs to use as filters. There are several valid keys, for a full reference, check out @@ -86,4 +87,4 @@ This data source exports the following attributes in addition to the arguments a [1]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_Filter.html - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/route53_resolver_rule.html.markdown b/website/docs/cdktf/typescript/d/route53_resolver_rule.html.markdown index bcaac3873dfd..3af8af3dd23c 100644 --- a/website/docs/cdktf/typescript/d/route53_resolver_rule.html.markdown +++ b/website/docs/cdktf/typescript/d/route53_resolver_rule.html.markdown @@ -41,6 +41,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `domainName` - (Optional) Domain name the desired resolver rule forwards DNS queries for. Conflicts with `resolverRuleId`. * `name` - (Optional) Friendly name of the desired resolver rule. Conflicts with `resolverRuleId`. * `resolverEndpointId` (Optional) ID of the outbound resolver endpoint of the desired resolver rule. Conflicts with `resolverRuleId`. @@ -58,4 +59,4 @@ This data source exports the following attributes in addition to the arguments a Values are `NOT_SHARED`, `SHARED_BY_ME` or `SHARED_WITH_ME` * `tags` - Map of tags assigned to the resolver rule. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/route53_resolver_rules.html.markdown b/website/docs/cdktf/typescript/d/route53_resolver_rules.html.markdown index f7be786f67c0..e61cca7bb75e 100644 --- a/website/docs/cdktf/typescript/d/route53_resolver_rules.html.markdown +++ b/website/docs/cdktf/typescript/d/route53_resolver_rules.html.markdown @@ -89,6 +89,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `nameRegex` - (Optional) Regex string to filter resolver rule names. The filtering is done locally, so could have a performance impact if the result is large. This argument should be used along with other arguments to limit the number of results returned. @@ -104,4 +105,4 @@ This data source exports the following attributes in addition to the arguments a * `id` - AWS Region. * `resolverRuleIds` - IDs of the matched resolver rules. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/route53_traffic_policy_document.html.markdown b/website/docs/cdktf/typescript/d/route53_traffic_policy_document.html.markdown index f0eabb202089..f3680edf0da6 100644 --- a/website/docs/cdktf/typescript/d/route53_traffic_policy_document.html.markdown +++ b/website/docs/cdktf/typescript/d/route53_traffic_policy_document.html.markdown @@ -36,11 +36,11 @@ class MyConvertedCode extends TerraformStack { { id: "my_elb", type: "elastic-load-balancer", - value: "elb-111111.${" + current.name + "}.elb.amazonaws.com", + value: "elb-111111.${" + current.region + "}.elb.amazonaws.com", }, { id: "site_down_banner", - region: Token.asString(current.name), + region: Token.asString(current.region), type: "s3-website", value: "www.example.com", }, @@ -248,4 +248,4 @@ This data source exports the following attributes in addition to the arguments a * `json` - Standard JSON policy document rendered based on the arguments above. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/route53profiles_profiles.html.markdown b/website/docs/cdktf/typescript/d/route53profiles_profiles.html.markdown index aff1446c6d74..6721b0421daf 100644 --- a/website/docs/cdktf/typescript/d/route53profiles_profiles.html.markdown +++ b/website/docs/cdktf/typescript/d/route53profiles_profiles.html.markdown @@ -36,7 +36,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -This data source does not support any arguments. +This data source supports the following arguments: + +* `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). ## Attribute Reference @@ -48,4 +50,4 @@ This data source exports the following attributes in addition to the arguments a * `name` - Name of the Profile. * `shareStatus` - Share status of the Profile. Valid values [AWS docs](https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53profiles_Profile.html) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/route_table.html.markdown b/website/docs/cdktf/typescript/d/route_table.html.markdown index 039a9f4968f0..90ab925f9e6f 100644 --- a/website/docs/cdktf/typescript/d/route_table.html.markdown +++ b/website/docs/cdktf/typescript/d/route_table.html.markdown @@ -51,6 +51,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `filter` - (Optional) Configuration block. Detailed below. * `gatewayId` - (Optional) ID of an Internet Gateway or Virtual Private Gateway which is connected to the Route Table (not exported if not passed as a parameter). * `routeTableId` - (Optional) ID of the specific Route Table to retrieve. @@ -116,4 +117,4 @@ Associations are also exported with the following attributes: - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/route_tables.html.markdown b/website/docs/cdktf/typescript/d/route_tables.html.markdown index d27be277b929..7eea94337770 100644 --- a/website/docs/cdktf/typescript/d/route_tables.html.markdown +++ b/website/docs/cdktf/typescript/d/route_tables.html.markdown @@ -62,6 +62,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `filter` - (Optional) Custom filter block as described below. * `vpcId` - (Optional) VPC ID that you want to filter from. * `tags` - (Optional) Map of tags, each pair of which must exactly match @@ -89,4 +90,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/s3_access_point.html.markdown b/website/docs/cdktf/typescript/d/s3_access_point.html.markdown new file mode 100644 index 000000000000..73e4220023f1 --- /dev/null +++ b/website/docs/cdktf/typescript/d/s3_access_point.html.markdown @@ -0,0 +1,66 @@ +--- +subcategory: "S3 Control" +layout: "aws" +page_title: "AWS: aws_s3_access_point" +description: |- + Provides details about a specific S3 access point +--- + + + +# Data Source: aws_s3_access_point + +Provides details about a specific S3 access point. + +## Example Usage + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { DataAwsS3AccessPoint } from "./.gen/providers/aws/data-aws-s3-access-point"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + new DataAwsS3AccessPoint(this, "example", { + name: "example-access-point", + }); + } +} + +``` + +## Argument Reference + +This data source supports the following arguments: + +* `accountId` - (Optional) AWS account ID for the account that owns the specified access point. +* `name` - (Required) Name of the access point. +* `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). + +## Attribute Reference + +This data source exports the following attributes in addition to the arguments above: + +* `alias` - Access point alias. +* `arn` - Access point ARN. +* `bucket` - Name of the bucket associated with the access point. +* `bucketAccountId` - AWS account ID associated with the S3 bucket associated with the access point. +* `dataSourceId` - Unique identifier for the data source of the access point. +* `dataSourceType` - Type of the data source that the access point is attached to. +* `endpoints` - VPC endpoint for the access point. +* `networkOrigin` - Indicates whether the access point allows access from the public Internet. +* `publicAccessBlockConfiguration` - `PublicAccessBlock` configuration for the access point. + * `blockPublicAcls` - Whether Amazon S3 blocks public ACLs for buckets in this account. + * `blockPublicPolicy` - Whether Amazon S3 blocks public bucket policies for buckets in this account. + * `ignorePublicAcls` - Whether Amazon S3 ignores public ACLs for buckets in this account. + * `restrictPublicBuckets` - Whether Amazon S3 restricts public bucket policies for buckets in this account. +* `tags` - Tags assigned to the access point. +* `vpcConfiguration` - VPC configuration for the access point. + * `vpcId` - Access point will only allow connections from this VPC. + + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/s3_bucket.html.markdown b/website/docs/cdktf/typescript/d/s3_bucket.html.markdown index 07c822cb014b..e7c3e4bfea5a 100644 --- a/website/docs/cdktf/typescript/d/s3_bucket.html.markdown +++ b/website/docs/cdktf/typescript/d/s3_bucket.html.markdown @@ -102,6 +102,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `bucket` - (Required) Name of the bucket ## Attribute Reference @@ -111,10 +112,10 @@ This data source exports the following attributes in addition to the arguments a * `id` - Name of the bucket. * `arn` - ARN of the bucket. Will be of format `arn:aws:s3:::bucketname`. * `bucketDomainName` - Bucket domain name. Will be of format `bucketname.s3.amazonaws.com`. +* `bucketRegion` - AWS region this bucket resides in. * `bucketRegionalDomainName` - The bucket region-specific domain name. The bucket domain name including the region name. Please refer to the [S3 endpoints reference](https://docs.aws.amazon.com/general/latest/gr/s3.html#s3_region) for format. Note: AWS CloudFront allows specifying an S3 region-specific endpoint when creating an S3 origin. This will prevent redirect issues from CloudFront to the S3 Origin URL. For more information, see the [Virtual Hosted-Style Requests for Other Regions](https://docs.aws.amazon.com/AmazonS3/latest/userguide/VirtualHosting.html#deprecated-global-endpoint) section in the AWS S3 User Guide. * `hostedZoneId` - The [Route 53 Hosted Zone ID](https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_website_region_endpoints) for this bucket's region. -* `region` - AWS region this bucket resides in. * `websiteEndpoint` - Website endpoint, if the bucket is configured with a website. If not, this will be an empty string. * `websiteDomain` - Domain of the website endpoint, if the bucket is configured with a website. If not, this will be an empty string. This is used to create Route 53 alias records. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/s3_bucket_object.html.markdown b/website/docs/cdktf/typescript/d/s3_bucket_object.html.markdown index 13886f5fb6ea..260f07f96c4a 100644 --- a/website/docs/cdktf/typescript/d/s3_bucket_object.html.markdown +++ b/website/docs/cdktf/typescript/d/s3_bucket_object.html.markdown @@ -106,6 +106,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `bucket` - (Required) Name of the bucket to read the object from. Alternatively, an [S3 access point](https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html) ARN can be specified * `key` - (Required) Full path to the object inside the bucket * `versionId` - (Optional) Specific version ID of the object returned (defaults to latest version) @@ -139,4 +140,4 @@ This data source exports the following attributes in addition to the arguments a -> **Note:** Terraform ignores all leading `/`s in the object's `key` and treats multiple `/`s in the rest of the object's `key` as a single `/`, so values of `/index.html` and `index.html` correspond to the same S3 object as do `first//second///third//` and `first/second/third/`. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/s3_bucket_objects.html.markdown b/website/docs/cdktf/typescript/d/s3_bucket_objects.html.markdown index d441a01c5d95..f14245de7ae9 100644 --- a/website/docs/cdktf/typescript/d/s3_bucket_objects.html.markdown +++ b/website/docs/cdktf/typescript/d/s3_bucket_objects.html.markdown @@ -59,6 +59,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `bucket` - (Required) Lists object keys in this S3 bucket. Alternatively, an [S3 access point](https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html) ARN can be specified * `prefix` - (Optional) Limits results to object keys with this prefix (Default: none) * `delimiter` - (Optional) Character used to group keys (Default: none) @@ -76,4 +77,4 @@ This data source exports the following attributes in addition to the arguments a * `id` - S3 Bucket. * `owners` - List of strings representing object owner IDs (see `fetchOwner` above) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/s3_bucket_policy.html.markdown b/website/docs/cdktf/typescript/d/s3_bucket_policy.html.markdown index ed177d4e512b..bfc354e8f49e 100644 --- a/website/docs/cdktf/typescript/d/s3_bucket_policy.html.markdown +++ b/website/docs/cdktf/typescript/d/s3_bucket_policy.html.markdown @@ -43,6 +43,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `bucket` - (Required) Bucket name. ## Attribute Reference @@ -51,4 +52,4 @@ This data source exports the following attributes in addition to the arguments a * `policy` - IAM bucket policy. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/s3_directory_buckets.html.markdown b/website/docs/cdktf/typescript/d/s3_directory_buckets.html.markdown index 7015e73ba2bf..3ff88e5359a8 100644 --- a/website/docs/cdktf/typescript/d/s3_directory_buckets.html.markdown +++ b/website/docs/cdktf/typescript/d/s3_directory_buckets.html.markdown @@ -34,7 +34,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -This data source does not support any arguments. +This data source supports the following arguments: + +* `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). ## Attribute Reference @@ -43,4 +45,4 @@ This data source exports the following attributes in addition to the arguments a * `arns` - Bucket ARNs. * `buckets` - Buckets names. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/s3_object.html.markdown b/website/docs/cdktf/typescript/d/s3_object.html.markdown index 9afac57722aa..7bd00f658d39 100644 --- a/website/docs/cdktf/typescript/d/s3_object.html.markdown +++ b/website/docs/cdktf/typescript/d/s3_object.html.markdown @@ -101,6 +101,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `bucket` - (Required) Name of the bucket to read the object from. Alternatively, an [S3 access point](https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html) ARN can be specified * `checksumMode` - (Optional) To retrieve the object's checksum, this argument must be `ENABLED`. If you enable `checksumMode` and the object is encrypted with KMS, you must have permission to use the `kms:Decrypt` action. Valid values: `ENABLED` * `key` - (Required) Full path to the object inside the bucket @@ -141,4 +142,4 @@ This data source exports the following attributes in addition to the arguments a -> **Note:** Terraform ignores all leading `/`s in the object's `key` and treats multiple `/`s in the rest of the object's `key` as a single `/`, so values of `/index.html` and `index.html` correspond to the same S3 object as do `first//second///third//` and `first/second/third/`. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/s3_objects.html.markdown b/website/docs/cdktf/typescript/d/s3_objects.html.markdown index 740ecdf8da2d..b629beb21e31 100644 --- a/website/docs/cdktf/typescript/d/s3_objects.html.markdown +++ b/website/docs/cdktf/typescript/d/s3_objects.html.markdown @@ -57,6 +57,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `bucket` - (Required) Lists object keys in this S3 bucket. Alternatively, an [S3 access point](https://docs.aws.amazon.com/AmazonS3/latest/dev/using-access-points.html) ARN can be specified * `prefix` - (Optional) Limits results to object keys with this prefix (Default: none) * `delimiter` - (Optional) Character used to group keys (Default: none) @@ -76,4 +77,4 @@ This data source exports the following attributes in addition to the arguments a * `owners` - List of strings representing object owner IDs (see `fetchOwner` above) * `requestCharged` - If present, indicates that the requester was successfully charged for the request. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/s3control_multi_region_access_point.html.markdown b/website/docs/cdktf/typescript/d/s3control_multi_region_access_point.html.markdown index e89bf3a5c87b..63b0b84a8a69 100644 --- a/website/docs/cdktf/typescript/d/s3control_multi_region_access_point.html.markdown +++ b/website/docs/cdktf/typescript/d/s3control_multi_region_access_point.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `accountId` - (Optional) The AWS account ID of the S3 Multi-Region Access Point. Defaults to automatically determined account ID of the Terraform AWS provider. * `name` - (Required) The name of the Multi-Region Access Point. @@ -72,4 +73,4 @@ This data source exports the following attributes in addition to the arguments a * `bucketAccountId` - The AWS account ID that owns the bucket. * `region` - The name of the region. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/sagemaker_prebuilt_ecr_image.html.markdown b/website/docs/cdktf/typescript/d/sagemaker_prebuilt_ecr_image.html.markdown index 5f0621e9605c..543ea4dbd907 100644 --- a/website/docs/cdktf/typescript/d/sagemaker_prebuilt_ecr_image.html.markdown +++ b/website/docs/cdktf/typescript/d/sagemaker_prebuilt_ecr_image.html.markdown @@ -46,7 +46,7 @@ This data source supports the following arguments: * `repositoryName` - (Required) Name of the repository, which is generally the algorithm or library. Values include `autogluon-inference`, `autogluon-training`, `blazingtext`, `djl-inference`, `factorization-machines`, `forecasting-deepar`, `huggingface-pytorch-inference`, `huggingface-pytorch-inference-neuron`, `huggingface-pytorch-inference-neuronx`, `huggingface-pytorch-tgi-inference`, `huggingface-pytorch-training`, `huggingface-pytorch-training-neuronx`, `huggingface-pytorch-trcomp-training`, `huggingface-tensorflow-inference`, `huggingface-tensorflow-training`, `huggingface-tensorflow-trcomp-training`, `image-classification`, `image-classification-neo`, `ipinsights`, `kmeans`, `knn`, `lda`, `linear-learner`, `mxnet-inference`, `mxnet-inference-eia`, `mxnet-training`, `ntm`, `object-detection`, `object2vec`, `pca`, `pytorch-inference`, `pytorch-inference-eia`, `pytorch-inference-graviton`, `pytorch-inference-neuronx`, `pytorch-training`, `pytorch-training-neuronx`, `pytorch-trcomp-training`, `randomcutforest`, `sagemaker-base-python`, `sagemaker-chainer`, `sagemaker-clarify-processing`, `sagemaker-data-wrangler-container`, `sagemaker-debugger-rules`, `sagemaker-geospatial-v1-0`, `sagemaker-inference-mxnet`, `sagemaker-inference-pytorch`, `sagemaker-inference-tensorflow`, `sagemaker-model-monitor-analyzer`, `sagemaker-mxnet`, `sagemaker-mxnet-eia`, `sagemaker-mxnet-serving`, `sagemaker-mxnet-serving-eia`, `sagemaker-neo-mxnet`, `sagemaker-neo-pytorch`, `sagemaker-neo-tensorflow`, `sagemaker-pytorch`, `sagemaker-rl-coach-container`, `sagemaker-rl-mxnet`, `sagemaker-rl-ray-container`, `sagemaker-rl-tensorflow`, `sagemaker-rl-vw-container`, `sagemaker-scikit-learn`, `sagemaker-spark-processing`, `sagemaker-sparkml-serving`, `sagemaker-tensorflow`, `sagemaker-tensorflow-eia`, `sagemaker-tensorflow-scriptmode`, `sagemaker-tensorflow-serving`, `sagemaker-tensorflow-serving-eia`, `sagemaker-tritonserver`, `sagemaker-xgboost`, `semantic-segmentation`, `seq2seq`, `stabilityai-pytorch-inference`, `tei`, `tei-cpu`, `tensorflow-inference`, `tensorflow-inference-eia`, `tensorflow-inference-graviton`, `tensorflow-training`, and `xgboost-neo`. * `dnsSuffix` - (Optional) DNS suffix to use in the registry path. If not specified, the AWS provider sets it to the DNS suffix for the current region. * `imageTag` - (Optional) Image tag for the Docker image. If not specified, the AWS provider sets the value to `1`, which for many repositories indicates the latest version. Some repositories, such as XGBoost, do not support `1` or `latest` and specific version must be used. -* `region` (Optional) - Region to use in the registry path. If not specified, the AWS provider sets it to the current region. +* `region` - (Optional) Region to use in the registry path. Defaults to the Region set in the [provider configuration](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#aws-configuration-reference). ## Attribute Reference @@ -55,4 +55,4 @@ This data source exports the following attributes in addition to the arguments a * `registryId` - Account ID containing the image. For example, `469771592824`. * `registryPath` - Docker image URL. For example, `341280168497.dkr.ecr.ca-central-1.amazonaws.com/sagemaker-sparkml-serving:2.4`. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/secretsmanager_random_password.html.markdown b/website/docs/cdktf/typescript/d/secretsmanager_random_password.html.markdown index 91973e88215d..eceb07dfe788 100644 --- a/website/docs/cdktf/typescript/d/secretsmanager_random_password.html.markdown +++ b/website/docs/cdktf/typescript/d/secretsmanager_random_password.html.markdown @@ -39,6 +39,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `excludeCharacters` - (Optional) String of the characters that you don't want in the password. * `excludeLowercase` - (Optional) Specifies whether to exclude lowercase letters from the password. * `excludeNumbers` - (Optional) Specifies whether to exclude numbers from the password. @@ -54,4 +55,4 @@ This data source exports the following attributes in addition to the arguments a * `randomPassword` - Random password. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/secretsmanager_secret.html.markdown b/website/docs/cdktf/typescript/d/secretsmanager_secret.html.markdown index 947152475f6b..57c9dc08172f 100644 --- a/website/docs/cdktf/typescript/d/secretsmanager_secret.html.markdown +++ b/website/docs/cdktf/typescript/d/secretsmanager_secret.html.markdown @@ -62,6 +62,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `arn` - (Optional) ARN of the secret to retrieve. * `name` - (Optional) Name of the secret to retrieve. @@ -78,4 +79,4 @@ This data source exports the following attributes in addition to the arguments a * `policy` - Resource-based policy document that's attached to the secret. * `tags` - Tags of the secret. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/secretsmanager_secret_rotation.html.markdown b/website/docs/cdktf/typescript/d/secretsmanager_secret_rotation.html.markdown index b33a528404b9..ea26dd941e72 100644 --- a/website/docs/cdktf/typescript/d/secretsmanager_secret_rotation.html.markdown +++ b/website/docs/cdktf/typescript/d/secretsmanager_secret_rotation.html.markdown @@ -40,14 +40,21 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `secretId` - (Required) Specifies the secret containing the version that you want to retrieve. You can specify either the ARN or the friendly name of the secret. ## Attribute Reference This data source exports the following attributes in addition to the arguments above: -* `rotationEnabled` - ARN of the secret. -* `rotationLambdaArn` - Decrypted part of the protected secret information that was originally provided as a string. -* `rotationRules` - Decrypted part of the protected secret information that was originally provided as a binary. Base64 encoded. +* `rotationEnabled` - Specifies whether automatic rotation is enabled for this secret. +* `rotationLambdaArn` - Amazon Resource Name (ARN) of the lambda function used for rotation. +* `rotationRules` - Configuration block for rotation rules. See [`rotationRules`](#rotation_rules) below. - \ No newline at end of file +### rotation_rules + +* `automaticallyAfterDays` - Number of days between automatic scheduled rotations of the secret. +* `duration` - Length of the rotation window in hours. +* `scheduleExpression` - A `cron()` or `rate()` expression that defines the schedule for rotating the secret. + + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/secretsmanager_secret_version.html.markdown b/website/docs/cdktf/typescript/d/secretsmanager_secret_version.html.markdown index 06df95ae1d38..562a940cc53d 100644 --- a/website/docs/cdktf/typescript/d/secretsmanager_secret_version.html.markdown +++ b/website/docs/cdktf/typescript/d/secretsmanager_secret_version.html.markdown @@ -87,6 +87,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `secretId` - (Required) Specifies the secret containing the version that you want to retrieve. You can specify either the ARN or the friendly name of the secret. * `versionId` - (Optional) Specifies the unique identifier of the version of the secret that you want to retrieve. Overrides `versionStage`. * `versionStage` - (Optional) Specifies the secret version that you want to retrieve by the staging label attached to the version. Defaults to `AWSCURRENT`. @@ -102,4 +103,4 @@ This data source exports the following attributes in addition to the arguments a * `secretBinary` - Decrypted part of the protected secret information that was originally provided as a binary. * `versionId` - Unique identifier of this version of the secret. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/secretsmanager_secret_versions.html.markdown b/website/docs/cdktf/typescript/d/secretsmanager_secret_versions.html.markdown index 1b062d3690df..7d7a83204470 100644 --- a/website/docs/cdktf/typescript/d/secretsmanager_secret_versions.html.markdown +++ b/website/docs/cdktf/typescript/d/secretsmanager_secret_versions.html.markdown @@ -87,6 +87,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `secretId` - (Required) Specifies the secret containing the version that you want to retrieve. You can specify either the ARN or the friendly name of the secret. * `includeDeprecated` - (Optional) If true, all deprecated secret versions are included in the response. If false, no deprecated secret versions are included in the response. If no value is specified, the default value is `false`. @@ -106,4 +107,4 @@ This data source exports the following attributes in addition to the arguments a * `versionId` - Unique version identifier of this version of the secret. * `versionStages` - List of staging labels attached to the version. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/secretsmanager_secrets.html.markdown b/website/docs/cdktf/typescript/d/secretsmanager_secrets.html.markdown index a29ec8979b32..1b221d1cf8ed 100644 --- a/website/docs/cdktf/typescript/d/secretsmanager_secrets.html.markdown +++ b/website/docs/cdktf/typescript/d/secretsmanager_secrets.html.markdown @@ -43,6 +43,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `filter` - (Optional) Configuration block(s) for filtering. Detailed below. ## filter Configuration Block @@ -59,4 +60,4 @@ This data source exports the following attributes in addition to the arguments a * `arns` - Set of ARNs of the matched Secrets Manager secrets. * `names` - Set of names of the matched Secrets Manager secrets. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/security_group.html.markdown b/website/docs/cdktf/typescript/d/security_group.html.markdown index ef00ded0eafa..4261b22d2b16 100644 --- a/website/docs/cdktf/typescript/d/security_group.html.markdown +++ b/website/docs/cdktf/typescript/d/security_group.html.markdown @@ -57,6 +57,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `filter` - (Optional) Custom filter block as described below. * `id` - (Optional) Id of the specific security group to retrieve. * `name` - (Optional) Name that the desired security group must have. @@ -92,4 +93,4 @@ The following fields are also exported: - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/security_groups.html.markdown b/website/docs/cdktf/typescript/d/security_groups.html.markdown index 149964abf65d..0e879821f522 100644 --- a/website/docs/cdktf/typescript/d/security_groups.html.markdown +++ b/website/docs/cdktf/typescript/d/security_groups.html.markdown @@ -70,6 +70,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `tags` - (Optional) Map of tags, each pair of which must exactly match for desired security groups. * `filter` - (Optional) One or more name/value pairs to use as filters. There are several valid keys, for a full reference, check out [describe-security-groups in the AWS CLI reference][1]. @@ -90,4 +91,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/securityhub_standards_control_associations.html.markdown b/website/docs/cdktf/typescript/d/securityhub_standards_control_associations.html.markdown index 12dc3b369d0c..2ec826b3e6a6 100644 --- a/website/docs/cdktf/typescript/d/securityhub_standards_control_associations.html.markdown +++ b/website/docs/cdktf/typescript/d/securityhub_standards_control_associations.html.markdown @@ -48,6 +48,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `securityControlId` - (Required) The identifier of the control (identified with `SecurityControlId`, `SecurityControlArn`, or a mix of both parameters). ## Attribute Reference @@ -69,4 +70,4 @@ See [`standardsControlAssociations`](#standards_control_associations-attribute-r * `updatedAt` - Last time that a control's enablement status in a specified standard was updated. * `updatedReason` - Reason for updating a control's enablement status in a specified standard. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/serverlessapplicationrepository_application.html.markdown b/website/docs/cdktf/typescript/d/serverlessapplicationrepository_application.html.markdown index 7c6c03380fe9..549b9617de9e 100644 --- a/website/docs/cdktf/typescript/d/serverlessapplicationrepository_application.html.markdown +++ b/website/docs/cdktf/typescript/d/serverlessapplicationrepository_application.html.markdown @@ -59,6 +59,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `applicationId` - (Required) ARN of the application. * `semanticVersion` - (Optional) Requested version of the application. By default, retrieves the latest version. @@ -72,4 +73,4 @@ This data source exports the following attributes in addition to the arguments a * `sourceCodeUrl` - URL pointing to the source code of the application version. * `templateUrl` - URL pointing to the Cloud Formation template for the application version. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/service.html.markdown b/website/docs/cdktf/typescript/d/service.html.markdown index 6bc27a93537a..a63202fcc3f2 100644 --- a/website/docs/cdktf/typescript/d/service.html.markdown +++ b/website/docs/cdktf/typescript/d/service.html.markdown @@ -31,7 +31,7 @@ class MyConvertedCode extends TerraformStack { super(scope, name); const current = new DataAwsRegion(this, "current", {}); new DataAwsService(this, "test", { - region: Token.asString(current.name), + region: Token.asString(current.region), serviceId: "ec2", }); } @@ -88,8 +88,8 @@ class MyConvertedCode extends TerraformStack { The following arguments are optional: * `dnsName` - (Optional) DNS name of the service (_e.g.,_ `rds.us-east-1.amazonaws.com`). One of `dnsName`, `reverseDnsName`, or `serviceId` is required. -* `partition` - (Optional) Partition corresponding to the region. -* `region` - (Optional) Region of the service (_e.g.,_ `us-west-2`, `ap-northeast-1`). +* `partition` - (Optional) Partition corresponding to the Region. +* `region` - (Optional) Region of the service (_e.g.,_ `us-west-2`, `ap-northeast-1`). Defaults to the Region set in the [provider configuration](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#aws-configuration-reference). * `reverseDnsName` - (Optional) Reverse DNS name of the service (_e.g.,_ `com.amazonaws.us-west-2.s3`). One of `dnsName`, `reverseDnsName`, or `serviceId` is required. * `reverseDnsPrefix` - (Optional) Prefix of the service (_e.g.,_ `com.amazonaws` in AWS Commercial, `cn.com.amazonaws` in AWS China). * `serviceId` - (Optional) Service endpoint ID (_e.g.,_ `s3`, `rds`, `ec2`). One of `dnsName`, `reverseDnsName`, or `serviceId` is required. A service's endpoint ID can be found in the [_AWS General Reference_](https://docs.aws.amazon.com/general/latest/gr/aws-service-information.html). @@ -100,4 +100,4 @@ This data source exports the following attributes in addition to the arguments a * `supported` - Whether the service is supported in the region's partition. New services may not be listed immediately as supported. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/service_discovery_dns_namespace.html.markdown b/website/docs/cdktf/typescript/d/service_discovery_dns_namespace.html.markdown index a4f88100d2a9..84ae9709c191 100644 --- a/website/docs/cdktf/typescript/d/service_discovery_dns_namespace.html.markdown +++ b/website/docs/cdktf/typescript/d/service_discovery_dns_namespace.html.markdown @@ -39,6 +39,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `name` - (Required) Name of the namespace. * `type` - (Required) Type of the namespace. Allowed values are `DNS_PUBLIC` or `DNS_PRIVATE`. @@ -52,4 +53,4 @@ This data source exports the following attributes in addition to the arguments a * `hostedZone` - ID for the hosted zone that Amazon Route 53 creates when you create a namespace. * `tags` - Map of tags for the resource. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/service_discovery_http_namespace.html.markdown b/website/docs/cdktf/typescript/d/service_discovery_http_namespace.html.markdown index 46541c0ef092..874c263367fc 100644 --- a/website/docs/cdktf/typescript/d/service_discovery_http_namespace.html.markdown +++ b/website/docs/cdktf/typescript/d/service_discovery_http_namespace.html.markdown @@ -36,6 +36,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `name` - (Required) Name of the http namespace. ## Attribute Reference @@ -48,4 +49,4 @@ This data source exports the following attributes in addition to the arguments a * `httpName` - Name of an HTTP namespace. * `tags` - Map of tags for the resource. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/service_discovery_service.html.markdown b/website/docs/cdktf/typescript/d/service_discovery_service.html.markdown index 1f701bdaeeee..c3de706abb7a 100644 --- a/website/docs/cdktf/typescript/d/service_discovery_service.html.markdown +++ b/website/docs/cdktf/typescript/d/service_discovery_service.html.markdown @@ -39,6 +39,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `name` - (Required) Name of the service. * `namespaceId` - (Required) ID of the namespace that the service belongs to. @@ -84,4 +85,4 @@ The `healthCheckCustomConfig` configuration block supports the following argumen * `failureThreshold` - The number of 30-second intervals that you want service discovery to wait before it changes the health status of a service instance. Maximum value of 10. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/service_principal.html.markdown b/website/docs/cdktf/typescript/d/service_principal.html.markdown index d7e2ae980388..04cc995b0f3a 100644 --- a/website/docs/cdktf/typescript/d/service_principal.html.markdown +++ b/website/docs/cdktf/typescript/d/service_principal.html.markdown @@ -43,16 +43,15 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: * `serviceName` - (Required) Name of the service you want to generate a Service Principal Name for. -* `region` - (Optional) Region you'd like the SPN for. By default, uses the current region. +* `region` - (Optional) Region you'd like the SPN for. Defaults to the Region set in the [provider configuration](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#aws-configuration-reference). ## Attribute Reference This data source exports the following attributes in addition to the arguments above: -* `id` - Identifier of the current Service Principal (compound of service, region and suffix). (e.g. `logs.us-east-1.amazonaws.com`in AWS Commercial, `logs.cn-north-1.amazonaws.com.cn` in AWS China). +* `id` - Identifier of the current Service Principal (compound of service, Region and suffix). (e.g. `logs.us-east-1.amazonaws.com`in AWS Commercial, `logs.cn-north-1.amazonaws.com.cn` in AWS China). * `name` - Service Principal Name (e.g., `logs.amazonaws.com` in AWS Commercial, `logs.amazonaws.com.cn` in AWS China). * `service` - Service used for SPN generation (e.g. `logs`). * `suffix` - Suffix of the SPN (e.g., `amazonaws.com` in AWS Commercial, `amazonaws.com.cn` in AWS China). -*`region` - Region identifier of the generated SPN (e.g., `us-east-1` in AWS Commercial, `cn-north-1` in AWS China). - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/servicecatalog_constraint.html.markdown b/website/docs/cdktf/typescript/d/servicecatalog_constraint.html.markdown index a774f69706de..11065c16c4df 100644 --- a/website/docs/cdktf/typescript/d/servicecatalog_constraint.html.markdown +++ b/website/docs/cdktf/typescript/d/servicecatalog_constraint.html.markdown @@ -45,6 +45,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `acceptLanguage` - (Optional) Language code. Valid values: `en` (English), `jp` (Japanese), `zh` (Chinese). Default value is `en`. ## Attribute Reference @@ -59,4 +60,4 @@ This data source exports the following attributes in addition to the arguments a * `status` - Constraint status. * `type` - Type of constraint. Valid values are `LAUNCH`, `NOTIFICATION`, `RESOURCE_UPDATE`, `STACKSET`, and `TEMPLATE`. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/servicecatalog_launch_paths.html.markdown b/website/docs/cdktf/typescript/d/servicecatalog_launch_paths.html.markdown index 277ef6d6e8d5..85836d110985 100644 --- a/website/docs/cdktf/typescript/d/servicecatalog_launch_paths.html.markdown +++ b/website/docs/cdktf/typescript/d/servicecatalog_launch_paths.html.markdown @@ -44,6 +44,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `acceptLanguage` - (Optional) Language code. Valid values: `en` (English), `jp` (Japanese), `zh` (Chinese). Default value is `en`. ## Attribute Reference @@ -64,4 +65,4 @@ This data source exports the following attributes in addition to the arguments a * `description` - Description of the constraint. * `type` - Type of constraint. Valid values are `LAUNCH`, `NOTIFICATION`, `STACKSET`, and `TEMPLATE`. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/servicecatalog_portfolio.html.markdown b/website/docs/cdktf/typescript/d/servicecatalog_portfolio.html.markdown index 9d7ba0c3bb45..2b4351f9552b 100644 --- a/website/docs/cdktf/typescript/d/servicecatalog_portfolio.html.markdown +++ b/website/docs/cdktf/typescript/d/servicecatalog_portfolio.html.markdown @@ -42,6 +42,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `acceptLanguage` - (Optional) Language code. Valid values: `en` (English), `jp` (Japanese), `zh` (Chinese). Default value is `en`. ## Attribute Reference @@ -55,4 +56,4 @@ This data source exports the following attributes in addition to the arguments a * `providerName` - Name of the person or organization who owns the portfolio. * `tags` - Tags applied to the portfolio. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/servicecatalog_portfolio_constraints.html.markdown b/website/docs/cdktf/typescript/d/servicecatalog_portfolio_constraints.html.markdown index d1a484fcad9e..80ce356c7b70 100644 --- a/website/docs/cdktf/typescript/d/servicecatalog_portfolio_constraints.html.markdown +++ b/website/docs/cdktf/typescript/d/servicecatalog_portfolio_constraints.html.markdown @@ -44,6 +44,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `acceptLanguage` - (Optional) Language code. Valid values: `en` (English), `jp` (Japanese), `zh` (Chinese). Default value is `en`. * `productId` - (Optional) Product identifier. @@ -61,4 +62,4 @@ This data source exports the following attributes in addition to the arguments a * `productId` - Identifier of the product the constraint applies to. A constraint applies to a specific instance of a product within a certain portfolio. * `type` - Type of constraint. Valid values are `LAUNCH`, `NOTIFICATION`, `STACKSET`, and `TEMPLATE`. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/servicecatalog_product.html.markdown b/website/docs/cdktf/typescript/d/servicecatalog_product.html.markdown index 9935e6f35b67..f16a022cf741 100644 --- a/website/docs/cdktf/typescript/d/servicecatalog_product.html.markdown +++ b/website/docs/cdktf/typescript/d/servicecatalog_product.html.markdown @@ -46,6 +46,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `acceptLanguage` - (Optional) Language code. Valid values are `en` (English), `jp` (Japanese), `zh` (Chinese). The default value is `en`. ## Attribute Reference @@ -66,4 +67,4 @@ This data source exports the following attributes in addition to the arguments a * `tags` - Tags applied to the product. * `type` - Type of product. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/servicecatalog_provisioning_artifacts.html.markdown b/website/docs/cdktf/typescript/d/servicecatalog_provisioning_artifacts.html.markdown index f16c6f666688..7f1a3221bcb0 100644 --- a/website/docs/cdktf/typescript/d/servicecatalog_provisioning_artifacts.html.markdown +++ b/website/docs/cdktf/typescript/d/servicecatalog_provisioning_artifacts.html.markdown @@ -44,6 +44,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `acceptLanguage` - (Optional) Language code. Valid values: `en` (English), `jp` (Japanese), `zh` (Chinese). Default value is `en`. ## Attribute Reference @@ -62,4 +63,4 @@ This data source exports the following attributes in addition to the arguments a * `name` - The name of the provisioning artifact. * `type` - The type of provisioning artifact. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/servicecatalogappregistry_application.html.markdown b/website/docs/cdktf/typescript/d/servicecatalogappregistry_application.html.markdown index c46ea5f722a4..6d3276788ec6 100644 --- a/website/docs/cdktf/typescript/d/servicecatalogappregistry_application.html.markdown +++ b/website/docs/cdktf/typescript/d/servicecatalogappregistry_application.html.markdown @@ -38,8 +38,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `id` - (Required) Application identifier. ## Attribute Reference @@ -52,4 +53,4 @@ This data source exports the following attributes in addition to the arguments a * `name` - Name of the application. * `tags` - A map of tags assigned to the Application. If configured with a provider [`defaultTags` 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. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/servicecatalogappregistry_attribute_group.html.markdown b/website/docs/cdktf/typescript/d/servicecatalogappregistry_attribute_group.html.markdown index e172bea9faa3..fcc527342833 100644 --- a/website/docs/cdktf/typescript/d/servicecatalogappregistry_attribute_group.html.markdown +++ b/website/docs/cdktf/typescript/d/servicecatalogappregistry_attribute_group.html.markdown @@ -24,7 +24,7 @@ import { TerraformStack } from "cdktf"; * Provider bindings are generated by running `cdktf get`. * See https://cdk.tf/provider-generation for more details. */ -import { DataAwsServicecatalogappregistryAttributeGroup } from "./.gen/providers/aws/"; +import { DataAwsServicecatalogappregistryAttributeGroup } from "./.gen/providers/aws/data-aws-servicecatalogappregistry-attribute-group"; class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); @@ -40,8 +40,8 @@ class MyConvertedCode extends TerraformStack { The following arguments are optional: +* `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). ~> Exactly one of `arn`, `id`, or `name` must be set. - * `arn` - (Optional) ARN of the Attribute Group to find. * `id` - (Optional) ID of the Attribute Group to find. * `name` - (Optional) Name of the Attribute Group to find. @@ -54,4 +54,4 @@ This data source exports the following attributes in addition to the arguments a * `description` - Description of the Attribute Group. * `tags` - A map of tags assigned to the Attribute Group. If configured with a provider [`defaultTags` 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. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/servicecatalogappregistry_attribute_group_associations.html.markdown b/website/docs/cdktf/typescript/d/servicecatalogappregistry_attribute_group_associations.html.markdown index b0d375b99c62..10de9a3e5aff 100644 --- a/website/docs/cdktf/typescript/d/servicecatalogappregistry_attribute_group_associations.html.markdown +++ b/website/docs/cdktf/typescript/d/servicecatalogappregistry_attribute_group_associations.html.markdown @@ -44,17 +44,15 @@ class MyConvertedCode extends TerraformStack { The following arguments are optional: +* `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). ~> Exactly one of `id`or `name` must be set. - * `id` - (Optional) ID of the application to which attribute groups are associated. * `name` - (Optional) Name of the application to which attribute groups are associated. -The following arguments are optional: - ## Attribute Reference This data source exports the following attributes in addition to the arguments above: * `attributeGroupIds` - Set of attribute group IDs this application is associated with. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/servicequotas_service.html.markdown b/website/docs/cdktf/typescript/d/servicequotas_service.html.markdown index cee21b40def0..b011ed356145 100644 --- a/website/docs/cdktf/typescript/d/servicequotas_service.html.markdown +++ b/website/docs/cdktf/typescript/d/servicequotas_service.html.markdown @@ -40,6 +40,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `serviceName` - (Required) Service name to lookup within Service Quotas. Available values can be found with the [AWS CLI service-quotas list-services command](https://docs.aws.amazon.com/cli/latest/reference/service-quotas/list-services.html). ## Attribute Reference @@ -49,4 +50,4 @@ This data source exports the following attributes in addition to the arguments a * `id` - Code of the service. * `serviceCode` - Code of the service. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/servicequotas_service_quota.html.markdown b/website/docs/cdktf/typescript/d/servicequotas_service_quota.html.markdown index 6983a6f5434a..c7bff1ecf0a7 100644 --- a/website/docs/cdktf/typescript/d/servicequotas_service_quota.html.markdown +++ b/website/docs/cdktf/typescript/d/servicequotas_service_quota.html.markdown @@ -45,6 +45,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `serviceCode` - (Required) Service code for the quota. Available values can be found with the [`aws_servicequotas_service` data source](/docs/providers/aws/d/servicequotas_service.html) or [AWS CLI service-quotas list-services command](https://docs.aws.amazon.com/cli/latest/reference/service-quotas/list-services.html). * `quotaCode` - (Optional) Quota code within the service. When configured, the data source directly looks up the service quota. Available values can be found with the [AWS CLI service-quotas list-service-quotas command](https://docs.aws.amazon.com/cli/latest/reference/service-quotas/list-service-quotas.html). One of `quotaCode` or `quotaName` must be specified. * `quotaName` - (Optional) Quota name within the service. When configured, the data source searches through all service quotas to find the matching quota name. Available values can be found with the [AWS CLI service-quotas list-service-quotas command](https://docs.aws.amazon.com/cli/latest/reference/service-quotas/list-service-quotas.html). One of `quotaName` or `quotaCode` must be specified. @@ -72,4 +73,4 @@ This data source exports the following attributes in addition to the arguments a * `metric_statistic_recommendation` - The metric statistic that AWS recommend you use when determining quota usage. * `value` - Current value of the service quota. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/servicequotas_templates.html.markdown b/website/docs/cdktf/typescript/d/servicequotas_templates.html.markdown index 68a122b6b68e..68c1099a4986 100644 --- a/website/docs/cdktf/typescript/d/servicequotas_templates.html.markdown +++ b/website/docs/cdktf/typescript/d/servicequotas_templates.html.markdown @@ -3,14 +3,14 @@ subcategory: "Service Quotas" layout: "aws" page_title: "AWS: aws_servicequotas_templates" description: |- - Terraform data source for managing an AWS Service Quotas Templates. + Terraform data source for managing AWS Service Quotas Templates. --- # Data Source: aws_servicequotas_templates -Terraform data source for managing an AWS Service Quotas Templates. +Terraform data source for managing AWS Service Quotas Templates. ## Example Usage @@ -29,7 +29,7 @@ class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); new DataAwsServicequotasTemplates(this, "example", { - region: "us-east-1", + awsRegion: "us-east-1", }); } } @@ -38,9 +38,10 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This data source supports the following arguments: -* `region` - (Required) AWS Region to which the quota increases apply. +* `awsRegion` - (Optional) AWS Region to which the quota increases apply. +* `region` - (Optional, **Deprecated**) AWS Region to which the quota increases apply. Use `awsRegion` instead. ## Attribute Reference @@ -54,9 +55,9 @@ This data source exports the following attributes in addition to the arguments a * `quotaName` - Quota name. * `quotaCode` - Quota identifier. * `region` - AWS Region to which the template applies. -* `serviceCode` - (Required) Service identifier. +* `serviceCode` - Service identifier. * `serviceName` - Service name. * `unit` - Unit of measurement. -* `value` - (Required) The new, increased value for the quota. +* `value` - The new, increased value for the quota. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/ses_active_receipt_rule_set.html.markdown b/website/docs/cdktf/typescript/d/ses_active_receipt_rule_set.html.markdown index e0dc6f4db4e7..600f12cbef37 100644 --- a/website/docs/cdktf/typescript/d/ses_active_receipt_rule_set.html.markdown +++ b/website/docs/cdktf/typescript/d/ses_active_receipt_rule_set.html.markdown @@ -34,7 +34,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -This data source does not support any arguments. +This data source supports the following arguments: + +* `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). ## Attribute Reference @@ -43,4 +45,4 @@ This data source exports the following attributes in addition to the arguments a * `arn` - SES receipt rule set ARN. * `ruleSetName` - Name of the rule set - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/ses_domain_identity.html.markdown b/website/docs/cdktf/typescript/d/ses_domain_identity.html.markdown index 22de846a930a..0dfcac51c131 100644 --- a/website/docs/cdktf/typescript/d/ses_domain_identity.html.markdown +++ b/website/docs/cdktf/typescript/d/ses_domain_identity.html.markdown @@ -36,7 +36,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -This data source does not support any arguments. +This data source supports the following arguments: + +* `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). ## Attribute Reference @@ -46,4 +48,4 @@ This data source exports the following attributes in addition to the arguments a * `domain` - Name of the domain * `verificationToken` - Code which when added to the domain as a TXT record will signal to SES that the owner of the domain has authorized SES to act on their behalf. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/ses_email_identity.html.markdown b/website/docs/cdktf/typescript/d/ses_email_identity.html.markdown index 1b00dbb5ce3f..502da3c0099d 100644 --- a/website/docs/cdktf/typescript/d/ses_email_identity.html.markdown +++ b/website/docs/cdktf/typescript/d/ses_email_identity.html.markdown @@ -36,7 +36,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -This data source does not support any arguments. +This data source supports the following arguments: + +* `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). ## Attribute Reference @@ -45,4 +47,4 @@ This data source exports the following attributes in addition to the arguments a * `arn` - The ARN of the email identity. * `email` - Email identity. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/sesv2_configuration_set.html.markdown b/website/docs/cdktf/typescript/d/sesv2_configuration_set.html.markdown index c699597f8d7a..e0238f100580 100644 --- a/website/docs/cdktf/typescript/d/sesv2_configuration_set.html.markdown +++ b/website/docs/cdktf/typescript/d/sesv2_configuration_set.html.markdown @@ -38,8 +38,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `configurationSetName` - (Required) The name of the configuration set. ## Attribute Reference @@ -67,4 +68,4 @@ This data source exports the following attributes in addition to the arguments a * `guardianOptions` - Specifies additional settings for your VDM configuration as applicable to the Guardian. * `optimizedSharedDelivery` - Specifies the status of your VDM optimized shared delivery. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/sesv2_dedicated_ip_pool.html.markdown b/website/docs/cdktf/typescript/d/sesv2_dedicated_ip_pool.html.markdown index 9b9141f3b497..dfcaaabbe1aa 100644 --- a/website/docs/cdktf/typescript/d/sesv2_dedicated_ip_pool.html.markdown +++ b/website/docs/cdktf/typescript/d/sesv2_dedicated_ip_pool.html.markdown @@ -38,8 +38,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `poolName` - (Required) Name of the dedicated IP pool. ## Attribute Reference @@ -57,4 +58,4 @@ This data source exports the following attributes in addition to the arguments a * `warmup_percentage` - Indicates how complete the dedicated IP warm-up process is. When this value equals `1`, the address has completed the warm-up process and is ready for use. * `warmup_status` - The warm-up status of a dedicated IP address. Valid values: `IN_PROGRESS`, `DONE`. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/sesv2_email_identity.html.markdown b/website/docs/cdktf/typescript/d/sesv2_email_identity.html.markdown index 83c6e865a321..9c541dd97915 100644 --- a/website/docs/cdktf/typescript/d/sesv2_email_identity.html.markdown +++ b/website/docs/cdktf/typescript/d/sesv2_email_identity.html.markdown @@ -38,8 +38,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `emailIdentity` - (Required) The name of the email identity. ## Attribute Reference @@ -56,6 +57,7 @@ This data source exports the following attributes in addition to the arguments a * `tokens` - If you used Easy DKIM to configure DKIM authentication for the domain, then this object contains a set of unique strings that you use to create a set of CNAME records that you add to the DNS configuration for your domain. When Amazon SES detects these records in the DNS configuration for your domain, the DKIM authentication process is complete. If you configured DKIM authentication for the domain by providing your own public-private key pair, then this object contains the selector for the public key. * `identityType` - The email identity type. Valid values: `EMAIL_ADDRESS`, `DOMAIN`. * `tags` - Key-value mapping of resource tags. +* `verificationStatus` - The verification status of the identity. The status can be one of the following: `PENDING`, `SUCCESS`, `FAILED`, `TEMPORARY_FAILURE`, and `NOT_STARTED`. * `verifiedForSendingStatus` - Specifies whether or not the identity is verified. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/sesv2_email_identity_mail_from_attributes.html.markdown b/website/docs/cdktf/typescript/d/sesv2_email_identity_mail_from_attributes.html.markdown index 5af89e241adb..0f96083e28fe 100644 --- a/website/docs/cdktf/typescript/d/sesv2_email_identity_mail_from_attributes.html.markdown +++ b/website/docs/cdktf/typescript/d/sesv2_email_identity_mail_from_attributes.html.markdown @@ -47,8 +47,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `emailIdentity` - (Required) The name of the email identity. ## Attribute Reference @@ -58,4 +59,4 @@ This data source exports the following attributes in addition to the arguments a * `behaviorOnMxFailure` - The action to take if the required MX record isn't found when you send an email. Valid values: `USE_DEFAULT_VALUE`, `REJECT_MESSAGE`. * `mailFromDomain` - The custom MAIL FROM domain that you want the verified identity to use. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/sfn_activity.html.markdown b/website/docs/cdktf/typescript/d/sfn_activity.html.markdown index d025bf73dfb9..c5656dbb0ed2 100644 --- a/website/docs/cdktf/typescript/d/sfn_activity.html.markdown +++ b/website/docs/cdktf/typescript/d/sfn_activity.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `name` - (Optional) Name that identifies the activity. * `arn` - (Optional) ARN that identifies the activity. @@ -48,4 +49,4 @@ This data source exports the following attributes in addition to the arguments a * `id` - ARN that identifies the activity. * `creationDate` - Date the activity was created. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/sfn_alias.html.markdown b/website/docs/cdktf/typescript/d/sfn_alias.html.markdown index 86cbffa58e9f..b5f04cf3cbbd 100644 --- a/website/docs/cdktf/typescript/d/sfn_alias.html.markdown +++ b/website/docs/cdktf/typescript/d/sfn_alias.html.markdown @@ -39,8 +39,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `name` - (Required) Name of the State Machine alias. * `statemachineArn` - (Required) ARN of the State Machine. @@ -53,4 +54,4 @@ This data source exports the following attributes in addition to the arguments a * `description` - Description of state machine alias. * `routingConfiguration` - Routing Configuration of state machine alias - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/sfn_state_machine.html.markdown b/website/docs/cdktf/typescript/d/sfn_state_machine.html.markdown index 485d6077cc9f..8e1f2c214c22 100644 --- a/website/docs/cdktf/typescript/d/sfn_state_machine.html.markdown +++ b/website/docs/cdktf/typescript/d/sfn_state_machine.html.markdown @@ -40,6 +40,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `name` - (Required) Friendly name of the state machine to match. ## Attribute Reference @@ -54,4 +55,4 @@ This data source exports the following attributes in addition to the arguments a * `revisionId` - The revision identifier for the state machine. * `status` - Set to the current status of the state machine. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/sfn_state_machine_versions.html.markdown b/website/docs/cdktf/typescript/d/sfn_state_machine_versions.html.markdown index efb7974bb9bb..21bed36f5906 100644 --- a/website/docs/cdktf/typescript/d/sfn_state_machine_versions.html.markdown +++ b/website/docs/cdktf/typescript/d/sfn_state_machine_versions.html.markdown @@ -38,8 +38,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `statemachineArn` - (Required) ARN of the State Machine. ## Attribute Reference @@ -48,4 +49,4 @@ This data source exports the following attributes in addition to the arguments a * `statemachineVersions` - ARN List identifying the statemachine versions. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/signer_signing_job.html.markdown b/website/docs/cdktf/typescript/d/signer_signing_job.html.markdown index fda77f152177..a0a7381dcf31 100644 --- a/website/docs/cdktf/typescript/d/signer_signing_job.html.markdown +++ b/website/docs/cdktf/typescript/d/signer_signing_job.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `jobId` - (Required) ID of the signing job on output. ## Attribute Reference @@ -60,4 +61,4 @@ This data source exports the following attributes in addition to the arguments a * `status` - Status of the signing job. * `statusReason` - String value that contains the status reason. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/signer_signing_profile.html.markdown b/website/docs/cdktf/typescript/d/signer_signing_profile.html.markdown index 6b8ba0a1a8da..c844e0f86f91 100644 --- a/website/docs/cdktf/typescript/d/signer_signing_profile.html.markdown +++ b/website/docs/cdktf/typescript/d/signer_signing_profile.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `name` - (Required) Name of the target signing profile. ## Attribute Reference @@ -49,9 +50,12 @@ This data source exports the following attributes in addition to the arguments a * `platformId` - ID of the platform that is used by the target signing profile. * `revocationRecord` - Revocation information for a signing profile. * `signatureValidityPeriod` - The validity period for a signing job. +* `signingMaterial` - AWS Certificate Manager certificate that will be used to sign code with the new signing profile. + * `certificateArn` - ARN of the certificate used for signing. +* `signing_parameters` - Map of key-value pairs for signing. * `status` - Status of the target signing profile. * `tags` - List of tags associated with the signing profile. * `version` - Current version of the signing profile. * `versionArn` - Signing profile ARN, including the profile version. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/sns_topic.html.markdown b/website/docs/cdktf/typescript/d/sns_topic.html.markdown index 5cfe135a915b..6edce2cc23f7 100644 --- a/website/docs/cdktf/typescript/d/sns_topic.html.markdown +++ b/website/docs/cdktf/typescript/d/sns_topic.html.markdown @@ -40,6 +40,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `name` - (Required) Friendly name of the topic to match. ## Attribute Reference @@ -50,4 +51,4 @@ This data source exports the following attributes in addition to the arguments a * `id` - ARN of the found topic, suitable for referencing in other resources that support SNS topics. * `tags` - Map of tags for the resource. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/spot_datafeed_subscription.html.markdown b/website/docs/cdktf/typescript/d/spot_datafeed_subscription.html.markdown index aa2598ac7859..a2931894d1ba 100644 --- a/website/docs/cdktf/typescript/d/spot_datafeed_subscription.html.markdown +++ b/website/docs/cdktf/typescript/d/spot_datafeed_subscription.html.markdown @@ -36,7 +36,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -This data source does not support any arguments. +This data source supports the following arguments: + +* `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). ## Attribute Reference @@ -45,4 +47,4 @@ This data source exports the following attributes in addition to the arguments a * `bucket` - The name of the Amazon S3 bucket where the spot instance data feed is located. * `prefix` - The prefix for the data feed files. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/sqs_queue.html.markdown b/website/docs/cdktf/typescript/d/sqs_queue.html.markdown index e39c73d1e2ee..fb0383ed28f2 100644 --- a/website/docs/cdktf/typescript/d/sqs_queue.html.markdown +++ b/website/docs/cdktf/typescript/d/sqs_queue.html.markdown @@ -42,6 +42,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `name` - (Required) Name of the queue to match. ## Attribute Reference @@ -52,4 +53,4 @@ This data source exports the following attributes in addition to the arguments a * `url` - URL of the queue. * `tags` - Map of tags for the resource. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/sqs_queues.html.markdown b/website/docs/cdktf/typescript/d/sqs_queues.html.markdown index 93dea812b21d..d59566613cb7 100644 --- a/website/docs/cdktf/typescript/d/sqs_queues.html.markdown +++ b/website/docs/cdktf/typescript/d/sqs_queues.html.markdown @@ -40,6 +40,7 @@ class MyConvertedCode extends TerraformStack { The following arguments are optional: +* `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). * `queueNamePrefix` - (Optional) A string to use for filtering the list results. Only those queues whose name begins with the specified string are returned. Queue URLs and names are case-sensitive. ## Attribute Reference @@ -48,4 +49,4 @@ This data source exports the following attributes in addition to the arguments a * `queueUrls` - A list of queue URLs. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/ssm_document.html.markdown b/website/docs/cdktf/typescript/d/ssm_document.html.markdown index 663cc9eb8e27..8f1ae18b9f8b 100644 --- a/website/docs/cdktf/typescript/d/ssm_document.html.markdown +++ b/website/docs/cdktf/typescript/d/ssm_document.html.markdown @@ -67,6 +67,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `name` - (Required) The name of the document. * `documentFormat` - The format of the document. Valid values: `JSON`, `TEXT`, `YAML`. * `documentVersion` - The document version. @@ -79,4 +80,4 @@ This data source exports the following attributes in addition to the arguments a * `content` - The content for the SSM document in JSON or YAML format. * `documentType` - The type of the document. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/ssm_instances.html.markdown b/website/docs/cdktf/typescript/d/ssm_instances.html.markdown index e530a80b4a7e..c654f420c468 100644 --- a/website/docs/cdktf/typescript/d/ssm_instances.html.markdown +++ b/website/docs/cdktf/typescript/d/ssm_instances.html.markdown @@ -43,6 +43,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `filter` - (Optional) Configuration block(s) for filtering. Detailed below. ### filter Configuration Block @@ -58,4 +59,4 @@ This data source exports the following attributes in addition to the arguments a * `ids` - Set of instance IDs of the matched SSM managed instances. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/ssm_maintenance_windows.html.markdown b/website/docs/cdktf/typescript/d/ssm_maintenance_windows.html.markdown index 733089e5e5a2..fbffef0caeb1 100644 --- a/website/docs/cdktf/typescript/d/ssm_maintenance_windows.html.markdown +++ b/website/docs/cdktf/typescript/d/ssm_maintenance_windows.html.markdown @@ -43,6 +43,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `filter` - (Optional) Configuration block(s) for filtering. Detailed below. ### filter Configuration Block @@ -58,4 +59,4 @@ This data source exports the following attributes in addition to the arguments a * `ids` - List of window IDs of the matched SSM maintenance windows. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/ssm_parameter.html.markdown b/website/docs/cdktf/typescript/d/ssm_parameter.html.markdown index d91007d40168..551ba2fea512 100644 --- a/website/docs/cdktf/typescript/d/ssm_parameter.html.markdown +++ b/website/docs/cdktf/typescript/d/ssm_parameter.html.markdown @@ -43,6 +43,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `name` - (Required) Name of the parameter. * `withDecryption` - (Optional) Whether to return decrypted `SecureString` value. Defaults to `true`. @@ -57,4 +58,4 @@ This data source exports the following attributes in addition to the arguments a * `insecureValue` - Value of the parameter. **Use caution:** This value is never marked as sensitive. * `version` - Version of the parameter. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/ssm_parameters_by_path.html.markdown b/website/docs/cdktf/typescript/d/ssm_parameters_by_path.html.markdown index 1a2557920726..7255614d70bc 100644 --- a/website/docs/cdktf/typescript/d/ssm_parameters_by_path.html.markdown +++ b/website/docs/cdktf/typescript/d/ssm_parameters_by_path.html.markdown @@ -42,6 +42,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `path` - (Required) The hierarchy for the parameter. Hierarchies start with a forward slash (/). The hierarchy is the parameter name except the last part of the parameter. The last part of the parameter name can't be in the path. A parameter name hierarchy can have a maximum of 15 levels. **Note:** If the parameter name (e.g., `/my-app/my-param`) is specified, the data source will not retrieve any value as designed, unless there are other parameters that happen to use the former path in their hierarchy (e.g., `/my-app/my-param/my-actual-param`). * `withDecryption` - (Optional) Whether to retrieve all parameters in the hierarchy, particularly those of `SecureString` type, with their value decrypted. Defaults to `true`. * `recursive` - (Optional) Whether to retrieve all parameters within the hirerachy. Defaults to `false`. @@ -55,4 +56,4 @@ This data source exports the following attributes in addition to the arguments a * `types` - A list that contains the types (`String`, `StringList`, or `SecureString`) of retrieved parameters. * `values` - A list that contains the retrieved parameter values. **Note:** This value is always marked as sensitive in the Terraform plan output, regardless of whether any retrieved parameters are of `SecureString` type. Use the [`nonsensitive` function](https://developer.hashicorp.com/terraform/language/functions/nonsensitive) to override the behavior at your own risk and discretion, if you are certain that there are no sensitive values being retrieved. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/ssm_patch_baseline.html.markdown b/website/docs/cdktf/typescript/d/ssm_patch_baseline.html.markdown index 3755fb7022a2..3e8fb7c70127 100644 --- a/website/docs/cdktf/typescript/d/ssm_patch_baseline.html.markdown +++ b/website/docs/cdktf/typescript/d/ssm_patch_baseline.html.markdown @@ -71,6 +71,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `defaultBaseline` - (Optional) Filters the results against the baselines default_baseline field. * `namePrefix` - (Optional) Filter results by the baseline name prefix. * `operatingSystem` - (Optional) Specified OS for the baseline. Valid values: `AMAZON_LINUX`, `AMAZON_LINUX_2`, `UBUNTU`, `REDHAT_ENTERPRISE_LINUX`, `SUSE`, `CENTOS`, `ORACLE_LINUX`, `DEBIAN`, `MACOS`, `RASPBIAN` and `ROCKY_LINUX`. @@ -90,6 +91,7 @@ This data source exports the following attributes in addition to the arguments a * `patchFilter` - Patch filter group that defines the criteria for the rule. * `key` - Key for the filter. * `values` - Value for the filter. +* `availableSecurityUpdatesComplianceStatus` - Indicates the compliance status of managed nodes for which security-related patches are available but were not approved. Supported for Windows Server managed nodes only. * `globalFilter` - Set of global filters used to exclude patches from the baseline. * `key` - Key for the filter. * `values` - Value for the filter. @@ -104,4 +106,4 @@ This data source exports the following attributes in addition to the arguments a * `name` - Name specified to identify the patch source. * `products` - Specific operating system versions a patch repository applies to. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/ssm_patch_baselines.html.markdown b/website/docs/cdktf/typescript/d/ssm_patch_baselines.html.markdown index d311aafed477..a0465d0e515a 100644 --- a/website/docs/cdktf/typescript/d/ssm_patch_baselines.html.markdown +++ b/website/docs/cdktf/typescript/d/ssm_patch_baselines.html.markdown @@ -24,7 +24,7 @@ import { TerraformStack } from "cdktf"; * Provider bindings are generated by running `cdktf get`. * See https://cdk.tf/provider-generation for more details. */ -import { DataAwsSsmPatchBaselines } from "./.gen/providers/aws/"; +import { DataAwsSsmPatchBaselines } from "./.gen/providers/aws/data-aws-ssm-patch-baselines"; class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); @@ -44,7 +44,7 @@ import { TerraformStack } from "cdktf"; * Provider bindings are generated by running `cdktf get`. * See https://cdk.tf/provider-generation for more details. */ -import { DataAwsSsmPatchBaselines } from "./.gen/providers/aws/"; +import { DataAwsSsmPatchBaselines } from "./.gen/providers/aws/data-aws-ssm-patch-baselines"; class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); @@ -69,8 +69,9 @@ class MyConvertedCode extends TerraformStack { The following arguments are optional: +* `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). * `filter` - (Optional) Key-value pairs used to filter the results. See [`filter`](#filter-argument-reference) below. -* `default_baselines` - (Optional) Only return baseline identities where `defaultBaseline` is `true`. +* `defaultBaselines` - (Optional) Only return baseline identities where `defaultBaseline` is `true`. ### `filter` Argument Reference @@ -81,9 +82,9 @@ The following arguments are optional: This data source exports the following attributes in addition to the arguments above: -* `baseline_identities` - List of baseline identities. See [`baseline_identities`](#baseline_identities-attribute-reference) below. +* `baselineIdentities` - List of baseline identities. See [`baselineIdentities`](#baseline_identities-attribute-reference) below. -### `baseline_identities` Attribute Reference +### `baselineIdentities` Attribute Reference * `baseline_description` - Description of the patch baseline. * `baselineId` - ID of the patch baseline. @@ -91,4 +92,4 @@ This data source exports the following attributes in addition to the arguments a * `defaultBaseline` - Indicates whether this is the default baseline. AWS Systems Manager supports creating multiple default patch baselines. For example, you can create a default patch baseline for each operating system. * `operatingSystem` - Operating system the patch baseline applies to. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/ssmcontacts_contact.html.markdown b/website/docs/cdktf/typescript/d/ssmcontacts_contact.html.markdown index 3fd7f1d17ca8..1507558c6ca4 100644 --- a/website/docs/cdktf/typescript/d/ssmcontacts_contact.html.markdown +++ b/website/docs/cdktf/typescript/d/ssmcontacts_contact.html.markdown @@ -38,8 +38,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `arn` - (Required) The Amazon Resource Name (ARN) of the contact or escalation plan. ## Attribute Reference @@ -51,4 +52,4 @@ This data source exports the following attributes in addition to the arguments a * `displayName` - Full friendly name of the contact or escalation plan. * `tags` - Map of tags to assign to the resource. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/ssmcontacts_contact_channel.html.markdown b/website/docs/cdktf/typescript/d/ssmcontacts_contact_channel.html.markdown index c811d2d34df0..30ef00d3b55d 100644 --- a/website/docs/cdktf/typescript/d/ssmcontacts_contact_channel.html.markdown +++ b/website/docs/cdktf/typescript/d/ssmcontacts_contact_channel.html.markdown @@ -38,8 +38,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +- `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). - `arn` - Amazon Resource Name (ARN) of the contact channel. ## Attribute Reference @@ -47,13 +48,9 @@ The following arguments are required: This data source exports the following attributes in addition to the arguments above: - `activationStatus` - Whether the contact channel is activated. - - `contactId` - Amazon Resource Name (ARN) of the AWS SSM Contact that the contact channel belongs to. - - `deliveryAddress` - Details used to engage the contact channel. - - `name` - Name of the contact channel. - - `type` - Type of the contact channel. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/ssmcontacts_plan.html.markdown b/website/docs/cdktf/typescript/d/ssmcontacts_plan.html.markdown index 2aae4f5db13c..d270c7201cfb 100644 --- a/website/docs/cdktf/typescript/d/ssmcontacts_plan.html.markdown +++ b/website/docs/cdktf/typescript/d/ssmcontacts_plan.html.markdown @@ -39,8 +39,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `contactId` - (Required) The Amazon Resource Name (ARN) of the contact or escalation plan. ## Attribute Reference @@ -49,4 +50,4 @@ This data source exports the following attributes in addition to the arguments a * `stage` - List of stages. A contact has an engagement plan with stages that contact specified contact channels. An escalation plan uses stages that contact specified contacts. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/ssmcontacts_rotation.html.markdown b/website/docs/cdktf/typescript/d/ssmcontacts_rotation.html.markdown index b9f66930be4e..b57559e5a1e2 100644 --- a/website/docs/cdktf/typescript/d/ssmcontacts_rotation.html.markdown +++ b/website/docs/cdktf/typescript/d/ssmcontacts_rotation.html.markdown @@ -38,8 +38,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `arn` - (Required) The Amazon Resource Name (ARN) of the rotation. ## Attribute Reference @@ -53,4 +54,4 @@ This data source exports the following attributes in addition to the arguments a * `startTime` - The date and time, in RFC 3339 format, that the rotation goes into effect. * `tags` - A map of tags to assign to the resource. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/ssmincidents_replication_set.html.markdown b/website/docs/cdktf/typescript/d/ssmincidents_replication_set.html.markdown index 07d681b4a294..277c7bd00150 100644 --- a/website/docs/cdktf/typescript/d/ssmincidents_replication_set.html.markdown +++ b/website/docs/cdktf/typescript/d/ssmincidents_replication_set.html.markdown @@ -45,14 +45,16 @@ This data source does not support any arguments. This data source exports the following attributes in addition to the arguments above: * `arn` - The Amazon Resource Name (ARN) of the replication set. -* `tags` - All tags applied to the replication set. * `createdBy` - The ARN of the user who created the replication set. * `deletionProtected` - If `true`, the last remaining Region in a replication set can’t be deleted. * `lastModifiedBy` - The ARN of the user who last modified the replication set. +* `region` - (**Deprecated**) The replication set's Regions. Use `regions` instead. +* `regions` - The replication set's Regions. * `status` - The overall status of a replication set. * Valid Values: `ACTIVE` | `CREATING` | `UPDATING` | `DELETING` | `FAILED` +* `tags` - All tags applied to the replication set. -The `region` configuration block exports the following attributes for each Region: +The `regions` configuration block exports the following attributes for each Region: * `name` - The name of the Region. * `kmsKeyArn` - The ARN of the AWS Key Management Service (AWS KMS) encryption key. @@ -60,4 +62,4 @@ The `region` configuration block exports the following attributes for each Regio * Valid Values: `ACTIVE` | `CREATING` | `UPDATING` | `DELETING` | `FAILED` * `statusMessage` - More information about the status of a Region. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/ssmincidents_response_plan.html.markdown b/website/docs/cdktf/typescript/d/ssmincidents_response_plan.html.markdown index 8b149f69a133..db4fa4f0bb03 100644 --- a/website/docs/cdktf/typescript/d/ssmincidents_response_plan.html.markdown +++ b/website/docs/cdktf/typescript/d/ssmincidents_response_plan.html.markdown @@ -44,8 +44,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `arn` - (Required) The Amazon Resource Name (ARN) of the response plan. ## Attribute Reference @@ -94,4 +95,4 @@ The `integration` configuration block exports the following attributes: * `serviceId` - The ID of the PagerDuty service that the response plan associates with an incident when it launches. * `secretId` - The ID of the AWS Secrets Manager secret that stores your PagerDuty key — either a General Access REST API Key or User Token REST API Key — and other user credentials. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/ssoadmin_application.html.markdown b/website/docs/cdktf/typescript/d/ssoadmin_application.html.markdown index 72caad15782b..2f3bf6a98638 100644 --- a/website/docs/cdktf/typescript/d/ssoadmin_application.html.markdown +++ b/website/docs/cdktf/typescript/d/ssoadmin_application.html.markdown @@ -39,8 +39,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `applicationArn` - (Required) ARN of the application. ## Attribute Reference @@ -56,4 +57,4 @@ This data source exports the following attributes in addition to the arguments a * `portalOptions` - Options for the portal associated with an application. See the `aws_ssoadmin_application` [resource documentation](../r/ssoadmin_application.html.markdown#portal_options-argument-reference). The attributes are the same. * `status` - Status of the application. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/ssoadmin_application_assignments.html.markdown b/website/docs/cdktf/typescript/d/ssoadmin_application_assignments.html.markdown index 4d60bf27bad2..b114d4dca311 100644 --- a/website/docs/cdktf/typescript/d/ssoadmin_application_assignments.html.markdown +++ b/website/docs/cdktf/typescript/d/ssoadmin_application_assignments.html.markdown @@ -29,9 +29,7 @@ class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); new DataAwsSsoadminApplicationAssignments(this, "example", { - applicationArn: Token.asString( - awsSsoadminApplicationExample.applicationArn - ), + applicationArn: Token.asString(awsSsoadminApplicationExample.arn), }); } } @@ -40,8 +38,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `applicationArn` - (Required) ARN of the application. ## Attribute Reference @@ -56,4 +55,4 @@ This data source exports the following attributes in addition to the arguments a * `principalId` - An identifier for an object in IAM Identity Center, such as a user or group. * `principalType` - Entity type for which the assignment will be created. Valid values are `USER` or `GROUP`. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/ssoadmin_application_providers.html.markdown b/website/docs/cdktf/typescript/d/ssoadmin_application_providers.html.markdown index ce66c404be95..d516075c36a9 100644 --- a/website/docs/cdktf/typescript/d/ssoadmin_application_providers.html.markdown +++ b/website/docs/cdktf/typescript/d/ssoadmin_application_providers.html.markdown @@ -36,7 +36,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -This data source does not support any arguments. +This data source supports the following arguments: + +* `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). ## Attribute Reference @@ -48,13 +50,13 @@ This data source exports the following attributes in addition to the arguments a ### `applicationProviders` Attribute Reference * `applicationProviderArn` - ARN of the application provider. -* `displayData` - An object describing how IAM Identity Center represents the application provider in the portal. See [`displayData`](#display_data-attribute-reference) below. -* `federationProtocol` - Protocol that the application provider uses to perform federation. Valid values are `SAML` and `OAUTH`. +* `display_data` - An object describing how IAM Identity Center represents the application provider in the portal. See [`display_data`](#display_data-attribute-reference) below. +* `federation_protocol` - Protocol that the application provider uses to perform federation. Valid values are `SAML` and `OAUTH`. -### `displayData` Attribute Reference +### `display_data` Attribute Reference * `description` - Description of the application provider. * `displayName` - Name of the application provider. -* `iconUrl` - URL that points to an icon that represents the application provider. +* `icon_url` - URL that points to an icon that represents the application provider. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/ssoadmin_instances.html.markdown b/website/docs/cdktf/typescript/d/ssoadmin_instances.html.markdown index e46d1ee9c26b..07b2bce1c2b1 100644 --- a/website/docs/cdktf/typescript/d/ssoadmin_instances.html.markdown +++ b/website/docs/cdktf/typescript/d/ssoadmin_instances.html.markdown @@ -40,7 +40,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -This data source does not support any arguments. +This data source supports the following arguments: + +* `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). ## Attribute Reference @@ -50,4 +52,4 @@ This data source exports the following attributes in addition to the arguments a * `id` - AWS Region. * `identityStoreIds` - Set of identifiers of the identity stores connected to the SSO Instances. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/ssoadmin_permission_set.html.markdown b/website/docs/cdktf/typescript/d/ssoadmin_permission_set.html.markdown index 0c1ff1d32579..d30b9ab11eff 100644 --- a/website/docs/cdktf/typescript/d/ssoadmin_permission_set.html.markdown +++ b/website/docs/cdktf/typescript/d/ssoadmin_permission_set.html.markdown @@ -49,12 +49,13 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: -~> **NOTE:** Either `arn` or `name` must be configured. - +* `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). * `arn` - (Optional) ARN of the permission set. * `instanceArn` - (Required) ARN of the SSO Instance associated with the permission set. * `name` - (Optional) Name of the SSO Permission Set. +~> **NOTE:** Either `arn` or `name` must be configured. + ## Attribute Reference This data source exports the following attributes in addition to the arguments above: @@ -65,4 +66,4 @@ This data source exports the following attributes in addition to the arguments a * `sessionDuration` - Length of time that the application user sessions are valid in the ISO-8601 standard. * `tags` - Key-value map of resource tags. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/ssoadmin_permission_sets.html.markdown b/website/docs/cdktf/typescript/d/ssoadmin_permission_sets.html.markdown index 3ec70fc910be..c218250c6bac 100644 --- a/website/docs/cdktf/typescript/d/ssoadmin_permission_sets.html.markdown +++ b/website/docs/cdktf/typescript/d/ssoadmin_permission_sets.html.markdown @@ -45,8 +45,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `instanceArn` - (Required) ARN of the SSO Instance associated with the permission set. ## Attribute Reference @@ -55,4 +56,4 @@ This data source exports the following attributes in addition to the arguments a * `arns` - Set of string contain the ARN of all Permission Sets. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/ssoadmin_principal_application_assignments.html.markdown b/website/docs/cdktf/typescript/d/ssoadmin_principal_application_assignments.html.markdown index 93498bbc8837..3a4051f75e38 100644 --- a/website/docs/cdktf/typescript/d/ssoadmin_principal_application_assignments.html.markdown +++ b/website/docs/cdktf/typescript/d/ssoadmin_principal_application_assignments.html.markdown @@ -40,8 +40,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `instanceArn` - (Required) ARN of the instance of IAM Identity Center. * `principalId` - (Required) An identifier for an object in IAM Identity Center, such as a user or group. * `principalType` - (Required) Entity type for which the assignment will be created. Valid values are `USER` or `GROUP`. @@ -58,4 +59,4 @@ This data source exports the following attributes in addition to the arguments a * `principalId` - An identifier for an object in IAM Identity Center, such as a user or group. * `principalType` - Entity type for which the assignment will be created. Valid values are `USER` or `GROUP`. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/storagegateway_local_disk.html.markdown b/website/docs/cdktf/typescript/d/storagegateway_local_disk.html.markdown index d78b7a4d3720..318ef8ff289b 100644 --- a/website/docs/cdktf/typescript/d/storagegateway_local_disk.html.markdown +++ b/website/docs/cdktf/typescript/d/storagegateway_local_disk.html.markdown @@ -39,6 +39,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `gatewayArn` - (Required) ARN of the gateway. * `diskNode` - (Optional) Device node of the local disk to retrieve. For example, `/dev/sdb`. * `diskPath` - (Optional) Device path of the local disk to retrieve. For example, `/dev/xvdb` or `/dev/nvme1n1`. @@ -50,4 +51,4 @@ This data source exports the following attributes in addition to the arguments a * `diskId` - Disk identifierE.g., `pci-0000:03:00.0-scsi-0:0:0:0` * `id` - Disk identifierE.g., `pci-0000:03:00.0-scsi-0:0:0:0` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/subnet.html.markdown b/website/docs/cdktf/typescript/d/subnet.html.markdown index fbbe64fb7816..d036563255fb 100644 --- a/website/docs/cdktf/typescript/d/subnet.html.markdown +++ b/website/docs/cdktf/typescript/d/subnet.html.markdown @@ -86,6 +86,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `availabilityZone` - (Optional) Availability zone where the subnet must reside. * `availabilityZoneId` - (Optional) ID of the Availability Zone for the subnet. This argument is not supported in all regions or partitions. If necessary, use `availabilityZone` instead. * `cidrBlock` - (Optional) CIDR block of the desired subnet. @@ -132,4 +133,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/subnets.html.markdown b/website/docs/cdktf/typescript/d/subnets.html.markdown index 1189bdca0a84..97f5b628f1fa 100644 --- a/website/docs/cdktf/typescript/d/subnets.html.markdown +++ b/website/docs/cdktf/typescript/d/subnets.html.markdown @@ -115,6 +115,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `filter` - (Optional) Custom filter block as described below. * `tags` - (Optional) Map of tags, each pair of which must exactly match a pair on the desired subnets. @@ -169,4 +170,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/synthetics_runtime_version.html.markdown b/website/docs/cdktf/typescript/d/synthetics_runtime_version.html.markdown index ed34d9144143..3db26fc09e4f 100644 --- a/website/docs/cdktf/typescript/d/synthetics_runtime_version.html.markdown +++ b/website/docs/cdktf/typescript/d/synthetics_runtime_version.html.markdown @@ -67,6 +67,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `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`. @@ -80,4 +81,4 @@ This data source exports the following attributes in addition to the arguments a * `releaseDate` - Date that the runtime version was released. * `versionName` - 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). - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/synthetics_runtime_versions.html.markdown b/website/docs/cdktf/typescript/d/synthetics_runtime_versions.html.markdown index 827357fb46fa..c9b316780c2b 100644 --- a/website/docs/cdktf/typescript/d/synthetics_runtime_versions.html.markdown +++ b/website/docs/cdktf/typescript/d/synthetics_runtime_versions.html.markdown @@ -36,7 +36,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -This data source does not support any arguments. +This data source supports the following arguments: + +* `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). ## Attribute Reference @@ -53,4 +55,4 @@ This data source exports the following attributes in addition to the arguments a * `versionName` - 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). - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/timestreamwrite_database.html.markdown b/website/docs/cdktf/typescript/d/timestreamwrite_database.html.markdown index e3a7450f5cda..09947f9e2e8d 100644 --- a/website/docs/cdktf/typescript/d/timestreamwrite_database.html.markdown +++ b/website/docs/cdktf/typescript/d/timestreamwrite_database.html.markdown @@ -38,9 +38,10 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This data source supports the following arguments: -* `databaseName` – (Required) The name of the Timestream database. Minimum length of 3. Maximum length of 256. +* `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). +* `databaseName` - (Required) The name of the Timestream database. Minimum length of 3. Maximum length of 256. ## Attribute Reference @@ -48,9 +49,9 @@ This data source exports the following attributes in addition to the arguments a * `arn` - The ARN that uniquely identifies this database. * `createdTime` - Creation time of database. -* `databaseName` – (Required) The name of the Timestream database. Minimum length of 3. Maximum length of 256. +* `databaseName` - (Required) The name of the Timestream database. Minimum length of 3. Maximum length of 256. * `kmsKeyId` - The ARN of the KMS key used to encrypt the data stored in the database. * `lastUpdatedTime` - Last time database was updated. * `tableCount` - Total number of tables in the Timestream database. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/timestreamwrite_table.html.markdown b/website/docs/cdktf/typescript/d/timestreamwrite_table.html.markdown index 5cf9cf963a1b..a610384cd39c 100644 --- a/website/docs/cdktf/typescript/d/timestreamwrite_table.html.markdown +++ b/website/docs/cdktf/typescript/d/timestreamwrite_table.html.markdown @@ -39,8 +39,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `databaseName` - (Required) Name of the Timestream database. * `name` - (Required) Name of the Timestream table. @@ -70,4 +71,4 @@ This data source exports the following attributes in addition to the arguments a * `name` - Name of the table. * `tableStatus` - Current state of table. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/transfer_connector.html.markdown b/website/docs/cdktf/typescript/d/transfer_connector.html.markdown index 35f79ef98f7d..54a7a70d2e49 100644 --- a/website/docs/cdktf/typescript/d/transfer_connector.html.markdown +++ b/website/docs/cdktf/typescript/d/transfer_connector.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `id` - (Required) Unique identifier for connector ## Attribute Reference @@ -67,4 +68,4 @@ This data source exports the following attributes in addition to the arguments a * `value` - Values associated with the tags key. * `url` - URL of the partner's AS2 or SFTP endpoint. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/transfer_server.html.markdown b/website/docs/cdktf/typescript/d/transfer_server.html.markdown index 985a088e3fa0..73576bbc0c6b 100644 --- a/website/docs/cdktf/typescript/d/transfer_server.html.markdown +++ b/website/docs/cdktf/typescript/d/transfer_server.html.markdown @@ -39,6 +39,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `serverId` - (Required) ID for an SFTP server. ## Attribute Reference @@ -59,4 +60,4 @@ This data source exports the following attributes in addition to the arguments a * `tags` - Map of tags assigned to the resource. * `url` - URL of the service endpoint used to authenticate users with an `identityProviderType` of `API_GATEWAY`. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/verifiedpermissions_policy_store.html.markdown b/website/docs/cdktf/typescript/d/verifiedpermissions_policy_store.html.markdown index b66ddf62bd14..e4af2bb74c23 100644 --- a/website/docs/cdktf/typescript/d/verifiedpermissions_policy_store.html.markdown +++ b/website/docs/cdktf/typescript/d/verifiedpermissions_policy_store.html.markdown @@ -38,8 +38,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `id` - (Required) The ID of the Policy Store. ## Attribute Reference @@ -48,8 +49,9 @@ This data source exports the following attributes in addition to the arguments a * `arn` - The ARN of the Policy Store. * `createdDate` - The date the Policy Store was created. +* `deletionProtection` - Whether the policy store can be deleted. * `lastUpdatedDate` - The date the Policy Store was last updated. * `tags` - Map of key-value pairs associated with the policy store. * `validationSettings` - Validation settings for the policy store. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/vpc.html.markdown b/website/docs/cdktf/typescript/d/vpc.html.markdown index ff75ac6347a0..58eb773babc1 100644 --- a/website/docs/cdktf/typescript/d/vpc.html.markdown +++ b/website/docs/cdktf/typescript/d/vpc.html.markdown @@ -57,6 +57,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `cidrBlock` - (Optional) Cidr block of the desired VPC. * `dhcpOptionsId` - (Optional) DHCP options id of the desired VPC. * `default` - (Optional) Boolean constraint on whether the desired VPC is @@ -108,4 +109,4 @@ The following attribute is additionally exported: - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/vpc_dhcp_options.html.markdown b/website/docs/cdktf/typescript/d/vpc_dhcp_options.html.markdown index 599736d8dff1..a07e26b19c83 100644 --- a/website/docs/cdktf/typescript/d/vpc_dhcp_options.html.markdown +++ b/website/docs/cdktf/typescript/d/vpc_dhcp_options.html.markdown @@ -71,6 +71,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `dhcpOptionsId` - (Optional) EC2 DHCP Options ID. * `filter` - (Optional) List of custom filters as described below. @@ -105,4 +106,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/vpc_endpoint.html.markdown b/website/docs/cdktf/typescript/d/vpc_endpoint.html.markdown index 3d47138790d5..ec1c6ea2c787 100644 --- a/website/docs/cdktf/typescript/d/vpc_endpoint.html.markdown +++ b/website/docs/cdktf/typescript/d/vpc_endpoint.html.markdown @@ -45,6 +45,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `filter` - (Optional) Custom filter block as described below. * `id` - (Optional) ID of the specific VPC Endpoint to retrieve. * `serviceName` - (Optional) Service name of the specific VPC Endpoint to retrieve. For AWS services the service name is usually in the form `com.amazonaws..` (the SageMaker AI Notebook service is an exception to this rule, the service name is in the form `aws.sagemaker..notebook`). @@ -105,4 +106,4 @@ DNS options (for `dnsOptions`) support the following attributes: - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/vpc_endpoint_associations.html.markdown b/website/docs/cdktf/typescript/d/vpc_endpoint_associations.html.markdown index e1f71f17a5c0..d10733c2811e 100644 --- a/website/docs/cdktf/typescript/d/vpc_endpoint_associations.html.markdown +++ b/website/docs/cdktf/typescript/d/vpc_endpoint_associations.html.markdown @@ -38,8 +38,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `vpcEndpointId` - ID of the specific VPC Endpoint to retrieve. ## Attribute Reference @@ -75,4 +76,4 @@ DNS blocks (for `private_dns_entry`) support the following attributes: * `dnsName` - DNS name. * `hostedZoneId` - ID of the private hosted zone. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/vpc_endpoint_service.html.markdown b/website/docs/cdktf/typescript/d/vpc_endpoint_service.html.markdown index 0aa923c64052..2bdf9b8adc82 100644 --- a/website/docs/cdktf/typescript/d/vpc_endpoint_service.html.markdown +++ b/website/docs/cdktf/typescript/d/vpc_endpoint_service.html.markdown @@ -128,8 +128,9 @@ This data source exports the following attributes in addition to the arguments a * `owner` - AWS account ID of the service owner or `amazon`. * `privateDnsName` - Private DNS name for the service. * `privateDnsNames` - Private DNS names assigned to the VPC endpoint service. -* `region` - Region of the endpoint service. +* `region` - (**Deprecated**) Region of the endpoint service. Use `serviceRegion` instead. * `serviceId` - ID of the endpoint service. +* `serviceRegion` - Region of the endpoint service. * `supportedIpAddressTypes` - The supported IP address types. * `tags` - Map of tags assigned to the resource. * `vpcEndpointPolicySupported` - Whether or not the service supports endpoint policies - `true` or `false`. @@ -140,4 +141,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/vpc_ipam.html.markdown b/website/docs/cdktf/typescript/d/vpc_ipam.html.markdown index 66b08630a2eb..4d1d46a8f1ab 100644 --- a/website/docs/cdktf/typescript/d/vpc_ipam.html.markdown +++ b/website/docs/cdktf/typescript/d/vpc_ipam.html.markdown @@ -24,7 +24,7 @@ import { TerraformStack } from "cdktf"; * Provider bindings are generated by running `cdktf get`. * See https://cdk.tf/provider-generation for more details. */ -import { DataAwsVpcIpam } from "./.gen/providers/aws/"; +import { DataAwsVpcIpam } from "./.gen/providers/aws/data-aws-vpc-ipam"; class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); @@ -38,8 +38,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `id` - (Required) ID of the IPAM. ## Attribute Reference @@ -53,15 +54,16 @@ This data source exports the following attributes in addition to the arguments a * `enablePrivateGua` - If private GUA is enabled. * `id` - ID of the IPAM resource. * `ipamRegion` - Region that the IPAM exists in. +* `metered_account` - AWS account that is charged for active IP addresses managed in IPAM. * `operatingRegions` - Regions that the IPAM is configured to operate in. * `ownerId` - ID of the account that owns this IPAM. * `privateDefaultScopeId` - ID of the default private scope. * `publicDefaultScopeId` - ID of the default public scope. -* `resource_discovery_association_count` - Number of resource discovery associations. +* `resourceDiscoveryAssociationCount` - Number of resource discovery associations. * `scopeCount` - Number of scopes on this IPAM. * `state` - Current state of the IPAM. -* `state_message` - State message of the IPAM. +* `stateMessage` - State message of the IPAM. * `tier` - IPAM Tier. * `tags` - Tags of the IPAM resource. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/vpc_ipam_pool.html.markdown b/website/docs/cdktf/typescript/d/vpc_ipam_pool.html.markdown index 7ca9aaf4648a..371c8684b670 100644 --- a/website/docs/cdktf/typescript/d/vpc_ipam_pool.html.markdown +++ b/website/docs/cdktf/typescript/d/vpc_ipam_pool.html.markdown @@ -62,6 +62,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `ipamPoolId` - (Optional) ID of the IPAM pool you would like information on. * `filter` - (Optional) Custom filter block as described below. @@ -96,4 +97,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/vpc_ipam_pool_cidrs.html.markdown b/website/docs/cdktf/typescript/d/vpc_ipam_pool_cidrs.html.markdown index e4ba31786811..54312987eeac 100644 --- a/website/docs/cdktf/typescript/d/vpc_ipam_pool_cidrs.html.markdown +++ b/website/docs/cdktf/typescript/d/vpc_ipam_pool_cidrs.html.markdown @@ -104,6 +104,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `ipamPoolId` - ID of the IPAM pool you would like the list of provisioned CIDRs. * `filter` - Custom filter block as described below. @@ -132,4 +133,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `1m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/vpc_ipam_pools.html.markdown b/website/docs/cdktf/typescript/d/vpc_ipam_pools.html.markdown index 020bcaceea07..9d0638596e26 100644 --- a/website/docs/cdktf/typescript/d/vpc_ipam_pools.html.markdown +++ b/website/docs/cdktf/typescript/d/vpc_ipam_pools.html.markdown @@ -51,6 +51,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `filter` - (Required) Custom filter block as described below. The arguments of this data source act as filters for querying the available IPAM Pools in the current region. @@ -86,4 +87,4 @@ The following attributes are available on each pool entry found. * `sourceIpamPoolId` - ID of the source IPAM pool. * `tags` - Map of tags to assigned to the resource. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/vpc_ipam_preview_next_cidr.html.markdown b/website/docs/cdktf/typescript/d/vpc_ipam_preview_next_cidr.html.markdown index 4a225f3f5b20..edf3709b4ac3 100644 --- a/website/docs/cdktf/typescript/d/vpc_ipam_preview_next_cidr.html.markdown +++ b/website/docs/cdktf/typescript/d/vpc_ipam_preview_next_cidr.html.markdown @@ -58,6 +58,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `disallowedCidrs` - (Optional) Exclude a particular CIDR range from being returned by the pool. * `ipamPoolId` - (Required) ID of the pool to which you want to assign a CIDR. * `netmaskLength` - (Optional) Netmask length of the CIDR you would like to preview from the IPAM pool. @@ -75,4 +76,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/vpc_ipams.html.markdown b/website/docs/cdktf/typescript/d/vpc_ipams.html.markdown index d39baa59d5a9..76164032867b 100644 --- a/website/docs/cdktf/typescript/d/vpc_ipams.html.markdown +++ b/website/docs/cdktf/typescript/d/vpc_ipams.html.markdown @@ -94,6 +94,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `ipamIds` - (Optional) IDs of the IPAM resources to query for. * `filter` - (Optional) Custom filter block as described below. @@ -133,4 +134,4 @@ This data source exports the following attributes in addition to the arguments a * `stateMessage` - State message of the IPAM. * `tier` - IPAM Tier. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/vpc_peering_connection.html.markdown b/website/docs/cdktf/typescript/d/vpc_peering_connection.html.markdown index cae67bb028c4..5529c13250a3 100644 --- a/website/docs/cdktf/typescript/d/vpc_peering_connection.html.markdown +++ b/website/docs/cdktf/typescript/d/vpc_peering_connection.html.markdown @@ -55,11 +55,9 @@ This data source supports the following arguments: * `vpcId` - (Optional) ID of the requester VPC of the specific VPC Peering Connection to retrieve. * `ownerId` - (Optional) AWS account ID of the owner of the requester VPC of the specific VPC Peering Connection to retrieve. * `cidrBlock` - (Optional) Primary CIDR block of the requester VPC of the specific VPC Peering Connection to retrieve. -* `region` - (Optional) Region of the requester VPC of the specific VPC Peering Connection to retrieve. * `peerVpcId` - (Optional) ID of the accepter VPC of the specific VPC Peering Connection to retrieve. * `peerOwnerId` - (Optional) AWS account ID of the owner of the accepter VPC of the specific VPC Peering Connection to retrieve. * `peerCidrBlock` - (Optional) Primary CIDR block of the accepter VPC of the specific VPC Peering Connection to retrieve. -* `peerRegion` - (Optional) Region of the accepter VPC of the specific VPC Peering Connection to retrieve. * `filter` - (Optional) Custom filter block as described below. * `tags` - (Optional) Map of tags, each pair of which must exactly match a pair on the desired VPC Peering Connection. @@ -73,7 +71,6 @@ More complex filters can be expressed using one or more `filter` sub-blocks, whi * `name` - (Required) Name of the field to filter by, as defined by [the underlying AWS API](http://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeVpcPeeringConnections.html). - * `values` - (Required) Set of values that are accepted for the given field. A VPC Peering Connection will be selected if any one of the given values matches. @@ -87,8 +84,11 @@ This data source exports the following attributes in addition to the arguments a * `ipv6CidrBlockSet` - List of objects with IPv6 CIDR blocks of the requester VPC. * `peerCidrBlockSet` - List of objects with IPv4 CIDR blocks of the accepter VPC. * `peerIpv6CidrBlockSet` - List of objects with IPv6 CIDR blocks of the accepter VPC. +* `peerRegion` - Region of the accepter VPC. +* `region` - (**Deprecated**) Region of the requester VPC. Use `requesterRegion` instead. * `requester` - Configuration block that describes [VPC Peering Connection] (https://docs.aws.amazon.com/vpc/latest/peering/what-is-vpc-peering.html) options set for the requester VPC. +* `requesterRegion` - Region of the requester VPC. #### Accepter and Requester Attribute Reference @@ -105,4 +105,4 @@ private IP addresses when queried from instances in a peer VPC. - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/vpc_peering_connections.html.markdown b/website/docs/cdktf/typescript/d/vpc_peering_connections.html.markdown index 9a2d2f38225c..17529b3797cf 100644 --- a/website/docs/cdktf/typescript/d/vpc_peering_connections.html.markdown +++ b/website/docs/cdktf/typescript/d/vpc_peering_connections.html.markdown @@ -57,6 +57,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `filter` - (Optional) Custom filter block as described below. * `tags` - (Optional) Mapping of tags, each pair of which must exactly match a pair on the desired VPC Peering Connection. @@ -85,4 +86,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/vpc_security_group_rule.html.markdown b/website/docs/cdktf/typescript/d/vpc_security_group_rule.html.markdown index b608537ae6ca..b2e99bc13e35 100644 --- a/website/docs/cdktf/typescript/d/vpc_security_group_rule.html.markdown +++ b/website/docs/cdktf/typescript/d/vpc_security_group_rule.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `securityGroupRuleId` - (Optional) ID of the security group rule to select. * `filter` - (Optional) Configuration block(s) for filtering. Detailed below. @@ -67,4 +68,4 @@ This data source exports the following attributes in addition to the arguments a * `tags` - A map of tags assigned to the resource. * `toPort` - (Optional) The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/vpc_security_group_rules.html.markdown b/website/docs/cdktf/typescript/d/vpc_security_group_rules.html.markdown index 77fc8aa1df57..732fd42cb933 100644 --- a/website/docs/cdktf/typescript/d/vpc_security_group_rules.html.markdown +++ b/website/docs/cdktf/typescript/d/vpc_security_group_rules.html.markdown @@ -43,6 +43,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `filter` - (Optional) Custom filter block as described below. * `tags` - (Optional) Map of tags, each pair of which must exactly match a pair on the desired security group rule. @@ -63,4 +64,4 @@ This data source exports the following attributes in addition to the arguments a * `ids` - List of all the security group rule IDs found. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/vpclattice_auth_policy.html.markdown b/website/docs/cdktf/typescript/d/vpclattice_auth_policy.html.markdown index 2c091b925523..db5b086ad782 100644 --- a/website/docs/cdktf/typescript/d/vpclattice_auth_policy.html.markdown +++ b/website/docs/cdktf/typescript/d/vpclattice_auth_policy.html.markdown @@ -40,8 +40,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `resourceIdentifier` - (Required) The ID or Amazon Resource Name (ARN) of the service network or service for which the policy is created. ## Attribute Reference @@ -51,4 +52,4 @@ This data source exports the following attributes in addition to the arguments a * `policy` - The auth policy. The policy string in JSON must not contain newlines or blank lines. * `state` - The state of the auth policy. The auth policy is only active when the auth type is set to AWS_IAM. If you provide a policy, then authentication and authorization decisions are made based on this policy and the client's IAM policy. If the Auth type is NONE, then, any auth policy you provide will remain inactive. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/vpclattice_listener.html.markdown b/website/docs/cdktf/typescript/d/vpclattice_listener.html.markdown index 5df9676a2384..425741b19214 100644 --- a/website/docs/cdktf/typescript/d/vpclattice_listener.html.markdown +++ b/website/docs/cdktf/typescript/d/vpclattice_listener.html.markdown @@ -43,8 +43,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `serviceIdentifier` - (Required) ID or Amazon Resource Name (ARN) of the service network * `listenerIdentifier` - (Required) ID or Amazon Resource Name (ARN) of the listener @@ -64,4 +65,4 @@ This data source exports the following attributes in addition to the arguments a * `serviceId` - The ID of the service. * `tags` - List of tags associated with the listener. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/vpclattice_resource_policy.html.markdown b/website/docs/cdktf/typescript/d/vpclattice_resource_policy.html.markdown index b2223c6f99c4..12922287c3c0 100644 --- a/website/docs/cdktf/typescript/d/vpclattice_resource_policy.html.markdown +++ b/website/docs/cdktf/typescript/d/vpclattice_resource_policy.html.markdown @@ -38,8 +38,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This data source supports the following arguments: +* `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). * `resourceArn` - (Required) Resource ARN of the resource for which a policy is retrieved. ## Attribute Reference @@ -48,4 +49,4 @@ This data source exports the following attributes in addition to the arguments a * `policy` - JSON-encoded string representation of the applied resource policy. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/vpclattice_service.html.markdown b/website/docs/cdktf/typescript/d/vpclattice_service.html.markdown index 0d65fd0d2ef2..7ebf507d8736 100644 --- a/website/docs/cdktf/typescript/d/vpclattice_service.html.markdown +++ b/website/docs/cdktf/typescript/d/vpclattice_service.html.markdown @@ -40,6 +40,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `name` - (Optional) Service name. * `serviceIdentifier` - (Optional) ID or Amazon Resource Name (ARN) of the service. @@ -58,4 +59,4 @@ This data source exports the following attributes in addition to the arguments a * `status` - Status of the service. * `tags` - List of tags associated with the service. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/vpclattice_service_network.html.markdown b/website/docs/cdktf/typescript/d/vpclattice_service_network.html.markdown index 2edccf484af3..c20056ee410c 100644 --- a/website/docs/cdktf/typescript/d/vpclattice_service_network.html.markdown +++ b/website/docs/cdktf/typescript/d/vpclattice_service_network.html.markdown @@ -40,6 +40,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `serviceNetworkIdentifier` - (Required) Identifier of the service network. ## Attribute Reference @@ -55,4 +56,4 @@ This data source exports the following attributes in addition to the arguments a * `numberOfAssociatedServices` - Number of services associated with this service network. * `numberOfAssociatedVpcs` - Number of VPCs associated with this service network. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/vpcs.html.markdown b/website/docs/cdktf/typescript/d/vpcs.html.markdown index aa288ac3409d..faf29206ec66 100644 --- a/website/docs/cdktf/typescript/d/vpcs.html.markdown +++ b/website/docs/cdktf/typescript/d/vpcs.html.markdown @@ -109,6 +109,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `tags` - (Optional) Map of tags, each pair of which must exactly match a pair on the desired vpcs. * `filter` - (Optional) Custom filter block as described below. @@ -135,4 +136,4 @@ This data source exports the following attributes in addition to the arguments a - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/vpn_gateway.html.markdown b/website/docs/cdktf/typescript/d/vpn_gateway.html.markdown index 8c116618c9ff..a95d0da7828b 100644 --- a/website/docs/cdktf/typescript/d/vpn_gateway.html.markdown +++ b/website/docs/cdktf/typescript/d/vpn_gateway.html.markdown @@ -47,6 +47,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `id` - (Optional) ID of the specific VPN Gateway to retrieve. * `state` - (Optional) State of the specific VPN Gateway to retrieve. * `availabilityZone` - (Optional) Availability Zone of the specific VPN Gateway to retrieve. @@ -78,4 +79,4 @@ This data source exports no additional attributes. - `read` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/wafregional_ipset.html.markdown b/website/docs/cdktf/typescript/d/wafregional_ipset.html.markdown index 9eaca372f49a..a89d463c42ef 100644 --- a/website/docs/cdktf/typescript/d/wafregional_ipset.html.markdown +++ b/website/docs/cdktf/typescript/d/wafregional_ipset.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `name` - (Required) Name of the WAF Regional IP set. ## Attribute Reference @@ -46,4 +47,4 @@ This data source exports the following attributes in addition to the arguments a * `id` - ID of the WAF Regional IP set. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/wafregional_rate_based_rule.html.markdown b/website/docs/cdktf/typescript/d/wafregional_rate_based_rule.html.markdown index ba08d047d158..0b3a5f37ce88 100644 --- a/website/docs/cdktf/typescript/d/wafregional_rate_based_rule.html.markdown +++ b/website/docs/cdktf/typescript/d/wafregional_rate_based_rule.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `name` - (Required) Name of the WAF Regional rate based rule. ## Attribute Reference @@ -46,4 +47,4 @@ This data source exports the following attributes in addition to the arguments a * `id` - ID of the WAF Regional rate based rule. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/wafregional_rule.html.markdown b/website/docs/cdktf/typescript/d/wafregional_rule.html.markdown index de6d06d142a2..f414393ed132 100644 --- a/website/docs/cdktf/typescript/d/wafregional_rule.html.markdown +++ b/website/docs/cdktf/typescript/d/wafregional_rule.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `name` - (Required) Name of the WAF Regional rule. ## Attribute Reference @@ -46,4 +47,4 @@ This data source exports the following attributes in addition to the arguments a * `id` - ID of the WAF Regional rule. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/wafregional_subscribed_rule_group.html.markdown b/website/docs/cdktf/typescript/d/wafregional_subscribed_rule_group.html.markdown index d1f547ffdf61..5cb5162af542 100644 --- a/website/docs/cdktf/typescript/d/wafregional_subscribed_rule_group.html.markdown +++ b/website/docs/cdktf/typescript/d/wafregional_subscribed_rule_group.html.markdown @@ -68,6 +68,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `name` - (Optional) Name of the WAF rule group. * `metricName` - (Optional) Name of the WAF rule group. @@ -79,4 +80,4 @@ This data source exports the following attributes in addition to the arguments a * `id` - ID of the WAF rule group. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/wafregional_web_acl.html.markdown b/website/docs/cdktf/typescript/d/wafregional_web_acl.html.markdown index e0aa03a3f149..fe37278aa978 100644 --- a/website/docs/cdktf/typescript/d/wafregional_web_acl.html.markdown +++ b/website/docs/cdktf/typescript/d/wafregional_web_acl.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `name` - (Required) Name of the WAF Regional Web ACL. ## Attribute Reference @@ -46,4 +47,4 @@ This data source exports the following attributes in addition to the arguments a * `id` - ID of the WAF Regional Web ACL. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/wafv2_ip_set.html.markdown b/website/docs/cdktf/typescript/d/wafv2_ip_set.html.markdown index 38d13b11fe97..edad23f8ed1a 100644 --- a/website/docs/cdktf/typescript/d/wafv2_ip_set.html.markdown +++ b/website/docs/cdktf/typescript/d/wafv2_ip_set.html.markdown @@ -39,6 +39,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `name` - (Required) Name of the WAFv2 IP Set. * `scope` - (Required) Specifies whether this is for an AWS CloudFront distribution or for a regional application. Valid values are `CLOUDFRONT` or `REGIONAL`. To work with CloudFront, you must also specify the region `us-east-1` (N. Virginia) on the AWS provider. @@ -52,4 +53,4 @@ This data source exports the following attributes in addition to the arguments a * `id` - Unique identifier for the set. * `ipAddressVersion` - IP address version of the set. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/wafv2_regex_pattern_set.html.markdown b/website/docs/cdktf/typescript/d/wafv2_regex_pattern_set.html.markdown index 1fefb4080c3d..48e9eb9a8b47 100644 --- a/website/docs/cdktf/typescript/d/wafv2_regex_pattern_set.html.markdown +++ b/website/docs/cdktf/typescript/d/wafv2_regex_pattern_set.html.markdown @@ -39,6 +39,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `name` - (Required) Name of the WAFv2 Regex Pattern Set. * `scope` - (Required) Specifies whether this is for an AWS CloudFront distribution or for a regional application. Valid values are `CLOUDFRONT` or `REGIONAL`. To work with CloudFront, you must also specify the region `us-east-1` (N. Virginia) on the AWS provider. @@ -57,4 +58,4 @@ Each `regularExpression` supports the following argument: * `regexString` - (Required) String representing the regular expression, see the AWS WAF [documentation](https://docs.aws.amazon.com/waf/latest/developerguide/waf-regex-pattern-set-creating.html) for more information. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/wafv2_rule_group.html.markdown b/website/docs/cdktf/typescript/d/wafv2_rule_group.html.markdown index f694d076cf3c..d31029770294 100644 --- a/website/docs/cdktf/typescript/d/wafv2_rule_group.html.markdown +++ b/website/docs/cdktf/typescript/d/wafv2_rule_group.html.markdown @@ -39,6 +39,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `name` - (Required) Name of the WAFv2 Rule Group. * `scope` - (Required) Specifies whether this is for an AWS CloudFront distribution or for a regional application. Valid values are `CLOUDFRONT` or `REGIONAL`. To work with CloudFront, you must also specify the region `us-east-1` (N. Virginia) on the AWS provider. @@ -50,4 +51,4 @@ This data source exports the following attributes in addition to the arguments a * `description` - Description of the rule group that helps with identification. * `id` - Unique identifier of the rule group. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/wafv2_web_acl.html.markdown b/website/docs/cdktf/typescript/d/wafv2_web_acl.html.markdown index d1244df6d87c..703146782b4d 100644 --- a/website/docs/cdktf/typescript/d/wafv2_web_acl.html.markdown +++ b/website/docs/cdktf/typescript/d/wafv2_web_acl.html.markdown @@ -14,6 +14,8 @@ Retrieves the summary of a WAFv2 Web ACL. ## Example Usage +### Lookup by name + ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug import { Construct } from "constructs"; @@ -35,11 +37,41 @@ class MyConvertedCode extends TerraformStack { ``` +### Lookup by associated resource + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { DataAwsWafv2WebAcl } from "./.gen/providers/aws/data-aws-wafv2-web-acl"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + new DataAwsWafv2WebAcl(this, "alb_example", { + resourceArn: + "arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/app/my-alb/xxxxx", + scope: "REGIONAL", + }); + new DataAwsWafv2WebAcl(this, "cloudfront_example", { + resourceArn: "arn:aws:cloudfront::123456789012:distribution/XXX", + scope: "CLOUDFRONT", + }); + } +} + +``` + ## Argument Reference This data source supports the following arguments: -* `name` - (Required) Name of the WAFv2 Web ACL. +* `name` - (Optional) Name of the WAFv2 Web ACL. Exactly one of `name` or `resourceArn` must be specified. +* `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). +* `resourceArn` - (Optional) ARN of the AWS resource associated with the Web ACL. This can be an ARN of an Application Load Balancer, Amazon API Gateway REST API, AWS AppSync GraphQL API, Amazon Cognito user pool, AWS App Runner service, AWS Verified Access instance, or AWS Amplify application. Exactly one of `name` or `resourceArn` must be specified. * `scope` - (Required) Specifies whether this is for an AWS CloudFront distribution or for a regional application. Valid values are `CLOUDFRONT` or `REGIONAL`. To work with CloudFront, you must also specify the region `us-east-1` (N. Virginia) on the AWS provider. ## Attribute Reference @@ -50,4 +82,4 @@ This data source exports the following attributes in addition to the arguments a * `description` - Description of the WebACL that helps with identification. * `id` - Unique identifier of the WebACL. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/workspaces_bundle.html.markdown b/website/docs/cdktf/typescript/d/workspaces_bundle.html.markdown index 221d4f2da269..c96ffbd39615 100644 --- a/website/docs/cdktf/typescript/d/workspaces_bundle.html.markdown +++ b/website/docs/cdktf/typescript/d/workspaces_bundle.html.markdown @@ -63,21 +63,22 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: -* `bundleId` – (Optional) ID of the bundle. -* `owner` – (Optional) Owner of the bundles. You have to leave it blank for own bundles. You cannot combine this parameter with `bundleId`. -* `name` – (Optional) Name of the bundle. You cannot combine this parameter with `bundleId`. +* `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). +* `bundleId` - (Optional) ID of the bundle. +* `owner` - (Optional) Owner of the bundles. You have to leave it blank for own bundles. You cannot combine this parameter with `bundleId`. +* `name` - (Optional) Name of the bundle. You cannot combine this parameter with `bundleId`. ## Attribute Reference This data source exports the following attributes in addition to the arguments above: -* `description` – The description of the bundle. -* `bundleId` – The ID of the bundle. -* `name` – The name of the bundle. -* `owner` – The owner of the bundle. -* `computeType` – The compute type. See supported fields below. -* `rootStorage` – The root volume. See supported fields below. -* `userStorage` – The user storage. See supported fields below. +* `description` - The description of the bundle. +* `bundleId` - The ID of the bundle. +* `name` - The name of the bundle. +* `owner` - The owner of the bundle. +* `computeType` - The compute type. See supported fields below. +* `rootStorage` - The root volume. See supported fields below. +* `userStorage` - The user storage. See supported fields below. ### `computeType` @@ -91,4 +92,4 @@ This data source exports the following attributes in addition to the arguments a * `capacity` - Size of the user storage. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/workspaces_directory.html.markdown b/website/docs/cdktf/typescript/d/workspaces_directory.html.markdown index f1f0bf2446c5..7b5a0423a077 100644 --- a/website/docs/cdktf/typescript/d/workspaces_directory.html.markdown +++ b/website/docs/cdktf/typescript/d/workspaces_directory.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `directoryId` - (Required) Directory identifier for registration in WorkSpaces service. ## Attribute Reference @@ -45,9 +46,9 @@ This data source supports the following arguments: This data source exports the following attributes in addition to the arguments above: * `id` - WorkSpaces directory identifier. -* `active_directory_config` - Configuration for Active Directory integration when `workspace_type` is set to `POOLS`. - * `domainName` – Fully qualified domain name of the AWS Directory Service directory. - * `service_account_secret_arn` – ARN of the Secrets Manager secret that contains the credentials for the service account. +* `activeDirectoryConfig` - Configuration for Active Directory integration when `workspaceType` is set to `POOLS`. + * `domainName` - Fully qualified domain name of the AWS Directory Service directory. + * `serviceAccountSecretArn` - ARN of the Secrets Manager secret that contains the credentials for the service account. * `alias` - Directory alias. * `customerUserName` - User name for the service account. * `directoryName` - Name of the directory. @@ -56,33 +57,33 @@ This data source exports the following attributes in addition to the arguments a * `iamRoleId` - Identifier of the IAM role. This is the role that allows Amazon WorkSpaces to make calls to other services, such as Amazon EC2, on your behalf. * `ipGroupIds` - Identifiers of the IP access control groups associated with the directory. * `registrationCode` - Registration code for the directory. This is the code that users enter in their Amazon WorkSpaces client application to connect to the directory. -* `selfServicePermissions` – The permissions to enable or disable self-service capabilities. - * `changeComputeType` – Whether WorkSpaces directory users can change the compute type (bundle) for their workspace. - * `increaseVolumeSize` – Whether WorkSpaces directory users can increase the volume size of the drives on their workspace. - * `rebuildWorkspace` – Whether WorkSpaces directory users can rebuild the operating system of a workspace to its original state. - * `restartWorkspace` – Whether WorkSpaces directory users can restart their workspace. - * `switchRunningMode` – Whether WorkSpaces directory users can switch the running mode of their workspace. +* `selfServicePermissions` - The permissions to enable or disable self-service capabilities. + * `changeComputeType` - Whether WorkSpaces directory users can change the compute type (bundle) for their workspace. + * `increaseVolumeSize` - Whether WorkSpaces directory users can increase the volume size of the drives on their workspace. + * `rebuildWorkspace` - Whether WorkSpaces directory users can rebuild the operating system of a workspace to its original state. + * `restartWorkspace` - Whether WorkSpaces directory users can restart their workspace. + * `switchRunningMode` - Whether WorkSpaces directory users can switch the running mode of their workspace. * `subnetIds` - Identifiers of the subnets where the directory resides. -* `tags` – A map of tags assigned to the WorkSpaces directory. -* `user_identity_type` - The user identity type for the WorkSpaces directory. -* `workspaceAccessProperties` – Specifies which devices and operating systems users can use to access their WorkSpaces. - * `deviceTypeAndroid` – (Optional) Indicates whether users can use Android devices to access their WorkSpaces. - * `deviceTypeChromeos` – (Optional) Indicates whether users can use Chromebooks to access their WorkSpaces. - * `deviceTypeIos` – (Optional) Indicates whether users can use iOS devices to access their WorkSpaces. - * `deviceTypeLinux` – (Optional) Indicates whether users can use Linux clients to access their WorkSpaces. - * `deviceTypeOsx` – (Optional) Indicates whether users can use macOS clients to access their WorkSpaces. - * `deviceTypeWeb` – (Optional) Indicates whether users can access their WorkSpaces through a web browser. - * `deviceTypeWindows` – (Optional) Indicates whether users can use Windows clients to access their WorkSpaces. - * `deviceTypeZeroclient` – (Optional) Indicates whether users can use zero client devices to access their WorkSpaces. -* `workspaceCreationProperties` – The default properties that are used for creating WorkSpaces. - * `customSecurityGroupId` – The identifier of your custom security group. Should relate to the same VPC, where workspaces reside in. - * `defaultOu` – The default organizational unit (OU) for your WorkSpace directories. - * `enableInternetAccess` – Indicates whether internet access is enabled for your WorkSpaces. - * `enableMaintenanceMode` – Indicates whether maintenance mode is enabled for your WorkSpaces. For more information, see [WorkSpace Maintenance](https://docs.aws.amazon.com/workspaces/latest/adminguide/workspace-maintenance.html). - * `userEnabledAsLocalAdministrator` – Indicates whether users are local administrators of their WorkSpaces. -* `workspace_directory_description` - The description of the WorkSpaces directory when `workspace_type` is set to `POOLS`. -* `workspace_directory_name` - The name of the WorkSpaces directory when `workspace_type` is set to `POOLS`. +* `tags` - A map of tags assigned to the WorkSpaces directory. +* `userIdentityType` - The user identity type for the WorkSpaces directory. +* `workspaceAccessProperties` - Specifies which devices and operating systems users can use to access their WorkSpaces. + * `deviceTypeAndroid` - (Optional) Indicates whether users can use Android devices to access their WorkSpaces. + * `deviceTypeChromeos` - (Optional) Indicates whether users can use Chromebooks to access their WorkSpaces. + * `deviceTypeIos` - (Optional) Indicates whether users can use iOS devices to access their WorkSpaces. + * `deviceTypeLinux` - (Optional) Indicates whether users can use Linux clients to access their WorkSpaces. + * `deviceTypeOsx` - (Optional) Indicates whether users can use macOS clients to access their WorkSpaces. + * `deviceTypeWeb` - (Optional) Indicates whether users can access their WorkSpaces through a web browser. + * `deviceTypeWindows` - (Optional) Indicates whether users can use Windows clients to access their WorkSpaces. + * `deviceTypeZeroclient` - (Optional) Indicates whether users can use zero client devices to access their WorkSpaces. +* `workspaceCreationProperties` - The default properties that are used for creating WorkSpaces. + * `customSecurityGroupId` - The identifier of your custom security group. Should relate to the same VPC, where workspaces reside in. + * `defaultOu` - The default organizational unit (OU) for your WorkSpace directories. + * `enableInternetAccess` - Indicates whether internet access is enabled for your WorkSpaces. + * `enableMaintenanceMode` - Indicates whether maintenance mode is enabled for your WorkSpaces. For more information, see [WorkSpace Maintenance](https://docs.aws.amazon.com/workspaces/latest/adminguide/workspace-maintenance.html). + * `userEnabledAsLocalAdministrator` - Indicates whether users are local administrators of their WorkSpaces. +* `workspaceDirectoryDescription` - The description of the WorkSpaces directory when `workspaceType` is set to `POOLS`. +* `workspaceDirectoryName` - The name of the WorkSpaces directory when `workspaceType` is set to `POOLS`. * `workspaceSecurityGroupId` - The identifier of the security group that is assigned to new WorkSpaces. -* `workspace_type` - The type of WorkSpaces directory. +* `workspaceType` - The type of WorkSpaces directory. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/workspaces_image.html.markdown b/website/docs/cdktf/typescript/d/workspaces_image.html.markdown index c5434430ce3d..8e2025440d32 100644 --- a/website/docs/cdktf/typescript/d/workspaces_image.html.markdown +++ b/website/docs/cdktf/typescript/d/workspaces_image.html.markdown @@ -38,16 +38,17 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: -* `imageId` – (Required) ID of the image. +* `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). +* `imageId` - (Required) ID of the image. ## Attribute Reference This data source exports the following attributes in addition to the arguments above: -* `name` – The name of the image. -* `description` – The description of the image. -* `os` – The operating system that the image is running. -* `requiredTenancy` – Specifies whether the image is running on dedicated hardware. When Bring Your Own License (BYOL) is enabled, this value is set to DEDICATED. For more information, see [Bring Your Own Windows Desktop Images](https://docs.aws.amazon.com/workspaces/latest/adminguide/byol-windows-images.html). -* `state` – The status of the image. +* `name` - The name of the image. +* `description` - The description of the image. +* `os` - The operating system that the image is running. +* `requiredTenancy` - Specifies whether the image is running on dedicated hardware. When Bring Your Own License (BYOL) is enabled, this value is set to DEDICATED. For more information, see [Bring Your Own Windows Desktop Images](https://docs.aws.amazon.com/workspaces/latest/adminguide/byol-windows-images.html). +* `state` - The status of the image. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/d/workspaces_workspace.html.markdown b/website/docs/cdktf/typescript/d/workspaces_workspace.html.markdown index 8b30f3f4e9b0..e188c8296914 100644 --- a/website/docs/cdktf/typescript/d/workspaces_workspace.html.markdown +++ b/website/docs/cdktf/typescript/d/workspaces_workspace.html.markdown @@ -63,23 +63,24 @@ class MyConvertedCode extends TerraformStack { This data source supports the following arguments: +* `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). * `bundleId` - (Optional) ID of the bundle for the WorkSpace. * `directoryId` - (Optional) ID of the directory for the WorkSpace. You have to specify `userName` along with `directoryId`. You cannot combine this parameter with `workspaceId`. * `rootVolumeEncryptionEnabled` - (Optional) Indicates whether the data stored on the root volume is encrypted. * `tags` - (Optional) Tags for the WorkSpace. -* `userName` – (Optional) User name of the user for the WorkSpace. This user name must exist in the directory for the WorkSpace. You cannot combine this parameter with `workspaceId`. -* `userVolumeEncryptionEnabled` – (Optional) Indicates whether the data stored on the user volume is encrypted. -* `volumeEncryptionKey` – (Optional) Symmetric AWS KMS customer master key (CMK) used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric CMKs. +* `userName` - (Optional) User name of the user for the WorkSpace. This user name must exist in the directory for the WorkSpace. You cannot combine this parameter with `workspaceId`. +* `userVolumeEncryptionEnabled` - (Optional) Indicates whether the data stored on the user volume is encrypted. +* `volumeEncryptionKey` - (Optional) Symmetric AWS KMS customer master key (CMK) used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric CMKs. * `workspaceId` - (Optional) ID of the WorkSpace. You cannot combine this parameter with `directoryId`. -* `workspaceProperties` – (Optional) WorkSpace properties. +* `workspaceProperties` - (Optional) WorkSpace properties. `workspaceProperties` supports the following: -* `computeTypeName` – (Optional) Compute type. For more information, see [Amazon WorkSpaces Bundles](http://aws.amazon.com/workspaces/details/#Amazon_WorkSpaces_Bundles). Valid values are `VALUE`, `STANDARD`, `PERFORMANCE`, `POWER`, `GRAPHICS`, `POWERPRO` and `GRAPHICSPRO`. -* `rootVolumeSizeGib` – (Optional) Size of the root volume. -* `runningMode` – (Optional) Running mode. For more information, see [Manage the WorkSpace Running Mode](https://docs.aws.amazon.com/workspaces/latest/adminguide/running-mode.html). Valid values are `AUTO_STOP` and `ALWAYS_ON`. -* `runningModeAutoStopTimeoutInMinutes` – (Optional) Time after a user logs off when WorkSpaces are automatically stopped. Configured in 60-minute intervals. -* `userVolumeSizeGib` – (Optional) Size of the user storage. +* `computeTypeName` - (Optional) Compute type. For more information, see [Amazon WorkSpaces Bundles](http://aws.amazon.com/workspaces/details/#Amazon_WorkSpaces_Bundles). Valid values are `VALUE`, `STANDARD`, `PERFORMANCE`, `POWER`, `GRAPHICS`, `POWERPRO` and `GRAPHICSPRO`. +* `rootVolumeSizeGib` - (Optional) Size of the root volume. +* `runningMode` - (Optional) Running mode. For more information, see [Manage the WorkSpace Running Mode](https://docs.aws.amazon.com/workspaces/latest/adminguide/running-mode.html). Valid values are `AUTO_STOP` and `ALWAYS_ON`. +* `runningModeAutoStopTimeoutInMinutes` - (Optional) Time after a user logs off when WorkSpaces are automatically stopped. Configured in 60-minute intervals. +* `userVolumeSizeGib` - (Optional) Size of the user storage. ## Attribute Reference @@ -90,4 +91,4 @@ This data source exports the following attributes in addition to the arguments a * `computerName` - Name of the WorkSpace, as seen by the operating system. * `state` - Operational state of the WorkSpace. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/ephemeral-resources/cognito_identity_openid_token_for_developer_identity.markdown b/website/docs/cdktf/typescript/ephemeral-resources/cognito_identity_openid_token_for_developer_identity.markdown index 9b1bb36ae4c7..6c8c142f2bc7 100644 --- a/website/docs/cdktf/typescript/ephemeral-resources/cognito_identity_openid_token_for_developer_identity.markdown +++ b/website/docs/cdktf/typescript/ephemeral-resources/cognito_identity_openid_token_for_developer_identity.markdown @@ -13,7 +13,7 @@ description: |- Terraform ephemeral resource for managing an AWS Cognito Identity Open ID Token for Developer Identity. -~> Ephemeral resources are a new feature and may evolve as we continue to explore their most effective uses. [Learn more](https://developer.hashicorp.com/terraform/language/v1.10.x/resources/ephemeral). +~> Ephemeral resources are a new feature and may evolve as we continue to explore their most effective uses. [Learn more](https://developer.hashicorp.com/terraform/language/resources/ephemeral). ## Example Usage @@ -41,12 +41,14 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `identityPoolId` - (Required) An identity pool ID in the format REGION:GUID. The following arguments are optional: +* `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). * `identityId` - (Optional) A unique identifier in the format REGION:GUID. * `logins` - (Optional) A set of optional name-value pairs that map provider names to provider tokens. Each name-value pair represents a user from a public provider or developer provider. If the user is from a developer provider, the name-value pair will follow the syntax `"developer_provider_name": "developer_user_identifier"`. The developer provider is the "domain" by which Cognito will refer to your users; you provided this domain while creating/updating the identity pool. The developer user identifier is an identifier from your backend that uniquely identifies a user. When you create an identity pool, you can specify the supported logins. @@ -61,4 +63,4 @@ This resource exports the following attributes in addition to the arguments abov * `token` - An OpenID token. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/ephemeral-resources/eks_cluster_auth.html.markdown b/website/docs/cdktf/typescript/ephemeral-resources/eks_cluster_auth.html.markdown index adc88c4481bf..54c43daad7c7 100644 --- a/website/docs/cdktf/typescript/ephemeral-resources/eks_cluster_auth.html.markdown +++ b/website/docs/cdktf/typescript/ephemeral-resources/eks_cluster_auth.html.markdown @@ -12,7 +12,7 @@ description: |- Retrieve an authentication token to communicate with an EKS cluster. -~> **NOTE:** Ephemeral resources are a new feature and may evolve as we continue to explore their most effective uses. [Learn more](https://developer.hashicorp.com/terraform/language/v1.10.x/resources/ephemeral). +~> **NOTE:** Ephemeral resources are a new feature and may evolve as we continue to explore their most effective uses. [Learn more](https://developer.hashicorp.com/terraform/language/resources/ephemeral). ## Example Usage @@ -62,6 +62,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) Name of the EKS cluster. ## Attribute Reference @@ -70,4 +71,4 @@ This resource exports the following attributes in addition to the arguments abov * `token` - Token to use to authenticate with the cluster. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/ephemeral-resources/kms_secrets.html.markdown b/website/docs/cdktf/typescript/ephemeral-resources/kms_secrets.html.markdown index a306c2118967..ada936dbeac1 100644 --- a/website/docs/cdktf/typescript/ephemeral-resources/kms_secrets.html.markdown +++ b/website/docs/cdktf/typescript/ephemeral-resources/kms_secrets.html.markdown @@ -12,7 +12,7 @@ description: |- Decrypt multiple secrets from data encrypted with the AWS KMS service. -~> **NOTE:** Ephemeral resources are a new feature and may evolve as we continue to explore their most effective uses. [Learn more](https://developer.hashicorp.com/terraform/language/v1.10.x/resources/ephemeral). +~> **NOTE:** Ephemeral resources are a new feature and may evolve as we continue to explore their most effective uses. [Learn more](https://developer.hashicorp.com/terraform/language/resources/ephemeral). ## Example Usage @@ -60,6 +60,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `secret` - (Required) One or more encrypted payload definitions from the KMS service. See the Secret Definitions below. ### Secret Definitions @@ -82,4 +83,4 @@ This resource exports the following attributes in addition to the arguments abov * `plaintext` - Map containing each `secret` `name` as the key with its decrypted plaintext value - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/ephemeral-resources/lambda_invocation.html.markdown b/website/docs/cdktf/typescript/ephemeral-resources/lambda_invocation.html.markdown index a0a5b46801d6..6b7c8e8e0da7 100644 --- a/website/docs/cdktf/typescript/ephemeral-resources/lambda_invocation.html.markdown +++ b/website/docs/cdktf/typescript/ephemeral-resources/lambda_invocation.html.markdown @@ -3,34 +3,224 @@ subcategory: "Lambda" layout: "aws" page_title: "AWS: aws_lambda_invocation" description: |- - Invoke AWS Lambda Function + Invokes an AWS Lambda Function as an ephemeral resource. --- # Ephemeral: aws_lambda_invocation -Use this ephemeral resource to invoke a Lambda function. The lambda function is invoked with the [RequestResponse](https://docs.aws.amazon.com/lambda/latest/dg/API_Invoke.html#API_Invoke_RequestSyntax) invocation type. +Invokes an AWS Lambda Function as an ephemeral resource. Use this ephemeral resource to execute Lambda functions during Terraform operations without persisting results in state, ideal for generating sensitive data or performing lightweight operations. -~> **NOTE:** Ephemeral resources are a new feature and may evolve as we continue to explore their most effective uses. [Learn more](https://developer.hashicorp.com/terraform/language/v1.10.x/resources/ephemeral). +The Lambda function is invoked with [RequestResponse](https://docs.aws.amazon.com/lambda/latest/dg/API_Invoke.html#API_Invoke_RequestSyntax) invocation type. -~> **NOTE:** The `aws_lambda_invocation` ephemeral resource invokes the function during every `plan` and `apply` when the function is known. A common use case for this functionality is when invoking a lightweight function—where repeated invocations are acceptable—that produces sensitive information you do not want to store in the state. +~> **Note:** Ephemeral resources are a new feature and may evolve as we continue to explore their most effective uses. [Learn more](https://developer.hashicorp.com/terraform/language/resources/ephemeral). -~> **NOTE:** If you get a `KMSAccessDeniedException: Lambda was unable to decrypt the environment variables because KMS access was denied` error when invoking an [`aws_lambda_function`](/docs/providers/aws/r/lambda_function.html) with environment variables, the IAM role associated with the function may have been deleted and recreated _after_ the function was created. You can fix the problem two ways: 1) updating the function's role to another role and then updating it back again to the recreated role, or 2) by using Terraform to `taint` the function and `apply` your configuration again to recreate the function. (When you create a function, Lambda grants permissions on the KMS key to the function's IAM role. If the IAM role is recreated, the grant is no longer valid. Changing the function's role or recreating the function causes Lambda to update the grant.) +~> **Note:** The `aws_lambda_invocation` ephemeral resource invokes the function during every `plan` and `apply` when the function is known. A common use case for this functionality is when invoking a lightweight function—where repeated invocations are acceptable—that produces sensitive information you do not want to store in the state. + +~> **Note:** If you get a `KMSAccessDeniedException: Lambda was unable to decrypt the environment variables because KMS access was denied` error when invoking a Lambda function with environment variables, the IAM role associated with the function may have been deleted and recreated after the function was created. You can fix the problem two ways: 1) updating the function's role to another role and then updating it back again to the recreated role, or 2) by using Terraform to `taint` the function and `apply` your configuration again to recreate the function. (When you create a function, Lambda grants permissions on the KMS key to the function's IAM role. If the IAM role is recreated, the grant is no longer valid. Changing the function's role or recreating the function causes Lambda to update the grant.) ## Example Usage -### Basic Example +### Generate Sensitive Configuration ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug import { Construct } from "constructs"; -import { TerraformOutput, Fn, TerraformStack } from "cdktf"; +import { + VariableType, + TerraformVariable, + TerraformOutput, + Fn, + Token, + TerraformStack, +} from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { SsmParameter } from "./.gen/providers/aws/ssm-parameter"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + /*Terraform Variables are not always the best fit for getting inputs in the context of Terraform CDK. + You can read more about this at https://cdk.tf/variables*/ + const environment = new TerraformVariable(this, "environment", { + description: "The environment name (e.g., dev, prod)", + type: VariableType.STRING, + }); + new TerraformOutput(this, "key_generated", { + value: "API key generated and stored in Parameter Store", + }); + new SsmParameter(this, "api_key", { + name: "/app/${" + environment.value + "}/api-key", + tags: { + Environment: environment.stringValue, + Generated: "ephemeral-lambda", + }, + type: "SecureString", + value: Token.asString( + Fn.lookupNested( + Fn.jsondecode(awsLambdaInvocation.secretGenerator.result), + ["api_key"] + ) + ), + }); + } +} + +``` + +### Dynamic Resource Configuration + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { Fn, Token, TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { AutoscalingGroup } from "./.gen/providers/aws/autoscaling-group"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + const sizing = Fn.jsondecode(awsLambdaInvocation.resourceCalculator.result); + new AutoscalingGroup(this, "example", { + desiredCapacity: Token.asNumber( + Fn.lookupNested(sizing, ["desired_instances"]) + ), + healthCheckType: "ELB", + launchTemplate: { + id: Token.asString(awsLaunchTemplateExample.id), + version: "$Latest", + }, + maxSize: Token.asNumber(Fn.lookupNested(sizing, ["max_instances"])), + minSize: Token.asNumber(Fn.lookupNested(sizing, ["min_instances"])), + name: "optimized-asg", + tag: [ + { + key: "OptimizedBy", + propagateAtLaunch: true, + value: "ephemeral-lambda", + }, + ], + targetGroupArns: [Token.asString(awsLbTargetGroupExample.arn)], + vpcZoneIdentifier: subnetIds.listValue, + }); + } +} + +``` + +### Validation and Compliance Checks + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { + VariableType, + TerraformVariable, + conditional, + Token, + TerraformCount, + Fn, + TerraformStack, +} from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { Resource } from "./.gen/providers/null/resource"; +import { Instance } from "./.gen/providers/aws/instance"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + /*Terraform Variables are not always the best fit for getting inputs in the context of Terraform CDK. + You can read more about this at https://cdk.tf/variables*/ + const instanceType = new TerraformVariable(this, "instance_type", { + description: "The EC2 instance type to use", + type: VariableType.STRING, + }); + const isCompliant = compliant; + const violations = validationResultViolations; + /*In most cases loops should be handled in the programming language context and + not inside of the Terraform context. If you are looping over something external, e.g. a variable or a file input + you should consider using a for loop. If you are looping over something only known to Terraform, e.g. a result of a data source + you need to keep this like it is.*/ + const exampleCount = TerraformCount.of( + Token.asNumber(conditional(isCompliant, 1, 0)) + ); + new Instance(this, "example", { + ami: Token.asString(dataAwsAmiExample.id), + instanceType: instanceType.stringValue, + rootBlockDevice: { + encrypted: encryptStorage.booleanValue, + }, + tags: { + ComplianceCheck: "passed", + Environment: environment.stringValue, + }, + count: exampleCount, + }); + /*In most cases loops should be handled in the programming language context and + not inside of the Terraform context. If you are looping over something external, e.g. a variable or a file input + you should consider using a for loop. If you are looping over something only known to Terraform, e.g. a result of a data source + you need to keep this like it is.*/ + const complianceGateCount = TerraformCount.of( + Token.asNumber(conditional(isCompliant, 0, 1)) + ); + new Resource(this, "compliance_gate", { + count: complianceGateCount, + provisioners: [ + { + type: "local-exec", + command: + "echo 'Compliance violations: " + + Token.asString(Fn.join(", ", Token.asList(violations))) + + "' && exit 1", + }, + ], + }); + } +} + +``` + +### External API Integration + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { Fn, Token, TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { EcsService } from "./.gen/providers/aws/ecs-service"; class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); - new TerraformOutput(this, "result_entry", { - value: Fn.lookupNested(Fn.jsondecode(example.result), ['"key1"']), + const externalConfig = Fn.jsondecode( + awsLambdaInvocation.externalConfig.result + ); + new EcsService(this, "example", { + cluster: Token.asString(awsEcsClusterExample.id), + deploymentConfiguration: { + maximum_percent: Fn.lookupNested(externalConfig, ["max_percent"]), + minimum_healthy_percent: Fn.lookupNested(externalConfig, [ + "min_healthy_percent", + ]), + }, + desiredCount: Token.asNumber( + Fn.lookupNested(externalConfig, ["replica_count"]) + ), + name: "web-app", + tags: { + ConfigSource: "external-api", + Environment: environment.stringValue, + }, + taskDefinition: Token.asString(awsEcsTaskDefinitionExample.arn), }); } } @@ -47,17 +237,115 @@ The following arguments are required: The following arguments are optional: * `clientContext` - (Optional) Up to 3583 bytes of base64-encoded data about the invoking client to pass to the function in the context object. -* `logType` - (Optional) Set to `Tail` to include the execution log in the response. Valid values are `None` and `Tail`. +* `logType` - (Optional) Set to `Tail` to include the execution log in the response. Valid values: `None` and `Tail`. * `qualifier` - (Optional) Version or alias to invoke a published version of the function. Defaults to `$LATEST`. +* `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). ## Attribute Reference -This resource exports the following attributes in addition to the arguments above: +This ephemeral resource exports the following attributes in addition to the arguments above: -* `executed_version` - Version of the function that executed. When you invoke a function with an alias, the version the alias resolved to. +* `executed_version` - Version of the function that executed. When you invoke a function with an alias, this shows the version the alias resolved to. * `function_error` - If present, indicates that an error occurred during function execution. Details about the error are included in `result`. * `log_result` - Last 4 KB of the execution log, which is base64-encoded. -* `result` - String result of the lambda function invocation. +* `result` - String result of the Lambda function invocation. * `statusCode` - HTTP status code is in the 200 range for a successful request. - \ No newline at end of file +## Usage Notes + +### Handling Sensitive Data + +Since ephemeral resources are designed to not persist data in state, they are ideal for handling sensitive information: + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { Token, TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { SecretsmanagerSecretVersion } from "./.gen/providers/aws/secretsmanager-secret-version"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + new SecretsmanagerSecretVersion(this, "example", { + secretId: Token.asString(awsSecretsmanagerSecretExample.id), + secretString: awsLambdaInvocation.credentials.result, + }); + } +} + +``` + +### Error Handling + +Always check for function errors in your configuration: + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { + Op, + Fn, + Token, + conditional, + TerraformCount, + TerraformStack, +} from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { Resource } from "./.gen/providers/null/resource"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + const hasError = Op.neq(awsLambdaInvocation.example.functionError, "null"); + const invocationResult = Fn.jsondecode(awsLambdaInvocation.example.result); + /*In most cases loops should be handled in the programming language context and + not inside of the Terraform context. If you are looping over something external, e.g. a variable or a file input + you should consider using a for loop. If you are looping over something only known to Terraform, e.g. a result of a data source + you need to keep this like it is.*/ + const validationCount = TerraformCount.of( + Token.asNumber( + conditional( + hasError, + fail( + "Lambda function error: " + + Token.asString( + Fn.lookupNested(invocationResult, ["errorMessage"]) + ) + ), + 0 + ) + ) + ); + new Resource(this, "validation", { + count: validationCount, + }); + } +} + +``` + +### Logging + +Enable detailed logging for debugging: + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { TerraformOutput, Fn, TerraformStack } from "cdktf"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + new TerraformOutput(this, "execution_logs", { + value: Fn.base64decode(awsLambdaInvocation.example.logResult), + }); + } +} + +``` + + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/ephemeral-resources/secretsmanager_random_password.html.markdown b/website/docs/cdktf/typescript/ephemeral-resources/secretsmanager_random_password.html.markdown index 69e3cb625a0d..d86710019b41 100644 --- a/website/docs/cdktf/typescript/ephemeral-resources/secretsmanager_random_password.html.markdown +++ b/website/docs/cdktf/typescript/ephemeral-resources/secretsmanager_random_password.html.markdown @@ -32,6 +32,7 @@ class MyConvertedCode extends TerraformStack { The following arguments are optional: +* `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). * `excludeCharacters` - (Optional) String of the characters that you don't want in the password. * `excludeLowercase` - (Optional) Specifies whether to exclude lowercase letters from the password. * `excludeNumbers` - (Optional) Specifies whether to exclude numbers from the password. @@ -47,4 +48,4 @@ This resource exports the following attributes in addition to the arguments abov * `randomPassword` - Random password. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/ephemeral-resources/secretsmanager_secret_version.html.markdown b/website/docs/cdktf/typescript/ephemeral-resources/secretsmanager_secret_version.html.markdown index 9f722d1d5093..f82e6a6d0337 100644 --- a/website/docs/cdktf/typescript/ephemeral-resources/secretsmanager_secret_version.html.markdown +++ b/website/docs/cdktf/typescript/ephemeral-resources/secretsmanager_secret_version.html.markdown @@ -12,7 +12,7 @@ description: |- Retrieve information about a Secrets Manager secret version, including its secret value. To retrieve secret metadata, see the [`aws_secretsmanager_secret` data source](/docs/providers/aws/d/secretsmanager_secret.html). -~> **NOTE:** Ephemeral resources are a new feature and may evolve as we continue to explore their most effective uses. [Learn more](https://developer.hashicorp.com/terraform/language/v1.10.x/resources/ephemeral). +~> **NOTE:** Ephemeral resources are a new feature and may evolve as we continue to explore their most effective uses. [Learn more](https://developer.hashicorp.com/terraform/language/resources/ephemeral). ## Example Usage @@ -72,6 +72,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `secretId` - (Required) Specifies the secret containing the version that you want to retrieve. You can specify either the ARN or the friendly name of the secret. * `versionId` - (Optional) Specifies the unique identifier of the version of the secret that you want to retrieve. Overrides `versionStage`. * `versionStage` - (Optional) Specifies the secret version that you want to retrieve by the staging label attached to the version. Defaults to `AWSCURRENT`. @@ -87,4 +88,4 @@ This resource exports the following attributes in addition to the arguments abov * `secretBinary` - Decrypted part of the protected secret information that was originally provided as a binary. * `versionId` - Unique identifier of this version of the secret. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/ephemeral-resources/ssm_parameter.html.markdown b/website/docs/cdktf/typescript/ephemeral-resources/ssm_parameter.html.markdown index 0cebc3c87be5..26f3ef4cd198 100644 --- a/website/docs/cdktf/typescript/ephemeral-resources/ssm_parameter.html.markdown +++ b/website/docs/cdktf/typescript/ephemeral-resources/ssm_parameter.html.markdown @@ -12,7 +12,7 @@ description: |- Retrieve information about an SSM parameter, including its value. -~> **NOTE:** Ephemeral resources are a new feature and may evolve as we continue to explore their most effective uses. [Learn more](https://developer.hashicorp.com/terraform/language/v1.10.x/resources/ephemeral). +~> **NOTE:** Ephemeral resources are a new feature and may evolve as we continue to explore their most effective uses. [Learn more](https://developer.hashicorp.com/terraform/language/resources/ephemeral). ## Example Usage @@ -36,6 +36,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `arn` - (Required) The Amazon Resource Name (ARN) of the parameter that you want to query * `withDecryption` - (Optional) Return decrypted values for a secure string parameter (Defaults to `true`). @@ -49,4 +50,4 @@ This resource exports the following attributes in addition to the arguments abov * `version` - The parameter version. * `withDecryption` - Indicates whether the secure string parameters were decrypted. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/guides/custom-service-endpoints.html.markdown b/website/docs/cdktf/typescript/guides/custom-service-endpoints.html.markdown index c6c0045f5259..bd24b344b14c 100644 --- a/website/docs/cdktf/typescript/guides/custom-service-endpoints.html.markdown +++ b/website/docs/cdktf/typescript/guides/custom-service-endpoints.html.markdown @@ -134,6 +134,7 @@ class MyConvertedCode extends TerraformStack { |App Runner|`apprunner`|`AWS_ENDPOINT_URL_APPRUNNER`|`apprunner`| |AppStream 2.0|`appstream`|`AWS_ENDPOINT_URL_APPSTREAM`|`appstream`| |AppSync|`appsync`|`AWS_ENDPOINT_URL_APPSYNC`|`appsync`| +|Application Resilience Controller Region Switch|`arcregionswitch`|`AWS_ENDPOINT_URL_ARC_REGION_SWITCH`|`arc_region_switch`| |Athena|`athena`|`AWS_ENDPOINT_URL_ATHENA`|`athena`| |Audit Manager|`auditmanager`|`AWS_ENDPOINT_URL_AUDITMANAGER`|`auditmanager`| |Auto Scaling|`autoscaling`|`AWS_ENDPOINT_URL_AUTO_SCALING`|`auto_scaling`| @@ -143,6 +144,7 @@ class MyConvertedCode extends TerraformStack { |BCM Data Exports|`bcmdataexports`|`AWS_ENDPOINT_URL_BCM_DATA_EXPORTS`|`bcm_data_exports`| |Bedrock|`bedrock`|`AWS_ENDPOINT_URL_BEDROCK`|`bedrock`| |Bedrock Agents|`bedrockagent`|`AWS_ENDPOINT_URL_BEDROCK_AGENT`|`bedrock_agent`| +|Bedrock AgentCore|`bedrockagentcore`|`AWS_ENDPOINT_URL_BEDROCK_AGENTCORE_CONTROL`|`bedrock_agentcore_control`| |Billing|`billing`|`AWS_ENDPOINT_URL_BILLING`|`billing`| |Web Services Budgets|`budgets`|`AWS_ENDPOINT_URL_BUDGETS`|`budgets`| |CE (Cost Explorer)|`ce`(or `costexplorer`)|`AWS_ENDPOINT_URL_COST_EXPLORER`|`cost_explorer`| @@ -240,8 +242,6 @@ class MyConvertedCode extends TerraformStack { |CloudWatch Internet Monitor|`internetmonitor`|`AWS_ENDPOINT_URL_INTERNETMONITOR`|`internetmonitor`| |Invoicing|`invoicing`|`AWS_ENDPOINT_URL_INVOICING`|`invoicing`| |IoT Core|`iot`|`AWS_ENDPOINT_URL_IOT`|`iot`| -|IoT Analytics|`iotanalytics`|`AWS_ENDPOINT_URL_IOTANALYTICS`|`iotanalytics`| -|IoT Events|`iotevents`|`AWS_ENDPOINT_URL_IOT_EVENTS`|`iotEvents`| |IVS (Interactive Video)|`ivs`|`AWS_ENDPOINT_URL_IVS`|`ivs`| |IVS (Interactive Video) Chat|`ivschat`|`AWS_ENDPOINT_URL_IVSCHAT`|`ivschat`| |Managed Streaming for Kafka|`kafka`(or `msk`)|`AWS_ENDPOINT_URL_KAFKA`|`kafka`| @@ -284,9 +284,9 @@ class MyConvertedCode extends TerraformStack { |User Notifications|`notifications`|`AWS_ENDPOINT_URL_NOTIFICATIONS`|`notifications`| |User Notifications Contacts|`notificationscontacts`|`AWS_ENDPOINT_URL_NOTIFICATIONSCONTACTS`|`notificationscontacts`| |CloudWatch Observability Access Manager|`oam`(or `cloudwatchobservabilityaccessmanager`)|`AWS_ENDPOINT_URL_OAM`|`oam`| +|Oracle Database@AWS|`odb`|`AWS_ENDPOINT_URL_ODB`|`odb`| |OpenSearch|`opensearch`(or `opensearchservice`)|`AWS_ENDPOINT_URL_OPENSEARCH`|`opensearch`| |OpenSearch Serverless|`opensearchserverless`|`AWS_ENDPOINT_URL_OPENSEARCHSERVERLESS`|`opensearchserverless`| -|OpsWorks|`opsworks`|`AWS_ENDPOINT_URL_OPSWORKS`|`opsworks`| |Organizations|`organizations`|`AWS_ENDPOINT_URL_ORGANIZATIONS`|`organizations`| |OpenSearch Ingestion|`osis`(or `opensearchingestion`)|`AWS_ENDPOINT_URL_OSIS`|`osis`| |Outposts|`outposts`|`AWS_ENDPOINT_URL_OUTPOSTS`|`outposts`| @@ -324,6 +324,7 @@ class MyConvertedCode extends TerraformStack { |S3 Control|`s3Control`|`AWS_ENDPOINT_URL_S3_CONTROL`|`s3_control`| |S3 on Outposts|`s3Outposts`|`AWS_ENDPOINT_URL_S3OUTPOSTS`|`s3Outposts`| |S3 Tables|`s3Tables`|`AWS_ENDPOINT_URL_S3TABLES`|`s3Tables`| +|S3 Vectors|`s3Vectors`|`AWS_ENDPOINT_URL_S3VECTORS`|`s3Vectors`| |SageMaker AI|`sagemaker`|`AWS_ENDPOINT_URL_SAGEMAKER`|`sagemaker`| |EventBridge Scheduler|`scheduler`|`AWS_ENDPOINT_URL_SCHEDULER`|`scheduler`| |EventBridge Schemas|`schemas`|`AWS_ENDPOINT_URL_SCHEMAS`|`schemas`| @@ -340,7 +341,6 @@ class MyConvertedCode extends TerraformStack { |SFN (Step Functions)|`sfn`(or `stepfunctions`)|`AWS_ENDPOINT_URL_SFN`|`sfn`| |Shield|`shield`|`AWS_ENDPOINT_URL_SHIELD`|`shield`| |Signer|`signer`|`AWS_ENDPOINT_URL_SIGNER`|`signer`| -|SDB (SimpleDB)|`simpledb`(or `sdb`)|`AWS_ENDPOINT_URL_SIMPLEDB`|`simpledb`| |SNS (Simple Notification)|`sns`|`AWS_ENDPOINT_URL_SNS`|`sns`| |SQS (Simple Queue)|`sqs`|`AWS_ENDPOINT_URL_SQS`|`sqs`| |SSM (Systems Manager)|`ssm`|`AWS_ENDPOINT_URL_SSM`|`ssm`| @@ -366,7 +366,6 @@ class MyConvertedCode extends TerraformStack { |WAF Classic Regional|`wafregional`|`AWS_ENDPOINT_URL_WAF_REGIONAL`|`waf_regional`| |WAF|`wafv2`|`AWS_ENDPOINT_URL_WAFV2`|`wafv2`| |Well-Architected Tool|`wellarchitected`|`AWS_ENDPOINT_URL_WELLARCHITECTED`|`wellarchitected`| -|WorkLink|`worklink`|`AWS_ENDPOINT_URL_WORKLINK`|`worklink`| |WorkSpaces|`workspaces`|`AWS_ENDPOINT_URL_WORKSPACES`|`workspaces`| |WorkSpaces Web|`workspacesweb`|`AWS_ENDPOINT_URL_WORKSPACES_WEB`|`workspaces_web`| |X-Ray|`xray`|`AWS_ENDPOINT_URL_XRAY`|`xray`| @@ -477,4 +476,4 @@ class MyConvertedCode extends TerraformStack { ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/guides/enhanced-region-support.html.markdown b/website/docs/cdktf/typescript/guides/enhanced-region-support.html.markdown new file mode 100644 index 000000000000..5349fcc4befe --- /dev/null +++ b/website/docs/cdktf/typescript/guides/enhanced-region-support.html.markdown @@ -0,0 +1,713 @@ +--- +subcategory: "" +layout: "aws" +page_title: "Terraform AWS Provider Enhanced Region Support" +description: |- + Enhanced Region support with the Terraform AWS Provider. +--- + + + +# Enhanced Region Support + +Version 6.0.0 of the Terraform AWS Provider adds `region` to most resources making it significantly easier to manage infrastructure across AWS Regions without requiring multiple provider configurations. + + + +- [What's new](#whats-new) +- [What's not changing](#whats-not-changing) +- [Can I use `region` in every resource?](#can-i-use-region-in-every-resource) +- [Why make this change](#why-make-this-change) +- [How `region` works](#how-region-works) +- [Migrating from multiple provider configurations](#migrating-from-multiple-provider-configurations) +- [Before and after examples using `region`](#before-and-after-examples-using-region) +- [Non–region-aware resources](#nonregion-aware-resources) + + + +## What's new + +As of v6.0.0, most existing resources, data sources, and ephemeral resources are now [Region-aware](#nonregion-aware-resources), meaning they support a new top-level `region`. This allows you to manage a resource in a Region different from the one specified in the provider configuration without requiring multiple provider blocks. See [How `region` works](#how-region-works) for details. + +For example, if your provider is configured for `us-east-1`, you can now manage a VPC in `us-west-2` without defining an additional provider block: + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { Vpc } from "./.gen/providers/aws/vpc"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + new Vpc(this, "peer", { + cidrBlock: "10.1.0.0/16", + region: "us-west-2", + }); + } +} + +``` + +## What's _not_ changing + +_Pre-v6.0.0 configurations that use provider blocks per Region remain valid in v6.0.0 and are not deprecated._ + +You can still define the Region at the provider level using any of the existing methods—for example, through the AWS [config file](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html), [provider configuration](https://developer.hashicorp.com/terraform/language/providers/configuration), [environment variables](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#environment-variables), [shared configuration files](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#shared-configuration-and-credentials-files), or explicitly using the `provider`’s [`region`](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#region). + +## Can I use `region` in every resource? + +No. While most resources are now Region-aware, there are exceptions. These include a few resources that already had a `region` and resources that are inherently global. See [Non–region-aware resources](#nonregion-aware-resources). + +## Why make this change + +Before version 6.0.0, managing infrastructure across multiple Regions required a separate provider configuration for each Region. This approach led to complex and repetitive configurations, especially for large infrastructures—AWS currently operates in [36 Regions](https://aws.amazon.com/about-aws/global-infrastructure/), with more announced. Additionally, each provider configuration adds overhead in terms of memory and compute resources. + +See the [examples](#before-and-after-examples-using-region) below for a comparison of configurations before and after introducing `region`. + +## How `region` works + +The new top-level `region` is [_Optional_ and _Computed_](https://developer.hashicorp.com/terraform/plugin/framework/handling-data/attributes/string#configurability), and defaults to the Region specified in the provider configuration. Its value is validated to ensure it belongs to the configured [partition](https://docs.aws.amazon.com/whitepapers/latest/aws-fault-isolation-boundaries/partitions.html). **Changing the value of `region` will force resource replacement.** + +To [import](https://developer.hashicorp.com/terraform/cli/import) a resource in a specific Region, append `@` to the [import ID](https://developer.hashicorp.com/terraform/language/import#import-id)—for example: + +```sh +terraform import aws_vpc.test_vpc vpc-a01106c2@eu-west-1 +``` + +## Migrating from multiple provider configurations + +To migrate from a separate provider configuration for each Region to a single provider configuration block and per-resource `region` values you must ensure that Terraform state is refreshed before editing resource configuration: + +1. Upgrade to v6.0.0 +2. Run a Terraform apply in [refresh-only mode](https://developer.hashicorp.com/terraform/cli/commands/plan#planning-modes) -- `terraform apply -refresh-only` +3. Modify the affected resource configurations, replacing the [`provider` meta-argument](https://developer.hashicorp.com/terraform/language/meta-arguments/resource-provider) with a `region` argument + +## Before and after examples using `region` + +### Cross-region VPC peering + +
+Before, Pre-v6.0.0 +

+ +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { Token, TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { DataAwsCallerIdentity } from "./.gen/providers/aws/data-aws-caller-identity"; +import { AwsProvider } from "./.gen/providers/aws/provider"; +import { Vpc } from "./.gen/providers/aws/vpc"; +import { VpcPeeringConnection } from "./.gen/providers/aws/vpc-peering-connection"; +import { VpcPeeringConnectionAccepterA } from "./.gen/providers/aws/vpc-peering-connection-accepter"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + new AwsProvider(this, "aws", { + region: "us-east-1", + }); + const peer = new AwsProvider(this, "aws_1", { + alias: "peer", + region: "us-west-2", + }); + const main = new Vpc(this, "main", { + cidrBlock: "10.0.0.0/16", + }); + const awsVpcPeer = new Vpc(this, "peer", { + cidrBlock: "10.1.0.0/16", + provider: peer, + }); + const dataAwsCallerIdentityPeer = new DataAwsCallerIdentity( + this, + "peer_4", + { + provider: peer, + } + ); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + dataAwsCallerIdentityPeer.overrideLogicalId("peer"); + const awsVpcPeeringConnectionPeer = new VpcPeeringConnection( + this, + "peer_5", + { + autoAccept: false, + peerOwnerId: Token.asString(dataAwsCallerIdentityPeer.accountId), + peerRegion: "us-west-2", + peerVpcId: Token.asString(awsVpcPeer.id), + vpcId: main.id, + } + ); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + awsVpcPeeringConnectionPeer.overrideLogicalId("peer"); + const awsVpcPeeringConnectionAccepterPeer = + new VpcPeeringConnectionAccepterA(this, "peer_6", { + autoAccept: true, + provider: peer, + vpcPeeringConnectionId: Token.asString(awsVpcPeeringConnectionPeer.id), + }); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + awsVpcPeeringConnectionAccepterPeer.overrideLogicalId("peer"); + } +} + +``` + +

+
+ +
+After, v6.0.0+ +

+ +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { Token, TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { AwsProvider } from "./.gen/providers/aws/provider"; +import { Vpc } from "./.gen/providers/aws/vpc"; +import { VpcPeeringConnection } from "./.gen/providers/aws/vpc-peering-connection"; +import { VpcPeeringConnectionAccepterA } from "./.gen/providers/aws/vpc-peering-connection-accepter"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + new AwsProvider(this, "aws", { + region: "us-east-1", + }); + const main = new Vpc(this, "main", { + cidrBlock: "10.0.0.0/16", + }); + const peer = new Vpc(this, "peer", { + cidrBlock: "10.1.0.0/16", + region: "us-west-2", + }); + const awsVpcPeeringConnectionPeer = new VpcPeeringConnection( + this, + "peer_3", + { + autoAccept: false, + peerRegion: "us-west-2", + peerVpcId: peer.id, + vpcId: main.id, + } + ); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + awsVpcPeeringConnectionPeer.overrideLogicalId("peer"); + const awsVpcPeeringConnectionAccepterPeer = + new VpcPeeringConnectionAccepterA(this, "peer_4", { + autoAccept: true, + region: "us-west-2", + vpcPeeringConnectionId: Token.asString(awsVpcPeeringConnectionPeer.id), + }); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + awsVpcPeeringConnectionAccepterPeer.overrideLogicalId("peer"); + } +} + +``` + +

+
+ +### KMS replica key + +
+Before, Pre-v6.0.0 +

+ +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { Token, TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { KmsKey } from "./.gen/providers/aws/kms-key"; +import { KmsReplicaKey } from "./.gen/providers/aws/kms-replica-key"; +import { AwsProvider } from "./.gen/providers/aws/provider"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + const primary = new AwsProvider(this, "aws", { + alias: "primary", + region: "us-east-1", + }); + new AwsProvider(this, "aws_1", { + region: "us-west-2", + }); + const awsKmsKeyPrimary = new KmsKey(this, "primary", { + deletionWindowInDays: 30, + description: "Multi-Region primary key", + multiRegion: true, + provider: primary, + }); + new KmsReplicaKey(this, "replica", { + deletionWindowInDays: 7, + description: "Multi-Region replica key", + primaryKeyArn: Token.asString(awsKmsKeyPrimary.arn), + }); + } +} + +``` + +

+
+ +
+After, v6.0.0 +

+ +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { KmsKey } from "./.gen/providers/aws/kms-key"; +import { KmsReplicaKey } from "./.gen/providers/aws/kms-replica-key"; +import { AwsProvider } from "./.gen/providers/aws/provider"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + new AwsProvider(this, "aws", { + region: "us-west-2", + }); + const primary = new KmsKey(this, "primary", { + deletionWindowInDays: 30, + description: "Multi-Region primary key", + multiRegion: true, + region: "us-east-1", + }); + new KmsReplicaKey(this, "replica", { + deletionWindowInDays: 7, + description: "Multi-Region replica key", + primaryKeyArn: primary.arn, + }); + } +} + +``` + +

+
+ +### S3 bucket replication configuration + +
+Before, Pre-v6.0.0 +

+ +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { Token, TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { DataAwsIamPolicyDocument } from "./.gen/providers/aws/data-aws-iam-policy-document"; +import { IamPolicy } from "./.gen/providers/aws/iam-policy"; +import { IamRole } from "./.gen/providers/aws/iam-role"; +import { IamRolePolicyAttachment } from "./.gen/providers/aws/iam-role-policy-attachment"; +import { AwsProvider } from "./.gen/providers/aws/provider"; +import { S3Bucket } from "./.gen/providers/aws/s3-bucket"; +import { S3BucketAcl } from "./.gen/providers/aws/s3-bucket-acl"; +import { S3BucketReplicationConfigurationA } from "./.gen/providers/aws/s3-bucket-replication-configuration"; +import { S3BucketVersioningA } from "./.gen/providers/aws/s3-bucket-versioning"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + new AwsProvider(this, "aws", { + region: "eu-west-1", + }); + const central = new AwsProvider(this, "aws_1", { + alias: "central", + region: "eu-central-1", + }); + const destination = new S3Bucket(this, "destination", { + bucket: "tf-test-bucket-destination-12345", + }); + const source = new S3Bucket(this, "source", { + bucket: "tf-test-bucket-source-12345", + provider: central, + }); + new S3BucketAcl(this, "source_bucket_acl", { + acl: "private", + bucket: source.id, + provider: central, + }); + const awsS3BucketVersioningDestination = new S3BucketVersioningA( + this, + "destination_5", + { + bucket: destination.id, + versioningConfiguration: { + status: "Enabled", + }, + } + ); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + awsS3BucketVersioningDestination.overrideLogicalId("destination"); + const awsS3BucketVersioningSource = new S3BucketVersioningA( + this, + "source_6", + { + bucket: source.id, + provider: central, + versioningConfiguration: { + status: "Enabled", + }, + } + ); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + awsS3BucketVersioningSource.overrideLogicalId("source"); + const assumeRole = new DataAwsIamPolicyDocument(this, "assume_role", { + statement: [ + { + actions: ["sts:AssumeRole"], + effect: "Allow", + principals: [ + { + identifiers: ["s3.amazonaws.com"], + type: "Service", + }, + ], + }, + ], + }); + const replication = new DataAwsIamPolicyDocument(this, "replication", { + statement: [ + { + actions: ["s3:GetReplicationConfiguration", "s3:ListBucket"], + effect: "Allow", + resources: [source.arn], + }, + { + actions: [ + "s3:GetObjectVersionForReplication", + "s3:GetObjectVersionAcl", + "s3:GetObjectVersionTagging", + ], + effect: "Allow", + resources: ["${" + source.arn + "}/*"], + }, + { + actions: [ + "s3:ReplicateObject", + "s3:ReplicateDelete", + "s3:ReplicateTags", + ], + effect: "Allow", + resources: ["${" + destination.arn + "}/*"], + }, + ], + }); + const awsIamPolicyReplication = new IamPolicy(this, "replication_9", { + name: "tf-iam-role-policy-replication-12345", + policy: Token.asString(replication.json), + }); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + awsIamPolicyReplication.overrideLogicalId("replication"); + const awsIamRoleReplication = new IamRole(this, "replication_10", { + assumeRolePolicy: Token.asString(assumeRole.json), + name: "tf-iam-role-replication-12345", + }); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + awsIamRoleReplication.overrideLogicalId("replication"); + const awsIamRolePolicyAttachmentReplication = new IamRolePolicyAttachment( + this, + "replication_11", + { + policyArn: Token.asString(awsIamPolicyReplication.arn), + role: Token.asString(awsIamRoleReplication.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.*/ + awsIamRolePolicyAttachmentReplication.overrideLogicalId("replication"); + const awsS3BucketReplicationConfigurationReplication = + new S3BucketReplicationConfigurationA(this, "replication_12", { + bucket: source.id, + dependsOn: [awsS3BucketVersioningSource], + provider: central, + role: Token.asString(awsIamRoleReplication.arn), + rule: [ + { + destination: { + bucket: destination.arn, + storageClass: "STANDARD", + }, + filter: { + prefix: "example", + }, + id: "examplerule", + status: "Enabled", + }, + ], + }); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + awsS3BucketReplicationConfigurationReplication.overrideLogicalId( + "replication" + ); + } +} + +``` + +

+
+ +
+After, v6.0.0 +

+ +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { Token, TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { DataAwsIamPolicyDocument } from "./.gen/providers/aws/data-aws-iam-policy-document"; +import { IamPolicy } from "./.gen/providers/aws/iam-policy"; +import { IamRole } from "./.gen/providers/aws/iam-role"; +import { IamRolePolicyAttachment } from "./.gen/providers/aws/iam-role-policy-attachment"; +import { AwsProvider } from "./.gen/providers/aws/provider"; +import { S3Bucket } from "./.gen/providers/aws/s3-bucket"; +import { S3BucketAcl } from "./.gen/providers/aws/s3-bucket-acl"; +import { S3BucketReplicationConfigurationA } from "./.gen/providers/aws/s3-bucket-replication-configuration"; +import { S3BucketVersioningA } from "./.gen/providers/aws/s3-bucket-versioning"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + new AwsProvider(this, "aws", { + region: "eu-west-1", + }); + const destination = new S3Bucket(this, "destination", { + bucket: "tf-test-bucket-destination-12345", + }); + const source = new S3Bucket(this, "source", { + bucket: "tf-test-bucket-source-12345", + region: "eu-central-1", + }); + new S3BucketAcl(this, "source_bucket_acl", { + acl: "private", + bucket: source.id, + region: "eu-central-1", + }); + const awsS3BucketVersioningDestination = new S3BucketVersioningA( + this, + "destination_4", + { + bucket: destination.id, + versioningConfiguration: { + status: "Enabled", + }, + } + ); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + awsS3BucketVersioningDestination.overrideLogicalId("destination"); + const awsS3BucketVersioningSource = new S3BucketVersioningA( + this, + "source_5", + { + bucket: source.id, + region: "eu-central-1", + versioningConfiguration: { + status: "Enabled", + }, + } + ); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + awsS3BucketVersioningSource.overrideLogicalId("source"); + const assumeRole = new DataAwsIamPolicyDocument(this, "assume_role", { + statement: [ + { + actions: ["sts:AssumeRole"], + effect: "Allow", + principals: [ + { + identifiers: ["s3.amazonaws.com"], + type: "Service", + }, + ], + }, + ], + }); + const replication = new DataAwsIamPolicyDocument(this, "replication", { + statement: [ + { + actions: ["s3:GetReplicationConfiguration", "s3:ListBucket"], + effect: "Allow", + resources: [source.arn], + }, + { + actions: [ + "s3:GetObjectVersionForReplication", + "s3:GetObjectVersionAcl", + "s3:GetObjectVersionTagging", + ], + effect: "Allow", + resources: ["${" + source.arn + "}/*"], + }, + { + actions: [ + "s3:ReplicateObject", + "s3:ReplicateDelete", + "s3:ReplicateTags", + ], + effect: "Allow", + resources: ["${" + destination.arn + "}/*"], + }, + ], + }); + const awsIamPolicyReplication = new IamPolicy(this, "replication_8", { + name: "tf-iam-role-policy-replication-12345", + policy: Token.asString(replication.json), + }); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + awsIamPolicyReplication.overrideLogicalId("replication"); + const awsIamRoleReplication = new IamRole(this, "replication_9", { + assumeRolePolicy: Token.asString(assumeRole.json), + name: "tf-iam-role-replication-12345", + }); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + awsIamRoleReplication.overrideLogicalId("replication"); + const awsIamRolePolicyAttachmentReplication = new IamRolePolicyAttachment( + this, + "replication_10", + { + policyArn: Token.asString(awsIamPolicyReplication.arn), + role: Token.asString(awsIamRoleReplication.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.*/ + awsIamRolePolicyAttachmentReplication.overrideLogicalId("replication"); + const awsS3BucketReplicationConfigurationReplication = + new S3BucketReplicationConfigurationA(this, "replication_11", { + bucket: source.id, + dependsOn: [awsS3BucketVersioningSource], + region: "eu-central-1", + role: Token.asString(awsIamRoleReplication.arn), + rule: [ + { + destination: { + bucket: destination.arn, + storageClass: "STANDARD", + }, + filter: { + prefix: "example", + }, + id: "examplerule", + status: "Enabled", + }, + ], + }); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + awsS3BucketReplicationConfigurationReplication.overrideLogicalId( + "replication" + ); + } +} + +``` + +

+
+ +## Non–region-aware resources + +This section lists resources that are not Region-aware—meaning `region` has not been added to them. + +Some resources, such as [IAM and STS](https://docs.aws.amazon.com/IAM/latest/UserGuide/programming.html#IAMEndpoints), are [global](https://docs.aws.amazon.com/whitepapers/latest/aws-fault-isolation-boundaries/global-services.html) and exist in all Regions within a partition. + +Other resources are not Region-aware because they already had a top-level `region`, are inherently global, or because adding `region` would not be appropriate for other reasons. + +### Resources deprecating `region` + +The following regional resources and data sources had a top-level `region` prior to version 6.0.0. It is now deprecated and will be replaced in a future version to support the new Region-aware behavior. + +* `aws_cloudformation_stack_set_instance` resource +* `aws_config_aggregate_authorization` resource +* `aws_dx_hosted_connection` resource +* `awsRegion` data source +* `aws_s3_bucket` data source +* `aws_servicequotas_template` resource +* `aws_servicequotas_templates` data source +* `aws_ssmincidents_replication_set` resource and data source +* `aws_vpc_endpoint_service` data source +* `aws_vpc_peering_connection` data source + +### Global services + +All resources for the following services are considered _global_: + +* Account Management (`aws_account_*`) +* Billing (`aws_billing_*`) +* Billing and Cost Management Data Exports (`aws_bcmdataexports_*`) +* Budgets (`aws_budgets_*`) +* CloudFront (`aws_cloudfront_*` and `aws_cloudfrontkeyvaluestore_*`) +* Cost Explorer (`aws_ce_*`) +* Cost Optimization Hub (`aws_costoptimizationhub_*`) +* Cost and Usage Report (`aws_cur_*`) +* Global Accelerator (`aws_globalaccelerator_*`) +* IAM (`aws_iam_*`, `aws_rolesanywhere_*` and `aws_caller_identity`) +* Network Manager (`aws_networkmanager_*`) +* Organizations (`aws_organizations_*`) +* Price List (`aws_pricing_*`) +* Route 53 (`aws_route53_*` and `aws_route53domains_*`) +* Route 53 ARC (`aws_route53recoverycontrolconfig_*` and `aws_route53recoveryreadiness_*`) +* Shield Advanced (`aws_shield_*`) +* User Notifications (`aws_notifications_*`) +* User Notifications Contacts (`aws_notificationscontacts_*`) +* WAF Classic (`aws_waf_*`) + +### Global resources in regional services + +Some regional services have a subset of resources that are global: + +| Service | Type | Name | +|---|---|---| +| Backup | Resource | `aws_backup_global_settings` | +| Chime SDK Voice | Resource | `aws_chimesdkvoice_global_settings` | +| CloudTrail | Resource | `aws_cloudtrail_organization_delegated_admin_account` | +| Direct Connect | Resource | `aws_dx_gateway` | +| Direct Connect | Data Source | `aws_dx_gateway` | +| EC2 | Resource | `aws_ec2_image_block_public_access` | +| Firewall Manager | Resource | `aws_fms_admin_account` | +| IPAM | Resource | `aws_vpc_ipam_organization_admin_account` | +| QuickSight | Resource | `aws_quicksight_account_settings` | +| Resource Access Manager | Resource | `aws_ram_sharing_with_organization` | +| S3 | Data Source | `aws_canonical_user_id` | +| S3 | Resource | `aws_s3_account_public_access_block` | +| S3 | Data Source | `aws_s3_account_public_access_block` | +| Service Catalog | Resource | `aws_servicecatalog_organizations_access` | + +### Meta data sources + +The `aws_default_tags`, `aws_partition`, and `aws_regions` data sources are effectively global. + +`region` of the `aws_arn` data source stays as-is. + +### Policy Document Data Sources + +Some data sources convert HCL into JSON policy documents and are effectively global: + +* `aws_cloudwatch_log_data_protection_policy_document` +* `aws_ecr_lifecycle_policy_document` + + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/guides/version-6-upgrade.html.markdown b/website/docs/cdktf/typescript/guides/version-6-upgrade.html.markdown new file mode 100644 index 000000000000..d9fa38f2cc11 --- /dev/null +++ b/website/docs/cdktf/typescript/guides/version-6-upgrade.html.markdown @@ -0,0 +1,777 @@ +--- +subcategory: "" +layout: "aws" +page_title: "Terraform AWS Provider Version 6 Upgrade Guide" +description: |- + Terraform AWS Provider Version 6 Upgrade Guide +--- + + + +# Terraform AWS Provider Version 6 Upgrade Guide + +Version 6.0.0 of the AWS provider for Terraform is a major release and includes changes that you need to consider when upgrading. This guide will help with that process and focuses only on changes from version 5.x to version 6.0.0. See the [Version 5 Upgrade Guide](/docs/providers/aws/guides/version-5-upgrade.html) for information on upgrading from 4.x to version 5.0.0. + +Upgrade topics: + + + +- [Prerequisites to Upgrade to v6.0.0](#prerequisites-to-upgrade-to-v600) +- [Removed Provider Arguments](#removed-provider-arguments) +- [Enhanced Region Support](#enhanced-region-support) +- [Amazon Elastic Transcoder Deprecation](#amazon-elastic-transcoder-deprecation) +- [CloudWatch Evidently Deprecation](#cloudwatch-evidently-deprecation) +- [Nullable Boolean Validation Update](#nullable-boolean-validation-update) +- [OpsWorks Stacks Removal](#opsworks-stacks-removal) +- [S3 Global Endpoint Deprecation](#s3-global-endpoint-deprecation) +- [SimpleDB Support Removed](#simpledb-support-removed) +- [Worklink Support Removed](#worklink-support-removed) +- [Data Source `aws_ami`](#data-source-aws_ami) +- [Data Source `aws_batch_compute_environment`](#data-source-aws_batch_compute_environment) +- [Data Source `aws_ecs_task_definition`](#data-source-aws_ecs_task_definition) +- [Data Source `aws_ecs_task_execution`](#data-source-aws_ecs_task_execution) +- [Data Source `aws_elbv2_listener_rule`](#data-source-aws_elbv2_listener_rule) +- [Data Source `aws_globalaccelerator_accelerator`](#data-source-aws_globalaccelerator_accelerator) +- [Data Source `aws_identitystore_group`](#data-source-aws_identitystore_group) +- [Data Source `aws_identitystore_user`](#data-source-aws_identitystore_user) +- [Data Source `aws_kms_secret`](#data-source-aws_kms_secret) +- [Data Source `aws_launch_template`](#data-source-aws_launch_template) +- [Data Source `aws_opensearch_domain`](#data-source-aws_opensearch_domain) +- [Data Source `aws_opensearchserverless_security_config`](#data-source-aws_opensearchserverless_security_config) +- [Data Source `aws_quicksight_data_set`](#data-source-aws_quicksight_data_set) +- [Data Source `awsRegion`](#data-source-aws_region) +- [Data Source `aws_s3_bucket`](#data-source-aws_s3_bucket) +- [Data Source `aws_service_discovery_service`](#data-source-aws_service_discovery_service) +- [Data Source `aws_servicequotas_templates`](#data-source-aws_servicequotas_templates) +- [Data Source `aws_ssmincidents_replication_set`](#data-source-aws_ssmincidents_replication_set) +- [Data Source `aws_vpc_endpoint_service`](#data-source-aws_vpc_endpoint_service) +- [Data Source `aws_vpc_peering_connection`](#data-source-aws_vpc_peering_connection) +- [Resource `aws_accessanalyzer_archive_rule`](#typenullablebool-validation-update) +- [Resource `aws_alb_target_group`](#typenullablebool-validation-update) +- [Resource `aws_api_gateway_account`](#resource-aws_api_gateway_account) +- [Resource `aws_api_gateway_deployment`](#resource-aws_api_gateway_deployment) +- [Resource `aws_appflow_connector_profile`](#resource-aws_appflow_connector_profile) +- [Resource `aws_appflow_flow`](#resource-aws_appflow_flow) +- [Resource `aws_batch_compute_environment`](#resource-aws_batch_compute_environment) +- [Resource `aws_batch_job_queue`](#resource-aws_batch_job_queue) +- [Resource `aws_bedrock_model_invocation_logging_configuration`](#resource-aws_bedrock_model_invocation_logging_configuration) +- [Resource `aws_cloudformation_stack_set_instance`](#resource-aws_cloudformation_stack_set_instance) +- [Resource `aws_cloudfront_key_value_store`](#resource-aws_cloudfront_key_value_store) +- [Resource `aws_cloudfront_response_headers_policy`](#resource-aws_cloudfront_response_headers_policy) +- [Resource `aws_cloudtrail_event_data_store`](#typenullablebool-validation-update) +- [Resource `aws_cognito_user_in_group`](#resource-aws_cognito_user_in_group) +- [Resource `aws_config_aggregate_authorization`](#resource-aws_config_aggregate_authorization) +- [Resource `aws_cur_report_definition`](#resource-aws_cur_report_definition) +- [Resource `aws_db_instance`](#resource-aws_db_instance) +- [Resource `aws_dms_endpoint`](#resource-aws_dms_endpoint) +- [Resource `aws_dx_gateway_association`](#resource-aws_dx_gateway_association) +- [Resource `aws_dx_hosted_connection`](#resource-aws_dx_hosted_connection) +- [Resource `aws_ec2_spot_instance_fleet`](#typenullablebool-validation-update) +- [Resource `aws_ecs_task_definition`](#resource-aws_ecs_task_definition) +- [Resource `aws_eip`](#resource-aws_eip) +- [Resource `aws_eks_addon`](#resource-aws_eks_addon) +- [Resource `aws_elasticache_cluster`](#typenullablebool-validation-update) +- [Resource `aws_elasticache_replication_group`](#resource-aws_elasticache_replication_group) +- [Resource `aws_elasticache_user`](#resource-aws_elasticache_user) +- [Resource `aws_elasticache_user_group`](#resource-aws_elasticache_user_group) +- [Resource `aws_evidently_feature`](#typenullablebool-validation-update) +- [Resource `aws_flow_log`](#resource-aws_flow_log) +- [Resource `aws_guardduty_detector`](#resource-aws_guardduty_detector) +- [Resource `aws_guardduty_organization_configuration`](#resource-aws_guardduty_organization_configuration) +- [Resource `aws_imagebuilder_container_recipe`](#typenullablebool-validation-update) +- [Resource `aws_imagebuilder_image_recipe`](#typenullablebool-validation-update) +- [Resource `aws_instance`](#resource-aws_instance) +- [Resource `aws_kinesis_analytics_application`](#resource-aws_kinesis_analytics_application) +- [Resource `aws_launch_template`](#resource-aws_launch_template) +- [Resource `aws_lb_listener`](#resource-aws_lb_listener) +- [Resource `aws_lb_target_group`](#typenullablebool-validation-update) +- [Resource `aws_media_store_container`](#resource-aws_media_store_container) +- [Resource `aws_media_store_container_policy`](#resource-aws_media_store_container_policy) +- [Resource `aws_mq_broker`](#typenullablebool-validation-update) +- [Resource `aws_networkmanager_core_network`](#resource-aws_networkmanager_core_network) +- [Resource `aws_opensearch_domain`](#resource-aws_opensearch_domain) +- [Resource `aws_opensearchserverless_security_config`](#resource-aws_opensearchserverless_security_config) +- [Resource `aws_paymentcryptography_key`](#resource-aws_paymentcryptography_key) +- [Resource `aws_redshift_cluster`](#resource-aws_redshift_cluster) +- [Resource `aws_redshift_service_account`](#resource-aws_redshift_service_account) +- [Resource `aws_rekognition_stream_processor`](#resource-aws_rekognition_stream_processor) +- [Resource `aws_resiliencehub_resiliency_policy`](#resource-aws_resiliencehub_resiliency_policy) +- [Resource `aws_s3_bucket`](#resource-aws_s3_bucket) +- [Resource `aws_sagemaker_image_version`](#resource-aws_sagemaker_image_version) +- [Resource `aws_sagemaker_notebook_instance`](#resource-aws_sagemaker_notebook_instance) +- [Resource `aws_servicequotas_template`](#resource-aws_servicequotas_template) +- [Resource `aws_spot_instance_request`](#resource-aws_spot_instance_request) +- [Resource `aws_ssm_association`](#resource-aws_ssm_association) +- [Resource `aws_ssmincidents_replication_set`](#resource-aws_ssmincidents_replication_set) +- [Resource `aws_verifiedpermissions_schema`](#resource-aws_verifiedpermissions_schema) +- [Resource `aws_wafv2_web_acl`](#resource-aws_wafv2_web_acl) + + + +## Prerequisites to Upgrade to v6.0.0 + +-> Before upgrading to version `6.0.0`, first upgrade to the latest available `5.x` version of the provider. Run [`terraform plan`](https://developer.hashicorp.com/terraform/cli/commands/plan) and confirm that: + +- Your plan completes without errors or unexpected changes. +- There are no deprecation warnings related to the changes described in this guide. + +If you use [version constraints](https://developer.hashicorp.com/terraform/language/providers/requirements#provider-versions) (recommended), update them to allow the `6.x` series and run [`terraform init -upgrade`](https://developer.hashicorp.com/terraform/cli/commands/init) to download the new version. + +### Example + +**Before:** + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { AwsProvider } from "./.gen/providers/aws/provider"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + new AwsProvider(this, "aws", {}); + } +} + +``` + +**After:** + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { AwsProvider } from "./.gen/providers/aws/provider"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + new AwsProvider(this, "aws", {}); + } +} + +``` + +## Removed Provider Arguments + +Remove the following from your provider configuration—they are no longer supported: + +- `endpoints.opsworks` – removed following AWS OpsWorks Stacks End of Life. +- `endpoints.simpledb` and `endpoints.sdb` – removed due to the removal of Amazon SimpleDB support. +- `endpoints.worklink` – removed due to the removal of Amazon Worklink support. + +## Enhanced Region Support + +Version 6.0.0 adds `region` to most resources making it significantly easier to manage infrastructure across AWS Regions without requiring multiple provider configurations. See [Enhanced Region Support](enhanced-region-support.html). + +## Amazon Elastic Transcoder Deprecation + +Amazon Elastic Transcoder will be [discontinued](https://aws.amazon.com/blogs/media/support-for-amazon-elastic-transcoder-ending-soon/) on **November 13, 2025**. + +The following resources are deprecated and will be removed in a future major release: + +- `aws_elastictranscoder_pipeline` +- `aws_elastictranscoder_preset` + +Use [AWS Elemental MediaConvert](https://aws.amazon.com/blogs/media/migrating-workflows-from-amazon-elastic-transcoder-to-aws-elemental-mediaconvert/) instead. + +## CloudWatch Evidently Deprecation + +AWS will [end support](https://aws.amazon.com/blogs/mt/support-for-amazon-cloudwatch-evidently-ending-soon/) for CloudWatch Evidently on **October 17, 2025**. + +The following resources are deprecated and will be removed in a future major release: + +- `aws_evidently_feature` +- `aws_evidently_launch` +- `aws_evidently_project` +- `aws_evidently_segment` + +Migrate to [AWS AppConfig Feature Flags](https://aws.amazon.com/blogs/mt/using-aws-appconfig-feature-flags/). + +## Nullable Boolean Validation Update + +Update your configuration to _only_ use `""`, `true`, or `false` if you use the arguments below _and_ you are using `0` or `1` to represent boolean values: + +| Resource | Attribute(s) | +|-----------------------------------------|--------------------------------------------------------------------------| +| `aws_accessanalyzer_archive_rule` | `filter.exists` | +| `aws_alb_target_group` | `preserveClientIp` | +| `aws_cloudtrail_event_data_store` | `suspend` | +| `aws_ec2_spot_instance_fleet` | `terminateInstancesOnDelete` | +| `aws_elasticache_cluster` | `autoMinorVersionUpgrade` | +| `aws_elasticache_replication_group` | `atRestEncryptionEnabled`, `autoMinorVersionUpgrade` | +| `aws_evidently_feature` | `variations.value.bool_value` | +| `aws_imagebuilder_container_recipe` | `instance_configuration.block_device_mapping.ebs.delete_on_termination`, `instance_configuration.block_device_mapping.ebs.encrypted` | +| `aws_imagebuilder_image_recipe` | `block_device_mapping.ebs.delete_on_termination`, `block_device_mapping.ebs.encrypted` | +| `aws_launch_template` | `block_device_mappings.ebs.delete_on_termination`, `block_device_mappings.ebs.encrypted`, `ebsOptimized`, `network_interfaces.associate_carrier_ip_address`, `network_interfaces.associate_public_ip_address`, `network_interfaces.delete_on_termination`, `network_interfaces.primary_ipv6` | +| `aws_lb_target_group` | `preserveClientIp` | +| `aws_mq_broker` | `logs.audit` | + +This is due to changes to `TypeNullableBool`. + +## OpsWorks Stacks Removal + +The AWS OpsWorks Stacks service has reached [End of Life](https://docs.aws.amazon.com/opsworks/latest/userguide/stacks-eol-faqs.html). The following resources have been removed: + +- `aws_opsworks_application` +- `aws_opsworks_custom_layer` +- `aws_opsworks_ecs_cluster_layer` +- `aws_opsworks_ganglia_layer` +- `aws_opsworks_haproxy_layer` +- `aws_opsworks_instance` +- `aws_opsworks_java_app_layer` +- `aws_opsworks_memcached_layer` +- `aws_opsworks_mysql_layer` +- `aws_opsworks_nodejs_app_layer` +- `aws_opsworks_permission` +- `aws_opsworks_php_app_layer` +- `aws_opsworks_rails_app_layer` +- `aws_opsworks_rds_db_instance` +- `aws_opsworks_stack` +- `aws_opsworks_static_web_layer` +- `aws_opsworks_user_profile` + +## SimpleDB Support Removed + +The `aws_simpledb_domain` resource has been removed, as the [AWS SDK for Go v2](https://docs.aws.amazon.com/sdk-for-go/v2/developer-guide/welcome.html) no longer supports Amazon SimpleDB. + +## Worklink Support Removed + +The following resources have been removed due to dropped support for Amazon Worklink in the [AWS SDK for Go v2](https://github.com/aws/aws-sdk-go-v2/pull/2814): + +- `aws_worklink_fleet` +- `aws_worklink_website_certificate_authority_association` + +## S3 Global Endpoint Deprecation + +Support for the global S3 endpoint is deprecated. This affects S3 resources in `us-east-1` (excluding directory buckets) when `s3UsEast1RegionalEndpoint` is set to `legacy`. + +`s3UsEast1RegionalEndpoint` will be removed in `v7.0.0`. + +To prepare: + +- Remove `s3UsEast1RegionalEndpoint` from your provider configuration, **or** +- Set its value to `regional` and verify functionality. + +## Data Source `aws_ami` + +When using `most_recent = true`, your configuration **must now include** an `owner` or a `filter` that identifies the image by `image-id` or `owner-id`. + +- **Before (v5 and earlier):** + Terraform allowed this setup and showed only a warning. + +- **Now (v6+):** + Terraform will stop with an **error** to prevent unsafe or ambiguous AMI lookups. + +### How to fix it + +Do one of the following: + +- Add `owner`: + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { TerraformStack } from "cdktf"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + } +} + +``` + +- Or add a `filter` block that includes either `image-id` or `owner-id`: + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { TerraformStack } from "cdktf"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + } +} + +``` + +### Unsafe option (not recommended) + +To override this check, you can set: + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { TerraformStack } from "cdktf"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + } +} + +``` + +However, this may lead to unreliable results and should be avoided unless absolutely necessary. + +## Data Source `aws_batch_compute_environment` + +`compute_environment_name` has been renamed to `name`. + +Update your configurations to replace any usage of `compute_environment_name` with `name` to use this version. + +## Data Source `aws_ecs_task_definition` + +Remove `inference_accelerator`—it is no longer supported. Amazon Elastic Inference reached end of life in April 2024. + +## Data Source `aws_ecs_task_execution` + +Remove `inference_accelerator_overrides`—it is no longer supported. Amazon Elastic Inference reached end of life in April 2024. + +## Data Source `aws_elbv2_listener_rule` + +Treat the following as lists of nested blocks instead of single-nested blocks: + +- `action.authenticate_cognito` +- `action.authenticate_oidc` +- `action.fixed_response` +- `action.forward` +- `action.forward.stickiness` +- `action.redirect` +- `condition.host_header` +- `condition.http_header` +- `condition.http_request_method` +- `condition.path_pattern` +- `condition.query_string` +- `condition.source_ip` + +The data source configuration itself does not change. However, now, include an index when referencing them. For example, update `action[0].authenticate_cognito.scope` to `action[0].authenticate_cognito[0].scope`. + +## Data Source `aws_globalaccelerator_accelerator` + +`id` is now **computed only** and can no longer be set manually. +If your configuration explicitly attempts to set a value for `id`, you must remove it to avoid an error. + +## Data Source `aws_identitystore_group` + +Remove `filter`—it is no longer supported. To locate a group, update your configuration to use `alternateIdentifier` instead. + +## Data Source `aws_identitystore_user` + +Remove `filter`—it is no longer supported. +To locate a user, update your configuration to use `alternateIdentifier` instead. + +## Data Source `aws_kms_secret` + +The functionality for this data source was removed in **v2.0.0** and the data source will be removed in a future version. + +## Data Source `aws_launch_template` + +Remove the following—they are no longer supported: + +- `elastic_gpu_specifications`: Amazon Elastic Graphics reached end of life in January 2024. +- `elastic_inference_accelerator`: Amazon Elastic Inference reached end of life in April 2024. + +## Data Source `aws_opensearch_domain` + +Remove `kibanaEndpoint`—it is no longer supported. AWS OpenSearch Service no longer uses Kibana endpoints. The service now uses **Dashboards**, accessible at the `/_dashboards/` path on the domain endpoint. +For more details, refer to the [AWS OpenSearch Dashboards documentation](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/dashboards.html). + +## Data Source `aws_opensearchserverless_security_config` + +Treat `samlOptions` as a list of nested blocks instead of a single-nested block. The data source configuration itself does not change. However, now, include an index when referencing it. For example, update `saml_options.session_timeout` to `saml_options[0].session_timeout`. + +## Data Source `aws_quicksight_data_set` + +Remove `tagsAll`—it is no longer supported. + +## Data Source `awsRegion` + +`name` has been deprecated. Use `region` instead. + +## Data Source `aws_s3_bucket` + +`bucketRegion` has been added and should be used instead of `region`, which is now used for [Enhanced Region Support](enhanced-region-support.html). + +## Data Source `aws_service_discovery_service` + +Remove `tagsAll`—it is no longer supported. + +## Data Source `aws_servicequotas_templates` + +`region` has been deprecated. Use `awsRegion` instead. + +## Data Source `aws_ssmincidents_replication_set` + +`region` has been deprecated. Use `regions` instead. + +## Data Source `aws_vpc_endpoint_service` + +`region` has been deprecated. Use `serviceRegion` instead. + +## Data Source `aws_vpc_peering_connection` + +`region` has been deprecated. Use `requesterRegion` instead. + +## Resource `aws_api_gateway_account` + +Remove `reset_on_delete`—it is no longer supported. The destroy operation will now always reset the API Gateway account settings by default. + +If you want to retain the previous behavior (where the account settings were not changed upon destruction), use a `removed` block in your configuration. For more details, see the [removing resources documentation](https://developer.hashicorp.com/terraform/language/resources/syntax#removing-resources). + +## Resource `aws_api_gateway_deployment` + +* Use the `aws_api_gateway_stage` resource if your configuration uses any of the following, which have been removed from the `aws_api_gateway_deployment` resource: + - `stageName` + - `stage_description` + - `canarySettings` +* Remove `invokeUrl` and `executionArn`—they are no longer supported. Use the `aws_api_gateway_stage` resource instead. + +### Migration Example + +**Before (v5 and earlier, using implicit stage):** + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { Token, TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { ApiGatewayDeployment } from "./.gen/providers/aws/api-gateway-deployment"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + new ApiGatewayDeployment(this, "example", { + restApiId: Token.asString(awsApiGatewayRestApiExample.id), + stage_name: "prod", + }); + } +} + +``` + +**After (v6+, using explicit stage):** + +If your previous configuration relied on an implicitly created stage, you must now define and manage that stage explicitly using the `aws_api_gateway_stage` resource. To do this, create a corresponding resource and import the existing stage into your configuration. + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { Token, TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { ApiGatewayDeployment } from "./.gen/providers/aws/api-gateway-deployment"; +import { ApiGatewayStage } from "./.gen/providers/aws/api-gateway-stage"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + const example = new ApiGatewayDeployment(this, "example", { + restApiId: Token.asString(awsApiGatewayRestApiExample.id), + }); + new ApiGatewayStage(this, "prod", { + deploymentId: example.id, + restApiId: Token.asString(awsApiGatewayRestApiExample.id), + stageName: "prod", + }); + } +} + +``` + +Import the existing stage, replacing `restApiId` and `stageName` with your values: + +```sh +terraform import aws_api_gateway_stage.prod rest_api_id/stage_name +``` + +## Resource `aws_appflow_connector_profile` + +Importing an `aws_appflow_connector_profile` resource now uses the `name` of the Connector Profile. + +## Resource `aws_appflow_flow` + +Importing an `aws_appflow_flow` resource now uses the `name` of the Flow. + +## Resource `aws_batch_compute_environment` + +Replace any usage of `compute_environment_name` with `name` and `compute_environment_name_prefix` with `namePrefix` as they have been renamed. + +## Resource `aws_batch_job_queue` + +Remove `compute_environments`—it is no longer supported. +Use `computeEnvironmentOrder` configuration blocks instead. While you must update your configuration, Terraform will upgrade states with `compute_environments` to `computeEnvironmentOrder`. + +**Before (v5 and earlier):** + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { BatchJobQueue } from "./.gen/providers/aws/batch-job-queue"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + new BatchJobQueue(this, "example", { + compute_environments: [awsBatchComputeEnvironmentExample.arn], + name: "patagonia", + priority: 1, + state: "ENABLED", + }); + } +} + +``` + +**After (v6+):** + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { Token, TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { BatchJobQueue } from "./.gen/providers/aws/batch-job-queue"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + new BatchJobQueue(this, "example", { + computeEnvironmentOrder: [ + { + computeEnvironment: Token.asString( + awsBatchComputeEnvironmentExample.arn + ), + order: 0, + }, + ], + name: "patagonia", + priority: 1, + state: "ENABLED", + }); + } +} + +``` + +## Resource `aws_bedrock_model_invocation_logging_configuration` + +Treat the following as lists of nested blocks instead of single-nested blocks: + +- `loggingConfig` +- `logging_config.cloudwatch_config` +- `logging_config.cloudwatch_config.large_data_delivery_s3_config` +- `logging_config.s3_config` + +The resource configuration itself does not change, but you must now include an index when referencing them. For example, update `logging_config.cloudwatch_config.log_group_name` to `logging_config[0].cloudwatch_config[0].log_group_name`. + +## Resource `aws_cloudformation_stack_set_instance` + +`region` has been deprecated. Use `stackSetInstanceRegion` instead. + +## Resource `aws_cloudfront_key_value_store` + +Use `name` to reference the resource name. `id` represents the ID value returned by the AWS API. + +## Resource `aws_cloudfront_response_headers_policy` + +Do not set a value for `etag` as it is now computed only. + +## Resource `aws_cognito_user_in_group` + +For the `id`, use a comma-delimited string concatenating `userPoolId`, `groupName`, and `username`. For example, in an import command, use comma-delimiting for the composite `id`. + +## Resource `aws_config_aggregate_authorization` + +`region` has been deprecated. Use `authorizedAwsRegion` instead. + +## Resource `aws_cur_report_definition` + +`s3Prefix` is now required. + +## Resource `aws_db_instance` + +Do not use `characterSetName` with `replicateSourceDb`, `restoreToPointInTime`, `s3Import`, or `snapshotIdentifier`. The combination is no longer valid. + +## Resource `aws_dms_endpoint` + +`s3Settings` has been removed. Use the `aws_dms_s3_endpoint` resource rather than `s3Settings` of `aws_dms_endpoint`. + +## Resource `aws_dx_gateway_association` + +Remove `vpnGatewayId`—it is no longer supported. Use `associatedGatewayId` instead. + +## Resource `aws_dx_hosted_connection` + +`region` has been deprecated. Use `connectionRegion` instead. + +## Resource `aws_ecs_task_definition` + +Remove `inference_accelerator`—it is no longer supported. Amazon Elastic Inference reached end of life in April 2024. + +## Resource `aws_eip` + +Remove `vpc`—it is no longer supported. Use `domain` instead. + +## Resource `aws_eks_addon` + +Remove `resolve_conflicts`—it is no longer supported. Use `resolveConflictsOnCreate` and `resolveConflictsOnUpdate` instead. + +## Resource `aws_elasticache_replication_group` + +* `authTokenUpdateStrategy` no longer has a default value. If `authToken` is set, it must also be explicitly configured. +* The ability to provide an uppercase `engine` value is deprecated. In `v7.0.0`, plan-time validation of `engine` will require an entirely lowercase value to match the returned value from the AWS API without diff suppression. +* See also [changes](#typenullablebool-validation-update) to `atRestEncryptionEnabled` and `autoMinorVersionUpgrade`. + +## Resource `aws_elasticache_user` + +The ability to provide an uppercase `engine` value is deprecated. +In `v7.0.0`, plan-time validation of `engine` will require an entirely lowercase value to match the returned value from the AWS API without diff suppression. + +## Resource `aws_elasticache_user_group` + +The ability to provide an uppercase `engine` value is deprecated. +In `v7.0.0`, plan-time validation of `engine` will require an entirely lowercase value to match the returned value from the AWS API without diff suppression. + +## Resource `aws_flow_log` + +Remove `logGroupName`—it is no longer supported. Use `logDestination` instead. + +## Resource `aws_guardduty_detector` + +`datasources` is deprecated. +Use the `aws_guardduty_detector_feature` resource instead. + +## Resource `aws_guardduty_organization_configuration` + +* Remove `autoEnable`—it is no longer supported. +* `autoEnableOrganizationMembers` is now required. +* `datasources` is deprecated. + +## Resource `aws_instance` + +* `userData` no longer applies hashing and is now stored in clear text. **Do not include passwords or sensitive information** in `userData`, as it will be visible in plaintext. Follow [AWS Best Practices](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html) to secure your instance metadata. If you need to provide base64-encoded user data, use `userDataBase64` instead. +* Remove `cpu_core_count` and `cpu_threads_per_core`—they are no longer supported. Instead, use the `cpuOptions` configuration block with `coreCount` and `threadsPerCore`. + +## Resource `aws_kinesis_analytics_application` + +This resource is deprecated and will be removed in a future version. [Effective January 27, 2026](https://aws.amazon.com/blogs/big-data/migrate-from-amazon-kinesis-data-analytics-for-sql-to-amazon-managed-service-for-apache-flink-and-amazon-managed-service-for-apache-flink-studio/), AWS will [no longer support](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/discontinuation.html) Amazon Kinesis Data Analytics for SQL. Use the `aws_kinesisanalyticsv2_application` resource instead to manage Amazon Kinesis Data Analytics for Apache Flink applications. AWS provides guidance for migrating from [Amazon Kinesis Data Analytics for SQL Applications to Amazon Managed Service for Apache Flink Studio](https://aws.amazon.com/blogs/big-data/migrate-from-amazon-kinesis-data-analytics-for-sql-applications-to-amazon-managed-service-for-apache-flink-studio/) including [examples](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/migrating-to-kda-studio-overview.html). + +## Resource `aws_launch_template` + +* Remove `elastic_gpu_specifications`—it is no longer supported. Amazon Elastic Graphics reached end of life in January 2024. +* Remove `elastic_inference_accelerator`—it is no longer supported. Amazon Elastic Inference reached end of life in April 2024. +* See also [changes](#typenullablebool-validation-update) to `block_device_mappings.ebs.delete_on_termination`, `block_device_mappings.ebs.encrypted`, `ebsOptimized`, `network_interfaces.associate_carrier_ip_address`, `network_interfaces.associate_public_ip_address`, `network_interfaces.delete_on_termination`, and `network_interfaces.primary_ipv6`. + +## Resource `aws_lb_listener` + +* For `mutualAuthentication`, `advertiseTrustStoreCaNames`, `ignoreClientCertificateExpiry`, and `trustStoreArn` can now only be set when `mode` is `verify`. +* `trustStoreArn` is required when `mode` is `verify`. + +## Resource `aws_media_store_container` + +This resource is deprecated and will be removed in a future version. AWS has [announced](https://aws.amazon.com/blogs/media/support-for-aws-elemental-mediastore-ending-soon/) the discontinuation of AWS Elemental MediaStore, effective November 13, 2025. Users should begin transitioning to alternative solutions as soon as possible. For simple live streaming workflows, AWS recommends migrating to Amazon S3. For advanced use cases that require features such as packaging, DRM, or cross-region redundancy, consider using AWS Elemental MediaPackage. + +## Resource `aws_media_store_container_policy` + +This resource is deprecated and will be removed in a future version. AWS has [announced](https://aws.amazon.com/blogs/media/support-for-aws-elemental-mediastore-ending-soon/) the discontinuation of AWS Elemental MediaStore, effective November 13, 2025. Users should begin transitioning to alternative solutions as soon as possible. For simple live streaming workflows, AWS recommends migrating to Amazon S3. For advanced use cases that require features such as packaging, DRM, or cross-region redundancy, consider using AWS Elemental MediaPackage. + +## Resource `aws_networkmanager_core_network` + +Remove `base_policy_region`—it is no longer supported. Use `basePolicyRegions` instead. + +## Resource `aws_opensearch_domain` + +Remove `kibanaEndpoint`—it is no longer supported. AWS OpenSearch Service does not use Kibana endpoints (i.e., `_plugin/kibana`). Instead, OpenSearch uses Dashboards, accessible at the path `/_dashboards/` on the domain endpoint. The terminology has shifted from “Kibana” to “Dashboards.” + +For more information, see the [AWS OpenSearch Dashboards documentation](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/dashboards.html). + +## Resource `aws_opensearchserverless_security_config` + +Treat `samlOptions` as a list of nested blocks instead of a single-nested block. The resource configuration itself does not change. However, now, include an index when referencing it. For example, update `saml_options.session_timeout` to `saml_options[0].session_timeout`. + +## Resource `aws_paymentcryptography_key` + +Treat the `keyAttributes` and `key_attributes.key_modes_of_use` as lists of nested blocks instead of single-nested blocks. The resource configuration itself does not change. However, now, include an index when referencing them. For example, update `key_attributes.key_modes_of_use.decrypt` to `key_attributes[0].key_modes_of_use[0].decrypt`. + +## Resource `aws_redshift_cluster` + +* `encrypted` now defaults to `true`. +* `publiclyAccessible` now defaults to `false`. +* Remove `snapshot_copy`—it is no longer supported. Use the `aws_redshift_snapshot_copy` resource instead. +* Remove `logging`—it is no longer supported. Use the `aws_redshift_logging` resource instead. +* `clusterPublicKey`, `clusterRevisionNumber`, and `endpoint` are now read only and should not be set. + +## Resource `aws_redshift_service_account` + +The `aws_redshift_service_account` resource has been removed. AWS [recommends](https://docs.aws.amazon.com/redshift/latest/mgmt/db-auditing.html#db-auditing-bucket-permissions) that a [service principal name](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html#principal-services) should be used instead of an AWS account ID in any relevant IAM policy. + +## Resource `aws_rekognition_stream_processor` + +Treat `regions_of_interest.bounding_box` as a list of nested blocks instead of a single-nested block. The resource configuration itself does not change. However, now, include an index when referencing it. For example, update `regions_of_interest[0].bounding_box.height` to `regions_of_interest[0].bounding_box[0].height`. + +## Resource `aws_resiliencehub_resiliency_policy` + +Treat the following as lists of nested blocks instead of single-nested blocks: + +- `policy` +- `policy.az` +- `policy.hardware` +- `policy.software` +- `policy.region` + +The resource configuration itself does not change. However, now, include an index when referencing them. For example, update `policy.az.rpo` to `policy[0].az[0].rpo`. + +## Resource `aws_s3_bucket` + +`bucketRegion` has been added and should be used instead of `region`, which is now used for [Enhanced Region Support](enhanced-region-support.html). + +## Resource `aws_sagemaker_image_version` + +For the `id`, use a comma-delimited string concatenating `imageName` and `version`. For example, in an import command, use comma-delimiting for the composite `id`. +Use `imageName` to reference the image name. + +## Resource `aws_sagemaker_notebook_instance` + +Remove `acceleratorTypes`—it is no longer supported. Instead, use `instanceType` to use [Inferentia](https://docs.aws.amazon.com/sagemaker/latest/dg/neo-supported-cloud.html). + +## Resource `aws_servicequotas_template` + +`region` has been deprecated. Use `awsRegion` instead. + +## Resource `aws_spot_instance_request` + +Remove `blockDurationMinutes`—it is no longer supported. + +## Resource `aws_ssm_association` + +Remove `instanceId`—it is no longer supported. Use `targets` instead. + +## Resource `aws_ssmincidents_replication_set` + +`region` has been deprecated. Use `regions` instead. + +## Resource `aws_verifiedpermissions_schema` + +Treat `definition` as a list of nested blocks instead of a single-nested block. The resource configuration itself does not change. However, now, include an index when referencing it. For example, update `definition.value` to `definition[0].value`. + +## Resource `aws_wafv2_web_acl` + +The default value for `rule.statement.managed_rule_group_statement.managed_rule_group_configs.aws_managed_rules_bot_control_rule_set.enable_machine_learning` is now `false`. +To retain the previous behavior where the argument was omitted, explicitly set the value to `true`. + + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/index.html.markdown b/website/docs/cdktf/typescript/index.html.markdown index 43166ac2d987..5ff551941d19 100644 --- a/website/docs/cdktf/typescript/index.html.markdown +++ b/website/docs/cdktf/typescript/index.html.markdown @@ -9,18 +9,13 @@ description: |- # AWS Provider -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. +The Amazon Web Services (AWS) provider is Terraform’s most widely-used provider and the industry-standard way to manage AWS infrastructure as code. It is an indispensable part of how leading technology companies, global banks, government agencies, and some of the largest enterprises in the world build and operate in the cloud. Every day, it provisions and orchestrates billions of dollars of AWS infrastructure across thousands of organizations. -Use the navigation to the left to read about the available resources. There are currently 1514 resources and 608 data sources available in the provider. +With 1,523 resources and 609 data sources, the AWS provider spans the full breadth of AWS services—from foundational capabilities like compute, storage, networking, and identity management to advanced services for AI, analytics, and event-driven architectures, including Lambda, RDS, SageMaker, and Bedrock. Whether automating a single S3 bucket or orchestrating a multi-region, enterprise-scale environment, the provider delivers consistent, reliable workflows that scale with your needs. -To learn the basics of Terraform using this provider, follow the -hands-on [get started tutorials](https://developer.hashicorp.com/terraform/tutorials/aws-get-started/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, -including Lambda, RDS, and IAM by following the [AWS services -tutorials](https://developer.hashicorp.com/terraform/tutorials/aws?utm_source=WEBSITE&utm_medium=WEB_IO&utm_offer=ARTICLE_PAGE&utm_content=DOCS). +Configure the provider with your AWS credentials, and you can immediately begin creating and managing infrastructure in a safe, repeatable way. Use the navigation on the left to explore the available resources, or start with our [Get Started tutorials](https://developer.hashicorp.com/terraform/tutorials/aws-get-started/infrastructure-as-code?in=terraform/aws-get-started&utm_source=WEBSITE&utm_medium=WEB_IO&utm_offer=ARTICLE_PAGE&utm_content=DOCS) to learn the fundamentals. For deeper guidance on specific AWS services, visit the [AWS services tutorials](https://developer.hashicorp.com/terraform/tutorials/aws?utm_source=WEBSITE&utm_medium=WEB_IO&utm_offer=ARTICLE_PAGE&utm_content=DOCS). -Some AWS services do not support IPv6. As a result, the provider may not be able to interact with AWS APIs using IPv6 addresses. +Note: Some AWS services do not yet support IPv6. In those cases, the provider may not be able to connect to AWS APIs over IPv6 addresses. ## Example Usage @@ -481,17 +476,19 @@ In addition to [generic `provider` arguments](https://www.terraform.io/docs/conf Can also be set with either the `AWS_REGION` or `AWS_DEFAULT_REGION` environment variables, or via a shared config file parameter `region` if `profile` is used. If credentials are retrieved from the EC2 Instance Metadata Service, the Region can also be retrieved from the metadata. + Most Regional resources, data sources and ephemeral resources support an optional top-level `region` argument which can be used to override the provider configuration value. See the individual resource's documentation for details. * `retryMode` - (Optional) Specifies how retries are attempted. Valid values are `standard` and `adaptive`. Can also be configured using the `AWS_RETRY_MODE` environment variable or the shared config file parameter `retryMode`. * `s3UsePathStyle` - (Optional) Whether to enable the request to use path-style addressing, i.e., `https://s3.amazonaws.com/BUCKET/KEY`. By default, the S3 client will use virtual hosted bucket addressing, `https://BUCKET.s3.amazonaws.com/KEY`, when possible. Specific to the Amazon S3 service. -* `s3UsEast1RegionalEndpoint` - (Optional) Specifies whether S3 API calls in the `us-east-1` Region use the legacy global endpoint or a regional endpoint. +* `s3UsEast1RegionalEndpoint` - (Optional, **Deprecated**) Specifies whether S3 API calls in the `us-east-1` Region use the legacy global endpoint or a regional endpoint. Valid values are `legacy` or `regional`. If omitted, the default behavior in the `us-east-1` Region is to use the global endpoint for general purpose buckets and the regional endpoint for directory buckets. Can also be configured using the `AWS_S3_US_EAST_1_REGIONAL_ENDPOINT` environment variable or the `s3UsEast1RegionalEndpoint` shared config file parameter. Specific to the Amazon S3 service. + This argument and the ability to use the global S3 endpoint are deprecated and will be removed in `v7.0.0`. * `secretKey` - (Optional) AWS secret key. Can also be set with the `AWS_SECRET_ACCESS_KEY` environment variable, or via a shared configuration and credentials files if `profile` is used. See also `accessKey`. * `sharedConfigFiles` - (Optional) List of paths to AWS shared config files. If not set, the default is `[~/.aws/config]`. A single value can also be set with the `AWS_CONFIG_FILE` environment variable. * `sharedCredentialsFiles` - (Optional) List of paths to the shared credentials file. If not set and a profile is used, the default value is `[~/.aws/credentials]`. A single value can also be set with the `AWS_SHARED_CREDENTIALS_FILE` environment variable. @@ -951,4 +948,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. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/accessanalyzer_analyzer.html.markdown b/website/docs/cdktf/typescript/r/accessanalyzer_analyzer.html.markdown index 4b82a7242cb9..ca84cca9c054 100644 --- a/website/docs/cdktf/typescript/r/accessanalyzer_analyzer.html.markdown +++ b/website/docs/cdktf/typescript/r/accessanalyzer_analyzer.html.markdown @@ -70,7 +70,7 @@ class MyConvertedCode extends TerraformStack { ``` -### Organization Unused Access Analyzer with analysis rule +### Organization Unused Access Analyzer With Analysis Rule ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -88,25 +88,23 @@ class MyConvertedCode extends TerraformStack { analyzerName: "example", configuration: { unusedAccess: { - analysis_rule: [ - { - exclusion: [ - { - account_ids: ["123456789012", "234567890123"], - }, - { - resource_tags: [ - { - key1: "value1", - }, - { - key2: "value2", - }, - ], - }, - ], - }, - ], + analysisRule: { + exclusion: [ + { + accountIds: ["123456789012", "234567890123"], + }, + { + resourceTags: [ + { + key1: "value1", + }, + { + key2: "value2", + }, + ], + }, + ], + }, unusedAccessAge: 180, }, }, @@ -117,6 +115,79 @@ class MyConvertedCode extends TerraformStack { ``` +### Account Internal Access Analyzer by Resource Types + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { AccessanalyzerAnalyzer } from "./.gen/providers/aws/accessanalyzer-analyzer"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + new AccessanalyzerAnalyzer(this, "test", { + analyzerName: "example", + configuration: { + internalAccess: { + analysisRule: { + inclusion: [ + { + resourceTypes: [ + "AWS::S3::Bucket", + "AWS::RDS::DBSnapshot", + "AWS::DynamoDB::Table", + ], + }, + ], + }, + }, + }, + type: "ORGANIZATION_INTERNAL_ACCESS", + }); + } +} + +``` + +### Organization Internal Access Analyzer by Account ID and Resource ARN + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { AccessanalyzerAnalyzer } from "./.gen/providers/aws/accessanalyzer-analyzer"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + new AccessanalyzerAnalyzer(this, "test", { + analyzerName: "example", + configuration: { + internalAccess: { + analysisRule: { + inclusion: [ + { + accountIds: ["123456789012"], + resourceArns: ["arn:aws:s3:::my-example-bucket"], + }, + ], + }, + }, + }, + type: "ORGANIZATION_INTERNAL_ACCESS", + }); + } +} + +``` + ## Argument Reference The following arguments are required: @@ -125,34 +196,64 @@ The following arguments are required: The following arguments are optional: -* `configuration` - (Optional) A block that specifies the configuration of the analyzer. [Documented below](#configuration-argument-reference) +* `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). +* `configuration` - (Optional) A block that specifies the configuration of the analyzer. See [`configuration` Block](#configuration-block) for details. * `tags` - (Optional) Key-value map of resource tags. If configured with a provider [`defaultTags` 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. -* `type` - (Optional) Type of Analyzer. Valid values are `ACCOUNT`, `ORGANIZATION`, `ACCOUNT_UNUSED_ACCESS `, `ORGANIZATION_UNUSED_ACCESS`. Defaults to `ACCOUNT`. +* `type` - (Optional) Type that represents the zone of trust or scope for the analyzer. Valid values are `ACCOUNT`, `ACCOUNT_INTERNAL_ACCESS`, `ACCOUNT_UNUSED_ACCESS`, `ORGANIZATION`, `ORGANIZATION_INTERNAL_ACCESS`, `ORGANIZATION_UNUSED_ACCESS`. Defaults to `ACCOUNT`. + +### `configuration` Block + +The `configuration` configuration block supports the following arguments: + +* `internalAccess` - (Optional) Specifies the configuration of an internal access analyzer for an AWS organization or account. This configuration determines how the analyzer evaluates access within your AWS environment. See [`internalAccess` Block](#internal_access-block) for details. +* `unusedAccess` - (Optional) Specifies the configuration of an unused access analyzer for an AWS organization or account. See [`unusedAccess` Block](#unused_access-block) for details. + +### `internalAccess` Block + +The `internalAccess` configuration block supports the following arguments: + +* `analysisRule` - (Optional) Information about analysis rules for the internal access analyzer. These rules determine which resources and access patterns will be analyzed. See [`analysisRule` Block for Internal Access Analyzer](#analysis_rule-block-for-internal-access-analyzer) for details. + +### `analysisRule` Block for Internal Access Analyzer + +The `analysisRule` configuration block for internal access analyzer supports the following arguments: + +* `inclusion` - (Optional) List of rules for the internal access analyzer containing criteria to include in analysis. Only resources that meet the rule criteria will generate findings. See [`inclusion` Block](#inclusion-block) for details. + +### `inclusion` Block + +The `inclusion` configuration block supports the following arguments: + +* `accountIds` - (Optional) List of AWS account IDs to apply to the internal access analysis rule criteria. Account IDs can only be applied to the analysis rule criteria for organization-level analyzers. +* `resourceArns` - (Optional) List of resource ARNs to apply to the internal access analysis rule criteria. The analyzer will only generate findings for resources that match these ARNs. +* `resourceTypes` - (Optional) List of resource types to apply to the internal access analysis rule criteria. The analyzer will only generate findings for resources of these types. Refer to [InternalAccessAnalysisRuleCriteria](https://docs.aws.amazon.com/access-analyzer/latest/APIReference/API_InternalAccessAnalysisRuleCriteria.html) in the AWS IAM Access Analyzer API Reference for valid values. + +### `unusedAccess` Block -### `configuration` Argument Reference +The `unusedAccess` configuration block supports the following arguments: -* `unusedAccess` - (Optional) A block that specifies the configuration of an unused access analyzer for an AWS organization or account. [Documented below](#unused_access-argument-reference) +* `unusedAccessAge` - (Optional) Specified access age in days for which to generate findings for unused access. +* `analysisRule` - (Optional) Information about analysis rules for the analyzer. Analysis rules determine which entities will generate findings based on the criteria you define when you create the rule. See [`analysisRule` Block for Unused Access Analyzer](#analysis_rule-block-for-unused-access-analyzer) for details. -### `unusedAccess` Argument Reference +### `analysisRule` Block for Unused Access Analyzer -* `unusedAccessAge` - (Optional) The specified access age in days for which to generate findings for unused access. -* `analysis_rule` - (Optional) A block for analysis rules. [Documented below](#analysis_rule-argument-reference) +The `analysisRule` configuration block for unused access analyzer supports the following arguments: -### `analysis_rule` Argument Reference +* `exclusion` - (Optional) List of rules for the analyzer containing criteria to exclude from analysis. Entities that meet the rule criteria will not generate findings. See [`exclusion` Block](#exclusion-block) for details. -* `exclusion` - (Optional) A block for the analyzer rules containing criteria to exclude from analysis. [Documented below](#exclusion-argument-reference) +### `exclusion` Block -#### `exclusion` Argument Reference +The `exclusion` configuration block supports the following arguments: -* `accountIds` - (Optional) A list of account IDs to exclude from the analysis. -* `resourceTags` - (Optional) A list of key-value pairs for resource tags to exclude from the analysis. +* `accountIds` - (Optional) List of AWS account IDs to apply to the analysis rule criteria. The accounts cannot include the organization analyzer owner account. Account IDs can only be applied to the analysis rule criteria for organization-level analyzers. +* `resourceTags` - (Optional) List of key-value pairs for resource tags to exclude from the analysis. ## Attribute Reference This resource exports the following attributes in addition to the arguments above: * `arn` - ARN of the Analyzer. -* `id` - Analyzer name. +* `id` - Name of the analyzer. * `tagsAll` - Map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). ## Import @@ -183,4 +284,4 @@ Using `terraform import`, import Access Analyzer Analyzers using the `analyzerNa % terraform import aws_accessanalyzer_analyzer.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/accessanalyzer_archive_rule.html.markdown b/website/docs/cdktf/typescript/r/accessanalyzer_archive_rule.html.markdown index 4ee0eb1810f8..aeb2e171645c 100644 --- a/website/docs/cdktf/typescript/r/accessanalyzer_archive_rule.html.markdown +++ b/website/docs/cdktf/typescript/r/accessanalyzer_archive_rule.html.markdown @@ -53,8 +53,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `analyzerName` - (Required) Analyzer name. * `filter` - (Required) Filter criteria for the archive rule. See [Filter](#filter) for more details. * `ruleName` - (Required) Rule name. @@ -107,4 +108,4 @@ Using `terraform import`, import AccessAnalyzer ArchiveRule using the `analyzer_ % terraform import aws_accessanalyzer_archive_rule.example example-analyzer/example-rule ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/acm_certificate.html.markdown b/website/docs/cdktf/typescript/r/acm_certificate.html.markdown index 174ac8ef427e..462e6c123f25 100644 --- a/website/docs/cdktf/typescript/r/acm_certificate.html.markdown +++ b/website/docs/cdktf/typescript/r/acm_certificate.html.markdown @@ -208,6 +208,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * Creating an Amazon issued certificate * `domainName` - (Required) Domain name for which the certificate should be issued * `subjectAlternativeNames` - (Optional) Set of domains that should be SANs in the issued certificate. To remove all elements of a previously configured list, set this value equal to an empty list (`[]`) or use the [`terraform taint` command](https://www.terraform.io/docs/commands/taint.html) to trigger recreation. @@ -235,6 +236,7 @@ This resource supports the following arguments: Supported nested arguments for the `options` configuration block: * `certificateTransparencyLoggingPreference` - (Optional) Whether certificate details should be added to a certificate transparency log. Valid values are `ENABLED` or `DISABLED`. See https://docs.aws.amazon.com/acm/latest/userguide/acm-concepts.html#concept-transparency for more details. +* `export` - (Optional) Whether the certificate can be exported. Valid values are `ENABLED` or `DISABLED` (default). **Note** Issuing an exportable certificate is subject to additional charges. See [AWS Certificate Manager pricing](https://aws.amazon.com/certificate-manager/pricing/) for more details. ## validation_option Configuration Block @@ -309,4 +311,4 @@ Using `terraform import`, import certificates using their ARN. For example: % terraform import aws_acm_certificate.cert arn:aws:acm:eu-central-1:123456789012:certificate/7e7a28d2-163f-4b8f-b9cd-822f96c08d6a ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/acm_certificate_validation.html.markdown b/website/docs/cdktf/typescript/r/acm_certificate_validation.html.markdown index 82b01cf19683..c80fde5e0a2a 100644 --- a/website/docs/cdktf/typescript/r/acm_certificate_validation.html.markdown +++ b/website/docs/cdktf/typescript/r/acm_certificate_validation.html.markdown @@ -249,6 +249,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `certificateArn` - (Required) ARN of the certificate that is being validated. * `validationRecordFqdns` - (Optional) List of FQDNs that implement the validation. Only valid for DNS validation method ACM certificates. If this is set, the resource can implement additional sanity checks and has an explicit dependency on the resource that is implementing the validation @@ -264,4 +265,4 @@ This resource exports the following attributes in addition to the arguments abov - `create` - (Default `75m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/acmpca_certificate.html.markdown b/website/docs/cdktf/typescript/r/acmpca_certificate.html.markdown index ab61f31855ba..565f35041423 100644 --- a/website/docs/cdktf/typescript/r/acmpca_certificate.html.markdown +++ b/website/docs/cdktf/typescript/r/acmpca_certificate.html.markdown @@ -83,6 +83,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `certificateAuthorityArn` - (Required) ARN of the certificate authority. * `certificateSigningRequest` - (Required) Certificate Signing Request in PEM format. * `signingAlgorithm` - (Required) Algorithm to use to sign certificate requests. Valid values: `SHA256WITHRSA`, `SHA256WITHECDSA`, `SHA384WITHRSA`, `SHA384WITHECDSA`, `SHA512WITHRSA`, `SHA512WITHECDSA`. @@ -136,4 +137,4 @@ Using `terraform import`, import ACM PCA Certificates using their ARN. For examp % terraform import aws_acmpca_certificate.cert arn:aws:acm-pca:eu-west-1:675225743824:certificate-authority/08319ede-83g9-1400-8f21-c7d12b2b6edb/certificate/a4e9c2aa4bcfab625g1b9136464cd3a ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/acmpca_certificate_authority.html.markdown b/website/docs/cdktf/typescript/r/acmpca_certificate_authority.html.markdown index 9cf1168d56f3..3da46e183a6f 100644 --- a/website/docs/cdktf/typescript/r/acmpca_certificate_authority.html.markdown +++ b/website/docs/cdktf/typescript/r/acmpca_certificate_authority.html.markdown @@ -158,6 +158,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `certificateAuthorityConfiguration` - (Required) Nested argument containing algorithms and certificate subject information. Defined below. * `enabled` - (Optional) Whether the certificate authority is enabled or disabled. Defaults to `true`. Can only be disabled if the CA is in an `ACTIVE` state. * `revocationConfiguration` - (Optional) Nested argument containing revocation configuration. Defined below. @@ -262,4 +263,4 @@ Using `terraform import`, import `aws_acmpca_certificate_authority` using the ce % terraform import aws_acmpca_certificate_authority.example arn:aws:acm-pca:us-east-1:123456789012:certificate-authority/12345678-1234-1234-1234-123456789012 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/acmpca_certificate_authority_certificate.html.markdown b/website/docs/cdktf/typescript/r/acmpca_certificate_authority_certificate.html.markdown index c27d6c373c91..8110f5909103 100644 --- a/website/docs/cdktf/typescript/r/acmpca_certificate_authority_certificate.html.markdown +++ b/website/docs/cdktf/typescript/r/acmpca_certificate_authority_certificate.html.markdown @@ -184,6 +184,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `certificate` - (Required) PEM-encoded certificate for the Certificate Authority. * `certificateAuthorityArn` - (Required) ARN of the Certificate Authority. * `certificateChain` - (Optional) PEM-encoded certificate chain that includes any intermediate certificates and chains up to root CA. Required for subordinate Certificate Authorities. Not allowed for root Certificate Authorities. @@ -192,4 +193,4 @@ This resource supports the following arguments: This resource exports no additional attributes. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/acmpca_permission.html.markdown b/website/docs/cdktf/typescript/r/acmpca_permission.html.markdown index efa760c39184..b515f3b62957 100644 --- a/website/docs/cdktf/typescript/r/acmpca_permission.html.markdown +++ b/website/docs/cdktf/typescript/r/acmpca_permission.html.markdown @@ -53,6 +53,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `certificateAuthorityArn` - (Required) ARN of the CA that grants the permissions. * `actions` - (Required) Actions that the specified AWS service principal can use. These include `IssueCertificate`, `GetCertificate`, and `ListPermissions`. Note that in order for ACM to automatically rotate certificates issued by a PCA, it must be granted permission on all 3 actions, as per the example above. * `principal` - (Required) AWS service or identity that receives the permission. At this time, the only valid principal is `acm.amazonaws.com`. @@ -64,4 +65,4 @@ This resource exports the following attributes in addition to the arguments abov * `policy` - IAM policy that is associated with the permission. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/acmpca_policy.html.markdown b/website/docs/cdktf/typescript/r/acmpca_policy.html.markdown index f869b5cd1228..fba16e23be4c 100644 --- a/website/docs/cdktf/typescript/r/acmpca_policy.html.markdown +++ b/website/docs/cdktf/typescript/r/acmpca_policy.html.markdown @@ -85,6 +85,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `resourceArn` - (Required) ARN of the private CA to associate with the policy. * `policy` - (Required) JSON-formatted IAM policy to attach to the specified private CA resource. @@ -124,4 +125,4 @@ Using `terraform import`, import `aws_acmpca_policy` using the `resourceArn` val % terraform import aws_acmpca_policy.example arn:aws:acm-pca:us-east-1:123456789012:certificate-authority/12345678-1234-1234-1234-123456789012 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ami.html.markdown b/website/docs/cdktf/typescript/r/ami.html.markdown index 5fc9882ff962..517caa10c554 100644 --- a/website/docs/cdktf/typescript/r/ami.html.markdown +++ b/website/docs/cdktf/typescript/r/ami.html.markdown @@ -55,6 +55,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) Region-unique name for the AMI. * `bootMode` - (Optional) Boot mode of the AMI. For more information, see [Boot modes](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-boot.html) in the Amazon Elastic Compute Cloud User Guide. * `deprecationTime` - (Optional) Date and time to deprecate the AMI. If you specified a value for seconds, Amazon EC2 rounds the seconds to the nearest minute. Valid values: [RFC3339 time string](https://tools.ietf.org/html/rfc3339#section-5.8) (`YYYY-MM-DDTHH:MM:SSZ`) @@ -168,4 +169,4 @@ Using `terraform import`, import `aws_ami` using the ID of the AMI. For example: % terraform import aws_ami.example ami-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ami_copy.html.markdown b/website/docs/cdktf/typescript/r/ami_copy.html.markdown index 520ee1d86a4a..1df81e1c9701 100644 --- a/website/docs/cdktf/typescript/r/ami_copy.html.markdown +++ b/website/docs/cdktf/typescript/r/ami_copy.html.markdown @@ -53,6 +53,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) Region-unique name for the AMI. * `sourceAmiId` - (Required) Id of the AMI to copy. This id must be valid in the region given by `sourceAmiRegion`. @@ -85,4 +86,4 @@ configuration. * `update` - (Default `40m`) * `delete` - (Default `90m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ami_from_instance.html.markdown b/website/docs/cdktf/typescript/r/ami_from_instance.html.markdown index 6601a7044cdd..b4a94669d4ce 100644 --- a/website/docs/cdktf/typescript/r/ami_from_instance.html.markdown +++ b/website/docs/cdktf/typescript/r/ami_from_instance.html.markdown @@ -55,6 +55,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) Region-unique name for the AMI. * `sourceInstanceId` - (Required) ID of the instance to use as the basis of the AMI. * `snapshotWithoutReboot` - (Optional) Boolean that overrides the behavior of stopping @@ -82,4 +83,4 @@ This resource also exports a full set of attributes corresponding to the argumen [`aws_ami`](/docs/providers/aws/r/ami.html) resource, allowing the properties of the created AMI to be used elsewhere in the configuration. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ami_launch_permission.html.markdown b/website/docs/cdktf/typescript/r/ami_launch_permission.html.markdown index f7abc5503da8..8c5fc6695d8f 100644 --- a/website/docs/cdktf/typescript/r/ami_launch_permission.html.markdown +++ b/website/docs/cdktf/typescript/r/ami_launch_permission.html.markdown @@ -89,6 +89,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `accountId` - (Optional) AWS account ID for the launch permission. * `group` - (Optional) Name of the group for the launch permission. Valid values: `"all"`. * `imageId` - (Required) ID of the AMI. @@ -133,4 +134,4 @@ Using `terraform import`, import AMI Launch Permissions using `[ACCOUNT-ID|GROUP % terraform import aws_ami_launch_permission.example 123456789012/ami-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/amplify_app.html.markdown b/website/docs/cdktf/typescript/r/amplify_app.html.markdown index 2e6cb51bc6d6..dd1345219f89 100644 --- a/website/docs/cdktf/typescript/r/amplify_app.html.markdown +++ b/website/docs/cdktf/typescript/r/amplify_app.html.markdown @@ -203,10 +203,36 @@ class MyConvertedCode extends TerraformStack { ``` +### Job Config + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { AmplifyApp } from "./.gen/providers/aws/amplify-app"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + new AmplifyApp(this, "example", { + jobConfig: { + buildComputeType: "STANDARD_8GB", + }, + name: "example", + }); + } +} + +``` + ## Argument Reference This resource supports the following arguments: +* `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). * `name` - (Required) Name for an Amplify app. * `accessToken` - (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. * `autoBranchCreationConfig` - (Optional) Automated branch creation configuration for an Amplify app. See [`autoBranchCreationConfig` Block](#auto_branch_creation_config-block) for details. @@ -214,7 +240,7 @@ This resource supports the following arguments: * `basicAuthCredentials` - (Optional) Credentials for basic authorization for an Amplify app. * `buildSpec` - (Optional) The [build specification](https://docs.aws.amazon.com/amplify/latest/userguide/build-settings.html) (build spec) for an Amplify app. * `cacheConfig` - (Optional) Cache configuration for the Amplify app. See [`cacheConfig` Block](#cache_config-block) for details. -* `compute_role_arn` - (Optional) AWS Identity and Access Management (IAM) SSR compute role for an Amplify app. +* `computeRoleArn` - (Optional) AWS Identity and Access Management (IAM) SSR compute role for an Amplify app. * `customHeaders` - (Optional) The [custom HTTP headers](https://docs.aws.amazon.com/amplify/latest/userguide/custom-headers.html) for an Amplify app. * `customRule` - (Optional) Custom rewrite and redirect rules for an Amplify app. See [`customRule` Block](#custom_rule-block) for details. * `description` - (Optional) Description for an Amplify app. @@ -224,6 +250,7 @@ This resource supports the following arguments: * `enableBranchAutoDeletion` - (Optional) Automatically disconnects a branch in the Amplify Console when you delete a branch from your Git repository. * `environmentVariables` - (Optional) Environment variables map for an Amplify app. * `iamServiceRoleArn` - (Optional) AWS Identity and Access Management (IAM) service role for an Amplify app. +* `jobConfig` - (Optional) Used to configure the [Amplify Application build instance compute type](https://docs.aws.amazon.com/amplify/latest/APIReference/API_JobConfig.html#amplify-Type-JobConfig-buildComputeType). See [`jobConfig` Block](#job_config-block) for details. * `oauthToken` - (Optional) OAuth token for a third-party source control system for an Amplify app. The OAuth token is used to create a webhook and a read-only deploy key. The OAuth token is not stored. * `platform` - (Optional) Platform or framework for an Amplify app. Valid values: `WEB`, `WEB_COMPUTE`. Default value: `WEB`. * `repository` - (Optional) Repository for an Amplify app. @@ -259,6 +286,12 @@ The `customRule` configuration block supports the following arguments: * `status` - (Optional) Status code for a URL rewrite or redirect rule. Valid values: `200`, `301`, `302`, `404`, `404-200`. * `target` - (Required) Target pattern for a URL rewrite or redirect rule. +### `jobConfig` Block + +The `jobConfig` configuration block supports the following arguments: + +* `buildComputeType` - (Optional) Size of the build instance. Valid values: `STANDARD_8GB`, `LARGE_16GB`, and `XLARGE_72GB`. Default: `STANDARD_8GB`. + ## Attribute Reference This resource exports the following attributes in addition to the arguments above: @@ -306,4 +339,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`). - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/amplify_backend_environment.html.markdown b/website/docs/cdktf/typescript/r/amplify_backend_environment.html.markdown index fab4eaebd13a..559109d6058d 100644 --- a/website/docs/cdktf/typescript/r/amplify_backend_environment.html.markdown +++ b/website/docs/cdktf/typescript/r/amplify_backend_environment.html.markdown @@ -51,6 +51,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `appId` - (Required) Unique ID for an Amplify app. * `environmentName` - (Required) Name for the backend environment. * `deploymentArtifacts` - (Optional) Name of deployment artifacts. @@ -95,4 +96,4 @@ Using `terraform import`, import Amplify backend environment using `appId` and ` % terraform import aws_amplify_backend_environment.example d2ypk4k47z8u6/example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/amplify_branch.html.markdown b/website/docs/cdktf/typescript/r/amplify_branch.html.markdown index ea8f3e8e44a3..1cca1f775a17 100644 --- a/website/docs/cdktf/typescript/r/amplify_branch.html.markdown +++ b/website/docs/cdktf/typescript/r/amplify_branch.html.markdown @@ -213,6 +213,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `appId` - (Required) Unique ID for an Amplify app. * `branchName` - (Required) Name for the branch. * `backendEnvironmentArn` - (Optional) ARN for a backend environment that is part of an Amplify app. @@ -224,6 +225,7 @@ This resource supports the following arguments: * `enableNotification` - (Optional) Enables notifications for the branch. * `enablePerformanceMode` - (Optional) Enables performance mode for the branch. * `enablePullRequestPreview` - (Optional) Enables pull request previews for this branch. +* `enableSkewProtection` - (Optional) Enables skew protection for the branch. * `environmentVariables` - (Optional) Environment variables for the branch. * `framework` - (Optional) Framework for the branch. * `pullRequestEnvironmentName` - (Optional) Amplify environment name for the pull request. @@ -274,4 +276,4 @@ Using `terraform import`, import Amplify branch using `appId` and `branchName`. % terraform import aws_amplify_branch.master d2ypk4k47z8u6/master ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/amplify_domain_association.html.markdown b/website/docs/cdktf/typescript/r/amplify_domain_association.html.markdown index 504c5b08bda7..635dcb196a33 100644 --- a/website/docs/cdktf/typescript/r/amplify_domain_association.html.markdown +++ b/website/docs/cdktf/typescript/r/amplify_domain_association.html.markdown @@ -71,6 +71,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `appId` - (Required) Unique ID for an Amplify app. * `certificateSettings` - (Optional) The type of SSL/TLS certificate to use for your custom domain. If you don't specify a certificate type, Amplify uses the default certificate that it provisions and manages for you. * `domainName` - (Required) Domain name for the domain association. @@ -134,4 +135,4 @@ Using `terraform import`, import Amplify domain association using `appId` and `d % terraform import aws_amplify_domain_association.app d2ypk4k47z8u6/example.com ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/amplify_webhook.html.markdown b/website/docs/cdktf/typescript/r/amplify_webhook.html.markdown index 4122bd8fa578..dec10e5d8da2 100644 --- a/website/docs/cdktf/typescript/r/amplify_webhook.html.markdown +++ b/website/docs/cdktf/typescript/r/amplify_webhook.html.markdown @@ -51,6 +51,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `appId` - (Required) Unique ID for an Amplify app. * `branchName` - (Required) Name for a branch that is part of the Amplify app. * `description` - (Optional) Description for a webhook. @@ -94,4 +95,4 @@ Using `terraform import`, import Amplify webhook using a webhook ID. For example % terraform import aws_amplify_webhook.master a26b22a0-748b-4b57-b9a0-ae7e601fe4b1 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/api_gateway_account.html.markdown b/website/docs/cdktf/typescript/r/api_gateway_account.html.markdown index fed1fb0538f7..1804c9859ca7 100644 --- a/website/docs/cdktf/typescript/r/api_gateway_account.html.markdown +++ b/website/docs/cdktf/typescript/r/api_gateway_account.html.markdown @@ -87,6 +87,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `cloudwatchRoleArn` - (Optional) ARN of an IAM role for CloudWatch (to allow logging & monitoring). See more [in AWS Docs](https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-stage-settings.html#how-to-stage-settings-console). Logging & monitoring can be enabled/disabled and otherwise tuned on the API Gateway Stage level. * `reset_on_delete` - (Optional) If `true`, destroying the resource will reset account settings to default, otherwise account settings are not modified. Defaults to `false`. @@ -107,7 +108,7 @@ This resource exports the following attributes in addition to the arguments abov ## Import -In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import API Gateway Accounts using the word `api-gateway-account`. For example: +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import API Gateway Accounts using the account ID. For example: ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -121,20 +122,16 @@ import { ApiGatewayAccount } from "./.gen/providers/aws/api-gateway-account"; class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); - ApiGatewayAccount.generateConfigForImport( - this, - "demo", - "api-gateway-account" - ); + ApiGatewayAccount.generateConfigForImport(this, "demo", "123456789012"); } } ``` -Using `terraform import`, import API Gateway Accounts using the word `api-gateway-account`. For example: +Using `terraform import`, import API Gateway Accounts using the account ID. For example: ```console -% terraform import aws_api_gateway_account.demo api-gateway-account +% terraform import aws_api_gateway_account.demo 123456789012 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/api_gateway_api_key.html.markdown b/website/docs/cdktf/typescript/r/api_gateway_api_key.html.markdown index 959cf6fd9c4e..e0f0f5152eb7 100644 --- a/website/docs/cdktf/typescript/r/api_gateway_api_key.html.markdown +++ b/website/docs/cdktf/typescript/r/api_gateway_api_key.html.markdown @@ -40,6 +40,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) Name of the API key. * `customerId` - (Optional) An Amazon Web Services Marketplace customer identifier, when integrating with the Amazon Web Services SaaS Marketplace. * `description` - (Optional) API key description. Defaults to "Managed by Terraform". @@ -89,4 +90,4 @@ Using `terraform import`, import API Gateway Keys using the `id`. For example: % terraform import aws_api_gateway_api_key.example 8bklk8bl1k3sB38D9B3l0enyWT8c09B30lkq0blk ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/api_gateway_authorizer.html.markdown b/website/docs/cdktf/typescript/r/api_gateway_authorizer.html.markdown index 03d82d8796ee..ec01785284fd 100644 --- a/website/docs/cdktf/typescript/r/api_gateway_authorizer.html.markdown +++ b/website/docs/cdktf/typescript/r/api_gateway_authorizer.html.markdown @@ -133,6 +133,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `authorizerUri` - (Optional, required for type `TOKEN`/`REQUEST`) Authorizer's Uniform Resource Identifier (URI). This must be a well-formed Lambda function URI in the form of `arn:aws:apigateway:{region}:lambda:path/{service_api}`, e.g., `arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:012345678912:function:my-function/invocations` * `name` - (Required) Name of the authorizer @@ -183,4 +184,4 @@ Using `terraform import`, import AWS API Gateway Authorizer using the `REST-API- % terraform import aws_api_gateway_authorizer.authorizer 12345abcde/example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/api_gateway_base_path_mapping.html.markdown b/website/docs/cdktf/typescript/r/api_gateway_base_path_mapping.html.markdown index dcc53cde2e5a..c6b31d2466a4 100644 --- a/website/docs/cdktf/typescript/r/api_gateway_base_path_mapping.html.markdown +++ b/website/docs/cdktf/typescript/r/api_gateway_base_path_mapping.html.markdown @@ -72,11 +72,12 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `domainName` - (Required) Already-registered domain name to connect the API to. * `apiId` - (Required) ID of the API to connect. * `stageName` - (Optional) Name of a specific deployment stage to expose at the given path. If omitted, callers may select any stage by including its name as a path element after the base path. * `basePath` - (Optional) Path segment that must be prepended to the path when accessing the API via this mapping. If omitted, the API is exposed at the root of the given domain. -* `domain_name_id` - (Optional) The identifier for the domain name resource. Supported only for private custom domain names. +* `domainNameId` - (Optional) The identifier for the domain name resource. Supported only for private custom domain names. ## Attribute Reference @@ -178,4 +179,4 @@ For a non-root `basePath` and a private custom domain name: % terraform import aws_api_gateway_base_path_mapping.example api.internal.example.com/base-path/abcde12345 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/api_gateway_client_certificate.html.markdown b/website/docs/cdktf/typescript/r/api_gateway_client_certificate.html.markdown index 8409089fc438..3df0b722579d 100644 --- a/website/docs/cdktf/typescript/r/api_gateway_client_certificate.html.markdown +++ b/website/docs/cdktf/typescript/r/api_gateway_client_certificate.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `description` - (Optional) Description of the client certificate. * `tags` - (Optional) Key-value map of resource tags. If configured with a provider [`defaultTags` 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. @@ -80,4 +81,4 @@ Using `terraform import`, import API Gateway Client Certificates using the id. F % terraform import aws_api_gateway_client_certificate.demo ab1cqe ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/api_gateway_deployment.html.markdown b/website/docs/cdktf/typescript/r/api_gateway_deployment.html.markdown index 7d724da88c5d..9ede545ed192 100644 --- a/website/docs/cdktf/typescript/r/api_gateway_deployment.html.markdown +++ b/website/docs/cdktf/typescript/r/api_gateway_deployment.html.markdown @@ -17,8 +17,6 @@ To properly capture all REST API configuration in a deployment, this resource mu * For REST APIs that are configured via OpenAPI specification ([`aws_api_gateway_rest_api` resource](api_gateway_rest_api.html) `body` argument), no special dependency setup is needed beyond referencing the `id` attribute of that resource unless additional Terraform resources have further customized the REST API. * When the REST API configuration involves other Terraform resources ([`aws_api_gateway_integration` resource](api_gateway_integration.html), etc.), the dependency setup can be done with implicit resource references in the `triggers` argument or explicit resource references using the [resource `dependsOn` meta-argument](https://www.terraform.io/docs/configuration/meta-arguments/depends_on.html). The `triggers` argument should be preferred over `dependsOn`, since `dependsOn` can only capture dependency ordering and will not cause the resource to recreate (redeploy the REST API) with upstream configuration changes. -!> **WARNING:** We recommend using the [`aws_api_gateway_stage` resource](api_gateway_stage.html) instead of managing an API Gateway Stage via the `stageName` argument of this resource. When this resource is recreated (REST API redeployment) with the `stageName` configured, the stage is deleted and recreated. This will cause a temporary service interruption, increase Terraform plan differences, and can require a second Terraform apply to recreate any downstream stage configuration such as associated `aws_api_method_settings` resources. - ~> **NOTE:** Enable the [resource `lifecycle` configuration block `create_before_destroy` argument](https://www.terraform.io/language/meta-arguments/lifecycle#create_before_destroy) in this resource configuration to properly order redeployments in Terraform. Without enabling `create_before_destroy`, API Gateway can return errors such as `BadRequestException: Active stages pointing to this deployment must be moved or deleted` on recreation. ## Example Usage @@ -165,35 +163,17 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: -* `canarySettings` - (Optional, **Deprecated** Use an explicit [`aws_api_gateway_stage` resource](api_gateway_stage.html) instead) Input configuration for the canary deployment when the deployment is a canary release deployment. - See [`canary_settings](#canary_settings-argument-reference) below. - Has no effect when `stage_name` is not set. -* `description` - (Optional) Description of the deployment +* `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). +* `description` - (Optional) Description of the deployment. * `restApiId` - (Required) REST API identifier. -* `stageDescription` - (Optional, **Deprecated** Use an explicit [`aws_api_gateway_stage` resource](api_gateway_stage.html) instead) Description to set on the stage managed by the `stageName` argument. - Has no effect when `stageName` is not set. -* `stageName` - (Optional, **Deprecated** Use an explicit [`aws_api_gateway_stage` resource](api_gateway_stage.html) instead) Name of the stage to create with this deployment. - If the specified stage already exists, it will be updated to point to the new deployment. - We recommend using the [`aws_api_gateway_stage` resource](api_gateway_stage.html) instead to manage stages. * `triggers` - (Optional) Map of arbitrary keys and values that, when changed, will trigger a redeployment. To force a redeployment without changing these keys/values, use the [`-replace` option](https://developer.hashicorp.com/terraform/cli/commands/plan#replace-address) with `terraform plan` or `terraform apply`. -* `variables` - (Optional) Map to set on the stage managed by the `stageName` argument. - -### `canarySettings` Argument Reference - -* `percentTraffic` - Percentage (0.0-100.0) of traffic routed to the canary deployment. -* `stageVariableOverrides` - Stage variable overrides used for the canary release deployment. They can override existing stage variables or add new stage variables for the canary release deployment. These stage variables are represented as a string-to-string map between stage variable names and their values. -* `useStageCache` - Boolean flag to indicate whether the canary release deployment uses the stage cache or not. +* `variables` - (Optional) Map to set on the related stage. ## Attribute Reference This resource exports the following attributes in addition to the arguments above: * `id` - ID of the deployment -* `invokeUrl` - **DEPRECATED: Use the `aws_api_gateway_stage` resource instead.** URL to invoke the API pointing to the stage, - e.g., `https://z4675bid1j.execute-api.eu-west-2.amazonaws.com/prod` -* `executionArn` - **DEPRECATED: Use the `aws_api_gateway_stage` resource instead.** Execution ARN to be used in [`lambda_permission`](/docs/providers/aws/r/lambda_permission.html)'s `sourceArn` - when allowing API Gateway to invoke a Lambda function, - e.g., `arn:aws:execute-api:eu-west-2:123456789012:z4675bid1j/prod` * `createdDate` - Creation date of the deployment ## Import @@ -228,8 +208,8 @@ Using `terraform import`, import `aws_api_gateway_deployment` using `REST-API-ID % terraform import aws_api_gateway_deployment.example aabbccddee/1122334 ``` -The `stageName`, `stageDescription`, and `variables` arguments cannot be imported. Use the [`aws_api_gateway_stage` resource](api_gateway_stage.html) to import and manage stages. +The `variables` arguments cannot be imported. Use the [`aws_api_gateway_stage` resource](api_gateway_stage.html) to import and manage stages. The `triggers` argument cannot be imported. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/api_gateway_documentation_part.html.markdown b/website/docs/cdktf/typescript/r/api_gateway_documentation_part.html.markdown index a5004ecbdeac..ed4bf1ba885d 100644 --- a/website/docs/cdktf/typescript/r/api_gateway_documentation_part.html.markdown +++ b/website/docs/cdktf/typescript/r/api_gateway_documentation_part.html.markdown @@ -51,6 +51,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `location` - (Required) Location of the targeted API entity of the to-be-created documentation part. See below. * `properties` - (Required) Content map of API-specific key-value pairs describing the targeted API entity. The map must be encoded as a JSON string, e.g., "{ \"description\": \"The API does ...\" }". Only Swagger-compliant key-value pairs can be exported and, hence, published. * `restApiId` - (Required) ID of the associated Rest API @@ -106,4 +107,4 @@ Using `terraform import`, import API Gateway documentation_parts using `REST-API % terraform import aws_api_gateway_documentation_part.example 5i4e1ko720/3oyy3t ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/api_gateway_documentation_version.html.markdown b/website/docs/cdktf/typescript/r/api_gateway_documentation_version.html.markdown index 7c9391afc068..19c741d43669 100644 --- a/website/docs/cdktf/typescript/r/api_gateway_documentation_version.html.markdown +++ b/website/docs/cdktf/typescript/r/api_gateway_documentation_version.html.markdown @@ -59,6 +59,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `version` - (Required) Version identifier of the API documentation snapshot. * `restApiId` - (Required) ID of the associated Rest API * `description` - (Optional) Description of the API documentation version. @@ -99,4 +100,4 @@ Using `terraform import`, import API Gateway documentation versions using `REST- % terraform import aws_api_gateway_documentation_version.example 5i4e1ko720/example-version ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/api_gateway_domain_name.html.markdown b/website/docs/cdktf/typescript/r/api_gateway_domain_name.html.markdown index 7ca49996c643..5496a3555532 100644 --- a/website/docs/cdktf/typescript/r/api_gateway_domain_name.html.markdown +++ b/website/docs/cdktf/typescript/r/api_gateway_domain_name.html.markdown @@ -220,6 +220,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `domainName` - (Required) Fully-qualified domain name to register. * `endpointConfiguration` - (Optional) Configuration block defining API endpoint information including type. See below. * `mutualTlsAuthentication` - (Optional) Mutual TLS authentication configuration for the domain name. See below. @@ -327,4 +328,4 @@ For a private custom domain name: % terraform import aws_api_gateway_domain_name.example dev.api.internal.example.com/abcde12345 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/api_gateway_domain_name_access_association.html.markdown b/website/docs/cdktf/typescript/r/api_gateway_domain_name_access_association.html.markdown index 3df2e6f821c4..509abbc8d72b 100644 --- a/website/docs/cdktf/typescript/r/api_gateway_domain_name_access_association.html.markdown +++ b/website/docs/cdktf/typescript/r/api_gateway_domain_name_access_association.html.markdown @@ -40,6 +40,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `accessAssociationSource` - (Required) The identifier of the domain name access association source. For a `VPCE`, the value is the VPC endpoint ID. * `accessAssociationSourceType` - (Required) The type of the domain name access association source. Valid values are `VPCE`. * `domainNameArn` - (Required) The ARN of the domain name. @@ -85,4 +86,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 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/api_gateway_gateway_response.html.markdown b/website/docs/cdktf/typescript/r/api_gateway_gateway_response.html.markdown index 242c7a787d09..9e400041802d 100644 --- a/website/docs/cdktf/typescript/r/api_gateway_gateway_response.html.markdown +++ b/website/docs/cdktf/typescript/r/api_gateway_gateway_response.html.markdown @@ -50,6 +50,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `restApiId` - (Required) String identifier of the associated REST API. * `responseType` - (Required) Response type of the associated GatewayResponse. * `statusCode` - (Optional) HTTP status code of the Gateway Response. @@ -92,4 +93,4 @@ Using `terraform import`, import `aws_api_gateway_gateway_response` using `REST- % terraform import aws_api_gateway_gateway_response.example 12345abcde/UNAUTHORIZED ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/api_gateway_integration.html.markdown b/website/docs/cdktf/typescript/r/api_gateway_integration.html.markdown index 0c326d1c623b..3f8ffd81808a 100644 --- a/website/docs/cdktf/typescript/r/api_gateway_integration.html.markdown +++ b/website/docs/cdktf/typescript/r/api_gateway_integration.html.markdown @@ -253,6 +253,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `restApiId` - (Required) ID of the associated REST API. * `resourceId` - (Required) API resource ID. * `httpMethod` - (Required) HTTP method (`GET`, `POST`, `PUT`, `DELETE`, `HEAD`, `OPTION`, `ANY`) @@ -321,4 +322,4 @@ Using `terraform import`, import `aws_api_gateway_integration` using `REST-API-I % terraform import aws_api_gateway_integration.example 12345abcde/67890fghij/GET ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/api_gateway_integration_response.html.markdown b/website/docs/cdktf/typescript/r/api_gateway_integration_response.html.markdown index 9315e6a16ff0..b5b9233a7153 100644 --- a/website/docs/cdktf/typescript/r/api_gateway_integration_response.html.markdown +++ b/website/docs/cdktf/typescript/r/api_gateway_integration_response.html.markdown @@ -87,6 +87,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `contentHandling` - (Optional) How to handle request payload content type conversions. Supported values are `CONVERT_TO_BINARY` and `CONVERT_TO_TEXT`. If this property is not defined, the response payload will be passed through from the integration response to the method response without modification. * `responseParameters` - (Optional) Map of response parameters that can be read from the backend response. For example: `response_parameters = { "method.response.header.X-Some-Header" = "integration.response.header.X-Some-Other-Header" }`. * `responseTemplates` - (Optional) Map of templates used to transform the integration response body. @@ -128,4 +129,4 @@ Using `terraform import`, import `aws_api_gateway_integration_response` using `R % terraform import aws_api_gateway_integration_response.example 12345abcde/67890fghij/GET/200 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/api_gateway_method.html.markdown b/website/docs/cdktf/typescript/r/api_gateway_method.html.markdown index 0d36826f6dcd..14ab5001d4c2 100644 --- a/website/docs/cdktf/typescript/r/api_gateway_method.html.markdown +++ b/website/docs/cdktf/typescript/r/api_gateway_method.html.markdown @@ -123,6 +123,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `restApiId` - (Required) ID of the associated REST API * `resourceId` - (Required) API resource ID * `httpMethod` - (Required) HTTP Method (`GET`, `POST`, `PUT`, `DELETE`, `HEAD`, `OPTIONS`, `ANY`) @@ -174,4 +175,4 @@ Using `terraform import`, import `aws_api_gateway_method` using `REST-API-ID/RES % terraform import aws_api_gateway_method.example 12345abcde/67890fghij/GET ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/api_gateway_method_response.html.markdown b/website/docs/cdktf/typescript/r/api_gateway_method_response.html.markdown index 9e30f22d432c..e7e9bbf2b4eb 100644 --- a/website/docs/cdktf/typescript/r/api_gateway_method_response.html.markdown +++ b/website/docs/cdktf/typescript/r/api_gateway_method_response.html.markdown @@ -144,6 +144,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `restApiId` - (Required) The string identifier of the associated REST API. * `resourceId` - (Required) The Resource identifier for the method resource. * `httpMethod` - (Required) The HTTP verb of the method resource (`GET`, `POST`, `PUT`, `DELETE`, `HEAD`, `OPTIONS`, `ANY`). @@ -151,7 +152,7 @@ This resource supports the following arguments: * `responseModels` - (Optional) A map specifying the model resources used for the response's content type. Response models are represented as a key/value map, with a content type as the key and a Model name as the value. * `responseParameters` - (Optional) A map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header name and the associated value is a boolean flag indicating whether the method response parameter is required. The method response header names must match the pattern of `method.response.header.{name}`, where `name` is a valid and unique header name. - The response parameter names defined here are available in the integration response to be mapped from an integration response header expressed in `integration.response.header.{name}`, a static value enclosed within a pair of single quotes (e.g., '`application/json'`), or a JSON expression from the back-end response payload in the form of `integration.response.body.{JSON-expression}`, where `JSON-expression` is a valid JSON expression without the `$` prefix.) +The response parameter names defined here are available in the integration response to be mapped from an integration response header expressed in `integration.response.header.{name}`, a static value enclosed within a pair of single quotes (e.g., '`application/json'`), or a JSON expression from the back-end response payload in the form of `integration.response.body.{JSON-expression}`, where `JSON-expression` is a valid JSON expression without the `$` prefix.) ## Attribute Reference @@ -189,4 +190,4 @@ Using `terraform import`, import `aws_api_gateway_method_response` using `REST-A % terraform import aws_api_gateway_method_response.example 12345abcde/67890fghij/GET/200 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/api_gateway_method_settings.html.markdown b/website/docs/cdktf/typescript/r/api_gateway_method_settings.html.markdown index 01055a8271fc..ea772e68b5da 100644 --- a/website/docs/cdktf/typescript/r/api_gateway_method_settings.html.markdown +++ b/website/docs/cdktf/typescript/r/api_gateway_method_settings.html.markdown @@ -210,6 +210,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `restApiId` - (Required) ID of the REST API * `stageName` - (Required) Name of the stage * `methodPath` - (Required) Method path defined as `{resource_path}/{http_method}` for an individual method override, or `*/*` for overriding all methods in the stage. Ensure to trim any leading forward slashes in the path (e.g., `trimprefix(aws_api_gateway_resource.example.path, "/")`). @@ -264,4 +265,4 @@ Using `terraform import`, import `aws_api_gateway_method_settings` using `REST-A % terraform import aws_api_gateway_method_settings.example 12345abcde/example/test/GET ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/api_gateway_model.html.markdown b/website/docs/cdktf/typescript/r/api_gateway_model.html.markdown index 293e3ce39b9b..ff669364d209 100644 --- a/website/docs/cdktf/typescript/r/api_gateway_model.html.markdown +++ b/website/docs/cdktf/typescript/r/api_gateway_model.html.markdown @@ -51,6 +51,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `restApiId` - (Required) ID of the associated REST API * `name` - (Required) Name of the model * `description` - (Optional) Description of the model @@ -95,4 +96,4 @@ Using `terraform import`, import `aws_api_gateway_model` using `REST-API-ID/NAME % terraform import aws_api_gateway_model.example 12345abcde/example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/api_gateway_request_validator.html.markdown b/website/docs/cdktf/typescript/r/api_gateway_request_validator.html.markdown index 6d52d7860140..2604e89aab82 100644 --- a/website/docs/cdktf/typescript/r/api_gateway_request_validator.html.markdown +++ b/website/docs/cdktf/typescript/r/api_gateway_request_validator.html.markdown @@ -41,6 +41,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) Name of the request validator * `restApiId` - (Required) ID of the associated Rest API * `validateRequestBody` - (Optional) Boolean whether to validate request body. Defaults to `false`. @@ -84,4 +85,4 @@ Using `terraform import`, import `aws_api_gateway_request_validator` using `REST % terraform import aws_api_gateway_request_validator.example 12345abcde/67890fghij ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/api_gateway_resource.html.markdown b/website/docs/cdktf/typescript/r/api_gateway_resource.html.markdown index 08ed01e695b1..9887259cf6d4 100644 --- a/website/docs/cdktf/typescript/r/api_gateway_resource.html.markdown +++ b/website/docs/cdktf/typescript/r/api_gateway_resource.html.markdown @@ -45,6 +45,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `restApiId` - (Required) ID of the associated REST API * `parentId` - (Required) ID of the parent API resource * `pathPart` - (Required) Last path segment of this API resource. @@ -88,4 +89,4 @@ Using `terraform import`, import `aws_api_gateway_resource` using `REST-API-ID/R % terraform import aws_api_gateway_resource.example 12345abcde/67890fghij ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/api_gateway_rest_api.html.markdown b/website/docs/cdktf/typescript/r/api_gateway_rest_api.html.markdown index ce737ad63113..b3217b5802be 100644 --- a/website/docs/cdktf/typescript/r/api_gateway_rest_api.html.markdown +++ b/website/docs/cdktf/typescript/r/api_gateway_rest_api.html.markdown @@ -256,6 +256,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `apiKeySource` - (Optional) Source of the API key for requests. Valid values are `HEADER` (default) and `AUTHORIZER`. If importing an OpenAPI specification via the `body` argument, this corresponds to the [`x-amazon-apigateway-api-key-source` extension](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-api-key-source.html). If the argument value is provided and is different than the OpenAPI value, the argument value will override the OpenAPI value. * `binaryMediaTypes` - (Optional) List of binary media types supported by the REST API. By default, the REST API supports only UTF-8-encoded text payloads. If importing an OpenAPI specification via the `body` argument, this corresponds to the [`x-amazon-apigateway-binary-media-types` extension](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-swagger-extensions-binary-media-types.html). If the argument value is provided and is different than the OpenAPI value, the argument value will override the OpenAPI value. * `body` - (Optional) OpenAPI specification that defines the set of routes and integrations to create as part of the REST API. This configuration, and any updates to it, will replace all REST API configuration except values overridden in this resource configuration and other resource updates applied after this resource but before any `aws_api_gateway_deployment` creation. More information about REST API OpenAPI support can be found in the [API Gateway Developer Guide](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-import-api.html). @@ -330,4 +331,4 @@ Using `terraform import`, import `aws_api_gateway_rest_api` using the REST API I ~> **NOTE:** Resource import does not currently support the `body` attribute. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/api_gateway_rest_api_policy.html.markdown b/website/docs/cdktf/typescript/r/api_gateway_rest_api_policy.html.markdown index 469caf3152c5..c54c92ad19ab 100644 --- a/website/docs/cdktf/typescript/r/api_gateway_rest_api_policy.html.markdown +++ b/website/docs/cdktf/typescript/r/api_gateway_rest_api_policy.html.markdown @@ -82,6 +82,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `restApiId` - (Required) ID of the REST API. * `policy` - (Required) JSON formatted policy document that controls access to the API Gateway. For more information about building AWS IAM policy documents with Terraform, see the [AWS IAM Policy Document Guide](https://learn.hashicorp.com/terraform/aws/iam-policy) @@ -123,4 +124,4 @@ Using `terraform import`, import `aws_api_gateway_rest_api_policy` using the RES % terraform import aws_api_gateway_rest_api_policy.example 12345abcde ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/api_gateway_rest_api_put.markdown b/website/docs/cdktf/typescript/r/api_gateway_rest_api_put.markdown index 370da252e846..c3557bb73711 100644 --- a/website/docs/cdktf/typescript/r/api_gateway_rest_api_put.markdown +++ b/website/docs/cdktf/typescript/r/api_gateway_rest_api_put.markdown @@ -166,13 +166,15 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `body` - (Required) PUT request body containing external API definitions. Currently, only OpenAPI definition JSON/YAML files are supported. The maximum size of the API definition file is 6MB. * `restApiId` - (Required) Identifier of the associated REST API. The following arguments are optional: +* `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). * `failOnWarnings` - (Optional) Whether to rollback the API update when a warning is encountered. The default value is `false`. * `parameters` - (Optional) Map of customizations for importing the specification in the `body` argument. For example, to exclude DocumentationParts from an imported API, use `ignore = "documentation"`. Additional documentation, including other parameters such as `basepath`, can be found in the [API Gateway Developer Guide](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-import-api.html). * `triggers` - (Optional) Map of arbitrary keys and values that, when changed, will trigger a redeployment. To force a redeployment without changing these keys/values, use the [`-replace` option](https://developer.hashicorp.com/terraform/cli/commands/plan#replace-address) with `terraform plan` or `terraform apply`. @@ -219,4 +221,4 @@ Using `terraform import`, import API Gateway REST API Put using the `restApiId`. % terraform import aws_api_gateway_rest_api_put.example import-id-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/api_gateway_stage.html.markdown b/website/docs/cdktf/typescript/r/api_gateway_stage.html.markdown index 68a963b7ad95..2e4975030ce7 100644 --- a/website/docs/cdktf/typescript/r/api_gateway_stage.html.markdown +++ b/website/docs/cdktf/typescript/r/api_gateway_stage.html.markdown @@ -137,6 +137,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `restApiId` - (Required) ID of the associated REST API * `stageName` - (Required) Name of the stage * `deploymentId` - (Required) ID of the deployment that the stage points to @@ -146,8 +147,8 @@ This resource supports the following arguments: * `canarySettings` - (Optional) Configuration settings of a canary deployment. See [Canary Settings](#canary-settings) below. * `clientCertificateId` - (Optional) Identifier of a client certificate for the stage. * `description` - (Optional) Description of the stage. -* `documentationVersion` - (Optional) Version of the associated API documentation -* `variables` - (Optional) Map that defines the stage variables +* `documentationVersion` - (Optional) Version of the associated API documentation. +* `variables` - (Optional) Map that defines the stage variables. * `tags` - (Optional) Map of tags to assign to the resource. If configured with a provider [`defaultTags` 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. * `xrayTracingEnabled` - (Optional) Whether active tracing with X-ray is enabled. Defaults to `false`. @@ -210,4 +211,4 @@ Using `terraform import`, import `aws_api_gateway_stage` using `REST-API-ID/STAG % terraform import aws_api_gateway_stage.example 12345abcde/example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/api_gateway_usage_plan.html.markdown b/website/docs/cdktf/typescript/r/api_gateway_usage_plan.html.markdown index 1012183b0f8f..4a9be0837092 100644 --- a/website/docs/cdktf/typescript/r/api_gateway_usage_plan.html.markdown +++ b/website/docs/cdktf/typescript/r/api_gateway_usage_plan.html.markdown @@ -95,6 +95,7 @@ resource "aws_api_gateway_usage_plan" "example" { This resource supports the following arguments: +* `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). * `name` - (Required) Name of the usage plan. * `description` - (Optional) Description of a usage plan. * `apiStages` - (Optional) Associated [API stages](#api-stages-arguments) of the usage plan. @@ -172,4 +173,4 @@ Using `terraform import`, import AWS API Gateway Usage Plan using the `id`. For % terraform import aws_api_gateway_usage_plan.myusageplan ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/api_gateway_usage_plan_key.html.markdown b/website/docs/cdktf/typescript/r/api_gateway_usage_plan_key.html.markdown index c6c4918876eb..bf4ab92ae51b 100644 --- a/website/docs/cdktf/typescript/r/api_gateway_usage_plan_key.html.markdown +++ b/website/docs/cdktf/typescript/r/api_gateway_usage_plan_key.html.markdown @@ -58,6 +58,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `keyId` - (Required) Identifier of the API key resource. * `keyType` - (Required) Type of the API key resource. Currently, the valid key type is API_KEY. * `usagePlanId` - (Required) Id of the usage plan resource representing to associate the key to. @@ -105,4 +106,4 @@ Using `terraform import`, import AWS API Gateway Usage Plan Key using the `USAGE % terraform import aws_api_gateway_usage_plan_key.key 12345abcde/zzz ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/api_gateway_vpc_link.html.markdown b/website/docs/cdktf/typescript/r/api_gateway_vpc_link.html.markdown index ca6122b83132..b8b0e5467dff 100644 --- a/website/docs/cdktf/typescript/r/api_gateway_vpc_link.html.markdown +++ b/website/docs/cdktf/typescript/r/api_gateway_vpc_link.html.markdown @@ -60,6 +60,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) Name used to label and identify the VPC link. * `description` - (Optional) Description of the VPC link. * `targetArns` - (Required, ForceNew) List of network load balancer arns in the VPC targeted by the VPC link. Currently AWS only supports 1 target. @@ -100,4 +101,4 @@ Using `terraform import`, import API Gateway VPC Link using the `id`. For exampl % terraform import aws_api_gateway_vpc_link.example 12345abcde ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/apigatewayv2_api.html.markdown b/website/docs/cdktf/typescript/r/apigatewayv2_api.html.markdown index b1c103c75f98..5eb3314fbcfb 100644 --- a/website/docs/cdktf/typescript/r/apigatewayv2_api.html.markdown +++ b/website/docs/cdktf/typescript/r/apigatewayv2_api.html.markdown @@ -67,6 +67,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) Name of the API. Must be less than or equal to 128 characters in length. * `protocolType` - (Required) API protocol. Valid values: `HTTP`, `WEBSOCKET`. * `apiKeySelectionExpression` - (Optional) An [API key selection expression](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions). @@ -146,4 +147,4 @@ Using `terraform import`, import `aws_apigatewayv2_api` using the API identifier % terraform import aws_apigatewayv2_api.example aabbccddee ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/apigatewayv2_api_mapping.html.markdown b/website/docs/cdktf/typescript/r/apigatewayv2_api_mapping.html.markdown index 2a757e880c75..0e22188546ba 100644 --- a/website/docs/cdktf/typescript/r/apigatewayv2_api_mapping.html.markdown +++ b/website/docs/cdktf/typescript/r/apigatewayv2_api_mapping.html.markdown @@ -43,6 +43,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `apiId` - (Required) API identifier. * `domainName` - (Required) Domain name. Use the [`aws_apigatewayv2_domain_name`](/docs/providers/aws/r/apigatewayv2_domain_name.html) resource to configure a domain name. * `stage` - (Required) API stage. Use the [`aws_apigatewayv2_stage`](/docs/providers/aws/r/apigatewayv2_stage.html) resource to configure an API stage. @@ -86,4 +87,4 @@ Using `terraform import`, import `aws_apigatewayv2_api_mapping` using the API ma % terraform import aws_apigatewayv2_api_mapping.example 1122334/ws-api.example.com ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/apigatewayv2_authorizer.html.markdown b/website/docs/cdktf/typescript/r/apigatewayv2_authorizer.html.markdown index ec803599d912..57207a8885ba 100644 --- a/website/docs/cdktf/typescript/r/apigatewayv2_authorizer.html.markdown +++ b/website/docs/cdktf/typescript/r/apigatewayv2_authorizer.html.markdown @@ -72,6 +72,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `apiId` - (Required) API identifier. * `authorizerType` - (Required) Authorizer type. Valid values: `JWT`, `REQUEST`. Specify `REQUEST` for a Lambda function using incoming request parameters. @@ -144,4 +145,4 @@ Using `terraform import`, import `aws_apigatewayv2_authorizer` using the API ide % terraform import aws_apigatewayv2_authorizer.example aabbccddee/1122334 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/apigatewayv2_deployment.html.markdown b/website/docs/cdktf/typescript/r/apigatewayv2_deployment.html.markdown index 82e99261c6d3..95ff1dad5e9e 100644 --- a/website/docs/cdktf/typescript/r/apigatewayv2_deployment.html.markdown +++ b/website/docs/cdktf/typescript/r/apigatewayv2_deployment.html.markdown @@ -94,6 +94,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `apiId` - (Required) API identifier. * `description` - (Optional) Description for the deployment resource. Must be less than or equal to 1024 characters in length. * `triggers` - (Optional) Map of arbitrary keys and values that, when changed, will trigger a redeployment. To force a redeployment without changing these keys/values, use the [`terraform taint` command](https://www.terraform.io/docs/commands/taint.html). @@ -139,4 +140,4 @@ Using `terraform import`, import `aws_apigatewayv2_deployment` using the API ide The `triggers` argument cannot be imported. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/apigatewayv2_domain_name.html.markdown b/website/docs/cdktf/typescript/r/apigatewayv2_domain_name.html.markdown index 598db8ab418d..d8b6749dfae1 100644 --- a/website/docs/cdktf/typescript/r/apigatewayv2_domain_name.html.markdown +++ b/website/docs/cdktf/typescript/r/apigatewayv2_domain_name.html.markdown @@ -99,6 +99,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `domainName` - (Required) Domain name. Must be between 1 and 512 characters in length. * `domainNameConfiguration` - (Required) Domain name configuration. See below. * `mutualTlsAuthentication` - (Optional) Mutual TLS authentication configuration for the domain name. @@ -167,4 +168,4 @@ Using `terraform import`, import `aws_apigatewayv2_domain_name` using the domain % terraform import aws_apigatewayv2_domain_name.example ws-api.example.com ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/apigatewayv2_integration.html.markdown b/website/docs/cdktf/typescript/r/apigatewayv2_integration.html.markdown index 34a2feb65641..e085f8df9d07 100644 --- a/website/docs/cdktf/typescript/r/apigatewayv2_integration.html.markdown +++ b/website/docs/cdktf/typescript/r/apigatewayv2_integration.html.markdown @@ -166,6 +166,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `apiId` - (Required) API identifier. * `integrationType` - (Required) Integration type of an integration. Valid values: `AWS` (supported only for WebSocket APIs), `AWS_PROXY`, `HTTP` (supported only for WebSocket APIs), `HTTP_PROXY`, `MOCK` (supported only for WebSocket APIs). For an HTTP API private integration, use `HTTP_PROXY`. @@ -244,4 +245,4 @@ Using `terraform import`, import `aws_apigatewayv2_integration` using the API id -> **Note:** The API Gateway managed integration created as part of [_quick_create_](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-basic-concept.html#apigateway-definition-quick-create) cannot be imported. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/apigatewayv2_integration_response.html.markdown b/website/docs/cdktf/typescript/r/apigatewayv2_integration_response.html.markdown index 25314c310fee..ae0a102362f8 100644 --- a/website/docs/cdktf/typescript/r/apigatewayv2_integration_response.html.markdown +++ b/website/docs/cdktf/typescript/r/apigatewayv2_integration_response.html.markdown @@ -43,6 +43,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `apiId` - (Required) API identifier. * `integrationId` - (Required) Identifier of the [`aws_apigatewayv2_integration`](/docs/providers/aws/r/apigatewayv2_integration.html). * `integrationResponseKey` - (Required) Integration response key. @@ -88,4 +89,4 @@ Using `terraform import`, import `aws_apigatewayv2_integration_response` using t % terraform import aws_apigatewayv2_integration_response.example aabbccddee/1122334/998877 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/apigatewayv2_model.html.markdown b/website/docs/cdktf/typescript/r/apigatewayv2_model.html.markdown index d4bd351fd425..39efb812fff2 100644 --- a/website/docs/cdktf/typescript/r/apigatewayv2_model.html.markdown +++ b/website/docs/cdktf/typescript/r/apigatewayv2_model.html.markdown @@ -54,6 +54,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `apiId` - (Required) API identifier. * `contentType` - (Required) The content-type for the model, for example, `application/json`. Must be between 1 and 256 characters in length. * `name` - (Required) Name of the model. Must be alphanumeric. Must be between 1 and 128 characters in length. @@ -98,4 +99,4 @@ Using `terraform import`, import `aws_apigatewayv2_model` using the API identifi % terraform import aws_apigatewayv2_model.example aabbccddee/1122334 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/apigatewayv2_route.html.markdown b/website/docs/cdktf/typescript/r/apigatewayv2_route.html.markdown index 12bed89420a8..033dc9f17efa 100644 --- a/website/docs/cdktf/typescript/r/apigatewayv2_route.html.markdown +++ b/website/docs/cdktf/typescript/r/apigatewayv2_route.html.markdown @@ -102,6 +102,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `apiId` - (Required) API identifier. * `routeKey` - (Required) Route key for the route. For HTTP APIs, the route key can be either `$default`, or a combination of an HTTP method and resource path, for example, `GET /pets`. * `apiKeyRequired` - (Optional) Boolean whether an API key is required for the route. Defaults to `false`. Supported only for WebSocket APIs. @@ -163,4 +164,4 @@ Using `terraform import`, import `aws_apigatewayv2_route` using the API identifi -> **Note:** The API Gateway managed route created as part of [_quick_create_](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-basic-concept.html#apigateway-definition-quick-create) cannot be imported. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/apigatewayv2_route_response.html.markdown b/website/docs/cdktf/typescript/r/apigatewayv2_route_response.html.markdown index 3d91dac29358..459daa7c8471 100644 --- a/website/docs/cdktf/typescript/r/apigatewayv2_route_response.html.markdown +++ b/website/docs/cdktf/typescript/r/apigatewayv2_route_response.html.markdown @@ -49,6 +49,7 @@ You can only define the $default route response for WebSocket APIs. You can use This resource supports the following arguments: +* `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). * `apiId` - (Required) API identifier. * `routeId` - (Required) Identifier of the [`aws_apigatewayv2_route`](/docs/providers/aws/r/apigatewayv2_route.html). * `routeResponseKey` - (Required) Route response key. @@ -93,4 +94,4 @@ Using `terraform import`, import `aws_apigatewayv2_route_response` using the API % terraform import aws_apigatewayv2_route_response.example aabbccddee/1122334/998877 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/apigatewayv2_stage.html.markdown b/website/docs/cdktf/typescript/r/apigatewayv2_stage.html.markdown index a0a53f8d17e0..1b9121ab7cac 100644 --- a/website/docs/cdktf/typescript/r/apigatewayv2_stage.html.markdown +++ b/website/docs/cdktf/typescript/r/apigatewayv2_stage.html.markdown @@ -47,6 +47,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `accessLogSettings` - (Optional) Settings for logging access in this stage. Use the [`aws_api_gateway_account`](/docs/providers/aws/r/api_gateway_account.html) resource to configure [permissions for CloudWatch Logging](https://docs.aws.amazon.com/apigateway/latest/developerguide/set-up-logging.html#set-up-access-logging-permissions). * `autoDeploy` - (Optional) Whether updates to an API automatically trigger a new deployment. Defaults to `false`. Applicable for HTTP APIs. @@ -132,4 +133,4 @@ Using `terraform import`, import `aws_apigatewayv2_stage` using the API identifi -> **Note:** The API Gateway managed stage created as part of [_quick_create_](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-basic-concept.html#apigateway-definition-quick-create) cannot be imported. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/apigatewayv2_vpc_link.html.markdown b/website/docs/cdktf/typescript/r/apigatewayv2_vpc_link.html.markdown index afe56177391b..0d1e41b0ef63 100644 --- a/website/docs/cdktf/typescript/r/apigatewayv2_vpc_link.html.markdown +++ b/website/docs/cdktf/typescript/r/apigatewayv2_vpc_link.html.markdown @@ -46,6 +46,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) Name of the VPC Link. Must be between 1 and 128 characters in length. * `securityGroupIds` - (Required) Security group IDs for the VPC Link. * `subnetIds` - (Required) Subnet IDs for the VPC Link. @@ -87,4 +88,4 @@ Using `terraform import`, import `aws_apigatewayv2_vpc_link` using the VPC Link % terraform import aws_apigatewayv2_vpc_link.example aabbccddee ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/app_cookie_stickiness_policy.html.markdown b/website/docs/cdktf/typescript/r/app_cookie_stickiness_policy.html.markdown index c840c9bbc5c6..413315a28ee9 100644 --- a/website/docs/cdktf/typescript/r/app_cookie_stickiness_policy.html.markdown +++ b/website/docs/cdktf/typescript/r/app_cookie_stickiness_policy.html.markdown @@ -54,6 +54,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) Name of the stickiness policy. * `loadBalancer` - (Required) Name of load balancer to which the policy should be attached. @@ -104,4 +105,4 @@ Using `terraform import`, import application cookie stickiness policies using th % terraform import aws_app_cookie_stickiness_policy.example my-elb:80:my-policy ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/appautoscaling_policy.html.markdown b/website/docs/cdktf/typescript/r/appautoscaling_policy.html.markdown index 045040e64bf7..73a0967a3fbc 100644 --- a/website/docs/cdktf/typescript/r/appautoscaling_policy.html.markdown +++ b/website/docs/cdktf/typescript/r/appautoscaling_policy.html.markdown @@ -275,6 +275,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) Name of the policy. Must be between 1 and 255 characters in length. * `policyType` - (Optional) Policy type. Valid values are `StepScaling` and `TargetTrackingScaling`. Defaults to `StepScaling`. Certain services only support only one policy type. For more information see the [Target Tracking Scaling Policies](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-target-tracking.html) and [Step Scaling Policies](https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-step-scaling-policies.html) documentation. * `resourceId` - (Required) Resource type and unique identifier string for the resource associated with the scaling policy. Documentation can be found in the `ResourceId` parameter at: [AWS Application Auto Scaling API Reference](https://docs.aws.amazon.com/autoscaling/application/APIReference/API_RegisterScalableTarget.html) @@ -497,4 +498,4 @@ Using `terraform import`, import Application AutoScaling Policy using the `servi % terraform import aws_appautoscaling_policy.test-policy service-namespace/resource-id/scalable-dimension/policy-name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/appautoscaling_scheduled_action.html.markdown b/website/docs/cdktf/typescript/r/appautoscaling_scheduled_action.html.markdown index eae157c5bd56..40e929993181 100644 --- a/website/docs/cdktf/typescript/r/appautoscaling_scheduled_action.html.markdown +++ b/website/docs/cdktf/typescript/r/appautoscaling_scheduled_action.html.markdown @@ -100,6 +100,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) Name of the scheduled action. * `serviceNamespace` - (Required) Namespace of the AWS service. Documentation can be found in the `ServiceNamespace` parameter at: [AWS Application Auto Scaling API Reference](https://docs.aws.amazon.com/autoscaling/application/APIReference/API_PutScheduledAction.html) Example: ecs * `resourceId` - (Required) Identifier of the resource associated with the scheduled action. Documentation can be found in the `ResourceId` parameter at: [AWS Application Auto Scaling API Reference](https://docs.aws.amazon.com/autoscaling/application/APIReference/API_PutScheduledAction.html) @@ -121,4 +122,4 @@ This resource exports the following attributes in addition to the arguments abov * `arn` - ARN of the scheduled action. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/appautoscaling_target.html.markdown b/website/docs/cdktf/typescript/r/appautoscaling_target.html.markdown index 15f03455bd59..8f97e1665bc8 100644 --- a/website/docs/cdktf/typescript/r/appautoscaling_target.html.markdown +++ b/website/docs/cdktf/typescript/r/appautoscaling_target.html.markdown @@ -158,6 +158,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `maxCapacity` - (Required) Max capacity of the scalable target. * `minCapacity` - (Required) Min capacity of the scalable target. * `resourceId` - (Required) Resource type and unique identifier string for the resource associated with the scaling policy. Documentation can be found in the `ResourceId` parameter at: [AWS Application Auto Scaling API Reference](https://docs.aws.amazon.com/autoscaling/application/APIReference/API_RegisterScalableTarget.html#API_RegisterScalableTarget_RequestParameters) @@ -214,4 +215,4 @@ Using `terraform import`, import Application AutoScaling Target using the `servi % terraform import aws_appautoscaling_target.test-target service-namespace/resource-id/scalable-dimension ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/appconfig_application.html.markdown b/website/docs/cdktf/typescript/r/appconfig_application.html.markdown index b73d13c85f86..d78754414402 100644 --- a/website/docs/cdktf/typescript/r/appconfig_application.html.markdown +++ b/website/docs/cdktf/typescript/r/appconfig_application.html.markdown @@ -42,6 +42,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) Name for the application. Must be between 1 and 64 characters in length. * `description` - (Optional) Description of the application. Can be at most 1024 characters. * `tags` - (Optional) Map of tags to assign to the resource. If configured with a provider [`defaultTags` 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. @@ -82,4 +83,4 @@ Using `terraform import`, import AppConfig Applications using their application % terraform import aws_appconfig_application.example 71rxuzt ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/appconfig_configuration_profile.html.markdown b/website/docs/cdktf/typescript/r/appconfig_configuration_profile.html.markdown index 998e61f5a66a..6753fdb0ada3 100644 --- a/website/docs/cdktf/typescript/r/appconfig_configuration_profile.html.markdown +++ b/website/docs/cdktf/typescript/r/appconfig_configuration_profile.html.markdown @@ -50,6 +50,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `applicationId` - (Required, Forces new resource) Application ID. Must be between 4 and 7 characters in length. * `locationUri` - (Required, Forces new resource) URI to locate the configuration. You can specify the AWS AppConfig hosted configuration store, Systems Manager (SSM) document, an SSM Parameter Store parameter, or an Amazon S3 object. For the hosted configuration store, specify `hosted`. For an SSM document, specify either the document name in the format `ssm-document://` or the ARN. For a parameter, specify either the parameter name in the format `ssm-parameter://` or the ARN. For an Amazon S3 object, specify the URI in the following format: `s3:///`. * `name` - (Required) Name for the configuration profile. Must be between 1 and 128 characters in length. @@ -108,4 +109,4 @@ Using `terraform import`, import AppConfig Configuration Profiles using the conf % terraform import aws_appconfig_configuration_profile.example 71abcde:11xxxxx ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/appconfig_deployment.html.markdown b/website/docs/cdktf/typescript/r/appconfig_deployment.html.markdown index a8de25d6e0e8..562d5cf0168b 100644 --- a/website/docs/cdktf/typescript/r/appconfig_deployment.html.markdown +++ b/website/docs/cdktf/typescript/r/appconfig_deployment.html.markdown @@ -55,6 +55,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `applicationId` - (Required, Forces new resource) Application ID. Must be between 4 and 7 characters in length. * `configurationProfileId` - (Required, Forces new resource) Configuration profile ID. Must be between 4 and 7 characters in length. * `configurationVersion` - (Required, Forces new resource) Configuration version to deploy. Can be at most 1024 characters. @@ -107,4 +108,4 @@ Using `terraform import`, import AppConfig Deployments using the application ID, % terraform import aws_appconfig_deployment.example 71abcde/11xxxxx/1 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/appconfig_deployment_strategy.html.markdown b/website/docs/cdktf/typescript/r/appconfig_deployment_strategy.html.markdown index ff8471d13049..7d3812b7d7f4 100644 --- a/website/docs/cdktf/typescript/r/appconfig_deployment_strategy.html.markdown +++ b/website/docs/cdktf/typescript/r/appconfig_deployment_strategy.html.markdown @@ -47,6 +47,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `deploymentDurationInMinutes` - (Required) Total amount of time for a deployment to last. Minimum value of 0, maximum value of 1440. * `growthFactor` - (Required) Percentage of targets to receive a deployed configuration during each interval. Minimum value of 1.0, maximum value of 100.0. * `name` - (Required, Forces new resource) Name for the deployment strategy. Must be between 1 and 64 characters in length. @@ -96,4 +97,4 @@ Using `terraform import`, import AppConfig Deployment Strategies using their dep % terraform import aws_appconfig_deployment_strategy.example 11xxxxx ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/appconfig_environment.html.markdown b/website/docs/cdktf/typescript/r/appconfig_environment.html.markdown index 2b247a12496a..98a488fb0aff 100644 --- a/website/docs/cdktf/typescript/r/appconfig_environment.html.markdown +++ b/website/docs/cdktf/typescript/r/appconfig_environment.html.markdown @@ -63,6 +63,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `applicationId` - (Required, Forces new resource) AppConfig application ID. Must be between 4 and 7 characters in length. * `name` - (Required) Name for the environment. Must be between 1 and 64 characters in length. * `description` - (Optional) Description of the environment. Can be at most 1024 characters. @@ -119,4 +120,4 @@ Using `terraform import`, import AppConfig Environments using the environment ID % terraform import aws_appconfig_environment.example 71abcde:11xxxxx ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/appconfig_extension.html.markdown b/website/docs/cdktf/typescript/r/appconfig_extension.html.markdown index b7eb08400765..b398f918fb8f 100644 --- a/website/docs/cdktf/typescript/r/appconfig_extension.html.markdown +++ b/website/docs/cdktf/typescript/r/appconfig_extension.html.markdown @@ -87,6 +87,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) A name for the extension. Each extension name in your account must be unique. Extension versions use the same name. * `description` - (Optional) Information about the extension. * `actionPoint` - (Required) The action points defined in the extension. [Detailed below](#action_point). @@ -153,4 +154,4 @@ Using `terraform import`, import AppConfig Extensions using their extension ID. % terraform import aws_appconfig_extension.example 71rxuzt ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/appconfig_extension_association.html.markdown b/website/docs/cdktf/typescript/r/appconfig_extension_association.html.markdown index 14ed6d603250..99755935753b 100644 --- a/website/docs/cdktf/typescript/r/appconfig_extension_association.html.markdown +++ b/website/docs/cdktf/typescript/r/appconfig_extension_association.html.markdown @@ -101,6 +101,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `extensionArn` - (Required) The ARN of the extension defined in the association. * `resourceArn` - (Optional) The ARN of the application, configuration profile, or environment to associate with the extension. * `parameters` - (Optional) The parameter names and values defined for the association. @@ -145,4 +146,4 @@ Using `terraform import`, import AppConfig Extension Associations using their ex % terraform import aws_appconfig_extension_association.example 71rxuzt ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/appconfig_hosted_configuration_version.html.markdown b/website/docs/cdktf/typescript/r/appconfig_hosted_configuration_version.html.markdown index 5290a4eb7e0c..5f51d08e0d3f 100644 --- a/website/docs/cdktf/typescript/r/appconfig_hosted_configuration_version.html.markdown +++ b/website/docs/cdktf/typescript/r/appconfig_hosted_configuration_version.html.markdown @@ -119,6 +119,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `applicationId` - (Required, Forces new resource) Application ID. * `configurationProfileId` - (Required, Forces new resource) Configuration profile ID. * `content` - (Required, Forces new resource) Content of the configuration or the configuration data. @@ -165,4 +166,4 @@ Using `terraform import`, import AppConfig Hosted Configuration Versions using t % terraform import aws_appconfig_hosted_configuration_version.example 71abcde/11xxxxx/2 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/appfabric_app_authorization.html.markdown b/website/docs/cdktf/typescript/r/appfabric_app_authorization.html.markdown index 2862d2a65f0d..94c888130aff 100644 --- a/website/docs/cdktf/typescript/r/appfabric_app_authorization.html.markdown +++ b/website/docs/cdktf/typescript/r/appfabric_app_authorization.html.markdown @@ -57,6 +57,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `app` - (Required) The name of the application for valid values see https://docs.aws.amazon.com/appfabric/latest/api/API_CreateAppAuthorization.html. * `appBundleArn` - (Required) The Amazon Resource Name (ARN) of the app bundle to use for the request. * `authType` - (Required) The authorization type for the app authorization valid values are oauth2 and apiKey. @@ -99,4 +100,4 @@ This resource exports the following attributes in addition to the arguments abov * `update` - (Default `30m`) * `delete` - (Default `30m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/appfabric_app_authorization_connection.html.markdown b/website/docs/cdktf/typescript/r/appfabric_app_authorization_connection.html.markdown index 19e74c480332..5fa1cd1a4721 100644 --- a/website/docs/cdktf/typescript/r/appfabric_app_authorization_connection.html.markdown +++ b/website/docs/cdktf/typescript/r/appfabric_app_authorization_connection.html.markdown @@ -41,6 +41,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `appBundleArn` - (Required) The Amazon Resource Name (ARN) of the app bundle to use for the request. * `appAuthorizationArn` - (Required) The Amazon Resource Name (ARN) or Universal Unique Identifier (UUID) of the app authorization to use for the request. * `authRequest` - (Optional) Contains OAuth2 authorization information.This is required if the app authorization for the request is configured with an OAuth2 (oauth2) authorization type. @@ -63,4 +64,4 @@ This resource exports the following attributes in addition to the arguments abov * `create` - (Default `30m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/appfabric_app_bundle.html.markdown b/website/docs/cdktf/typescript/r/appfabric_app_bundle.html.markdown index 880062c90537..c2183a9de9f9 100644 --- a/website/docs/cdktf/typescript/r/appfabric_app_bundle.html.markdown +++ b/website/docs/cdktf/typescript/r/appfabric_app_bundle.html.markdown @@ -43,6 +43,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `customerManagedKeyArn` - (Optional) The Amazon Resource Name (ARN) of the AWS Key Management Service (AWS KMS) key to use to encrypt the application data. If this is not specified, an AWS owned key is used for encryption. * `tags` - (Optional) Map of tags to assign to the resource. If configured with a provider [`defaultTags` 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. @@ -85,4 +86,4 @@ Using `terraform import`, import AppFabric AppBundle using the `arn`. For exampl % terraform import aws_appfabric_app_bundle.example arn:aws:appfabric:[region]:[account]:appbundle/ee5587b4-5765-4288-a202-xxxxxxxxxx ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/appfabric_ingestion.html.markdown b/website/docs/cdktf/typescript/r/appfabric_ingestion.html.markdown index eb67760a3750..d37f66a0cf2f 100644 --- a/website/docs/cdktf/typescript/r/appfabric_ingestion.html.markdown +++ b/website/docs/cdktf/typescript/r/appfabric_ingestion.html.markdown @@ -46,6 +46,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `app` - (Required) Name of the application. Refer to the AWS Documentation for the [list of valid values](https://docs.aws.amazon.com/appfabric/latest/api/API_CreateIngestion.html#appfabric-CreateIngestion-request-app) * `appBundleArn` - (Required) Amazon Resource Name (ARN) of the app bundle to use for the request. @@ -92,4 +93,4 @@ Using `terraform import`, import AppFabric Ingestion using the `app_bundle_ident % terraform import aws_appfabric_ingestion.example arn:aws:appfabric:[region]:[account]:appbundle/a9b91477-8831-43c0-970c-xxxxxxxxxx,arn:aws:appfabric:[region]:[account]:appbundle/a9b91477-8831-43c0-970c-xxxxxxxxxx/ingestion/32251416-710b-4425-96ca-xxxxxxxxxx ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/appfabric_ingestion_destination.html.markdown b/website/docs/cdktf/typescript/r/appfabric_ingestion_destination.html.markdown index c4832ebb30b0..8ae6a2e43ed0 100644 --- a/website/docs/cdktf/typescript/r/appfabric_ingestion_destination.html.markdown +++ b/website/docs/cdktf/typescript/r/appfabric_ingestion_destination.html.markdown @@ -68,6 +68,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `appBundleArn` - (Required) The Amazon Resource Name (ARN) of the app bundle to use for the request. * `ingestionArn` - (Required) The Amazon Resource Name (ARN) of the ingestion to use for the request. * `destinationConfiguration` - (Required) Contains information about the destination of ingested data. @@ -120,4 +121,4 @@ This resource exports the following attributes in addition to the arguments abov * `update` - (Default `5m`) * `delete` - (Default `5m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/appflow_connector_profile.html.markdown b/website/docs/cdktf/typescript/r/appflow_connector_profile.html.markdown index 1177a911d290..270bdcdc64f6 100644 --- a/website/docs/cdktf/typescript/r/appflow_connector_profile.html.markdown +++ b/website/docs/cdktf/typescript/r/appflow_connector_profile.html.markdown @@ -117,6 +117,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name ` (Required) - Name of the connector profile. The name is unique for each `ConnectorProfile` in your AWS account. * `connectionMode` (Required) - Indicates the connection mode and specifies whether it is public or private. Private flows use AWS PrivateLink to route data over AWS infrastructure without exposing it to the public internet. One of: `Public`, `Private`. * `connectorLabel` (Optional) - The label of the connector. The label is unique for each ConnectorRegistration in your AWS account. Only needed if calling for `CustomConnector` connector type. @@ -357,7 +358,7 @@ This resource exports the following attributes in addition to the arguments abov ## Import -In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import AppFlow Connector Profile using the connector profile `arn`. For example: +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import AppFlow Connector Profile using the connector profile `name`. For example: ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -373,21 +374,21 @@ class MyConvertedCode extends TerraformStack { super(scope, name); AppflowConnectorProfile.generateConfigForImport( this, - "profile", - "arn:aws:appflow:us-west-2:123456789012:connectorprofile/example-profile" + "example", + "example-profile" ); } } ``` -Using `terraform import`, import AppFlow Connector Profile using the connector profile `arn`. For example: +Using `terraform import`, import AppFlow Connector Profile using the connector profile `name`. For example: ```console -% terraform import aws_appflow_connector_profile.profile arn:aws:appflow:us-west-2:123456789012:connectorprofile/example-profile +% terraform import aws_appflow_connector_profile.example example-profile ``` [1]: https://docs.aws.amazon.com/appflow/1.0/APIReference/Welcome.html [2]: https://docs.aws.amazon.com/appflow/1.0/APIReference/API_CreateConnectorProfile.html - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/appflow_flow.html.markdown b/website/docs/cdktf/typescript/r/appflow_flow.html.markdown index f7f2e591cf2f..1f52ce50c202 100644 --- a/website/docs/cdktf/typescript/r/appflow_flow.html.markdown +++ b/website/docs/cdktf/typescript/r/appflow_flow.html.markdown @@ -174,6 +174,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) Name of the flow. * `destinationFlowConfig` - (Required) A [Destination Flow Config](#destination-flow-config) that controls how Amazon AppFlow places data in the destination connector. * `sourceFlowConfig` - (Required) The [Source Flow Config](#source-flow-config) that controls how Amazon AppFlow retrieves data from the source connector. @@ -484,7 +485,7 @@ This resource exports the following attributes in addition to the arguments abov ## Import -In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import AppFlow flows using the `arn`. For example: +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import AppFlow flows using the `name`. For example: ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -498,20 +499,16 @@ import { AppflowFlow } from "./.gen/providers/aws/appflow-flow"; class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); - AppflowFlow.generateConfigForImport( - this, - "example", - "arn:aws:appflow:us-west-2:123456789012:flow/example-flow" - ); + AppflowFlow.generateConfigForImport(this, "example", "example-flow"); } } ``` -Using `terraform import`, import AppFlow flows using the `arn`. For example: +Using `terraform import`, import AppFlow flows using the `name`. For example: ```console -% terraform import aws_appflow_flow.example arn:aws:appflow:us-west-2:123456789012:flow/example-flow +% terraform import aws_appflow_flow.example example-flow ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/appintegrations_data_integration.html.markdown b/website/docs/cdktf/typescript/r/appintegrations_data_integration.html.markdown index b0e081d6b413..904e4976ce40 100644 --- a/website/docs/cdktf/typescript/r/appintegrations_data_integration.html.markdown +++ b/website/docs/cdktf/typescript/r/appintegrations_data_integration.html.markdown @@ -49,6 +49,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `description` - (Optional) Specifies the description of the Data Integration. * `kmsKey` - (Required) Specifies the KMS key Amazon Resource Name (ARN) for the Data Integration. * `name` - (Required) Specifies the name of the Data Integration. @@ -102,4 +103,4 @@ Using `terraform import`, import Amazon AppIntegrations Data Integrations using % terraform import aws_appintegrations_data_integration.example 12345678-1234-1234-1234-123456789123 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/appintegrations_event_integration.html.markdown b/website/docs/cdktf/typescript/r/appintegrations_event_integration.html.markdown index 01e8fa3a7452..df4599be1da5 100644 --- a/website/docs/cdktf/typescript/r/appintegrations_event_integration.html.markdown +++ b/website/docs/cdktf/typescript/r/appintegrations_event_integration.html.markdown @@ -46,6 +46,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `description` - (Optional) Description of the Event Integration. * `eventbridgeBus` - (Required) EventBridge bus. * `eventFilter` - (Required) Block that defines the configuration information for the event filter. The Event Filter block is documented below. @@ -96,4 +97,4 @@ Using `terraform import`, import Amazon AppIntegrations Event Integrations using % terraform import aws_appintegrations_event_integration.example example-name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/applicationinsights_application.html.markdown b/website/docs/cdktf/typescript/r/applicationinsights_application.html.markdown index ad6de82f1bc7..f0eeb33d006e 100644 --- a/website/docs/cdktf/typescript/r/applicationinsights_application.html.markdown +++ b/website/docs/cdktf/typescript/r/applicationinsights_application.html.markdown @@ -62,6 +62,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `autoConfigEnabled` - (Optional) Indicates whether Application Insights automatically configures unmonitored resources in the resource group. * `autoCreate` - (Optional) Configures all of the resources in the resource group by applying the recommended configurations. * `cweMonitorEnabled` - (Optional) Indicates whether Application Insights can listen to CloudWatch events for the application resources, such as instance terminated, failed deployment, and others. @@ -110,4 +111,4 @@ Using `terraform import`, import ApplicationInsights Applications using the `res % terraform import aws_applicationinsights_application.some some-application ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/appmesh_gateway_route.html.markdown b/website/docs/cdktf/typescript/r/appmesh_gateway_route.html.markdown index b19408884217..519c42ffe94b 100644 --- a/website/docs/cdktf/typescript/r/appmesh_gateway_route.html.markdown +++ b/website/docs/cdktf/typescript/r/appmesh_gateway_route.html.markdown @@ -59,6 +59,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) Name to use for the gateway route. Must be between 1 and 255 characters in length. * `meshName` - (Required) Name of the service mesh in which to create the gateway route. Must be between 1 and 255 characters in length. * `virtualGatewayName` - (Required) Name of the [virtual gateway](/docs/providers/aws/r/appmesh_virtual_gateway.html) to associate the gateway route with. Must be between 1 and 255 characters in length. @@ -212,4 +213,4 @@ Using `terraform import`, import App Mesh gateway routes using `meshName` and `v [1]: /docs/providers/aws/index.html - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/appmesh_mesh.html.markdown b/website/docs/cdktf/typescript/r/appmesh_mesh.html.markdown index f602473c698c..81e607202ab3 100644 --- a/website/docs/cdktf/typescript/r/appmesh_mesh.html.markdown +++ b/website/docs/cdktf/typescript/r/appmesh_mesh.html.markdown @@ -67,6 +67,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `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. * `egressFilter`- (Optional) Egress filter rules for the service mesh. @@ -115,4 +116,4 @@ Using `terraform import`, import App Mesh service meshes using the `name`. For e % terraform import aws_appmesh_mesh.simple simpleapp ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/appmesh_route.html.markdown b/website/docs/cdktf/typescript/r/appmesh_route.html.markdown index 31fa2b2fa3b6..8fbc122a4d46 100644 --- a/website/docs/cdktf/typescript/r/appmesh_route.html.markdown +++ b/website/docs/cdktf/typescript/r/appmesh_route.html.markdown @@ -193,6 +193,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) Name to use for the route. Must be between 1 and 255 characters in length. * `meshName` - (Required) Name of the service mesh in which to create the route. Must be between 1 and 255 characters in length. * `meshOwner` - (Optional) AWS account ID of the service mesh's owner. Defaults to the account ID the [AWS provider][1] is currently connected to. @@ -405,4 +406,4 @@ Using `terraform import`, import App Mesh virtual routes using `meshName` and `v [1]: /docs/providers/aws/index.html - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/appmesh_virtual_gateway.html.markdown b/website/docs/cdktf/typescript/r/appmesh_virtual_gateway.html.markdown index ccf30e71c23c..94b2f038e158 100644 --- a/website/docs/cdktf/typescript/r/appmesh_virtual_gateway.html.markdown +++ b/website/docs/cdktf/typescript/r/appmesh_virtual_gateway.html.markdown @@ -102,6 +102,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) Name to use for the virtual gateway. Must be between 1 and 255 characters in length. * `meshName` - (Required) Name of the service mesh in which to create the virtual gateway. Must be between 1 and 255 characters in length. * `meshOwner` - (Optional) AWS account ID of the service mesh's owner. Defaults to the account ID the [AWS provider][1] is currently connected to. @@ -330,4 +331,4 @@ Using `terraform import`, import App Mesh virtual gateway using `meshName` toget [1]: /docs/providers/aws/index.html - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/appmesh_virtual_node.html.markdown b/website/docs/cdktf/typescript/r/appmesh_virtual_node.html.markdown index 674f76942fc2..cc778d4802a2 100644 --- a/website/docs/cdktf/typescript/r/appmesh_virtual_node.html.markdown +++ b/website/docs/cdktf/typescript/r/appmesh_virtual_node.html.markdown @@ -232,6 +232,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) Name to use for the virtual node. Must be between 1 and 255 characters in length. * `meshName` - (Required) Name of the service mesh in which to create the virtual node. Must be between 1 and 255 characters in length. * `meshOwner` - (Optional) AWS account ID of the service mesh's owner. Defaults to the account ID the [AWS provider][1] is currently connected to. @@ -549,4 +550,4 @@ Using `terraform import`, import App Mesh virtual nodes using `meshName` togethe [1]: /docs/providers/aws/index.html - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/appmesh_virtual_router.html.markdown b/website/docs/cdktf/typescript/r/appmesh_virtual_router.html.markdown index 2b913c59901f..a91a706d673f 100644 --- a/website/docs/cdktf/typescript/r/appmesh_virtual_router.html.markdown +++ b/website/docs/cdktf/typescript/r/appmesh_virtual_router.html.markdown @@ -59,6 +59,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) Name to use for the virtual router. Must be between 1 and 255 characters in length. * `meshName` - (Required) Name of the service mesh in which to create the virtual router. Must be between 1 and 255 characters in length. * `meshOwner` - (Optional) AWS account ID of the service mesh's owner. Defaults to the account ID the [AWS provider][1] is currently connected to. @@ -124,4 +125,4 @@ Using `terraform import`, import App Mesh virtual routers using `meshName` toget [1]: /docs/providers/aws/index.html - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/appmesh_virtual_service.html.markdown b/website/docs/cdktf/typescript/r/appmesh_virtual_service.html.markdown index 2d115a755172..825ebe193ac1 100644 --- a/website/docs/cdktf/typescript/r/appmesh_virtual_service.html.markdown +++ b/website/docs/cdktf/typescript/r/appmesh_virtual_service.html.markdown @@ -78,6 +78,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) Name to use for the virtual service. Must be between 1 and 255 characters in length. * `meshName` - (Required) Name of the service mesh in which to create the virtual service. Must be between 1 and 255 characters in length. * `meshOwner` - (Optional) AWS account ID of the service mesh's owner. Defaults to the account ID the [AWS provider][1] is currently connected to. @@ -146,4 +147,4 @@ Using `terraform import`, import App Mesh virtual services using `meshName` toge [1]: /docs/providers/aws/index.html - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/apprunner_auto_scaling_configuration_version.html.markdown b/website/docs/cdktf/typescript/r/apprunner_auto_scaling_configuration_version.html.markdown index 590bb769f868..372f857e730a 100644 --- a/website/docs/cdktf/typescript/r/apprunner_auto_scaling_configuration_version.html.markdown +++ b/website/docs/cdktf/typescript/r/apprunner_auto_scaling_configuration_version.html.markdown @@ -44,6 +44,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `autoScalingConfigurationName` - (Required, Forces new resource) Name of the auto scaling configuration. * `maxConcurrency` - (Optional, Forces new resource) Maximal number of concurrent requests that you want an instance to process. When the number of concurrent requests goes over this limit, App Runner scales up your service. * `maxSize` - (Optional, Forces new resource) Maximal number of instances that App Runner provisions for your service. @@ -92,4 +93,4 @@ Using `terraform import`, import App Runner AutoScaling Configuration Versions u % terraform import aws_apprunner_auto_scaling_configuration_version.example "arn:aws:apprunner:us-east-1:1234567890:autoscalingconfiguration/example/1/69bdfe0115224b0db49398b7beb68e0f ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/apprunner_connection.html.markdown b/website/docs/cdktf/typescript/r/apprunner_connection.html.markdown index a8e8fa80fdac..ad85f9bb8186 100644 --- a/website/docs/cdktf/typescript/r/apprunner_connection.html.markdown +++ b/website/docs/cdktf/typescript/r/apprunner_connection.html.markdown @@ -44,6 +44,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `connectionName` - (Required) Name of the connection. * `providerType` - (Required) Source repository provider. Valid values: `GITHUB`. * `tags` - (Optional) Key-value map of resource tags. If configured with a provider [`defaultTags` 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. @@ -84,4 +85,4 @@ Using `terraform import`, import App Runner Connections using the `connectionNam % terraform import aws_apprunner_connection.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/apprunner_custom_domain_association.html.markdown b/website/docs/cdktf/typescript/r/apprunner_custom_domain_association.html.markdown index 9c98c7565b52..72ac2736247f 100644 --- a/website/docs/cdktf/typescript/r/apprunner_custom_domain_association.html.markdown +++ b/website/docs/cdktf/typescript/r/apprunner_custom_domain_association.html.markdown @@ -41,6 +41,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `domainName` - (Required) Custom domain endpoint to association. Specify a base domain e.g., `example.com` or a subdomain e.g., `subdomain.example.com`. * `enableWwwSubdomain` (Optional) Whether to associate the subdomain with the App Runner service in addition to the base domain. Defaults to `true`. * `serviceArn` - (Required) ARN of the App Runner service. @@ -94,4 +95,4 @@ Using `terraform import`, import App Runner Custom Domain Associations using the % terraform import aws_apprunner_custom_domain_association.example example.com,arn:aws:apprunner:us-east-1:123456789012:service/example-app/8fe1e10304f84fd2b0df550fe98a71fa ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/apprunner_default_auto_scaling_configuration_version.html.markdown b/website/docs/cdktf/typescript/r/apprunner_default_auto_scaling_configuration_version.html.markdown index 9a3537a256f3..a0a20c6308dc 100644 --- a/website/docs/cdktf/typescript/r/apprunner_default_auto_scaling_configuration_version.html.markdown +++ b/website/docs/cdktf/typescript/r/apprunner_default_auto_scaling_configuration_version.html.markdown @@ -57,6 +57,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `autoScalingConfigurationArn` - (Required) The ARN of the App Runner auto scaling configuration that you want to set as the default. ## Attribute Reference @@ -95,4 +96,4 @@ Using `terraform import`, import App Runner default auto scaling configurations % terraform import aws_apprunner_default_auto_scaling_configuration_version.example us-west-2 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/apprunner_deployment.html.markdown b/website/docs/cdktf/typescript/r/apprunner_deployment.html.markdown index c30cef4e4fff..f46207eb5378 100644 --- a/website/docs/cdktf/typescript/r/apprunner_deployment.html.markdown +++ b/website/docs/cdktf/typescript/r/apprunner_deployment.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `serviceArn` - (Required) The Amazon Resource Name (ARN) of the App Runner service to start the deployment for. ## Attribute Reference @@ -48,4 +49,4 @@ This resource exports the following attributes in addition to the arguments abov * `operationId` - The unique ID of the operation associated with deployment. * `status` - The current status of the App Runner service deployment. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/apprunner_observability_configuration.html.markdown b/website/docs/cdktf/typescript/r/apprunner_observability_configuration.html.markdown index 7fd9923aadfa..56a1b1d4ec9d 100644 --- a/website/docs/cdktf/typescript/r/apprunner_observability_configuration.html.markdown +++ b/website/docs/cdktf/typescript/r/apprunner_observability_configuration.html.markdown @@ -44,6 +44,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `observabilityConfigurationName` - (Required, Forces new resource) Name of the observability configuration. * `traceConfiguration` - (Optional) Configuration of the tracing feature within this observability configuration. If you don't specify it, App Runner doesn't enable tracing. See [Trace Configuration](#trace-configuration) below for more details. * `tags` - (Optional) Key-value map of resource tags. If configured with a provider [`defaultTags` 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. @@ -96,4 +97,4 @@ Using `terraform import`, import App Runner Observability Configuration using th % terraform import aws_apprunner_observability_configuration.example arn:aws:apprunner:us-east-1:1234567890:observabilityconfiguration/example/1/d75bc7ea55b71e724fe5c23452fe22a1 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/apprunner_service.html.markdown b/website/docs/cdktf/typescript/r/apprunner_service.html.markdown index 49791dfe823e..4dc73c78f751 100644 --- a/website/docs/cdktf/typescript/r/apprunner_service.html.markdown +++ b/website/docs/cdktf/typescript/r/apprunner_service.html.markdown @@ -160,6 +160,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `autoScalingConfigurationArn` - ARN of an App Runner automatic scaling configuration resource that you want to associate with your service. If not provided, App Runner associates the latest revision of a default auto scaling configuration. * `encryptionConfiguration` - (Forces new resource) An optional custom encryption key that App Runner uses to encrypt the copy of your source repository that it maintains and your service logs. By default, App Runner uses an AWS managed CMK. See [Encryption Configuration](#encryption-configuration) below for more details. * `healthCheckConfiguration` - Settings of the health check that AWS App Runner performs to monitor the health of your service. See [Health Check Configuration](#health-check-configuration) below for more details. @@ -341,4 +342,4 @@ Using `terraform import`, import App Runner Services using the `arn`. For exampl % terraform import aws_apprunner_service.example arn:aws:apprunner:us-east-1:1234567890:service/example/0a03292a89764e5882c41d8f991c82fe ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/apprunner_vpc_connector.html.markdown b/website/docs/cdktf/typescript/r/apprunner_vpc_connector.html.markdown index 674b034b260c..1a006427f8f7 100644 --- a/website/docs/cdktf/typescript/r/apprunner_vpc_connector.html.markdown +++ b/website/docs/cdktf/typescript/r/apprunner_vpc_connector.html.markdown @@ -40,6 +40,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `vpcConnectorName` - (Required) Name for the VPC connector. * `subnets` (Required) List of IDs of subnets that App Runner should use when it associates your service with a custom Amazon VPC. Specify IDs of subnets of a single Amazon VPC. App Runner determines the Amazon VPC from the subnets you specify. * `securityGroups` - List of IDs of security groups that App Runner should use for access to AWS resources under the specified subnets. If not specified, App Runner uses the default security group of the Amazon VPC. The default security group allows all outbound traffic. @@ -86,4 +87,4 @@ Using `terraform import`, import App Runner vpc connector using the `arn`. For e % terraform import aws_apprunner_vpc_connector.example arn:aws:apprunner:us-east-1:1234567890:vpcconnector/example/1/0a03292a89764e5882c41d8f991c82fe ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/apprunner_vpc_ingress_connection.html.markdown b/website/docs/cdktf/typescript/r/apprunner_vpc_ingress_connection.html.markdown index 1f85299251f9..84472c220174 100644 --- a/website/docs/cdktf/typescript/r/apprunner_vpc_ingress_connection.html.markdown +++ b/website/docs/cdktf/typescript/r/apprunner_vpc_ingress_connection.html.markdown @@ -46,6 +46,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) A name for the VPC Ingress Connection resource. It must be unique across all the active VPC Ingress Connections in your AWS account in the AWS Region. * `serviceArn` - (Required) The Amazon Resource Name (ARN) for this App Runner service that is used to create the VPC Ingress Connection resource. * `ingressVpcConfiguration` - (Required) Specifications for the customer’s Amazon VPC and the related AWS PrivateLink VPC endpoint that are used to create the VPC Ingress Connection resource. See [Ingress VPC Configuration](#ingress-vpc-configuration) below for more details. @@ -99,4 +100,4 @@ Using `terraform import`, import App Runner VPC Ingress Connection using the `ar % terraform import aws_apprunner_vpc_ingress_connection.example "arn:aws:apprunner:us-west-2:837424938642:vpcingressconnection/example/b379f86381d74825832c2e82080342fa" ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/appstream_directory_config.html.markdown b/website/docs/cdktf/typescript/r/appstream_directory_config.html.markdown index 829578e5191e..45d0182d1a6e 100644 --- a/website/docs/cdktf/typescript/r/appstream_directory_config.html.markdown +++ b/website/docs/cdktf/typescript/r/appstream_directory_config.html.markdown @@ -41,8 +41,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `directoryName` - (Required) Fully qualified name of the directory. * `organizationalUnitDistinguishedNames` - (Required) Distinguished names of the organizational units for computer accounts. * `serviceAccountCredentials` - (Required) Configuration block for the name of the directory and organizational unit (OU) to use to join the directory config to a Microsoft Active Directory domain. See [`serviceAccountCredentials`](#service_account_credentials) below. @@ -91,4 +92,4 @@ Using `terraform import`, import `aws_appstream_directory_config` using the id. % terraform import aws_appstream_directory_config.example directoryNameExample ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/appstream_fleet.html.markdown b/website/docs/cdktf/typescript/r/appstream_fleet.html.markdown index 8a2c2ed87a9e..25e007573bda 100644 --- a/website/docs/cdktf/typescript/r/appstream_fleet.html.markdown +++ b/website/docs/cdktf/typescript/r/appstream_fleet.html.markdown @@ -61,6 +61,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `description` - (Optional) Description to display. * `disconnectTimeoutInSeconds` - (Optional) Amount of time that a streaming session remains active after users disconnect. * `displayName` - (Optional) Human-readable friendly name for the AppStream fleet. @@ -138,4 +139,4 @@ Using `terraform import`, import `aws_appstream_fleet` using the id. For example % terraform import aws_appstream_fleet.example fleetNameExample ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/appstream_fleet_stack_association.html.markdown b/website/docs/cdktf/typescript/r/appstream_fleet_stack_association.html.markdown index f74cc4a9f289..7a8a1e5b9091 100644 --- a/website/docs/cdktf/typescript/r/appstream_fleet_stack_association.html.markdown +++ b/website/docs/cdktf/typescript/r/appstream_fleet_stack_association.html.markdown @@ -55,8 +55,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `fleetName` - (Required) Name of the fleet. * `stackName` (Required) Name of the stack. @@ -98,4 +99,4 @@ Using `terraform import`, import AppStream Stack Fleet Association using the `fl % terraform import aws_appstream_fleet_stack_association.example fleetName/stackName ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/appstream_image_builder.html.markdown b/website/docs/cdktf/typescript/r/appstream_image_builder.html.markdown index 5898c401b4b1..f985ae3e01b6 100644 --- a/website/docs/cdktf/typescript/r/appstream_image_builder.html.markdown +++ b/website/docs/cdktf/typescript/r/appstream_image_builder.html.markdown @@ -54,6 +54,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `accessEndpoint` - (Optional) Set of interface VPC endpoint (interface endpoint) objects. Maximum of 4. See below. * `appstreamAgentVersion` - (Optional) Version of the AppStream 2.0 agent to use for this image builder. * `description` - (Optional) Description to display. @@ -129,4 +130,4 @@ Using `terraform import`, import `aws_appstream_image_builder` using the `name`. % terraform import aws_appstream_image_builder.example imageBuilderExample ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/appstream_stack.html.markdown b/website/docs/cdktf/typescript/r/appstream_stack.html.markdown index 3ca74541f4d6..37d2180c5dd5 100644 --- a/website/docs/cdktf/typescript/r/appstream_stack.html.markdown +++ b/website/docs/cdktf/typescript/r/appstream_stack.html.markdown @@ -92,6 +92,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `accessEndpoints` - (Optional) Set of configuration blocks defining the interface VPC endpoints. Users of the stack can connect to AppStream 2.0 only through the specified endpoints. See [`accessEndpoints`](#access_endpoints) below. * `applicationSettings` - (Optional) Settings for application settings persistence. @@ -177,4 +178,4 @@ Using `terraform import`, import `aws_appstream_stack` using the id. For example % terraform import aws_appstream_stack.example stackID ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/appstream_user.html.markdown b/website/docs/cdktf/typescript/r/appstream_user.html.markdown index 78cfe5a5d518..c1daf83fffa9 100644 --- a/website/docs/cdktf/typescript/r/appstream_user.html.markdown +++ b/website/docs/cdktf/typescript/r/appstream_user.html.markdown @@ -46,6 +46,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `enabled` - (Optional) Whether the user in the user pool is enabled. * `firstName` - (Optional) First name, or given name, of the user. * `lastName` - (Optional) Last name, or surname, of the user. @@ -92,4 +93,4 @@ Using `terraform import`, import `aws_appstream_user` using the `userName` and ` % terraform import aws_appstream_user.example UserName/AuthenticationType ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/appstream_user_stack_association.html.markdown b/website/docs/cdktf/typescript/r/appstream_user_stack_association.html.markdown index 2424c099223b..fecaf4f42bce 100644 --- a/website/docs/cdktf/typescript/r/appstream_user_stack_association.html.markdown +++ b/website/docs/cdktf/typescript/r/appstream_user_stack_association.html.markdown @@ -62,6 +62,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `sendEmailNotification` - (Optional) Whether a welcome email is sent to a user after the user is created in the user pool. ## Attribute Reference @@ -102,4 +103,4 @@ Using `terraform import`, import AppStream User Stack Association using the `use % terraform import aws_appstream_user_stack_association.example userName/auhtenticationType/stackName ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/appsync_api.html.markdown b/website/docs/cdktf/typescript/r/appsync_api.html.markdown new file mode 100644 index 000000000000..d440ec192177 --- /dev/null +++ b/website/docs/cdktf/typescript/r/appsync_api.html.markdown @@ -0,0 +1,285 @@ +--- +subcategory: "AppSync" +layout: "aws" +page_title: "AWS: aws_appsync_api" +description: |- + Manages an AWS AppSync Event API. +--- + + + +# Resource: aws_appsync_api + +Manages an [AWS AppSync Event API](https://docs.aws.amazon.com/appsync/latest/eventapi/event-api-concepts.html#API). Event APIs enable real-time subscriptions and event-driven communication in AppSync applications. + +## Example Usage + +### Basic Usage + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { AppsyncApi } from "./.gen/providers/aws/appsync-api"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + new AppsyncApi(this, "example", { + eventConfig: [ + { + authProvider: [ + { + authType: "API_KEY", + }, + ], + connectionAuthMode: [ + { + authType: "API_KEY", + }, + ], + defaultPublishAuthMode: [ + { + authType: "API_KEY", + }, + ], + defaultSubscribeAuthMode: [ + { + authType: "API_KEY", + }, + ], + }, + ], + name: "example-event-api", + }); + } +} + +``` + +### With Cognito Authentication + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { Token, TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { AppsyncApi } from "./.gen/providers/aws/appsync-api"; +import { CognitoUserPool } from "./.gen/providers/aws/cognito-user-pool"; +import { DataAwsRegion } from "./.gen/providers/aws/data-aws-region"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + const example = new CognitoUserPool(this, "example", { + name: "example-user-pool", + }); + const current = new DataAwsRegion(this, "current", {}); + const awsAppsyncApiExample = new AppsyncApi(this, "example_2", { + eventConfig: [ + { + authProvider: [ + { + authType: "AMAZON_COGNITO_USER_POOLS", + cognitoConfig: [ + { + awsRegion: Token.asString(current.name), + userPoolId: example.id, + }, + ], + }, + ], + connectionAuthMode: [ + { + authType: "AMAZON_COGNITO_USER_POOLS", + }, + ], + defaultPublishAuthMode: [ + { + authType: "AMAZON_COGNITO_USER_POOLS", + }, + ], + defaultSubscribeAuthMode: [ + { + authType: "AMAZON_COGNITO_USER_POOLS", + }, + ], + }, + ], + name: "example-event-api", + }); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + awsAppsyncApiExample.overrideLogicalId("example"); + } +} + +``` + +### With Lambda Authorizer + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { Token, TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { AppsyncApi } from "./.gen/providers/aws/appsync-api"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + new AppsyncApi(this, "example", { + eventConfig: [ + { + authProvider: [ + { + authType: "AWS_LAMBDA", + lambdaAuthorizerConfig: [ + { + authorizerResultTtlInSeconds: 300, + authorizerUri: Token.asString( + awsLambdaFunctionExample.invokeArn + ), + }, + ], + }, + ], + connectionAuthMode: [ + { + authType: "AWS_LAMBDA", + }, + ], + defaultPublishAuthMode: [ + { + authType: "AWS_LAMBDA", + }, + ], + defaultSubscribeAuthMode: [ + { + authType: "AWS_LAMBDA", + }, + ], + }, + ], + name: "example-event-api", + }); + } +} + +``` + +## Argument Reference + +The following arguments are required: + +* `eventConfig` - (Required) Configuration for the Event API. See [Event Config](#event-config) below. +* `name` - (Required) Name of the Event API. + +The following arguments are optional: + +* `ownerContact` - (Optional) Contact information for the owner of the Event API. +* `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). +* `tags` - (Optional) Map of tags to assign to the resource. If configured with a provider [`defaultTags` 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. + +### Event Config + +The `eventConfig` block supports the following: + +* `authProvider` - (Required) List of authentication providers. See [Auth Providers](#auth-providers) below. +* `connectionAuthMode` - (Required) List of authentication modes for connections. See [Auth Modes](#auth-modes) below. +* `defaultPublishAuthMode` - (Required) List of default authentication modes for publishing. See [Auth Modes](#auth-modes) below. +* `defaultSubscribeAuthMode` - (Required) List of default authentication modes for subscribing. See [Auth Modes](#auth-modes) below. +* `logConfig` - (Optional) Logging configuration. See [Log Config](#log-config) below. + +### Auth Providers + +The `authProvider` block supports the following: + +* `authType` - (Required) Type of authentication provider. Valid values: `AMAZON_COGNITO_USER_POOLS`, `AWS_LAMBDA`, `OPENID_CONNECT`, `API_KEY`. +* `cognitoConfig` - (Optional) Configuration for Cognito user pool authentication. Required when `authType` is `AMAZON_COGNITO_USER_POOLS`. See [Cognito Config](#cognito-config) below. +* `lambdaAuthorizerConfig` - (Optional) Configuration for Lambda authorization. Required when `authType` is `AWS_LAMBDA`. See [Lambda Authorizer Config](#lambda-authorizer-config) below. +* `openidConnectConfig` - (Optional) Configuration for OpenID Connect. Required when `authType` is `OPENID_CONNECT`. See [OpenID Connect Config](#openid-connect-config) below. + +### Cognito Config + +The `cognitoConfig` block supports the following: + +* `appIdClientRegex` - (Optional) Regular expression for matching the client ID. +* `awsRegion` - (Required) AWS region where the user pool is located. +* `userPoolId` - (Required) ID of the Cognito user pool. + +### Lambda Authorizer Config + +The `lambdaAuthorizerConfig` block supports the following: + +* `authorizerResultTtlInSeconds` - (Optional) TTL in seconds for the authorization result cache. +* `authorizerUri` - (Required) URI of the Lambda function for authorization. +* `identityValidationExpression` - (Optional) Regular expression for identity validation. + +### OpenID Connect Config + +The `openidConnectConfig` block supports the following: + +* `authTtl` - (Optional) TTL in seconds for the authentication token. +* `clientId` - (Optional) Client ID for the OpenID Connect provider. +* `iatTtl` - (Optional) TTL in seconds for the issued at time. +* `issuer` - (Required) Issuer URL for the OpenID Connect provider. + +### Auth Modes + +The `connectionAuthMode`, `defaultPublishAuthMode`, and `defaultSubscribeAuthMode` blocks support the following: + +* `authType` - (Required) Type of authentication. Valid values: `API_KEY`, `AWS_IAM`, `AMAZON_COGNITO_USER_POOLS`, `OPENID_CONNECT`, `AWS_LAMBDA`. + +### Log Config + +The `logConfig` block supports the following: + +* `cloudwatchLogsRoleArn` - (Required) ARN of the IAM role for CloudWatch logs. +* `logLevel` - (Required) Log level. Valid values: `NONE`, `ERROR`, `ALL`, `INFO`, `DEBUG`. + +## Attribute Reference + +This resource exports the following attributes in addition to the arguments above: + +* `apiId` - ID of the Event API. +* `apiArn` - ARN of the Event API. +* `dns` - DNS configuration for the Event API. +* `tagsAll` - Map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). +* `wafWebAclArn` - ARN of the associated WAF web ACL. + +## Import + +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import AppSync Event API using the `apiId`. For example: + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { AppsyncApi } from "./.gen/providers/aws/appsync-api"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + AppsyncApi.generateConfigForImport(this, "example", "example-api-id"); + } +} + +``` + +Using `terraform import`, import AppSync Event API using the `apiId`. For example: + +```console +% terraform import aws_appsync_api.example example-api-id +``` + + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/appsync_api_cache.html.markdown b/website/docs/cdktf/typescript/r/appsync_api_cache.html.markdown index a42345c8c4ff..eb0f1661ea60 100644 --- a/website/docs/cdktf/typescript/r/appsync_api_cache.html.markdown +++ b/website/docs/cdktf/typescript/r/appsync_api_cache.html.markdown @@ -48,6 +48,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `apiId` - (Required) GraphQL API ID. * `apiCachingBehavior` - (Required) Caching behavior. Valid values are `FULL_REQUEST_CACHING` and `PER_RESOLVER_CACHING`. * `type` - (Required) Cache instance type. Valid values are `SMALL`, `MEDIUM`, `LARGE`, `XLARGE`, `LARGE_2X`, `LARGE_4X`, `LARGE_8X`, `LARGE_12X`, `T2_SMALL`, `T2_MEDIUM`, `R4_LARGE`, `R4_XLARGE`, `R4_2XLARGE`, `R4_4XLARGE`, `R4_8XLARGE`. @@ -89,4 +90,4 @@ Using `terraform import`, import `aws_appsync_api_cache` using the AppSync API I % terraform import aws_appsync_api_cache.example xxxxx ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/appsync_api_key.html.markdown b/website/docs/cdktf/typescript/r/appsync_api_key.html.markdown index d5e1747364ae..34f2ce74b146 100644 --- a/website/docs/cdktf/typescript/r/appsync_api_key.html.markdown +++ b/website/docs/cdktf/typescript/r/appsync_api_key.html.markdown @@ -46,6 +46,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `apiId` - (Required) ID of the associated AppSync API * `description` - (Optional) API key description. Defaults to "Managed by Terraform". * `expires` - (Optional) RFC3339 string representation of the expiry date. Rounded down to nearest hour. By default, it is 7 days from the date of creation. @@ -85,4 +86,4 @@ Using `terraform import`, import `aws_appsync_api_key` using the AppSync API ID % terraform import aws_appsync_api_key.example xxxxx:yyyyy ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/appsync_channel_namespace.html.markdown b/website/docs/cdktf/typescript/r/appsync_channel_namespace.html.markdown new file mode 100644 index 000000000000..d316b02aaa99 --- /dev/null +++ b/website/docs/cdktf/typescript/r/appsync_channel_namespace.html.markdown @@ -0,0 +1,128 @@ +--- +subcategory: "AppSync" +layout: "aws" +page_title: "AWS: aws_appsync_channel_namespace" +description: |- + Manages an AWS AppSync Channel Namespace. +--- + + + +# Resource: aws_appsync_channel_namespace + +Manages an [AWS AppSync Channel Namespace](https://docs.aws.amazon.com/appsync/latest/eventapi/event-api-concepts.html#namespace). + +## Example Usage + +### Basic Usage + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { Token, TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { AppsyncChannelNamespace } from "./.gen/providers/aws/appsync-channel-namespace"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + new AppsyncChannelNamespace(this, "example", { + apiId: Token.asString(awsAppsyncApiExample.apiId), + name: "example-channel-namespace", + }); + } +} + +``` + +## Argument Reference + +The following arguments are required: + +* `apiId` - (Required) Event API ID. +* `name` - (Required) Name of the channel namespace. + +The following arguments are optional: + +* `codeHandlers` - (Optional) Event handler functions that run custom business logic to process published events and subscribe requests. +* `handlerConfigs` - (Optional) Configuration for the `onPublish` and `onSubscribe` handlers. See [Handler Configs](#handler-configs) below. +* `publishAuthMode` - (Optional) Authorization modes to use for publishing messages on the channel namespace. This configuration overrides the default API authorization configuration. See [Auth Modes](#auth-modes) below. +* `subscribeAuthMode` - (Optional) Authorization modes to use for subscribing to messages on the channel namespace. This configuration overrides the default API authorization configuration. See [Auth Modes](#auth-modes) below. +* `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). +* `tags` - (Optional) Map of tags to assign to the resource. If configured with a provider [`defaultTags` 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. + +### Auth Modes + +The `publishAuthMode`, and `subscribeAuthMode` blocks support the following: + +* `authType` - (Required) Type of authentication. Valid values: `API_KEY`, `AWS_IAM`, `AMAZON_COGNITO_USER_POOLS`, `OPENID_CONNECT`, `AWS_LAMBDA`. + +### Handler Configs + +The `handlerConfigs` block support the following: + +* `onPublish` - (Optional) Handler configuration. See [Handler Config](#handler-config) below. +* `onSubscribe` - (Optional) Handler configuration. See [Handler Config](#handler-config) below. + +### Handler Config + +The `onPublish` and `onSubscribe` blocks support the following: + +* `behavior` - (Required) Behavior for the handler. Valid values: `CODE`, `DIRECT`. +* `integration` - (Required) Integration data source configuration for the handler. See [Integration](#integration) below. + +### Integration + +The `integration` block support the following: + +* `dataSourceName` - (Required) Unique name of the data source that has been configured on the API. +* `lambdaConfig` - (Optional) Configuration for a Lambda data source. See [Lambda Config](#lambda-config) below. + +### Lambad Config + +The `lambdaConfig` block support the following: + +* `invokeType` - (Optional) Invocation type for a Lambda data source. Valid values: `REQUEST_RESPONSE`, `EVENT`. + +## Attribute Reference + +This resource exports the following attributes in addition to the arguments above: + +* `channelNamespaceArn` - ARN of the channel namespace. +* `tagsAll` - Map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). + +## Import + +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import AppSync Channel Namespace using the `apiId` and `name` separated by a comma (`,`). For example: + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { AppsyncChannelNamespace } from "./.gen/providers/aws/appsync-channel-namespace"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + AppsyncChannelNamespace.generateConfigForImport( + this, + "example", + "example-api-id,example-channel-namespace" + ); + } +} + +``` + +Using `terraform import`, import AppSync Channel Namespace using the `apiId` and `name` separated by a comma (`,`). For example: + +```console +% terraform import aws_appsync_channel_namespace.example example-api-id,example-channel-namespace +``` + + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/appsync_datasource.html.markdown b/website/docs/cdktf/typescript/r/appsync_datasource.html.markdown index 9a85754d1a68..92b396c67144 100644 --- a/website/docs/cdktf/typescript/r/appsync_datasource.html.markdown +++ b/website/docs/cdktf/typescript/r/appsync_datasource.html.markdown @@ -115,6 +115,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `apiId` - (Required) API ID for the GraphQL API for the data source. * `name` - (Required) User-supplied name for the data source. * `type` - (Required) Type of the Data Source. Valid values: `AWS_LAMBDA`, `AMAZON_DYNAMODB`, `AMAZON_ELASTICSEARCH`, `HTTP`, `NONE`, `RELATIONAL_DATABASE`, `AMAZON_EVENTBRIDGE`, `AMAZON_OPENSEARCH_SERVICE`. @@ -248,4 +249,4 @@ Using `terraform import`, import `aws_appsync_datasource` using the `apiId`, a h % terraform import aws_appsync_datasource.example abcdef123456-example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/appsync_domain_name.html.markdown b/website/docs/cdktf/typescript/r/appsync_domain_name.html.markdown index 8a7559da667e..56f6e309bd13 100644 --- a/website/docs/cdktf/typescript/r/appsync_domain_name.html.markdown +++ b/website/docs/cdktf/typescript/r/appsync_domain_name.html.markdown @@ -39,6 +39,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `certificateArn` - (Required) ARN of the certificate. This can be an Certificate Manager (ACM) certificate or an Identity and Access Management (IAM) server certificate. The certifiacte must reside in us-east-1. * `description` - (Optional) A description of the Domain Name. * `domainName` - (Required) Domain name. @@ -79,4 +80,4 @@ Using `terraform import`, import `aws_appsync_domain_name` using the AppSync dom % terraform import aws_appsync_domain_name.example example.com ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/appsync_domain_name_api_association.html.markdown b/website/docs/cdktf/typescript/r/appsync_domain_name_api_association.html.markdown index 147722d542f6..618d2b1993ce 100644 --- a/website/docs/cdktf/typescript/r/appsync_domain_name_api_association.html.markdown +++ b/website/docs/cdktf/typescript/r/appsync_domain_name_api_association.html.markdown @@ -39,6 +39,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `apiId` - (Required) API ID. * `domainName` - (Required) Appsync domain name. @@ -80,4 +81,4 @@ Using `terraform import`, import `aws_appsync_domain_name_api_association` using % terraform import aws_appsync_domain_name_api_association.example example.com ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/appsync_function.html.markdown b/website/docs/cdktf/typescript/r/appsync_function.html.markdown index 5365ca42c2bb..21ad64988bf2 100644 --- a/website/docs/cdktf/typescript/r/appsync_function.html.markdown +++ b/website/docs/cdktf/typescript/r/appsync_function.html.markdown @@ -97,6 +97,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `apiId` - (Required) ID of the associated AppSync API. * `code` - (Optional) The function code that contains the request and response functions. When code is used, the runtime is required. The runtime value must be APPSYNC_JS. * `dataSource` - (Required) Function data source name. @@ -166,4 +167,4 @@ Using `terraform import`, import `aws_appsync_function` using the AppSync API ID % terraform import aws_appsync_function.example xxxxx-yyyyy ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/appsync_graphql_api.html.markdown b/website/docs/cdktf/typescript/r/appsync_graphql_api.html.markdown index 415571813fb5..1c9f330ef150 100644 --- a/website/docs/cdktf/typescript/r/appsync_graphql_api.html.markdown +++ b/website/docs/cdktf/typescript/r/appsync_graphql_api.html.markdown @@ -78,7 +78,7 @@ class MyConvertedCode extends TerraformStack { authenticationType: "AMAZON_COGNITO_USER_POOLS", name: "example", userPoolConfig: { - awsRegion: Token.asString(current.name), + awsRegion: Token.asString(current.region), defaultAction: "DENY", userPoolId: Token.asString(awsCognitoUserPoolExample.id), }, @@ -368,13 +368,15 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `authenticationType` - (Required) Authentication type. Valid values: `API_KEY`, `AWS_IAM`, `AMAZON_COGNITO_USER_POOLS`, `OPENID_CONNECT`, `AWS_LAMBDA` * `name` - (Required) User-supplied name for the GraphQL API. The following arguments are optional: +* `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). * `additionalAuthenticationProvider` - (Optional) One or more additional authentication providers for the GraphQL API. See [`additionalAuthenticationProvider` Block](#additional_authentication_provider-block) for details. * `apiType` - (Optional) API type. Valid values are `GRAPHQL` or `MERGED`. A `MERGED` type requires `mergedApiExecutionRoleArn` to be set. * `enhancedMetricsConfig` - (Optional) Enables and controls the enhanced metrics feature. See [`enhancedMetricsConfig` Block](#enhanced_metrics_config-block) for details. @@ -480,4 +482,4 @@ Using `terraform import`, import AppSync GraphQL API using the GraphQL API ID. F % terraform import aws_appsync_graphql_api.example 0123456789 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/appsync_resolver.html.markdown b/website/docs/cdktf/typescript/r/appsync_resolver.html.markdown index 6cb4758ed1a6..315cc508c382 100644 --- a/website/docs/cdktf/typescript/r/appsync_resolver.html.markdown +++ b/website/docs/cdktf/typescript/r/appsync_resolver.html.markdown @@ -113,6 +113,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `apiId` - (Required) API ID for the GraphQL API. * `code` - (Optional) The function code that contains the request and response functions. When code is used, the runtime is required. The runtime value must be APPSYNC_JS. * `type` - (Required) Type name from the schema defined in the GraphQL API. @@ -189,4 +190,4 @@ Using `terraform import`, import `aws_appsync_resolver` using the `apiId`, a hyp % terraform import aws_appsync_resolver.example abcdef123456-exampleType-exampleField ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/appsync_source_api_association.html.markdown b/website/docs/cdktf/typescript/r/appsync_source_api_association.html.markdown index 4163fb8d757b..7f93065888c8 100644 --- a/website/docs/cdktf/typescript/r/appsync_source_api_association.html.markdown +++ b/website/docs/cdktf/typescript/r/appsync_source_api_association.html.markdown @@ -3,13 +3,13 @@ subcategory: "AppSync" layout: "aws" page_title: "AWS: aws_appsync_source_api_association" description: |- - Terraform resource for managing an AWS AppSync Source Api Association. + Terraform resource for managing an AWS AppSync Source API Association. --- # Resource: aws_appsync_source_api_association -Terraform resource for managing an AWS AppSync Source Api Association. +Terraform resource for managing an AWS AppSync Source API Association. ## Example Usage @@ -41,6 +41,7 @@ class MyConvertedCode extends TerraformStack { The following arguments are optional: +* `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). * `description` - (Optional) Description of the source API being merged. * `mergedApiArn` - (Optional) ARN of the merged API. One of `mergedApiArn` or `mergedApiId` must be specified. * `mergedApiId` - (Optional) ID of the merged API. One of `mergedApiArn` or `mergedApiId` must be specified. @@ -57,9 +58,9 @@ The `sourceApiAssociationConfig` configuration block supports the following argu This resource exports the following attributes in addition to the arguments above: -* `arn` - ARN of the Source Api Association. -* `associationId` - ID of the Source Api Association. -* `id` - Combined ID of the Source Api Association and Merge Api. +* `arn` - ARN of the Source API Association. +* `associationId` - ID of the Source API Association. +* `id` - Combined ID of the Source API Association and Merge API. ## Timeouts @@ -71,7 +72,7 @@ This resource exports the following attributes in addition to the arguments abov ## Import -In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import AppSync Source Api Association using the `example_id_arg`. For example: +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import AppSync Source API Association using the `associationId` and `mergedApiId` separated by `,`. For example: ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -95,10 +96,10 @@ class MyConvertedCode extends TerraformStack { ``` -Using `terraform import`, import AppSync Source Api Association using the `gzos6bteufdunffzzifiowisoe,243685a0-9347-4a1a-89c1-9b57dea01e31`. For example: +Using `terraform import`, import AppSync Source API Association using the `associationId` and `mergedApiId` separated by `,`. For example: ```console % terraform import aws_appsync_source_api_association.example gzos6bteufdunffzzifiowisoe,243685a0-9347-4a1a-89c1-9b57dea01e31 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/appsync_type.html.markdown b/website/docs/cdktf/typescript/r/appsync_type.html.markdown index 2e300a20ea47..b5c66064e5d6 100644 --- a/website/docs/cdktf/typescript/r/appsync_type.html.markdown +++ b/website/docs/cdktf/typescript/r/appsync_type.html.markdown @@ -48,6 +48,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `apiId` - (Required) GraphQL API ID. * `format` - (Required) The type format: `SDL` or `JSON`. * `definition` - (Required) The type definition. @@ -89,4 +90,4 @@ Using `terraform import`, import Appsync Types using the `id`. For example: % terraform import aws_appsync_type.example api-id:format:name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/athena_capacity_reservation.html.markdown b/website/docs/cdktf/typescript/r/athena_capacity_reservation.html.markdown index b68548cb2d0a..5684905eb146 100644 --- a/website/docs/cdktf/typescript/r/athena_capacity_reservation.html.markdown +++ b/website/docs/cdktf/typescript/r/athena_capacity_reservation.html.markdown @@ -47,6 +47,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `tags` - (Optional) Map of tags assigned to the resource. If configured with a provider [`defaultTags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. ## Attribute Reference @@ -98,4 +99,4 @@ Using `terraform import`, import Athena Capacity Reservation using the `name`. F % terraform import aws_athena_capacity_reservation.example example-reservation ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/athena_data_catalog.html.markdown b/website/docs/cdktf/typescript/r/athena_data_catalog.html.markdown index 9551ebe89e90..138b1559234e 100644 --- a/website/docs/cdktf/typescript/r/athena_data_catalog.html.markdown +++ b/website/docs/cdktf/typescript/r/athena_data_catalog.html.markdown @@ -136,6 +136,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +- `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). - `name` - (Required) Name of the data catalog. The catalog name must be unique for the AWS account and can use a maximum of 128 alphanumeric, underscore, at sign, or hyphen characters. - `type` - (Required) Type of data catalog: `LAMBDA` for a federated catalog, `GLUE` for AWS Glue Catalog, or `HIVE` for an external hive metastore. - `parameters` - (Required) Key value pairs that specifies the Lambda function or functions to use for the data catalog. The mapping used depends on the catalog type. @@ -182,4 +183,4 @@ Using `terraform import`, import data catalogs using their `name`. For example: % terraform import aws_athena_data_catalog.example example-data-catalog ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/athena_database.html.markdown b/website/docs/cdktf/typescript/r/athena_database.html.markdown index e2f40bd65962..f6fca9701af7 100644 --- a/website/docs/cdktf/typescript/r/athena_database.html.markdown +++ b/website/docs/cdktf/typescript/r/athena_database.html.markdown @@ -45,6 +45,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `bucket` - (Required) Name of S3 bucket to save the results of the query execution. * `name` - (Required) Name of the database to create. * `aclConfiguration` - (Optional) That an Amazon S3 canned ACL should be set to control ownership of stored query results. See [ACL Configuration](#acl-configuration) below. @@ -53,6 +54,7 @@ This resource supports the following arguments: * `expectedBucketOwner` - (Optional) AWS account ID that you expect to be the owner of the Amazon S3 bucket. * `forceDestroy` - (Optional, Default: false) Boolean that indicates all tables should be deleted from the database so that the database can be destroyed without error. The tables are *not* recoverable. * `properties` - (Optional) Key-value map of custom metadata properties for the database definition. +* `workgroup` - (Optional) Name of the workgroup. ### ACL Configuration @@ -125,4 +127,4 @@ class MyConvertedCode extends TerraformStack { ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/athena_named_query.html.markdown b/website/docs/cdktf/typescript/r/athena_named_query.html.markdown index 166083969fcd..db39624b9322 100644 --- a/website/docs/cdktf/typescript/r/athena_named_query.html.markdown +++ b/website/docs/cdktf/typescript/r/athena_named_query.html.markdown @@ -71,6 +71,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) Plain language name for the query. Maximum length of 128. * `workgroup` - (Optional) Workgroup to which the query belongs. Defaults to `primary` * `database` - (Required) Database to which the query belongs. @@ -111,4 +112,4 @@ Using `terraform import`, import Athena Named Query using the query ID. For exam % terraform import aws_athena_named_query.example 0123456789 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/athena_prepared_statement.html.markdown b/website/docs/cdktf/typescript/r/athena_prepared_statement.html.markdown index a036b441d025..60da214743c9 100644 --- a/website/docs/cdktf/typescript/r/athena_prepared_statement.html.markdown +++ b/website/docs/cdktf/typescript/r/athena_prepared_statement.html.markdown @@ -65,6 +65,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) The name of the prepared statement. Maximum length of 256. * `workgroup` - (Required) The name of the workgroup to which the prepared statement belongs. * `queryStatement` - (Required) The query string for the prepared statement. @@ -116,4 +117,4 @@ Using `terraform import`, import Athena Prepared Statement using the `WORKGROUP- % terraform import aws_athena_prepared_statement.example 12345abcde/example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/athena_workgroup.html.markdown b/website/docs/cdktf/typescript/r/athena_workgroup.html.markdown index 674ed5ebfd7a..ff18399bab0e 100644 --- a/website/docs/cdktf/typescript/r/athena_workgroup.html.markdown +++ b/website/docs/cdktf/typescript/r/athena_workgroup.html.markdown @@ -49,6 +49,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) Name of the workgroup. * `configuration` - (Optional) Configuration block with various settings for the workgroup. Documented below. * `description` - (Optional) Description of the workgroup. @@ -61,19 +62,25 @@ This resource supports the following arguments: * `bytesScannedCutoffPerQuery` - (Optional) Integer for the upper data usage limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan. Must be at least `10485760`. * `enforceWorkgroupConfiguration` - (Optional) Boolean whether the settings for the workgroup override client-side settings. For more information, see [Workgroup Settings Override Client-Side Settings](https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html). Defaults to `true`. * `engineVersion` - (Optional) Configuration block for the Athena Engine Versioning. For more information, see [Athena Engine Versioning](https://docs.aws.amazon.com/athena/latest/ug/engine-versions.html). See [Engine Version](#engine-version) below. -* `executionRole` - (Optional) Role used in a notebook session for accessing the user's resources. +* `executionRole` - (Optional) Role used to access user resources in notebook sessions and IAM Identity Center enabled workgroups. The property is required for IAM Identity Center enabled workgroups. +* `identityCenterConfiguration` - (Optional) Configuration block to set up an IAM Identity Center enabled workgroup. See [Identity Center Configuration](#identity-center-configuration) below. * `publishCloudwatchMetricsEnabled` - (Optional) Boolean whether Amazon CloudWatch metrics are enabled for the workgroup. Defaults to `true`. -* `resultConfiguration` - (Optional) Configuration block with result settings. See [Result Configuration](#result-configuration) below. * `requesterPaysEnabled` - (Optional) If set to true , allows members assigned to a workgroup to reference Amazon S3 Requester Pays buckets in queries. If set to false , workgroup members cannot query data from Requester Pays buckets, and queries that retrieve data from Requester Pays buckets cause an error. The default is false . For more information about Requester Pays buckets, see [Requester Pays Buckets](https://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html) in the Amazon Simple Storage Service Developer Guide. +* `resultConfiguration` - (Optional) Configuration block with result settings. See [Result Configuration](#result-configuration) below. #### Engine Version * `selectedEngineVersion` - (Optional) Requested engine version. Defaults to `AUTO`. +#### Identity Center Configuration + +* `enableIdentityCenter` - (Optional) Specifies whether the workgroup is IAM Identity Center supported. +* `identityCenterInstanceArn` - (Optional) The IAM Identity Center instance ARN that the workgroup associates to. + #### Result Configuration -* `encryptionConfiguration` - (Optional) Configuration block with encryption settings. See [Encryption Configuration](#encryption-configuration) below. * `aclConfiguration` - (Optional) That an Amazon S3 canned ACL should be set to control ownership of stored query results. See [ACL Configuration](#acl-configuration) below. +* `encryptionConfiguration` - (Optional) Configuration block with encryption settings. See [Encryption Configuration](#encryption-configuration) below. * `expectedBucketOwner` - (Optional) AWS account ID that you expect to be the owner of the Amazon S3 bucket. * `outputLocation` - (Optional) Location in Amazon S3 where your query results are stored, such as `s3://path/to/query/bucket/`. For more information, see [Queries and Query Result Files](https://docs.aws.amazon.com/athena/latest/ug/querying.html). @@ -125,4 +132,4 @@ Using `terraform import`, import Athena Workgroups using their name. For example % terraform import aws_athena_workgroup.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/auditmanager_account_registration.html.markdown b/website/docs/cdktf/typescript/r/auditmanager_account_registration.html.markdown index be17773e071f..d8be0ad0608a 100644 --- a/website/docs/cdktf/typescript/r/auditmanager_account_registration.html.markdown +++ b/website/docs/cdktf/typescript/r/auditmanager_account_registration.html.markdown @@ -60,6 +60,7 @@ class MyConvertedCode extends TerraformStack { The following arguments are optional: +* `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). * `delegatedAdminAccount` - (Optional) Identifier for the delegated administrator account. * `deregisterOnDestroy` - (Optional) Flag to deregister AuditManager in the account upon destruction. Defaults to `false` (ie. AuditManager will remain active in the account, even if this resource is removed). * `kmsKey` - (Optional) KMS key identifier. @@ -103,4 +104,4 @@ Using `terraform import`, import Audit Manager Account Registration resources us % terraform import aws_auditmanager_account_registration.example us-east-1 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/auditmanager_assessment.html.markdown b/website/docs/cdktf/typescript/r/auditmanager_assessment.html.markdown index 9db807be01f0..e8182ea940dc 100644 --- a/website/docs/cdktf/typescript/r/auditmanager_assessment.html.markdown +++ b/website/docs/cdktf/typescript/r/auditmanager_assessment.html.markdown @@ -75,6 +75,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `description` - (Optional) Description of the assessment. * `tags` - (Optional) A map of tags to assign to the assessment. If configured with a provider [`defaultTags` 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. @@ -142,4 +143,4 @@ Using `terraform import`, import Audit Manager Assessments using the assessment % terraform import aws_auditmanager_assessment.example abc123-de45 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/auditmanager_assessment_delegation.html.markdown b/website/docs/cdktf/typescript/r/auditmanager_assessment_delegation.html.markdown index 85091d601247..b9ccf57badf4 100644 --- a/website/docs/cdktf/typescript/r/auditmanager_assessment_delegation.html.markdown +++ b/website/docs/cdktf/typescript/r/auditmanager_assessment_delegation.html.markdown @@ -50,6 +50,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `comment` - (Optional) Comment describing the delegation request. ## Attribute Reference @@ -92,4 +93,4 @@ Using `terraform import`, import Audit Manager Assessment Delegation using the ` % terraform import aws_auditmanager_assessment_delegation.example abcdef-123456,arn:aws:iam::123456789012:role/example,example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/auditmanager_assessment_report.html.markdown b/website/docs/cdktf/typescript/r/auditmanager_assessment_report.html.markdown index aaf8e05ab2cd..93b43bab681a 100644 --- a/website/docs/cdktf/typescript/r/auditmanager_assessment_report.html.markdown +++ b/website/docs/cdktf/typescript/r/auditmanager_assessment_report.html.markdown @@ -46,6 +46,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `description` - (Optional) Description of the assessment report. ## Attribute Reference @@ -88,4 +89,4 @@ Using `terraform import`, import Audit Manager Assessment Reports using the asse % terraform import aws_auditmanager_assessment_report.example abc123-de45 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/auditmanager_control.html.markdown b/website/docs/cdktf/typescript/r/auditmanager_control.html.markdown index 20e69ca95898..fe0fdd21f18e 100644 --- a/website/docs/cdktf/typescript/r/auditmanager_control.html.markdown +++ b/website/docs/cdktf/typescript/r/auditmanager_control.html.markdown @@ -52,6 +52,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `actionPlanInstructions` - (Optional) Recommended actions to carry out if the control isn't fulfilled. * `actionPlanTitle` - (Optional) Title of the action plan for remediating the control. * `description` - (Optional) Description of the control. @@ -68,6 +69,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `sourceDescription` - (Optional) Description of the source. * `sourceFrequency` - (Optional) Frequency of evidence collection. Valid values are `DAILY`, `WEEKLY`, or `MONTHLY`. * `sourceKeyword` - (Optional) The keyword to search for in CloudTrail logs, Config rules, Security Hub checks, and Amazon Web Services API names. See [`sourceKeyword`](#source_keyword) below. @@ -77,8 +79,8 @@ The following arguments are optional: The following arguments are required: -* `keywordInputType` - (Required) Input method for the keyword. Valid values are `INPUT_TEXT`, `SELECT_FROM_LIST`, or `UPLOAD_FILE`. -* `keywordValue` - (Required) The value of the keyword that's used when mapping a control data source. For example, this can be a CloudTrail event name, a rule name for Config, a Security Hub control, or the name of an Amazon Web Services API call. See the [Audit Manager supported control data sources documentation](https://docs.aws.amazon.com/audit-manager/latest/userguide/control-data-sources.html) for more information. +* `keyword_input_type` - (Required) Input method for the keyword. Valid values are `INPUT_TEXT`, `SELECT_FROM_LIST`, or `UPLOAD_FILE`. +* `keyword_value` - (Required) The value of the keyword that's used when mapping a control data source. For example, this can be a CloudTrail event name, a rule name for Config, a Security Hub control, or the name of an Amazon Web Services API call. See the [Audit Manager supported control data sources documentation](https://docs.aws.amazon.com/audit-manager/latest/userguide/control-data-sources.html) for more information. ## Attribute Reference @@ -117,4 +119,4 @@ Using `terraform import`, import an Audit Manager Control using the `id`. For ex % terraform import aws_auditmanager_control.example abc123-de45 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/auditmanager_framework.html.markdown b/website/docs/cdktf/typescript/r/auditmanager_framework.html.markdown index 0b9a98702208..264c2a94c93d 100644 --- a/website/docs/cdktf/typescript/r/auditmanager_framework.html.markdown +++ b/website/docs/cdktf/typescript/r/auditmanager_framework.html.markdown @@ -58,6 +58,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `complianceType` - (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 [`defaultTags` 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. @@ -116,4 +117,4 @@ Using `terraform import`, import Audit Manager Framework using the framework `id % terraform import aws_auditmanager_framework.example abc123-de45 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/auditmanager_framework_share.html.markdown b/website/docs/cdktf/typescript/r/auditmanager_framework_share.html.markdown index 2584a950e5d0..3910cc1313fb 100644 --- a/website/docs/cdktf/typescript/r/auditmanager_framework_share.html.markdown +++ b/website/docs/cdktf/typescript/r/auditmanager_framework_share.html.markdown @@ -48,6 +48,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `comment` - (Optional) Comment from the sender about the share request. ## Attribute Reference @@ -89,4 +90,4 @@ Using `terraform import`, import Audit Manager Framework Share using the `id`. F % terraform import aws_auditmanager_framework_share.example abcdef-123456 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/auditmanager_organization_admin_account_registration.html.markdown b/website/docs/cdktf/typescript/r/auditmanager_organization_admin_account_registration.html.markdown index c1da5cbc0183..58ec75740f22 100644 --- a/website/docs/cdktf/typescript/r/auditmanager_organization_admin_account_registration.html.markdown +++ b/website/docs/cdktf/typescript/r/auditmanager_organization_admin_account_registration.html.markdown @@ -38,8 +38,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `adminAccountId` - (Required) Identifier for the organization administrator account. ## Attribute Reference @@ -81,4 +82,4 @@ Using `terraform import`, import Audit Manager Organization Admin Account Regist % terraform import aws_auditmanager_organization_admin_account_registration.example 123456789012 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/autoscaling_attachment.html.markdown b/website/docs/cdktf/typescript/r/autoscaling_attachment.html.markdown index 637fea1c6000..bd2b4e8ad329 100644 --- a/website/docs/cdktf/typescript/r/autoscaling_attachment.html.markdown +++ b/website/docs/cdktf/typescript/r/autoscaling_attachment.html.markdown @@ -62,6 +62,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `autoscalingGroupName` - (Required) Name of ASG to associate with the ELB. * `elb` - (Optional) Name of the ELB. * `lbTargetGroupArn` - (Optional) ARN of a load balancer target group. @@ -70,4 +71,4 @@ This resource supports the following arguments: This resource exports no additional attributes. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/autoscaling_group.html.markdown b/website/docs/cdktf/typescript/r/autoscaling_group.html.markdown index 2b3b86edbde4..bc507f7ffe03 100644 --- a/website/docs/cdktf/typescript/r/autoscaling_group.html.markdown +++ b/website/docs/cdktf/typescript/r/autoscaling_group.html.markdown @@ -550,6 +550,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +- `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). - `name` - (Optional) Name of the Auto Scaling Group. By default generated by Terraform. Conflicts with `namePrefix`. - `namePrefix` - (Optional) Creates a unique name beginning with the specified prefix. Conflicts with `name`. @@ -639,8 +640,8 @@ This resource supports the following arguments: This configuration block supports the following: -- `capacity_reservation_ids` - (Optional) List of On-Demand Capacity Reservation Ids. Conflicts with `capacity_reservation_resource_group_arns`. -- `capacity_reservation_resource_group_arns` - (Optional) List of On-Demand Capacity Reservation Resource Group Arns. Conflicts with `capacity_reservation_ids`. +- `capacityReservationIds` - (Optional) List of On-Demand Capacity Reservation Ids. Conflicts with `capacityReservationResourceGroupArns`. +- `capacityReservationResourceGroupArns` - (Optional) List of On-Demand Capacity Reservation Resource Group Arns. Conflicts with `capacityReservationIds`. ### launch_template @@ -1010,4 +1011,4 @@ Using `terraform import`, import Auto Scaling Groups using the `name`. For examp % terraform import aws_autoscaling_group.web web-asg ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/autoscaling_group_tag.html.markdown b/website/docs/cdktf/typescript/r/autoscaling_group_tag.html.markdown index 05edda8902ac..2f845ed8e229 100644 --- a/website/docs/cdktf/typescript/r/autoscaling_group_tag.html.markdown +++ b/website/docs/cdktf/typescript/r/autoscaling_group_tag.html.markdown @@ -80,6 +80,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `autoscalingGroupName` - (Required) Name of the Autoscaling Group to apply the tag to. * `tag` - (Required) Tag to create. The `tag` block is documented below. @@ -127,4 +128,4 @@ Using `terraform import`, import `aws_autoscaling_group_tag` using the ASG name % terraform import aws_autoscaling_group_tag.example asg-example,k8s.io/cluster-autoscaler/node-template/label/eks.amazonaws.com/capacityType ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/autoscaling_lifecycle_hook.html.markdown b/website/docs/cdktf/typescript/r/autoscaling_lifecycle_hook.html.markdown index 4f7987ddb510..b94880d00c0b 100644 --- a/website/docs/cdktf/typescript/r/autoscaling_lifecycle_hook.html.markdown +++ b/website/docs/cdktf/typescript/r/autoscaling_lifecycle_hook.html.markdown @@ -87,13 +87,14 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) Name of the lifecycle hook. * `autoscalingGroupName` - (Required) Name of the Auto Scaling group to which you want to assign the lifecycle hook * `defaultResult` - (Optional) Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. The value for this parameter can be either CONTINUE or ABANDON. The default value for this parameter is ABANDON. * `heartbeatTimeout` - (Optional) Defines the amount of time, in seconds, that can elapse before the lifecycle hook times out. When the lifecycle hook times out, Auto Scaling performs the action defined in the DefaultResult parameter * `lifecycleTransition` - (Required) Instance state to which you want to attach the lifecycle hook. For a list of lifecycle hook types, see [describe-lifecycle-hook-types](https://docs.aws.amazon.com/cli/latest/reference/autoscaling/describe-lifecycle-hook-types.html#examples) * `notificationMetadata` - (Optional) Contains additional information that you want to include any time Auto Scaling sends a message to the notification target. -* `notificationTargetArn` - (Optional) ARN of the notification target that Auto Scaling will use to notify you when an instance is in the transition state for the lifecycle hook. This ARN target can be either an SQS queue or an SNS topic. +* `notificationTargetArn` - (Optional) ARN of the notification target that Auto Scaling will use to notify you when an instance is in the transition state for the lifecycle hook. This ARN target can be either an SQS queue, an SNS topic, or a Lambda function. * `roleArn` - (Optional) ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target. ## Attribute Reference @@ -132,4 +133,4 @@ Using `terraform import`, import AutoScaling Lifecycle Hooks using the role auto % terraform import aws_autoscaling_lifecycle_hook.test-lifecycle-hook asg-name/lifecycle-hook-name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/autoscaling_notification.html.markdown b/website/docs/cdktf/typescript/r/autoscaling_notification.html.markdown index 08f24557a096..727eed6c4f54 100644 --- a/website/docs/cdktf/typescript/r/autoscaling_notification.html.markdown +++ b/website/docs/cdktf/typescript/r/autoscaling_notification.html.markdown @@ -70,6 +70,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `groupNames` - (Required) List of AutoScaling Group Names * `notifications` - (Required) List of Notification Types that trigger notifications. Acceptable values are documented [in the AWS documentation here][1] @@ -86,4 +87,4 @@ This resource exports the following attributes in addition to the arguments abov [1]: https://docs.aws.amazon.com/AutoScaling/latest/APIReference/API_NotificationConfiguration.html [2]: https://docs.aws.amazon.com/AutoScaling/latest/APIReference/API_DescribeNotificationConfigurations.html - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/autoscaling_policy.html.markdown b/website/docs/cdktf/typescript/r/autoscaling_policy.html.markdown index 823b74002ca5..2393eafbd1d2 100644 --- a/website/docs/cdktf/typescript/r/autoscaling_policy.html.markdown +++ b/website/docs/cdktf/typescript/r/autoscaling_policy.html.markdown @@ -259,6 +259,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) Name of the policy. * `autoscalingGroupName` - (Required) Name of the autoscaling group. * `adjustmentType` - (Optional) Whether the adjustment is an absolute number or a percentage of the current capacity. Valid values are `ChangeInCapacity`, `ExactCapacity`, and `PercentChangeInCapacity`. @@ -571,4 +572,4 @@ Using `terraform import`, import AutoScaling scaling policy using the role autos % terraform import aws_autoscaling_policy.test-policy asg-name/policy-name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/autoscaling_schedule.html.markdown b/website/docs/cdktf/typescript/r/autoscaling_schedule.html.markdown index de291339df18..7ee9f4445a50 100644 --- a/website/docs/cdktf/typescript/r/autoscaling_schedule.html.markdown +++ b/website/docs/cdktf/typescript/r/autoscaling_schedule.html.markdown @@ -66,6 +66,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `desiredCapacity` - (Optional) The initial capacity of the Auto Scaling group after the scheduled action runs and the capacity it attempts to maintain. Set to `-1` if you don't want to change the desired capacity at the scheduled time. Defaults to `0`. * `endTime` - (Optional) The date and time for the recurring schedule to end, in UTC with the format `"YYYY-MM-DDThh:mm:ssZ"` (e.g. `"2021-06-01T00:00:00Z"`). * `maxSize` - (Optional) The maximum size of the Auto Scaling group. Set to `-1` if you don't want to change the maximum size at the scheduled time. Defaults to `0`. @@ -114,4 +115,4 @@ Using `terraform import`, import AutoScaling ScheduledAction using the `auto-sca % terraform import aws_autoscaling_schedule.resource-name auto-scaling-group-name/scheduled-action-name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/autoscaling_traffic_source_attachment.html.markdown b/website/docs/cdktf/typescript/r/autoscaling_traffic_source_attachment.html.markdown index ce00729df0b2..0aea5b3349f9 100644 --- a/website/docs/cdktf/typescript/r/autoscaling_traffic_source_attachment.html.markdown +++ b/website/docs/cdktf/typescript/r/autoscaling_traffic_source_attachment.html.markdown @@ -46,6 +46,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +- `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). - `autoscalingGroupName` - (Required) The name of the Auto Scaling group. - `trafficSource` - (Required) The unique identifiers of a traffic sources. @@ -62,4 +63,4 @@ This resource supports the following arguments: This resource exports no additional attributes. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/autoscalingplans_scaling_plan.html.markdown b/website/docs/cdktf/typescript/r/autoscalingplans_scaling_plan.html.markdown index 4e5440762e05..080cce26f998 100644 --- a/website/docs/cdktf/typescript/r/autoscalingplans_scaling_plan.html.markdown +++ b/website/docs/cdktf/typescript/r/autoscalingplans_scaling_plan.html.markdown @@ -172,6 +172,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) Name of the scaling plan. Names cannot contain vertical bars, colons, or forward slashes. * `applicationSource` - (Required) CloudFormation stack or set of tags. You can create one scaling plan per application source. * `scalingInstruction` - (Required) Scaling instructions. More details can be found in the [AWS Auto Scaling API Reference](https://docs.aws.amazon.com/autoscaling/plans/APIReference/API_ScalingInstruction.html). @@ -287,4 +288,4 @@ Using `terraform import`, import Auto Scaling scaling plans using the `name`. Fo % terraform import aws_autoscalingplans_scaling_plan.example MyScale1 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/backup_framework.html.markdown b/website/docs/cdktf/typescript/r/backup_framework.html.markdown index b52e724bc3a9..96722ed7f18c 100644 --- a/website/docs/cdktf/typescript/r/backup_framework.html.markdown +++ b/website/docs/cdktf/typescript/r/backup_framework.html.markdown @@ -116,6 +116,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `control` - (Required) One or more control blocks that make up the framework. Each control in the list has a name, input parameters, and scope. Detailed below. * `description` - (Optional) The description of the framework with a maximum of 1,024 characters * `name` - (Required) The unique name of the framework. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters, numbers, and underscores. @@ -191,4 +192,4 @@ Using `terraform import`, import Backup Framework using the `id` which correspon % terraform import aws_backup_framework.test ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/backup_logically_air_gapped_vault.html.markdown b/website/docs/cdktf/typescript/r/backup_logically_air_gapped_vault.html.markdown index 5fee36e3c1b6..bba65a45f6ce 100644 --- a/website/docs/cdktf/typescript/r/backup_logically_air_gapped_vault.html.markdown +++ b/website/docs/cdktf/typescript/r/backup_logically_air_gapped_vault.html.markdown @@ -42,6 +42,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) Name of the Logically Air Gapped Backup Vault to create. * `maxRetentionDays` - (Required) Maximum retention period that the Logically Air Gapped Backup Vault retains recovery points. * `minRetentionDays` - (Required) Minimum retention period that the Logically Air Gapped Backup Vault retains recovery points. @@ -94,4 +95,4 @@ Using `terraform import`, import Backup Logically Air Gapped Vault using the `id % terraform import aws_backup_logically_air_gapped_vault.example lag-example-vault ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/backup_plan.html.markdown b/website/docs/cdktf/typescript/r/backup_plan.html.markdown index 0b9f44efd98b..33d456346e61 100644 --- a/website/docs/cdktf/typescript/r/backup_plan.html.markdown +++ b/website/docs/cdktf/typescript/r/backup_plan.html.markdown @@ -56,6 +56,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) The display name of a backup plan. * `rule` - (Required) A rule object that specifies a scheduled task that is used to back up a selection of resources. * `advancedBackupSetting` - (Optional) An object that specifies backup options for each resource type. @@ -135,4 +136,4 @@ Using `terraform import`, import Backup Plan using the `id`. For example: % terraform import aws_backup_plan.test ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/backup_region_settings.html.markdown b/website/docs/cdktf/typescript/r/backup_region_settings.html.markdown index 15555d856c0e..cb300ae47b9e 100644 --- a/website/docs/cdktf/typescript/r/backup_region_settings.html.markdown +++ b/website/docs/cdktf/typescript/r/backup_region_settings.html.markdown @@ -62,6 +62,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `resourceTypeOptInPreference` - (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). * `resourceTypeManagementPreference` - (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). @@ -99,4 +100,4 @@ Using `terraform import`, import Backup Region Settings using the `region`. For % terraform import aws_backup_region_settings.test us-west-2 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/backup_report_plan.html.markdown b/website/docs/cdktf/typescript/r/backup_report_plan.html.markdown index 4c028c62f2ce..5d4e85c0de83 100644 --- a/website/docs/cdktf/typescript/r/backup_report_plan.html.markdown +++ b/website/docs/cdktf/typescript/r/backup_report_plan.html.markdown @@ -49,6 +49,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `description` - (Optional) The description of the report plan with a maximum of 1,024 characters * `name` - (Required) The unique name of the report plan. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters, numbers, and underscores. * `reportDeliveryChannel` - (Required) An object that contains information about where and how to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports. Detailed below. @@ -112,4 +113,4 @@ Using `terraform import`, import Backup Report Plan using the `id` which corresp % terraform import aws_backup_report_plan.test ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/backup_restore_testing_plan.html.markdown b/website/docs/cdktf/typescript/r/backup_restore_testing_plan.html.markdown index c4168f4e9331..cdece63102e8 100644 --- a/website/docs/cdktf/typescript/r/backup_restore_testing_plan.html.markdown +++ b/website/docs/cdktf/typescript/r/backup_restore_testing_plan.html.markdown @@ -45,8 +45,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `name` (Required): The name of the restore testing plan. Must be between 1 and 50 characters long and contain only alphanumeric characters and underscores. * `scheduleExpression` (Required): The schedule expression for the restore testing plan. * `scheduleExpressionTimezone` (Optional): The timezone for the schedule expression. If not provided, the state value will be used. @@ -100,4 +101,4 @@ Using `terraform import`, import Backup Restore Testing Plan using the `name`. F % terraform import aws_backup_restore_testing_plan.example my_testing_plan ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/backup_restore_testing_selection.html.markdown b/website/docs/cdktf/typescript/r/backup_restore_testing_selection.html.markdown index 92100ac4daf9..cff882510fc2 100644 --- a/website/docs/cdktf/typescript/r/backup_restore_testing_selection.html.markdown +++ b/website/docs/cdktf/typescript/r/backup_restore_testing_selection.html.markdown @@ -83,6 +83,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) The name of the backup restore testing selection. * `restoreTestingPlanName` - (Required) The name of the restore testing plan. * `protectedResourceType` - (Required) The type of the protected resource. @@ -138,4 +139,4 @@ Using `terraform import`, import Backup Restore Testing Selection using `name:re % terraform import aws_backup_restore_testing_selection.example restore_testing_selection_12345678:restore_testing_plan_12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/backup_selection.html.markdown b/website/docs/cdktf/typescript/r/backup_selection.html.markdown index c5608a3f5970..48fc1d0f461b 100644 --- a/website/docs/cdktf/typescript/r/backup_selection.html.markdown +++ b/website/docs/cdktf/typescript/r/backup_selection.html.markdown @@ -226,6 +226,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) The display name of a resource selection document. * `planId` - (Required) The backup plan ID to be associated with the selection of resources. * `iamRoleArn` - (Required) The ARN of the IAM role that AWS Backup uses to authenticate when restoring and backing up the target resource. See the [AWS Backup Developer Guide](https://docs.aws.amazon.com/aws-backup/latest/devguide/access-control.html#managed-policies) for additional information about using AWS managed policies or creating custom policies attached to the IAM role. @@ -317,4 +318,4 @@ Using `terraform import`, import Backup selection using the role plan_id and id % terraform import aws_backup_selection.example plan-id|selection-id ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/backup_vault.html.markdown b/website/docs/cdktf/typescript/r/backup_vault.html.markdown index e49488d4fb7a..3c5bd76c193f 100644 --- a/website/docs/cdktf/typescript/r/backup_vault.html.markdown +++ b/website/docs/cdktf/typescript/r/backup_vault.html.markdown @@ -39,6 +39,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `forceDestroy` - (Optional, Default: `false`) A boolean that indicates that all recovery points stored in the vault are deleted so that the vault can be destroyed without error. * `kmsKeyArn` - (Optional) The server-side encryption key that is used to protect your backups. * `name` - (Required) Name of the backup vault to create. @@ -87,4 +88,4 @@ Using `terraform import`, import Backup vault using the `name`. For example: % terraform import aws_backup_vault.test-vault TestVault ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/backup_vault_lock_configuration.html.markdown b/website/docs/cdktf/typescript/r/backup_vault_lock_configuration.html.markdown index 2e8e15e72c1c..aaf6c48e293d 100644 --- a/website/docs/cdktf/typescript/r/backup_vault_lock_configuration.html.markdown +++ b/website/docs/cdktf/typescript/r/backup_vault_lock_configuration.html.markdown @@ -41,6 +41,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `backupVaultName` - (Required) Name of the backup vault to add a lock configuration for. * `changeableForDays` - (Optional) The number of days before the lock date. If omitted creates a vault lock in `governance` mode, otherwise it will create a vault lock in `compliance` mode. * `maxRetentionDays` - (Optional) The maximum retention period that the vault retains its recovery points. @@ -85,4 +86,4 @@ Using `terraform import`, import Backup vault lock configuration using the `name % terraform import aws_backup_vault_lock_configuration.test TestVault ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/backup_vault_notifications.html.markdown b/website/docs/cdktf/typescript/r/backup_vault_notifications.html.markdown index 64f92244708f..96b062b4cb16 100644 --- a/website/docs/cdktf/typescript/r/backup_vault_notifications.html.markdown +++ b/website/docs/cdktf/typescript/r/backup_vault_notifications.html.markdown @@ -81,6 +81,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `backupVaultName` - (Required) Name of the backup vault to add notifications for. * `snsTopicArn` - (Required) The Amazon Resource Name (ARN) that specifies the topic for a backup vault’s events * `backupVaultEvents` - (Required) An array of events that indicate the status of jobs to back up resources to the backup vault. @@ -120,4 +121,4 @@ Using `terraform import`, import Backup vault notifications using the `name`. Fo % terraform import aws_backup_vault_notifications.test TestVault ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/backup_vault_policy.html.markdown b/website/docs/cdktf/typescript/r/backup_vault_policy.html.markdown index 295b449639b5..bb42472faabd 100644 --- a/website/docs/cdktf/typescript/r/backup_vault_policy.html.markdown +++ b/website/docs/cdktf/typescript/r/backup_vault_policy.html.markdown @@ -82,6 +82,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `backupVaultName` - (Required) Name of the backup vault to add policy for. * `policy` - (Required) The backup vault access policy document in JSON format. @@ -120,4 +121,4 @@ Using `terraform import`, import Backup vault policy using the `name`. For examp % terraform import aws_backup_vault_policy.test TestVault ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/batch_compute_environment.html.markdown b/website/docs/cdktf/typescript/r/batch_compute_environment.html.markdown index efca7e78127e..2d2294759f21 100644 --- a/website/docs/cdktf/typescript/r/batch_compute_environment.html.markdown +++ b/website/docs/cdktf/typescript/r/batch_compute_environment.html.markdown @@ -147,7 +147,6 @@ class MyConvertedCode extends TerraformStack { this, "sample_11", { - computeEnvironmentName: "sample", computeResources: { instanceRole: Token.asString( awsIamInstanceProfileEcsInstanceRole.arn @@ -161,6 +160,7 @@ class MyConvertedCode extends TerraformStack { type: "EC2", }, dependsOn: [awsIamRolePolicyAttachmentAwsBatchServiceRole], + name: "sample", serviceRole: awsBatchServiceRole.arn, type: "MANAGED", } @@ -187,7 +187,6 @@ class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); new BatchComputeEnvironment(this, "sample", { - computeEnvironmentName: "sample", computeResources: { maxVcpus: 16, securityGroupIds: [Token.asString(awsSecurityGroupSample.id)], @@ -195,6 +194,7 @@ class MyConvertedCode extends TerraformStack { type: "FARGATE", }, dependsOn: [awsBatchServiceRole], + name: "sample", serviceRole: Token.asString(awsIamRoleAwsBatchServiceRole.arn), type: "MANAGED", }); @@ -218,7 +218,6 @@ class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); new BatchComputeEnvironment(this, "sample", { - computeEnvironmentName: "sample", computeResources: { allocationStrategy: "BEST_FIT_PROGRESSIVE", instanceRole: ecsInstance.arn, @@ -229,6 +228,7 @@ class MyConvertedCode extends TerraformStack { subnets: [Token.asString(awsSubnetSample.id)], type: "EC2", }, + name: "sample", type: "MANAGED", updatePolicy: { jobExecutionTimeoutMinutes: 30, @@ -244,8 +244,9 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: -* `computeEnvironmentName` - (Optional, Forces new resource) The name for your compute environment. Up to 128 letters (uppercase and lowercase), numbers, and underscores are allowed. If omitted, Terraform will assign a random, unique name. -* `computeEnvironmentNamePrefix` - (Optional, Forces new resource) Creates a unique compute environment name beginning with the specified prefix. Conflicts with `computeEnvironmentName`. +* `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). +* `name` - (Optional, Forces new resource) The name for your compute environment. Up to 128 letters (uppercase and lowercase), numbers, and underscores are allowed. If omitted, Terraform will assign a random, unique name. +* `namePrefix` - (Optional, Forces new resource) Creates a unique compute environment name beginning with the specified prefix. Conflicts with `name`. * `computeResources` - (Optional) Details of the compute resources managed by the compute environment. This parameter is required for managed compute environments. See details below. * `eksConfiguration` - (Optional) Details for the Amazon EKS cluster that supports the compute environment. See details below. * `serviceRole` - (Optional) The full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch to make calls to other AWS services on your behalf. @@ -279,6 +280,7 @@ This resource supports the following arguments: `ec2Configuration` supports the following: * `imageIdOverride` - (Optional) The AMI ID used for instances launched in the compute environment that match the image type. This setting overrides the `imageId` argument in the [`computeResources`](#compute_resources) block. +* `imageKubernetesVersion` - (Optional) The Kubernetes version for the compute environment. If you don't specify a value, the latest version that AWS Batch supports is used. See [Supported Kubernetes versions](https://docs.aws.amazon.com/batch/latest/userguide/supported_kubernetes_version.html) for the list of Kubernetes versions supported by AWS Batch on Amazon EKS. * `imageType` - (Optional) The image type to match with the instance type to select an AMI. If the `imageIdOverride` parameter isn't specified, then a recent [Amazon ECS-optimized Amazon Linux 2 AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#al2ami) (`ECS_AL2`) is used. ### launch_template @@ -301,7 +303,7 @@ This resource supports the following arguments: `updatePolicy` supports the following: * `jobExecutionTimeoutMinutes` - (Required) Specifies the job timeout (in minutes) when the compute environment infrastructure is updated. -* `terminateJobsOnUpdate` - (Required) Specifies whether jobs are automatically terminated when the computer environment infrastructure is updated. +* `terminateJobsOnUpdate` - (Required) Specifies whether jobs are automatically terminated when the compute environment infrastructure is updated. ## Attribute Reference @@ -315,7 +317,7 @@ This resource exports the following attributes in addition to the arguments abov ## Import -In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import AWS Batch compute using the `computeEnvironmentName`. For example: +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import AWS Batch compute using the `name`. For example: ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -335,7 +337,7 @@ class MyConvertedCode extends TerraformStack { ``` -Using `terraform import`, import AWS Batch compute using the `computeEnvironmentName`. For example: +Using `terraform import`, import AWS Batch compute using the `name`. For example: ```console % terraform import aws_batch_compute_environment.sample sample @@ -345,4 +347,4 @@ Using `terraform import`, import AWS Batch compute using the `computeEnvironment [2]: http://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html [3]: http://docs.aws.amazon.com/batch/latest/userguide/troubleshooting.html - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/batch_job_definition.html.markdown b/website/docs/cdktf/typescript/r/batch_job_definition.html.markdown index 37cf7a306424..aa9053c93c76 100644 --- a/website/docs/cdktf/typescript/r/batch_job_definition.html.markdown +++ b/website/docs/cdktf/typescript/r/batch_job_definition.html.markdown @@ -353,6 +353,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `containerProperties` - (Optional) 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`. * `deregisterOnNewRevision` - (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`. * `ecsProperties` - (Optional) Valid [ECS 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`. @@ -415,7 +416,7 @@ The following arguments are optional: #### eks_metadata -* `labels` - Key-value pairs used to identify, sort, and organize cube resources. +* `labels` - Key-value pairs used to identify, sort, and organize kubernetes resources. #### `eks_secret` @@ -479,4 +480,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 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/batch_job_queue.html.markdown b/website/docs/cdktf/typescript/r/batch_job_queue.html.markdown index 5cc228e531fb..77f5ee144be9 100644 --- a/website/docs/cdktf/typescript/r/batch_job_queue.html.markdown +++ b/website/docs/cdktf/typescript/r/batch_job_queue.html.markdown @@ -103,8 +103,8 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) Specifies the name of the job queue. -* `computeEnvironments` - (Deprecated) (Optional) This parameter is deprecated, please use `computeEnvironmentOrder` instead. List of compute environment ARNs mapped to a job queue. The position of the compute environments in the list will dictate the order. When importing a AWS Batch Job Queue, the parameter `computeEnvironments` will always be used over `computeEnvironmentOrder`. Please adjust your HCL accordingly. * `computeEnvironmentOrder` - (Optional) The set of compute environments mapped to a job queue and their order relative to each other. The job scheduler uses this parameter to determine which compute environment runs a specific job. Compute environments must be in the VALID state before you can associate them with a job queue. You can associate up to three compute environments with a job queue. * `jobStateTimeLimitAction` - (Optional) The set of job state time limit actions mapped to a job queue. Specifies an action that AWS Batch will take after the job has remained at the head of the queue in the specified state for longer than the specified time. * `priority` - (Required) The priority of the job queue. Job queues with a higher priority @@ -172,4 +172,4 @@ Using `terraform import`, import Batch Job Queue using the `arn`. For example: % terraform import aws_batch_job_queue.test_queue arn:aws:batch:us-east-1:123456789012:job-queue/sample ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/batch_scheduling_policy.html.markdown b/website/docs/cdktf/typescript/r/batch_scheduling_policy.html.markdown index 8c421a7c80d1..db2d3c684d34 100644 --- a/website/docs/cdktf/typescript/r/batch_scheduling_policy.html.markdown +++ b/website/docs/cdktf/typescript/r/batch_scheduling_policy.html.markdown @@ -55,6 +55,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `fairshare_policy` - (Optional) A fairshare policy block specifies the `computeReservation`, `share_delay_seconds`, and `shareDistribution` of the scheduling policy. The `fairshare_policy` block is documented below. * `name` - (Required) Specifies the name of the scheduling policy. * `tags` - (Optional) Key-value map of resource tags. If configured with a provider [`defaultTags` 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. @@ -109,4 +110,4 @@ Using `terraform import`, import Batch Scheduling Policy using the `arn`. For ex % terraform import aws_batch_scheduling_policy.test_policy arn:aws:batch:us-east-1:123456789012:scheduling-policy/sample ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/bcmdataexports_export.html.markdown b/website/docs/cdktf/typescript/r/bcmdataexports_export.html.markdown index 7e0bb4bb473e..f71831de0f9d 100644 --- a/website/docs/cdktf/typescript/r/bcmdataexports_export.html.markdown +++ b/website/docs/cdktf/typescript/r/bcmdataexports_export.html.markdown @@ -25,9 +25,15 @@ import { Token, TerraformStack } from "cdktf"; * See https://cdk.tf/provider-generation for more details. */ import { BcmdataexportsExport } from "./.gen/providers/aws/bcmdataexports-export"; +import { DataAwsCallerIdentity } from "./.gen/providers/aws/data-aws-caller-identity"; +import { DataAwsPartition } from "./.gen/providers/aws/data-aws-partition"; class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); + const current = new DataAwsCallerIdentity(this, "current", {}); + const dataAwsPartitionCurrent = new DataAwsPartition(this, "current_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.*/ + dataAwsPartitionCurrent.overrideLogicalId("current"); new BcmdataexportsExport(this, "test", { export: [ { @@ -37,6 +43,12 @@ class MyConvertedCode extends TerraformStack { "SELECT identity_line_item_id, identity_time_interval, line_item_product_code,line_item_unblended_cost FROM COST_AND_USAGE_REPORT", tableConfigurations: { COST_AND_USAGE_REPORT: { + BILLING_VIEW_ARN: + "arn:${" + + dataAwsPartitionCurrent.partition + + "}:billing::${" + + current.accountId + + "}:billingview/primary", INCLUDE_MANUAL_DISCOUNT_COMPATIBILITY: "FALSE", INCLUDE_RESOURCES: "FALSE", INCLUDE_SPLIT_COST_ALLOCATION_DATA: "FALSE", @@ -94,8 +106,8 @@ The following arguments are required: ### `dataQuery` Argument Reference -* `queryStatement` - (Required) Query statement. -* `tableConfigurations` - (Optional) Table configuration. +* `queryStatement` - (Required) Query statement. The SQL table name for CUR 2.0 is `COST_AND_USAGE_REPORT`. See the [AWS documentation](https://docs.aws.amazon.com/cur/latest/userguide/table-dictionary-cur2.html) for a list of available columns. +* `tableConfigurations` - (Optional) Table configuration. See the [AWS documentation](https://docs.aws.amazon.com/cur/latest/userguide/table-dictionary-cur2.html#cur2-table-configurations) for the available configurations. In addition to those listed in the documentation, `BILLING_VIEW_ARN` must also be included, as shown in the example above. ### `destinationConfigurations` Argument Reference @@ -123,7 +135,8 @@ The following arguments are required: This resource exports the following attributes in addition to the arguments above: -* `exportArn` - Amazon Resource Name (ARN) for this export. +* `arn` - Amazon Resource Name (ARN) for this export. +* `export[0].export_arn` - Amazon Resource Name (ARN) for this export. ## Timeouts @@ -164,4 +177,4 @@ Using `terraform import`, import BCM Data Exports Export using the export ARN. F % terraform import aws_bcmdataexports_export.example arn:aws:bcm-data-exports:us-east-1:123456789012:export/CostUsageReport-9f1c75f3-f982-4d9a-b936-1e7ecab814b7 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/bedrock_custom_model.html.markdown b/website/docs/cdktf/typescript/r/bedrock_custom_model.html.markdown index a318225f9a0b..05a14794021c 100644 --- a/website/docs/cdktf/typescript/r/bedrock_custom_model.html.markdown +++ b/website/docs/cdktf/typescript/r/bedrock_custom_model.html.markdown @@ -80,6 +80,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `baseModelIdentifier` - (Required) The Amazon Resource Name (ARN) of the base model. * `customModelKmsKeyId` - (Optional) The custom model is encrypted at rest using this key. Specify the key ARN. * `customModelName` - (Required) Name for the custom model. @@ -96,8 +97,8 @@ This resource supports the following arguments: * `validator` - (Required) Information about the validators. * `s3Uri` - (Required) The S3 URI where the validation data is stored. * `vpcConfig` - (Optional) Configuration parameters for the private Virtual Private Cloud (VPC) that contains the resources you are using for this job. - * `securityGroupIds` – (Required) VPC configuration security group IDs. - * `subnetIds` – (Required) VPC configuration subnets. + * `securityGroupIds` - (Required) VPC configuration security group IDs. + * `subnetIds` - (Required) VPC configuration subnets. ## Attribute Reference @@ -150,4 +151,4 @@ Using `terraform import`, import Bedrock custom model using the `jobArn`. For ex % terraform import aws_bedrock_custom_model.example arn:aws:bedrock:us-west-2:123456789012:model-customization-job/amazon.titan-text-express-v1:0:8k/1y5n57gh5y2e ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/bedrock_guardrail.html.markdown b/website/docs/cdktf/typescript/r/bedrock_guardrail.html.markdown index dee81102db7b..38b17396d62d 100644 --- a/website/docs/cdktf/typescript/r/bedrock_guardrail.html.markdown +++ b/website/docs/cdktf/typescript/r/bedrock_guardrail.html.markdown @@ -29,19 +29,30 @@ resource "aws_bedrock_guardrail" "example" { output_strength = "MEDIUM" type = "HATE" } + tier_config { + tier_name = "STANDARD" + } } sensitive_information_policy_config { pii_entities_config { - action = "BLOCK" - type = "NAME" + action = "BLOCK" + input_action = "BLOCK" + output_action = "ANONYMIZE" + input_enabled = true + output_enabled = true + type = "NAME" } regexes_config { - action = "BLOCK" - description = "example regex" - name = "regex_example" - pattern = "^\\d{3}-\\d{2}-\\d{4}$" + action = "BLOCK" + input_action = "BLOCK" + output_action = "BLOCK" + input_enabled = true + output_enabled = false + description = "example regex" + name = "regex_example" + pattern = "^\\d{3}-\\d{2}-\\d{4}$" } } @@ -52,6 +63,9 @@ resource "aws_bedrock_guardrail" "example" { type = "DENY" definition = "Investment advice refers to inquiries, guidance, or recommendations regarding the management or allocation of funds or assets with the goal of generating returns ." } + tier_config { + tier_name = "CLASSIC" + } } word_policy_config { @@ -75,6 +89,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `contentPolicyConfig` - (Optional) Content policy config for a guardrail. See [Content Policy Config](#content-policy-config) for more information. * `contextualGroundingPolicyConfig` - (Optional) Contextual grounding policy config for a guardrail. See [Contextual Grounding Policy Config](#contextual-grounding-policy-config) for more information. * `description` (Optional) Description of the guardrail or its version. @@ -90,6 +105,7 @@ The `contentPolicyConfig` configuration block supports the following arguments: * `filtersConfig` - (Optional) Set of content filter configs in content policy. See [Filters Config](#content-filters-config) for more information. +* `tierConfig` - (Optional) Configuration block for the content policy tier. See [Tier Config](#content-tier-config) for more information. #### Content Filters Config @@ -99,6 +115,12 @@ The `filtersConfig` configuration block supports the following arguments: * `outputStrength` - (Optional) Strength for filters. * `type` - (Optional) Type of filter in content policy. +#### Content Tier Config + +The `tierConfig` configuration block supports the following arguments: + +* `tier_name` - (Required) The name of the content policy tier. Valid values include STANDARD or CLASSIC. + ### Contextual Grounding Policy Config * `filtersConfig` (Required) List of contextual grounding filter configs. See [Contextual Grounding Filters Config](#contextual-grounding-filters-config) for more information. @@ -110,8 +132,17 @@ The `filtersConfig` configuration block supports the following arguments: * `threshold` - (Required) The threshold for this filter. * `type` - (Required) Type of contextual grounding filter. +### Cross Region Inference + +* `crossRegionConfig` (Optional) Configuration block to enable cross-region routing for bedrock guardrails. See [Cross Region Config](#cross-region-config for more information. Note see [available regions](https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-cross-region.html) here. + +#### Cross Region Config + +* `guardrailProfileIdentifier` (Required) Guardrail profile ARN. + ### Topic Policy Config +* `tierConfig` - (Optional) Configuration block for the topic policy tier. See [Tier Config](#topics-tier-config) for more information. * `topicsConfig` (Required) List of topic configs in topic policy. See [Topics Config](#topics-config) for more information. #### Topics Config @@ -121,6 +152,12 @@ The `filtersConfig` configuration block supports the following arguments: * `type` (Required) Type of topic in a policy. * `examples` (Optional) List of text examples. +#### Topics Tier Config + +The `tierConfig` configuration block supports the following arguments: + +* `tier_name` - (Required) The name of the content policy tier. Valid values include STANDARD or CLASSIC. + ### Sensitive Information Policy Config * `piiEntitiesConfig` (Optional) List of entities. See [PII Entities Config](#pii-entities-config) for more information. @@ -128,13 +165,21 @@ The `filtersConfig` configuration block supports the following arguments: #### PII Entities Config -* `action` (Required) Options for sensitive information action. +* `action` (Required) Options for sensitive information action. Valid values: `BLOCK`, `ANONYMIZE`, `NONE`. +* `inputAction` (Optional) Action to take when harmful content is detected in the input. Valid values: `BLOCK`, `ANONYMIZE`, `NONE`. +* `inputEnabled` (Optional) Whether to enable guardrail evaluation on the input. When disabled, you aren't charged for the evaluation. +* `outputAction` (Optional) Action to take when harmful content is detected in the output. Valid values: `BLOCK`, `ANONYMIZE`, `NONE`. +* `outputEnabled` (Optional) Whether to enable guardrail evaluation on the output. When disabled, you aren't charged for the evaluation. * `type` (Required) The currently supported PII entities. #### Regexes Config -* `action` (Required) Options for sensitive information action. +* `action` (Required) Options for sensitive information action. Valid values: `BLOCK`, `ANONYMIZE`, `NONE`. +* `inputAction` (Optional) Action to take when harmful content is detected in the input. Valid values: `BLOCK`, `ANONYMIZE`, `NONE`. +* `inputEnabled` (Optional) Whether to enable guardrail evaluation on the input. When disabled, you aren't charged for the evaluation. * `name` (Required) The regex name. +* `outputAction` (Optional) Action to take when harmful content is detected in the output. Valid values: `BLOCK`, `ANONYMIZE`, `NONE`. +* `outputEnabled` (Optional) Whether to enable guardrail evaluation on the output. When disabled, you aren't charged for the evaluation. * `pattern` (Required) The regex pattern. * `description` (Optional) The regex description. @@ -201,4 +246,4 @@ Using `terraform import`, import Amazon Bedrock Guardrail using using a comma-de % terraform import aws_bedrock_guardrail.example guardrail-id-12345678,DRAFT ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/bedrock_guardrail_version.html.markdown b/website/docs/cdktf/typescript/r/bedrock_guardrail_version.html.markdown index 8a6d5d2bfedc..c7ff1fddf1c9 100644 --- a/website/docs/cdktf/typescript/r/bedrock_guardrail_version.html.markdown +++ b/website/docs/cdktf/typescript/r/bedrock_guardrail_version.html.markdown @@ -45,6 +45,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `description` - (Optional) Description of the Guardrail version. * `skipDestroy` - (Optional) Whether to retain the old version of a previously deployed Guardrail. Default is `false` @@ -93,4 +94,4 @@ Using `terraform import`, import Amazon Bedrock Guardrail Version using using a % terraform import aws_bedrock_guardrail_version.example arn:aws:bedrock:us-west-2:123456789012:guardrail-id-12345678,1 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/bedrock_inference_profile.html.markdown b/website/docs/cdktf/typescript/r/bedrock_inference_profile.html.markdown index 73e5a4adccdd..6afdc4b4b5dc 100644 --- a/website/docs/cdktf/typescript/r/bedrock_inference_profile.html.markdown +++ b/website/docs/cdktf/typescript/r/bedrock_inference_profile.html.markdown @@ -24,16 +24,16 @@ import { TerraformStack } from "cdktf"; * Provider bindings are generated by running `cdktf get`. * See https://cdk.tf/provider-generation for more details. */ -import { BedrockInferenceProfile } from "./.gen/providers/aws/"; +import { BedrockInferenceProfile } from "./.gen/providers/aws/bedrock-inference-profile"; import { DataAwsCallerIdentity } from "./.gen/providers/aws/data-aws-caller-identity"; class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); new BedrockInferenceProfile(this, "example", { description: "Profile with tag for cost allocation tracking", - model_source: [ + modelSource: [ { - copy_from: + copyFrom: "arn:aws:bedrock:us-west-2::foundation-model/anthropic.claude-3-5-sonnet-20241022-v2:0", }, ], @@ -53,16 +53,17 @@ class MyConvertedCode extends TerraformStack { The following arguments are required: * `name` - (Required) The name of the inference profile. -* `model_source` - (Required) The source of the model this inference profile will track metrics and cost for. See [`model_source`](#model_source). +* `modelSource` - (Required) The source of the model this inference profile will track metrics and cost for. See [`modelSource`](#model_source). The following arguments are optional: +* `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). * `description` - (Optional) The description of the inference profile. * `tags` - (Optional) Key-value mapping of resource tags for the inference profile. -### `model_source` +### `modelSource` -- `copy_from` - The Amazon Resource Name (ARN) of the model. +- `copyFrom` - The Amazon Resource Name (ARN) of the model. ## Attribute Reference @@ -92,7 +93,7 @@ This resource exports the following attributes in addition to the arguments abov ## Import -In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import Bedrock Inference Profile using the `example_id_arg`. For example: +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import Bedrock Inference Profile using the `name`. For example: ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -102,7 +103,7 @@ import { TerraformStack } from "cdktf"; * Provider bindings are generated by running `cdktf get`. * See https://cdk.tf/provider-generation for more details. */ -import { BedrockInferenceProfile } from "./.gen/providers/aws/"; +import { BedrockInferenceProfile } from "./.gen/providers/aws/bedrock-inference-profile"; class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); @@ -116,10 +117,10 @@ class MyConvertedCode extends TerraformStack { ``` -Using `terraform import`, import Bedrock Inference Profile using the `example_id_arg`. For example: +Using `terraform import`, import Bedrock Inference Profile using the `name`. For example: ```console % terraform import aws_bedrock_inference_profile.example inference_profile-id-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/bedrock_model_invocation_logging_configuration.html.markdown b/website/docs/cdktf/typescript/r/bedrock_model_invocation_logging_configuration.html.markdown index c5364e584f14..305cc5c6eef4 100644 --- a/website/docs/cdktf/typescript/r/bedrock_model_invocation_logging_configuration.html.markdown +++ b/website/docs/cdktf/typescript/r/bedrock_model_invocation_logging_configuration.html.markdown @@ -83,42 +83,43 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `loggingConfig` - (Required) The logging configuration values to set. See [`loggingConfig` Block](#logging_config-block) for details. ### `loggingConfig` Block The `loggingConfig` configuration block supports the following arguments: -* `cloudwatchConfig` – (Optional) CloudWatch logging configuration. See [`cloudwatchConfig` Block](#cloudwatch_config-block) for details. -* `embeddingDataDeliveryEnabled` – (Optional) Set to include embeddings data in the log delivery. Defaults to `true`. -* `imageDataDeliveryEnabled` – (Optional) Set to include image data in the log delivery. Defaults to `true`. -* `s3Config` – (Optional) S3 configuration for storing log data. See [`s3Config` Block](#s3_config-block) for details. -* `textDataDeliveryEnabled` – (Optional) Set to include text data in the log delivery. Defaults to `true`. -* `videoDataDeliveryEnabled` – (Optional) Set to include text data in the log delivery. Defaults to `true`. +* `cloudwatchConfig` - (Optional) CloudWatch logging configuration. See [`cloudwatchConfig` Block](#cloudwatch_config-block) for details. +* `embeddingDataDeliveryEnabled` - (Optional) Set to include embeddings data in the log delivery. Defaults to `true`. +* `imageDataDeliveryEnabled` - (Optional) Set to include image data in the log delivery. Defaults to `true`. +* `s3Config` - (Optional) S3 configuration for storing log data. See [`s3Config` Block](#s3_config-block) for details. +* `textDataDeliveryEnabled` - (Optional) Set to include text data in the log delivery. Defaults to `true`. +* `videoDataDeliveryEnabled` - (Optional) Set to include text data in the log delivery. Defaults to `true`. ### `cloudwatchConfig` Block The `cloudwatchConfig` configuration block supports the following arguments: -* `largeDataDeliveryS3Config` – (Optional) S3 configuration for delivering a large amount of data. See [`largeDataDeliveryS3Config` Block](#large_data_delivery_s3_config-block) for details. -* `logGroupName` – (Required) Log group name. -* `roleArn` – (Optional) The role ARN. +* `largeDataDeliveryS3Config` - (Optional) S3 configuration for delivering a large amount of data. See [`largeDataDeliveryS3Config` Block](#large_data_delivery_s3_config-block) for details. +* `logGroupName` - (Required) Log group name. +* `roleArn` - (Optional) The role ARN. ### `largeDataDeliveryS3Config` Block The `largeDataDeliveryS3Config` configuration block supports the following arguments: -* `bucketName` – (Required) S3 bucket name. -* `keyPrefix` – (Optional) S3 prefix. +* `bucketName` - (Required) S3 bucket name. +* `keyPrefix` - (Optional) S3 prefix. ### `s3Config` Block The `s3Config` configuration block supports the following arguments: -* `bucketName` – (Required) S3 bucket name. -* `keyPrefix` – (Optional) S3 prefix. +* `bucketName` - (Required) S3 bucket name. +* `keyPrefix` - (Optional) S3 prefix. ## Attribute Reference @@ -158,4 +159,4 @@ Using `terraform import`, import Bedrock custom model using the `id` set to the % terraform import aws_bedrock_model_invocation_logging_configuration.my_config us-east-1 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/bedrock_provisioned_model_throughput.html.markdown b/website/docs/cdktf/typescript/r/bedrock_provisioned_model_throughput.html.markdown index 21add6c9da09..faa2f59d61a0 100644 --- a/website/docs/cdktf/typescript/r/bedrock_provisioned_model_throughput.html.markdown +++ b/website/docs/cdktf/typescript/r/bedrock_provisioned_model_throughput.html.markdown @@ -42,6 +42,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `commitmentDuration` - (Optional) Commitment duration requested for the Provisioned Throughput. For custom models, you can purchase on-demand Provisioned Throughput by omitting this argument. Valid values: `OneMonth`, `SixMonths`. * `modelArn` - (Required) ARN of the model to associate with this Provisioned Throughput. * `modelUnits` - (Required) Number of model units to allocate. A model unit delivers a specific throughput level for the specified model. @@ -93,4 +94,4 @@ Using `terraform import`, import Provisioned Throughput using the `provisionedMo % terraform import aws_bedrock_provisioned_model_throughput.example arn:aws:bedrock:us-west-2:123456789012:provisioned-model/1y5n57gh5y2e ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/bedrockagent_agent.html.markdown b/website/docs/cdktf/typescript/r/bedrockagent_agent.html.markdown index 46a89abe9bc4..ae8a22f63927 100644 --- a/website/docs/cdktf/typescript/r/bedrockagent_agent.html.markdown +++ b/website/docs/cdktf/typescript/r/bedrockagent_agent.html.markdown @@ -51,7 +51,7 @@ class MyConvertedCode extends TerraformStack { "arn:${" + dataAwsPartitionCurrent.partition + "}:bedrock:${" + - dataAwsRegionCurrent.name + + dataAwsRegionCurrent.region + "}::foundation-model/anthropic.claude-v2", ], }, @@ -77,7 +77,7 @@ class MyConvertedCode extends TerraformStack { "arn:${" + dataAwsPartitionCurrent.partition + "}:bedrock:${" + - dataAwsRegionCurrent.name + + dataAwsRegionCurrent.region + "}:${" + current.accountId + "}:agent/*", @@ -132,6 +132,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `agentCollaboration` - (Optional) Agents collaboration role. Valid values: `SUPERVISOR`, `SUPERVISOR_ROUTER`, `DISABLED`. * `customerEncryptionKeyArn` - (Optional) ARN of the AWS KMS key that encrypts the agent. * `description` - (Optional) Description of the agent. @@ -233,4 +234,4 @@ Using `terraform import`, import Agents for Amazon Bedrock Agent using the agent % terraform import aws_bedrockagent_agent.example GGRRAED6JP ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/bedrockagent_agent_action_group.html.markdown b/website/docs/cdktf/typescript/r/bedrockagent_agent_action_group.html.markdown index 8f3496f1a4b7..9e7417a84393 100644 --- a/website/docs/cdktf/typescript/r/bedrockagent_agent_action_group.html.markdown +++ b/website/docs/cdktf/typescript/r/bedrockagent_agent_action_group.html.markdown @@ -195,6 +195,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `actionGroupState` - (Optional) Whether the action group is available for the agent to invoke or not when sending an [InvokeAgent](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html) request. Valid values: `ENABLED`, `DISABLED`. * `apiSchema` - (Optional) Either details about the S3 object containing the OpenAPI schema for the action group or the JSON or YAML-formatted payload defining the schema. For more information, see [Action group OpenAPI schemas](https://docs.aws.amazon.com/bedrock/latest/userguide/agents-api-schema.html). See [`apiSchema` Block](#api_schema-block) for details. * `description` - (Optional) Description of the action group. @@ -277,6 +278,7 @@ This resource exports the following attributes in addition to the arguments abov * `create` - (Default `30m`) * `update` - (Default `30m`) +* `delete` - (Default `30m`) ## Import @@ -310,4 +312,4 @@ Using `terraform import`, import Agents for Amazon Bedrock Agent Action Group th % terraform import aws_bedrockagent_agent_action_group.example MMAUDBZTH4,GGRRAED6JP,DRAFT ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/bedrockagent_agent_alias.html.markdown b/website/docs/cdktf/typescript/r/bedrockagent_agent_alias.html.markdown index 1627c20fa4f2..af45357b3fc4 100644 --- a/website/docs/cdktf/typescript/r/bedrockagent_agent_alias.html.markdown +++ b/website/docs/cdktf/typescript/r/bedrockagent_agent_alias.html.markdown @@ -52,7 +52,7 @@ class MyConvertedCode extends TerraformStack { "arn:${" + dataAwsPartitionCurrent.partition + "}:bedrock:${" + - dataAwsRegionCurrent.name + + dataAwsRegionCurrent.region + "}::foundation-model/anthropic.claude-v2", ], }, @@ -78,7 +78,7 @@ class MyConvertedCode extends TerraformStack { "arn:${" + dataAwsPartitionCurrent.partition + "}:bedrock:${" + - dataAwsRegionCurrent.name + + dataAwsRegionCurrent.region + "}:${" + current.accountId + "}:agent/*", @@ -143,6 +143,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `description` - (Optional) Description of the alias. * `routingConfiguration` - (Optional) Details about the routing configuration of the alias. See [`routingConfiguration` Block](#routing_configuration-block) for details. * `tags` - (Optional) Map of tags assigned to the resource. If configured with a provider [`defaultTags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. @@ -203,4 +204,4 @@ Using `terraform import`, import Agents for Amazon Bedrock Agent Alias using the % terraform import aws_bedrockagent_agent_alias.example 66IVY0GUTF,GGRRAED6JP ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/bedrockagent_agent_collaborator.html.markdown b/website/docs/cdktf/typescript/r/bedrockagent_agent_collaborator.html.markdown index 5ecf53d760e4..788274fe2122 100644 --- a/website/docs/cdktf/typescript/r/bedrockagent_agent_collaborator.html.markdown +++ b/website/docs/cdktf/typescript/r/bedrockagent_agent_collaborator.html.markdown @@ -53,7 +53,7 @@ class MyConvertedCode extends TerraformStack { "arn:${" + dataAwsPartitionCurrent.partition + "}:bedrock:${" + - dataAwsRegionCurrent.name + + dataAwsRegionCurrent.region + "}::foundation-model/anthropic.claude-3-5-sonnet-20241022-v2:0", ], }, @@ -63,14 +63,14 @@ class MyConvertedCode extends TerraformStack { "arn:${" + currentAgent.partition + "}:bedrock:${" + - dataAwsRegionCurrent.name + + dataAwsRegionCurrent.region + "}:${" + current.accountId + "}:agent/*", "arn:${" + currentAgent.partition + "}:bedrock:${" + - dataAwsRegionCurrent.name + + dataAwsRegionCurrent.region + "}:${" + current.accountId + "}:agent-alias/*", @@ -98,7 +98,7 @@ class MyConvertedCode extends TerraformStack { "arn:${" + dataAwsPartitionCurrent.partition + "}:bedrock:${" + - dataAwsRegionCurrent.name + + dataAwsRegionCurrent.region + "}:${" + current.accountId + "}:agent/*", @@ -188,10 +188,11 @@ The following arguments are required: * `agentId` - (Required) ID if the agent to associate the collaborator. * `collaborationInstruction` - (Required) Instruction to give the collaborator. -* `collbaorator_name` - (Required) Name of this collaborator. +* `collaboratorName` - (Required) Name of this collaborator. The following arguments are optional: +* `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). * `prepareAgent` (Optional) Whether to prepare the agent after creation or modification. Defaults to `true`. * `relayConversationHistory` - (Optional) Configure relaying the history to the collaborator. @@ -247,4 +248,4 @@ Using `terraform import`, import Bedrock Agents Agent Collaborator using a comma % terraform import aws_bedrockagent_agent_collaborator.example 9LSJO0BFI8,DRAFT,AG3TN4RQIY ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/bedrockagent_agent_knowledge_base_association.html.markdown b/website/docs/cdktf/typescript/r/bedrockagent_agent_knowledge_base_association.html.markdown index ee1e81193bd8..323c56c121fc 100644 --- a/website/docs/cdktf/typescript/r/bedrockagent_agent_knowledge_base_association.html.markdown +++ b/website/docs/cdktf/typescript/r/bedrockagent_agent_knowledge_base_association.html.markdown @@ -49,6 +49,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `agentVersion` - (Optional, Forces new resource) Version of the agent with which you want to associate the knowledge base. Valid values: `DRAFT`. ## Attribute Reference @@ -63,6 +64,7 @@ This resource exports the following attributes in addition to the arguments abov * `create` - (Default `5m`) * `update` - (Default `5m`) +* `delete` - (Default `5m`) ## Import @@ -96,4 +98,4 @@ Using `terraform import`, import Agents for Amazon Bedrock Agent Knowledge Base % terraform import aws_bedrockagent_agent_knowledge_base_association.example GGRRAED6JP,DRAFT,EMDPPAYPZI ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/bedrockagent_data_source.html.markdown b/website/docs/cdktf/typescript/r/bedrockagent_data_source.html.markdown index 0761e705171e..85ac3c921f61 100644 --- a/website/docs/cdktf/typescript/r/bedrockagent_data_source.html.markdown +++ b/website/docs/cdktf/typescript/r/bedrockagent_data_source.html.markdown @@ -57,6 +57,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `dataDeletionPolicy` - (Optional) Data deletion policy for a data source. Valid values: `RETAIN`, `DELETE`. * `description` - (Optional) Description of the data source. * `serverSideEncryptionConfiguration` - (Optional) Details about the configuration of the server-side encryption. See [`serverSideEncryptionConfiguration` block](#server_side_encryption_configuration-block) for details. @@ -363,4 +364,4 @@ Using `terraform import`, import Agents for Amazon Bedrock Data Source using the [3]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_SharePointDataSourceConfiguration.html [4]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_WebDataSourceConfiguration.html - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/bedrockagent_flow.html.markdown b/website/docs/cdktf/typescript/r/bedrockagent_flow.html.markdown new file mode 100644 index 000000000000..c1be5da333e3 --- /dev/null +++ b/website/docs/cdktf/typescript/r/bedrockagent_flow.html.markdown @@ -0,0 +1,464 @@ +--- +subcategory: "Bedrock Agents" +layout: "aws" +page_title: "AWS: aws_bedrockagent_flow" +description: |- + Terraform resource for managing an AWS Bedrock Agents Flow. +--- + + + +# Resource: aws_bedrockagent_flow + +Terraform resource for managing an AWS Bedrock Agents Flow. + +### Basic Usage + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { Token, TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { BedrockagentFlow } from "./.gen/providers/aws/bedrockagent-flow"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + new BedrockagentFlow(this, "example", { + executionRoleArn: Token.asString(awsIamRoleExample.arn), + name: "example-flow", + }); + } +} + +``` + +## Example Usage + +The default definition: + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { Token, TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { BedrockagentFlow } from "./.gen/providers/aws/bedrockagent-flow"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + new BedrockagentFlow(this, "example", { + definition: [ + { + connection: { + configuration: [ + { + data: [ + { + sourceOutput: "document", + targetInput: "topic", + }, + ], + }, + ], + name: "FlowInputNodeFlowInputNode0ToPrompt_1PromptsNode0", + source: "FlowInputNode", + target: "Prompt_1", + type: "Data", + }, + nodeAttribute: [ + { + configuration: [ + { + input: [{}], + }, + ], + name: "FlowInputNode", + output: [ + { + name: "document", + type: "String", + }, + ], + type: "Input", + }, + { + configuration: [ + { + prompt: [ + { + sourceConfiguration: [ + { + inline: [ + { + inferenceConfiguration: [ + { + text: [ + { + maxTokens: 2048, + stopSequences: ["User:"], + temperature: 0, + topP: 0.8999999761581421, + }, + ], + }, + ], + modelId: "amazon.titan-text-express-v1", + templateConfiguration: [ + { + text: [ + { + inputVariable: [ + { + name: "topic", + }, + ], + text: "Write a paragraph about {{topic}}.", + }, + ], + }, + ], + templateType: "TEXT", + }, + ], + }, + ], + }, + ], + }, + ], + input: [ + { + expression: "$.data", + name: "topic", + type: "String", + }, + ], + name: "Prompt_1", + output: [ + { + name: "modelCompletion", + type: "String", + }, + ], + type: "Prompt", + }, + { + configuration: [ + { + output: [{}], + }, + ], + input: [ + { + expression: "$.data", + name: "document", + type: "String", + }, + ], + name: "FlowOutputNode", + type: "Output", + }, + ], + }, + ], + executionRoleArn: Token.asString(awsIamRoleExample.arn), + name: "example", + }); + } +} + +``` + +## Argument Reference + +The following arguments are required: + +* `name` - (Required) A name for the flow. +* `executionRoleArn` - (Required) The Amazon Resource Name (ARN) of the service role with permissions to create and manage a flow. For more information, see [Create a service role for flows in Amazon Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/flows-permissions.html) in the Amazon Bedrock User Guide. + +The following arguments are optional: + +* `description` - (Optional) A description for the flow. +* `customerEncryptionKeyArn` - (Optional) The Amazon Resource Name (ARN) of the KMS key to encrypt the flow. +* `definition` - (Optional) A definition of the nodes and connections between nodes in the flow. See [Definition](#definition) for more information. +* `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). +* `tags` (Optional) Key-value map of resource tags. If configured with a provider [`defaultTags` 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. + +### Definition + +* `connection` - (Optional) A list of connection definitions in the flow. See [Connection](#connection) for more information. +* `node` - (Optional) A list of node definitions in the flow. See [Node](#node) for more information. + +### Connection + +* `name` - (Required) A name for the connection that you can reference. +* `source` - (Required) The node that the connection starts at. +* `target` - (Required) The node that the connection ends at. +* `type` - (Required) Whether the source node that the connection begins from is a condition node `Conditional` or not `Data`. +* `configuration` - (Required) Configuration of the connection. See [Connection Configuration](#connection-configuration) for more information. + +### Connection Configuration + +* `data` - (Optional) The configuration of a connection originating from a node that isn’t a Condition node. See [Data Connection Configuration](#data-connection-configuration) for more information. +* `conditional` - (Optional) The configuration of a connection originating from a Condition node. See [Conditional Connection Configuration](#conditional-connection-configuration) for more information. + +#### Data Connection Configuration + +* `sourceOutput` - (Required) The name of the output in the source node that the connection begins from. +* `targetInput` - (Required) The name of the input in the target node that the connection ends at. + +#### Conditional Connection Configuration + +* `condition` - (Required) The condition that triggers this connection. For more information about how to write conditions, see the Condition node type in the [Node types](https://docs.aws.amazon.com/bedrock/latest/userguide/node-types.html) topic in the Amazon Bedrock User Guide. + +### Node + +* `name` - (Required) A name for the node. +* `type` - (Required) The type of node. This value must match the name of the key that you provide in the configuration. Valid values: `Agent`, `Collector`, `Condition`, `Input`, `Iterator`, `KnowledgeBase`, `LambdaFunction`, `Lex`, `Output`, `Prompt`, `Retrieval`, `Storage` +* `configuration` - (Required) Contains configurations for the node. See [Node Configuration](#node-configuration) for more information. +* `input` - (Optional) A list of objects containing information about an input into the node. See [Node Input](#node-input) for more information. +* `output` - (Optional) A list of objects containing information about an output from the node. See [Node Output](#node-output) for more information. + +### Node Input + +* `name` - (Required) A name for the input that you can reference. +* `type` - (Required) The data type of the input. If the input doesn’t match this type at runtime, a validation error will be thrown. +* `expression` - (Required) An expression that formats the input for the node. For an explanation of how to create expressions, see [Expressions in Prompt flows in Amazon Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/flows-expressions.html). +* `category` - (Optional) How input data flows between iterations in a DoWhile loop. + +### Node Output + +* `name` - (Required) A name for the output that you can reference. +* `type` - (Required) The data type of the output. If the output doesn’t match this type at runtime, a validation error will be thrown. + +### Node Configuration + +* `agent` - (Optional) Contains configurations for an agent node in your flow. Invokes an alias of an agent and returns the response. See [Agent Node Configuration](#agent-node-configuration) for more information. +* `collector` - (Optional) Contains configurations for a collector node in your flow. Collects an iteration of inputs and consolidates them into an array of outputs. This object has no fields. +* `condition` - (Optional) Contains configurations for a Condition node in your flow. Defines conditions that lead to different branches of the flow. See [Condition Node Configuration](#condition-node-configuration) for more information. +* `inlineCode` - (Optional) Contains configurations for an inline code node in your flow. See [Inline Code Node Configuration](#inline-code-node-configuration) for more information. +* `input` - (Optional) Contains configurations for an input flow node in your flow. The node `inputs` can’t be specified for this node. This object has no fields. +* `iterator` - (Optional) Contains configurations for an iterator node in your flow. Takes an input that is an array and iteratively sends each item of the array as an output to the following node. The size of the array is also returned in the output. The output flow node at the end of the flow iteration will return a response for each member of the array. To return only one response, you can include a collector node downstream from the iterator node. This object has no fields. +* `knowledgeBase` - (Optional) Contains configurations for a knowledge base node in your flow. Queries a knowledge base and returns the retrieved results or generated response. See [Knowledge Base Node Configuration](#knowledge-base-node-configuration) for more information. +* `lambdaFunction` - (Optional) Contains configurations for a Lambda function node in your flow. Invokes a Lambda function. See [Lambda Function Node Configuration](#lambda-function-node-configuration) for more information. +* `lex` - (Optional) Contains configurations for a Lex node in your flow. Invokes an Amazon Lex bot to identify the intent of the input and return the intent as the output. See [Lex Node Configuration](#lex-node-configuration) for more information. +* `output` - (Optional) Contains configurations for an output flow node in your flow. The node `outputs` can’t be specified for this node. This object has no fields. +* `prompt` - (Optional) Contains configurations for a prompt node in your flow. Runs a prompt and generates the model response as the output. You can use a prompt from Prompt management or you can configure one in this node. See [Prompt Node Configuration](#prompt-node-configuration) for more information. +* `retrieval` - (Optional) Contains configurations for a Retrieval node in your flow. Retrieves data from an Amazon S3 location and returns it as the output. See [Retrieval Node Configuration](#retrieval-node-configuration) for more information. +* `storage` - (Optional) Contains configurations for a Storage node in your flow. Stores an input in an Amazon S3 location. See [Storage Node Configuration](#storage-node-configuration) for more information. + +### Agent Node Configuration + +* `agentAliasArn` - (Required) The Amazon Resource Name (ARN) of the alias of the agent to invoke. + +### Condition Node Configuration + +* `condition` - (Optional) A list of conditions. See [Condition Config](#condition-config) for more information. + +#### Condition Config + +* `name` - (Required) A name for the condition that you can reference. +* `expression` - (Optional) Defines the condition. You must refer to at least one of the inputs in the condition. For more information, expand the Condition node section in [Node types in prompt flows](https://docs.aws.amazon.com/bedrock/latest/userguide/flows-how-it-works.html#flows-nodes). + +### Inline Code Node Configuration + +* `code` - (Required) The code that's executed in your inline code node. +* `language` - (Required) The programming language used by your inline code node. + +### Knowledge Base Node Configuration + +* `knowledgeBaseId` - (Required) The unique identifier of the knowledge base to query. +* `modelId` - (Required) The unique identifier of the model or inference profile to use to generate a response from the query results. Omit this field if you want to return the retrieved results as an array. +* `guardrailConfiguration` - (Required) Contains configurations for a guardrail to apply during query and response generation for the knowledge base in this configuration. See [Guardrail Configuration](#guardrail-configuration) for more information. + +#### Guardrail Configuration + +* `guardrailIdentifier` - (Required) The unique identifier of the guardrail. +* `guardrailVersion` - (Required) The version of the guardrail. + +### Lambda Function Node Configuration + +* `lambdaArn` - (Required) The Amazon Resource Name (ARN) of the Lambda function to invoke. + +### Lex Node Configuration + +* `botAliasArn` - (Required) The Amazon Resource Name (ARN) of the Amazon Lex bot alias to invoke. +* `localeId` - (Required) The Region to invoke the Amazon Lex bot in + +### Prompt Node Configuration + +* `resource` - (Optional) Contains configurations for a prompt from Prompt management. See [Prompt Resource Configuration](#prompt-resource-configuration) for more information. +* `inline` - (Optional) Contains configurations for a prompt that is defined inline. See [Prompt Inline Configuration](#prompt-inline-configuration) for more information. + +#### Prompt Resource Configuration + +* `prompt_arn` - (Required) The Amazon Resource Name (ARN) of the prompt from Prompt management. + +#### Prompt Inline Configuration + +* `additionalModelRequestFields` - (Optional) Additional fields to be included in the model request for the Prompt node. +* `inferenceConfiguration` - (Optional) Contains inference configurations for the prompt. See [Prompt Inference Configuration](#prompt-inference-configuration) for more information. +* `modelId` - (Required) The unique identifier of the model or [inference profile](https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference.html) to run inference with. +* `templateType` - (Required) The type of prompt template. Valid values: `TEXT`, `CHAT`. +* `templateConfiguration` - (Required) Contains a prompt and variables in the prompt that can be replaced with values at runtime. See [Prompt Template Configuration](#prompt-template-configuration) for more information. + +#### Prompt Inference Configuration + +* `text` - (Optional) Contains inference configurations for a text prompt. See [Text Inference Configuration](#text-inference-configuration) for more information. + +#### Text Inference Configuration + +* `maxTokens` - (Optional) Maximum number of tokens to return in the response. +* `stopSequences` - (Optional) List of strings that define sequences after which the model will stop generating. +* `temperature` - (Optional) Controls the randomness of the response. Choose a lower value for more predictable outputs and a higher value for more surprising outputs. +* `topP` - (Optional) Percentage of most-likely candidates that the model considers for the next token. + +#### Prompt Template Configuration + +* `text` - (Optional) Contains configurations for the text in a message for a prompt. See [Text Template Configuration](#text-template-configuration) +* `chat` - (Optional) Contains configurations to use the prompt in a conversational format. See [Chat Template Configuration](#chat-template-configuration) for more information. + +#### Text Template Configuration + +* `text` - (Required) The message for the prompt. +* `inputVariable` - (Optional) A list of variables in the prompt template. See [Input Variable](#input-variable) for more information. +* `cachePoint` - (Optional) A cache checkpoint within a template configuration. See [Cache Point](#cache-point) for more information. + +#### Chat Template Configuration + +* `inputVariable` - (Optional) A list of variables in the prompt template. See [Input Variable](#input-variable) for more information. +* `message` - (Optional) A list of messages in the chat for the prompt. See [Message](#message) for more information. +* `system` - (Optional) A list of system prompts to provide context to the model or to describe how it should behave. See [System](#system) for more information. +* `toolConfiguration` - (Optional) Configuration information for the tools that the model can use when generating a response. See [Tool Configuration](#tool-configuration) for more information. + +#### Message + +* `role` - (Required) The role that the message belongs to. +* `content` - (Required) Contains the content for the message you pass to, or receive from a model. See [Message Content] for more information. + +#### Message Content + +* `cachePoint` - (Optional) Creates a cache checkpoint within a message. See [Cache Point](#cache-point) for more information. +* `text` - (Optional) The text in the message. + +#### System + +* `cachePoint` - (Optional) Creates a cache checkpoint within a tool designation. See [Cache Point](#cache-point) for more information. +* `text` - (Optional) The text in the system prompt. + +#### Tool Configuration + +* `toolChoice` - (Optional) Defines which tools the model should request when invoked. See [Tool Choice](#tool-choice) for more information. +* `tool` - (Optional) A list of tools to pass to a model. See [Tool](#tool) for more information. + +#### Tool Choice + +* `any` - (Optional) Defines tools, at least one of which must be requested by the model. No text is generated but the results of tool use are sent back to the model to help generate a response. This object has no fields. +* `auto` - (Optional) Defines tools. The model automatically decides whether to call a tool or to generate text instead. This object has no fields. +* `tool` - (Optional) Defines a specific tool that the model must request. No text is generated but the results of tool use are sent back to the model to help generate a response. See [Named Tool](#named-tool) for more information. + +#### Named Tool + +* `name` - (Required) The name of the tool. + +#### Tool + +* `cachePoint` - (Optional) Creates a cache checkpoint within a tool designation. See [Cache Point](#cache-point) for more information. +* `toolSpec` - (Optional) The specification for the tool. See [Tool Specification](#tool-specification) for more information. + +#### Tool Specification + +* `name` - (Required) The name of the tool. +* `description` - (Optional) The description of the tool. +* `inputSchema` - (Optional) The input schema of the tool. See [Tool Input Schema](#tool-input-schema) for more information. + +#### Tool Input Schema + +* `json` - (Optional) A JSON object defining the input schema for the tool. + +#### Input Variable + +* `name` - (Required) The name of the variable. + +#### Cache Point + +* `type` - (Required) Indicates that the CachePointBlock is of the default type. Valid values: `default`. + +### Retrieval Node Configuration + +* `serviceConfiguration` - (Required) Contains configurations for the service to use for retrieving data to return as the output from the node. See [Retrieval Service Configuration](#retrieval-service-configuration) for more information. + +#### Retrieval Service Configuration + +* `s3` - (Optional) Contains configurations for the Amazon S3 location from which to retrieve data to return as the output from the node. See [Retrieval S3 Service Configuration](#retrieval-s3-service-configuration) for more information. + +#### Retrieval S3 Service Configuration + +* `bucketName` - (Required) The name of the Amazon S3 bucket from which to retrieve data. + +### Storage Node Configuration + +* `serviceConfiguration` - (Required) Contains configurations for a Storage node in your flow. Stores an input in an Amazon S3 location. See [Storage Service Configuration](#storage-service-configuration) for more information. + +#### Storage Service Configuration + +* `s3` - (Optional) Contains configurations for the service to use for storing the input into the node. See [Storage S3 Service Configuration](#storage-s3-service-configuration) for more information. + +#### Storage S3 Service Configuration + +* `bucketName` - (Required) The name of the Amazon S3 bucket in which to store the input into the node. + +## Attribute Reference + +This resource exports the following attributes in addition to the arguments above: + +* `arn` - The Amazon Resource Name (ARN) of the flow. +* `id` - The unique identifier of the flow. +* `createdAt` - The time at which the flow was created. +* `updatedAt` - The time at which the flow was last updated. +* `version` - The version of the flow. +* `status` - The status of the flow. +* `tagsAll` - A map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). + +## Timeouts + +[Configuration options](https://developer.hashicorp.com/terraform/language/resources/syntax#operation-timeouts): + +* `create` - (Default `5m`) +* `update` - (Default `5m`) +* `delete` - (Default `5m`) + +## Import + +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import Bedrock Agents Flow using the `id`. For example: + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { BedrockagentFlow } from "./.gen/providers/aws/bedrockagent-flow"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + BedrockagentFlow.generateConfigForImport(this, "example", "ABCDEFGHIJ"); + } +} + +``` + +Using `terraform import`, import Bedrock Agents Flow using the `id`. For example: + +```console +% terraform import aws_bedrockagent_flow.example ABCDEFGHIJ +``` + + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/bedrockagent_knowledge_base.html.markdown b/website/docs/cdktf/typescript/r/bedrockagent_knowledge_base.html.markdown index 2449c332162a..6b687c69aae4 100644 --- a/website/docs/cdktf/typescript/r/bedrockagent_knowledge_base.html.markdown +++ b/website/docs/cdktf/typescript/r/bedrockagent_knowledge_base.html.markdown @@ -89,21 +89,21 @@ class MyConvertedCode extends TerraformStack { { embeddingModelArn: "arn:aws:bedrock:us-west-2::foundation-model/amazon.titan-embed-text-v2:0", - embedding_model_configuration: [ + embeddingModelConfiguration: [ { - bedrock_embedding_model_configuration: [ + bedrockEmbeddingModelConfiguration: [ { dimensions: 1024, - embedding_data_type: "FLOAT32", + embeddingDataType: "FLOAT32", }, ], }, ], - supplemental_data_storage_configuration: [ + supplementalDataStorageConfiguration: [ { - storage_location: [ + storageLocation: [ { - s3_location: [ + s3Location: [ { uri: "s3://my-bucket/chunk-processor/", }, @@ -155,6 +155,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `description` - (Optional) Description of the knowledge base. * `tags` - (Optional) Map of tags assigned to the resource. If configured with a provider [`defaultTags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. @@ -170,25 +171,25 @@ The `knowledgeBaseConfiguration` configuration block supports the following argu The `vectorKnowledgeBaseConfiguration` configuration block supports the following arguments: * `embeddingModelArn` - (Required) ARN of the model used to create vector embeddings for the knowledge base. -* `embedding_model_configuration` - (Optional) The embeddings model configuration details for the vector model used in Knowledge Base. See [`embedding_model_configuration` block](#embedding_model_configuration-block) for details. -* `supplemental_data_storage_configuration` - (Optional) supplemental_data_storage_configuration. See [`supplemental_data_storage_configuration` block](#supplemental_data_storage_configuration-block) for details. +* `embeddingModelConfiguration` - (Optional) The embeddings model configuration details for the vector model used in Knowledge Base. See [`embeddingModelConfiguration` block](#embedding_model_configuration-block) for details. +* `supplementalDataStorageConfiguration` - (Optional) supplemental_data_storage_configuration. See [`supplementalDataStorageConfiguration` block](#supplemental_data_storage_configuration-block) for details. -### `embedding_model_configuration` block +### `embeddingModelConfiguration` block -The `embedding_model_configuration` configuration block supports the following arguments: +The `embeddingModelConfiguration` configuration block supports the following arguments: -* `bedrock_embedding_model_configuration` - (Optional) The vector configuration details on the Bedrock embeddings model. See [`bedrock_embedding_model_configuration` block](#bedrock_embedding_model_configuration-block) for details. +* `bedrockEmbeddingModelConfiguration` - (Optional) The vector configuration details on the Bedrock embeddings model. See [`bedrockEmbeddingModelConfiguration` block](#bedrock_embedding_model_configuration-block) for details. -### `bedrock_embedding_model_configuration` block +### `bedrockEmbeddingModelConfiguration` block -The `bedrock_embedding_model_configuration` configuration block supports the following arguments: +The `bedrockEmbeddingModelConfiguration` configuration block supports the following arguments: * `dimensions` - (Optional) Dimension details for the vector configuration used on the Bedrock embeddings model. -* `embedding_data_type` - (Optional) Data type for the vectors when using a model to convert text into vector embeddings. The model must support the specified data type for vector embeddings. Valid values are `FLOAT32` and `BINARY`. +* `embeddingDataType` - (Optional) Data type for the vectors when using a model to convert text into vector embeddings. The model must support the specified data type for vector embeddings. Valid values are `FLOAT32` and `BINARY`. -### `supplemental_data_storage_configuration` block +### `supplementalDataStorageConfiguration` block -The `supplemental_data_storage_configuration` configuration block supports the following arguments: +The `supplementalDataStorageConfiguration` configuration block supports the following arguments: * `storageLocation` - (Required) A storage location specification for images extracted from multimodal documents in your data source. See [`storageLocation` block](#storage_location-block) for details. @@ -313,4 +314,4 @@ Using `terraform import`, import Agents for Amazon Bedrock Knowledge Base using % terraform import aws_bedrockagent_knowledge_base.example EMDPPAYPZI ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/bedrockagent_prompt.html.markdown b/website/docs/cdktf/typescript/r/bedrockagent_prompt.html.markdown index 77337370d6c0..42aa10e136d2 100644 --- a/website/docs/cdktf/typescript/r/bedrockagent_prompt.html.markdown +++ b/website/docs/cdktf/typescript/r/bedrockagent_prompt.html.markdown @@ -101,6 +101,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `description` - (Optional) Description of the prompt. * `defaultVariant` - (Optional) Name of the default variant for your prompt. * `customerEncryptionKeyArn` - (Optional) Amazon Resource Name (ARN) of the KMS key that you encrypted the prompt with. @@ -252,4 +253,4 @@ Using `terraform import`, import Bedrock Agents Prompt using the `id`. For examp % terraform import aws_bedrockagent_prompt.example 1A2BC3DEFG ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/chatbot_slack_channel_configuration.html.markdown b/website/docs/cdktf/typescript/r/chatbot_slack_channel_configuration.html.markdown index 00c57f50bcfd..1b25b532ace3 100644 --- a/website/docs/cdktf/typescript/r/chatbot_slack_channel_configuration.html.markdown +++ b/website/docs/cdktf/typescript/r/chatbot_slack_channel_configuration.html.markdown @@ -53,6 +53,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `guardrailPolicyArns` - (Optional) List of IAM policy ARNs that are applied as channel guardrails. The AWS managed `AdministratorAccess` policy is applied by default if this is not set. * `loggingLevel` - (Optional) Logging levels include `ERROR`, `INFO`, or `NONE`. * `snsTopicArns` - (Optional) ARNs of the SNS topics that deliver notifications to AWS Chatbot. @@ -108,4 +109,4 @@ Using `terraform import`, import Chatbot Slack Channel Configuration using the ` % terraform import aws_chatbot_slack_channel_configuration.example arn:aws:chatbot::123456789012:chat-configuration/slack-channel/min-slaka-kanal ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/chatbot_teams_channel_configuration.html.markdown b/website/docs/cdktf/typescript/r/chatbot_teams_channel_configuration.html.markdown index a711c47851d9..c8432d20e366 100644 --- a/website/docs/cdktf/typescript/r/chatbot_teams_channel_configuration.html.markdown +++ b/website/docs/cdktf/typescript/r/chatbot_teams_channel_configuration.html.markdown @@ -57,6 +57,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `channelName` - (Optional) Name of the Microsoft Teams channel. * `guardrailPolicyArns` - (Optional) List of IAM policy ARNs that are applied as channel guardrails. The AWS managed `AdministratorAccess` policy is applied by default if this is not set. * `loggingLevel` - (Optional) Logging levels include `ERROR`, `INFO`, or `NONE`. @@ -112,4 +113,4 @@ Using `terraform import`, import Chatbot Microsoft Teams Channel Configuration u % terraform import aws_chatbot_teams_channel_configuration.example 5f4f15d2-b958-522a-8333-124aa8bf0925 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/chime_voice_connector.html.markdown b/website/docs/cdktf/typescript/r/chime_voice_connector.html.markdown index fcabaa2f3c19..25c0bac4b8fb 100644 --- a/website/docs/cdktf/typescript/r/chime_voice_connector.html.markdown +++ b/website/docs/cdktf/typescript/r/chime_voice_connector.html.markdown @@ -45,6 +45,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `awsRegion` - (Optional) The AWS Region in which the Amazon Chime Voice Connector is created. Default value: `us-east-1` * `tags` - (Optional) Key-value mapping of resource tags. If configured with a provider [`defaultTags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. @@ -84,4 +85,4 @@ Using `terraform import`, import Configuration Recorder using the name. For exam % terraform import aws_chime_voice_connector.test example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/chime_voice_connector_group.html.markdown b/website/docs/cdktf/typescript/r/chime_voice_connector_group.html.markdown index b9031ec22ca6..52e76107bfb8 100644 --- a/website/docs/cdktf/typescript/r/chime_voice_connector_group.html.markdown +++ b/website/docs/cdktf/typescript/r/chime_voice_connector_group.html.markdown @@ -61,6 +61,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) The name of the Amazon Chime Voice Connector group. * `connector` - (Optional) The Amazon Chime Voice Connectors to route inbound calls to. @@ -109,4 +110,4 @@ Using `terraform import`, import Configuration Recorder using the name. For exam % terraform import aws_chime_voice_connector_group.default example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/chime_voice_connector_logging.html.markdown b/website/docs/cdktf/typescript/r/chime_voice_connector_logging.html.markdown index 893abdf2ec6c..b2a22f2240ee 100644 --- a/website/docs/cdktf/typescript/r/chime_voice_connector_logging.html.markdown +++ b/website/docs/cdktf/typescript/r/chime_voice_connector_logging.html.markdown @@ -51,6 +51,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `voiceConnectorId` - (Required) The Amazon Chime Voice Connector ID. * `enableSipLogs` - (Optional) When true, enables SIP message logs for sending to Amazon CloudWatch Logs. * `enableMediaMetricLogs` - (Optional) When true, enables logging of detailed media metrics for Voice Connectors to Amazon CloudWatch logs. @@ -93,4 +94,4 @@ Using `terraform import`, import Chime Voice Connector Logging using the `voiceC % terraform import aws_chime_voice_connector_logging.default abcdef1ghij2klmno3pqr4 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/chime_voice_connector_origination.html.markdown b/website/docs/cdktf/typescript/r/chime_voice_connector_origination.html.markdown index 1ccc168cdac1..f23caf440ae9 100644 --- a/website/docs/cdktf/typescript/r/chime_voice_connector_origination.html.markdown +++ b/website/docs/cdktf/typescript/r/chime_voice_connector_origination.html.markdown @@ -63,6 +63,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `voiceConnectorId` - (Required) The Amazon Chime Voice Connector ID. * `route` - (Required) Set of call distribution properties defined for your SIP hosts. See [route](#route) below for more details. Minimum of 1. Maximum of 20. * `disabled` - (Optional) When origination settings are disabled, inbound calls are not enabled for your Amazon Chime Voice Connector. @@ -115,4 +116,4 @@ Using `terraform import`, import Chime Voice Connector Origination using the `vo % terraform import aws_chime_voice_connector_origination.default abcdef1ghij2klmno3pqr4 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/chime_voice_connector_streaming.html.markdown b/website/docs/cdktf/typescript/r/chime_voice_connector_streaming.html.markdown index ca4dabfbf0cc..3d01fc9d489f 100644 --- a/website/docs/cdktf/typescript/r/chime_voice_connector_streaming.html.markdown +++ b/website/docs/cdktf/typescript/r/chime_voice_connector_streaming.html.markdown @@ -144,6 +144,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `voiceConnectorId` - (Required) The Amazon Chime Voice Connector ID. * `dataRetention` - (Required) The retention period, in hours, for the Amazon Kinesis data. * `disabled` - (Optional) When true, media streaming to Amazon Kinesis is turned off. Default: `false` @@ -193,4 +194,4 @@ Using `terraform import`, import Chime Voice Connector Streaming using the `voic % terraform import aws_chime_voice_connector_streaming.default abcdef1ghij2klmno3pqr4 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/chime_voice_connector_termination.html.markdown b/website/docs/cdktf/typescript/r/chime_voice_connector_termination.html.markdown index 007227c03370..af778402b9c9 100644 --- a/website/docs/cdktf/typescript/r/chime_voice_connector_termination.html.markdown +++ b/website/docs/cdktf/typescript/r/chime_voice_connector_termination.html.markdown @@ -50,6 +50,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `voiceConnectorId` - (Required) The Amazon Chime Voice Connector ID. * `cidrAllowList` - (Required) The IP addresses allowed to make calls, in CIDR format. * `callingRegions` - (Required) The countries to which calls are allowed, in ISO 3166-1 alpha-2 format. @@ -95,4 +96,4 @@ Using `terraform import`, import Chime Voice Connector Termination using the `vo % terraform import aws_chime_voice_connector_termination.default abcdef1ghij2klmno3pqr4 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/chime_voice_connector_termination_credentials.html.markdown b/website/docs/cdktf/typescript/r/chime_voice_connector_termination_credentials.html.markdown index f002a94cc78d..53637923bac0 100644 --- a/website/docs/cdktf/typescript/r/chime_voice_connector_termination_credentials.html.markdown +++ b/website/docs/cdktf/typescript/r/chime_voice_connector_termination_credentials.html.markdown @@ -68,6 +68,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `voiceConnectorId` - (Required) Amazon Chime Voice Connector ID. * `credentials` - (Required) List of termination SIP credentials. @@ -116,4 +117,4 @@ Using `terraform import`, import Chime Voice Connector Termination Credentials u % terraform import aws_chime_voice_connector_termination_credentials.default abcdef1ghij2klmno3pqr4 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/chimesdkmediapipelines_media_insights_pipeline_configuration.html.markdown b/website/docs/cdktf/typescript/r/chimesdkmediapipelines_media_insights_pipeline_configuration.html.markdown index c92c2fc9d1cb..4c3ccb6bf61d 100644 --- a/website/docs/cdktf/typescript/r/chimesdkmediapipelines_media_insights_pipeline_configuration.html.markdown +++ b/website/docs/cdktf/typescript/r/chimesdkmediapipelines_media_insights_pipeline_configuration.html.markdown @@ -391,6 +391,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) Configuration name. * `resourceAccessRoleArn` - (Required) ARN of IAM Role used by service to invoke processors and sinks specified by configuration elements. * `elements` - (Required) Collection of processors and sinks to transform media and deliver data. @@ -508,4 +509,4 @@ Using `terraform import`, import Chime SDK Media Pipelines Media Insights Pipeli % terraform import aws_chimesdkmediapipelines_media_insights_pipeline_configuration.example abcdef123456 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/chimesdkvoice_sip_media_application.html.markdown b/website/docs/cdktf/typescript/r/chimesdkvoice_sip_media_application.html.markdown index d534c8cdd411..8640822c55b4 100644 --- a/website/docs/cdktf/typescript/r/chimesdkvoice_sip_media_application.html.markdown +++ b/website/docs/cdktf/typescript/r/chimesdkvoice_sip_media_application.html.markdown @@ -50,6 +50,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `tags` - (Optional) Key-value mapping of resource tags. If configured with a provider [`defaultTags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. ### `endpoints` @@ -98,4 +99,4 @@ Using `terraform import`, import a ChimeSDKVoice SIP Media Application using the % terraform import aws_chimesdkvoice_sip_media_application.example abcdef123456 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/chimesdkvoice_sip_rule.html.markdown b/website/docs/cdktf/typescript/r/chimesdkvoice_sip_rule.html.markdown index b9d878d79c4e..ff8eab4c0644 100644 --- a/website/docs/cdktf/typescript/r/chimesdkvoice_sip_rule.html.markdown +++ b/website/docs/cdktf/typescript/r/chimesdkvoice_sip_rule.html.markdown @@ -55,6 +55,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `disabled` - (Optional) Enables or disables a rule. You must disable rules before you can delete them. ### `targetApplications` @@ -103,4 +104,4 @@ Using `terraform import`, import a ChimeSDKVoice SIP Rule using the `id`. For ex % terraform import aws_chimesdkvoice_sip_rule.example abcdef123456 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/chimesdkvoice_voice_profile_domain.html.markdown b/website/docs/cdktf/typescript/r/chimesdkvoice_voice_profile_domain.html.markdown index fbbeea953f27..7e739193eb3f 100644 --- a/website/docs/cdktf/typescript/r/chimesdkvoice_voice_profile_domain.html.markdown +++ b/website/docs/cdktf/typescript/r/chimesdkvoice_voice_profile_domain.html.markdown @@ -61,6 +61,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `description` - (Optional) Description of Voice Profile Domain. ## Attribute Reference @@ -110,4 +111,4 @@ Using `terraform import`, import AWS Chime SDK Voice Profile Domain using the `i % terraform import aws_chimesdkvoice_voice_profile_domain.example abcdef123456 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/cleanrooms_collaboration.html.markdown b/website/docs/cdktf/typescript/r/cleanrooms_collaboration.html.markdown index 14a5352d265c..e2e0a5eca833 100644 --- a/website/docs/cdktf/typescript/r/cleanrooms_collaboration.html.markdown +++ b/website/docs/cdktf/typescript/r/cleanrooms_collaboration.html.markdown @@ -10,13 +10,11 @@ description: |- # Resource: aws_cleanrooms_collaboration -Provides a AWS Clean Rooms collaboration. All members included in the definition will be invited to -join the collaboration and can create memberships. +Provides a AWS Clean Rooms collaboration. +All members included in the definition will be invited to join the collaboration and can create memberships. ## Example Usage -### Collaboration with tags - ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug import { Construct } from "constructs"; @@ -33,6 +31,7 @@ class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string, config: MyConfig) { super(scope, name); new CleanroomsCollaboration(this, "test_collaboration", { + analyticsEngine: "SPARK", creatorDisplayName: "Creator ", creatorMemberAbilities: ["CAN_QUERY", "CAN_RECEIVE_RESULTS"], dataEncryptionMetadata: { @@ -62,7 +61,7 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -This resource supports the following arguments: +The following arguments are required: * `name` - (Required) - The name of the collaboration. Collaboration names do not need to be unique. * `description` - (Required) - A description for a collaboration. @@ -70,6 +69,10 @@ This resource supports the following arguments: * `creatorDisplayName` - (Required - Forces new resource) - The name for the member record for the collaboration creator. * `queryLogStatus` - (Required - Forces new resource) - Determines if members of the collaboration can enable query logs within their own. emberships. Valid values [may be found here](https://docs.aws.amazon.com/clean-rooms/latest/apireference/API_CreateCollaboration.html#API-CreateCollaboration-request-queryLogStatus). + +The following arguments are optional: + +* `analyticsEngine` - (Optional) Analytics engine used by the collaboration. Valid values are `CLEAN_ROOMS_SQL` (deprecated) and `SPARK`. * `dataEncryptionMetadata` - (Required - Forces new resource) - a collection of settings which determine how the [c3r client](https://docs.aws.amazon.com/clean-rooms/latest/userguide/crypto-computing.html) will encrypt data for use within this collaboration. * `data_encryption_metadata.allow_clear_text` - (Required - Forces new resource) - Indicates whether encrypted tables can contain cleartext data. This is a boolea field. @@ -83,17 +86,18 @@ or cryptographically processed (false). * `member.account_id` - (Required - Forces new resource) - The account id for the invited member. * `member.display_name` - (Required - Forces new resource) - The display name for the invited member. * `member.member_abilities` - (Required - Forces new resource) - The list of abilities for the invited member. Valid values [may be found here](https://docs.aws.amazon.com/clean-rooms/latest/apireference/API_CreateCollaboration.html#API-CreateCollaboration-request-creatorMemberAbilities). +* `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). * `tags` - (Optional) - Key value pairs which tag the collaboration. ## Attribute Reference This resource exports the following attributes in addition to the arguments above: -* `arn` - The arn of the collaboration. -* `id` - The id of the collaboration. -* `createTime` - The date and time the collaboration was created. +* `arn` - ARN of the collaboration. +* `id` - ID of the collaboration. +* `createTime` - Date and time the collaboration was created. * `member status` - For each member included in the collaboration an additional computed attribute of status is added. These values [may be found here](https://docs.aws.amazon.com/clean-rooms/latest/apireference/API_MemberSummary.html#API-Type-MemberSummary-status). -* `updatedTime` - The date and time the collaboration was last updated. +* `updatedTime` - Date and time the collaboration was last updated. ## Timeouts @@ -135,4 +139,4 @@ Using `terraform import`, import `aws_cleanrooms_collaboration` using the `id`. % terraform import aws_cleanrooms_collaboration.collaboration 1234abcd-12ab-34cd-56ef-1234567890ab ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/cleanrooms_configured_table.html.markdown b/website/docs/cdktf/typescript/r/cleanrooms_configured_table.html.markdown index 5e861e9003db..33b82dc203a1 100644 --- a/website/docs/cdktf/typescript/r/cleanrooms_configured_table.html.markdown +++ b/website/docs/cdktf/typescript/r/cleanrooms_configured_table.html.markdown @@ -50,6 +50,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) - The name of the configured table. * `description` - (Optional) - A description for the configured table. * `analysisMethod` - (Required) - The analysis method for the configured table. The only valid value is currently `DIRECT_QUERY`. @@ -108,4 +109,4 @@ Using `terraform import`, import `aws_cleanrooms_configured_table` using the `id % terraform import aws_cleanrooms_configured_table.table 1234abcd-12ab-34cd-56ef-1234567890ab ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/cleanrooms_membership.html.markdown b/website/docs/cdktf/typescript/r/cleanrooms_membership.html.markdown index db5ee069d245..40e92be84900 100644 --- a/website/docs/cdktf/typescript/r/cleanrooms_membership.html.markdown +++ b/website/docs/cdktf/typescript/r/cleanrooms_membership.html.markdown @@ -24,29 +24,29 @@ import { TerraformStack } from "cdktf"; * Provider bindings are generated by running `cdktf get`. * See https://cdk.tf/provider-generation for more details. */ -import { CleanroomsMembership } from "./.gen/providers/aws/"; +import { CleanroomsMembership } from "./.gen/providers/aws/cleanrooms-membership"; class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); new CleanroomsMembership(this, "test_membership", { - collaboration_id: "1234abcd-12ab-34cd-56ef-1234567890ab", - default_result_configuration: [ + collaborationId: "1234abcd-12ab-34cd-56ef-1234567890ab", + defaultResultConfiguration: [ { - output_configuration: [ + outputConfiguration: [ { s3: [ { bucket: "test-bucket", - key_prefix: "test-prefix", - result_format: "PARQUET", + keyPrefix: "test-prefix", + resultFormat: "PARQUET", }, ], }, ], - role_arn: "arn:aws:iam::123456789012:role/role-name", + roleArn: "arn:aws:iam::123456789012:role/role-name", }, ], - query_log_status: "DISABLED", + queryLogStatus: "DISABLED", tags: { Project: "Terraform", }, @@ -60,9 +60,10 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: -* `collaboration_id` - (Required - Forces new resource) - The ID of the collaboration to which the member was invited. +* `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). +* `collaborationId` - (Required - Forces new resource) - The ID of the collaboration to which the member was invited. * `queryLogStatus` - (Required) - An indicator as to whether query logging has been enabled or disabled for the membership. -* `default_result_configuration` - (Optional) - The default configuration for a query result. +* `defaultResultConfiguration` - (Optional) - The default configuration for a query result. - `roleArn` - (Optional) - The ARN of the IAM role which will be used to create the membership. - `output_configuration.s3.bucket` - (Required) - The name of the S3 bucket where the query results will be stored. - `output_configuration.s3.result_format` - (Required) - The format of the query results. Valid values are `PARQUET` and `CSV`. @@ -74,11 +75,11 @@ This resource supports the following arguments: This resource exports the following attributes in addition to the arguments above: * `arn` - The ARN of the membership. -* `collaboration_arn` - The ARN of the joined collaboration. -* `collaboration_creator_account_id` - The account ID of the collaboration's creator. -* `collaboration_creator_display_name` - The display name of the collaboration's creator. -* `collaboration_id` - The ID of the joined collaboration. -* `collaboration_name` - The name of the joined collaboration. +* `collaborationArn` - The ARN of the joined collaboration. +* `collaborationCreatorAccountId` - The account ID of the collaboration's creator. +* `collaborationCreatorDisplayName` - The display name of the collaboration's creator. +* `collaborationId` - The ID of the joined collaboration. +* `collaborationName` - The name of the joined collaboration. * `createTime` - The date and time the membership was created. * `id` - The ID of the membership. * `memberAbilities` - The list of abilities for the invited member. @@ -98,7 +99,7 @@ import { TerraformStack } from "cdktf"; * Provider bindings are generated by running `cdktf get`. * See https://cdk.tf/provider-generation for more details. */ -import { CleanroomsMembership } from "./.gen/providers/aws/"; +import { CleanroomsMembership } from "./.gen/providers/aws/cleanrooms-membership"; class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); @@ -118,4 +119,4 @@ Using `terraform import`, import `aws_cleanrooms_membership` using the `id`. For % terraform import aws_cleanrooms_membership.membership 1234abcd-12ab-34cd-56ef-1234567890ab ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/cloud9_environment_ec2.html.markdown b/website/docs/cdktf/typescript/r/cloud9_environment_ec2.html.markdown index 7f89cb91ebea..4790a1c571a8 100644 --- a/website/docs/cdktf/typescript/r/cloud9_environment_ec2.html.markdown +++ b/website/docs/cdktf/typescript/r/cloud9_environment_ec2.html.markdown @@ -132,6 +132,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) The name of the environment. * `instanceType` - (Required) The type of instance to connect to the environment, e.g., `t2.micro`. * `imageId` - (Required) The identifier for the Amazon Machine Image (AMI) that's used to create the EC2 instance. Valid values are @@ -159,4 +160,4 @@ This resource exports the following attributes in addition to the arguments abov * `tagsAll` - A map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). * `type` - The type of the environment (e.g., `ssh` or `ec2`). - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/cloud9_environment_membership.html.markdown b/website/docs/cdktf/typescript/r/cloud9_environment_membership.html.markdown index e3b8148440bd..70110046db47 100644 --- a/website/docs/cdktf/typescript/r/cloud9_environment_membership.html.markdown +++ b/website/docs/cdktf/typescript/r/cloud9_environment_membership.html.markdown @@ -61,6 +61,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `environmentId` - (Required) The ID of the environment that contains the environment member you want to add. * `permissions` - (Required) The type of environment member permissions you want to associate with this environment member. Allowed values are `read-only` and `read-write` . * `userArn` - (Required) The Amazon Resource Name (ARN) of the environment member you want to add. @@ -104,4 +105,4 @@ Using `terraform import`, import Cloud9 environment membership using the `enviro % terraform import aws_cloud9_environment_membership.test environment-id#user-arn ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/cloudcontrolapi_resource.html.markdown b/website/docs/cdktf/typescript/r/cloudcontrolapi_resource.html.markdown index 7d3d9ca22dc1..3c634632a198 100644 --- a/website/docs/cdktf/typescript/r/cloudcontrolapi_resource.html.markdown +++ b/website/docs/cdktf/typescript/r/cloudcontrolapi_resource.html.markdown @@ -54,6 +54,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `roleArn` - (Optional) Amazon Resource Name (ARN) of the IAM Role to assume for operations. * `schema` - (Optional) JSON string of the CloudFormation resource type schema which is used for plan time validation where possible. Automatically fetched if not provided. In large scale environments with multiple resources using the same `typeName`, it is recommended to fetch the schema once via the [`aws_cloudformation_type` data source](/docs/providers/aws/d/cloudformation_type.html) and use this argument to reduce `DescribeType` API operation throttling. This value is marked sensitive only to prevent large plan differences from showing. * `typeVersionId` - (Optional) Identifier of the CloudFormation resource type version. @@ -64,4 +65,4 @@ This resource exports the following attributes in addition to the arguments abov * `properties` - JSON string matching the CloudFormation resource type schema with current configuration. Underlying attributes can be referenced via the [`jsondecode()` function](https://www.terraform.io/docs/language/functions/jsondecode.html), for example, `jsondecode(data.aws_cloudcontrolapi_resource.example.properties)["example"]`. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/cloudformation_stack.html.markdown b/website/docs/cdktf/typescript/r/cloudformation_stack.html.markdown index fb1f62e3dc10..31b4fb8726fa 100644 --- a/website/docs/cdktf/typescript/r/cloudformation_stack.html.markdown +++ b/website/docs/cdktf/typescript/r/cloudformation_stack.html.markdown @@ -69,6 +69,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) Stack name. * `templateBody` - (Optional) Structure containing the template body (max size: 51,200 bytes). * `templateUrl` - (Optional) Location of a file containing the template body (max size: 460,800 bytes). @@ -136,4 +137,4 @@ Using `terraform import`, import Cloudformation Stacks using the `name`. For exa % terraform import aws_cloudformation_stack.stack networking-stack ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/cloudformation_stack_instances.html.markdown b/website/docs/cdktf/typescript/r/cloudformation_stack_instances.html.markdown index a0d036e8f120..9a83b53aae8d 100644 --- a/website/docs/cdktf/typescript/r/cloudformation_stack_instances.html.markdown +++ b/website/docs/cdktf/typescript/r/cloudformation_stack_instances.html.markdown @@ -167,6 +167,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `accounts` - (Optional) Accounts where you want to create stack instances in the specified `regions`. You can specify either `accounts` or `deploymentTargets`, but not both. * `deploymentTargets` - (Optional) AWS Organizations accounts for which to create stack instances in the `regions`. stack sets doesn't deploy stack instances to the organization management account, even if the organization management account is in your organization or in an OU in your organization. Drift detection is not possible for most of this argument. See [deployment_targets](#deployment_targets) below. * `parameterOverrides` - (Optional) Key-value map of input parameters to override from the stack set for these instances. This argument's drift detection is limited to the first account and region since each instance can have unique parameters. @@ -285,4 +286,4 @@ Using `terraform import`, Import CloudFormation stack instances that target OUs, % terraform import aws_cloudformation_stack_instances.example example,SELF,OU ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/cloudformation_stack_set.html.markdown b/website/docs/cdktf/typescript/r/cloudformation_stack_set.html.markdown index 5b39f6eac976..918ddb535481 100644 --- a/website/docs/cdktf/typescript/r/cloudformation_stack_set.html.markdown +++ b/website/docs/cdktf/typescript/r/cloudformation_stack_set.html.markdown @@ -140,6 +140,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `administrationRoleArn` - (Optional) Amazon Resource Number (ARN) of the IAM Role in the administrator account. This must be defined when using the `SELF_MANAGED` permission model. * `autoDeployment` - (Optional) Configuration block containing the auto-deployment model for your StackSet. This can only be defined when using the `SERVICE_MANAGED` permission model. * `enabled` - (Optional) Whether or not auto-deployment is enabled. @@ -242,4 +243,4 @@ Using `terraform import`, import CloudFormation StackSets when acting a delegate % terraform import aws_cloudformation_stack_set.example example,DELEGATED_ADMIN ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/cloudformation_stack_set_instance.html.markdown b/website/docs/cdktf/typescript/r/cloudformation_stack_set_instance.html.markdown index a2ed9743a501..7b46d71ddf0d 100644 --- a/website/docs/cdktf/typescript/r/cloudformation_stack_set_instance.html.markdown +++ b/website/docs/cdktf/typescript/r/cloudformation_stack_set_instance.html.markdown @@ -34,7 +34,7 @@ class MyConvertedCode extends TerraformStack { super(scope, name); new CloudformationStackSetInstance(this, "example", { accountId: "123456789012", - region: "us-east-1", + stackSetInstanceRegion: "us-east-1", stackSetName: Token.asString(awsCloudformationStackSetExample.name), }); } @@ -149,7 +149,7 @@ class MyConvertedCode extends TerraformStack { ), ], }, - region: "us-east-1", + stackSetInstanceRegion: "us-east-1", stackSetName: Token.asString(awsCloudformationStackSetExample.name), }); } @@ -163,12 +163,13 @@ This resource supports the following arguments: * `stackSetName` - (Required) Name of the StackSet. * `accountId` - (Optional) Target AWS Account ID to create a Stack based on the StackSet. Defaults to current account. +* `callAs` - (Optional) Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account. Valid values: `SELF` (default), `DELEGATED_ADMIN`. * `deploymentTargets` - (Optional) AWS Organizations accounts to which StackSets deploys. StackSets doesn't deploy stack instances to the organization management account, even if the organization management account is in your organization or in an OU in your organization. Drift detection is not possible for this argument. See [deployment_targets](#deployment_targets-argument-reference) below. +* `operationPreferences` - (Optional) Preferences for how AWS CloudFormation performs a stack set operation. * `parameterOverrides` - (Optional) Key-value map of input parameters to override from the StackSet for this Instance. -* `region` - (Optional) Target AWS Region to create a Stack based on the StackSet. Defaults to current region. +* `region` - (Optional, **Deprecated**) Target AWS Region to create a Stack based on the StackSet. Defaults to current region. Use `stackSetInstanceRegion` instead. * `retainStack` - (Optional) During Terraform resource destroy, remove Instance from StackSet while keeping the Stack and its associated resources. Must be enabled in Terraform state _before_ destroy operation to take effect. You cannot reassociate a retained Stack or add an existing, saved Stack to a new StackSet. Defaults to `false`. -* `callAs` - (Optional) Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account. Valid values: `SELF` (default), `DELEGATED_ADMIN`. -* `operationPreferences` - (Optional) Preferences for how AWS CloudFormation performs a stack set operation. +* `stackSetInstanceRegion` - Target AWS Region to create a Stack based on the StackSet. Defaults to current region. ### `deploymentTargets` Argument Reference @@ -306,4 +307,4 @@ Using `terraform import`, import CloudFormation StackSet Instances when acting a % terraform import aws_cloudformation_stack_set_instance.example example,ou-sdas-123123123/ou-sdas-789789789,us-east-1,DELEGATED_ADMIN ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/cloudformation_type.html.markdown b/website/docs/cdktf/typescript/r/cloudformation_type.html.markdown index f3a6f566ee31..c94f588ab0fa 100644 --- a/website/docs/cdktf/typescript/r/cloudformation_type.html.markdown +++ b/website/docs/cdktf/typescript/r/cloudformation_type.html.markdown @@ -54,6 +54,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `executionRoleArn` - (Optional) Amazon Resource Name (ARN) of the IAM Role for CloudFormation to assume when invoking the extension. If your extension calls AWS APIs in any of its handlers, you must create an IAM execution role that includes the necessary permissions to call those AWS APIs, and provision that execution role in your account. When CloudFormation needs to invoke the extension handler, CloudFormation assumes this execution role to create a temporary session token, which it then passes to the extension handler, thereby supplying your extension with the appropriate credentials. * `loggingConfig` - (Optional) Configuration block containing logging configuration. * `schemaHandlerPackage` - (Required) URL to the S3 bucket containing the extension project package that contains the necessary files for the extension you want to register. Must begin with `s3://` or `https://`. For example, `s3://example-bucket/example-object`. @@ -116,4 +117,4 @@ Using `terraform import`, import `aws_cloudformation_type` using the type versio % terraform import aws_cloudformation_type.example arn:aws:cloudformation:us-east-1:123456789012:type/resource/ExampleCompany-ExampleService-ExampleType/1 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/cloudfront_continuous_deployment_policy.html.markdown b/website/docs/cdktf/typescript/r/cloudfront_continuous_deployment_policy.html.markdown index 15e074312790..8dce3726d914 100644 --- a/website/docs/cdktf/typescript/r/cloudfront_continuous_deployment_policy.html.markdown +++ b/website/docs/cdktf/typescript/r/cloudfront_continuous_deployment_policy.html.markdown @@ -192,8 +192,8 @@ The following arguments are required: ### `sessionStickinessConfig` -* `idleTtl` - (Required) The amount of time in seconds after which sessions will cease if no requests are received. Valid values are `300` – `3600` (5–60 minutes). The value must be less than or equal to `maximumTtl`. -* `maximumTtl` - (Required) The maximum amount of time in seconds to consider requests from the viewer as being part of the same session. Valid values are `300` – `3600` (5–60 minutes). The value must be greater than or equal to `idleTtl`. +* `idleTtl` - (Required) The amount of time in seconds after which sessions will cease if no requests are received. Valid values are `300` - `3600` (5–60 minutes). The value must be less than or equal to `maximumTtl`. +* `maximumTtl` - (Required) The maximum amount of time in seconds to consider requests from the viewer as being part of the same session. Valid values are `300` - `3600` (5–60 minutes). The value must be greater than or equal to `idleTtl`. ## Attribute Reference @@ -236,4 +236,4 @@ Using `terraform import`, import CloudFront Continuous Deployment Policy using t % terraform import aws_cloudfront_continuous_deployment_policy.example abcd-1234 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/cloudfront_distribution.html.markdown b/website/docs/cdktf/typescript/r/cloudfront_distribution.html.markdown index 8982d9192a8d..9b980a31aaf4 100644 --- a/website/docs/cdktf/typescript/r/cloudfront_distribution.html.markdown +++ b/website/docs/cdktf/typescript/r/cloudfront_distribution.html.markdown @@ -229,12 +229,8 @@ import { TerraformStack } from "cdktf"; * See https://cdk.tf/provider-generation for more details. */ import { CloudfrontDistribution } from "./.gen/providers/aws/cloudfront-distribution"; -interface MyConfig { - cachedMethods: any; - viewerProtocolPolicy: any; -} class MyConvertedCode extends TerraformStack { - constructor(scope: Construct, name: string, config: MyConfig) { + constructor(scope: Construct, name: string) { super(scope, name); const s3OriginId = "myS3Origin"; new CloudfrontDistribution(this, "s3_distribution", { @@ -242,9 +238,9 @@ class MyConvertedCode extends TerraformStack { defaultCacheBehavior: { allowedMethods: ["GET", "HEAD", "OPTIONS"], cachePolicyId: "4135ea2d-6df8-44a3-9df3-4b5a84be39ad", + cachedMethods: ["GET", "HEAD"], targetOriginId: s3OriginId, - cachedMethods: config.cachedMethods, - viewerProtocolPolicy: config.viewerProtocolPolicy, + viewerProtocolPolicy: "allow-all", }, defaultRootObject: "index.html", enabled: true, @@ -289,7 +285,6 @@ import { CloudfrontDistribution } from "./.gen/providers/aws/cloudfront-distribu import { CloudwatchLogDelivery } from "./.gen/providers/aws/cloudwatch-log-delivery"; import { CloudwatchLogDeliveryDestination } from "./.gen/providers/aws/cloudwatch-log-delivery-destination"; import { CloudwatchLogDeliverySource } from "./.gen/providers/aws/cloudwatch-log-delivery-source"; -import { AwsProvider } from "./.gen/providers/aws/provider"; import { S3Bucket } from "./.gen/providers/aws/s3-bucket"; interface MyConfig { defaultCacheBehavior: any; @@ -301,15 +296,7 @@ interface MyConfig { class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string, config: MyConfig) { super(scope, name); - new AwsProvider(this, "aws", { - region: region.stringValue, - }); - const usEast1 = new AwsProvider(this, "aws_1", { - alias: "us_east_1", - region: "us-east-1", - }); const example = new CloudfrontDistribution(this, "example", { - provider: usEast1, defaultCacheBehavior: config.defaultCacheBehavior, enabled: config.enabled, origin: config.origin, @@ -317,22 +304,22 @@ class MyConvertedCode extends TerraformStack { viewerCertificate: config.viewerCertificate, }); const awsCloudwatchLogDeliverySourceExample = - new CloudwatchLogDeliverySource(this, "example_3", { + new CloudwatchLogDeliverySource(this, "example_1", { logType: "ACCESS_LOGS", name: "example", - provider: usEast1, + region: "us-east-1", resourceArn: 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.*/ awsCloudwatchLogDeliverySourceExample.overrideLogicalId("example"); - const awsS3BucketExample = new S3Bucket(this, "example_4", { + const awsS3BucketExample = new S3Bucket(this, "example_2", { bucket: "testbucket", forceDestroy: true, }); /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ awsS3BucketExample.overrideLogicalId("example"); const awsCloudwatchLogDeliveryDestinationExample = - new CloudwatchLogDeliveryDestination(this, "example_5", { + new CloudwatchLogDeliveryDestination(this, "example_3", { deliveryDestinationConfiguration: [ { destinationResourceArn: "${" + awsS3BucketExample.arn + "}/prefix", @@ -340,13 +327,13 @@ class MyConvertedCode extends TerraformStack { ], name: "s3-destination", outputFormat: "parquet", - provider: usEast1, + region: "us-east-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.*/ awsCloudwatchLogDeliveryDestinationExample.overrideLogicalId("example"); const awsCloudwatchLogDeliveryExample = new CloudwatchLogDelivery( this, - "example_6", + "example_4", { deliveryDestinationArn: Token.asString( awsCloudwatchLogDeliveryDestinationExample.arn @@ -354,7 +341,7 @@ class MyConvertedCode extends TerraformStack { deliverySourceName: Token.asString( awsCloudwatchLogDeliverySourceExample.name ), - provider: usEast1, + region: "us-east-1", s3DeliveryConfiguration: [ { suffixPath: "/123456678910/{DistributionId}/{yyyy}/{MM}/{dd}/{HH}", @@ -369,11 +356,102 @@ class MyConvertedCode extends TerraformStack { ``` +### With V2 logging to Data Firehose + +The example below creates a CloudFront distribution with [standard logging V2 to Data Firehose](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/standard-logging.html#enable-access-logging-api). + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { Token, TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { CloudfrontDistribution } from "./.gen/providers/aws/cloudfront-distribution"; +import { CloudwatchLogDelivery } from "./.gen/providers/aws/cloudwatch-log-delivery"; +import { CloudwatchLogDeliveryDestination } from "./.gen/providers/aws/cloudwatch-log-delivery-destination"; +import { CloudwatchLogDeliverySource } from "./.gen/providers/aws/cloudwatch-log-delivery-source"; +import { KinesisFirehoseDeliveryStream } from "./.gen/providers/aws/kinesis-firehose-delivery-stream"; +interface MyConfig { + defaultCacheBehavior: any; + enabled: any; + origin: any; + restrictions: any; + viewerCertificate: any; + destination: any; + name: any; +} +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string, config: MyConfig) { + super(scope, name); + const example = new CloudfrontDistribution(this, "example", { + defaultCacheBehavior: config.defaultCacheBehavior, + enabled: config.enabled, + origin: config.origin, + restrictions: config.restrictions, + viewerCertificate: config.viewerCertificate, + }); + const awsCloudwatchLogDeliverySourceExample = + new CloudwatchLogDeliverySource(this, "example_1", { + logType: "ACCESS_LOGS", + name: "cloudfront-logs-source", + region: "us-east-1", + resourceArn: 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.*/ + awsCloudwatchLogDeliverySourceExample.overrideLogicalId("example"); + const cloudfrontLogs = new KinesisFirehoseDeliveryStream( + this, + "cloudfront_logs", + { + region: "us-east-1", + tags: { + LogDeliveryEnabled: "true", + }, + destination: config.destination, + name: config.name, + } + ); + const awsCloudwatchLogDeliveryDestinationExample = + new CloudwatchLogDeliveryDestination(this, "example_3", { + deliveryDestinationConfiguration: [ + { + destinationResourceArn: cloudfrontLogs.arn, + }, + ], + name: "firehose-destination", + outputFormat: "json", + region: "us-east-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.*/ + awsCloudwatchLogDeliveryDestinationExample.overrideLogicalId("example"); + const awsCloudwatchLogDeliveryExample = new CloudwatchLogDelivery( + this, + "example_4", + { + deliveryDestinationArn: Token.asString( + awsCloudwatchLogDeliveryDestinationExample.arn + ), + deliverySourceName: Token.asString( + awsCloudwatchLogDeliverySourceExample.name + ), + region: "us-east-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.*/ + awsCloudwatchLogDeliveryExample.overrideLogicalId("example"); + } +} + +``` + ## Argument Reference This resource supports the following arguments: * `aliases` (Optional) - Extra CNAMEs (alternate domain names), if any, for this distribution. +* `anycastIpListId` (Optional) - ID of the Anycast static IP list that is associated with the distribution. * `comment` (Optional) - Any comments you want to include about the distribution. * `continuousDeploymentPolicyId` (Optional) - Identifier of a continuous deployment policy. This argument should only be set on a production distribution. See the [`aws_cloudfront_continuous_deployment_policy` resource](./cloudfront_continuous_deployment_policy.html.markdown) for additional details. * `customErrorResponse` (Optional) - One or more [custom error response](#custom-error-response-arguments) elements (multiples allowed). @@ -565,6 +643,8 @@ class MyConvertedCode extends TerraformStack { #### Custom Error Response Arguments +~> **NOTE:** When specifying either `responsePagePath` or `responseCode`, **both** must be set. + * `errorCachingMinTtl` (Optional) - Minimum amount of time you want HTTP error codes to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated. * `errorCode` (Required) - 4xx or 5xx HTTP status code that you want to customize. * `responseCode` (Optional) - HTTP status code that you want CloudFront to return with the custom error page to the viewer. @@ -716,4 +796,4 @@ Using `terraform import`, import CloudFront Distributions using the `id`. For ex % terraform import aws_cloudfront_distribution.distribution E74FTE3EXAMPLE ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/cloudfront_function.html.markdown b/website/docs/cdktf/typescript/r/cloudfront_function.html.markdown index 979e1a52db00..e96ce8a680bb 100644 --- a/website/docs/cdktf/typescript/r/cloudfront_function.html.markdown +++ b/website/docs/cdktf/typescript/r/cloudfront_function.html.markdown @@ -56,7 +56,7 @@ The following arguments are optional: * `comment` - (Optional) Comment. * `publish` - (Optional) Whether to publish creation/change as Live CloudFront Function Version. Defaults to `true`. -* `keyValueStoreAssociations` - (Optional) List of `aws_cloudfront_key_value_store` ARNs to be associated to the function. AWS limits associations to on key value store per function. +* `keyValueStoreAssociations` - (Optional) List of `aws_cloudfront_key_value_store` ARNs to be associated to the function. AWS limits associations to one key value store per function. ## Attribute Reference @@ -99,4 +99,4 @@ Using `terraform import`, import CloudFront Functions using the `name`. For exam % terraform import aws_cloudfront_function.test my_test_function ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/cloudfront_key_value_store.html.markdown b/website/docs/cdktf/typescript/r/cloudfront_key_value_store.html.markdown index 1d48e1c75517..28a23ef17f56 100644 --- a/website/docs/cdktf/typescript/r/cloudfront_key_value_store.html.markdown +++ b/website/docs/cdktf/typescript/r/cloudfront_key_value_store.html.markdown @@ -52,8 +52,8 @@ The following arguments are optional: This resource exports the following attributes in addition to the arguments above: * `arn` - Amazon Resource Name (ARN) identifying your CloudFront KeyValueStore. -* `id` - A unique identifier for the KeyValueStore. Same as `name`. * `etag` - ETag hash of the KeyValueStore. +* `id` - A unique identifier for the KeyValueStore. ## Timeouts @@ -93,4 +93,4 @@ Using `terraform import`, import CloudFront Key Value Store using the `name`. Fo % terraform import aws_cloudfront_key_value_store.example example_store ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/cloudfrontkeyvaluestore_key.html.markdown b/website/docs/cdktf/typescript/r/cloudfrontkeyvaluestore_key.html.markdown index eb30a9dc2bbb..138ba52e9a08 100644 --- a/website/docs/cdktf/typescript/r/cloudfrontkeyvaluestore_key.html.markdown +++ b/website/docs/cdktf/typescript/r/cloudfrontkeyvaluestore_key.html.markdown @@ -68,7 +68,7 @@ This resource exports the following attributes in addition to the arguments abov ## Import -In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import CloudFront KeyValueStore Key using the `example_id_arg`. For example: +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import CloudFront KeyValueStore Key using the `keyValueStoreArn` and 'key' separated by `,`. For example: ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -92,10 +92,10 @@ class MyConvertedCode extends TerraformStack { ``` -Using `terraform import`, import CloudFront KeyValueStore Key using the `id`. For example: +Using `terraform import`, import CloudFront KeyValueStore Key using the `keyValueStoreArn` and 'key' separated by `,`. For example: ```console % terraform import aws_cloudfrontkeyvaluestore_key.example arn:aws:cloudfront::111111111111:key-value-store/8562g61f-caba-2845-9d99-b97diwae5d3c,someKey ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/cloudhsm_v2_cluster.html.markdown b/website/docs/cdktf/typescript/r/cloudhsm_v2_cluster.html.markdown index 0e790ef9defb..194c360baa54 100644 --- a/website/docs/cdktf/typescript/r/cloudhsm_v2_cluster.html.markdown +++ b/website/docs/cdktf/typescript/r/cloudhsm_v2_cluster.html.markdown @@ -89,6 +89,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `sourceBackupIdentifier` - (Optional) ID of Cloud HSM v2 cluster backup to be restored. * `hsmType` - (Required) The type of HSM module in the cluster. Currently, `hsm1.medium` and `hsm2m.medium` are supported. * `subnetIds` - (Required) The IDs of subnets in which cluster will operate. @@ -146,4 +147,4 @@ Using `terraform import`, import CloudHSM v2 Clusters using the cluster `id`. Fo % terraform import aws_cloudhsm_v2_cluster.test_cluster cluster-aeb282a201 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/cloudhsm_v2_hsm.html.markdown b/website/docs/cdktf/typescript/r/cloudhsm_v2_hsm.html.markdown index 3e4a2307e77d..9ae1a03fb919 100644 --- a/website/docs/cdktf/typescript/r/cloudhsm_v2_hsm.html.markdown +++ b/website/docs/cdktf/typescript/r/cloudhsm_v2_hsm.html.markdown @@ -45,13 +45,14 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: -~> **NOTE:** Either `subnetId` or `availabilityZone` must be specified. - +* `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). * `clusterId` - (Required) The ID of Cloud HSM v2 cluster to which HSM will be added. * `subnetId` - (Optional) The ID of subnet in which HSM module will be located. Conflicts with `availabilityZone`. * `availabilityZone` - (Optional) The IDs of AZ in which HSM module will be located. Conflicts with `subnetId`. * `ipAddress` - (Optional) The IP address of HSM module. Must be within the CIDR of selected subnet. +~> **NOTE:** Either `subnetId` or `availabilityZone` must be specified. + ## Attribute Reference This resource exports the following attributes in addition to the arguments above: @@ -92,4 +93,4 @@ Using `terraform import`, import HSM modules using their HSM ID. For example: % terraform import aws_cloudhsm_v2_hsm.bar hsm-quo8dahtaca ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/cloudsearch_domain.html.markdown b/website/docs/cdktf/typescript/r/cloudsearch_domain.html.markdown index 9603f7e0bcc0..18d7c029c65c 100644 --- a/website/docs/cdktf/typescript/r/cloudsearch_domain.html.markdown +++ b/website/docs/cdktf/typescript/r/cloudsearch_domain.html.markdown @@ -63,6 +63,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `endpointOptions` - (Optional) Domain endpoint options. Documented below. * `indexField` - (Optional) The index fields for documents added to the domain. Documented below. * `multiAz` - (Optional) Whether or not to maintain extra instances for the domain in a second Availability Zone to ensure high availability. @@ -148,4 +149,4 @@ Using `terraform import`, import CloudSearch Domains using the `name`. For examp % terraform import aws_cloudsearch_domain.example example-domain ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/cloudsearch_domain_service_access_policy.html.markdown b/website/docs/cdktf/typescript/r/cloudsearch_domain_service_access_policy.html.markdown index e69cd8347138..1525df0cac99 100644 --- a/website/docs/cdktf/typescript/r/cloudsearch_domain_service_access_policy.html.markdown +++ b/website/docs/cdktf/typescript/r/cloudsearch_domain_service_access_policy.html.markdown @@ -77,6 +77,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `accessPolicy` - (Required) The access rules you want to configure. These rules replace any existing rules. See the [AWS documentation](https://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-access.html) for details. * `domainName` - (Required) The CloudSearch domain name the policy applies to. @@ -123,4 +124,4 @@ Using `terraform import`, import CloudSearch domain service access policies usin % terraform import aws_cloudsearch_domain_service_access_policy.example example-domain ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/cloudtrail.html.markdown b/website/docs/cdktf/typescript/r/cloudtrail.html.markdown index f90e6afa1997..c224bad7a73c 100644 --- a/website/docs/cdktf/typescript/r/cloudtrail.html.markdown +++ b/website/docs/cdktf/typescript/r/cloudtrail.html.markdown @@ -66,7 +66,7 @@ class MyConvertedCode extends TerraformStack { "arn:${" + dataAwsPartitionCurrent.partition + "}:cloudtrail:${" + - dataAwsRegionCurrent.name + + dataAwsRegionCurrent.region + "}:${" + current.accountId + "}:trail/example", @@ -98,7 +98,7 @@ class MyConvertedCode extends TerraformStack { "arn:${" + dataAwsPartitionCurrent.partition + "}:cloudtrail:${" + - dataAwsRegionCurrent.name + + dataAwsRegionCurrent.region + "}:${" + current.accountId + "}:trail/example", @@ -483,6 +483,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `advancedEventSelector` - (Optional) Specifies an advanced event selector for enabling data event logging. Fields documented below. Conflicts with `eventSelector`. * `cloudWatchLogsGroupArn` - (Optional) Log group name using an ARN that represents the log group to which CloudTrail logs will be delivered. Note that CloudTrail requires the Log Stream wildcard. * `cloudWatchLogsRoleArn` - (Optional) Role for the CloudWatch Logs endpoint to assume to write to a user’s log group. @@ -571,4 +572,4 @@ Using `terraform import`, import Cloudtrails using the `arn`. For example: % terraform import aws_cloudtrail.sample arn:aws:cloudtrail:us-east-1:123456789012:trail/my-sample-trail ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/cloudtrail_event_data_store.html.markdown b/website/docs/cdktf/typescript/r/cloudtrail_event_data_store.html.markdown index 897995d9ea0c..7c9fc3388932 100644 --- a/website/docs/cdktf/typescript/r/cloudtrail_event_data_store.html.markdown +++ b/website/docs/cdktf/typescript/r/cloudtrail_event_data_store.html.markdown @@ -104,6 +104,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +- `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). - `name` - (Required) The name of the event data store. - `billingMode` - (Optional) The billing mode for the event data store. The valid values are `EXTENDABLE_RETENTION_PRICING` and `FIXED_RETENTION_PRICING`. Defaults to `EXTENDABLE_RETENTION_PRICING`. - `suspend` - (Optional) Specifies whether to stop ingesting new events into the event data store. If set to `true`, ingestion is suspended while maintaining the ability to query existing events. If set to `false`, ingestion is active. @@ -174,4 +175,4 @@ Using `terraform import`, import event data stores using their `arn`. For exampl % terraform import aws_cloudtrail_event_data_store.example arn:aws:cloudtrail:us-east-1:123456789123:eventdatastore/22333815-4414-412c-b155-dd254033gfhf ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/cloudwatch_composite_alarm.html.markdown b/website/docs/cdktf/typescript/r/cloudwatch_composite_alarm.html.markdown index 74ee3ba72ebb..f6083697a622 100644 --- a/website/docs/cdktf/typescript/r/cloudwatch_composite_alarm.html.markdown +++ b/website/docs/cdktf/typescript/r/cloudwatch_composite_alarm.html.markdown @@ -54,6 +54,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `actionsEnabled` - (Optional, Forces new resource) Indicates whether actions should be executed during any changes to the alarm state of the composite alarm. Defaults to `true`. * `actionsSuppressor` - (Optional) Actions will be suppressed if the suppressor alarm is in the ALARM state. * `alarm` - (Required) Can be an AlarmName or an Amazon Resource Name (ARN) from an existing alarm. @@ -103,4 +104,4 @@ Using `terraform import`, import a CloudWatch Composite Alarm using the `alarmNa % terraform import aws_cloudwatch_composite_alarm.test my-alarm ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/cloudwatch_contributor_insight_rule.html.markdown b/website/docs/cdktf/typescript/r/cloudwatch_contributor_insight_rule.html.markdown index daf57063e0f6..411ff096a188 100644 --- a/website/docs/cdktf/typescript/r/cloudwatch_contributor_insight_rule.html.markdown +++ b/website/docs/cdktf/typescript/r/cloudwatch_contributor_insight_rule.html.markdown @@ -48,6 +48,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `ruleState` - (Optional) State of the rule. Valid values are `ENABLED` and `DISABLED`. ## Attribute Reference @@ -88,4 +89,4 @@ Using `terraform import`, import CloudWatch Contributor Insight Rule using the ` % terraform import aws_cloudwatch_contributor_insight_rule.example contributor_insight_rule-name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/cloudwatch_contributor_managed_insight_rule.html.markdown b/website/docs/cdktf/typescript/r/cloudwatch_contributor_managed_insight_rule.html.markdown index b56363cb4e00..6fc544740ecb 100644 --- a/website/docs/cdktf/typescript/r/cloudwatch_contributor_managed_insight_rule.html.markdown +++ b/website/docs/cdktf/typescript/r/cloudwatch_contributor_managed_insight_rule.html.markdown @@ -47,6 +47,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `ruleState` - (Optional) State of the rule. Valid values are `ENABLED` and `DISABLED`. ## Attribute Reference @@ -87,4 +88,4 @@ Using `terraform import`, import CloudWatch Contributor Managed Insight Rule usi % terraform import aws_cloudwatch_contributor_managed_insight_rule.example contributor_managed_insight_rule-id-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/cloudwatch_dashboard.html.markdown b/website/docs/cdktf/typescript/r/cloudwatch_dashboard.html.markdown index ddb01e636e8f..7466b02711ad 100644 --- a/website/docs/cdktf/typescript/r/cloudwatch_dashboard.html.markdown +++ b/website/docs/cdktf/typescript/r/cloudwatch_dashboard.html.markdown @@ -70,6 +70,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `dashboardName` - (Required) The name of the dashboard. * `dashboardBody` - (Required) The detailed information about the dashboard, including what widgets are included and their location on the dashboard. You can read more about the body structure in the [documentation](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/CloudWatch-Dashboard-Body-Structure.html). @@ -111,4 +112,4 @@ Using `terraform import`, import CloudWatch dashboards using the `dashboardName` % terraform import aws_cloudwatch_dashboard.sample dashboard_name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/cloudwatch_event_api_destination.html.markdown b/website/docs/cdktf/typescript/r/cloudwatch_event_api_destination.html.markdown index 005c3434cb5c..2d7e592c00e1 100644 --- a/website/docs/cdktf/typescript/r/cloudwatch_event_api_destination.html.markdown +++ b/website/docs/cdktf/typescript/r/cloudwatch_event_api_destination.html.markdown @@ -45,6 +45,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) The name of the new API Destination. The name must be unique for your account. Maximum of 64 characters consisting of numbers, lower/upper case letters, .,-,_. * `description` - (Optional) The description of the new API Destination. Maximum of 512 characters. * `invocationEndpoint` - (Required) URL endpoint to invoke as a target. This could be a valid endpoint generated by a partner service. You can include "*" as path parameters wildcards to be set from the Target HttpParameters. @@ -90,4 +91,4 @@ Using `terraform import`, import EventBridge API Destinations using the `name`. % terraform import aws_cloudwatch_event_api_destination.test api-destination ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/cloudwatch_event_archive.html.markdown b/website/docs/cdktf/typescript/r/cloudwatch_event_archive.html.markdown index dcd340094f28..c0ec018115b8 100644 --- a/website/docs/cdktf/typescript/r/cloudwatch_event_archive.html.markdown +++ b/website/docs/cdktf/typescript/r/cloudwatch_event_archive.html.markdown @@ -47,7 +47,7 @@ class MyConvertedCode extends TerraformStack { ``` -## Example all optional arguments +## Example Usage Optional Arguments ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -87,21 +87,117 @@ class MyConvertedCode extends TerraformStack { ``` +## Example Usage CMK Encryption + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { Fn, Token, TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { CloudwatchEventArchive } from "./.gen/providers/aws/cloudwatch-event-archive"; +import { CloudwatchEventBus } from "./.gen/providers/aws/cloudwatch-event-bus"; +import { DataAwsCallerIdentity } from "./.gen/providers/aws/data-aws-caller-identity"; +import { DataAwsPartition } from "./.gen/providers/aws/data-aws-partition"; +import { KmsKey } from "./.gen/providers/aws/kms-key"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + const example = new CloudwatchEventBus(this, "example", { + name: "example", + }); + const current = new DataAwsCallerIdentity(this, "current", {}); + const dataAwsPartitionCurrent = new DataAwsPartition(this, "current_2", {}); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + dataAwsPartitionCurrent.overrideLogicalId("current"); + const awsKmsKeyExample = new KmsKey(this, "example_3", { + deletionWindowInDays: 7, + policy: Token.asString( + Fn.jsonencode({ + Id: "key-policy-example", + Statement: [ + { + Action: "kms:*", + Effect: "Allow", + Principal: { + AWS: + "arn:${" + + dataAwsPartitionCurrent.partition + + "}:iam::${" + + current.accountId + + "}:root", + }, + Resource: "*", + Sid: "Enable IAM User Permissions", + }, + { + Action: ["kms:DescribeKey"], + Effect: "Allow", + Principal: { + Service: "events.amazonaws.com", + }, + Resource: "*", + Sid: "Allow describing of the key", + }, + { + Action: ["kms:GenerateDataKey", "kms:Decrypt", "kms:ReEncrypt*"], + Condition: { + StringEquals: { + "kms:EncryptionContext:aws:events:event-bus:arn": example.arn, + }, + }, + Effect: "Allow", + Principal: { + Service: "events.amazonaws.com", + }, + Resource: "*", + Sid: "Allow use of the key", + }, + ], + Version: "2012-10-17", + }) + ), + tags: { + EventBridgeApiDestinations: "true", + }, + }); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + awsKmsKeyExample.overrideLogicalId("example"); + const awsCloudwatchEventArchiveExample = new CloudwatchEventArchive( + this, + "example_4", + { + eventSourceArn: example.arn, + kmsKeyIdentifier: Token.asString(awsKmsKeyExample.id), + name: "example", + } + ); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + awsCloudwatchEventArchiveExample.overrideLogicalId("example"); + } +} + +``` + ## Argument Reference This resource supports the following arguments: -* `name` - (Required) The name of the new event archive. The archive name cannot exceed 48 characters. -* `eventSourceArn` - (Required) Event bus source ARN from where these events should be archived. -* `description` - (Optional) The description of the new event archive. -* `eventPattern` - (Optional) Instructs the new event archive to only capture events matched by this pattern. By default, it attempts to archive every event received in the `eventSourceArn`. +* `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). +* `name` - (Required) Name of the archive. The archive name cannot exceed 48 characters. +* `eventSourceArn` - (Required) ARN of the event bus associated with the archive. Only events from this event bus are sent to the archive. +* `description` - (Optional) Description for the archive. +* `eventPattern` - (Optional) Event pattern to use to filter events sent to the archive. By default, it attempts to archive every event received in the `eventSourceArn`. +* `kmsKeyIdentifier` - (Optional) Identifier of the AWS KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt this archive. The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN. * `retentionDays` - (Optional) The maximum number of days to retain events in the new event archive. By default, it archives indefinitely. ## Attribute Reference This resource exports the following attributes in addition to the arguments above: -* `arn` - The Amazon Resource Name (ARN) of the event archive. +* `arn` - ARN of the archive. ## Import @@ -135,4 +231,4 @@ Using `terraform import`, import an EventBridge archive using the `name`. For ex % terraform import aws_cloudwatch_event_archive.imported_event_archive order-archive ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/cloudwatch_event_bus.html.markdown b/website/docs/cdktf/typescript/r/cloudwatch_event_bus.html.markdown index e7ed13c592b4..a6bdb5f9b11b 100644 --- a/website/docs/cdktf/typescript/r/cloudwatch_event_bus.html.markdown +++ b/website/docs/cdktf/typescript/r/cloudwatch_event_bus.html.markdown @@ -16,6 +16,8 @@ Provides an EventBridge event bus resource. ## Example Usage +### Basic Usages + ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug import { Construct } from "constructs"; @@ -72,21 +74,299 @@ class MyConvertedCode extends TerraformStack { ``` +### Logging to CloudWatch Logs, S3, and Data Firehose + +See [Configuring logs for Amazon EventBridge event buses](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-bus-logs.html) for more details. + +#### Required Resources + +* EventBridge Event Bus with `logConfig` configured +* Log destinations: + + * CloudWatch Logs log group + * S3 bucket + * Data Firehose delivery stream + +* Resource-based policy or tagging for the service-linked role: + + * CloudWatch Logs log group - `aws_cloudwatch_log_resource_policy` to allow `delivery.logs.amazonaws.com` to put logs into the log group + * S3 bucket - `aws_s3_bucket_policy` to allow `delivery.logs.amazonaws.com` to put logs into the bucket + * Data Firehose delivery stream - tagging the delivery stream with `LogDeliveryEnabled = "true"` to allow the service-linked role `AWSServiceRoleForLogDelivery` to deliver logs + +* CloudWatch Logs Delivery: + + * `aws_cloudwatch_log_delivery_source` for each log type (INFO, ERROR, TRACE) + * `aws_cloudwatch_log_delivery_destination` for the log destination (S3 bucket, CloudWatch Logs log group, or Data Firehose delivery stream) + * `aws_cloudwatch_log_delivery` to link each log type’s delivery source to the delivery destination + +#### Example Usage + +The following example demonstrates how to set up logging for an EventBridge event bus to all three destinations: CloudWatch Logs, S3, and Data Firehose. + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { Token, TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { CloudwatchEventBus } from "./.gen/providers/aws/cloudwatch-event-bus"; +import { CloudwatchLogDelivery } from "./.gen/providers/aws/cloudwatch-log-delivery"; +import { CloudwatchLogDeliveryDestination } from "./.gen/providers/aws/cloudwatch-log-delivery-destination"; +import { CloudwatchLogDeliverySource } from "./.gen/providers/aws/cloudwatch-log-delivery-source"; +import { CloudwatchLogGroup } from "./.gen/providers/aws/cloudwatch-log-group"; +import { CloudwatchLogResourcePolicy } from "./.gen/providers/aws/cloudwatch-log-resource-policy"; +import { DataAwsCallerIdentity } from "./.gen/providers/aws/data-aws-caller-identity"; +import { DataAwsIamPolicyDocument } from "./.gen/providers/aws/data-aws-iam-policy-document"; +import { KinesisFirehoseDeliveryStream } from "./.gen/providers/aws/kinesis-firehose-delivery-stream"; +import { S3Bucket } from "./.gen/providers/aws/s3-bucket"; +import { S3BucketPolicy } from "./.gen/providers/aws/s3-bucket-policy"; +interface MyConfig { + destination: any; + name: any; +} +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string, config: MyConfig) { + super(scope, name); + const example = new CloudwatchEventBus(this, "example", { + logConfig: { + includeDetail: "FULL", + level: "TRACE", + }, + name: "example-event-bus", + }); + const errorLogs = new CloudwatchLogDeliverySource(this, "error_logs", { + logType: "ERROR_LOGS", + name: "EventBusSource-${" + example.name + "}-ERROR_LOGS", + resourceArn: example.arn, + }); + const infoLogs = new CloudwatchLogDeliverySource(this, "info_logs", { + logType: "INFO_LOGS", + name: "EventBusSource-${" + example.name + "}-INFO_LOGS", + resourceArn: example.arn, + }); + const traceLogs = new CloudwatchLogDeliverySource(this, "trace_logs", { + logType: "TRACE_LOGS", + name: "EventBusSource-${" + example.name + "}-TRACE_LOGS", + resourceArn: example.arn, + }); + const eventBusLogs = new CloudwatchLogGroup(this, "event_bus_logs", { + name: "/aws/vendedlogs/events/event-bus/${" + example.name + "}", + }); + const cloudfrontLogs = new KinesisFirehoseDeliveryStream( + this, + "cloudfront_logs", + { + tags: { + LogDeliveryEnabled: "true", + }, + destination: config.destination, + name: config.name, + } + ); + const awsS3BucketExample = new S3Bucket(this, "example_6", { + bucket: "example-event-bus-logs", + }); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + awsS3BucketExample.overrideLogicalId("example"); + const current = new DataAwsCallerIdentity(this, "current", {}); + const bucket = new DataAwsIamPolicyDocument(this, "bucket", { + statement: [ + { + actions: ["s3:PutObject"], + condition: [ + { + test: "StringEquals", + values: ["bucket-owner-full-control"], + variable: "s3:x-amz-acl", + }, + { + test: "StringEquals", + values: [Token.asString(current.accountId)], + variable: "aws:SourceAccount", + }, + { + test: "ArnLike", + values: [infoLogs.arn, errorLogs.arn, traceLogs.arn], + variable: "aws:SourceArn", + }, + ], + effect: "Allow", + principals: [ + { + identifiers: ["delivery.logs.amazonaws.com"], + type: "Service", + }, + ], + resources: [ + "${" + + awsS3BucketExample.arn + + "}/AWSLogs/${" + + current.accountId + + "}/EventBusLogs/*", + ], + }, + ], + }); + const cwlogs = new DataAwsIamPolicyDocument(this, "cwlogs", { + statement: [ + { + actions: ["logs:CreateLogStream", "logs:PutLogEvents"], + condition: [ + { + test: "StringEquals", + values: [Token.asString(current.accountId)], + variable: "aws:SourceAccount", + }, + { + test: "ArnLike", + values: [infoLogs.arn, errorLogs.arn, traceLogs.arn], + variable: "aws:SourceArn", + }, + ], + effect: "Allow", + principals: [ + { + identifiers: ["delivery.logs.amazonaws.com"], + type: "Service", + }, + ], + resources: ["${" + eventBusLogs.arn + "}:log-stream:*"], + }, + ], + }); + const awsCloudwatchLogDeliveryDestinationCwlogs = + new CloudwatchLogDeliveryDestination(this, "cwlogs_10", { + deliveryDestinationConfiguration: [ + { + destinationResourceArn: eventBusLogs.arn, + }, + ], + name: "EventsDeliveryDestination-${" + example.name + "}-CWLogs", + }); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + awsCloudwatchLogDeliveryDestinationCwlogs.overrideLogicalId("cwlogs"); + const firehose = new CloudwatchLogDeliveryDestination(this, "firehose", { + deliveryDestinationConfiguration: [ + { + destinationResourceArn: cloudfrontLogs.arn, + }, + ], + name: "EventsDeliveryDestination-${" + example.name + "}-Firehose", + }); + const s3 = new CloudwatchLogDeliveryDestination(this, "s3", { + deliveryDestinationConfiguration: [ + { + destinationResourceArn: Token.asString(awsS3BucketExample.arn), + }, + ], + name: "EventsDeliveryDestination-${" + example.name + "}-S3", + }); + const awsCloudwatchLogResourcePolicyExample = + new CloudwatchLogResourcePolicy(this, "example_13", { + policyDocument: Token.asString(cwlogs.json), + policyName: "AWSLogDeliveryWrite-${" + example.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.*/ + awsCloudwatchLogResourcePolicyExample.overrideLogicalId("example"); + const awsS3BucketPolicyExample = new S3BucketPolicy(this, "example_14", { + bucket: Token.asString(awsS3BucketExample.bucket), + policy: Token.asString(bucket.json), + }); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + awsS3BucketPolicyExample.overrideLogicalId("example"); + const s3InfoLogs = new CloudwatchLogDelivery(this, "s3_info_logs", { + deliveryDestinationArn: s3.arn, + deliverySourceName: infoLogs.name, + }); + const cwlogsInfoLogs = new CloudwatchLogDelivery(this, "cwlogs_info_logs", { + deliveryDestinationArn: Token.asString( + awsCloudwatchLogDeliveryDestinationCwlogs.arn + ), + deliverySourceName: infoLogs.name, + dependsOn: [s3InfoLogs], + }); + const firehoseInfoLogs = new CloudwatchLogDelivery( + this, + "firehose_info_logs", + { + deliveryDestinationArn: firehose.arn, + deliverySourceName: infoLogs.name, + dependsOn: [cwlogsInfoLogs], + } + ); + const s3ErrorLogs = new CloudwatchLogDelivery(this, "s3_error_logs", { + deliveryDestinationArn: s3.arn, + deliverySourceName: errorLogs.name, + dependsOn: [s3InfoLogs], + }); + const s3TraceLogs = new CloudwatchLogDelivery(this, "s3_trace_logs", { + deliveryDestinationArn: s3.arn, + deliverySourceName: traceLogs.name, + dependsOn: [s3ErrorLogs], + }); + const cwlogsErrorLogs = new CloudwatchLogDelivery( + this, + "cwlogs_error_logs", + { + deliveryDestinationArn: Token.asString( + awsCloudwatchLogDeliveryDestinationCwlogs.arn + ), + deliverySourceName: errorLogs.name, + dependsOn: [s3ErrorLogs, cwlogsInfoLogs], + } + ); + const cwlogsTraceLogs = new CloudwatchLogDelivery( + this, + "cwlogs_trace_logs", + { + deliveryDestinationArn: Token.asString( + awsCloudwatchLogDeliveryDestinationCwlogs.arn + ), + deliverySourceName: traceLogs.name, + dependsOn: [s3TraceLogs, cwlogsErrorLogs], + } + ); + const firehoseErrorLogs = new CloudwatchLogDelivery( + this, + "firehose_error_logs", + { + deliveryDestinationArn: firehose.arn, + deliverySourceName: errorLogs.name, + dependsOn: [cwlogsErrorLogs, firehoseInfoLogs], + } + ); + new CloudwatchLogDelivery(this, "firehose_trace_logs", { + deliveryDestinationArn: firehose.arn, + deliverySourceName: traceLogs.name, + dependsOn: [cwlogsTraceLogs, firehoseErrorLogs], + }); + } +} + +``` + ## Argument Reference This resource supports the following arguments: +* `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). The following arguments are required: * `name` - (Required) Name of the new event bus. The names of custom event buses can't contain the / character. To create a partner event bus, ensure that the `name` matches the `eventSourceName`. The following arguments are optional: +* `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). * `deadLetterConfig` - (Optional) Configuration details of the Amazon SQS queue for EventBridge to use as a dead-letter queue (DLQ). This block supports the following arguments: * `arn` - (Optional) The ARN of the SQS queue specified as the target for the dead-letter queue. * `description` - (Optional) Event bus description. * `eventSourceName` - (Optional) Partner event source that the new event bus will be matched with. Must match `name`. * `kmsKeyIdentifier` - (Optional) Identifier of the AWS KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt events on this event bus. The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN. +* `logConfig` - (Optional) Block for logging configuration settings for the event bus. + * `includeDetail` - (Optional) Whether EventBridge include detailed event information in the records it generates. Valid values are `NONE` and `FULL`. + * `level` - (Optional) Level of logging detail to include. Valid values are `OFF`, `ERROR`, `INFO`, and `TRACE`. * `tags` - (Optional) Map of tags assigned to the resource. If configured with a provider [`defaultTags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. ## Attribute Reference @@ -129,4 +409,4 @@ Using `terraform import`, import EventBridge event buses using the name of the e % terraform import aws_cloudwatch_event_bus.messenger chat-messages ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/cloudwatch_event_bus_policy.html.markdown b/website/docs/cdktf/typescript/r/cloudwatch_event_bus_policy.html.markdown index 2e49a1ed9ad0..9947790d8c03 100644 --- a/website/docs/cdktf/typescript/r/cloudwatch_event_bus_policy.html.markdown +++ b/website/docs/cdktf/typescript/r/cloudwatch_event_bus_policy.html.markdown @@ -206,6 +206,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `policy` - (Required) The text of the policy. For more information about building AWS IAM policy documents with Terraform, see the [AWS IAM Policy Document Guide](https://learn.hashicorp.com/terraform/aws/iam-policy). * `eventBusName` - (Optional) The name of the event bus to set the permissions on. If you omit this, the permissions are set on the `default` event bus. @@ -248,4 +249,4 @@ Using `terraform import`, import an EventBridge policy using the `eventBusName`. % terraform import aws_cloudwatch_event_bus_policy.DevAccountAccess example-event-bus ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/cloudwatch_event_connection.html.markdown b/website/docs/cdktf/typescript/r/cloudwatch_event_connection.html.markdown index 7f9b5575bf1f..c41c8d57609f 100644 --- a/website/docs/cdktf/typescript/r/cloudwatch_event_connection.html.markdown +++ b/website/docs/cdktf/typescript/r/cloudwatch_event_connection.html.markdown @@ -215,7 +215,7 @@ class MyConvertedCode extends TerraformStack { }, authorizationType: "BASIC", description: "A connection description", - kms_key_identifier: example.id, + kmsKeyIdentifier: example.id, name: "ngrok-connection", }); const current = new DataAwsCallerIdentity(this, "current", {}); @@ -283,6 +283,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) The name for the connection. Maximum of 64 characters consisting of numbers, lower/upper case letters, .,-,_. * `description` - (Optional) Description for the connection. Maximum of 512 characters. * `authorizationType` - (Required) Type of authorization to use for the connection. One of `API_KEY`,`BASIC`,`OAUTH_CLIENT_CREDENTIALS`. @@ -380,4 +381,4 @@ Using `terraform import`, import EventBridge EventBridge connection using the `n % terraform import aws_cloudwatch_event_connection.test ngrok-connection ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/cloudwatch_event_endpoint.html.markdown b/website/docs/cdktf/typescript/r/cloudwatch_event_endpoint.html.markdown index 7cd5bd5fe69b..c4017f3754b3 100644 --- a/website/docs/cdktf/typescript/r/cloudwatch_event_endpoint.html.markdown +++ b/website/docs/cdktf/typescript/r/cloudwatch_event_endpoint.html.markdown @@ -62,6 +62,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `description` - (Optional) A description of the global endpoint. * `eventBus` - (Required) The event buses to use. The names of the event buses must be identical in each Region. Exactly two event buses are required. Documented below. * `name` - (Required) The name of the global endpoint. @@ -133,4 +134,4 @@ Using `terraform import`, import EventBridge Global Endpoints using the `name`. % terraform import aws_cloudwatch_event_endpoint.imported_endpoint example-endpoint ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/cloudwatch_event_permission.html.markdown b/website/docs/cdktf/typescript/r/cloudwatch_event_permission.html.markdown index 5f85155245cd..ff84e93bba08 100644 --- a/website/docs/cdktf/typescript/r/cloudwatch_event_permission.html.markdown +++ b/website/docs/cdktf/typescript/r/cloudwatch_event_permission.html.markdown @@ -73,6 +73,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `principal` - (Required) The 12-digit AWS account ID that you are permitting to put events to your default event bus. Specify `*` to permit any account to put events to your default event bus, optionally limited by `condition`. * `statementId` - (Required) An identifier string for the external account that you are granting permissions to. * `action` - (Optional) The action that you are enabling the other account to perform. Defaults to `events:PutEvents`. @@ -124,4 +125,4 @@ Using `terraform import`, import EventBridge permissions using the `event_bus_na % terraform import aws_cloudwatch_event_permission.DevAccountAccess example-event-bus/DevAccountAccess ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/cloudwatch_event_rule.html.markdown b/website/docs/cdktf/typescript/r/cloudwatch_event_rule.html.markdown index 7c674d9c1aea..2f9cc66a7474 100644 --- a/website/docs/cdktf/typescript/r/cloudwatch_event_rule.html.markdown +++ b/website/docs/cdktf/typescript/r/cloudwatch_event_rule.html.markdown @@ -62,28 +62,21 @@ data "aws_iam_policy_document" "sns_topic_policy" { This resource supports the following arguments: +* `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). * `name` - (Optional) The name of the rule. If omitted, Terraform will assign a random, unique name. Conflicts with `namePrefix`. * `namePrefix` - (Optional) Creates a unique name beginning with the specified prefix. Conflicts with `name`. **Note**: Due to the length of the generated suffix, must be 38 characters or less. * `scheduleExpression` - (Optional) The scheduling expression. For example, `cron(0 20 * * ? *)` or `rate(5 minutes)`. At least one of `scheduleExpression` or `eventPattern` is required. Can only be used on the default event bus. For more information, refer to the AWS documentation [Schedule Expressions for Rules](https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html). -* `eventBusName` - (Optional) The name or ARN of the event bus to associate with this rule. - If you omit this, the `default` event bus is used. +* `eventBusName` - (Optional) The name or ARN of the event bus to associate with this rule. If you omit this, the `default` event bus is used. * `eventPattern` - (Optional) The event pattern described a JSON object. At least one of `scheduleExpression` or `eventPattern` is required. See full documentation of [Events and Event Patterns in EventBridge](https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html) for details. **Note**: The event pattern size is 2048 by default but it is adjustable up to 4096 characters by submitting a service quota increase request. See [Amazon EventBridge quotas](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-quota.html) for details. * `forceDestroy` - (Optional) Used to delete managed rules created by AWS. Defaults to `false`. * `description` - (Optional) The description of the rule. * `roleArn` - (Optional) The Amazon Resource Name (ARN) associated with the role that is used for target invocation. -* `isEnabled` - (Optional, **Deprecated** Use `state` instead) Whether the rule should be enabled. - Defaults to `true`. - Conflicts with `state`. -* `state` - (Optional) State of the rule. - Valid values are `DISABLED`, `ENABLED`, and `ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS`. - When state is `ENABLED`, the rule is enabled for all events except those delivered by CloudTrail. - To also enable the rule for events delivered by CloudTrail, set `state` to `ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS`. - Defaults to `ENABLED`. - Conflicts with `isEnabled`. - - **NOTE:** The rule state `ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS` cannot be used in conjunction with the `scheduleExpression` argument. +* `isEnabled` - (Optional, **Deprecated** Use `state` instead) Whether the rule should be enabled. Defaults to `true`. Conflicts with `state`. +* `state` - (Optional) State of the rule. Valid values are `DISABLED`, `ENABLED`, and `ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS`. When state is `ENABLED`, the rule is enabled for all events except those delivered by CloudTrail. To also enable the rule for events delivered by CloudTrail, set `state` to `ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS`. Defaults to `ENABLED`. Conflicts with `isEnabled`. * `tags` - (Optional) A map of tags to assign to the resource. If configured with a provider [`defaultTags` 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. +**NOTE:** The rule state `ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS` cannot be used in conjunction with the `scheduleExpression` argument. + ## Attribute Reference This resource exports the following attributes in addition to the arguments above: @@ -124,4 +117,4 @@ Using `terraform import`, import EventBridge Rules using the `event_bus_name/rul % terraform import aws_cloudwatch_event_rule.console example-event-bus/capture-console-sign-in ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/cloudwatch_event_target.html.markdown b/website/docs/cdktf/typescript/r/cloudwatch_event_target.html.markdown index 1bd95ebc54f4..241a5109051f 100644 --- a/website/docs/cdktf/typescript/r/cloudwatch_event_target.html.markdown +++ b/website/docs/cdktf/typescript/r/cloudwatch_event_target.html.markdown @@ -794,6 +794,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `appsyncTarget` - (Optional) Parameters used when you are using the rule to invoke an AppSync GraphQL API mutation. Documented below. A maximum of 1 are allowed. * `batchTarget` - (Optional) Parameters used when you are using the rule to invoke an Amazon Batch Job. Documented below. A maximum of 1 are allowed. * `deadLetterConfig` - (Optional) Parameters used when you are providing a dead letter config. Documented below. A maximum of 1 are allowed. @@ -955,4 +956,4 @@ Using `terraform import`, import EventBridge Targets using `event_bus_name/rule- % terraform import aws_cloudwatch_event_target.test-event-target rule-name/target-id ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/cloudwatch_log_account_policy.html.markdown b/website/docs/cdktf/typescript/r/cloudwatch_log_account_policy.html.markdown index 4cb6e4511a29..3e759cc85db0 100644 --- a/website/docs/cdktf/typescript/r/cloudwatch_log_account_policy.html.markdown +++ b/website/docs/cdktf/typescript/r/cloudwatch_log_account_policy.html.markdown @@ -129,6 +129,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `policyDocument` - (Required) Text of the account policy. Refer to the [AWS docs](https://docs.aws.amazon.com/cli/latest/reference/logs/put-account-policy.html) for more information. * `policyType` - (Required) Type of account policy. One of `DATA_PROTECTION_POLICY`, `SUBSCRIPTION_FILTER_POLICY`, `FIELD_INDEX_POLICY` or `TRANSFORMER_POLICY`. You can have one account policy per type in an account. * `policyName` - (Required) Name of the account policy. @@ -171,4 +172,4 @@ Using `terraform import`, import this resource using the `policyName` and `polic % terraform import aws_cloudwatch_log_account_policy.example "my-account-policy:SUBSCRIPTION_FILTER_POLICY" ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/cloudwatch_log_anomaly_detector.html.markdown b/website/docs/cdktf/typescript/r/cloudwatch_log_anomaly_detector.html.markdown index fd7e92bd2ac2..89f3466589b9 100644 --- a/website/docs/cdktf/typescript/r/cloudwatch_log_anomaly_detector.html.markdown +++ b/website/docs/cdktf/typescript/r/cloudwatch_log_anomaly_detector.html.markdown @@ -55,12 +55,14 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `logGroupArnList` - (Required) Array containing the ARN of the log group that this anomaly detector will watch. You can specify only one log group ARN. The following arguments are optional: +* `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). * `anomalyVisibilityTime` - (Optional) Number of days to have visibility on an anomaly. After this time period has elapsed for an anomaly, it will be automatically baselined and the anomaly detector will treat new occurrences of a similar anomaly as normal. Therefore, if you do not correct the cause of an anomaly during the time period specified in `anomalyVisibilityTime`, it will be considered normal going forward and will not be detected as an anomaly. Valid Range: Minimum value of 7. Maximum value of 90. * `detectorName` - (Optional) Name for this anomaly detector. @@ -103,10 +105,10 @@ class MyConvertedCode extends TerraformStack { ``` -Using `terraform import`, import CloudWatch Log Anomaly Detector using the `example_id_arg`. For example: +Using `terraform import`, import CloudWatch Log Anomaly Detector using the `arn`. For example: ```console % terraform import aws_cloudwatch_log_anomaly_detector.example log_anomaly_detector-arn-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/cloudwatch_log_data_protection_policy.html.markdown b/website/docs/cdktf/typescript/r/cloudwatch_log_data_protection_policy.html.markdown index e48aad619f96..0c09df4534f2 100644 --- a/website/docs/cdktf/typescript/r/cloudwatch_log_data_protection_policy.html.markdown +++ b/website/docs/cdktf/typescript/r/cloudwatch_log_data_protection_policy.html.markdown @@ -87,6 +87,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `logGroupName` - (Required) The name of the log group under which the log stream is to be created. * `policyDocument` - (Required) Specifies the data protection policy in JSON. Read more at [Data protection policy syntax](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/mask-sensitive-log-data-start.html#mask-sensitive-log-data-policysyntax). @@ -126,4 +127,4 @@ Using `terraform import`, import this resource using the `logGroupName`. For exa % terraform import aws_cloudwatch_log_data_protection_policy.example my-log-group ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/cloudwatch_log_delivery.html.markdown b/website/docs/cdktf/typescript/r/cloudwatch_log_delivery.html.markdown index 8f81946a131d..d1d0be9d9491 100644 --- a/website/docs/cdktf/typescript/r/cloudwatch_log_delivery.html.markdown +++ b/website/docs/cdktf/typescript/r/cloudwatch_log_delivery.html.markdown @@ -47,6 +47,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `deliveryDestinationArn` - (Required) The ARN of the delivery destination to use for this delivery. * `deliverySourceName` - (Required) The name of the delivery source to use for this delivery. * `fieldDelimiter` - (Optional) The field delimiter to use between record fields when the final output format of a delivery is in `plain`, `w3c`, or `raw` format. @@ -96,4 +97,4 @@ Using `terraform import`, import CloudWatch Logs Delivery using the `id`. For ex % terraform import aws_cloudwatch_log_delivery.example jsoGVi4Zq8VlYp9n ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/cloudwatch_log_delivery_destination.html.markdown b/website/docs/cdktf/typescript/r/cloudwatch_log_delivery_destination.html.markdown index fe53303e5033..9519a728530c 100644 --- a/website/docs/cdktf/typescript/r/cloudwatch_log_delivery_destination.html.markdown +++ b/website/docs/cdktf/typescript/r/cloudwatch_log_delivery_destination.html.markdown @@ -47,6 +47,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `deliveryDestinationConfiguration` - (Required) The AWS resource that will receive the logs. * `destinationResourceArn` - (Required) The ARN of the AWS destination that this delivery destination represents. * `name` - (Required) The name for this delivery destination. @@ -93,4 +94,4 @@ Using `terraform import`, import CloudWatch Logs Delivery Destination using the % terraform import aws_cloudwatch_log_delivery_destination.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/cloudwatch_log_delivery_destination_policy.html.markdown b/website/docs/cdktf/typescript/r/cloudwatch_log_delivery_destination_policy.html.markdown index 05d9fae1672c..c2c69ca2d8f1 100644 --- a/website/docs/cdktf/typescript/r/cloudwatch_log_delivery_destination_policy.html.markdown +++ b/website/docs/cdktf/typescript/r/cloudwatch_log_delivery_destination_policy.html.markdown @@ -45,6 +45,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `deliveryDestinationName` - (Required) The name of the delivery destination to assign this policy to. * `deliveryDestinationPolicy` - (Required) The contents of the policy. @@ -84,4 +85,4 @@ Using `terraform import`, import CloudWatch Logs Delivery Destination Policy usi % terraform import aws_cloudwatch_log_delivery_destination_policy.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/cloudwatch_log_delivery_source.html.markdown b/website/docs/cdktf/typescript/r/cloudwatch_log_delivery_source.html.markdown index 8df0ae732fa0..7f024332af7a 100644 --- a/website/docs/cdktf/typescript/r/cloudwatch_log_delivery_source.html.markdown +++ b/website/docs/cdktf/typescript/r/cloudwatch_log_delivery_source.html.markdown @@ -42,6 +42,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `logType` - (Required) The type of log that the source is sending. For Amazon Bedrock, the valid value is `APPLICATION_LOGS`. For Amazon CodeWhisperer, the valid value is `EVENT_LOGS`. For IAM Identity Center, the valid value is `ERROR_LOGS`. For Amazon WorkMail, the valid values are `ACCESS_CONTROL_LOGS`, `AUTHENTICATION_LOGS`, `WORKMAIL_AVAILABILITY_PROVIDER_LOGS`, and `WORKMAIL_MAILBOX_ACCESS_LOGS`. * `name` - (Required) The name for this delivery source. * `resourceArn` - (Required) The ARN of the AWS resource that is generating and sending logs. @@ -87,4 +88,4 @@ Using `terraform import`, import CloudWatch Logs Delivery Source using the `name % terraform import aws_cloudwatch_log_delivery_source.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/cloudwatch_log_destination.html.markdown b/website/docs/cdktf/typescript/r/cloudwatch_log_destination.html.markdown index aa3dc2401dcb..98678fafaddc 100644 --- a/website/docs/cdktf/typescript/r/cloudwatch_log_destination.html.markdown +++ b/website/docs/cdktf/typescript/r/cloudwatch_log_destination.html.markdown @@ -40,6 +40,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) A name for the log destination. * `roleArn` - (Required) The ARN of an IAM role that grants Amazon CloudWatch Logs permissions to put data into the target. * `targetArn` - (Required) The ARN of the target Amazon Kinesis stream resource for the destination. @@ -84,4 +85,4 @@ Using `terraform import`, import CloudWatch Logs destinations using the `name`. % terraform import aws_cloudwatch_log_destination.test_destination test_destination ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/cloudwatch_log_destination_policy.html.markdown b/website/docs/cdktf/typescript/r/cloudwatch_log_destination_policy.html.markdown index 5da179cf1047..efbe13225f7e 100644 --- a/website/docs/cdktf/typescript/r/cloudwatch_log_destination_policy.html.markdown +++ b/website/docs/cdktf/typescript/r/cloudwatch_log_destination_policy.html.markdown @@ -74,6 +74,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `destinationName` - (Required) A name for the subscription filter * `accessPolicy` - (Required) The policy document. This is a JSON formatted string. * `forceUpdate` - (Optional) Specify true if you are updating an existing destination policy to grant permission to an organization ID instead of granting permission to individual AWS accounts. @@ -114,4 +115,4 @@ Using `terraform import`, import CloudWatch Logs destination policies using the % terraform import aws_cloudwatch_log_destination_policy.test_destination_policy test_destination ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/cloudwatch_log_group.html.markdown b/website/docs/cdktf/typescript/r/cloudwatch_log_group.html.markdown index d59bd9179012..bf2450b8b43f 100644 --- a/website/docs/cdktf/typescript/r/cloudwatch_log_group.html.markdown +++ b/website/docs/cdktf/typescript/r/cloudwatch_log_group.html.markdown @@ -42,13 +42,14 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Optional, Forces new resource) The name of the log group. If omitted, Terraform will assign a random, unique name. * `namePrefix` - (Optional, Forces new resource) Creates a unique name beginning with the specified prefix. Conflicts with `name`. * `skipDestroy` - (Optional) Set to true if you do not wish the log group (and any logs it may contain) to be deleted at destroy time, and instead just remove the log group from the Terraform state. -* `logGroupClass` - (Optional) Specified the log class of the log group. Possible values are: `STANDARD` or `INFREQUENT_ACCESS`. +* `logGroupClass` - (Optional) Specified the log class of the log group. Possible values are: `STANDARD`, `INFREQUENT_ACCESS`, or `DELIVERY`. * `retentionInDays` - (Optional) Specifies the number of days you want to retain log events in the specified log group. Possible values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1096, 1827, 2192, 2557, 2922, 3288, 3653, and 0. - If you select 0, the events in the log group are always retained and never expire. + If you select 0, the events in the log group are always retained and never expire. If `logGroupClass` is set to `DELIVERY`, this argument is ignored and `retentionInDays` is forcibly set to 2. * `kmsKeyId` - (Optional) The ARN of the KMS Key to use when encrypting log data. Please note, after the AWS KMS CMK is disassociated from the log group, AWS CloudWatch Logs stops encrypting newly ingested data for the log group. All previously ingested data remains encrypted, and AWS CloudWatch Logs requires permissions for the CMK whenever the encrypted data is requested. @@ -89,4 +90,4 @@ Using `terraform import`, import Cloudwatch Log Groups using the `name`. For exa % terraform import aws_cloudwatch_log_group.test_group yada ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/cloudwatch_log_index_policy.html.markdown b/website/docs/cdktf/typescript/r/cloudwatch_log_index_policy.html.markdown index f7162cbe79e5..2c91ae85f230 100644 --- a/website/docs/cdktf/typescript/r/cloudwatch_log_index_policy.html.markdown +++ b/website/docs/cdktf/typescript/r/cloudwatch_log_index_policy.html.markdown @@ -19,13 +19,13 @@ Terraform resource for managing an AWS CloudWatch Logs Index Policy. ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug import { Construct } from "constructs"; -import { Fn, TerraformStack } from "cdktf"; +import { Fn, Token, TerraformStack } from "cdktf"; /* * Provider bindings are generated by running `cdktf get`. * See https://cdk.tf/provider-generation for more details. */ -import { CloudwatchLogIndexPolicy } from "./.gen/providers/aws/"; import { CloudwatchLogGroup } from "./.gen/providers/aws/cloudwatch-log-group"; +import { CloudwatchLogIndexPolicy } from "./.gen/providers/aws/cloudwatch-log-index-policy"; class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); @@ -36,10 +36,12 @@ class MyConvertedCode extends TerraformStack { this, "example_1", { - log_group_name: example.name, - policy_document: Fn.jsonencode({ - Fields: ["eventName"], - }), + logGroupName: example.name, + policyDocument: Token.asString( + Fn.jsonencode({ + Fields: ["eventName"], + }) + ), } ); /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ @@ -51,8 +53,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `logGroupName` - (Required) Log group name to set the policy for. * `policyDocument` - (Required) JSON policy document. This is a JSON formatted string. @@ -72,7 +75,7 @@ import { TerraformStack } from "cdktf"; * Provider bindings are generated by running `cdktf get`. * See https://cdk.tf/provider-generation for more details. */ -import { CloudwatchLogIndexPolicy } from "./.gen/providers/aws/"; +import { CloudwatchLogIndexPolicy } from "./.gen/providers/aws/cloudwatch-log-index-policy"; class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); @@ -92,4 +95,4 @@ Using `terraform import`, import CloudWatch Logs Index Policy using the `logGrou % terraform import aws_cloudwatch_log_index_policy.example /aws/log/group/name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/cloudwatch_log_metric_filter.html.markdown b/website/docs/cdktf/typescript/r/cloudwatch_log_metric_filter.html.markdown index a2b15f92ef7e..91048bcbb8fb 100644 --- a/website/docs/cdktf/typescript/r/cloudwatch_log_metric_filter.html.markdown +++ b/website/docs/cdktf/typescript/r/cloudwatch_log_metric_filter.html.markdown @@ -49,11 +49,13 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) A name for the metric filter. * `pattern` - (Required) A valid [CloudWatch Logs filter pattern](https://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/FilterAndPatternSyntax.html) for extracting metric data out of ingested log events. * `logGroupName` - (Required) The name of the log group to associate the metric filter with. * `metricTransformation` - (Required) A block defining collection of information needed to define how metric data gets emitted. See below. +* `applyOnTransformedLogs` - (Optional) Whether the metric filter will be applied on the transformed version of the log events instead of the original ingested log events. Defaults to `false`. Valid only for log groups that have an active log transformer. The `metricTransformation` block supports the following arguments: @@ -102,4 +104,4 @@ Using `terraform import`, import CloudWatch Log Metric Filter using the `log_gro % terraform import aws_cloudwatch_log_metric_filter.test /aws/lambda/function:test ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/cloudwatch_log_resource_policy.html.markdown b/website/docs/cdktf/typescript/r/cloudwatch_log_resource_policy.html.markdown index a0bc0e6e078f..390a3d72a175 100644 --- a/website/docs/cdktf/typescript/r/cloudwatch_log_resource_policy.html.markdown +++ b/website/docs/cdktf/typescript/r/cloudwatch_log_resource_policy.html.markdown @@ -120,6 +120,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `policyDocument` - (Required) Details of the resource policy, including the identity of the principal that is enabled to put logs to this account. This is formatted as a JSON string. Maximum length of 5120 characters. * `policyName` - (Required) Name of the resource policy. @@ -161,4 +162,4 @@ Using `terraform import`, import CloudWatch log resource policies using the poli % terraform import aws_cloudwatch_log_resource_policy.MyPolicy MyPolicy ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/cloudwatch_log_stream.html.markdown b/website/docs/cdktf/typescript/r/cloudwatch_log_stream.html.markdown index ce800d37e65a..9610c4c83c5e 100644 --- a/website/docs/cdktf/typescript/r/cloudwatch_log_stream.html.markdown +++ b/website/docs/cdktf/typescript/r/cloudwatch_log_stream.html.markdown @@ -43,6 +43,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) The name of the log stream. Must not be longer than 512 characters and must not contain `:` * `logGroupName` - (Required) The name of the log group under which the log stream is to be created. @@ -84,4 +85,4 @@ Using `terraform import`, import Cloudwatch Log Stream using the stream's `logGr % terraform import aws_cloudwatch_log_stream.foo Yada:SampleLogStream1234 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/cloudwatch_log_subscription_filter.html.markdown b/website/docs/cdktf/typescript/r/cloudwatch_log_subscription_filter.html.markdown index 8d25a7774f7a..b5b55266ac23 100644 --- a/website/docs/cdktf/typescript/r/cloudwatch_log_subscription_filter.html.markdown +++ b/website/docs/cdktf/typescript/r/cloudwatch_log_subscription_filter.html.markdown @@ -43,6 +43,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) A name for the subscription filter * `destinationArn` - (Required) The ARN of the destination to deliver matching log events to. Kinesis stream or Lambda function ARN. * `filterPattern` - (Required) A valid CloudWatch Logs filter pattern for subscribing to a filtered stream of log events. Use empty string `""` to match everything. For more information, see the [Amazon CloudWatch Logs User Guide](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html). @@ -86,4 +87,4 @@ Using `terraform import`, import CloudWatch Logs subscription filter using the l % terraform import aws_cloudwatch_log_subscription_filter.test_lambdafunction_logfilter "/aws/lambda/example_lambda_name|test_lambdafunction_logfilter" ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/cloudwatch_metric_alarm.html.markdown b/website/docs/cdktf/typescript/r/cloudwatch_metric_alarm.html.markdown index b91ed26ebbee..f40f40abc33e 100644 --- a/website/docs/cdktf/typescript/r/cloudwatch_metric_alarm.html.markdown +++ b/website/docs/cdktf/typescript/r/cloudwatch_metric_alarm.html.markdown @@ -243,6 +243,7 @@ You must choose one or the other This resource supports the following arguments: +* `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). * `alarmName` - (Required) The descriptive name for the alarm. This name must be unique within the user's AWS account * `comparisonOperator` - (Required) The arithmetic operation to use when comparing the specified Statistic and Threshold. The specified Statistic value is used as the first operand. Either of the following is supported: `GreaterThanOrEqualToThreshold`, `GreaterThanThreshold`, `LessThanThreshold`, `LessThanOrEqualToThreshold`. Additionally, the values `LessThanLowerOrGreaterThanUpperThreshold`, `LessThanLowerThreshold`, and `GreaterThanUpperThreshold` are used only for alarms based on anomaly detection models. * `evaluationPeriods` - (Required) The number of periods over which data is compared to the specified threshold. @@ -344,4 +345,4 @@ Using `terraform import`, import CloudWatch Metric Alarm using the `alarmName`. % terraform import aws_cloudwatch_metric_alarm.test alarm-12345 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/cloudwatch_metric_stream.html.markdown b/website/docs/cdktf/typescript/r/cloudwatch_metric_stream.html.markdown index 889bd826ec54..ab7348f6582b 100644 --- a/website/docs/cdktf/typescript/r/cloudwatch_metric_stream.html.markdown +++ b/website/docs/cdktf/typescript/r/cloudwatch_metric_stream.html.markdown @@ -230,6 +230,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `excludeFilter` - (Optional) List of exclusive metric filters. If you specify this parameter, the stream sends metrics from all metric namespaces except for the namespaces and the conditional metric names that you specify here. If you don't specify metric names or provide empty metric names whole metric namespace is excluded. Conflicts with `includeFilter`. * `includeFilter` - (Optional) List of inclusive metric filters. If you specify this parameter, the stream sends only the conditional metric names from the metric namespaces that you specify here. If you don't specify metric names or provide empty metric names whole metric namespace is included. Conflicts with `excludeFilter`. * `name` - (Optional, Forces new resource) Friendly name of the metric stream. If omitted, Terraform will assign a random, unique name. Conflicts with `namePrefix`. @@ -302,4 +303,4 @@ Using `terraform import`, import CloudWatch metric streams using the `name`. For % terraform import aws_cloudwatch_metric_stream.sample sample-stream-name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/cloudwatch_query_definition.html.markdown b/website/docs/cdktf/typescript/r/cloudwatch_query_definition.html.markdown index a013c5b2b4d8..41b79d502e33 100644 --- a/website/docs/cdktf/typescript/r/cloudwatch_query_definition.html.markdown +++ b/website/docs/cdktf/typescript/r/cloudwatch_query_definition.html.markdown @@ -41,6 +41,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) The name of the query. * `queryString` - (Required) The query to save. You can read more about CloudWatch Logs Query Syntax in the [documentation](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_QuerySyntax.html). * `logGroupNames` - (Optional) Specific log groups to use with the query. @@ -83,4 +84,4 @@ Using `terraform import`, import CloudWatch query definitions using the query de % terraform import aws_cloudwatch_query_definition.example arn:aws:logs:us-west-2:123456789012:query-definition:269951d7-6f75-496d-9d7b-6b7a5486bdbd ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/codeartifact_domain.html.markdown b/website/docs/cdktf/typescript/r/codeartifact_domain.html.markdown index 1bc213a81b44..964feedcce84 100644 --- a/website/docs/cdktf/typescript/r/codeartifact_domain.html.markdown +++ b/website/docs/cdktf/typescript/r/codeartifact_domain.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `domain` - (Required) The name of the domain to create. All domain names in an AWS Region that are in the same AWS account must be unique. The domain name is used as the prefix in DNS hostnames. Do not use sensitive information in a domain name because it is publicly discoverable. * `encryptionKey` - (Optional) The encryption key for the domain. This is used to encrypt content stored in a domain. The KMS Key Amazon Resource Name (ARN). The default aws/codeartifact AWS KMS master key is used if this element is absent. * `tags` - (Optional) Key-value map of resource tags. If configured with a provider [`defaultTags` 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. @@ -87,4 +88,4 @@ Using `terraform import`, import CodeArtifact Domain using the CodeArtifact Doma % terraform import aws_codeartifact_domain.example arn:aws:codeartifact:us-west-2:012345678912:domain/tf-acc-test-8593714120730241305 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/codeartifact_domain_permissions_policy.html.markdown b/website/docs/cdktf/typescript/r/codeartifact_domain_permissions_policy.html.markdown index 461fece75d6a..392ce248d541 100644 --- a/website/docs/cdktf/typescript/r/codeartifact_domain_permissions_policy.html.markdown +++ b/website/docs/cdktf/typescript/r/codeartifact_domain_permissions_policy.html.markdown @@ -73,6 +73,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `domain` - (Required) The name of the domain on which to set the resource policy. * `policyDocument` - (Required) A JSON policy string to be set as the access control resource policy on the provided domain. * `domainOwner` - (Optional) The account number of the AWS account that owns the domain. @@ -117,4 +118,4 @@ Using `terraform import`, import CodeArtifact Domain Permissions Policies using % terraform import aws_codeartifact_domain_permissions_policy.example arn:aws:codeartifact:us-west-2:012345678912:domain/tf-acc-test-1928056699409417367 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/codeartifact_repository.html.markdown b/website/docs/cdktf/typescript/r/codeartifact_repository.html.markdown index 45528112b9e3..0688f8e2bd45 100644 --- a/website/docs/cdktf/typescript/r/codeartifact_repository.html.markdown +++ b/website/docs/cdktf/typescript/r/codeartifact_repository.html.markdown @@ -116,6 +116,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `domain` - (Required) The domain that contains the created repository. * `repository` - (Required) The name of the repository to create. * `domainOwner` - (Optional) The account number of the AWS account that owns the domain. @@ -173,4 +174,4 @@ Using `terraform import`, import CodeArtifact Repository using the CodeArtifact % terraform import aws_codeartifact_repository.example arn:aws:codeartifact:us-west-2:012345678912:repository/tf-acc-test-6968272603913957763/tf-acc-test-6968272603913957763 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/codeartifact_repository_permissions_policy.html.markdown b/website/docs/cdktf/typescript/r/codeartifact_repository_permissions_policy.html.markdown index 25f5a65acf7b..e7fd6fd678e1 100644 --- a/website/docs/cdktf/typescript/r/codeartifact_repository_permissions_policy.html.markdown +++ b/website/docs/cdktf/typescript/r/codeartifact_repository_permissions_policy.html.markdown @@ -93,6 +93,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `repository` - (Required) The name of the repository to set the resource policy on. * `domain` - (Required) The name of the domain on which to set the resource policy. * `policyDocument` - (Required) A JSON policy string to be set as the access control resource policy on the provided domain. @@ -138,4 +139,4 @@ Using `terraform import`, import CodeArtifact Repository Permissions Policies us % terraform import aws_codeartifact_repository_permissions_policy.example arn:aws:codeartifact:us-west-2:012345678912:repository/tf-acc-test-6968272603913957763/tf-acc-test-6968272603913957763 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/codebuild_fleet.html.markdown b/website/docs/cdktf/typescript/r/codebuild_fleet.html.markdown index ca9c9af8ccdd..ac12e9a69968 100644 --- a/website/docs/cdktf/typescript/r/codebuild_fleet.html.markdown +++ b/website/docs/cdktf/typescript/r/codebuild_fleet.html.markdown @@ -89,7 +89,8 @@ The following arguments are required: The following arguments are optional: -* `compute_configuration` - (Optional) The compute configuration of the compute fleet. This is only required if `computeType` is set to `ATTRIBUTE_BASED_COMPUTE`. See [`compute_configuration`](#compute_configuration) below. +* `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). +* `computeConfiguration` - (Optional) The compute configuration of the compute fleet. This is only required if `computeType` is set to `ATTRIBUTE_BASED_COMPUTE` or `CUSTOM_INSTANCE_TYPE`. See [`computeConfiguration`](#compute_configuration) below. * `fleetServiceRole` - (Optional) The service role associated with the compute fleet. * `imageId` - (Optional) The Amazon Machine Image (AMI) of the compute fleet. * `overflowBehavior` - (Optional) Overflow behavior for compute fleet. Valid values: `ON_DEMAND`, `QUEUE`. @@ -100,9 +101,10 @@ The following arguments are optional: ### compute_configuration * `disk` - (Optional) Amount of disk space of the instance type included in the fleet. -* `machine_type` - (Optional) Machine type of the instance type included in the fleet. Valid values: `GENERAL`, `NVME`. -* `memory` - (Optional) Amount of memory of the instance type included in the fleet. -* `vcpu` - (Optional) Number of vCPUs of the instance type included in the fleet. +* `instanceType` - (Optional) EC2 instance type to be launched in the fleet. Specify only if `computeType` is set to `CUSTOM_INSTANCE_TYPE`. See [Supported instance families](https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-compute-types.html#environment-reserved-capacity.instance-types). +* `machineType` - (Optional) Machine type of the instance type included in the fleet. Valid values: `GENERAL`, `NVME`. Specify only if `computeType` is set to `ATTRIBUTE_BASED_COMPUTE`. +* `memory` - (Optional) Amount of memory of the instance type included in the fleet. Specify only if `computeType` is set to `ATTRIBUTE_BASED_COMPUTE`. +* `vcpu` - (Optional) Number of vCPUs of the instance type included in the fleet. Specify only if `computeType` is set to `ATTRIBUTE_BASED_COMPUTE`. ### scaling_configuration @@ -162,4 +164,4 @@ Using `terraform import`, import CodeBuild Fleet using the `name`. For example: % terraform import aws_codebuild_fleet.name fleet-name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/codebuild_project.html.markdown b/website/docs/cdktf/typescript/r/codebuild_project.html.markdown index 43ff29de4971..155f0b6bf494 100644 --- a/website/docs/cdktf/typescript/r/codebuild_project.html.markdown +++ b/website/docs/cdktf/typescript/r/codebuild_project.html.markdown @@ -16,6 +16,8 @@ source (e.g., the "rebuild every time a code change is pushed" option in the Cod ## Example Usage +### Basic Usage + ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug import { Construct } from "constructs"; @@ -258,6 +260,11 @@ class MyConvertedCode extends TerraformStack { ``` +### Runner Project + +While no special configuration is required for `aws_codebuild_project` to create a project as a Runner Project, an `aws_codebuild_webhook` resource with an appropriate `filterGroup` is required. +See the [`aws_codebuild_webhook` resource documentation example](/docs/providers/aws/r/codebuild_webhook.html#for-codebuild-runner-project) for more details. + ## Argument Reference The following arguments are required: @@ -271,6 +278,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `badgeEnabled` - (Optional) Generates a publicly-accessible URL for the projects build badge. Available as `badgeUrl` attribute when enabled. * `buildBatchConfig` - (Optional) Defines the batch build options for the project. @@ -358,6 +366,7 @@ The following arguments are optional: `BUILD_GENERAL1_SMALL`, `BUILD_GENERAL1_MEDIUM`, `BUILD_GENERAL1_LARGE`, `BUILD_GENERAL1_XLARGE`, `BUILD_GENERAL1_2XLARGE`, `BUILD_LAMBDA_1GB`, `BUILD_LAMBDA_2GB`, `BUILD_LAMBDA_4GB`, `BUILD_LAMBDA_8GB`, `BUILD_LAMBDA_10GB`. For additional information, see the [CodeBuild User Guide](https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-compute-types.html). +* `dockerServer` - (Optional) Configuration block. Detailed below. * `fleet` - (Optional) Configuration block. Detailed below. * `environmentVariable` - (Optional) Configuration block. Detailed below. * `imagePullCredentialsType` - (Optional) Type of credentials AWS CodeBuild uses to pull images in your build. Valid @@ -376,6 +385,11 @@ The following arguments are optional: `LINUX_LAMBDA_CONTAINER`, `ARM_LAMBDA_CONTAINER`, `LINUX_EC2`, `ARM_EC2`, `WINDOWS_EC2`, `MAC_ARM`. For additional information, see the [CodeBuild User Guide](https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-compute-types.html). +#### environment: docker_server + +* `computeType` - (Required) Compute type for the Docker server. Valid values: `BUILD_GENERAL1_SMALL`, `BUILD_GENERAL1_MEDIUM`, `BUILD_GENERAL1_LARGE`, `BUILD_GENERAL1_XLARGE`, and `BUILD_GENERAL1_2XLARGE`. +* `securityGroupIds` - (Optional) List of security group IDs to assign to the Docker server. + #### environment: fleet * `fleetArn` - (Optional) Compute fleet ARN for the build project. @@ -602,4 +616,4 @@ Using `terraform import`, import CodeBuild Project using the `name`. For example % terraform import aws_codebuild_project.name project-name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/codebuild_report_group.html.markdown b/website/docs/cdktf/typescript/r/codebuild_report_group.html.markdown index 405a38b21957..50b2005b2e89 100644 --- a/website/docs/cdktf/typescript/r/codebuild_report_group.html.markdown +++ b/website/docs/cdktf/typescript/r/codebuild_report_group.html.markdown @@ -92,6 +92,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) The name of a Report Group. * `type` - (Required) The type of the Report Group. Valid value are `TEST` and `CODE_COVERAGE`. * `exportConfig` - (Required) Information about the destination where the raw data of this Report Group is exported. see [Export Config](#export-config) documented below. @@ -153,4 +154,4 @@ Using `terraform import`, import CodeBuild Report Group using the CodeBuild Repo % terraform import aws_codebuild_report_group.example arn:aws:codebuild:us-west-2:123456789:report-group/report-group-name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/codebuild_resource_policy.html.markdown b/website/docs/cdktf/typescript/r/codebuild_resource_policy.html.markdown index 37954a1c8cb2..383c6668d9a0 100644 --- a/website/docs/cdktf/typescript/r/codebuild_resource_policy.html.markdown +++ b/website/docs/cdktf/typescript/r/codebuild_resource_policy.html.markdown @@ -85,6 +85,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `resourceArn` - (Required) The ARN of the Project or ReportGroup resource you want to associate with a resource policy. * `policy` - (Required) A JSON-formatted resource policy. For more information, see [Sharing a Projec](https://docs.aws.amazon.com/codebuild/latest/userguide/project-sharing.html#project-sharing-share) and [Sharing a Report Group](https://docs.aws.amazon.com/codebuild/latest/userguide/report-groups-sharing.html#report-groups-sharing-share). @@ -126,4 +127,4 @@ Using `terraform import`, import CodeBuild Resource Policy using the CodeBuild R % terraform import aws_codebuild_resource_policy.example arn:aws:codebuild:us-west-2:123456789:report-group/report-group-name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/codebuild_source_credential.html.markdown b/website/docs/cdktf/typescript/r/codebuild_source_credential.html.markdown index 12279a90a310..16b56ae484c9 100644 --- a/website/docs/cdktf/typescript/r/codebuild_source_credential.html.markdown +++ b/website/docs/cdktf/typescript/r/codebuild_source_credential.html.markdown @@ -95,6 +95,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `authType` - (Required) The type of authentication used to connect to a GitHub, GitHub Enterprise, or Bitbucket repository. Valid values are `BASIC_AUTH`, `PERSONAL_ACCESS_TOKEN`, `CODECONNECTIONS`, and `SECRETS_MANAGER`. An OAUTH connection is not supported by the API. @@ -145,4 +146,4 @@ Using `terraform import`, import CodeBuild Source Credential using the CodeBuild % terraform import aws_codebuild_source_credential.example arn:aws:codebuild:us-west-2:123456789:token:github ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/codebuild_webhook.html.markdown b/website/docs/cdktf/typescript/r/codebuild_webhook.html.markdown index e32dabcf047d..a2ea4636441c 100644 --- a/website/docs/cdktf/typescript/r/codebuild_webhook.html.markdown +++ b/website/docs/cdktf/typescript/r/codebuild_webhook.html.markdown @@ -106,10 +106,47 @@ class MyConvertedCode extends TerraformStack { ``` +### For CodeBuild Runner Project + +To create a CodeBuild project as a Runner Project, the following `aws_codebuild_webhook` resource is required for the project. +See thr [AWS Documentation](https://docs.aws.amazon.com/codebuild/latest/userguide/action-runner.html) for more information about CodeBuild Runner Projects. + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { Token, TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { CodebuildWebhook } from "./.gen/providers/aws/codebuild-webhook"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + new CodebuildWebhook(this, "example", { + buildType: "BUILD", + filterGroup: [ + { + filter: [ + { + pattern: "WORKFLOW_JOB_QUEUED", + type: "EVENT", + }, + ], + }, + ], + projectName: Token.asString(awsCodebuildProjectExample.name), + }); + } +} + +``` + ## Argument Reference This resource supports the following arguments: +* `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). * `projectName` - (Required) The name of the build project. * `buildType` - (Optional) The type of build this webhook will trigger. Valid values for this parameter are: `BUILD`, `BUILD_BATCH`. * `manualCreation` - (Optional) If true, CodeBuild doesn't create a webhook in GitHub and instead returns `payloadUrl` and `secret` values for the webhook. The `payloadUrl` and `secret` values in the output can be used to manually create a webhook within GitHub. @@ -172,4 +209,4 @@ Using `terraform import`, import CodeBuild Webhooks using the CodeBuild Project % terraform import aws_codebuild_webhook.example MyProjectName ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/codecatalyst_dev_environment.html.markdown b/website/docs/cdktf/typescript/r/codecatalyst_dev_environment.html.markdown index ce7dcaffecdb..ffa64904617e 100644 --- a/website/docs/cdktf/typescript/r/codecatalyst_dev_environment.html.markdown +++ b/website/docs/cdktf/typescript/r/codecatalyst_dev_environment.html.markdown @@ -62,6 +62,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `inactivityTimeoutMinutes` - (Optional) The amount of time the Dev Environment will run without any activity detected before stopping, in minutes. Only whole integers are allowed. Dev Environments consume compute minutes when running. * `repositories` - (Optional) The source repository that contains the branch to clone into the Dev Environment. @@ -93,4 +94,4 @@ This resource exports the following attributes in addition to the arguments abov - `update` - (Default `10m`) - `delete` - (Default `10m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/codecatalyst_project.html.markdown b/website/docs/cdktf/typescript/r/codecatalyst_project.html.markdown index f8cecc82e958..7cd7e6fbbfc8 100644 --- a/website/docs/cdktf/typescript/r/codecatalyst_project.html.markdown +++ b/website/docs/cdktf/typescript/r/codecatalyst_project.html.markdown @@ -47,6 +47,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `description` - (Optional) The description of the project. This description will be displayed to all users of the project. We recommend providing a brief description of the project and its intended purpose. ## Attribute Reference @@ -96,4 +97,4 @@ Using `terraform import`, import CodeCatalyst Project using the `id`. For exampl % terraform import aws_codecatalyst_project.example project-id-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/codecatalyst_source_repository.html.markdown b/website/docs/cdktf/typescript/r/codecatalyst_source_repository.html.markdown index 0749dc04606d..078747358cf7 100644 --- a/website/docs/cdktf/typescript/r/codecatalyst_source_repository.html.markdown +++ b/website/docs/cdktf/typescript/r/codecatalyst_source_repository.html.markdown @@ -48,6 +48,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `description` - (Optional) The description of the project. This description will be displayed to all users of the project. We recommend providing a brief description of the project and its intended purpose. ## Attribute Reference @@ -96,4 +97,4 @@ Using `terraform import`, import CodeCatalyst Source Repository using the `id`. % terraform import aws_codecatalyst_source_repository.example example-repo ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/codecommit_approval_rule_template.html.markdown b/website/docs/cdktf/typescript/r/codecommit_approval_rule_template.html.markdown index 3f1c30c69e70..6bc577752e85 100644 --- a/website/docs/cdktf/typescript/r/codecommit_approval_rule_template.html.markdown +++ b/website/docs/cdktf/typescript/r/codecommit_approval_rule_template.html.markdown @@ -54,6 +54,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `content` - (Required) The content of the approval rule template. Maximum of 3000 characters. * `name` - (Required) The name for the approval rule template. Maximum of 100 characters. * `description` - (Optional) The description of the approval rule template. Maximum of 1000 characters. @@ -100,4 +101,4 @@ Using `terraform import`, import CodeCommit approval rule templates using the `n % terraform import aws_codecommit_approval_rule_template.imported ExistingApprovalRuleTemplateName ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/codecommit_approval_rule_template_association.html.markdown b/website/docs/cdktf/typescript/r/codecommit_approval_rule_template_association.html.markdown index 08b12419cda0..7d070cb2269c 100644 --- a/website/docs/cdktf/typescript/r/codecommit_approval_rule_template_association.html.markdown +++ b/website/docs/cdktf/typescript/r/codecommit_approval_rule_template_association.html.markdown @@ -43,6 +43,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `approvalRuleTemplateName` - (Required) The name for the approval rule template. * `repositoryName` - (Required) The name of the repository that you want to associate with the template. @@ -84,4 +85,4 @@ Using `terraform import`, import CodeCommit approval rule template associations % terraform import aws_codecommit_approval_rule_template_association.example approver-rule-for-example,MyExampleRepo ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/codecommit_repository.html.markdown b/website/docs/cdktf/typescript/r/codecommit_repository.html.markdown index c503ab0a04bd..751037451727 100644 --- a/website/docs/cdktf/typescript/r/codecommit_repository.html.markdown +++ b/website/docs/cdktf/typescript/r/codecommit_repository.html.markdown @@ -74,6 +74,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `repositoryName` - (Required) The name for the repository. This needs to be less than 100 characters. * `description` - (Optional) The description of the repository. This needs to be less than 1000 characters * `defaultBranch` - (Optional) The default branch of the repository. The branch specified here needs to exist. @@ -122,4 +123,4 @@ Using `terraform import`, import CodeCommit repository using repository name. Fo % terraform import aws_codecommit_repository.imported ExistingRepo ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/codecommit_trigger.html.markdown b/website/docs/cdktf/typescript/r/codecommit_trigger.html.markdown index de735411092a..e61f6a5a4bea 100644 --- a/website/docs/cdktf/typescript/r/codecommit_trigger.html.markdown +++ b/website/docs/cdktf/typescript/r/codecommit_trigger.html.markdown @@ -53,6 +53,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `repositoryName` - (Required) The name for the repository. This needs to be less than 100 characters. * `trigger` - (Required) The name of the trigger. * `name` - (Required) The name of the trigger. @@ -67,4 +68,4 @@ This resource exports the following attributes in addition to the arguments abov * `configurationId` - System-generated unique identifier. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/codeconnections_connection.html.markdown b/website/docs/cdktf/typescript/r/codeconnections_connection.html.markdown index 45738d831b89..661ff12135bd 100644 --- a/website/docs/cdktf/typescript/r/codeconnections_connection.html.markdown +++ b/website/docs/cdktf/typescript/r/codeconnections_connection.html.markdown @@ -43,6 +43,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) The name of the connection to be created. The name must be unique in the calling AWS account. Changing `name` will create a new resource. * `providerType` - (Optional) The name of the external provider where your third-party code repository is configured. Changing `providerType` will create a new resource. Conflicts with `hostArn`. * `hostArn` - (Optional) The Amazon Resource Name (ARN) of the host associated with the connection. Conflicts with `providerType` @@ -52,9 +53,9 @@ This resource supports the following arguments: This resource exports the following attributes in addition to the arguments above: -* `id` - The codeconnections connection ARN. * `arn` - The codeconnections connection ARN. * `connectionStatus` - The codeconnections connection status. Possible values are `PENDING`, `AVAILABLE` and `ERROR`. +* `id` - (**Deprecated**) The codeconnections connection ARN. * `tagsAll` - A map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). ## Import @@ -89,4 +90,4 @@ Using `terraform import`, import CodeConnections connection using the ARN. For e % terraform import aws_codeconnections_connection.test-connection arn:aws:codeconnections:us-west-1:0123456789:connection/79d4d357-a2ee-41e4-b350-2fe39ae59448 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/codeconnections_host.html.markdown b/website/docs/cdktf/typescript/r/codeconnections_host.html.markdown index 49eee71f27d6..dfc5deac608e 100644 --- a/website/docs/cdktf/typescript/r/codeconnections_host.html.markdown +++ b/website/docs/cdktf/typescript/r/codeconnections_host.html.markdown @@ -44,6 +44,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) The name of the host to be created. The name must be unique in the calling AWS account. * `providerEndpoint` - (Required) The endpoint of the infrastructure to be represented by the host after it is created. * `providerType` - (Required) The name of the external provider where your third-party code repository is configured. @@ -60,8 +61,8 @@ A `vpcConfiguration` block supports the following arguments: This resource exports the following attributes in addition to the arguments above: -* `id` - The CodeConnections Host ARN. * `arn` - The CodeConnections Host ARN. +* `id` - (**Deprecated**) The CodeConnections Host ARN. * `status` - The CodeConnections Host status. Possible values are `PENDING`, `AVAILABLE`, `VPC_CONFIG_DELETING`, `VPC_CONFIG_INITIALIZING`, and `VPC_CONFIG_FAILED_INITIALIZATION`. ## Import @@ -96,4 +97,4 @@ Using `terraform import`, import CodeConnections Host using the ARN. For example % terraform import aws_codeconnections_host.example-host arn:aws:codeconnections:us-west-1:0123456789:host/79d4d357-a2ee-41e4-b350-2fe39ae59448 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/codedeploy_app.html.markdown b/website/docs/cdktf/typescript/r/codedeploy_app.html.markdown index 612c516c4ef0..907c50252f5a 100644 --- a/website/docs/cdktf/typescript/r/codedeploy_app.html.markdown +++ b/website/docs/cdktf/typescript/r/codedeploy_app.html.markdown @@ -87,6 +87,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) The name of the application. * `computePlatform` - (Optional) The compute platform can either be `ECS`, `Lambda`, or `Server`. Default is `Server`. * `tags` - (Optional) Key-value map of resource tags. If configured with a provider [`defaultTags` 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. @@ -131,4 +132,4 @@ Using `terraform import`, import CodeDeploy Applications using the `name`. For e % terraform import aws_codedeploy_app.example my-application ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/codedeploy_deployment_config.html.markdown b/website/docs/cdktf/typescript/r/codedeploy_deployment_config.html.markdown index 9d7d71e2fb63..e8198a61d190 100644 --- a/website/docs/cdktf/typescript/r/codedeploy_deployment_config.html.markdown +++ b/website/docs/cdktf/typescript/r/codedeploy_deployment_config.html.markdown @@ -130,6 +130,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `deploymentConfigName` - (Required) The name of the deployment config. * `computePlatform` - (Optional) The compute platform can be `Server`, `Lambda`, or `ECS`. Default is `Server`. * `minimumHealthyHosts` - (Optional) A minimum_healthy_hosts block. Required for `Server` compute platform. Minimum Healthy Hosts are documented below. @@ -211,4 +212,4 @@ Using `terraform import`, import CodeDeploy Deployment Configurations using the % terraform import aws_codedeploy_deployment_config.example my-deployment-config ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/codedeploy_deployment_group.html.markdown b/website/docs/cdktf/typescript/r/codedeploy_deployment_group.html.markdown index ca5e1dd0c161..52b370bc315e 100644 --- a/website/docs/cdktf/typescript/r/codedeploy_deployment_group.html.markdown +++ b/website/docs/cdktf/typescript/r/codedeploy_deployment_group.html.markdown @@ -246,6 +246,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `appName` - (Required) The name of the application. * `deploymentGroupName` - (Required) The name of the deployment group. * `serviceRoleArn` - (Required) The service role ARN that allows deployments. @@ -452,4 +453,4 @@ Using `terraform import`, import CodeDeploy Deployment Groups using `appName`, a [1]: http://docs.aws.amazon.com/codedeploy/latest/userguide/monitoring-sns-event-notifications-create-trigger.html - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/codeguruprofiler_profiling_group.html.markdown b/website/docs/cdktf/typescript/r/codeguruprofiler_profiling_group.html.markdown index e723465f4a35..a22c0cc6910f 100644 --- a/website/docs/cdktf/typescript/r/codeguruprofiler_profiling_group.html.markdown +++ b/website/docs/cdktf/typescript/r/codeguruprofiler_profiling_group.html.markdown @@ -50,6 +50,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `computePlatform` - (Optional) Compute platform of the profiling group. * `tags` - (Optional) Map of tags assigned to the resource. If configured with a provider [`defaultTags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. @@ -97,4 +98,4 @@ Using `terraform import`, import CodeGuru Profiler Profiling Group using the `id % terraform import aws_codeguruprofiler_profiling_group.example profiling_group-name-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/codegurureviewer_repository_association.html.markdown b/website/docs/cdktf/typescript/r/codegurureviewer_repository_association.html.markdown index 531ba86acdbf..c07b03c9afbc 100644 --- a/website/docs/cdktf/typescript/r/codegurureviewer_repository_association.html.markdown +++ b/website/docs/cdktf/typescript/r/codegurureviewer_repository_association.html.markdown @@ -66,6 +66,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `kmsKeyDetails` - (Optional) An object describing the KMS key to asssociate. Block is documented below. ## repository @@ -122,4 +123,4 @@ This resource exports the following attributes in addition to the arguments abov * `update` - (Default `180m`) * `delete` - (Default `90m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/codepipeline.html.markdown b/website/docs/cdktf/typescript/r/codepipeline.html.markdown index 1edf6a9194f3..fa3f65109d19 100644 --- a/website/docs/cdktf/typescript/r/codepipeline.html.markdown +++ b/website/docs/cdktf/typescript/r/codepipeline.html.markdown @@ -191,18 +191,19 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) The name of the pipeline. * `pipelineType` - (Optional) Type of the pipeline. Possible values are: `V1` and `V2`. Default value is `V1`. * `roleArn` - (Required) A service role Amazon Resource Name (ARN) that grants AWS CodePipeline permission to make calls to AWS services on your behalf. * `artifactStore` (Required) One or more artifact_store blocks. Artifact stores are documented below. * `executionMode` (Optional) The method that the pipeline will use to handle multiple executions. The default mode is `SUPERSEDED`. For value values, refer to the [AWS documentation](https://docs.aws.amazon.com/codepipeline/latest/APIReference/API_PipelineDeclaration.html#CodePipeline-Type-PipelineDeclaration-executionMode). - - **Note:** `QUEUED` or `PARALLEL` mode can only be used with V2 pipelines. * `stage` (Minimum of at least two `stage` blocks is required) A stage block. Stages are documented below. * `tags` - (Optional) A map of tags to assign to the resource. If configured with a provider [`defaultTags` 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. * `trigger` - (Optional) A trigger block. Valid only when `pipelineType` is `V2`. Triggers are documented below. * `variable` - (Optional) A pipeline-level variable block. Valid only when `pipelineType` is `V2`. Variable are documented below. +**Note:** `QUEUED` or `PARALLEL` mode can only be used with V2 pipelines. + ### `artifactStore` An `artifactStore` block supports the following arguments: @@ -400,4 +401,4 @@ Using `terraform import`, import CodePipelines using the `name`. For example: % terraform import aws_codepipeline.example example-pipeline ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/codepipeline_custom_action_type.html.markdown b/website/docs/cdktf/typescript/r/codepipeline_custom_action_type.html.markdown index 63d74b519255..62889c689b5b 100644 --- a/website/docs/cdktf/typescript/r/codepipeline_custom_action_type.html.markdown +++ b/website/docs/cdktf/typescript/r/codepipeline_custom_action_type.html.markdown @@ -48,6 +48,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `category` - (Required) The category of the custom action. Valid values: `Source`, `Build`, `Deploy`, `Test`, `Invoke`, `Approval` * `configurationProperty` - (Optional) The configuration properties for the custom action. Max 10 items. @@ -129,4 +130,4 @@ Using `terraform import`, import CodeDeploy CustomActionType using the `id`. For % terraform import aws_codepipeline_custom_action_type.example Build:terraform:1 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/codepipeline_webhook.html.markdown b/website/docs/cdktf/typescript/r/codepipeline_webhook.html.markdown index 34669979de25..d24aa438ab02 100644 --- a/website/docs/cdktf/typescript/r/codepipeline_webhook.html.markdown +++ b/website/docs/cdktf/typescript/r/codepipeline_webhook.html.markdown @@ -122,6 +122,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) The name of the webhook. * `authentication` - (Required) The type of authentication to use. One of `IP`, `GITHUB_HMAC`, or `UNAUTHENTICATED`. * `authenticationConfiguration` - (Optional) An `auth` block. Required for `IP` and `GITHUB_HMAC`. Auth blocks are documented below. @@ -181,4 +182,4 @@ Using `terraform import`, import CodePipeline Webhooks using their ARN. For exam % terraform import aws_codepipeline_webhook.example arn:aws:codepipeline:us-west-2:123456789012:webhook:example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/codestarconnections_connection.html.markdown b/website/docs/cdktf/typescript/r/codestarconnections_connection.html.markdown index 562f4616dc41..e0c3bd4371d3 100644 --- a/website/docs/cdktf/typescript/r/codestarconnections_connection.html.markdown +++ b/website/docs/cdktf/typescript/r/codestarconnections_connection.html.markdown @@ -112,6 +112,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) The name of the connection to be created. The name must be unique in the calling AWS account. Changing `name` will create a new resource. * `providerType` - (Optional) The name of the external provider where your third-party code repository is configured. Valid values are `Bitbucket`, `GitHub`, `GitHubEnterpriseServer`, `GitLab` or `GitLabSelfManaged`. Changing `providerType` will create a new resource. Conflicts with `hostArn` * `hostArn` - (Optional) The Amazon Resource Name (ARN) of the host associated with the connection. Conflicts with `providerType` @@ -158,4 +159,4 @@ Using `terraform import`, import CodeStar connections using the ARN. For example % terraform import aws_codestarconnections_connection.test-connection arn:aws:codestar-connections:us-west-1:0123456789:connection/79d4d357-a2ee-41e4-b350-2fe39ae59448 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/codestarconnections_host.html.markdown b/website/docs/cdktf/typescript/r/codestarconnections_host.html.markdown index 3cb7f2e2c8db..35381a885dce 100644 --- a/website/docs/cdktf/typescript/r/codestarconnections_host.html.markdown +++ b/website/docs/cdktf/typescript/r/codestarconnections_host.html.markdown @@ -42,6 +42,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) The name of the host to be created. The name must be unique in the calling AWS account. * `providerEndpoint` - (Required) The endpoint of the infrastructure to be represented by the host after it is created. * `providerType` - (Required) The name of the external provider where your third-party code repository is configured. @@ -94,4 +95,4 @@ Using `terraform import`, import CodeStar Host using the ARN. For example: % terraform import aws_codestarconnections_host.example-host arn:aws:codestar-connections:us-west-1:0123456789:host/79d4d357-a2ee-41e4-b350-2fe39ae59448 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/codestarnotifications_notification_rule.html.markdown b/website/docs/cdktf/typescript/r/codestarnotifications_notification_rule.html.markdown index b120f69d8f4f..aef8bbbed7b1 100644 --- a/website/docs/cdktf/typescript/r/codestarnotifications_notification_rule.html.markdown +++ b/website/docs/cdktf/typescript/r/codestarnotifications_notification_rule.html.markdown @@ -74,6 +74,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `detailType` - (Required) The level of detail to include in the notifications for this resource. Possible values are `BASIC` and `FULL`. * `eventTypeIds` - (Required) A list of event types associated with this notification rule. For list of allowed events see [here](https://docs.aws.amazon.com/codestar-notifications/latest/userguide/concepts.html#concepts-api). @@ -128,4 +129,4 @@ Using `terraform import`, import CodeStar notification rule using the ARN. For e % terraform import aws_codestarnotifications_notification_rule.foo arn:aws:codestar-notifications:us-west-1:0123456789:notificationrule/2cdc68a3-8f7c-4893-b6a5-45b362bd4f2b ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/cognito_identity_pool.html.markdown b/website/docs/cdktf/typescript/r/cognito_identity_pool.html.markdown index 15ee69e7eec6..968a85ac5aa9 100644 --- a/website/docs/cdktf/typescript/r/cognito_identity_pool.html.markdown +++ b/website/docs/cdktf/typescript/r/cognito_identity_pool.html.markdown @@ -67,6 +67,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `identityPoolName` (Required) - The Cognito Identity Pool name. * `allowUnauthenticatedIdentities` (Required) - Whether the identity pool supports unauthenticated logins or not. * `allowClassicFlow` (Optional) - Enables or disables the classic / basic authentication flow. Default is `false`. @@ -124,4 +125,4 @@ Using `terraform import`, import Cognito Identity Pool using its ID. For example % terraform import aws_cognito_identity_pool.mypool us-west-2:1a234567-8901-234b-5cde-f6789g01h2i3 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/cognito_identity_pool_provider_principal_tag.html.markdown b/website/docs/cdktf/typescript/r/cognito_identity_pool_provider_principal_tag.html.markdown index fcacb186a25d..62e7c06c10f8 100644 --- a/website/docs/cdktf/typescript/r/cognito_identity_pool_provider_principal_tag.html.markdown +++ b/website/docs/cdktf/typescript/r/cognito_identity_pool_provider_principal_tag.html.markdown @@ -85,6 +85,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `identityPoolId` (Required) - An identity pool ID. * `identityProviderName` (Required) - The name of the identity provider. * `principalTags`: (Optional: []) - String to string map of variables. @@ -126,4 +127,4 @@ Using `terraform import`, import Cognito Identity Pool Roles Attachment using th % terraform import aws_cognito_identity_pool_provider_principal_tag.example us-west-2_abc123:CorpAD ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/cognito_identity_pool_roles_attachment.html.markdown b/website/docs/cdktf/typescript/r/cognito_identity_pool_roles_attachment.html.markdown index 289875313b77..5f72a5af4334 100644 --- a/website/docs/cdktf/typescript/r/cognito_identity_pool_roles_attachment.html.markdown +++ b/website/docs/cdktf/typescript/r/cognito_identity_pool_roles_attachment.html.markdown @@ -130,6 +130,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `identityPoolId` (Required) - An identity pool ID in the format `REGION_GUID`. * `roleMapping` (Optional) - A List of [Role Mapping](#role-mappings). * `roles` (Required) - The map of roles associated with this pool. For a given role, the key will be either "authenticated" or "unauthenticated" and the value will be the Role ARN. @@ -186,4 +187,4 @@ Using `terraform import`, import Cognito Identity Pool Roles Attachment using th % terraform import aws_cognito_identity_pool_roles_attachment.example us-west-2:b64805ad-cb56-40ba-9ffc-f5d8207e6d42 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/cognito_identity_provider.html.markdown b/website/docs/cdktf/typescript/r/cognito_identity_provider.html.markdown index d7387cc885e7..58ba7a3e3b2a 100644 --- a/website/docs/cdktf/typescript/r/cognito_identity_provider.html.markdown +++ b/website/docs/cdktf/typescript/r/cognito_identity_provider.html.markdown @@ -55,6 +55,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `userPoolId` (Required) - The user pool id * `providerName` (Required) - The provider name * `providerType` (Required) - The provider type. [See AWS API for valid values](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateIdentityProvider.html#CognitoUserPools-CreateIdentityProvider-request-ProviderType) @@ -98,4 +99,4 @@ Using `terraform import`, import `aws_cognito_identity_provider` resources using % terraform import aws_cognito_identity_provider.example us-west-2_abc123:CorpAD ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/cognito_log_delivery_configuration.html.markdown b/website/docs/cdktf/typescript/r/cognito_log_delivery_configuration.html.markdown new file mode 100644 index 000000000000..2cf63c615586 --- /dev/null +++ b/website/docs/cdktf/typescript/r/cognito_log_delivery_configuration.html.markdown @@ -0,0 +1,310 @@ +--- +subcategory: "Cognito IDP (Identity Provider)" +layout: "aws" +page_title: "AWS: aws_cognito_log_delivery_configuration" +description: |- + Manages an AWS Cognito IDP (Identity Provider) Log Delivery Configuration. +--- + + + +# Resource: aws_cognito_log_delivery_configuration + +Manages an AWS Cognito IDP (Identity Provider) Log Delivery Configuration. + +## Example Usage + +### Basic Usage with CloudWatch Logs + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { Token, TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { CloudwatchLogGroup } from "./.gen/providers/aws/cloudwatch-log-group"; +import { CognitoLogDeliveryConfiguration } from "./.gen/providers/aws/cognito-log-delivery-configuration"; +import { CognitoUserPool } from "./.gen/providers/aws/cognito-user-pool"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + const example = new CloudwatchLogGroup(this, "example", { + name: "example", + }); + const awsCognitoUserPoolExample = new CognitoUserPool(this, "example_1", { + name: "example", + }); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + awsCognitoUserPoolExample.overrideLogicalId("example"); + const awsCognitoLogDeliveryConfigurationExample = + new CognitoLogDeliveryConfiguration(this, "example_2", { + logConfigurations: [ + { + cloudWatchLogsConfiguration: [ + { + logGroupArn: example.arn, + }, + ], + eventSource: "userNotification", + logLevel: "ERROR", + }, + ], + userPoolId: Token.asString(awsCognitoUserPoolExample.id), + }); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + awsCognitoLogDeliveryConfigurationExample.overrideLogicalId("example"); + } +} + +``` + +### Multiple Log Configurations with Different Destinations + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { Fn, Token, TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { CloudwatchLogGroup } from "./.gen/providers/aws/cloudwatch-log-group"; +import { CognitoLogDeliveryConfiguration } from "./.gen/providers/aws/cognito-log-delivery-configuration"; +import { CognitoUserPool } from "./.gen/providers/aws/cognito-user-pool"; +import { IamRole } from "./.gen/providers/aws/iam-role"; +import { IamRolePolicy } from "./.gen/providers/aws/iam-role-policy"; +import { KinesisFirehoseDeliveryStream } from "./.gen/providers/aws/kinesis-firehose-delivery-stream"; +import { S3Bucket } from "./.gen/providers/aws/s3-bucket"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + const example = new CloudwatchLogGroup(this, "example", { + name: "example", + }); + const awsCognitoUserPoolExample = new CognitoUserPool(this, "example_1", { + name: "example", + }); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + awsCognitoUserPoolExample.overrideLogicalId("example"); + const firehose = new IamRole(this, "firehose", { + assumeRolePolicy: Token.asString( + Fn.jsonencode({ + Statement: [ + { + Action: "sts:AssumeRole", + Effect: "Allow", + Principal: { + Service: "firehose.amazonaws.com", + }, + }, + ], + Version: "2012-10-17", + }) + ), + name: "firehose-role", + }); + const awsS3BucketExample = new S3Bucket(this, "example_3", { + bucket: "example-bucket", + forceDestroy: true, + }); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + awsS3BucketExample.overrideLogicalId("example"); + const awsIamRolePolicyFirehose = new IamRolePolicy(this, "firehose_4", { + name: "firehose-policy", + policy: Token.asString( + Fn.jsonencode({ + Statement: [ + { + Action: [ + "s3:AbortMultipartUpload", + "s3:GetBucketLocation", + "s3:GetObject", + "s3:ListBucket", + "s3:ListBucketMultipartUploads", + "s3:PutObject", + ], + Effect: "Allow", + Resource: [ + awsS3BucketExample.arn, + "${" + awsS3BucketExample.arn + "}/*", + ], + }, + ], + Version: "2012-10-17", + }) + ), + role: firehose.id, + }); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + awsIamRolePolicyFirehose.overrideLogicalId("firehose"); + const awsKinesisFirehoseDeliveryStreamExample = + new KinesisFirehoseDeliveryStream(this, "example_5", { + destination: "extended_s3", + extendedS3Configuration: { + bucketArn: Token.asString(awsS3BucketExample.arn), + roleArn: firehose.arn, + }, + name: "example-stream", + }); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + awsKinesisFirehoseDeliveryStreamExample.overrideLogicalId("example"); + const awsCognitoLogDeliveryConfigurationExample = + new CognitoLogDeliveryConfiguration(this, "example_6", { + logConfigurations: [ + { + cloudWatchLogsConfiguration: [ + { + logGroupArn: example.arn, + }, + ], + eventSource: "userNotification", + logLevel: "INFO", + }, + { + eventSource: "userAuthEvents", + firehoseConfiguration: [ + { + streamArn: Token.asString( + awsKinesisFirehoseDeliveryStreamExample.arn + ), + }, + ], + logLevel: "ERROR", + }, + ], + userPoolId: Token.asString(awsCognitoUserPoolExample.id), + }); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + awsCognitoLogDeliveryConfigurationExample.overrideLogicalId("example"); + } +} + +``` + +### S3 Configuration + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { Token, TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { CognitoLogDeliveryConfiguration } from "./.gen/providers/aws/cognito-log-delivery-configuration"; +import { CognitoUserPool } from "./.gen/providers/aws/cognito-user-pool"; +import { S3Bucket } from "./.gen/providers/aws/s3-bucket"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + const example = new CognitoUserPool(this, "example", { + name: "example", + }); + const awsS3BucketExample = new S3Bucket(this, "example_1", { + bucket: "example-bucket", + forceDestroy: true, + }); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + awsS3BucketExample.overrideLogicalId("example"); + const awsCognitoLogDeliveryConfigurationExample = + new CognitoLogDeliveryConfiguration(this, "example_2", { + logConfigurations: [ + { + eventSource: "userNotification", + logLevel: "ERROR", + s3Configuration: [ + { + bucketArn: Token.asString(awsS3BucketExample.arn), + }, + ], + }, + ], + userPoolId: example.id, + }); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + awsCognitoLogDeliveryConfigurationExample.overrideLogicalId("example"); + } +} + +``` + +## Argument Reference + +The following arguments are required: + +* `userPoolId` - (Required) The ID of the user pool for which to configure log delivery. + +The following arguments are optional: + +* `logConfigurations` - (Optional) Configuration block for log delivery. At least one configuration block is required. See [Log Configurations](#log-configurations) below. +* `region` - (Optional) The AWS region. + +### Log Configurations + +The `logConfigurations` block supports the following: + +* `eventSource` - (Required) The event source to configure logging for. Valid values are `userNotification` and `userAuthEvents`. +* `logLevel` - (Required) The log level to set for the event source. Valid values are `ERROR` and `INFO`. +* `cloudWatchLogsConfiguration` - (Optional) Configuration for CloudWatch Logs delivery. See [CloudWatch Logs Configuration](#cloudwatch-logs-configuration) below. +* `firehoseConfiguration` - (Optional) Configuration for Kinesis Data Firehose delivery. See [Firehose Configuration](#firehose-configuration) below. +* `s3Configuration` - (Optional) Configuration for S3 delivery. See [S3 Configuration](#s3-configuration) below. + +~> **Note:** At least one destination configuration (`cloudWatchLogsConfiguration`, `firehoseConfiguration`, or `s3Configuration`) must be specified for each log configuration. + +#### CloudWatch Logs Configuration + +The `cloudWatchLogsConfiguration` block supports the following: + +* `logGroupArn` - (Optional) The ARN of the CloudWatch Logs log group to which the logs should be delivered. + +#### Firehose Configuration + +The `firehoseConfiguration` block supports the following: + +* `streamArn` - (Optional) The ARN of the Kinesis Data Firehose delivery stream to which the logs should be delivered. + +#### S3 Configuration + +The `s3Configuration` block supports the following: + +* `bucketArn` - (Optional) The ARN of the S3 bucket to which the logs should be delivered. + +## Attribute Reference + +This resource exports the following attributes in addition to the arguments above: + +## Import + +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import Cognito IDP (Identity Provider) Log Delivery Configuration using the `userPoolId`. For example: + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { CognitoLogDeliveryConfiguration } from "./.gen/providers/aws/cognito-log-delivery-configuration"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + CognitoLogDeliveryConfiguration.generateConfigForImport( + this, + "example", + "us-west-2_example123" + ); + } +} + +``` + +Using `terraform import`, import Cognito IDP (Identity Provider) Log Delivery Configuration using the `userPoolId`. For example: + +```console +% terraform import aws_cognito_log_delivery_configuration.example us-west-2_example123 +``` + + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/cognito_managed_user_pool_client.html.markdown b/website/docs/cdktf/typescript/r/cognito_managed_user_pool_client.html.markdown index 103e1e52a407..a46a590f17f8 100644 --- a/website/docs/cdktf/typescript/r/cognito_managed_user_pool_client.html.markdown +++ b/website/docs/cdktf/typescript/r/cognito_managed_user_pool_client.html.markdown @@ -126,6 +126,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `accessTokenValidity` - (Optional) Time limit, between 5 minutes and 1 day, after which the access token is no longer valid and cannot be used. By default, the unit is hours. The unit can be overridden by a value in `token_validity_units.access_token`. * `allowedOauthFlowsUserPoolClient` - (Optional) Whether the client is allowed to use OAuth 2.0 features. `allowedOauthFlowsUserPoolClient` must be set to `true` before you can configure the following arguments: `callbackUrls`, `logoutUrls`, `allowedOauthScopes` and `allowedOauthFlows`. * `allowedOauthFlows` - (Optional) List of allowed OAuth flows, including `code`, `implicit`, and `client_credentials`. `allowedOauthFlowsUserPoolClient` must be set to `true` before you can configure this option. @@ -142,7 +143,7 @@ The following arguments are optional: * `logoutUrls` - (Optional) List of allowed logout URLs for the identity providers. `allowedOauthFlowsUserPoolClient` must be set to `true` before you can configure this option. * `preventUserExistenceErrors` - (Optional) Setting determines the errors and responses returned by Cognito APIs when a user does not exist in the user pool during authentication, account confirmation, and password recovery. * `readAttributes` - (Optional) List of user pool attributes that the application client can read from. -* `refresh_token_rotation` - (Optional) A block that specifies the configuration of refresh token rotation. [Detailed below](#refresh_token_rotation). +* `refreshTokenRotation` - (Optional) A block that specifies the configuration of refresh token rotation. [Detailed below](#refresh_token_rotation). * `refreshTokenValidity` - (Optional) Time limit, between 60 minutes and 10 years, after which the refresh token is no longer valid and cannot be used. By default, the unit is days. The unit can be overridden by a value in `token_validity_units.refresh_token`. * `supportedIdentityProviders` - (Optional) List of provider names for the identity providers that are supported on this client. It uses the `providerName` attribute of the `aws_cognito_identity_provider` resource(s), or the equivalent string(s). * `tokenValidityUnits` - (Optional) Configuration block for representing the validity times in units. See details below. [Detailed below](#token_validity_units). @@ -161,7 +162,7 @@ Either `applicationArn` or `applicationId` is required for this configuration bl ### refresh_token_rotation * `feature` - (Required) The state of refresh token rotation for the current app client. Valid values are `ENABLED` or `DISABLED`. -* `retry_grace_period_seconds` - (Optional) A period of time in seconds that the user has to use the old refresh token before it is invalidated. Valid values are between `0` and `60`. +* `retryGracePeriodSeconds` - (Optional) A period of time in seconds that the user has to use the old refresh token before it is invalidated. Valid values are between `0` and `60`. ### token_validity_units @@ -211,4 +212,4 @@ Using `terraform import`, import Cognito User Pool Clients using the `id` of the % terraform import aws_cognito_managed_user_pool_client.client us-west-2_abc123/3ho4ek12345678909nh3fmhpko ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/cognito_resource_server.html.markdown b/website/docs/cdktf/typescript/r/cognito_resource_server.html.markdown index a53df80b20f8..3b7933bd8a94 100644 --- a/website/docs/cdktf/typescript/r/cognito_resource_server.html.markdown +++ b/website/docs/cdktf/typescript/r/cognito_resource_server.html.markdown @@ -81,6 +81,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `identifier` - (Required) An identifier for the resource server. * `name` - (Required) A name for the resource server. * `userPoolId` - (Required) User pool the client belongs to. @@ -129,4 +130,4 @@ Using `terraform import`, import `aws_cognito_resource_server` using their User % terraform import aws_cognito_resource_server.example "us-west-2_abc123|https://example.com" ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/cognito_risk_configuration.html.markdown b/website/docs/cdktf/typescript/r/cognito_risk_configuration.html.markdown index 480f242598d6..7f8e9ecbcd84 100644 --- a/website/docs/cdktf/typescript/r/cognito_risk_configuration.html.markdown +++ b/website/docs/cdktf/typescript/r/cognito_risk_configuration.html.markdown @@ -41,6 +41,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `userPoolId` - (Required) The user pool ID. * `clientId` - (Optional) The app client ID. When the client ID is not provided, the same risk configuration is applied to all the clients in the User Pool. * `accountTakeoverRiskConfiguration` - (Optional) The account takeover risk configuration. See details below. @@ -164,4 +165,4 @@ Import using the user pool ID and Client ID separated by a `:`: % terraform import aws_cognito_risk_configuration.main example:example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/cognito_user.html.markdown b/website/docs/cdktf/typescript/r/cognito_user.html.markdown index 5d6f22eafb1e..c0fed651dc91 100644 --- a/website/docs/cdktf/typescript/r/cognito_user.html.markdown +++ b/website/docs/cdktf/typescript/r/cognito_user.html.markdown @@ -104,6 +104,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `attributes` - (Optional) A map that contains user attributes and attribute values to be set for the user. * `clientMetadata` - (Optional) A map of custom key-value pairs that you can provide as input for any custom workflows that user creation triggers. Amazon Cognito does not store the `clientMetadata` value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration does not include triggers, the ClientMetadata parameter serves no purpose. For more information, see [Customizing User Pool Workflows with Lambda Triggers](https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools-working-with-aws-lambda-triggers.html). * `desiredDeliveryMediums` - (Optional) A list of mediums to the welcome message will be sent through. Allowed values are `EMAIL` and `SMS`. If it's provided, make sure you have also specified `email` attribute for the `EMAIL` medium and `phoneNumber` for the `SMS`. More than one value can be specified. Amazon Cognito does not store the `desiredDeliveryMediums` value. Defaults to `["SMS"]`. @@ -156,4 +157,4 @@ Using `terraform import`, import Cognito User using the `userPoolId`/`name` attr % terraform import aws_cognito_user.user us-east-1_vG78M4goG/user ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/cognito_user_group.html.markdown b/website/docs/cdktf/typescript/r/cognito_user_group.html.markdown index f77cad137a13..f088401757ee 100644 --- a/website/docs/cdktf/typescript/r/cognito_user_group.html.markdown +++ b/website/docs/cdktf/typescript/r/cognito_user_group.html.markdown @@ -82,6 +82,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) The name of the user group. * `userPoolId` - (Required) The user pool ID. * `description` - (Optional) The description of the user group. @@ -124,4 +125,4 @@ Using `terraform import`, import Cognito User Groups using the `userPoolId`/`nam % terraform import aws_cognito_user_group.group us-east-1_vG78M4goG/user-group ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/cognito_user_in_group.html.markdown b/website/docs/cdktf/typescript/r/cognito_user_in_group.html.markdown index 45c3d2ee4e63..5ec9fc8aeae7 100644 --- a/website/docs/cdktf/typescript/r/cognito_user_in_group.html.markdown +++ b/website/docs/cdktf/typescript/r/cognito_user_in_group.html.markdown @@ -69,8 +69,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `userPoolId` - (Required) The user pool ID of the user and group. * `groupName` - (Required) The name of the group to which the user is to be added. * `username` - (Required) The username of the user to be added to the group. @@ -79,4 +80,36 @@ The following arguments are required: This resource exports no additional attributes. - \ No newline at end of file +## Import + +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import a Cognito Group User using a comma-delimited string concatenating the `userPoolId`, `groupName`, and `username` arguments. For example: + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { CognitoUserInGroup } from "./.gen/providers/aws/cognito-user-in-group"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + CognitoUserInGroup.generateConfigForImport( + this, + "example", + "us-east-1_vG78M4goG,example-group,example-user" + ); + } +} + +``` + +Using `terraform import`, import a Cognito Group User using a comma-delimited string concatenating the `userPoolId`, `groupName`, and `username` arguments. For example: + +```console +% terraform import aws_cognito_user_in_group.example us-east-1_vG78M4goG,example-group,example-user +``` + + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/cognito_user_pool.html.markdown b/website/docs/cdktf/typescript/r/cognito_user_pool.html.markdown index 6348611a89e1..378a65426c0f 100644 --- a/website/docs/cdktf/typescript/r/cognito_user_pool.html.markdown +++ b/website/docs/cdktf/typescript/r/cognito_user_pool.html.markdown @@ -109,6 +109,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) Name of the user pool. * `accountRecoverySetting` - (Optional) Configuration block to define which verified available method a user can use to recover their forgotten password. [Detailed below](#account_recovery_setting). * `adminCreateUserConfig` - (Optional) Configuration block for creating a new user profile. [Detailed below](#admin_create_user_config). @@ -117,18 +118,18 @@ This resource supports the following arguments: * `deletionProtection` - (Optional) When active, DeletionProtection prevents accidental deletion of your user pool. Before you can delete a user pool that you have protected against deletion, you must deactivate this feature. Valid values are `ACTIVE` and `INACTIVE`, Default value is `INACTIVE`. * `deviceConfiguration` - (Optional) Configuration block for the user pool's device tracking. [Detailed below](#device_configuration). * `emailConfiguration` - (Optional) Configuration block for configuring email. [Detailed below](#email_configuration). -* `emailMfaConfiguration` - (Optional) Configuration block for configuring email Multi-Factor Authentication (MFA); requires at least 2 `accountRecoverySetting` entries; requires an `emailConfiguration` configuration block. [Detailed below](#email_mfa_configuration). +* `emailMfaConfiguration` - (Optional) Configuration block for configuring email Multi-Factor Authentication (MFA); requires at least 2 `accountRecoverySetting` entries; requires an `emailConfiguration` configuration block. Effective only when `mfaConfiguration` is `ON` or `OPTIONAL`. [Detailed below](#email_mfa_configuration). * `emailVerificationMessage` - (Optional) String representing the email verification message. Conflicts with `verificationMessageTemplate` configuration block `emailMessage` argument. * `emailVerificationSubject` - (Optional) String representing the email verification subject. Conflicts with `verificationMessageTemplate` configuration block `emailSubject` argument. * `lambdaConfig` - (Optional) Configuration block for the AWS Lambda triggers associated with the user pool. [Detailed below](#lambda_config). -* `mfaConfiguration` - (Optional) Multi-Factor Authentication (MFA) configuration for the User Pool. Defaults of `OFF`. Valid values are `OFF` (MFA Tokens are not required), `ON` (MFA is required for all users to sign in; requires at least one of `smsConfiguration` or `softwareTokenMfaConfiguration` to be configured), or `OPTIONAL` (MFA Will be required only for individual users who have MFA Enabled; requires at least one of `smsConfiguration` or `softwareTokenMfaConfiguration` to be configured). +* `mfaConfiguration` - (Optional) Multi-Factor Authentication (MFA) configuration for the User Pool. Defaults of `OFF`. Valid values are `OFF` (MFA Tokens are not required), `ON` (MFA is required for all users to sign in; requires at least one of `emailMfaConfiguration`, `smsConfiguration` or `softwareTokenMfaConfiguration` to be configured), or `OPTIONAL` (MFA Will be required only for individual users who have MFA Enabled; requires at least one of `emailMfaConfiguration`, `smsConfiguration` or `softwareTokenMfaConfiguration` to be configured). * `passwordPolicy` - (Optional) Configuration block for information about the user pool password policy. [Detailed below](#password_policy). * `schema` - (Optional) Configuration block for the schema attributes of a user pool. [Detailed below](#schema). Schema attributes from the [standard attribute set](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html#cognito-user-pools-standard-attributes) only need to be specified if they are different from the default configuration. Attributes can be added, but not modified or removed. Maximum of 50 attributes. * `signInPolicy` - (Optional) Configuration block for information about the user pool sign in policy. [Detailed below](#sign_in_policy). * `smsAuthenticationMessage` - (Optional) String representing the SMS authentication message. The Message must contain the `{####}` placeholder, which will be replaced with the code. -* `smsConfiguration` - (Optional) Configuration block for Short Message Service (SMS) settings. [Detailed below](#sms_configuration). These settings apply to SMS user verification and SMS Multi-Factor Authentication (MFA). Due to Cognito API restrictions, the SMS configuration cannot be removed without recreating the Cognito User Pool. For user data safety, this resource will ignore the removal of this configuration by disabling drift detection. To force resource recreation after this configuration has been applied, see the [`taint` command](https://www.terraform.io/docs/commands/taint.html). +* `smsConfiguration` - (Optional) Configuration block for Short Message Service (SMS) settings. [Detailed below](#sms_configuration). These settings apply to SMS user verification and SMS Multi-Factor Authentication (MFA). SMS MFA is activated only when `mfaConfiguration` is set to `ON` or `OPTIONAL` along with this block. Due to Cognito API restrictions, the SMS configuration cannot be removed without recreating the Cognito User Pool. For user data safety, this resource will ignore the removal of this configuration by disabling drift detection. To force resource recreation after this configuration has been applied, see the [`taint` command](https://www.terraform.io/docs/commands/taint.html). * `smsVerificationMessage` - (Optional) String representing the SMS verification message. Conflicts with `verificationMessageTemplate` configuration block `smsMessage` argument. -* `softwareTokenMfaConfiguration` - (Optional) Configuration block for software token Mult-Factor Authentication (MFA) settings. [Detailed below](#software_token_mfa_configuration). +* `softwareTokenMfaConfiguration` - (Optional) Configuration block for software token Mult-Factor Authentication (MFA) settings. Effective only when `mfaConfiguration` is `ON` or `OPTIONAL`. [Detailed below](#software_token_mfa_configuration). * `tags` - (Optional) Map of tags to assign to the User Pool. If configured with a provider [`defaultTags` 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. * `userAttributeUpdateSettings` - (Optional) Configuration block for user attribute update settings. [Detailed below](#user_attribute_update_settings). * `userPoolAddOns` - (Optional) Configuration block for user pool add-ons to enable user pool advanced security mode features. [Detailed below](#user_pool_add_ons). @@ -368,4 +369,4 @@ Using `terraform import`, import Cognito User Pools using the `id`. For example: % terraform import aws_cognito_user_pool.pool us-west-2_abc123 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/cognito_user_pool_client.html.markdown b/website/docs/cdktf/typescript/r/cognito_user_pool_client.html.markdown index 69e86a46d7d0..ae6bc053d85d 100644 --- a/website/docs/cdktf/typescript/r/cognito_user_pool_client.html.markdown +++ b/website/docs/cdktf/typescript/r/cognito_user_pool_client.html.markdown @@ -229,10 +229,10 @@ class MyConvertedCode extends TerraformStack { new CognitoUserPoolClient(this, "userpool_client", { explicitAuthFlows: ["ADMIN_NO_SRP_AUTH"], name: "client", - refresh_token_rotation: [ + refreshTokenRotation: [ { feature: "ENABLED", - retry_grace_period_seconds: 10, + retryGracePeriodSeconds: 10, }, ], userPoolId: pool.id, @@ -251,6 +251,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `accessTokenValidity` - (Optional) Time limit, between 5 minutes and 1 day, after which the access token is no longer valid and cannot be used. By default, the unit is hours. The unit can be overridden by a value in `token_validity_units.access_token`. * `allowedOauthFlowsUserPoolClient` - (Optional) Whether the client is allowed to use OAuth 2.0 features. `allowedOauthFlowsUserPoolClient` must be set to `true` before you can configure the following arguments: `callbackUrls`, `logoutUrls`, `allowedOauthScopes` and `allowedOauthFlows`. * `allowedOauthFlows` - (Optional) List of allowed OAuth flows, including `code`, `implicit`, and `client_credentials`. `allowedOauthFlowsUserPoolClient` must be set to `true` before you can configure this option. @@ -267,7 +268,7 @@ The following arguments are optional: * `logoutUrls` - (Optional) List of allowed logout URLs for the identity providers. `allowedOauthFlowsUserPoolClient` must be set to `true` before you can configure this option. * `preventUserExistenceErrors` - (Optional) Setting determines the errors and responses returned by Cognito APIs when a user does not exist in the user pool during authentication, account confirmation, and password recovery. * `readAttributes` - (Optional) List of user pool attributes that the application client can read from. -* `refresh_token_rotation` - (Optional) A block that specifies the configuration of refresh token rotation. [Detailed below](#refresh_token_rotation). +* `refreshTokenRotation` - (Optional) A block that specifies the configuration of refresh token rotation. [Detailed below](#refresh_token_rotation). * `refreshTokenValidity` - (Optional) Time limit, between 60 minutes and 10 years, after which the refresh token is no longer valid and cannot be used. By default, the unit is days. The unit can be overridden by a value in `token_validity_units.refresh_token`. * `supportedIdentityProviders` - (Optional) List of provider names for the identity providers that are supported on this client. It uses the `providerName` attribute of the `aws_cognito_identity_provider` resource(s), or the equivalent string(s). * `tokenValidityUnits` - (Optional) Configuration block for representing the validity times in units. See details below. [Detailed below](#token_validity_units). @@ -286,7 +287,7 @@ Either `applicationArn` or `applicationId` is required. ### refresh_token_rotation * `feature` - (Required) The state of refresh token rotation for the current app client. Valid values are `ENABLED` or `DISABLED`. -* `retry_grace_period_seconds` - (Optional) A period of time in seconds that the user has to use the old refresh token before it is invalidated. Valid values are between `0` and `60`. +* `retryGracePeriodSeconds` - (Optional) A period of time in seconds that the user has to use the old refresh token before it is invalidated. Valid values are between `0` and `60`. ### token_validity_units @@ -335,4 +336,4 @@ Using `terraform import`, import Cognito User Pool Clients using the `id` of the % terraform import aws_cognito_user_pool_client.client us-west-2_abc123/3ho4ek12345678909nh3fmhpko ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/cognito_user_pool_domain.html.markdown b/website/docs/cdktf/typescript/r/cognito_user_pool_domain.html.markdown index 88a64e2c073f..9a97d3f1b06d 100644 --- a/website/docs/cdktf/typescript/r/cognito_user_pool_domain.html.markdown +++ b/website/docs/cdktf/typescript/r/cognito_user_pool_domain.html.markdown @@ -94,6 +94,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `domain` - (Required) For custom domains, this is the fully-qualified domain name, such as auth.example.com. For Amazon Cognito prefix domains, this is the prefix alone, such as auth. * `userPoolId` - (Required) The user pool ID. * `certificateArn` - (Optional) The ARN of an ISSUED ACM certificate in us-east-1 for a custom domain. @@ -142,4 +143,4 @@ Using `terraform import`, import Cognito User Pool Domains using the `domain`. F % terraform import aws_cognito_user_pool_domain.main auth.example.org ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/cognito_user_pool_ui_customization.html.markdown b/website/docs/cdktf/typescript/r/cognito_user_pool_ui_customization.html.markdown index 6e60f34eead9..12374d82c8e6 100644 --- a/website/docs/cdktf/typescript/r/cognito_user_pool_ui_customization.html.markdown +++ b/website/docs/cdktf/typescript/r/cognito_user_pool_ui_customization.html.markdown @@ -116,6 +116,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `clientId` (Optional) The client ID for the client app. Defaults to `ALL`. If `ALL` is specified, the `css` and/or `imageFile` settings will be used for every client that has no UI customization set previously. * `css` (Optional) - The CSS values in the UI customization, provided as a String. At least one of `css` or `imageFile` is required. * `imageFile` (Optional) - The uploaded logo image for the UI customization, provided as a base64-encoded String. Drift detection is not possible for this argument. At least one of `css` or `imageFile` is required. @@ -162,4 +163,4 @@ Using `terraform import`, import Cognito User Pool UI Customizations using the ` % terraform import aws_cognito_user_pool_ui_customization.example us-west-2_ZCTarbt5C,12bu4fuk3mlgqa2rtrujgp6egq ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/comprehend_document_classifier.html.markdown b/website/docs/cdktf/typescript/r/comprehend_document_classifier.html.markdown index c2ac6fdd9707..ebfcc1547f04 100644 --- a/website/docs/cdktf/typescript/r/comprehend_document_classifier.html.markdown +++ b/website/docs/cdktf/typescript/r/comprehend_document_classifier.html.markdown @@ -47,7 +47,7 @@ class MyConvertedCode extends TerraformStack { dataAccessRoleArn: Token.asString(awsIamRoleExample.arn), dependsOn: [awsIamRolePolicyExample], inputDataConfig: { - s3Uri: "s3://${" + test.bucket + "}/${" + documents.id + "}", + s3Uri: "s3://${" + test.bucket + "}/${" + documents.key + "}", }, languageCode: "en", name: "example", @@ -72,6 +72,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `mode` - (Optional, Default: `MULTI_CLASS`) The document classification mode. One of `MULTI_CLASS` or `MULTI_LABEL`. `MULTI_CLASS` is also known as "Single Label" in the AWS Console. @@ -181,4 +182,4 @@ Using `terraform import`, import Comprehend Document Classifier using the ARN. F % terraform import aws_comprehend_document_classifier.example arn:aws:comprehend:us-west-2:123456789012:document_classifier/example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/comprehend_entity_recognizer.html.markdown b/website/docs/cdktf/typescript/r/comprehend_entity_recognizer.html.markdown index e1f14b11e30e..0522883122df 100644 --- a/website/docs/cdktf/typescript/r/comprehend_entity_recognizer.html.markdown +++ b/website/docs/cdktf/typescript/r/comprehend_entity_recognizer.html.markdown @@ -52,12 +52,16 @@ class MyConvertedCode extends TerraformStack { "s3://${" + awsS3BucketDocuments.bucket + "}/${" + - documents.id + + documents.key + "}", }, entityList: { s3Uri: - "s3://${" + awsS3BucketEntities.bucket + "}/${" + entities.id + "}", + "s3://${" + + awsS3BucketEntities.bucket + + "}/${" + + entities.key + + "}", }, entityTypes: [ { @@ -91,6 +95,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `modelKmsKeyId` - (Optional) The ID or ARN of a KMS Key used to encrypt trained Entity Recognizers. * `tags` - (Optional) A map of tags to assign to the resource. If configured with a provider [`defaultTags` Configuration Block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. * `versionName` - (Optional) Name for the version of the Entity Recognizer. @@ -212,4 +217,4 @@ Using `terraform import`, import Comprehend Entity Recognizer using the ARN. For % terraform import aws_comprehend_entity_recognizer.example arn:aws:comprehend:us-west-2:123456789012:entity-recognizer/example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/computeoptimizer_enrollment_status.html.markdown b/website/docs/cdktf/typescript/r/computeoptimizer_enrollment_status.html.markdown index 37de9cdcb29c..5e78aa8bb7ad 100644 --- a/website/docs/cdktf/typescript/r/computeoptimizer_enrollment_status.html.markdown +++ b/website/docs/cdktf/typescript/r/computeoptimizer_enrollment_status.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `includeMemberAccounts` - (Optional) Whether to enroll member accounts of the organization if the account is the management account of an organization. Default is `false`. * `status` - (Required) The enrollment status of the account. Valid values: `Active`, `Inactive`. @@ -86,4 +87,4 @@ Using `terraform import`, import enrollment status using the account ID. For exa % terraform import aws_computeoptimizer_enrollment_status.example 123456789012 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/computeoptimizer_recommendation_preferences.html.markdown b/website/docs/cdktf/typescript/r/computeoptimizer_recommendation_preferences.html.markdown index 409c7bfdaa88..51300541a3f7 100644 --- a/website/docs/cdktf/typescript/r/computeoptimizer_recommendation_preferences.html.markdown +++ b/website/docs/cdktf/typescript/r/computeoptimizer_recommendation_preferences.html.markdown @@ -87,12 +87,13 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `enhancedInfrastructureMetrics` - (Optional) The status of the enhanced infrastructure metrics recommendation preference. Valid values: `Active`, `Inactive`. * `externalMetricsPreference` - (Optional) The provider of the external metrics recommendation preference. See [External Metrics Preference](#external-metrics-preference) below. * `inferredWorkloadTypes` - (Optional) The status of the inferred workload types recommendation preference. Valid values: `Active`, `Inactive`. * `lookBackPeriod` - (Optional) The preference to control the number of days the utilization metrics of the AWS resource are analyzed. Valid values: `DAYS_14`, `DAYS_32`, `DAYS_93`. * `preferredResource` - (Optional) The preference to control which resource type values are considered when generating rightsizing recommendations. See [Preferred Resources](#preferred-resources) below. -* `resourceType` - (Required) The target resource type of the recommendation preferences. Valid values: `Ec2Instance`, `AutoScalingGroup`, `RdsDBInstance`. +* `resourceType` - (Required) The target resource type of the recommendation preferences. Valid values: `Ec2Instance`, `AutoScalingGroup`, `RdsDBInstance`, `AuroraDBClusterStorage`. * `savingsEstimationMode` - (Optional) The status of the savings estimation mode preference. Valid values: `AfterDiscounts`, `BeforeDiscounts`. * `scope` - (Required) The scope of the recommendation preferences. See [Scope](#scope) below. * `utilizationPreference` - (Optional) The preference to control the resource’s CPU utilization threshold, CPU utilization headroom, and memory utilization headroom. See [Utilization Preferences](#utilization-preferences) below. @@ -158,4 +159,4 @@ Using `terraform import`, import recommendation preferences using the resource t % terraform import aws_computeoptimizer_recommendation_preferences.example Ec2Instance,AccountId,123456789012 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/config_aggregate_authorization.html.markdown b/website/docs/cdktf/typescript/r/config_aggregate_authorization.html.markdown index 8163269dda3a..8ab8180a768e 100644 --- a/website/docs/cdktf/typescript/r/config_aggregate_authorization.html.markdown +++ b/website/docs/cdktf/typescript/r/config_aggregate_authorization.html.markdown @@ -28,7 +28,7 @@ class MyConvertedCode extends TerraformStack { super(scope, name); new ConfigAggregateAuthorization(this, "example", { accountId: "123456789012", - region: "eu-west-2", + authorizedAwsRegion: "eu-west-2", }); } } @@ -39,8 +39,9 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: -* `accountId` - (Required) Account ID -* `region` - (Required) Region +* `accountId` - (Required) Account ID. +* `authorizedAwsRegion` - (Optional) The region authorized to collect aggregated data. +* `region` - (Optional, **Deprecated**) The region authorized to collect aggregated data. Use `authorizedAwsRegion` instead. * `tags` - (Optional) A map of tags to assign to the resource. If configured with a provider [`defaultTags` 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. ## Attribute Reference @@ -52,7 +53,7 @@ This resource exports the following attributes in addition to the arguments abov ## Import -In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import Config aggregate authorizations using `account_id:region`. For example: +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import Config aggregate authorizations using `account_id:authorized_aws_region`. For example: ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -76,10 +77,10 @@ class MyConvertedCode extends TerraformStack { ``` -Using `terraform import`, import Config aggregate authorizations using `account_id:region`. For example: +Using `terraform import`, import Config aggregate authorizations using `account_id:authorized_aws_region`. For example: ```console % terraform import aws_config_aggregate_authorization.example 123456789012:us-east-1 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/config_config_rule.html.markdown b/website/docs/cdktf/typescript/r/config_config_rule.html.markdown index 0f02426242e9..b9c3d4935e33 100644 --- a/website/docs/cdktf/typescript/r/config_config_rule.html.markdown +++ b/website/docs/cdktf/typescript/r/config_config_rule.html.markdown @@ -185,6 +185,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) The name of the rule * `description` - (Optional) Description of the rule * `evaluationMode` - (Optional) The modes the Config rule can be evaluated in. See [Evaluation Mode](#evaluation-mode) for more details. @@ -269,4 +270,4 @@ Using `terraform import`, import Config Rule using the name. For example: % terraform import aws_config_config_rule.foo example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/config_configuration_aggregator.html.markdown b/website/docs/cdktf/typescript/r/config_configuration_aggregator.html.markdown index c14961821174..7d62f465da97 100644 --- a/website/docs/cdktf/typescript/r/config_configuration_aggregator.html.markdown +++ b/website/docs/cdktf/typescript/r/config_configuration_aggregator.html.markdown @@ -108,6 +108,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) The name of the configuration aggregator. * `accountAggregationSource` - (Optional) The account(s) to aggregate config data from as documented below. * `organizationAggregationSource` - (Optional) The organization to aggregate config data from as documented below. @@ -172,4 +173,4 @@ Using `terraform import`, import Configuration Aggregators using the name. For e % terraform import aws_config_configuration_aggregator.example foo ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/config_configuration_recorder.html.markdown b/website/docs/cdktf/typescript/r/config_configuration_recorder.html.markdown index e9f507c11145..1b1323adcbc2 100644 --- a/website/docs/cdktf/typescript/r/config_configuration_recorder.html.markdown +++ b/website/docs/cdktf/typescript/r/config_configuration_recorder.html.markdown @@ -135,6 +135,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Optional) The name of the recorder. Defaults to `default`. Changing it recreates the resource. * `roleArn` - (Required) Amazon Resource Name (ARN) of the IAM role. Used to make read or write requests to the delivery channel and to describe the AWS resources associated with the account. See [AWS Docs](http://docs.aws.amazon.com/config/latest/developerguide/iamrole-permissions.html) for more details. * `recordingGroup` - (Optional) Recording group - see below. @@ -201,4 +202,4 @@ Using `terraform import`, import Configuration Recorder using the name. For exam % terraform import aws_config_configuration_recorder.foo example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/config_configuration_recorder_status.html.markdown b/website/docs/cdktf/typescript/r/config_configuration_recorder_status.html.markdown index fdf851599153..249544ea5adc 100644 --- a/website/docs/cdktf/typescript/r/config_configuration_recorder_status.html.markdown +++ b/website/docs/cdktf/typescript/r/config_configuration_recorder_status.html.markdown @@ -107,6 +107,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) The name of the recorder * `isEnabled` - (Required) Whether the configuration recorder should be enabled or disabled. @@ -146,4 +147,4 @@ Using `terraform import`, import Configuration Recorder Status using the name of % terraform import aws_config_configuration_recorder_status.foo example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/config_conformance_pack.html.markdown b/website/docs/cdktf/typescript/r/config_conformance_pack.html.markdown index ff37f24a9342..1723d2fbdb3b 100644 --- a/website/docs/cdktf/typescript/r/config_conformance_pack.html.markdown +++ b/website/docs/cdktf/typescript/r/config_conformance_pack.html.markdown @@ -100,6 +100,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required, Forces new resource) The name of the conformance pack. Must begin with a letter and contain from 1 to 256 alphanumeric characters and hyphens. * `deliveryS3Bucket` - (Optional) Amazon S3 bucket where AWS Config stores conformance pack templates. Maximum length of 63. * `deliveryS3KeyPrefix` - (Optional) The prefix for the Amazon S3 bucket. Maximum length of 1024. @@ -150,4 +151,4 @@ Using `terraform import`, import Config Conformance Packs using the `name`. For % terraform import aws_config_conformance_pack.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/config_delivery_channel.html.markdown b/website/docs/cdktf/typescript/r/config_delivery_channel.html.markdown index 41526a426c7c..40daf1fbac0c 100644 --- a/website/docs/cdktf/typescript/r/config_delivery_channel.html.markdown +++ b/website/docs/cdktf/typescript/r/config_delivery_channel.html.markdown @@ -95,6 +95,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Optional) The name of the delivery channel. Defaults to `default`. Changing it recreates the resource. * `s3BucketName` - (Required) The name of the S3 bucket used to store the configuration history. * `s3KeyPrefix` - (Optional) The prefix for the specified S3 bucket. @@ -140,4 +141,4 @@ Using `terraform import`, import Delivery Channel using the name. For example: % terraform import aws_config_delivery_channel.foo example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/config_organization_conformance_pack.html.markdown b/website/docs/cdktf/typescript/r/config_organization_conformance_pack.html.markdown index 3e02a50df533..03fabdc34b23 100644 --- a/website/docs/cdktf/typescript/r/config_organization_conformance_pack.html.markdown +++ b/website/docs/cdktf/typescript/r/config_organization_conformance_pack.html.markdown @@ -111,6 +111,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required, Forces new resource) The name of the organization conformance pack. Must begin with a letter and contain from 1 to 128 alphanumeric characters and hyphens. * `deliveryS3Bucket` - (Optional) Amazon S3 bucket where AWS Config stores conformance pack templates. Delivery bucket must begin with `awsconfigconforms` prefix. Maximum length of 63. * `deliveryS3KeyPrefix` - (Optional) The prefix for the Amazon S3 bucket. Maximum length of 1024. @@ -173,4 +174,4 @@ Using `terraform import`, import Config Organization Conformance Packs using the % terraform import aws_config_organization_conformance_pack.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/config_organization_custom_policy_rule.html.markdown b/website/docs/cdktf/typescript/r/config_organization_custom_policy_rule.html.markdown index 4e97d381e0b2..e1e7d1c4c354 100644 --- a/website/docs/cdktf/typescript/r/config_organization_custom_policy_rule.html.markdown +++ b/website/docs/cdktf/typescript/r/config_organization_custom_policy_rule.html.markdown @@ -50,28 +50,29 @@ class MyConvertedCode extends TerraformStack { The following arguments are required: -* `name` - (Required) name of the rule -* `policyText` - (Required) policy definition containing the logic for your organization AWS Config Custom Policy rule -* `policyRuntime` - (Required) runtime system for your organization AWS Config Custom Policy rules -* `triggerTypes` - (Required) List of notification types that trigger AWS Config to run an evaluation for the rule. Valid values: `ConfigurationItemChangeNotification`, `OversizedConfigurationItemChangeNotification` +* `name` - (Required) Name of the rule. +* `policyText` - (Required) Policy definition containing the rule logic. +* `policyRuntime` - (Required) Runtime system for policy rules. +* `triggerTypes` - (Required) List of notification types that trigger AWS Config to run an evaluation for the rule. Valid values: `ConfigurationItemChangeNotification`, `OversizedConfigurationItemChangeNotification`. The following arguments are optional: -* `description` - (Optional) Description of the rule -* `debugLogDeliveryAccounts` - (Optional) List of AWS account identifiers to exclude from the rule -* `excludedAccounts` - (Optional) List of AWS account identifiers to exclude from the rule -* `inputParameters` - (Optional) A string in JSON format that is passed to the AWS Config Rule Lambda Function +* `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). +* `description` - (Optional) Description of the rule. +* `debugLogDeliveryAccounts` - (Optional) List of accounts that you can enable debug logging for. The list is null when debug logging is enabled for all accounts. +* `excludedAccounts` - (Optional) List of AWS account identifiers to exclude from the rule. +* `inputParameters` - (Optional) A string in JSON format that is passed to the AWS Config Rule Lambda Function. * `maximumExecutionFrequency` - (Optional) Maximum frequency with which AWS Config runs evaluations for a rule, if the rule is triggered at a periodic frequency. Defaults to `TwentyFour_Hours` for periodic frequency triggered rules. Valid values: `One_Hour`, `Three_Hours`, `Six_Hours`, `Twelve_Hours`, or `TwentyFour_Hours`. -* `resourceIdScope` - (Optional) Identifier of the AWS resource to evaluate -* `resourceTypesScope` - (Optional) List of types of AWS resources to evaluate -* `tagKeyScope` - (Optional, Required if `tagValueScope` is configured) Tag key of AWS resources to evaluate -* `tagValueScope` - (Optional) Tag value of AWS resources to evaluate +* `resourceIdScope` - (Optional) Identifier of the AWS resource to evaluate. +* `resourceTypesScope` - (Optional) List of types of AWS resources to evaluate. +* `tagKeyScope` - (Optional, Required if `tagValueScope` is configured) Tag key of AWS resources to evaluate. +* `tagValueScope` - (Optional) Tag value of AWS resources to evaluate. ## Attribute Reference This resource exports the following attributes in addition to the arguments above: -* `arn` - Amazon Resource Name (ARN) of the rule +* `arn` - Amazon Resource Name (ARN) of the rule. ## Timeouts @@ -113,4 +114,4 @@ Using `terraform import`, import a Config Organization Custom Policy Rule using % terraform import aws_config_organization_custom_policy_rule.example example_rule_name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/config_organization_custom_rule.html.markdown b/website/docs/cdktf/typescript/r/config_organization_custom_rule.html.markdown index 3e3fa3bfcc05..7c445206ac96 100644 --- a/website/docs/cdktf/typescript/r/config_organization_custom_rule.html.markdown +++ b/website/docs/cdktf/typescript/r/config_organization_custom_rule.html.markdown @@ -66,6 +66,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `lambdaFunctionArn` - (Required) Amazon Resource Name (ARN) of the rule Lambda Function * `name` - (Required) The name of the rule * `triggerTypes` - (Required) List of notification types that trigger AWS Config to run an evaluation for the rule. Valid values: `ConfigurationItemChangeNotification`, `OversizedConfigurationItemChangeNotification`, and `ScheduledNotification` @@ -124,4 +125,4 @@ Using `terraform import`, import Config Organization Custom Rules using the name % terraform import aws_config_organization_custom_rule.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/config_organization_managed_rule.html.markdown b/website/docs/cdktf/typescript/r/config_organization_managed_rule.html.markdown index a8b59cae18b8..ada4d1f64184 100644 --- a/website/docs/cdktf/typescript/r/config_organization_managed_rule.html.markdown +++ b/website/docs/cdktf/typescript/r/config_organization_managed_rule.html.markdown @@ -52,6 +52,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) The name of the rule * `ruleIdentifier` - (Required) Identifier of an available AWS Config Managed Rule to call. For available values, see the [List of AWS Config Managed Rules](https://docs.aws.amazon.com/config/latest/developerguide/managed-rules-by-aws-config.html) documentation * `description` - (Optional) Description of the rule @@ -109,4 +110,4 @@ Using `terraform import`, import Config Organization Managed Rules using the nam % terraform import aws_config_organization_managed_rule.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/config_remediation_configuration.html.markdown b/website/docs/cdktf/typescript/r/config_remediation_configuration.html.markdown index 2e7896cc4155..43cf132cc2bb 100644 --- a/website/docs/cdktf/typescript/r/config_remediation_configuration.html.markdown +++ b/website/docs/cdktf/typescript/r/config_remediation_configuration.html.markdown @@ -86,6 +86,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `automatic` - (Optional) Remediation is triggered automatically if `true`. * `executionControls` - (Optional) Configuration block for execution controls. See below. * `maximumAutomaticAttempts` - (Optional) Maximum number of failed attempts for auto-remediation. If you do not select a number, the default is 5. @@ -152,4 +153,4 @@ Using `terraform import`, import Remediation Configurations using the name confi % terraform import aws_config_remediation_configuration.this example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/config_retention_configuration.html.markdown b/website/docs/cdktf/typescript/r/config_retention_configuration.html.markdown index c7aaa0c5912f..ccb9410c1382 100644 --- a/website/docs/cdktf/typescript/r/config_retention_configuration.html.markdown +++ b/website/docs/cdktf/typescript/r/config_retention_configuration.html.markdown @@ -39,6 +39,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `retentionPeriodInDays` - (Required) The number of days AWS Config stores historical information. ## Attribute Reference @@ -79,4 +80,4 @@ Using `terraform import`, import the AWS Config retention configuration using th % terraform import aws_config_retention_configuration.example default ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/connect_bot_association.html.markdown b/website/docs/cdktf/typescript/r/connect_bot_association.html.markdown index 2a2acf1a1b25..1dc285a527fc 100644 --- a/website/docs/cdktf/typescript/r/connect_bot_association.html.markdown +++ b/website/docs/cdktf/typescript/r/connect_bot_association.html.markdown @@ -105,7 +105,7 @@ class MyConvertedCode extends TerraformStack { { instanceId: Token.asString(awsConnectInstanceExample.id), lexBot: { - lexRegion: Token.asString(current.name), + lexRegion: Token.asString(current.region), name: Token.asString(awsLexBotExample.name), }, } @@ -121,6 +121,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `instanceId` - (Required) The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance. * `lexBot` - (Required) Configuration information of an Amazon Lex (V1) bot. Detailed below. @@ -169,4 +170,4 @@ Using `terraform import`, import `aws_connect_bot_association` using the Amazon % terraform import aws_connect_bot_association.example aaaaaaaa-bbbb-cccc-dddd-111111111111:Example:us-west-2 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/connect_contact_flow.html.markdown b/website/docs/cdktf/typescript/r/connect_contact_flow.html.markdown index bd26203fb68c..6f2cbcf0f840 100644 --- a/website/docs/cdktf/typescript/r/connect_contact_flow.html.markdown +++ b/website/docs/cdktf/typescript/r/connect_contact_flow.html.markdown @@ -121,6 +121,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `content` - (Optional) Specifies the content of the Contact Flow, provided as a JSON string, written in Amazon Connect Contact Flow Language. If defined, the `filename` argument cannot be used. * `contentHash` - (Optional) Used to trigger updates. Must be set to a base64-encoded SHA256 hash of the Contact Flow source specified with `filename`. The usual way to set this is filebase64sha256("mycontact_flow.json") (Terraform 0.11.12 and later) or base64sha256(file("mycontact_flow.json")) (Terraform 0.11.11 and earlier), where "mycontact_flow.json" is the local filename of the Contact Flow source. * `description` - (Optional) Specifies the description of the Contact Flow. @@ -171,4 +172,4 @@ Using `terraform import`, import Amazon Connect Contact Flows using the `instanc % terraform import aws_connect_contact_flow.example f1288a1f-6193-445a-b47e-af739b2:c1d4e5f6-1b3c-1b3c-1b3c-c1d4e5f6c1d4e5 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/connect_contact_flow_module.html.markdown b/website/docs/cdktf/typescript/r/connect_contact_flow_module.html.markdown index 9af1685cab1b..9ec81b7f71f0 100644 --- a/website/docs/cdktf/typescript/r/connect_contact_flow_module.html.markdown +++ b/website/docs/cdktf/typescript/r/connect_contact_flow_module.html.markdown @@ -137,6 +137,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `content` - (Optional) Specifies the content of the Contact Flow Module, provided as a JSON string, written in Amazon Connect Contact Flow Language. If defined, the `filename` argument cannot be used. * `contentHash` - (Optional) Used to trigger updates. Must be set to a base64-encoded SHA256 hash of the Contact Flow Module source specified with `filename`. The usual way to set this is filebase64sha256("contact_flow_module.json") (Terraform 0.11.12 and later) or base64sha256(file("contact_flow_module.json")) (Terraform 0.11.11 and earlier), where "contact_flow_module.json" is the local filename of the Contact Flow Module source. * `description` - (Optional) Specifies the description of the Contact Flow Module. @@ -186,4 +187,4 @@ Using `terraform import`, import Amazon Connect Contact Flow Modules using the ` % terraform import aws_connect_contact_flow_module.example f1288a1f-6193-445a-b47e-af739b2:c1d4e5f6-1b3c-1b3c-1b3c-c1d4e5f6c1d4e5 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/connect_hours_of_operation.html.markdown b/website/docs/cdktf/typescript/r/connect_hours_of_operation.html.markdown index dbd268838252..31f327f3f8d0 100644 --- a/website/docs/cdktf/typescript/r/connect_hours_of_operation.html.markdown +++ b/website/docs/cdktf/typescript/r/connect_hours_of_operation.html.markdown @@ -69,6 +69,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `config` - (Required) One or more config blocks which define the configuration information for the hours of operation: day, start time, and end time . Config blocks are documented below. * `description` - (Optional) Specifies the description of the Hours of Operation. * `instanceId` - (Required) Specifies the identifier of the hosting Amazon Connect Instance. @@ -133,4 +134,4 @@ Using `terraform import`, import Amazon Connect Hours of Operations using the `i % terraform import aws_connect_hours_of_operation.example f1288a1f-6193-445a-b47e-af739b2:c1d4e5f6-1b3c-1b3c-1b3c-c1d4e5f6c1d4e5 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/connect_instance.html.markdown b/website/docs/cdktf/typescript/r/connect_instance.html.markdown index 45275b0b476f..331f19c3ba4a 100644 --- a/website/docs/cdktf/typescript/r/connect_instance.html.markdown +++ b/website/docs/cdktf/typescript/r/connect_instance.html.markdown @@ -98,6 +98,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `autoResolveBestVoicesEnabled` - (Optional) Specifies whether auto resolve best voices is enabled. Defaults to `true`. * `contactFlowLogsEnabled` - (Optional) Specifies whether contact flow logs are enabled. Defaults to `false`. * `contactLensEnabled` - (Optional) Specifies whether contact lens is enabled. Defaults to `true`. @@ -161,4 +162,4 @@ Using `terraform import`, import Connect instances using the `id`. For example: % terraform import aws_connect_instance.example f1288a1f-6193-445a-b47e-af739b2 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/connect_instance_storage_config.html.markdown b/website/docs/cdktf/typescript/r/connect_instance_storage_config.html.markdown index cd0fec29814b..b75e8f4d8eb8 100644 --- a/website/docs/cdktf/typescript/r/connect_instance_storage_config.html.markdown +++ b/website/docs/cdktf/typescript/r/connect_instance_storage_config.html.markdown @@ -177,6 +177,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `instanceId` - (Required) Specifies the identifier of the hosting Amazon Connect Instance. * `resourceType` - (Required) A valid resource type. Valid Values: `AGENT_EVENTS` | `ATTACHMENTS` | `CALL_RECORDINGS` | `CHAT_TRANSCRIPTS` | `CONTACT_EVALUATIONS` | `CONTACT_TRACE_RECORDS` | `EMAIL_MESSAGES` | `MEDIA_STREAMS` | `REAL_TIME_CONTACT_ANALYSIS_CHAT_SEGMENTS` | `REAL_TIME_CONTACT_ANALYSIS_SEGMENTS` | `REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS` | `SCHEDULED_REPORTS` | `SCREEN_RECORDINGS`. * `storageConfig` - (Required) Specifies the storage configuration options for the Connect Instance. [Documented below](#storage_config). @@ -265,4 +266,4 @@ Using `terraform import`, import Amazon Connect Instance Storage Configs using t % terraform import aws_connect_instance_storage_config.example f1288a1f-6193-445a-b47e-af739b2:c1d4e5f6-1b3c-1b3c-1b3c-c1d4e5f6c1d4e5:CHAT_TRANSCRIPTS ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/connect_lambda_function_association.html.markdown b/website/docs/cdktf/typescript/r/connect_lambda_function_association.html.markdown index 3579a3708252..6c6934969c49 100644 --- a/website/docs/cdktf/typescript/r/connect_lambda_function_association.html.markdown +++ b/website/docs/cdktf/typescript/r/connect_lambda_function_association.html.markdown @@ -40,6 +40,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `functionArn` - (Required) Amazon Resource Name (ARN) of the Lambda Function, omitting any version or alias qualifier. * `instanceId` - (Required) The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance. @@ -81,4 +82,4 @@ Using `terraform import`, import `aws_connect_lambda_function_association` using % terraform import aws_connect_lambda_function_association.example aaaaaaaa-bbbb-cccc-dddd-111111111111,arn:aws:lambda:us-west-2:123456789123:function:example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/connect_phone_number.html.markdown b/website/docs/cdktf/typescript/r/connect_phone_number.html.markdown index ce5b1bc8cfe4..96726908f818 100644 --- a/website/docs/cdktf/typescript/r/connect_phone_number.html.markdown +++ b/website/docs/cdktf/typescript/r/connect_phone_number.html.markdown @@ -96,6 +96,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `countryCode` - (Required, Forces new resource) The ISO country code. For a list of Valid values, refer to [PhoneNumberCountryCode](https://docs.aws.amazon.com/connect/latest/APIReference/API_SearchAvailablePhoneNumbers.html#connect-SearchAvailablePhoneNumbers-request-PhoneNumberCountryCode). * `description` - (Optional, Forces new resource) The description of the phone number. * `prefix` - (Optional, Forces new resource) The prefix of the phone number that is used to filter available phone numbers. If provided, it must contain `+` as part of the country code. Do not specify this argument when importing the resource. @@ -160,4 +161,4 @@ Using `terraform import`, import Amazon Connect Phone Numbers using its `id`. Fo % terraform import aws_connect_phone_number.example 12345678-abcd-1234-efgh-9876543210ab ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/connect_phone_number_contact_flow_association.html.markdown b/website/docs/cdktf/typescript/r/connect_phone_number_contact_flow_association.html.markdown new file mode 100644 index 000000000000..73061c83babc --- /dev/null +++ b/website/docs/cdktf/typescript/r/connect_phone_number_contact_flow_association.html.markdown @@ -0,0 +1,84 @@ +--- +subcategory: "Connect" +layout: "aws" +page_title: "AWS: aws_connect_phone_number_contact_flow_association" +description: |- + Associates a flow with a phone number claimed to an Amazon Connect instance. +--- + + + +# Resource: aws_connect_phone_number_contact_flow_association + +Associates a flow with a phone number claimed to an Amazon Connect instance. + +## Example Usage + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { ConnectPhoneNumberContactFlowAssociation } from "./.gen/providers/aws/"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + new ConnectPhoneNumberContactFlowAssociation(this, "example", { + contact_flow_id: awsConnectContactFlowExample.contactFlowId, + instance_id: awsConnectInstanceExample.id, + phone_number_id: awsConnectPhoneNumberExample.id, + }); + } +} + +``` + +## Argument Reference + +This resource supports the following arguments: + +* `contactFlowId` - (Required) Contact flow ID. +* `instanceId` - (Required) Amazon Connect instance ID. +* `phone_number_id` - (Required) Phone number ID. +* `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). + +## 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 `aws_connect_phone_number_contact_flow_association` using the `phone_number_id`, `instanceId` and `contactFlowId` separated by a comma (`,`). For example: + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { ConnectPhoneNumberContactFlowAssociation } from "./.gen/providers/aws/"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + ConnectPhoneNumberContactFlowAssociation.generateConfigForImport( + this, + "example", + "36727a4c-4683-4e49-880c-3347c61110a4,fa6c1691-e2eb-4487-bdb9-1aaed6268ebd,c4acdc79-395e-4280-a294-9062f56b07bb" + ); + } +} + +``` + +Using `terraform import`, import `aws_connect_phone_number_contact_flow_association` using the `phone_number_id`, `instanceId` and `contactFlowId` separated by a comma (`,`). For example: + +```console +% terraform import aws_connect_phone_number_contact_flow_association.example 36727a4c-4683-4e49-880c-3347c61110a4,fa6c1691-e2eb-4487-bdb9-1aaed6268ebd,c4acdc79-395e-4280-a294-9062f56b07bb +``` + + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/connect_queue.html.markdown b/website/docs/cdktf/typescript/r/connect_queue.html.markdown index 65cdd28fd9cb..7bdf6973834a 100644 --- a/website/docs/cdktf/typescript/r/connect_queue.html.markdown +++ b/website/docs/cdktf/typescript/r/connect_queue.html.markdown @@ -109,6 +109,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `description` - (Optional) Specifies the description of the Queue. * `hoursOfOperationId` - (Required) Specifies the identifier of the Hours of Operation. * `instanceId` - (Required) Specifies the identifier of the hosting Amazon Connect Instance. @@ -166,4 +167,4 @@ Using `terraform import`, import Amazon Connect Queues using the `instanceId` an % terraform import aws_connect_queue.example f1288a1f-6193-445a-b47e-af739b2:c1d4e5f6-1b3c-1b3c-1b3c-c1d4e5f6c1d4e5 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/connect_quick_connect.html.markdown b/website/docs/cdktf/typescript/r/connect_quick_connect.html.markdown index a6f7ed552b13..82145ac24903 100644 --- a/website/docs/cdktf/typescript/r/connect_quick_connect.html.markdown +++ b/website/docs/cdktf/typescript/r/connect_quick_connect.html.markdown @@ -52,6 +52,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `description` - (Optional) Specifies the description of the Quick Connect. * `instanceId` - (Required) Specifies the identifier of the hosting Amazon Connect Instance. * `name` - (Required) Specifies the name of the Quick Connect. @@ -120,4 +121,4 @@ Using `terraform import`, import Amazon Connect Quick Connects using the `instan % terraform import aws_connect_quick_connect.example f1288a1f-6193-445a-b47e-af739b2:c1d4e5f6-1b3c-1b3c-1b3c-c1d4e5f6c1d4e5 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/connect_routing_profile.html.markdown b/website/docs/cdktf/typescript/r/connect_routing_profile.html.markdown index 7c337c1b6a2b..aa0568aed030 100644 --- a/website/docs/cdktf/typescript/r/connect_routing_profile.html.markdown +++ b/website/docs/cdktf/typescript/r/connect_routing_profile.html.markdown @@ -59,6 +59,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `defaultOutboundQueueId` - (Required) Specifies the default outbound queue for the Routing Profile. * `description` - (Required) Specifies the description of the Routing Profile. * `instanceId` - (Required) Specifies the identifier of the hosting Amazon Connect Instance. @@ -127,4 +128,4 @@ Using `terraform import`, import Amazon Connect Routing Profiles using the `inst % terraform import aws_connect_routing_profile.example f1288a1f-6193-445a-b47e-af739b2:c1d4e5f6-1b3c-1b3c-1b3c-c1d4e5f6c1d4e5 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/connect_security_profile.html.markdown b/website/docs/cdktf/typescript/r/connect_security_profile.html.markdown index 1a06fb7017b1..5472217a190f 100644 --- a/website/docs/cdktf/typescript/r/connect_security_profile.html.markdown +++ b/website/docs/cdktf/typescript/r/connect_security_profile.html.markdown @@ -45,6 +45,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `description` - (Optional) Specifies the description of the Security Profile. * `instanceId` - (Required) Specifies the identifier of the hosting Amazon Connect Instance. * `name` - (Required) Specifies the name of the Security Profile. @@ -94,4 +95,4 @@ Using `terraform import`, import Amazon Connect Security Profiles using the `ins % terraform import aws_connect_security_profile.example f1288a1f-6193-445a-b47e-af739b2:c1d4e5f6-1b3c-1b3c-1b3c-c1d4e5f6c1d4e5 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/connect_user.html.markdown b/website/docs/cdktf/typescript/r/connect_user.html.markdown index cc5ba9a6487b..257a4a43fd92 100644 --- a/website/docs/cdktf/typescript/r/connect_user.html.markdown +++ b/website/docs/cdktf/typescript/r/connect_user.html.markdown @@ -113,7 +113,7 @@ class MyConvertedCode extends TerraformStack { email: "example@example.com", firstName: "example", lastName: "example2", - secondary_email: "secondary@example.com", + secondaryEmail: "secondary@example.com", }, instanceId: Token.asString(awsConnectInstanceExample.id), name: "example", @@ -209,6 +209,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `directoryUserId` - (Optional) The identifier of the user account in the directory used for identity management. If Amazon Connect cannot access the directory, you can specify this identifier to authenticate users. If you include the identifier, we assume that Amazon Connect cannot access the directory. Otherwise, the identity information is used to authenticate users from your directory. This parameter is required if you are using an existing directory for identity management in Amazon Connect when Amazon Connect cannot access your directory to authenticate users. If you are using SAML for identity management and include this parameter, an error is returned. * `hierarchyGroupId` - (Optional) The identifier of the hierarchy group for the user. * `identityInfo` - (Optional) A block that contains information about the identity of the user. Documented below. @@ -226,7 +227,7 @@ A `identityInfo` block supports the following arguments: * `email` - (Optional) The email address. If you are using SAML for identity management and include this parameter, an error is returned. Note that updates to the `email` is supported. From the [UpdateUserIdentityInfo API documentation](https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdateUserIdentityInfo.html) it is strongly recommended to limit who has the ability to invoke `UpdateUserIdentityInfo`. Someone with that ability can change the login credentials of other users by changing their email address. This poses a security risk to your organization. They can change the email address of a user to the attacker's email address, and then reset the password through email. For more information, see [Best Practices for Security Profiles](https://docs.aws.amazon.com/connect/latest/adminguide/security-profile-best-practices.html) in the Amazon Connect Administrator Guide. * `firstName` - (Optional) The first name. This is required if you are using Amazon Connect or SAML for identity management. Minimum length of 1. Maximum length of 100. * `lastName` - (Optional) The last name. This is required if you are using Amazon Connect or SAML for identity management. Minimum length of 1. Maximum length of 100. -* `secondary_email` - (Optional) The secondary email address. If present, email notifications will be sent to this email address instead of the primary one. +* `secondaryEmail` - (Optional) The secondary email address. If present, email notifications will be sent to this email address instead of the primary one. A `phoneConfig` block supports the following arguments: @@ -277,4 +278,4 @@ Using `terraform import`, import Amazon Connect Users using the `instanceId` and % terraform import aws_connect_user.example f1288a1f-6193-445a-b47e-af739b2:c1d4e5f6-1b3c-1b3c-1b3c-c1d4e5f6c1d4e5 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/connect_user_hierarchy_group.html.markdown b/website/docs/cdktf/typescript/r/connect_user_hierarchy_group.html.markdown index 149bed1bf807..1082002c22c1 100644 --- a/website/docs/cdktf/typescript/r/connect_user_hierarchy_group.html.markdown +++ b/website/docs/cdktf/typescript/r/connect_user_hierarchy_group.html.markdown @@ -81,6 +81,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `instanceId` - (Required) Specifies the identifier of the hosting Amazon Connect Instance. * `name` - (Required) The name of the user hierarchy group. Must not be more than 100 characters. * `parentGroupId` - (Optional) The identifier for the parent hierarchy group. The user hierarchy is created at level one if the parent group ID is null. @@ -145,4 +146,4 @@ Using `terraform import`, import Amazon Connect User Hierarchy Groups using the % terraform import aws_connect_user_hierarchy_group.example f1288a1f-6193-445a-b47e-af739b2:c1d4e5f6-1b3c-1b3c-1b3c-c1d4e5f6c1d4e5 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/connect_user_hierarchy_structure.html.markdown b/website/docs/cdktf/typescript/r/connect_user_hierarchy_structure.html.markdown index 3f3d7d0078bd..3ec2151be6b6 100644 --- a/website/docs/cdktf/typescript/r/connect_user_hierarchy_structure.html.markdown +++ b/website/docs/cdktf/typescript/r/connect_user_hierarchy_structure.html.markdown @@ -85,6 +85,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `hierarchyStructure` - (Required) A block that defines the hierarchy structure's levels. The `hierarchyStructure` block is documented below. * `instanceId` - (Required) Specifies the identifier of the hosting Amazon Connect Instance. @@ -144,4 +145,4 @@ Using `terraform import`, import Amazon Connect User Hierarchy Structures using % terraform import aws_connect_user_hierarchy_structure.example f1288a1f-6193-445a-b47e-af739b2 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/connect_vocabulary.html.markdown b/website/docs/cdktf/typescript/r/connect_vocabulary.html.markdown index 279c0566c6e3..f7fca8d0667a 100644 --- a/website/docs/cdktf/typescript/r/connect_vocabulary.html.markdown +++ b/website/docs/cdktf/typescript/r/connect_vocabulary.html.markdown @@ -46,6 +46,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `content` - (Required) The content of the custom vocabulary in plain-text format with a table of values. Each row in the table represents a word or a phrase, described with Phrase, IPA, SoundsLike, and DisplayAs fields. Separate the fields with TAB characters. For more information, see [Create a custom vocabulary using a table](https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html#create-vocabulary-table). Minimum length of `1`. Maximum length of `60000`. * `instanceId` - (Required) Specifies the identifier of the hosting Amazon Connect Instance. * `languageCode` - (Required) The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see [What is Amazon Transcribe?](https://docs.aws.amazon.com/transcribe/latest/dg/transcribe-whatis.html). Valid Values are `ar-AE`, `de-CH`, `de-DE`, `en-AB`, `en-AU`, `en-GB`, `en-IE`, `en-IN`, `en-US`, `en-WL`, `es-ES`, `es-US`, `fr-CA`, `fr-FR`, `hi-IN`, `it-IT`, `ja-JP`, `ko-KR`, `pt-BR`, `pt-PT`, `zh-CN`. @@ -105,4 +106,4 @@ Using `terraform import`, import Amazon Connect Vocabularies using the `instance % terraform import aws_connect_vocabulary.example f1288a1f-6193-445a-b47e-af739b2:c1d4e5f6-1b3c-1b3c-1b3c-c1d4e5f6c1d4e5 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/controltower_control.html.markdown b/website/docs/cdktf/typescript/r/controltower_control.html.markdown index 579831bf1dac..562e24356de6 100644 --- a/website/docs/cdktf/typescript/r/controltower_control.html.markdown +++ b/website/docs/cdktf/typescript/r/controltower_control.html.markdown @@ -44,7 +44,7 @@ class MyConvertedCode extends TerraformStack { { controlIdentifier: "arn:aws:controltower:${" + - current.name + + current.region + "}::control/AWS-GR_EC2_VOLUME_INUSE_CHECK", parameters: [ { @@ -78,6 +78,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `parameters` - (Optional) Parameter values which are specified to configure the control when you enable it. See [Parameters](#parameters) for more details. ### Parameters @@ -124,4 +125,4 @@ Using `terraform import`, import Control Tower Controls using their `organizatio % terraform import aws_controltower_control.example arn:aws:organizations::123456789101:ou/o-qqaejywet/ou-qg5o-ufbhdtv3,arn:aws:controltower:us-east-1::control/WTDSMKDKDNLE ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/controltower_landing_zone.html.markdown b/website/docs/cdktf/typescript/r/controltower_landing_zone.html.markdown index 648f2f578f36..1d3966888685 100644 --- a/website/docs/cdktf/typescript/r/controltower_landing_zone.html.markdown +++ b/website/docs/cdktf/typescript/r/controltower_landing_zone.html.markdown @@ -42,6 +42,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `manifestJson` - (Required) The manifest JSON file is a text file that describes your AWS resources. For examples, review [Launch your landing zone](https://docs.aws.amazon.com/controltower/latest/userguide/lz-api-launch). * `version` - (Required) The landing zone version. * `tags` - (Optional) Tags to apply to the landing zone. If configured with a provider [`defaultTags` 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. @@ -97,4 +98,4 @@ Using `terraform import`, import a Control Tower Landing Zone using the `id`. Fo % terraform import aws_controltower_landing_zone.example 1A2B3C4D5E6F7G8H ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/cur_report_definition.html.markdown b/website/docs/cdktf/typescript/r/cur_report_definition.html.markdown index cae6cb8922b1..8eb120eca73f 100644 --- a/website/docs/cdktf/typescript/r/cur_report_definition.html.markdown +++ b/website/docs/cdktf/typescript/r/cur_report_definition.html.markdown @@ -35,6 +35,7 @@ class MyConvertedCode extends TerraformStack { format: "textORcsv", reportName: "example-cur-report-definition", s3Bucket: "example-bucket-name", + s3Prefix: "example-cur-report", s3Region: "us-east-1", timeUnit: "HOURLY", }); @@ -51,9 +52,9 @@ This resource supports the following arguments: * `timeUnit` - (Required) The frequency on which report data are measured and displayed. Valid values are: `DAILY`, `HOURLY`, `MONTHLY`. * `format` - (Required) Format for report. Valid values are: `textORcsv`, `Parquet`. If `Parquet` is used, then Compression must also be `Parquet`. * `compression` - (Required) Compression format for report. Valid values are: `GZIP`, `ZIP`, `Parquet`. If `Parquet` is used, then format must also be `Parquet`. -* `additionalSchemaElements` - (Required) A list of schema elements. Valid values are: `RESOURCES`, `SPLIT_COST_ALLOCATION_DATA`. +* `additionalSchemaElements` - (Required) A list of schema elements. Valid values are: `RESOURCES`, `SPLIT_COST_ALLOCATION_DATA`, `MANUAL_DISCOUNT_COMPATIBILITY`. * `s3Bucket` - (Required) Name of the existing S3 bucket to hold generated reports. -* `s3Prefix` - (Optional) Report path prefix. Limited to 256 characters. +* `s3Prefix` - (Required) Report path prefix. Limited to 256 characters. May be empty (`""`) but the resource can then not be modified via the AWS Console. * `s3Region` - (Required) Region of the existing S3 bucket to hold generated reports. * `additionalArtifacts` - (Required) A list of additional artifacts. Valid values are: `REDSHIFT`, `QUICKSIGHT`, `ATHENA`. When ATHENA exists within additional_artifacts, no other artifact type can be declared and report_versioning must be `OVERWRITE_REPORT`. * `refreshClosedReports` - (Optional) Set to true to update your reports after they have been finalized if AWS detects charges related to previous months. @@ -99,4 +100,4 @@ Using `terraform import`, import Report Definitions using the `reportName`. For % terraform import aws_cur_report_definition.example_cur_report_definition example-cur-report-definition ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/customer_gateway.html.markdown b/website/docs/cdktf/typescript/r/customer_gateway.html.markdown index 648d46d2007e..5349cbd5a175 100644 --- a/website/docs/cdktf/typescript/r/customer_gateway.html.markdown +++ b/website/docs/cdktf/typescript/r/customer_gateway.html.markdown @@ -45,6 +45,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `bgpAsn` - (Optional, Forces new resource) The gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN). Valid values are from `1` to `2147483647`. Conflicts with `bgpAsnExtended`. * `bgpAsnExtended` - (Optional, Forces new resource) The gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN). Valid values are from `2147483648` to `4294967295` Conflicts with `bgpAsn`. * `certificateArn` - (Optional) The Amazon Resource Name (ARN) for the customer gateway certificate. @@ -90,4 +91,4 @@ Using `terraform import`, import Customer Gateways using the `id`. For example: % terraform import aws_customer_gateway.main cgw-b4dc3961 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/customerprofiles_domain.html.markdown b/website/docs/cdktf/typescript/r/customerprofiles_domain.html.markdown index a186aa4cdaf7..a2acc81c866e 100644 --- a/website/docs/cdktf/typescript/r/customerprofiles_domain.html.markdown +++ b/website/docs/cdktf/typescript/r/customerprofiles_domain.html.markdown @@ -132,6 +132,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `deadLetterQueueUrl` - The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications. * `defaultEncryptionKey` - The default encryption key, which is an AWS managed key, is used when no specific type of encryption key is specified. It is used to encrypt all data before it is placed in permanent or semi-permanent storage. * `matching` - A block that specifies the process of matching duplicate profiles. [Documented below](#matching). @@ -264,4 +265,4 @@ Using `terraform import`, import Amazon Customer Profiles Domain using the resou % terraform import aws_customerprofiles_domain.example e6f777be-22d0-4b40-b307-5d2720ef16b2 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/customerprofiles_profile.html.markdown b/website/docs/cdktf/typescript/r/customerprofiles_profile.html.markdown index 160ee81e58ed..2eed43f1881d 100644 --- a/website/docs/cdktf/typescript/r/customerprofiles_profile.html.markdown +++ b/website/docs/cdktf/typescript/r/customerprofiles_profile.html.markdown @@ -57,6 +57,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `accountNumber` - A unique account number that you have given to the customer. * `additionalInformation` - Any additional information relevant to the customer’s profile. * `address` - A block that specifies a generic address associated with the customer that is not mailing, shipping, or billing. [Documented below](#address). @@ -140,4 +141,4 @@ Using `terraform import`, import Amazon Customer Profiles Profile using the reso % terraform import aws_customerprofiles_profile.example domain-name/5f2f473dfbe841eb8d05cfc2a4c926df ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/dataexchange_data_set.html.markdown b/website/docs/cdktf/typescript/r/dataexchange_data_set.html.markdown index cfa07048d9aa..4388f3359b93 100644 --- a/website/docs/cdktf/typescript/r/dataexchange_data_set.html.markdown +++ b/website/docs/cdktf/typescript/r/dataexchange_data_set.html.markdown @@ -40,6 +40,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `assetType` - (Required) The type of asset that is added to a data set. Valid values include `API_GATEWAY_API`, `LAKE_FORMATION_DATA_PERMISSION`, `REDSHIFT_DATA_SHARE`, `S3_DATA_ACCESS`, `S3_SNAPSHOT`. * `description` - (Required) A description for the data set. * `name` - (Required) The name of the data set. @@ -85,4 +86,4 @@ Using `terraform import`, import DataExchange DataSets using their `id`. For exa % terraform import aws_dataexchange_data_set.example 4fa784c7-ccb4-4dbf-ba4f-02198320daa1 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/dataexchange_event_action.html.markdown b/website/docs/cdktf/typescript/r/dataexchange_event_action.html.markdown index 41160c6c09eb..aa711b1cc30f 100644 --- a/website/docs/cdktf/typescript/r/dataexchange_event_action.html.markdown +++ b/website/docs/cdktf/typescript/r/dataexchange_event_action.html.markdown @@ -66,6 +66,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `action` - (Required) Describes the action to take. Described in [`action` Configuration Block](#action-configuration-block) below. * `event` - (Required) Describes the event that triggers the `action`. @@ -146,4 +147,4 @@ Using `terraform import`, import Data Exchange Event Action using the id. For ex % terraform import aws_dataexchange_event_action.example example-event-action-id ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/dataexchange_revision.html.markdown b/website/docs/cdktf/typescript/r/dataexchange_revision.html.markdown index 20edb24176bd..5a4a16ffe322 100644 --- a/website/docs/cdktf/typescript/r/dataexchange_revision.html.markdown +++ b/website/docs/cdktf/typescript/r/dataexchange_revision.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `dataSetId` - (Required) The dataset id. * `comment` - (Required) An optional comment about the revision. * `tags` - (Optional) A map of tags to assign to the resource. If configured with a provider [`defaultTags` 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. @@ -83,4 +84,4 @@ Using `terraform import`, import DataExchange Revisions using their `data-set-id % terraform import aws_dataexchange_revision.example 4fa784c7-ccb4-4dbf-ba4f-02198320daa1:4fa784c7-ccb4-4dbf-ba4f-02198320daa1 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/dataexchange_revision_assets.html.markdown b/website/docs/cdktf/typescript/r/dataexchange_revision_assets.html.markdown index 734b8c6e2b69..30157afb137a 100644 --- a/website/docs/cdktf/typescript/r/dataexchange_revision_assets.html.markdown +++ b/website/docs/cdktf/typescript/r/dataexchange_revision_assets.html.markdown @@ -63,6 +63,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `comment` - (Optional) A comment for the revision. Maximum length is 16,348 characters. * `finalize` - (Optional) Finalized a revision. Defaults to `false`. * `force_destoy` - (Optional) Force destroy the revision. Defaults to `false`. @@ -109,4 +110,4 @@ Configuration options: * `create` - (Default 30m) Time to create the revision. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/datapipeline_pipeline.html.markdown b/website/docs/cdktf/typescript/r/datapipeline_pipeline.html.markdown index e46130f5bfca..b8050d383ad5 100644 --- a/website/docs/cdktf/typescript/r/datapipeline_pipeline.html.markdown +++ b/website/docs/cdktf/typescript/r/datapipeline_pipeline.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) The name of Pipeline. * `description` - (Optional) The description of Pipeline. * `tags` - (Optional) A map of tags to assign to the resource. If configured with a provider [`defaultTags` 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. @@ -81,4 +82,4 @@ Using `terraform import`, import `aws_datapipeline_pipeline` using the id (Pipel % terraform import aws_datapipeline_pipeline.default df-1234567890 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/datapipeline_pipeline_definition.html.markdown b/website/docs/cdktf/typescript/r/datapipeline_pipeline_definition.html.markdown index 03c414f98738..fcdcefe6c079 100644 --- a/website/docs/cdktf/typescript/r/datapipeline_pipeline_definition.html.markdown +++ b/website/docs/cdktf/typescript/r/datapipeline_pipeline_definition.html.markdown @@ -103,6 +103,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `parameterObject` - (Optional) Configuration block for the parameter objects used in the pipeline definition. See below * `parameterValue` - (Optional) Configuration block for the parameter values used in the pipeline definition. See below @@ -171,4 +172,4 @@ Using `terraform import`, import `aws_datapipeline_pipeline_definition` using th % terraform import aws_datapipeline_pipeline_definition.example df-1234567890 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/datasync_agent.html.markdown b/website/docs/cdktf/typescript/r/datasync_agent.html.markdown index f9994aba9725..a003584bbcab 100644 --- a/website/docs/cdktf/typescript/r/datasync_agent.html.markdown +++ b/website/docs/cdktf/typescript/r/datasync_agent.html.markdown @@ -57,7 +57,7 @@ class MyConvertedCode extends TerraformStack { const current = new DataAwsRegion(this, "current", {}); const example = new VpcEndpoint(this, "example", { securityGroupIds: [Token.asString(awsSecurityGroupExample.id)], - serviceName: "com.amazonaws.${" + current.name + "}.datasync", + serviceName: "com.amazonaws.${" + current.region + "}.datasync", subnetIds: [Token.asString(awsSubnetExample.id)], vpcEndpointType: "Interface", vpcId: Token.asString(awsVpcExample.id), @@ -94,6 +94,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) Name of the DataSync Agent. * `activationKey` - (Optional) DataSync Agent activation key during resource creation. Conflicts with `ipAddress`. If an `ipAddress` is provided instead, Terraform will retrieve the `activationKey` as part of the resource creation. * `ipAddress` - (Optional) DataSync Agent IP address to retrieve activation key during resource creation. Conflicts with `activationKey`. DataSync Agent must be accessible on port 80 from where Terraform is running. @@ -149,4 +150,4 @@ Using `terraform import`, import `aws_datasync_agent` using the DataSync Agent A % terraform import aws_datasync_agent.example arn:aws:datasync:us-east-1:123456789012:agent/agent-12345678901234567 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/datasync_location_azure_blob.html.markdown b/website/docs/cdktf/typescript/r/datasync_location_azure_blob.html.markdown index edbb101aaf33..4ba080e3c44c 100644 --- a/website/docs/cdktf/typescript/r/datasync_location_azure_blob.html.markdown +++ b/website/docs/cdktf/typescript/r/datasync_location_azure_blob.html.markdown @@ -46,6 +46,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `accessTier` - (Optional) The access tier that you want your objects or files transferred into. Valid values: `HOT`, `COOL` and `ARCHIVE`. Default: `HOT`. * `agentArns` - (Required) A list of DataSync Agent ARNs with which this location will be associated. * `authenticationType` - (Required) The authentication method DataSync uses to access your Azure Blob Storage. Valid values: `SAS`. @@ -98,4 +99,4 @@ Using `terraform import`, import `aws_datasync_location_azure_blob` using the Am % terraform import aws_datasync_location_azure_blob.example arn:aws:datasync:us-east-1:123456789012:location/loc-12345678901234567 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/datasync_location_efs.html.markdown b/website/docs/cdktf/typescript/r/datasync_location_efs.html.markdown index 5aa490791e71..8bda2ef00c41 100644 --- a/website/docs/cdktf/typescript/r/datasync_location_efs.html.markdown +++ b/website/docs/cdktf/typescript/r/datasync_location_efs.html.markdown @@ -44,6 +44,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `accessPointArn` - (Optional) Specifies the Amazon Resource Name (ARN) of the access point that DataSync uses to access the Amazon EFS file system. * `ec2Config` - (Required) Configuration block containing EC2 configurations for connecting to the EFS File System. * `efsFileSystemArn` - (Required) Amazon Resource Name (ARN) of EFS File System. @@ -99,4 +100,4 @@ Using `terraform import`, import `aws_datasync_location_efs` using the DataSync % terraform import aws_datasync_location_efs.example arn:aws:datasync:us-east-1:123456789012:location/loc-12345678901234567 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/datasync_location_fsx_lustre_file_system.html.markdown b/website/docs/cdktf/typescript/r/datasync_location_fsx_lustre_file_system.html.markdown index 7f8a726f2c51..6d3d840dcf54 100644 --- a/website/docs/cdktf/typescript/r/datasync_location_fsx_lustre_file_system.html.markdown +++ b/website/docs/cdktf/typescript/r/datasync_location_fsx_lustre_file_system.html.markdown @@ -39,6 +39,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `fsxFilesystemArn` - (Required) The Amazon Resource Name (ARN) for the FSx for Lustre file system. * `securityGroupArns` - (Optional) The Amazon Resource Names (ARNs) of the security groups that are to use to configure the FSx for Lustre file system. * `subdirectory` - (Optional) Subdirectory to perform actions as source or destination. @@ -86,4 +87,4 @@ Using `terraform import`, import `aws_datasync_location_fsx_lustre_file_system` % terraform import aws_datasync_location_fsx_lustre_file_system.example arn:aws:datasync:us-west-2:123456789012:location/loc-12345678901234567#arn:aws:fsx:us-west-2:476956259333:file-system/fs-08e04cd442c1bb94a ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/datasync_location_fsx_ontap_file_system.html.markdown b/website/docs/cdktf/typescript/r/datasync_location_fsx_ontap_file_system.html.markdown index 71282dc66930..60b90ff9c603 100644 --- a/website/docs/cdktf/typescript/r/datasync_location_fsx_ontap_file_system.html.markdown +++ b/website/docs/cdktf/typescript/r/datasync_location_fsx_ontap_file_system.html.markdown @@ -59,6 +59,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `subdirectory` - (Optional) Path to the file share in the SVM where you'll copy your data. You can specify a junction path (also known as a mount point), qtree path (for NFS file shares), or share name (for SMB file shares) (e.g. `/vol1`, `/vol1/tree1`, `share1`). * `tags` - (Optional) Key-value pairs of resource tags to assign to the DataSync Location. If configured with a provider [`defaultTags` 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. @@ -126,4 +127,4 @@ Using `terraform import`, import `aws_datasync_location_fsx_ontap_file_system` u % terraform import aws_datasync_location_fsx_ontap_file_system.example arn:aws:datasync:us-west-2:123456789012:location/loc-12345678901234567#arn:aws:fsx:us-west-2:123456789012:storage-virtual-machine/svm-12345678abcdef123 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/datasync_location_fsx_openzfs_file_system.html.markdown b/website/docs/cdktf/typescript/r/datasync_location_fsx_openzfs_file_system.html.markdown index b97fa58a3f2a..3a42970588e9 100644 --- a/website/docs/cdktf/typescript/r/datasync_location_fsx_openzfs_file_system.html.markdown +++ b/website/docs/cdktf/typescript/r/datasync_location_fsx_openzfs_file_system.html.markdown @@ -46,6 +46,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `fsxFilesystemArn` - (Required) The Amazon Resource Name (ARN) for the FSx for OpenZfs file system. * `protocol` - (Required) The type of protocol that DataSync uses to access your file system. See below. * `securityGroupArns` - (Optional) The Amazon Resource Names (ARNs) of the security groups that are to use to configure the FSx for openzfs file system. @@ -106,4 +107,4 @@ Using `terraform import`, import `aws_datasync_location_fsx_openzfs_file_system` % terraform import aws_datasync_location_fsx_openzfs_file_system.example arn:aws:datasync:us-west-2:123456789012:location/loc-12345678901234567#arn:aws:fsx:us-west-2:123456789012:file-system/fs-08e04cd442c1bb94a ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/datasync_location_fsx_windows_file_system.html.markdown b/website/docs/cdktf/typescript/r/datasync_location_fsx_windows_file_system.html.markdown index 5a5758ed8990..6a9657f1ee6f 100644 --- a/website/docs/cdktf/typescript/r/datasync_location_fsx_windows_file_system.html.markdown +++ b/website/docs/cdktf/typescript/r/datasync_location_fsx_windows_file_system.html.markdown @@ -41,6 +41,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `fsxFilesystemArn` - (Required) The Amazon Resource Name (ARN) for the FSx for Windows file system. * `password` - (Required) The password of the user who has the permissions to access files and folders in the FSx for Windows file system. * `user` - (Required) The user who has the permissions to access files and folders in the FSx for Windows file system. @@ -91,4 +92,4 @@ Using `terraform import`, import `aws_datasync_location_fsx_windows_file_system` % terraform import aws_datasync_location_fsx_windows_file_system.example arn:aws:datasync:us-west-2:123456789012:location/loc-12345678901234567#arn:aws:fsx:us-west-2:476956259333:file-system/fs-08e04cd442c1bb94a ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/datasync_location_hdfs.html.markdown b/website/docs/cdktf/typescript/r/datasync_location_hdfs.html.markdown index 3fb676c106cb..6d7028c0a4ad 100644 --- a/website/docs/cdktf/typescript/r/datasync_location_hdfs.html.markdown +++ b/website/docs/cdktf/typescript/r/datasync_location_hdfs.html.markdown @@ -80,6 +80,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `agentArns` - (Required) A list of DataSync Agent ARNs with which this location will be associated. * `authenticationType` - (Required) The type of authentication used to determine the identity of the user. Valid values are `SIMPLE` and `KERBEROS`. * `blockSize` - (Optional) The size of data blocks to write into the HDFS cluster. The block size must be a multiple of 512 bytes. The default block size is 128 mebibytes (MiB). @@ -145,4 +146,4 @@ Using `terraform import`, import `aws_datasync_location_hdfs` using the Amazon R % terraform import aws_datasync_location_hdfs.example arn:aws:datasync:us-east-1:123456789012:location/loc-12345678901234567 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/datasync_location_nfs.html.markdown b/website/docs/cdktf/typescript/r/datasync_location_nfs.html.markdown index 66fc7a0f3ee3..2200f7dd5221 100644 --- a/website/docs/cdktf/typescript/r/datasync_location_nfs.html.markdown +++ b/website/docs/cdktf/typescript/r/datasync_location_nfs.html.markdown @@ -44,6 +44,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `mountOptions` - (Optional) Configuration block containing mount options used by DataSync to access the NFS Server. * `onPremConfig` - (Required) Configuration block containing information for connecting to the NFS File System. * `serverHostname` - (Required) Specifies the IP address or DNS name of the NFS server. The DataSync Agent(s) use this to mount the NFS server. @@ -102,4 +103,4 @@ Using `terraform import`, import `aws_datasync_location_nfs` using the DataSync % terraform import aws_datasync_location_nfs.example arn:aws:datasync:us-east-1:123456789012:location/loc-12345678901234567 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/datasync_location_object_storage.html.markdown b/website/docs/cdktf/typescript/r/datasync_location_object_storage.html.markdown index ba2fc2d3bd18..4e0d4dcf39b6 100644 --- a/website/docs/cdktf/typescript/r/datasync_location_object_storage.html.markdown +++ b/website/docs/cdktf/typescript/r/datasync_location_object_storage.html.markdown @@ -42,6 +42,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `agentArns` - (Required) A list of DataSync Agent ARNs with which this location will be associated. * `accessKey` - (Optional) The access key is used if credentials are required to access the self-managed object storage server. If your object storage requires a user name and password to authenticate, use `accessKey` and `secretKey` to provide the user name and password, respectively. * `bucketName` - (Required) The bucket on the self-managed object storage server that is used to read data from. @@ -93,4 +94,4 @@ Using `terraform import`, import `aws_datasync_location_object_storage` using th % terraform import aws_datasync_location_object_storage.example arn:aws:datasync:us-east-1:123456789012:location/loc-12345678901234567 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/datasync_location_s3.html.markdown b/website/docs/cdktf/typescript/r/datasync_location_s3.html.markdown index e8ee61e23ba2..b266da8e5266 100644 --- a/website/docs/cdktf/typescript/r/datasync_location_s3.html.markdown +++ b/website/docs/cdktf/typescript/r/datasync_location_s3.html.markdown @@ -72,6 +72,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `agentArns` - (Optional) (Amazon S3 on Outposts only) Amazon Resource Name (ARN) of the DataSync agent on the Outpost. * `s3BucketArn` - (Required) Amazon Resource Name (ARN) of the S3 bucket, or the Amazon S3 access point if the S3 bucket is located on an AWS Outposts resource. * `s3Config` - (Required) Configuration block containing information for connecting to S3. @@ -125,4 +126,4 @@ Using `terraform import`, import `aws_datasync_location_s3` using the DataSync T % terraform import aws_datasync_location_s3.example arn:aws:datasync:us-east-1:123456789012:location/loc-12345678901234567 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/datasync_location_smb.html.markdown b/website/docs/cdktf/typescript/r/datasync_location_smb.html.markdown index 2f6473d78cf8..7ab33e7c99e1 100644 --- a/website/docs/cdktf/typescript/r/datasync_location_smb.html.markdown +++ b/website/docs/cdktf/typescript/r/datasync_location_smb.html.markdown @@ -44,6 +44,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `agentArns` - (Required) A list of DataSync Agent ARNs with which this location will be associated. * `domain` - (Optional) The name of the Windows domain the SMB server belongs to. * `mountOptions` - (Optional) Configuration block containing mount options used by DataSync to access the SMB Server. Can be `AUTOMATIC`, `SMB2`, or `SMB3`. @@ -98,4 +99,4 @@ Using `terraform import`, import `aws_datasync_location_smb` using the Amazon Re % terraform import aws_datasync_location_smb.example arn:aws:datasync:us-east-1:123456789012:location/loc-12345678901234567 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/datasync_task.html.markdown b/website/docs/cdktf/typescript/r/datasync_task.html.markdown index 70f644351ca2..b5c3ca6c9a62 100644 --- a/website/docs/cdktf/typescript/r/datasync_task.html.markdown +++ b/website/docs/cdktf/typescript/r/datasync_task.html.markdown @@ -133,6 +133,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `destinationLocationArn` - (Required) Amazon Resource Name (ARN) of destination DataSync Location. * `sourceLocationArn` - (Required) Amazon Resource Name (ARN) of source DataSync Location. * `cloudwatchLogGroupArn` - (Optional) Amazon Resource Name (ARN) of the CloudWatch Log Group that is used to monitor and log events in the sync task. @@ -258,4 +259,4 @@ Using `terraform import`, import `aws_datasync_task` using the DataSync Task Ama % terraform import aws_datasync_task.example arn:aws:datasync:us-east-1:123456789012:task/task-12345678901234567 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/datazone_asset_type.html.markdown b/website/docs/cdktf/typescript/r/datazone_asset_type.html.markdown index 55162ddcfd7b..58784e061fec 100644 --- a/website/docs/cdktf/typescript/r/datazone_asset_type.html.markdown +++ b/website/docs/cdktf/typescript/r/datazone_asset_type.html.markdown @@ -49,6 +49,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `description` - (Optional) The description of the custom asset type. * `formsInput` - (Optional) The metadata forms that are to be attached to the custom asset type. @@ -98,4 +99,4 @@ Using `terraform import`, import DataZone Asset Type using the `domain_identifie % terraform import aws_datazone_asset_type.example domain-id-12345678,example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/datazone_domain.html.markdown b/website/docs/cdktf/typescript/r/datazone_domain.html.markdown index 96f65b8fd5f2..c8281abddc6d 100644 --- a/website/docs/cdktf/typescript/r/datazone_domain.html.markdown +++ b/website/docs/cdktf/typescript/r/datazone_domain.html.markdown @@ -26,6 +26,7 @@ import { Fn, Token, TerraformStack } from "cdktf"; */ import { DatazoneDomain } from "./.gen/providers/aws/datazone-domain"; import { IamRole } from "./.gen/providers/aws/iam-role"; +import { IamRolePolicy } from "./.gen/providers/aws/iam-role-policy"; class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); @@ -51,25 +52,31 @@ class MyConvertedCode extends TerraformStack { Version: "2012-10-17", }) ), - inlinePolicy: [ - { - name: "domain_execution_policy", - policy: Token.asString( - Fn.jsonencode({ - Statement: [ - { - Action: ["datazone:*", "ram:*", "sso:*", "kms:*"], - Effect: "Allow", - Resource: "*", - }, - ], - Version: "2012-10-17", - }) - ), - }, - ], name: "my_domain_execution_role", }); + const awsIamRolePolicyDomainExecutionRole = new IamRolePolicy( + this, + "domain_execution_role_1", + { + policy: Token.asString( + Fn.jsonencode({ + Statement: [ + { + Action: ["datazone:*", "ram:*", "sso:*", "kms:*"], + Effect: "Allow", + Resource: "*", + }, + ], + Version: "2012-10-17", + }) + ), + role: domainExecutionRole.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.*/ + awsIamRolePolicyDomainExecutionRole.overrideLogicalId( + "domain_execution_role" + ); new DatazoneDomain(this, "example", { domainExecutionRole: domainExecutionRole.arn, name: "example", @@ -79,6 +86,131 @@ class MyConvertedCode extends TerraformStack { ``` +### V2 Domain + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { Token, TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { DataAwsCallerIdentity } from "./.gen/providers/aws/data-aws-caller-identity"; +import { DataAwsIamPolicy } from "./.gen/providers/aws/data-aws-iam-policy"; +import { DataAwsIamPolicyDocument } from "./.gen/providers/aws/data-aws-iam-policy-document"; +import { DatazoneDomain } from "./.gen/providers/aws/datazone-domain"; +import { IamRole } from "./.gen/providers/aws/iam-role"; +import { IamRolePolicyAttachment } from "./.gen/providers/aws/iam-role-policy-attachment"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + const current = new DataAwsCallerIdentity(this, "current", {}); + const domainExecutionRole = new DataAwsIamPolicy( + this, + "domain_execution_role", + { + name: "SageMakerStudioDomainExecutionRolePolicy", + } + ); + const domainServiceRole = new DataAwsIamPolicy( + this, + "domain_service_role", + { + name: "SageMakerStudioDomainServiceRolePolicy", + } + ); + const assumeRoleDomainExecution = new DataAwsIamPolicyDocument( + this, + "assume_role_domain_execution", + { + statement: [ + { + actions: ["sts:AssumeRole", "sts:TagSession", "sts:SetContext"], + condition: [ + { + test: "StringEquals", + values: [Token.asString(current.accountId)], + variable: "aws:SourceAccount", + }, + { + test: "ForAllValues:StringLike", + values: ["datazone*"], + variable: "aws:TagKeys", + }, + ], + principals: [ + { + identifiers: ["datazone.amazonaws.com"], + type: "Service", + }, + ], + }, + ], + } + ); + const assumeRoleDomainService = new DataAwsIamPolicyDocument( + this, + "assume_role_domain_service", + { + statement: [ + { + actions: ["sts:AssumeRole"], + condition: [ + { + test: "StringEquals", + values: [Token.asString(current.accountId)], + variable: "aws:SourceAccount", + }, + ], + principals: [ + { + identifiers: ["datazone.amazonaws.com"], + type: "Service", + }, + ], + }, + ], + } + ); + const domainExecution = new IamRole(this, "domain_execution", { + assumeRolePolicy: Token.asString(assumeRoleDomainExecution.json), + name: "example-domain-execution-role", + }); + const domainService = new IamRole(this, "domain_service", { + assumeRolePolicy: Token.asString(assumeRoleDomainService.json), + name: "example-domain-service-role", + }); + const awsIamRolePolicyAttachmentDomainExecution = + new IamRolePolicyAttachment(this, "domain_execution_7", { + policyArn: Token.asString(domainExecutionRole.arn), + role: domainExecution.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.*/ + awsIamRolePolicyAttachmentDomainExecution.overrideLogicalId( + "domain_execution" + ); + const awsIamRolePolicyAttachmentDomainService = new IamRolePolicyAttachment( + this, + "domain_service_8", + { + policyArn: Token.asString(domainServiceRole.arn), + role: domainService.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.*/ + awsIamRolePolicyAttachmentDomainService.overrideLogicalId("domain_service"); + new DatazoneDomain(this, "example", { + domainExecutionRole: domainExecution.arn, + domainVersion: "V2", + name: "example-domain", + serviceRole: domainService.arn, + }); + } +} + +``` + ## Argument Reference The following arguments are required: @@ -88,8 +220,11 @@ The following arguments are required: The following arguments are optional: +* `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). * `description` - (Optional) Description of the Domain. +* `domainVersion` - (Optional) Version of the Domain. Valid values are `V1` and `V2`. Defaults to `V1`. * `kmsKeyIdentifier` - (Optional) ARN of the KMS key used to encrypt the Amazon DataZone domain, metadata and reporting data. +* `serviceRole` - (Optional) ARN of the service role used by DataZone. Required when `domainVersion` is set to `V2`. * `singleSignOn` - (Optional) Single sign on options, used to [enable AWS IAM Identity Center](https://docs.aws.amazon.com/datazone/latest/userguide/enable-IAM-identity-center-for-datazone.html) for DataZone. * `skipDeletionCheck` - (Optional) Whether to skip the deletion check for the Domain. @@ -141,4 +276,4 @@ Using `terraform import`, import DataZone Domain using the `domainId`. For examp % terraform import aws_datazone_domain.example domain-id-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/datazone_environment.html.markdown b/website/docs/cdktf/typescript/r/datazone_environment.html.markdown index e0f27360ce8d..ccdc8f7dc1eb 100644 --- a/website/docs/cdktf/typescript/r/datazone_environment.html.markdown +++ b/website/docs/cdktf/typescript/r/datazone_environment.html.markdown @@ -69,6 +69,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `accountIdentifier` - (Optional) The ID of the Amazon Web Services account where the environment exists * `accountRegion` - (Optional) The Amazon Web Services region where the environment exists. * `blueprintIdentifier` - (Optional) The blueprint with which the environment is created. @@ -132,4 +133,4 @@ Using `terraform import`, import DataZone Environment using the `domain_idntifie % terraform import aws_datazone_environment.example dzd_d2i7tzk3tnjjf4,5vpywijpwryec0 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/datazone_environment_blueprint_configuration.html.markdown b/website/docs/cdktf/typescript/r/datazone_environment_blueprint_configuration.html.markdown index 3df4d2797873..c259ca4eaf3b 100644 --- a/website/docs/cdktf/typescript/r/datazone_environment_blueprint_configuration.html.markdown +++ b/website/docs/cdktf/typescript/r/datazone_environment_blueprint_configuration.html.markdown @@ -73,6 +73,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `manageAccessRoleArn` - (Optional) ARN of the manage access role with which this blueprint is created. * `provisioningRoleArn` - (Optional) ARN of the provisioning role with which this blueprint is created. * `regionalParameters` - (Optional) Parameters for each region in which the blueprint is enabled @@ -113,4 +114,4 @@ Using `terraform import`, import DataZone Environment Blueprint Configuration us % terraform import aws_datazone_environment_blueprint_configuration.example domain-id-12345/environment-blueprint-id-54321 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/datazone_environment_profile.html.markdown b/website/docs/cdktf/typescript/r/datazone_environment_profile.html.markdown index 6f0e5e1921b7..fe1f148ccdff 100644 --- a/website/docs/cdktf/typescript/r/datazone_environment_profile.html.markdown +++ b/website/docs/cdktf/typescript/r/datazone_environment_profile.html.markdown @@ -156,6 +156,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `awsAccountId` - (Required) - Id of the AWS account being used. * `awsAccountRegion` - (Required) - Desired region for environment profile. * `domainIdentifier` - (Required) - Domain Identifier for environment profile. @@ -208,4 +209,4 @@ Using `terraform import`, import DataZone Environment Profile using a comma-deli % terraform import aws_datazone_environment_profile.example environment_profile-id-12345678,domain-id-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/datazone_form_type.html.markdown b/website/docs/cdktf/typescript/r/datazone_form_type.html.markdown index 263832536013..8b229578561d 100644 --- a/website/docs/cdktf/typescript/r/datazone_form_type.html.markdown +++ b/website/docs/cdktf/typescript/r/datazone_form_type.html.markdown @@ -123,6 +123,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `description` - (Optional) Description of form type. Must have a length of between 1 and 2048 characters. * `status` - (Optional) Status of form type. Must be "ENABLED" or "DISABLED" If status is set to "ENABLED" terraform cannot delete the resource until it is manually changed in the AWS console. @@ -169,4 +170,4 @@ Using `terraform import`, import DataZone Form Type using a comma separated valu % terraform import aws_datazone_form_type.example domain_identifier,name,revision ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/datazone_glossary.html.markdown b/website/docs/cdktf/typescript/r/datazone_glossary.html.markdown index 83d75b996c75..bedf5850cc69 100644 --- a/website/docs/cdktf/typescript/r/datazone_glossary.html.markdown +++ b/website/docs/cdktf/typescript/r/datazone_glossary.html.markdown @@ -137,6 +137,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `description` - (Optional) Description of the glossary. Must have a length between 0 and 4096. * `status` - (Optional) Status of business glossary. Valid values are DISABLED and ENABLED. @@ -148,7 +149,7 @@ This resource exports the following attributes in addition to the arguments abov ## Import -In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import DataZone Glossary using the `example_id_arg`. For example: +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import DataZone Glossary using a comma-delimited string combining the domain id, glossary id, and the id of the project it's under. For example: ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -178,4 +179,4 @@ Using `terraform import`, import DataZone Glossary using the import Datazone Glo % terraform import aws_datazone_glossary.example domain-id,glossary-id,owning-project-identifier ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/datazone_glossary_term.html.markdown b/website/docs/cdktf/typescript/r/datazone_glossary_term.html.markdown index 29c3e7e6b316..0f9f8e34bcf7 100644 --- a/website/docs/cdktf/typescript/r/datazone_glossary_term.html.markdown +++ b/website/docs/cdktf/typescript/r/datazone_glossary_term.html.markdown @@ -128,6 +128,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `longDescription` - (Optional) Long description of entry. * `shortDescription` - (Optional) Short description of entry. * `status` - (Optional) If glossary term is ENABLED or DISABLED. @@ -181,4 +182,4 @@ Using `terraform import`, import DataZone Glossary Term using a comma-delimited % terraform import aws_datazone_glossary_term.example domain-id,glossary-term-id,glossary-id ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/datazone_project.html.markdown b/website/docs/cdktf/typescript/r/datazone_project.html.markdown index d998da3ea400..d1096798d49a 100644 --- a/website/docs/cdktf/typescript/r/datazone_project.html.markdown +++ b/website/docs/cdktf/typescript/r/datazone_project.html.markdown @@ -73,6 +73,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `skipDeletionCheck` - (Optional) Optional flag to delete all child entities within the project. * `description` - (Optional) Description of project. * `glossaryTerms` - (Optional) List of glossary terms that can be used in the project. The list cannot be empty or include over 20 values. Each value must follow the regex of `[a-zA-Z0-9_-]{1,36}$`. @@ -131,4 +132,4 @@ Using `terraform import`, import DataZone Project using a colon-delimited string % terraform import aws_datazone_project.example domain-1234:project-1234 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/datazone_user_profile.html.markdown b/website/docs/cdktf/typescript/r/datazone_user_profile.html.markdown index 98f84d96c5f2..dea68fe859c5 100644 --- a/website/docs/cdktf/typescript/r/datazone_user_profile.html.markdown +++ b/website/docs/cdktf/typescript/r/datazone_user_profile.html.markdown @@ -47,6 +47,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `status` - (Optional) The user profile status. * `userType` - (Optional) The user type. @@ -97,4 +98,4 @@ Using `terraform import`, import DataZone User Profile using the `user_identifie % terraform import aws_datazone_user_profile.example arn:aws:iam::123456789012:user/example,dzd_54nakfrg9k6suo,IAM ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/dax_cluster.html.markdown b/website/docs/cdktf/typescript/r/dax_cluster.html.markdown index 24bfe6eb4d78..5aa3d922b4b9 100644 --- a/website/docs/cdktf/typescript/r/dax_cluster.html.markdown +++ b/website/docs/cdktf/typescript/r/dax_cluster.html.markdown @@ -41,49 +41,37 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: -* `clusterEndpointEncryptionType` – (Optional) The type of encryption the +* `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). +* `clusterEndpointEncryptionType` - (Optional) The type of encryption the cluster's endpoint should support. Valid values are: `NONE` and `TLS`. Default value is `NONE`. - -* `clusterName` – (Required) Group identifier. DAX converts this name to +* `clusterName` - (Required) Group identifier. DAX converts this name to lowercase - * `iamRoleArn` - (Required) A valid Amazon Resource Name (ARN) that identifies an IAM role. At runtime, DAX will assume this role and use the role's permissions to access DynamoDB on your behalf - -* `nodeType` – (Required) The compute and memory capacity of the nodes. See +* `nodeType` - (Required) The compute and memory capacity of the nodes. See [Nodes][1] for supported node types - -* `replicationFactor` – (Required) The number of nodes in the DAX cluster. A +* `replicationFactor` - (Required) The number of nodes in the DAX cluster. A replication factor of 1 will create a single-node cluster, without any read replicas - * `availabilityZones` - (Optional) List of Availability Zones in which the nodes will be created - -* `description` – (Optional) Description for the cluster - -* `notificationTopicArn` – (Optional) An Amazon Resource Name (ARN) of an +* `description` - (Optional) Description for the cluster +* `notificationTopicArn` - (Optional) An Amazon Resource Name (ARN) of an SNS topic to send DAX notifications to. Example: `arn:aws:sns:us-east-1:012345678999:my_sns_topic` - -* `parameterGroupName` – (Optional) Name of the parameter group to associate +* `parameterGroupName` - (Optional) Name of the parameter group to associate with this DAX cluster - -* `maintenanceWindow` – (Optional) Specifies the weekly time range for when +* `maintenanceWindow` - (Optional) Specifies the weekly time range for when maintenance on the cluster is performed. The format is `ddd:hh24:mi-ddd:hh24:mi` (24H Clock UTC). The minimum maintenance window is a 60 minute period. Example: `sun:05:00-sun:09:00` - -* `securityGroupIds` – (Optional) One or more VPC security groups associated +* `securityGroupIds` - (Optional) One or more VPC security groups associated with the cluster - * `serverSideEncryption` - (Optional) Encrypt at rest options - -* `subnetGroupName` – (Optional) Name of the subnet group to be used for the +* `subnetGroupName` - (Optional) Name of the subnet group to be used for the cluster - * `tags` - (Optional) A map of tags to assign to the resource. If configured with a provider [`defaultTags` 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 `serverSideEncryption` object supports the following: @@ -147,4 +135,4 @@ Using `terraform import`, import DAX Clusters using the `clusterName`. For examp [1]: http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DAX.concepts.cluster.html#DAX.concepts.nodes - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/dax_parameter_group.html.markdown b/website/docs/cdktf/typescript/r/dax_parameter_group.html.markdown index 6aceb51460d1..2907ab71ac1a 100644 --- a/website/docs/cdktf/typescript/r/dax_parameter_group.html.markdown +++ b/website/docs/cdktf/typescript/r/dax_parameter_group.html.markdown @@ -48,11 +48,10 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: -* `name` – (Required) The name of the parameter group. - +* `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). +* `name` - (Required) The name of the parameter group. * `description` - (Optional, ForceNew) A description of the parameter group. - -* `parameters` – (Optional) The parameters of the parameter group. +* `parameters` - (Optional) The parameters of the parameter group. ## parameters @@ -95,4 +94,4 @@ Using `terraform import`, import DAX Parameter Group using the `name`. For examp % terraform import aws_dax_parameter_group.example my_dax_pg ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/dax_subnet_group.html.markdown b/website/docs/cdktf/typescript/r/dax_subnet_group.html.markdown index e964065ad681..9f09384cb7a6 100644 --- a/website/docs/cdktf/typescript/r/dax_subnet_group.html.markdown +++ b/website/docs/cdktf/typescript/r/dax_subnet_group.html.markdown @@ -39,16 +39,17 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: -* `name` – (Required) The name of the subnet group. +* `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). +* `name` - (Required) The name of the subnet group. * `description` - (Optional) A description of the subnet group. -* `subnetIds` – (Required) A list of VPC subnet IDs for the subnet group. +* `subnetIds` - (Required) A list of VPC subnet IDs for the subnet group. ## Attribute Reference This resource exports the following attributes in addition to the arguments above: * `id` - The name of the subnet group. -* `vpcId` – VPC ID of the subnet group. +* `vpcId` - VPC ID of the subnet group. ## Import @@ -78,4 +79,4 @@ Using `terraform import`, import DAX Subnet Group using the `name`. For example: % terraform import aws_dax_subnet_group.example my_dax_sg ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/db_cluster_snapshot.html.markdown b/website/docs/cdktf/typescript/r/db_cluster_snapshot.html.markdown index bd87cfcb8353..3c17a9d9ad1a 100644 --- a/website/docs/cdktf/typescript/r/db_cluster_snapshot.html.markdown +++ b/website/docs/cdktf/typescript/r/db_cluster_snapshot.html.markdown @@ -39,6 +39,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `dbClusterIdentifier` - (Required) The DB Cluster Identifier from which to take the snapshot. * `dbClusterSnapshotIdentifier` - (Required) The Identifier for the snapshot. * `sharedAccounts` - (Optional) List of AWS Account IDs to share the snapshot with. Use `all` to make the snapshot public. @@ -57,7 +58,7 @@ This resource exports the following attributes in addition to the arguments abov * `licenseModel` - License model information for the restored DB cluster. * `port` - Port that the DB cluster was listening on at the time of the snapshot. -* `source_db_cluster_snapshot_identifier` - DB Cluster Snapshot ARN that the DB Cluster Snapshot was copied from. It only has value in case of cross customer or cross region copy. +* `sourceDbClusterSnapshotIdentifier` - DB Cluster Snapshot ARN that the DB Cluster Snapshot was copied from. It only has value in case of cross customer or cross region copy. * `storageEncrypted` - Whether the DB cluster snapshot is encrypted. * `status` - The status of this DB Cluster Snapshot. * `tagsAll` - A map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). @@ -101,4 +102,4 @@ Using `terraform import`, import `aws_db_cluster_snapshot` using the cluster sna % terraform import aws_db_cluster_snapshot.example my-cluster-snapshot ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/db_event_subscription.html.markdown b/website/docs/cdktf/typescript/r/db_event_subscription.html.markdown index 30bcca9c235a..42717279fe3d 100644 --- a/website/docs/cdktf/typescript/r/db_event_subscription.html.markdown +++ b/website/docs/cdktf/typescript/r/db_event_subscription.html.markdown @@ -77,6 +77,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Optional) The name of the DB event subscription. By default generated by Terraform. * `namePrefix` - (Optional) The name of the DB event subscription. Conflicts with `name`. * `snsTopic` - (Required) The SNS topic to send events to. @@ -135,4 +136,4 @@ Using `terraform import`, import DB Event Subscriptions using the `name`. For ex % terraform import aws_db_event_subscription.default rds-event-sub ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/db_instance.html.markdown b/website/docs/cdktf/typescript/r/db_instance.html.markdown index 8c7fea7849da..c11a727a4c24 100644 --- a/website/docs/cdktf/typescript/r/db_instance.html.markdown +++ b/website/docs/cdktf/typescript/r/db_instance.html.markdown @@ -29,7 +29,7 @@ See the AWS Docs on [RDS Instance Maintenance][instance-maintenance] for more in ~> **Note:** All arguments including the username and password will be stored in the raw state as plain-text. [Read more about sensitive data instate](https://www.terraform.io/docs/state/sensitive-data.html). --> **Note:** Write-Only argument `passwordWo` is available to use in place of `password`. Write-Only arguments are supported in HashiCorp Terraform 1.11.0 and later. [Learn more](https://developer.hashicorp.com/terraform/language/v1.11.x/resources/ephemeral#write-only-arguments). +-> **Note:** Write-Only argument `passwordWo` is available to use in place of `password`. Write-Only arguments are supported in HashiCorp Terraform 1.11.0 and later. [Learn more](https://developer.hashicorp.com/terraform/language/resources/ephemeral#write-only-arguments). > **Hands-on:** Try the [Manage AWS RDS Instances](https://learn.hashicorp.com/tutorials/terraform/aws-rds) tutorial on HashiCorp Learn. @@ -395,6 +395,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `allocatedStorage` - (Required unless a `snapshotIdentifier` or `replicateSourceDb` is provided) The allocated storage in gibibytes. If `maxAllocatedStorage` is configured, this argument represents the initial storage allocation and differences from the configuration will be ignored automatically when Storage Autoscaling occurs. If `replicateSourceDb` is set, the value is ignored during the creation of the instance. * `allowMajorVersionUpgrade` - (Optional) Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and @@ -424,7 +425,7 @@ Defaults to true. See [Oracle Character Sets Supported in Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.OracleCharacterSets.html) or [Server-Level Collation for Microsoft SQL Server](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.SQLServer.CommonDBATasks.Collation.html) for more information. Cannot be set with `replicateSourceDb`, `restoreToPointInTime`, `s3Import`, or `snapshotIdentifier`. -* `copyTagsToSnapshot` – (Optional, boolean) Copy all Instance `tags` to snapshots. Default is `false`. +* `copyTagsToSnapshot` - (Optional, boolean) Copy all Instance `tags` to snapshots. Default is `false`. * `customIamInstanceProfile` - (Optional) The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. * `databaseInsightsMode` - (Optional) The mode of Database Insights that is enabled for the instance. Valid values: `standard`, `advanced` . * `dbName` - (Optional) The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance. Note that this does not apply for Oracle or SQL Server engines. See the [AWS documentation](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/rds/create-db-instance.html) for more details on what applies for those engines. If you are providing an Oracle db name, it needs to be in all upper case. Cannot be specified for a replica. @@ -709,4 +710,4 @@ Using `terraform import`, import DB Instances using the `identifier`. For exampl % terraform import aws_db_instance.default mydb-rds-instance ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/db_instance_automated_backups_replication.html.markdown b/website/docs/cdktf/typescript/r/db_instance_automated_backups_replication.html.markdown index 8f3b4991f3e3..a7a9db14f05e 100644 --- a/website/docs/cdktf/typescript/r/db_instance_automated_backups_replication.html.markdown +++ b/website/docs/cdktf/typescript/r/db_instance_automated_backups_replication.html.markdown @@ -125,6 +125,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `kmsKeyId` - (Optional, Forces new resource) The AWS KMS key identifier for encryption of the replicated automated backups. The KMS key ID is the Amazon Resource Name (ARN) for the KMS encryption key in the destination AWS Region, for example, `arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE`. * `preSignedUrl` - (Optional, Forces new resource) A URL that contains a [Signature Version 4](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) signed request for the [`StartDBInstanceAutomatedBackupsReplication`](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_StartDBInstanceAutomatedBackupsReplication.html) action to be called in the AWS Region of the source DB instance. * `retentionPeriod` - (Optional, Forces new resource) The retention period for the replicated automated backups, defaults to `7`. @@ -175,4 +176,4 @@ Using `terraform import`, import RDS instance automated backups replication usin % terraform import aws_db_instance_automated_backups_replication.default arn:aws:rds:us-east-1:123456789012:auto-backup:ab-faaa2mgdj1vmp4xflr7yhsrmtbtob7ltrzzz2my ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/db_instance_role_association.html.markdown b/website/docs/cdktf/typescript/r/db_instance_role_association.html.markdown index 660cffbc1fa5..e25f216feaa1 100644 --- a/website/docs/cdktf/typescript/r/db_instance_role_association.html.markdown +++ b/website/docs/cdktf/typescript/r/db_instance_role_association.html.markdown @@ -48,6 +48,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `dbInstanceIdentifier` - (Required) DB Instance Identifier to associate with the IAM Role. * `featureName` - (Required) Name of the feature for association. This can be found in the AWS documentation relevant to the integration or a full list is available in the `SupportedFeatureNames` list returned by [AWS CLI rds describe-db-engine-versions](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-engine-versions.html). * `roleArn` - (Required) Amazon Resource Name (ARN) of the IAM Role to associate with the DB Instance. @@ -97,4 +98,4 @@ Using `terraform import`, import `aws_db_instance_role_association` using the DB % terraform import aws_db_instance_role_association.example my-db-instance,arn:aws:iam::123456789012:role/my-role ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/db_option_group.html.markdown b/website/docs/cdktf/typescript/r/db_option_group.html.markdown index c771777820ed..6404ba86653f 100644 --- a/website/docs/cdktf/typescript/r/db_option_group.html.markdown +++ b/website/docs/cdktf/typescript/r/db_option_group.html.markdown @@ -79,6 +79,7 @@ More information about this can be found [here](https://docs.aws.amazon.com/Amaz This resource supports the following arguments: +* `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). * `name` - (Optional, Forces new resource) Name of the option group. If omitted, Terraform will assign a random, unique name. Must be lowercase, to match as it is stored in AWS. * `namePrefix` - (Optional, Forces new resource) Creates a unique name beginning with the specified prefix. Conflicts with `name`. Must be lowercase, to match as it is stored in AWS. * `optionGroupDescription` - (Optional) Description of the option group. Defaults to "Managed by Terraform". @@ -152,4 +153,4 @@ Using `terraform import`, import DB option groups using the `name`. For example: % terraform import aws_db_option_group.example mysql-option-group ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/db_parameter_group.html.markdown b/website/docs/cdktf/typescript/r/db_parameter_group.html.markdown index 850235449e43..558ff2151dc0 100644 --- a/website/docs/cdktf/typescript/r/db_parameter_group.html.markdown +++ b/website/docs/cdktf/typescript/r/db_parameter_group.html.markdown @@ -247,6 +247,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Optional, Forces new resource) The name of the DB parameter group. If omitted, Terraform will assign a random, unique name. * `namePrefix` - (Optional, Forces new resource) Creates a unique name beginning with the specified prefix. Conflicts with `name`. * `family` - (Required, Forces new resource) The family of the DB parameter group. @@ -301,4 +302,4 @@ Using `terraform import`, import DB Parameter groups using the `name`. For examp % terraform import aws_db_parameter_group.rds_pg rds-pg ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/db_proxy.html.markdown b/website/docs/cdktf/typescript/r/db_proxy.html.markdown index 7c913d98587f..4adf52f5251d 100644 --- a/website/docs/cdktf/typescript/r/db_proxy.html.markdown +++ b/website/docs/cdktf/typescript/r/db_proxy.html.markdown @@ -165,6 +165,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) The identifier for the proxy. This name must be unique for all proxies owned by your AWS account in the specified AWS Region. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens. * `auth` - (Required) Configuration block(s) with authorization mechanisms to connect to the associated instances or clusters. Described below. * `debugLogging` - (Optional) Whether the proxy includes detailed information about SQL statements in its logs. This information helps you to debug issues involving SQL behavior or the performance and scalability of the proxy connections. The debug information includes the text of SQL statements that you submit through the proxy. Thus, only enable this setting when needed for debugging, and only when you have security measures in place to safeguard any sensitive information that appears in the logs. @@ -230,4 +231,4 @@ Using `terraform import`, import DB proxies using the `name`. For example: % terraform import aws_db_proxy.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/db_proxy_default_target_group.html.markdown b/website/docs/cdktf/typescript/r/db_proxy_default_target_group.html.markdown index 12413429004a..39790b8bec6e 100644 --- a/website/docs/cdktf/typescript/r/db_proxy_default_target_group.html.markdown +++ b/website/docs/cdktf/typescript/r/db_proxy_default_target_group.html.markdown @@ -76,6 +76,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `dbProxyName` - (Required) Name of the RDS DB Proxy. * `connectionPoolConfig` - (Optional) The settings that determine the size and behavior of the connection pool for the target group. @@ -134,4 +135,4 @@ Using `terraform import`, import DB proxy default target groups using the `dbPro % terraform import aws_db_proxy_default_target_group.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/db_proxy_endpoint.html.markdown b/website/docs/cdktf/typescript/r/db_proxy_endpoint.html.markdown index b71f3e56f48c..9276c7e17e4a 100644 --- a/website/docs/cdktf/typescript/r/db_proxy_endpoint.html.markdown +++ b/website/docs/cdktf/typescript/r/db_proxy_endpoint.html.markdown @@ -41,6 +41,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `dbProxyEndpointName` - (Required) The identifier for the proxy endpoint. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens. * `dbProxyName` - (Required) The name of the DB proxy associated with the DB proxy endpoint that you create. * `vpcSubnetIds` - (Required) One or more VPC subnet IDs to associate with the new proxy. @@ -94,4 +95,4 @@ Using `terraform import`, import DB proxy endpoints using the `DB-PROXY-NAME/DB- % terraform import aws_db_proxy_endpoint.example example/example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/db_proxy_target.html.markdown b/website/docs/cdktf/typescript/r/db_proxy_target.html.markdown index ad548acc3c91..be470b2a98be 100644 --- a/website/docs/cdktf/typescript/r/db_proxy_target.html.markdown +++ b/website/docs/cdktf/typescript/r/db_proxy_target.html.markdown @@ -82,6 +82,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `dbProxyName` - (Required, Forces new resource) The name of the DB proxy. * `targetGroupName` - (Required, Forces new resource) The name of the target group. * `dbInstanceIdentifier` - (Optional, Forces new resource) DB instance identifier. @@ -167,4 +168,4 @@ Provisioned Clusters: % terraform import aws_db_proxy_target.example example-proxy/default/TRACKED_CLUSTER/example-cluster ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/db_snapshot.html.markdown b/website/docs/cdktf/typescript/r/db_snapshot.html.markdown index 04f106666962..d0cb3fcc6d29 100644 --- a/website/docs/cdktf/typescript/r/db_snapshot.html.markdown +++ b/website/docs/cdktf/typescript/r/db_snapshot.html.markdown @@ -52,6 +52,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `dbInstanceIdentifier` - (Required) The DB Instance Identifier from which to take the snapshot. * `dbSnapshotIdentifier` - (Required) The Identifier for the snapshot. * `sharedAccounts` - (Optional) List of AWS Account IDs to share the snapshot with. Use `all` to make the snapshot public. @@ -112,4 +113,4 @@ Using `terraform import`, import `aws_db_snapshot` using the snapshot identifier % terraform import aws_db_snapshot.example my-snapshot ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/db_snapshot_copy.html.markdown b/website/docs/cdktf/typescript/r/db_snapshot_copy.html.markdown index fa0a2ba10bd2..526c3e733a1a 100644 --- a/website/docs/cdktf/typescript/r/db_snapshot_copy.html.markdown +++ b/website/docs/cdktf/typescript/r/db_snapshot_copy.html.markdown @@ -63,6 +63,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `copyTags` - (Optional) Whether to copy existing tags. Defaults to `false`. * `destinationRegion` - (Optional) The Destination region to place snapshot copy. * `kmsKeyId` - (Optional) KMS key ID. @@ -130,4 +131,4 @@ Using `terraform import`, import `aws_db_snapshot_copy` using the snapshot ident % terraform import aws_db_snapshot_copy.example my-snapshot ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/db_subnet_group.html.markdown b/website/docs/cdktf/typescript/r/db_subnet_group.html.markdown index 5721a00391bf..6d9d3b948052 100644 --- a/website/docs/cdktf/typescript/r/db_subnet_group.html.markdown +++ b/website/docs/cdktf/typescript/r/db_subnet_group.html.markdown @@ -44,6 +44,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Optional, Forces new resource) The name of the DB subnet group. If omitted, Terraform will assign a random, unique name. * `namePrefix` - (Optional, Forces new resource) Creates a unique name beginning with the specified prefix. Conflicts with `name`. * `description` - (Optional) The description of the DB subnet group. Defaults to "Managed by Terraform". @@ -92,4 +93,4 @@ Using `terraform import`, import DB Subnet groups using the `name`. For example: % terraform import aws_db_subnet_group.default production-subnet-group ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/default_network_acl.html.markdown b/website/docs/cdktf/typescript/r/default_network_acl.html.markdown index 68b114cfae83..269c00206b9d 100644 --- a/website/docs/cdktf/typescript/r/default_network_acl.html.markdown +++ b/website/docs/cdktf/typescript/r/default_network_acl.html.markdown @@ -184,6 +184,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `egress` - (Optional) Configuration block for an egress rule. Detailed below. * `ingress` - (Optional) Configuration block for an ingress rule. Detailed below. * `subnetIds` - (Optional) List of Subnet IDs to apply the ACL to. See the notes above on Managing Subnets in the Default Network ACL @@ -203,6 +204,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `cidrBlock` - (Optional) The CIDR block to match. This must be a valid network mask. * `icmpCode` - (Optional) The ICMP type code to be used. Default 0. * `icmpType` - (Optional) The ICMP type to be used. Default 0. @@ -250,4 +252,4 @@ Using `terraform import`, import Default Network ACLs using the `id`. For exampl % terraform import aws_default_network_acl.sample acl-7aaabd18 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/default_route_table.html.markdown b/website/docs/cdktf/typescript/r/default_route_table.html.markdown index fe2ffbabfeaa..9be9af517f0a 100644 --- a/website/docs/cdktf/typescript/r/default_route_table.html.markdown +++ b/website/docs/cdktf/typescript/r/default_route_table.html.markdown @@ -89,6 +89,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `propagatingVgws` - (Optional) List of virtual gateways for propagation. * `route` - (Optional) Configuration block of routes. Detailed below. This argument is processed in [attribute-as-blocks mode](https://www.terraform.io/docs/configuration/attr-as-blocks.html). This means that omitting this argument is interpreted as ignoring any existing routes. To remove all managed routes an empty list should be specified. See the example above. * `tags` - (Optional) Map of tags to assign to the resource. If configured with a provider [`defaultTags` 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. @@ -164,4 +165,4 @@ Using `terraform import`, import Default VPC route tables using the `vpcId`. For [tf-main-route-table-association]: /docs/providers/aws/r/main_route_table_association.html - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/default_security_group.html.markdown b/website/docs/cdktf/typescript/r/default_security_group.html.markdown index 1156a76f0448..890ba98127e2 100644 --- a/website/docs/cdktf/typescript/r/default_security_group.html.markdown +++ b/website/docs/cdktf/typescript/r/default_security_group.html.markdown @@ -108,6 +108,7 @@ Removing this resource from your configuration will remove it from your statefil The following arguments are optional: +* `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). * `egress` - (Optional, VPC only) Configuration block. Detailed below. * `ingress` - (Optional) Configuration block. Detailed below. * `tags` - (Optional) Map of tags to assign to the resource. If configured with a provider [`defaultTags` 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. @@ -174,4 +175,4 @@ Using `terraform import`, import Security Groups using the security group `id`. % terraform import aws_default_security_group.default_sg sg-903004f8 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/detective_graph.html.markdown b/website/docs/cdktf/typescript/r/detective_graph.html.markdown index d66569864322..b3af2d8595a1 100644 --- a/website/docs/cdktf/typescript/r/detective_graph.html.markdown +++ b/website/docs/cdktf/typescript/r/detective_graph.html.markdown @@ -40,6 +40,7 @@ class MyConvertedCode extends TerraformStack { The following arguments are optional: +* `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). * `tags` - (Optional) A map of tags to assign to the instance. If configured with a provider [`defaultTags` 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. ## Attribute Reference @@ -81,4 +82,4 @@ Using `terraform import`, import `aws_detective_graph` using the ARN. For exampl % terraform import aws_detective_graph.example arn:aws:detective:us-east-1:123456789101:graph:231684d34gh74g4bae1dbc7bd807d02d ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/detective_invitation_accepter.html.markdown b/website/docs/cdktf/typescript/r/detective_invitation_accepter.html.markdown index 6eb2c5cafe16..f7638399d1b1 100644 --- a/website/docs/cdktf/typescript/r/detective_invitation_accepter.html.markdown +++ b/website/docs/cdktf/typescript/r/detective_invitation_accepter.html.markdown @@ -51,6 +51,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `graphArn` - (Required) ARN of the behavior graph that the member account is accepting the invitation for. ## Attribute Reference @@ -91,4 +92,4 @@ Using `terraform import`, import `aws_detective_invitation_accepter` using the g % terraform import aws_detective_invitation_accepter.example arn:aws:detective:us-east-1:123456789101:graph:231684d34gh74g4bae1dbc7bd807d02d ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/detective_member.html.markdown b/website/docs/cdktf/typescript/r/detective_member.html.markdown index 0f35be2add69..7e5bec8c5d85 100644 --- a/website/docs/cdktf/typescript/r/detective_member.html.markdown +++ b/website/docs/cdktf/typescript/r/detective_member.html.markdown @@ -46,6 +46,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `accountId` - (Required) AWS account ID for the account. * `emailAddress` - (Required) Email address for the account. * `graphArn` - (Required) ARN of the behavior graph to invite the member accounts to contribute their data to. @@ -95,4 +96,4 @@ Using `terraform import`, import `aws_detective_member` using the ARN of the gra % terraform import aws_detective_member.example arn:aws:detective:us-east-1:123456789101:graph:231684d34gh74g4bae1dbc7bd807d02d/123456789012 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/detective_organization_admin_account.html.markdown b/website/docs/cdktf/typescript/r/detective_organization_admin_account.html.markdown index 3c896c132eed..f2268351a842 100644 --- a/website/docs/cdktf/typescript/r/detective_organization_admin_account.html.markdown +++ b/website/docs/cdktf/typescript/r/detective_organization_admin_account.html.markdown @@ -47,6 +47,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `accountId` - (Required) AWS account identifier to designate as a delegated administrator for Detective. ## Attribute Reference @@ -74,4 +75,4 @@ Using `terraform import`, import `aws_detective_organization_admin_account` usin % terraform import aws_detective_organization_admin_account.example 123456789012 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/detective_organization_configuration.html.markdown b/website/docs/cdktf/typescript/r/detective_organization_configuration.html.markdown index 75d41c7eb803..576417ac5f46 100644 --- a/website/docs/cdktf/typescript/r/detective_organization_configuration.html.markdown +++ b/website/docs/cdktf/typescript/r/detective_organization_configuration.html.markdown @@ -48,6 +48,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `autoEnable` - (Required) When this setting is enabled, all new accounts that are created in, or added to, the organization are added as a member accounts of the organization’s Detective delegated administrator and Detective is enabled in that AWS Region. * `graphArn` - (Required) ARN of the behavior graph. @@ -89,4 +90,4 @@ Using `terraform import`, import `aws_detective_organization_admin_account` usin % terraform import aws_detective_organization_configuration.example arn:aws:detective:us-east-1:123456789012:graph:00b00fd5aecc0ab60a708659477e9617 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/devicefarm_device_pool.html.markdown b/website/docs/cdktf/typescript/r/devicefarm_device_pool.html.markdown index c9404602dfdb..88a4ccdef5f4 100644 --- a/website/docs/cdktf/typescript/r/devicefarm_device_pool.html.markdown +++ b/website/docs/cdktf/typescript/r/devicefarm_device_pool.html.markdown @@ -46,6 +46,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) The name of the Device Pool * `projectArn` - (Required) The ARN of the project for the device pool. * `rule` - (Required) The device pool's rules. See [Rule](#rule). @@ -98,4 +99,4 @@ Using `terraform import`, import DeviceFarm Device Pools using their ARN. For ex % terraform import aws_devicefarm_device_pool.example arn:aws:devicefarm:us-west-2:123456789012:devicepool:4fa784c7-ccb4-4dbf-ba4f-02198320daa1/4fa784c7-ccb4-4dbf-ba4f-02198320daa1 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/devicefarm_instance_profile.html.markdown b/website/docs/cdktf/typescript/r/devicefarm_instance_profile.html.markdown index 5318a911fe72..50fc2652b627 100644 --- a/website/docs/cdktf/typescript/r/devicefarm_instance_profile.html.markdown +++ b/website/docs/cdktf/typescript/r/devicefarm_instance_profile.html.markdown @@ -40,6 +40,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `description` - (Optional) The description of the instance profile. * `excludeAppPackagesFromCleanup` - (Optional) An array of strings that specifies the list of app packages that should not be cleaned up from the device after a test run. * `name` - (Required) The name for the instance profile. @@ -86,4 +87,4 @@ Using `terraform import`, import DeviceFarm Instance Profiles using their ARN. F % terraform import aws_devicefarm_instance_profile.example arn:aws:devicefarm:us-west-2:123456789012:instanceprofile:4fa784c7-ccb4-4dbf-ba4f-02198320daa1 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/devicefarm_network_profile.html.markdown b/website/docs/cdktf/typescript/r/devicefarm_network_profile.html.markdown index 6e19ea23e778..1265e644c81d 100644 --- a/website/docs/cdktf/typescript/r/devicefarm_network_profile.html.markdown +++ b/website/docs/cdktf/typescript/r/devicefarm_network_profile.html.markdown @@ -51,6 +51,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `description` - (Optional) The description of the network profile. * `downlinkBandwidthBits` - (Optional) The data throughput rate in bits per second, as an integer from `0` to `104857600`. Default value is `104857600`. * `downlinkDelayMs` - (Optional) Delay time for all packets to destination in milliseconds as an integer from `0` to `2000`. @@ -104,4 +105,4 @@ Using `terraform import`, import DeviceFarm Network Profiles using their ARN. Fo % terraform import aws_devicefarm_network_profile.example arn:aws:devicefarm:us-west-2:123456789012:networkprofile:4fa784c7-ccb4-4dbf-ba4f-02198320daa1 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/devicefarm_project.html.markdown b/website/docs/cdktf/typescript/r/devicefarm_project.html.markdown index 222e50210924..98802a35bcf2 100644 --- a/website/docs/cdktf/typescript/r/devicefarm_project.html.markdown +++ b/website/docs/cdktf/typescript/r/devicefarm_project.html.markdown @@ -43,6 +43,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) The name of the project * `defaultJobTimeoutMinutes` - (Optional) Sets the execution timeout value (in minutes) for a project. All test runs in this project use the specified execution timeout value unless overridden when scheduling a run. * `tags` - (Optional) A map of tags to assign to the resource. If configured with a provider [`defaultTags` 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. @@ -88,4 +89,4 @@ Using `terraform import`, import DeviceFarm Projects using their ARN. For exampl % terraform import aws_devicefarm_project.example arn:aws:devicefarm:us-west-2:123456789012:project:4fa784c7-ccb4-4dbf-ba4f-02198320daa1 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/devicefarm_test_grid_project.html.markdown b/website/docs/cdktf/typescript/r/devicefarm_test_grid_project.html.markdown index 5b0e959e94fe..cb24bc92ad30 100644 --- a/website/docs/cdktf/typescript/r/devicefarm_test_grid_project.html.markdown +++ b/website/docs/cdktf/typescript/r/devicefarm_test_grid_project.html.markdown @@ -47,6 +47,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) The name of the Selenium testing project. * `description` - (Optional) Human-readable description of the project. * `vpcConfig` - (Required) The VPC security groups and subnets that are attached to a project. See [VPC Config](#vpc-config) below. @@ -97,4 +98,4 @@ Using `terraform import`, import DeviceFarm Test Grid Projects using their ARN. % terraform import aws_devicefarm_test_grid_project.example arn:aws:devicefarm:us-west-2:123456789012:testgrid-project:4fa784c7-ccb4-4dbf-ba4f-02198320daa1 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/devicefarm_upload.html.markdown b/website/docs/cdktf/typescript/r/devicefarm_upload.html.markdown index 55235a4ceecd..fe7d0fc3b632 100644 --- a/website/docs/cdktf/typescript/r/devicefarm_upload.html.markdown +++ b/website/docs/cdktf/typescript/r/devicefarm_upload.html.markdown @@ -48,6 +48,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `contentType` - (Optional) The upload's content type (for example, application/octet-stream). * `name` - (Required) The upload's file name. The name should not contain any forward slashes (/). If you are uploading an iOS app, the file name must end with the .ipa extension. If you are uploading an Android app, the file name must end with the .apk extension. For all others, the file name must end with the .zip file extension. * `projectArn` - (Required) The ARN of the project for the upload. @@ -94,4 +95,4 @@ Using `terraform import`, import DeviceFarm Uploads using their ARN. For example % terraform import aws_devicefarm_upload.example arn:aws:devicefarm:us-west-2:123456789012:upload:4fa784c7-ccb4-4dbf-ba4f-02198320daa1 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/devopsguru_event_sources_config.html.markdown b/website/docs/cdktf/typescript/r/devopsguru_event_sources_config.html.markdown index 60876ed4b4e5..c02d9539fee6 100644 --- a/website/docs/cdktf/typescript/r/devopsguru_event_sources_config.html.markdown +++ b/website/docs/cdktf/typescript/r/devopsguru_event_sources_config.html.markdown @@ -49,8 +49,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `eventSources` - (Required) Configuration information about the integration of DevOps Guru as the Consumer via EventBridge with another AWS Service. See [`eventSources`](#event_sources-argument-reference) below. ### `eventSources` Argument Reference @@ -69,7 +70,7 @@ This resource exports the following attributes in addition to the arguments abov ## Import -In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import DevOps Guru Event Sources Config using the `id`. For example: +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import DevOps Guru Event Sources Config using the region. For example: ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -93,10 +94,10 @@ class MyConvertedCode extends TerraformStack { ``` -Using `terraform import`, import DevOps Guru Event Sources Config using the `id`. For example: +Using `terraform import`, import DevOps Guru Event Sources Config using the region. For example: ```console % terraform import aws_devopsguru_event_sources_config.example us-east-1 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/devopsguru_notification_channel.html.markdown b/website/docs/cdktf/typescript/r/devopsguru_notification_channel.html.markdown index 1209464d84a3..9c509514c5d6 100644 --- a/website/docs/cdktf/typescript/r/devopsguru_notification_channel.html.markdown +++ b/website/docs/cdktf/typescript/r/devopsguru_notification_channel.html.markdown @@ -79,6 +79,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `filters` - (Optional) Filter configurations for the Amazon SNS notification topic. See the [`filters` argument reference](#filters-argument-reference) below. ### `sns` Argument Reference @@ -128,4 +129,4 @@ Using `terraform import`, import DevOps Guru Notification Channel using the `id` % terraform import aws_devopsguru_notification_channel.example id-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/devopsguru_resource_collection.html.markdown b/website/docs/cdktf/typescript/r/devopsguru_resource_collection.html.markdown index 1457d9c37084..e0fa8234a08b 100644 --- a/website/docs/cdktf/typescript/r/devopsguru_resource_collection.html.markdown +++ b/website/docs/cdktf/typescript/r/devopsguru_resource_collection.html.markdown @@ -135,6 +135,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `cloudformation` - (Optional) A collection of AWS CloudFormation stacks. See [`cloudformation`](#cloudformation-argument-reference) below for additional details. * `tags` - (Optional) AWS tags used to filter the resources in the resource collection. See [`tags`](#tags-argument-reference) below for additional details. @@ -185,4 +186,4 @@ Using `terraform import`, import DevOps Guru Resource Collection using the `id`. % terraform import aws_devopsguru_resource_collection.example AWS_CLOUD_FORMATION ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/devopsguru_service_integration.html.markdown b/website/docs/cdktf/typescript/r/devopsguru_service_integration.html.markdown index 9f9d091f2169..59ee01e3934b 100644 --- a/website/docs/cdktf/typescript/r/devopsguru_service_integration.html.markdown +++ b/website/docs/cdktf/typescript/r/devopsguru_service_integration.html.markdown @@ -96,8 +96,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `kmsServerSideEncryption` - (Required) Information about whether DevOps Guru is configured to encrypt server-side data using KMS. See [`kmsServerSideEncryption`](#kms_server_side_encryption-argument-reference) below. * `logsAnomalyDetection` - (Required) Information about whether DevOps Guru is configured to perform log anomaly detection on Amazon CloudWatch log groups. See [`logsAnomalyDetection`](#logs_anomaly_detection-argument-reference) below. * `opsCenter` - (Required) Information about whether DevOps Guru is configured to create an OpsItem in AWS Systems Manager OpsCenter for each created insight. See [`opsCenter`](#ops_center-argument-reference) below. @@ -124,7 +125,7 @@ This resource exports the following attributes in addition to the arguments abov ## Import -In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import DevOps Guru Service Integration using the `id`. For example: +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import DevOps Guru Service Integration using the region. For example: ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -148,10 +149,10 @@ class MyConvertedCode extends TerraformStack { ``` -Using `terraform import`, import DevOps Guru Service Integration using the `id`. For example: +Using `terraform import`, import DevOps Guru Service Integration using the region. For example: ```console % terraform import aws_devopsguru_service_integration.example us-east-1 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/directory_service_conditional_forwarder.html.markdown b/website/docs/cdktf/typescript/r/directory_service_conditional_forwarder.html.markdown index d84b4c525137..4e37eeb88aac 100644 --- a/website/docs/cdktf/typescript/r/directory_service_conditional_forwarder.html.markdown +++ b/website/docs/cdktf/typescript/r/directory_service_conditional_forwarder.html.markdown @@ -40,6 +40,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `directoryId` - (Required) ID of directory. * `dnsIps` - (Required) A list of forwarder IP addresses. * `remoteDomainName` - (Required) The fully qualified domain name of the remote domain for which forwarders will be used. @@ -80,4 +81,4 @@ Using `terraform import`, import conditional forwarders using the directory id a % terraform import aws_directory_service_conditional_forwarder.example d-1234567890:example.com ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/directory_service_directory.html.markdown b/website/docs/cdktf/typescript/r/directory_service_directory.html.markdown index d26c5bca9733..08fba50e0106 100644 --- a/website/docs/cdktf/typescript/r/directory_service_directory.html.markdown +++ b/website/docs/cdktf/typescript/r/directory_service_directory.html.markdown @@ -172,6 +172,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) The fully qualified name for the directory, such as `corp.example.com` * `password` - (Required) The password for the directory administrator or connector user. * `size` - (Optional) (For `SimpleAD` and `ADConnector` types) The size of the directory (`Small` or `Large` are accepted values). `Large` by default. @@ -252,4 +253,4 @@ Using `terraform import`, import DirectoryService directories using the director % terraform import aws_directory_service_directory.sample d-926724cf57 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/directory_service_log_subscription.html.markdown b/website/docs/cdktf/typescript/r/directory_service_log_subscription.html.markdown index 8b941c530094..26342ca8d577 100644 --- a/website/docs/cdktf/typescript/r/directory_service_log_subscription.html.markdown +++ b/website/docs/cdktf/typescript/r/directory_service_log_subscription.html.markdown @@ -76,6 +76,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `directoryId` - (Required) ID of directory. * `logGroupName` - (Required) Name of the cloudwatch log group to which the logs should be published. The log group should be already created and the directory service principal should be provided with required permission to create stream and publish logs. Changing this value would delete the current subscription and create a new one. A directory can only have one log subscription at a time. @@ -115,4 +116,4 @@ Using `terraform import`, import Directory Service Log Subscriptions using the d % terraform import aws_directory_service_log_subscription.msad d-1234567890 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/directory_service_radius_settings.html.markdown b/website/docs/cdktf/typescript/r/directory_service_radius_settings.html.markdown index 93f58f796563..aeb9938ae51e 100644 --- a/website/docs/cdktf/typescript/r/directory_service_radius_settings.html.markdown +++ b/website/docs/cdktf/typescript/r/directory_service_radius_settings.html.markdown @@ -45,6 +45,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `authenticationProtocol` - (Optional) The protocol specified for your RADIUS endpoints. Valid values: `PAP`, `CHAP`, `MS-CHAPv1`, `MS-CHAPv2`. * `directoryId` - (Required) The identifier of the directory for which you want to manager RADIUS settings. * `displayLabel` - (Required) Display label. @@ -100,4 +101,4 @@ Using `terraform import`, import RADIUS settings using the directory ID. For exa % terraform import aws_directory_service_radius_settings.example d-926724cf57 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/directory_service_region.html.markdown b/website/docs/cdktf/typescript/r/directory_service_region.html.markdown index 9f2a74b346ed..50368470cc37 100644 --- a/website/docs/cdktf/typescript/r/directory_service_region.html.markdown +++ b/website/docs/cdktf/typescript/r/directory_service_region.html.markdown @@ -171,6 +171,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `desiredNumberOfDomainControllers` - (Optional) The number of domain controllers desired in the replicated directory. Minimum value of `2`. * `directoryId` - (Required) The identifier of the directory to which you want to add Region replication. * `regionName` - (Required) The name of the Region where you want to add domain controllers for replication. @@ -228,4 +229,4 @@ Using `terraform import`, import Replicated Regions using directory ID,Region na % terraform import aws_directory_service_region.example d-9267651497,us-east-2 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/directory_service_shared_directory.html.markdown b/website/docs/cdktf/typescript/r/directory_service_shared_directory.html.markdown index 2d09caf26716..ffab2d42c8e4 100644 --- a/website/docs/cdktf/typescript/r/directory_service_shared_directory.html.markdown +++ b/website/docs/cdktf/typescript/r/directory_service_shared_directory.html.markdown @@ -61,6 +61,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `method` - (Optional) Method used when sharing a directory. Valid values are `ORGANIZATIONS` and `HANDSHAKE`. Default is `HANDSHAKE`. * `notes` - (Optional, Sensitive) Message sent by the directory owner to the directory consumer to help the directory consumer administrator determine whether to approve or reject the share invitation. @@ -114,4 +115,4 @@ Using `terraform import`, import Directory Service Shared Directories using the % terraform import aws_directory_service_shared_directory.example d-1234567890/d-9267633ece ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/directory_service_shared_directory_accepter.html.markdown b/website/docs/cdktf/typescript/r/directory_service_shared_directory_accepter.html.markdown index 495dc5c72cbe..00058287b1f6 100644 --- a/website/docs/cdktf/typescript/r/directory_service_shared_directory_accepter.html.markdown +++ b/website/docs/cdktf/typescript/r/directory_service_shared_directory_accepter.html.markdown @@ -52,8 +52,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `sharedDirectoryId` - (Required) Identifier of the directory that is stored in the directory consumer account that corresponds to the shared directory in the owner account. ## Attribute Reference @@ -105,4 +106,4 @@ Using `terraform import`, import Directory Service Shared Directories using the % terraform import aws_directory_service_shared_directory_accepter.example d-9267633ece ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/directory_service_trust.html.markdown b/website/docs/cdktf/typescript/r/directory_service_trust.html.markdown index d92645e9f885..9bad123746f4 100644 --- a/website/docs/cdktf/typescript/r/directory_service_trust.html.markdown +++ b/website/docs/cdktf/typescript/r/directory_service_trust.html.markdown @@ -144,6 +144,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `conditionalForwarderIpAddrs` - (Optional) Set of IPv4 addresses for the DNS server associated with the remote Directory. Can contain between 1 and 4 values. * `deleteAssociatedConditionalForwarder` - (Optional) Whether to delete the conditional forwarder when deleting the Trust relationship. @@ -206,4 +207,4 @@ Using `terraform import`, import the Trust relationship using the directory ID a % terraform import aws_directory_service_trust.example d-926724cf57/directory.example.com ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/dlm_lifecycle_policy.html.markdown b/website/docs/cdktf/typescript/r/dlm_lifecycle_policy.html.markdown index 57e49da60832..4a4ff8e87db9 100644 --- a/website/docs/cdktf/typescript/r/dlm_lifecycle_policy.html.markdown +++ b/website/docs/cdktf/typescript/r/dlm_lifecycle_policy.html.markdown @@ -114,6 +114,42 @@ class MyConvertedCode extends TerraformStack { ``` +### Example Default Policy + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { Token, TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { DlmLifecyclePolicy } from "./.gen/providers/aws/dlm-lifecycle-policy"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + new DlmLifecyclePolicy(this, "example", { + defaultPolicy: "VOLUME", + description: "tf-acc-basic", + executionRoleArn: Token.asString(awsIamRoleExample.arn), + policyDetails: { + createInterval: 5, + exclusions: { + excludeBootVolumes: false, + excludeTags: { + test: "exclude", + }, + excludeVolumeTypes: ["gp2"], + }, + policyLanguage: "SIMPLIFIED", + resourceType: "VOLUME", + }, + }); + } +} + +``` + ### Example Cross-Region Snapshot Copy Usage ```typescript @@ -273,12 +309,74 @@ class MyConvertedCode extends TerraformStack { ``` +### Example Post/Pre Scripts + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { Token, TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { DataAwsIamPolicy } from "./.gen/providers/aws/data-aws-iam-policy"; +import { DlmLifecyclePolicy } from "./.gen/providers/aws/dlm-lifecycle-policy"; +import { IamRolePolicyAttachment } from "./.gen/providers/aws/iam-role-policy-attachment"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + new DlmLifecyclePolicy(this, "example", { + description: "tf-acc-basic", + executionRoleArn: Token.asString(awsIamRoleExample.arn), + policyDetails: { + resourceTypes: ["INSTANCE"], + schedule: [ + { + createRule: { + interval: 12, + scripts: { + executeOperationOnScriptFailure: false, + executionHandler: "AWS_VSS_BACKUP", + maximumRetryCount: 2, + }, + }, + name: "Windows VSS", + retainRule: { + count: 10, + }, + }, + ], + targetTags: { + tag1: "Windows", + }, + }, + }); + const awsIamRolePolicyAttachmentExample = new IamRolePolicyAttachment( + this, + "example_1", + { + policyArn: Token.asString(dataAwsIamPolicyExample.arn), + role: test.id, + } + ); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + awsIamRolePolicyAttachmentExample.overrideLogicalId("example"); + new DataAwsIamPolicy(this, "test", { + name: "AWSDataLifecycleManagerSSMFullAccess", + }); + } +} + +``` + ## Argument Reference This resource supports the following arguments: +* `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). * `description` - (Required) A description for the DLM lifecycle policy. * `executionRoleArn` - (Required) The ARN of an IAM role that is able to be assumed by the DLM service. +* `defaultPolicy` - (Required) Specify the type of default policy to create. valid values are `VOLUME` or `INSTANCE`. * `policyDetails` - (Required) See the [`policyDetails` configuration](#policy-details-arguments) block. Max of 1. * `state` - (Optional) Whether the lifecycle policy should be enabled or disabled. `ENABLED` or `DISABLED` are valid values. Defaults to `ENABLED`. * `tags` - (Optional) Key-value map of resource tags. If configured with a provider [`defaultTags` 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. @@ -286,13 +384,20 @@ This resource supports the following arguments: #### Policy Details arguments * `action` - (Optional) The actions to be performed when the event-based policy is triggered. You can specify only one action per policy. This parameter is required for event-based policies only. If you are creating a snapshot or AMI policy, omit this parameter. See the [`action` configuration](#action-arguments) block. +* `copyTags` - (Optional, Default policies only) Indicates whether the policy should copy tags from the source resource to the snapshot or AMI. Default value is `false`. +* `createInterval` - (Optional, Default policies only) How often the policy should run and create snapshots or AMIs. valid values range from `1` to `7`. Default value is `1`. +* `exclusions` - (Optional, Default policies only) Specifies exclusion parameters for volumes or instances for which you do not want to create snapshots or AMIs. See the [`exclusions` configuration](#exclusions-arguments) block. +* `extendDeletion` - (Optional, Default policies only) snapshot or AMI retention behavior for the policy if the source volume or instance is deleted, or if the policy enters the error, disabled, or deleted state. Default value is `false`. +* `retainInterval` - (Optional, Default policies only) Specifies how long the policy should retain snapshots or AMIs before deleting them. valid values range from `2` to `14`. Default value is `7`. * `eventSource` - (Optional) The event that triggers the event-based policy. This parameter is required for event-based policies only. If you are creating a snapshot or AMI policy, omit this parameter. See the [`eventSource` configuration](#event-source-arguments) block. +* `resourceType` - (Optional, Default policies only) Type of default policy to create. Valid values are `VOLUME` and `INSTANCE`. * `resourceTypes` - (Optional) A list of resource types that should be targeted by the lifecycle policy. Valid values are `VOLUME` and `INSTANCE`. -* `resourceLocations` - (Optional) The location of the resources to backup. If the source resources are located in an AWS Region, specify `CLOUD`. If the source resources are located on an Outpost in your account, specify `OUTPOST`. If you specify `OUTPOST`, Amazon Data Lifecycle Manager backs up all resources of the specified type with matching target tags across all of the Outposts in your account. Valid values are `CLOUD` and `OUTPOST`. +* `resourceLocations` - (Optional) The location of the resources to backup. If the source resources are located in an AWS Region, specify `CLOUD`. If the source resources are located on an Outpost in your account, specify `OUTPOST`. If the source resources are located in a Local Zone, specify `LOCAL_ZONE`. Valid values are `CLOUD`, `LOCAL_ZONE`, and `OUTPOST`. +* `policyLanguage` - (Optional) Type of policy to create. `SIMPLIFIED` To create a default policy. `STANDARD` To create a custom policy. * `policyType` - (Optional) The valid target resource types and actions a policy can manage. Specify `EBS_SNAPSHOT_MANAGEMENT` to create a lifecycle policy that manages the lifecycle of Amazon EBS snapshots. Specify `IMAGE_MANAGEMENT` to create a lifecycle policy that manages the lifecycle of EBS-backed AMIs. Specify `EVENT_BASED_POLICY` to create an event-based policy that performs specific actions when a defined event occurs in your AWS account. Default value is `EBS_SNAPSHOT_MANAGEMENT`. * `parameters` - (Optional) A set of optional parameters for snapshot and AMI lifecycle policies. See the [`parameters` configuration](#parameters-arguments) block. * `schedule` - (Optional) See the [`schedule` configuration](#schedule-arguments) block. -* `targetTags` (Optional) A map of tag keys and their values. Any resources that match the `resourceTypes` and are tagged with _any_ of these tags will be targeted. +* `targetTags` (Optional) A map of tag keys and their values. Any resources that match the `resourceTypes` and are tagged with _any_ of these tags will be targeted. Required when `policyType` is `EBS_SNAPSHOT_MANAGEMENT` or `IMAGE_MANAGEMENT`. Must not be specified when `policyType` is `EVENT_BASED_POLICY`. ~> Note: You cannot have overlapping lifecycle policies that share the same `targetTags`. Terraform is unable to detect this at plan time but it will fail during apply. @@ -323,6 +428,12 @@ This resource supports the following arguments: * `eventType` - (Required) The type of event. Currently, only `shareSnapshot` events are supported. * `snapshotOwner` - (Required) The IDs of the AWS accounts that can trigger policy by sharing snapshots with your account. The policy only runs if one of the specified AWS accounts shares a snapshot with your account. +#### Exclusions arguments + +* `excludeBootVolumes` - (Optional) Indicates whether to exclude volumes that are attached to instances as the boot volume. To exclude boot volumes, specify `true`. +* `excludeTags` - (Optional) Map specifies whether to exclude volumes that have specific tags. +* `excludeVolumeTypes` - (Optional) List specifies the volume types to exclude. + #### Parameters arguments * `excludeBootVolume` - (Optional) Indicates whether to exclude the root volume from snapshots created using CreateSnapshots. The default is `false`. @@ -330,6 +441,7 @@ This resource supports the following arguments: #### Schedule arguments +* `archiveRule` - (Optional) Specifies a snapshot archiving rule for a schedule. See [`archiveRule`](#archive-rule-arguments) block. * `copyTags` - (Optional) Copy all user-defined tags on a source volume to snapshots of the volume created by this policy. * `createRule` - (Required) See the [`createRule`](#create-rule-arguments) block. Max of 1 per schedule. * `crossRegionCopyRule` (Optional) - See the [`crossRegionCopyRule`](#cross-region-copy-rule-arguments) block. Max of 3 per schedule. @@ -341,12 +453,21 @@ This resource supports the following arguments: * `tagsToAdd` - (Optional) A map of tag keys and their values. DLM lifecycle policies will already tag the snapshot with the tags on the volume. This configuration adds extra tags on top of these. * `variableTags` - (Optional) A map of tag keys and variable values, where the values are determined when the policy is executed. Only `$(instance-id)` or `$(timestamp)` are valid values. Can only be used when `resourceTypes` is `INSTANCE`. +#### Archive Rule Arguments + +* `archiveRetainRule` - (Required) Information about the retention period for the snapshot archiving rule. See the [`archiveRetainRule`](#archive-retain-rule-arguments) block. + +#### Archive Retain Rule Arguments + +* `retentionArchiveTier` - (Required) Information about retention period in the Amazon EBS Snapshots Archive. See the [`retentionArchiveTier`](#retention-archive-tier-arguments) block. + #### Create Rule arguments * `cronExpression` - (Optional) The schedule, as a Cron expression. The schedule interval must be between 1 hour and 1 year. Conflicts with `interval`, `intervalUnit`, and `times`. * `interval` - (Optional) How often this lifecycle policy should be evaluated. `1`, `2`,`3`,`4`,`6`,`8`,`12` or `24` are valid values. Conflicts with `cronExpression`. If set, `intervalUnit` and `times` must also be set. * `intervalUnit` - (Optional) The unit for how often the lifecycle policy should be evaluated. `HOURS` is currently the only allowed value and also the default value. Conflicts with `cronExpression`. Must be set if `interval` is set. * `location` - (Optional) Specifies the destination for snapshots created by the policy. To create snapshots in the same Region as the source resource, specify `CLOUD`. To create snapshots on the same Outpost as the source resource, specify `OUTPOST_LOCAL`. If you omit this parameter, `CLOUD` is used by default. If the policy targets resources in an AWS Region, then you must create snapshots in the same Region as the source resource. If the policy targets resources on an Outpost, then you can create snapshots on the same Outpost as the source resource, or in the Region of that Outpost. Valid values are `CLOUD` and `OUTPOST_LOCAL`. +* `scripts` - (Optional) Specifies pre and/or post scripts for a snapshot lifecycle policy that targets instances. Valid only when `resourceType` is INSTANCE. See the [`scripts` configuration](#scripts-rule-arguments) block. * `times` - (Optional) A list of times in 24 hour clock format that sets when the lifecycle policy should be evaluated. Max of 1. Conflicts with `cronExpression`. Must be set if `interval` is set. #### Deprecate Rule arguments @@ -381,7 +502,8 @@ This resource supports the following arguments: * `deprecateRule` - (Optional) The AMI deprecation rule for cross-Region AMI copies created by the rule. See the [`deprecateRule`](#cross-region-copy-rule-deprecate-rule-arguments) block. * `encrypted` - (Required) To encrypt a copy of an unencrypted snapshot if encryption by default is not enabled, enable encryption using this parameter. Copies of encrypted snapshots are encrypted, even if this parameter is false or if encryption by default is not enabled. * `retainRule` - (Required) The retention rule that indicates how long snapshot copies are to be retained in the destination Region. See the [`retainRule`](#cross-region-copy-rule-retain-rule-arguments) block. Max of 1 per schedule. -* `target` - (Required) The target Region or the Amazon Resource Name (ARN) of the target Outpost for the snapshot copies. +* `target` - Use only for DLM policies of `policy_type=EBS_SNAPSHOT_MANAGEMENT`. The target Region or the Amazon Resource Name (ARN) of the target Outpost for the snapshot copies. +* `targetRegion` - Use only for DLM policies of `policy_type=IMAGE_MANAGEMENT`. The target Region or the Amazon Resource Name (ARN) of the target Outpost for the snapshot copies. #### Cross Region Copy Rule Deprecate Rule arguments @@ -393,6 +515,26 @@ This resource supports the following arguments: * `interval` - (Required) The amount of time to retain each snapshot. The maximum is 100 years. This is equivalent to 1200 months, 5200 weeks, or 36500 days. * `intervalUnit` - (Required) The unit of time for time-based retention. Valid values: `DAYS`, `WEEKS`, `MONTHS`, or `YEARS`. +#### Scripts Rule arguments + +* `executeOperationOnScriptFailure` - (Optional) Indicates whether Amazon Data Lifecycle Manager should default to crash-consistent snapshots if the pre script fails. The default is `true`. + +* `executionHandler` - (Required) The SSM document that includes the pre and/or post scripts to run. In case automating VSS backups, specify `AWS_VSS_BACKUP`. In case automating application-consistent snapshots for SAP HANA workloads, specify `AWSSystemsManagerSAP-CreateDLMSnapshotForSAPHANA`. If you are using a custom SSM document that you own, specify either the name or ARN of the SSM document. + +* `executionHandlerService` - (Optional) Indicates the service used to execute the pre and/or post scripts. If using custom SSM documents or automating application-consistent snapshots of SAP HANA workloads, specify `AWS_SYSTEMS_MANAGER`. In case automating VSS Backups, omit this parameter. The default is `AWS_SYSTEMS_MANAGER`. + +* `executionTimeout` - (Optional) Specifies a timeout period, in seconds, after which Amazon Data Lifecycle Manager fails the script run attempt if it has not completed. In case automating VSS Backups, omit this parameter. The default is `10`. + +* `maximumRetryCount` - (Optional) Specifies the number of times Amazon Data Lifecycle Manager should retry scripts that fail. Must be an integer between `0` and `3`. The default is `0`. + +* `stages` - (Optional) List to indicate which scripts Amazon Data Lifecycle Manager should run on target instances. Pre scripts run before Amazon Data Lifecycle Manager initiates snapshot creation. Post scripts run after Amazon Data Lifecycle Manager initiates snapshot creation. Valid values: `PRE` and `POST`. The default is `PRE` and `POST` + +#### Retention Archive Tier Arguments + +* `count` - (Optional)The maximum number of snapshots to retain in the archive storage tier for each volume. Must be an integer between `1` and `1000`. Conflicts with `interval` and `intervalUnit`. +* `interval` - (Optional) Specifies the period of time to retain snapshots in the archive tier. After this period expires, the snapshot is permanently deleted. Conflicts with `count`. If set, `intervalUnit` must also be set. +* `intervalUnit` - (Optional) The unit of time for time-based retention. Valid values are `DAYS`, `WEEKS`, `MONTHS`, `YEARS`. Conflicts with `count`. Must be set if `interval` is set. + ## Attribute Reference This resource exports the following attributes in addition to the arguments above: @@ -433,4 +575,4 @@ Using `terraform import`, import DLM lifecycle policies using their policy ID. F % terraform import aws_dlm_lifecycle_policy.example policy-abcdef12345678901 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/dms_certificate.html.markdown b/website/docs/cdktf/typescript/r/dms_certificate.html.markdown index 7792ceb66532..111068818f68 100644 --- a/website/docs/cdktf/typescript/r/dms_certificate.html.markdown +++ b/website/docs/cdktf/typescript/r/dms_certificate.html.markdown @@ -45,10 +45,8 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `certificateId` - (Required) The certificate identifier. - - - Must contain from 1 to 255 alphanumeric characters and hyphens. - * `certificatePem` - (Optional) The contents of the .pem X.509 certificate file for the certificate. Either `certificatePem` or `certificateWallet` must be set. * `certificateWallet` - (Optional) The contents of the Oracle Wallet certificate for use with SSL, provided as a base64-encoded String. Either `certificatePem` or `certificateWallet` must be set. * `tags` - (Optional) A map of tags to assign to the resource. If configured with a provider [`defaultTags` 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. @@ -92,4 +90,4 @@ Using `terraform import`, import certificates using the `certificateId`. For exa % terraform import aws_dms_certificate.test test-dms-certificate-tf ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/dms_endpoint.html.markdown b/website/docs/cdktf/typescript/r/dms_endpoint.html.markdown index 3f3bdc91cf23..daf616c30970 100644 --- a/website/docs/cdktf/typescript/r/dms_endpoint.html.markdown +++ b/website/docs/cdktf/typescript/r/dms_endpoint.html.markdown @@ -14,8 +14,6 @@ Provides a DMS (Data Migration Service) endpoint resource. DMS endpoints can be ~> **Note:** All arguments including the password will be stored in the raw state as plain-text. [Read more about sensitive data in state](https://www.terraform.io/docs/state/sensitive-data.html). -~> **Note:** The `s3Settings` argument is deprecated, may not be maintained, and will be removed in a future version. Use the [`aws_dms_s3_endpoint`](/docs/providers/aws/r/dms_s3_endpoint.html) resource instead. - ## Example Usage ```typescript @@ -56,15 +54,17 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `endpointId` - (Required) Database endpoint identifier. Identifiers must contain from 1 to 255 alphanumeric characters or hyphens, begin with a letter, contain only ASCII letters, digits, and hyphens, not end with a hyphen, and not contain two consecutive hyphens. * `endpointType` - (Required) Type of endpoint. Valid values are `source`, `target`. * `engineName` - (Required) Type of engine for the endpoint. Valid values are `aurora`, `aurora-postgresql`, `aurora-serverless`, `aurora-postgresql-serverless`,`azuredb`, `azure-sql-managed-instance`, `babelfish`, `db2`, `db2-zos`, `docdb`, `dynamodb`, `elasticsearch`, `kafka`, `kinesis`, `mariadb`, `mongodb`, `mysql`, `opensearch`, `oracle`, `postgres`, `redshift`,`redshift-serverless`, `s3`, `sqlserver`, `neptune` ,`sybase`. Please note that some of engine names are available only for `target` endpoint type (e.g. `redshift`). -* `kmsKeyArn` - (Required when `engineName` is `mongodb`, cannot be set when `engineName` is `s3`, optional otherwise) ARN for the KMS key that will be used to encrypt the connection parameters. If you do not specify a value for `kmsKeyArn`, then AWS DMS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS region. To encrypt an S3 target with a KMS Key, use the parameter `s3_settings.server_side_encryption_kms_key_id`. When `engineName` is `redshift`, `kmsKeyArn` is the KMS Key for the Redshift target and the parameter `redshift_settings.server_side_encryption_kms_key_id` encrypts the S3 intermediate storage. +* `kmsKeyArn` - (Required when `engineName` is `mongodb`, optional otherwise) ARN for the KMS key that will be used to encrypt the connection parameters. If you do not specify a value for `kmsKeyArn`, then AWS DMS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS region. When `engineName` is `redshift`, `kmsKeyArn` is the KMS Key for the Redshift target and the parameter `redshift_settings.server_side_encryption_kms_key_id` encrypts the S3 intermediate storage. The following arguments are optional: +* `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). * `certificateArn` - (Optional, Default: empty string) ARN for the certificate. * `databaseName` - (Optional) Name of the endpoint database. * `elasticsearchSettings` - (Optional) Configuration block for OpenSearch settings. See below. @@ -72,12 +72,12 @@ The following arguments are optional: * `kafkaSettings` - (Optional) Configuration block for Kafka settings. See below. * `kinesisSettings` - (Optional) Configuration block for Kinesis settings. See below. * `mongodbSettings` - (Optional) Configuration block for MongoDB settings. See below. +* `oracleSettings` - (Optional) Configuration block for Oracle settings. See below. * `password` - (Optional) Password to be used to login to the endpoint database. * `postgresSettings` - (Optional) Configuration block for Postgres settings. See below. * `pauseReplicationTasks` - (Optional) Whether to pause associated running replication tasks, regardless if they are managed by Terraform, prior to modifying the endpoint. Only tasks paused by the resource will be restarted after the modification completes. Default is `false`. * `port` - (Optional) Port used by the endpoint database. * `redshiftSettings` - (Optional) Configuration block for Redshift settings. See below. -* `s3Settings` - (Optional) (**Deprecated**, use the [`aws_dms_s3_endpoint`](/docs/providers/aws/r/dms_s3_endpoint.html) resource instead) Configuration block for S3 settings. See below. * `secretsManagerAccessRoleArn` - (Optional) ARN of the IAM role that specifies AWS DMS as the trusted entity and has the required permissions to access the value in the Secrets Manager secret referred to by `secretsManagerArn`. The role must allow the `iam:PassRole` action. ~> **Note:** You can specify one of two sets of values for these permissions. You can specify the values for this setting and `secretsManagerArn`. Or you can specify clear-text values for `username`, `password` , `serverName`, and `port`. You can't specify both. @@ -149,11 +149,18 @@ The following arguments are optional: * `extractDocId` - (Optional) Document ID. Use this setting when `nestingLevel` is set to `none`. Default is `false`. * `nestingLevel` - (Optional) Specifies either document or table mode. Default is `none`. Valid values are `one` (table mode) and `none` (document mode). +### oracle_settings + +-> Additional information can be found in the [Using Oracle as a Source for AWS DMS documentation](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html). + +* `authenticationMethod` - (Optional) Authentication mechanism to access the Oracle source endpoint. Default is `password`. Valid values are `password` and `kerberos`. + ### postgres_settings -> Additional information can be found in the [Using PostgreSQL as a Source for AWS DMS documentation](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.PostgreSQL.html). * `afterConnectScript` - (Optional) For use with change data capture (CDC) only, this attribute has AWS DMS bypass foreign keys and user triggers to reduce the time it takes to bulk load data. +* `authenticationMethod` - (Optional) Specifies the authentication method. Valid values: `password`, `iam`. * `babelfishDatabaseName` - (Optional) The Babelfish for Aurora PostgreSQL database name for the endpoint. * `captureDdls` - (Optional) To capture DDL events, AWS DMS creates various artifacts in the PostgreSQL database when the task starts. * `databaseMode` - (Optional) Specifies the default behavior of the replication's handling of PostgreSQL- compatible endpoints that require some additional configuration, such as Babelfish endpoints. @@ -168,6 +175,7 @@ The following arguments are optional: * `mapLongVarcharAs` - Optional When true, DMS migrates LONG values as VARCHAR. * `maxFileSize` - (Optional) Specifies the maximum size (in KB) of any .csv file used to transfer data to PostgreSQL. Default is `32,768 KB`. * `pluginName` - (Optional) Specifies the plugin to use to create a replication slot. Valid values: `pglogical`, `test_decoding`. +* `serviceAccessRoleArn` - (Optional) Specifies the IAM role to use to authenticate the connection. * `slotName` - (Optional) Sets the name of a previously created logical replication slot for a CDC load of the PostgreSQL source instance. ### redis_settings @@ -192,51 +200,6 @@ The following arguments are optional: * `serverSideEncryptionKmsKeyId` - (Required when `encryptionMode` is `SSE_KMS`, must not be set otherwise) ARN or Id of KMS Key to use when `encryptionMode` is `SSE_KMS`. * `serviceAccessRoleArn` - (Optional) Amazon Resource Name (ARN) of the IAM Role with permissions to read from or write to the S3 Bucket for intermediate storage. -### s3_settings - -~> **Deprecated:** This argument is deprecated, may not be maintained, and will be removed in a future version. Use the [`aws_dms_s3_endpoint`](/docs/providers/aws/r/dms_s3_endpoint.html) resource instead. - --> Additional information can be found in the [Using Amazon S3 as a Source for AWS Database Migration Service documentation](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.S3.html) and [Using Amazon S3 as a Target for AWS Database Migration Service documentation](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html). - -* `addColumnName` - (Optional) Whether to add column name information to the .csv output file. Default is `false`. -* `bucketFolder` - (Optional) S3 object prefix. -* `bucketName` - (Optional) S3 bucket name. -* `cannedAclForObjects` - (Optional) Predefined (canned) access control list for objects created in an S3 bucket. Valid values include `none`, `private`, `public-read`, `public-read-write`, `authenticated-read`, `aws-exec-read`, `bucket-owner-read`, and `bucket-owner-full-control`. Default is `none`. -* `cdcInsertsAndUpdates` - (Optional) Whether to write insert and update operations to .csv or .parquet output files. Default is `false`. -* `cdcInsertsOnly` - (Optional) Whether to write insert operations to .csv or .parquet output files. Default is `false`. -* `cdcMaxBatchInterval` - (Optional) Maximum length of the interval, defined in seconds, after which to output a file to Amazon S3. Default is `60`. -* `cdcMinFileSize` - (Optional) Minimum file size condition as defined in kilobytes to output a file to Amazon S3. Default is `32000`. **NOTE:** Previously, this setting was measured in megabytes but now represents kilobytes. Update configurations accordingly. -* `cdcPath` - (Optional) Folder path of CDC files. For an S3 source, this setting is required if a task captures change data; otherwise, it's optional. If `cdcPath` is set, AWS DMS reads CDC files from this path and replicates the data changes to the target endpoint. Supported in AWS DMS versions 3.4.2 and later. -* `compressionType` - (Optional) Set to compress target files. Default is `NONE`. Valid values are `GZIP` and `NONE`. -* `csvDelimiter` - (Optional) Delimiter used to separate columns in the source files. Default is `,`. -* `csvNoSupValue` - (Optional) String to use for all columns not included in the supplemental log. -* `csvNullValue` - (Optional) String to as null when writing to the target. -* `csvRowDelimiter` - (Optional) Delimiter used to separate rows in the source files. Default is `\n`. -* `dataFormat` - (Optional) Output format for the files that AWS DMS uses to create S3 objects. Valid values are `csv` and `parquet`. Default is `csv`. -* `dataPageSize` - (Optional) Size of one data page in bytes. Default is `1048576` (1 MiB). -* `datePartitionDelimiter` - (Optional) Date separating delimiter to use during folder partitioning. Valid values are `SLASH`, `UNDERSCORE`, `DASH`, and `NONE`. Default is `SLASH`. -* `datePartitionEnabled` - (Optional) Partition S3 bucket folders based on transaction commit dates. Default is `false`. -* `datePartitionSequence` - (Optional) Date format to use during folder partitioning. Use this parameter when `datePartitionEnabled` is set to true. Valid values are `YYYYMMDD`, `YYYYMMDDHH`, `YYYYMM`, `MMYYYYDD`, and `DDMMYYYY`. Default is `YYYYMMDD`. -* `dictPageSizeLimit` - (Optional) Maximum size in bytes of an encoded dictionary page of a column. Default is `1048576` (1 MiB). -* `enableStatistics` - (Optional) Whether to enable statistics for Parquet pages and row groups. Default is `true`. -* `encodingType` - (Optional) Type of encoding to use. Value values are `rle_dictionary`, `plain`, and `plain_dictionary`. Default is `rle_dictionary`. -* `encryptionMode` - (Optional) Server-side encryption mode that you want to encrypt your .csv or .parquet object files copied to S3. Valid values are `SSE_S3` and `SSE_KMS`. Default is `SSE_S3`. -* `externalTableDefinition` - (Optional) JSON document that describes how AWS DMS should interpret the data. -* `glueCatalogGeneration` - (Optional) Whether to integrate AWS Glue Data Catalog with an Amazon S3 target. See [Using AWS Glue Data Catalog with an Amazon S3 target for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.GlueCatalog) for more information. Default is `false`. -* `ignoreHeaderRows` - (Optional) When this value is set to `1`, DMS ignores the first row header in a .csv file. Default is `0`. -* `includeOpForFullLoad` - (Optional) Whether to enable a full load to write INSERT operations to the .csv output files only to indicate how the rows were added to the source database. Default is `false`. -* `maxFileSize` - (Optional) Maximum size (in KB) of any .csv file to be created while migrating to an S3 target during full load. Valid values are from `1` to `1048576`. Default is `1048576` (1 GB). -* `parquetTimestampInMillisecond` - (Optional) - Specifies the precision of any TIMESTAMP column values written to an S3 object file in .parquet format. Default is `false`. -* `parquetVersion` - (Optional) Version of the .parquet file format. Default is `parquet-1-0`. Valid values are `parquet-1-0` and `parquet-2-0`. -* `preserveTransactions` - (Optional) Whether DMS saves the transaction order for a CDC load on the S3 target specified by `cdcPath`. Default is `false`. -* `rfc4180` - (Optional) For an S3 source, whether each leading double quotation mark has to be followed by an ending double quotation mark. Default is `true`. -* `rowGroupLength` - (Optional) Number of rows in a row group. Default is `10000`. -* `serverSideEncryptionKmsKeyId` - (Required when `encryptionMode` is `SSE_KMS`, must not be set otherwise) ARN or Id of KMS Key to use when `encryptionMode` is `SSE_KMS`. -* `serviceAccessRoleArn` - (Optional) ARN of the IAM Role with permissions to read from or write to the S3 Bucket. -* `timestampColumnName` - (Optional) Column to add with timestamp information to the endpoint data for an Amazon S3 target. -* `useCsvNoSupValue` - (Optional) Whether to use `csvNoSupValue` for columns not included in the supplemental log. -* `useTaskStartTimeForFullLoadTimestamp` - (Optional) When set to true, uses the task start time as the timestamp column value instead of the time data is written to target. For full load, when set to true, each row of the timestamp column contains the task start time. For CDC loads, each row of the timestamp column contains the transaction commit time. When set to false, the full load timestamp in the timestamp column increments with the time data arrives at the target. Default is `false`. - ## Attribute Reference This resource exports the following attributes in addition to the arguments above: @@ -279,4 +242,4 @@ Using `terraform import`, import endpoints using the `endpointId`. For example: % terraform import aws_dms_endpoint.test test-dms-endpoint-tf ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/dms_event_subscription.html.markdown b/website/docs/cdktf/typescript/r/dms_event_subscription.html.markdown index 05a76f7e7483..c901e5c8ba37 100644 --- a/website/docs/cdktf/typescript/r/dms_event_subscription.html.markdown +++ b/website/docs/cdktf/typescript/r/dms_event_subscription.html.markdown @@ -48,6 +48,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) Name of event subscription. * `enabled` - (Optional, Default: true) Whether the event subscription should be enabled. * `eventCategories` - (Optional) List of event categories to listen for, see `DescribeEventCategories` for a canonical list. @@ -103,4 +104,4 @@ Using `terraform import`, import event subscriptions using the `name`. For examp % terraform import aws_dms_event_subscription.test my-awesome-event-subscription ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/dms_replication_config.html.markdown b/website/docs/cdktf/typescript/r/dms_replication_config.html.markdown index 6dfde317e856..85d53adcf1d7 100644 --- a/website/docs/cdktf/typescript/r/dms_replication_config.html.markdown +++ b/website/docs/cdktf/typescript/r/dms_replication_config.html.markdown @@ -53,6 +53,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `computeConfig` - (Required) Configuration block for provisioning an DMS Serverless replication. * `startReplication` - (Optional) Whether to run or stop the serverless replication, default is false. * `replicationConfigIdentifier` - (Required) Unique identifier that you want to use to create the config. @@ -130,4 +131,4 @@ Using `terraform import`, import a replication config using the `arn`. For examp % terraform import aws_dms_replication_config.example arn:aws:dms:us-east-1:123456789012:replication-config:UX6OL6MHMMJKFFOXE3H7LLJCMEKBDUG4ZV7DRSI ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/dms_replication_instance.html.markdown b/website/docs/cdktf/typescript/r/dms_replication_instance.html.markdown index aaabf46dbdc5..4ef597279158 100644 --- a/website/docs/cdktf/typescript/r/dms_replication_instance.html.markdown +++ b/website/docs/cdktf/typescript/r/dms_replication_instance.html.markdown @@ -126,35 +126,34 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `allocatedStorage` - (Optional, Default: 50, Min: 5, Max: 6144) The amount of storage (in gigabytes) to be initially allocated for the replication instance. * `allowMajorVersionUpgrade` - (Optional, Default: false) Indicates that major version upgrades are allowed. * `applyImmediately` - (Optional, Default: false) Indicates whether the changes should be applied immediately or during the next maintenance window. Only used when updating an existing resource. * `autoMinorVersionUpgrade` - (Optional, Default: false) Indicates that minor engine upgrades will be applied automatically to the replication instance during the maintenance window. * `availabilityZone` - (Optional) The EC2 Availability Zone that the replication instance will be created in. +* `dnsNameServers` - (Optional) A list of custom DNS name servers supported for the replication instance to access your on-premise source or target database. This list overrides the default name servers supported by the replication instance. You can specify a comma-separated list of internet addresses for up to four on-premise DNS name servers. * `engineVersion` - (Optional) The engine version number of the replication instance. +* `kerberosAuthenticationSettings` - (Optional) Configuration block for settings required for Kerberos authentication. See below. * `kmsKeyArn` - (Optional) The Amazon Resource Name (ARN) for the KMS key that will be used to encrypt the connection parameters. If you do not specify a value for `kmsKeyArn`, then AWS DMS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS region. * `multiAz` - (Optional) Specifies if the replication instance is a multi-az deployment. You cannot set the `availabilityZone` parameter if the `multiAz` parameter is set to `true`. * `networkType` - (Optional) The type of IP address protocol used by a replication instance. Valid values: `IPV4`, `DUAL`. * `preferredMaintenanceWindow` - (Optional) The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). - - - Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. - - Format: `ddd:hh24:mi-ddd:hh24:mi` - - Valid Days: `mon, tue, wed, thu, fri, sat, sun` - - Constraints: Minimum 30-minute window. - * `publiclyAccessible` - (Optional, Default: false) Specifies the accessibility options for the replication instance. A value of true represents an instance with a public IP address. A value of false represents an instance with a private IP address. * `replicationInstanceClass` - (Required) The compute and memory capacity of the replication instance as specified by the replication instance class. See [AWS DMS User Guide](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_ReplicationInstance.Types.html) for available instance sizes and advice on which one to choose. * `replicationInstanceId` - (Required) The replication instance identifier. This parameter is stored as a lowercase string. - - - Must contain from 1 to 63 alphanumeric characters or hyphens. - - First character must be a letter. - - Cannot end with a hyphen - - Cannot contain two consecutive hyphens. - * `replicationSubnetGroupId` - (Optional) A subnet group to associate with the replication instance. * `tags` - (Optional) A map of tags to assign to the resource. If configured with a provider [`defaultTags` 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. * `vpcSecurityGroupIds` - (Optional) A list of VPC security group IDs to be used with the replication instance. The VPC security groups must work with the VPC containing the replication instance. +## kerberos_authentication_settings + +-> Additional information can be found in the [Using Kerberos Authentication with AWS Database Migration Service documentation](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.Kerberos.html). + +* `keyCacheSecretIamArn` - (Required) ARN of the IAM role that grants AWS DMS access to the secret containing key cache file for the Kerberos authentication. +* `keyCacheSecretId` - (Required) Secret ID that stores the key cache file required for Kerberos authentication. +* `krb5FileContents` - (Required) Contents of krb5 configuration file required for Kerberos authentication. + ## Attribute Reference This resource exports the following attributes in addition to the arguments above: @@ -204,4 +203,4 @@ Using `terraform import`, import replication instances using the `replicationIns % terraform import aws_dms_replication_instance.test test-dms-replication-instance-tf ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/dms_replication_subnet_group.html.markdown b/website/docs/cdktf/typescript/r/dms_replication_subnet_group.html.markdown index c2f05eeab353..1592827d875e 100644 --- a/website/docs/cdktf/typescript/r/dms_replication_subnet_group.html.markdown +++ b/website/docs/cdktf/typescript/r/dms_replication_subnet_group.html.markdown @@ -108,6 +108,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `replicationSubnetGroupDescription` - (Required) Description for the subnet group. * `replicationSubnetGroupId` - (Required) Name for the replication subnet group. This value is stored as a lowercase string. It must contain no more than 255 alphanumeric characters, periods, spaces, underscores, or hyphens and cannot be `default`. * `subnetIds` - (Required) List of at least 2 EC2 subnet IDs for the subnet group. The subnets must cover at least 2 availability zones. @@ -160,4 +161,4 @@ Using `terraform import`, import replication subnet groups using the `replicatio % terraform import aws_dms_replication_subnet_group.test test-dms-replication-subnet-group-tf ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/dms_replication_task.html.markdown b/website/docs/cdktf/typescript/r/dms_replication_task.html.markdown index 554cf5105bb3..4ccc88ef5b0d 100644 --- a/website/docs/cdktf/typescript/r/dms_replication_task.html.markdown +++ b/website/docs/cdktf/typescript/r/dms_replication_task.html.markdown @@ -52,6 +52,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `cdcStartPosition` - (Optional, Conflicts with `cdcStartTime`) Indicates when you want a change data capture (CDC) operation to start. The value can be a RFC3339 formatted date, a checkpoint, or a LSN/SCN format depending on the source engine. For more information see [Determining a CDC native start point](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Task.CDC.html#CHAP_Task.CDC.StartPoint.Native). * `cdcStartTime` - (Optional, Conflicts with `cdcStartPosition`) RFC3339 formatted date string or UNIX timestamp for the start of the Change Data Capture (CDC) operation. * `migrationType` - (Required) Migration type. Can be one of `full-load | cdc | full-load-and-cdc`. @@ -105,4 +106,4 @@ Using `terraform import`, import replication tasks using the `replicationTaskId` % terraform import aws_dms_replication_task.test test-dms-replication-task-tf ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/dms_s3_endpoint.html.markdown b/website/docs/cdktf/typescript/r/dms_s3_endpoint.html.markdown index 6936f8f5e63f..af750d91e7b1 100644 --- a/website/docs/cdktf/typescript/r/dms_s3_endpoint.html.markdown +++ b/website/docs/cdktf/typescript/r/dms_s3_endpoint.html.markdown @@ -128,6 +128,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `addColumnName` - (Optional) Whether to add column name information to the .csv output file. Default is `false`. * `addTrailingPaddingCharacter` - (Optional) Whether to add padding. Default is `false`. (Ignored for source endpoints.) * `bucketFolder` - (Optional) S3 object prefix. @@ -222,4 +223,4 @@ Using `terraform import`, import endpoints using the `endpointId`. For example: % terraform import aws_dms_s3_endpoint.example example-dms-endpoint-tf ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/docdb_cluster.html.markdown b/website/docs/cdktf/typescript/r/docdb_cluster.html.markdown index 932babf5d024..08c1131f1d47 100644 --- a/website/docs/cdktf/typescript/r/docdb_cluster.html.markdown +++ b/website/docs/cdktf/typescript/r/docdb_cluster.html.markdown @@ -23,7 +23,7 @@ phase because a modification has not yet taken place. You can use the ~> **Note:** All arguments including the username and password will be stored in the raw state as plain-text. [Read more about sensitive data in state](https://www.terraform.io/docs/state/sensitive-data.html). --> **Note:** Write-Only argument `masterPasswordWo` is available to use in place of `masterPassword`. Write-Only arguments are supported in HashiCorp Terraform 1.11.0 and later. [Learn more](https://developer.hashicorp.com/terraform/language/v1.11.x/resources/ephemeral#write-only-arguments). +-> **Note:** Write-Only argument `masterPasswordWo` is available to use in place of `masterPassword`. Write-Only arguments are supported in HashiCorp Terraform 1.11.0 and later. [Learn more](https://developer.hashicorp.com/terraform/language/resources/ephemeral#write-only-arguments). ## Example Usage @@ -57,6 +57,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `allowMajorVersionUpgrade` - (Optional) A value that indicates whether major version upgrades are allowed. Constraints: You must allow major version upgrades when specifying a value for the EngineVersion parameter that is a different major version than the DB cluster's current version. * `applyImmediately` - (Optional) Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is @@ -90,6 +91,7 @@ This resource supports the following arguments: Default: A 30-minute window selected at random from an 8-hour block of time per regionE.g., 04:00-09:00 * `preferredMaintenanceWindow` - (Optional) The weekly time range during which system maintenance can occur, in (UTC) e.g., wed:04:00-wed:04:30 * `restoreToPointInTime` - (Optional, Forces new resource) A configuration block for restoring a DB instance to an arbitrary point in time. Requires the `identifier` argument to be set with the name of the new DB instance to be created. See [Restore To Point In Time](#restore-to-point-in-time) below for details. +* `serverlessV2ScalingConfiguration` - (Optional) Scaling configuration of an Amazon DocumentDB Serverless cluster. See [Serverless V2 Scaling Configuration](#serverless-v2-scaling-configuration) below for details. * `skipFinalSnapshot` - (Optional) Determines whether a final DB snapshot is created before the DB cluster is deleted. If true is specified, no DB snapshot is created. If false is specified, a DB snapshot is created before the DB cluster is deleted, using the value from `finalSnapshotIdentifier`. Default is `false`. * `snapshotIdentifier` - (Optional) Specifies whether or not to create this cluster from a snapshot. You can use either the name or ARN when specifying a DB cluster snapshot, or the ARN when specifying a DB snapshot. Automated snapshots **should not** be used for this attribute, unless from a different cluster. Automated snapshots are deleted as part of cluster destruction when the resource is replaced. * `storageEncrypted` - (Optional) Specifies whether the DB cluster is encrypted. The default is `false`. @@ -110,16 +112,24 @@ The `restoreToPointInTime` block supports the following arguments: * `sourceClusterIdentifier` - (Required) The identifier of the source DB cluster from which to restore. Must match the identifier of an existing DB cluster. * `useLatestRestorableTime` - (Optional) A boolean value that indicates whether the DB cluster is restored from the latest backup time. Defaults to `false`. Cannot be specified with `restoreToTime`. +### Serverless V2 Scaling Configuration + +The `serverlessV2ScalingConfiguration` block supports the following arguments. +Adding this block (i.e. switching to serverless) or removing it (i.e. switching from serverless) will trigger cluster replacement. + +* `maxCapacity` - (Required) Maximum number of Amazon DocumentDB capacity units (DCUs) for an instance in an Amazon DocumentDB Serverless cluster. Valid values are multiples of 0.5 between 1 and 256. +* `minCapacity` - (Required) Minimum number of Amazon DocumentDB capacity units (DCUs) for an instance in an Amazon DocumentDB Serverless cluster. Valid values are multiples of 0.5 between 0.5 and 256. + ## Attribute Reference This resource exports the following attributes in addition to the arguments above: * `arn` - Amazon Resource Name (ARN) of cluster -* `clusterMembers` – List of DocumentDB Instances that are a part of this cluster +* `clusterMembers` - List of DocumentDB Instances that are a part of this cluster * `clusterResourceId` - The DocumentDB Cluster Resource ID * `endpoint` - The DNS address of the DocumentDB instance * `hostedZoneId` - The Route53 Hosted Zone ID of the endpoint -* `id` - The DocumentDB Cluster Identifier +* `id` - (**Deprecated**) Amazon Resource Name (ARN) of cluster * `readerEndpoint` - A read-only endpoint for the DocumentDB cluster, automatically load-balanced across replicas * `tagsAll` - A map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). @@ -164,4 +174,4 @@ Using `terraform import`, import DocumentDB Clusters using the `clusterIdentifie % terraform import aws_docdb_cluster.docdb_cluster docdb-prod-cluster ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/docdb_cluster_instance.html.markdown b/website/docs/cdktf/typescript/r/docdb_cluster_instance.html.markdown index 6d0563bb4d3c..30bcffea3995 100644 --- a/website/docs/cdktf/typescript/r/docdb_cluster_instance.html.markdown +++ b/website/docs/cdktf/typescript/r/docdb_cluster_instance.html.markdown @@ -60,13 +60,14 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `applyImmediately` - (Optional) Specifies whether any database modifications are applied immediately, or during the next maintenance window. Default is`false`. * `autoMinorVersionUpgrade` - (Optional) This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set (see [docs](https://docs.aws.amazon.com/documentdb/latest/developerguide/API_DBInstance.html)). Default `true`. * `availabilityZone` - (Optional, Computed) The EC2 Availability Zone that the DB instance is created in. See [docs](https://docs.aws.amazon.com/documentdb/latest/developerguide/API_CreateDBInstance.html) about the details. * `caCertIdentifier` - (Optional) The identifier of the certificate authority (CA) certificate for the DB instance. * `clusterIdentifier` - (Required) The identifier of the [`aws_docdb_cluster`](/docs/providers/aws/r/docdb_cluster.html) in which to launch this instance. -* `copyTagsToSnapshot` – (Optional, boolean) Copy all DB instance `tags` to snapshots. Default is `false`. +* `copyTagsToSnapshot` - (Optional, boolean) Copy all DB instance `tags` to snapshots. Default is `false`. * `enablePerformanceInsights` - (Optional) A value that indicates whether to enable Performance Insights for the DB Instance. Default `false`. See [docs] (https://docs.aws.amazon.com/documentdb/latest/developerguide/performance-insights.html) about the details. * `engine` - (Optional) The name of the database engine to be used for the DocumentDB instance. Defaults to `docdb`. Valid Values: `docdb`. * `identifier` - (Optional, Forces new resource) The identifier for the DocumentDB instance, if omitted, Terraform will assign a random, unique identifier. @@ -115,7 +116,10 @@ This resource exports the following attributes in addition to the arguments abov * `preferredBackupWindow` - The daily time range during which automated backups are created if automated backups are enabled. * `storageEncrypted` - Specifies whether the DB cluster is encrypted. * `tagsAll` - A map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). -* `writer` – Boolean indicating if this instance is writable. `False` indicates this instance is a read replica. +* `writer` - Boolean indicating if this instance is writable. `False` indicates this instance is a read replica. + +For more detailed documentation about each argument, refer to +the [AWS official documentation](https://docs.aws.amazon.com/cli/latest/reference/docdb/create-db-instance.html). For more detailed documentation about each argument, refer to the [AWS official documentation](https://docs.aws.amazon.com/cli/latest/reference/docdb/create-db-instance.html). @@ -167,4 +171,4 @@ Using `terraform import`, import DocumentDB Cluster Instances using the `identif % terraform import aws_docdb_cluster_instance.prod_instance_1 aurora-cluster-instance-1 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/docdb_cluster_parameter_group.html.markdown b/website/docs/cdktf/typescript/r/docdb_cluster_parameter_group.html.markdown index 35e4c97d7b66..cffe92efffae 100644 --- a/website/docs/cdktf/typescript/r/docdb_cluster_parameter_group.html.markdown +++ b/website/docs/cdktf/typescript/r/docdb_cluster_parameter_group.html.markdown @@ -46,6 +46,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Optional, Forces new resource) The name of the DocumentDB cluster parameter group. If omitted, Terraform will assign a random, unique name. * `namePrefix` - (Optional, Forces new resource) Creates a unique name beginning with the specified prefix. Conflicts with `name`. * `family` - (Required, Forces new resource) The family of the DocumentDB cluster parameter group. @@ -101,4 +102,4 @@ Using `terraform import`, import DocumentDB Cluster Parameter Groups using the ` % terraform import aws_docdb_cluster_parameter_group.cluster_pg production-pg-1 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/docdb_cluster_snapshot.html.markdown b/website/docs/cdktf/typescript/r/docdb_cluster_snapshot.html.markdown index 534553b740fc..8dfdb05576eb 100644 --- a/website/docs/cdktf/typescript/r/docdb_cluster_snapshot.html.markdown +++ b/website/docs/cdktf/typescript/r/docdb_cluster_snapshot.html.markdown @@ -39,6 +39,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `dbClusterIdentifier` - (Required) The DocumentDB Cluster Identifier from which to take the snapshot. * `dbClusterSnapshotIdentifier` - (Required) The Identifier for the snapshot. @@ -52,7 +53,7 @@ This resource exports the following attributes in addition to the arguments abov * `engineVersion` - Version of the database engine for this DocumentDB cluster snapshot. * `kmsKeyId` - If storage_encrypted is true, the AWS KMS key identifier for the encrypted DocumentDB cluster snapshot. * `port` - Port that the DocumentDB cluster was listening on at the time of the snapshot. -* `source_db_cluster_snapshot_identifier` - The DocumentDB Cluster Snapshot Arn that the DocumentDB Cluster Snapshot was copied from. It only has value in case of cross customer or cross region copy. +* `sourceDbClusterSnapshotIdentifier` - The DocumentDB Cluster Snapshot Arn that the DocumentDB Cluster Snapshot was copied from. It only has value in case of cross customer or cross region copy. * `storageEncrypted` - Specifies whether the DocumentDB cluster snapshot is encrypted. * `status` - The status of this DocumentDB Cluster Snapshot. * `vpcId` - The VPC ID associated with the DocumentDB cluster snapshot. @@ -95,4 +96,4 @@ Using `terraform import`, import `aws_docdb_cluster_snapshot` using the cluster % terraform import aws_docdb_cluster_snapshot.example my-cluster-snapshot ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/docdb_event_subscription.html.markdown b/website/docs/cdktf/typescript/r/docdb_event_subscription.html.markdown index 38e068b994b8..464db1558778 100644 --- a/website/docs/cdktf/typescript/r/docdb_event_subscription.html.markdown +++ b/website/docs/cdktf/typescript/r/docdb_event_subscription.html.markdown @@ -67,6 +67,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Optional) The name of the DocumentDB event subscription. By default generated by Terraform. * `namePrefix` - (Optional) The name of the DocumentDB event subscription. Conflicts with `name`. * `snsTopic` - (Required) The SNS topic to send events to. @@ -125,4 +126,4 @@ Using `terraform import`, import DocumentDB Event Subscriptions using the `name` % terraform import aws_docdb_event_subscription.example event-sub ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/docdb_global_cluster.html.markdown b/website/docs/cdktf/typescript/r/docdb_global_cluster.html.markdown index 466ed9f21fd3..033266d2f374 100644 --- a/website/docs/cdktf/typescript/r/docdb_global_cluster.html.markdown +++ b/website/docs/cdktf/typescript/r/docdb_global_cluster.html.markdown @@ -136,6 +136,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `globalClusterIdentifier` - (Required, Forces new resources) The global cluster identifier. * `databaseName` - (Optional, Forces new resources) Name for an automatically created database on cluster creation. * `deletionProtection` - (Optional) If the Global Cluster should have deletion protection enabled. The database can't be deleted when this value is set to `true`. The default is `false`. @@ -220,4 +221,4 @@ class MyConvertedCode extends TerraformStack { ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/docdb_subnet_group.html.markdown b/website/docs/cdktf/typescript/r/docdb_subnet_group.html.markdown index 79e2baebae29..9a0ac195870f 100644 --- a/website/docs/cdktf/typescript/r/docdb_subnet_group.html.markdown +++ b/website/docs/cdktf/typescript/r/docdb_subnet_group.html.markdown @@ -42,6 +42,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Optional, Forces new resource) The name of the docDB subnet group. If omitted, Terraform will assign a random, unique name. * `namePrefix` - (Optional, Forces new resource) Creates a unique name beginning with the specified prefix. Conflicts with `name`. * `description` - (Optional) The description of the docDB subnet group. Defaults to "Managed by Terraform". @@ -88,4 +89,4 @@ Using `terraform import`, import DocumentDB Subnet groups using the `name`. For % terraform import aws_docdb_subnet_group.default production-subnet-group ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/docdbelastic_cluster.html.markdown b/website/docs/cdktf/typescript/r/docdbelastic_cluster.html.markdown index 3145d8593fe7..a71c21303188 100644 --- a/website/docs/cdktf/typescript/r/docdbelastic_cluster.html.markdown +++ b/website/docs/cdktf/typescript/r/docdbelastic_cluster.html.markdown @@ -54,6 +54,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `backupRetentionPeriod` - (Optional) The number of days for which automatic snapshots are retained. It should be in between 1 and 35. If not specified, the default value of 1 is set. * `kmsKeyId` - (Optional) ARN of a KMS key that is used to encrypt the Elastic DocumentDB cluster. If not specified, the default encryption key that KMS creates for your account is used. * `preferredBackupWindow` - (Optional) The daily time range during which automated backups are created if automated backups are enabled, as determined by the `backupRetentionPeriod`. @@ -112,4 +113,4 @@ Using `terraform import`, import DocDB (DocumentDB) Elastic Cluster using the `a % terraform import aws_docdbelastic_cluster.example arn:aws:docdb-elastic:us-east-1:000011112222:cluster/12345678-7abc-def0-1234-56789abcdef ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/drs_replication_configuration_template.html.markdown b/website/docs/cdktf/typescript/r/drs_replication_configuration_template.html.markdown index 3187434cd7b3..51067aa22ad0 100644 --- a/website/docs/cdktf/typescript/r/drs_replication_configuration_template.html.markdown +++ b/website/docs/cdktf/typescript/r/drs_replication_configuration_template.html.markdown @@ -98,6 +98,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `autoReplicateNewDisks` - (Optional) Whether to allow the AWS replication agent to automatically replicate newly added disks. * `tags` - (Optional) Set of tags to be associated with the Replication Configuration Template resource. @@ -159,4 +160,4 @@ Using `terraform import`, import DRS Replication Configuration Template using th % terraform import aws_drs_replication_configuration_template.example templateid ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/dsql_cluster.html.markdown b/website/docs/cdktf/typescript/r/dsql_cluster.html.markdown index 6348b58fa614..7621e2ee6b97 100644 --- a/website/docs/cdktf/typescript/r/dsql_cluster.html.markdown +++ b/website/docs/cdktf/typescript/r/dsql_cluster.html.markdown @@ -24,12 +24,12 @@ import { TerraformStack } from "cdktf"; * Provider bindings are generated by running `cdktf get`. * See https://cdk.tf/provider-generation for more details. */ -import { DsqlCluster } from "./.gen/providers/aws/"; +import { DsqlCluster } from "./.gen/providers/aws/dsql-cluster"; class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); new DsqlCluster(this, "example", { - deletion_protection_enabled: true, + deletionProtectionEnabled: true, tags: { Name: "TestCluster", }, @@ -44,9 +44,10 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: * `deletionProtectionEnabled` - (Required) Whether deletion protection is enabled in this cluster. -* `kms_encryption_key` - (Optional) The ARN of the AWS KMS key that encrypts data in the DSQL Cluster, or `"AWS_OWNED_KMS_KEY"`. -* `multi_region_properties` - (Optional) Multi-region properties of the DSQL Cluster. - * `witness_region` - (Required) Witness region for the multi-region clusters. Setting this makes this cluster a multi-region cluster. Changing it recreates the resource. +* `kmsEncryptionKey` - (Optional) The ARN of the AWS KMS key that encrypts data in the DSQL Cluster, or `"AWS_OWNED_KMS_KEY"`. +* `multiRegionProperties` - (Optional) Multi-region properties of the DSQL Cluster. + * `witnessRegion` - (Required) Witness region for the multi-region clusters. Setting this makes this cluster a multi-region cluster. Changing it recreates the resource. +* `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). * `tags` - (Optional) Set of tags to be associated with the AWS DSQL Cluster resource. ## Attribute Reference @@ -54,14 +55,14 @@ This resource supports the following arguments: This resource exports the following attributes in addition to the arguments above: * `arn` - ARN of the Cluster. -* `encryption_details` - Encryption configuration details for the DSQL Cluster. +* `encryptionDetails` - Encryption configuration details for the DSQL Cluster. * `encryption_status` - The status of encryption for the DSQL Cluster. * `encryptionType` - The type of encryption that protects the data on the DSQL Cluster. * `identifier` - Cluster Identifier. -* `multi_region_properties` - Multi-region properties of the DSQL Cluster. +* `multiRegionProperties` - Multi-region properties of the DSQL Cluster. * `clusters` - List of DSQL Cluster ARNs peered to this cluster. * `tagsAll` - Map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block). -* `vpc_endpoint_service_name` - The DSQL Cluster's VPC endpoint service name. +* `vpcEndpointServiceName` - The DSQL Cluster's VPC endpoint service name. ## Timeouts @@ -83,7 +84,7 @@ import { TerraformStack } from "cdktf"; * Provider bindings are generated by running `cdktf get`. * See https://cdk.tf/provider-generation for more details. */ -import { DsqlCluster } from "./.gen/providers/aws/"; +import { DsqlCluster } from "./.gen/providers/aws/dsql-cluster"; class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); @@ -103,4 +104,4 @@ Using `terraform import`, import DSQL Cluster using the `identifier`. For exampl % terraform import aws_dsql_cluster.example abcde1f234ghijklmnop5qr6st ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/dsql_cluster_peering.html.markdown b/website/docs/cdktf/typescript/r/dsql_cluster_peering.html.markdown index 01411f23a6e7..ee1c7eb5635b 100644 --- a/website/docs/cdktf/typescript/r/dsql_cluster_peering.html.markdown +++ b/website/docs/cdktf/typescript/r/dsql_cluster_peering.html.markdown @@ -19,26 +19,27 @@ Terraform resource for managing an Amazon Aurora DSQL Cluster Peering. ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug import { Construct } from "constructs"; -import { Fn, TerraformStack } from "cdktf"; +import { Fn, Token, TerraformStack } from "cdktf"; /* * Provider bindings are generated by running `cdktf get`. * See https://cdk.tf/provider-generation for more details. */ -import { DsqlCluster, DsqlClusterPeering } from "./.gen/providers/aws/"; +import { DsqlCluster } from "./.gen/providers/aws/dsql-cluster"; +import { DsqlClusterPeering } from "./.gen/providers/aws/dsql-cluster-peering"; class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); const example1 = new DsqlCluster(this, "example_1", { - multi_region_properties: [ + multiRegionProperties: [ { - witness_region: "us-west-2", + witnessRegion: "us-west-2", }, ], }); const example2 = new DsqlCluster(this, "example_2", { - multi_region_properties: [ + multiRegionProperties: [ { - witness_region: "us-west-2", + witnessRegion: "us-west-2", }, ], provider: alternate, @@ -49,10 +50,12 @@ class MyConvertedCode extends TerraformStack { { clusters: [example2.arn], identifier: example1.identifier, - witness_region: Fn.lookupNested(example1.multiRegionProperties, [ - "0", - "witness_region", - ]), + witnessRegion: Token.asString( + Fn.lookupNested(example1.multiRegionProperties, [ + "0", + "witness_region", + ]) + ), } ); /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ @@ -64,10 +67,12 @@ class MyConvertedCode extends TerraformStack { clusters: [example1.arn], identifier: example2.identifier, provider: alternate, - witness_region: Fn.lookupNested(example2.multiRegionProperties, [ - "0", - "witness_region", - ]), + witnessRegion: Token.asString( + Fn.lookupNested(example2.multiRegionProperties, [ + "0", + "witness_region", + ]) + ), } ); /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ @@ -83,7 +88,8 @@ This resource supports the following arguments: * `clusters` - (Required) List of DSQL Cluster ARNs to be peered to this cluster. * `identifier` - (Required) DSQL Cluster Identifier. -* `witness_region` - (Required) Witness region for a multi-region cluster. +* `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). +* `witnessRegion` - (Required) Witness region for a multi-region cluster. ## Attribute Reference @@ -107,7 +113,7 @@ import { TerraformStack } from "cdktf"; * Provider bindings are generated by running `cdktf get`. * See https://cdk.tf/provider-generation for more details. */ -import { DsqlClusterPeering } from "./.gen/providers/aws/"; +import { DsqlClusterPeering } from "./.gen/providers/aws/dsql-cluster-peering"; class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); @@ -127,4 +133,4 @@ Using `terraform import`, import DSQL Cluster Peering using the `identifier`. Fo % terraform import aws_dsql_cluster_peering.example cluster-id-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/dx_bgp_peer.html.markdown b/website/docs/cdktf/typescript/r/dx_bgp_peer.html.markdown index 9a1d663fccd6..3f55bdd87284 100644 --- a/website/docs/cdktf/typescript/r/dx_bgp_peer.html.markdown +++ b/website/docs/cdktf/typescript/r/dx_bgp_peer.html.markdown @@ -40,6 +40,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `addressFamily` - (Required) The address family for the BGP peer. `ipv4 ` or `ipv6`. * `bgpAsn` - (Required) The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration. * `virtualInterfaceId` - (Required) The ID of the Direct Connect virtual interface on which to create the BGP peer. @@ -65,4 +66,4 @@ This resource exports the following attributes in addition to the arguments abov - `create` - (Default `10m`) - `delete` - (Default `10m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/dx_connection.html.markdown b/website/docs/cdktf/typescript/r/dx_connection.html.markdown index 0588178381b4..1dcc2af947c9 100644 --- a/website/docs/cdktf/typescript/r/dx_connection.html.markdown +++ b/website/docs/cdktf/typescript/r/dx_connection.html.markdown @@ -95,6 +95,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `bandwidth` - (Required) The bandwidth of the connection. Valid values for dedicated connections: 1Gbps, 10Gbps, 100Gbps, and 400Gbps. Valid values for hosted connections: 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, 500Mbps, 1Gbps, 2Gbps, 5Gbps, 10Gbps, and 25Gbps. Case sensitive. Refer to the AWS Direct Connection supported bandwidths for [Dedicated Connections](https://docs.aws.amazon.com/directconnect/latest/UserGuide/dedicated_connection.html) and [Hosted Connections](https://docs.aws.amazon.com/directconnect/latest/UserGuide/hosted_connection.html). * `encryptionMode` - (Optional) The connection MAC Security (MACsec) encryption mode. MAC Security (MACsec) is only available on dedicated connections. Valid values are `no_encrypt`, `should_encrypt`, and `must_encrypt`. * `location` - (Required) The AWS Direct Connect location where the connection is located. See [DescribeLocations](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_DescribeLocations.html) for the list of AWS Direct Connect locations. Use `locationCode`. @@ -155,4 +156,4 @@ Using `terraform import`, import Direct Connect connections using the connection % terraform import aws_dx_connection.test_connection dxcon-ffre0ec3 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/dx_connection_association.html.markdown b/website/docs/cdktf/typescript/r/dx_connection_association.html.markdown index f7232578899f..cbdd9ff9a8c0 100644 --- a/website/docs/cdktf/typescript/r/dx_connection_association.html.markdown +++ b/website/docs/cdktf/typescript/r/dx_connection_association.html.markdown @@ -59,6 +59,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `connectionId` - (Required) The ID of the connection. * `lagId` - (Required) The ID of the LAG with which to associate the connection. @@ -66,4 +67,4 @@ This resource supports the following arguments: This resource exports no additional attributes. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/dx_connection_confirmation.html.markdown b/website/docs/cdktf/typescript/r/dx_connection_confirmation.html.markdown index 00d1037aacd2..ca5ed841fdb0 100644 --- a/website/docs/cdktf/typescript/r/dx_connection_confirmation.html.markdown +++ b/website/docs/cdktf/typescript/r/dx_connection_confirmation.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `connectionId` - (Required) The ID of the hosted connection. ### Removing `aws_dx_connection_confirmation` from your configuration @@ -51,4 +52,4 @@ This resource exports the following attributes in addition to the arguments abov * `id` - The ID of the connection. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/dx_gateway_association.html.markdown b/website/docs/cdktf/typescript/r/dx_gateway_association.html.markdown index 84d70e2e50df..78c33503ffe0 100644 --- a/website/docs/cdktf/typescript/r/dx_gateway_association.html.markdown +++ b/website/docs/cdktf/typescript/r/dx_gateway_association.html.markdown @@ -160,6 +160,7 @@ A full example of how to create a VPN Gateway in one AWS account, create a Direc This resource supports the following arguments: +* `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). * `dxGatewayId` - (Required) The ID of the Direct Connect gateway. * `associatedGatewayId` - (Optional) The ID of the VGW or transit gateway with which to associate the Direct Connect gateway. Used for single account Direct Connect gateway associations. @@ -177,10 +178,10 @@ Used for cross-account Direct Connect gateway associations. This resource exports the following attributes in addition to the arguments above: -* `id` - The ID of the Direct Connect gateway association resource. * `associatedGatewayType` - The type of the associated gateway, `transitGateway` or `virtualPrivateGateway`. * `dxGatewayAssociationId` - The ID of the Direct Connect gateway association. * `dxGatewayOwnerAccountId` - The ID of the AWS account that owns the Direct Connect gateway. +* `transitGatewayAttachmentId` - The ID of the Transit Gateway Attachment when the type is `transitGateway`. ## Timeouts @@ -222,4 +223,4 @@ Using `terraform import`, import Direct Connect gateway associations using `dxGa % terraform import aws_dx_gateway_association.example 345508c3-7215-4aef-9832-07c125d5bd0f/vgw-98765432 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/dx_gateway_association_proposal.html.markdown b/website/docs/cdktf/typescript/r/dx_gateway_association_proposal.html.markdown index 9eb8b29b4cc0..7b11be1ef39a 100644 --- a/website/docs/cdktf/typescript/r/dx_gateway_association_proposal.html.markdown +++ b/website/docs/cdktf/typescript/r/dx_gateway_association_proposal.html.markdown @@ -44,6 +44,7 @@ A full example of how to create a VPN Gateway in one AWS account, create a Direc This resource supports the following arguments: +* `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). * `associatedGatewayId` - (Required) The ID of the VGW or transit gateway with which to associate the Direct Connect gateway. * `dxGatewayId` - (Required) Direct Connect Gateway identifier. * `dxGatewayOwnerAccountId` - (Required) AWS Account identifier of the Direct Connect Gateway's owner. @@ -126,4 +127,4 @@ Using a proposal ID, Direct Connect Gateway ID and associated gateway ID separat The latter case is useful when a previous proposal has been accepted and deleted by AWS. The `aws_dx_gateway_association_proposal` resource will then represent a pseudo-proposal for the same Direct Connect Gateway and associated gateway. If no previous proposal is available, use a tool like [`uuidgen`](http://manpages.ubuntu.com/manpages/bionic/man1/uuidgen.1.html) to generate a new random pseudo-proposal ID. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/dx_hosted_connection.html.markdown b/website/docs/cdktf/typescript/r/dx_hosted_connection.html.markdown index a836b96dc6a3..cbb473f63d11 100644 --- a/website/docs/cdktf/typescript/r/dx_hosted_connection.html.markdown +++ b/website/docs/cdktf/typescript/r/dx_hosted_connection.html.markdown @@ -52,16 +52,17 @@ This resource supports the following arguments: This resource exports the following attributes in addition to the arguments above: -* `id` - The ID of the connection. -* `jumboFrameCapable` - Boolean value representing if jumbo frames have been enabled for this connection. -* `hasLogicalRedundancy` - Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6). * `awsDevice` - The Direct Connect endpoint on which the physical connection terminates. -* `state` - The state of the connection. Possible values include: ordering, requested, pending, available, down, deleting, deleted, rejected, unknown. See [AllocateHostedConnection](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_AllocateHostedConnection.html) for a description of each connection state. +* `connectionRegion` - The AWS Region where the connection is located. +* `hasLogicalRedundancy` - Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6). +* `id` - The ID of the hosted connection. +* `jumboFrameCapable` - Boolean value representing if jumbo frames have been enabled for this connection. * `lagId` - The ID of the LAG. * `loaIssueTime` - The time of the most recent call to [DescribeLoa](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_DescribeLoa.html) for this connection. * `location` - The location of the connection. * `partnerName` - The name of the AWS Direct Connect service provider associated with the connection. * `providerName` - The name of the service provider associated with the connection. -* `region` - The AWS Region where the connection is located. +* `region` - (**Deprecated**) The AWS Region where the connection is located. Use `connectionRegion` instead. +* `state` - The state of the connection. Possible values include: ordering, requested, pending, available, down, deleting, deleted, rejected, unknown. See [AllocateHostedConnection](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_AllocateHostedConnection.html) for a description of each connection state. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/dx_hosted_private_virtual_interface.html.markdown b/website/docs/cdktf/typescript/r/dx_hosted_private_virtual_interface.html.markdown index fa9abfce1de8..bd1d63dd2cdb 100644 --- a/website/docs/cdktf/typescript/r/dx_hosted_private_virtual_interface.html.markdown +++ b/website/docs/cdktf/typescript/r/dx_hosted_private_virtual_interface.html.markdown @@ -47,6 +47,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `addressFamily` - (Required) The address family for the BGP peer. `ipv4 ` or `ipv6`. * `bgpAsn` - (Required) The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration. * `connectionId` - (Required) The ID of the Direct Connect connection (or LAG) on which to create the virtual interface. @@ -107,4 +108,4 @@ Using `terraform import`, import Direct Connect hosted private virtual interface % terraform import aws_dx_hosted_private_virtual_interface.test dxvif-33cc44dd ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/dx_hosted_private_virtual_interface_accepter.html.markdown b/website/docs/cdktf/typescript/r/dx_hosted_private_virtual_interface_accepter.html.markdown index 5c2ab08f8ddf..c09b859723fd 100644 --- a/website/docs/cdktf/typescript/r/dx_hosted_private_virtual_interface_accepter.html.markdown +++ b/website/docs/cdktf/typescript/r/dx_hosted_private_virtual_interface_accepter.html.markdown @@ -76,6 +76,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `virtualInterfaceId` - (Required) The ID of the Direct Connect virtual interface to accept. * `dxGatewayId` - (Optional) The ID of the Direct Connect gateway to which to connect the virtual interface. * `tags` - (Optional) A map of tags to assign to the resource. If configured with a provider [`defaultTags` 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. @@ -136,4 +137,4 @@ Using `terraform import`, import Direct Connect hosted private virtual interface % terraform import aws_dx_hosted_private_virtual_interface_accepter.test dxvif-33cc44dd ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/dx_hosted_public_virtual_interface.html.markdown b/website/docs/cdktf/typescript/r/dx_hosted_public_virtual_interface.html.markdown index a274deb1cec5..6bc42759dfdc 100644 --- a/website/docs/cdktf/typescript/r/dx_hosted_public_virtual_interface.html.markdown +++ b/website/docs/cdktf/typescript/r/dx_hosted_public_virtual_interface.html.markdown @@ -50,6 +50,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `addressFamily` - (Required) The address family for the BGP peer. `ipv4 ` or `ipv6`. * `bgpAsn` - (Required) The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration. * `connectionId` - (Required) The ID of the Direct Connect connection (or LAG) on which to create the virtual interface. @@ -108,4 +109,4 @@ Using `terraform import`, import Direct Connect hosted public virtual interfaces % terraform import aws_dx_hosted_public_virtual_interface.test dxvif-33cc44dd ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/dx_hosted_public_virtual_interface_accepter.html.markdown b/website/docs/cdktf/typescript/r/dx_hosted_public_virtual_interface_accepter.html.markdown index a7f83c2919bb..f110436d50d8 100644 --- a/website/docs/cdktf/typescript/r/dx_hosted_public_virtual_interface_accepter.html.markdown +++ b/website/docs/cdktf/typescript/r/dx_hosted_public_virtual_interface_accepter.html.markdown @@ -73,6 +73,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `virtualInterfaceId` - (Required) The ID of the Direct Connect virtual interface to accept. * `tags` - (Optional) A map of tags to assign to the resource. If configured with a provider [`defaultTags` 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. @@ -131,4 +132,4 @@ Using `terraform import`, import Direct Connect hosted public virtual interfaces % terraform import aws_dx_hosted_public_virtual_interface_accepter.test dxvif-33cc44dd ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/dx_hosted_transit_virtual_interface.html.markdown b/website/docs/cdktf/typescript/r/dx_hosted_transit_virtual_interface.html.markdown index bc1eb2acf87c..282695b92c27 100644 --- a/website/docs/cdktf/typescript/r/dx_hosted_transit_virtual_interface.html.markdown +++ b/website/docs/cdktf/typescript/r/dx_hosted_transit_virtual_interface.html.markdown @@ -48,6 +48,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `addressFamily` - (Required) The address family for the BGP peer. `ipv4 ` or `ipv6`. * `bgpAsn` - (Required) The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration. * `connectionId` - (Required) The ID of the Direct Connect connection (or LAG) on which to create the virtual interface. @@ -108,4 +109,4 @@ Using `terraform import`, import Direct Connect hosted transit virtual interface % terraform import aws_dx_hosted_transit_virtual_interface.test dxvif-33cc44dd ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/dx_hosted_transit_virtual_interface_accepter.html.markdown b/website/docs/cdktf/typescript/r/dx_hosted_transit_virtual_interface_accepter.html.markdown index 2405b849f43e..bcb328fdf729 100644 --- a/website/docs/cdktf/typescript/r/dx_hosted_transit_virtual_interface_accepter.html.markdown +++ b/website/docs/cdktf/typescript/r/dx_hosted_transit_virtual_interface_accepter.html.markdown @@ -80,6 +80,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `dxGatewayId` - (Required) The ID of the [Direct Connect gateway](dx_gateway.html) to which to connect the virtual interface. * `virtualInterfaceId` - (Required) The ID of the Direct Connect virtual interface to accept. * `tags` - (Optional) A map of tags to assign to the resource. If configured with a provider [`defaultTags` 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. @@ -131,4 +132,4 @@ Using `terraform import`, import Direct Connect hosted transit virtual interface % terraform import aws_dx_hosted_transit_virtual_interface_accepter.test dxvif-33cc44dd ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/dx_lag.html.markdown b/website/docs/cdktf/typescript/r/dx_lag.html.markdown index 15c8ad570cd7..8d0d7f8344b8 100644 --- a/website/docs/cdktf/typescript/r/dx_lag.html.markdown +++ b/website/docs/cdktf/typescript/r/dx_lag.html.markdown @@ -43,6 +43,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) The name of the LAG. * `connectionsBandwidth` - (Required) The bandwidth of the individual dedicated connections bundled by the LAG. Valid values: 1Gbps, 10Gbps, 100Gbps, and 400Gbps. Case sensitive. Refer to the AWS Direct Connection supported bandwidths for [Dedicated Connections](https://docs.aws.amazon.com/directconnect/latest/UserGuide/dedicated_connection.html). * `location` - (Required) The AWS Direct Connect location in which the LAG should be allocated. See [DescribeLocations](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_DescribeLocations.html) for the list of AWS Direct Connect locations. Use `locationCode`. @@ -90,4 +91,4 @@ Using `terraform import`, import Direct Connect LAGs using the LAG `id`. For exa % terraform import aws_dx_lag.test_lag dxlag-fgnsp5rq ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/dx_macsec_key_association.html.markdown b/website/docs/cdktf/typescript/r/dx_macsec_key_association.html.markdown index 06d04115fcae..a6f5905363bb 100644 --- a/website/docs/cdktf/typescript/r/dx_macsec_key_association.html.markdown +++ b/website/docs/cdktf/typescript/r/dx_macsec_key_association.html.markdown @@ -90,6 +90,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `cak` - (Optional) The MAC Security (MACsec) CAK to associate with the dedicated connection. The valid values are 64 hexadecimal characters (0-9, A-E). Required if using `ckn`. * `ckn` - (Optional) The MAC Security (MACsec) CKN to associate with the dedicated connection. The valid values are 64 hexadecimal characters (0-9, A-E). Required if using `cak`. * `connectionId` - (Required) The ID of the dedicated Direct Connect connection. The connection must be a dedicated connection in the `AVAILABLE` state. @@ -105,4 +106,4 @@ This resource exports the following attributes in addition to the arguments abov * `startOn` - The date in UTC format that the MAC Security (MACsec) secret key takes effect. * `state` - The state of the MAC Security (MACsec) secret key. The possible values are: associating, associated, disassociating, disassociated. See [MacSecKey](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_MacSecKey.html#DX-Type-MacSecKey-state) for descriptions of each state. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/dx_private_virtual_interface.html.markdown b/website/docs/cdktf/typescript/r/dx_private_virtual_interface.html.markdown index cb2d977cf1fc..991386bae01d 100644 --- a/website/docs/cdktf/typescript/r/dx_private_virtual_interface.html.markdown +++ b/website/docs/cdktf/typescript/r/dx_private_virtual_interface.html.markdown @@ -42,6 +42,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `addressFamily` - (Required) The address family for the BGP peer. `ipv4 ` or `ipv6`. * `bgpAsn` - (Required) The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration. * `connectionId` - (Required) The ID of the Direct Connect connection (or LAG) on which to create the virtual interface. @@ -107,4 +108,4 @@ Using `terraform import`, import Direct Connect private virtual interfaces using % terraform import aws_dx_private_virtual_interface.test dxvif-33cc44dd ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/dx_public_virtual_interface.html.markdown b/website/docs/cdktf/typescript/r/dx_public_virtual_interface.html.markdown index ab4b770357ea..24d692436c84 100644 --- a/website/docs/cdktf/typescript/r/dx_public_virtual_interface.html.markdown +++ b/website/docs/cdktf/typescript/r/dx_public_virtual_interface.html.markdown @@ -45,6 +45,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `addressFamily` - (Required) The address family for the BGP peer. `ipv4 ` or `ipv6`. * `bgpAsn` - (Required) The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration. * `connectionId` - (Required) The ID of the Direct Connect connection (or LAG) on which to create the virtual interface. @@ -104,4 +105,4 @@ Using `terraform import`, import Direct Connect public virtual interfaces using % terraform import aws_dx_public_virtual_interface.test dxvif-33cc44dd ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/dx_transit_virtual_interface.html.markdown b/website/docs/cdktf/typescript/r/dx_transit_virtual_interface.html.markdown index 031127a13766..cd09e7773309 100644 --- a/website/docs/cdktf/typescript/r/dx_transit_virtual_interface.html.markdown +++ b/website/docs/cdktf/typescript/r/dx_transit_virtual_interface.html.markdown @@ -55,6 +55,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `addressFamily` - (Required) The address family for the BGP peer. `ipv4 ` or `ipv6`. * `bgpAsn` - (Required) The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration. * `connectionId` - (Required) The ID of the Direct Connect connection (or LAG) on which to create the virtual interface. @@ -119,4 +120,4 @@ Using `terraform import`, import Direct Connect transit virtual interfaces using % terraform import aws_dx_transit_virtual_interface.test dxvif-33cc44dd ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/dynamodb_contributor_insights.html.markdown b/website/docs/cdktf/typescript/r/dynamodb_contributor_insights.html.markdown index ec473c25aed0..459748e553ed 100644 --- a/website/docs/cdktf/typescript/r/dynamodb_contributor_insights.html.markdown +++ b/website/docs/cdktf/typescript/r/dynamodb_contributor_insights.html.markdown @@ -38,8 +38,10 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `tableName` - (Required) The name of the table to enable contributor insights * `indexName` - (Optional) The global secondary index name +* `mode` - (Optional) argument to specify the [CloudWatch contributor insights mode](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/contributorinsights_HowItWorks.html#contributorinsights_HowItWorks.Modes) ## Attribute Reference @@ -77,4 +79,4 @@ Using `terraform import`, import `aws_dynamodb_contributor_insights` using the f % terraform import aws_dynamodb_contributor_insights.test name:ExampleTableName/index:ExampleIndexName/123456789012 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/dynamodb_global_table.html.markdown b/website/docs/cdktf/typescript/r/dynamodb_global_table.html.markdown index 5f85933e4379..d3f854c597c6 100644 --- a/website/docs/cdktf/typescript/r/dynamodb_global_table.html.markdown +++ b/website/docs/cdktf/typescript/r/dynamodb_global_table.html.markdown @@ -92,6 +92,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) The name of the global table. Must match underlying DynamoDB Table names in all regions. * `replica` - (Required) Underlying DynamoDB Table. At least 1 replica must be defined. See below. @@ -136,4 +137,4 @@ Using `terraform import`, import DynamoDB Global Tables using the global table n % terraform import aws_dynamodb_global_table.MyTable MyTable ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/dynamodb_kinesis_streaming_destination.html.markdown b/website/docs/cdktf/typescript/r/dynamodb_kinesis_streaming_destination.html.markdown index c473fffff482..cb6ac874a302 100644 --- a/website/docs/cdktf/typescript/r/dynamodb_kinesis_streaming_destination.html.markdown +++ b/website/docs/cdktf/typescript/r/dynamodb_kinesis_streaming_destination.html.markdown @@ -61,6 +61,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `approximateCreationDateTimePrecision` - (Optional) Toggle for the precision of Kinesis data stream timestamp. Valid values: `MILLISECOND` and `MICROSECOND`. * `streamArn` - (Required) The ARN for a Kinesis data stream. This must exist in the same account and region as the DynamoDB table. * `tableName` - (Required) The name of the DynamoDB table. There can only be one Kinesis streaming destination for a given DynamoDB table. @@ -103,4 +104,4 @@ Using `terraform import`, import DynamoDB Kinesis Streaming Destinations using t % terraform import aws_dynamodb_kinesis_streaming_destination.example example,arn:aws:kinesis:us-east-1:111122223333:exampleStreamName ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/dynamodb_resource_policy.html.markdown b/website/docs/cdktf/typescript/r/dynamodb_resource_policy.html.markdown index 2dfe24878841..f27949bf952b 100644 --- a/website/docs/cdktf/typescript/r/dynamodb_resource_policy.html.markdown +++ b/website/docs/cdktf/typescript/r/dynamodb_resource_policy.html.markdown @@ -47,6 +47,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `confirmRemoveSelfResourceAccess` - (Optional) Set this parameter to true to confirm that you want to remove your permissions to change the policy of this resource in the future. ## Attribute Reference @@ -57,7 +58,7 @@ This resource exports the following attributes in addition to the arguments abov ## Import -In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import DynamoDB Resource Policy using the `example_id_arg`. For example: +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import DynamoDB Resource Policy using the `resourceArn`. For example: ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -81,10 +82,10 @@ class MyConvertedCode extends TerraformStack { ``` -Using `terraform import`, import DynamoDB Resource Policy using the `example_id_arg`. For example: +Using `terraform import`, import DynamoDB Resource Policy using the `resourceArn`. For example: ```console % terraform import aws_dynamodb_resource_policy.example arn:aws:dynamodb:us-east-1:1234567890:table/my-table ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/dynamodb_table.html.markdown b/website/docs/cdktf/typescript/r/dynamodb_table.html.markdown index afb9489a2753..cf3df1807859 100644 --- a/website/docs/cdktf/typescript/r/dynamodb_table.html.markdown +++ b/website/docs/cdktf/typescript/r/dynamodb_table.html.markdown @@ -133,6 +133,54 @@ class MyConvertedCode extends TerraformStack { ``` +#### Global Tables with Multi-Region Strong Consistency + +A global table configured for Multi-Region strong consistency (MRSC) provides the ability to perform a strongly consistent read with multi-Region scope. Performing a strongly consistent read on an MRSC table ensures you're always reading the latest version of an item, irrespective of the Region in which you're performing the read. + +**Note** Please see detailed information, restrictions, caveats etc on the [AWS Support Page](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/multi-region-strong-consistency-gt.html). + +Consistency Mode (`consistencyMode`) is a new argument on the embedded `replica` that allows you to configure consistency mode for Global Tables. + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { DynamodbTable } from "./.gen/providers/aws/dynamodb-table"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + new DynamodbTable(this, "example", { + attribute: [ + { + name: "TestTableHashKey", + type: "S", + }, + ], + billingMode: "PAY_PER_REQUEST", + hashKey: "TestTableHashKey", + name: "example", + replica: [ + { + consistencyMode: "STRONG", + regionName: "us-east-2", + }, + { + consistencyMode: "STRONG", + regionName: "us-west-2", + }, + ], + streamEnabled: true, + streamViewType: "NEW_AND_OLD_IMAGES", + }); + } +} + +``` + ### Replica Tagging You can manage global table replicas' tags in various ways. This example shows using `replica.*.propagate_tags` for the first replica and the `aws_dynamodb_tag` resource for the other. @@ -203,7 +251,7 @@ class MyConvertedCode extends TerraformStack { resourceArn: Token.asString( Fn.replace( example.arn, - Token.asString(current.name), + Token.asString(current.region), Token.asString(alternate.name) ) ), @@ -226,6 +274,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `billingMode` - (Optional) Controls how you are charged for read and write throughput and how you manage capacity. The valid values are `PROVISIONED` and `PAY_PER_REQUEST`. Defaults to `PROVISIONED`. * `deletionProtectionEnabled` - (Optional) Enables deletion protection for table. Defaults to `false`. * `importTable` - (Optional) Import Amazon S3 data into a new table. See below. @@ -314,6 +363,7 @@ The following arguments are optional: **Note:** This attribute will _not_ be populated with the ARN of _default_ keys. **Note:** Changing this value will recreate the replica. * `pointInTimeRecovery` - (Optional) Whether to enable Point In Time Recovery for the replica. Default is `false`. +* `deletionProtectionEnabled` - (Optional) Whether deletion protection is enabled (true) or disabled (false) on the replica. Default is `false`. * `propagateTags` - (Optional) Whether to propagate the global table's tags to a replica. Default is `false`. Changes to tags only move in one direction: from global (source) to replica. @@ -321,6 +371,7 @@ The following arguments are optional: Tag changes on the global table are propagated to replicas. Changing from `true` to `false` on a subsequent `apply` leaves replica tags as-is and no longer manages them. * `regionName` - (Required) Region name of the replica. +* `consistencyMode` - (Optional) Whether this global table will be using `STRONG` consistency mode or `EVENTUAL` consistency mode. Default value is `EVENTUAL`. ### `serverSideEncryption` @@ -389,4 +440,4 @@ Using `terraform import`, import DynamoDB tables using the `name`. For example: % terraform import aws_dynamodb_table.basic-dynamodb-table GameScores ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/dynamodb_table_export.html.markdown b/website/docs/cdktf/typescript/r/dynamodb_table_export.html.markdown index 15ba62639186..57167c92a0f4 100644 --- a/website/docs/cdktf/typescript/r/dynamodb_table_export.html.markdown +++ b/website/docs/cdktf/typescript/r/dynamodb_table_export.html.markdown @@ -132,6 +132,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `exportFormat` - (Optional, Forces new resource) Format for the exported data. Valid values are: `DYNAMODB_JSON`, `ION`. See the [AWS Documentation](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/S3DataExport.Output.html#S3DataExport.Output_Data) for more information on these export formats. Default is `DYNAMODB_JSON`. * `exportTime` - (Optional, Forces new resource) Time in RFC3339 format from which to export table data. The table export will be a snapshot of the table's state at this point in time. Omitting this value will result in a snapshot from the current time. * `exportType` - (Optional, Forces new resource) Whether to execute as a full export or incremental export. Valid values are: `FULL_EXPORT`, `INCREMENTAL_EXPORT`. Defaults to `FULL_EXPORT`. If `INCREMENTAL_EXPORT` is provided, the `incrementalExportSpecification` argument must also be provided. @@ -200,4 +201,4 @@ Using `terraform import`, import DynamoDB table exports using the `arn`. For exa % terraform import aws_dynamodb_table_export.example arn:aws:dynamodb:us-west-2:12345678911:table/my-table-1/export/01580735656614-2c2f422e ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/dynamodb_table_item.html.markdown b/website/docs/cdktf/typescript/r/dynamodb_table_item.html.markdown index d2864e24d5b3..ce051163304b 100644 --- a/website/docs/cdktf/typescript/r/dynamodb_table_item.html.markdown +++ b/website/docs/cdktf/typescript/r/dynamodb_table_item.html.markdown @@ -62,6 +62,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `hashKey` - (Required) Hash key to use for lookups and identification of the item * `item` - (Required) JSON representation of a map of attribute name/value pairs, one for each attribute. Only the primary key attributes are required; you can optionally provide other attribute name-value pairs for the item. * `rangeKey` - (Optional) Range key to use for lookups and identification of the item. Required if there is range key defined in the table. @@ -77,4 +78,4 @@ This resource exports the following attributes in addition to the arguments abov You cannot import DynamoDB table items. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/dynamodb_table_replica.html.markdown b/website/docs/cdktf/typescript/r/dynamodb_table_replica.html.markdown index 2e3632c66fae..8a91d5d77633 100644 --- a/website/docs/cdktf/typescript/r/dynamodb_table_replica.html.markdown +++ b/website/docs/cdktf/typescript/r/dynamodb_table_replica.html.markdown @@ -86,6 +86,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `kmsKeyArn` - (Optional, Forces new resource) ARN of the CMK that should be used for the AWS KMS encryption. This argument should only be used if the key is different from the default KMS-managed DynamoDB key, `alias/aws/dynamodb`. **Note:** This attribute will _not_ be populated with the ARN of _default_ keys. * `deletionProtectionEnabled` - (Optional) Whether deletion protection is enabled (true) or disabled (false) on the table replica. * `pointInTimeRecovery` - (Optional) Whether to enable Point In Time Recovery for the table replica. Default is `false`. @@ -144,4 +145,4 @@ Using `terraform import`, import DynamoDB table replicas using the `table-name:m % terraform import aws_dynamodb_table_replica.example TestTable:us-west-2 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/dynamodb_tag.html.markdown b/website/docs/cdktf/typescript/r/dynamodb_tag.html.markdown index bf2c8546e82c..1817491b0447 100644 --- a/website/docs/cdktf/typescript/r/dynamodb_tag.html.markdown +++ b/website/docs/cdktf/typescript/r/dynamodb_tag.html.markdown @@ -61,7 +61,7 @@ class MyConvertedCode extends TerraformStack { resourceArn: Token.asString( Fn.replace( example.arn, - Token.asString(current.name), + Token.asString(current.region), Token.asString(dataAwsRegionReplica.name) ) ), @@ -76,6 +76,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `resourceArn` - (Required) Amazon Resource Name (ARN) of the DynamoDB resource to tag. * `key` - (Required) Tag name. * `value` - (Required) Tag value. @@ -118,4 +119,4 @@ Using `terraform import`, import `aws_dynamodb_tag` using the DynamoDB resource % terraform import aws_dynamodb_tag.example arn:aws:dynamodb:us-east-1:123456789012:table/example,Name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ebs_default_kms_key.html.markdown b/website/docs/cdktf/typescript/r/ebs_default_kms_key.html.markdown index 63cc195d09ec..50037dd57948 100644 --- a/website/docs/cdktf/typescript/r/ebs_default_kms_key.html.markdown +++ b/website/docs/cdktf/typescript/r/ebs_default_kms_key.html.markdown @@ -45,6 +45,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `keyArn` - (Required, ForceNew) The ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use to encrypt the EBS volume. ## Attribute Reference @@ -83,4 +84,4 @@ Using `terraform import`, import the EBS default KMS CMK using the KMS key ARN. % terraform import aws_ebs_default_kms_key.example arn:aws:kms:us-east-1:123456789012:key/abcd-1234 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ebs_encryption_by_default.html.markdown b/website/docs/cdktf/typescript/r/ebs_encryption_by_default.html.markdown index 10a3561e6a20..4f95f2031c1e 100644 --- a/website/docs/cdktf/typescript/r/ebs_encryption_by_default.html.markdown +++ b/website/docs/cdktf/typescript/r/ebs_encryption_by_default.html.markdown @@ -40,6 +40,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `enabled` - (Optional) Whether or not default EBS encryption is enabled. Valid values are `true` or `false`. Defaults to `true`. ## Attribute Reference @@ -74,4 +75,4 @@ Using `terraform import`, import the default EBS encryption state. For example: % terraform import aws_ebs_encryption_by_default.example default ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ebs_fast_snapshot_restore.html.markdown b/website/docs/cdktf/typescript/r/ebs_fast_snapshot_restore.html.markdown index 47d2b700f779..e01fa6b5d6b1 100644 --- a/website/docs/cdktf/typescript/r/ebs_fast_snapshot_restore.html.markdown +++ b/website/docs/cdktf/typescript/r/ebs_fast_snapshot_restore.html.markdown @@ -39,8 +39,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `availabilityZone` - (Required) Availability zone in which to enable fast snapshot restores. * `snapshotId` - (Required) ID of the snapshot. @@ -60,7 +61,7 @@ This resource exports the following attributes in addition to the arguments abov ## Import -In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import EC2 (Elastic Compute Cloud) EBS Fast Snapshot Restore using the `example_id_arg`. For example: +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import EC2 (Elastic Compute Cloud) EBS Fast Snapshot Restore using the `availabilityZone` and `snapshotId` separated by `,`. For example: ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -84,10 +85,10 @@ class MyConvertedCode extends TerraformStack { ``` -Using `terraform import`, import EC2 (Elastic Compute Cloud) EBS Fast Snapshot Restore using the `id`. For example: +Using `terraform import`, import EC2 (Elastic Compute Cloud) EBS Fast Snapshot Restore using the `availabilityZone` and `snapshotId` separated by `,`. For example: ```console % terraform import aws_ebs_fast_snapshot_restore.example us-west-2a,snap-abcdef123456 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ebs_snapshot.html.markdown b/website/docs/cdktf/typescript/r/ebs_snapshot.html.markdown index 591ddf756fb3..18b45d880487 100644 --- a/website/docs/cdktf/typescript/r/ebs_snapshot.html.markdown +++ b/website/docs/cdktf/typescript/r/ebs_snapshot.html.markdown @@ -49,6 +49,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `volumeId` - (Required) The Volume ID of which to make a snapshot. * `description` - (Optional) A description of what the snapshot is. * `outpostArn` - (Optional) The Amazon Resource Name (ARN) of the Outpost on which to create a local snapshot. @@ -106,4 +107,4 @@ Using `terraform import`, import EBS Snapshot using the `id`. For example: % terraform import aws_ebs_snapshot.id snap-049df61146c4d7901 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ebs_snapshot_block_public_access.html.markdown b/website/docs/cdktf/typescript/r/ebs_snapshot_block_public_access.html.markdown index c1acbf4bba48..6f6199054e39 100644 --- a/website/docs/cdktf/typescript/r/ebs_snapshot_block_public_access.html.markdown +++ b/website/docs/cdktf/typescript/r/ebs_snapshot_block_public_access.html.markdown @@ -40,6 +40,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `state` - (Required) The mode in which to enable "Block public access for snapshots" for the region. Allowed values are `block-all-sharing`, `block-new-sharing`, `unblocked`. ## Attribute Reference @@ -78,4 +79,4 @@ Using `terraform import`, import the state. For example: % terraform import aws_ebs_snapshot_block_public_access.example default ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ebs_snapshot_copy.html.markdown b/website/docs/cdktf/typescript/r/ebs_snapshot_copy.html.markdown index bfe713de10d6..5351e220da72 100644 --- a/website/docs/cdktf/typescript/r/ebs_snapshot_copy.html.markdown +++ b/website/docs/cdktf/typescript/r/ebs_snapshot_copy.html.markdown @@ -57,6 +57,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `description` - (Optional) A description of what the snapshot is. * `encrypted` - Whether the snapshot is encrypted. * `kmsKeyId` - The ARN for the KMS encryption key. @@ -65,7 +66,7 @@ This resource supports the following arguments: * `storageTier` - (Optional) The name of the storage tier. Valid values are `archive` and `standard`. Default value is `standard`. * `permanentRestore` - (Optional) Indicates whether to permanently restore an archived snapshot. * `temporaryRestoreDays` - (Optional) Specifies the number of days for which to temporarily restore an archived snapshot. Required for temporary restores only. The snapshot will be automatically re-archived after this period. -* `completion_duration_minutes` - (Optional) Specifies a completion duration to initiate a time-based snapshot copy. Time-based snapshot copy operations complete within the specified duration. Value must be between 15 and 2880 minutes, in 15 minute increments only. +* `completionDurationMinutes` - (Optional) Specifies a completion duration to initiate a time-based snapshot copy. Time-based snapshot copy operations complete within the specified duration. Value must be between 15 and 2880 minutes, in 15 minute increments only. * `tags` - A map of tags for the snapshot. If configured with a provider [`defaultTags` 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. ## Attribute Reference @@ -87,4 +88,4 @@ This resource exports the following attributes in addition to the arguments abov - `create` - (Default `10m`) - `delete` - (Default `10m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ebs_snapshot_import.html.markdown b/website/docs/cdktf/typescript/r/ebs_snapshot_import.html.markdown index 50f0e85f5bf4..ac2b4744a917 100644 --- a/website/docs/cdktf/typescript/r/ebs_snapshot_import.html.markdown +++ b/website/docs/cdktf/typescript/r/ebs_snapshot_import.html.markdown @@ -48,6 +48,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `clientData` - (Optional) The client-specific data. Detailed below. * `description` - (Optional) The description string for the import snapshot task. * `diskContainer` - (Required) Information about the disk container. Detailed below. @@ -97,4 +98,4 @@ This resource exports the following attributes in addition to the arguments abov * `dataEncryptionKeyId` - The data encryption key identifier for the snapshot. * `tagsAll` - A map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ebs_volume.html.markdown b/website/docs/cdktf/typescript/r/ebs_volume.html.markdown index 117ea5bbfef7..344111e51c60 100644 --- a/website/docs/cdktf/typescript/r/ebs_volume.html.markdown +++ b/website/docs/cdktf/typescript/r/ebs_volume.html.markdown @@ -42,6 +42,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `availabilityZone` - (Required) Availability zone where the EBS volume will exist. * `encrypted` - (Optional) If true, the disk will be encrypted. * `finalSnapshot` - (Optional) If true, snapshot will be created before volume deletion. Any tags on the volume will be migrated to the snapshot. By default set to false @@ -54,6 +55,7 @@ This resource supports the following arguments: * `tags` - (Optional) A map of tags to assign to the resource. If configured with a provider [`defaultTags` 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. * `throughput` - (Optional) Throughput that the volume supports, in MiB/s. Only valid for `type` of `gp3`. * `type` - (Optional) Type of EBS volume. Can be `standard`, `gp2`, `gp3`, `io1`, `io2`, `sc1` or `st1` (Default: `gp2`). +* `volumeInitializationRate` - (Optional) EBS provisioned rate for volume initialization, in MiB/s, at which to download the snapshot blocks from Amazon S3 to the volume. This argument can only be set if `snapshotId` is specified. ~> **NOTE:** At least one of `size` or `snapshotId` is required. @@ -104,4 +106,4 @@ Using `terraform import`, import EBS Volumes using the `id`. For example: % terraform import aws_ebs_volume.id vol-049df61146c4d7901 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ec2_availability_zone_group.html.markdown b/website/docs/cdktf/typescript/r/ec2_availability_zone_group.html.markdown index dbd27d0c235b..e463fa61bae2 100644 --- a/website/docs/cdktf/typescript/r/ec2_availability_zone_group.html.markdown +++ b/website/docs/cdktf/typescript/r/ec2_availability_zone_group.html.markdown @@ -39,8 +39,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `groupName` - (Required) Name of the Availability Zone Group. * `optInStatus` - (Required) Indicates whether to enable or disable Availability Zone Group. Valid values: `opted-in` or `not-opted-in`. @@ -82,4 +83,4 @@ Using `terraform import`, import EC2 Availability Zone Groups using the group na % terraform import aws_ec2_availability_zone_group.example us-west-2-lax-1 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ec2_capacity_block_reservation.html.markdown b/website/docs/cdktf/typescript/r/ec2_capacity_block_reservation.html.markdown index 1888438564f1..f5d6a119ae2c 100644 --- a/website/docs/cdktf/typescript/r/ec2_capacity_block_reservation.html.markdown +++ b/website/docs/cdktf/typescript/r/ec2_capacity_block_reservation.html.markdown @@ -54,6 +54,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `capacityBlockOfferingId` - (Required) The Capacity Block Reservation ID. * `instancePlatform` - (Required) The type of operating system for which to reserve capacity. Valid options are `Linux/UNIX`, `Red Hat Enterprise Linux`, `SUSE Linux`, `Windows`, `Windows with SQL Server`, `Windows with SQL Server Enterprise`, `Windows with SQL Server Standard` or `Windows with SQL Server Web`. * `tags` - (Optional) A map of tags to assign to the resource. If configured with a provider [`defaultTags` 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. @@ -78,4 +79,4 @@ This resource exports the following attributes in addition to the arguments abov * `tenancy` - Indicates the tenancy of the Capacity Block Reservation. Specify either `default` or `dedicated`. * `tagsAll` - A map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ec2_capacity_reservation.html.markdown b/website/docs/cdktf/typescript/r/ec2_capacity_reservation.html.markdown index 2ca2d3b82f46..f59fbb70a71f 100644 --- a/website/docs/cdktf/typescript/r/ec2_capacity_reservation.html.markdown +++ b/website/docs/cdktf/typescript/r/ec2_capacity_reservation.html.markdown @@ -41,6 +41,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `availabilityZone` - (Required) The Availability Zone in which to create the Capacity Reservation. * `ebsOptimized` - (Optional) Indicates whether the Capacity Reservation supports EBS-optimized instances. * `endDate` - (Optional) The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity is released and you can no longer launch instances into it. Valid values: [RFC3339 time string](https://tools.ietf.org/html/rfc3339#section-5.8) (`YYYY-MM-DDTHH:MM:SSZ`) @@ -104,4 +105,4 @@ Using `terraform import`, import Capacity Reservations using the `id`. For examp % terraform import aws_ec2_capacity_reservation.web cr-0123456789abcdef0 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ec2_carrier_gateway.html.markdown b/website/docs/cdktf/typescript/r/ec2_carrier_gateway.html.markdown index c56c60470a36..c4b9538e5127 100644 --- a/website/docs/cdktf/typescript/r/ec2_carrier_gateway.html.markdown +++ b/website/docs/cdktf/typescript/r/ec2_carrier_gateway.html.markdown @@ -41,6 +41,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `tags` - (Optional) A map of tags to assign to the resource. If configured with a provider [`defaultTags` 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. * `vpcId` - (Required) The ID of the VPC to associate with the carrier gateway. @@ -81,4 +82,4 @@ Using `terraform import`, import `aws_ec2_carrier_gateway` using the carrier gat % terraform import aws_ec2_carrier_gateway.example cgw-12345 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ec2_client_vpn_authorization_rule.html.markdown b/website/docs/cdktf/typescript/r/ec2_client_vpn_authorization_rule.html.markdown index 2321ed8c629a..83e08d05fa2f 100644 --- a/website/docs/cdktf/typescript/r/ec2_client_vpn_authorization_rule.html.markdown +++ b/website/docs/cdktf/typescript/r/ec2_client_vpn_authorization_rule.html.markdown @@ -41,6 +41,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `clientVpnEndpointId` - (Required) The ID of the Client VPN endpoint. * `targetNetworkCidr` - (Required) The IPv4 address range, in CIDR notation, of the network to which the authorization rule applies. * `accessGroupId` - (Optional) The ID of the group to which the authorization rule grants access. One of `accessGroupId` or `authorizeAllGroups` must be set. @@ -124,4 +125,4 @@ Using the endpoint ID, target network CIDR, and group name: % terraform import aws_ec2_client_vpn_authorization_rule.example cvpn-endpoint-0ac3a1abbccddd666,10.1.0.0/24,team-a ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ec2_client_vpn_endpoint.html.markdown b/website/docs/cdktf/typescript/r/ec2_client_vpn_endpoint.html.markdown index b8066cdfe2cc..17cb549e13b2 100644 --- a/website/docs/cdktf/typescript/r/ec2_client_vpn_endpoint.html.markdown +++ b/website/docs/cdktf/typescript/r/ec2_client_vpn_endpoint.html.markdown @@ -52,21 +52,24 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `authenticationOptions` - (Required) Information about the authentication method to be used to authenticate clients. -* `clientCidrBlock` - (Required) The IPv4 address range, in CIDR notation, from which to assign client IP addresses. The address range cannot overlap with the local CIDR of the VPC in which the associated subnet is located, or the routes that you add manually. The address range cannot be changed after the Client VPN endpoint has been created. The CIDR block should be /22 or greater. +* `clientCidrBlock` - (Optional) The IPv4 address range, in CIDR notation, from which to assign client IP addresses. The address range cannot overlap with the local CIDR of the VPC in which the associated subnet is located, or the routes that you add manually. The address range cannot be changed after the Client VPN endpoint has been created. The CIDR block should be /22 or greater. When `trafficIpAddressType` is set to `ipv6`, it must not be specified. Otherwise, it is required. * `clientConnectOptions` - (Optional) The options for managing connection authorization for new client connections. * `clientLoginBannerOptions` - (Optional) Options for enabling a customizable text banner that will be displayed on AWS provided clients when a VPN session is established. -* `client_route_enforcement_options` - (Optional) Options for enforce administrator defined routes on devices connected through the VPN. +* `clientRouteEnforcementOptions` - (Optional) Options for enforce administrator defined routes on devices connected through the VPN. * `connectionLogOptions` - (Required) Information about the client connection logging options. * `description` - (Optional) A brief description of the Client VPN endpoint. * `disconnectOnSessionTimeout` - (Optional) Indicates whether the client VPN session is disconnected after the maximum `sessionTimeoutHours` is reached. If `true`, users are prompted to reconnect client VPN. If `false`, client VPN attempts to reconnect automatically. The default value is `false`. * `dnsServers` - (Optional) Information about the DNS servers to be used for DNS resolution. A Client VPN endpoint can have up to two DNS servers. If no DNS server is specified, the DNS address of the connecting device is used. +* `endpointIpAddressType` - (Optional) IP address type for the Client VPN endpoint. Valid values are `ipv4`, `ipv6`, or `dual-stack`. Defaults to `ipv4`. * `securityGroupIds` - (Optional) The IDs of one or more security groups to apply to the target network. You must also specify the ID of the VPC that contains the security groups. * `selfServicePortal` - (Optional) Specify whether to enable the self-service portal for the Client VPN endpoint. Values can be `enabled` or `disabled`. Default value is `disabled`. * `serverCertificateArn` - (Required) The ARN of the ACM server certificate. * `sessionTimeoutHours` - (Optional) The maximum session duration is a trigger by which end-users are required to re-authenticate prior to establishing a VPN session. Default value is `24` - Valid values: `8 | 10 | 12 | 24` * `splitTunnel` - (Optional) Indicates whether split-tunnel is enabled on VPN endpoint. Default value is `false`. * `tags` - (Optional) A mapping of tags to assign to the resource. If configured with a provider [`defaultTags` 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. +* `trafficIpAddressType` - (Optional) IP address type for traffic within the Client VPN tunnel. Valid values are `ipv4`, `ipv6`, or `dual-stack`. Defaults to `ipv4`. When it is set to `ipv6`, `clientCidrBlock` must not be specified. * `transportProtocol` - (Optional) The transport protocol to be used by the VPN session. Default value is `udp`. * `vpcId` - (Optional) The ID of the VPC to associate with the Client VPN endpoint. If no security group IDs are specified in the request, the default security group for the VPC is applied. * `vpnPort` - (Optional) The port number for the Client VPN endpoint. Valid values are `443` and `1194`. Default value is `443`. @@ -91,7 +94,7 @@ One of the following arguments must be supplied: * `bannerText` - (Optional) Customizable text that will be displayed in a banner on AWS provided clients when a VPN session is established. UTF-8 encoded characters only. Maximum of 1400 characters. * `enabled` - (Optional) Enable or disable a customizable text banner that will be displayed on AWS provided clients when a VPN session is established. The default is `false` (not enabled). -### `client_route_enforcement_options` Argument reference +### `clientRouteEnforcementOptions` Argument reference * `enforced` - (Optional) Enable or disable Client Route Enforcement. The default is `false` (not enabled). @@ -145,4 +148,4 @@ Using `terraform import`, import AWS Client VPN endpoints using the `id` value f % terraform import aws_ec2_client_vpn_endpoint.example cvpn-endpoint-0ac3a1abbccddd666 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ec2_client_vpn_network_association.html.markdown b/website/docs/cdktf/typescript/r/ec2_client_vpn_network_association.html.markdown index 2debd8dd3511..f3d4e49e93de 100644 --- a/website/docs/cdktf/typescript/r/ec2_client_vpn_network_association.html.markdown +++ b/website/docs/cdktf/typescript/r/ec2_client_vpn_network_association.html.markdown @@ -40,6 +40,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `clientVpnEndpointId` - (Required) The ID of the Client VPN endpoint. * `subnetId` - (Required) The ID of the subnet to associate with the Client VPN endpoint. @@ -90,4 +91,4 @@ Using `terraform import`, import AWS Client VPN network associations using the e % terraform import aws_ec2_client_vpn_network_association.example cvpn-endpoint-0ac3a1abbccddd666,cvpn-assoc-0b8db902465d069ad ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ec2_client_vpn_route.html.markdown b/website/docs/cdktf/typescript/r/ec2_client_vpn_route.html.markdown index 856e2b4d5dc0..68808a5a3290 100644 --- a/website/docs/cdktf/typescript/r/ec2_client_vpn_route.html.markdown +++ b/website/docs/cdktf/typescript/r/ec2_client_vpn_route.html.markdown @@ -72,6 +72,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `clientVpnEndpointId` - (Required) The ID of the Client VPN endpoint. * `destinationCidrBlock` - (Required) The IPv4 address range, in CIDR notation, of the route destination. * `description` - (Optional) A brief description of the route. @@ -124,4 +125,4 @@ Using `terraform import`, import AWS Client VPN routes using the endpoint ID, ta % terraform import aws_ec2_client_vpn_route.example cvpn-endpoint-1234567890abcdef,subnet-9876543210fedcba,10.1.0.0/24 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ec2_default_credit_specification.html.markdown b/website/docs/cdktf/typescript/r/ec2_default_credit_specification.html.markdown index 5ef055a7306d..07135273d4ab 100644 --- a/website/docs/cdktf/typescript/r/ec2_default_credit_specification.html.markdown +++ b/website/docs/cdktf/typescript/r/ec2_default_credit_specification.html.markdown @@ -23,13 +23,13 @@ import { TerraformStack } from "cdktf"; * Provider bindings are generated by running `cdktf get`. * See https://cdk.tf/provider-generation for more details. */ -import { Ec2DefaultCreditSpecification } from "./.gen/providers/aws/"; +import { Ec2DefaultCreditSpecification } from "./.gen/providers/aws/ec2-default-credit-specification"; class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); new Ec2DefaultCreditSpecification(this, "example", { - cpu_credits: "standard", - instance_family: "t2", + cpuCredits: "standard", + instanceFamily: "t2", }); } } @@ -38,8 +38,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `cpuCredits` - (Required) Credit option for CPU usage of the instance family. Valid values: `standard`, `unlimited`. * `instanceFamily` - (Required) Instance family. Valid values are `t2`, `t3`, `t3a`, `t4g`. @@ -66,7 +67,7 @@ import { TerraformStack } from "cdktf"; * Provider bindings are generated by running `cdktf get`. * See https://cdk.tf/provider-generation for more details. */ -import { Ec2DefaultCreditSpecification } from "./.gen/providers/aws/"; +import { Ec2DefaultCreditSpecification } from "./.gen/providers/aws/ec2-default-credit-specification"; class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); @@ -85,4 +86,4 @@ Using `terraform import`, import EC2 (Elastic Compute Cloud) Default Credit Spec ```console % terraform import aws_ec2_default_credit_specification.example t2 - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ec2_fleet.html.markdown b/website/docs/cdktf/typescript/r/ec2_fleet.html.markdown index 392b453d7ffc..5d6187efee15 100644 --- a/website/docs/cdktf/typescript/r/ec2_fleet.html.markdown +++ b/website/docs/cdktf/typescript/r/ec2_fleet.html.markdown @@ -49,6 +49,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `context` - (Optional) Reserved. * `excessCapacityTerminationPolicy` - (Optional) Whether running instances should be terminated if the total target capacity of the EC2 Fleet is decreased below the current size of the EC2. Valid values: `no-termination`, `termination`. Defaults to `termination`. Supported only for fleets of type `maintain`. * `launchTemplateConfig` - (Required) Nested argument containing EC2 Launch Template configurations. Defined below. @@ -290,4 +291,4 @@ Using `terraform import`, import `aws_ec2_fleet` using the Fleet identifier. For % terraform import aws_ec2_fleet.example fleet-b9b55d27-c5fc-41ac-a6f3-48fcc91f080c ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ec2_host.html.markdown b/website/docs/cdktf/typescript/r/ec2_host.html.markdown index d616a208c743..5c118209122b 100644 --- a/website/docs/cdktf/typescript/r/ec2_host.html.markdown +++ b/website/docs/cdktf/typescript/r/ec2_host.html.markdown @@ -41,6 +41,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `assetId` - (Optional) The ID of the Outpost hardware asset on which to allocate the Dedicated Hosts. This parameter is supported only if you specify OutpostArn. If you are allocating the Dedicated Hosts in a Region, omit this parameter. * `autoPlacement` - (Optional) Indicates whether the host accepts any untargeted instance launches that match its instance type configuration, or if it only accepts Host tenancy instance launches that specify its unique host ID. Valid values: `on`, `off`. Default: `on`. * `availabilityZone` - (Required) The Availability Zone in which to allocate the Dedicated Host. @@ -95,4 +96,4 @@ Using `terraform import`, import hosts using the host `id`. For example: % terraform import aws_ec2_host.example h-0385a99d0e4b20cbb ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ec2_instance_connect_endpoint.html.markdown b/website/docs/cdktf/typescript/r/ec2_instance_connect_endpoint.html.markdown index ec30d68ec29c..8d0ffab573c2 100644 --- a/website/docs/cdktf/typescript/r/ec2_instance_connect_endpoint.html.markdown +++ b/website/docs/cdktf/typescript/r/ec2_instance_connect_endpoint.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `preserveClientIp` - (Optional) Indicates whether your client's IP address is preserved as the source. Default: `true`. * `securityGroupIds` - (Optional) One or more security groups to associate with the endpoint. If you don't specify a security group, the default security group for the VPC will be associated with the endpoint. * `subnetId` - (Required) The ID of the subnet in which to create the EC2 Instance Connect Endpoint. @@ -95,4 +96,4 @@ Using `terraform import`, import EC2 Instance Connect Endpoints using the `id`. % terraform import aws_ec2_instance_connect_endpoint.example eice-012345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ec2_instance_metadata_defaults.html.markdown b/website/docs/cdktf/typescript/r/ec2_instance_metadata_defaults.html.markdown index dbecc0455417..548e4a2cc3b3 100644 --- a/website/docs/cdktf/typescript/r/ec2_instance_metadata_defaults.html.markdown +++ b/website/docs/cdktf/typescript/r/ec2_instance_metadata_defaults.html.markdown @@ -40,6 +40,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `httpEndpoint` - (Optional) Whether the metadata service is available. Can be `"enabled"`, `"disabled"`, or `"no-preference"`. Default: `"no-preference"`. * `httpTokens` - (Optional) Whether the metadata service requires session tokens, also referred to as _Instance Metadata Service Version 2 (IMDSv2)_. Can be `"optional"`, `"required"`, or `"no-preference"`. Default: `"no-preference"`. * `httpPutResponseHopLimit` - (Optional) The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel. Can be an integer from `1` to `64`, or `-1` to indicate no preference. Default: `-1`. @@ -53,4 +54,4 @@ This data source exports no additional attributes. You cannot import this resource. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ec2_instance_state.html.markdown b/website/docs/cdktf/typescript/r/ec2_instance_state.html.markdown index 5faee798065e..493e606fe5eb 100644 --- a/website/docs/cdktf/typescript/r/ec2_instance_state.html.markdown +++ b/website/docs/cdktf/typescript/r/ec2_instance_state.html.markdown @@ -71,6 +71,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `force` - (Optional) Whether to request a forced stop when `state` is `stopped`. Otherwise (_i.e._, `state` is `running`), ignored. When an instance is forced to stop, it does not flush file system caches or file system metadata, and you must subsequently perform file system check and repair. Not recommended for Windows instances. Defaults to `false`. ## Attribute Reference @@ -119,4 +120,4 @@ Using `terraform import`, import `aws_ec2_instance_state` using the `instanceId` % terraform import aws_ec2_instance_state.test i-02cae6557dfcf2f96 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ec2_local_gateway_route.html.markdown b/website/docs/cdktf/typescript/r/ec2_local_gateway_route.html.markdown index c8186c1b0025..2b7c89abe572 100644 --- a/website/docs/cdktf/typescript/r/ec2_local_gateway_route.html.markdown +++ b/website/docs/cdktf/typescript/r/ec2_local_gateway_route.html.markdown @@ -42,8 +42,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `destinationCidrBlock` - (Required) IPv4 CIDR range used for destination matches. Routing decisions are based on the most specific match. * `localGatewayRouteTableId` - (Required) Identifier of EC2 Local Gateway Route Table. * `localGatewayVirtualInterfaceGroupId` - (Required) Identifier of EC2 Local Gateway Virtual Interface Group. @@ -86,4 +87,4 @@ Using `terraform import`, import `aws_ec2_local_gateway_route` using the EC2 Loc % terraform import aws_ec2_local_gateway_route.example lgw-rtb-12345678_172.16.0.0/16 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ec2_local_gateway_route_table_vpc_association.html.markdown b/website/docs/cdktf/typescript/r/ec2_local_gateway_route_table_vpc_association.html.markdown index c7bae8d17e04..89b08bbaf376 100644 --- a/website/docs/cdktf/typescript/r/ec2_local_gateway_route_table_vpc_association.html.markdown +++ b/website/docs/cdktf/typescript/r/ec2_local_gateway_route_table_vpc_association.html.markdown @@ -63,6 +63,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `tags` - (Optional) Key-value map of resource tags. If configured with a provider [`defaultTags` 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. ## Attribute Reference @@ -104,4 +105,4 @@ Using `terraform import`, import `aws_ec2_local_gateway_route_table_vpc_associat % terraform import aws_ec2_local_gateway_route_table_vpc_association.example lgw-vpc-assoc-1234567890abcdef ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ec2_managed_prefix_list.html.markdown b/website/docs/cdktf/typescript/r/ec2_managed_prefix_list.html.markdown index 01e560dc2d7b..7c40d8e0512f 100644 --- a/website/docs/cdktf/typescript/r/ec2_managed_prefix_list.html.markdown +++ b/website/docs/cdktf/typescript/r/ec2_managed_prefix_list.html.markdown @@ -67,6 +67,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `addressFamily` - (Required, Forces new resource) Address family (`IPv4` or `IPv6`) of this prefix list. * `entry` - (Optional) Configuration block for prefix list entry. Detailed below. Different entries may have overlapping CIDR blocks, but a particular CIDR should not be duplicated. * `maxEntries` - (Required) Maximum number of entries that this prefix list can contain. @@ -120,4 +121,4 @@ Using `terraform import`, import Prefix Lists using the `id`. For example: % terraform import aws_ec2_managed_prefix_list.default pl-0570a1d2d725c16be ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ec2_managed_prefix_list_entry.html.markdown b/website/docs/cdktf/typescript/r/ec2_managed_prefix_list_entry.html.markdown index d2511ccde9c2..93dc9a43606f 100644 --- a/website/docs/cdktf/typescript/r/ec2_managed_prefix_list_entry.html.markdown +++ b/website/docs/cdktf/typescript/r/ec2_managed_prefix_list_entry.html.markdown @@ -55,6 +55,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `cidr` - (Required) CIDR block of this entry. * `description` - (Optional) Description of this entry. Please note that due to API limitations, updating only the description of an entry will require recreating the entry. * `prefixListId` - (Required) The ID of the prefix list. @@ -97,4 +98,4 @@ Using `terraform import`, import prefix list entries using `prefixListId` and `c % terraform import aws_ec2_managed_prefix_list_entry.default pl-0570a1d2d725c16be,10.0.3.0/24 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ec2_network_insights_analysis.html.markdown b/website/docs/cdktf/typescript/r/ec2_network_insights_analysis.html.markdown index 61b693447e39..2a885042be6b 100644 --- a/website/docs/cdktf/typescript/r/ec2_network_insights_analysis.html.markdown +++ b/website/docs/cdktf/typescript/r/ec2_network_insights_analysis.html.markdown @@ -48,6 +48,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `filterInArns` - (Optional) A list of ARNs for resources the path must traverse. * `waitForCompletion` - (Optional) If enabled, the resource will wait for the Network Insights Analysis status to change to `succeeded` or `failed`. Setting this to `false` will skip the process. Default: `true`. * `tags` - (Optional) Map of tags to assign to the resource. If configured with a provider [`defaultTags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. @@ -106,4 +107,4 @@ Using `terraform import`, import Network Insights Analyzes using the `id`. For e % terraform import aws_ec2_network_insights_analysis.test nia-0462085c957f11a55 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ec2_network_insights_path.html.markdown b/website/docs/cdktf/typescript/r/ec2_network_insights_path.html.markdown index 339ea50aa308..b0d625e8d6f9 100644 --- a/website/docs/cdktf/typescript/r/ec2_network_insights_path.html.markdown +++ b/website/docs/cdktf/typescript/r/ec2_network_insights_path.html.markdown @@ -45,6 +45,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `sourceIp` - (Optional) IP address of the source resource. * `destination` - (Optional) ID or ARN of the resource which is the destination of the path. Can be an Instance, Internet Gateway, Network Interface, Transit Gateway, VPC Endpoint, VPC Peering Connection or VPN Gateway. If the resource is in another account, you must specify an ARN. Either the `destination` argument or the `destinationAddress` argument in the `filterAtSource` block must be specified. * `destinationIp` - (Optional) IP address of the destination resource. @@ -107,4 +108,4 @@ Using `terraform import`, import Network Insights Paths using the `id`. For exam % terraform import aws_ec2_network_insights_path.test nip-00edfba169923aefd ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ec2_serial_console_access.html.markdown b/website/docs/cdktf/typescript/r/ec2_serial_console_access.html.markdown index c539cbc3f028..2cc8695e5f39 100644 --- a/website/docs/cdktf/typescript/r/ec2_serial_console_access.html.markdown +++ b/website/docs/cdktf/typescript/r/ec2_serial_console_access.html.markdown @@ -40,6 +40,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `enabled` - (Optional) Whether or not serial console access is enabled. Valid values are `true` or `false`. Defaults to `true`. ## Attribute Reference @@ -74,4 +75,4 @@ Using `terraform import`, import serial console access state. For example: % terraform import aws_ec2_serial_console_access.example default ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ec2_subnet_cidr_reservation.html.markdown b/website/docs/cdktf/typescript/r/ec2_subnet_cidr_reservation.html.markdown index 84208ccefcc8..e80a809f3784 100644 --- a/website/docs/cdktf/typescript/r/ec2_subnet_cidr_reservation.html.markdown +++ b/website/docs/cdktf/typescript/r/ec2_subnet_cidr_reservation.html.markdown @@ -40,6 +40,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `cidrBlock` - (Required) The CIDR block for the reservation. * `reservationType` - (Required) The type of reservation to create. Valid values: `explicit`, `prefix` * `subnetId` - (Required) The ID of the subnet to create the reservation for. @@ -84,4 +85,4 @@ Using `terraform import`, import Existing CIDR reservations using `SUBNET_ID:RES % terraform import aws_ec2_subnet_cidr_reservation.example subnet-01llsxvsxabqiymcz:scr-4mnvz6wb7otksjcs9 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ec2_tag.html.markdown b/website/docs/cdktf/typescript/r/ec2_tag.html.markdown index a05b2069d1f5..ec214f42c465 100644 --- a/website/docs/cdktf/typescript/r/ec2_tag.html.markdown +++ b/website/docs/cdktf/typescript/r/ec2_tag.html.markdown @@ -70,6 +70,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `resourceId` - (Required) The ID of the EC2 resource to manage the tag for. * `key` - (Required) The tag name. * `value` - (Required) The value of the tag. @@ -112,4 +113,4 @@ Using `terraform import`, import `aws_ec2_tag` using the EC2 resource identifier % terraform import aws_ec2_tag.example tgw-attach-1234567890abcdef,Name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ec2_traffic_mirror_filter.html.markdown b/website/docs/cdktf/typescript/r/ec2_traffic_mirror_filter.html.markdown index c0b67362cb17..6379350b878d 100644 --- a/website/docs/cdktf/typescript/r/ec2_traffic_mirror_filter.html.markdown +++ b/website/docs/cdktf/typescript/r/ec2_traffic_mirror_filter.html.markdown @@ -42,6 +42,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `description` - (Optional, Forces new resource) A description of the filter. * `networkServices` - (Optional) List of amazon network services that should be mirrored. Valid values: `amazon-dns`. * `tags` - (Optional) Key-value map of resource tags. If configured with a provider [`defaultTags` 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. @@ -86,4 +87,4 @@ Using `terraform import`, import traffic mirror filter using the `id`. For examp % terraform import aws_ec2_traffic_mirror_filter.foo tmf-0fbb93ddf38198f64 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ec2_traffic_mirror_filter_rule.html.markdown b/website/docs/cdktf/typescript/r/ec2_traffic_mirror_filter_rule.html.markdown index 1fd52abea770..bc7892456eaa 100644 --- a/website/docs/cdktf/typescript/r/ec2_traffic_mirror_filter_rule.html.markdown +++ b/website/docs/cdktf/typescript/r/ec2_traffic_mirror_filter_rule.html.markdown @@ -70,6 +70,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `description` - (Optional) Description of the traffic mirror filter rule. * `trafficMirrorFilterId` - (Required) ID of the traffic mirror filter to which this rule should be added * `destinationCidrBlock` - (Required) Destination CIDR block to assign to the Traffic Mirror rule. @@ -125,4 +126,4 @@ Using `terraform import`, import traffic mirror rules using the `trafficMirrorFi % terraform import aws_ec2_traffic_mirror_filter_rule.rule tmf-0fbb93ddf38198f64:tmfr-05a458f06445d0aee ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ec2_traffic_mirror_session.html.markdown b/website/docs/cdktf/typescript/r/ec2_traffic_mirror_session.html.markdown index 6422c9ca9cf5..8b3d16e6860d 100644 --- a/website/docs/cdktf/typescript/r/ec2_traffic_mirror_session.html.markdown +++ b/website/docs/cdktf/typescript/r/ec2_traffic_mirror_session.html.markdown @@ -54,6 +54,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `description` - (Optional) A description of the traffic mirror session. * `networkInterfaceId` - (Required, Forces new) ID of the source network interface. Not all network interfaces are eligible as mirror sources. On EC2 instances only nitro based instances support mirroring. * `trafficMirrorFilterId` - (Required) ID of the traffic mirror filter to be used @@ -104,4 +105,4 @@ Using `terraform import`, import traffic mirror sessions using the `id`. For exa % terraform import aws_ec2_traffic_mirror_session.session tms-0d8aa3ca35897b82e ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ec2_traffic_mirror_target.html.markdown b/website/docs/cdktf/typescript/r/ec2_traffic_mirror_target.html.markdown index 2bdc130fc1bf..842c79babf63 100644 --- a/website/docs/cdktf/typescript/r/ec2_traffic_mirror_target.html.markdown +++ b/website/docs/cdktf/typescript/r/ec2_traffic_mirror_target.html.markdown @@ -50,6 +50,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `description` - (Optional, Forces new) A description of the traffic mirror session. * `networkInterfaceId` - (Optional, Forces new) The network interface ID that is associated with the target. * `networkLoadBalancerArn` - (Optional, Forces new) The Amazon Resource Name (ARN) of the Network Load Balancer that is associated with the target. @@ -99,4 +100,4 @@ Using `terraform import`, import traffic mirror targets using the `id`. For exam % terraform import aws_ec2_traffic_mirror_target.target tmt-0c13a005422b86606 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ec2_transit_gateway.html.markdown b/website/docs/cdktf/typescript/r/ec2_transit_gateway.html.markdown index ccbeef69f6ca..dfc96fe4f010 100644 --- a/website/docs/cdktf/typescript/r/ec2_transit_gateway.html.markdown +++ b/website/docs/cdktf/typescript/r/ec2_transit_gateway.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `amazonSideAsn` - (Optional) Private Autonomous System Number (ASN) for the Amazon side of a BGP session. The range is `64512` to `65534` for 16-bit ASNs and `4200000000` to `4294967294` for 32-bit ASNs. Default value: `64512`. -> **NOTE:** Modifying `amazonSideAsn` on a Transit Gateway with active BGP sessions is [not allowed](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyTransitGatewayOptions.html). You must first delete all Transit Gateway attachments that have BGP configured prior to modifying `amazonSideAsn`. @@ -100,4 +101,4 @@ Using `terraform import`, import `aws_ec2_transit_gateway` using the EC2 Transit % terraform import aws_ec2_transit_gateway.example tgw-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ec2_transit_gateway_connect.html.markdown b/website/docs/cdktf/typescript/r/ec2_transit_gateway_connect.html.markdown index dae24a198b4e..eae646a35634 100644 --- a/website/docs/cdktf/typescript/r/ec2_transit_gateway_connect.html.markdown +++ b/website/docs/cdktf/typescript/r/ec2_transit_gateway_connect.html.markdown @@ -45,6 +45,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `protocol` - (Optional) The tunnel protocol. Valid values: `gre`. Default is `gre`. * `tags` - (Optional) Key-value tags for the EC2 Transit Gateway Connect. If configured with a provider [`defaultTags` 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. * `transitGatewayDefaultRouteTableAssociation` - (Optional) Boolean whether the Connect should be associated with the EC2 Transit Gateway association default route table. This cannot be configured or perform drift detection with Resource Access Manager shared EC2 Transit Gateways. Default value: `true`. @@ -99,4 +100,4 @@ Using `terraform import`, import `aws_ec2_transit_gateway_connect` using the EC2 % terraform import aws_ec2_transit_gateway_connect.example tgw-attach-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ec2_transit_gateway_connect_peer.html.markdown b/website/docs/cdktf/typescript/r/ec2_transit_gateway_connect_peer.html.markdown index c8332f7205df..7508bb337f54 100644 --- a/website/docs/cdktf/typescript/r/ec2_transit_gateway_connect_peer.html.markdown +++ b/website/docs/cdktf/typescript/r/ec2_transit_gateway_connect_peer.html.markdown @@ -50,6 +50,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `bgpAsn` - (Optional) The BGP ASN number assigned customer device. If not provided, it will use the same BGP ASN as is associated with Transit Gateway. * `insideCidrBlocks` - (Required) The CIDR block that will be used for addressing within the tunnel. It must contain exactly one IPv4 CIDR block and up to one IPv6 CIDR block. The IPv4 CIDR block must be /29 size and must be within 169.254.0.0/16 range, with exception of: 169.254.0.0/29, 169.254.1.0/29, 169.254.2.0/29, 169.254.3.0/29, 169.254.4.0/29, 169.254.5.0/29, 169.254.169.248/29. The IPv6 CIDR block must be /125 size and must be within fd00::/8. The first IP from each CIDR block is assigned for customer gateway, the second and third is for Transit Gateway (An example: from range 169.254.100.0/29, .1 is assigned to customer gateway and .2 and .3 are assigned to Transit Gateway) * `peerAddress` - (Required) The IP addressed assigned to customer device, which will be used as tunnel endpoint. It can be IPv4 or IPv6 address, but must be the same address family as `transitGatewayAddress` @@ -106,4 +107,4 @@ Using `terraform import`, import `aws_ec2_transit_gateway_connect_peer` using th % terraform import aws_ec2_transit_gateway_connect_peer.example tgw-connect-peer-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ec2_transit_gateway_default_route_table_association.html.markdown b/website/docs/cdktf/typescript/r/ec2_transit_gateway_default_route_table_association.html.markdown index e85dd9e8ae12..b6d371de81e2 100644 --- a/website/docs/cdktf/typescript/r/ec2_transit_gateway_default_route_table_association.html.markdown +++ b/website/docs/cdktf/typescript/r/ec2_transit_gateway_default_route_table_association.html.markdown @@ -40,8 +40,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `transitGatewayId` - (Required) ID of the Transit Gateway to change the default association route table on. * `transitGatewayRouteTableId` - (Required) ID of the Transit Gateway Route Table to be made the default association route table. @@ -57,4 +58,4 @@ This resource exports no additional attributes. * `update` - (Default `5m`) * `delete` - (Default `5m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ec2_transit_gateway_default_route_table_propagation.html.markdown b/website/docs/cdktf/typescript/r/ec2_transit_gateway_default_route_table_propagation.html.markdown index 293f34c850b2..e5dbdda6fc4a 100644 --- a/website/docs/cdktf/typescript/r/ec2_transit_gateway_default_route_table_propagation.html.markdown +++ b/website/docs/cdktf/typescript/r/ec2_transit_gateway_default_route_table_propagation.html.markdown @@ -40,8 +40,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `transitGatewayId` - (Required) ID of the Transit Gateway to change the default association route table on. * `transitGatewayRouteTableId` - (Required) ID of the Transit Gateway Route Table to be made the default association route table. @@ -57,4 +58,4 @@ This resource exports no additional attributes. * `update` - (Default `5m`) * `delete` - (Default `5m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ec2_transit_gateway_multicast_domain.html.markdown b/website/docs/cdktf/typescript/r/ec2_transit_gateway_multicast_domain.html.markdown index 204eb115a992..85d463a96093 100644 --- a/website/docs/cdktf/typescript/r/ec2_transit_gateway_multicast_domain.html.markdown +++ b/website/docs/cdktf/typescript/r/ec2_transit_gateway_multicast_domain.html.markdown @@ -167,6 +167,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `transitGatewayId` - (Required) EC2 Transit Gateway identifier. The EC2 Transit Gateway must have `multicastSupport` enabled. * `autoAcceptSharedAssociations` - (Optional) Whether to automatically accept cross-account subnet associations that are associated with the EC2 Transit Gateway Multicast Domain. Valid values: `disable`, `enable`. Default value: `disable`. * `igmpv2Support` - (Optional) Whether to enable Internet Group Management Protocol (IGMP) version 2 for the EC2 Transit Gateway Multicast Domain. Valid values: `disable`, `enable`. Default value: `disable`. @@ -221,4 +222,4 @@ Using `terraform import`, import `aws_ec2_transit_gateway_multicast_domain` usin % terraform import aws_ec2_transit_gateway_multicast_domain.example tgw-mcast-domain-12345 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ec2_transit_gateway_multicast_domain_association.html.markdown b/website/docs/cdktf/typescript/r/ec2_transit_gateway_multicast_domain_association.html.markdown index 66554522bdfc..09a58f31b89b 100644 --- a/website/docs/cdktf/typescript/r/ec2_transit_gateway_multicast_domain_association.html.markdown +++ b/website/docs/cdktf/typescript/r/ec2_transit_gateway_multicast_domain_association.html.markdown @@ -69,6 +69,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `subnetId` - (Required) The ID of the subnet to associate with the transit gateway multicast domain. * `transitGatewayAttachmentId` - (Required) The ID of the transit gateway attachment. * `transitGatewayMulticastDomainId` - (Required) The ID of the transit gateway multicast domain. @@ -86,4 +87,4 @@ This resource exports the following attributes in addition to the arguments abov - `create` - (Default `10m`) - `delete` - (Default `10m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ec2_transit_gateway_multicast_group_member.html.markdown b/website/docs/cdktf/typescript/r/ec2_transit_gateway_multicast_group_member.html.markdown index cf0ceda246e4..71093d53ad16 100644 --- a/website/docs/cdktf/typescript/r/ec2_transit_gateway_multicast_group_member.html.markdown +++ b/website/docs/cdktf/typescript/r/ec2_transit_gateway_multicast_group_member.html.markdown @@ -43,6 +43,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `groupIpAddress` - (Required) The IP address assigned to the transit gateway multicast group. * `networkInterfaceId` - (Required) The group members' network interface ID to register with the transit gateway multicast group. * `transitGatewayMulticastDomainId` - (Required) The ID of the transit gateway multicast domain. @@ -53,4 +54,4 @@ This resource exports the following attributes in addition to the arguments abov * `id` - EC2 Transit Gateway Multicast Group Member identifier. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ec2_transit_gateway_multicast_group_source.html.markdown b/website/docs/cdktf/typescript/r/ec2_transit_gateway_multicast_group_source.html.markdown index b96cd36bbf26..21cde8f66751 100644 --- a/website/docs/cdktf/typescript/r/ec2_transit_gateway_multicast_group_source.html.markdown +++ b/website/docs/cdktf/typescript/r/ec2_transit_gateway_multicast_group_source.html.markdown @@ -43,6 +43,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `groupIpAddress` - (Required) The IP address assigned to the transit gateway multicast group. * `networkInterfaceId` - (Required) The group members' network interface ID to register with the transit gateway multicast group. * `transitGatewayMulticastDomainId` - (Required) The ID of the transit gateway multicast domain. @@ -53,4 +54,4 @@ This resource exports the following attributes in addition to the arguments abov * `id` - EC2 Transit Gateway Multicast Group Member identifier. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ec2_transit_gateway_peering_attachment.html.markdown b/website/docs/cdktf/typescript/r/ec2_transit_gateway_peering_attachment.html.markdown index 71c7f5610615..6ca9151af13b 100644 --- a/website/docs/cdktf/typescript/r/ec2_transit_gateway_peering_attachment.html.markdown +++ b/website/docs/cdktf/typescript/r/ec2_transit_gateway_peering_attachment.html.markdown @@ -75,6 +75,7 @@ A full example of how to create a Transit Gateway in one AWS account, share it w This resource supports the following arguments: +* `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). * `peerAccountId` - (Optional) Account ID of EC2 Transit Gateway to peer with. Defaults to the account ID the [AWS provider][1] is currently connected to. * `peerRegion` - (Required) Region of EC2 Transit Gateway to peer with. * `peerTransitGatewayId` - (Required) Identifier of EC2 Transit Gateway to peer with. @@ -130,4 +131,4 @@ Using `terraform import`, import `aws_ec2_transit_gateway_peering_attachment` us [1]: /docs/providers/aws/index.html - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ec2_transit_gateway_peering_attachment_accepter.html.markdown b/website/docs/cdktf/typescript/r/ec2_transit_gateway_peering_attachment_accepter.html.markdown index f96751abffd1..a0a107361536 100644 --- a/website/docs/cdktf/typescript/r/ec2_transit_gateway_peering_attachment_accepter.html.markdown +++ b/website/docs/cdktf/typescript/r/ec2_transit_gateway_peering_attachment_accepter.html.markdown @@ -45,6 +45,7 @@ A full example of how to create a Transit Gateway in one AWS account, share it w This resource supports the following arguments: +* `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). * `transitGatewayAttachmentId` - (Required) The ID of the EC2 Transit Gateway Peering Attachment to manage. * `tags` - (Optional) Key-value tags for the EC2 Transit Gateway Peering Attachment. If configured with a provider [`defaultTags` 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. @@ -90,4 +91,4 @@ Using `terraform import`, import `aws_ec2_transit_gateway_peering_attachment_acc % terraform import aws_ec2_transit_gateway_peering_attachment_accepter.example tgw-attach-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ec2_transit_gateway_policy_table.html.markdown b/website/docs/cdktf/typescript/r/ec2_transit_gateway_policy_table.html.markdown index 13654a173356..805503f528a5 100644 --- a/website/docs/cdktf/typescript/r/ec2_transit_gateway_policy_table.html.markdown +++ b/website/docs/cdktf/typescript/r/ec2_transit_gateway_policy_table.html.markdown @@ -41,6 +41,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `transitGatewayId` - (Required) EC2 Transit Gateway identifier. * `tags` - (Optional) Key-value tags for the EC2 Transit Gateway Policy Table. If configured with a provider [`defaultTags` 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. @@ -85,4 +86,4 @@ Using `terraform import`, import `aws_ec2_transit_gateway_policy_table` using th % terraform import aws_ec2_transit_gateway_policy_table.example tgw-rtb-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ec2_transit_gateway_policy_table_association.html.markdown b/website/docs/cdktf/typescript/r/ec2_transit_gateway_policy_table_association.html.markdown index 4f80b03da28c..eeb004426610 100644 --- a/website/docs/cdktf/typescript/r/ec2_transit_gateway_policy_table_association.html.markdown +++ b/website/docs/cdktf/typescript/r/ec2_transit_gateway_policy_table_association.html.markdown @@ -43,6 +43,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `transitGatewayAttachmentId` - (Required) Identifier of EC2 Transit Gateway Attachment. * `transitGatewayPolicyTableId` - (Required) Identifier of EC2 Transit Gateway Policy Table. @@ -86,4 +87,4 @@ Using `terraform import`, import `aws_ec2_transit_gateway_policy_table_associati % terraform import aws_ec2_transit_gateway_policy_table_association.example tgw-rtb-12345678_tgw-attach-87654321 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ec2_transit_gateway_prefix_list_reference.html.markdown b/website/docs/cdktf/typescript/r/ec2_transit_gateway_prefix_list_reference.html.markdown index 4c6055b56016..e7ce96dcee1b 100644 --- a/website/docs/cdktf/typescript/r/ec2_transit_gateway_prefix_list_reference.html.markdown +++ b/website/docs/cdktf/typescript/r/ec2_transit_gateway_prefix_list_reference.html.markdown @@ -77,6 +77,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `blackhole` - (Optional) Indicates whether to drop traffic that matches the Prefix List. Defaults to `false`. * `transitGatewayAttachmentId` - (Optional) Identifier of EC2 Transit Gateway Attachment. @@ -118,4 +119,4 @@ Using `terraform import`, import `aws_ec2_transit_gateway_prefix_list_reference` % terraform import aws_ec2_transit_gateway_prefix_list_reference.example tgw-rtb-12345678_pl-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ec2_transit_gateway_route.html.markdown b/website/docs/cdktf/typescript/r/ec2_transit_gateway_route.html.markdown index 7c6d917cdba5..099258015857 100644 --- a/website/docs/cdktf/typescript/r/ec2_transit_gateway_route.html.markdown +++ b/website/docs/cdktf/typescript/r/ec2_transit_gateway_route.html.markdown @@ -72,6 +72,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `destinationCidrBlock` - (Required) IPv4 or IPv6 RFC1924 CIDR used for destination matches. Routing decisions are based on the most specific match. * `transitGatewayAttachmentId` - (Optional) Identifier of EC2 Transit Gateway Attachment (required if `blackhole` is set to false). * `blackhole` - (Optional) Indicates whether to drop traffic that matches this route (default to `false`). @@ -115,4 +116,4 @@ Using `terraform import`, import `aws_ec2_transit_gateway_route` using the EC2 T % terraform import aws_ec2_transit_gateway_route.example tgw-rtb-12345678_0.0.0.0/0 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ec2_transit_gateway_route_table.html.markdown b/website/docs/cdktf/typescript/r/ec2_transit_gateway_route_table.html.markdown index 0cee01d7a198..b80f8e0fecae 100644 --- a/website/docs/cdktf/typescript/r/ec2_transit_gateway_route_table.html.markdown +++ b/website/docs/cdktf/typescript/r/ec2_transit_gateway_route_table.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `transitGatewayId` - (Required) Identifier of EC2 Transit Gateway. * `tags` - (Optional) Key-value tags for the EC2 Transit Gateway Route Table. If configured with a provider [`defaultTags` 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. @@ -83,4 +84,4 @@ Using `terraform import`, import `aws_ec2_transit_gateway_route_table` using the % terraform import aws_ec2_transit_gateway_route_table.example tgw-rtb-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ec2_transit_gateway_route_table_association.html.markdown b/website/docs/cdktf/typescript/r/ec2_transit_gateway_route_table_association.html.markdown index 0a9cde346637..2b4d3d9a1f4f 100644 --- a/website/docs/cdktf/typescript/r/ec2_transit_gateway_route_table_association.html.markdown +++ b/website/docs/cdktf/typescript/r/ec2_transit_gateway_route_table_association.html.markdown @@ -43,6 +43,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `transitGatewayAttachmentId` - (Required) Identifier of EC2 Transit Gateway Attachment. * `transitGatewayRouteTableId` - (Required) Identifier of EC2 Transit Gateway Route Table. * `replaceExistingAssociation` - (Optional) Boolean whether the Gateway Attachment should remove any current Route Table association before associating with the specified Route Table. Default value: `false`. This argument is intended for use with EC2 Transit Gateways shared into the current account, otherwise the `transitGatewayDefaultRouteTableAssociation` argument of the `aws_ec2_transit_gateway_vpc_attachment` resource should be used. @@ -87,4 +88,4 @@ Using `terraform import`, import `aws_ec2_transit_gateway_route_table_associatio % terraform import aws_ec2_transit_gateway_route_table_association.example tgw-rtb-12345678_tgw-attach-87654321 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ec2_transit_gateway_route_table_propagation.html.markdown b/website/docs/cdktf/typescript/r/ec2_transit_gateway_route_table_propagation.html.markdown index 0a514f736073..43011f87178e 100644 --- a/website/docs/cdktf/typescript/r/ec2_transit_gateway_route_table_propagation.html.markdown +++ b/website/docs/cdktf/typescript/r/ec2_transit_gateway_route_table_propagation.html.markdown @@ -43,6 +43,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `transitGatewayAttachmentId` - (Required) Identifier of EC2 Transit Gateway Attachment. * `transitGatewayRouteTableId` - (Required) Identifier of EC2 Transit Gateway Route Table. @@ -86,4 +87,4 @@ Using `terraform import`, import `aws_ec2_transit_gateway_route_table_propagatio % terraform import aws_ec2_transit_gateway_route_table_propagation.example tgw-rtb-12345678_tgw-attach-87654321 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ec2_transit_gateway_vpc_attachment.html.markdown b/website/docs/cdktf/typescript/r/ec2_transit_gateway_vpc_attachment.html.markdown index c0d62d4a0e62..be00a2b9cd5a 100644 --- a/website/docs/cdktf/typescript/r/ec2_transit_gateway_vpc_attachment.html.markdown +++ b/website/docs/cdktf/typescript/r/ec2_transit_gateway_vpc_attachment.html.markdown @@ -42,6 +42,7 @@ A full example of how to create a Transit Gateway in one AWS account, share it w This resource supports the following arguments: +* `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). * `subnetIds` - (Required) Identifiers of EC2 Subnets. * `transitGatewayId` - (Required) Identifier of EC2 Transit Gateway. * `vpcId` - (Required) Identifier of EC2 VPC. @@ -94,4 +95,4 @@ Using `terraform import`, import `aws_ec2_transit_gateway_vpc_attachment` using % terraform import aws_ec2_transit_gateway_vpc_attachment.example tgw-attach-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ec2_transit_gateway_vpc_attachment_accepter.html.markdown b/website/docs/cdktf/typescript/r/ec2_transit_gateway_vpc_attachment_accepter.html.markdown index 6f52d66e84dc..a2b4f0b10eba 100644 --- a/website/docs/cdktf/typescript/r/ec2_transit_gateway_vpc_attachment_accepter.html.markdown +++ b/website/docs/cdktf/typescript/r/ec2_transit_gateway_vpc_attachment_accepter.html.markdown @@ -51,6 +51,7 @@ A full example of how to create a Transit Gateway in one AWS account, share it w This resource supports the following arguments: +* `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). * `transitGatewayAttachmentId` - (Required) The ID of the EC2 Transit Gateway Attachment to manage. * `transitGatewayDefaultRouteTableAssociation` - (Optional) Boolean whether the VPC Attachment should be associated with the EC2 Transit Gateway association default route table. Default value: `true`. * `transitGatewayDefaultRouteTablePropagation` - (Optional) Boolean whether the VPC Attachment should propagate routes with the EC2 Transit Gateway propagation default route table. Default value: `true`. @@ -103,4 +104,4 @@ Using `terraform import`, import `aws_ec2_transit_gateway_vpc_attachment_accepte % terraform import aws_ec2_transit_gateway_vpc_attachment_accepter.example tgw-attach-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ecr_account_setting.html.markdown b/website/docs/cdktf/typescript/r/ecr_account_setting.html.markdown index 447944326c0d..3056e75c79ba 100644 --- a/website/docs/cdktf/typescript/r/ecr_account_setting.html.markdown +++ b/website/docs/cdktf/typescript/r/ecr_account_setting.html.markdown @@ -64,6 +64,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) Name of the account setting. One of: `BASIC_SCAN_TYPE_VERSION`, `REGISTRY_POLICY_SCOPE`. * `value` - (Required) Setting value that is specified. Valid values are: * If `name` is specified as `BASIC_SCAN_TYPE_VERSION`, one of: `AWS_NATIVE`, `CLAIR`. @@ -107,4 +108,4 @@ Using `terraform import`, import EMR Security Configurations using the account s % terraform import aws_ecr_account_setting.foo BASIC_SCAN_TYPE_VERSION ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ecr_lifecycle_policy.html.markdown b/website/docs/cdktf/typescript/r/ecr_lifecycle_policy.html.markdown index d0512ec4fc2e..fa96b0d9f281 100644 --- a/website/docs/cdktf/typescript/r/ecr_lifecycle_policy.html.markdown +++ b/website/docs/cdktf/typescript/r/ecr_lifecycle_policy.html.markdown @@ -90,6 +90,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `repository` - (Required) Name of the repository to apply the policy. * `policy` - (Required) The policy document. This is a JSON formatted string. See more details about [Policy Parameters](http://docs.aws.amazon.com/AmazonECR/latest/userguide/LifecyclePolicies.html#lifecycle_policy_parameters) in the official AWS docs. Consider using the [`aws_ecr_lifecycle_policy_document` data_source](/docs/providers/aws/d/ecr_lifecycle_policy_document.html) to generate/manage the JSON document used for the `policy` argument. @@ -102,6 +103,32 @@ This resource exports the following attributes in addition to the arguments abov ## Import +In Terraform v1.12.0 and later, the [`import` block](https://developer.hashicorp.com/terraform/language/import) can be used with the `identity` attribute. For example: + +```terraform +import { + to = aws_ecr_lifecycle_policy.example + identity = { + repository = "tf-example" + } +} + +resource "aws_ecr_lifecycle_policy" "example" { + ### Configuration omitted for brevity ### +} +``` + +### Identity Schema + +#### Required + +* `repository` - (String) Name of the ECR repository. + +#### Optional + +- `accountId` (String) AWS Account where this resource is managed. +- `region` (String) Region where this resource is managed. + In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import ECR Lifecycle Policy using the name of the repository. For example: ```typescript @@ -128,4 +155,4 @@ Using `terraform import`, import ECR Lifecycle Policy using the name of the repo % terraform import aws_ecr_lifecycle_policy.example tf-example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ecr_pull_through_cache_rule.html.markdown b/website/docs/cdktf/typescript/r/ecr_pull_through_cache_rule.html.markdown index 4c584f9355c6..6be693823fca 100644 --- a/website/docs/cdktf/typescript/r/ecr_pull_through_cache_rule.html.markdown +++ b/website/docs/cdktf/typescript/r/ecr_pull_through_cache_rule.html.markdown @@ -44,6 +44,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `credentialArn` - (Optional) ARN of the Secret which will be used to authenticate against the registry. * `customRoleArn` - (Optional) The ARN of the IAM role associated with the pull through cache rule. Must be specified if the upstream registry is a cross-account ECR private registry. See [AWS Document - Setting up permissions for cross-account ECR to ECR PTC](https://docs.aws.amazon.com/AmazonECR/latest/userguide/pull-through-cache-private.html). * `ecrRepositoryPrefix` - (Required, Forces new resource) The repository name prefix to use when caching images from the source registry. Use `ROOT` as the prefix to apply a template to all repositories in your registry that don't have an associated pull through cache rule. @@ -88,4 +89,4 @@ Using `terraform import`, import a pull-through cache rule using the `ecrReposit % terraform import aws_ecr_pull_through_cache_rule.example ecr-public ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ecr_registry_policy.html.markdown b/website/docs/cdktf/typescript/r/ecr_registry_policy.html.markdown index 3a8541a593e4..530edafd4a92 100644 --- a/website/docs/cdktf/typescript/r/ecr_registry_policy.html.markdown +++ b/website/docs/cdktf/typescript/r/ecr_registry_policy.html.markdown @@ -57,7 +57,7 @@ class MyConvertedCode extends TerraformStack { "arn:${" + dataAwsPartitionCurrent.partition + "}:ecr:${" + - dataAwsRegionCurrent.name + + dataAwsRegionCurrent.region + "}:${" + current.accountId + "}:repository/*", @@ -78,6 +78,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `policy` - (Required) The policy document. This is a JSON formatted string. For more information about building IAM policy documents with Terraform, see the [AWS IAM Policy Document Guide](https://learn.hashicorp.com/terraform/aws/iam-policy) ## Attribute Reference @@ -114,4 +115,4 @@ Using `terraform import`, import ECR Registry Policy using the registry id. For % terraform import aws_ecr_registry_policy.example 123456789012 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ecr_registry_scanning_configuration.html.markdown b/website/docs/cdktf/typescript/r/ecr_registry_scanning_configuration.html.markdown index 63aa58fe2535..8e65a0401015 100644 --- a/website/docs/cdktf/typescript/r/ecr_registry_scanning_configuration.html.markdown +++ b/website/docs/cdktf/typescript/r/ecr_registry_scanning_configuration.html.markdown @@ -93,6 +93,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +- `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). - `scanType` - (Required) the scanning type to set for the registry. Can be either `ENHANCED` or `BASIC`. - `rule` - (Optional) One or multiple blocks specifying scanning rules to determine which repository filters are used and at what frequency scanning will occur. See [below for schema](#rule). @@ -139,4 +140,4 @@ Using `terraform import`, import ECR Scanning Configurations using the `registry % terraform import aws_ecr_registry_scanning_configuration.example 123456789012 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ecr_replication_configuration.html.markdown b/website/docs/cdktf/typescript/r/ecr_replication_configuration.html.markdown index b4c1ca352cee..310ba8a70ee9 100644 --- a/website/docs/cdktf/typescript/r/ecr_replication_configuration.html.markdown +++ b/website/docs/cdktf/typescript/r/ecr_replication_configuration.html.markdown @@ -146,6 +146,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `replicationConfiguration` - (Required) Replication configuration for a registry. See [Replication Configuration](#replication-configuration). ### Replication Configuration @@ -205,4 +206,4 @@ Using `terraform import`, import ECR Replication Configuration using the `regist % terraform import aws_ecr_replication_configuration.service 012345678912 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ecr_repository.html.markdown b/website/docs/cdktf/typescript/r/ecr_repository.html.markdown index 698149833826..f69894ceceed 100644 --- a/website/docs/cdktf/typescript/r/ecr_repository.html.markdown +++ b/website/docs/cdktf/typescript/r/ecr_repository.html.markdown @@ -38,15 +38,50 @@ class MyConvertedCode extends TerraformStack { ``` +### With Image Tag Mutability Exclusion + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { EcrRepository } from "./.gen/providers/aws/ecr-repository"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + new EcrRepository(this, "example", { + imageTagMutability: "IMMUTABLE_WITH_EXCLUSION", + imageTagMutabilityExclusionFilter: [ + { + filter: "latest*", + filterType: "WILDCARD", + }, + { + filter: "dev-*", + filterType: "WILDCARD", + }, + ], + name: "example-repo", + }); + } +} + +``` + ## Argument Reference This resource supports the following arguments: +* `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). * `name` - (Required) Name of the repository. * `encryptionConfiguration` - (Optional) Encryption configuration for the repository. See [below for schema](#encryption_configuration). * `forceDelete` - (Optional) If `true`, will delete the repository even if it contains images. Defaults to `false`. -* `imageTagMutability` - (Optional) The tag mutability setting for the repository. Must be one of: `MUTABLE` or `IMMUTABLE`. Defaults to `MUTABLE`. +* `imageTagMutability` - (Optional) The tag mutability setting for the repository. Must be one of: `MUTABLE`, `IMMUTABLE`, `IMMUTABLE_WITH_EXCLUSION`, or `MUTABLE_WITH_EXCLUSION`. Defaults to `MUTABLE`. +* `imageTagMutabilityExclusionFilter` - (Optional) Configuration block that defines filters to specify which image tags can override the default tag mutability setting. Only applicable when `imageTagMutability` is set to `IMMUTABLE_WITH_EXCLUSION` or `MUTABLE_WITH_EXCLUSION`. See [below for schema](#image_tag_mutability_exclusion_filter). * `imageScanningConfiguration` - (Optional) Configuration block that defines image scanning configuration for the repository. By default, image scanning must be manually triggered. See the [ECR User Guide](https://docs.aws.amazon.com/AmazonECR/latest/userguide/image-scanning.html) for more information about image scanning. * `scanOnPush` - (Required) Indicates whether images are scanned after being pushed to the repository (true) or not scanned (false). * `tags` - (Optional) A map of tags to assign to the resource. If configured with a provider [`defaultTags` 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. @@ -56,6 +91,11 @@ This resource supports the following arguments: * `encryptionType` - (Optional) The encryption type to use for the repository. Valid values are `AES256` or `KMS`. Defaults to `AES256`. * `kmsKey` - (Optional) The ARN of the KMS key to use when `encryptionType` is `KMS`. If not specified, uses the default AWS managed key for ECR. +### image_tag_mutability_exclusion_filter + +* `filter` - (Required) The filter pattern to use for excluding image tags from the mutability setting. Must contain only letters, numbers, and special characters (._*-). Each filter can be up to 128 characters long and can contain a maximum of 2 wildcards (*). +* `filterType` - (Required) The type of filter to use. Must be `WILDCARD`. + ## Attribute Reference This resource exports the following attributes in addition to the arguments above: @@ -73,6 +113,32 @@ This resource exports the following attributes in addition to the arguments abov ## Import +In Terraform v1.12.0 and later, the [`import` block](https://developer.hashicorp.com/terraform/language/import) can be used with the `identity` attribute. For example: + +```terraform +import { + to = aws_ecr_repository.service + identity = { + name = "test-service" + } +} + +resource "aws_ecr_repository" "service" { + ### Configuration omitted for brevity ### +} +``` + +### Identity Schema + +#### Required + +* `name` - (String) Name of the ECR repository. + +#### Optional + +- `accountId` (String) AWS Account where this resource is managed. +- `region` (String) Region where this resource is managed. + In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import ECR Repositories using the `name`. For example: ```typescript @@ -99,4 +165,4 @@ Using `terraform import`, import ECR Repositories using the `name`. For example: % terraform import aws_ecr_repository.service test-service ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ecr_repository_creation_template.html.markdown b/website/docs/cdktf/typescript/r/ecr_repository_creation_template.html.markdown index 5f010f27ed66..80dea352b46d 100644 --- a/website/docs/cdktf/typescript/r/ecr_repository_creation_template.html.markdown +++ b/website/docs/cdktf/typescript/r/ecr_repository_creation_template.html.markdown @@ -87,12 +87,14 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `prefix` - (Required, Forces new resource) The repository name prefix to match against. Use `ROOT` to match any prefix that doesn't explicitly match another template. * `appliedFor` - (Required) Which features this template applies to. Must contain one or more of `PULL_THROUGH_CACHE` or `REPLICATION`. * `customRoleArn` - (Optional) A custom IAM role to use for repository creation. Required if using repository tags or KMS encryption. * `description` - (Optional) The description for this template. * `encryptionConfiguration` - (Optional) Encryption configuration for any created repositories. See [below for schema](#encryption_configuration). * `imageTagMutability` - (Optional) The tag mutability setting for any created repositories. Must be one of: `MUTABLE` or `IMMUTABLE`. Defaults to `MUTABLE`. +* `imageTagMutabilityExclusionFilter` - (Optional) Configuration block that defines filters to specify which image tags can override the default tag mutability setting. Only applicable when `imageTagMutability` is set to `IMMUTABLE_WITH_EXCLUSION` or `MUTABLE_WITH_EXCLUSION`. See [below for schema](#image_tag_mutability_exclusion_filter). * `lifecyclePolicy` - (Optional) The lifecycle policy document to apply to any created repositories. See more details about [Policy Parameters](http://docs.aws.amazon.com/AmazonECR/latest/userguide/LifecyclePolicies.html#lifecycle_policy_parameters) in the official AWS docs. Consider using the [`aws_ecr_lifecycle_policy_document` data_source](/docs/providers/aws/d/ecr_lifecycle_policy_document.html) to generate/manage the JSON document used for the `lifecyclePolicy` argument. * `repositoryPolicy` - (Optional) The registry policy document to apply to any created repositories. This is a JSON formatted string. For more information about building IAM policy documents with Terraform, see the [AWS IAM Policy Document Guide](https://learn.hashicorp.com/terraform/aws/iam-policy). * `resourceTags` - (Optional) A map of tags to assign to any created repositories. @@ -102,6 +104,11 @@ This resource supports the following arguments: * `encryptionType` - (Optional) The encryption type to use for any created repositories. Valid values are `AES256` or `KMS`. Defaults to `AES256`. * `kmsKey` - (Optional) The ARN of the KMS key to use when `encryptionType` is `KMS`. If not specified, uses the default AWS managed key for ECR. +### image_tag_mutability_exclusion_filter + +* `filter` - (Required) The filter pattern to use for excluding image tags from the mutability setting. Must contain only letters, numbers, and special characters (._*-). Each filter can be up to 128 characters long and can contain a maximum of 2 wildcards (*). +* `filterType` - (Required) The type of filter to use. Must be `WILDCARD`. + ## Attribute Reference This resource exports the following attributes in addition to the arguments above: @@ -140,4 +147,4 @@ Using `terraform import`, import the ECR Repository Creating Templates using the % terraform import aws_ecr_repository_creation_template.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ecr_repository_policy.html.markdown b/website/docs/cdktf/typescript/r/ecr_repository_policy.html.markdown index 0fc1d2d0f973..bd285f9755ad 100644 --- a/website/docs/cdktf/typescript/r/ecr_repository_policy.html.markdown +++ b/website/docs/cdktf/typescript/r/ecr_repository_policy.html.markdown @@ -88,6 +88,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `repository` - (Required) Name of the repository to apply the policy. * `policy` - (Required) The policy document. This is a JSON formatted string. For more information about building IAM policy documents with Terraform, see the [AWS IAM Policy Document Guide](https://learn.hashicorp.com/terraform/aws/iam-policy) @@ -100,6 +101,32 @@ This resource exports the following attributes in addition to the arguments abov ## Import +In Terraform v1.12.0 and later, the [`import` block](https://developer.hashicorp.com/terraform/language/import) can be used with the `identity` attribute. For example: + +```terraform +import { + to = aws_ecr_repository_policy.example + identity = { + repository = "example" + } +} + +resource "aws_ecr_repository_policy" "example" { + ### Configuration omitted for brevity ### +} +``` + +### Identity Schema + +#### Required + +* `repository` - (String) Name of the ECR repository. + +#### Optional + +- `accountId` (String) AWS Account where this resource is managed. +- `region` (String) Region where this resource is managed. + In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import ECR Repository Policy using the repository name. For example: ```typescript @@ -126,4 +153,4 @@ Using `terraform import`, import ECR Repository Policy using the repository name % terraform import aws_ecr_repository_policy.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ecrpublic_repository.html.markdown b/website/docs/cdktf/typescript/r/ecrpublic_repository.html.markdown index 49b83dd08024..42ef1510ae40 100644 --- a/website/docs/cdktf/typescript/r/ecrpublic_repository.html.markdown +++ b/website/docs/cdktf/typescript/r/ecrpublic_repository.html.markdown @@ -57,6 +57,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `repositoryName` - (Required) Name of the repository. * `catalogData` - (Optional) Catalog data configuration for the repository. See [below for schema](#catalog_data). * `tags` - (Optional) Key-value mapping of resource tags. If configured with a provider [`defaultTags` 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. @@ -114,4 +115,4 @@ Using `terraform import`, import ECR Public Repositories using the `repositoryNa % terraform import aws_ecrpublic_repository.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ecrpublic_repository_policy.html.markdown b/website/docs/cdktf/typescript/r/ecrpublic_repository_policy.html.markdown index b224120cba82..3b71aab291fc 100644 --- a/website/docs/cdktf/typescript/r/ecrpublic_repository_policy.html.markdown +++ b/website/docs/cdktf/typescript/r/ecrpublic_repository_policy.html.markdown @@ -90,6 +90,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `repositoryName` - (Required) Name of the repository to apply the policy. * `policy` - (Required) The policy document. This is a JSON formatted string. For more information about building IAM policy documents with Terraform, see the [AWS IAM Policy Document Guide](https://learn.hashicorp.com/terraform/aws/iam-policy) @@ -131,4 +132,4 @@ Using `terraform import`, import ECR Public Repository Policy using the reposito % terraform import aws_ecrpublic_repository_policy.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ecs_account_setting_default.html.markdown b/website/docs/cdktf/typescript/r/ecs_account_setting_default.html.markdown index b00246ffc295..49d30e0d2b0e 100644 --- a/website/docs/cdktf/typescript/r/ecs_account_setting_default.html.markdown +++ b/website/docs/cdktf/typescript/r/ecs_account_setting_default.html.markdown @@ -68,6 +68,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) Name of the account setting to set. * `value` - (Required) State of the setting. @@ -75,7 +76,6 @@ This resource supports the following arguments: This resource exports the following attributes in addition to the arguments above: -* `id` - ARN that identifies the account setting. * `prinicpal_arn` - ARN that identifies the account setting. ## Import @@ -110,4 +110,4 @@ Using `terraform import`, import ECS Account Setting defaults using the `name`. % terraform import aws_ecs_account_setting_default.example taskLongArnFormat ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ecs_capacity_provider.html.markdown b/website/docs/cdktf/typescript/r/ecs_capacity_provider.html.markdown index 27f9daddab3c..4b3ebf2eb445 100644 --- a/website/docs/cdktf/typescript/r/ecs_capacity_provider.html.markdown +++ b/website/docs/cdktf/typescript/r/ecs_capacity_provider.html.markdown @@ -33,7 +33,7 @@ interface MyConfig { class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string, config: MyConfig) { super(scope, name); - const test = new AutoscalingGroup(this, "test", { + const example = new AutoscalingGroup(this, "example", { tag: [ { key: "AmazonECSManaged", @@ -44,21 +44,25 @@ class MyConvertedCode extends TerraformStack { maxSize: config.maxSize, minSize: config.minSize, }); - const awsEcsCapacityProviderTest = new EcsCapacityProvider(this, "test_1", { - autoScalingGroupProvider: { - autoScalingGroupArn: test.arn, - managedScaling: { - maximumScalingStepSize: 1000, - minimumScalingStepSize: 1, - status: "ENABLED", - targetCapacity: 10, + const awsEcsCapacityProviderExample = new EcsCapacityProvider( + this, + "example_1", + { + autoScalingGroupProvider: { + autoScalingGroupArn: example.arn, + managedScaling: { + maximumScalingStepSize: 1000, + minimumScalingStepSize: 1, + status: "ENABLED", + targetCapacity: 10, + }, + managedTerminationProtection: "ENABLED", }, - managedTerminationProtection: "ENABLED", - }, - name: "test", - }); + name: "example", + } + ); /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ - awsEcsCapacityProviderTest.overrideLogicalId("test"); + awsEcsCapacityProviderExample.overrideLogicalId("example"); } } @@ -68,6 +72,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `autoScalingGroupProvider` - (Required) Configuration block for the provider for the ECS auto scaling group. Detailed below. * `name` - (Required) Name of the capacity provider. * `tags` - (Optional) Key-value map of resource tags. If configured with a provider [`defaultTags` 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. @@ -94,12 +99,11 @@ This resource supports the following arguments: This resource exports the following attributes in addition to the arguments above: * `arn` - ARN that identifies the capacity provider. -* `id` - ARN that identifies the capacity provider. * `tagsAll` - Map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). ## Import -In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import ECS Capacity Providers using the `name`. For example: +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import ECS Capacity Providers using the `arn`. For example: ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -113,16 +117,20 @@ import { EcsCapacityProvider } from "./.gen/providers/aws/ecs-capacity-provider" class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); - EcsCapacityProvider.generateConfigForImport(this, "example", "example"); + EcsCapacityProvider.generateConfigForImport( + this, + "example", + "arn:aws:ecs:us-west-2:123456789012:capacity-provider/example" + ); } } ``` -Using `terraform import`, import ECS Capacity Providers using the `name`. For example: +Using `terraform import`, import ECS Capacity Providers using the `arn`. For example: ```console -% terraform import aws_ecs_capacity_provider.example example +% terraform import aws_ecs_capacity_provider.example arn:aws:ecs:us-west-2:123456789012:capacity-provider/example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ecs_cluster.html.markdown b/website/docs/cdktf/typescript/r/ecs_cluster.html.markdown index cc4dc147a09e..f9dad5558d6f 100644 --- a/website/docs/cdktf/typescript/r/ecs_cluster.html.markdown +++ b/website/docs/cdktf/typescript/r/ecs_cluster.html.markdown @@ -186,6 +186,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `configuration` - (Optional) Execute command configuration for the cluster. See [`configuration` Block](#configuration-block) for details. * `serviceConnectDefaults` - (Optional) Default Service Connect namespace. See [`serviceConnectDefaults` Block](#service_connect_defaults-block) for details. * `setting` - (Optional) Configuration block(s) with cluster settings. For example, this can be used to enable CloudWatch Container Insights for a cluster. See [`setting` Block](#setting-block) for details. @@ -241,7 +242,6 @@ The `setting` configuration block supports the following arguments: This resource exports the following attributes in addition to the arguments above: * `arn` - ARN that identifies the cluster. -* `id` - ARN that identifies the cluster. * `tagsAll` - Map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). ## Import @@ -272,4 +272,4 @@ Using `terraform import`, import ECS clusters using the cluster name. For exampl % terraform import aws_ecs_cluster.stateless stateless-app ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ecs_cluster_capacity_providers.html.markdown b/website/docs/cdktf/typescript/r/ecs_cluster_capacity_providers.html.markdown index 89542d2c008d..d3482b6afb37 100644 --- a/website/docs/cdktf/typescript/r/ecs_cluster_capacity_providers.html.markdown +++ b/website/docs/cdktf/typescript/r/ecs_cluster_capacity_providers.html.markdown @@ -55,6 +55,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `capacityProviders` - (Optional) Set of names of one or more capacity providers to associate with the cluster. Valid values also include `FARGATE` and `FARGATE_SPOT`. * `clusterName` - (Required, Forces new resource) Name of the ECS cluster to manage capacity providers for. * `defaultCapacityProviderStrategy` - (Optional) Set of capacity provider strategies to use by default for the cluster. Detailed below. @@ -103,4 +104,4 @@ Using `terraform import`, import ECS cluster capacity providers using the `clust % terraform import aws_ecs_cluster_capacity_providers.example my-cluster ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ecs_service.html.markdown b/website/docs/cdktf/typescript/r/ecs_service.html.markdown index 2c06ef40bf63..538880364861 100644 --- a/website/docs/cdktf/typescript/r/ecs_service.html.markdown +++ b/website/docs/cdktf/typescript/r/ecs_service.html.markdown @@ -173,6 +173,34 @@ class MyConvertedCode extends TerraformStack { ``` +### Blue/Green Deployment with SIGINT Rollback + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { Token, TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { EcsService } from "./.gen/providers/aws/ecs-service"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + new EcsService(this, "example", { + cluster: Token.asString(awsEcsClusterExample.id), + deploymentConfiguration: { + strategy: "BLUE_GREEN", + }, + name: "example", + sigintRollback: true, + waitForSteadyState: true, + }); + } +} + +``` + ### Redeploy Service On Every Apply The key used with `triggers` is arbitrary. @@ -212,11 +240,13 @@ The following arguments are required: The following arguments are optional: +* `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). * `alarms` - (Optional) Information about the CloudWatch alarms. [See below](#alarms). * `availabilityZoneRebalancing` - (Optional) ECS automatically redistributes tasks within a service across Availability Zones (AZs) to mitigate the risk of impaired application availability due to underlying infrastructure failures and task lifecycle activities. The valid values are `ENABLED` and `DISABLED`. Defaults to `DISABLED`. * `capacityProviderStrategy` - (Optional) Capacity provider strategies to use for the service. Can be one or more. These can be updated without destroying and recreating the service only if `force_new_deployment = true` and not changing from 0 `capacityProviderStrategy` blocks to greater than 0, or vice versa. [See below](#capacity_provider_strategy). Conflicts with `launchType`. * `cluster` - (Optional) ARN of an ECS cluster. * `deploymentCircuitBreaker` - (Optional) Configuration block for deployment circuit breaker. [See below](#deployment_circuit_breaker). +* `deploymentConfiguration` - (Optional) Configuration block for deployment settings. [See below](#deployment_configuration). * `deploymentController` - (Optional) Configuration block for deployment controller configuration. [See below](#deployment_controller). * `deploymentMaximumPercent` - (Optional) Upper limit (as a percentage of the service's desiredCount) of the number of running tasks that can be running in a service during a deployment. Not valid when using the `DAEMON` scheduling strategy. * `deploymentMinimumHealthyPercent` - (Optional) Lower limit (as a percentage of the service's desiredCount) of the number of running tasks that must remain running and healthy in a service during a deployment. @@ -237,6 +267,7 @@ The following arguments are optional: * `schedulingStrategy` - (Optional) Scheduling strategy to use for the service. The valid values are `REPLICA` and `DAEMON`. Defaults to `REPLICA`. Note that [*Tasks using the Fargate launch type or the `CODE_DEPLOY` or `EXTERNAL` deployment controller types don't support the `DAEMON` scheduling strategy*](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html). * `serviceConnectConfiguration` - (Optional) ECS Service Connect configuration for this service to discover and connect to services, and be discovered by, and connected from, other services within a namespace. [See below](#service_connect_configuration). * `serviceRegistries` - (Optional) Service discovery registries for the service. The maximum number of `serviceRegistries` blocks is `1`. [See below](#service_registries). +* `sigintRollback` - (Optional) Whether to enable graceful termination of deployments using SIGINT signals. When enabled, allows customers to safely cancel an in-progress deployment and automatically trigger a rollback to the previous stable state. Defaults to `false`. Only applicable when using `ECS` deployment controller and requires `wait_for_steady_state = true`. * `tags` - (Optional) Key-value map of resource tags. If configured with a provider [`defaultTags` 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. * `taskDefinition` - (Optional) Family and revision (`family:revision`) or full ARN of the task definition that you want to run in your service. Required unless using the `EXTERNAL` deployment controller. If a revision is not specified, the latest `ACTIVE` revision is used. * `triggers` - (Optional) Map of arbitrary keys and values that, when changed, will trigger an in-place update (redeployment). Useful with `plantimestamp()`. See example above. @@ -291,6 +322,22 @@ The `capacityProviderStrategy` configuration block supports the following: * `capacityProvider` - (Required) Short name of the capacity provider. * `weight` - (Required) Relative percentage of the total number of launched tasks that should use the specified capacity provider. +### deployment_configuration + +The `deploymentConfiguration` configuration block supports the following: + +* `strategy` - (Optional) Type of deployment strategy. Valid values: `ROLLING`, `BLUE_GREEN`. Default: `ROLLING`. +* `bakeTimeInMinutes` - (Optional) Number of minutes to wait after a new deployment is fully provisioned before terminating the old deployment. Only used when `strategy` is set to `BLUE_GREEN`. +* `lifecycleHook` - (Optional) Configuration block for lifecycle hooks that are invoked during deployments. [See below](#lifecycle_hook). + +### lifecycle_hook + +The `lifecycleHook` configuration block supports the following: + +* `hookTargetArn` - (Required) ARN of the Lambda function to invoke for the lifecycle hook. +* `roleArn` - (Required) ARN of the IAM role that grants the service permission to invoke the Lambda function. +* `lifecycleStages` - (Required) Stages during the deployment when the hook should be invoked. Valid values: `RECONCILE_SERVICE`, `PRE_SCALE_UP`, `POST_SCALE_UP`, `TEST_TRAFFIC_SHIFT`, `POST_TEST_TRAFFIC_SHIFT`, `PRODUCTION_TRAFFIC_SHIFT`, `POST_PRODUCTION_TRAFFIC_SHIFT`. + ### deployment_circuit_breaker The `deploymentCircuitBreaker` configuration block supports the following: @@ -312,9 +359,19 @@ The `deploymentController` configuration block supports the following: * `targetGroupArn` - (Required for ALB/NLB) ARN of the Load Balancer target group to associate with the service. * `containerName` - (Required) Name of the container to associate with the load balancer (as it appears in a container definition). * `containerPort` - (Required) Port on the container to associate with the load balancer. +* `advancedConfiguration` - (Optional) Configuration block for Blue/Green deployment settings. Required when using `BLUE_GREEN` deployment strategy. [See below](#advanced_configuration). -> **Version note:** Multiple `loadBalancer` configuration block support was added in Terraform AWS Provider version 2.22.0. This allows configuration of [ECS service support for multiple target groups](https://aws.amazon.com/about-aws/whats-new/2019/07/amazon-ecs-services-now-support-multiple-load-balancer-target-groups/). +### advanced_configuration + +The `advancedConfiguration` configuration block supports the following: + +* `alternateTargetGroupArn` - (Required) ARN of the alternate target group to use for Blue/Green deployments. +* `productionListenerRule` - (Required) ARN of the listener rule that routes production traffic. +* `roleArn` - (Required) ARN of the IAM role that allows ECS to manage the target groups. +* `testListenerRule` - (Optional) ARN of the listener rule that routes test traffic. + ### network_configuration `networkConfiguration` support the following: @@ -381,7 +438,7 @@ For more information, see [Task Networking](https://docs.aws.amazon.com/AmazonEC `service` supports the following: -* `clientAlias` - (Optional) List of client aliases for this Service Connect service. You use these to assign names that can be used by client applications. The maximum number of client aliases that you can have in this list is 1. [See below](#client_alias). +* `clientAlias` - (Optional) List of client aliases for this Service Connect service. You use these to assign names that can be used by client applications. For each service block where enabled is true, exactly one `clientAlias` with one `port` should be specified. [See below](#client_alias). * `discoveryName` - (Optional) Name of the new AWS Cloud Map service that Amazon ECS creates for this Amazon ECS service. * `ingressPortOverride` - (Optional) Port number for the Service Connect proxy to listen on. * `portName` - (Required) Name of one of the `portMappings` from all the containers in the task definition of this Amazon ECS service. @@ -415,6 +472,26 @@ For more information, see [Task Networking](https://docs.aws.amazon.com/AmazonEC * `dnsName` - (Optional) Name that you use in the applications of client tasks to connect to this service. * `port` - (Required) Listening port number for the Service Connect proxy. This port is available inside of all of the tasks within the same namespace. +* `testTrafficRules` - (Optional) Configuration block for test traffic routing rules. [See below](#test_traffic_rules). + +### test_traffic_rules + +The `testTrafficRules` configuration block supports the following: + +* `header` - (Optional) Configuration block for header-based routing rules. [See below](#header). + +### header + +The `header` configuration block supports the following: + +* `name` - (Required) Name of the HTTP header to match. +* `value` - (Required) Configuration block for header value matching criteria. [See below](#value). + +### value + +The `value` configuration block supports the following: + +* `exact` - (Required) Exact string value to match in the header. ### tag_specifications @@ -428,7 +505,7 @@ For more information, see [Task Networking](https://docs.aws.amazon.com/AmazonEC This resource exports the following attributes in addition to the arguments above: -* `id` - ARN that identifies the service. +* `arn` - ARN that identifies the service. * `tagsAll` - A map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). ## Timeouts @@ -471,4 +548,4 @@ Using `terraform import`, import ECS services using the `name` together with ecs % terraform import aws_ecs_service.imported cluster-name/service-name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ecs_tag.html.markdown b/website/docs/cdktf/typescript/r/ecs_tag.html.markdown index 93cb565f929b..e3c850dc23ae 100644 --- a/website/docs/cdktf/typescript/r/ecs_tag.html.markdown +++ b/website/docs/cdktf/typescript/r/ecs_tag.html.markdown @@ -32,7 +32,7 @@ class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); const example = new BatchComputeEnvironment(this, "example", { - computeEnvironmentName: "example", + name: "example", serviceRole: Token.asString(awsIamRoleExample.arn), type: "UNMANAGED", }); @@ -52,6 +52,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `resourceArn` - (Required) Amazon Resource Name (ARN) of the ECS resource to tag. * `key` - (Required) Tag name. * `value` - (Required) Tag value. @@ -94,4 +95,4 @@ Using `terraform import`, import `aws_ecs_tag` using the ECS resource identifier % terraform import aws_ecs_tag.example arn:aws:ecs:us-east-1:123456789012:cluster/example,Name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ecs_task_definition.html.markdown b/website/docs/cdktf/typescript/r/ecs_task_definition.html.markdown index 10357afb00ee..e08425d4653e 100644 --- a/website/docs/cdktf/typescript/r/ecs_task_definition.html.markdown +++ b/website/docs/cdktf/typescript/r/ecs_task_definition.html.markdown @@ -226,7 +226,7 @@ resource "aws_secretsmanager_secret_version" "test" { } ``` -### Example Using `containerDefinitions` and `inferenceAccelerator` +### Example Using `containerDefinitions` ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -242,14 +242,8 @@ class MyConvertedCode extends TerraformStack { super(scope, name); new EcsTaskDefinition(this, "test", { containerDefinitions: - '[\n {\n "cpu": 10,\n "command": ["sleep", "10"],\n "entryPoint": ["/"],\n "environment": [\n {"name": "VARNAME", "value": "VARVAL"}\n ],\n "essential": true,\n "image": "jenkins",\n "memory": 128,\n "name": "jenkins",\n "portMappings": [\n {\n "containerPort": 80,\n "hostPort": 8080\n }\n ],\n "resourceRequirements":[\n {\n "type":"InferenceAccelerator",\n "value":"device_1"\n }\n ]\n }\n]\n\n', + '[\n {\n "cpu": 10,\n "command": ["sleep", "10"],\n "entryPoint": ["/"],\n "environment": [\n {"name": "VARNAME", "value": "VARVAL"}\n ],\n "essential": true,\n "image": "jenkins",\n "memory": 128,\n "name": "jenkins",\n "portMappings": [\n {\n "containerPort": 80,\n "hostPort": 8080\n }\n ]\n }\n]\n\n', family: "test", - inferenceAccelerator: [ - { - deviceName: "device_1", - deviceType: "eia1.medium", - }, - ], }); } } @@ -297,12 +291,10 @@ The following arguments are required: The following arguments are optional: +* `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). * `cpu` - (Optional) Number of cpu units used by the task. If the `requiresCompatibilities` is `FARGATE` this field is required. * `enableFaultInjection` - (Optional) Enables fault injection and allows for fault injection requests to be accepted from the task's containers. Default is `false`. - - **Note:** Fault injection only works with tasks using the `awsvpc` or `host` network modes. Fault injection isn't available on Windows. * `executionRoleArn` - (Optional) ARN of the task execution role that the Amazon ECS container agent and the Docker daemon can assume. -* `inferenceAccelerator` - (Optional) Configuration block(s) with Inference Accelerators settings. [Detailed below.](#inference_accelerator) * `ipcMode` - (Optional) IPC resource namespace to be used for the containers in the task The valid values are `host`, `task`, and `none`. * `memory` - (Optional) Amount (in MiB) of memory used by the task. If the `requiresCompatibilities` is `FARGATE` this field is required. * `networkMode` - (Optional) Docker networking mode to use for the containers in the task. Valid values are `none`, `bridge`, `awsvpc`, and `host`. @@ -320,6 +312,8 @@ The following arguments are optional: ~> **NOTE:** Proper escaping is required for JSON field values containing quotes (`"`) such as `environment` values. If directly setting the JSON, they should be escaped as `\"` in the JSON, e.g., `"value": "I \"love\" escaped quotes"`. If using a Terraform variable value, they should be escaped as `\\\"` in the variable, e.g., `value = "I \\\"love\\\" escaped quotes"` in the variable and `"value": "${var.myvariable}"` in the JSON. +~> **Note:** Fault injection only works with tasks using the `awsvpc` or `host` network modes. Fault injection isn't available on Windows. + ### volume * `dockerVolumeConfiguration` - (Optional) Configuration block to configure a [docker volume](#docker_volume_configuration). Detailed below. @@ -388,11 +382,6 @@ For more information, see [Specifying an FSX Windows File Server volume in your * `sizeInGib` - (Required) The total amount, in GiB, of ephemeral storage to set for the task. The minimum supported value is `21` GiB and the maximum supported value is `200` GiB. -### inference_accelerator - -* `deviceName` - (Required) Elastic Inference accelerator device name. The deviceName must also be referenced in a container definition as a ResourceRequirement. -* `deviceType` - (Required) Elastic Inference accelerator type to use. - ## Attribute Reference This resource exports the following attributes in addition to the arguments above: @@ -434,4 +423,4 @@ Using `terraform import`, import ECS Task Definitions using their ARNs. For exam % terraform import aws_ecs_task_definition.example arn:aws:ecs:us-east-1:012345678910:task-definition/mytaskfamily:123 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ecs_task_set.html.markdown b/website/docs/cdktf/typescript/r/ecs_task_set.html.markdown index adb2f64c7e08..1480ecf72bdd 100644 --- a/website/docs/cdktf/typescript/r/ecs_task_set.html.markdown +++ b/website/docs/cdktf/typescript/r/ecs_task_set.html.markdown @@ -92,6 +92,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `capacityProviderStrategy` - (Optional) The capacity provider strategy to use for the service. Can be one or more. [Defined below](#capacity_provider_strategy). * `externalId` - (Optional) The external ID associated with the task set. * `forceDelete` - (Optional) Whether to allow deleting the task set without waiting for scaling down to 0. You can force a task set to delete even if it's in the process of scaling a resource. Normally, Terraform drains all the tasks before deleting the task set. This bypasses that behavior and potentially leaves resources dangling. @@ -193,4 +194,4 @@ Using `terraform import`, import ECS Task Sets using the `taskSetId`, `service`, % terraform import aws_ecs_task_set.example ecs-svc/7177320696926227436,arn:aws:ecs:us-west-2:123456789101:service/example/example-1234567890,arn:aws:ecs:us-west-2:123456789101:cluster/example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/efs_access_point.html.markdown b/website/docs/cdktf/typescript/r/efs_access_point.html.markdown index 247aa48540fa..86106bae5651 100644 --- a/website/docs/cdktf/typescript/r/efs_access_point.html.markdown +++ b/website/docs/cdktf/typescript/r/efs_access_point.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `fileSystemId` - (Required) ID of the file system for which the access point is intended. * `posixUser` - (Optional) Operating system user and group applied to all file system requests made using the access point. [Detailed](#posix_user) below. * `rootDirectory`- (Optional) Directory on the Amazon EFS file system that the access point provides access to. [Detailed](#root_directory) below. @@ -101,4 +102,4 @@ Using `terraform import`, import the EFS access points using the `id`. For examp % terraform import aws_efs_access_point.test fsap-52a643fb ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/efs_backup_policy.html.markdown b/website/docs/cdktf/typescript/r/efs_backup_policy.html.markdown index 52450ddadc97..5c23d50e7804 100644 --- a/website/docs/cdktf/typescript/r/efs_backup_policy.html.markdown +++ b/website/docs/cdktf/typescript/r/efs_backup_policy.html.markdown @@ -46,6 +46,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `fileSystemId` - (Required) The ID of the EFS file system. * `backupPolicy` - (Required) A backup_policy object (documented below). @@ -89,4 +90,4 @@ Using `terraform import`, import the EFS backup policies using the `id`. For exa % terraform import aws_efs_backup_policy.example fs-6fa144c6 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/efs_file_system.html.markdown b/website/docs/cdktf/typescript/r/efs_file_system.html.markdown index 057dc51d0a05..09bf463f98d3 100644 --- a/website/docs/cdktf/typescript/r/efs_file_system.html.markdown +++ b/website/docs/cdktf/typescript/r/efs_file_system.html.markdown @@ -70,6 +70,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `availabilityZoneName` - (Optional) the AWS Availability Zone in which to create the file system. Used to create a file system that uses One Zone storage classes. See [user guide](https://docs.aws.amazon.com/efs/latest/ug/availability-durability.html) for more information. * `creationToken` - (Optional) A unique name (a maximum of 64 characters are allowed) used as reference when creating the Elastic File System to ensure idempotent file @@ -150,4 +151,4 @@ Using `terraform import`, import the EFS file systems using the `id`. For exampl % terraform import aws_efs_file_system.foo fs-6fa144c6 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/efs_file_system_policy.html.markdown b/website/docs/cdktf/typescript/r/efs_file_system_policy.html.markdown index b52cd6d36bd5..fa3fc4dff2fa 100644 --- a/website/docs/cdktf/typescript/r/efs_file_system_policy.html.markdown +++ b/website/docs/cdktf/typescript/r/efs_file_system_policy.html.markdown @@ -81,6 +81,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `bypassPolicyLockoutSafetyCheck` - (Optional) A flag to indicate whether to bypass the `aws_efs_file_system_policy` lockout safety check. The policy lockout safety check determines whether the policy in the request will prevent the principal making the request will be locked out from making future `PutFileSystemPolicy` requests on the file system. Set `bypassPolicyLockoutSafetyCheck` to `true` only when you intend to prevent the principal that is making the request from making a subsequent `PutFileSystemPolicy` request on the file system. The default value is `false`. ## Attribute Reference @@ -117,4 +118,4 @@ Using `terraform import`, import the EFS file system policies using the `id`. Fo % terraform import aws_efs_file_system_policy.foo fs-6fa144c6 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/efs_mount_target.html.markdown b/website/docs/cdktf/typescript/r/efs_mount_target.html.markdown index f2d6318619d7..140a52a28e30 100644 --- a/website/docs/cdktf/typescript/r/efs_mount_target.html.markdown +++ b/website/docs/cdktf/typescript/r/efs_mount_target.html.markdown @@ -51,10 +51,13 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `fileSystemId` - (Required) The ID of the file system for which the mount target is intended. * `subnetId` - (Required) The ID of the subnet to add the mount target in. * `ipAddress` - (Optional) The address (within the address range of the specified subnet) at which the file system may be mounted via the mount target. +* `ipAddressType` - (Optional) IP address type for the mount target. Valid values are `IPV4_ONLY` (only IPv4 addresses), `IPV6_ONLY` (only IPv6 addresses), and `DUAL_STACK` (dual-stack, both IPv4 and IPv6 addresses). Defaults to `IPV4_ONLY`. +* `ipv6Address` - (Optional) IPv6 address to use. Valid only when `ipAddressType` is set to `IPV6_ONLY` or `DUAL_STACK`. * `securityGroups` - (Optional) A list of up to 5 VPC security group IDs (that must be for the same VPC as subnet specified) in effect for the mount target. @@ -110,4 +113,4 @@ Using `terraform import`, import the EFS mount targets using the `id`. For examp % terraform import aws_efs_mount_target.alpha fsmt-52a643fb ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/efs_replication_configuration.html.markdown b/website/docs/cdktf/typescript/r/efs_replication_configuration.html.markdown index 52414b4fcf8d..bfa23d2d1fd5 100644 --- a/website/docs/cdktf/typescript/r/efs_replication_configuration.html.markdown +++ b/website/docs/cdktf/typescript/r/efs_replication_configuration.html.markdown @@ -111,6 +111,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `destination` - (Required) A destination configuration block (documented below). * `sourceFileSystemId` - (Required) The ID of the file system that is to be replicated. @@ -173,4 +174,4 @@ Using `terraform import`, import EFS Replication Configurations using the file s % terraform import aws_efs_replication_configuration.example fs-id ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/egress_only_internet_gateway.html.markdown b/website/docs/cdktf/typescript/r/egress_only_internet_gateway.html.markdown index c1d3addadca0..5eb740a80744 100644 --- a/website/docs/cdktf/typescript/r/egress_only_internet_gateway.html.markdown +++ b/website/docs/cdktf/typescript/r/egress_only_internet_gateway.html.markdown @@ -55,6 +55,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `vpcId` - (Required) The VPC ID to create in. * `tags` - (Optional) A map of tags to assign to the resource. If configured with a provider [`defaultTags` 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. @@ -97,4 +98,4 @@ Using `terraform import`, import Egress-only Internet gateways using the `id`. F % terraform import aws_egress_only_internet_gateway.example eigw-015e0e244e24dfe8a ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/eip.html.markdown b/website/docs/cdktf/typescript/r/eip.html.markdown index 0fc5ca3b2427..aeb102e524ae 100644 --- a/website/docs/cdktf/typescript/r/eip.html.markdown +++ b/website/docs/cdktf/typescript/r/eip.html.markdown @@ -173,6 +173,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `address` - (Optional) IP address from an EC2 BYOIP pool. This option is only available for VPC EIPs. * `associateWithPrivateIp` - (Optional) User-specified primary or secondary private IP address to associate with the Elastic IP address. If no private IP address is specified, the Elastic IP address is associated with the primary private IP address. * `customerOwnedIpv4Pool` - (Optional) ID of a customer-owned address pool. For more on customer owned IP addressed check out [Customer-owned IP addresses guide](https://docs.aws.amazon.com/outposts/latest/userguide/outposts-networking-components.html#ip-addressing). @@ -184,13 +185,12 @@ This resource supports the following arguments: * `publicIpv4Pool` - (Optional) EC2 IPv4 address pool identifier or `amazon`. This option is only available for VPC EIPs. * `tags` - (Optional) Map of tags to assign to the resource. Tags can only be applied to EIPs in a VPC. If configured with a provider [`defaultTags` 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. -* `vpc` - (Optional **Deprecated**) Boolean if the EIP is in a VPC or not. Use `domain` instead. - Defaults to `true` unless the region supports EC2-Classic. -~> **NOTE:** You can specify either the `instance` ID or the `networkInterface` ID, but not both. Including both will **not** return an error from the AWS API, but will have undefined behavior. See the relevant [AssociateAddress API Call][1] for more information. +~> **NOTE:** You can specify either the `instance` ID or the `networkInterface` ID, but not both. +Including both will **not** return an error from the AWS API, but will have undefined behavior. +See the relevant [AssociateAddress API Call][1] for more information. -~> **NOTE:** Specifying both `publicIpv4Pool` and `address` won't cause an error but `address` will be used in the -case both options are defined as the api only requires one or the other. +~> **NOTE:** Specifying both `publicIpv4Pool` and `address` won't cause an error, however, only `address` will be used if both options are defined as the API only requires one of the two. ## Attribute Reference @@ -248,4 +248,4 @@ Using `terraform import`, import EIPs in a VPC using their Allocation ID. For ex [1]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_AssociateAddress.html - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/eip_association.html.markdown b/website/docs/cdktf/typescript/r/eip_association.html.markdown index ce278dd0cef1..1d0621af1fd6 100644 --- a/website/docs/cdktf/typescript/r/eip_association.html.markdown +++ b/website/docs/cdktf/typescript/r/eip_association.html.markdown @@ -56,6 +56,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `allocationId` - (Optional, Forces new resource) ID of the associated Elastic IP. This argument is required despite being optional at the resource level due to legacy support for EC2-Classic networking. * `allowReassociation` - (Optional, Forces new resource) Whether to allow an Elastic IP address to be re-associated. @@ -104,4 +105,4 @@ Using `terraform import`, import EIP Assocations using their association IDs. Fo % terraform import aws_eip_association.test eipassoc-ab12c345 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/eip_domain_name.html.markdown b/website/docs/cdktf/typescript/r/eip_domain_name.html.markdown index 04f17971d43a..a445da99a4e3 100644 --- a/website/docs/cdktf/typescript/r/eip_domain_name.html.markdown +++ b/website/docs/cdktf/typescript/r/eip_domain_name.html.markdown @@ -54,6 +54,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `allocationId` - (Required) The allocation ID. * `domainName` - (Required) The domain name to modify for the IP address. @@ -71,4 +72,4 @@ This resource exports the following attributes in addition to the arguments abov - `update` - (Default `10m`) - `delete` - (Default `10m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/eks_access_entry.html.markdown b/website/docs/cdktf/typescript/r/eks_access_entry.html.markdown index 3a192fea9419..625ef30bb1c2 100644 --- a/website/docs/cdktf/typescript/r/eks_access_entry.html.markdown +++ b/website/docs/cdktf/typescript/r/eks_access_entry.html.markdown @@ -41,12 +41,13 @@ class MyConvertedCode extends TerraformStack { The following arguments are required: -* `clusterName` – (Required) Name of the EKS Cluster. -* `principalArn` – (Required) The IAM Principal ARN which requires Authentication access to the EKS cluster. +* `clusterName` - (Required) Name of the EKS Cluster. +* `principalArn` - (Required) The IAM Principal ARN which requires Authentication access to the EKS cluster. The following arguments are optional: -* `kubernetesGroups` – (Optional) List of string which can optionally specify the Kubernetes groups the user would belong to when creating an access entry. +* `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). +* `kubernetesGroups` - (Optional) List of string which can optionally specify the Kubernetes groups the user would belong to when creating an access entry. * `tags` - (Optional) Key-value map of resource tags. If configured with a provider [`defaultTags` 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. * `type` - (Optional) Defaults to STANDARD which provides the standard workflow. EC2_LINUX, EC2_WINDOWS, FARGATE_LINUX types disallow users to input a username or groups, and prevent associations. * `userName` - (Optional) Defaults to principal ARN if user is principal else defaults to assume-role/session-name is role is used. @@ -100,4 +101,4 @@ Using `terraform import`, import EKS access entry using the `clusterName` and `p % terraform import aws_eks_access_entry.my_eks_access_entry my_cluster_name:my_principal_arn ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/eks_access_policy_association.html.markdown b/website/docs/cdktf/typescript/r/eks_access_policy_association.html.markdown index a6702d11df87..fb83daea83d4 100644 --- a/website/docs/cdktf/typescript/r/eks_access_policy_association.html.markdown +++ b/website/docs/cdktf/typescript/r/eks_access_policy_association.html.markdown @@ -42,12 +42,13 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This resource supports the following arguments: -* `clusterName` – (Required) Name of the EKS Cluster. -* `policyArn` – (Required) The ARN of the access policy that you're associating. -* `principalArn` – (Required) The IAM Principal ARN which requires Authentication access to the EKS cluster. -* `accessScope` – (Required) The configuration block to determine the scope of the access. See [`accessScope` Block](#access_scope-block) below. +* `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). +* `clusterName` - (Required) Name of the EKS Cluster. +* `policyArn` - (Required) The ARN of the access policy that you're associating. +* `principalArn` - (Required) The IAM Principal ARN which requires Authentication access to the EKS cluster. +* `accessScope` - (Required) The configuration block to determine the scope of the access. See [`accessScope` Block](#access_scope-block) below. ### `accessScope` Block @@ -109,4 +110,4 @@ Using `terraform import`, import EKS access entry using the `clusterName` `princ % terraform import aws_eks_access_policy_association.my_eks_access_entry my_cluster_name#my_principal_arn#my_policy_arn ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/eks_addon.html.markdown b/website/docs/cdktf/typescript/r/eks_addon.html.markdown index 8eb95d014fe7..61485e584cf0 100644 --- a/website/docs/cdktf/typescript/r/eks_addon.html.markdown +++ b/website/docs/cdktf/typescript/r/eks_addon.html.markdown @@ -234,20 +234,21 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This resource supports the following arguments: -* `addonName` – (Required) Name of the EKS add-on. The name must match one of +* `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). +* `addonName` - (Required) Name of the EKS add-on. The name must match one of the names returned by [describe-addon-versions](https://docs.aws.amazon.com/cli/latest/reference/eks/describe-addon-versions.html). -* `clusterName` – (Required) Name of the EKS Cluster. +* `clusterName` - (Required) Name of the EKS Cluster. The following arguments are optional: -* `addonVersion` – (Optional) The version of the EKS add-on. The version must +* `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). +* `addonVersion` - (Optional) The version of the EKS add-on. The version must match one of the versions returned by [describe-addon-versions](https://docs.aws.amazon.com/cli/latest/reference/eks/describe-addon-versions.html). * `configurationValues` - (Optional) custom configuration values for addons with single JSON string. This JSON string value must match the JSON schema derived from [describe-addon-configuration](https://docs.aws.amazon.com/cli/latest/reference/eks/describe-addon-configuration.html). -* `resolveConflictsOnCreate` - (Optional) How to resolve field value conflicts when migrating a self-managed add-on to an Amazon EKS add-on. Valid values are `NONE` and `OVERWRITE`. For more details see the [CreateAddon](https://docs.aws.amazon.com/eks/latest/APIReference/API_CreateAddon.html) API Docs. -* `resolveConflictsOnUpdate` - (Optional) How to resolve field value conflicts for an Amazon EKS add-on if you've changed a value from the Amazon EKS default value. Valid values are `NONE`, `OVERWRITE`, and `PRESERVE`. For more details see the [UpdateAddon](https://docs.aws.amazon.com/eks/latest/APIReference/API_UpdateAddon.html) API Docs. -* `resolveConflicts` - (**Deprecated** use the `resolveConflictsOnCreate` and `resolveConflictsOnUpdate` attributes instead) Define how to resolve parameter value conflicts when migrating an existing add-on to an Amazon EKS add-on or when applying version updates to the add-on. Valid values are `NONE`, `OVERWRITE` and `PRESERVE`. Note that `PRESERVE` is only valid on addon update, not for initial addon creation. If you need to set this to `PRESERVE`, use the `resolveConflictsOnCreate` and `resolveConflictsOnUpdate` attributes instead. For more details check [UpdateAddon](https://docs.aws.amazon.com/eks/latest/APIReference/API_UpdateAddon.html) API Docs. +* `resolveConflictsOnCreate` - (Optional) How to resolve field value conflicts when migrating a self-managed add-on to an Amazon EKS add-on. Valid values are `NONE` and `OVERWRITE`. For more details see the [CreateAddon](https://docs.aws.amazon.com/eks/latest/APIReference/API_CreateAddon.html) API Documentation. +* `resolveConflictsOnUpdate` - (Optional) How to resolve field value conflicts for an Amazon EKS add-on if you've changed a value from the Amazon EKS default value. Valid values are `NONE`, `OVERWRITE`, and `PRESERVE`. For more details see the [UpdateAddon](https://docs.aws.amazon.com/eks/latest/APIReference/API_UpdateAddon.html) API Documentation. * `tags` - (Optional) Key-value map of resource tags. If configured with a provider [`defaultTags` 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. * `podIdentityAssociation` - (Optional) Configuration block with EKS Pod Identity association settings. See [`podIdentityAssociation`](#pod-identity-association) below for details. * `preserve` - (Optional) Indicates if you want to preserve the created resources when deleting the EKS add-on. @@ -319,4 +320,4 @@ Using `terraform import`, import EKS add-on using the `clusterName` and `addonNa % terraform import aws_eks_addon.my_eks_addon my_cluster_name:my_addon_name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/eks_cluster.html.markdown b/website/docs/cdktf/typescript/r/eks_cluster.html.markdown index 4200c2bec346..e935649904e7 100644 --- a/website/docs/cdktf/typescript/r/eks_cluster.html.markdown +++ b/website/docs/cdktf/typescript/r/eks_cluster.html.markdown @@ -365,7 +365,7 @@ class MyConvertedCode extends TerraformStack { The following arguments are required: -* `name` – (Required) Name of the cluster. Must be between 1-100 characters in length. Must begin with an alphanumeric character, and must only contain alphanumeric characters, dashes and underscores (`^[0-9A-Za-z][A-Za-z0-9\-_]*$`). +* `name` - (Required) Name of the cluster. Must be between 1-100 characters in length. Must begin with an alphanumeric character, and must only contain alphanumeric characters, dashes and underscores (`^[0-9A-Za-z][A-Za-z0-9\-_]*$`). * `roleArn` - (Required) ARN of the IAM role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf. Ensure the resource configuration includes explicit dependencies on the IAM Role permissions by adding [`dependsOn`](https://www.terraform.io/docs/configuration/meta-arguments/depends_on.html) if using the [`aws_iam_role_policy` resource](/docs/providers/aws/r/iam_role_policy.html) or [`aws_iam_role_policy_attachment` resource](/docs/providers/aws/r/iam_role_policy_attachment.html), otherwise EKS cannot delete EKS managed EC2 infrastructure such as Security Groups on EKS Cluster deletion. * `vpcConfig` - (Required) Configuration block for the VPC associated with your cluster. Amazon EKS VPC resources have specific requirements to work properly with Kubernetes. For more information, see [Cluster VPC Considerations](https://docs.aws.amazon.com/eks/latest/userguide/network_reqs.html) and [Cluster Security Group Considerations](https://docs.aws.amazon.com/eks/latest/userguide/sec-group-reqs.html) in the Amazon EKS User Guide. Detailed below. Also contains attributes detailed in the Attributes section. @@ -374,16 +374,18 @@ The following arguments are optional: * `accessConfig` - (Optional) Configuration block for the access config associated with your cluster, see [Amazon EKS Access Entries](https://docs.aws.amazon.com/eks/latest/userguide/access-entries.html). [Detailed](#access_config) below. * `bootstrapSelfManagedAddons` - (Optional) Install default unmanaged add-ons, such as `aws-cni`, `kube-proxy`, and CoreDNS during cluster creation. If `false`, you must manually install desired add-ons. Changing this value will force a new cluster to be created. Defaults to `true`. * `computeConfig` - (Optional) Configuration block with compute configuration for EKS Auto Mode. [Detailed](#compute_config) below. +* `deletionProtection` - (Optional) Whether to enable deletion protection for the cluster. When enabled, the cluster cannot be deleted unless deletion protection is first disabled. Default: `false`. * `enabledClusterLogTypes` - (Optional) List of the desired control plane logging to enable. For more information, see [Amazon EKS Control Plane Logging](https://docs.aws.amazon.com/eks/latest/userguide/control-plane-logs.html). * `encryptionConfig` - (Optional) Configuration block with encryption configuration for the cluster. [Detailed](#encryption_config) below. * `forceUpdateVersion` - (Optional) Force version update by overriding upgrade-blocking readiness checks when updating a cluster. * `kubernetesNetworkConfig` - (Optional) Configuration block with kubernetes network configuration for the cluster. [Detailed](#kubernetes_network_config) below. If removed, Terraform will only perform drift detection if a configuration value is provided. * `outpostConfig` - (Optional) Configuration block representing the configuration of your local Amazon EKS cluster on an AWS Outpost. This block isn't available for creating Amazon EKS clusters on the AWS cloud. +* `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). * `remoteNetworkConfig` - (Optional) Configuration block with remote network configuration for EKS Hybrid Nodes. [Detailed](#remote_network_config) below. * `storageConfig` - (Optional) Configuration block with storage configuration for EKS Auto Mode. [Detailed](#storage_config) below. * `tags` - (Optional) Key-value map of resource tags. If configured with a provider [`defaultTags` 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. * `upgradePolicy` - (Optional) Configuration block for the support policy to use for the cluster. See [upgrade_policy](#upgrade_policy) for details. -* `version` – (Optional) Desired Kubernetes master version. If you do not specify a value, the latest available version at resource creation is used and no upgrades will occur except those automatically triggered by EKS. The value must be configured and increased to upgrade the version when desired. Downgrades are not supported by EKS. +* `version` - (Optional) Desired Kubernetes master version. If you do not specify a value, the latest available version at resource creation is used and no upgrades will occur except those automatically triggered by EKS. The value must be configured and increased to upgrade the version when desired. Downgrades are not supported by EKS. * `zonalShiftConfig` - (Optional) Configuration block with zonal shift configuration for the cluster. [Detailed](#zonal_shift_config) below. ### access_config @@ -391,7 +393,7 @@ The following arguments are optional: The `accessConfig` configuration block supports the following arguments: * `authenticationMode` - (Optional) The authentication mode for the cluster. Valid values are `CONFIG_MAP`, `API` or `API_AND_CONFIG_MAP` -* `bootstrapClusterCreatorAdminPermissions` - (Optional) Whether or not to bootstrap the access config values to the cluster. Default is `false`. +* `bootstrapClusterCreatorAdminPermissions` - (Optional) Whether or not to bootstrap the access config values to the cluster. Default is `true`. ### compute_config @@ -439,8 +441,8 @@ The `remotePodNetworks` configuration block supports the following arguments: * `endpointPrivateAccess` - (Optional) Whether the Amazon EKS private API server endpoint is enabled. Default is `false`. * `endpointPublicAccess` - (Optional) Whether the Amazon EKS public API server endpoint is enabled. Default is `true`. * `publicAccessCidrs` - (Optional) List of CIDR blocks. Indicates which CIDR blocks can access the Amazon EKS public API server endpoint when enabled. EKS defaults this to a list with `0.0.0.0/0`. Terraform will only perform drift detection of its value when present in a configuration. -* `securityGroupIds` – (Optional) List of security group IDs for the cross-account elastic network interfaces that Amazon EKS creates to use to allow communication between your worker nodes and the Kubernetes control plane. -* `subnetIds` – (Required) List of subnet IDs. Must be in at least two different availability zones. Amazon EKS creates cross-account elastic network interfaces in these subnets to allow communication between your worker nodes and the Kubernetes control plane. +* `securityGroupIds` - (Optional) List of security group IDs for the cross-account elastic network interfaces that Amazon EKS creates to use to allow communication between your worker nodes and the Kubernetes control plane. +* `subnetIds` - (Required) List of subnet IDs. Must be in at least two different availability zones. Amazon EKS creates cross-account elastic network interfaces in these subnets to allow communication between your worker nodes and the Kubernetes control plane. * `vpcId` - (Computed) ID of the VPC associated with your cluster. ### kubernetes_network_config @@ -574,4 +576,4 @@ Using `terraform import`, import EKS Clusters using the `name`. For example: % terraform import aws_eks_cluster.my_cluster my_cluster ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/eks_fargate_profile.html.markdown b/website/docs/cdktf/typescript/r/eks_fargate_profile.html.markdown index 438d42bdcb01..cab234a86c67 100644 --- a/website/docs/cdktf/typescript/r/eks_fargate_profile.html.markdown +++ b/website/docs/cdktf/typescript/r/eks_fargate_profile.html.markdown @@ -92,14 +92,15 @@ class MyConvertedCode extends TerraformStack { The following arguments are required: -* `clusterName` – (Required) Name of the EKS Cluster. -* `fargateProfileName` – (Required) Name of the EKS Fargate Profile. -* `podExecutionRoleArn` – (Required) Amazon Resource Name (ARN) of the IAM Role that provides permissions for the EKS Fargate Profile. +* `clusterName` - (Required) Name of the EKS Cluster. +* `fargateProfileName` - (Required) Name of the EKS Fargate Profile. +* `podExecutionRoleArn` - (Required) Amazon Resource Name (ARN) of the IAM Role that provides permissions for the EKS Fargate Profile. * `selector` - (Required) Configuration block(s) for selecting Kubernetes Pods to execute with this EKS Fargate Profile. Detailed below. -* `subnetIds` – (Required) Identifiers of private EC2 Subnets to associate with the EKS Fargate Profile. These subnets must have the following resource tag: `kubernetes.io/cluster/CLUSTER_NAME` (where `CLUSTER_NAME` is replaced with the name of the EKS Cluster). +* `subnetIds` - (Required) Identifiers of private EC2 Subnets to associate with the EKS Fargate Profile. These subnets must have the following resource tag: `kubernetes.io/cluster/CLUSTER_NAME` (where `CLUSTER_NAME` is replaced with the name of the EKS Cluster). The following arguments are optional: +* `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). * `tags` - (Optional) Key-value map of resource tags. If configured with a provider [`defaultTags` 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. ### selector Configuration Block @@ -110,6 +111,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `labels` - (Optional) Key-value map of Kubernetes labels for selection. ## Attribute Reference @@ -160,4 +162,4 @@ Using `terraform import`, import EKS Fargate Profiles using the `clusterName` an % terraform import aws_eks_fargate_profile.my_fargate_profile my_cluster:my_fargate_profile ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/eks_identity_provider_config.html.markdown b/website/docs/cdktf/typescript/r/eks_identity_provider_config.html.markdown index f538d26e0a0b..554d5349c48c 100644 --- a/website/docs/cdktf/typescript/r/eks_identity_provider_config.html.markdown +++ b/website/docs/cdktf/typescript/r/eks_identity_provider_config.html.markdown @@ -43,16 +43,17 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: -* `clusterName` – (Required) Name of the EKS Cluster. +* `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). +* `clusterName` - (Required) Name of the EKS Cluster. * `oidc` - (Required) Nested attribute containing [OpenID Connect](https://openid.net/connect/) identity provider information for the cluster. Detailed below. * `tags` - (Optional) Key-value map of resource tags. If configured with a provider [`defaultTags` 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. ### oidc Configuration Block -* `clientId` – (Required) Client ID for the OpenID Connect identity provider. +* `clientId` - (Required) Client ID for the OpenID Connect identity provider. * `groupsClaim` - (Optional) The JWT claim that the provider will use to return groups. * `groupsPrefix` - (Optional) A prefix that is prepended to group claims e.g., `oidc:`. -* `identityProviderConfigName` – (Required) The name of the identity provider config. +* `identityProviderConfigName` - (Required) The name of the identity provider config. * `issuerUrl` - (Required) Issuer URL for the OpenID Connect identity provider. * `requiredClaims` - (Optional) The key value pairs that describe required claims in the identity token. * `usernameClaim` - (Optional) The JWT claim that the provider will use as the username. @@ -106,4 +107,4 @@ Using `terraform import`, import EKS Identity Provider Configurations using the % terraform import aws_eks_identity_provider_config.my_identity_provider_config my_cluster:my_identity_provider_config ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/eks_node_group.html.markdown b/website/docs/cdktf/typescript/r/eks_node_group.html.markdown index 884726be8d6d..cd57844e6999 100644 --- a/website/docs/cdktf/typescript/r/eks_node_group.html.markdown +++ b/website/docs/cdktf/typescript/r/eks_node_group.html.markdown @@ -236,13 +236,14 @@ class MyConvertedCode extends TerraformStack { The following arguments are required: -* `clusterName` – (Required) Name of the EKS Cluster. -* `nodeRoleArn` – (Required) Amazon Resource Name (ARN) of the IAM Role that provides permissions for the EKS Node Group. +* `clusterName` - (Required) Name of the EKS Cluster. +* `nodeRoleArn` - (Required) Amazon Resource Name (ARN) of the IAM Role that provides permissions for the EKS Node Group. * `scalingConfig` - (Required) Configuration block with scaling settings. See [`scalingConfig`](#scaling_config-configuration-block) below for details. -* `subnetIds` – (Required) Identifiers of EC2 Subnets to associate with the EKS Node Group. +* `subnetIds` - (Required) Identifiers of EC2 Subnets to associate with the EKS Node Group. The following arguments are optional: +* `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). * `amiType` - (Optional) Type of Amazon Machine Image (AMI) associated with the EKS Node Group. See the [AWS documentation](https://docs.aws.amazon.com/eks/latest/APIReference/API_Nodegroup.html#AmazonEKS-Type-Nodegroup-amiType) for valid values. Terraform will only perform drift detection if a configuration value is provided. * `capacityType` - (Optional) Type of capacity associated with the EKS Node Group. Valid values: `ON_DEMAND`, `SPOT`. Terraform will only perform drift detection if a configuration value is provided. * `diskSize` - (Optional) Disk size in GiB for worker nodes. Defaults to `50` for Windows, `20` all other node groups. Terraform will only perform drift detection if a configuration value is provided. @@ -250,15 +251,15 @@ The following arguments are optional: * `instanceTypes` - (Optional) List of instance types associated with the EKS Node Group. Defaults to `["t3.medium"]`. Terraform will only perform drift detection if a configuration value is provided. * `labels` - (Optional) Key-value map of Kubernetes labels. Only labels that are applied with the EKS API are managed by this argument. Other Kubernetes labels applied to the EKS Node Group will not be managed. * `launchTemplate` - (Optional) Configuration block with Launch Template settings. See [`launchTemplate`](#launch_template-configuration-block) below for details. Conflicts with `remoteAccess`. -* `nodeGroupName` – (Optional) Name of the EKS Node Group. If omitted, Terraform will assign a random, unique name. Conflicts with `nodeGroupNamePrefix`. The node group name can't be longer than 63 characters. It must start with a letter or digit, but can also include hyphens and underscores for the remaining characters. -* `nodeGroupNamePrefix` – (Optional) Creates a unique name beginning with the specified prefix. Conflicts with `nodeGroupName`. -* `node_repair_config` - (Optional) The node auto repair configuration for the node group. See [`node_repair_config`](#node_repair_config-configuration-block) below for details. -* `releaseVersion` – (Optional) AMI version of the EKS Node Group. Defaults to latest version for Kubernetes version. +* `nodeGroupName` - (Optional) Name of the EKS Node Group. If omitted, Terraform will assign a random, unique name. Conflicts with `nodeGroupNamePrefix`. The node group name can't be longer than 63 characters. It must start with a letter or digit, but can also include hyphens and underscores for the remaining characters. +* `nodeGroupNamePrefix` - (Optional) Creates a unique name beginning with the specified prefix. Conflicts with `nodeGroupName`. +* `nodeRepairConfig` - (Optional) The node auto repair configuration for the node group. See [`nodeRepairConfig`](#node_repair_config-configuration-block) below for details. +* `releaseVersion` - (Optional) AMI version of the EKS Node Group. Defaults to latest version for Kubernetes version. * `remoteAccess` - (Optional) Configuration block with remote access settings. See [`remoteAccess`](#remote_access-configuration-block) below for details. Conflicts with `launchTemplate`. * `tags` - (Optional) Key-value map of resource tags. If configured with a provider [`defaultTags` 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. * `taint` - (Optional) The Kubernetes taints to be applied to the nodes in the node group. Maximum of 50 taints per node group. See [taint](#taint-configuration-block) below for details. * `updateConfig` - (Optional) Configuration block with update settings. See [`updateConfig`](#update_config-configuration-block) below for details. -* `version` – (Optional) Kubernetes version. Defaults to EKS Cluster Kubernetes version. Terraform will only perform drift detection if a configuration value is provided. +* `version` - (Optional) Kubernetes version. Defaults to EKS Cluster Kubernetes version. Terraform will only perform drift detection if a configuration value is provided. ### launch_template Configuration Block @@ -349,4 +350,4 @@ Using `terraform import`, import EKS Node Groups using the `clusterName` and `no % terraform import aws_eks_node_group.my_node_group my_cluster:my_node_group ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/eks_pod_identity_association.html.markdown b/website/docs/cdktf/typescript/r/eks_pod_identity_association.html.markdown index f72fedc81578..9f823b253c6f 100644 --- a/website/docs/cdktf/typescript/r/eks_pod_identity_association.html.markdown +++ b/website/docs/cdktf/typescript/r/eks_pod_identity_association.html.markdown @@ -89,7 +89,10 @@ The following arguments are required: The following arguments are optional: +* `disableSessionTags` - (Optional) Disable the tags that are automatically added to role session by Amazon EKS. +* `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). * `tags` - (Optional) Key-value map of resource tags. If configured with a provider [`defaultTags` 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. +* `targetRoleArn` - (Optional) The Amazon Resource Name (ARN) of the IAM role to be chained to the the IAM role specified as `roleArn`. ## Attribute Reference @@ -97,6 +100,7 @@ This resource exports the following attributes in addition to the arguments abov * `associationArn` - The Amazon Resource Name (ARN) of the association. * `associationId` - The ID of the association. +* `externalId` - The unique identifier for this association for a target IAM role. You put this value in the trust policy of the target role, in a Condition to match the sts.ExternalId. * `tagsAll` - A map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). ## Import @@ -131,4 +135,4 @@ Using `terraform import`, import EKS (Elastic Kubernetes) Pod Identity Associati % terraform import aws_eks_pod_identity_association.example example,a-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/elastic_beanstalk_application.html.markdown b/website/docs/cdktf/typescript/r/elastic_beanstalk_application.html.markdown index 32d4eff7d05f..bb3e3393d07c 100644 --- a/website/docs/cdktf/typescript/r/elastic_beanstalk_application.html.markdown +++ b/website/docs/cdktf/typescript/r/elastic_beanstalk_application.html.markdown @@ -49,6 +49,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) The name of the application, must be unique within your account * `description` - (Optional) Short description of the application * `tags` - (Optional) Key-value map of tags for the Elastic Beanstalk Application. If configured with a provider [`defaultTags` 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. @@ -99,4 +100,4 @@ Using `terraform import`, import Elastic Beanstalk Applications using the `name` % terraform import aws_elastic_beanstalk_application.tf_test tf-test-name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/elastic_beanstalk_application_version.html.markdown b/website/docs/cdktf/typescript/r/elastic_beanstalk_application_version.html.markdown index 09799dab757c..a11f5b0675f8 100644 --- a/website/docs/cdktf/typescript/r/elastic_beanstalk_application_version.html.markdown +++ b/website/docs/cdktf/typescript/r/elastic_beanstalk_application_version.html.markdown @@ -60,7 +60,7 @@ class MyConvertedCode extends TerraformStack { application: "tf-test-name", bucket: Token.asString(awsS3BucketDefault.id), description: "application version created by terraform", - key: Token.asString(awsS3ObjectDefault.id), + key: Token.asString(awsS3ObjectDefault.key), name: "tf-test-version-label", }); /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ @@ -81,6 +81,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `description` - (Optional) Short description of the Application Version. * `forceDelete` - (Optional) On delete, force an Application Version to be deleted when it may be in use by multiple Elastic Beanstalk Environments. * `process` - (Optional) Pre-processes and validates the environment manifest (env.yaml ) and configuration files (*.config files in the .ebextensions folder) in the source bundle. Validating configuration files can identify issues prior to deploying the application version to an environment. You must turn processing on for application versions that you create using AWS CodeBuild or AWS CodeCommit. For application versions built from a source bundle in Amazon S3, processing is optional. It validates Elastic Beanstalk configuration files. It doesn’t validate your application’s configuration files, like proxy server or Docker configuration. @@ -93,4 +94,4 @@ This resource exports the following attributes in addition to the arguments abov * `arn` - ARN assigned by AWS for this Elastic Beanstalk Application. * `tagsAll` - Map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/elastic_beanstalk_configuration_template.html.markdown b/website/docs/cdktf/typescript/r/elastic_beanstalk_configuration_template.html.markdown index 5b164f0a3503..f968989a65ff 100644 --- a/website/docs/cdktf/typescript/r/elastic_beanstalk_configuration_template.html.markdown +++ b/website/docs/cdktf/typescript/r/elastic_beanstalk_configuration_template.html.markdown @@ -47,14 +47,15 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) A unique name for this Template. -* `application` – (Required) name of the application to associate with this configuration template +* `application` - (Required) name of the application to associate with this configuration template * `description` - (Optional) Short description of the Template -* `environmentId` – (Optional) The ID of the environment used with this configuration template -* `setting` – (Optional) Option settings to configure the new Environment. These +* `environmentId` - (Optional) The ID of the environment used with this configuration template +* `setting` - (Optional) Option settings to configure the new Environment. These override specific values that are set as defaults. The format is detailed below in [Option Settings](#option-settings) -* `solutionStackName` – (Optional) A solution stack to base your Template +* `solutionStackName` - (Optional) A solution stack to base your Template off of. Example stacks can be found in the [Amazon API documentation][1] ## Option Settings @@ -79,4 +80,4 @@ This resource exports the following attributes in addition to the arguments abov [1]: https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/concepts.platforms.html - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/elastic_beanstalk_environment.html.markdown b/website/docs/cdktf/typescript/r/elastic_beanstalk_environment.html.markdown index c35799eac960..22b5e3360aa1 100644 --- a/website/docs/cdktf/typescript/r/elastic_beanstalk_environment.html.markdown +++ b/website/docs/cdktf/typescript/r/elastic_beanstalk_environment.html.markdown @@ -50,29 +50,30 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) A unique name for this Environment. This name is used in the application URL -* `application` – (Required) Name of the application that contains the version +* `application` - (Required) Name of the application that contains the version to be deployed * `cnamePrefix` - (Optional) Prefix to use for the fully qualified DNS name of the Environment. * `description` - (Optional) Short description of the Environment * `tier` - (Optional) Elastic Beanstalk Environment tier. Valid values are `Worker` or `WebServer`. If tier is left blank `WebServer` will be used. -* `setting` – (Optional) Option settings to configure the new Environment. These +* `setting` - (Optional) Option settings to configure the new Environment. These override specific values that are set as defaults. The format is detailed below in [Option Settings](#option-settings) -* `solutionStackName` – (Optional) A solution stack to base your environment +* `solutionStackName` - (Optional) A solution stack to base your environment off of. Example stacks can be found in the [Amazon API documentation][1] -* `templateName` – (Optional) The name of the Elastic Beanstalk Configuration +* `templateName` - (Optional) The name of the Elastic Beanstalk Configuration template to use in deployment -* `platformArn` – (Optional) The [ARN][2] of the Elastic Beanstalk [Platform][3] +* `platformArn` - (Optional) The [ARN][2] of the Elastic Beanstalk [Platform][3] to use in deployment * `waitForReadyTimeout` - (Default `20m`) The maximum [duration](https://golang.org/pkg/time/#ParseDuration) that Terraform should wait for an Elastic Beanstalk Environment to be in a ready state before timing out. -* `pollInterval` – The time between polling the AWS API to +* `pollInterval` - The time between polling the AWS API to check if changes have been applied. Use this to adjust the rate of API calls for any `create` or `update` action. Minimum `10s`, maximum `180s`. Omit this to use the default behavior, which is an exponential backoff @@ -142,9 +143,9 @@ This resource exports the following attributes in addition to the arguments abov * `description` - Description of the Elastic Beanstalk Environment. * `tier` - The environment tier specified. * `tagsAll` - A map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). -* `application` – The Elastic Beanstalk Application specified for this environment. -* `setting` – Settings specifically set for this Environment. -* `allSettings` – List of all option settings configured in this Environment. These +* `application` - The Elastic Beanstalk Application specified for this environment. +* `setting` - Settings specifically set for this Environment. +* `allSettings` - List of all option settings configured in this Environment. These are a combination of default settings and their overrides from `setting` in the configuration. * `cname` - Fully qualified DNS name for this Environment. @@ -192,4 +193,4 @@ Using `terraform import`, import Elastic Beanstalk Environments using the `id`. % terraform import aws_elastic_beanstalk_environment.prodenv e-rpqsewtp2j ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/elasticache_cluster.html.markdown b/website/docs/cdktf/typescript/r/elasticache_cluster.html.markdown index 3735e946660f..209d42dd46e0 100644 --- a/website/docs/cdktf/typescript/r/elasticache_cluster.html.markdown +++ b/website/docs/cdktf/typescript/r/elasticache_cluster.html.markdown @@ -237,26 +237,24 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This resource supports the following arguments: -* `clusterId` – (Required) Group identifier. ElastiCache converts this name to lowercase. Changing this value will re-create the resource. -* `engine` – (Optional, Required if `replicationGroupId` is not specified) Name of the cache engine to be used for this cache cluster. Valid values are `memcached`, `redis` and `valkey`. -* `nodeType` – (Required unless `replicationGroupId` is provided) The instance class used. +* `clusterId` - (Required) Group identifier. ElastiCache converts this name to lowercase. Changing this value will re-create the resource. +* `engine` - (Optional, Required if `replicationGroupId` is not specified) Name of the cache engine to be used for this cache cluster. Valid values are `memcached`, `redis` and `valkey`. +* `nodeType` - (Required unless `replicationGroupId` is provided) The instance class used. See AWS documentation for information on [supported node types for Valkey or Redis OSS](https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/CacheNodes.SupportedTypes.html#CacheNodes.CurrentGen) and [guidance on selecting node types for Valkey or Redis OSS](https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/CacheNodes.SelectSize.html#CacheNodes.SelectSize.redis). See AWS documentation for information on [supported node types for Memcached](https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/CacheNodes.SupportedTypes.html#CacheNodes.CurrentGen-Memcached) and [guidance on selecting node types for Memcached](https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/CacheNodes.SelectSize.html#CacheNodes.SelectSize.Mem). For Memcached, changing this value will re-create the resource. -* `numCacheNodes` – (Required unless `replicationGroupId` is provided) The initial number of cache nodes that the cache cluster will have. For Redis, this value must be 1. For Memcached, this value must be between 1 and 40. If this number is reduced on subsequent runs, the highest numbered nodes will be removed. -* `parameterGroupName` – (Required unless `replicationGroupId` is provided) The name of the parameter group to associate with this cache cluster. - -The following arguments are optional: - +* `numCacheNodes` - (Required unless `replicationGroupId` is provided) The initial number of cache nodes that the cache cluster will have. For Redis, this value must be 1. For Memcached, this value must be between 1 and 40. If this number is reduced on subsequent runs, the highest numbered nodes will be removed. +* `parameterGroupName` - (Required unless `replicationGroupId` is provided) The name of the parameter group to associate with this cache cluster. +* `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). * `applyImmediately` - (Optional) Whether any database modifications are applied immediately, or during the next maintenance window. Default is `false`. See [Amazon ElastiCache Documentation for more information](https://docs.aws.amazon.com/AmazonElastiCache/latest/APIReference/API_ModifyCacheCluster.html). * `autoMinorVersionUpgrade` - (Optional) Specifies whether minor version engine upgrades will be applied automatically to the underlying Cache Cluster instances during the maintenance window. Only supported for engine type `"redis"` and if the engine version is 6 or higher. Defaults to `true`. * `availabilityZone` - (Optional) Availability Zone for the cache cluster. If you want to create cache nodes in multi-az, use `preferredAvailabilityZones` instead. Default: System chosen Availability Zone. Changing this value will re-create the resource. * `azMode` - (Optional, Memcached only) Whether the nodes in this Memcached node group are created in a single Availability Zone or created across multiple Availability Zones in the cluster's region. Valid values for this parameter are `single-az` or `cross-az`, default is `single-az`. If you want to choose `cross-az`, `numCacheNodes` must be greater than `1`. -* `engineVersion` – (Optional) Version number of the cache engine to be used. +* `engineVersion` - (Optional) Version number of the cache engine to be used. If not set, defaults to the latest version. See [Describe Cache Engine Versions](https://docs.aws.amazon.com/cli/latest/reference/elasticache/describe-cache-engine-versions.html) in the AWS Documentation for supported versions. When `engine` is `redis` and the version is 7 or higher, the major and minor version should be set, e.g., `7.2`. @@ -267,22 +265,22 @@ The following arguments are optional: * `finalSnapshotIdentifier` - (Optional, Redis only) Name of your final cluster snapshot. If omitted, no final snapshot will be made. * `ipDiscovery` - (Optional) The IP version to advertise in the discovery protocol. Valid values are `ipv4` or `ipv6`. * `logDeliveryConfiguration` - (Optional, Redis only) Specifies the destination and format of Redis [SLOWLOG](https://redis.io/commands/slowlog) or Redis [Engine Log](https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/Log_Delivery.html#Log_contents-engine-log). See the documentation on [Amazon ElastiCache](https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/Log_Delivery.html). See [Log Delivery Configuration](#log-delivery-configuration) below for more details. -* `maintenanceWindow` – (Optional) Specifies the weekly time range for when maintenance +* `maintenanceWindow` - (Optional) Specifies the weekly time range for when maintenance on the cache cluster is performed. The format is `ddd:hh24:mi-ddd:hh24:mi` (24H Clock UTC). The minimum maintenance window is a 60 minute period. Example: `sun:05:00-sun:09:00`. * `networkType` - (Optional) The IP versions for cache cluster connections. IPv6 is supported with Redis engine `6.2` onword or Memcached version `1.6.6` for all [Nitro system](https://aws.amazon.com/ec2/nitro/) instances. Valid values are `ipv4`, `ipv6` or `dual_stack`. -* `notificationTopicArn` – (Optional) ARN of an SNS topic to send ElastiCache notifications to. Example: `arn:aws:sns:us-east-1:012345678999:my_sns_topic`. +* `notificationTopicArn` - (Optional) ARN of an SNS topic to send ElastiCache notifications to. Example: `arn:aws:sns:us-east-1:012345678999:my_sns_topic`. * `outpostMode` - (Optional) Specify the outpost mode that will apply to the cache cluster creation. Valid values are `"single-outpost"` and `"cross-outpost"`, however AWS currently only supports `"single-outpost"` mode. -* `port` – (Optional) The port number on which each of the cache nodes will accept connections. For Memcached the default is 11211, and for Redis the default port is 6379. Cannot be provided with `replicationGroupId`. Changing this value will re-create the resource. +* `port` - (Optional) The port number on which each of the cache nodes will accept connections. For Memcached the default is 11211, and for Redis the default port is 6379. Cannot be provided with `replicationGroupId`. Changing this value will re-create the resource. * `preferredAvailabilityZones` - (Optional, Memcached only) List of the Availability Zones in which cache nodes are created. If you are creating your cluster in an Amazon VPC you can only locate nodes in Availability Zones that are associated with the subnets in the selected subnet group. The number of Availability Zones listed must equal the value of `numCacheNodes`. If you want all the nodes in the same Availability Zone, use `availabilityZone` instead, or repeat the Availability Zone multiple times in the list. Default: System chosen Availability Zones. Detecting drift of existing node availability zone is not currently supported. Updating this argument by itself to migrate existing node availability zones is not currently supported and will show a perpetual difference. * `preferredOutpostArn` - (Optional, Required if `outpostMode` is specified) The outpost ARN in which the cache cluster will be created. * `replicationGroupId` - (Optional, Required if `engine` is not specified) ID of the replication group to which this cluster should belong. If this parameter is specified, the cluster is added to the specified replication group as a read replica; otherwise, the cluster is a standalone primary that is not part of any replication group. -* `securityGroupIds` – (Optional, VPC only) One or more VPC security groups associated with the cache cluster. Cannot be provided with `replication_group_id.` -* `snapshotArns` – (Optional, Redis only) Single-element string list containing an Amazon Resource Name (ARN) of a Redis RDB snapshot file stored in Amazon S3. The object name cannot contain any commas. Changing `snapshotArns` forces a new resource. +* `securityGroupIds` - (Optional, VPC only) One or more VPC security groups associated with the cache cluster. Cannot be provided with `replication_group_id.` +* `snapshotArns` - (Optional, Redis only) Single-element string list containing an Amazon Resource Name (ARN) of a Redis RDB snapshot file stored in Amazon S3. The object name cannot contain any commas. Changing `snapshotArns` forces a new resource. * `snapshotName` - (Optional, Redis only) Name of a snapshot from which to restore data into the new node group. Changing `snapshotName` forces a new resource. * `snapshotRetentionLimit` - (Optional, Redis only) Number of days for which ElastiCache will retain automatic cache cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, then a snapshot that was taken today will be retained for 5 days before being deleted. If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off. Please note that setting a `snapshotRetentionLimit` is not supported on cache.t1.micro cache nodes * `snapshotWindow` - (Optional, Redis only) Daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your cache cluster. Example: 05:00-09:00 -* `subnetGroupName` – (Optional, VPC only) Name of the subnet group to be used for the cache cluster. Changing this value will re-create the resource. Cannot be provided with `replication_group_id.` +* `subnetGroupName` - (Optional, VPC only) Name of the subnet group to be used for the cache cluster. Changing this value will re-create the resource. Cannot be provided with `replication_group_id.` * `tags` - (Optional) Map of tags to assign to the resource. If configured with a provider [`defaultTags` 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. * `transitEncryptionEnabled` - (Optional) Enable encryption in-transit. Supported with Memcached versions `1.6.12` and later, Valkey `7.2` and later, Redis OSS versions `3.2.6`, `4.0.10` and later, running in a VPC. See the [ElastiCache in-transit encryption documentation](https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/in-transit-encryption.html#in-transit-encryption-constraints) for more details. @@ -342,4 +340,4 @@ Using `terraform import`, import ElastiCache Clusters using the `clusterId`. For % terraform import aws_elasticache_cluster.my_cluster my_cluster ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/elasticache_global_replication_group.html.markdown b/website/docs/cdktf/typescript/r/elasticache_global_replication_group.html.markdown index 06a7ca680636..bdc6d5dacf09 100644 --- a/website/docs/cdktf/typescript/r/elasticache_global_replication_group.html.markdown +++ b/website/docs/cdktf/typescript/r/elasticache_global_replication_group.html.markdown @@ -61,8 +61,7 @@ The initial Redis version is determined by the version set on the primary replic However, once it is part of a Global Replication Group, the Global Replication Group manages the version of all member replication groups. -The member replication groups must have [`lifecycle.ignore_changes[engine_version]`](https://www.terraform.io/language/meta-arguments/lifecycle) set, -or Terraform will always return a diff. +The provider is configured to ignore changes to `engine`, `engineVersion` and `parameterGroupName` inside `aws_elasticache_replication_group` resources if they belong to a global replication group. In this example, the primary replication group will be created with Redis 6.0, @@ -86,9 +85,6 @@ class MyConvertedCode extends TerraformStack { description: "primary replication group", engine: "redis", engineVersion: "6.0", - lifecycle: { - ignoreChanges: [engineVersion], - }, nodeType: "cache.m5.large", numCacheClusters: 1, replicationGroupId: "example-primary", @@ -101,9 +97,6 @@ class MyConvertedCode extends TerraformStack { new ElasticacheReplicationGroup(this, "secondary", { description: "secondary replication group", globalReplicationGroupId: example.globalReplicationGroupId, - lifecycle: { - ignoreChanges: [engineVersion], - }, numCacheClusters: 1, provider: otherRegion, replicationGroupId: "example-secondary", @@ -117,13 +110,19 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `automaticFailoverEnabled` - (Optional) Specifies whether read-only replicas will be automatically promoted to read/write primary if the existing primary fails. When creating, by default the Global Replication Group inherits the automatic failover setting of the primary replication group. * `cacheNodeType` - (Optional) The instance class used. See AWS documentation for information on [supported node types](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html) and [guidance on selecting node types](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/nodes-select-size.html). When creating, by default the Global Replication Group inherits the node type of the primary replication group. -* `engineVersion` - (Optional) Redis version to use for the Global Replication Group. +* `engine` - (Optional) The name of the cache engine to be used for the clusters in this global replication group. + When creating, by default the Global Replication Group inherits the engine of the primary replication group. + If an engine is specified, the Global Replication Group and all member replication groups will be upgraded to this engine. + Valid values are `redis` or `valkey`. + Default is `redis` if `engineVersion` is specified. +* `engineVersion` - (Optional) Engine version to use for the Global Replication Group. When creating, by default the Global Replication Group inherits the version of the primary replication group. If a version is specified, the Global Replication Group and all member replication groups will be upgraded to this version. Cannot be downgraded without replacing the Global Replication Group and all member replication groups. @@ -131,12 +130,12 @@ This resource supports the following arguments: When the version is 6, the major and minor version can be set, e.g., `6.2`, or the minor version can be unspecified which will use the latest version at creation time, e.g., `6.x`. The actual engine version used is returned in the attribute `engineVersionActual`, see [Attribute Reference](#attribute-reference) below. -* `globalReplicationGroupIdSuffix` – (Required) The suffix name of a Global Datastore. If `globalReplicationGroupIdSuffix` is changed, creates a new resource. -* `primaryReplicationGroupId` – (Required) The ID of the primary cluster that accepts writes and will replicate updates to the secondary cluster. If `primaryReplicationGroupId` is changed, creates a new resource. -* `globalReplicationGroupDescription` – (Optional) A user-created description for the global replication group. +* `globalReplicationGroupIdSuffix` - (Required) The suffix name of a Global Datastore. If `globalReplicationGroupIdSuffix` is changed, creates a new resource. +* `primaryReplicationGroupId` - (Required) The ID of the primary cluster that accepts writes and will replicate updates to the secondary cluster. If `primaryReplicationGroupId` is changed, creates a new resource. +* `globalReplicationGroupDescription` - (Optional) A user-created description for the global replication group. * `numNodeGroups` - (Optional) The number of node groups (shards) on the global replication group. * `parameterGroupName` - (Optional) An ElastiCache Parameter Group to use for the Global Replication Group. - Required when upgrading a major engine version, but will be ignored if left configured after the upgrade is complete. + Required when upgrading an engine or major engine version, but will be ignored if left configured after the upgrade is complete. Specifying without a major version upgrade will fail. Note that ElastiCache creates a copy of this parameter group for each member replication group. @@ -150,7 +149,6 @@ This resource exports the following attributes in addition to the arguments abov * `atRestEncryptionEnabled` - A flag that indicate whether the encryption at rest is enabled. * `authTokenEnabled` - A flag that indicate whether AuthToken (password) is enabled. * `clusterEnabled` - Indicates whether the Global Datastore is cluster enabled. -* `engine` - The name of the cache engine to be used for the clusters in this global replication group. * `globalReplicationGroupId` - The full ID of the global replication group. * `globalNodeGroups` - Set of node groups (shards) on the global replication group. Has the values: @@ -198,4 +196,4 @@ Using `terraform import`, import ElastiCache Global Replication Groups using the % terraform import aws_elasticache_global_replication_group.my_global_replication_group okuqm-global-replication-group-1 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/elasticache_parameter_group.html.markdown b/website/docs/cdktf/typescript/r/elasticache_parameter_group.html.markdown index e1bef8e2473f..e6c461ca9ca6 100644 --- a/website/docs/cdktf/typescript/r/elasticache_parameter_group.html.markdown +++ b/website/docs/cdktf/typescript/r/elasticache_parameter_group.html.markdown @@ -51,6 +51,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) The name of the ElastiCache parameter group. * `family` - (Required) The family of the ElastiCache parameter group. * `description` - (Optional) The description of the ElastiCache parameter group. Defaults to "Managed by Terraform". @@ -102,4 +103,4 @@ Using `terraform import`, import ElastiCache Parameter Groups using the `name`. % terraform import aws_elasticache_parameter_group.default redis-params ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/elasticache_replication_group.html.markdown b/website/docs/cdktf/typescript/r/elasticache_replication_group.html.markdown index 8fb6884299ed..92ac2f482f8e 100644 --- a/website/docs/cdktf/typescript/r/elasticache_replication_group.html.markdown +++ b/website/docs/cdktf/typescript/r/elasticache_replication_group.html.markdown @@ -273,17 +273,18 @@ class MyConvertedCode extends TerraformStack { The following arguments are required: -* `description` – (Required) User-created description for the replication group. Must not be empty. -* `replicationGroupId` – (Required) Replication group identifier. This parameter is stored as a lowercase string. +* `description` - (Required) User-created description for the replication group. Must not be empty. +* `replicationGroupId` - (Required) Replication group identifier. This parameter is stored as a lowercase string. The following arguments are optional: +* `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). * `applyImmediately` - (Optional) Specifies whether any modifications are applied immediately, or during the next maintenance window. Default is `false`. * `atRestEncryptionEnabled` - (Optional) Whether to enable encryption at rest. When `engine` is `redis`, default is `false`. When `engine` is `valkey`, default is `true`. * `authToken` - (Optional) Password used to access a password protected server. Can be specified only if `transit_encryption_enabled = true`. -* `authTokenUpdateStrategy` - (Optional) Strategy to use when updating the `authToken`. Valid values are `SET`, `ROTATE`, and `DELETE`. Defaults to `ROTATE`. +* `authTokenUpdateStrategy` - (Optional) Strategy to use when updating the `authToken`. Valid values are `SET`, `ROTATE`, and `DELETE`. Required if `authToken` is set. * `autoMinorVersionUpgrade` - (Optional) Specifies whether minor version engine upgrades will be applied automatically to the underlying Cache Cluster instances during the maintenance window. Only supported for engine types `"redis"` and `"valkey"` and if the engine version is 6 or higher. Defaults to `true`. @@ -304,7 +305,7 @@ The following arguments are optional: * `ipDiscovery` - (Optional) The IP version to advertise in the discovery protocol. Valid values are `ipv4` or `ipv6`. * `kmsKeyId` - (Optional) The ARN of the key that you wish to use if encrypting at rest. If not supplied, uses service managed encryption. Can be specified only if `at_rest_encryption_enabled = true`. * `logDeliveryConfiguration` - (Optional, Redis only) Specifies the destination and format of Redis OSS/Valkey [SLOWLOG](https://redis.io/commands/slowlog) or Redis OSS/Valkey [Engine Log](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Log_Delivery.html#Log_contents-engine-log). See the documentation on [Amazon ElastiCache](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/Log_Delivery.html#Log_contents-engine-log). See [Log Delivery Configuration](#log-delivery-configuration) below for more details. -* `maintenanceWindow` – (Optional) Specifies the weekly time range for when maintenance on the cache cluster is performed. The format is `ddd:hh24:mi-ddd:hh24:mi` (24H Clock UTC). The minimum maintenance window is a 60 minute period. Example: `sun:05:00-sun:09:00` +* `maintenanceWindow` - (Optional) Specifies the weekly time range for when maintenance on the cache cluster is performed. The format is `ddd:hh24:mi-ddd:hh24:mi` (24H Clock UTC). The minimum maintenance window is a 60 minute period. Example: `sun:05:00-sun:09:00` * `multiAzEnabled` - (Optional) Specifies whether to enable Multi-AZ Support for the replication group. If `true`, `automaticFailoverEnabled` must also be enabled. Defaults to `false`. @@ -313,7 +314,7 @@ The following arguments are optional: See AWS documentation for information on [supported node types](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html) and [guidance on selecting node types](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/nodes-select-size.html). Required unless `globalReplicationGroupId` is set. Cannot be set if `globalReplicationGroupId` is set. -* `notificationTopicArn` – (Optional) ARN of an SNS topic to send ElastiCache notifications to. Example: `arn:aws:sns:us-east-1:012345678999:my_sns_topic` +* `notificationTopicArn` - (Optional) ARN of an SNS topic to send ElastiCache notifications to. Example: `arn:aws:sns:us-east-1:012345678999:my_sns_topic` * `numCacheClusters` - (Optional) Number of cache clusters (primary and replicas) this replication group will have. If `automaticFailoverEnabled` or `multiAzEnabled` are `true`, must be at least 2. Updates will occur before other modifications. @@ -323,7 +324,7 @@ The following arguments are optional: Changing this number will trigger a resizing operation before other settings modifications. Conflicts with `numCacheClusters`. * `parameterGroupName` - (Optional) Name of the parameter group to associate with this replication group. If this argument is omitted, the default cache parameter group for the specified engine is used. To enable "cluster mode", i.e., data sharding, use a parameter group that has the parameter `cluster-enabled` set to true. -* `port` – (Optional) Port number on which each of the cache nodes will accept connections. For Memcache the default is 11211, and for Redis the default port is 6379. +* `port` - (Optional) Port number on which each of the cache nodes will accept connections. For Memcache the default is 11211, and for Redis the default port is 6379. * `preferredCacheClusterAzs` - (Optional) List of EC2 availability zones in which the replication group's cache clusters will be created. The order of the availability zones in the list is considered. The first item in the list will be the primary node. Ignored when updating. * `replicasPerNodeGroup` - (Optional) Number of replica nodes in each node group. Changing this number will trigger a resizing operation before other settings modifications. @@ -332,7 +333,7 @@ The following arguments are optional: Can only be set if `numNodeGroups` is set. * `securityGroupIds` - (Optional) IDs of one or more Amazon VPC security groups associated with this replication group. Use this parameter only when you are creating a replication group in an Amazon Virtual Private Cloud. * `securityGroupNames` - (Optional) Names of one or more Amazon VPC security groups associated with this replication group. Use this parameter only when you are creating a replication group in an Amazon Virtual Private Cloud. -* `snapshotArns` – (Optional) List of ARNs that identify Redis RDB snapshot files stored in Amazon S3. The names object names cannot contain any commas. +* `snapshotArns` - (Optional) List of ARNs that identify Redis RDB snapshot files stored in Amazon S3. The names object names cannot contain any commas. * `snapshotName` - (Optional) Name of a snapshot from which to restore data into the new node group. Changing the `snapshotName` forces a new resource. * `snapshotRetentionLimit` - (Optional, Redis only) Number of days for which ElastiCache will retain automatic cache cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, then a snapshot that was taken today will be retained for 5 days before being deleted. If the value of `snapshotRetentionLimit` is set to zero (0), backups are turned off. Please note that setting a `snapshotRetentionLimit` is not supported on cache.t1.micro cache nodes * `snapshotWindow` - (Optional, Redis only) Daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your cache cluster. The minimum snapshot window is a 60 minute period. Example: `05:00-09:00` @@ -410,4 +411,4 @@ Using `terraform import`, import ElastiCache Replication Groups using the `repli % terraform import aws_elasticache_replication_group.my_replication_group replication-group-1 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/elasticache_reserved_cache_node.html.markdown b/website/docs/cdktf/typescript/r/elasticache_reserved_cache_node.html.markdown index e8c497dd6a9b..961c7642b8d8 100644 --- a/website/docs/cdktf/typescript/r/elasticache_reserved_cache_node.html.markdown +++ b/website/docs/cdktf/typescript/r/elasticache_reserved_cache_node.html.markdown @@ -63,6 +63,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `cacheNodeCount` - (Optional) Number of cache node instances to reserve. Default value is `1`. * `id` - (Optional) Customer-specified identifier to track this reservation. @@ -75,7 +76,7 @@ This resource exports the following attributes in addition to the arguments abov * `arn` - ARN for the reserved cache node. * `duration` - Duration of the reservation as an RFC3339 duration. -* `fixedPrice` – Fixed price charged for this reserved cache node. +* `fixedPrice` - Fixed price charged for this reserved cache node. * `cacheNodeType` - Node type for the reserved cache nodes. * `offeringType` - Offering type of this reserved cache node. * `productDescription` - Engine type for the reserved cache node. @@ -125,4 +126,4 @@ Using `terraform import`, import ElastiCache Reserved Cache Node using the `id`. % terraform import aws_elasticache_reserved_cache_node.example CustomReservationID ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/elasticache_serverless_cache.html.markdown b/website/docs/cdktf/typescript/r/elasticache_serverless_cache.html.markdown index 970ad83f23d7..116ab7da6b3d 100644 --- a/website/docs/cdktf/typescript/r/elasticache_serverless_cache.html.markdown +++ b/website/docs/cdktf/typescript/r/elasticache_serverless_cache.html.markdown @@ -151,21 +151,22 @@ class MyConvertedCode extends TerraformStack { The following arguments are required: -* `engine` – (Required) Name of the cache engine to be used for this cache cluster. Valid values are `memcached`, `redis` or `valkey`. -* `name` – (Required) The Cluster name which serves as a unique identifier to the serverless cache +* `engine` - (Required) Name of the cache engine to be used for this cache cluster. Valid values are `memcached`, `redis` or `valkey`. +* `name` - (Required) The Cluster name which serves as a unique identifier to the serverless cache The following arguments are optional: +* `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). * `cacheUsageLimits` - (Optional) Sets the cache usage limits for storage and ElastiCache Processing Units for the cache. See [`cacheUsageLimits` Block](#cache_usage_limits-block) for details. * `dailySnapshotTime` - (Optional) The daily time that snapshots will be created from the new serverless cache. Only supported for engine types `"redis"` or `"valkey"`. Defaults to `0`. * `description` - (Optional) User-provided description for the serverless cache. The default is NULL. * `kmsKeyId` - (Optional) ARN of the customer managed key for encrypting the data at rest. If no KMS key is provided, a default service key is used. -* `majorEngineVersion` – (Optional) The version of the cache engine that will be used to create the serverless cache. +* `majorEngineVersion` - (Optional) The version of the cache engine that will be used to create the serverless cache. See [Describe Cache Engine Versions](https://docs.aws.amazon.com/cli/latest/reference/elasticache/describe-cache-engine-versions.html) in the AWS Documentation for supported versions. * `securityGroupIds` - (Optional) A list of the one or more VPC security groups to be associated with the serverless cache. The security group will authorize traffic access for the VPC end-point (private-link). If no other information is given this will be the VPC’s Default Security Group that is associated with the cluster VPC end-point. * `snapshotArnsToRestore` - (Optional, Redis only) The list of ARN(s) of the snapshot that the new serverless cache will be created from. Available for Redis only. * `snapshotRetentionLimit` - (Optional, Redis only) The number of snapshots that will be retained for the serverless cache that is being created. As new snapshots beyond this limit are added, the oldest snapshots will be deleted on a rolling basis. Available for Redis only. -* `subnetIds` – (Optional) A list of the identifiers of the subnets where the VPC endpoint for the serverless cache will be deployed. All the subnetIds must belong to the same VPC. +* `subnetIds` - (Optional) A list of the identifiers of the subnets where the VPC endpoint for the serverless cache will be deployed. All the subnetIds must belong to the same VPC. * `tags` - (Optional) Map of tags to assign to the resource. If configured with a provider [`defaultTags` 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. * `userGroupId` - (Optional) The identifier of the UserGroup to be associated with the serverless cache. Available for Redis only. Default is NULL. @@ -257,4 +258,4 @@ Using `terraform import`, import ElastiCache Serverless Cache using the `name`. % terraform import aws_elasticache_serverless_cache.my_cluster my_cluster ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/elasticache_subnet_group.html.markdown b/website/docs/cdktf/typescript/r/elasticache_subnet_group.html.markdown index 6cb8466fe2b6..1a5a85dd9ce0 100644 --- a/website/docs/cdktf/typescript/r/elasticache_subnet_group.html.markdown +++ b/website/docs/cdktf/typescript/r/elasticache_subnet_group.html.markdown @@ -57,9 +57,10 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: -* `name` – (Required) Name for the cache subnet group. ElastiCache converts this name to lowercase. -* `description` – (Optional) Description for the cache subnet group. Defaults to "Managed by Terraform". -* `subnetIds` – (Required) List of VPC Subnet IDs for the cache subnet group +* `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). +* `name` - (Required) Name for the cache subnet group. ElastiCache converts this name to lowercase. +* `description` - (Optional) Description for the cache subnet group. Defaults to "Managed by Terraform". +* `subnetIds` - (Required) List of VPC Subnet IDs for the cache subnet group * `tags` - (Optional) Key-value map of resource tags. If configured with a provider [`defaultTags` 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. ## Attribute Reference @@ -101,4 +102,4 @@ Using `terraform import`, import ElastiCache Subnet Groups using the `name`. For % terraform import aws_elasticache_subnet_group.bar tf-test-cache-subnet ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/elasticache_user.html.markdown b/website/docs/cdktf/typescript/r/elasticache_user.html.markdown index 08e4f195de55..bae3f546da61 100644 --- a/website/docs/cdktf/typescript/r/elasticache_user.html.markdown +++ b/website/docs/cdktf/typescript/r/elasticache_user.html.markdown @@ -106,6 +106,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `authenticationMode` - (Optional) Denotes the user's authentication properties. Detailed below. * `noPasswordRequired` - (Optional) Indicates a password is not required for this user. * `passwords` - (Optional) Passwords used for this user. You can create up to two passwords for each user. @@ -159,4 +160,4 @@ Using `terraform import`, import ElastiCache users using the `userId`. For examp % terraform import aws_elasticache_user.my_user userId1 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/elasticache_user_group.html.markdown b/website/docs/cdktf/typescript/r/elasticache_user_group.html.markdown index 7ba15924af71..07538d3994e1 100644 --- a/website/docs/cdktf/typescript/r/elasticache_user_group.html.markdown +++ b/website/docs/cdktf/typescript/r/elasticache_user_group.html.markdown @@ -60,6 +60,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `userIds` - (Optional) The list of user IDs that belong to the user group. * `tags` - (Optional) Key-value map of resource tags. If configured with a provider [`defaultTags` 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. @@ -103,4 +104,4 @@ Using `terraform import`, import ElastiCache user groups using the `userGroupId` % terraform import aws_elasticache_user_group.my_user_group userGoupId1 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/elasticache_user_group_association.html.markdown b/website/docs/cdktf/typescript/r/elasticache_user_group_association.html.markdown index 0ece3367ce38..2204eec53d0f 100644 --- a/website/docs/cdktf/typescript/r/elasticache_user_group_association.html.markdown +++ b/website/docs/cdktf/typescript/r/elasticache_user_group_association.html.markdown @@ -74,8 +74,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `userGroupId` - (Required) ID of the user group. * `userId` - (Required) ID of the user to associated with the user group. @@ -122,4 +123,4 @@ Using `terraform import`, import ElastiCache user group associations using the ` % terraform import aws_elasticache_user_group_association.example userGoupId1,userId ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/elasticsearch_domain.html.markdown b/website/docs/cdktf/typescript/r/elasticsearch_domain.html.markdown index 7f6237641f3a..97d26695727e 100644 --- a/website/docs/cdktf/typescript/r/elasticsearch_domain.html.markdown +++ b/website/docs/cdktf/typescript/r/elasticsearch_domain.html.markdown @@ -73,7 +73,7 @@ class MyConvertedCode extends TerraformStack { new ElasticsearchDomain(this, "example", { accessPolicies: '{\n "Version": "2012-10-17",\n "Statement": [\n {\n "Action": "es:*",\n "Principal": "*",\n "Effect": "Allow",\n "Resource": "arn:aws:es:${' + - dataAwsRegionCurrent.name + + dataAwsRegionCurrent.region + "}:${" + current.accountId + "}:domain/${" + @@ -230,7 +230,7 @@ class MyConvertedCode extends TerraformStack { const awsElasticsearchDomainEs = new ElasticsearchDomain(this, "es_8", { accessPolicies: '{\n\t"Version": "2012-10-17",\n\t"Statement": [\n\t\t{\n\t\t\t"Action": "es:*",\n\t\t\t"Principal": "*",\n\t\t\t"Effect": "Allow",\n\t\t\t"Resource": "arn:aws:es:${' + - dataAwsRegionCurrent.name + + dataAwsRegionCurrent.region + "}:${" + current.accountId + "}:domain/${" + @@ -272,6 +272,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `accessPolicies` - (Optional) IAM policy document specifying the access policies for the domain. * `advancedOptions` - (Optional) Key-value string pairs to specify advanced configuration options. Note that the values for these configuration options must be strings (wrapped in quotes) or they may be wrong and cause a perpetual diff, causing Terraform to want to recreate your Elasticsearch domain on every apply. * `advancedSecurityOptions` - (Optional) Configuration block for [fine-grained access control](https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/fgac.html). Detailed below. @@ -404,7 +405,6 @@ This resource exports the following attributes in addition to the arguments abov * `arn` - ARN of the domain. * `domainId` - Unique identifier for the domain. -* `domainName` - Name of the Elasticsearch domain. * `endpoint` - Domain-specific endpoint used to submit index, search, and data upload requests. * `kibanaEndpoint` - Domain-specific endpoint for kibana without https scheme. * `tagsAll` - Map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). @@ -447,4 +447,4 @@ Using `terraform import`, import Elasticsearch domains using the `domainName`. F % terraform import aws_elasticsearch_domain.example domain_name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/elasticsearch_domain_policy.html.markdown b/website/docs/cdktf/typescript/r/elasticsearch_domain_policy.html.markdown index ec5d86f49c38..e012baeed50a 100644 --- a/website/docs/cdktf/typescript/r/elasticsearch_domain_policy.html.markdown +++ b/website/docs/cdktf/typescript/r/elasticsearch_domain_policy.html.markdown @@ -47,6 +47,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `domainName` - (Required) Name of the domain. * `accessPolicies` - (Optional) IAM policy document specifying the access policies for the domain @@ -54,4 +55,4 @@ This resource supports the following arguments: This resource exports no additional attributes. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/elasticsearch_domain_saml_options.html.markdown b/website/docs/cdktf/typescript/r/elasticsearch_domain_saml_options.html.markdown index 9524d15b7dd4..895721a16a90 100644 --- a/website/docs/cdktf/typescript/r/elasticsearch_domain_saml_options.html.markdown +++ b/website/docs/cdktf/typescript/r/elasticsearch_domain_saml_options.html.markdown @@ -68,6 +68,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `samlOptions` - (Optional) The SAML authentication options for an AWS Elasticsearch Domain. ### saml_options @@ -123,4 +124,4 @@ Using `terraform import`, import Elasticsearch domains using the `domainName`. F % terraform import aws_elasticsearch_domain_saml_options.example domain_name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/elasticsearch_vpc_endpoint.html.markdown b/website/docs/cdktf/typescript/r/elasticsearch_vpc_endpoint.html.markdown index 41eadc4a56c0..eaea90a25370 100644 --- a/website/docs/cdktf/typescript/r/elasticsearch_vpc_endpoint.html.markdown +++ b/website/docs/cdktf/typescript/r/elasticsearch_vpc_endpoint.html.markdown @@ -47,6 +47,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `domainArn` - (Required, Forces new resource) Specifies the Amazon Resource Name (ARN) of the domain to create the endpoint for * `vpcOptions` - (Required) Options to specify the subnets and security groups for the endpoint. @@ -102,4 +103,4 @@ Using `terraform import`, import elasticsearch VPC endpoint connections using th % terraform import aws_elasticsearch_vpc_endpoint_connection.example endpoint-id ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/elastictranscoder_pipeline.html.markdown b/website/docs/cdktf/typescript/r/elastictranscoder_pipeline.html.markdown index 409c73aa4df9..e5be522da8dc 100644 --- a/website/docs/cdktf/typescript/r/elastictranscoder_pipeline.html.markdown +++ b/website/docs/cdktf/typescript/r/elastictranscoder_pipeline.html.markdown @@ -12,6 +12,8 @@ description: |- Provides an Elastic Transcoder pipeline resource. +~> **Warning:** This resource is deprecated. Use [AWS Elemental MediaConvert](https://aws.amazon.com/blogs/media/migrating-workflows-from-amazon-elastic-transcoder-to-aws-elemental-mediaconvert/) instead. AWS will [discontinue support for Amazon Elastic Transcoder](https://aws.amazon.com/blogs/media/support-for-amazon-elastic-transcoder-ending-soon/), effective November 13, 2025. + ## Example Usage ```typescript @@ -48,6 +50,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `awsKmsKeyArn` - (Optional) The AWS Key Management Service (AWS KMS) key that you want to use with this pipeline. * `contentConfig` - (Optional) The ContentConfig object specifies information about the Amazon S3 bucket in which you want Elastic Transcoder to save transcoded files and playlists. (documented below) * `contentConfigPermissions` - (Optional) The permissions for the `contentConfig` object. (documented below) @@ -146,4 +149,4 @@ Using `terraform import`, import Elastic Transcoder pipelines using the `id`. Fo % terraform import aws_elastictranscoder_pipeline.basic_pipeline 1407981661351-cttk8b ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/elastictranscoder_preset.html.markdown b/website/docs/cdktf/typescript/r/elastictranscoder_preset.html.markdown index 7902ab885e97..6e3f8d871a5c 100644 --- a/website/docs/cdktf/typescript/r/elastictranscoder_preset.html.markdown +++ b/website/docs/cdktf/typescript/r/elastictranscoder_preset.html.markdown @@ -12,6 +12,8 @@ description: |- Provides an Elastic Transcoder preset resource. +~> **Warning:** This resource is deprecated. Use [AWS Elemental MediaConvert](https://aws.amazon.com/blogs/media/migrating-workflows-from-amazon-elastic-transcoder-to-aws-elemental-mediaconvert/) instead. AWS will [discontinue support for Amazon Elastic Transcoder](https://aws.amazon.com/blogs/media/support-for-amazon-elastic-transcoder-ending-soon/), effective November 13, 2025. + ## Example Usage ```typescript @@ -92,6 +94,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `audio` - (Optional, Forces new resource) Audio parameters object (documented below). * `audioCodecOptions` - (Optional, Forces new resource) Codec options for the audio parameters (documented below) * `container` - (Required, Forces new resource) The container type for the output file. Valid values are `flac`, `flv`, `fmp4`, `gif`, `mp3`, `mp4`, `mpg`, `mxf`, `oga`, `ogg`, `ts`, and `webm`. @@ -209,4 +212,4 @@ Using `terraform import`, import Elastic Transcoder presets using the `id`. For % terraform import aws_elastictranscoder_preset.basic_preset 1407981661351-cttk8b ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/elb.html.markdown b/website/docs/cdktf/typescript/r/elb.html.markdown index 81f0c64ed07b..1030370d114c 100644 --- a/website/docs/cdktf/typescript/r/elb.html.markdown +++ b/website/docs/cdktf/typescript/r/elb.html.markdown @@ -84,6 +84,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Optional) The name of the ELB. By default generated by Terraform. * `namePrefix` - (Optional, Forces new resource) Creates a unique name beginning with the specified prefix. Conflicts with `name`. @@ -189,4 +190,4 @@ Using `terraform import`, import ELBs using the `name`. For example: % terraform import aws_elb.bar elb-production-12345 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/elb_attachment.html.markdown b/website/docs/cdktf/typescript/r/elb_attachment.html.markdown index dff08fb643f4..6871d8b75679 100644 --- a/website/docs/cdktf/typescript/r/elb_attachment.html.markdown +++ b/website/docs/cdktf/typescript/r/elb_attachment.html.markdown @@ -46,6 +46,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `elb` - (Required) The name of the ELB. * `instance` - (Required) Instance ID to place in the ELB pool. @@ -53,4 +54,4 @@ This resource supports the following arguments: This resource exports no additional attributes. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/emr_block_public_access_configuration.html.markdown b/website/docs/cdktf/typescript/r/emr_block_public_access_configuration.html.markdown index e46a459484d4..c97db031accb 100644 --- a/website/docs/cdktf/typescript/r/emr_block_public_access_configuration.html.markdown +++ b/website/docs/cdktf/typescript/r/emr_block_public_access_configuration.html.markdown @@ -134,6 +134,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `permittedPublicSecurityGroupRuleRange` - (Optional) Configuration block for defining permitted public security group rule port ranges. Can be defined multiple times per resource. Only valid if `blockPublicSecurityGroupRules` is set to `true`. ### `permittedPublicSecurityGroupRuleRange` @@ -179,4 +180,4 @@ Using `terraform import`, import the current EMR Block Public Access Configurati % terraform import aws_emr_block_public_access_configuration.example current ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/emr_cluster.html.markdown b/website/docs/cdktf/typescript/r/emr_cluster.html.markdown index 9e40de2f1729..8d2f6b575035 100644 --- a/website/docs/cdktf/typescript/r/emr_cluster.html.markdown +++ b/website/docs/cdktf/typescript/r/emr_cluster.html.markdown @@ -628,6 +628,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `additionalInfo` - (Optional) JSON string for selecting additional features such as adding proxy information. Note: Currently there is no API to retrieve the value of this argument after EMR cluster creation from provider, therefore Terraform cannot detect drift from the actual EMR cluster if its value is changed outside Terraform. * `applications` - (Optional) A case-insensitive list of applications for Amazon EMR to install and configure when launching the cluster. For a list of applications available for each Amazon EMR release version, see the [Amazon EMR Release Guide](https://docs.aws.amazon.com/emr/latest/ReleaseGuide/emr-release-components.html). * `autoscalingRole` - (Optional) IAM role for automatic scaling policies. The IAM role provides permissions that the automatic scaling feature requires to launch and terminate EC2 instances in an instance group. @@ -679,6 +680,7 @@ class MyConvertedCode extends TerraformStack { * `logUri` - (Optional) S3 bucket to write the log files of the job flow. If a value is not provided, logs are not created. * `masterInstanceFleet` - (Optional) Configuration block to use an [Instance Fleet](https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-instance-fleet.html) for the master node type. Cannot be specified if any `masterInstanceGroup` configuration blocks are set. Detailed below. * `masterInstanceGroup` - (Optional) Configuration block to use an [Instance Group](https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-instance-group-configuration.html#emr-plan-instance-groups) for the [master node type](https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-master-core-task-nodes.html#emr-plan-master). +* `osReleaseLabel` - (Optional) Amazon Linux release for all nodes in a cluster launch RunJobFlow request. If not specified, Amazon EMR uses the latest validated Amazon Linux release for cluster launch. * `placementGroupConfig` - (Optional) The specified placement group configuration for an Amazon EMR cluster. * `scaleDownBehavior` - (Optional) Way that individual Amazon EC2 instances terminate when an automatic scale-in activity occurs or an `instance group` is resized. * `securityConfiguration` - (Optional) Security configuration name to attach to the EMR cluster. Only valid for EMR clusters with `releaseLabel` 4.8.0 or greater. @@ -689,6 +691,8 @@ class MyConvertedCode extends TerraformStack { * `unhealthyNodeReplacement` - (Optional) Whether whether Amazon EMR should gracefully replace core nodes that have degraded within the cluster. Default value is `false`. * `visibleToAllUsers` - (Optional) Whether the job flow is visible to all IAM users of the AWS account associated with the job flow. Default value is `true`. + **NOTE:** As per the [Amazon EMR API Reference](https://docs.aws.amazon.com/emr/latest/APIReference/API_RunJobFlow.html#EMR-RunJobFlow-request-VisibleToAllUsers), this argument is no longer supported. Do not set this argument, particularly to `false`, as it would lead to perpetual differences. + ### bootstrap_action * `args` - (Optional) List of command line arguments to pass to the bootstrap action script. @@ -855,7 +859,6 @@ This resource exports the following attributes in addition to the arguments abov * `releaseLabel` - Release label for the Amazon EMR release. * `serviceRole` - IAM role that will be assumed by the Amazon EMR service to access AWS resources on your behalf. * `tagsAll` - Map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). -* `visibleToAllUsers` - Indicates whether the job flow is visible to all IAM users of the AWS account associated with the job flow. ## Import @@ -917,4 +920,4 @@ class MyConvertedCode extends TerraformStack { ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/emr_instance_fleet.html.markdown b/website/docs/cdktf/typescript/r/emr_instance_fleet.html.markdown index 8d770c460f93..a02a8f175f0b 100644 --- a/website/docs/cdktf/typescript/r/emr_instance_fleet.html.markdown +++ b/website/docs/cdktf/typescript/r/emr_instance_fleet.html.markdown @@ -82,6 +82,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `clusterId` - (Required) ID of the EMR Cluster to attach to. Changing this forces a new resource to be created. * `instanceTypeConfigs` - (Optional) Configuration block for instance fleet * `launchSpecifications` - (Optional) Configuration block for launch specification @@ -181,4 +182,4 @@ Using `terraform import`, import EMR Instance Fleet using the EMR Cluster identi % terraform import aws_emr_instance_fleet.example j-123456ABCDEF/if-15EK4O09RZLNR ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/emr_instance_group.html.markdown b/website/docs/cdktf/typescript/r/emr_instance_group.html.markdown index a6c3124308f6..3ccaf5c3a125 100644 --- a/website/docs/cdktf/typescript/r/emr_instance_group.html.markdown +++ b/website/docs/cdktf/typescript/r/emr_instance_group.html.markdown @@ -46,6 +46,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` (Required) Human friendly name given to the instance group. Changing this forces a new resource to be created. * `clusterId` (Required) ID of the EMR Cluster to attach to. Changing this forces a new resource to be created. * `instanceType` (Required) The EC2 instance type for all instances in the instance group. Changing this forces a new resource to be created. @@ -130,4 +131,4 @@ Using `terraform import`, import EMR task instance group using their EMR Cluster % terraform import aws_emr_instance_group.task_group j-123456ABCDEF/ig-15EK4O09RZLNR ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/emr_managed_scaling_policy.html.markdown b/website/docs/cdktf/typescript/r/emr_managed_scaling_policy.html.markdown index e5709a043239..4b4ea1b648b8 100644 --- a/website/docs/cdktf/typescript/r/emr_managed_scaling_policy.html.markdown +++ b/website/docs/cdktf/typescript/r/emr_managed_scaling_policy.html.markdown @@ -62,6 +62,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `clusterId` - (Required) ID of the EMR cluster * `computeLimits` - (Required) Configuration block with compute limit settings. Described below. @@ -109,4 +110,4 @@ Using `terraform import`, import EMR Managed Scaling Policies using the EMR Clus % terraform import aws_emr_managed_scaling_policy.example j-123456ABCDEF ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/emr_security_configuration.html.markdown b/website/docs/cdktf/typescript/r/emr_security_configuration.html.markdown index 0a1a8e0c6649..52acbcc123c7 100644 --- a/website/docs/cdktf/typescript/r/emr_security_configuration.html.markdown +++ b/website/docs/cdktf/typescript/r/emr_security_configuration.html.markdown @@ -40,6 +40,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Optional) The name of the EMR Security Configuration. By default generated by Terraform. * `namePrefix` - (Optional) Creates a unique name beginning with the specified prefix. Conflicts with `name`. @@ -86,4 +87,4 @@ Using `terraform import`, import EMR Security Configurations using the `name`. F % terraform import aws_emr_security_configuration.sc example-sc-name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/emr_studio.html.markdown b/website/docs/cdktf/typescript/r/emr_studio.html.markdown index 0d2e8b3962fa..f2f1747e6c47 100644 --- a/website/docs/cdktf/typescript/r/emr_studio.html.markdown +++ b/website/docs/cdktf/typescript/r/emr_studio.html.markdown @@ -57,6 +57,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `description` - (Optional) A detailed description of the Amazon EMR Studio. * `encryptionKeyArn` - (Optional) The AWS KMS key identifier (ARN) used to encrypt Amazon EMR Studio workspace and notebook files when backed up to Amazon S3. * `idpAuthUrl` - (Optional) The authentication endpoint of your identity provider (IdP). Specify this value when you use IAM authentication and want to let federated users log in to a Studio with the Studio URL and credentials from your IdP. Amazon EMR Studio redirects users to this endpoint to enter credentials. @@ -99,4 +100,4 @@ Using `terraform import`, import EMR studios using the `id`. For example: % terraform import aws_emr_studio.studio es-123456ABCDEF ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/emr_studio_session_mapping.html.markdown b/website/docs/cdktf/typescript/r/emr_studio_session_mapping.html.markdown index 68fd77495ce8..cc132b5966a4 100644 --- a/website/docs/cdktf/typescript/r/emr_studio_session_mapping.html.markdown +++ b/website/docs/cdktf/typescript/r/emr_studio_session_mapping.html.markdown @@ -41,6 +41,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `identityId`- (Optional) The globally unique identifier (GUID) of the user or group from the Amazon Web Services SSO Identity Store. * `identityName` - (Optional) The name of the user or group from the Amazon Web Services SSO Identity Store. * `identityType` - (Required) Specifies whether the identity to map to the Amazon EMR Studio is a `USER` or a `GROUP`. @@ -85,4 +86,4 @@ Using `terraform import`, import EMR studio session mappings using `studio-id:id % terraform import aws_emr_studio_session_mapping.example es-xxxxx:USER:xxxxx-xxx-xxx ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/emrcontainers_job_template.html.markdown b/website/docs/cdktf/typescript/r/emrcontainers_job_template.html.markdown index b2a91ef0103d..7657a9b0cd38 100644 --- a/website/docs/cdktf/typescript/r/emrcontainers_job_template.html.markdown +++ b/website/docs/cdktf/typescript/r/emrcontainers_job_template.html.markdown @@ -49,9 +49,10 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `jobTemplateData` - (Required) The job template data which holds values of StartJobRun API request. * `kmsKeyArn` - (Optional) The KMS key ARN used to encrypt the job template. -* `name` – (Required) The specified name of the job template. +* `name` - (Required) The specified name of the job template. * `tags` - (Optional) Key-value mapping of resource tags. If configured with a provider [`defaultTags` 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. ### job_template_data Arguments @@ -144,4 +145,4 @@ Using `terraform import`, import EKS job templates using the `id`. For example: % terraform import aws_emrcontainers_job_template.example a1b2c3d4e5f6g7h8i9j10k11l ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/emrcontainers_virtual_cluster.html.markdown b/website/docs/cdktf/typescript/r/emrcontainers_virtual_cluster.html.markdown index 067bce9e1e6b..8c4d1deee822 100644 --- a/website/docs/cdktf/typescript/r/emrcontainers_virtual_cluster.html.markdown +++ b/website/docs/cdktf/typescript/r/emrcontainers_virtual_cluster.html.markdown @@ -49,8 +49,9 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `containerProvider` - (Required) Configuration block for the container provider associated with your cluster. -* `name` – (Required) Name of the virtual cluster. +* `name` - (Required) Name of the virtual cluster. * `tags` - (Optional) Key-value mapping of resource tags. If configured with a provider [`defaultTags` 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. ### container_provider Arguments @@ -101,4 +102,4 @@ Using `terraform import`, import EKS Clusters using the `id`. For example: % terraform import aws_emrcontainers_virtual_cluster.example a1b2c3d4e5f6g7h8i9j10k11l ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/emrserverless_application.html.markdown b/website/docs/cdktf/typescript/r/emrserverless_application.html.markdown index 15ebc5907102..4f3f346e1a48 100644 --- a/website/docs/cdktf/typescript/r/emrserverless_application.html.markdown +++ b/website/docs/cdktf/typescript/r/emrserverless_application.html.markdown @@ -106,17 +106,18 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: -* `architecture` – (Optional) The CPU architecture of an application. Valid values are `ARM64` or `X86_64`. Default value is `X86_64`. -* `autoStartConfiguration` – (Optional) The configuration for an application to automatically start on job submission. -* `autoStopConfiguration` – (Optional) The configuration for an application to automatically stop after a certain amount of time being idle. -* `imageConfiguration` – (Optional) The image configuration applied to all worker types. -* `initialCapacity` – (Optional) The capacity to initialize when the application is created. -* `interactiveConfiguration` – (Optional) Enables the interactive use cases to use when running an application. -* `maximumCapacity` – (Optional) The maximum capacity to allocate when the application is created. This is cumulative across all workers at any given point in time, not just when an application is created. No new resources will be created once any one of the defined limits is hit. -* `name` – (Required) The name of the application. -* `networkConfiguration` – (Optional) The network configuration for customer VPC connectivity. -* `releaseLabel` – (Required) The EMR release version associated with the application. -* `type` – (Required) The type of application you want to start, such as `spark` or `hive`. +* `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). +* `architecture` - (Optional) The CPU architecture of an application. Valid values are `ARM64` or `X86_64`. Default value is `X86_64`. +* `autoStartConfiguration` - (Optional) The configuration for an application to automatically start on job submission. +* `autoStopConfiguration` - (Optional) The configuration for an application to automatically stop after a certain amount of time being idle. +* `imageConfiguration` - (Optional) The image configuration applied to all worker types. +* `initialCapacity` - (Optional) The capacity to initialize when the application is created. +* `interactiveConfiguration` - (Optional) Enables the interactive use cases to use when running an application. +* `maximumCapacity` - (Optional) The maximum capacity to allocate when the application is created. This is cumulative across all workers at any given point in time, not just when an application is created. No new resources will be created once any one of the defined limits is hit. +* `name` - (Required) The name of the application. +* `networkConfiguration` - (Optional) The network configuration for customer VPC connectivity. +* `releaseLabel` - (Required) The EMR release version associated with the application. +* `type` - (Required) The type of application you want to start, such as `spark` or `hive`. * `tags` - (Optional) Key-value mapping of resource tags. If configured with a provider [`defaultTags` 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. ### auto_start_configuration Arguments @@ -200,4 +201,4 @@ Using `terraform import`, import EMR Severless applications using the `id`. For % terraform import aws_emrserverless_application.example id ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/evidently_feature.html.markdown b/website/docs/cdktf/typescript/r/evidently_feature.html.markdown index d6ebd422a59d..828bbef4b238 100644 --- a/website/docs/cdktf/typescript/r/evidently_feature.html.markdown +++ b/website/docs/cdktf/typescript/r/evidently_feature.html.markdown @@ -12,6 +12,8 @@ description: |- Provides a CloudWatch Evidently Feature resource. +~> **Warning:** This resource is deprecated. Use [AWS AppConfig feature flags](https://aws.amazon.com/blogs/mt/using-aws-appconfig-feature-flags/) instead. + ## Example Usage ### Basic @@ -166,6 +168,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `defaultVariation` - (Optional) The name of the variation to use as the default variation. The default variation is served to users who are not allocated to any ongoing launches or experiments of this feature. This variation must also be listed in the `variations` structure. If you omit `defaultVariation`, the first variation listed in the `variations` structure is used as the default variation. * `description` - (Optional) Specifies the description of the feature. * `entityOverrides` - (Optional) Specify users that should always be served a specific variation of a feature. Each user is specified by a key-value pair . For each key, specify a user by entering their user ID, account ID, or some other identifier. For the value, specify the name of the variation that they are to be served. @@ -253,4 +256,4 @@ Using `terraform import`, import CloudWatch Evidently Feature using the feature % terraform import aws_evidently_feature.example exampleFeatureName:arn:aws:evidently:us-east-1:123456789012:project/example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/evidently_launch.html.markdown b/website/docs/cdktf/typescript/r/evidently_launch.html.markdown index 564a2417b311..d797fb479ff5 100644 --- a/website/docs/cdktf/typescript/r/evidently_launch.html.markdown +++ b/website/docs/cdktf/typescript/r/evidently_launch.html.markdown @@ -12,6 +12,8 @@ description: |- Provides a CloudWatch Evidently Launch resource. +~> **Warning:** This resource is deprecated. Use [AWS AppConfig feature flags](https://aws.amazon.com/blogs/mt/using-aws-appconfig-feature-flags/) instead. + ## Example Usage ### Basic @@ -366,6 +368,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `description` - (Optional) Specifies the description of the launch. * `groups` - (Required) One or up to five blocks that contain the feature and variations that are to be used for the launch. [Detailed below](#groups). * `metricMonitors` - (Optional) One or up to three blocks that define the metrics that will be used to monitor the launch performance. [Detailed below](#metric_monitors). @@ -515,4 +518,4 @@ Import using the `name` of the launch and `arn` of the project separated by a `: % terraform import aws_evidently_launch.example exampleLaunchName:arn:aws:evidently:us-east-1:123456789012:project/exampleProjectName ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/evidently_project.html.markdown b/website/docs/cdktf/typescript/r/evidently_project.html.markdown index d3510e616782..4b5decac50d7 100644 --- a/website/docs/cdktf/typescript/r/evidently_project.html.markdown +++ b/website/docs/cdktf/typescript/r/evidently_project.html.markdown @@ -12,6 +12,8 @@ description: |- Provides a CloudWatch Evidently Project resource. +~> **Warning:** This resource is deprecated. Use [AWS AppConfig feature flags](https://aws.amazon.com/blogs/mt/using-aws-appconfig-feature-flags/) instead. + ## Example Usage ### Basic @@ -107,6 +109,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `dataDelivery` - (Optional) A block that contains information about where Evidently is to store evaluation events for longer term storage, if you choose to do so. If you choose not to store these events, Evidently deletes them after using them to produce metrics and other experiment results that you can view. See below. * `description` - (Optional) Specifies the description of the project. * `name` - (Required) A name for the project. @@ -184,4 +187,4 @@ Using `terraform import`, import CloudWatch Evidently Project using the `arn`. F % terraform import aws_evidently_project.example arn:aws:evidently:us-east-1:123456789012:segment/example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/evidently_segment.html.markdown b/website/docs/cdktf/typescript/r/evidently_segment.html.markdown index a368c2a4df3e..a93bb499be10 100644 --- a/website/docs/cdktf/typescript/r/evidently_segment.html.markdown +++ b/website/docs/cdktf/typescript/r/evidently_segment.html.markdown @@ -12,6 +12,8 @@ description: |- Provides a CloudWatch Evidently Segment resource. +~> **Warning:** This resource is deprecated. Use [AWS AppConfig feature flags](https://aws.amazon.com/blogs/mt/using-aws-appconfig-feature-flags/) instead. + ## Example Usage ### Basic @@ -95,6 +97,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `description` - (Optional, Forces new resource) Specifies the description of the segment. * `name` - (Required, Forces new resource) A name for the segment. * `pattern` - (Required, Forces new resource) The pattern to use for the segment. For more information about pattern syntax, see [Segment rule pattern syntax](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Evidently-segments.html#CloudWatch-Evidently-segments-syntax.html). @@ -144,4 +147,4 @@ Using `terraform import`, import CloudWatch Evidently Segment using the `arn`. F % terraform import aws_evidently_segment.example arn:aws:evidently:us-west-2:123456789012:segment/example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/finspace_kx_cluster.html.markdown b/website/docs/cdktf/typescript/r/finspace_kx_cluster.html.markdown index fee38d1c1fe4..091355f6b8d2 100644 --- a/website/docs/cdktf/typescript/r/finspace_kx_cluster.html.markdown +++ b/website/docs/cdktf/typescript/r/finspace_kx_cluster.html.markdown @@ -94,11 +94,12 @@ The following arguments are required: * RDB - Realtime Database. This type of database captures all the data from a ticker plant and stores it in memory until the end of day, after which it writes all of its data to a disk and reloads the HDB. This cluster type requires local storage for temporary storage of data during the savedown process. If you specify this field in your request, you must provide the `savedownStorageConfiguration` parameter. * GATEWAY - A gateway cluster allows you to access data across processes in kdb systems. It allows you to create your own routing logic using the initialization scripts and custom code. This type of cluster does not require a writable local storage. * GP - A general purpose cluster allows you to quickly iterate on code during development by granting greater access to system commands and enabling a fast reload of custom code. This cluster type can optionally mount databases including cache and savedown storage. For this cluster type, the node count is fixed at 1. It does not support autoscaling and supports only `SINGLE` AZ mode. - * Tickerplant – A tickerplant cluster allows you to subscribe to feed handlers based on IAM permissions. It can publish to RDBs, other Tickerplants, and real-time subscribers (RTS). Tickerplants can persist messages to log, which is readable by any RDB environment. It supports only single-node that is only one kdb process. + * Tickerplant - A tickerplant cluster allows you to subscribe to feed handlers based on IAM permissions. It can publish to RDBs, other Tickerplants, and real-time subscribers (RTS). Tickerplants can persist messages to log, which is readable by any RDB environment. It supports only single-node that is only one kdb process. * `vpcConfiguration` - (Required) Configuration details about the network where the Privatelink endpoint of the cluster resides. See [vpc_configuration](#vpc_configuration). The following arguments are optional: +* `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). * `autoScalingConfiguration` - (Optional) Configuration based on which FinSpace will scale in or scale out nodes in your cluster. See [auto_scaling_configuration](#auto_scaling_configuration). * `availabilityZoneId` - (Optional) The availability zone identifiers for the requested regions. Required when `azMode` is set to SINGLE. * `cacheStorageConfigurations` - (Optional) Configurations for a read only cache storage associated with a cluster. This cache will be stored as an FSx Lustre that reads from the S3 store. See [cache_storage_configuration](#cache_storage_configuration). @@ -131,13 +132,13 @@ The capacity_configuration block supports the following arguments: * `nodeType` - (Required) Determines the hardware of the host computer used for your cluster instance. Each node type offers different memory and storage capabilities. Choose a node type based on the requirements of the application or software that you plan to run on your instance. You can only specify one of the following values: - * kx.s.large – The node type with a configuration of 12 GiB memory and 2 vCPUs. - * kx.s.xlarge – The node type with a configuration of 27 GiB memory and 4 vCPUs. - * kx.s.2xlarge – The node type with a configuration of 54 GiB memory and 8 vCPUs. - * kx.s.4xlarge – The node type with a configuration of 108 GiB memory and 16 vCPUs. - * kx.s.8xlarge – The node type with a configuration of 216 GiB memory and 32 vCPUs. - * kx.s.16xlarge – The node type with a configuration of 432 GiB memory and 64 vCPUs. - * kx.s.32xlarge – The node type with a configuration of 864 GiB memory and 128 vCPUs. + * kx.s.large - The node type with a configuration of 12 GiB memory and 2 vCPUs. + * kx.s.xlarge - The node type with a configuration of 27 GiB memory and 4 vCPUs. + * kx.s.2xlarge - The node type with a configuration of 54 GiB memory and 8 vCPUs. + * kx.s.4xlarge - The node type with a configuration of 108 GiB memory and 16 vCPUs. + * kx.s.8xlarge - The node type with a configuration of 216 GiB memory and 32 vCPUs. + * kx.s.16xlarge - The node type with a configuration of 432 GiB memory and 64 vCPUs. + * kx.s.32xlarge - The node type with a configuration of 864 GiB memory and 128 vCPUs. * `nodeCount` - (Required) Number of instances running in a cluster. Must be at least 1 and at most 5. ### cache_storage_configuration @@ -261,4 +262,4 @@ Using `terraform import`, import an AWS FinSpace Kx Cluster using the `id` (envi % terraform import aws_finspace_kx_cluster.example n3ceo7wqxoxcti5tujqwzs,my-tf-kx-cluster ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/finspace_kx_database.html.markdown b/website/docs/cdktf/typescript/r/finspace_kx_database.html.markdown index 8f9bc9063841..1af859ca72f5 100644 --- a/website/docs/cdktf/typescript/r/finspace_kx_database.html.markdown +++ b/website/docs/cdktf/typescript/r/finspace_kx_database.html.markdown @@ -69,6 +69,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `description` - (Optional) Description of the KX database. * `tags` - (Optional) Key-value mapping of resource tags. If configured with a provider [`defaultTags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. @@ -122,4 +123,4 @@ Using `terraform import`, import an AWS FinSpace Kx Database using the `id` (env % terraform import aws_finspace_kx_database.example n3ceo7wqxoxcti5tujqwzs,my-tf-kx-database ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/finspace_kx_dataview.html.markdown b/website/docs/cdktf/typescript/r/finspace_kx_dataview.html.markdown index c2b9f98df88a..827ecdae1381 100644 --- a/website/docs/cdktf/typescript/r/finspace_kx_dataview.html.markdown +++ b/website/docs/cdktf/typescript/r/finspace_kx_dataview.html.markdown @@ -68,6 +68,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `autoUpdate` - (Optional) The option to specify whether you want to apply all the future additions and corrections automatically to the dataview, when you ingest new changesets. The default value is false. * `availabilityZoneId` - (Optional) The identifier of the availability zones. If attaching a volume, the volume must be in the same availability zone as the dataview that you are attaching to. * `changesetId` - (Optional) A unique identifier of the changeset of the database that you want to use to ingest data. @@ -135,4 +136,4 @@ Using `terraform import`, import an AWS FinSpace Kx Cluster using the `id` (envi % terraform import aws_finspace_kx_dataview.example n3ceo7wqxoxcti5tujqwzs,my-tf-kx-database,my-tf-kx-dataview ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/finspace_kx_environment.html.markdown b/website/docs/cdktf/typescript/r/finspace_kx_environment.html.markdown index 99280d6c83f1..4d47e005043f 100644 --- a/website/docs/cdktf/typescript/r/finspace_kx_environment.html.markdown +++ b/website/docs/cdktf/typescript/r/finspace_kx_environment.html.markdown @@ -163,6 +163,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `customDnsConfiguration` - (Optional) List of DNS server name and server IP. This is used to set up Route-53 outbound resolvers. Defined below. * `description` - (Optional) Description for the KX environment. * `tags` - (Optional) Key-value mapping of resource tags. If configured with a provider [`defaultTags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. @@ -263,4 +264,4 @@ Using `terraform import`, import an AWS FinSpace Kx Environment using the `id`. % terraform import aws_finspace_kx_environment.example n3ceo7wqxoxcti5tujqwzs ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/finspace_kx_scaling_group.html.markdown b/website/docs/cdktf/typescript/r/finspace_kx_scaling_group.html.markdown index 68d26b3ee6d3..cd5fc808bc1f 100644 --- a/website/docs/cdktf/typescript/r/finspace_kx_scaling_group.html.markdown +++ b/website/docs/cdktf/typescript/r/finspace_kx_scaling_group.html.markdown @@ -50,6 +50,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `tags` - (Optional) Key-value mapping of resource tags. If configured with a provider [`defaultTags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. You can add up to 50 tags to a scaling group. ## Attribute Reference @@ -61,14 +62,14 @@ This resource exports the following attributes in addition to the arguments abov * `createdTimestamp` - The timestamp at which the scaling group was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000. * `lastModifiedTimestamp` - Last timestamp at which the scaling group was updated in FinSpace. Value determined as epoch time in seconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000. * `status` - The status of scaling group. - * `CREATING` – The scaling group creation is in progress. - * `CREATE_FAILED` – The scaling group creation has failed. - * `ACTIVE` – The scaling group is active. - * `UPDATING` – The scaling group is in the process of being updated. - * `UPDATE_FAILED` – The update action failed. - * `DELETING` – The scaling group is in the process of being deleted. - * `DELETE_FAILED` – The system failed to delete the scaling group. - * `DELETED` – The scaling group is successfully deleted. + * `CREATING` - The scaling group creation is in progress. + * `CREATE_FAILED` - The scaling group creation has failed. + * `ACTIVE` - The scaling group is active. + * `UPDATING` - The scaling group is in the process of being updated. + * `UPDATE_FAILED` - The update action failed. + * `DELETING` - The scaling group is in the process of being deleted. + * `DELETE_FAILED` - The system failed to delete the scaling group. + * `DELETED` - The scaling group is successfully deleted. * `statusReason` - The error message when a failed state occurs. * `tagsAll` - Map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block). @@ -112,4 +113,4 @@ Using `terraform import`, import an AWS FinSpace Kx Scaling Group using the `id` % terraform import aws_finspace_kx_scaling_group.example n3ceo7wqxoxcti5tujqwzs,my-tf-kx-scalinggroup ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/finspace_kx_user.html.markdown b/website/docs/cdktf/typescript/r/finspace_kx_user.html.markdown index f250a1782a7d..f57a29f9b7c8 100644 --- a/website/docs/cdktf/typescript/r/finspace_kx_user.html.markdown +++ b/website/docs/cdktf/typescript/r/finspace_kx_user.html.markdown @@ -87,6 +87,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `tags` - (Optional) Key-value mapping of resource tags. If configured with a provider [`defaultTags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. ## Attribute Reference @@ -137,4 +138,4 @@ Using `terraform import`, import an AWS FinSpace Kx User using the `id` (environ % terraform import aws_finspace_kx_user.example n3ceo7wqxoxcti5tujqwzs,my-tf-kx-user ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/finspace_kx_volume.html.markdown b/website/docs/cdktf/typescript/r/finspace_kx_volume.html.markdown index ce68cee9d6fe..470be7e18ee0 100644 --- a/website/docs/cdktf/typescript/r/finspace_kx_volume.html.markdown +++ b/website/docs/cdktf/typescript/r/finspace_kx_volume.html.markdown @@ -29,7 +29,7 @@ class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); new FinspaceKxVolume(this, "example", { - availabilityZones: Token.asList("use1-az2"), + availabilityZones: ["use1-az2"], azMode: "SINGLE", environmentId: Token.asString(awsFinspaceKxEnvironmentExample.id), name: "my-tf-kx-volume", @@ -59,6 +59,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `nas1Configuration` - (Optional) Specifies the configuration for the Network attached storage (`NAS_1`) file system volume. This parameter is required when `volumeType` is `NAS_1`. See [`nas1Configuration` Argument Reference](#nas1_configuration-argument-reference) below. * `description` - (Optional) Description of the volume. * `tags` - (Optional) A list of key-value pairs to label the volume. You can add up to 50 tags to a volume @@ -77,15 +78,15 @@ This resource exports the following attributes in addition to the arguments abov * `arn` - Amazon Resource Name (ARN) identifier of the KX volume. * `createdTimestamp` - The timestamp at which the volume was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000. * `status` - The status of volume creation. - * `CREATING` – The volume creation is in progress. - * `CREATE_FAILED` – The volume creation has failed. - * `ACTIVE` – The volume is active. - * `UPDATING` – The volume is in the process of being updated. - * `UPDATE_FAILED` – The update action failed. - * `UPDATED` – The volume is successfully updated. - * `DELETING` – The volume is in the process of being deleted. - * `DELETE_FAILED` – The system failed to delete the volume. - * `DELETED` – The volume is successfully deleted. + * `CREATING` - The volume creation is in progress. + * `CREATE_FAILED` - The volume creation has failed. + * `ACTIVE` - The volume is active. + * `UPDATING` - The volume is in the process of being updated. + * `UPDATE_FAILED` - The update action failed. + * `UPDATED` - The volume is successfully updated. + * `DELETING` - The volume is in the process of being deleted. + * `DELETE_FAILED` - The system failed to delete the volume. + * `DELETED` - The volume is successfully deleted. * `statusReason` - The error message when a failed state occurs. * `lastModifiedTimestamp` - Last timestamp at which the volume was updated in FinSpace. Value determined as epoch time in seconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000. @@ -129,4 +130,4 @@ Using `terraform import`, import an AWS FinSpace Kx Volume using the `id` (envir % terraform import aws_finspace_kx_volume.example n3ceo7wqxoxcti5tujqwzs,my-tf-kx-volume ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/fis_experiment_template.html.markdown b/website/docs/cdktf/typescript/r/fis_experiment_template.html.markdown index 3c30a74eccfa..9df359ee96aa 100644 --- a/website/docs/cdktf/typescript/r/fis_experiment_template.html.markdown +++ b/website/docs/cdktf/typescript/r/fis_experiment_template.html.markdown @@ -225,6 +225,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `experimentOptions` - (Optional) The experiment options for the experiment template. See [experiment_options](#experiment_options) below for more details! * `tags` - (Optional) Key-value mapping of tags. If configured with a provider [`defaultTags` 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. * `target` - (Optional) Target of an action. See below. @@ -365,4 +366,4 @@ Using `terraform import`, import FIS Experiment Templates using the `id`. For ex % terraform import aws_fis_experiment_template.template EXT123AbCdEfGhIjK ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/flow_log.html.markdown b/website/docs/cdktf/typescript/r/flow_log.html.markdown index 5cc699ffecda..2d411acac349 100644 --- a/website/docs/cdktf/typescript/r/flow_log.html.markdown +++ b/website/docs/cdktf/typescript/r/flow_log.html.markdown @@ -11,7 +11,7 @@ description: |- # Resource: aws_flow_log Provides a VPC/Subnet/ENI/Transit Gateway/Transit Gateway Attachment Flow Log to capture IP traffic for a specific network -interface, subnet, or VPC. Logs are sent to a CloudWatch Log Group, a S3 Bucket, or Amazon Kinesis Data Firehose +interface, subnet, or VPC. Logs are sent to a CloudWatch Log Group, a S3 Bucket, or Amazon Data Firehose ## Example Usage @@ -97,7 +97,7 @@ class MyConvertedCode extends TerraformStack { ``` -### Amazon Kinesis Data Firehose logging +### Amazon Data Firehose logging ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -265,26 +265,201 @@ class MyConvertedCode extends TerraformStack { ``` +### Cross-Account Amazon Data Firehose Logging + +The following example shows how to set up a flow log in one AWS account (source) that sends logs to an Amazon Data Firehose delivery stream in another AWS account (destination). +See the [AWS Documentation](https://docs.aws.amazon.com/vpc/latest/userguide/flow-logs-firehose.html). + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { Token, TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { DataAwsIamPolicyDocument } from "./.gen/providers/aws/data-aws-iam-policy-document"; +import { FlowLog } from "./.gen/providers/aws/flow-log"; +import { IamRole } from "./.gen/providers/aws/iam-role"; +import { IamRolePolicy } from "./.gen/providers/aws/iam-role-policy"; +import { KinesisFirehoseDeliveryStream } from "./.gen/providers/aws/kinesis-firehose-delivery-stream"; +import { AwsProvider } from "./.gen/providers/aws/provider"; +import { Vpc } from "./.gen/providers/aws/vpc"; +interface MyConfig { + destination: any; + name: any; +} +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string, config: MyConfig) { + super(scope, name); + new AwsProvider(this, "aws", { + profile: "admin-src", + }); + const destinationAccount = new AwsProvider(this, "aws_1", { + alias: "destination_account", + profile: "admin-dst", + }); + const dst = new KinesisFirehoseDeliveryStream(this, "dst", { + provider: destinationAccount, + tags: { + LogDeliveryEnabled: "true", + }, + destination: config.destination, + name: config.name, + }); + const src = new Vpc(this, "src", {}); + const dstRolePolicy = new DataAwsIamPolicyDocument( + this, + "dst_role_policy", + { + statement: [ + { + actions: [ + "iam:CreateServiceLinkedRole", + "firehose:TagDeliveryStream", + ], + effect: "Allow", + resources: ["*"], + }, + ], + } + ); + const srcAssumeRolePolicy = new DataAwsIamPolicyDocument( + this, + "src_assume_role_policy", + { + statement: [ + { + actions: ["sts:AssumeRole"], + effect: "Allow", + principals: [ + { + identifiers: ["delivery.logs.amazonaws.com"], + type: "Service", + }, + ], + }, + ], + } + ); + const awsIamRoleSrc = new IamRole(this, "src_6", { + assumeRolePolicy: Token.asString(srcAssumeRolePolicy.json), + name: "tf-example-mySourceRole", + }); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + awsIamRoleSrc.overrideLogicalId("src"); + const dstAssumeRolePolicy = new DataAwsIamPolicyDocument( + this, + "dst_assume_role_policy", + { + statement: [ + { + actions: ["sts:AssumeRole"], + effect: "Allow", + principals: [ + { + identifiers: [Token.asString(awsIamRoleSrc.arn)], + type: "AWS", + }, + ], + }, + ], + } + ); + const awsIamRoleDst = new IamRole(this, "dst_8", { + assumeRolePolicy: Token.asString(dstAssumeRolePolicy.json), + name: "AWSLogDeliveryFirehoseCrossAccountRole", + provider: destinationAccount, + }); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + awsIamRoleDst.overrideLogicalId("dst"); + const awsIamRolePolicyDst = new IamRolePolicy(this, "dst_9", { + name: "AWSLogDeliveryFirehoseCrossAccountRolePolicy", + policy: Token.asString(dstRolePolicy.json), + provider: destinationAccount, + role: Token.asString(awsIamRoleDst.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.*/ + awsIamRolePolicyDst.overrideLogicalId("dst"); + const srcRolePolicy = new DataAwsIamPolicyDocument( + this, + "src_role_policy", + { + statement: [ + { + actions: ["iam:PassRole"], + condition: [ + { + test: "StringEquals", + values: ["delivery.logs.amazonaws.com"], + variable: "iam:PassedToService", + }, + { + test: "StringLike", + values: [src.arn], + variable: "iam:AssociatedResourceARN", + }, + ], + effect: "Allow", + resources: [Token.asString(awsIamRoleSrc.arn)], + }, + { + actions: [ + "logs:CreateLogDelivery", + "logs:DeleteLogDelivery", + "logs:ListLogDeliveries", + "logs:GetLogDelivery", + ], + effect: "Allow", + resources: ["*"], + }, + { + actions: ["sts:AssumeRole"], + effect: "Allow", + resources: [Token.asString(awsIamRoleDst.arn)], + }, + ], + } + ); + const awsFlowLogSrc = new FlowLog(this, "src_11", { + deliverCrossAccountRole: Token.asString(awsIamRoleDst.arn), + iamRoleArn: Token.asString(awsIamRoleSrc.arn), + logDestination: dst.arn, + logDestinationType: "kinesis-data-firehose", + trafficType: "ALL", + vpcId: src.id, + }); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + awsFlowLogSrc.overrideLogicalId("src"); + new IamRolePolicy(this, "src_policy", { + name: "tf-example-mySourceRolePolicy", + policy: Token.asString(srcRolePolicy.json), + role: Token.asString(awsIamRoleSrc.name), + }); + } +} + +``` + ## Argument Reference This resource supports the following arguments: +* `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). * `trafficType` - (Required) The type of traffic to capture. Valid values: `ACCEPT`,`REJECT`, `ALL`. -* `deliverCrossAccountRole` - (Optional) ARN of the IAM role that allows Amazon EC2 to publish flow logs across accounts. -* `eniId` - (Optional) Elastic Network Interface ID to attach to -* `iamRoleArn` - (Optional) The ARN for the IAM role that's used to post flow logs to a CloudWatch Logs log group -* `logDestinationType` - (Optional) The type of the logging destination. Valid values: `cloud-watch-logs`, `s3`, `kinesis-data-firehose`. Default: `cloud-watch-logs`. -* `logDestination` - (Optional) The ARN of the logging destination. Either `logDestination` or `logGroupName` must be set. -* `logGroupName` - (Optional) **Deprecated:** Use `logDestination` instead. The name of the CloudWatch log group. Either `logGroupName` or `logDestination` must be set. -* `subnetId` - (Optional) Subnet ID to attach to -* `transitGatewayId` - (Optional) Transit Gateway ID to attach to -* `transitGatewayAttachmentId` - (Optional) Transit Gateway Attachment ID to attach to -* `vpcId` - (Optional) VPC ID to attach to +* `deliverCrossAccountRole` - (Optional) ARN of the IAM role in the destination account used for cross-account delivery of flow logs. +* `eniId` - (Optional) Elastic Network Interface ID to attach to. +* `iamRoleArn` - (Optional) ARN of the IAM role used to post flow logs. Corresponds to `DeliverLogsPermissionArn` in the [AWS API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFlowLogs.html). +* `logDestinationType` - (Optional) Logging destination type. Valid values: `cloud-watch-logs`, `s3`, `kinesis-data-firehose`. Default: `cloud-watch-logs`. +* `logDestination` - (Optional) ARN of the logging destination. +* `subnetId` - (Optional) Subnet ID to attach to. +* `transitGatewayId` - (Optional) Transit Gateway ID to attach to. +* `transitGatewayAttachmentId` - (Optional) Transit Gateway Attachment ID to attach to. +* `vpcId` - (Optional) VPC ID to attach to. * `logFormat` - (Optional) The fields to include in the flow log record. Accepted format example: `"$${interface-id} $${srcaddr} $${dstaddr} $${srcport} $${dstport}"`. -* `maxAggregationInterval` - (Optional) The maximum interval of time - during which a flow of packets is captured and aggregated into a flow - log record. Valid Values: `60` seconds (1 minute) or `600` seconds (10 - minutes). Default: `600`. When `transitGatewayId` or `transitGatewayAttachmentId` is specified, `maxAggregationInterval` *must* be 60 seconds (1 minute). +* `maxAggregationInterval` - (Optional) The maximum interval of time during which a flow of packets is captured and aggregated into a flow log record. + Valid Values: `60` seconds (1 minute) or `600` seconds (10 minutes). Default: `600`. + When `transitGatewayId` or `transitGatewayAttachmentId` is specified, `maxAggregationInterval` *must* be 60 seconds (1 minute). * `destinationOptions` - (Optional) Describes the destination options for a flow log. More details below. * `tags` - (Optional) Key-value map of resource tags. If configured with a provider [`defaultTags` 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. @@ -294,7 +469,7 @@ This resource supports the following arguments: Describes the destination options for a flow log. -* `fileFormat` - (Optional) The format for the flow log. Default value: `plain-text`. Valid values: `plain-text`, `parquet`. +* `fileFormat` - (Optional) File format for the flow log. Default value: `plain-text`. Valid values: `plain-text`, `parquet`. * `hiveCompatiblePartitions` - (Optional) Indicates whether to use Hive-compatible prefixes for flow logs stored in Amazon S3. Default value: `false`. * `perHourPartition` - (Optional) Indicates whether to partition the flow log per hour. This reduces the cost and response time for queries. Default value: `false`. @@ -302,8 +477,8 @@ Describes the destination options for a flow log. This resource exports the following attributes in addition to the arguments above: -* `id` - The Flow Log ID -* `arn` - The ARN of the Flow Log. +* `id` - Flow Log ID. +* `arn` - ARN of the Flow Log. * `tagsAll` - A map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). ## Import @@ -334,4 +509,4 @@ Using `terraform import`, import Flow Logs using the `id`. For example: % terraform import aws_flow_log.test_flow_log fl-1a2b3c4d ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/fms_policy.html.markdown b/website/docs/cdktf/typescript/r/fms_policy.html.markdown index 87f411836b60..cb1c4dfb52f6 100644 --- a/website/docs/cdktf/typescript/r/fms_policy.html.markdown +++ b/website/docs/cdktf/typescript/r/fms_policy.html.markdown @@ -73,6 +73,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required, Forces new resource) The friendly name of the AWS Firewall Manager Policy. * `deleteAllPolicyResources` - (Optional) If true, the request will also perform a clean-up process. Defaults to `true`. More information can be found here [AWS Firewall Manager delete policy](https://docs.aws.amazon.com/fms/2018-01-01/APIReference/API_DeletePolicy.html) * `deleteUnusedFmManagedResources` - (Optional) If true, Firewall Manager will automatically remove protections from resources that leave the policy scope. Defaults to `false`. More information can be found here [AWS Firewall Manager policy contents](https://docs.aws.amazon.com/fms/2018-01-01/APIReference/API_Policy.html) @@ -81,6 +82,7 @@ This resource supports the following arguments: * `excludeResourceTags` - (Required, Forces new resource) A boolean value, if true the tags that are specified in the `resourceTags` are not protected by this policy. If set to false and resource_tags are populated, resources that contain tags will be protected by this policy. * `includeMap` - (Optional) A map of lists of accounts and OU's to include in the policy. See the [`includeMap`](#include_map-configuration-block) block. * `remediationEnabled` - (Required) A boolean value, indicates if the policy should automatically applied to resources that already exist in the account. +* `resourceTagLogicalOperator` - (Optional) Controls how multiple resource tags are combined: with AND, so that a resource must have all tags to be included or excluded, or OR, so that a resource must have at least one tag. The valid values are `AND` and `OR`. * `resourceTags` - (Optional) A map of resource tags, that if present will filter protections on resources based on the exclude_resource_tags. * `resourceType` - (Optional) A resource type to protect. Conflicts with `resourceTypeList`. See the [FMS API Reference](https://docs.aws.amazon.com/fms/2018-01-01/APIReference/API_Policy.html#fms-Type-Policy-ResourceType) for more information about supported values. * `resourceTypeList` - (Optional) A list of resource types to protect. Conflicts with `resourceType`. See the [FMS API Reference](https://docs.aws.amazon.com/fms/2018-01-01/APIReference/API_Policy.html#fms-Type-Policy-ResourceType) for more information about supported values. Lists with only one element are not supported, instead use `resourceType`. @@ -202,4 +204,4 @@ Using `terraform import`, import Firewall Manager policies using the policy ID. % terraform import aws_fms_policy.example 5be49585-a7e3-4c49-dde1-a179fe4a619a ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/fms_resource_set.html.markdown b/website/docs/cdktf/typescript/r/fms_resource_set.html.markdown index 146721a1a68d..f4b544a9ebdd 100644 --- a/website/docs/cdktf/typescript/r/fms_resource_set.html.markdown +++ b/website/docs/cdktf/typescript/r/fms_resource_set.html.markdown @@ -43,8 +43,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `resourceSet` - (Required) Details about the resource set to be created or updated. See [`resourceSet` Attribute Reference](#resource_set-attribute-reference) below. ### `resourceSet` Attribute Reference @@ -102,4 +103,4 @@ Using `terraform import`, import FMS (Firewall Manager) Resource Set using the ` % terraform import aws_fms_resource_set.example resource_set-id-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/fsx_backup.html.markdown b/website/docs/cdktf/typescript/r/fsx_backup.html.markdown index 8203228fc369..84f081afe0e0 100644 --- a/website/docs/cdktf/typescript/r/fsx_backup.html.markdown +++ b/website/docs/cdktf/typescript/r/fsx_backup.html.markdown @@ -144,12 +144,13 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: -Note - Only file_system_id or volume_id can be specified. file_system_id is used for Lustre and Windows, volume_id is used for ONTAP. - +* `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). * `fileSystemId` - (Optional) The ID of the file system to back up. Required if backing up Lustre or Windows file systems. * `tags` - (Optional) A map of tags to assign to the file system. If configured with a provider [`defaultTags` 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. If you have set `copyTagsToBackups` to true, and you specify one or more tags, no existing file system tags are copied from the file system to the backup. * `volumeId` - (Optional) The ID of the volume to back up. Required if backing up a ONTAP Volume. +Note - One of `fileSystemId` or `volumeId` can be specified. `fileSystemId` is used for Lustre and Windows, `volumeId` is used for ONTAP. + ## Attribute Reference This resource exports the following attributes in addition to the arguments above: @@ -196,4 +197,4 @@ Using `terraform import`, import FSx Backups using the `id`. For example: % terraform import aws_fsx_backup.example fs-543ab12b1ca672f33 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/fsx_data_repository_association.html.markdown b/website/docs/cdktf/typescript/r/fsx_data_repository_association.html.markdown index c84c9e8cc338..096a99b1239d 100644 --- a/website/docs/cdktf/typescript/r/fsx_data_repository_association.html.markdown +++ b/website/docs/cdktf/typescript/r/fsx_data_repository_association.html.markdown @@ -73,6 +73,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `batchImportMetaDataOnCreate` - (Optional) Set to true to run an import data repository task to import metadata from the data repository to the file system after the data repository association is created. Defaults to `false`. * `dataRepositoryPath` - (Required) The path to the Amazon S3 data repository that will be linked to the file system. The path must be an S3 bucket s3://myBucket/myPrefix/. This path specifies where in the S3 data repository files will be imported from or exported to. The same S3 bucket cannot be linked more than once to the same file system. * `fileSystemId` - (Required) The ID of the Amazon FSx file system to on which to create a data repository association. @@ -140,4 +141,4 @@ Using `terraform import`, import FSx Data Repository Associations using the `id` % terraform import aws_fsx_data_repository_association.example dra-0b1cfaeca11088b10 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/fsx_file_cache.html.markdown b/website/docs/cdktf/typescript/r/fsx_file_cache.html.markdown index 0c0504365155..4f7fb60ee910 100644 --- a/website/docs/cdktf/typescript/r/fsx_file_cache.html.markdown +++ b/website/docs/cdktf/typescript/r/fsx_file_cache.html.markdown @@ -74,6 +74,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `copyTagsToDataRepositoryAssociations` - A boolean flag indicating whether tags for the cache should be copied to data repository associations. This value defaults to false. * `dataRepositoryAssociation` - See the [`dataRepositoryAssociation` configuration](#data-repository-association-arguments) block. Max of 8. A list of up to 8 configurations for data repository associations (DRAs) to be created during the cache creation. The DRAs link the cache to either an Amazon S3 data repository or a Network File System (NFS) data repository that supports the NFSv3 protocol. The DRA configurations must meet the following requirements: 1) All configurations on the list must be of the same data repository type, either all S3 or all NFS. A cache can't link to different data repository types at the same time. 2) An NFS DRA must link to an NFS file system that supports the NFSv3 protocol. DRA automatic import and automatic export is not supported. @@ -161,4 +162,4 @@ Using `terraform import`, import Amazon File Cache cache using the resource `id` % terraform import aws_fsx_file_cache.example fc-8012925589 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/fsx_lustre_file_system.html.markdown b/website/docs/cdktf/typescript/r/fsx_lustre_file_system.html.markdown index ab70bd9dbac8..220692cfdbda 100644 --- a/website/docs/cdktf/typescript/r/fsx_lustre_file_system.html.markdown +++ b/website/docs/cdktf/typescript/r/fsx_lustre_file_system.html.markdown @@ -40,12 +40,14 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `subnetIds` - (Required) A list of IDs for the subnets that the file system will be accessible from. File systems currently support only one subnet. The file server is also launched in that subnet's Availability Zone. The following arguments are optional: +* `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). * `autoImportPolicy` - (Optional) How Amazon FSx keeps your file and directory listings up to date as you add or modify objects in your linked S3 bucket. see [Auto Import Data Repo](https://docs.aws.amazon.com/fsx/latest/LustreGuide/autoimport-data-repo.html) for more details. Only supported on `PERSISTENT_1` deployment types. * `automaticBackupRetentionDays` - (Optional) The number of days to retain automatic backups. Setting this to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. only valid for `PERSISTENT_1` and `PERSISTENT_2` deployment_type. * `backupId` - (Optional) The ID of the source backup to create the filesystem from. @@ -72,7 +74,7 @@ The following arguments are optional: **Note:** If the filesystem uses a Scratch deployment type, final backup during delete will always be skipped and this argument will not be used even when set. * `storageCapacity` - (Optional) The storage capacity (GiB) of the file system. Minimum of `1200`. See more details at [Allowed values for Fsx storage capacity](https://docs.aws.amazon.com/fsx/latest/APIReference/API_CreateFileSystem.html#FSx-CreateFileSystem-request-StorageCapacity). Update is allowed only for `SCRATCH_2`, `PERSISTENT_1` and `PERSISTENT_2` deployment types, See more details at [Fsx Storage Capacity Update](https://docs.aws.amazon.com/fsx/latest/APIReference/API_UpdateFileSystem.html#FSx-UpdateFileSystem-request-StorageCapacity). Required when not creating filesystem for a backup. -* `storageType` - (Optional) - The filesystem storage type. One of `SSD`, `HDD` or `INTELLIGENT_TIERING`, defaults to `SSD`. `HDD` is only supported on `PERSISTENT_1` deployment types. `INTELLIGENT_TIERING` requires `data_read_cache_configuration` and `metadataConfiguration` to be set and is only supported for `PERSISTENT_2` deployment types. +* `storageType` - (Optional) - The filesystem storage type. One of `SSD`, `HDD` or `INTELLIGENT_TIERING`, defaults to `SSD`. `HDD` is only supported on `PERSISTENT_1` deployment types. `INTELLIGENT_TIERING` requires `dataReadCacheConfiguration` and `metadataConfiguration` to be set and is only supported for `PERSISTENT_2` deployment types. * `tags` - (Optional) A map of tags to assign to the file system. If configured with a provider [`defaultTags` 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. * `throughputCapacity` - (Optional) Throughput in MBps required for the `INTELLIGENT_TIERING` storage type. Must be 4000 or multiples of 4000. * `weeklyMaintenanceStartTime` - (Optional) The preferred start time (in `d:HH:MM` format) to perform weekly maintenance, in the UTC time zone. @@ -100,12 +102,12 @@ The `rootSquashConfiguration` configuration block supports the following argumen * `noSquashNids` - (Optional) When root squash is enabled, you can optionally specify an array of NIDs of clients for which root squash does not apply. A client NID is a Lustre Network Identifier used to uniquely identify a client. You can specify the NID as either a single address or a range of addresses: 1. A single address is described in standard Lustre NID format by specifying the client’s IP address followed by the Lustre network ID (for example, 10.0.1.6@tcp). 2. An address range is described using a dash to separate the range (for example, 10.0.[2-10].[1-255]@tcp). * `rootSquash` - (Optional) You enable root squash by setting a user ID (UID) and group ID (GID) for the file system in the format UID:GID (for example, 365534:65534). The UID and GID values can range from 0 to 4294967294. -### `data_read_cache_configuration` Block +### `dataReadCacheConfiguration` Block -The `data_read_cache_configuration` configuration block supports the following arguments: +The `dataReadCacheConfiguration` configuration block supports the following arguments: -* `size` - (Optional) Size of the file system's SSD read cache, in gibibytes (GiB). Required when the `sizing_mode` is `USER_PROVISIONED`. -* `sizing_mode` - (Required) Sizing mode for the cache. Valud values are `NO_CACHE`, `USER_PROVISIONED`, and `PROPORTIONAL_TO_THROUGHPUT_CAPACITY`. +* `size` - (Optional) Size of the file system's SSD read cache, in gibibytes (GiB). Required when the `sizingMode` is `USER_PROVISIONED`. +* `sizingMode` - (Required) Sizing mode for the cache. Valud values are `NO_CACHE`, `USER_PROVISIONED`, and `PROPORTIONAL_TO_THROUGHPUT_CAPACITY`. ## Attribute Reference @@ -189,4 +191,4 @@ class MyConvertedCode extends TerraformStack { ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/fsx_ontap_file_system.html.markdown b/website/docs/cdktf/typescript/r/fsx_ontap_file_system.html.markdown index af84f72912c2..23e7d1bfd7f9 100644 --- a/website/docs/cdktf/typescript/r/fsx_ontap_file_system.html.markdown +++ b/website/docs/cdktf/typescript/r/fsx_ontap_file_system.html.markdown @@ -118,6 +118,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `storageCapacity` - (Required) The storage capacity (GiB) of the file system. Valid values between `1024` and `196608` for file systems with deployment_type `SINGLE_AZ_1` and `MULTI_AZ_1`. Valid values are between `1024` and `524288` for `MULTI_AZ_2`. Valid values between `1024` (`1024` per ha pair) and `1048576` for file systems with deployment_type `SINGLE_AZ_2`. For `SINGLE_AZ_2`, the `1048576` (1PB) maximum is only supported when using 2 or more ha_pairs, the maximum is `524288` (512TB) when using 1 ha_pair. * `subnetIds` - (Required) A list of IDs for the subnets that the file system will be accessible from. Up to 2 subnets can be provided. * `preferredSubnetId` - (Required) The ID for a subnet. A subnet is a range of IP addresses in your virtual private cloud (VPC). @@ -242,4 +243,4 @@ class MyConvertedCode extends TerraformStack { ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/fsx_ontap_storage_virtual_machine.html.markdown b/website/docs/cdktf/typescript/r/fsx_ontap_storage_virtual_machine.html.markdown index c3afbd452a75..efc1acbaf630 100644 --- a/website/docs/cdktf/typescript/r/fsx_ontap_storage_virtual_machine.html.markdown +++ b/website/docs/cdktf/typescript/r/fsx_ontap_storage_virtual_machine.html.markdown @@ -76,6 +76,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `activeDirectoryConfiguration` - (Optional) Configuration block that Amazon FSx uses to join the FSx ONTAP Storage Virtual Machine(SVM) to your Microsoft Active Directory (AD) directory. Detailed below. * `fileSystemId` - (Required) The ID of the Amazon FSx ONTAP File System that this SVM will be created on. * `name` - (Required) The name of the SVM. You can use a maximum of 47 alphanumeric characters, plus the underscore (_) special character. @@ -195,4 +196,4 @@ class MyConvertedCode extends TerraformStack { ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/fsx_ontap_volume.html.markdown b/website/docs/cdktf/typescript/r/fsx_ontap_volume.html.markdown index 8712401bd85f..598732d77c45 100644 --- a/website/docs/cdktf/typescript/r/fsx_ontap_volume.html.markdown +++ b/website/docs/cdktf/typescript/r/fsx_ontap_volume.html.markdown @@ -86,6 +86,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `aggregateConfiguration` - (Optional) The Aggregate configuration only applies to `FLEXGROUP` volumes. See [`aggregateConfiguration` Block] for details. * `bypassSnaplockEnterpriseRetention` - (Optional) Setting this to `true` allows a SnapLock administrator to delete an FSx for ONTAP SnapLock Enterprise volume with unexpired write once, read many (WORM) files. This configuration must be applied separately before attempting to delete the resource to have the desired behavior. Defaults to `false`. * `copyTagsToBackups` - (Optional) A boolean flag indicating whether tags for the volume should be copied to backups. This value defaults to `false`. @@ -217,4 +218,4 @@ Using `terraform import`, import FSx ONTAP volume using the `id`. For example: % terraform import aws_fsx_ontap_volume.example fsvol-12345678abcdef123 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/fsx_openzfs_file_system.html.markdown b/website/docs/cdktf/typescript/r/fsx_openzfs_file_system.html.markdown index 340e24f520d2..92e5be4ad2e9 100644 --- a/website/docs/cdktf/typescript/r/fsx_openzfs_file_system.html.markdown +++ b/website/docs/cdktf/typescript/r/fsx_openzfs_file_system.html.markdown @@ -49,6 +49,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `automaticBackupRetentionDays` - (Optional) The number of days to retain automatic backups. Setting this to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. * `backupId` - (Optional) The ID of the source backup to create the filesystem from. * `copyTagsToBackups` - (Optional) A boolean flag indicating whether tags for the file system should be copied to backups. The default value is false. @@ -194,4 +195,4 @@ class MyConvertedCode extends TerraformStack { ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/fsx_openzfs_snapshot.html.markdown b/website/docs/cdktf/typescript/r/fsx_openzfs_snapshot.html.markdown index 6290d1680847..8459c68a994e 100644 --- a/website/docs/cdktf/typescript/r/fsx_openzfs_snapshot.html.markdown +++ b/website/docs/cdktf/typescript/r/fsx_openzfs_snapshot.html.markdown @@ -98,6 +98,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) The name of the Snapshot. You can use a maximum of 203 alphanumeric characters plus either _ or - or : or . for the name. * `tags` - (Optional) A map of tags to assign to the file system. If configured with a provider [`defaultTags` 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. If you have set `copyTagsToBackups` to true, and you specify one or more tags, no existing file system tags are copied from the file system to the backup. * `volumeId` - (Optional) The ID of the volume to snapshot. This can be the root volume or a child volume. @@ -150,4 +151,4 @@ Using `terraform import`, import FSx OpenZFS snapshot using the `id`. For exampl % terraform import aws_fsx_openzfs_snapshot.example fs-543ab12b1ca672f33 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/fsx_openzfs_volume.html.markdown b/website/docs/cdktf/typescript/r/fsx_openzfs_volume.html.markdown index ba3587540cc8..291ef849a231 100644 --- a/website/docs/cdktf/typescript/r/fsx_openzfs_volume.html.markdown +++ b/website/docs/cdktf/typescript/r/fsx_openzfs_volume.html.markdown @@ -40,6 +40,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) The name of the Volume. You can use a maximum of 203 alphanumeric characters, plus the underscore (_) special character. * `parentVolumeId` - (Required) The volume id of volume that will be the parent volume for the volume being created, this could be the root volume created from the `aws_fsx_openzfs_file_system` resource with the `rootVolumeId` or the `id` property of another `aws_fsx_openzfs_volume`. * `copyTagsToSnapshots` - (Optional) A boolean flag indicating whether tags for the file system should be copied to snapshots. The default value is false. @@ -130,4 +131,4 @@ Using `terraform import`, import FSx Volumes using the `id`. For example: % terraform import aws_fsx_openzfs_volume.example fsvol-543ab12b1ca672f33 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/fsx_s3_access_point_attachment.html.markdown b/website/docs/cdktf/typescript/r/fsx_s3_access_point_attachment.html.markdown new file mode 100644 index 000000000000..73e6fd6aa467 --- /dev/null +++ b/website/docs/cdktf/typescript/r/fsx_s3_access_point_attachment.html.markdown @@ -0,0 +1,148 @@ +--- +subcategory: "FSx" +layout: "aws" +page_title: "AWS: aws_fsx_s3_access_point_attachment" +description: |- + Manages an Amazon FSx S3 Access Point attachment. +--- + + + +# Resource: aws_fsx_s3_access_point_attachment + +Manages an Amazon FSx S3 Access Point attachment. + +## Example Usage + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { Token, TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { FsxS3AccessPointAttachment } from "./.gen/providers/aws/fsx-s3-access-point-attachment"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + new FsxS3AccessPointAttachment(this, "example", { + name: "example-attachment", + openzfsConfiguration: [ + { + fileSystemIdentity: [ + { + posixUser: [ + { + gid: 1001, + uid: 1001, + }, + ], + type: "POSIX", + }, + ], + volumeId: Token.asString(awsFsxOpenzfsVolumeExample.id), + }, + ], + type: "OPENZFS", + }); + } +} + +``` + +## Argument Reference + +The following arguments are required: + +* `name` - (Required) Name of the S3 access point. +* `openzfsConfiguration` - (Required) Configuration to use when creating and attaching an S3 access point to an FSx for OpenZFS volume. See [`openzfsConfiguration` Block](#openzfs_configuration-block) for details. +* `type` - (Required) Type of S3 access point. Valid values: `OpenZFS`. + +The following arguments are optional: + +* `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). +* `s3AccessPoint` - (Optional) S3 access point configuration. See [`s3AccessPoint` Block](#s3_access_point-block) for details. + +### `openzfsConfiguration` Block + +The `openzfsConfiguration` configuration block supports the following arguments: + +* `fileSystemIdentity` - (Required) File system user identity to use for authorizing file read and write requests that are made using the S3 access point. See [`fileSystemIdentity` Block](#file_system_identity-block) for details. +* `volumeId` - (Required) ID of the FSx for OpenZFS volume to which the S3 access point is attached. + +### `fileSystemIdentity` Block + +The `fileSystemIdentity` configuration block supports the following arguments: + +* `posixUser` - (Required) UID and GIDs of the file system POSIX user. See [`posixUser` Block](#posix_user-block) for details. +* `type` - (Required) FSx for OpenZFS user identity type. Valid values: `POSIX`. + +### `posixUser` Block + +The `posixUser` configuration block supports the following arguments: + +* `gid` - (Required) GID of the file system user. +* `secondaryGids` - (Optional) List of secondary GIDs for the file system user.. +* `uid` - (Required) UID of the file system user. + +### `s3AccessPoint` Block + +The `s3AccessPoint` configuration block supports the following arguments: + +* `policy` - (Required) Access policy associated with the S3 access point configuration. +* `vpcConfiguration` - (Optional) Amazon S3 restricts access to the S3 access point to requests made from the specified VPC. See [`vpcConfiguration` Block](#vpc_configuration-block) for details. + +### `vpcConfiguration` Block + +The `vpcConfiguration` configuration block supports the following arguments: + +* `vpcId` - (Required) VPC ID. + +## Attribute Reference + +This resource exports the following attributes in addition to the arguments above: + +* `s3AccessPointAlias` - S3 access point's alias. +* `s3AccessPointArn` - S3 access point's ARN. + +## Timeouts + +[Configuration options](https://developer.hashicorp.com/terraform/language/resources/syntax#operation-timeouts): + +* `create` - (Default `15m`) +* `delete` - (Default `15m`) + +## Import + +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import FSx S3 Access Point attachments using the `name`. For example: + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { FsxS3AccessPointAttachment } from "./.gen/providers/aws/fsx-s3-access-point-attachment"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + FsxS3AccessPointAttachment.generateConfigForImport( + this, + "example", + "example-attachment" + ); + } +} + +``` + +Using `terraform import`, import FSx S3 Access Point attachments using the `name`. For example: + +```console +% terraform import aws_fsx_s3_access_point_attachment.example example-attachment +``` + + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/fsx_windows_file_system.html.markdown b/website/docs/cdktf/typescript/r/fsx_windows_file_system.html.markdown index a25f31e75a2d..340a6c4d19e2 100644 --- a/website/docs/cdktf/typescript/r/fsx_windows_file_system.html.markdown +++ b/website/docs/cdktf/typescript/r/fsx_windows_file_system.html.markdown @@ -86,6 +86,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `activeDirectoryId` - (Optional) The ID for an existing Microsoft Active Directory instance that the file system should join when it's created. Cannot be specified with `selfManagedActiveDirectory`. * `aliases` - (Optional) An array DNS alias names that you want to associate with the Amazon FSx file system. For more information, see [Working with DNS Aliases](https://docs.aws.amazon.com/fsx/latest/WindowsGuide/managing-dns-aliases.html) * `auditLogConfiguration` - (Optional) The configuration that Amazon FSx for Windows File Server uses to audit and log user accesses of files, folders, and file shares on the Amazon FSx for Windows File Server file system. See [`auditLogConfiguration` Block](#audit_log_configuration-block) for details. @@ -217,4 +218,4 @@ class MyConvertedCode extends TerraformStack { ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/gamelift_alias.html.markdown b/website/docs/cdktf/typescript/r/gamelift_alias.html.markdown index 16367cb2b32c..57f358042eb8 100644 --- a/website/docs/cdktf/typescript/r/gamelift_alias.html.markdown +++ b/website/docs/cdktf/typescript/r/gamelift_alias.html.markdown @@ -43,6 +43,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) Name of the alias. * `description` - (Optional) Description of the alias. * `routingStrategy` - (Required) Specifies the fleet and/or routing type to use for the alias. @@ -92,4 +93,4 @@ Using `terraform import`, import GameLift Aliases using the ID. For example: % terraform import aws_gamelift_alias.example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/gamelift_build.html.markdown b/website/docs/cdktf/typescript/r/gamelift_build.html.markdown index 8fb9fd30090a..91d9b8d98cfe 100644 --- a/website/docs/cdktf/typescript/r/gamelift_build.html.markdown +++ b/website/docs/cdktf/typescript/r/gamelift_build.html.markdown @@ -44,6 +44,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) Name of the build * `operatingSystem` - (Required) Operating system that the game server binaries are built to run on. Valid values: `WINDOWS_2012`, `AMAZON_LINUX`, `AMAZON_LINUX_2`, `WINDOWS_2016`, `AMAZON_LINUX_2023`. * `storageLocation` - (Required) Information indicating where your game build files are stored. See below. @@ -95,4 +96,4 @@ Using `terraform import`, import GameLift Builds using the ID. For example: % terraform import aws_gamelift_build.example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/gamelift_fleet.html.markdown b/website/docs/cdktf/typescript/r/gamelift_fleet.html.markdown index b9a6981933db..2c28319de85a 100644 --- a/website/docs/cdktf/typescript/r/gamelift_fleet.html.markdown +++ b/website/docs/cdktf/typescript/r/gamelift_fleet.html.markdown @@ -34,7 +34,8 @@ resource "aws_gamelift_fleet" "example" { This resource supports the following arguments: -* `buildId` - (Optional) ID of the GameLift Build to be deployed on the fleet. +* `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). +* `buildId` - (Optional) ID of the GameLift Build to be deployed on the fleet. Conflicts with `scriptId`. * `certificateConfiguration` - (Optional) Prompts GameLift to generate a TLS/SSL certificate for the fleet. See [certificate_configuration](#certificate_configuration). * `description` - (Optional) Human-readable description of the fleet. * `ec2InboundPermission` - (Optional) Range of IP addresses and port settings that permit inbound traffic to access server processes running on the fleet. See below. @@ -46,7 +47,7 @@ This resource supports the following arguments: * `newGameSessionProtectionPolicy` - (Optional) Game session protection policy to apply to all instances in this fleetE.g., `FullProtection`. Defaults to `NoProtection`. * `resourceCreationLimitPolicy` - (Optional) Policy that limits the number of game sessions an individual player can create over a span of time for this fleet. See below. * `runtimeConfiguration` - (Optional) Instructions for launching server processes on each instance in the fleet. See below. -* `scriptId` - (Optional) ID of the GameLift Script to be deployed on the fleet. +* `scriptId` - (Optional) ID of the GameLift Script to be deployed on the fleet. Conflicts with `buildId`. * `tags` - (Optional) Key-value map of resource tags. If configured with a provider [`defaultTags` 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. ### Nested Fields @@ -125,4 +126,4 @@ Using `terraform import`, import GameLift Fleets using the ID. For example: % terraform import aws_gamelift_fleet.example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/gamelift_game_server_group.html.markdown b/website/docs/cdktf/typescript/r/gamelift_game_server_group.html.markdown index c8bd9be84174..5e71c668bda9 100644 --- a/website/docs/cdktf/typescript/r/gamelift_game_server_group.html.markdown +++ b/website/docs/cdktf/typescript/r/gamelift_game_server_group.html.markdown @@ -162,6 +162,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `balancingStrategy` - (Optional) Indicates how GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances. Valid values: `SPOT_ONLY`, `SPOT_PREFERRED`, `ON_DEMAND_ONLY`. Defaults to `SPOT_PREFERRED`. * `gameServerGroupName` - (Required) Name of the game server group. @@ -263,4 +264,4 @@ Using `terraform import`, import GameLift Game Server Group using the `name`. Fo % terraform import aws_gamelift_game_server_group.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/gamelift_game_session_queue.html.markdown b/website/docs/cdktf/typescript/r/gamelift_game_session_queue.html.markdown index 33bcd27a8abc..70b4e45ce692 100644 --- a/website/docs/cdktf/typescript/r/gamelift_game_session_queue.html.markdown +++ b/website/docs/cdktf/typescript/r/gamelift_game_session_queue.html.markdown @@ -50,6 +50,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) Name of the session queue. * `timeoutInSeconds` - (Required) Maximum time a game session request can remain in the queue. * `customEventData` - (Optional) Information to be added to all events that are related to this game session queue. @@ -104,4 +105,4 @@ Using `terraform import`, import GameLift Game Session Queues using their `name` % terraform import aws_gamelift_game_session_queue.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/gamelift_script.html.markdown b/website/docs/cdktf/typescript/r/gamelift_script.html.markdown index f638e68e70e4..dc3a690310f3 100644 --- a/website/docs/cdktf/typescript/r/gamelift_script.html.markdown +++ b/website/docs/cdktf/typescript/r/gamelift_script.html.markdown @@ -43,6 +43,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) Name of the script * `storageLocation` - (Optional) Information indicating where your game script files are stored. See below. * `version` - (Optional) Version that is associated with this script. @@ -94,4 +95,4 @@ Using `terraform import`, import GameLift Scripts using the ID. For example: % terraform import aws_gamelift_script.example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/glacier_vault.html.markdown b/website/docs/cdktf/typescript/r/glacier_vault.html.markdown index 66b940be5dc0..88c6707dde68 100644 --- a/website/docs/cdktf/typescript/r/glacier_vault.html.markdown +++ b/website/docs/cdktf/typescript/r/glacier_vault.html.markdown @@ -73,6 +73,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) The name of the Vault. Names can be between 1 and 255 characters long and the valid characters are a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), and '.' (period). * `accessPolicy` - (Optional) The policy document. This is a JSON formatted string. The heredoc syntax or `file` function is helpful here. Use the [Glacier Developer Guide](https://docs.aws.amazon.com/amazonglacier/latest/dev/vault-access-policy.html) for more information on Glacier Vault Policy @@ -120,4 +121,4 @@ Using `terraform import`, import Glacier Vaults using the `name`. For example: % terraform import aws_glacier_vault.archive my_archive ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/glacier_vault_lock.html.markdown b/website/docs/cdktf/typescript/r/glacier_vault_lock.html.markdown index 45a6b76c7c86..cfaa65dedddb 100644 --- a/website/docs/cdktf/typescript/r/glacier_vault_lock.html.markdown +++ b/website/docs/cdktf/typescript/r/glacier_vault_lock.html.markdown @@ -101,6 +101,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `completeLock` - (Required) Boolean whether to permanently apply this Glacier Lock Policy. Once completed, this cannot be undone. If set to `false`, the Glacier Lock Policy remains in a testing mode for 24 hours. After that time, the Glacier Lock Policy is automatically removed by Glacier and the Terraform resource will show as needing recreation. Changing this from `false` to `true` will show as resource recreation, which is expected. Changing this from `true` to `false` is not possible unless the Glacier Vault is recreated at the same time. * `policy` - (Required) JSON string containing the IAM policy to apply as the Glacier Vault Lock policy. * `vaultName` - (Required) The name of the Glacier Vault. @@ -140,4 +141,4 @@ Using `terraform import`, import Glacier Vault Locks using the Glacier Vault nam % terraform import aws_glacier_vault_lock.example example-vault ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/globalaccelerator_cross_account_attachment.html.markdown b/website/docs/cdktf/typescript/r/globalaccelerator_cross_account_attachment.html.markdown index ebadc0919943..364c05cf0186 100644 --- a/website/docs/cdktf/typescript/r/globalaccelerator_cross_account_attachment.html.markdown +++ b/website/docs/cdktf/typescript/r/globalaccelerator_cross_account_attachment.html.markdown @@ -101,7 +101,7 @@ This resource exports the following attributes in addition to the arguments abov ## Import -In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import Global Accelerator Cross Account Attachment using the `example_id_arg`. For example: +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import Global Accelerator Cross Account Attachment using the `arn`. For example: ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -125,10 +125,10 @@ class MyConvertedCode extends TerraformStack { ``` -Using `terraform import`, import Global Accelerator Cross Account Attachment using the `example_id_arg`. For example: +Using `terraform import`, import Global Accelerator Cross Account Attachment using the `arn`. For example: ```console % terraform import aws_globalaccelerator_cross_account_attachment.example arn:aws:globalaccelerator::012345678910:attachment/01234567-abcd-8910-efgh-123456789012 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/glue_catalog_database.html.markdown b/website/docs/cdktf/typescript/r/glue_catalog_database.html.markdown index 00888fca91dc..99e6148c9033 100644 --- a/website/docs/cdktf/typescript/r/glue_catalog_database.html.markdown +++ b/website/docs/cdktf/typescript/r/glue_catalog_database.html.markdown @@ -68,6 +68,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `catalogId` - (Optional) ID of the Glue Catalog to create the database in. If omitted, this defaults to the AWS Account ID. * `createTableDefaultPermission` - (Optional) Creates a set of default permissions on the table for principals. See [`createTableDefaultPermission`](#create_table_default_permission) below. * `description` - (Optional) Description of the database. @@ -138,4 +139,4 @@ Using `terraform import`, import Glue Catalog Databases using the `catalog_id:na % terraform import aws_glue_catalog_database.database 123456789012:my_database ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/glue_catalog_table.html.markdown b/website/docs/cdktf/typescript/r/glue_catalog_table.html.markdown index 472e2c5bf64d..2a013c945053 100644 --- a/website/docs/cdktf/typescript/r/glue_catalog_table.html.markdown +++ b/website/docs/cdktf/typescript/r/glue_catalog_table.html.markdown @@ -114,6 +114,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `catalogId` - (Optional) ID of the Glue Catalog and database to create the table in. If omitted, this defaults to the AWS Account ID plus the database name. * `description` - (Optional) Description of the table. * `owner` - (Optional) Owner of the table. @@ -156,6 +157,7 @@ To add an index to an existing table, see the [`glue_partition_index` resource]( * `comment` - (Optional) Free-form text comment. * `name` - (Required) Name of the Partition Key. +* `parameters` - (Optional) Map of key-value pairs. * `type` - (Optional) Datatype of data in the Partition Key. ### storage_descriptor @@ -257,4 +259,4 @@ Using `terraform import`, import Glue Tables using the catalog ID (usually AWS a % terraform import aws_glue_catalog_table.MyTable 123456789012:MyDatabase:MyTable ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/glue_catalog_table_optimizer.html.markdown b/website/docs/cdktf/typescript/r/glue_catalog_table_optimizer.html.markdown index ff4cee599498..96d00198484f 100644 --- a/website/docs/cdktf/typescript/r/glue_catalog_table_optimizer.html.markdown +++ b/website/docs/cdktf/typescript/r/glue_catalog_table_optimizer.html.markdown @@ -64,13 +64,13 @@ class MyConvertedCode extends TerraformStack { configuration: [ { enabled: true, - retention_configuration: [ + retentionConfiguration: [ { - iceberg_configuration: [ + icebergConfiguration: [ { - clean_expired_files: true, - number_of_snapshots_to_retain: 3, - snapshot_retention_period_in_days: 7, + cleanExpiredFiles: true, + numberOfSnapshotsToRetain: 3, + snapshotRetentionPeriodInDays: 7, }, ], }, @@ -106,12 +106,12 @@ class MyConvertedCode extends TerraformStack { configuration: [ { enabled: true, - orphan_file_deletion_configuration: [ + orphanFileDeletionConfiguration: [ { - iceberg_configuration: [ + icebergConfiguration: [ { location: "s3://example-bucket/example_table/", - orphan_file_retention_period_in_days: 7, + orphanFileRetentionPeriodInDays: 7, }, ], }, @@ -130,8 +130,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `catalogId` - (Required) The Catalog ID of the table. * `configuration` - (Required) A configuration block that defines the table optimizer settings. See [Configuration](#configuration) for additional details. * `databaseName` - (Required) The name of the database in the catalog in which the table resides. @@ -141,22 +142,22 @@ The following arguments are required: ### Configuration * `enabled` - (Required) Indicates whether the table optimizer is enabled. -* `orphan_file_deletion_configuration` (Optional) - The configuration block for an orphan file deletion optimizer. See [Orphan File Deletion Configuration](#orphan-file-deletion-configuration) for additional details. -* `retention_configuration` (Optional) - The configuration block for a snapshot retention optimizer. See [Retention Configuration](#retention-configuration) for additional details. +* `orphanFileDeletionConfiguration` (Optional) - The configuration block for an orphan file deletion optimizer. See [Orphan File Deletion Configuration](#orphan-file-deletion-configuration) for additional details. +* `retentionConfiguration` (Optional) - The configuration block for a snapshot retention optimizer. See [Retention Configuration](#retention-configuration) for additional details. * `roleArn` - (Required) The ARN of the IAM role to use for the table optimizer. ### Orphan File Deletion Configuration * `icebergConfiguration` (Optional) - The configuration for an Iceberg orphan file deletion optimizer. - * `orphan_file_retention_period_in_days` (Optional) - The number of days that orphan files should be retained before file deletion. Defaults to `3`. + * `orphanFileRetentionPeriodInDays` (Optional) - The number of days that orphan files should be retained before file deletion. Defaults to `3`. * `location` (Optional) - Specifies a directory in which to look for files. You may choose a sub-directory rather than the top-level table location. Defaults to the table's location. ### Retention Configuration * `icebergConfiguration` (Optional) - The configuration for an Iceberg snapshot retention optimizer. - * `snapshot_retention_period_in_days` (Optional) - The number of days to retain the Iceberg snapshots. Defaults to `5`, or the corresponding Iceberg table configuration field if it exists. - * `number_of_snapshots_to_retain` (Optional) - The number of Iceberg snapshots to retain within the retention period. Defaults to `1` or the corresponding Iceberg table configuration field if it exists. - * `clean_expired_files` (Optional) - If set to `false`, snapshots are only deleted from table metadata, and the underlying data and metadata files are not deleted. Defaults to `false`. + * `snapshotRetentionPeriodInDays` (Optional) - The number of days to retain the Iceberg snapshots. Defaults to `5`, or the corresponding Iceberg table configuration field if it exists. + * `numberOfSnapshotsToRetain` (Optional) - The number of Iceberg snapshots to retain within the retention period. Defaults to `1` or the corresponding Iceberg table configuration field if it exists. + * `cleanExpiredFiles` (Optional) - If set to `false`, snapshots are only deleted from table metadata, and the underlying data and metadata files are not deleted. Defaults to `false`. ## Attribute Reference @@ -194,4 +195,4 @@ Using `terraform import`, import Glue Catalog Table Optimizer using the `catalog % terraform import aws_glue_catalog_table_optimizer.example 123456789012,example_database,example_table,compaction ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/glue_classifier.html.markdown b/website/docs/cdktf/typescript/r/glue_classifier.html.markdown index 9e1a38c186cc..31bbe06b0a16 100644 --- a/website/docs/cdktf/typescript/r/glue_classifier.html.markdown +++ b/website/docs/cdktf/typescript/r/glue_classifier.html.markdown @@ -127,11 +127,12 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `csvClassifier` - (Optional) A classifier for CSV content. Defined below. -* `grokClassifier` – (Optional) A classifier that uses grok patterns. Defined below. -* `jsonClassifier` – (Optional) A classifier for JSON content. Defined below. -* `name` – (Required) The name of the classifier. -* `xmlClassifier` – (Optional) A classifier for XML content. Defined below. +* `grokClassifier` - (Optional) A classifier that uses grok patterns. Defined below. +* `jsonClassifier` - (Optional) A classifier for JSON content. Defined below. +* `name` - (Required) The name of the classifier. +* `xmlClassifier` - (Optional) A classifier for XML content. Defined below. ### csv_classifier @@ -143,7 +144,7 @@ This resource supports the following arguments: * `disableValueTrimming` - (Optional) Specifies whether to trim column values. * `header` - (Optional) A list of strings representing column names. * `quoteSymbol` - (Optional) A custom symbol to denote what combines content into a single column value. It must be different from the column delimiter. -* `serde` – (Optional) The SerDe for processing CSV. Valid values are `OpenCSVSerDe`, `LazySimpleSerDe`, `None`. +* `serde` - (Optional) The SerDe for processing CSV. Valid values are `OpenCSVSerDe`, `LazySimpleSerDe`, `None`. ### grok_classifier @@ -198,4 +199,4 @@ Using `terraform import`, import Glue Classifiers using their name. For example: % terraform import aws_glue_classifier.MyClassifier MyClassifier ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/glue_connection.html.markdown b/website/docs/cdktf/typescript/r/glue_connection.html.markdown index 7e19c514ae44..010c6a5e38be 100644 --- a/website/docs/cdktf/typescript/r/glue_connection.html.markdown +++ b/website/docs/cdktf/typescript/r/glue_connection.html.markdown @@ -456,20 +456,22 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This resource supports the following arguments: -* `name` – (Required) Name of the connection. +* `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). +* `name` - (Required) Name of the connection. The following arguments are optional: -* `catalogId` – (Optional) ID of the Data Catalog in which to create the connection. If none is supplied, the AWS account ID is used by default. -* `athenaProperties` – (Optional) Map of key-value pairs used as connection properties specific to the Athena compute environment. -* `connectionProperties` – (Optional) Map of key-value pairs used as parameters for this connection. For more information, see the [AWS Documentation](https://docs.aws.amazon.com/glue/latest/dg/connection-properties.html). +* `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). +* `catalogId` - (Optional) ID of the Data Catalog in which to create the connection. If none is supplied, the AWS account ID is used by default. +* `athenaProperties` - (Optional) Map of key-value pairs used as connection properties specific to the Athena compute environment. +* `connectionProperties` - (Optional) Map of key-value pairs used as parameters for this connection. For more information, see the [AWS Documentation](https://docs.aws.amazon.com/glue/latest/dg/connection-properties.html). **Note:** Some connection types require the `SparkProperties` property with a JSON document that contains the actual connection properties. For specific examples, refer to [Example Usage](#example-usage). -* `connectionType` – (Optional) Type of the connection. Valid values: `AZURECOSMOS`, `AZURESQL`, `BIGQUERY`, `CUSTOM`, `DYNAMODB`, `JDBC`, `KAFKA`, `MARKETPLACE`, `MONGODB`, `NETWORK`, `OPENSEARCH`, `SNOWFLAKE`. Defaults to `JDBC`. -* `description` – (Optional) Description of the connection. -* `matchCriteria` – (Optional) List of criteria that can be used in selecting this connection. +* `connectionType` - (Optional) Type of the connection. Valid values: `AZURECOSMOS`, `AZURESQL`, `BIGQUERY`, `CUSTOM`, `DYNAMODB`, `JDBC`, `KAFKA`, `MARKETPLACE`, `MONGODB`, `NETWORK`, `OPENSEARCH`, `SNOWFLAKE`. Defaults to `JDBC`. +* `description` - (Optional) Description of the connection. +* `matchCriteria` - (Optional) List of criteria that can be used in selecting this connection. * `physicalConnectionRequirements` - (Optional) Map of physical connection requirements, such as VPC and SecurityGroup. See [`physicalConnectionRequirements` Block](#physical_connection_requirements-block) for details. * `tags` - (Optional) Key-value map of resource tags. If configured with a provider [`defaultTags` 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. @@ -521,4 +523,4 @@ Using `terraform import`, import Glue Connections using the `CATALOG-ID` (AWS ac % terraform import aws_glue_connection.MyConnection 123456789012:MyConnection ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/glue_crawler.html.markdown b/website/docs/cdktf/typescript/r/glue_crawler.html.markdown index b74a57731dd2..daad08b0e059 100644 --- a/website/docs/cdktf/typescript/r/glue_crawler.html.markdown +++ b/website/docs/cdktf/typescript/r/glue_crawler.html.markdown @@ -215,6 +215,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `databaseName` (Required) Glue database where results are written. * `name` (Required) Name of the crawler. * `role` (Required) The IAM role friendly name (including path without leading slash), or ARN of an IAM role, used by the crawler to access other resources. @@ -355,4 +356,4 @@ Using `terraform import`, import Glue Crawlers using `name`. For example: % terraform import aws_glue_crawler.MyJob MyJob ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/glue_data_catalog_encryption_settings.html.markdown b/website/docs/cdktf/typescript/r/glue_data_catalog_encryption_settings.html.markdown index e4b9def504bf..25cc783afda9 100644 --- a/website/docs/cdktf/typescript/r/glue_data_catalog_encryption_settings.html.markdown +++ b/website/docs/cdktf/typescript/r/glue_data_catalog_encryption_settings.html.markdown @@ -48,8 +48,9 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: -* `dataCatalogEncryptionSettings` – (Required) The security configuration to set. see [Data Catalog Encryption Settings](#data_catalog_encryption_settings). -* `catalogId` – (Optional) The ID of the Data Catalog to set the security configuration for. If none is provided, the AWS account ID is used by default. +* `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). +* `dataCatalogEncryptionSettings` - (Required) The security configuration to set. see [Data Catalog Encryption Settings](#data_catalog_encryption_settings). +* `catalogId` - (Optional) The ID of the Data Catalog to set the security configuration for. If none is provided, the AWS account ID is used by default. ### data_catalog_encryption_settings @@ -105,4 +106,4 @@ Using `terraform import`, import Glue Data Catalog Encryption Settings using `CA % terraform import aws_glue_data_catalog_encryption_settings.example 123456789012 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/glue_data_quality_ruleset.html.markdown b/website/docs/cdktf/typescript/r/glue_data_quality_ruleset.html.markdown index 651a132e1bda..fde0f95cfb29 100644 --- a/website/docs/cdktf/typescript/r/glue_data_quality_ruleset.html.markdown +++ b/website/docs/cdktf/typescript/r/glue_data_quality_ruleset.html.markdown @@ -118,6 +118,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `description` - (Optional) Description of the data quality ruleset. * `name` - (Required, Forces new resource) Name of the data quality ruleset. * `ruleset` - (Optional) A Data Quality Definition Language (DQDL) ruleset. For more information, see the AWS Glue developer guide. @@ -172,4 +173,4 @@ Using `terraform import`, import Glue Data Quality Ruleset using the `name`. For % terraform import aws_glue_data_quality_ruleset.example exampleName ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/glue_dev_endpoint.html.markdown b/website/docs/cdktf/typescript/r/glue_dev_endpoint.html.markdown index 25e141efeb9c..2552d7394417 100644 --- a/website/docs/cdktf/typescript/r/glue_dev_endpoint.html.markdown +++ b/website/docs/cdktf/typescript/r/glue_dev_endpoint.html.markdown @@ -69,6 +69,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `arguments` - (Optional) A map of arguments used to configure the endpoint. * `extraJarsS3Path` - (Optional) Path to one or more Java Jars in an S3 bucket that should be loaded in this endpoint. * `extraPythonLibsS3Path` - (Optional) Path(s) to one or more Python libraries in an S3 bucket that should be loaded in this endpoint. Multiple values must be complete paths separated by a comma. @@ -129,4 +130,4 @@ Using `terraform import`, import a Glue Development Endpoint using the `name`. F % terraform import aws_glue_dev_endpoint.example foo ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/glue_job.html.markdown b/website/docs/cdktf/typescript/r/glue_job.html.markdown index d9bb942c71f2..ac12ac73c193 100644 --- a/website/docs/cdktf/typescript/r/glue_job.html.markdown +++ b/website/docs/cdktf/typescript/r/glue_job.html.markdown @@ -297,34 +297,29 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: -* `command` – (Required) The command of the job. Defined below. -* `connections` – (Optional) The list of connections used for this job. -* `defaultArguments` – (Optional) The map of default arguments for this job. You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes. For information about how to specify and consume your own Job arguments, see the [Calling AWS Glue APIs in Python](http://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-calling.html) topic in the developer guide. For information about the key-value pairs that AWS Glue consumes to set up your job, see the [Special Parameters Used by AWS Glue](http://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-glue-arguments.html) topic in the developer guide. -* `nonOverridableArguments` – (Optional) Non-overridable arguments for this job, specified as name-value pairs. -* `description` – (Optional) Description of the job. -* `executionProperty` – (Optional) Execution property of the job. Defined below. +* `command` - (Required) The command of the job. Defined below. +* `connections` - (Optional) The list of connections used for this job. +* `defaultArguments` - (Optional) The map of default arguments for this job. You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes. For information about how to specify and consume your own Job arguments, see the [Calling AWS Glue APIs in Python](http://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-calling.html) topic in the developer guide. For information about the key-value pairs that AWS Glue consumes to set up your job, see the [Special Parameters Used by AWS Glue](http://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-glue-arguments.html) topic in the developer guide. +* `description` - (Optional) Description of the job. +* `executionClass` - (Optional) Indicates whether the job is run with a standard or flexible execution class. The standard execution class is ideal for time-sensitive workloads that require fast job startup and dedicated resources. Valid value: `FLEX`, `STANDARD`. +* `executionProperty` - (Optional) Execution property of the job. Defined below. * `glueVersion` - (Optional) The version of glue to use, for example "1.0". Ray jobs should set this to 4.0 or greater. For information about available versions, see the [AWS Glue Release Notes](https://docs.aws.amazon.com/glue/latest/dg/release-notes.html). +* `jobMode` - (Optional) Describes how a job was created. Valid values are `SCRIPT`, `NOTEBOOK` and `VISUAL`. * `jobRunQueuingEnabled` - (Optional) Specifies whether job run queuing is enabled for the job runs for this job. A value of true means job run queuing is enabled for the job runs. If false or not populated, the job runs will not be considered for queueing. -* `executionClass` - (Optional) Indicates whether the job is run with a standard or flexible execution class. The standard execution class is ideal for time-sensitive workloads that require fast job startup and dedicated resources. Valid value: `FLEX`, `STANDARD`. -* `maintenanceWindow` – (Optional) Specifies the day of the week and hour for the maintenance window for streaming jobs. -* `maxCapacity` – (Optional) The maximum number of AWS Glue data processing units (DPUs) that can be allocated when this job runs. `Required` when `pythonshell` is set, accept either `0.0625` or `1.0`. Use `numberOfWorkers` and `workerType` arguments instead with `glueVersion` `2.0` and above. -* `maxRetries` – (Optional) The maximum number of times to retry this job if it fails. -* `name` – (Required) The name you assign to this job. It must be unique in your account. +* `maintenanceWindow` - (Optional) Specifies the day of the week and hour for the maintenance window for streaming jobs. +* `maxCapacity` - (Optional) The maximum number of AWS Glue data processing units (DPUs) that can be allocated when this job runs. `Required` when `pythonshell` is set, accept either `0.0625` or `1.0`. Use `numberOfWorkers` and `workerType` arguments instead with `glueVersion` `2.0` and above. +* `maxRetries` - (Optional) The maximum number of times to retry this job if it fails. +* `name` - (Required) The name you assign to this job. It must be unique in your account. +* `nonOverridableArguments` - (Optional) Non-overridable arguments for this job, specified as name-value pairs. * `notificationProperty` - (Optional) Notification property of the job. Defined below. -* `roleArn` – (Required) The ARN of the IAM role associated with this job. +* `numberOfWorkers` - (Optional) The number of workers of a defined workerType that are allocated when a job runs. +* `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). +* `roleArn` - (Required) The ARN of the IAM role associated with this job. * `tags` - (Optional) Key-value map of resource tags. If configured with a provider [`defaultTags` 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) The job timeout in minutes. The default is 2880 minutes (48 hours) for `glueetl` and `pythonshell` jobs, and null (unlimited) for `gluestreaming` jobs. +* `timeout` - (Optional) The job timeout in minutes. The default is 2880 minutes (48 hours) for `glueetl` and `pythonshell` jobs, and null (unlimited) for `gluestreaming` jobs. * `securityConfiguration` - (Optional) The name of the Security Configuration to be associated with the job. * `sourceControlDetails` - (Optional) The details for a source control configuration for a job, allowing synchronization of job artifacts to or from a remote repository. Defined below. -* `workerType` - (Optional) The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, G.2X, or G.025X for Spark jobs. Accepts the value Z.2X for Ray jobs. - * For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker. - * For the G.1X worker type, each worker maps to 1 DPU (4 vCPU, 16 GB of memory, 64 GB disk), and provides 1 executor per worker. Recommended for memory-intensive jobs. - * For the G.2X worker type, each worker maps to 2 DPU (8 vCPU, 32 GB of memory, 128 GB disk), and provides 1 executor per worker. Recommended for memory-intensive jobs. - * For the G.4X worker type, each worker maps to 4 DPU (16 vCPUs, 64 GB of memory) with 256GB disk (approximately 235GB free), and provides 1 executor per worker. Recommended for memory-intensive jobs. Only available for Glue version 3.0. Available AWS Regions: US East (Ohio), US East (N. Virginia), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe (Stockholm). - * For the G.8X worker type, each worker maps to 8 DPU (32 vCPUs, 128 GB of memory) with 512GB disk (approximately 487GB free), and provides 1 executor per worker. Recommended for memory-intensive jobs. Only available for Glue version 3.0. Available AWS Regions: US East (Ohio), US East (N. Virginia), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe (Stockholm). - * For the G.025X worker type, each worker maps to 0.25 DPU (2 vCPU, 4GB of memory, 64 GB disk), and provides 1 executor per worker. Recommended for low volume streaming jobs. Only available for Glue version 3.0. - * For the Z.2X worker type, each worker maps to 2 M-DPU (8vCPU, 64 GB of m emory, 128 GB disk), and provides up to 8 Ray workers based on the autoscaler. -* `numberOfWorkers` - (Optional) The number of workers of a defined workerType that are allocated when a job runs. +* `workerType` - (Optional) The type of predefined worker that is allocated when a job runs. Valid values: `Standard`, `G.1X`, `G.2X`, `G.025X`, `G.4X`, `G.8X`, `G.12X`, `G.16X`, `R.1X`, `R.2X`, `R.4X`, `R.8X`, `Z.2X` (Ray jobs). See the [AWS documentation](https://docs.aws.amazon.com/glue/latest/dg/worker-types.html) for details. ### command Argument Reference @@ -388,4 +383,4 @@ Using `terraform import`, import Glue Jobs using `name`. For example: % terraform import aws_glue_job.MyJob MyJob ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/glue_ml_transform.html.markdown b/website/docs/cdktf/typescript/r/glue_ml_transform.html.markdown index c7ced2be29e2..f44612d51518 100644 --- a/website/docs/cdktf/typescript/r/glue_ml_transform.html.markdown +++ b/website/docs/cdktf/typescript/r/glue_ml_transform.html.markdown @@ -130,16 +130,17 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: -* `name` – (Required) The name you assign to this ML Transform. It must be unique in your account. +* `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). +* `name` - (Required) The name you assign to this ML Transform. It must be unique in your account. * `inputRecordTables` - (Required) A list of AWS Glue table definitions used by the transform. see [Input Record Tables](#input_record_tables). * `parameters` - (Required) The algorithmic parameters that are specific to the transform type used. Conditionally dependent on the transform type. see [Parameters](#parameters). -* `roleArn` – (Required) The ARN of the IAM role associated with this ML Transform. -* `description` – (Optional) Description of the ML Transform. +* `roleArn` - (Required) The ARN of the IAM role associated with this ML Transform. +* `description` - (Optional) Description of the ML Transform. * `glueVersion` - (Optional) The version of glue to use, for example "1.0". For information about available versions, see the [AWS Glue Release Notes](https://docs.aws.amazon.com/glue/latest/dg/release-notes.html). -* `maxCapacity` – (Optional) The number of AWS Glue data processing units (DPUs) that are allocated to task runs for this transform. You can allocate from `2` to `100` DPUs; the default is `10`. `maxCapacity` is a mutually exclusive option with `numberOfWorkers` and `workerType`. -* `maxRetries` – (Optional) The maximum number of times to retry this ML Transform if it fails. +* `maxCapacity` - (Optional) The number of AWS Glue data processing units (DPUs) that are allocated to task runs for this transform. You can allocate from `2` to `100` DPUs; the default is `10`. `maxCapacity` is a mutually exclusive option with `numberOfWorkers` and `workerType`. +* `maxRetries` - (Optional) The maximum number of times to retry this ML Transform if it fails. * `tags` - (Optional) Key-value map of resource tags. If configured with a provider [`defaultTags` 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) The ML Transform timeout in minutes. The default is 2880 minutes (48 hours). +* `timeout` - (Optional) The ML Transform timeout in minutes. The default is 2880 minutes (48 hours). * `workerType` - (Optional) The type of predefined worker that is allocated when an ML Transform runs. Accepts a value of `Standard`, `G.1X`, or `G.2X`. Required with `numberOfWorkers`. * `numberOfWorkers` - (Optional) The number of workers of a defined `workerType` that are allocated when an ML Transform runs. Required with `workerType`. @@ -209,4 +210,4 @@ Using `terraform import`, import Glue ML Transforms using `id`. For example: % terraform import aws_glue_ml_transform.example tfm-c2cafbe83b1c575f49eaca9939220e2fcd58e2d5 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/glue_partition.html.markdown b/website/docs/cdktf/typescript/r/glue_partition.html.markdown index cc2b469a506d..ec424c2712b4 100644 --- a/website/docs/cdktf/typescript/r/glue_partition.html.markdown +++ b/website/docs/cdktf/typescript/r/glue_partition.html.markdown @@ -40,6 +40,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `databaseName` - (Required) Name of the metadata database where the table metadata resides. For Hive compatibility, this must be all lowercase. * `partitionValues` - (Required) The values that define the partition. * `catalogId` - (Optional) ID of the Glue Catalog and database to create the table in. If omitted, this defaults to the AWS Account ID plus the database name. @@ -126,4 +127,4 @@ Using `terraform import`, import Glue Partitions using the catalog ID (usually A % terraform import aws_glue_partition.part 123456789012:MyDatabase:MyTable:val1#val2 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/glue_partition_index.html.markdown b/website/docs/cdktf/typescript/r/glue_partition_index.html.markdown index 82f479b04dc2..87b98db52ea0 100644 --- a/website/docs/cdktf/typescript/r/glue_partition_index.html.markdown +++ b/website/docs/cdktf/typescript/r/glue_partition_index.html.markdown @@ -123,6 +123,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `tableName` - (Required) Name of the table. For Hive compatibility, this must be entirely lowercase. * `databaseName` - (Required) Name of the metadata database where the table metadata resides. For Hive compatibility, this must be all lowercase. * `partitionIndex` - (Required) Configuration block for a partition index. See [`partitionIndex`](#partition_index) below. @@ -178,4 +179,4 @@ Using `terraform import`, import Glue Partition Indexes using the catalog ID (us % terraform import aws_glue_partition_index.example 123456789012:MyDatabase:MyTable:index-name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/glue_registry.html.markdown b/website/docs/cdktf/typescript/r/glue_registry.html.markdown index e2f5da609362..947598f77d8e 100644 --- a/website/docs/cdktf/typescript/r/glue_registry.html.markdown +++ b/website/docs/cdktf/typescript/r/glue_registry.html.markdown @@ -38,8 +38,9 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: -* `registryName` – (Required) The Name of the registry. -* `description` – (Optional) A description of the registry. +* `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). +* `registryName` - (Required) The Name of the registry. +* `description` - (Optional) A description of the registry. * `tags` - (Optional) Key-value map of resource tags. If configured with a provider [`defaultTags` 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. ## Attribute Reference @@ -82,4 +83,4 @@ Using `terraform import`, import Glue Registries using `arn`. For example: % terraform import aws_glue_registry.example arn:aws:glue:us-west-2:123456789012:registry/example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/glue_resource_policy.html.markdown b/website/docs/cdktf/typescript/r/glue_resource_policy.html.markdown index fbfb203908e5..72cfbd17167c 100644 --- a/website/docs/cdktf/typescript/r/glue_resource_policy.html.markdown +++ b/website/docs/cdktf/typescript/r/glue_resource_policy.html.markdown @@ -54,7 +54,7 @@ class MyConvertedCode extends TerraformStack { "arn:${" + dataAwsPartitionCurrent.partition + "}:glue:${" + - dataAwsRegionCurrent.name + + dataAwsRegionCurrent.region + "}:${" + current.accountId + "}:*", @@ -75,7 +75,8 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: -* `policy` – (Required) The policy to be applied to the aws glue data catalog. +* `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). +* `policy` - (Required) The policy to be applied to the aws glue data catalog. * `enableHybrid` - (Optional) Indicates that you are using both methods to grant cross-account. Valid values are `TRUE` and `FALSE`. Note the terraform will not perform drift detetction on this field as its not return on read. ## Attribute Reference @@ -110,4 +111,4 @@ Using `terraform import`, import Glue Resource Policy using the account ID. For % terraform import aws_glue_resource_policy.Test 12356789012 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/glue_schema.html.markdown b/website/docs/cdktf/typescript/r/glue_schema.html.markdown index 0fefdd2f5dd3..226fbe47f39e 100644 --- a/website/docs/cdktf/typescript/r/glue_schema.html.markdown +++ b/website/docs/cdktf/typescript/r/glue_schema.html.markdown @@ -43,12 +43,13 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: -* `schemaName` – (Required) The Name of the schema. +* `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). +* `schemaName` - (Required) The Name of the schema. * `registryArn` - (Required) The ARN of the Glue Registry to create the schema in. * `dataFormat` - (Required) The data format of the schema definition. Valid values are `AVRO`, `JSON` and `PROTOBUF`. * `compatibility` - (Required) The compatibility mode of the schema. Values values are: `NONE`, `DISABLED`, `BACKWARD`, `BACKWARD_ALL`, `FORWARD`, `FORWARD_ALL`, `FULL`, and `FULL_ALL`. * `schemaDefinition` - (Required) The schema definition using the `dataFormat` setting for `schemaName`. -* `description` – (Optional) A description of the schema. +* `description` - (Optional) A description of the schema. * `tags` - (Optional) Key-value map of resource tags. If configured with a provider [`defaultTags` 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. ## Attribute Reference @@ -95,4 +96,4 @@ Using `terraform import`, import Glue Registries using `arn`. For example: % terraform import aws_glue_schema.example arn:aws:glue:us-west-2:123456789012:schema/example/example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/glue_security_configuration.html.markdown b/website/docs/cdktf/typescript/r/glue_security_configuration.html.markdown index 89ce2aa8d48a..7500e7a2bfba 100644 --- a/website/docs/cdktf/typescript/r/glue_security_configuration.html.markdown +++ b/website/docs/cdktf/typescript/r/glue_security_configuration.html.markdown @@ -50,8 +50,9 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: -* `encryptionConfiguration` – (Required) Configuration block containing encryption configuration. Detailed below. -* `name` – (Required) Name of the security configuration. +* `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). +* `encryptionConfiguration` - (Required) Configuration block containing encryption configuration. Detailed below. +* `name` - (Required) Name of the security configuration. ### encryption_configuration Argument Reference @@ -112,4 +113,4 @@ Using `terraform import`, import Glue Security Configurations using `name`. For % terraform import aws_glue_security_configuration.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/glue_trigger.html.markdown b/website/docs/cdktf/typescript/r/glue_trigger.html.markdown index a16f8781d056..3c12b33b324e 100644 --- a/website/docs/cdktf/typescript/r/glue_trigger.html.markdown +++ b/website/docs/cdktf/typescript/r/glue_trigger.html.markdown @@ -187,15 +187,16 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: -* `actions` – (Required) List of actions initiated by this trigger when it fires. See [Actions](#actions) Below. -* `description` – (Optional) A description of the new trigger. -* `enabled` – (Optional) Start the trigger. Defaults to `true`. -* `name` – (Required) The name of the trigger. -* `predicate` – (Optional) A predicate to specify when the new trigger should fire. Required when trigger type is `CONDITIONAL`. See [Predicate](#predicate) Below. -* `schedule` – (Optional) A cron expression used to specify the schedule. [Time-Based Schedules for Jobs and Crawlers](https://docs.aws.amazon.com/glue/latest/dg/monitor-data-warehouse-schedule.html) +* `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). +* `actions` - (Required) List of actions initiated by this trigger when it fires. See [Actions](#actions) Below. +* `description` - (Optional) A description of the new trigger. +* `enabled` - (Optional) Start the trigger. Defaults to `true`. +* `name` - (Required) The name of the trigger. +* `predicate` - (Optional) A predicate to specify when the new trigger should fire. Required when trigger type is `CONDITIONAL`. See [Predicate](#predicate) Below. +* `schedule` - (Optional) A cron expression used to specify the schedule. [Time-Based Schedules for Jobs and Crawlers](https://docs.aws.amazon.com/glue/latest/dg/monitor-data-warehouse-schedule.html) * `tags` - (Optional) Key-value map of resource tags. If configured with a provider [`defaultTags` 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. -* `startOnCreation` – (Optional) Set to true to start `SCHEDULED` and `CONDITIONAL` triggers when created. True is not supported for `ON_DEMAND` triggers. -* `type` – (Required) The type of trigger. Valid values are `CONDITIONAL`, `EVENT`, `ON_DEMAND`, and `SCHEDULED`. +* `startOnCreation` - (Optional) Set to true to start `SCHEDULED` and `CONDITIONAL` triggers when created. True is not supported for `ON_DEMAND` triggers. +* `type` - (Required) The type of trigger. Valid values are `CONDITIONAL`, `EVENT`, `ON_DEMAND`, and `SCHEDULED`. * `workflowName` - (Optional) A workflow to which the trigger should be associated to. Every workflow graph (DAG) needs a starting trigger (`ON_DEMAND` or `SCHEDULED` type) and can contain multiple additional `CONDITIONAL` triggers. * `eventBatchingCondition` - (Optional) Batch condition that must be met (specified number of events received or batch time window expired) before EventBridge event trigger fires. See [Event Batching Condition](#event-batching-condition). @@ -275,4 +276,4 @@ Using `terraform import`, import Glue Triggers using `name`. For example: % terraform import aws_glue_trigger.MyTrigger MyTrigger ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/glue_user_defined_function.html.markdown b/website/docs/cdktf/typescript/r/glue_user_defined_function.html.markdown index 8d126d4e5f75..b5f9481c1443 100644 --- a/website/docs/cdktf/typescript/r/glue_user_defined_function.html.markdown +++ b/website/docs/cdktf/typescript/r/glue_user_defined_function.html.markdown @@ -59,6 +59,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) The name of the function. * `catalogId` - (Optional) ID of the Glue Catalog to create the function in. If omitted, this defaults to the AWS Account ID. * `databaseName` - (Required) The name of the Database to create the Function. @@ -112,4 +113,4 @@ Using `terraform import`, import Glue User Defined Functions using the `catalog_ % terraform import aws_glue_user_defined_function.func 123456789012:my_database:my_func ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/glue_workflow.html.markdown b/website/docs/cdktf/typescript/r/glue_workflow.html.markdown index 0f2440146daa..30bb0d8110d4 100644 --- a/website/docs/cdktf/typescript/r/glue_workflow.html.markdown +++ b/website/docs/cdktf/typescript/r/glue_workflow.html.markdown @@ -69,9 +69,10 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: -* `name` – (Required) The name you assign to this workflow. -* `defaultRunProperties` – (Optional) A map of default run properties for this workflow. These properties are passed to all jobs associated to the workflow. -* `description` – (Optional) Description of the workflow. +* `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). +* `name` - (Required) The name you assign to this workflow. +* `defaultRunProperties` - (Optional) A map of default run properties for this workflow. These properties are passed to all jobs associated to the workflow. +* `description` - (Optional) Description of the workflow. * `maxConcurrentRuns` - (Optional) Prevents exceeding the maximum number of concurrent runs of any of the component jobs. If you leave this parameter blank, there is no limit to the number of concurrent workflow runs. * `tags` - (Optional) Key-value map of resource tags. If configured with a provider [`defaultTags` 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. @@ -111,4 +112,4 @@ Using `terraform import`, import Glue Workflows using `name`. For example: % terraform import aws_glue_workflow.MyWorkflow MyWorkflow ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/grafana_license_association.html.markdown b/website/docs/cdktf/typescript/r/grafana_license_association.html.markdown index 207d97365e68..d1ed81e87518 100644 --- a/website/docs/cdktf/typescript/r/grafana_license_association.html.markdown +++ b/website/docs/cdktf/typescript/r/grafana_license_association.html.markdown @@ -73,6 +73,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `grafanaToken` - (Optional) A token from Grafana Labs that ties your AWS account with a Grafana Labs account. * `licenseType` - (Required) The type of license for the workspace license association. Valid values are `ENTERPRISE` and `ENTERPRISE_FREE_TRIAL`. * `workspaceId` - (Required) The workspace id. @@ -116,4 +117,4 @@ Using `terraform import`, import Grafana workspace license association using the % terraform import aws_grafana_license_association.example g-2054c75a02 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/grafana_role_association.html.markdown b/website/docs/cdktf/typescript/r/grafana_role_association.html.markdown index d11b622b6db5..ed769240f566 100644 --- a/website/docs/cdktf/typescript/r/grafana_role_association.html.markdown +++ b/website/docs/cdktf/typescript/r/grafana_role_association.html.markdown @@ -79,6 +79,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `groupIds` - (Optional) The AWS SSO group ids to be assigned the role given in `role`. * `userIds` - (Optional) The AWS SSO user ids to be assigned the role given in `role`. @@ -86,4 +87,4 @@ The following arguments are optional: This resource exports no additional attributes. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/grafana_workspace.html.markdown b/website/docs/cdktf/typescript/r/grafana_workspace.html.markdown index 79d0346301be..7d7730d71899 100644 --- a/website/docs/cdktf/typescript/r/grafana_workspace.html.markdown +++ b/website/docs/cdktf/typescript/r/grafana_workspace.html.markdown @@ -93,7 +93,7 @@ class MyConvertedCode extends TerraformStack { ``` -The optional argument `configuration` is a JSON string that enables the unified `Grafana Alerting` (Grafana version 10 or newer) and `Plugins Management` (Grafana version 9 or newer) on the Grafana Workspaces. +The optional argument `configuration` is a JSON string that disables the unified `Grafana Alerting` (Grafana version 10 or newer) and enables `Plugin Management` (Grafana version 9 or newer) on the Grafana Workspaces. For more information about using Grafana alerting, and the effects of turning it on or off, see [Alerts in Grafana version 10](https://docs.aws.amazon.com/grafana/latest/userguide/v10-alerts.html). @@ -107,8 +107,9 @@ The following arguments are required: The following arguments are optional: +* `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). * `configuration` - (Optional) The configuration string for the workspace that you create. For more information about the format and configuration options available, see [Working in your Grafana workspace](https://docs.aws.amazon.com/grafana/latest/userguide/AMG-configure-workspace.html). -* `dataSources` - (Optional) The data sources for the workspace. Valid values are `AMAZON_OPENSEARCH_SERVICE`, `ATHENA`, `CLOUDWATCH`, `PROMETHEUS`, `REDSHIFT`, `SITEWISE`, `TIMESTREAM`, `XRAY` +* `dataSources` - (Optional) The data sources for the workspace. Valid values are `AMAZON_OPENSEARCH_SERVICE`, `ATHENA`, `CLOUDWATCH`, `PROMETHEUS`, `REDSHIFT`, `SITEWISE`, `TIMESTREAM`, `TWINMAKER`, XRAY` * `description` - (Optional) The workspace description. * `grafanaVersion` - (Optional) Specifies the version of Grafana to support in the new workspace. Supported values are `8.4`, `9.4` and `10.4`. If not specified, defaults to the latest version. * `name` - (Optional) The Grafana workspace name. @@ -168,4 +169,4 @@ Using `terraform import`, import Grafana Workspace using the workspace's `id`. F % terraform import aws_grafana_workspace.example g-2054c75a02 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/grafana_workspace_api_key.html.markdown b/website/docs/cdktf/typescript/r/grafana_workspace_api_key.html.markdown index 8a2970422a87..ec2f43b67176 100644 --- a/website/docs/cdktf/typescript/r/grafana_workspace_api_key.html.markdown +++ b/website/docs/cdktf/typescript/r/grafana_workspace_api_key.html.markdown @@ -41,8 +41,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +- `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). - `keyName` - (Required) Specifies the name of the API key. Key names must be unique to the workspace. - `keyRole` - (Required) Specifies the permission level of the API key. Valid values are `VIEWER`, `EDITOR`, or `ADMIN`. - `secondsToLive` - (Required) Specifies the time in seconds until the API key expires. Keys can be valid for up to 30 days. @@ -54,4 +55,4 @@ This resource exports the following attributes in addition to the arguments abov * `key` - The key token in JSON format. Use this value as a bearer token to authenticate HTTP requests to the workspace. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/grafana_workspace_saml_configuration.html.markdown b/website/docs/cdktf/typescript/r/grafana_workspace_saml_configuration.html.markdown index f4ac84f81479..53c715ab6c85 100644 --- a/website/docs/cdktf/typescript/r/grafana_workspace_saml_configuration.html.markdown +++ b/website/docs/cdktf/typescript/r/grafana_workspace_saml_configuration.html.markdown @@ -76,6 +76,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `adminRoleValues` - (Optional) The admin role values. * `allowedOrganizations` - (Optional) The allowed organizations. * `emailAssertion` - (Optional) The email assertion. @@ -126,4 +127,4 @@ Using `terraform import`, import Grafana Workspace SAML configuration using the % terraform import aws_grafana_workspace_saml_configuration.example g-2054c75a02 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/grafana_workspace_service_account.html.markdown b/website/docs/cdktf/typescript/r/grafana_workspace_service_account.html.markdown index 995087abea8b..49d783d10d19 100644 --- a/website/docs/cdktf/typescript/r/grafana_workspace_service_account.html.markdown +++ b/website/docs/cdktf/typescript/r/grafana_workspace_service_account.html.markdown @@ -43,8 +43,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `name` - (Required) A name for the service account. The name must be unique within the workspace, as it determines the ID associated with the service account. * `grafanaRole` - (Required) The permission level to use for this service account. For more information about the roles and the permissions each has, see the [User roles](https://docs.aws.amazon.com/grafana/latest/userguide/Grafana-user-roles.html) documentation. * `workspaceId` - (Required) The Grafana workspace with which the service account is associated. @@ -87,4 +88,4 @@ Using `terraform import`, import Managed Grafana Workspace Service Account using % terraform import aws_grafana_workspace_service_account.example g-abc12345,1 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/grafana_workspace_service_account_token.html.markdown b/website/docs/cdktf/typescript/r/grafana_workspace_service_account_token.html.markdown index 501f5d3f27d3..b2705c70e1e3 100644 --- a/website/docs/cdktf/typescript/r/grafana_workspace_service_account_token.html.markdown +++ b/website/docs/cdktf/typescript/r/grafana_workspace_service_account_token.html.markdown @@ -53,8 +53,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `name` - (Required) A name for the token to create. The name must be unique within the workspace. * `secondsToLive` - (Required) Sets how long the token will be valid, in seconds. You can set the time up to 30 days in the future. * `serviceAccountId` - (Required) The ID of the service account for which to create a token. @@ -69,4 +70,4 @@ This resource exports the following attributes in addition to the arguments abov * `expiresAt` - Specifies when the service account token will expire. * `key` - The key for the service account token. Used when making calls to the Grafana HTTP APIs to authenticate and authorize the requests. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/guardduty_detector.html.markdown b/website/docs/cdktf/typescript/r/guardduty_detector.html.markdown index 510b1c85a76e..2078f9f93408 100644 --- a/website/docs/cdktf/typescript/r/guardduty_detector.html.markdown +++ b/website/docs/cdktf/typescript/r/guardduty_detector.html.markdown @@ -57,9 +57,10 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `enable` - (Optional) Enable monitoring and feedback reporting. Setting to `false` is equivalent to "suspending" GuardDuty. Defaults to `true`. * `findingPublishingFrequency` - (Optional) Specifies the frequency of notifications sent for subsequent finding occurrences. If the detector is a GuardDuty member account, the value is determined by the GuardDuty primary account and cannot be modified, otherwise defaults to `SIX_HOURS`. For standalone and GuardDuty primary accounts, it must be configured in Terraform to enable drift detection. Valid values for standalone and primary accounts: `FIFTEEN_MINUTES`, `ONE_HOUR`, `SIX_HOURS`. See [AWS Documentation](https://docs.aws.amazon.com/guardduty/latest/ug/guardduty_findings_cloudwatch.html#guardduty_findings_cloudwatch_notification_frequency) for more information. -* `datasources` - (Optional) Describes which data sources will be enabled for the detector. See [Data Sources](#data-sources) below for more details. [Deprecated](https://docs.aws.amazon.com/guardduty/latest/ug/guardduty-feature-object-api-changes-march2023.html) in favor of [`aws_guardduty_detector_feature` resources](guardduty_detector_feature.html). +* `datasources` - (Optional, **Deprecated** use `aws_guardduty_detector_feature` resources instead) Describes which data sources will be enabled for the detector. See [Data Sources](#data-sources) below for more details. [Deprecated](https://docs.aws.amazon.com/guardduty/latest/ug/guardduty-feature-object-api-changes-march2023.html) in favor of [`aws_guardduty_detector_feature` resources](guardduty_detector_feature.html). * `tags` - (Optional) Key-value map of resource tags. If configured with a provider [`defaultTags` 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. ### Data Sources @@ -160,4 +161,4 @@ Using `terraform import`, import GuardDuty detectors using the detector ID. For The ID of the detector can be retrieved via the [AWS CLI](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/guardduty/list-detectors.html) using `aws guardduty list-detectors`. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/guardduty_detector_feature.html.markdown b/website/docs/cdktf/typescript/r/guardduty_detector_feature.html.markdown index 387144a2f40d..03cc294a73d5 100644 --- a/website/docs/cdktf/typescript/r/guardduty_detector_feature.html.markdown +++ b/website/docs/cdktf/typescript/r/guardduty_detector_feature.html.markdown @@ -32,6 +32,41 @@ class MyConvertedCode extends TerraformStack { const example = new GuarddutyDetector(this, "example", { enable: true, }); + new GuarddutyDetectorFeature(this, "s3_protection", { + detectorId: example.id, + name: "S3_DATA_EVENTS", + status: "ENABLED", + }); + } +} + +``` + +## Extended Threat Detection for EKS + +To enable GuardDuty [Extended Threat Detection](https://docs.aws.amazon.com/guardduty/latest/ug/guardduty-extended-threat-detection.html) for EKS, you need at least one of these features enabled: [EKS Protection](https://docs.aws.amazon.com/guardduty/latest/ug/kubernetes-protection.html) or [Runtime Monitoring](https://docs.aws.amazon.com/guardduty/latest/ug/runtime-monitoring-configuration.html). For maximum detection coverage, enabling both is recommended to enhance detection capabilities. + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { GuarddutyDetector } from "./.gen/providers/aws/guardduty-detector"; +import { GuarddutyDetectorFeature } from "./.gen/providers/aws/guardduty-detector-feature"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + const example = new GuarddutyDetector(this, "example", { + enable: true, + }); + new GuarddutyDetectorFeature(this, "eks_protection", { + detectorId: example.id, + name: "EKS_AUDIT_LOGS", + status: "ENABLED", + }); new GuarddutyDetectorFeature(this, "eks_runtime_monitoring", { additionalConfiguration: [ { @@ -52,6 +87,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `detectorId` - (Required) Amazon GuardDuty detector ID. * `name` - (Required) The name of the detector feature. Valid values: `S3_DATA_EVENTS`, `EKS_AUDIT_LOGS`, `EBS_MALWARE_PROTECTION`, `RDS_LOGIN_EVENTS`, `EKS_RUNTIME_MONITORING`, `LAMBDA_NETWORK_LOGS`, `RUNTIME_MONITORING`. Only one of two features `EKS_RUNTIME_MONITORING` or `RUNTIME_MONITORING` can be added, adding both features will cause an error. Refer to the [AWS Documentation](https://docs.aws.amazon.com/guardduty/latest/APIReference/API_DetectorFeatureConfiguration.html) for the current list of supported values. * `status` - (Required) The status of the detector feature. Valid values: `ENABLED`, `DISABLED`. @@ -68,4 +104,4 @@ The `additionalConfiguration` block supports the following: This resource exports no additional attributes. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/guardduty_filter.html.markdown b/website/docs/cdktf/typescript/r/guardduty_filter.html.markdown index 59b05d83229b..cd0dcf402440 100644 --- a/website/docs/cdktf/typescript/r/guardduty_filter.html.markdown +++ b/website/docs/cdktf/typescript/r/guardduty_filter.html.markdown @@ -62,6 +62,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `detectorId` - (Required) ID of a GuardDuty detector, attached to your account. * `name` - (Required) The name of your filter. * `description` - (Optional) Description of the filter. @@ -87,7 +88,6 @@ The `criterion` block suports the following: This resource exports the following attributes in addition to the arguments above: * `arn` - The ARN of the GuardDuty filter. -* `id` - A compound field, consisting of the ID of the GuardDuty detector and the name of the filter. * `tagsAll` - A map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). ## Import @@ -122,4 +122,4 @@ Using `terraform import`, import GuardDuty filters using the detector ID and fil % terraform import aws_guardduty_filter.MyFilter 00b00fd5aecc0ab60a708659477e9617:MyFilter ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/guardduty_invite_accepter.html.markdown b/website/docs/cdktf/typescript/r/guardduty_invite_accepter.html.markdown index f2dc24b72b45..b5b30623abc5 100644 --- a/website/docs/cdktf/typescript/r/guardduty_invite_accepter.html.markdown +++ b/website/docs/cdktf/typescript/r/guardduty_invite_accepter.html.markdown @@ -71,14 +71,13 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `detectorId` - (Required) The detector ID of the member GuardDuty account. * `masterAccountId` - (Required) AWS account ID for primary account. ## Attribute Reference -This resource exports the following attributes in addition to the arguments above: - -* `id` - GuardDuty member detector ID +This resource exports no additional attributes. ## Timeouts @@ -118,4 +117,4 @@ Using `terraform import`, import `aws_guardduty_invite_accepter` using the membe % terraform import aws_guardduty_invite_accepter.member 00b00fd5aecc0ab60a708659477e9617 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/guardduty_ipset.html.markdown b/website/docs/cdktf/typescript/r/guardduty_ipset.html.markdown index 8be8aacfafe4..c6c03a61f0e6 100644 --- a/website/docs/cdktf/typescript/r/guardduty_ipset.html.markdown +++ b/website/docs/cdktf/typescript/r/guardduty_ipset.html.markdown @@ -65,6 +65,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `activate` - (Required) Specifies whether GuardDuty is to start using the uploaded IPSet. * `detectorId` - (Required) The detector ID of the GuardDuty. * `format` - (Required) The format of the file that contains the IPSet. Valid values: `TXT` | `STIX` | `OTX_CSV` | `ALIEN_VAULT` | `PROOF_POINT` | `FIRE_EYE` @@ -77,7 +78,6 @@ This resource supports the following arguments: This resource exports the following attributes in addition to the arguments above: * `arn` - Amazon Resource Name (ARN) of the GuardDuty IPSet. -* `id` - The ID of the GuardDuty IPSet. * `tagsAll` - A map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). ## Import @@ -112,4 +112,4 @@ Using `terraform import`, import GuardDuty IPSet using the primary GuardDuty det % terraform import aws_guardduty_ipset.MyIPSet 00b00fd5aecc0ab60a708659477e9617:123456789012 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/guardduty_malware_protection_plan.html.markdown b/website/docs/cdktf/typescript/r/guardduty_malware_protection_plan.html.markdown index 52804d971afb..d1faaf9da806 100644 --- a/website/docs/cdktf/typescript/r/guardduty_malware_protection_plan.html.markdown +++ b/website/docs/cdktf/typescript/r/guardduty_malware_protection_plan.html.markdown @@ -60,6 +60,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `actions` - (Optional) Information about whether the tags will be added to the S3 object after scanning. See [`actions`](#actions-argument-reference) below. * `protectedResource` - (Required) Information about the protected resource that is associated with the created Malware Protection plan. Presently, S3Bucket is the only supported protected resource. See [`protectedResource`](#protected_resource-argument-reference) below. * `role` - (Required) ARN of IAM role that includes the permissions required to scan and add tags to the associated protected resource. @@ -123,4 +124,4 @@ Using `terraform import`, import GuardDuty malware protection plans using their % terraform import aws_guardduty_malware_protection_plan.example 1234567890abcdef0123 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/guardduty_member.html.markdown b/website/docs/cdktf/typescript/r/guardduty_member.html.markdown index 2491e6379dc4..7bf86c78f183 100644 --- a/website/docs/cdktf/typescript/r/guardduty_member.html.markdown +++ b/website/docs/cdktf/typescript/r/guardduty_member.html.markdown @@ -52,6 +52,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `accountId` - (Required) AWS account ID for member account. * `detectorId` - (Required) The detector ID of the GuardDuty account where you want to create member accounts. * `email` - (Required) Email address for member account. @@ -63,7 +64,6 @@ This resource supports the following arguments: This resource exports the following attributes in addition to the arguments above: -* `id` - The ID of the GuardDuty member * `relationshipStatus` - The status of the relationship between the member account and its primary account. More information can be found in [Amazon GuardDuty API Reference](https://docs.aws.amazon.com/guardduty/latest/ug/get-members.html). ## Timeouts @@ -105,4 +105,4 @@ Using `terraform import`, import GuardDuty members using the primary GuardDuty d % terraform import aws_guardduty_member.MyMember 00b00fd5aecc0ab60a708659477e9617:123456789012 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/guardduty_member_detector_feature.html.markdown b/website/docs/cdktf/typescript/r/guardduty_member_detector_feature.html.markdown index b5d375b6b5d9..6c5cb74c091b 100644 --- a/website/docs/cdktf/typescript/r/guardduty_member_detector_feature.html.markdown +++ b/website/docs/cdktf/typescript/r/guardduty_member_detector_feature.html.markdown @@ -24,8 +24,8 @@ import { TerraformStack } from "cdktf"; * Provider bindings are generated by running `cdktf get`. * See https://cdk.tf/provider-generation for more details. */ -import { GuarddutyMemberDetectorFeature } from "./.gen/providers/aws/"; import { GuarddutyDetector } from "./.gen/providers/aws/guardduty-detector"; +import { GuarddutyMemberDetectorFeature } from "./.gen/providers/aws/guardduty-member-detector-feature"; class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); @@ -33,19 +33,52 @@ class MyConvertedCode extends TerraformStack { enable: true, }); new GuarddutyMemberDetectorFeature(this, "runtime_monitoring", { + accountId: "123456789012", + detectorId: example.id, + name: "S3_DATA_EVENTS", + status: "ENABLED", + }); + } +} + +``` + +## Extended Threat Detection for EKS + +To enable GuardDuty [Extended Threat Detection](https://docs.aws.amazon.com/guardduty/latest/ug/guardduty-extended-threat-detection.html) for EKS, you need at least one of these features enabled: [EKS Protection](https://docs.aws.amazon.com/guardduty/latest/ug/kubernetes-protection.html) or [Runtime Monitoring](https://docs.aws.amazon.com/guardduty/latest/ug/runtime-monitoring-configuration.html). For maximum detection coverage, enabling both is recommended to enhance detection capabilities. + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { GuarddutyDetector } from "./.gen/providers/aws/guardduty-detector"; +import { GuarddutyDetectorFeature } from "./.gen/providers/aws/guardduty-detector-feature"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + const example = new GuarddutyDetector(this, "example", { + enable: true, + }); + new GuarddutyDetectorFeature(this, "eks_protection", { + account_id: "123456789012", + detectorId: example.id, + name: "EKS_AUDIT_LOGS", + status: "ENABLED", + }); + new GuarddutyDetectorFeature(this, "eks_runtime_monitoring", { account_id: "123456789012", - additional_configuration: [ + additionalConfiguration: [ { name: "EKS_ADDON_MANAGEMENT", status: "ENABLED", }, - { - name: "ECS_FARGATE_AGENT_MANAGEMENT", - status: "ENABLED", - }, ], - detector_id: example.id, - name: "RUNTIME_MONITORING", + detectorId: example.id, + name: "EKS_RUNTIME_MONITORING", status: "ENABLED", }); } @@ -57,6 +90,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `detectorId` - (Required) Amazon GuardDuty detector ID. * `accountId` - (Required) Member account ID to be updated. * `name` - (Required) The name of the detector feature. Valid values: `S3_DATA_EVENTS`, `EKS_AUDIT_LOGS`, `EBS_MALWARE_PROTECTION`, `RDS_LOGIN_EVENTS`, `EKS_RUNTIME_MONITORING`,`RUNTIME_MONITORING`, `LAMBDA_NETWORK_LOGS`. @@ -74,4 +108,4 @@ The `additionalConfiguration` block supports the following: This resource exports no additional attributes. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/guardduty_organization_admin_account.html.markdown b/website/docs/cdktf/typescript/r/guardduty_organization_admin_account.html.markdown index c1b9b2940bf5..52c9083a6ffc 100644 --- a/website/docs/cdktf/typescript/r/guardduty_organization_admin_account.html.markdown +++ b/website/docs/cdktf/typescript/r/guardduty_organization_admin_account.html.markdown @@ -55,13 +55,12 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `adminAccountId` - (Required) AWS account identifier to designate as a delegated administrator for GuardDuty. ## Attribute Reference -This resource exports the following attributes in addition to the arguments above: - -* `id` - AWS account identifier. +This resource exports no additional attributes. ## Import @@ -95,4 +94,4 @@ Using `terraform import`, import GuardDuty Organization Admin Account using the % terraform import aws_guardduty_organization_admin_account.example 123456789012 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/guardduty_organization_configuration.html.markdown b/website/docs/cdktf/typescript/r/guardduty_organization_configuration.html.markdown index 421640ba1c4f..5e86e3245420 100644 --- a/website/docs/cdktf/typescript/r/guardduty_organization_configuration.html.markdown +++ b/website/docs/cdktf/typescript/r/guardduty_organization_configuration.html.markdown @@ -65,8 +65,9 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: -* `autoEnable` - (Optional) *Deprecated:* Use `autoEnableOrganizationMembers` instead. When this setting is enabled, all new accounts that are created in, or added to, the organization are added as a member accounts of the organization’s GuardDuty delegated administrator and GuardDuty is enabled in that AWS Region. -* `autoEnableOrganizationMembers` - (Optional) Indicates the auto-enablement configuration of GuardDuty for the member accounts in the organization. Valid values are `ALL`, `NEW`, `NONE`. +* `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). +* `autoEnableOrganizationMembers` - (Required) Indicates the auto-enablement configuration of GuardDuty for the member accounts in the organization. + Valid values are `ALL`, `NEW`, `NONE`. * `detectorId` - (Required) The detector ID of the GuardDuty account. * `datasources` - (Optional) Configuration for the collected datasources. [Deprecated](https://docs.aws.amazon.com/guardduty/latest/ug/guardduty-feature-object-api-changes-march2023.html) in favor of [`aws_guardduty_organization_configuration_feature` resources](guardduty_organization_configuration_feature.html). @@ -121,9 +122,7 @@ The `ebsVolumes` block supports the following: ## Attribute Reference -This resource exports the following attributes in addition to the arguments above: - -* `id` - Identifier of the GuardDuty Detector. +This resource exports no additional attributes. ## Import @@ -157,4 +156,4 @@ Using `terraform import`, import GuardDuty Organization Configurations using the % terraform import aws_guardduty_organization_configuration.example 00b00fd5aecc0ab60a708659477e9617 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/guardduty_organization_configuration_feature.html.markdown b/website/docs/cdktf/typescript/r/guardduty_organization_configuration_feature.html.markdown index e55abc10b499..56d3f1b2389d 100644 --- a/website/docs/cdktf/typescript/r/guardduty_organization_configuration_feature.html.markdown +++ b/website/docs/cdktf/typescript/r/guardduty_organization_configuration_feature.html.markdown @@ -12,7 +12,7 @@ description: |- Provides a resource to manage a single Amazon GuardDuty [organization configuration feature](https://docs.aws.amazon.com/guardduty/latest/ug/guardduty-features-activation-model.html#guardduty-features). -~> **NOTE:** Deleting this resource does not disable the organization configuration feature, the resource in simply removed from state instead. +~> **NOTE:** Deleting this resource does not disable the organization configuration feature, the resource is simply removed from state instead. ## Example Usage @@ -56,6 +56,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `autoEnable` - (Required) The status of the feature that is configured for the member accounts within the organization. Valid values: `NEW`, `ALL`, `NONE`. * `detectorId` - (Required) The ID of the detector that configures the delegated administrator. * `name` - (Required) The name of the feature that will be configured for the organization. Valid values: `S3_DATA_EVENTS`, `EKS_AUDIT_LOGS`, `EBS_MALWARE_PROTECTION`, `RDS_LOGIN_EVENTS`, `EKS_RUNTIME_MONITORING`, `LAMBDA_NETWORK_LOGS`, `RUNTIME_MONITORING`. Only one of two features `EKS_RUNTIME_MONITORING` or `RUNTIME_MONITORING` can be added, adding both features will cause an error. Refer to the [AWS Documentation](https://docs.aws.amazon.com/guardduty/latest/APIReference/API_DetectorFeatureConfiguration.html) for the current list of supported values. @@ -72,4 +73,4 @@ The `additionalConfiguration` block supports the following: This resource exports no additional attributes. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/guardduty_publishing_destination.html.markdown b/website/docs/cdktf/typescript/r/guardduty_publishing_destination.html.markdown index b8ec1f803581..7a357ab9d7f2 100644 --- a/website/docs/cdktf/typescript/r/guardduty_publishing_destination.html.markdown +++ b/website/docs/cdktf/typescript/r/guardduty_publishing_destination.html.markdown @@ -90,7 +90,7 @@ class MyConvertedCode extends TerraformStack { ], resources: [ "arn:aws:kms:${" + - dataAwsRegionCurrent.name + + dataAwsRegionCurrent.region + "}:${" + current.accountId + "}:key/*", @@ -107,7 +107,7 @@ class MyConvertedCode extends TerraformStack { ], resources: [ "arn:aws:kms:${" + - dataAwsRegionCurrent.name + + dataAwsRegionCurrent.region + "}:${" + current.accountId + "}:key/*", @@ -138,6 +138,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `detectorId` - (Required) The detector ID of the GuardDuty. * `destinationArn` - (Required) The bucket arn and prefix under which the findings get exported. Bucket-ARN is required, the prefix is optional and will be `AWSLogs/[Account-ID]/GuardDuty/[Region]/` if not provided * `kmsKeyArn` - (Required) The ARN of the KMS key used to encrypt GuardDuty findings. GuardDuty enforces this to be encrypted. @@ -147,9 +148,7 @@ This resource supports the following arguments: ## Attribute Reference -This resource exports the following attributes in addition to the arguments above: - -* `id` - The ID of the GuardDuty PublishingDestination and the detector ID. Format: `:` +This resource exports no additional attributes. ## Import @@ -183,4 +182,4 @@ Using `terraform import`, import GuardDuty PublishingDestination using the maste % terraform import aws_guardduty_publishing_destination.test a4b86f26fa42e7e7cf0d1c333ea77777:a4b86f27a0e464e4a7e0516d242f1234 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/guardduty_threatintelset.html.markdown b/website/docs/cdktf/typescript/r/guardduty_threatintelset.html.markdown index d8d3652c3ee6..b50da0727a52 100644 --- a/website/docs/cdktf/typescript/r/guardduty_threatintelset.html.markdown +++ b/website/docs/cdktf/typescript/r/guardduty_threatintelset.html.markdown @@ -71,6 +71,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `activate` - (Required) Specifies whether GuardDuty is to start using the uploaded ThreatIntelSet. * `detectorId` - (Required) The detector ID of the GuardDuty. * `format` - (Required) The format of the file that contains the ThreatIntelSet. Valid values: `TXT` | `STIX` | `OTX_CSV` | `ALIEN_VAULT` | `PROOF_POINT` | `FIRE_EYE` @@ -83,7 +84,6 @@ This resource supports the following arguments: This resource exports the following attributes in addition to the arguments above: * `arn` - Amazon Resource Name (ARN) of the GuardDuty ThreatIntelSet. -* `id` - The ID of the GuardDuty ThreatIntelSet and the detector ID. Format: `:` * `tagsAll` - A map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). ## Import @@ -118,4 +118,4 @@ Using `terraform import`, import GuardDuty ThreatIntelSet using the primary Guar % terraform import aws_guardduty_threatintelset.MyThreatIntelSet 00b00fd5aecc0ab60a708659477e9617:123456789012 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/iam_group_membership.html.markdown b/website/docs/cdktf/typescript/r/iam_group_membership.html.markdown index 960b3ae168ed..36608e89f562 100644 --- a/website/docs/cdktf/typescript/r/iam_group_membership.html.markdown +++ b/website/docs/cdktf/typescript/r/iam_group_membership.html.markdown @@ -60,7 +60,7 @@ This resource supports the following arguments: * `name` - (Required) The name to identify the Group Membership * `users` - (Required) A list of IAM User names to associate with the Group -* `group` – (Required) The IAM Group name to attach the list of `users` to +* `group` - (Required) The IAM Group name to attach the list of `users` to ## Attribute Reference @@ -68,10 +68,10 @@ This resource exports the following attributes in addition to the arguments abov * `name` - The name to identify the Group Membership * `users` - list of IAM User names -* `group` – IAM Group name +* `group` - IAM Group name [1]: /docs/providers/aws/r/iam_group.html [2]: /docs/providers/aws/r/iam_user.html [3]: /docs/providers/aws/r/iam_user_group_membership.html - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/iam_role_policy.html.markdown b/website/docs/cdktf/typescript/r/iam_role_policy.html.markdown index e1c6f9206567..badb6e8d0717 100644 --- a/website/docs/cdktf/typescript/r/iam_role_policy.html.markdown +++ b/website/docs/cdktf/typescript/r/iam_role_policy.html.markdown @@ -74,21 +74,18 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: -* `name` - (Optional) The name of the role policy. If omitted, Terraform will -assign a random, unique name. -* `namePrefix` - (Optional) Creates a unique name beginning with the specified - prefix. Conflicts with `name`. -* `policy` - (Required) The inline policy document. This is a JSON formatted string. For more information about building IAM policy documents with Terraform, see the [AWS IAM Policy Document Guide](https://learn.hashicorp.com/terraform/aws/iam-policy) +* `name` - (Optional) The name of the role policy. + If omitted, Terraform will assign a random, unique name. +* `namePrefix` - (Optional) Creates a unique name beginning with the specified prefix. + Conflicts with `name`. +* `policy` - (Required) The inline policy document. + This is a JSON formatted string. + For more information about building IAM policy documents with Terraform, see the [AWS IAM Policy Document Guide](https://learn.hashicorp.com/terraform/aws/iam-policy) * `role` - (Required) The name of the IAM role to attach to the policy. ## Attribute Reference -This resource exports the following attributes in addition to the arguments above: - -* `id` - The role policy ID, in the form of `role_name:role_policy_name`. -* `name` - The name of the policy. -* `policy` - The policy document attached to the role. -* `role` - The name of the role associated with the policy. +This resource exports no additional attributes. ## Import @@ -122,4 +119,4 @@ Using `terraform import`, import IAM Role Policies using the `role_name:role_pol % terraform import aws_iam_role_policy.mypolicy role_of_mypolicy_name:mypolicy_name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/iam_server_certificate.html.markdown b/website/docs/cdktf/typescript/r/iam_server_certificate.html.markdown index 545bc90f3220..eb813960d6dc 100644 --- a/website/docs/cdktf/typescript/r/iam_server_certificate.html.markdown +++ b/website/docs/cdktf/typescript/r/iam_server_certificate.html.markdown @@ -129,9 +129,9 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: -* `certificateBody` – (Required, Forces new resource) The contents of the public key certificate in +* `certificateBody` - (Required, Forces new resource) The contents of the public key certificate in PEM-encoded format. -* `certificateChain` – (Optional, Forces new resource) The contents of the certificate chain. +* `certificateChain` - (Optional, Forces new resource) The contents of the certificate chain. This is typically a concatenation of the PEM-encoded public key certificates of the chain. * `name` - (Optional) The name of the Server Certificate. Do not include the path in this value. If omitted, Terraform will assign a random, unique name. @@ -141,7 +141,7 @@ This resource supports the following arguments: included, it defaults to a slash (/). If this certificate is for use with AWS CloudFront, the path must be in format `/cloudfront/your_path_here`. See [IAM Identifiers][1] for more details on IAM Paths. -* `privateKey` – (Required, Forces new resource) The contents of the private key in PEM-encoded format. +* `privateKey` - (Required, Forces new resource) The contents of the private key in PEM-encoded format. * `tags` - (Optional) Map of resource tags for the server certificate. If configured with a provider [`defaultTags` 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. ~> **NOTE:** AWS performs behind-the-scenes modifications to some certificate files if they do not adhere to a specific format. These modifications will result in terraform forever believing that it needs to update the resources since the local and AWS file contents will not match after theses modifications occur. In order to prevent this from happening you must ensure that all your PEM-encoded files use UNIX line-breaks and that `certificateBody` contains only one certificate. All other certificates should go in `certificateChain`. It is common for some Certificate Authorities to issue certificate files that have DOS line-breaks and that are actually multiple certificates concatenated together in order to form a full certificate chain. @@ -198,4 +198,4 @@ Using `terraform import`, import IAM Server Certificates using the `name`. For e [2]: https://docs.aws.amazon.com/IAM/latest/UserGuide/ManagingServerCerts.html [lifecycle]: /docs/configuration/resources.html - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/iam_signing_certificate.html.markdown b/website/docs/cdktf/typescript/r/iam_signing_certificate.html.markdown index cde0c023f553..3f7691376995 100644 --- a/website/docs/cdktf/typescript/r/iam_signing_certificate.html.markdown +++ b/website/docs/cdktf/typescript/r/iam_signing_certificate.html.markdown @@ -76,9 +76,9 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: -* `certificateBody` – (Required) The contents of the signing certificate in PEM-encoded format. -* `status` – (Optional) The status you want to assign to the certificate. `Active` means that the certificate can be used for programmatic calls to Amazon Web Services `Inactive` means that the certificate cannot be used. -* `userName` – (Required) The name of the user the signing certificate is for. +* `certificateBody` - (Required) The contents of the signing certificate in PEM-encoded format. +* `status` - (Optional) The status you want to assign to the certificate. `Active` means that the certificate can be used for programmatic calls to Amazon Web Services `Inactive` means that the certificate cannot be used. +* `userName` - (Required) The name of the user the signing certificate is for. ## Attribute Reference @@ -119,4 +119,4 @@ Using `terraform import`, import IAM Signing Certificates using the `id`. For ex % terraform import aws_iam_signing_certificate.certificate IDIDIDIDID:user-name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/iam_virtual_mfa_device.html.markdown b/website/docs/cdktf/typescript/r/iam_virtual_mfa_device.html.markdown index ea263f83b71b..ad564e305747 100644 --- a/website/docs/cdktf/typescript/r/iam_virtual_mfa_device.html.markdown +++ b/website/docs/cdktf/typescript/r/iam_virtual_mfa_device.html.markdown @@ -48,7 +48,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: * `virtualMfaDeviceName` - (Required) The name of the virtual MFA device. Use with path to uniquely identify a virtual MFA device. -* `path` – (Optional) The path for the virtual MFA device. +* `path` - (Optional) The path for the virtual MFA device. * `tags` - (Optional) Map of resource tags for the virtual mfa device. If configured with a provider [`defaultTags` 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. ## Attribute Reference @@ -94,4 +94,4 @@ Using `terraform import`, import IAM Virtual MFA Devices using the `arn`. For ex % terraform import aws_iam_virtual_mfa_device.example arn:aws:iam::123456789012:mfa/example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/identitystore_group.html.markdown b/website/docs/cdktf/typescript/r/identitystore_group.html.markdown index a148a4c5ecf3..f751eb4f6f14 100644 --- a/website/docs/cdktf/typescript/r/identitystore_group.html.markdown +++ b/website/docs/cdktf/typescript/r/identitystore_group.html.markdown @@ -48,6 +48,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `displayName` - (Optional) A string containing the name of the group. This value is commonly displayed when the group is referenced. * `description` - (Optional) A string containing the description of the group. @@ -103,4 +104,4 @@ Using `terraform import`, import an Identity Store Group using the combination ` % terraform import aws_identitystore_group.example d-9c6705e95c/b8a1c340-8031-7071-a2fb-7dc540320c30 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/identitystore_group_membership.html.markdown b/website/docs/cdktf/typescript/r/identitystore_group_membership.html.markdown index 78300f500ba4..eddb12f87561 100644 --- a/website/docs/cdktf/typescript/r/identitystore_group_membership.html.markdown +++ b/website/docs/cdktf/typescript/r/identitystore_group_membership.html.markdown @@ -79,6 +79,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `memberId` - (Required) The identifier for a user in the Identity Store. * `groupId` - (Required) The identifier for a group in the Identity Store. * `identityStoreId` - (Required) Identity Store ID associated with the Single Sign-On Instance. @@ -121,4 +122,4 @@ Using `terraform import`, import `aws_identitystore_group_membership` using the % terraform import aws_identitystore_group_membership.example d-0000000000/00000000-0000-0000-0000-000000000000 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/identitystore_user.html.markdown b/website/docs/cdktf/typescript/r/identitystore_user.html.markdown index 7bd19c954735..01ae3667660f 100644 --- a/website/docs/cdktf/typescript/r/identitystore_user.html.markdown +++ b/website/docs/cdktf/typescript/r/identitystore_user.html.markdown @@ -66,6 +66,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `addresses` - (Optional) Details about the user's address. At most 1 address is allowed. Detailed below. * `emails` - (Optional) Details about the user's email. At most 1 email is allowed. Detailed below. * `locale` - (Optional) The user's geographical region or location. @@ -105,6 +106,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `formatted` - (Optional) The name that is typically displayed when the name is shown for display. * `honorificPrefix` - (Optional) The honorific prefix of the user. * `honorificSuffix` - (Optional) The honorific suffix of the user. @@ -157,4 +159,4 @@ Using `terraform import`, import an Identity Store User using the combination `i % terraform import aws_identitystore_user.example d-9c6705e95c/065212b4-9061-703b-5876-13a517ae2a7c ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/imagebuilder_component.html.markdown b/website/docs/cdktf/typescript/r/imagebuilder_component.html.markdown index f31cb6a589a5..3929c6495694 100644 --- a/website/docs/cdktf/typescript/r/imagebuilder_component.html.markdown +++ b/website/docs/cdktf/typescript/r/imagebuilder_component.html.markdown @@ -98,6 +98,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `changeDescription` - (Optional) Change description of the component. * `data` - (Optional) Inline YAML string with data of the component. Exactly one of `data` and `uri` can be specified. Terraform will only perform drift detection of its value when present in a configuration. * `description` - (Optional) Description of the component. @@ -154,4 +155,4 @@ Using `terraform import`, import `aws_imagebuilder_components` resources using t Certain resource arguments, such as `uri`, cannot be read via the API and imported into Terraform. Terraform will display a difference for these arguments the first run after import if declared in the Terraform configuration for an imported resource. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/imagebuilder_container_recipe.html.markdown b/website/docs/cdktf/typescript/r/imagebuilder_container_recipe.html.markdown index 8f9ad318dcd0..6874c3f7984f 100644 --- a/website/docs/cdktf/typescript/r/imagebuilder_container_recipe.html.markdown +++ b/website/docs/cdktf/typescript/r/imagebuilder_container_recipe.html.markdown @@ -72,6 +72,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `description` - (Optional) The description of the container recipe. * `dockerfileTemplateData` - (Optional) The Dockerfile template used to build the image as an inline data blob. * `dockerfileTemplateUri` - (Optional) The Amazon S3 URI for the Dockerfile that will be used to build the container image. @@ -106,6 +107,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `blockDeviceMapping` - (Optional) Configuration block(s) with block device mappings for the container recipe. Detailed below. * `image` - (Optional) The AMI ID to use as the base image for a container build and test instance. If not specified, Image Builder will use the appropriate ECS-optimized AMI as a base image. @@ -113,6 +115,7 @@ The following arguments are optional: The following arguments are optional: +* `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). * `deviceName` - (Optional) Name of the device. For example, `/dev/sda` or `/dev/xvdb`. * `ebs` - (Optional) Configuration block with Elastic Block Storage (EBS) block device mapping settings. Detailed below. * `noDevice` - (Optional) Set to `true` to remove a mapping from the parent image. @@ -122,6 +125,7 @@ The following arguments are optional: The following arguments are optional: +* `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). * `deleteOnTermination` - (Optional) Whether to delete the volume on termination. Defaults to unset, which is the value inherited from the parent image. * `encrypted` - (Optional) Whether to encrypt the volume. Defaults to unset, which is the value inherited from the parent image. * `iops` - (Optional) Number of Input/Output (I/O) operations per second to provision for an `io1` or `io2` volume. @@ -174,4 +178,4 @@ Using `terraform import`, import `aws_imagebuilder_container_recipe` resources u % terraform import aws_imagebuilder_container_recipe.example arn:aws:imagebuilder:us-east-1:123456789012:container-recipe/example/1.0.0 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/imagebuilder_distribution_configuration.html.markdown b/website/docs/cdktf/typescript/r/imagebuilder_distribution_configuration.html.markdown index b9cb35a8e78b..40e4df1664cc 100644 --- a/website/docs/cdktf/typescript/r/imagebuilder_distribution_configuration.html.markdown +++ b/website/docs/cdktf/typescript/r/imagebuilder_distribution_configuration.html.markdown @@ -62,6 +62,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `description` - (Optional) Description of the distribution configuration. * `tags` - (Optional) Key-value map of resource tags for the distribution configuration. If configured with a provider [`defaultTags` 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. @@ -73,6 +74,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `amiDistributionConfiguration` - (Optional) Configuration block with Amazon Machine Image (AMI) distribution settings. Detailed below. * `containerDistributionConfiguration` - (Optional) Configuration block with container distribution settings. Detailed below. * `fastLaunchConfiguration` - (Optional) Set of Windows faster-launching configurations to use for AMI distribution. Detailed below. @@ -85,6 +87,7 @@ The following arguments are optional: The following arguments are optional: +* `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). * `amiTags` - (Optional) Key-value map of tags to apply to the distributed AMI. * `description` - (Optional) Description to apply to the distributed AMI. * `kmsKeyId` - (Optional) Amazon Resource Name (ARN) of the Key Management Service (KMS) Key to encrypt the distributed AMI. @@ -96,6 +99,7 @@ The following arguments are optional: The following arguments are optional: +* `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). * `organizationArns` - (Optional) Set of AWS Organization ARNs to assign. * `organizationalUnitArns` - (Optional) Set of AWS Organizational Unit ARNs to assign. * `userGroups` - (Optional) Set of EC2 launch permission user groups to assign. Use `all` to distribute a public AMI. @@ -190,4 +194,4 @@ Using `terraform import`, import `aws_imagebuilder_distribution_configurations` % terraform import aws_imagebuilder_distribution_configuration.example arn:aws:imagebuilder:us-east-1:123456789012:distribution-configuration/example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/imagebuilder_image.html.markdown b/website/docs/cdktf/typescript/r/imagebuilder_image.html.markdown index f74162b4a612..b12423054423 100644 --- a/website/docs/cdktf/typescript/r/imagebuilder_image.html.markdown +++ b/website/docs/cdktf/typescript/r/imagebuilder_image.html.markdown @@ -48,6 +48,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `containerRecipeArn` - (Optional) - Amazon Resource Name (ARN) of the container recipe. * `distributionConfigurationArn` - (Optional) Amazon Resource Name (ARN) of the Image Builder Distribution Configuration. * `enhancedImageMetadataEnabled` - (Optional) Whether additional information about the image being created is collected. Defaults to `true`. @@ -62,6 +63,7 @@ The following arguments are optional: The following arguments are optional: +* `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). * `imageTestsEnabled` - (Optional) Whether image tests are enabled. Defaults to `true`. * `timeoutMinutes` - (Optional) Number of minutes before image tests time out. Valid values are between `60` and `1440`. Defaults to `720`. @@ -69,6 +71,7 @@ The following arguments are optional: The following arguments are optional: +* `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). * `imageScanningEnabled` - (Optional) Indicates whether Image Builder keeps a snapshot of the vulnerability scans that Amazon Inspector runs against the build instance when you create a new image. Defaults to `false`. * `ecrConfiguration` - (Optional) Configuration block with ECR configuration. Detailed below. @@ -76,6 +79,7 @@ The following arguments are optional: The following arguments are optional: +* `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). * `repositoryName` - (Optional) The name of the container repository that Amazon Inspector scans to identify findings for your container images. * `containerTags` - (Optional) Set of tags for Image Builder to apply to the output container image that that Amazon Inspector scans. @@ -87,6 +91,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `onFailure` - (Optional) The action to take if the workflow fails. Must be one of `CONTINUE` or `ABORT`. * `parallelGroup` - (Optional) The parallel group in which to run a test Workflow. * `parameter` - (Optional) Configuration block for the workflow parameters. Detailed below. @@ -157,4 +162,4 @@ Using `terraform import`, import `aws_imagebuilder_image` resources using the Am % terraform import aws_imagebuilder_image.example arn:aws:imagebuilder:us-east-1:123456789012:image/example/1.0.0/1 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/imagebuilder_image_pipeline.html.markdown b/website/docs/cdktf/typescript/r/imagebuilder_image_pipeline.html.markdown index 262c51cbf3db..f9ef4b06e7ce 100644 --- a/website/docs/cdktf/typescript/r/imagebuilder_image_pipeline.html.markdown +++ b/website/docs/cdktf/typescript/r/imagebuilder_image_pipeline.html.markdown @@ -60,7 +60,7 @@ class MyConvertedCode extends TerraformStack { "arn:${" + current.partition + "}:imagebuilder:${" + - dataAwsRegionCurrent.name + + dataAwsRegionCurrent.region + "}:aws:image/amazon-linux-2-x86/x.x.x", version: "1.0.0", }); @@ -97,6 +97,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `containerRecipeArn` - (Optional) Amazon Resource Name (ARN) of the container recipe. * `description` - (Optional) Description of the image pipeline. * `distributionConfigurationArn` - (Optional) Amazon Resource Name (ARN) of the Image Builder Distribution Configuration. @@ -114,6 +115,7 @@ The following arguments are optional: The following arguments are optional: +* `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). * `imageScanningEnabled` - (Optional) Whether image scans are enabled. Defaults to `false`. * `ecrConfiguration` - (Optional) Configuration block with ECR configuration for image scanning. Detailed below. @@ -121,6 +123,7 @@ The following arguments are optional: The following arguments are optional: +* `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). * `container tags` - (Optional) list of tags to apply to scanned images * `repositoryName` - (Optional) The name of the repository to scan @@ -128,6 +131,7 @@ The following arguments are optional: The following arguments are optional: +* `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). * `imageTestsEnabled` - (Optional) Whether image tests are enabled. Defaults to `true`. * `timeoutMinutes` - (Optional) Number of minutes before image tests time out. Valid values are between `60` and `1440`. Defaults to `720`. @@ -139,6 +143,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `pipelineExecutionStartCondition` - (Optional) Condition when the pipeline should trigger a new image build. Valid values are `EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE` and `EXPRESSION_MATCH_ONLY`. Defaults to `EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE`. * `timezone` - (Optional) The timezone that applies to the scheduling expression. For example, "Etc/UTC", "America/Los_Angeles" in the [IANA timezone format](https://www.joda.org/joda-time/timezones.html). If not specified this defaults to UTC. @@ -151,6 +156,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `onFailure` - (Optional) The action to take if the workflow fails. Must be one of `CONTINUE` or `ABORT`. * `parallelGroup` - (Optional) The parallel group in which to run a test Workflow. * `parameter` - (Optional) Configuration block for the workflow parameters. Detailed below. @@ -206,4 +212,4 @@ Using `terraform import`, import `aws_imagebuilder_image_pipeline` resources usi % terraform import aws_imagebuilder_image_pipeline.example arn:aws:imagebuilder:us-east-1:123456789012:image-pipeline/example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/imagebuilder_image_recipe.html.markdown b/website/docs/cdktf/typescript/r/imagebuilder_image_recipe.html.markdown index 07b7b874ec27..5f408a46ebc5 100644 --- a/website/docs/cdktf/typescript/r/imagebuilder_image_recipe.html.markdown +++ b/website/docs/cdktf/typescript/r/imagebuilder_image_recipe.html.markdown @@ -57,7 +57,7 @@ class MyConvertedCode extends TerraformStack { "arn:${" + current.partition + "}:imagebuilder:${" + - dataAwsRegionCurrent.name + + dataAwsRegionCurrent.region + "}:aws:image/amazon-linux-2-x86/x.x.x", version: "1.0.0", }); @@ -77,6 +77,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `blockDeviceMapping` - (Optional) Configuration block(s) with block device mappings for the image recipe. Detailed below. * `description` - (Optional) Description of the image recipe. * `systemsManagerAgent` - (Optional) Configuration block for the Systems Manager Agent installed by default by Image Builder. Detailed below. @@ -158,4 +159,4 @@ Using `terraform import`, import `aws_imagebuilder_image_recipe` resources using % terraform import aws_imagebuilder_image_recipe.example arn:aws:imagebuilder:us-east-1:123456789012:image-recipe/example/1.0.0 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/imagebuilder_infrastructure_configuration.html.markdown b/website/docs/cdktf/typescript/r/imagebuilder_infrastructure_configuration.html.markdown index a30e58b1948b..80c336ae3f0b 100644 --- a/website/docs/cdktf/typescript/r/imagebuilder_infrastructure_configuration.html.markdown +++ b/website/docs/cdktf/typescript/r/imagebuilder_infrastructure_configuration.html.markdown @@ -60,6 +60,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `description` - (Optional) Description for the configuration. * `instanceMetadataOptions` - (Optional) Configuration block with instance metadata options for the HTTP requests that pipeline builds use to launch EC2 build and test instances. Detailed below. * `instanceTypes` - (Optional) Set of EC2 Instance Types. @@ -77,6 +78,7 @@ The following arguments are optional: The following arguments are optional: +* `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). * `httpPutResponseHopLimit` - The number of hops that an instance can traverse to reach its destonation. * `httpTokens` - Whether a signed token is required for instance metadata retrieval requests. Valid values: `required`, `optional`. @@ -94,12 +96,14 @@ The following arguments are required: The following arguments are optional: +* `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). * `s3KeyPrefix` - (Optional) Prefix to use for S3 logs. Defaults to `/`. ### placement The following arguments are optional: +* `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). * `availabilityZone` - (Optional) Availability Zone where your build and test instances will launch. * `hostId` - (Optional) ID of the Dedicated Host on which build and test instances run. Conflicts with `hostResourceGroupArn`. * `hostResourceGroupArn` - (Optional) ARN of the host resource group in which to launch build and test instances. Conflicts with `hostId`. @@ -147,4 +151,4 @@ Using `terraform import`, import `aws_imagebuilder_infrastructure_configuration` % terraform import aws_imagebuilder_infrastructure_configuration.example arn:aws:imagebuilder:us-east-1:123456789012:infrastructure-configuration/example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/imagebuilder_lifecycle_policy.html.markdown b/website/docs/cdktf/typescript/r/imagebuilder_lifecycle_policy.html.markdown index 2154e12c794e..c9a7bfadee23 100644 --- a/website/docs/cdktf/typescript/r/imagebuilder_lifecycle_policy.html.markdown +++ b/website/docs/cdktf/typescript/r/imagebuilder_lifecycle_policy.html.markdown @@ -22,11 +22,11 @@ import { Fn, Token, TerraformStack } from "cdktf"; * Provider bindings are generated by running `cdktf get`. * See https://cdk.tf/provider-generation for more details. */ -import { ImagebuilderLifecyclePolicy } from "./.gen/providers/aws/"; import { DataAwsPartition } from "./.gen/providers/aws/data-aws-partition"; import { DataAwsRegion } from "./.gen/providers/aws/data-aws-region"; import { IamRole } from "./.gen/providers/aws/iam-role"; import { IamRolePolicyAttachment } from "./.gen/providers/aws/iam-role-policy-attachment"; +import { ImagebuilderLifecyclePolicy } from "./.gen/providers/aws/imagebuilder-lifecycle-policy"; class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); @@ -89,12 +89,10 @@ class MyConvertedCode extends TerraformStack { ], resourceSelection: [ { - tagMap: [ - { - key1: "value1", - key2: "value2", - }, - ], + tagMap: { + key1: "value1", + key2: "value2", + }, }, ], resourceType: "AMI_IMAGE", @@ -113,11 +111,12 @@ The following arguments are required: * `name` - (Required) The name of the lifecycle policy to create. * `resourceType` - (Required) The type of Image Builder resource that the lifecycle policy applies to. Valid values: `AMI_IMAGE` or `CONTAINER_IMAGE`. * `executionRole` - (Required) The Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to run lifecycle actions. More information about this role can be found [`here`](https://docs.aws.amazon.com/imagebuilder/latest/userguide/image-lifecycle-prerequisites.html#image-lifecycle-prereq-role). -* `policy_detail` - (Required) Configuration block with policy details. Detailed below. -* `resource_selection` - (Required) Selection criteria for the resources that the lifecycle policy applies to. Detailed below. +* `policyDetail` - (Required) Configuration block with policy details. Detailed below. +* `resourceSelection` - (Required) Selection criteria for the resources that the lifecycle policy applies to. Detailed below. The following arguments are optional: +* `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). * `description` - (Optional) description for the lifecycle policy. * `tags` - (Optional) Key-value map of resource tags for the Image Builder Lifecycle Policy. If configured with a provider [`defaultTags` 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. @@ -130,7 +129,8 @@ The following arguments are required: The following arguments are optional: -* `exclusion_rules` - (Optional) Additional rules to specify resources that should be exempt from policy actions. +* `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). +* `exclusionRules` - (Optional) Additional rules to specify resources that should be exempt from policy actions. ### action @@ -140,12 +140,14 @@ The following arguments are required: The following arguments are optional: -* `include_resources` - (Optional) Specifies the resources that the lifecycle policy applies to. Detailed below. +* `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). +* `includeResources` - (Optional) Specifies the resources that the lifecycle policy applies to. Detailed below. ### include_resources The following arguments are optional: +* `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). * `amis` - (Optional) Specifies whether the lifecycle action should apply to distributed AMIs. * `containers` - (Optional) Specifies whether the lifecycle action should apply to distributed containers. * `snapshots` - (Optional) Specifies whether the lifecycle action should apply to snapshots associated with distributed AMIs. @@ -159,25 +161,28 @@ The following arguments are required: The following arguments are optional: -* `retain_at_least` - (Optional) For age-based filters, this is the number of resources to keep on hand after the lifecycle DELETE action is applied. Impacted resources are only deleted if you have more than this number of resources. If you have fewer resources than this number, the impacted resource is not deleted. +* `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). +* `retainAtLeast` - (Optional) For age-based filters, this is the number of resources to keep on hand after the lifecycle DELETE action is applied. Impacted resources are only deleted if you have more than this number of resources. If you have fewer resources than this number, the impacted resource is not deleted. * `unit` - (Optional) Defines the unit of time that the lifecycle policy uses to determine impacted resources. This is required for age-based rules. Valid values: `DAYS`, `WEEKS`, `MONTHS` or `YEARS`. ### exclusion_rules The following arguments are optional: +* `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). * `amis` - (Optional) Lists configuration values that apply to AMIs that Image Builder should exclude from the lifecycle action. Detailed below. -* `tag_map` - (Optional) Contains a list of tags that Image Builder uses to skip lifecycle actions for Image Builder image resources that have them. +* `tagMap` - (Optional) Contains a list of tags that Image Builder uses to skip lifecycle actions for Image Builder image resources that have them. ### amis The following arguments are optional: -* `is_public` - (Optional) Configures whether public AMIs are excluded from the lifecycle action. -* `last_launched` - (Optional) Specifies configuration details for Image Builder to exclude the most recent resources from lifecycle actions. Detailed below. +* `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). +* `isPublic` - (Optional) Configures whether public AMIs are excluded from the lifecycle action. +* `lastLaunched` - (Optional) Specifies configuration details for Image Builder to exclude the most recent resources from lifecycle actions. Detailed below. * `regions` - (Optional) Configures AWS Regions that are excluded from the lifecycle action. * `sharedAccounts` - Specifies AWS accounts whose resources are excluded from the lifecycle action. -* `tag_map` - (Optional) Lists tags that should be excluded from lifecycle actions for the AMIs that have them. +* `tagMap` - (Optional) Lists tags that should be excluded from lifecycle actions for the AMIs that have them. ### last_launched @@ -190,8 +195,9 @@ The following arguments are required: The following arguments are optional: +* `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). * `recipe` - (Optional) A list of recipe that are used as selection criteria for the output images that the lifecycle policy applies to. Detailed below. -* `tag_map` - (Optional) A list of tags that are used as selection criteria for the Image Builder image resources that the lifecycle policy applies to. +* `tagMap` - (Optional) A list of tags that are used as selection criteria for the Image Builder image resources that the lifecycle policy applies to. ### recipe @@ -221,7 +227,7 @@ import { TerraformStack } from "cdktf"; * Provider bindings are generated by running `cdktf get`. * See https://cdk.tf/provider-generation for more details. */ -import { ImagebuilderLifecyclePolicy } from "./.gen/providers/aws/"; +import { ImagebuilderLifecyclePolicy } from "./.gen/providers/aws/imagebuilder-lifecycle-policy"; class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); @@ -241,4 +247,4 @@ Using `terraform import`, import `aws_imagebuilder_lifecycle_policy` using the A % terraform import aws_imagebuilder_lifecycle_policy.example arn:aws:imagebuilder:us-east-1:123456789012:lifecycle-policy/example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/imagebuilder_workflow.html.markdown b/website/docs/cdktf/typescript/r/imagebuilder_workflow.html.markdown index b13447cf6fcf..1b988d299b2a 100644 --- a/website/docs/cdktf/typescript/r/imagebuilder_workflow.html.markdown +++ b/website/docs/cdktf/typescript/r/imagebuilder_workflow.html.markdown @@ -50,6 +50,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `changeDescription` - (Optional) Change description of the workflow. * `data` - (Optional) Inline YAML string with data of the workflow. Exactly one of `data` and `uri` can be specified. * `description` - (Optional) Description of the workflow. @@ -67,7 +68,7 @@ This resource exports the following attributes in addition to the arguments abov ## Import -In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import EC2 Image Builder Workflow using the `example_id_arg`. For example: +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import EC2 Image Builder Workflow using the `arn`. For example: ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -91,7 +92,7 @@ class MyConvertedCode extends TerraformStack { ``` -Using `terraform import`, import EC2 Image Builder Workflow using the `example_id_arg`. For example: +Using `terraform import`, import EC2 Image Builder Workflow using the `arn`. For example: ```console % terraform import aws_imagebuilder_workflow.example arn:aws:imagebuilder:us-east-1:aws:workflow/test/example/1.0.1/1 @@ -99,4 +100,4 @@ Using `terraform import`, import EC2 Image Builder Workflow using the `example_i Certain resource arguments, such as `uri`, cannot be read via the API and imported into Terraform. Terraform will display a difference for these arguments the first run after import if declared in the Terraform configuration for an imported resource. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/inspector2_delegated_admin_account.html.markdown b/website/docs/cdktf/typescript/r/inspector2_delegated_admin_account.html.markdown index fd47f6920ebc..93092a62d6f8 100644 --- a/website/docs/cdktf/typescript/r/inspector2_delegated_admin_account.html.markdown +++ b/website/docs/cdktf/typescript/r/inspector2_delegated_admin_account.html.markdown @@ -40,8 +40,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `accountId` - (Required) Account to enable as delegated admin account. ## Attribute Reference @@ -89,4 +90,4 @@ Using `terraform import`, import Inspector Delegated Admin Account using the `ac % terraform import aws_inspector2_delegated_admin_account.example 123456789012 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/inspector2_enabler.html.markdown b/website/docs/cdktf/typescript/r/inspector2_enabler.html.markdown index 2b3904cc4877..878f5f489e87 100644 --- a/website/docs/cdktf/typescript/r/inspector2_enabler.html.markdown +++ b/website/docs/cdktf/typescript/r/inspector2_enabler.html.markdown @@ -66,12 +66,13 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `accountIds` - (Required) Set of account IDs. Can contain one of: the Organization's Administrator Account, or one or more Member Accounts. * `resourceTypes` - (Required) Type of resources to scan. - Valid values are `EC2`, `ECR`, `LAMBDA` and `LAMBDA_CODE`. + Valid values are `EC2`, `ECR`, `LAMBDA`, `LAMBDA_CODE` and `CODE_REPOSITORY`. At least one item is required. ## Attribute Reference @@ -86,4 +87,36 @@ This resource exports no additional attributes. * `update` - (Default `5m`) * `delete` - (Default `5m`) - \ No newline at end of file +## Import + +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import Inspector Enabler using `accountIds` and `region_types` formatted as `[account_id1]:[account_id2]:...-[resource_type1]:[resource_type2]:...`, where `accountIds` are sorted in ascending order and `resourceTypes` are sorted in alphabetical order. For example: + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { Inspector2Enabler } from "./.gen/providers/aws/inspector2-enabler"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + Inspector2Enabler.generateConfigForImport( + this, + "example", + "123456789012:234567890123-EC2:ECR" + ); + } +} + +``` + +Using `terraform import`, import Inspector Enabler using using `accountIds` and `region_types` formatted as `[account_id1]:[account_id2]:...-[resource_type1]:[resource_type2]:...`, where `accountIds` are sorted in ascending order and `resourceTypes` are sorted in alphabetical order. For example: + +```console +% terraform import aws_inspector2_enabler.example 123456789012:234567890123-EC2:ECR +``` + + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/inspector2_filter.html.markdown b/website/docs/cdktf/typescript/r/inspector2_filter.html.markdown index 82c2d5647cab..fc864835e3d7 100644 --- a/website/docs/cdktf/typescript/r/inspector2_filter.html.markdown +++ b/website/docs/cdktf/typescript/r/inspector2_filter.html.markdown @@ -57,6 +57,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `description` - (Optional) Description * `reason` - (Optional) Reason for creating the filter * `tags` - (Optional) Map of tags assigned to the resource. If configured with a provider [`defaultTags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. @@ -73,6 +74,8 @@ This resource exports the following attributes in addition to the arguments abov The `filterCriteria` configuration block supports the following attributes: * `awsAccountId` - (Optional) The AWS account ID in which the finding was generated. [Documented below](#string-filter). +* `code_repository_project_name` - (Optional) The project name in a code repository. [Documented below](#string-filter). +* `code_repository_provider_type` - (Optional) The repository provider type (such as GitHub, GitLab, etc.) [Documented below](#string-filter). * `codeVulnerabilityDetectorName` - (Optional) The ID of the component. [Documented below](#string-filter). * `codeVulnerabilityDetectorTags` - (Optional) The ID of the component. [Documented below](#string-filter). * `codeVulnerabilityFilePath` - (Optional) The ID of the component. [Documented below](#string-filter). @@ -82,6 +85,8 @@ The `filterCriteria` configuration block supports the following attributes: * `ec2InstanceSubnetId` - (Optional) The ID of the subnet. [Documented below](#string-filter). * `ec2InstanceVpcId` - (Optional) The ID of the VPC. [Documented below](#string-filter). * `ecrImageArchitecture` - (Optional) The architecture of the ECR image. [Documented below](#string-filter). +* `ecr_image_in_use_count` - (Optional) The number of the ECR images in use. [Documented below](#number-filter). +* `ecr_image_last_in_use_at` - (Optional) The date range when an ECR image was last used in an ECS cluster task or EKS cluster pod. [Documented below](#date-filter). * `ecrImageHash` - (Optional) The SHA256 hash of the ECR image. [Documented below](#string-filter). * `ecrImagePushedAt` - (Optional) The date range when the image was pushed. [Documented below](#date-filter). * `ecrImageRegistry` - (Optional) The registry of the ECR image. [Documented below](#string-filter). @@ -190,10 +195,10 @@ class MyConvertedCode extends TerraformStack { ``` -Using `terraform import`, import Inspector Filter using the `example_id_arg`. For example: +Using `terraform import`, import Inspector Filter using the `arn`. For example: ```console % terraform import aws_inspector2_filter.example "arn:aws:inspector2:us-east-1:111222333444:owner/111222333444/filter/abcdefgh12345678" ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/inspector2_member_association.html.markdown b/website/docs/cdktf/typescript/r/inspector2_member_association.html.markdown index bdf0a2af17cd..c6001f4ce2a2 100644 --- a/website/docs/cdktf/typescript/r/inspector2_member_association.html.markdown +++ b/website/docs/cdktf/typescript/r/inspector2_member_association.html.markdown @@ -38,8 +38,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `accountId` - (Required) ID of the account to associate ## Attribute Reference @@ -82,4 +83,4 @@ Using `terraform import`, import Amazon Inspector Member Association using the ` % terraform import aws_inspector2_member_association.example 123456789012 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/inspector2_organization_configuration.html.markdown b/website/docs/cdktf/typescript/r/inspector2_organization_configuration.html.markdown index 1d6d5b6493d2..421b9ddd38b9 100644 --- a/website/docs/cdktf/typescript/r/inspector2_organization_configuration.html.markdown +++ b/website/docs/cdktf/typescript/r/inspector2_organization_configuration.html.markdown @@ -34,6 +34,7 @@ class MyConvertedCode extends TerraformStack { super(scope, name); new Inspector2OrganizationConfiguration(this, "example", { autoEnable: { + codeRepository: false, ec2: true, ecr: false, lambda: true, @@ -47,14 +48,16 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `autoEnable` - (Required) Configuration block for auto enabling. See below. ### `autoEnable` * `ec2` - (Required) Whether Amazon EC2 scans are automatically enabled for new members of your Amazon Inspector organization. * `ecr` - (Required) Whether Amazon ECR scans are automatically enabled for new members of your Amazon Inspector organization. +* `codeRepository` - (Optional) Whether code repository scans are automatically enabled for new members of your Amazon Inspector organization. * `lambda` - (Optional) Whether Lambda Function scans are automatically enabled for new members of your Amazon Inspector organization. * `lambdaCode` - (Optional) Whether AWS Lambda code scans are automatically enabled for new members of your Amazon Inspector organization. **Note:** Lambda code scanning requires Lambda standard scanning to be activated. Consequently, if you are setting this argument to `true`, you must also set the `lambda` argument to `true`. See [Scanning AWS Lambda functions with Amazon Inspector](https://docs.aws.amazon.com/inspector/latest/user/scanning-lambda.html#lambda-code-scans) for more information. @@ -72,4 +75,4 @@ This resource exports the following attributes in addition to the arguments abov * `update` - (Default `5m`) * `delete` - (Default `5m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/inspector_assessment_target.html.markdown b/website/docs/cdktf/typescript/r/inspector_assessment_target.html.markdown index eee06537c763..923187fb9b4a 100644 --- a/website/docs/cdktf/typescript/r/inspector_assessment_target.html.markdown +++ b/website/docs/cdktf/typescript/r/inspector_assessment_target.html.markdown @@ -46,6 +46,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) The name of the assessment target. * `resourceGroupArn` (Optional) Inspector Resource Group Amazon Resource Name (ARN) stating tags for instance matching. If not specified, all EC2 instances in the current AWS account and region are included in the assessment target. @@ -87,4 +88,4 @@ Using `terraform import`, import Inspector Classic Assessment Targets using thei % terraform import aws_inspector_assessment_target.example arn:aws:inspector:us-east-1:123456789012:target/0-xxxxxxx ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/inspector_assessment_template.html.markdown b/website/docs/cdktf/typescript/r/inspector_assessment_template.html.markdown index 94121fd0de3d..f31de98dd593 100644 --- a/website/docs/cdktf/typescript/r/inspector_assessment_template.html.markdown +++ b/website/docs/cdktf/typescript/r/inspector_assessment_template.html.markdown @@ -52,6 +52,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) The name of the assessment template. * `targetArn` - (Required) The assessment target ARN to attach the template to. * `duration` - (Required) The duration of the inspector run. @@ -105,4 +106,4 @@ Using `terraform import`, import `aws_inspector_assessment_template` using the t % terraform import aws_inspector_assessment_template.example arn:aws:inspector:us-west-2:123456789012:target/0-9IaAzhGR/template/0-WEcjR8CH ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/inspector_resource_group.html.markdown b/website/docs/cdktf/typescript/r/inspector_resource_group.html.markdown index ada336c01196..5b7ff5e6ae99 100644 --- a/website/docs/cdktf/typescript/r/inspector_resource_group.html.markdown +++ b/website/docs/cdktf/typescript/r/inspector_resource_group.html.markdown @@ -41,6 +41,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `tags` - (Required) Key-value map of tags that are used to select the EC2 instances to be included in an [Amazon Inspector assessment target](/docs/providers/aws/r/inspector_assessment_target.html). ## Attribute Reference @@ -49,4 +50,4 @@ This resource exports the following attributes in addition to the arguments abov * `arn` - The resource group ARN. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/instance.html.markdown b/website/docs/cdktf/typescript/r/instance.html.markdown index ecae3b21a0e4..3c8d95416b9f 100644 --- a/website/docs/cdktf/typescript/r/instance.html.markdown +++ b/website/docs/cdktf/typescript/r/instance.html.markdown @@ -45,7 +45,7 @@ class MyConvertedCode extends TerraformStack { mostRecent: true, owners: ["099720109477"], }); - new Instance(this, "web", { + new Instance(this, "example", { ami: Token.asString(ubuntu.id), instanceType: "t3.micro", tags: { @@ -71,7 +71,7 @@ import { Instance } from "./.gen/providers/aws/instance"; class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); - new Instance(this, "web", { + new Instance(this, "example", { ami: "resolve:ssm:/aws/service/ami-amazon-linux-latest/al2023-ami-kernel-default-x86_64", instanceType: "t3.micro", tags: { @@ -98,7 +98,7 @@ import { Instance } from "./.gen/providers/aws/instance"; class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); - const thisVar = new DataAwsAmi(this, "this", { + const example = new DataAwsAmi(this, "example", { filter: [ { name: "architecture", @@ -112,8 +112,8 @@ class MyConvertedCode extends TerraformStack { mostRecent: true, owners: ["amazon"], }); - const awsInstanceThis = new Instance(this, "this_1", { - ami: Token.asString(thisVar.id), + const awsInstanceExample = new Instance(this, "example_1", { + ami: Token.asString(example.id), instanceMarketOptions: { marketType: "spot", spotOptions: { @@ -126,7 +126,7 @@ class MyConvertedCode extends TerraformStack { }, }); /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ - awsInstanceThis.overrideLogicalId("this"); + awsInstanceExample.overrideLogicalId("example"); } } @@ -163,28 +163,25 @@ class MyConvertedCode extends TerraformStack { }, vpcId: myVpc.id, }); - const foo = new NetworkInterface(this, "foo", { + const example = new NetworkInterface(this, "example", { privateIps: ["172.16.10.100"], subnetId: mySubnet.id, tags: { Name: "primary_network_interface", }, }); - const awsInstanceFoo = new Instance(this, "foo_3", { + const awsInstanceExample = new Instance(this, "example_3", { ami: "ami-005e54dee72cc1d00", creditSpecification: { cpuCredits: "unlimited", }, instanceType: "t2.micro", - networkInterface: [ - { - deviceIndex: 0, - networkInterfaceId: foo.id, - }, - ], + primaryNetworkInterface: { + networkInterfaceId: example.id, + }, }); /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ - awsInstanceFoo.overrideLogicalId("foo"); + awsInstanceExample.overrideLogicalId("example"); } } @@ -298,17 +295,12 @@ Do not use `volumeTags` if you plan to manage block device tags outside the `aws This resource supports the following arguments: +* `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). * `ami` - (Optional) AMI to use for the instance. Required unless `launchTemplate` is specified and the Launch Template specifes an AMI. If an AMI is specified in the Launch Template, setting `ami` will override the AMI specified in the Launch Template. * `associatePublicIpAddress` - (Optional) Whether to associate a public IP address with an instance in a VPC. * `availabilityZone` - (Optional) AZ to start the instance in. - * `capacityReservationSpecification` - (Optional) Describes an instance's Capacity Reservation targeting option. See [Capacity Reservation Specification](#capacity-reservation-specification) below for more details. - --> **NOTE:** Changing `cpuCoreCount` and/or `cpuThreadsPerCore` will cause the resource to be destroyed and re-created. - -* `cpuCoreCount` - (Optional, **Deprecated** use the `cpuOptions` argument instead) Sets the number of CPU cores for an instance. This option is only supported on creation of instance type that support CPU Options [CPU Cores and Threads Per CPU Core Per Instance Type](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-optimize-cpu.html#cpu-options-supported-instances-values) - specifying this option for unsupported instance types will return an error from the EC2 API. * `cpuOptions` - (Optional) The CPU options for the instance. See [CPU Options](#cpu-options) below for more details. -* `cpuThreadsPerCore` - (Optional - has no effect unless `cpuCoreCount` is also set, **Deprecated** use the `cpuOptions` argument instead) If set to 1, hyperthreading is disabled on the launched instance. Defaults to 2 if not set. See [Optimizing CPU Options](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-optimize-cpu.html) for more information. * `creditSpecification` - (Optional) Configuration block for customizing the credit specification of the instance. See [Credit Specification](#credit-specification) below for more details. Terraform will only perform drift detection of its value when present in a configuration. Removing this configuration on existing instances will only stop managing it. It will not change the configuration back to the default for the instance type. * `disableApiStop` - (Optional) If true, enables [EC2 Instance Stop Protection](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Stop_Start.html#Using_StopProtection). * `disableApiTermination` - (Optional) If true, enables [EC2 Instance Termination Protection](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/terminating-instances.html#Using_ChangingDisableAPITermination). @@ -317,6 +309,7 @@ This resource supports the following arguments: * `enablePrimaryIpv6` - (Optional) Whether to assign a primary IPv6 Global Unicast Address (GUA) to the instance when launched in a dual-stack or IPv6-only subnet. A primary IPv6 address ensures a consistent IPv6 address for the instance and is automatically assigned by AWS to the ENI. Once enabled, the first IPv6 GUA becomes the primary IPv6 address and cannot be disabled. The primary IPv6 address remains until the instance is terminated or the ENI is detached. Disabling `enablePrimaryIpv6` after it has been enabled forces recreation of the instance. * `enclaveOptions` - (Optional) Enable Nitro Enclaves on launched instances. See [Enclave Options](#enclave-options) below for more details. * `ephemeralBlockDevice` - (Optional) One or more configuration blocks to customize Ephemeral (also known as "Instance Store") volumes on the instance. See [Block Devices](#ebs-ephemeral-and-root-block-devices) below for details. When accessing this as an attribute reference, it is a set of objects. +* `forceDestroy` - (Optional) Destroys instance even if `disableApiTermination` or `disableApiStop` is set to `true`. Defaults to `false`. Once this parameter is set to `true`, a successful `terraform apply` run before a destroy is required to update this value in the resource state. Without a successful `terraform apply` after this parameter is set, this flag will have no effect. If setting this field in the same operation that would require replacing the instance or destroying the instance, this flag will not work. Additionally when importing an instance, a successful `terraform apply` is required to set this value in state before it will take effect on a destroy operation. * `getPasswordData` - (Optional) If true, wait for password data to become available and retrieve it. Useful for getting the administrator password for instances running Microsoft Windows. The password data is exported to the `passwordData` attribute. See [GetPasswordData](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetPasswordData.html) for more information. * `hibernation` - (Optional) If true, the launched EC2 instance will support hibernation. * `hostId` - (Optional) ID of a dedicated host that the instance will be assigned to. Use when an instance is to be launched on a specific dedicated host. @@ -332,9 +325,10 @@ This resource supports the following arguments: * `maintenanceOptions` - (Optional) Maintenance and recovery options for the instance. See [Maintenance Options](#maintenance-options) below for more details. * `metadataOptions` - (Optional) Customize the metadata options of the instance. See [Metadata Options](#metadata-options) below for more details. * `monitoring` - (Optional) If true, the launched EC2 instance will have detailed monitoring enabled. (Available since v0.6.0) -* `networkInterface` - (Optional) Customize network interfaces to be attached at instance boot time. See [Network Interfaces](#network-interfaces) below for more details. +* `networkInterface` - (Optional, **Deprecated** to specify the primary network interface, use `primaryNetworkInterface`, to attach additional network interfaces, use `aws_network_interface_attachment` resources) Customize network interfaces to be attached at instance boot time. See [Network Interfaces](#network-interfaces) below for more details. * `placementGroup` - (Optional) Placement Group to start the instance in. * `placementPartitionNumber` - (Optional) Number of the partition the instance is in. Valid only if [the `aws_placement_group` resource's](placement_group.html) `strategy` argument is set to `"partition"`. +* `primaryNetworkInterface` - (Optional) The primary network interface. See [Primary Network Interface](#primary-network-interface) below. * `privateDnsNameOptions` - (Optional) Options for the instance hostname. The default values are inherited from the subnet. See [Private DNS Name Options](#private-dns-name-options) below for more details. * `privateIp` - (Optional) Private IP address to associate with the instance in a VPC. * `rootBlockDevice` - (Optional) Configuration block to customize details about the root block device of the instance. See [Block Devices](#ebs-ephemeral-and-root-block-devices) below for details. When accessing this as an attribute reference, it is a list containing one object. @@ -481,7 +475,11 @@ For more information, see the documentation on the [Instance Metadata Service](h ### Network Interfaces -Each of the `networkInterface` blocks attach a network interface to an EC2 Instance during boot time. However, because the network interface is attached at boot-time, replacing/modifying the network interface **WILL** trigger a recreation of the EC2 Instance. If you should need at any point to detach/modify/re-attach a network interface to the instance, use the `aws_network_interface` or `aws_network_interface_attachment` resources instead. +`networkInterface` is **deprecated**. +Use `primaryNetworkInterface` to specify the primary network interface. +To attach additional network interfaces, use [`aws_network_interface_attachment`](docs/r/network_interface_attachment.html.markdown) resources. + +Each of the `networkInterface` blocks attach a network interface to an EC2 Instance during boot time. However, because the network interface is attached at boot-time, replacing/modifying the network interface **WILL** trigger a recreation of the EC2 Instance. If you should need at any point to detach/modify/re-attach a network interface to the instance, use [`aws_network_interface_attachment`](docs/r/network_interface_attachment.html.markdown) resources instead. The `networkInterface` configuration block _does_, however, allow users to supply their own network interface to be used as the default network interface on an EC2 Instance, attached at `eth0`. @@ -492,6 +490,16 @@ Each `networkInterface` block supports the following: * `networkCardIndex` - (Optional) Integer index of the network card. Limited by instance type. The default index is `0`. * `networkInterfaceId` - (Required) ID of the network interface to attach. +### Primary Network Interface + +Represents the primary network interface on the EC2 Instance. +To manage additional network interfaces, use [`aws_network_interface_attachment`](docs/r/network_interface_attachment.html.markdown) resources. + +Each `primaryNetworkInterface` block supports the following: + +* `deleteOnTermination` - (Read-Only) Whether the network interface will be deleted when the instance terminates. +* `networkInterfaceId` - (Required) ID of the network interface to attach. + ### Private DNS Name Options The `privateDnsNameOptions` block supports the following: @@ -565,6 +573,32 @@ For `instanceMarketOptions`, in addition to the arguments above, the following a ## Import +In Terraform v1.12.0 and later, the [`import` block](https://developer.hashicorp.com/terraform/language/import) can be used with the `identity` attribute. For example: + +```terraform +import { + to = aws_instance.example + identity = { + id = "i-12345678" + } +} + +resource "aws_instance" "example" { + ### Configuration omitted for brevity ### +} +``` + +### Identity Schema + +#### Required + +* `id` - (String) ID of the instance. + +#### Optional + +- `accountId` (String) AWS Account where this resource is managed. +- `region` (String) Region where this resource is managed. + In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import instances using the `id`. For example: ```typescript @@ -591,4 +625,4 @@ Using `terraform import`, import instances using the `id`. For example: % terraform import aws_instance.web i-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/internet_gateway.html.markdown b/website/docs/cdktf/typescript/r/internet_gateway.html.markdown index 63c2fdd7501a..47147cb927ed 100644 --- a/website/docs/cdktf/typescript/r/internet_gateway.html.markdown +++ b/website/docs/cdktf/typescript/r/internet_gateway.html.markdown @@ -41,6 +41,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `vpcId` - (Optional) The VPC ID to create in. See the [aws_internet_gateway_attachment](internet_gateway_attachment.html) resource for an alternate way to attach an Internet Gateway to a VPC. * `tags` - (Optional) A map of tags to assign to the resource. If configured with a provider [`defaultTags` 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. @@ -115,4 +116,4 @@ Using `terraform import`, import Internet Gateways using the `id`. For example: % terraform import aws_internet_gateway.gw igw-c0a643a9 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/internet_gateway_attachment.html.markdown b/website/docs/cdktf/typescript/r/internet_gateway_attachment.html.markdown index bab31fa8c617..ad0266174f00 100644 --- a/website/docs/cdktf/typescript/r/internet_gateway_attachment.html.markdown +++ b/website/docs/cdktf/typescript/r/internet_gateway_attachment.html.markdown @@ -53,6 +53,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `internetGatewayId` - (Required) The ID of the internet gateway. * `vpcId` - (Required) The ID of the VPC. @@ -101,4 +102,4 @@ Using `terraform import`, import Internet Gateway Attachments using the `id`. Fo % terraform import aws_internet_gateway_attachment.example igw-c0a643a9:vpc-123456 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/internetmonitor_monitor.html.markdown b/website/docs/cdktf/typescript/r/internetmonitor_monitor.html.markdown index abb29f514e26..b02073578370 100644 --- a/website/docs/cdktf/typescript/r/internetmonitor_monitor.html.markdown +++ b/website/docs/cdktf/typescript/r/internetmonitor_monitor.html.markdown @@ -42,6 +42,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `healthEventsConfig` - (Optional) Health event thresholds. A health event threshold percentage, for performance and availability, determines when Internet Monitor creates a health event when there's an internet issue that affects your application end users. See [Health Events Config](#health-events-config) below. * `internetMeasurementsLogDelivery` - (Optional) Publish internet measurements for Internet Monitor to an Amazon S3 bucket in addition to CloudWatch Logs. * `maxCityNetworksToMonitor` - (Optional) The maximum number of city-networks to monitor for your resources. A city-network is the location (city) where clients access your application resources from and the network or ASN, such as an internet service provider (ISP), that clients access the resources through. This limit helps control billing costs. @@ -97,4 +98,4 @@ Using `terraform import`, import Internet Monitor Monitors using the `monitorNam % terraform import aws_internetmonitor_monitor.some some-monitor ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/iot_authorizer.html.markdown b/website/docs/cdktf/typescript/r/iot_authorizer.html.markdown index 5c6fdaac0fcb..61c2843cc16e 100644 --- a/website/docs/cdktf/typescript/r/iot_authorizer.html.markdown +++ b/website/docs/cdktf/typescript/r/iot_authorizer.html.markdown @@ -50,6 +50,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `authorizerFunctionArn` - (Required) The ARN of the authorizer's Lambda function. * `enableCachingForHttp` - (Optional) Specifies whether the HTTP caching is enabled or not. Default: `false`. * `name` - (Required) The name of the authorizer. @@ -94,4 +95,4 @@ Using `terraform import`, import IOT Authorizers using the name. For example: % terraform import aws_iot_authorizer.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/iot_billing_group.html.markdown b/website/docs/cdktf/typescript/r/iot_billing_group.html.markdown index 0478647f63c4..99390a5083ea 100644 --- a/website/docs/cdktf/typescript/r/iot_billing_group.html.markdown +++ b/website/docs/cdktf/typescript/r/iot_billing_group.html.markdown @@ -46,6 +46,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) The name of the Billing Group. * `properties` - (Optional) The Billing Group properties. Defined below. * `tags` - (Optional) Key-value mapping of resource tags @@ -90,4 +91,4 @@ Using `terraform import`, import IoT Billing Groups using the name. For example: % terraform import aws_iot_billing_group.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/iot_ca_certificate.html.markdown b/website/docs/cdktf/typescript/r/iot_ca_certificate.html.markdown index 85a1bb54f0a0..098e5b205664 100644 --- a/website/docs/cdktf/typescript/r/iot_ca_certificate.html.markdown +++ b/website/docs/cdktf/typescript/r/iot_ca_certificate.html.markdown @@ -96,6 +96,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `active` - (Required) Boolean flag to indicate if the certificate should be active for device authentication. * `allowAutoRegistration` - (Required) Boolean flag to indicate if the certificate should be active for device regisration. * `caCertificatePem` - (Required) PEM encoded CA certificate. @@ -124,4 +125,4 @@ This resource exports the following attributes in addition to the arguments abov * `notAfter` - The certificate is not valid after this date. * `notBefore` - The certificate is not valid before this date. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/iot_certificate.html.markdown b/website/docs/cdktf/typescript/r/iot_certificate.html.markdown index 92223e0e21a5..482526122c35 100644 --- a/website/docs/cdktf/typescript/r/iot_certificate.html.markdown +++ b/website/docs/cdktf/typescript/r/iot_certificate.html.markdown @@ -86,6 +86,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `active` - (Required) Boolean flag to indicate if the certificate should be active * `csr` - (Optional) The certificate signing request. Review [CreateCertificateFromCsr](https://docs.aws.amazon.com/iot/latest/apireference/API_CreateCertificateFromCsr.html) @@ -110,4 +111,4 @@ This resource exports the following attributes in addition to the arguments abov * `publicKey` - When neither CSR nor certificate is provided, the public key. * `privateKey` - When neither CSR nor certificate is provided, the private key. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/iot_domain_configuration.html.markdown b/website/docs/cdktf/typescript/r/iot_domain_configuration.html.markdown index f01e3f38ca18..4cb8a026251f 100644 --- a/website/docs/cdktf/typescript/r/iot_domain_configuration.html.markdown +++ b/website/docs/cdktf/typescript/r/iot_domain_configuration.html.markdown @@ -41,6 +41,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `applicationProtocol` - (Optional) An enumerated string that specifies the application-layer protocol. Valid values are `SECURE_MQTT`, `MQTT_WSS`, `HTTPS` or `DEFAULT`. * `authenticationType` - (Optional) An enumerated string that specifies the authentication type. Valid values are `CUSTOM_AUTH_X509`, `CUSTOM_AUTH`, `AWS_X509`, `AWS_SIGV4` or `DEFAULT`. * `authorizerConfig` - (Optional) An object that specifies the authorization service for a domain. See the [`authorizerConfig` Block](#authorizer_config-block) below for details. @@ -103,4 +104,4 @@ Using `terraform import`, import domain configurations using the name. For examp % terraform import aws_iot_domain_configuration.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/iot_event_configurations.html.markdown b/website/docs/cdktf/typescript/r/iot_event_configurations.html.markdown index 6023c7539fa4..2ed5bb7c3ac7 100644 --- a/website/docs/cdktf/typescript/r/iot_event_configurations.html.markdown +++ b/website/docs/cdktf/typescript/r/iot_event_configurations.html.markdown @@ -52,6 +52,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `eventConfigurations` - (Required) Map. The new event configuration values. You can use only these strings as keys: `THING_GROUP_HIERARCHY`, `THING_GROUP_MEMBERSHIP`, `THING_TYPE`, `THING_TYPE_ASSOCIATION`, `THING_GROUP`, `THING`, `POLICY`, `CA_CERTIFICATE`, `JOB_EXECUTION`, `CERTIFICATE`, `JOB`. Use boolean for values of mapping. ## Attribute Reference @@ -90,4 +91,4 @@ Using `terraform import`, import IoT Event Configurations using the AWS Region. % terraform import aws_iot_event_configurations.example us-west-2 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/iot_indexing_configuration.html.markdown b/website/docs/cdktf/typescript/r/iot_indexing_configuration.html.markdown index d6fc40318771..d0029cd1bd41 100644 --- a/website/docs/cdktf/typescript/r/iot_indexing_configuration.html.markdown +++ b/website/docs/cdktf/typescript/r/iot_indexing_configuration.html.markdown @@ -64,6 +64,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `thingGroupIndexingConfiguration` - (Optional) Thing group indexing configuration. See below. * `thingIndexingConfiguration` - (Optional) Thing indexing configuration. See below. @@ -104,4 +105,4 @@ The `filter` configuration block supports the following: This resource exports no additional attributes. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/iot_logging_options.html.markdown b/website/docs/cdktf/typescript/r/iot_logging_options.html.markdown index 0f4b888d09c6..309d77332f4f 100644 --- a/website/docs/cdktf/typescript/r/iot_logging_options.html.markdown +++ b/website/docs/cdktf/typescript/r/iot_logging_options.html.markdown @@ -39,6 +39,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `defaultLogLevel` - (Optional) The default logging level. Valid Values: `"DEBUG"`, `"INFO"`, `"ERROR"`, `"WARN"`, `"DISABLED"`. * `disableAllLogs` - (Optional) If `true` all logs are disabled. The default is `false`. * `roleArn` - (Required) The ARN of the role that allows IoT to write to Cloudwatch logs. @@ -47,4 +48,4 @@ This resource supports the following arguments: This resource exports no additional attributes. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/iot_policy.html.markdown b/website/docs/cdktf/typescript/r/iot_policy.html.markdown index b0b1fd849fac..8f023ec0ae3c 100644 --- a/website/docs/cdktf/typescript/r/iot_policy.html.markdown +++ b/website/docs/cdktf/typescript/r/iot_policy.html.markdown @@ -52,6 +52,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) The name of the policy. * `policy` - (Required) The policy document. This is a JSON formatted string. Use the [IoT Developer Guide](http://docs.aws.amazon.com/iot/latest/developerguide/iot-policies.html) for more information on IoT Policies. For more information about building AWS IAM policy documents with Terraform, see the [AWS IAM Policy Document Guide](https://learn.hashicorp.com/terraform/aws/iam-policy). * `tags` - (Optional) Key-value mapping of resource tags. If configured with a provider [`defaultTags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. @@ -101,4 +102,4 @@ Using `terraform import`, import IoT policies using the `name`. For example: % terraform import aws_iot_policy.pubsub PubSubToAnyTopic ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/iot_policy_attachment.html.markdown b/website/docs/cdktf/typescript/r/iot_policy_attachment.html.markdown index c7e0a053f470..5b54ac4fe1d6 100644 --- a/website/docs/cdktf/typescript/r/iot_policy_attachment.html.markdown +++ b/website/docs/cdktf/typescript/r/iot_policy_attachment.html.markdown @@ -61,6 +61,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `policy` - (Required) The name of the policy to attach. * `target` - (Required) The identity to which the policy is attached. @@ -68,4 +69,4 @@ This resource supports the following arguments: This resource exports no additional attributes. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/iot_provisioning_template.html.markdown b/website/docs/cdktf/typescript/r/iot_provisioning_template.html.markdown index 92c564407294..d3b965e3be70 100644 --- a/website/docs/cdktf/typescript/r/iot_provisioning_template.html.markdown +++ b/website/docs/cdktf/typescript/r/iot_provisioning_template.html.markdown @@ -112,6 +112,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) The name of the fleet provisioning template. * `description` - (Optional) The description of the fleet provisioning template. * `enabled` - (Optional) True to enable the fleet provisioning template, otherwise false. @@ -168,4 +169,4 @@ Using `terraform import`, import IoT fleet provisioning templates using the `nam % terraform import aws_iot_provisioning_template.fleet FleetProvisioningTemplate ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/iot_role_alias.html.markdown b/website/docs/cdktf/typescript/r/iot_role_alias.html.markdown index 05785f7d01e6..3d37a8cbca0f 100644 --- a/website/docs/cdktf/typescript/r/iot_role_alias.html.markdown +++ b/website/docs/cdktf/typescript/r/iot_role_alias.html.markdown @@ -55,6 +55,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `alias` - (Required) The name of the role alias. * `roleArn` - (Required) The identity of the role to which the alias refers. * `credentialDuration` - (Optional) The duration of the credential, in seconds. If you do not specify a value for this setting, the default maximum of one hour is applied. This setting can have a value from 900 seconds (15 minutes) to 43200 seconds (12 hours). @@ -95,4 +96,4 @@ Using `terraform import`, import IOT Role Alias using the alias. For example: % terraform import aws_iot_role_alias.example myalias ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/iot_thing.html.markdown b/website/docs/cdktf/typescript/r/iot_thing.html.markdown index f8da409ec185..80c1308dba02 100644 --- a/website/docs/cdktf/typescript/r/iot_thing.html.markdown +++ b/website/docs/cdktf/typescript/r/iot_thing.html.markdown @@ -41,6 +41,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) The name of the thing. * `attributes` - (Optional) Map of attributes of the thing. * `thingTypeName` - (Optional) The thing type name. @@ -81,4 +82,4 @@ Using `terraform import`, import IOT Things using the name. For example: % terraform import aws_iot_thing.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/iot_thing_group.html.markdown b/website/docs/cdktf/typescript/r/iot_thing_group.html.markdown index b289d3d3ebb6..2879cc8013e2 100644 --- a/website/docs/cdktf/typescript/r/iot_thing_group.html.markdown +++ b/website/docs/cdktf/typescript/r/iot_thing_group.html.markdown @@ -54,6 +54,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) The name of the Thing Group. * `parentGroupName` - (Optional) The name of the parent Thing Group. * `properties` - (Optional) The Thing Group properties. Defined below. @@ -104,4 +105,4 @@ Using `terraform import`, import IoT Things Groups using the name. For example: % terraform import aws_iot_thing_group.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/iot_thing_group_membership.html.markdown b/website/docs/cdktf/typescript/r/iot_thing_group_membership.html.markdown index ad0eb5c26ab3..8a7b8281d5ac 100644 --- a/website/docs/cdktf/typescript/r/iot_thing_group_membership.html.markdown +++ b/website/docs/cdktf/typescript/r/iot_thing_group_membership.html.markdown @@ -40,6 +40,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `thingName` - (Required) The name of the thing to add to a group. * `thingGroupName` - (Required) The name of the group to which you are adding a thing. * `overrideDynamicGroup` - (Optional) Override dynamic thing groups with static thing groups when 10-group limit is reached. If a thing belongs to 10 thing groups, and one or more of those groups are dynamic thing groups, adding a thing to a static group removes the thing from the last dynamic group. @@ -82,4 +83,4 @@ Using `terraform import`, import IoT Thing Group Membership using the thing grou % terraform import aws_iot_thing_group_membership.example thing_group_name/thing_name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/iot_thing_principal_attachment.html.markdown b/website/docs/cdktf/typescript/r/iot_thing_principal_attachment.html.markdown index e19b6f9ad834..5f2f6fd3568a 100644 --- a/website/docs/cdktf/typescript/r/iot_thing_principal_attachment.html.markdown +++ b/website/docs/cdktf/typescript/r/iot_thing_principal_attachment.html.markdown @@ -48,11 +48,13 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `principal` - (Required) The AWS IoT Certificate ARN or Amazon Cognito Identity ID. * `thing` - (Required) The name of the thing. +* `thing_principal_type` - (Optional) The type of relationship to specify when attaching a principal to a thing. Valid values are `EXCLUSIVE_THING` (the thing will be the only one attached to the principal) or `NON_EXCLUSIVE_THING` (multiple things can be attached to the principal). Defaults to `NON_EXCLUSIVE_THING`. ## Attribute Reference This resource exports no additional attributes. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/iot_thing_type.html.markdown b/website/docs/cdktf/typescript/r/iot_thing_type.html.markdown index 525b205a0b25..62d04abb350e 100644 --- a/website/docs/cdktf/typescript/r/iot_thing_type.html.markdown +++ b/website/docs/cdktf/typescript/r/iot_thing_type.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required, Forces New Resource) The name of the thing type. * `deprecated` - (Optional, Defaults to false) Whether the thing type is deprecated. If true, no new things could be associated with this type. * `properties` - (Optional), Configuration block that can contain the following properties of the thing type: @@ -80,4 +81,4 @@ Using `terraform import`, import IOT Thing Types using the name. For example: % terraform import aws_iot_thing_type.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/iot_topic_rule.html.markdown b/website/docs/cdktf/typescript/r/iot_topic_rule.html.markdown index c719cb39a1d6..a66972e9f74f 100644 --- a/website/docs/cdktf/typescript/r/iot_topic_rule.html.markdown +++ b/website/docs/cdktf/typescript/r/iot_topic_rule.html.markdown @@ -100,6 +100,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) The name of the rule. * `description` - (Optional) The description of the rule. * `enabled` - (Required) Specifies whether the rule is enabled. @@ -288,4 +289,4 @@ Using `terraform import`, import IoT Topic Rules using the `name`. For example: % terraform import aws_iot_topic_rule.rule ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/iot_topic_rule_destination.html.markdown b/website/docs/cdktf/typescript/r/iot_topic_rule_destination.html.markdown index 800b362a1af7..a0d3aaea7b65 100644 --- a/website/docs/cdktf/typescript/r/iot_topic_rule_destination.html.markdown +++ b/website/docs/cdktf/typescript/r/iot_topic_rule_destination.html.markdown @@ -41,6 +41,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `enabled` - (Optional) Whether or not to enable the destination. Default: `true`. * `vpcConfiguration` - (Required) Configuration of the virtual private cloud (VPC) connection. For more info, see the [AWS documentation](https://docs.aws.amazon.com/iot/latest/developerguide/vpc-rule-action.html). @@ -89,4 +90,4 @@ Using `terraform import`, import IoT topic rule destinations using the `arn`. Fo % terraform import aws_iot_topic_rule_destination.example arn:aws:iot:us-west-2:123456789012:ruledestination/vpc/2ce781c8-68a6-4c52-9c62-63fe489ecc60 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ivs_channel.html.markdown b/website/docs/cdktf/typescript/r/ivs_channel.html.markdown index c567634e79cf..8b0a1640e04b 100644 --- a/website/docs/cdktf/typescript/r/ivs_channel.html.markdown +++ b/website/docs/cdktf/typescript/r/ivs_channel.html.markdown @@ -40,6 +40,7 @@ class MyConvertedCode extends TerraformStack { The following arguments are optional: +* `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). * `authorized` - (Optional) If `true`, channel is private (enabled for playback authorization). * `latencyMode` - (Optional) Channel latency mode. Valid values: `NORMAL`, `LOW`. * `name` - (Optional) Channel name. @@ -96,4 +97,4 @@ Using `terraform import`, import IVS (Interactive Video) Channel using the ARN. % terraform import aws_ivs_channel.example arn:aws:ivs:us-west-2:326937407773:channel/0Y1lcs4U7jk5 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ivs_playback_key_pair.html.markdown b/website/docs/cdktf/typescript/r/ivs_playback_key_pair.html.markdown index fd7be044431d..3b4d06bc3ff0 100644 --- a/website/docs/cdktf/typescript/r/ivs_playback_key_pair.html.markdown +++ b/website/docs/cdktf/typescript/r/ivs_playback_key_pair.html.markdown @@ -44,6 +44,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `name` - (Optional) Playback Key Pair name. * `tags` - (Optional) A map of tags to assign to the resource. If configured with a provider [`defaultTags` 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. @@ -94,4 +95,4 @@ Using `terraform import`, import IVS (Interactive Video) Playback Key Pair using % terraform import aws_ivs_playback_key_pair.example arn:aws:ivs:us-west-2:326937407773:playback-key/KDJRJNQhiQzA ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ivs_recording_configuration.html.markdown b/website/docs/cdktf/typescript/r/ivs_recording_configuration.html.markdown index 613bb05c682b..76e5fce97260 100644 --- a/website/docs/cdktf/typescript/r/ivs_recording_configuration.html.markdown +++ b/website/docs/cdktf/typescript/r/ivs_recording_configuration.html.markdown @@ -51,6 +51,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `name` - (Optional) Recording Configuration name. * `recordingReconnectWindowSeconds` - (Optional) If a broadcast disconnects and then reconnects within the specified interval, the multiple streams will be considered a single broadcast and merged together. * `tags` - (Optional) A map of tags to assign to the resource. If configured with a provider [`defaultTags` 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. @@ -105,4 +106,4 @@ Using `terraform import`, import IVS (Interactive Video) Recording Configuration % terraform import aws_ivs_recording_configuration.example arn:aws:ivs:us-west-2:326937407773:recording-configuration/KAk1sHBl2L47 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ivschat_logging_configuration.html.markdown b/website/docs/cdktf/typescript/r/ivschat_logging_configuration.html.markdown index 61230122c42e..0c1fd239383d 100644 --- a/website/docs/cdktf/typescript/r/ivschat_logging_configuration.html.markdown +++ b/website/docs/cdktf/typescript/r/ivschat_logging_configuration.html.markdown @@ -172,6 +172,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `name` - (Optional) Logging Configuration name. * `tags` - (Optional) A map of tags to assign to the resource. If configured with a provider [`defaultTags` 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. @@ -224,4 +225,4 @@ Using `terraform import`, import IVS (Interactive Video) Chat Logging Configurat % terraform import aws_ivschat_logging_configuration.example arn:aws:ivschat:us-west-2:326937407773:logging-configuration/MMUQc8wcqZmC ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ivschat_room.html.markdown b/website/docs/cdktf/typescript/r/ivschat_room.html.markdown index 04a42df0d70f..029c4bea3987 100644 --- a/website/docs/cdktf/typescript/r/ivschat_room.html.markdown +++ b/website/docs/cdktf/typescript/r/ivschat_room.html.markdown @@ -87,6 +87,7 @@ class MyConvertedCode extends TerraformStack { The following arguments are optional: +* `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). * `loggingConfigurationIdentifiers` - (Optional) List of Logging Configuration ARNs to attach to the room. * `maximumMessageLength` - (Optional) Maximum number of characters in a single @@ -151,4 +152,4 @@ Using `terraform import`, import IVS (Interactive Video) Chat Room using the ARN % terraform import aws_ivschat_room.example arn:aws:ivschat:us-west-2:326937407773:room/GoXEXyB4VwHb ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/kendra_data_source.html.markdown b/website/docs/cdktf/typescript/r/kendra_data_source.html.markdown index c3fcdb3d4b7c..c2411670c644 100644 --- a/website/docs/cdktf/typescript/r/kendra_data_source.html.markdown +++ b/website/docs/cdktf/typescript/r/kendra_data_source.html.markdown @@ -537,6 +537,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `configuration` - (Optional) A block with the configuration information to connect to your Data Source repository. You can't specify the `configuration` block when the `type` parameter is set to `CUSTOM`. [Detailed below](#configuration-block). * `customDocumentEnrichmentConfiguration` - (Optional) A block with the configuration information for altering document metadata and content during the document ingestion process. For more information on how to create, modify and delete document metadata, or make other content alterations when you ingest documents into Amazon Kendra, see [Customizing document metadata during the ingestion process](https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html). [Detailed below](#custom_document_enrichment_configuration-block). * `description` - (Optional) A description for the Data Source connector. @@ -584,7 +585,7 @@ The `documentsMetadataConfiguration` configuration block supports the following The `webCrawlerConfiguration` configuration block supports the following arguments: * `authenticationConfiguration` - (Optional) A block with the configuration information required to connect to websites using authentication. You can connect to websites using basic authentication of user name and password. You use a secret in AWS Secrets Manager to store your authentication credentials. You must provide the website host name and port number. For example, the host name of `https://a.example.com/page1.html` is `"a.example.com"` and the port is `443`, the standard port for HTTPS. [Detailed below](#authentication_configuration-block). -* `crawlDepth` - (Optional) Specifies the number of levels in a website that you want to crawl. The first level begins from the website seed or starting point URL. For example, if a website has 3 levels – index level (i.e. seed in this example), sections level, and subsections level – and you are only interested in crawling information up to the sections level (i.e. levels 0-1), you can set your depth to 1. The default crawl depth is set to `2`. Minimum value of `0`. Maximum value of `10`. +* `crawlDepth` - (Optional) Specifies the number of levels in a website that you want to crawl. The first level begins from the website seed or starting point URL. For example, if a website has 3 levels - index level (i.e. seed in this example), sections level, and subsections level - and you are only interested in crawling information up to the sections level (i.e. levels 0-1), you can set your depth to 1. The default crawl depth is set to `2`. Minimum value of `0`. Maximum value of `10`. * `maxContentSizePerPageInMegaBytes` - (Optional) The maximum size (in MB) of a webpage or attachment to crawl. Files larger than this size (in MB) are skipped/not crawled. The default maximum size of a webpage or attachment is set to `50` MB. Minimum value of `1.0e-06`. Maximum value of `50`. * `maxLinksPerPage` - (Optional) The maximum number of URLs on a webpage to include when crawling a website. This number is per webpage. As a website’s webpages are crawled, any URLs the webpages link to are also crawled. URLs on a webpage are crawled in order of appearance. The default maximum links per page is `100`. Minimum value of `1`. Maximum value of `1000`. * `maxUrlsPerMinuteCrawlRate` - (Optional) The maximum number of URLs crawled per website host per minute. The default maximum number of URLs crawled per website host per minute is `300`. Minimum value of `1`. Maximum value of `300`. @@ -634,9 +635,9 @@ The `seedUrlConfiguration` configuration block supports the following arguments: * `seedUrls` - (Required) The list of seed or starting point URLs of the websites you want to crawl. The list can include a maximum of `100` seed URLs. Array Members: Minimum number of `0` items. Maximum number of `100` items. Length Constraints: Minimum length of `1`. Maximum length of `2048`. * `webCrawlerMode` - (Optional) The default mode is set to `HOST_ONLY`. You can choose one of the following modes: - * `HOST_ONLY` – crawl only the website host names. For example, if the seed URL is `"abc.example.com"`, then only URLs with host name `"abc.example.com"` are crawled. - * `SUBDOMAINS` – crawl the website host names with subdomains. For example, if the seed URL is `"abc.example.com"`, then `"a.abc.example.com"` and `"b.abc.example.com"` are also crawled. - * `EVERYTHING` – crawl the website host names with subdomains and other domains that the webpages link to. + * `HOST_ONLY` - crawl only the website host names. For example, if the seed URL is `"abc.example.com"`, then only URLs with host name `"abc.example.com"` are crawled. + * `SUBDOMAINS` - crawl the website host names with subdomains. For example, if the seed URL is `"abc.example.com"`, then `"a.abc.example.com"` and `"b.abc.example.com"` are also crawled. + * `EVERYTHING` - crawl the website host names with subdomains and other domains that the webpages link to. ### site_maps_configuration Block @@ -764,4 +765,4 @@ Using `terraform import`, import Kendra Data Source using the unique identifiers % terraform import aws_kendra_data_source.example 1045d08d-66ef-4882-b3ed-dfb7df183e90/b34dfdf7-1f2b-4704-9581-79e00296845f ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/kendra_experience.html.markdown b/website/docs/cdktf/typescript/r/kendra_experience.html.markdown index 179e707b1ccc..23cfcc86fcc7 100644 --- a/website/docs/cdktf/typescript/r/kendra_experience.html.markdown +++ b/website/docs/cdktf/typescript/r/kendra_experience.html.markdown @@ -59,6 +59,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `description` - (Optional, Forces new resource if removed) A description for your Amazon Kendra experience. * `configuration` - (Optional) Configuration information for your Amazon Kendra experience. Terraform will only perform drift detection of its value when present in a configuration. [Detailed below](#configuration). @@ -139,4 +140,4 @@ Using `terraform import`, import Kendra Experience using the unique identifiers % terraform import aws_kendra_experience.example 1045d08d-66ef-4882-b3ed-dfb7df183e90/b34dfdf7-1f2b-4704-9581-79e00296845f ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/kendra_faq.html.markdown b/website/docs/cdktf/typescript/r/kendra_faq.html.markdown index 306a62a50a26..e0268c2e6343 100644 --- a/website/docs/cdktf/typescript/r/kendra_faq.html.markdown +++ b/website/docs/cdktf/typescript/r/kendra_faq.html.markdown @@ -119,6 +119,7 @@ The `s3Path` configuration block supports the following arguments: The following arguments are optional: +* `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). * `description` - (Optional, Forces new resource) The description for a FAQ. * `fileFormat` - (Optional, Forces new resource) The file format used by the input files for the FAQ. Valid Values are `CSV`, `CSV_WITH_HEADER`, `JSON`. * `languageCode` - (Optional, Forces new resource) The code for a language. This shows a supported language for the FAQ document. English is supported by default. For more information on supported languages, including their codes, see [Adding documents in languages other than English](https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html). @@ -176,4 +177,4 @@ Using `terraform import`, import `aws_kendra_faq` using the unique identifiers o % terraform import aws_kendra_faq.example faq-123456780/idx-8012925589 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/kendra_index.html.markdown b/website/docs/cdktf/typescript/r/kendra_index.html.markdown index d2d72c202767..3aa2b6fce38d 100644 --- a/website/docs/cdktf/typescript/r/kendra_index.html.markdown +++ b/website/docs/cdktf/typescript/r/kendra_index.html.markdown @@ -666,6 +666,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `capacityUnits` - (Optional) A block that sets the number of additional document storage and query capacity units that should be used by the index. [Detailed below](#capacity_units). * `description` - (Optional) The description of the Index. * `documentMetadataConfigurationUpdates` - (Optional) One or more blocks that specify the configuration settings for any metadata applied to the documents in the index. Minimum number of 0 items. Maximum number of 500 items. If specified, you must define all elements, including those that are provided by default. These index fields are documented at [Amazon Kendra Index documentation](https://docs.aws.amazon.com/kendra/latest/dg/hiw-index.html). For an example resource that defines these default index fields, refer to the [default example above](#specifying-the-predefined-elements). For an example resource that appends additional index fields, refer to the [append example above](#appending-additional-elements). All arguments for each block must be specified. Note that blocks cannot be removed since index fields cannot be deleted. This argument is [detailed below](#document_metadata_configuration_updates). @@ -825,4 +826,4 @@ Using `terraform import`, import Amazon Kendra Indexes using its `id`. For examp % terraform import aws_kendra_index.example 12345678-1234-5678-9123-123456789123 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/kendra_query_suggestions_block_list.html.markdown b/website/docs/cdktf/typescript/r/kendra_query_suggestions_block_list.html.markdown index 3c0e618191c5..a3a7ec7cc28c 100644 --- a/website/docs/cdktf/typescript/r/kendra_query_suggestions_block_list.html.markdown +++ b/website/docs/cdktf/typescript/r/kendra_query_suggestions_block_list.html.markdown @@ -61,6 +61,7 @@ The `sourceS3Path` configuration block supports the following arguments: The following arguments are optional: +* `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). * `description` - (Optional) Description for a block list. * `tags` - (Optional) Key-value map of resource tags. If configured with a provider [`defaultTags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block), tags with matching keys will overwrite those defined at the provider-level. @@ -112,4 +113,4 @@ Using `terraform import`, import the `aws_kendra_query_suggestions_block_list` r % terraform import aws_kendra_query_suggestions_block_list.example blocklist-123456780/idx-8012925589 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/kendra_thesaurus.html.markdown b/website/docs/cdktf/typescript/r/kendra_thesaurus.html.markdown index da3934857e49..20293eecda37 100644 --- a/website/docs/cdktf/typescript/r/kendra_thesaurus.html.markdown +++ b/website/docs/cdktf/typescript/r/kendra_thesaurus.html.markdown @@ -59,6 +59,7 @@ The `sourceS3Path` configuration block supports the following arguments: The following arguments are optional: +* `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). * `description` - (Optional) The description for a thesaurus. * `tags` - (Optional) Key-value map of resource tags. If configured with a provider [`defaultTags` 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. @@ -111,4 +112,4 @@ Using `terraform import`, import `aws_kendra_thesaurus` using the unique identif % terraform import aws_kendra_thesaurus.example thesaurus-123456780/idx-8012925589 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/key_pair.html.markdown b/website/docs/cdktf/typescript/r/key_pair.html.markdown index c87565611b94..6923683233f4 100644 --- a/website/docs/cdktf/typescript/r/key_pair.html.markdown +++ b/website/docs/cdktf/typescript/r/key_pair.html.markdown @@ -48,6 +48,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `keyName` - (Optional) The name for the key pair. If neither `keyName` nor `keyNamePrefix` is provided, Terraform will create a unique key name using the prefix `terraform-`. * `keyNamePrefix` - (Optional) Creates a unique name beginning with the specified prefix. Conflicts with `keyName`. If neither `keyName` nor `keyNamePrefix` is provided, Terraform will create a unique key name using the prefix `terraform-`. * `publicKey` - (Required) The public key material. @@ -95,4 +96,4 @@ Using `terraform import`, import Key Pairs using the `keyName`. For example: ~> **NOTE:** The AWS API does not include the public key in the response, so `terraform apply` will attempt to replace the key pair. There is currently no supported workaround for this limitation. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/keyspaces_keyspace.html.markdown b/website/docs/cdktf/typescript/r/keyspaces_keyspace.html.markdown index e9ff2a4f50fb..b57c681b8299 100644 --- a/website/docs/cdktf/typescript/r/keyspaces_keyspace.html.markdown +++ b/website/docs/cdktf/typescript/r/keyspaces_keyspace.html.markdown @@ -40,6 +40,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required, Forces new resource) The name of the keyspace to be created. * `replicationSpecification` - (Optional) The replication specification of the keyspace. * `regionList` - (Optional) Replication regions. If `replicationStrategy` is `MULTI_REGION`, `regionList` requires the current Region and at least one additional AWS Region where the keyspace is going to be replicated in. @@ -89,4 +90,4 @@ Using `terraform import`, import a keyspace using the `name`. For example: % terraform import aws_keyspaces_keyspace.example my_keyspace ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/keyspaces_table.html.markdown b/website/docs/cdktf/typescript/r/keyspaces_table.html.markdown index 3eedf689f222..1aeb35aa67ce 100644 --- a/website/docs/cdktf/typescript/r/keyspaces_table.html.markdown +++ b/website/docs/cdktf/typescript/r/keyspaces_table.html.markdown @@ -59,6 +59,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `capacitySpecification` - (Optional) Specifies the read/write throughput capacity mode for the table. * `clientSideTimestamps` - (Optional) Enables client-side timestamps for the table. By default, the setting is disabled. * `comment` - (Optional) A description of the table. @@ -168,4 +169,4 @@ Using `terraform import`, import a table using the `keyspaceName` and `tableName % terraform import aws_keyspaces_table.example my_keyspace/my_table ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/kinesis_analytics_application.html.markdown b/website/docs/cdktf/typescript/r/kinesis_analytics_application.html.markdown index b30b3d49fd11..299c646397cf 100644 --- a/website/docs/cdktf/typescript/r/kinesis_analytics_application.html.markdown +++ b/website/docs/cdktf/typescript/r/kinesis_analytics_application.html.markdown @@ -15,6 +15,8 @@ allows processing and analyzing streaming data using standard SQL. For more details, see the [Amazon Kinesis Analytics Documentation][1]. +!> **WARNING:** _This resource is deprecated and will be removed in a future version._ [Effective January 27, 2026](https://aws.amazon.com/blogs/big-data/migrate-from-amazon-kinesis-data-analytics-for-sql-to-amazon-managed-service-for-apache-flink-and-amazon-managed-service-for-apache-flink-studio/), AWS will [no longer support](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/discontinuation.html) Amazon Kinesis Data Analytics for SQL. Use the `aws_kinesisanalyticsv2_application` resource instead to manage Amazon Kinesis Data Analytics for Apache Flink applications. AWS provides guidance for migrating from [Amazon Kinesis Data Analytics for SQL Applications to Amazon Managed Service for Apache Flink Studio](https://aws.amazon.com/blogs/big-data/migrate-from-amazon-kinesis-data-analytics-for-sql-applications-to-amazon-managed-service-for-apache-flink-studio/) including [examples](https://docs.aws.amazon.com/kinesisanalytics/latest/dev/migrating-to-kda-studio-overview.html). + -> **Note:** To manage Amazon Kinesis Data Analytics for Apache Flink applications, use the [`aws_kinesisanalyticsv2_application`](/docs/providers/aws/r/kinesisanalyticsv2_application.html) resource. ## Example Usage @@ -180,6 +182,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) Name of the Kinesis Analytics Application. * `code` - (Optional) SQL Code to transform input data, and generate output. * `description` - (Optional) Description of the application. @@ -420,4 +423,4 @@ Using `terraform import`, import Kinesis Analytics Application using ARN. For ex % terraform import aws_kinesis_analytics_application.example arn:aws:kinesisanalytics:us-west-2:1234567890:application/example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/kinesis_firehose_delivery_stream.html.markdown b/website/docs/cdktf/typescript/r/kinesis_firehose_delivery_stream.html.markdown index f5cb94c6c637..1870fabe5ce1 100644 --- a/website/docs/cdktf/typescript/r/kinesis_firehose_delivery_stream.html.markdown +++ b/website/docs/cdktf/typescript/r/kinesis_firehose_delivery_stream.html.markdown @@ -700,7 +700,7 @@ class MyConvertedCode extends TerraformStack { "arn:${" + dataAwsPartitionCurrent.partition + "}:glue:${" + - dataAwsRegionCurrent.name + + dataAwsRegionCurrent.region + "}:${" + current.accountId + "}:catalog", @@ -871,14 +871,13 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) A name to identify the stream. This is unique to the AWS account and region the Stream is created in. When using for WAF logging, name must be prefixed with `aws-waf-logs-`. See [AWS Documentation](https://docs.aws.amazon.com/waf/latest/developerguide/waf-policies.html#waf-policies-logging-config) for more details. * `tags` - (Optional) A map of tags to assign to the resource. If configured with a provider [`defaultTags` 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. * `kinesisSourceConfiguration` - (Optional) The stream and role Amazon Resource Names (ARNs) for a Kinesis data stream used as the source for a delivery stream. See [`kinesisSourceConfiguration` block](#kinesis_source_configuration-block) below for details. * `mskSourceConfiguration` - (Optional) The configuration for the Amazon MSK cluster to be used as the source for a delivery stream. See [`mskSourceConfiguration` block](#msk_source_configuration-block) below for details. * `serverSideEncryption` - (Optional) Encrypt at rest options. See [`serverSideEncryption` block](#server_side_encryption-block) below for details. - - **NOTE:** Server-side encryption should not be enabled when a kinesis stream is configured as the source of the firehose delivery stream. -* `destination` – (Required) This is the destination to where the data is delivered. The only options are `s3` (Deprecated, use `extended_s3` instead), `extended_s3`, `redshift`, `elasticsearch`, `splunk`, `httpEndpoint`, `opensearch`, `opensearchserverless` and `snowflake`. +* `destination` - (Required) This is the destination to where the data is delivered. The only options are `s3` (Deprecated, use `extended_s3` instead), `extended_s3`, `redshift`, `elasticsearch`, `splunk`, `httpEndpoint`, `opensearch`, `opensearchserverless` and `snowflake`. * `elasticsearchConfiguration` - (Optional) Configuration options when `destination` is `elasticsearch`. See [`elasticsearchConfiguration` block](#elasticsearch_configuration-block) below for details. * `extendedS3Configuration` - (Optional, only Required when `destination` is `extended_s3`) Enhanced configuration options for the s3 destination. See [`extendedS3Configuration` block](#extended_s3_configuration-block) below for details. * `httpEndpointConfiguration` - (Optional) Configuration options when `destination` is `httpEndpoint`. Requires the user to also specify an `s3Configuration` block. See [`httpEndpointConfiguration` block](#http_endpoint_configuration-block) below for details. @@ -889,6 +888,8 @@ This resource supports the following arguments: * `snowflakeConfiguration` - (Optional) Configuration options when `destination` is `snowflake`. See [`snowflakeConfiguration` block](#snowflake_configuration-block) below for details. * `splunkConfiguration` - (Optional) Configuration options when `destination` is `splunk`. See [`splunkConfiguration` block](#splunk_configuration-block) below for details. +**NOTE:** Server-side encryption should not be enabled when a kinesis stream is configured as the source of the firehose delivery stream. + ### `kinesisSourceConfiguration` block The `kinesisSourceConfiguration` configuration block supports the following arguments: @@ -1381,4 +1382,4 @@ Using `terraform import`, import Kinesis Firehose Delivery streams using the str Note: Import does not work for stream destination `s3`. Consider using `extended_s3` since `s3` destination is deprecated. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/kinesis_resource_policy.html.markdown b/website/docs/cdktf/typescript/r/kinesis_resource_policy.html.markdown index 13756263f8b3..ee06c4e6b3f8 100644 --- a/website/docs/cdktf/typescript/r/kinesis_resource_policy.html.markdown +++ b/website/docs/cdktf/typescript/r/kinesis_resource_policy.html.markdown @@ -43,6 +43,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `policy` - (Required) The policy document. * `resourceArn` - (Required) The Amazon Resource Name (ARN) of the data stream or consumer. @@ -82,4 +83,4 @@ Using `terraform import`, import Kinesis resource policies using the `resourceAr % terraform import aws_kinesis_resource_policy.example arn:aws:kinesis:us-west-2:123456789012:stream/example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/kinesis_stream.html.markdown b/website/docs/cdktf/typescript/r/kinesis_stream.html.markdown index f375ef33de13..b3c8397ba4d4 100644 --- a/website/docs/cdktf/typescript/r/kinesis_stream.html.markdown +++ b/website/docs/cdktf/typescript/r/kinesis_stream.html.markdown @@ -50,8 +50,9 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) A name to identify the stream. This is unique to the AWS account and region the Stream is created in. -* `shardCount` – (Optional) The number of shards that the stream will use. If the `streamMode` is `PROVISIONED`, this field is required. +* `shardCount` - (Optional) The number of shards that the stream will use. If the `streamMode` is `PROVISIONED`, this field is required. Amazon has guidelines for specifying the Stream size that should be referenced when creating a Kinesis stream. See [Amazon Kinesis Streams][2] for more. * `retentionPeriod` - (Optional) Length of time data records are accessible after they are added to the stream. The maximum value of a stream's retention period is 8760 hours. Minimum value is 24. Default is 24. * `shardLevelMetrics` - (Optional) A list of shard-level CloudWatch metrics which can be enabled for the stream. See [Monitoring with CloudWatch][3] for more. Note that the value ALL should not be used; instead you should provide an explicit list of metrics you wish to enable. @@ -119,4 +120,4 @@ Using `terraform import`, import Kinesis Streams using the `name`. For example: [2]: https://docs.aws.amazon.com/kinesis/latest/dev/amazon-kinesis-streams.html [3]: https://docs.aws.amazon.com/streams/latest/dev/monitoring-with-cloudwatch.html - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/kinesis_stream_consumer.html.markdown b/website/docs/cdktf/typescript/r/kinesis_stream_consumer.html.markdown index db9457014d21..0627a306acea 100644 --- a/website/docs/cdktf/typescript/r/kinesis_stream_consumer.html.markdown +++ b/website/docs/cdktf/typescript/r/kinesis_stream_consumer.html.markdown @@ -54,8 +54,9 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required, Forces new resource) Name of the stream consumer. -* `streamArn` – (Required, Forces new resource) Amazon Resource Name (ARN) of the data stream the consumer is registered with. +* `streamArn` - (Required, Forces new resource) Amazon Resource Name (ARN) of the data stream the consumer is registered with. ## Attribute Reference @@ -99,4 +100,4 @@ Using `terraform import`, import Kinesis Stream Consumers using the Amazon Resou [1]: https://docs.aws.amazon.com/streams/latest/dev/amazon-kinesis-consumers.html - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/kinesis_video_stream.html.markdown b/website/docs/cdktf/typescript/r/kinesis_video_stream.html.markdown index a33a461bf9c3..774dadda9afd 100644 --- a/website/docs/cdktf/typescript/r/kinesis_video_stream.html.markdown +++ b/website/docs/cdktf/typescript/r/kinesis_video_stream.html.markdown @@ -46,9 +46,10 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) A name to identify the stream. This is unique to the AWS account and region the Stream is created in. -* `dataRetentionInHours` – (Optional) The number of hours that you want to retain the data in the stream. Kinesis Video Streams retains the data in a data store that is associated with the stream. The default value is `0`, indicating that the stream does not persist data. +* `dataRetentionInHours` - (Optional) The number of hours that you want to retain the data in the stream. Kinesis Video Streams retains the data in a data store that is associated with the stream. The default value is `0`, indicating that the stream does not persist data. * `deviceName` - (Optional) The name of the device that is writing to the stream. **In the current implementation, Kinesis Video Streams does not use this name.** * `kmsKeyId` - (Optional) The ID of the AWS Key Management Service (AWS KMS) key that you want Kinesis Video Streams to use to encrypt stream data. If no key ID is specified, the default, Kinesis Video-managed key (`aws/kinesisvideo`) is used. * `mediaType` - (Optional) The media type of the stream. Consumers of the stream can use this information when processing the stream. For more information about media types, see [Media Types][2]. If you choose to specify the MediaType, see [Naming Requirements][3] for guidelines. @@ -108,4 +109,4 @@ Using `terraform import`, import Kinesis Streams using the `arn`. For example: [2]: http://www.iana.org/assignments/media-types/media-types.xhtml [3]: https://tools.ietf.org/html/rfc6838#section-4.2 - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/kinesisanalyticsv2_application.html.markdown b/website/docs/cdktf/typescript/r/kinesisanalyticsv2_application.html.markdown index ab2604a294e1..defad8337d71 100644 --- a/website/docs/cdktf/typescript/r/kinesisanalyticsv2_application.html.markdown +++ b/website/docs/cdktf/typescript/r/kinesisanalyticsv2_application.html.markdown @@ -300,6 +300,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) The name of the application. * `runtimeEnvironment` - (Required) The runtime environment for the application. Valid values: `SQL-1_0`, `FLINK-1_6`, `FLINK-1_8`, `FLINK-1_11`, `FLINK-1_13`, `FLINK-1_15`, `FLINK-1_18`, `FLINK-1_19`. * `serviceExecutionRole` - (Required) The ARN of the [IAM role](/docs/providers/aws/r/iam_role.html) used by the application to access Kinesis data streams, Kinesis Data Firehose delivery streams, Amazon S3 objects, and other external resources. @@ -569,4 +570,4 @@ Using `terraform import`, import `aws_kinesisanalyticsv2_application` using the % terraform import aws_kinesisanalyticsv2_application.example arn:aws:kinesisanalytics:us-west-2:123456789012:application/example-sql-application ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/kinesisanalyticsv2_application_snapshot.html.markdown b/website/docs/cdktf/typescript/r/kinesisanalyticsv2_application_snapshot.html.markdown index 5d20aca169ca..02a76a91a1f8 100644 --- a/website/docs/cdktf/typescript/r/kinesisanalyticsv2_application_snapshot.html.markdown +++ b/website/docs/cdktf/typescript/r/kinesisanalyticsv2_application_snapshot.html.markdown @@ -42,6 +42,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `applicationName` - (Required) The name of an existing [Kinesis Analytics v2 Application](/docs/providers/aws/r/kinesisanalyticsv2_application.html). Note that the application must be running for a snapshot to be created. * `snapshotName` - (Required) The name of the application snapshot. @@ -92,4 +93,4 @@ Using `terraform import`, import `aws_kinesisanalyticsv2_application` using `app % terraform import aws_kinesisanalyticsv2_application_snapshot.example example-application/example-snapshot ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/kms_alias.html.markdown b/website/docs/cdktf/typescript/r/kms_alias.html.markdown index ea5df0681a58..97cc8193d27b 100644 --- a/website/docs/cdktf/typescript/r/kms_alias.html.markdown +++ b/website/docs/cdktf/typescript/r/kms_alias.html.markdown @@ -45,6 +45,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Optional) The display name of the alias. The name must start with the word "alias" followed by a forward slash (alias/) * `namePrefix` - (Optional) Creates an unique alias beginning with the specified prefix. The name must start with the word "alias" followed by a forward slash (alias/). Conflicts with `name`. @@ -59,6 +60,32 @@ This resource exports the following attributes in addition to the arguments abov ## Import +In Terraform v1.12.0 and later, the [`import` block](https://developer.hashicorp.com/terraform/language/import) can be used with the `identity` attribute. For example: + +```terraform +import { + to = aws_kms_alias.example + identity = { + name = "alias/my-key-alias" + } +} + +resource "aws_kms_alias" "example" { + ### Configuration omitted for brevity ### +} +``` + +### Identity Schema + +#### Required + +* `name` - (String) Name of the KMS key alias. + +#### Optional + +- `accountId` (String) AWS Account where this resource is managed. +- `region` (String) Region where this resource is managed. + In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import KMS aliases using the `name`. For example: ```typescript @@ -85,4 +112,4 @@ Using `terraform import`, import KMS aliases using the `name`. For example: % terraform import aws_kms_alias.a alias/my-key-alias ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/kms_ciphertext.html.markdown b/website/docs/cdktf/typescript/r/kms_ciphertext.html.markdown index 1911cdf65d8e..ed1e26381ee4 100644 --- a/website/docs/cdktf/typescript/r/kms_ciphertext.html.markdown +++ b/website/docs/cdktf/typescript/r/kms_ciphertext.html.markdown @@ -51,6 +51,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `plaintext` - (Required) Data to be encrypted. Note that this may show up in logs, and it will be stored in the state file. * `keyId` - (Required) Globally unique key ID for the customer master key. * `context` - (Optional) An optional mapping that makes up the encryption context. @@ -61,4 +62,4 @@ This resource exports the following attributes in addition to the arguments abov * `ciphertextBlob` - Base64 encoded ciphertext - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/kms_custom_key_store.html.markdown b/website/docs/cdktf/typescript/r/kms_custom_key_store.html.markdown index f144db0c5b48..fafb2bf92b38 100644 --- a/website/docs/cdktf/typescript/r/kms_custom_key_store.html.markdown +++ b/website/docs/cdktf/typescript/r/kms_custom_key_store.html.markdown @@ -109,6 +109,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `customKeyStoreType` - (Optional, ForceNew) Specifies the type of key store to create. Valid values are `AWS_CLOUDHSM` and `EXTERNAL_KEY_STORE`. If omitted, AWS will default the value to `AWS_CLOUDHSM`. If `customKeyStoreType` is `AWS_CLOUDHSM`, the following optional arguments must be set: @@ -176,4 +177,4 @@ Using `terraform import`, import KMS (Key Management) Custom Key Store using the % terraform import aws_kms_custom_key_store.example cks-5ebd4ef395a96288e ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/kms_external_key.html.markdown b/website/docs/cdktf/typescript/r/kms_external_key.html.markdown index a100d5e8c92f..693d231883d2 100644 --- a/website/docs/cdktf/typescript/r/kms_external_key.html.markdown +++ b/website/docs/cdktf/typescript/r/kms_external_key.html.markdown @@ -46,8 +46,11 @@ This resource supports the following arguments: * `description` - (Optional) Description of the key. * `enabled` - (Optional) Specifies whether the key is enabled. Keys pending import can only be `false`. Imported keys default to `true` unless expired. * `keyMaterialBase64` - (Optional) Base64 encoded 256-bit symmetric encryption key material to import. The CMK is permanently associated with this key material. The same key material can be reimported, but you cannot import different key material. +* `keySpec` - (Optional) Specifies whether the key contains a symmetric key or an asymmetric key pair and the encryption algorithms or signing algorithms that the key supports. Valid values: `SYMMETRIC_DEFAULT`, `RSA_2048`, `RSA_3072`, `RSA_4096`, `HMAC_224`, `HMAC_256`, `HMAC_384`, `HMAC_512`, `ECC_NIST_P256`, `ECC_NIST_P384`, `ECC_NIST_P521`, `ECC_SECG_P256K1`, `ML_DSA_44`, `ML_DSA_65`, `ML_DSA_87`, or `SM2` (China Regions only). Defaults to `SYMMETRIC_DEFAULT`. For help with choosing a key spec, see the [AWS KMS Developer Guide](https://docs.aws.amazon.com/kms/latest/developerguide/symm-asymm-choose.html). +* `keyUsage` - (Optional) Specifies the intended use of the key. Valid values: `ENCRYPT_DECRYPT`, `SIGN_VERIFY`, or `GENERATE_VERIFY_MAC`. Defaults to `ENCRYPT_DECRYPT`. * `multiRegion` - (Optional) Indicates whether the KMS key is a multi-Region (`true`) or regional (`false`) key. Defaults to `false`. * `policy` - (Optional) A key policy JSON document. If you do not provide a key policy, AWS KMS attaches a default key policy to the CMK. +* `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). * `tags` - (Optional) A key-value map of tags to assign to the key. If configured with a provider [`defaultTags` 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. * `validTo` - (Optional) Time at which the imported key material expires. When the key material expires, AWS KMS deletes the key material and the CMK becomes unusable. If not specified, key material does not expire. Valid values: [RFC3339 time string](https://tools.ietf.org/html/rfc3339#section-5.8) (`YYYY-MM-DDTHH:MM:SSZ`) @@ -59,7 +62,6 @@ This resource exports the following attributes in addition to the arguments abov * `expirationModel` - Whether the key material expires. Empty when pending key material import, otherwise `KEY_MATERIAL_EXPIRES` or `KEY_MATERIAL_DOES_NOT_EXPIRE`. * `id` - The unique identifier for the key. * `keyState` - The state of the CMK. -* `keyUsage` - The cryptographic operations for which you can use the CMK. * `tagsAll` - A map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). ## Import @@ -94,4 +96,4 @@ Using `terraform import`, import KMS External Keys using the `id`. For example: % terraform import aws_kms_external_key.a arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/kms_grant.html.markdown b/website/docs/cdktf/typescript/r/kms_grant.html.markdown index a9922865be77..3bf28085d050 100644 --- a/website/docs/cdktf/typescript/r/kms_grant.html.markdown +++ b/website/docs/cdktf/typescript/r/kms_grant.html.markdown @@ -77,6 +77,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Optional, Forces new resources) A friendly name for identifying the grant. * `keyId` - (Required, Forces new resources) The unique identifier for the customer master key (CMK) that the grant applies to. Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS account, you must use the key ARN. * `granteePrincipal` - (Required, Forces new resources) The principal that is given permission to perform the operations that the grant permits in ARN format. Note that due to eventual consistency issues around IAM principals, terraform's state may not always be refreshed to reflect what is true in AWS. @@ -131,4 +132,4 @@ Using `terraform import`, import KMS Grants using the Key ID and Grant ID separa % terraform import aws_kms_grant.test 1234abcd-12ab-34cd-56ef-1234567890ab:abcde1237f76e4ba7987489ac329fbfba6ad343d6f7075dbd1ef191f0120514 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/kms_key.html.markdown b/website/docs/cdktf/typescript/r/kms_key.html.markdown index a187db07715e..a2d7da2c47a1 100644 --- a/website/docs/cdktf/typescript/r/kms_key.html.markdown +++ b/website/docs/cdktf/typescript/r/kms_key.html.markdown @@ -386,12 +386,13 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `description` - (Optional) The description of the key as viewed in AWS console. * `keyUsage` - (Optional) Specifies the intended use of the key. Valid values: `ENCRYPT_DECRYPT`, `SIGN_VERIFY`, or `GENERATE_VERIFY_MAC`. Defaults to `ENCRYPT_DECRYPT`. * `customKeyStoreId` - (Optional) ID of the KMS [Custom Key Store](https://docs.aws.amazon.com/kms/latest/developerguide/create-cmk-keystore.html) where the key will be stored instead of KMS (eg CloudHSM). * `customerMasterKeySpec` - (Optional) Specifies whether the key contains a symmetric key or an asymmetric key pair and the encryption algorithms or signing algorithms that the key supports. -Valid values: `SYMMETRIC_DEFAULT`, `RSA_2048`, `RSA_3072`, `RSA_4096`, `HMAC_256`, `ECC_NIST_P256`, `ECC_NIST_P384`, `ECC_NIST_P521`, or `ECC_SECG_P256K1`. Defaults to `SYMMETRIC_DEFAULT`. For help with choosing a key spec, see the [AWS KMS Developer Guide](https://docs.aws.amazon.com/kms/latest/developerguide/symm-asymm-choose.html). +Valid values: `SYMMETRIC_DEFAULT`, `RSA_2048`, `RSA_3072`, `RSA_4096`, `HMAC_224`, `HMAC_256`, `HMAC_384`, `HMAC_512`, `ECC_NIST_P256`, `ECC_NIST_P384`, `ECC_NIST_P521`, `ECC_SECG_P256K1`, `ML_DSA_44`, `ML_DSA_65`, `ML_DSA_87`, or `SM2` (China Regions only). Defaults to `SYMMETRIC_DEFAULT`. For help with choosing a key spec, see the [AWS KMS Developer Guide](https://docs.aws.amazon.com/kms/latest/developerguide/symm-asymm-choose.html). * `policy` - (Optional) A valid policy JSON document. Although this is a key policy, not an IAM policy, an [`aws_iam_policy_document`](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document), in the form that designates a principal, can be used. For more information about building policy documents with Terraform, see the [AWS IAM Policy Document Guide](https://learn.hashicorp.com/terraform/aws/iam-policy). ~> **NOTE:** Note: All KMS keys must have a key policy. If a key policy is not specified, AWS gives the KMS key a [default key policy](https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default) that gives all principals in the owning account unlimited access to all KMS operations for the key. This default key policy effectively delegates all access control to IAM policies and KMS grants. @@ -428,6 +429,32 @@ This resource exports the following attributes in addition to the arguments abov ## Import +In Terraform v1.12.0 and later, the [`import` block](https://developer.hashicorp.com/terraform/language/import) can be used with the `identity` attribute. For example: + +```terraform +import { + to = aws_kms_key.example + identity = { + id = "1234abcd-12ab-34cd-56ef-1234567890ab" + } +} + +resource "aws_kms_key" "example" { + ### Configuration omitted for brevity ### +} +``` + +### Identity Schema + +#### Required + +* `id` - (String) ID of the KMS key. + +#### Optional + +- `accountId` (String) AWS Account where this resource is managed. +- `region` (String) Region where this resource is managed. + In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import KMS Keys using the `id`. For example: ```typescript @@ -458,4 +485,4 @@ Using `terraform import`, import KMS Keys using the `id`. For example: % terraform import aws_kms_key.a 1234abcd-12ab-34cd-56ef-1234567890ab ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/kms_key_policy.html.markdown b/website/docs/cdktf/typescript/r/kms_key_policy.html.markdown index c426d80e46b5..19542810cc2c 100644 --- a/website/docs/cdktf/typescript/r/kms_key_policy.html.markdown +++ b/website/docs/cdktf/typescript/r/kms_key_policy.html.markdown @@ -61,6 +61,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `keyId` - (Required) The ID of the KMS Key to attach the policy. * `policy` - (Required) A valid policy JSON document. Although this is a key policy, not an IAM policy, an [`aws_iam_policy_document`](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document), in the form that designates a principal, can be used. For more information about building policy documents with Terraform, see the [AWS IAM Policy Document Guide](https://learn.hashicorp.com/terraform/aws/iam-policy). @@ -106,4 +107,4 @@ Using `terraform import`, import KMS Key Policies using the `keyId`. For example % terraform import aws_kms_key_policy.a 1234abcd-12ab-34cd-56ef-1234567890ab ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/kms_replica_external_key.html.markdown b/website/docs/cdktf/typescript/r/kms_replica_external_key.html.markdown index f9452c4ba604..37a34b31cd46 100644 --- a/website/docs/cdktf/typescript/r/kms_replica_external_key.html.markdown +++ b/website/docs/cdktf/typescript/r/kms_replica_external_key.html.markdown @@ -59,6 +59,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `bypassPolicyLockoutSafetyCheck` - (Optional) A flag to indicate whether to bypass the key policy lockout safety check. Setting this value to true increases the risk that the KMS key becomes unmanageable. Do not set this value to true indiscriminately. For more information, refer to the scenario in the [Default Key Policy](https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam) section in the _AWS Key Management Service Developer Guide_. @@ -117,4 +118,4 @@ Using `terraform import`, import KMS multi-Region replica keys using the `id`. F % terraform import aws_kms_replica_external_key.example 1234abcd-12ab-34cd-56ef-1234567890ab ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/kms_replica_key.html.markdown b/website/docs/cdktf/typescript/r/kms_replica_key.html.markdown index 37bdee7d3ab4..afbd18b6f460 100644 --- a/website/docs/cdktf/typescript/r/kms_replica_key.html.markdown +++ b/website/docs/cdktf/typescript/r/kms_replica_key.html.markdown @@ -14,6 +14,8 @@ Manages a KMS multi-Region replica key. ## Example Usage +### Terraform AWS Provider v5 (and below) + ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug import { Construct } from "constructs"; @@ -51,10 +53,46 @@ class MyConvertedCode extends TerraformStack { ``` +### Terraform AWS Provider v6 (and above) + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { KmsKey } from "./.gen/providers/aws/kms-key"; +import { KmsReplicaKey } from "./.gen/providers/aws/kms-replica-key"; +import { AwsProvider } from "./.gen/providers/aws/provider"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + new AwsProvider(this, "aws", { + region: "us-west-2", + }); + const primary = new KmsKey(this, "primary", { + deletionWindowInDays: 30, + description: "Multi-Region primary key", + multiRegion: true, + region: "us-east-1", + }); + new KmsReplicaKey(this, "replica", { + deletionWindowInDays: 7, + description: "Multi-Region replica key", + primaryKeyArn: primary.arn, + }); + } +} + +``` + ## Argument Reference This resource supports the following arguments: +* `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). * `bypassPolicyLockoutSafetyCheck` - (Optional) A flag to indicate whether to bypass the key policy lockout safety check. Setting this value to true increases the risk that the KMS key becomes unmanageable. Do not set this value to true indiscriminately. For more information, refer to the scenario in the [Default Key Policy](https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam) section in the _AWS Key Management Service Developer Guide_. @@ -111,4 +149,4 @@ Using `terraform import`, import KMS multi-Region replica keys using the `id`. F % terraform import aws_kms_replica_key.example 1234abcd-12ab-34cd-56ef-1234567890ab ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/lakeformation_data_cells_filter.html.markdown b/website/docs/cdktf/typescript/r/lakeformation_data_cells_filter.html.markdown index a501deb6a556..b810a6c61b5e 100644 --- a/website/docs/cdktf/typescript/r/lakeformation_data_cells_filter.html.markdown +++ b/website/docs/cdktf/typescript/r/lakeformation_data_cells_filter.html.markdown @@ -50,8 +50,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `tableData` - (Required) Information about the data cells filter. See [Table Data](#table-data) below for details. ### Table Data @@ -88,7 +89,7 @@ This resource exports the following attributes in addition to the arguments abov ## Import -In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import Lake Formation Data Cells Filter using the `example_id_arg`. For example: +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import Lake Formation Data Cells Filter using the `databaseName`, `name`, `tableCatalogId`, and `tableName` separated by `,`. For example: ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -112,10 +113,10 @@ class MyConvertedCode extends TerraformStack { ``` -Using `terraform import`, import Lake Formation Data Cells Filter using the `id`. For example: +Using `terraform import`, import Lake Formation Data Cells Filter using the `databaseName`, `name`, `tableCatalogId`, and `tableName` separated by `,`. For example: ```console % terraform import aws_lakeformation_data_cells_filter.example database_name,name,table_catalog_id,table_name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/lakeformation_data_lake_settings.html.markdown b/website/docs/cdktf/typescript/r/lakeformation_data_lake_settings.html.markdown index a217c044cb88..fc1ebfa8da6e 100644 --- a/website/docs/cdktf/typescript/r/lakeformation_data_lake_settings.html.markdown +++ b/website/docs/cdktf/typescript/r/lakeformation_data_lake_settings.html.markdown @@ -141,17 +141,18 @@ class MyConvertedCode extends TerraformStack { The following arguments are optional: -* `admins` – (Optional) Set of ARNs of AWS Lake Formation principals (IAM users or roles). +* `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). +* `admins` - (Optional) Set of ARNs of AWS Lake Formation principals (IAM users or roles). * `allowExternalDataFiltering` - (Optional) Whether to allow Amazon EMR clusters to access data managed by Lake Formation. * `allowFullTableExternalDataAccess` - (Optional) Whether to allow a third-party query engine to get data access credentials without session tags when a caller has full data access permissions. * `authorizedSessionTagValueList` - (Optional) Lake Formation relies on a privileged process secured by Amazon EMR or the third party integrator to tag the user's role while assuming it. -* `catalogId` – (Optional) Identifier for the Data Catalog. By default, the account ID. +* `catalogId` - (Optional) Identifier for the Data Catalog. By default, the account ID. * `createDatabaseDefaultPermissions` - (Optional) Up to three configuration blocks of principal permissions for default create database permissions. Detailed below. * `createTableDefaultPermissions` - (Optional) Up to three configuration blocks of principal permissions for default create table permissions. Detailed below. * `externalDataFilteringAllowList` - (Optional) A list of the account IDs of Amazon Web Services accounts with Amazon EMR clusters that are to perform data filtering. * `parameters` - Key-value map of additional configuration. Valid values for the `CROSS_ACCOUNT_VERSION` key are `"1"`, `"2"`, `"3"`, or `"4"`. `SET_CONTEXT` is also returned with a value of `TRUE`. In a fresh account, prior to configuring, `CROSS_ACCOUNT_VERSION` is `"1"`. Destroying this resource sets the `CROSS_ACCOUNT_VERSION` to `"1"`. -* `readOnlyAdmins` – (Optional) Set of ARNs of AWS Lake Formation principals (IAM users or roles) with only view access to the resources. -* `trustedResourceOwners` – (Optional) List of the resource-owning account IDs that the caller's account can use to share their user access details (user ARNs). +* `readOnlyAdmins` - (Optional) Set of ARNs of AWS Lake Formation principals (IAM users or roles) with only view access to the resources. +* `trustedResourceOwners` - (Optional) List of the resource-owning account IDs that the caller's account can use to share their user access details (user ARNs). ~> **NOTE:** Although optional, not including `admins`, `createDatabaseDefaultPermissions`, `createTableDefaultPermissions`, `parameters`, and/or `trustedResourceOwners` results in the setting being cleared. @@ -159,6 +160,7 @@ The following arguments are optional: The following arguments are optional: +* `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). * `permissions` - (Optional) List of permissions that are granted to the principal. Valid values may include `ALL`, `SELECT`, `ALTER`, `DROP`, `DELETE`, `INSERT`, `DESCRIBE`, and `CREATE_TABLE`. For more details, see [Lake Formation Permissions Reference](https://docs.aws.amazon.com/lake-formation/latest/dg/lf-permissions-reference.html). * `principal` - (Optional) Principal who is granted permissions. To enforce metadata and underlying data access control only by IAM on new databases and tables set `principal` to `IAM_ALLOWED_PRINCIPALS` and `permissions` to `["ALL"]`. @@ -166,6 +168,7 @@ The following arguments are optional: The following arguments are optional: +* `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). * `permissions` - (Optional) List of permissions that are granted to the principal. Valid values may include `ALL`, `SELECT`, `ALTER`, `DROP`, `DELETE`, `INSERT`, and `DESCRIBE`. For more details, see [Lake Formation Permissions Reference](https://docs.aws.amazon.com/lake-formation/latest/dg/lf-permissions-reference.html). * `principal` - (Optional) Principal who is granted permissions. To enforce metadata and underlying data access control only by IAM on new databases and tables set `principal` to `IAM_ALLOWED_PRINCIPALS` and `permissions` to `["ALL"]`. @@ -173,4 +176,4 @@ The following arguments are optional: This resource exports no additional attributes. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/lakeformation_lf_tag.html.markdown b/website/docs/cdktf/typescript/r/lakeformation_lf_tag.html.markdown index 3efe9cf504f0..074f31f4799a 100644 --- a/website/docs/cdktf/typescript/r/lakeformation_lf_tag.html.markdown +++ b/website/docs/cdktf/typescript/r/lakeformation_lf_tag.html.markdown @@ -39,6 +39,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `catalogId` - (Optional) ID of the Data Catalog to create the tag in. If omitted, this defaults to the AWS Account ID. * `key` - (Required) Key-name for the tag. * `values` - (Required) List of possible values an attribute can take. @@ -81,4 +82,4 @@ Using `terraform import`, import Lake Formation LF-Tags using the `catalog_id:ke % terraform import aws_lakeformation_lf_tag.example 123456789012:some_key ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/lakeformation_opt_in.html.markdown b/website/docs/cdktf/typescript/r/lakeformation_opt_in.html.markdown index e7fc1b7a689e..cf37686972fc 100644 --- a/website/docs/cdktf/typescript/r/lakeformation_opt_in.html.markdown +++ b/website/docs/cdktf/typescript/r/lakeformation_opt_in.html.markdown @@ -36,8 +36,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `principal` - (Required) Lake Formation principal. Supported principals are IAM users or IAM roles. See [Principal](#principal) for more details. * `resourceData` - (Required) Structure for the resource. See [Resource](#resource) for more details. @@ -121,4 +122,4 @@ This resource exports the following attributes in addition to the arguments abov * `update` - (Default `180m`) * `delete` - (Default `90m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/lakeformation_permissions.html.markdown b/website/docs/cdktf/typescript/r/lakeformation_permissions.html.markdown index c7b1eb0e91b5..dfed46ccc351 100644 --- a/website/docs/cdktf/typescript/r/lakeformation_permissions.html.markdown +++ b/website/docs/cdktf/typescript/r/lakeformation_permissions.html.markdown @@ -249,8 +249,8 @@ class MyConvertedCode extends TerraformStack { The following arguments are required: -* `permissions` – (Required) List of permissions granted to the principal. Valid values may include `ALL`, `ALTER`, `ASSOCIATE`, `CREATE_DATABASE`, `CREATE_TABLE`, `DATA_LOCATION_ACCESS`, `DELETE`, `DESCRIBE`, `DROP`, `INSERT`, and `SELECT`. For details on each permission, see [Lake Formation Permissions Reference](https://docs.aws.amazon.com/lake-formation/latest/dg/lf-permissions-reference.html). -* `principal` – (Required) Principal to be granted the permissions on the resource. Supported principals include `IAM_ALLOWED_PRINCIPALS` (see [Default Behavior and `IAMAllowedPrincipals`](#default-behavior-and-iamallowedprincipals) above), IAM roles, users, groups, Federated Users, SAML groups and users, QuickSight groups, OUs, and organizations as well as AWS account IDs for cross-account permissions. For more information, see [Lake Formation Permissions Reference](https://docs.aws.amazon.com/lake-formation/latest/dg/lf-permissions-reference.html). +* `permissions` - (Required) List of permissions granted to the principal. Valid values may include `ALL`, `ALTER`, `ASSOCIATE`, `CREATE_DATABASE`, `CREATE_TABLE`, `DATA_LOCATION_ACCESS`, `DELETE`, `DESCRIBE`, `DROP`, `INSERT`, and `SELECT`. For details on each permission, see [Lake Formation Permissions Reference](https://docs.aws.amazon.com/lake-formation/latest/dg/lf-permissions-reference.html). +* `principal` - (Required) Principal to be granted the permissions on the resource. Supported principals include `IAM_ALLOWED_PRINCIPALS` (see [Default Behavior and `IAMAllowedPrincipals`](#default-behavior-and-iamallowedprincipals) above), IAM roles, users, groups, Federated Users, SAML groups and users, QuickSight groups, OUs, and organizations as well as AWS account IDs for cross-account permissions. For more information, see [Lake Formation Permissions Reference](https://docs.aws.amazon.com/lake-formation/latest/dg/lf-permissions-reference.html). ~> **NOTE:** We highly recommend that the `principal` _NOT_ be a Lake Formation administrator (granted using `aws_lakeformation_data_lake_settings`). The entity (e.g., IAM role) running Terraform will most likely need to be a Lake Formation administrator. As such, the entity will have implicit permissions and does not need permissions granted through this resource. @@ -267,7 +267,8 @@ One of the following is required: The following arguments are optional: -* `catalogId` – (Optional) Identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment. +* `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). +* `catalogId` - (Optional) Identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment. * `permissionsWithGrantOption` - (Optional) Subset of `permissions` which the principal can pass. ### data_cells_filter @@ -281,7 +282,7 @@ The following arguments are optional: The following argument is required: -* `arn` – (Required) Amazon Resource Name (ARN) that uniquely identifies the data location resource. +* `arn` - (Required) Amazon Resource Name (ARN) that uniquely identifies the data location resource. The following argument is optional: @@ -291,7 +292,7 @@ The following argument is optional: The following argument is required: -* `name` – (Required) Name of the database resource. Unique to the Data Catalog. +* `name` - (Required) Name of the database resource. Unique to the Data Catalog. The following argument is optional: @@ -301,7 +302,7 @@ The following argument is optional: The following arguments are required: -* `key` – (Required) The key-name for the tag. +* `key` - (Required) The key-name for the tag. * `values` - (Required) A list of possible values an attribute can take. The following argument is optional: @@ -312,7 +313,7 @@ The following argument is optional: The following arguments are required: -* `resourceType` – (Required) The resource type for which the tag policy applies. Valid values are `DATABASE` and `TABLE`. +* `resourceType` - (Required) The resource type for which the tag policy applies. Valid values are `DATABASE` and `TABLE`. * `expression` - (Required) A list of tag conditions that apply to the resource's tag policy. Configuration block for tag conditions that apply to the policy. See [`expression`](#expression) below. The following argument is optional: @@ -321,19 +322,20 @@ The following argument is optional: #### expression -* `key` – (Required) The key-name of an LF-Tag. +* `key` - (Required) The key-name of an LF-Tag. * `values` - (Required) A list of possible values of an LF-Tag. ### table The following argument is required: -* `databaseName` – (Required) Name of the database for the table. Unique to a Data Catalog. +* `databaseName` - (Required) Name of the database for the table. Unique to a Data Catalog. * `name` - (Required, at least one of `name` or `wildcard`) Name of the table. * `wildcard` - (Required, at least one of `name` or `wildcard`) Whether to use a wildcard representing every table under a database. Defaults to `false`. The following arguments are optional: +* `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). * `catalogId` - (Optional) Identifier for the Data Catalog. By default, it is the account ID of the caller. ### table_with_columns @@ -341,12 +343,13 @@ The following arguments are optional: The following arguments are required: * `columnNames` - (Required, at least one of `columnNames` or `wildcard`) Set of column names for the table. -* `databaseName` – (Required) Name of the database for the table with columns resource. Unique to the Data Catalog. -* `name` – (Required) Name of the table resource. +* `databaseName` - (Required) Name of the database for the table with columns resource. Unique to the Data Catalog. +* `name` - (Required) Name of the table resource. * `wildcard` - (Required, at least one of `columnNames` or `wildcard`) Whether to use a column wildcard. If `excludedColumnNames` is included, `wildcard` must be set to `true` to avoid Terraform reporting a difference. The following arguments are optional: +* `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). * `catalogId` - (Optional) Identifier for the Data Catalog. By default, it is the account ID of the caller. * `excludedColumnNames` - (Optional) Set of column names for the table to exclude. If `excludedColumnNames` is included, `wildcard` must be set to `true` to avoid Terraform reporting a difference. @@ -354,4 +357,4 @@ The following arguments are optional: This resource exports no additional attributes. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/lakeformation_resource.html.markdown b/website/docs/cdktf/typescript/r/lakeformation_resource.html.markdown index 15f415597df1..23c6001c3b78 100644 --- a/website/docs/cdktf/typescript/r/lakeformation_resource.html.markdown +++ b/website/docs/cdktf/typescript/r/lakeformation_resource.html.markdown @@ -53,13 +53,16 @@ class MyConvertedCode extends TerraformStack { The following arguments are required: -* `arn` – (Required) Amazon Resource Name (ARN) of the resource. +* `arn` - (Required) Amazon Resource Name (ARN) of the resource. The following arguments are optional: -* `roleArn` – (Optional) Role that has read/write access to the resource. +* `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). +* `roleArn` - (Optional) Role that has read/write access to the resource. * `useServiceLinkedRole` - (Optional) Designates an AWS Identity and Access Management (IAM) service-linked role by registering this role with the Data Catalog. * `hybridAccessEnabled` - (Optional) Flag to enable AWS LakeFormation hybrid access permission mode. +* `withFederation`- (Optional) Whether or not the resource is a federated resource. Set to true when registering AWS Glue connections for federated catalog functionality. +* `withPrivilegedAccess` - (Optional) Boolean to grant the calling principal the permissions to perform all supported Lake Formation operations on the registered data location. ~> **NOTE:** AWS does not support registering an S3 location with an IAM role and subsequently updating the S3 location registration to a service-linked role. @@ -69,4 +72,4 @@ This resource exports the following attributes in addition to the arguments abov * `lastModified` - Date and time the resource was last modified in [RFC 3339 format](https://tools.ietf.org/html/rfc3339#section-5.8). - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/lakeformation_resource_lf_tag.html.markdown b/website/docs/cdktf/typescript/r/lakeformation_resource_lf_tag.html.markdown index 99e75ef47080..403955b19ea4 100644 --- a/website/docs/cdktf/typescript/r/lakeformation_resource_lf_tag.html.markdown +++ b/website/docs/cdktf/typescript/r/lakeformation_resource_lf_tag.html.markdown @@ -49,7 +49,7 @@ class MyConvertedCode extends TerraformStack { The following arguments are required: -* `lfTag` – (Required) Set of LF-tags to attach to the resource. See [LF Tag](#lf-tag) for more details. +* `lfTag` - (Required) Set of LF-tags to attach to the resource. See [LF Tag](#lf-tag) for more details. Exactly one of the following is required: @@ -59,13 +59,14 @@ Exactly one of the following is required: The following arguments are optional: -* `catalogId` – (Optional) Identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment. +* `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). +* `catalogId` - (Optional) Identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment. ### LF Tag The following arguments are required: -* `key` – (Required) Key name for an existing LF-tag. +* `key` - (Required) Key name for an existing LF-tag. * `value` - (Required) Value from the possible values for the LF-tag. The following argument is optional: @@ -76,7 +77,7 @@ The following argument is optional: The following argument is required: -* `name` – (Required) Name of the database resource. Unique to the Data Catalog. +* `name` - (Required) Name of the database resource. Unique to the Data Catalog. The following argument is optional: @@ -86,12 +87,13 @@ The following argument is optional: The following argument is required: -* `databaseName` – (Required) Name of the database for the table. Unique to a Data Catalog. +* `databaseName` - (Required) Name of the database for the table. Unique to a Data Catalog. * `name` - (Required, at least one of `name` or `wildcard`) Name of the table. * `wildcard` - (Required, at least one of `name` or `wildcard`) Whether to use a wildcard representing every table under a database. Defaults to `false`. The following arguments are optional: +* `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). * `catalogId` - (Optional) Identifier for the Data Catalog. By default, it is the account ID of the caller. ### Table With Columns @@ -99,11 +101,12 @@ The following arguments are optional: The following arguments are required: * `columnNames` - (Required, at least one of `columnNames` or `wildcard`) Set of column names for the table. -* `databaseName` – (Required) Name of the database for the table with columns resource. Unique to the Data Catalog. -* `name` – (Required) Name of the table resource. +* `databaseName` - (Required) Name of the database for the table with columns resource. Unique to the Data Catalog. +* `name` - (Required) Name of the table resource. The following arguments are optional: +* `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). * `catalogId` - (Optional) Identifier for the Data Catalog. By default, it is the account ID of the caller. * `columnWildcard` - (Optional) Option to add column wildcard. See [Column Wildcard](#column-wildcard) for more details. @@ -126,4 +129,4 @@ This resource exports no additional attributes. You cannot import this resource. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/lakeformation_resource_lf_tags.html.markdown b/website/docs/cdktf/typescript/r/lakeformation_resource_lf_tags.html.markdown index 926afee34b5b..baeb0be6ee1b 100644 --- a/website/docs/cdktf/typescript/r/lakeformation_resource_lf_tags.html.markdown +++ b/website/docs/cdktf/typescript/r/lakeformation_resource_lf_tags.html.markdown @@ -128,7 +128,7 @@ class MyConvertedCode extends TerraformStack { The following arguments are required: -* `lfTag` – (Required) Set of LF-tags to attach to the resource. See below. +* `lfTag` - (Required) Set of LF-tags to attach to the resource. See below. Exactly one of the following is required: @@ -138,13 +138,14 @@ Exactly one of the following is required: The following arguments are optional: -* `catalogId` – (Optional) Identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment. +* `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). +* `catalogId` - (Optional) Identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment. ### lf_tag The following arguments are required: -* `key` – (Required) Key name for an existing LF-tag. +* `key` - (Required) Key name for an existing LF-tag. * `value` - (Required) Value from the possible values for the LF-tag. The following argument is optional: @@ -155,7 +156,7 @@ The following argument is optional: The following argument is required: -* `name` – (Required) Name of the database resource. Unique to the Data Catalog. +* `name` - (Required) Name of the database resource. Unique to the Data Catalog. The following argument is optional: @@ -165,12 +166,13 @@ The following argument is optional: The following argument is required: -* `databaseName` – (Required) Name of the database for the table. Unique to a Data Catalog. +* `databaseName` - (Required) Name of the database for the table. Unique to a Data Catalog. * `name` - (Required, at least one of `name` or `wildcard`) Name of the table. * `wildcard` - (Required, at least one of `name` or `wildcard`) Whether to use a wildcard representing every table under a database. Defaults to `false`. The following arguments are optional: +* `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). * `catalogId` - (Optional) Identifier for the Data Catalog. By default, it is the account ID of the caller. ### table_with_columns @@ -178,12 +180,13 @@ The following arguments are optional: The following arguments are required: * `columnNames` - (Required, at least one of `columnNames` or `wildcard`) Set of column names for the table. -* `databaseName` – (Required) Name of the database for the table with columns resource. Unique to the Data Catalog. -* `name` – (Required) Name of the table resource. +* `databaseName` - (Required) Name of the database for the table with columns resource. Unique to the Data Catalog. +* `name` - (Required) Name of the table resource. * `wildcard` - (Required, at least one of `columnNames` or `wildcard`) Whether to use a column wildcard. If `excludedColumnNames` is included, `wildcard` must be set to `true` to avoid Terraform reporting a difference. The following arguments are optional: +* `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). * `catalogId` - (Optional) Identifier for the Data Catalog. By default, it is the account ID of the caller. * `excludedColumnNames` - (Optional) Set of column names for the table to exclude. If `excludedColumnNames` is included, `wildcard` must be set to `true` to avoid Terraform reporting a difference. @@ -191,4 +194,4 @@ The following arguments are optional: This resource exports no additional attributes. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/lambda_alias.html.markdown b/website/docs/cdktf/typescript/r/lambda_alias.html.markdown index 1087e443310f..fc492b50bcd7 100644 --- a/website/docs/cdktf/typescript/r/lambda_alias.html.markdown +++ b/website/docs/cdktf/typescript/r/lambda_alias.html.markdown @@ -3,24 +3,25 @@ subcategory: "Lambda" layout: "aws" page_title: "AWS: aws_lambda_alias" description: |- - Creates a Lambda function alias. + Manages an AWS Lambda Alias. --- # Resource: aws_lambda_alias -Creates a Lambda function alias. Creates an alias that points to the specified Lambda function version. +Manages an AWS Lambda Alias. Use this resource to create an alias that points to a specific Lambda function version for traffic management and deployment strategies. -For information about Lambda and how to use it, see [What is AWS Lambda?][1] -For information about function aliases, see [CreateAlias][2] and [AliasRoutingConfiguration][3] in the API docs. +For information about Lambda and how to use it, see [What is AWS Lambda?](http://docs.aws.amazon.com/lambda/latest/dg/welcome.html). For information about function aliases, see [CreateAlias](http://docs.aws.amazon.com/lambda/latest/dg/API_CreateAlias.html) and [AliasRoutingConfiguration](https://docs.aws.amazon.com/lambda/latest/dg/API_AliasRoutingConfiguration.html) in the API docs. ## Example Usage +### Basic Alias + ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug import { Construct } from "constructs"; -import { TerraformStack } from "cdktf"; +import { Token, TerraformStack } from "cdktf"; /* * Provider bindings are generated by running `cdktf get`. * See https://cdk.tf/provider-generation for more details. @@ -29,14 +30,40 @@ import { LambdaAlias } from "./.gen/providers/aws/lambda-alias"; class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); - new LambdaAlias(this, "test_lambda_alias", { - description: "a sample description", - functionName: lambdaFunctionTest.arn, + new LambdaAlias(this, "example", { + description: "Production environment alias", + functionName: Token.asString(awsLambdaFunctionExample.arn), functionVersion: "1", - name: "my_alias", + name: "production", + }); + } +} + +``` + +### Alias with Traffic Splitting + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { Token, TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { LambdaAlias } from "./.gen/providers/aws/lambda-alias"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + new LambdaAlias(this, "example", { + description: "Staging environment with traffic splitting", + functionName: Token.asString(awsLambdaFunctionExample.functionName), + functionVersion: "2", + name: "staging", routingConfig: { additionalVersionWeights: { - 2: 0.5, + 1: 0.1, + 3: 0.2, }, }, }); @@ -45,30 +72,85 @@ class MyConvertedCode extends TerraformStack { ``` +### Blue-Green Deployment Alias + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { Token, TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { LambdaAlias } from "./.gen/providers/aws/lambda-alias"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + new LambdaAlias(this, "example", { + description: "Live traffic with gradual rollout to new version", + functionName: Token.asString(awsLambdaFunctionExample.functionName), + functionVersion: "5", + name: "live", + routingConfig: { + additionalVersionWeights: { + 6: 0.05, + }, + }, + }); + } +} + +``` + +### Development Alias + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { Token, TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { LambdaAlias } from "./.gen/providers/aws/lambda-alias"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + new LambdaAlias(this, "example", { + description: "Development environment - always points to latest", + functionName: Token.asString(awsLambdaFunctionExample.functionName), + functionVersion: "$LATEST", + name: "dev", + }); + } +} + +``` + ## Argument Reference -This resource supports the following arguments: +The following arguments are required: -* `name` - (Required) Name for the alias you are creating. Pattern: `(?!^[0-9]+$)([a-zA-Z0-9-_]+)` -* `description` - (Optional) Description of the alias. -* `functionName` - (Required) Lambda Function name or ARN. +* `functionName` - (Required) Name or ARN of the Lambda function. * `functionVersion` - (Required) Lambda function version for which you are creating the alias. Pattern: `(\$LATEST|[0-9]+)`. -* `routingConfig` - (Optional) The Lambda alias' route configuration settings. Fields documented below +* `name` - (Required) Name for the alias. Pattern: `(?!^[0-9]+$)([a-zA-Z0-9-_]+)`. -`routingConfig` supports the following arguments: +The following arguments are optional: -* `additionalVersionWeights` - (Optional) A map that defines the proportion of events that should be sent to different versions of a lambda function. +* `description` - (Optional) Description of the alias. +* `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). +* `routingConfig` - (Optional) Lambda alias' route configuration settings. [See below](#routing_config-configuration-block). + +### routing_config Configuration Block + +* `additionalVersionWeights` - (Optional) Map that defines the proportion of events that should be sent to different versions of a Lambda function. ## Attribute Reference This resource exports the following attributes in addition to the arguments above: -* `arn` - The Amazon Resource Name (ARN) identifying your Lambda function alias. -* `invokeArn` - The ARN to be used for invoking Lambda Function from API Gateway - to be used in [`aws_api_gateway_integration`](/docs/providers/aws/r/api_gateway_integration.html)'s `uri` - -[1]: http://docs.aws.amazon.com/lambda/latest/dg/welcome.html -[2]: http://docs.aws.amazon.com/lambda/latest/dg/API_CreateAlias.html -[3]: https://docs.aws.amazon.com/lambda/latest/dg/API_AliasRoutingConfiguration.html +* `arn` - ARN identifying your Lambda function alias. +* `invokeArn` - ARN to be used for invoking Lambda Function from API Gateway - to be used in [`aws_api_gateway_integration`](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/api_gateway_integration)'s `uri`. ## Import @@ -86,20 +168,16 @@ import { LambdaAlias } from "./.gen/providers/aws/lambda-alias"; class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); - LambdaAlias.generateConfigForImport( - this, - "testLambdaAlias", - "my_test_lambda_function/my_alias" - ); + LambdaAlias.generateConfigForImport(this, "example", "example/production"); } } ``` -Using `terraform import`, import Lambda Function Aliases using the `function_name/alias`. For example: +For backwards compatibility, the following legacy `terraform import` command is also supported: ```console -% terraform import aws_lambda_alias.test_lambda_alias my_test_lambda_function/my_alias +% terraform import aws_lambda_alias.example example/production ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/lambda_code_signing_config.html.markdown b/website/docs/cdktf/typescript/r/lambda_code_signing_config.html.markdown index 838707064baf..9baca5afbb29 100644 --- a/website/docs/cdktf/typescript/r/lambda_code_signing_config.html.markdown +++ b/website/docs/cdktf/typescript/r/lambda_code_signing_config.html.markdown @@ -3,19 +3,68 @@ subcategory: "Lambda" layout: "aws" page_title: "AWS: aws_lambda_code_signing_config" description: |- - Provides a Lambda Code Signing Config resource. + Manages an AWS Lambda Code Signing Config. --- # Resource: aws_lambda_code_signing_config -Provides a Lambda Code Signing Config resource. A code signing configuration defines a list of allowed signing profiles and defines the code-signing validation policy (action to be taken if deployment validation checks fail). +Manages an AWS Lambda Code Signing Config. Use this resource to define allowed signing profiles and code-signing validation policies for Lambda functions to ensure code integrity and authenticity. -For information about Lambda code signing configurations and how to use them, see [configuring code signing for Lambda functions][1] +For information about Lambda code signing configurations and how to use them, see [configuring code signing for Lambda functions](https://docs.aws.amazon.com/lambda/latest/dg/configuration-codesigning.html). ## Example Usage +### Basic Usage + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { LambdaCodeSigningConfig } from "./.gen/providers/aws/lambda-code-signing-config"; +import { SignerSigningProfile } from "./.gen/providers/aws/signer-signing-profile"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + const dev = new SignerSigningProfile(this, "dev", { + namePrefix: "dev_lambda_", + platformId: "AWSLambda-SHA384-ECDSA", + tags: { + Environment: "development", + }, + }); + const prod = new SignerSigningProfile(this, "prod", { + namePrefix: "prod_lambda_", + platformId: "AWSLambda-SHA384-ECDSA", + tags: { + Environment: "production", + }, + }); + new LambdaCodeSigningConfig(this, "example", { + allowedPublishers: { + signingProfileVersionArns: [prod.versionArn, dev.versionArn], + }, + description: "Code signing configuration for Lambda functions", + policies: { + untrustedArtifactOnDeployment: "Enforce", + }, + tags: { + Environment: "production", + Purpose: "code-signing", + }, + }); + } +} + +``` + +### Warning Only Configuration + ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug import { Construct } from "constructs"; @@ -28,16 +77,68 @@ import { LambdaCodeSigningConfig } from "./.gen/providers/aws/lambda-code-signin class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); - new LambdaCodeSigningConfig(this, "new_csc", { + new LambdaCodeSigningConfig(this, "example", { allowedPublishers: { - signingProfileVersionArns: [example1.versionArn, example2.versionArn], + signingProfileVersionArns: [dev.versionArn], }, - description: "My awesome code signing config.", + description: "Development code signing configuration", policies: { untrustedArtifactOnDeployment: "Warn", }, tags: { - Name: "dynamodb", + Environment: "development", + Purpose: "code-signing", + }, + }); + } +} + +``` + +### Multiple Environment Configuration + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { Token, TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { LambdaCodeSigningConfig } from "./.gen/providers/aws/lambda-code-signing-config"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + new LambdaCodeSigningConfig(this, "dev", { + allowedPublishers: { + signingProfileVersionArns: [ + Token.asString(awsSignerSigningProfileDev.versionArn), + test.versionArn, + ], + }, + description: "Development code signing configuration with warnings", + policies: { + untrustedArtifactOnDeployment: "Warn", + }, + tags: { + Environment: "development", + Security: "flexible", + }, + }); + new LambdaCodeSigningConfig(this, "prod", { + allowedPublishers: { + signingProfileVersionArns: [ + Token.asString(awsSignerSigningProfileProd.versionArn), + ], + }, + description: + "Production code signing configuration with strict enforcement", + policies: { + untrustedArtifactOnDeployment: "Enforce", + }, + tags: { + Environment: "production", + Security: "strict", }, }); } @@ -47,31 +148,33 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -This resource supports the following arguments: +The following arguments are required: + +* `allowedPublishers` - (Required) Configuration block of allowed publishers as signing profiles for this code signing configuration. [See below](#allowed_publishers-configuration-block). + +The following arguments are optional: -* `allowedPublishers` (Required) A configuration block of allowed publishers as signing profiles for this code signing configuration. Detailed below. -* `policies` (Optional) A configuration block of code signing policies that define the actions to take if the validation checks fail. Detailed below. * `description` - (Optional) Descriptive name for this code signing configuration. +* `policies` - (Optional) Configuration block of code signing policies that define the actions to take if the validation checks fail. [See below](#policies-configuration-block). +* `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). * `tags` - (Optional) Map of tags to assign to the object. If configured with a provider [`defaultTags` 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 `allowedPublishers` block supports the following argument: +### allowed_publishers Configuration Block -* `signingProfileVersionArns` - (Required) The Amazon Resource Name (ARN) for each of the signing profiles. A signing profile defines a trusted user who can sign a code package. +* `signingProfileVersionArns` - (Required) Set of ARNs for each of the signing profiles. A signing profile defines a trusted user who can sign a code package. Maximum of 20 signing profiles. -The `policies` block supports the following argument: +### policies Configuration Block -* `untrustedArtifactOnDeployment` - (Required) Code signing configuration policy for deployment validation failure. If you set the policy to Enforce, Lambda blocks the deployment request if code-signing validation checks fail. If you set the policy to Warn, Lambda allows the deployment and creates a CloudWatch log. Valid values: `Warn`, `Enforce`. Default value: `Warn`. +* `untrustedArtifactOnDeployment` - (Required) Code signing configuration policy for deployment validation failure. If you set the policy to `Enforce`, Lambda blocks the deployment request if code-signing validation checks fail. If you set the policy to `Warn`, Lambda allows the deployment and creates a CloudWatch log. Valid values: `Warn`, `Enforce`. Default value: `Warn`. ## Attribute Reference This resource exports the following attributes in addition to the arguments above: -* `arn` - The Amazon Resource Name (ARN) of the code signing configuration. +* `arn` - ARN of the code signing configuration. * `configId` - Unique identifier for the code signing configuration. -* `lastModified` - The date and time that the code signing configuration was last modified. -* `tagsAll` - A map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). - -[1]: https://docs.aws.amazon.com/lambda/latest/dg/configuration-codesigning.html +* `lastModified` - Date and time that the code signing configuration was last modified. +* `tagsAll` - Map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). ## Import @@ -91,7 +194,7 @@ class MyConvertedCode extends TerraformStack { super(scope, name); LambdaCodeSigningConfig.generateConfigForImport( this, - "importedCsc", + "example", "arn:aws:lambda:us-west-2:123456789012:code-signing-config:csc-0f6c334abcdea4d8b" ); } @@ -99,10 +202,10 @@ class MyConvertedCode extends TerraformStack { ``` -Using `terraform import`, import Code Signing Configs using their ARN. For example: +For backwards compatibility, the following legacy `terraform import` command is also supported: ```console -% terraform import aws_lambda_code_signing_config.imported_csc arn:aws:lambda:us-west-2:123456789012:code-signing-config:csc-0f6c334abcdea4d8b +% terraform import aws_lambda_code_signing_config.example arn:aws:lambda:us-west-2:123456789012:code-signing-config:csc-0f6c334abcdea4d8b ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/lambda_event_source_mapping.html.markdown b/website/docs/cdktf/typescript/r/lambda_event_source_mapping.html.markdown index d0f6188cd528..896d85fd64f0 100644 --- a/website/docs/cdktf/typescript/r/lambda_event_source_mapping.html.markdown +++ b/website/docs/cdktf/typescript/r/lambda_event_source_mapping.html.markdown @@ -3,21 +3,20 @@ subcategory: "Lambda" layout: "aws" page_title: "AWS: aws_lambda_event_source_mapping" description: |- - Provides a Lambda event source mapping. This allows Lambda functions to get events from Kinesis, DynamoDB, SQS, Amazon MQ and Managed Streaming for Apache Kafka (MSK). + Manages an AWS Lambda Event Source Mapping. --- # Resource: aws_lambda_event_source_mapping -Provides a Lambda event source mapping. This allows Lambda functions to get events from Kinesis, DynamoDB, SQS, Amazon MQ and Managed Streaming for Apache Kafka (MSK). +Manages an AWS Lambda Event Source Mapping. Use this resource to connect Lambda functions to event sources like Kinesis, DynamoDB, SQS, Amazon MQ, and Managed Streaming for Apache Kafka (MSK). -For information about Lambda and how to use it, see [What is AWS Lambda?][1]. -For information about event source mappings, see [CreateEventSourceMapping][2] in the API docs. +For information about Lambda and how to use it, see [What is AWS Lambda?](http://docs.aws.amazon.com/lambda/latest/dg/welcome.html). For information about event source mappings, see [CreateEventSourceMapping](http://docs.aws.amazon.com/lambda/latest/dg/API_CreateEventSourceMapping.html) in the API docs. ## Example Usage -### DynamoDB +### DynamoDB Stream ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -36,7 +35,7 @@ class MyConvertedCode extends TerraformStack { functionName: Token.asString(awsLambdaFunctionExample.arn), startingPosition: "LATEST", tags: { - Name: "dynamodb", + Name: "dynamodb-stream-mapping", }, }); } @@ -44,7 +43,7 @@ class MyConvertedCode extends TerraformStack { ``` -### Kinesis +### Kinesis Stream ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -59,8 +58,16 @@ class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); new LambdaEventSourceMapping(this, "example", { + batchSize: 100, + destinationConfig: { + onFailure: { + destinationArn: dlq.arn, + }, + }, eventSourceArn: Token.asString(awsKinesisStreamExample.arn), functionName: Token.asString(awsLambdaFunctionExample.arn), + maximumBatchingWindowInSeconds: 5, + parallelizationFactor: 2, startingPosition: "LATEST", }); } @@ -68,7 +75,7 @@ class MyConvertedCode extends TerraformStack { ``` -### Managed Streaming for Apache Kafka (MSK) +### SQS Queue ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -83,22 +90,24 @@ class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); new LambdaEventSourceMapping(this, "example", { - eventSourceArn: Token.asString(awsMskClusterExample.arn), + batchSize: 10, + eventSourceArn: Token.asString(awsSqsQueueExample.arn), functionName: Token.asString(awsLambdaFunctionExample.arn), - startingPosition: "TRIM_HORIZON", - topics: ["Example"], + scalingConfig: { + maximumConcurrency: 100, + }, }); } } ``` -### Self Managed Apache Kafka +### SQS with Event Filtering ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug import { Construct } from "constructs"; -import { Token, TerraformStack } from "cdktf"; +import { Token, Fn, TerraformStack } from "cdktf"; /* * Provider bindings are generated by running `cdktf get`. * See https://cdk.tf/provider-generation for more details. @@ -108,40 +117,33 @@ class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); new LambdaEventSourceMapping(this, "example", { - functionName: Token.asString(awsLambdaFunctionExample.arn), - provisionedPollerConfig: { - maximumPollers: 80, - minimumPollers: 10, - }, - selfManagedEventSource: { - endpoints: { - KAFKA_BOOTSTRAP_SERVERS: - "kafka1.example.com:9092,kafka2.example.com:9092", - }, + eventSourceArn: Token.asString(awsSqsQueueExample.arn), + filterCriteria: { + filter: [ + { + pattern: Token.asString( + Fn.jsonencode({ + body: { + Location: ["New York"], + Temperature: [ + { + numeric: [">", 0, "<=", 100], + }, + ], + }, + }) + ), + }, + ], }, - sourceAccessConfiguration: [ - { - type: "VPC_SUBNET", - uri: "subnet:subnet-example1", - }, - { - type: "VPC_SUBNET", - uri: "subnet:subnet-example2", - }, - { - type: "VPC_SECURITY_GROUP", - uri: "security_group:sg-example", - }, - ], - startingPosition: "TRIM_HORIZON", - topics: ["Example"], + functionName: Token.asString(awsLambdaFunctionExample.arn), }); } } ``` -### SQS +### Amazon MSK ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -156,20 +158,26 @@ class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); new LambdaEventSourceMapping(this, "example", { - eventSourceArn: sqsQueueTest.arn, + amazonManagedKafkaEventSourceConfig: { + consumerGroupId: "lambda-consumer-group", + }, + batchSize: 100, + eventSourceArn: Token.asString(awsMskClusterExample.arn), functionName: Token.asString(awsLambdaFunctionExample.arn), + startingPosition: "TRIM_HORIZON", + topics: ["orders", "inventory"], }); } } ``` -### SQS with event filter +### Self-Managed Apache Kafka ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug import { Construct } from "constructs"; -import { Fn, Token, TerraformStack } from "cdktf"; +import { Token, TerraformStack } from "cdktf"; /* * Provider bindings are generated by running `cdktf get`. * See https://cdk.tf/provider-generation for more details. @@ -179,26 +187,36 @@ class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); new LambdaEventSourceMapping(this, "example", { - eventSourceArn: sqsQueueTest.arn, - filterCriteria: { - filter: [ - { - pattern: Token.asString( - Fn.jsonencode({ - body: { - Location: ["New York"], - Temperature: [ - { - numeric: [">", 0, "<=", 100], - }, - ], - }, - }) - ), - }, - ], - }, functionName: Token.asString(awsLambdaFunctionExample.arn), + provisionedPollerConfig: { + maximumPollers: 100, + minimumPollers: 10, + }, + selfManagedEventSource: { + endpoints: { + KAFKA_BOOTSTRAP_SERVERS: + "kafka1.example.com:9092,kafka2.example.com:9092", + }, + }, + selfManagedKafkaEventSourceConfig: { + consumerGroupId: "lambda-consumer-group", + }, + sourceAccessConfiguration: [ + { + type: "VPC_SUBNET", + uri: "subnet:${" + example1.id + "}", + }, + { + type: "VPC_SUBNET", + uri: "subnet:${" + example2.id + "}", + }, + { + type: "VPC_SECURITY_GROUP", + uri: "security_group:${" + awsSecurityGroupExample.id + "}", + }, + ], + startingPosition: "TRIM_HORIZON", + topics: ["orders"], }); } } @@ -221,10 +239,9 @@ class MyConvertedCode extends TerraformStack { super(scope, name); new LambdaEventSourceMapping(this, "example", { batchSize: 10, - enabled: true, eventSourceArn: Token.asString(awsMqBrokerExample.arn), functionName: Token.asString(awsLambdaFunctionExample.arn), - queues: ["example"], + queues: ["orders"], sourceAccessConfiguration: [ { type: "BASIC_AUTH", @@ -253,14 +270,13 @@ class MyConvertedCode extends TerraformStack { super(scope, name); new LambdaEventSourceMapping(this, "example", { batchSize: 1, - enabled: true, eventSourceArn: Token.asString(awsMqBrokerExample.arn), functionName: Token.asString(awsLambdaFunctionExample.arn), - queues: ["example"], + queues: ["orders"], sourceAccessConfiguration: [ { type: "VIRTUAL_HOST", - uri: "/example", + uri: "/production", }, { type: "BASIC_AUTH", @@ -273,105 +289,141 @@ class MyConvertedCode extends TerraformStack { ``` +### DocumentDB Change Stream + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { Token, TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { LambdaEventSourceMapping } from "./.gen/providers/aws/lambda-event-source-mapping"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + new LambdaEventSourceMapping(this, "example", { + documentDbEventSourceConfig: { + collectionName: "transactions", + databaseName: "orders", + fullDocument: "UpdateLookup", + }, + eventSourceArn: Token.asString(awsDocdbClusterExample.arn), + functionName: Token.asString(awsLambdaFunctionExample.arn), + sourceAccessConfiguration: [ + { + type: "BASIC_AUTH", + uri: Token.asString(awsSecretsmanagerSecretVersionExample.arn), + }, + ], + startingPosition: "LATEST", + }); + } +} + +``` + ## Argument Reference -This resource supports the following arguments: - -* `amazonManagedKafkaEventSourceConfig` - (Optional) Additional configuration block for Amazon Managed Kafka sources. Incompatible with "self_managed_event_source" and "self_managed_kafka_event_source_config". Detailed below. -* `batchSize` - (Optional) The largest number of records that Lambda will retrieve from your event source at the time of invocation. Defaults to `100` for DynamoDB, Kinesis, MQ and MSK, `10` for SQS. -* `bisectBatchOnFunctionError`: - (Optional) If the function returns an error, split the batch in two and retry. Only available for stream sources (DynamoDB and Kinesis). Defaults to `false`. -* `destinationConfig`: - (Optional) An Amazon SQS queue, Amazon SNS topic or Amazon S3 bucket (only available for Kafka sources) destination for failed records. Only available for stream sources (DynamoDB and Kinesis) and Kafka sources (Amazon MSK and Self-managed Apache Kafka). Detailed below. -* `documentDbEventSourceConfig`: - (Optional) Configuration settings for a DocumentDB event source. Detailed below. -* `enabled` - (Optional) Determines if the mapping is enabled. This parameter can be used to enable or disable the mapping, both during resource creation and for already created resources. Defaults to `true`. -* `eventSourceArn` - (Optional) The event source ARN - this is required for Kinesis stream, DynamoDB stream, SQS queue, MQ broker, MSK cluster or DocumentDB change stream. It is incompatible with a Self Managed Kafka source. -* `filterCriteria` - (Optional) The criteria to use for [event filtering](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html) Kinesis stream, DynamoDB stream, SQS queue event sources. Detailed below. -* `functionName` - (Required) The name or the ARN of the Lambda function that will be subscribing to events. -* `functionResponseTypes` - (Optional) A list of current response type enums applied to the event source mapping for [AWS Lambda checkpointing](https://docs.aws.amazon.com/lambda/latest/dg/with-ddb.html#services-ddb-batchfailurereporting). Only available for SQS and stream sources (DynamoDB and Kinesis). Valid values: `ReportBatchItemFailures`. -* `kmsKeyArn` - (Optional) The ARN of the Key Management Service (KMS) customer managed key that Lambda uses to encrypt your function's filter criteria. -* `maximumBatchingWindowInSeconds` - (Optional) The maximum amount of time to gather records before invoking the function, in seconds (between 0 and 300). Records will continue to buffer (or accumulate in the case of an SQS queue event source) until either `maximumBatchingWindowInSeconds` expires or `batchSize` has been met. For streaming event sources, defaults to as soon as records are available in the stream. If the batch it reads from the stream/queue only has one record in it, Lambda only sends one record to the function. Only available for stream sources (DynamoDB and Kinesis) and SQS standard queues. -* `maximumRecordAgeInSeconds`: - (Optional) The maximum age of a record that Lambda sends to a function for processing. Only available for stream sources (DynamoDB and Kinesis). Must be either -1 (forever, and the default value) or between 60 and 604800 (inclusive). -* `maximumRetryAttempts`: - (Optional) The maximum number of times to retry when the function returns an error. Only available for stream sources (DynamoDB and Kinesis). Minimum and default of -1 (forever), maximum of 10000. -* `metricsConfig`: - (Optional) CloudWatch metrics configuration of the event source. Only available for stream sources (DynamoDB and Kinesis) and SQS queues. Detailed below. -* `parallelizationFactor`: - (Optional) The number of batches to process from each shard concurrently. Only available for stream sources (DynamoDB and Kinesis). Minimum and default of 1, maximum of 10. -* `provisionedPollerConfig`: - (Optional) Event poller configuration for the event source. Only valid for Amazon MSK or self-managed Apache Kafka sources. Detailed below. -* `queues` - (Optional) The name of the Amazon MQ broker destination queue to consume. Only available for MQ sources. The list must contain exactly one queue name. -* `scalingConfig` - (Optional) Scaling configuration of the event source. Only available for SQS queues. Detailed below. -* `selfManagedEventSource`: - (Optional) For Self Managed Kafka sources, the location of the self managed cluster. If set, configuration must also include `sourceAccessConfiguration`. Detailed below. -* `selfManagedKafkaEventSourceConfig` - (Optional) Additional configuration block for Self Managed Kafka sources. Incompatible with "event_source_arn" and "amazon_managed_kafka_event_source_config". Detailed below. -* `sourceAccessConfiguration`: (Optional) For Self Managed Kafka sources, the access configuration for the source. If set, configuration must also include `selfManagedEventSource`. Detailed below. -* `startingPosition` - (Optional) The position in the stream where AWS Lambda should start reading. Must be one of `AT_TIMESTAMP` (Kinesis only), `LATEST` or `TRIM_HORIZON` if getting events from Kinesis, DynamoDB, MSK or Self Managed Apache Kafka. Must not be provided if getting events from SQS. More information about these positions can be found in the [AWS DynamoDB Streams API Reference](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_streams_GetShardIterator.html) and [AWS Kinesis API Reference](https://docs.aws.amazon.com/kinesis/latest/APIReference/API_GetShardIterator.html#Kinesis-GetShardIterator-request-ShardIteratorType). -* `startingPositionTimestamp` - (Optional) A timestamp in [RFC3339 format](https://tools.ietf.org/html/rfc3339#section-5.8) of the data record which to start reading when using `startingPosition` set to `AT_TIMESTAMP`. If a record with this exact timestamp does not exist, the next later record is chosen. If the timestamp is older than the current trim horizon, the oldest available record is chosen. +The following arguments are required: + +* `functionName` - (Required) Name or ARN of the Lambda function that will be subscribing to events. + +The following arguments are optional: + +* `amazonManagedKafkaEventSourceConfig` - (Optional) Additional configuration block for Amazon Managed Kafka sources. Incompatible with `selfManagedEventSource` and `selfManagedKafkaEventSourceConfig`. [See below](#amazon_managed_kafka_event_source_config-configuration-block). +* `batchSize` - (Optional) Largest number of records that Lambda will retrieve from your event source at the time of invocation. Defaults to `100` for DynamoDB, Kinesis, MQ and MSK, `10` for SQS. +* `bisectBatchOnFunctionError` - (Optional) Whether to split the batch in two and retry if the function returns an error. Only available for stream sources (DynamoDB and Kinesis). Defaults to `false`. +* `destinationConfig` - (Optional) Amazon SQS queue, Amazon SNS topic or Amazon S3 bucket (only available for Kafka sources) destination for failed records. Only available for stream sources (DynamoDB and Kinesis) and Kafka sources (Amazon MSK and Self-managed Apache Kafka). [See below](#destination_config-configuration-block). +* `documentDbEventSourceConfig` - (Optional) Configuration settings for a DocumentDB event source. [See below](#document_db_event_source_config-configuration-block). +* `enabled` - (Optional) Whether the mapping is enabled. Defaults to `true`. +* `eventSourceArn` - (Optional) Event source ARN - required for Kinesis stream, DynamoDB stream, SQS queue, MQ broker, MSK cluster or DocumentDB change stream. Incompatible with Self Managed Kafka source. +* `filterCriteria` - (Optional) Criteria to use for [event filtering](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html) Kinesis stream, DynamoDB stream, SQS queue event sources. [See below](#filter_criteria-configuration-block). +* `functionResponseTypes` - (Optional) List of current response type enums applied to the event source mapping for [AWS Lambda checkpointing](https://docs.aws.amazon.com/lambda/latest/dg/with-ddb.html#services-ddb-batchfailurereporting). Only available for SQS and stream sources (DynamoDB and Kinesis). Valid values: `ReportBatchItemFailures`. +* `kmsKeyArn` - (Optional) ARN of the Key Management Service (KMS) customer managed key that Lambda uses to encrypt your function's filter criteria. +* `maximumBatchingWindowInSeconds` - (Optional) Maximum amount of time to gather records before invoking the function, in seconds (between 0 and 300). Records will continue to buffer until either `maximumBatchingWindowInSeconds` expires or `batchSize` has been met. For streaming event sources, defaults to as soon as records are available in the stream. Only available for stream sources (DynamoDB and Kinesis) and SQS standard queues. +* `maximumRecordAgeInSeconds` - (Optional) Maximum age of a record that Lambda sends to a function for processing. Only available for stream sources (DynamoDB and Kinesis). Must be either -1 (forever, and the default value) or between 60 and 604800 (inclusive). +* `maximumRetryAttempts` - (Optional) Maximum number of times to retry when the function returns an error. Only available for stream sources (DynamoDB and Kinesis). Minimum and default of -1 (forever), maximum of 10000. +* `metricsConfig` - (Optional) CloudWatch metrics configuration of the event source. Only available for stream sources (DynamoDB and Kinesis) and SQS queues. [See below](#metrics_config-configuration-block). +* `parallelizationFactor` - (Optional) Number of batches to process from each shard concurrently. Only available for stream sources (DynamoDB and Kinesis). Minimum and default of 1, maximum of 10. +* `provisionedPollerConfig` - (Optional) Event poller configuration for the event source. Only valid for Amazon MSK or self-managed Apache Kafka sources. [See below](#provisioned_poller_config-configuration-block). +* `queues` - (Optional) Name of the Amazon MQ broker destination queue to consume. Only available for MQ sources. The list must contain exactly one queue name. +* `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). +* `scalingConfig` - (Optional) Scaling configuration of the event source. Only available for SQS queues. [See below](#scaling_config-configuration-block). +* `selfManagedEventSource` - (Optional) For Self Managed Kafka sources, the location of the self managed cluster. If set, configuration must also include `sourceAccessConfiguration`. [See below](#self_managed_event_source-configuration-block). +* `selfManagedKafkaEventSourceConfig` - (Optional) Additional configuration block for Self Managed Kafka sources. Incompatible with `eventSourceArn` and `amazonManagedKafkaEventSourceConfig`. [See below](#self_managed_kafka_event_source_config-configuration-block). +* `sourceAccessConfiguration` - (Optional) For Self Managed Kafka sources, the access configuration for the source. If set, configuration must also include `selfManagedEventSource`. [See below](#source_access_configuration-configuration-block). +* `startingPosition` - (Optional) Position in the stream where AWS Lambda should start reading. Must be one of `AT_TIMESTAMP` (Kinesis only), `LATEST` or `TRIM_HORIZON` if getting events from Kinesis, DynamoDB, MSK or Self Managed Apache Kafka. Must not be provided if getting events from SQS. More information about these positions can be found in the [AWS DynamoDB Streams API Reference](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_streams_GetShardIterator.html) and [AWS Kinesis API Reference](https://docs.aws.amazon.com/kinesis/latest/APIReference/API_GetShardIterator.html#Kinesis-GetShardIterator-request-ShardIteratorType). +* `startingPositionTimestamp` - (Optional) Timestamp in [RFC3339 format](https://tools.ietf.org/html/rfc3339#section-5.8) of the data record which to start reading when using `startingPosition` set to `AT_TIMESTAMP`. If a record with this exact timestamp does not exist, the next later record is chosen. If the timestamp is older than the current trim horizon, the oldest available record is chosen. * `tags` - (Optional) Map of tags to assign to the object. If configured with a provider [`defaultTags` 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. -* `topics` - (Optional) The name of the Kafka topics. Only available for MSK sources. A single topic name must be specified. -* `tumblingWindowInSeconds` - (Optional) The duration in seconds of a processing window for [AWS Lambda streaming analytics](https://docs.aws.amazon.com/lambda/latest/dg/with-kinesis.html#services-kinesis-windows). The range is between 1 second up to 900 seconds. Only available for stream sources (DynamoDB and Kinesis). +* `topics` - (Optional) Name of the Kafka topics. Only available for MSK sources. A single topic name must be specified. +* `tumblingWindowInSeconds` - (Optional) Duration in seconds of a processing window for [AWS Lambda streaming analytics](https://docs.aws.amazon.com/lambda/latest/dg/with-kinesis.html#services-kinesis-windows). The range is between 1 second up to 900 seconds. Only available for stream sources (DynamoDB and Kinesis). ### amazon_managed_kafka_event_source_config Configuration Block -* `consumerGroupId` - (Optional) A Kafka consumer group ID between 1 and 200 characters for use when creating this event source mapping. If one is not specified, this value will be automatically generated. See [AmazonManagedKafkaEventSourceConfig Syntax](https://docs.aws.amazon.com/lambda/latest/dg/API_AmazonManagedKafkaEventSourceConfig.html). +* `consumerGroupId` - (Optional) Kafka consumer group ID between 1 and 200 characters for use when creating this event source mapping. If one is not specified, this value will be automatically generated. See [AmazonManagedKafkaEventSourceConfig Syntax](https://docs.aws.amazon.com/lambda/latest/dg/API_AmazonManagedKafkaEventSourceConfig.html). ### destination_config Configuration Block -* `onFailure` - (Optional) The destination configuration for failed invocations. Detailed below. +* `onFailure` - (Optional) Destination configuration for failed invocations. [See below](#destination_config-on_failure-configuration-block). #### destination_config on_failure Configuration Block -* `destinationArn` - (Required) The Amazon Resource Name (ARN) of the destination resource. +* `destinationArn` - (Required) ARN of the destination resource. ### document_db_event_source_config Configuration Block -* `collectionName` - (Optional) The name of the collection to consume within the database. If you do not specify a collection, Lambda consumes all collections. -* `databaseName` - (Required) The name of the database to consume within the DocumentDB cluster. +* `collectionName` - (Optional) Name of the collection to consume within the database. If you do not specify a collection, Lambda consumes all collections. +* `databaseName` - (Required) Name of the database to consume within the DocumentDB cluster. * `fullDocument` - (Optional) Determines what DocumentDB sends to your event stream during document update operations. If set to `UpdateLookup`, DocumentDB sends a delta describing the changes, along with a copy of the entire document. Otherwise, DocumentDB sends only a partial document that contains the changes. Valid values: `UpdateLookup`, `Default`. ### filter_criteria Configuration Block -* `filter` - (Optional) A set of up to 5 filter. If an event satisfies at least one, Lambda sends the event to the function or adds it to the next batch. Detailed below. +* `filter` - (Optional) Set of up to 5 filter. If an event satisfies at least one, Lambda sends the event to the function or adds it to the next batch. [See below](#filter_criteria-filter-configuration-block). #### filter_criteria filter Configuration Block -* `pattern` - (Optional) A filter pattern up to 4096 characters. See [Filter Rule Syntax](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html#filtering-syntax). +* `pattern` - (Optional) Filter pattern up to 4096 characters. See [Filter Rule Syntax](https://docs.aws.amazon.com/lambda/latest/dg/invocation-eventfiltering.html#filtering-syntax). ### metrics_config Configuration Block -* `metrics` - (Required) A list containing the metrics to be produced by the event source mapping. Valid values: `EventCount`. +* `metrics` - (Required) List containing the metrics to be produced by the event source mapping. Valid values: `EventCount`. ### provisioned_poller_config Configuration Block -* `maximumPollers` - (Optional) The maximum number of event pollers this event source can scale up to. The range is between 1 and 2000. -* `minimumPollers` - (Optional) The minimum number of event pollers this event source can scale down to. The range is between 1 and 200. +* `maximumPollers` - (Optional) Maximum number of event pollers this event source can scale up to. The range is between 1 and 2000. +* `minimumPollers` - (Optional) Minimum number of event pollers this event source can scale down to. The range is between 1 and 200. ### scaling_config Configuration Block -* `maximumConcurrency` - (Optional) Limits the number of concurrent instances that the Amazon SQS event source can invoke. Must be greater than or equal to `2`. See [Configuring maximum concurrency for Amazon SQS event sources](https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html#events-sqs-max-concurrency). You need to raise a [Service Quota Ticket](https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html) to increase the concurrency beyond 1000. +* `maximumConcurrency` - (Optional) Limits the number of concurrent instances that the Amazon SQS event source can invoke. Must be greater than or equal to 2. See [Configuring maximum concurrency for Amazon SQS event sources](https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html#events-sqs-max-concurrency). You need to raise a [Service Quota Ticket](https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html) to increase the concurrency beyond 1000. ### self_managed_event_source Configuration Block -* `endpoints` - (Required) A map of endpoints for the self managed source. For Kafka self-managed sources, the key should be `KAFKA_BOOTSTRAP_SERVERS` and the value should be a string with a comma separated list of broker endpoints. +* `endpoints` - (Required) Map of endpoints for the self managed source. For Kafka self-managed sources, the key should be `KAFKA_BOOTSTRAP_SERVERS` and the value should be a string with a comma separated list of broker endpoints. ### self_managed_kafka_event_source_config Configuration Block -* `consumerGroupId` - (Optional) A Kafka consumer group ID between 1 and 200 characters for use when creating this event source mapping. If one is not specified, this value will be automatically generated. See [SelfManagedKafkaEventSourceConfig Syntax](https://docs.aws.amazon.com/lambda/latest/dg/API_SelfManagedKafkaEventSourceConfig.html). +* `consumerGroupId` - (Optional) Kafka consumer group ID between 1 and 200 characters for use when creating this event source mapping. If one is not specified, this value will be automatically generated. See [SelfManagedKafkaEventSourceConfig Syntax](https://docs.aws.amazon.com/lambda/latest/dg/API_SelfManagedKafkaEventSourceConfig.html). ### source_access_configuration Configuration Block -* `type` - (Required) The type of authentication protocol, VPC components, or virtual host for your event source. For valid values, refer to the [AWS documentation](https://docs.aws.amazon.com/lambda/latest/api/API_SourceAccessConfiguration.html). -* `uri` - (Required) The URI for this configuration. For type `VPC_SUBNET` the value should be `subnet:subnet_id` where `subnetId` is the value you would find in an aws_subnet resource's id attribute. For type `VPC_SECURITY_GROUP` the value should be `security_group:security_group_id` where `securityGroupId` is the value you would find in an aws_security_group resource's id attribute. +* `type` - (Required) Type of authentication protocol, VPC components, or virtual host for your event source. For valid values, refer to the [AWS documentation](https://docs.aws.amazon.com/lambda/latest/api/API_SourceAccessConfiguration.html). +* `uri` - (Required) URI for this configuration. For type `VPC_SUBNET` the value should be `subnet:subnet_id` where `subnetId` is the value you would find in an aws_subnet resource's id attribute. For type `VPC_SECURITY_GROUP` the value should be `security_group:security_group_id` where `securityGroupId` is the value you would find in an aws_security_group resource's id attribute. ## Attribute Reference This resource exports the following attributes in addition to the arguments above: -* `arn` - The event source mapping ARN. -* `functionArn` - The ARN of the Lambda function the event source mapping is sending events to. (Note: this is a computed value that differs from `functionName` above.) -* `lastModified` - The date this resource was last modified. -* `lastProcessingResult` - The result of the last AWS Lambda invocation of your Lambda function. -* `state` - The state of the event source mapping. -* `stateTransitionReason` - The reason the event source mapping is in its current state. -* `tagsAll` - A map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). -* `uuid` - The UUID of the created event source mapping. - -[1]: http://docs.aws.amazon.com/lambda/latest/dg/welcome.html -[2]: http://docs.aws.amazon.com/lambda/latest/dg/API_CreateEventSourceMapping.html +* `arn` - Event source mapping ARN. +* `functionArn` - ARN of the Lambda function the event source mapping is sending events to. (Note: this is a computed value that differs from `functionName` above.) +* `lastModified` - Date this resource was last modified. +* `lastProcessingResult` - Result of the last AWS Lambda invocation of your Lambda function. +* `state` - State of the event source mapping. +* `stateTransitionReason` - Reason the event source mapping is in its current state. +* `tagsAll` - Map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). +* `uuid` - UUID of the created event source mapping. ## Import @@ -391,7 +443,7 @@ class MyConvertedCode extends TerraformStack { super(scope, name); LambdaEventSourceMapping.generateConfigForImport( this, - "eventSourceMapping", + "example", "12345kxodurf3443" ); } @@ -402,7 +454,7 @@ class MyConvertedCode extends TerraformStack { Using `terraform import`, import Lambda event source mappings using the `UUID` (event source mapping identifier). For example: ```console -% terraform import aws_lambda_event_source_mapping.event_source_mapping 12345kxodurf3443 +% terraform import aws_lambda_event_source_mapping.example 12345kxodurf3443 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/lambda_function.html.markdown b/website/docs/cdktf/typescript/r/lambda_function.html.markdown index c3b176f93878..1dcf17b6f138 100644 --- a/website/docs/cdktf/typescript/r/lambda_function.html.markdown +++ b/website/docs/cdktf/typescript/r/lambda_function.html.markdown @@ -3,28 +3,26 @@ subcategory: "Lambda" layout: "aws" page_title: "AWS: aws_lambda_function" description: |- - Provides a Lambda Function resource. Lambda allows you to trigger execution of code in response to events in AWS, enabling serverless backend solutions. The Lambda Function itself includes source code and runtime configuration. + Manages an AWS Lambda Function. --- # Resource: aws_lambda_function -Provides a Lambda Function resource. Lambda allows you to trigger execution of code in response to events in AWS, enabling serverless backend solutions. The Lambda Function itself includes source code and runtime configuration. +Manages an AWS Lambda Function. Use this resource to create serverless functions that run code in response to events without provisioning or managing servers. -For information about Lambda and how to use it, see [What is AWS Lambda?][1] +For information about Lambda and how to use it, see [What is AWS Lambda?](https://docs.aws.amazon.com/lambda/latest/dg/welcome.html). For a detailed example of setting up Lambda and API Gateway, see [Serverless Applications with AWS Lambda and API Gateway](https://learn.hashicorp.com/terraform/aws/lambda-api-gateway). -For a detailed example of setting up Lambda and API Gateway, see [Serverless Applications with AWS Lambda and API Gateway.][11] +~> **Note:** Due to [AWS Lambda improved VPC networking changes that began deploying in September 2019](https://aws.amazon.com/blogs/compute/announcing-improved-vpc-networking-for-aws-lambda-functions/), EC2 subnets and security groups associated with Lambda Functions can take up to 45 minutes to successfully delete. Terraform AWS Provider version 2.31.0 and later automatically handles this increased timeout, however prior versions require setting the customizable deletion timeouts of those Terraform resources to 45 minutes (`delete = "45m"`). AWS and HashiCorp are working together to reduce the amount of time required for resource deletion and updates can be tracked in this [GitHub issue](https://github.com/hashicorp/terraform-provider-aws/issues/10329). -~> **NOTE:** Due to [AWS Lambda improved VPC networking changes that began deploying in September 2019](https://aws.amazon.com/blogs/compute/announcing-improved-vpc-networking-for-aws-lambda-functions/), EC2 subnets and security groups associated with Lambda Functions can take up to 45 minutes to successfully delete. Terraform AWS Provider version 2.31.0 and later automatically handles this increased timeout, however prior versions require setting the customizable deletion timeouts of those Terraform resources to 45 minutes (`delete = "45m"`). AWS and HashiCorp are working together to reduce the amount of time required for resource deletion and updates can be tracked in this [GitHub issue](https://github.com/hashicorp/terraform-provider-aws/issues/10329). +~> **Note:** If you get a `KMSAccessDeniedException: Lambda was unable to decrypt the environment variables because KMS access was denied` error when invoking an `aws_lambda_function` with environment variables, the IAM role associated with the function may have been deleted and recreated after the function was created. You can fix the problem two ways: 1) updating the function's role to another role and then updating it back again to the recreated role, or 2) by using Terraform to `taint` the function and `apply` your configuration again to recreate the function. (When you create a function, Lambda grants permissions on the KMS key to the function's IAM role. If the IAM role is recreated, the grant is no longer valid. Changing the function's role or recreating the function causes Lambda to update the grant.) -~> **NOTE:** If you get a `KMSAccessDeniedException: Lambda was unable to decrypt the environment variables because KMS access was denied` error when invoking an [`aws_lambda_function`](/docs/providers/aws/r/lambda_function.html) with environment variables, the IAM role associated with the function may have been deleted and recreated _after_ the function was created. You can fix the problem two ways: 1) updating the function's role to another role and then updating it back again to the recreated role, or 2) by using Terraform to `taint` the function and `apply` your configuration again to recreate the function. (When you create a function, Lambda grants permissions on the KMS key to the function's IAM role. If the IAM role is recreated, the grant is no longer valid. Changing the function's role or recreating the function causes Lambda to update the grant.) - --> To give an external source (like an EventBridge Rule, SNS, or S3) permission to access the Lambda function, use the [`aws_lambda_permission`](lambda_permission.html) resource. See [Lambda Permission Model][4] for more details. On the other hand, the `role` argument of this resource is the function's execution role for identity and access to AWS services and resources. +-> **Tip:** To give an external source (like an EventBridge Rule, SNS, or S3) permission to access the Lambda function, use the [`aws_lambda_permission`](lambda_permission.html) resource. See [Lambda Permission Model](https://docs.aws.amazon.com/lambda/latest/dg/intro-permission-model.html) for more details. On the other hand, the `role` argument of this resource is the function's execution role for identity and access to AWS services and resources. ## Example Usage -### Basic Example +### Basic Function with Node.js ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -43,9 +41,9 @@ class MyConvertedCode extends TerraformStack { super(scope, name); /*The following providers are missing schema information and might need manual adjustments to synthesize correctly: archive. For a more precise conversion please use the --provider flag in convert.*/ - const lambda = new DataArchiveFile(this, "lambda", { - output_path: "lambda_function_payload.zip", - source_file: "lambda.js", + const example = new DataArchiveFile(this, "example", { + output_path: "${path.module}/lambda/function.zip", + source_file: "${path.module}/lambda/index.js", type: "zip", }); const assumeRole = new DataAwsIamPolicyDocument(this, "assume_role", { @@ -62,57 +60,103 @@ class MyConvertedCode extends TerraformStack { }, ], }); - const iamForLambda = new IamRole(this, "iam_for_lambda", { + const awsIamRoleExample = new IamRole(this, "example_2", { assumeRolePolicy: Token.asString(assumeRole.json), - name: "iam_for_lambda", + name: "lambda_execution_role", }); - new LambdaFunction(this, "test_lambda", { + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + awsIamRoleExample.overrideLogicalId("example"); + const awsLambdaFunctionExample = new LambdaFunction(this, "example_3", { environment: { variables: { - foo: "bar", + ENVIRONMENT: "production", + LOG_LEVEL: "info", }, }, - filename: "lambda_function_payload.zip", - functionName: "lambda_function_name", - handler: "index.test", - role: iamForLambda.arn, - runtime: "nodejs18.x", - sourceCodeHash: Token.asString(lambda.outputBase64Sha256), + filename: Token.asString(example.outputPath), + functionName: "example_lambda_function", + handler: "index.handler", + role: Token.asString(awsIamRoleExample.arn), + runtime: "nodejs20.x", + sourceCodeHash: Token.asString(example.outputBase64Sha256), + tags: { + Application: "example", + Environment: "production", + }, + }); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + awsLambdaFunctionExample.overrideLogicalId("example"); + } +} + +``` + +### Container Image Function + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { Token, TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { LambdaFunction } from "./.gen/providers/aws/lambda-function"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + new LambdaFunction(this, "example", { + architectures: ["arm64"], + functionName: "example_container_function", + imageConfig: { + command: ["app.handler"], + entryPoint: ["/lambda-entrypoint.sh"], + }, + imageUri: "${" + awsEcrRepositoryExample.repositoryUrl + "}:latest", + memorySize: 512, + packageType: "Image", + role: Token.asString(awsIamRoleExample.arn), + timeout: 30, }); } } ``` -### Lambda Layers +### Function with Lambda Layers -~> **NOTE:** The `aws_lambda_layer_version` attribute values for `arn` and `layerArn` were swapped in version 2.0.0 of the Terraform AWS Provider. For version 1.x, use `layerArn` references. For version 2.x, use `arn` references. +~> **Note:** The `aws_lambda_layer_version` attribute values for `arn` and `layerArn` were swapped in version 2.0.0 of the Terraform AWS Provider. For version 2.x, use `arn` references. ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug import { Construct } from "constructs"; -import { TerraformStack } from "cdktf"; +import { Token, TerraformStack } from "cdktf"; /* * Provider bindings are generated by running `cdktf get`. * See https://cdk.tf/provider-generation for more details. */ import { LambdaFunction } from "./.gen/providers/aws/lambda-function"; import { LambdaLayerVersion } from "./.gen/providers/aws/lambda-layer-version"; -interface MyConfig { - layerName: any; - functionName: any; - role: any; -} class MyConvertedCode extends TerraformStack { - constructor(scope: Construct, name: string, config: MyConfig) { + constructor(scope: Construct, name: string) { super(scope, name); const example = new LambdaLayerVersion(this, "example", { - layerName: config.layerName, + compatibleArchitectures: ["x86_64", "arm64"], + compatibleRuntimes: ["nodejs20.x", "python3.12"], + description: "Common dependencies for Lambda functions", + filename: "layer.zip", + layerName: "example_dependencies_layer", }); const awsLambdaFunctionExample = new LambdaFunction(this, "example_1", { + filename: "function.zip", + functionName: "example_layered_function", + handler: "index.handler", layers: [example.arn], - functionName: config.functionName, - role: config.role, + role: Token.asString(awsIamRoleExample.arn), + runtime: "nodejs20.x", + tracingConfig: { + mode: "Active", + }, }); /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ awsLambdaFunctionExample.overrideLogicalId("example"); @@ -121,9 +165,7 @@ class MyConvertedCode extends TerraformStack { ``` -### Lambda Ephemeral Storage - -Lambda Function Ephemeral Storage(`/tmp`) allows you to configure the storage upto `10` GB. The default value set to `512` MB. +### VPC Function with Enhanced Networking ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -133,53 +175,48 @@ import { Token, TerraformStack } from "cdktf"; * Provider bindings are generated by running `cdktf get`. * See https://cdk.tf/provider-generation for more details. */ -import { DataAwsIamPolicyDocument } from "./.gen/providers/aws/data-aws-iam-policy-document"; -import { IamRole } from "./.gen/providers/aws/iam-role"; import { LambdaFunction } from "./.gen/providers/aws/lambda-function"; class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); - const assumeRole = new DataAwsIamPolicyDocument(this, "assume_role", { - statement: [ - { - actions: ["sts:AssumeRole"], - effect: "Allow", - principals: [ - { - identifiers: ["lambda.amazonaws.com"], - type: "Service", - }, - ], - }, - ], - }); - const iamForLambda = new IamRole(this, "iam_for_lambda", { - assumeRolePolicy: Token.asString(assumeRole.json), - name: "iam_for_lambda", - }); - new LambdaFunction(this, "test_lambda", { + new LambdaFunction(this, "example", { ephemeralStorage: { - size: 10240, + size: 5120, + }, + filename: "function.zip", + functionName: "example_vpc_function", + handler: "app.handler", + memorySize: 1024, + role: Token.asString(awsIamRoleExample.arn), + runtime: "python3.12", + snapStart: { + applyOn: "PublishedVersions", + }, + timeout: 30, + vpcConfig: { + ipv6AllowedForDualStack: true, + securityGroupIds: [exampleLambda.id], + subnetIds: [examplePrivate1.id, examplePrivate2.id], }, - filename: "lambda_function_payload.zip", - functionName: "lambda_function_name", - handler: "index.test", - role: iamForLambda.arn, - runtime: "nodejs18.x", }); } } ``` -### Lambda File Systems - -Lambda File Systems allow you to connect an Amazon Elastic File System (EFS) file system to a Lambda function to share data across function invocations, access existing data including large files, and save function state. +### Function with EFS Integration ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug import { Construct } from "constructs"; -import { TerraformStack } from "cdktf"; +import { + VariableType, + TerraformVariable, + Fn, + Token, + TerraformCount, + TerraformStack, +} from "cdktf"; /* * Provider bindings are generated by running `cdktf get`. * See https://cdk.tf/provider-generation for more details. @@ -188,133 +225,391 @@ import { EfsAccessPoint } from "./.gen/providers/aws/efs-access-point"; import { EfsFileSystem } from "./.gen/providers/aws/efs-file-system"; import { EfsMountTarget } from "./.gen/providers/aws/efs-mount-target"; import { LambdaFunction } from "./.gen/providers/aws/lambda-function"; -interface MyConfig { - functionName: any; - role: any; -} class MyConvertedCode extends TerraformStack { - constructor(scope: Construct, name: string, config: MyConfig) { + constructor(scope: Construct, name: string) { super(scope, name); - const efsForLambda = new EfsFileSystem(this, "efs_for_lambda", { + /*Terraform Variables are not always the best fit for getting inputs in the context of Terraform CDK. + You can read more about this at https://cdk.tf/variables*/ + const subnetIds = new TerraformVariable(this, "subnet_ids", { + default: ["subnet-12345678", "subnet-87654321"], + description: "List of subnet IDs for EFS mount targets", + type: VariableType.list(VariableType.STRING), + }); + const example = new EfsFileSystem(this, "example", { + encrypted: true, tags: { - Name: "efs_for_lambda", + Name: "lambda-efs", }, }); - const alpha = new EfsMountTarget(this, "alpha", { - fileSystemId: efsForLambda.id, - securityGroups: [sgForLambda.id], - subnetId: subnetForLambda.id, + /*In most cases loops should be handled in the programming language context and + not inside of the Terraform context. If you are looping over something external, e.g. a variable or a file input + you should consider using a for loop. If you are looping over something only known to Terraform, e.g. a result of a data source + you need to keep this like it is.*/ + const exampleCount = TerraformCount.of( + Token.asNumber(Fn.lengthOf(subnetIds.value)) + ); + const awsEfsMountTargetExample = new EfsMountTarget(this, "example_2", { + fileSystemId: example.id, + securityGroups: [efs.id], + subnetId: Token.asString( + Fn.lookupNested(subnetIds.value, [exampleCount.index]) + ), + count: exampleCount, }); - const accessPointForLambda = new EfsAccessPoint( - this, - "access_point_for_lambda", - { - fileSystemId: efsForLambda.id, - posixUser: { - gid: 1000, - uid: 1000, - }, - rootDirectory: { - creationInfo: { - ownerGid: 1000, - ownerUid: 1000, - permissions: "777", - }, - path: "/lambda", + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + awsEfsMountTargetExample.overrideLogicalId("example"); + const awsEfsAccessPointExample = new EfsAccessPoint(this, "example_3", { + fileSystemId: example.id, + posixUser: { + gid: 1000, + uid: 1000, + }, + rootDirectory: { + creationInfo: { + ownerGid: 1000, + ownerUid: 1000, + permissions: "755", }, - } - ); - new LambdaFunction(this, "example", { - dependsOn: [alpha], + path: "/lambda", + }, + }); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + awsEfsAccessPointExample.overrideLogicalId("example"); + const awsLambdaFunctionExample = new LambdaFunction(this, "example_4", { + dependsOn: [awsEfsMountTargetExample], fileSystemConfig: { - arn: accessPointForLambda.arn, - localMountPath: "/mnt/efs", + arn: Token.asString(awsEfsAccessPointExample.arn), + localMountPath: "/mnt/data", }, + filename: "function.zip", + functionName: "example_efs_function", + handler: "index.handler", + role: Token.asString(awsIamRoleExample.arn), + runtime: "nodejs20.x", vpcConfig: { - securityGroupIds: [sgForLambda.id], - subnetIds: [subnetForLambda.id], + securityGroupIds: [lambda.id], + subnetIds: subnetIds.listValue, + }, + }); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + awsLambdaFunctionExample.overrideLogicalId("example"); + } +} + +``` + +### Function with Advanced Logging + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { Token, TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { CloudwatchLogGroup } from "./.gen/providers/aws/cloudwatch-log-group"; +import { LambdaFunction } from "./.gen/providers/aws/lambda-function"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + const example = new CloudwatchLogGroup(this, "example", { + name: "/aws/lambda/example_function", + retentionInDays: 14, + tags: { + Application: "example", + Environment: "production", }, - functionName: config.functionName, - role: config.role, }); + const awsLambdaFunctionExample = new LambdaFunction(this, "example_1", { + dependsOn: [example], + filename: "function.zip", + functionName: "example_function", + handler: "index.handler", + loggingConfig: { + applicationLogLevel: "INFO", + logFormat: "JSON", + systemLogLevel: "WARN", + }, + role: Token.asString(awsIamRoleExample.arn), + runtime: "nodejs20.x", + }); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + awsLambdaFunctionExample.overrideLogicalId("example"); } } ``` -### Lambda retries +### Function with logging to S3 or Data Firehose + +#### Required Resources -Lambda Functions allow you to configure error handling for asynchronous invocation. The settings that it supports are `Maximum age of event` and `Retry attempts` as stated in [Lambda documentation for Configuring error handling for asynchronous invocation](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#invocation-async-errors). To configure these settings, refer to the [aws_lambda_function_event_invoke_config resource](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/lambda_function_event_invoke_config). +* An S3 bucket or Data Firehose delivery stream to store the logs. +* A CloudWatch Log Group with: -## CloudWatch Logging and Permissions + * `log_group_class = "DELIVERY"` + * A subscription filter whose `destinationArn` points to the S3 bucket or the Data Firehose delivery stream. -For more information about CloudWatch Logs for Lambda, see the [Lambda User Guide](https://docs.aws.amazon.com/lambda/latest/dg/monitoring-functions-logs.html). +* IAM roles: + + * Assumed by the `logs.amazonaws.com` service to deliver logs to the S3 bucket or Data Firehose delivery stream. + * Assumed by the `lambda.amazonaws.com` service to send logs to CloudWatch Logs + +* A Lambda function: + + * In the `loggingConfiguration`, specify the name of the Log Group created above using the `logGroup` field + * No special configuration is required to use S3 or Firehose as the log destination + +For more details, see [Sending Lambda function logs to Amazon S3](https://docs.aws.amazon.com/lambda/latest/dg/logging-with-s3.html). + +#### Example: Exporting Lambda Logs to S3 Bucket ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug import { Construct } from "constructs"; -import { TerraformVariable, Token, TerraformStack } from "cdktf"; +import { Token, TerraformStack } from "cdktf"; /* * Provider bindings are generated by running `cdktf get`. * See https://cdk.tf/provider-generation for more details. */ import { CloudwatchLogGroup } from "./.gen/providers/aws/cloudwatch-log-group"; +import { CloudwatchLogSubscriptionFilter } from "./.gen/providers/aws/cloudwatch-log-subscription-filter"; import { DataAwsIamPolicyDocument } from "./.gen/providers/aws/data-aws-iam-policy-document"; -import { IamPolicy } from "./.gen/providers/aws/iam-policy"; -import { IamRolePolicyAttachment } from "./.gen/providers/aws/iam-role-policy-attachment"; +import { IamRole } from "./.gen/providers/aws/iam-role"; +import { IamRolePolicy } from "./.gen/providers/aws/iam-role-policy"; import { LambdaFunction } from "./.gen/providers/aws/lambda-function"; -interface MyConfig { - role: any; -} +import { S3Bucket } from "./.gen/providers/aws/s3-bucket"; class MyConvertedCode extends TerraformStack { - constructor(scope: Construct, name: string, config: MyConfig) { + constructor(scope: Construct, name: string) { super(scope, name); - /*Terraform Variables are not always the best fit for getting inputs in the context of Terraform CDK. - You can read more about this at https://cdk.tf/variables*/ - const lambdaFunctionName = new TerraformVariable( + const lambdaFunctionName = "lambda-log-export-example"; + const exportVar = new CloudwatchLogGroup(this, "export", { + logGroupClass: "DELIVERY", + name: "/aws/lambda/${" + lambdaFunctionName + "}", + }); + new LambdaFunction(this, "log_export", { + dependsOn: [exportVar], + filename: "function.zip", + functionName: lambdaFunctionName, + handler: "index.lambda_handler", + loggingConfig: { + logFormat: "Text", + logGroup: exportVar.name, + }, + role: example.arn, + runtime: "python3.13", + }); + const lambdaLogExport = new S3Bucket(this, "lambda_log_export", { + bucket: "${" + lambdaFunctionName + "}-bucket", + }); + const dataAwsIamPolicyDocumentLambdaLogExport = + new DataAwsIamPolicyDocument(this, "lambda_log_export_3", { + statement: [ + { + actions: ["s3:PutObject"], + effect: "Allow", + resources: ["${" + lambdaLogExport.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.*/ + dataAwsIamPolicyDocumentLambdaLogExport.overrideLogicalId( + "lambda_log_export" + ); + const logsAssumeRole = new DataAwsIamPolicyDocument( this, - "lambda_function_name", + "logs_assume_role", { - default: "lambda_function_name", + statement: [ + { + actions: ["sts:AssumeRole"], + effect: "Allow", + principals: [ + { + identifiers: ["logs.amazonaws.com"], + type: "Service", + }, + ], + }, + ], } ); - const example = new CloudwatchLogGroup(this, "example", { - name: "/aws/lambda/${" + lambdaFunctionName.value + "}", - retentionInDays: 14, + const logsLogExport = new IamRole(this, "logs_log_export", { + assumeRolePolicy: Token.asString(logsAssumeRole.json), + name: "${" + lambdaFunctionName + "}-lambda-log-export-role", }); - const lambdaLogging = new DataAwsIamPolicyDocument(this, "lambda_logging", { - statement: [ - { - actions: [ - "logs:CreateLogGroup", - "logs:CreateLogStream", - "logs:PutLogEvents", - ], - effect: "Allow", - resources: ["arn:aws:logs:*:*:*"], + const awsIamRolePolicyLambdaLogExport = new IamRolePolicy( + this, + "lambda_log_export_6", + { + policy: Token.asString(dataAwsIamPolicyDocumentLambdaLogExport.json), + role: logsLogExport.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.*/ + awsIamRolePolicyLambdaLogExport.overrideLogicalId("lambda_log_export"); + const awsCloudwatchLogSubscriptionFilterLambdaLogExport = + new CloudwatchLogSubscriptionFilter(this, "lambda_log_export_7", { + destinationArn: lambdaLogExport.arn, + filterPattern: "", + logGroupName: exportVar.name, + name: "${" + lambdaFunctionName + "}-filter", + roleArn: logsLogExport.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.*/ + awsCloudwatchLogSubscriptionFilterLambdaLogExport.overrideLogicalId( + "lambda_log_export" + ); + } +} + +``` + +### Function with Error Handling + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { Token, TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { LambdaFunction } from "./.gen/providers/aws/lambda-function"; +import { LambdaFunctionEventInvokeConfig } from "./.gen/providers/aws/lambda-function-event-invoke-config"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + const example = new LambdaFunction(this, "example", { + deadLetterConfig: { + targetArn: dlq.arn, + }, + filename: "function.zip", + functionName: "example_function", + handler: "index.handler", + role: Token.asString(awsIamRoleExample.arn), + runtime: "nodejs20.x", + }); + const awsLambdaFunctionEventInvokeConfigExample = + new LambdaFunctionEventInvokeConfig(this, "example_1", { + destinationConfig: { + onFailure: { + destination: dlq.arn, + }, + onSuccess: { + destination: success.arn, + }, }, - ], + functionName: example.functionName, + maximumEventAgeInSeconds: 60, + maximumRetryAttempts: 2, + }); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + awsLambdaFunctionEventInvokeConfigExample.overrideLogicalId("example"); + } +} + +``` + +### CloudWatch Logging and Permissions + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { + VariableType, + TerraformVariable, + Fn, + Token, + TerraformStack, +} from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { CloudwatchLogGroup } from "./.gen/providers/aws/cloudwatch-log-group"; +import { IamPolicy } from "./.gen/providers/aws/iam-policy"; +import { IamRole } from "./.gen/providers/aws/iam-role"; +import { IamRolePolicyAttachment } from "./.gen/providers/aws/iam-role-policy-attachment"; +import { LambdaFunction } from "./.gen/providers/aws/lambda-function"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + /*Terraform Variables are not always the best fit for getting inputs in the context of Terraform CDK. + You can read more about this at https://cdk.tf/variables*/ + const functionName = new TerraformVariable(this, "function_name", { + default: "example_function", + description: "Name of the Lambda function", + type: VariableType.STRING, + }); + const example = new CloudwatchLogGroup(this, "example", { + name: "/aws/lambda/${" + functionName.value + "}", + retentionInDays: 14, + tags: { + Environment: "production", + Function: functionName.stringValue, + }, }); - const awsIamPolicyLambdaLogging = new IamPolicy(this, "lambda_logging_3", { - description: "IAM policy for logging from a lambda", + const lambdaLogging = new IamPolicy(this, "lambda_logging", { + description: "IAM policy for logging from Lambda", name: "lambda_logging", path: "/", - policy: Token.asString(lambdaLogging.json), + policy: Token.asString( + Fn.jsonencode({ + Statement: [ + { + Action: [ + "logs:CreateLogGroup", + "logs:CreateLogStream", + "logs:PutLogEvents", + ], + Effect: "Allow", + Resource: ["arn:aws:logs:*:*:*"], + }, + ], + Version: "2012-10-17", + }) + ), + }); + const awsIamRoleExample = new IamRole(this, "example_3", { + assumeRolePolicy: Token.asString( + Fn.jsonencode({ + Statement: [ + { + Action: "sts:AssumeRole", + Effect: "Allow", + Principal: { + Service: "lambda.amazonaws.com", + }, + }, + ], + Version: "2012-10-17", + }) + ), + name: "lambda_execution_role", }); /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ - awsIamPolicyLambdaLogging.overrideLogicalId("lambda_logging"); + awsIamRoleExample.overrideLogicalId("example"); const lambdaLogs = new IamRolePolicyAttachment(this, "lambda_logs", { - policyArn: Token.asString(awsIamPolicyLambdaLogging.arn), - role: iamForLambda.name, + policyArn: lambdaLogging.arn, + role: Token.asString(awsIamRoleExample.name), }); - new LambdaFunction(this, "test_lambda", { + const awsLambdaFunctionExample = new LambdaFunction(this, "example_5", { dependsOn: [lambdaLogs, example], - functionName: lambdaFunctionName.stringValue, + filename: "function.zip", + functionName: functionName.stringValue, + handler: "index.handler", loggingConfig: { - logFormat: "Text", + applicationLogLevel: "INFO", + logFormat: "JSON", + systemLogLevel: "WARN", }, - role: config.role, + role: Token.asString(awsIamRoleExample.arn), + runtime: "nodejs20.x", }); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + awsLambdaFunctionExample.overrideLogicalId("example"); } } @@ -322,7 +617,7 @@ class MyConvertedCode extends TerraformStack { ## Specifying the Deployment Package -AWS Lambda expects source code to be provided as a deployment package whose structure varies depending on which `runtime` is in use. See [Runtimes][6] for the valid values of `runtime`. The expected structure of the deployment package can be found in [the AWS Lambda documentation for each runtime][8]. +AWS Lambda expects source code to be provided as a deployment package whose structure varies depending on which `runtime` is in use. See [Runtimes](https://docs.aws.amazon.com/lambda/latest/dg/API_CreateFunction.html#SSS-CreateFunction-request-Runtime) for the valid values of `runtime`. The expected structure of the deployment package can be found in [the AWS Lambda documentation for each runtime](https://docs.aws.amazon.com/lambda/latest/dg/deployment-package-v2.html). Once you have created your deployment package you can specify it either directly as a local file (using the `filename` argument) or indirectly via Amazon S3 (using the `s3Bucket`, `s3Key` and `s3ObjectVersion` arguments). When providing the deployment package via S3 it may be useful to use [the `aws_s3_object` resource](s3_object.html) to upload it. @@ -333,102 +628,85 @@ For larger deployment packages it is recommended by Amazon to upload via S3, sin The following arguments are required: * `functionName` - (Required) Unique name for your Lambda Function. -* `role` - (Required) Amazon Resource Name (ARN) of the function's execution role. The role provides the function's identity and access to AWS services and resources. +* `role` - (Required) ARN of the function's execution role. The role provides the function's identity and access to AWS services and resources. The following arguments are optional: -* `architectures` - (Optional) Instruction set architecture for your Lambda function. Valid values are `["x86_64"]` and `["arm64"]`. Default is `["x86_64"]`. Removing this attribute, function's architecture stay the same. -* `codeSigningConfigArn` - (Optional) To enable code signing for this function, specify the ARN of a code-signing configuration. A code-signing configuration includes a set of signing profiles, which define the trusted publishers for this function. -* `deadLetterConfig` - (Optional) Configuration block. Detailed below. +* `architectures` - (Optional) Instruction set architecture for your Lambda function. Valid values are `["x86_64"]` and `["arm64"]`. Default is `["x86_64"]`. Removing this attribute, function's architecture stays the same. +* `codeSigningConfigArn` - (Optional) ARN of a code-signing configuration to enable code signing for this function. +* `deadLetterConfig` - (Optional) Configuration block for dead letter queue. [See below](#dead_letter_config-configuration-block). * `description` - (Optional) Description of what your Lambda Function does. -* `environment` - (Optional) Configuration block. Detailed below. -* `ephemeralStorage` - (Optional) The amount of Ephemeral storage(`/tmp`) to allocate for the Lambda Function in MB. This parameter is used to expand the total amount of Ephemeral storage available, beyond the default amount of `512`MB. Detailed below. -* `fileSystemConfig` - (Optional) Configuration block. Detailed below. -* `filename` - (Optional) Path to the function's deployment package within the local filesystem. Exactly one of `filename`, `imageUri`, or `s3Bucket` must be specified. -* `handler` - (Optional) Function [entrypoint][3] in your code. -* `imageConfig` - (Optional) Configuration block. Detailed below. -* `imageUri` - (Optional) ECR image URI containing the function's deployment package. Exactly one of `filename`, `imageUri`, or `s3Bucket` must be specified. -* `kmsKeyArn` - (Optional) Amazon Resource Name (ARN) of the AWS Key Management Service (KMS) key that is used to encrypt environment variables. If this configuration is not provided when environment variables are in use, AWS Lambda uses a default service key. If this configuration is provided when environment variables are not in use, the AWS Lambda API does not save this configuration and Terraform will show a perpetual difference of adding the key. To fix the perpetual difference, remove this configuration. -* `layers` - (Optional) List of Lambda Layer Version ARNs (maximum of 5) to attach to your Lambda Function. See [Lambda Layers][10] -* `loggingConfig` - (Optional) Configuration block used to specify advanced logging settings. Detailed below. -* `memorySize` - (Optional) Amount of memory in MB your Lambda Function can use at runtime. Defaults to `128`. See [Limits][5] +* `environment` - (Optional) Configuration block for environment variables. [See below](#environment-configuration-block). +* `ephemeralStorage` - (Optional) Amount of ephemeral storage (`/tmp`) to allocate for the Lambda Function. [See below](#ephemeral_storage-configuration-block). +* `fileSystemConfig` - (Optional) Configuration block for EFS file system. [See below](#file_system_config-configuration-block). +* `filename` - (Optional) Path to the function's deployment package within the local filesystem. Conflicts with `imageUri` and `s3Bucket`. One of `filename`, `imageUri`, or `s3Bucket` must be specified. +* `handler` - (Optional) Function entry point in your code. Required if `packageType` is `Zip`. +* `imageConfig` - (Optional) Container image configuration values. [See below](#image_config-configuration-block). +* `imageUri` - (Optional) ECR image URI containing the function's deployment package. Conflicts with `filename` and `s3Bucket`. One of `filename`, `imageUri`, or `s3Bucket` must be specified. +* `kmsKeyArn` - (Optional) ARN of the AWS Key Management Service key used to encrypt environment variables. If not provided when environment variables are in use, AWS Lambda uses a default service key. If provided when environment variables are not in use, the AWS Lambda API does not save this configuration. +* `layers` - (Optional) List of Lambda Layer Version ARNs (maximum of 5) to attach to your Lambda Function. +* `loggingConfig` - (Optional) Configuration block for advanced logging settings. [See below](#logging_config-configuration-block). +* `memorySize` - (Optional) Amount of memory in MB your Lambda Function can use at runtime. Valid value between 128 MB to 10,240 MB (10 GB), in 1 MB increments. Defaults to 128. * `packageType` - (Optional) Lambda deployment package type. Valid values are `Zip` and `Image`. Defaults to `Zip`. * `publish` - (Optional) Whether to publish creation/change as new Lambda Function Version. Defaults to `false`. -* `reservedConcurrentExecutions` - (Optional) Amount of reserved concurrent executions for this lambda function. A value of `0` disables lambda from being triggered and `-1` removes any concurrency limitations. Defaults to Unreserved Concurrency Limits `-1`. See [Managing Concurrency][9] -* `replaceSecurityGroupsOnDestroy` - (Optional) Whether to replace the security groups on the function's VPC configuration prior to destruction. -Removing these security group associations prior to function destruction can speed up security group deletion times of AWS's internal cleanup operations. -By default, the security groups will be replaced with the `default` security group in the function's configured VPC. -Set the `replacementSecurityGroupIds` attribute to use a custom list of security groups for replacement. -* `replacementSecurityGroupIds` - (Optional) List of security group IDs to assign to the function's VPC configuration prior to destruction. -`replaceSecurityGroupsOnDestroy` must be set to `true` to use this attribute. -* `runtime` - (Optional) Identifier of the function's runtime. See [Runtimes][6] for valid values. -* `s3Bucket` - (Optional) S3 bucket location containing the function's deployment package. This bucket must reside in the same AWS region where you are creating the Lambda function. Exactly one of `filename`, `imageUri`, or `s3Bucket` must be specified. When `s3Bucket` is set, `s3Key` is required. -* `s3Key` - (Optional) S3 key of an object containing the function's deployment package. When `s3Bucket` is set, `s3Key` is required. +* `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). +* `replaceSecurityGroupsOnDestroy` - (Optional) Whether to replace the security groups on the function's VPC configuration prior to destruction. Default is `false`. +* `replacementSecurityGroupIds` - (Optional) List of security group IDs to assign to the function's VPC configuration prior to destruction. Required if `replaceSecurityGroupsOnDestroy` is `true`. +* `reservedConcurrentExecutions` - (Optional) Amount of reserved concurrent executions for this lambda function. A value of `0` disables lambda from being triggered and `-1` removes any concurrency limitations. Defaults to Unreserved Concurrency Limits `-1`. +* `runtime` - (Optional) Identifier of the function's runtime. Required if `packageType` is `Zip`. See [Runtimes](https://docs.aws.amazon.com/lambda/latest/dg/API_CreateFunction.html#SSS-CreateFunction-request-Runtime) for valid values. +* `s3Bucket` - (Optional) S3 bucket location containing the function's deployment package. Conflicts with `filename` and `imageUri`. One of `filename`, `imageUri`, or `s3Bucket` must be specified. +* `s3Key` - (Optional) S3 key of an object containing the function's deployment package. Required if `s3Bucket` is set. * `s3ObjectVersion` - (Optional) Object version containing the function's deployment package. Conflicts with `filename` and `imageUri`. -* `skipDestroy` - (Optional) Set to true if you do not wish the function to be deleted at destroy time, and instead just remove the function from the Terraform state. -* `sourceCodeHash` - (Optional) Virtual attribute used to trigger replacement when source code changes. Must be set to a base64-encoded SHA256 hash of the package file specified with either `filename` or `s3Key`. The usual way to set this is `filebase64sha256("file.zip")` (Terraform 0.11.12 and later) or `base64sha256(file("file.zip"))` (Terraform 0.11.11 and earlier), where "file.zip" is the local filename of the lambda function source archive. -* `snapStart` - (Optional) Snap start settings block. Detailed below. -* `tags` - (Optional) Map of tags to assign to the object. If configured with a provider [`defaultTags` 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) Amount of time your Lambda Function has to run in seconds. Defaults to `3`. See [Limits][5]. -* `tracingConfig` - (Optional) Configuration block. Detailed below. -* `vpcConfig` - (Optional) Configuration block. Detailed below. - -### dead_letter_config - -Dead letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing. For more information, see [Dead Letter Queues](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#dlq). - -* `targetArn` - (Required) ARN of an SNS topic or SQS queue to notify when an invocation fails. If this option is used, the function's IAM role must be granted suitable access to write to the target object, which means allowing either the `sns:Publish` or `sqs:SendMessage` action on this ARN, depending on which service is targeted. - -### environment +* `skipDestroy` - (Optional) Whether to retain the old version of a previously deployed Lambda Layer. Default is `false`. +* `snapStart` - (Optional) Configuration block for snap start settings. [See below](#snap_start-configuration-block). +* `sourceCodeHash` - (Optional) Base64-encoded SHA256 hash of the package file. Used to trigger updates when source code changes. +* `source_kms_key_arn` - (Optional) ARN of the AWS Key Management Service key used to encrypt the function's `.zip` deployment package. Conflicts with `imageUri`. +* `tags` - (Optional) Key-value map of tags for the Lambda function. If configured with a provider [`defaultTags` 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) Amount of time your Lambda Function has to run in seconds. Defaults to 3. Valid between 1 and 900. +* `tracingConfig` - (Optional) Configuration block for X-Ray tracing. [See below](#tracing_config-configuration-block). +* `vpcConfig` - (Optional) Configuration block for VPC. [See below](#vpc_config-configuration-block). -* `variables` - (Optional) Map of environment variables that are accessible from the function code during execution. If provided at least one key must be present. +### dead_letter_config Configuration Block -### ephemeral_storage +* `targetArn` - (Required) ARN of an SNS topic or SQS queue to notify when an invocation fails. -* `size` - (Required) The size of the Lambda function Ephemeral storage(`/tmp`) represented in MB. The minimum supported `ephemeralStorage` value defaults to `512`MB and the maximum supported value is `10240`MB. +### environment Configuration Block -### file_system_config +* `variables` - (Optional) Map of environment variables available to your Lambda function during execution. -Connection settings for an EFS file system. Before creating or updating Lambda functions with `fileSystemConfig`, EFS mount targets must be in available lifecycle state. Use `dependsOn` to explicitly declare this dependency. See [Using Amazon EFS with Lambda][12]. +### ephemeral_storage Configuration Block -* `arn` - (Required) Amazon Resource Name (ARN) of the Amazon EFS Access Point that provides access to the file system. -* `localMountPath` - (Required) Path where the function can access the file system, starting with /mnt/. +* `size` - (Required) Amount of ephemeral storage (`/tmp`) in MB. Valid between 512 MB and 10,240 MB (10 GB). -### image_config +### file_system_config Configuration Block -Container image configuration values that override the values in the container image Dockerfile. +* `arn` - (Required) ARN of the Amazon EFS Access Point. +* `localMountPath` - (Required) Path where the function can access the file system. Must start with `/mnt/`. -* `command` - (Optional) Parameters that you want to pass in with `entryPoint`. -* `entryPoint` - (Optional) Entry point to your application, which is typically the location of the runtime executable. -* `workingDirectory` - (Optional) Working directory. +### image_config Configuration Block -### logging_config +* `command` - (Optional) Parameters to pass to the container image. +* `entryPoint` - (Optional) Entry point to your application. +* `workingDirectory` - (Optional) Working directory for the container image. -Advanced logging settings. See [Configuring advanced logging controls for your Lambda function][13]. +### logging_config Configuration Block -* `applicationLogLevel` - (Optional) for JSON structured logs, choose the detail level of the logs your application sends to CloudWatch when using supported logging libraries. -* `logFormat` - (Required) select between `Text` and structured `JSON` format for your function's logs. -* `logGroup` - (Optional) the CloudWatch log group your function sends logs to. -* `systemLogLevel` - (optional) for JSON structured logs, choose the detail level of the Lambda platform event logs sent to CloudWatch, such as `WARN`, `DEBUG`, or `INFO`. +* `applicationLogLevel` - (Optional) Detail level of application logs. Valid values: `TRACE`, `DEBUG`, `INFO`, `WARN`, `ERROR`, `FATAL`. +* `logFormat` - (Required) Log format. Valid values: `Text`, `JSON`. +* `logGroup` - (Optional) CloudWatch log group where logs are sent. +* `systemLogLevel` - (Optional) Detail level of Lambda platform logs. Valid values: `DEBUG`, `INFO`, `WARN`. -### snap_start +### snap_start Configuration Block -Snap start settings for low-latency startups. This feature is currently only supported for specific runtimes, see [Supported features and limitations][14]. -Remove this block to delete the associated settings (rather than setting `apply_on = "None"`). +* `applyOn` - (Required) When to apply snap start optimization. Valid value: `PublishedVersions`. -* `applyOn` - (Required) Conditions where snap start is enabled. Valid values are `PublishedVersions`. +### tracing_config Configuration Block -### tracing_config +* `mode` - (Required) X-Ray tracing mode. Valid values: `Active`, `PassThrough`. -* `mode` - (Required) Whether to sample and trace a subset of incoming requests with AWS X-Ray. Valid values are `PassThrough` and `Active`. If `PassThrough`, Lambda will only trace the request from an upstream service if it contains a tracing header with "sampled=1". If `Active`, Lambda will respect any tracing header it receives from an upstream service. If no tracing header is received, Lambda will call X-Ray for a tracing decision. +### vpc_config Configuration Block -### vpc_config - -For network connectivity to AWS resources in a VPC, specify a list of security groups and subnets in the VPC. When you connect a function to a VPC, it can only access resources and the internet through that VPC. See [VPC Settings][7]. - -~> **NOTE:** If `subnetIds`, `securityGroupIds` and `ipv6AllowedForDualStack` are empty then `vpcConfig` is considered to be empty or unset. - -* `ipv6AllowedForDualStack` - (Optional) Allows outbound IPv6 traffic on VPC functions that are connected to dual-stack subnets. Default is `false`. +* `ipv6AllowedForDualStack` - (Optional) Whether to allow outbound IPv6 traffic on VPC functions connected to dual-stack subnets. Default: `false`. * `securityGroupIds` - (Required) List of security group IDs associated with the Lambda function. * `subnetIds` - (Required) List of subnet IDs associated with the Lambda function. @@ -436,34 +714,20 @@ For network connectivity to AWS resources in a VPC, specify a list of security g This resource exports the following attributes in addition to the arguments above: -* `arn` - Amazon Resource Name (ARN) identifying your Lambda Function. +* `arn` - ARN identifying your Lambda Function. * `codeSha256` - Base64-encoded representation of raw SHA-256 sum of the zip file. -* `invokeArn` - ARN to be used for invoking Lambda Function from API Gateway - to be used in [`aws_api_gateway_integration`](/docs/providers/aws/r/api_gateway_integration.html)'s `uri`. +* `invokeArn` - ARN to be used for invoking Lambda Function from API Gateway - to be used in [`aws_api_gateway_integration`](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/api_gateway_integration)'s `uri`. * `lastModified` - Date this resource was last modified. * `qualifiedArn` - ARN identifying your Lambda Function Version (if versioning is enabled via `publish = true`). -* `qualifiedInvokeArn` - Qualified ARN (ARN with lambda version number) to be used for invoking Lambda Function from API Gateway - to be used in [`aws_api_gateway_integration`](/docs/providers/aws/r/api_gateway_integration.html)'s `uri`. +* `qualifiedInvokeArn` - Qualified ARN (ARN with lambda version number) to be used for invoking Lambda Function from API Gateway - to be used in [`aws_api_gateway_integration`](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/api_gateway_integration)'s `uri`. * `signingJobArn` - ARN of the signing job. * `signingProfileVersionArn` - ARN of the signing profile version. * `snap_start.optimization_status` - Optimization status of the snap start configuration. Valid values are `On` and `Off`. * `sourceCodeSize` - Size in bytes of the function .zip file. -* `tagsAll` - A map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). +* `tagsAll` - Map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). * `version` - Latest published version of your Lambda Function. * `vpc_config.vpc_id` - ID of the VPC. -[1]: https://docs.aws.amazon.com/lambda/latest/dg/welcome.html -[3]: https://docs.aws.amazon.com/lambda/latest/dg/walkthrough-custom-events-create-test-function.html -[4]: https://docs.aws.amazon.com/lambda/latest/dg/intro-permission-model.html -[5]: https://docs.aws.amazon.com/lambda/latest/dg/limits.html -[6]: https://docs.aws.amazon.com/lambda/latest/dg/API_CreateFunction.html#SSS-CreateFunction-request-Runtime -[7]: https://docs.aws.amazon.com/lambda/latest/dg/configuration-vpc.html -[8]: https://docs.aws.amazon.com/lambda/latest/dg/deployment-package-v2.html -[9]: https://docs.aws.amazon.com/lambda/latest/dg/concurrent-executions.html -[10]: https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html -[11]: https://learn.hashicorp.com/terraform/aws/lambda-api-gateway -[12]: https://docs.aws.amazon.com/lambda/latest/dg/services-efs.html -[13]: https://docs.aws.amazon.com/lambda/latest/dg/monitoring-cloudwatchlogs.html#monitoring-cloudwatchlogs-advanced -[14]: https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html#snapstart-runtimes - ## Timeouts [Configuration options](https://developer.hashicorp.com/terraform/language/resources/syntax#operation-timeouts): @@ -488,11 +752,7 @@ import { LambdaFunction } from "./.gen/providers/aws/lambda-function"; class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); - LambdaFunction.generateConfigForImport( - this, - "testLambda", - "my_test_lambda_function" - ); + LambdaFunction.generateConfigForImport(this, "example", "example"); } } @@ -501,7 +761,7 @@ class MyConvertedCode extends TerraformStack { Using `terraform import`, import Lambda Functions using the `functionName`. For example: ```console -% terraform import aws_lambda_function.test_lambda my_test_lambda_function +% terraform import aws_lambda_function.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/lambda_function_event_invoke_config.html.markdown b/website/docs/cdktf/typescript/r/lambda_function_event_invoke_config.html.markdown index 4560e6e493fb..666775f8df03 100644 --- a/website/docs/cdktf/typescript/r/lambda_function_event_invoke_config.html.markdown +++ b/website/docs/cdktf/typescript/r/lambda_function_event_invoke_config.html.markdown @@ -3,20 +3,22 @@ subcategory: "Lambda" layout: "aws" page_title: "AWS: aws_lambda_function_event_invoke_config" description: |- - Manages an asynchronous invocation configuration for a Lambda Function or Alias. + Manages an AWS Lambda Function Event Invoke Config. --- # Resource: aws_lambda_function_event_invoke_config -Manages an asynchronous invocation configuration for a Lambda Function or Alias. More information about asynchronous invocations and the configurable values can be found in the [Lambda Developer Guide](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html). +Manages an AWS Lambda Function Event Invoke Config. Use this resource to configure error handling and destinations for asynchronous Lambda function invocations. + +More information about asynchronous invocations and the configurable values can be found in the [Lambda Developer Guide](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html). ## Example Usage -### Destination Configuration +### Complete Error Handling and Destinations -~> **NOTE:** Ensure the Lambda Function IAM Role has necessary permissions for the destination, such as `sqs:SendMessage` or `sns:Publish`, otherwise the API will return a generic `InvalidParameterValueException: The destination ARN arn:PARTITION:SERVICE:REGION:ACCOUNT:RESOURCE is invalid.` error. +~> **Note:** Ensure the Lambda Function IAM Role has necessary permissions for the destination, such as `sqs:SendMessage` or `sns:Publish`, otherwise the API will return a generic `InvalidParameterValueException: The destination ARN arn:PARTITION:SERVICE:REGION:ACCOUNT:RESOURCE is invalid.` error. ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -27,26 +29,44 @@ import { Token, TerraformStack } from "cdktf"; * See https://cdk.tf/provider-generation for more details. */ import { LambdaFunctionEventInvokeConfig } from "./.gen/providers/aws/lambda-function-event-invoke-config"; +import { SnsTopic } from "./.gen/providers/aws/sns-topic"; +import { SqsQueue } from "./.gen/providers/aws/sqs-queue"; class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); + const success = new SnsTopic(this, "success", { + name: "lambda-success-notifications", + tags: { + Environment: "production", + Purpose: "lambda-success-notifications", + }, + }); + const dlq = new SqsQueue(this, "dlq", { + name: "lambda-dlq", + tags: { + Environment: "production", + Purpose: "lambda-error-handling", + }, + }); new LambdaFunctionEventInvokeConfig(this, "example", { destinationConfig: { onFailure: { - destination: Token.asString(awsSqsQueueExample.arn), + destination: dlq.arn, }, onSuccess: { - destination: Token.asString(awsSnsTopicExample.arn), + destination: success.arn, }, }, - functionName: Token.asString(awsLambdaAliasExample.functionName), + functionName: Token.asString(awsLambdaFunctionExample.functionName), + maximumEventAgeInSeconds: 300, + maximumRetryAttempts: 1, }); } } ``` -### Error Handling Configuration +### Error Handling Only ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -61,7 +81,7 @@ class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); new LambdaFunctionEventInvokeConfig(this, "example", { - functionName: Token.asString(awsLambdaAliasExample.functionName), + functionName: Token.asString(awsLambdaFunctionExample.functionName), maximumEventAgeInSeconds: 60, maximumRetryAttempts: 0, }); @@ -70,7 +90,47 @@ class MyConvertedCode extends TerraformStack { ``` -### Configuration for Alias Name +### Configuration for Lambda Alias + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { Token, TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { LambdaAlias } from "./.gen/providers/aws/lambda-alias"; +import { LambdaFunctionEventInvokeConfig } from "./.gen/providers/aws/lambda-function-event-invoke-config"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + const example = new LambdaAlias(this, "example", { + description: "Production alias", + functionName: Token.asString(awsLambdaFunctionExample.functionName), + functionVersion: Token.asString(awsLambdaFunctionExample.version), + name: "production", + }); + const awsLambdaFunctionEventInvokeConfigExample = + new LambdaFunctionEventInvokeConfig(this, "example_1", { + destinationConfig: { + onFailure: { + destination: productionDlq.arn, + }, + }, + functionName: Token.asString(awsLambdaFunctionExample.functionName), + maximumEventAgeInSeconds: 1800, + maximumRetryAttempts: 2, + qualifier: example.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.*/ + awsLambdaFunctionEventInvokeConfigExample.overrideLogicalId("example"); + } +} + +``` + +### Configuration for Published Version ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -85,15 +145,25 @@ class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); new LambdaFunctionEventInvokeConfig(this, "example", { - functionName: Token.asString(awsLambdaAliasExample.functionName), - qualifier: Token.asString(awsLambdaAliasExample.name), + destinationConfig: { + onFailure: { + destination: versionDlq.arn, + }, + onSuccess: { + destination: versionSuccess.arn, + }, + }, + functionName: Token.asString(awsLambdaFunctionExample.functionName), + maximumEventAgeInSeconds: 21600, + maximumRetryAttempts: 2, + qualifier: Token.asString(awsLambdaFunctionExample.version), }); } } ``` -### Configuration for Function Latest Unpublished Version +### Configuration for Latest Version ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -108,7 +178,14 @@ class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); new LambdaFunctionEventInvokeConfig(this, "example", { + destinationConfig: { + onFailure: { + destination: devDlq.arn, + }, + }, functionName: Token.asString(awsLambdaFunctionExample.functionName), + maximumEventAgeInSeconds: 120, + maximumRetryAttempts: 0, qualifier: "$LATEST", }); } @@ -116,7 +193,7 @@ class MyConvertedCode extends TerraformStack { ``` -### Configuration for Function Published Version +### Multiple Destination Types ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -126,13 +203,28 @@ import { Token, TerraformStack } from "cdktf"; * Provider bindings are generated by running `cdktf get`. * See https://cdk.tf/provider-generation for more details. */ +import { CloudwatchEventBus } from "./.gen/providers/aws/cloudwatch-event-bus"; import { LambdaFunctionEventInvokeConfig } from "./.gen/providers/aws/lambda-function-event-invoke-config"; +import { S3Bucket } from "./.gen/providers/aws/s3-bucket"; class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); + const lambdaFailures = new CloudwatchEventBus(this, "lambda_failures", { + name: "lambda-failure-events", + }); + const lambdaSuccessArchive = new S3Bucket(this, "lambda_success_archive", { + bucket: "lambda-success-archive-${" + bucketSuffix.hex + "}", + }); new LambdaFunctionEventInvokeConfig(this, "example", { + destinationConfig: { + onFailure: { + destination: lambdaFailures.arn, + }, + onSuccess: { + destination: lambdaSuccessArchive.arn, + }, + }, functionName: Token.asString(awsLambdaFunctionExample.functionName), - qualifier: Token.asString(awsLambdaFunctionExample.version), }); } } @@ -143,45 +235,40 @@ class MyConvertedCode extends TerraformStack { The following arguments are required: -* `functionName` - (Required) Name or Amazon Resource Name (ARN) of the Lambda Function, omitting any version or alias qualifier. +* `functionName` - (Required) Name or ARN of the Lambda Function, omitting any version or alias qualifier. The following arguments are optional: -* `destinationConfig` - (Optional) Configuration block with destination configuration. See below for details. +* `destinationConfig` - (Optional) Configuration block with destination configuration. [See below](#destination_config-configuration-block). * `maximumEventAgeInSeconds` - (Optional) Maximum age of a request that Lambda sends to a function for processing in seconds. Valid values between 60 and 21600. * `maximumRetryAttempts` - (Optional) Maximum number of times to retry when the function returns an error. Valid values between 0 and 2. Defaults to 2. * `qualifier` - (Optional) Lambda Function published version, `$LATEST`, or Lambda Alias name. +* `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). ### destination_config Configuration Block -~> **NOTE:** At least one of `onFailure` or `onSuccess` must be configured when using this configuration block, otherwise remove it completely to prevent perpetual differences in Terraform runs. - -The following arguments are optional: +~> **Note:** At least one of `onFailure` or `onSuccess` must be configured when using this configuration block, otherwise remove it completely to prevent perpetual differences in Terraform runs. -* `onFailure` - (Optional) Configuration block with destination configuration for failed asynchronous invocations. See below for details. -* `onSuccess` - (Optional) Configuration block with destination configuration for successful asynchronous invocations. See below for details. +* `onFailure` - (Optional) Configuration block with destination configuration for failed asynchronous invocations. [See below](#destination_config-on_failure-configuration-block). +* `onSuccess` - (Optional) Configuration block with destination configuration for successful asynchronous invocations. [See below](#destination_config-on_success-configuration-block). #### destination_config on_failure Configuration Block -The following arguments are required: - -* `destination` - (Required) Amazon Resource Name (ARN) of the destination resource. See the [Lambda Developer Guide](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#invocation-async-destinations) for acceptable resource types and associated IAM permissions. +* `destination` - (Required) ARN of the destination resource. See the [Lambda Developer Guide](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#invocation-async-destinations) for acceptable resource types and associated IAM permissions. #### destination_config on_success Configuration Block -The following arguments are required: - -* `destination` - (Required) Amazon Resource Name (ARN) of the destination resource. See the [Lambda Developer Guide](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#invocation-async-destinations) for acceptable resource types and associated IAM permissions. +* `destination` - (Required) ARN of the destination resource. See the [Lambda Developer Guide](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#invocation-async-destinations) for acceptable resource types and associated IAM permissions. ## Attribute Reference This resource exports the following attributes in addition to the arguments above: -* `id` - Fully qualified Lambda Function name or Amazon Resource Name (ARN) +* `id` - Fully qualified Lambda Function name or ARN. ## Import -In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import Lambda Function Event Invoke Configs using the fully qualified Function name or Amazon Resource Name (ARN). For example: +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import Lambda Function Event Invoke Configs using the fully qualified Function name or ARN. For example: ARN without qualifier (all versions and aliases): @@ -200,7 +287,7 @@ class MyConvertedCode extends TerraformStack { LambdaFunctionEventInvokeConfig.generateConfigForImport( this, "example", - "arn:aws:us-east-1:123456789012:function:my_function" + "arn:aws:lambda:us-east-1:123456789012:function:example" ); } } @@ -224,7 +311,7 @@ class MyConvertedCode extends TerraformStack { LambdaFunctionEventInvokeConfig.generateConfigForImport( this, "example", - "arn:aws:us-east-1:123456789012:function:my_function:production" + "arn:aws:lambda:us-east-1:123456789012:function:example:production" ); } } @@ -248,7 +335,7 @@ class MyConvertedCode extends TerraformStack { LambdaFunctionEventInvokeConfig.generateConfigForImport( this, "example", - "my_function" + "example" ); } } @@ -272,37 +359,37 @@ class MyConvertedCode extends TerraformStack { LambdaFunctionEventInvokeConfig.generateConfigForImport( this, "example", - "my_function:production" + "example:production" ); } } ``` -**Using `terraform import` to import** Lambda Function Event Invoke Configs using the fully qualified Function name or Amazon Resource Name (ARN). For example: +For backwards compatibility, the following legacy `terraform import` commands are also supported: -ARN without qualifier (all versions and aliases): +Using ARN without qualifier: ```console -% terraform import aws_lambda_function_event_invoke_config.example arn:aws:us-east-1:123456789012:function:my_function +% terraform import aws_lambda_function_event_invoke_config.example arn:aws:lambda:us-east-1:123456789012:function:example ``` -ARN with qualifier: +Using ARN with qualifier: ```console -% terraform import aws_lambda_function_event_invoke_config.example arn:aws:us-east-1:123456789012:function:my_function:production +% terraform import aws_lambda_function_event_invoke_config.example arn:aws:lambda:us-east-1:123456789012:function:example:production ``` Name without qualifier (all versions and aliases): ```console -% terraform import aws_lambda_function_event_invoke_config.example my_function +% terraform import aws_lambda_function_event_invoke_config.example example ``` Name with qualifier: ```console -% terraform import aws_lambda_function_event_invoke_config.example my_function:production +% terraform import aws_lambda_function_event_invoke_config.example example:production ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/lambda_function_recursion_config.html.markdown b/website/docs/cdktf/typescript/r/lambda_function_recursion_config.html.markdown index 41d2b64061b6..48e2e97b4144 100644 --- a/website/docs/cdktf/typescript/r/lambda_function_recursion_config.html.markdown +++ b/website/docs/cdktf/typescript/r/lambda_function_recursion_config.html.markdown @@ -3,19 +3,55 @@ subcategory: "Lambda" layout: "aws" page_title: "AWS: aws_lambda_function_recursion_config" description: |- - Terraform resource for managing an AWS Lambda Function Recursion Config. + Manages an AWS Lambda Function Recursion Config. --- # Resource: aws_lambda_function_recursion_config -Terraform resource for managing an AWS Lambda Function Recursion Config. +Manages an AWS Lambda Function Recursion Config. Use this resource to control how Lambda handles recursive function invocations to prevent infinite loops. -~> Destruction of this resource will return the `recursiveLoop` configuration back to the default value of `Terminate`. +~> **Note:** Destruction of this resource will return the `recursiveLoop` configuration back to the default value of `Terminate`. ## Example Usage +### Allow Recursive Invocations + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { LambdaFunction } from "./.gen/providers/aws/lambda-function"; +import { LambdaFunctionRecursionConfig } from "./.gen/providers/aws/lambda-function-recursion-config"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + const example = new LambdaFunction(this, "example", { + filename: "function.zip", + functionName: "recursive_processor", + handler: "index.handler", + role: lambdaRole.arn, + runtime: "python3.12", + }); + const awsLambdaFunctionRecursionConfigExample = + new LambdaFunctionRecursionConfig(this, "example_1", { + functionName: example.functionName, + recursiveLoop: "Allow", + }); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + awsLambdaFunctionRecursionConfigExample.overrideLogicalId("example"); + } +} + +``` + +### Production Safety Configuration + ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug import { Construct } from "constructs"; @@ -24,13 +60,29 @@ import { TerraformStack } from "cdktf"; * Provider bindings are generated by running `cdktf get`. * See https://cdk.tf/provider-generation for more details. */ +import { LambdaFunction } from "./.gen/providers/aws/lambda-function"; import { LambdaFunctionRecursionConfig } from "./.gen/providers/aws/lambda-function-recursion-config"; class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); + const productionProcessor = new LambdaFunction( + this, + "production_processor", + { + filename: "processor.zip", + functionName: "production-data-processor", + handler: "app.handler", + role: lambdaRole.arn, + runtime: "nodejs20.x", + tags: { + Environment: "production", + Purpose: "data-processing", + }, + } + ); new LambdaFunctionRecursionConfig(this, "example", { - functionName: "SomeFunction", - recursiveLoop: "Allow", + functionName: productionProcessor.functionName, + recursiveLoop: "Terminate", }); } } @@ -41,16 +93,20 @@ class MyConvertedCode extends TerraformStack { The following arguments are required: -* `functionName` - (Required) Lambda function name. +* `functionName` - (Required) Name of the Lambda function. * `recursiveLoop` - (Required) Lambda function recursion configuration. Valid values are `Allow` or `Terminate`. +The following arguments are optional: + +* `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). + ## 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 AWS Lambda Function Recursion Config using the `functionName`. For example: +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import Lambda Function Recursion Config using the `functionName`. For example: ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -67,17 +123,17 @@ class MyConvertedCode extends TerraformStack { LambdaFunctionRecursionConfig.generateConfigForImport( this, "example", - "SomeFunction" + "recursive_processor" ); } } ``` -Using `terraform import`, import AWS Lambda Function Recursion Config using the `functionName`. For example: +For backwards compatibility, the following legacy `terraform import` command is also supported: ```console -% terraform import aws_lambda_function_recursion_config.example SomeFunction +% terraform import aws_lambda_function_recursion_config.example recursive_processor ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/lambda_function_url.html.markdown b/website/docs/cdktf/typescript/r/lambda_function_url.html.markdown index 2887ef763de0..7c86dc47fe99 100644 --- a/website/docs/cdktf/typescript/r/lambda_function_url.html.markdown +++ b/website/docs/cdktf/typescript/r/lambda_function_url.html.markdown @@ -2,24 +2,23 @@ subcategory: "Lambda" layout: "aws" page_title: "AWS: aws_lambda_function_url" -description: |- - Provides a Lambda function URL resource. +description: Manages a Lambda function URL. --- # Resource: aws_lambda_function_url -Provides a Lambda function URL resource. A function URL is a dedicated HTTP(S) endpoint for a Lambda function. - -See the [AWS Lambda documentation](https://docs.aws.amazon.com/lambda/latest/dg/lambda-urls.html) for more information. +Manages a Lambda function URL. Creates a dedicated HTTP(S) endpoint for a Lambda function to enable direct invocation via HTTP requests. ## Example Usage +### Basic Function URL with No Authentication + ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug import { Construct } from "constructs"; -import { TerraformStack } from "cdktf"; +import { Token, TerraformStack } from "cdktf"; /* * Provider bindings are generated by running `cdktf get`. * See https://cdk.tf/provider-generation for more details. @@ -28,21 +27,41 @@ import { LambdaFunctionUrl } from "./.gen/providers/aws/lambda-function-url"; class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); - new LambdaFunctionUrl(this, "test_latest", { + new LambdaFunctionUrl(this, "example", { authorizationType: "NONE", - functionName: test.functionName, + functionName: Token.asString(awsLambdaFunctionExample.functionName), }); - new LambdaFunctionUrl(this, "test_live", { + } +} + +``` + +### Function URL with IAM Authentication and CORS Configuration + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { Token, TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { LambdaFunctionUrl } from "./.gen/providers/aws/lambda-function-url"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + new LambdaFunctionUrl(this, "example", { authorizationType: "AWS_IAM", cors: { allowCredentials: true, allowHeaders: ["date", "keep-alive"], - allowMethods: ["*"], - allowOrigins: ["*"], + allowMethods: ["GET", "POST"], + allowOrigins: ["https://example.com"], exposeHeaders: ["keep-alive", "date"], maxAge: 86400, }, - functionName: test.functionName, + functionName: Token.asString(awsLambdaFunctionExample.functionName), + invokeMode: "RESPONSE_STREAM", qualifier: "my_alias", }); } @@ -52,32 +71,40 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -This resource supports the following arguments: +The following arguments are required: + +* `authorizationType` - (Required) Type of authentication that the function URL uses. Valid values are `AWS_IAM` and `NONE`. +* `functionName` - (Required) Name or ARN of the Lambda function. -* `authorizationType` - (Required) The type of authentication that the function URL uses. Set to `"AWS_IAM"` to restrict access to authenticated IAM users only. Set to `"NONE"` to bypass IAM authentication and create a public endpoint. See the [AWS documentation](https://docs.aws.amazon.com/lambda/latest/dg/urls-auth.html) for more details. -* `cors` - (Optional) The [cross-origin resource sharing (CORS)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) settings for the function URL. Documented below. -* `functionName` - (Required) The name (or ARN) of the Lambda function. -* `invokeMode` - (Optional) Determines how the Lambda function responds to an invocation. Valid values are `BUFFERED` (default) and `RESPONSE_STREAM`. See more in [Configuring a Lambda function to stream responses](https://docs.aws.amazon.com/lambda/latest/dg/configuration-response-streaming.html). -* `qualifier` - (Optional) The alias name or `"$LATEST"`. +The following arguments are optional: -### cors +* `cors` - (Optional) Cross-origin resource sharing (CORS) settings for the function URL. [See below](#cors). +* `invokeMode` - (Optional) How the Lambda function responds to an invocation. Valid values are `BUFFERED` (default) and `RESPONSE_STREAM`. +* `qualifier` - (Optional) Alias name or `$LATEST`. +* `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). -This configuration block supports the following attributes: +### CORS -* `allowCredentials` - (Optional) Whether to allow cookies or other credentials in requests to the function URL. The default is `false`. -* `allowHeaders` - (Optional) The HTTP headers that origins can include in requests to the function URL. For example: `["date", "keep-alive", "x-custom-header"]`. -* `allowMethods` - (Optional) The HTTP methods that are allowed when calling the function URL. For example: `["GET", "POST", "DELETE"]`, or the wildcard character (`["*"]`). -* `allowOrigins` - (Optional) The origins that can access the function URL. You can list any number of specific origins (or the wildcard character (`"*"`)), separated by a comma. For example: `["https://www.example.com", "http://localhost:60905"]`. -* `exposeHeaders` - (Optional) The HTTP headers in your function response that you want to expose to origins that call the function URL. -* `maxAge` - (Optional) The maximum amount of time, in seconds, that web browsers can cache results of a preflight request. By default, this is set to `0`, which means that the browser doesn't cache results. The maximum value is `86400`. +* `allowCredentials` - (Optional) Whether to allow cookies or other credentials in requests to the function URL. +* `allowHeaders` - (Optional) HTTP headers that origins can include in requests to the function URL. +* `allowMethods` - (Optional) HTTP methods that are allowed when calling the function URL. +* `allowOrigins` - (Optional) Origins that can access the function URL. +* `exposeHeaders` - (Optional) HTTP headers in your function response that you want to expose to origins that call the function URL. +* `maxAge` - (Optional) Maximum amount of time, in seconds, that web browsers can cache results of a preflight request. Maximum value is `86400`. ## Attribute Reference This resource exports the following attributes in addition to the arguments above: -* `functionArn` - The Amazon Resource Name (ARN) of the function. -* `functionUrl` - The HTTP URL endpoint for the function in the format `https://.lambda-url..on.aws/`. -* `urlId` - A generated ID for the endpoint. +* `functionArn` - ARN of the Lambda function. +* `functionUrl` - HTTP URL endpoint for the function in the format `https://.lambda-url..on.aws/`. +* `urlId` - Generated ID for the endpoint. + +## Timeouts + +[Configuration options](https://developer.hashicorp.com/terraform/language/resources/syntax#operation-timeouts): + +* `create` - (Default `10m`) ## Import @@ -95,11 +122,7 @@ import { LambdaFunctionUrl } from "./.gen/providers/aws/lambda-function-url"; class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); - LambdaFunctionUrl.generateConfigForImport( - this, - "testLambdaUrl", - "my_test_lambda_function" - ); + LambdaFunctionUrl.generateConfigForImport(this, "example", "example"); } } @@ -108,7 +131,7 @@ class MyConvertedCode extends TerraformStack { Using `terraform import`, import Lambda function URLs using the `functionName` or `function_name/qualifier`. For example: ```console -% terraform import aws_lambda_function_url.test_lambda_url my_test_lambda_function +% terraform import aws_lambda_function_url.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/lambda_invocation.html.markdown b/website/docs/cdktf/typescript/r/lambda_invocation.html.markdown index 009c47718ccc..7666f6eeed18 100644 --- a/website/docs/cdktf/typescript/r/lambda_invocation.html.markdown +++ b/website/docs/cdktf/typescript/r/lambda_invocation.html.markdown @@ -3,22 +3,22 @@ subcategory: "Lambda" layout: "aws" page_title: "AWS: aws_lambda_invocation" description: |- - Invoke AWS Lambda Function + Manages an AWS Lambda Function invocation. --- # Resource: aws_lambda_invocation -Use this resource to invoke a lambda function. The lambda function is invoked with the [RequestResponse](https://docs.aws.amazon.com/lambda/latest/dg/API_Invoke.html#API_Invoke_RequestSyntax) invocation type. +Manages an AWS Lambda Function invocation. Use this resource to invoke a Lambda function with the [RequestResponse](https://docs.aws.amazon.com/lambda/latest/dg/API_Invoke.html#API_Invoke_RequestSyntax) invocation type. -~> **NOTE:** By default this resource _only_ invokes the function when the arguments call for a create or replace. In other words, after an initial invocation on _apply_, if the arguments do not change, a subsequent _apply_ does not invoke the function again. To dynamically invoke the function, see the `triggers` example below. To always invoke a function on each _apply_, see the [`aws_lambda_invocation`](/docs/providers/aws/d/lambda_invocation.html) data source. To invoke the lambda function when the terraform resource is updated and deleted, see the [CRUD Lifecycle Scope](#crud-lifecycle-scope) example below. +~> **Note:** By default this resource _only_ invokes the function when the arguments call for a create or replace. After an initial invocation on _apply_, if the arguments do not change, a subsequent _apply_ does not invoke the function again. To dynamically invoke the function, see the `triggers` example below. To always invoke a function on each _apply_, see the [`aws_lambda_invocation` data source](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/lambda_invocation). To invoke the Lambda function when the Terraform resource is updated and deleted, see the [CRUD Lifecycle Management](#crud-lifecycle-management) example below. -~> **NOTE:** If you get a `KMSAccessDeniedException: Lambda was unable to decrypt the environment variables because KMS access was denied` error when invoking an [`aws_lambda_function`](/docs/providers/aws/r/lambda_function.html) with environment variables, the IAM role associated with the function may have been deleted and recreated _after_ the function was created. You can fix the problem two ways: 1) updating the function's role to another role and then updating it back again to the recreated role, or 2) by using Terraform to `taint` the function and `apply` your configuration again to recreate the function. (When you create a function, Lambda grants permissions on the KMS key to the function's IAM role. If the IAM role is recreated, the grant is no longer valid. Changing the function's role or recreating the function causes Lambda to update the grant.) +~> **Note:** If you get a `KMSAccessDeniedException: Lambda was unable to decrypt the environment variables because KMS access was denied` error when invoking a Lambda function with environment variables, the IAM role associated with the function may have been deleted and recreated after the function was created. You can fix the problem two ways: 1) updating the function's role to another role and then updating it back again to the recreated role, or 2) by using Terraform to `taint` the function and `apply` your configuration again to recreate the function. (When you create a function, Lambda grants permissions on the KMS key to the function's IAM role. If the IAM role is recreated, the grant is no longer valid. Changing the function's role or recreating the function causes Lambda to update the grant.) ## Example Usage -### Basic Example +### Basic Invocation ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -28,33 +28,49 @@ import { Fn, Token, TerraformOutput, TerraformStack } from "cdktf"; * Provider bindings are generated by running `cdktf get`. * See https://cdk.tf/provider-generation for more details. */ +import { LambdaFunction } from "./.gen/providers/aws/lambda-function"; import { LambdaInvocation } from "./.gen/providers/aws/lambda-invocation"; class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); - const example = new LambdaInvocation(this, "example", { - functionName: lambdaFunctionTest.functionName, + const example = new LambdaFunction(this, "example", { + filename: "function.zip", + functionName: "data_processor", + handler: "index.handler", + role: lambdaRole.arn, + runtime: "python3.12", + }); + const awsLambdaInvocationExample = new LambdaInvocation(this, "example_1", { + functionName: example.functionName, input: Token.asString( Fn.jsonencode({ - key1: "value1", - key2: "value2", + config: { + debug: false, + environment: "production", + }, + operation: "initialize", }) ), }); - new TerraformOutput(this, "result_entry", { - value: Fn.lookupNested(Fn.jsondecode(example.result), ['"key1"']), + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + awsLambdaInvocationExample.overrideLogicalId("example"); + new TerraformOutput(this, "initialization_result", { + value: Fn.lookupNested( + Fn.jsondecode(Token.asString(awsLambdaInvocationExample.result)), + ['"status"'] + ), }); } } ``` -### Dynamic Invocation Example Using Triggers +### Dynamic Invocation with Triggers ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug import { Construct } from "constructs"; -import { Fn, Token, TerraformStack } from "cdktf"; +import { Token, Fn, TerraformStack } from "cdktf"; /* * Provider bindings are generated by running `cdktf get`. * See https://cdk.tf/provider-generation for more details. @@ -64,21 +80,26 @@ class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); new LambdaInvocation(this, "example", { - functionName: lambdaFunctionTest.functionName, + functionName: Token.asString(awsLambdaFunctionExample.functionName), input: Token.asString( Fn.jsonencode({ - key1: "value1", - key2: "value2", + batch_id: batchId.result, + environment: environment.value, + operation: "process_data", }) ), triggers: { - redeployment: Token.asString( - Fn.sha1( + config_hash: Token.asString( + Fn.sha256( Token.asString( - Fn.jsonencode([awsLambdaFunctionExample.environment]) + Fn.jsonencode({ + environment: environment.value, + timestamp: Fn.timestamp(), + }) ) ) ), + function_version: Token.asString(awsLambdaFunctionExample.version), }, }); } @@ -86,12 +107,12 @@ class MyConvertedCode extends TerraformStack { ``` -### CRUD Lifecycle Scope +### CRUD Lifecycle Management ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug import { Construct } from "constructs"; -import { Fn, Token, TerraformStack } from "cdktf"; +import { Token, Fn, TerraformStack } from "cdktf"; /* * Provider bindings are generated by running `cdktf get`. * See https://cdk.tf/provider-generation for more details. @@ -101,11 +122,15 @@ class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); new LambdaInvocation(this, "example", { - functionName: lambdaFunctionTest.functionName, + functionName: Token.asString(awsLambdaFunctionExample.functionName), input: Token.asString( Fn.jsonencode({ - key1: "value1", - key2: "value2", + credentials: { + password: dbPassword.value, + username: dbUsername.value, + }, + database_url: awsDbInstanceExample.endpoint, + resource_name: "database_setup", }) ), lifecycleScope: "CRUD", @@ -115,19 +140,23 @@ class MyConvertedCode extends TerraformStack { ``` -~> **NOTE:** `lifecycle_scope = "CRUD"` will inject a key `tf` in the input event to pass lifecycle information! This allows the lambda function to handle different lifecycle transitions uniquely. If you need to use a key `tf` in your own input JSON, the default key name can be overridden with the `terraformKey` argument. +~> **Note:** `lifecycle_scope = "CRUD"` will inject a key `tf` in the input event to pass lifecycle information! This allows the Lambda function to handle different lifecycle transitions uniquely. If you need to use a key `tf` in your own input JSON, the default key name can be overridden with the `terraformKey` argument. -The key `tf` gets added with subkeys: +The lifecycle key gets added with subkeys: * `action` - Action Terraform performs on the resource. Values are `create`, `update`, or `delete`. * `prev_input` - Input JSON payload from the previous invocation. This can be used to handle update and delete events. -When the resource from the example above is created, the Lambda will get following JSON payload: +When the resource from the CRUD example above is created, the Lambda will receive the following JSON payload: ```json { - "key1": "value1", - "key2": "value2", + "resource_name": "database_setup", + "database_url": "mydb.cluster-xyz.us-west-2.rds.amazonaws.com:5432", + "credentials": { + "username": "admin", + "password": "secret123" + }, "tf": { "action": "create", "prev_input": null @@ -135,33 +164,49 @@ When the resource from the example above is created, the Lambda will get followi } ``` -If the input value of `key1` changes to "valueB", then the lambda will be invoked again with the following JSON payload: +If the `databaseUrl` changes, the Lambda will be invoked again with: ```json { - "key1": "valueB", - "key2": "value2", + "resource_name": "database_setup", + "database_url": "mydb-new.cluster-abc.us-west-2.rds.amazonaws.com:5432", + "credentials": { + "username": "admin", + "password": "secret123" + }, "tf": { "action": "update", "prev_input": { - "key1": "value1", - "key2": "value2" + "resource_name": "database_setup", + "database_url": "mydb.cluster-xyz.us-west-2.rds.amazonaws.com:5432", + "credentials": { + "username": "admin", + "password": "secret123" + } } } } ``` -When the invocation resource is removed, the final invocation will have the following JSON payload: +When the invocation resource is removed, the final invocation will have: ```json { - "key1": "valueB", - "key2": "value2", + "resource_name": "database_setup", + "database_url": "mydb-new.cluster-abc.us-west-2.rds.amazonaws.com:5432", + "credentials": { + "username": "admin", + "password": "secret123" + }, "tf": { "action": "delete", "prev_input": { - "key1": "valueB", - "key2": "value2" + "resource_name": "database_setup", + "database_url": "mydb-new.cluster-abc.us-west-2.rds.amazonaws.com:5432", + "credentials": { + "username": "admin", + "password": "secret123" + } } } } @@ -171,20 +216,21 @@ When the invocation resource is removed, the final invocation will have the foll The following arguments are required: -* `functionName` - (Required) Name of the lambda function. -* `input` - (Required) JSON payload to the lambda function. +* `functionName` - (Required) Name of the Lambda function. +* `input` - (Required) JSON payload to the Lambda function. The following arguments are optional: * `lifecycleScope` - (Optional) Lifecycle scope of the resource to manage. Valid values are `CREATE_ONLY` and `CRUD`. Defaults to `CREATE_ONLY`. `CREATE_ONLY` will invoke the function only on creation or replacement. `CRUD` will invoke the function on each lifecycle event, and augment the input JSON payload with additional lifecycle information. -* `qualifier` - (Optional) Qualifier (i.e., version) of the lambda function. Defaults to `$LATEST`. -* `terraformKey` - (Optional) The JSON key used to store lifecycle information in the input JSON payload. Defaults to `tf`. This additional key is only included when `lifecycleScope` is set to `CRUD`. -* `triggers` - (Optional) Map of arbitrary keys and values that, when changed, will trigger a re-invocation. To force a re-invocation without changing these keys/values, use the [`terraform taint` command](https://www.terraform.io/docs/commands/taint.html). +* `qualifier` - (Optional) Qualifier (i.e., version) of the Lambda function. Defaults to `$LATEST`. +* `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). +* `terraformKey` - (Optional) JSON key used to store lifecycle information in the input JSON payload. Defaults to `tf`. This additional key is only included when `lifecycleScope` is set to `CRUD`. +* `triggers` - (Optional) Map of arbitrary keys and values that, when changed, will trigger a re-invocation. To force a re-invocation without changing these keys/values, use the [`terraform taint` command](https://developer.hashicorp.com/terraform/cli/commands/taint). ## Attribute Reference This resource exports the following attributes in addition to the arguments above: -* `result` - String result of the lambda function invocation. +* `result` - String result of the Lambda function invocation. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/lambda_layer_version.html.markdown b/website/docs/cdktf/typescript/r/lambda_layer_version.html.markdown index 3fb0631360a3..a2f2611aea2d 100644 --- a/website/docs/cdktf/typescript/r/lambda_layer_version.html.markdown +++ b/website/docs/cdktf/typescript/r/lambda_layer_version.html.markdown @@ -3,21 +3,23 @@ subcategory: "Lambda" layout: "aws" page_title: "AWS: aws_lambda_layer_version" description: |- - Provides a Lambda Layer Version resource. Lambda Layers allow you to reuse shared bits of code across multiple lambda functions. + Manages an AWS Lambda Layer Version. --- # Resource: aws_lambda_layer_version -Provides a Lambda Layer Version resource. Lambda Layers allow you to reuse shared bits of code across multiple lambda functions. +Manages an AWS Lambda Layer Version. Use this resource to share code and dependencies across multiple Lambda functions. -For information about Lambda Layers and how to use them, see [AWS Lambda Layers][1]. +For information about Lambda Layers and how to use them, see [AWS Lambda Layers](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html). -~> **NOTE:** Setting `skipDestroy` to `true` means that the AWS Provider will _not_ destroy any layer version, even when running `terraform destroy`. Layer versions are thus intentional dangling resources that are _not_ managed by Terraform and may incur extra expense in your AWS account. +~> **Note:** Setting `skipDestroy` to `true` means that the AWS Provider will not destroy any layer version, even when running `terraform destroy`. Layer versions are thus intentional dangling resources that are not managed by Terraform and may incur extra expense in your AWS account. ## Example Usage +### Basic Layer + ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug import { Construct } from "constructs"; @@ -30,7 +32,7 @@ import { LambdaLayerVersion } from "./.gen/providers/aws/lambda-layer-version"; class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); - new LambdaLayerVersion(this, "lambda_layer", { + new LambdaLayerVersion(this, "example", { compatibleRuntimes: ["nodejs20.x"], filename: "lambda_layer_payload.zip", layerName: "lambda_layer_name", @@ -40,14 +42,72 @@ class MyConvertedCode extends TerraformStack { ``` +### Layer with S3 Source + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { LambdaLayerVersion } from "./.gen/providers/aws/lambda-layer-version"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + new LambdaLayerVersion(this, "example", { + compatibleArchitectures: ["x86_64", "arm64"], + compatibleRuntimes: ["nodejs20.x", "python3.12"], + layerName: "lambda_layer_name", + s3Bucket: lambdaLayerZip.bucket, + s3Key: lambdaLayerZip.key, + }); + } +} + +``` + +### Layer with Multiple Runtimes and Architectures + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { Fn, Token, TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { LambdaLayerVersion } from "./.gen/providers/aws/lambda-layer-version"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + new LambdaLayerVersion(this, "example", { + compatibleArchitectures: ["x86_64", "arm64"], + compatibleRuntimes: [ + "nodejs18.x", + "nodejs20.x", + "python3.11", + "python3.12", + ], + description: "Shared utilities for Lambda functions", + filename: "lambda_layer_payload.zip", + layerName: "multi_runtime_layer", + licenseInfo: "MIT", + sourceCodeHash: Token.asString( + Fn.filebase64sha256("lambda_layer_payload.zip") + ), + }); + } +} + +``` + ## Specifying the Deployment Package -AWS Lambda Layers expect source code to be provided as a deployment package whose structure varies depending on which `compatibleRuntimes` this layer specifies. -See [Runtimes][2] for the valid values of `compatibleRuntimes`. +AWS Lambda Layers expect source code to be provided as a deployment package whose structure varies depending on which `compatibleRuntimes` this layer specifies. See [Runtimes](https://docs.aws.amazon.com/lambda/latest/dg/API_PublishLayerVersion.html#SSS-PublishLayerVersion-request-CompatibleRuntimes) for the valid values of `compatibleRuntimes`. -Once you have created your deployment package you can specify it either directly as a local file (using the `filename` argument) or -indirectly via Amazon S3 (using the `s3Bucket`, `s3Key` and `s3ObjectVersion` arguments). When providing the deployment -package via S3 it may be useful to use [the `aws_s3_object` resource](s3_object.html) to upload it. +Once you have created your deployment package you can specify it either directly as a local file (using the `filename` argument) or indirectly via Amazon S3 (using the `s3Bucket`, `s3Key` and `s3ObjectVersion` arguments). When providing the deployment package via S3 it may be useful to use [the `aws_s3_object` resource](s3_object.html) to upload it. For larger deployment packages it is recommended by Amazon to upload via S3, since the S3 API has better support for uploading large files efficiently. @@ -55,20 +115,21 @@ For larger deployment packages it is recommended by Amazon to upload via S3, sin The following arguments are required: -* `layerName` - (Required) Unique name for your Lambda Layer +* `layerName` - (Required) Unique name for your Lambda Layer. The following arguments are optional: -* `compatibleArchitectures` - (Optional) List of [Architectures][4] this layer is compatible with. Currently `x86_64` and `arm64` can be specified. -* `compatibleRuntimes` - (Optional) List of [Runtimes][2] this layer is compatible with. Up to 15 runtimes can be specified. +* `compatibleArchitectures` - (Optional) List of [Architectures](https://docs.aws.amazon.com/lambda/latest/dg/API_PublishLayerVersion.html#SSS-PublishLayerVersion-request-CompatibleArchitectures) this layer is compatible with. Currently `x86_64` and `arm64` can be specified. +* `compatibleRuntimes` - (Optional) List of [Runtimes](https://docs.aws.amazon.com/lambda/latest/dg/API_PublishLayerVersion.html#SSS-PublishLayerVersion-request-CompatibleRuntimes) this layer is compatible with. Up to 15 runtimes can be specified. * `description` - (Optional) Description of what your Lambda Layer does. -* `filename` (Optional) Path to the function's deployment package within the local filesystem. If defined, The `s3_`-prefixed options cannot be used. -* `licenseInfo` - (Optional) License info for your Lambda Layer. See [License Info][3]. +* `filename` - (Optional) Path to the function's deployment package within the local filesystem. If defined, The `s3_`-prefixed options cannot be used. +* `licenseInfo` - (Optional) License info for your Lambda Layer. See [License Info](https://docs.aws.amazon.com/lambda/latest/dg/API_PublishLayerVersion.html#SSS-PublishLayerVersion-request-LicenseInfo). +* `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). * `s3Bucket` - (Optional) S3 bucket location containing the function's deployment package. Conflicts with `filename`. This bucket must reside in the same AWS region where you are creating the Lambda function. * `s3Key` - (Optional) S3 key of an object containing the function's deployment package. Conflicts with `filename`. * `s3ObjectVersion` - (Optional) Object version containing the function's deployment package. Conflicts with `filename`. * `skipDestroy` - (Optional) Whether to retain the old version of a previously deployed Lambda Layer. Default is `false`. When this is not set to `true`, changing any of `compatibleArchitectures`, `compatibleRuntimes`, `description`, `filename`, `layerName`, `licenseInfo`, `s3Bucket`, `s3Key`, `s3ObjectVersion`, or `sourceCodeHash` forces deletion of the existing layer version and creation of a new layer version. -* `sourceCodeHash` - (Optional) Virtual attribute used to trigger replacement when source code changes. Must be set to a base64-encoded SHA256 hash of the package file specified with either `filename` or `s3Key`. The usual way to set this is `${filebase64sha256("file.zip")}` (Terraform 0.11.12 or later) or `${base64sha256(file("file.zip"))}` (Terraform 0.11.11 and earlier), where "file.zip" is the local filename of the lambda layer source archive. +* `sourceCodeHash` - (Optional) Virtual attribute used to trigger replacement when source code changes. Must be set to a base64-encoded SHA256 hash of the package file specified with either `filename` or `s3Key`. The usual way to set this is `filebase64sha256("file.zip")` (Terraform 0.11.12 or later) or `base64sha256(file("file.zip"))` (Terraform 0.11.11 and earlier), where "file.zip" is the local filename of the lambda layer source archive. ## Attribute Reference @@ -83,11 +144,6 @@ This resource exports the following attributes in addition to the arguments abov * `sourceCodeSize` - Size in bytes of the function .zip file. * `version` - Lambda Layer version. -[1]: https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html -[2]: https://docs.aws.amazon.com/lambda/latest/dg/API_PublishLayerVersion.html#SSS-PublishLayerVersion-request-CompatibleRuntimes -[3]: https://docs.aws.amazon.com/lambda/latest/dg/API_PublishLayerVersion.html#SSS-PublishLayerVersion-request-LicenseInfo -[4]: https://docs.aws.amazon.com/lambda/latest/dg/API_PublishLayerVersion.html#SSS-PublishLayerVersion-request-CompatibleArchitectures - ## Import In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import Lambda Layers using `arn`. For example: @@ -106,8 +162,8 @@ class MyConvertedCode extends TerraformStack { super(scope, name); LambdaLayerVersion.generateConfigForImport( this, - "testLayer", - "arn:aws:lambda:_REGION_:_ACCOUNT_ID_:layer:_LAYER_NAME_:_LAYER_VERSION_" + "example", + "arn:aws:lambda:us-west-2:123456789012:layer:example:1" ); } } @@ -117,9 +173,7 @@ class MyConvertedCode extends TerraformStack { Using `terraform import`, import Lambda Layers using `arn`. For example: ```console -% terraform import \ - aws_lambda_layer_version.test_layer \ - arn:aws:lambda:_REGION_:_ACCOUNT_ID_:layer:_LAYER_NAME_:_LAYER_VERSION_ +% terraform import aws_lambda_layer_version.example arn:aws:lambda:us-west-2:123456789012:layer:example:1 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/lambda_layer_version_permission.html.markdown b/website/docs/cdktf/typescript/r/lambda_layer_version_permission.html.markdown index 35a2d1e118e3..4753fa6e3517 100644 --- a/website/docs/cdktf/typescript/r/lambda_layer_version_permission.html.markdown +++ b/website/docs/cdktf/typescript/r/lambda_layer_version_permission.html.markdown @@ -3,39 +3,144 @@ subcategory: "Lambda" layout: "aws" page_title: "AWS: aws_lambda_layer_version_permission" description: |- - Provides a Lambda Layer Version Permission resource. + Manages an AWS Lambda Layer Version Permission. --- # Resource: aws_lambda_layer_version_permission -Provides a Lambda Layer Version Permission resource. It allows you to share you own Lambda Layers to another account by account ID, to all accounts in AWS organization or even to all AWS accounts. +Manages an AWS Lambda Layer Version Permission. Use this resource to share Lambda Layers with other AWS accounts, organizations, or make them publicly accessible. -For information about Lambda Layer Permissions and how to use them, see [Using Resource-based Policies for AWS Lambda][1] +For information about Lambda Layer Permissions and how to use them, see [Using Resource-based Policies for AWS Lambda](https://docs.aws.amazon.com/lambda/latest/dg/access-control-resource-based.html#permissions-resource-xaccountlayer). -~> **NOTE:** Setting `skipDestroy` to `true` means that the AWS Provider will _not_ destroy any layer version permission, even when running `terraform destroy`. Layer version permissions are thus intentional dangling resources that are _not_ managed by Terraform and may incur extra expense in your AWS account. +~> **Note:** Setting `skipDestroy` to `true` means that the AWS Provider will not destroy any layer version permission, even when running `terraform destroy`. Layer version permissions are thus intentional dangling resources that are not managed by Terraform and may incur extra expense in your AWS account. ## Example Usage +### Share Layer with Specific Account + ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug import { Construct } from "constructs"; -import { TerraformStack } from "cdktf"; +import { Token, TerraformStack } from "cdktf"; /* * Provider bindings are generated by running `cdktf get`. * See https://cdk.tf/provider-generation for more details. */ +import { LambdaLayerVersion } from "./.gen/providers/aws/lambda-layer-version"; import { LambdaLayerVersionPermission } from "./.gen/providers/aws/lambda-layer-version-permission"; class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); - new LambdaLayerVersionPermission(this, "lambda_layer_permission", { + const example = new LambdaLayerVersion(this, "example", { + compatibleRuntimes: ["nodejs20.x", "python3.12"], + description: "Common utilities for Lambda functions", + filename: "layer.zip", + layerName: "shared_utilities", + }); + const awsLambdaLayerVersionPermissionExample = + new LambdaLayerVersionPermission(this, "example_1", { + action: "lambda:GetLayerVersion", + layerName: example.layerName, + principal: "123456789012", + statementId: "dev-account-access", + versionNumber: Token.asNumber(example.version), + }); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + awsLambdaLayerVersionPermissionExample.overrideLogicalId("example"); + } +} + +``` + +### Share Layer with Organization + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { Token, TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { LambdaLayerVersionPermission } from "./.gen/providers/aws/lambda-layer-version-permission"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + new LambdaLayerVersionPermission(this, "example", { action: "lambda:GetLayerVersion", - layerName: "arn:aws:lambda:us-west-2:123456654321:layer:test_layer1", + layerName: Token.asString(awsLambdaLayerVersionExample.layerName), + organizationId: "o-1234567890", + principal: "*", + statementId: "org-wide-access", + versionNumber: Token.asNumber(awsLambdaLayerVersionExample.version), + }); + } +} + +``` + +### Share Layer Publicly + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { Token, TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { LambdaLayerVersionPermission } from "./.gen/providers/aws/lambda-layer-version-permission"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + new LambdaLayerVersionPermission(this, "example", { + action: "lambda:GetLayerVersion", + layerName: Token.asString(awsLambdaLayerVersionExample.layerName), + principal: "*", + statementId: "public-access", + versionNumber: Token.asNumber(awsLambdaLayerVersionExample.version), + }); + } +} + +``` + +### Multiple Account Access + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { Token, TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { LambdaLayerVersionPermission } from "./.gen/providers/aws/lambda-layer-version-permission"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + new LambdaLayerVersionPermission(this, "dev_account", { + action: "lambda:GetLayerVersion", + layerName: example.layerName, principal: "111111111111", statementId: "dev-account", - versionNumber: 1, + versionNumber: Token.asNumber(example.version), + }); + new LambdaLayerVersionPermission(this, "prod_account", { + action: "lambda:GetLayerVersion", + layerName: example.layerName, + principal: "333333333333", + statementId: "prod-account", + versionNumber: Token.asNumber(example.version), + }); + new LambdaLayerVersionPermission(this, "staging_account", { + action: "lambda:GetLayerVersion", + layerName: example.layerName, + principal: "222222222222", + statementId: "staging-account", + versionNumber: Token.asNumber(example.version), }); } } @@ -44,23 +149,27 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -This resource supports the following arguments: +The following arguments are required: + +* `action` - (Required) Action that will be allowed. `lambda:GetLayerVersion` is the standard value for layer access. +* `layerName` - (Required) Name or ARN of the Lambda Layer. +* `principal` - (Required) AWS account ID that should be able to use your Lambda Layer. Use `*` to share with all AWS accounts. +* `statementId` - (Required) Unique identifier for the permission statement. +* `versionNumber` - (Required) Version of Lambda Layer to grant access to. Note: permissions only apply to a single version of a layer. -* `action` - (Required) Action, which will be allowed. `lambda:GetLayerVersion` value is suggested by AWS documantation. -* `layerName` (Required) The name or ARN of the Lambda Layer, which you want to grant access to. -* `organizationId` - (Optional) An identifier of AWS Organization, which should be able to use your Lambda Layer. `principal` should be equal to `*` if `organizationId` provided. -* `principal` - (Required) AWS account ID which should be able to use your Lambda Layer. `*` can be used here, if you want to share your Lambda Layer widely. -* `statementId` - (Required) The name of Lambda Layer Permission, for example `dev-account` - human readable note about what is this permission for. -* `versionNumber` (Required) Version of Lambda Layer, which you want to grant access to. Note: permissions only apply to a single version of a layer. -* `skipDestroy` - (Optional) Whether to retain the old version of a previously deployed Lambda Layer. Default is `false`. When this is not set to `true`, changing any of `compatibleArchitectures`, `compatibleRuntimes`, `description`, `filename`, `layerName`, `licenseInfo`, `s3Bucket`, `s3Key`, `s3ObjectVersion`, or `sourceCodeHash` forces deletion of the existing layer version and creation of a new layer version. +The following arguments are optional: + +* `organizationId` - (Optional) AWS Organization ID that should be able to use your Lambda Layer. `principal` should be set to `*` when `organizationId` is provided. +* `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). +* `skipDestroy` - (Optional) Whether to retain the permission when the resource is destroyed. Default is `false`. ## Attribute Reference This resource exports the following attributes in addition to the arguments above: -* `id` - The `layerName` and `versionNumber`, separated by a comma (`,`). -* `revisionId` - A unique identifier for the current revision of the policy. +* `id` - Layer name and version number, separated by a comma (`,`). * `policy` - Full Lambda Layer Permission policy. +* `revisionId` - Unique identifier for the current revision of the policy. ## Import @@ -81,19 +190,17 @@ class MyConvertedCode extends TerraformStack { LambdaLayerVersionPermission.generateConfigForImport( this, "example", - "arn:aws:lambda:us-west-2:123456654321:layer:test_layer1,1" + "arn:aws:lambda:us-west-2:123456789012:layer:shared_utilities,1" ); } } ``` -Using `terraform import`, import Lambda Layer Permissions using `layerName` and `versionNumber`, separated by a comma (`,`). For example: +For backwards compatibility, the following legacy `terraform import` command is also supported: ```console -% terraform import aws_lambda_layer_version_permission.example arn:aws:lambda:us-west-2:123456654321:layer:test_layer1,1 +% terraform import aws_lambda_layer_version_permission.example arn:aws:lambda:us-west-2:123456789012:layer:shared_utilities,1 ``` -[1]: https://docs.aws.amazon.com/lambda/latest/dg/access-control-resource-based.html#permissions-resource-xaccountlayer - - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/lambda_permission.html.markdown b/website/docs/cdktf/typescript/r/lambda_permission.html.markdown index 55b3d3fc0069..79da5f2b3b89 100644 --- a/website/docs/cdktf/typescript/r/lambda_permission.html.markdown +++ b/website/docs/cdktf/typescript/r/lambda_permission.html.markdown @@ -3,18 +3,18 @@ subcategory: "Lambda" layout: "aws" page_title: "AWS: aws_lambda_permission" description: |- - Creates a Lambda function permission. + Manages an AWS Lambda permission. --- # Resource: aws_lambda_permission -Gives an external source (like an EventBridge Rule, SNS, or S3) permission to access the Lambda function. +Manages an AWS Lambda permission. Use this resource to grant external sources (e.g., EventBridge Rules, SNS, or S3) permission to invoke Lambda functions. ## Example Usage -### Basic Usage +### Basic Usage with EventBridge ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -75,7 +75,7 @@ class MyConvertedCode extends TerraformStack { ``` -### With SNS +### SNS Integration ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -140,7 +140,7 @@ class MyConvertedCode extends TerraformStack { ``` -### With API Gateway REST API +### API Gateway REST API Integration ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -171,7 +171,7 @@ class MyConvertedCode extends TerraformStack { ``` -### With CloudWatch Log Group +### CloudWatch Log Group Integration ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -243,7 +243,7 @@ class MyConvertedCode extends TerraformStack { ``` -### With Cross-Account Invocation Policy +### Cross-Account Function URL Access ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -276,9 +276,7 @@ class MyConvertedCode extends TerraformStack { ``` -### With `replace_triggered_by` Lifecycle Configuration - -If omitting the `qualifier` argument (which forces re-creation each time a function version is published), a `lifecycle` block can be used to ensure permissions are re-applied on any change to the underlying function. +### Automatic Permission Updates with Function Changes ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -308,27 +306,23 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -This resource supports the following arguments: - -* `action` - (Required) The AWS Lambda action you want to allow in this statement. (e.g., `lambda:InvokeFunction`) -* `eventSourceToken` - (Optional) The Event Source Token to validate. Used with [Alexa Skills][1]. -* `functionName` - (Required) Name of the Lambda function whose resource policy you are updating -* `functionUrlAuthType` - (Optional) Lambda Function URLs [authentication type][3]. Valid values are: `AWS_IAM` or `NONE`. Only supported for `lambda:InvokeFunctionUrl` action. -* `principal` - (Required) The principal who is getting this permission e.g., `s3.amazonaws.com`, an AWS account ID, or AWS IAM principal, or AWS service principal such as `events.amazonaws.com` or `sns.amazonaws.com`. -* `qualifier` - (Optional) Query parameter to specify function version or alias name. The permission will then apply to the specific qualified ARN e.g., `arn:aws:lambda:aws-region:acct-id:function:function-name:2` -* `sourceAccount` - (Optional) This parameter is used when allowing cross-account access, or for S3 and SES. The AWS account ID (without a hyphen) of the source owner. -* `sourceArn` - (Optional) When the principal is an AWS service, the ARN of the specific resource within that service to grant permission to. - Without this, any resource from `principal` will be granted permission – even if that resource is from another account. - For S3, this should be the ARN of the S3 Bucket. - For EventBridge events, this should be the ARN of the EventBridge Rule. - For API Gateway, this should be the ARN of the API, as described [here][2]. -* `statementId` - (Optional) A unique statement identifier. By default generated by Terraform. -* `statementIdPrefix` - (Optional) A statement identifier prefix. Terraform will generate a unique suffix. Conflicts with `statementId`. -* `principalOrgId` - (Optional) The identifier for your organization in AWS Organizations. Use this to grant permissions to all the AWS accounts under this organization. - -[1]: https://developer.amazon.com/docs/custom-skills/host-a-custom-skill-as-an-aws-lambda-function.html#use-aws-cli -[2]: https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-control-access-using-iam-policies-to-invoke-api.html -[3]: https://docs.aws.amazon.com/lambda/latest/dg/urls-auth.html +The following arguments are required: + +* `action` - (Required) Lambda action to allow in this statement (e.g., `lambda:InvokeFunction`) +* `functionName` - (Required) Name or ARN of the Lambda function +* `principal` - (Required) AWS service or account that invokes the function (e.g., `s3.amazonaws.com`, `sns.amazonaws.com`, AWS account ID, or AWS IAM principal) + +The following arguments are optional: + +* `eventSourceToken` - (Optional) Event Source Token for Alexa Skills +* `functionUrlAuthType` - (Optional) Lambda Function URL authentication type. Valid values: `AWS_IAM` or `NONE`. Only valid with `lambda:InvokeFunctionUrl` action +* `principalOrgId` - (Optional) AWS Organizations ID to grant permission to all accounts under this organization +* `qualifier` - (Optional) Lambda function version or alias name +* `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) +* `sourceAccount` - (Optional) AWS account ID of the source owner for cross-account access, S3, or SES +* `sourceArn` - (Optional) ARN of the source resource granting permission to invoke the Lambda function +* `statementId` - (Optional) Statement identifier. Generated by Terraform if not provided +* `statementIdPrefix` - (Optional) Statement identifier prefix. Conflicts with `statementId` ## Attribute Reference @@ -360,6 +354,8 @@ class MyConvertedCode extends TerraformStack { ``` +Using `qualifier`: + ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug import { Construct } from "constructs"; @@ -382,14 +378,11 @@ class MyConvertedCode extends TerraformStack { ``` -Using `terraform import`, import Lambda permission statements using function_name/statement_id with an optional qualifier. For example: - -```console -% terraform import aws_lambda_permission.test_lambda_permission my_test_lambda_function/AllowExecutionFromCloudWatch -``` +For backwards compatibility, the following legacy `terraform import` commands are also supported: ```console +% terraform import aws_lambda_permission.example my_test_lambda_function/AllowExecutionFromCloudWatch % terraform import aws_lambda_permission.test_lambda_permission my_test_lambda_function:qualifier_name/AllowExecutionFromCloudWatch ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/lambda_provisioned_concurrency_config.html.markdown b/website/docs/cdktf/typescript/r/lambda_provisioned_concurrency_config.html.markdown index 89612af96ff6..4d3280b02e34 100644 --- a/website/docs/cdktf/typescript/r/lambda_provisioned_concurrency_config.html.markdown +++ b/website/docs/cdktf/typescript/r/lambda_provisioned_concurrency_config.html.markdown @@ -3,16 +3,16 @@ subcategory: "Lambda" layout: "aws" page_title: "AWS: aws_lambda_provisioned_concurrency_config" description: |- - Manages a Lambda Provisioned Concurrency Configuration + Manages an AWS Lambda Provisioned Concurrency Configuration. --- # Resource: aws_lambda_provisioned_concurrency_config -Manages a Lambda Provisioned Concurrency Configuration. +Manages an AWS Lambda Provisioned Concurrency Configuration. Use this resource to configure provisioned concurrency for Lambda functions. -~> **NOTE:** Setting `skipDestroy` to `true` means that the AWS Provider will _not_ destroy a provisioned concurrency configuration, even when running `terraform destroy`. The configuration is thus an intentional dangling resource that is _not_ managed by Terraform and may incur extra expense in your AWS account. +~> **Note:** Setting `skipDestroy` to `true` means that the AWS Provider will not destroy a provisioned concurrency configuration, even when running `terraform destroy`. The configuration is thus an intentional dangling resource that is not managed by Terraform and may incur extra expense in your AWS account. ## Example Usage @@ -69,12 +69,13 @@ class MyConvertedCode extends TerraformStack { The following arguments are required: * `functionName` - (Required) Name or Amazon Resource Name (ARN) of the Lambda Function. -* `provisionedConcurrentExecutions` - (Required) Amount of capacity to allocate. Must be greater than or equal to `1`. +* `provisionedConcurrentExecutions` - (Required) Amount of capacity to allocate. Must be greater than or equal to 1. * `qualifier` - (Required) Lambda Function version or Lambda Alias name. The following arguments are optional: -* `skipDestroy` - (Optional) Whether to retain the provisoned concurrency configuration upon destruction. Defaults to `false`. If set to `true`, the resource in simply removed from state instead. +* `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). +* `skipDestroy` - (Optional) Whether to retain the provisioned concurrency configuration upon destruction. Defaults to `false`. If set to `true`, the resource is simply removed from state instead. ## Attribute Reference @@ -108,7 +109,7 @@ class MyConvertedCode extends TerraformStack { LambdaProvisionedConcurrencyConfig.generateConfigForImport( this, "example", - "my_function,production" + "example,production" ); } } @@ -118,7 +119,7 @@ class MyConvertedCode extends TerraformStack { Using `terraform import`, import a Lambda Provisioned Concurrency Configuration using the `functionName` and `qualifier` separated by a comma (`,`). For example: ```console -% terraform import aws_lambda_provisioned_concurrency_config.example my_function,production +% terraform import aws_lambda_provisioned_concurrency_config.example example,production ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/lambda_runtime_management_config.html.markdown b/website/docs/cdktf/typescript/r/lambda_runtime_management_config.html.markdown index bba2ab336d98..584a929657df 100644 --- a/website/docs/cdktf/typescript/r/lambda_runtime_management_config.html.markdown +++ b/website/docs/cdktf/typescript/r/lambda_runtime_management_config.html.markdown @@ -3,18 +3,17 @@ subcategory: "Lambda" layout: "aws" page_title: "AWS: aws_lambda_runtime_management_config" description: |- - Terraform resource for managing an AWS Lambda Runtime Management Config. + Manages an AWS Lambda Runtime Management Config. --- # Resource: aws_lambda_runtime_management_config -Terraform resource for managing an AWS Lambda Runtime Management Config. +Manages an AWS Lambda Runtime Management Config. Use this resource to control how Lambda updates the runtime for your function. Refer to the [AWS Lambda documentation](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html) for supported runtimes. -~> Deletion of this resource returns the runtime update mode to `Auto` (the default behavior). -To leave the configured runtime management options in-place, use a [`removed` block](https://developer.hashicorp.com/terraform/language/resources/syntax#removing-resources) with the destroy lifecycle set to `false`. +~> **Note:** Deletion of this resource returns the runtime update mode to `Auto` (the default behavior). To leave the configured runtime management options in-place, use a [`removed` block](https://developer.hashicorp.com/terraform/language/resources/syntax#removing-resources) with the destroy lifecycle set to `false`. ## Example Usage @@ -23,7 +22,7 @@ To leave the configured runtime management options in-place, use a [`removed` bl ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug import { Construct } from "constructs"; -import { TerraformStack } from "cdktf"; +import { Token, TerraformStack } from "cdktf"; /* * Provider bindings are generated by running `cdktf get`. * See https://cdk.tf/provider-generation for more details. @@ -33,7 +32,7 @@ class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); new LambdaRuntimeManagementConfig(this, "example", { - functionName: test.functionName, + functionName: Token.asString(awsLambdaFunctionExample.functionName), updateRuntimeOn: "FunctionUpdate", }); } @@ -41,12 +40,12 @@ class MyConvertedCode extends TerraformStack { ``` -### `Manual` Update +### Manual Update ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug import { Construct } from "constructs"; -import { TerraformStack } from "cdktf"; +import { Token, TerraformStack } from "cdktf"; /* * Provider bindings are generated by running `cdktf get`. * See https://cdk.tf/provider-generation for more details. @@ -56,7 +55,7 @@ class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); new LambdaRuntimeManagementConfig(this, "example", { - functionName: test.functionName, + functionName: Token.asString(awsLambdaFunctionExample.functionName), runtimeVersionArn: "arn:aws:lambda:us-east-1::runtime:abcd1234", updateRuntimeOn: "Manual", }); @@ -65,7 +64,7 @@ class MyConvertedCode extends TerraformStack { ``` -~> Once the runtime update mode is set to `Manual`, the `aws_lambda_function` `runtime` cannot be updated. To upgrade a runtime, the `updateRuntimeOn` argument must be set to `Auto` or `FunctionUpdate` prior to changing the function's `runtime` argument. +~> **Note:** Once the runtime update mode is set to `Manual`, the `aws_lambda_function` `runtime` cannot be updated. To upgrade a runtime, the `updateRuntimeOn` argument must be set to `Auto` or `FunctionUpdate` prior to changing the function's `runtime` argument. ## Argument Reference @@ -76,6 +75,7 @@ The following arguments are required: The following arguments are optional: * `qualifier` - (Optional) Version of the function. This can be `$LATEST` or a published version number. If omitted, this resource will manage the runtime configuration for `$LATEST`. +* `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). * `runtimeVersionArn` - (Optional) ARN of the runtime version. Only required when `updateRuntimeOn` is `Manual`. * `updateRuntimeOn` - (Optional) Runtime update mode. Valid values are `Auto`, `FunctionUpdate`, and `Manual`. When a function is created, the default mode is `Auto`. @@ -104,7 +104,7 @@ class MyConvertedCode extends TerraformStack { LambdaRuntimeManagementConfig.generateConfigForImport( this, "example", - "my-function,$LATEST" + "example,$LATEST" ); } } @@ -114,7 +114,7 @@ class MyConvertedCode extends TerraformStack { Using `terraform import`, import Lambda Runtime Management Config using a comma-delimited string combining `functionName` and `qualifier`. For example: ```console -% terraform import aws_lambda_runtime_management_config.example my-function,$LATEST +% terraform import aws_lambda_runtime_management_config.example example,$LATEST ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/launch_configuration.html.markdown b/website/docs/cdktf/typescript/r/launch_configuration.html.markdown index 34559f90d2b1..98f469cd158b 100644 --- a/website/docs/cdktf/typescript/r/launch_configuration.html.markdown +++ b/website/docs/cdktf/typescript/r/launch_configuration.html.markdown @@ -188,6 +188,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `associatePublicIpAddress` - (Optional) Associate a public ip address with an instance in a VPC. * `ebsBlockDevice` - (Optional) Additional EBS block devices to attach to the instance. See [Block Devices](#block-devices) below for details. * `ebsOptimized` - (Optional) If true, the launched EC2 instance will be EBS-optimized. @@ -304,4 +305,4 @@ Using `terraform import`, import launch configurations using the `name`. For exa % terraform import aws_launch_configuration.as_conf terraform-lg-123456 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/launch_template.html.markdown b/website/docs/cdktf/typescript/r/launch_template.html.markdown index 27490c24fb1b..1ed84262009f 100644 --- a/website/docs/cdktf/typescript/r/launch_template.html.markdown +++ b/website/docs/cdktf/typescript/r/launch_template.html.markdown @@ -48,14 +48,6 @@ class MyConvertedCode extends TerraformStack { disableApiStop: true, disableApiTermination: true, ebsOptimized: Token.asString(true), - elasticGpuSpecifications: [ - { - type: "test", - }, - ], - elasticInferenceAccelerator: { - type: "eia1.medium", - }, iamInstanceProfile: { name: "test", }, @@ -112,6 +104,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `blockDeviceMappings` - (Optional) Specify volumes to attach to the instance besides the volumes specified by the AMI. See [Block Devices](#block-devices) below for details. * `capacityReservationSpecification` - (Optional) Targeting for EC2 capacity reservations. See [Capacity Reservation Specification](#capacity-reservation-specification) below for more details. @@ -124,9 +117,6 @@ This resource supports the following arguments: * `disableApiTermination` - (Optional) If `true`, enables [EC2 Instance Termination Protection](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_ChangingDisableAPITermination.html) * `ebsOptimized` - (Optional) If `true`, the launched EC2 instance will be EBS-optimized. -* `elasticGpuSpecifications` - (Optional) **DEPRECATED** The elastic GPU to attach to the instance. See [Elastic GPU](#elastic-gpu) - below for more details. -* `elasticInferenceAccelerator` - (Optional) **DEPRECATED** Configuration block containing an Elastic Inference Accelerator to attach to the instance. See [Elastic Inference Accelerator](#elastic-inference-accelerator) below for more details. * `enclaveOptions` - (Optional) Enable Nitro Enclaves on launched instances. See [Enclave Options](#enclave-options) below for more details. * `hibernationOptions` - (Optional) The hibernation options for the instance. See [Hibernation Options](#hibernation-options) below for more details. * `iamInstanceProfile` - (Optional) The IAM Instance Profile to launch the instance with. See [Instance Profile](#instance-profile) @@ -197,7 +187,7 @@ The `ebs` block supports the following: The `capacityReservationSpecification` block supports the following: -* `capacityReservationPreference` - Indicates the instance's Capacity Reservation preferences. Can be `open` or `none`. (Default `none`). +* `capacityReservationPreference` - Indicates the instance's Capacity Reservation preferences. Can be `capacity-reservations-only`, `open` or `none`. If `capacityReservationId` or `capacityReservationResourceGroupArn` is specified in `capacityReservationTarget` block, either omit `capacityReservationPreference` or set it to `capacity-reservations-only`. * `capacityReservationTarget` - Used to target a specific Capacity Reservation: The `capacityReservationTarget` block supports the following: @@ -228,22 +218,6 @@ The `creditSpecification` block supports the following: T3 instances are launched as `unlimited` by default. T2 instances are launched as `standard` by default. -### Elastic GPU - -Attach an elastic GPU the instance. - -The `elasticGpuSpecifications` block supports the following: - -* `type` - The [Elastic GPU Type](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-graphics.html#elastic-graphics-basics) - -### Elastic Inference Accelerator - -**DEPRECATED** Attach an Elastic Inference Accelerator to the instance. Additional information about Elastic Inference in EC2 can be found in the [EC2 User Guide](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-inference.html). - -The `elasticInferenceAccelerator` configuration block supports the following: - -* `type` - (Required) Accelerator type. - ### Enclave Options The `enclaveOptions` block supports the following: @@ -549,4 +523,4 @@ Using `terraform import`, import Launch Templates using the `id`. For example: % terraform import aws_launch_template.web lt-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/lb.html.markdown b/website/docs/cdktf/typescript/r/lb.html.markdown index e57b0681c771..ff9b34628264 100644 --- a/website/docs/cdktf/typescript/r/lb.html.markdown +++ b/website/docs/cdktf/typescript/r/lb.html.markdown @@ -154,6 +154,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `accessLogs` - (Optional) Access Logs block. See below. * `connectionLogs` - (Optional) Connection Logs block. See below. Only valid for Load Balancers of type `application`. * `clientKeepAlive` - (Optional) Client keep alive value in seconds. The valid range is 60-604800 seconds. The default is 3600 seconds. @@ -174,11 +175,12 @@ This resource supports the following arguments: * `ipAddressType` - (Optional) Type of IP addresses used by the subnets for your load balancer. The possible values depend upon the load balancer type: `ipv4` (all load balancer types), `dualstack` (all load balancer types), and `dualstack-without-public-ipv4` (type `application` only). * `ipamPools` (Optional). The IPAM pools to use with the load balancer. Only valid for Load Balancers of type `application`. See [ipam_pools](#ipam_pools) for more information. * `loadBalancerType` - (Optional) Type of load balancer to create. Possible values are `application`, `gateway`, or `network`. The default value is `application`. -* `minimum_load_balancer_capacity` - (Optional) Minimum capacity for a load balancer. Only valid for Load Balancers of type `application` or `network`. +* `minimumLoadBalancerCapacity` - (Optional) Minimum capacity for a load balancer. Only valid for Load Balancers of type `application` or `network`. * `name` - (Optional) Name of the LB. This name must be unique within your AWS account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, and must not begin or end with a hyphen. If not specified, Terraform will autogenerate a name beginning with `tf-lb`. * `namePrefix` - (Optional) Creates a unique name beginning with the specified prefix. Conflicts with `name`. * `securityGroups` - (Optional) List of security group IDs to assign to the LB. Only valid for Load Balancers of type `application` or `network`. For load balancers of type `network` security groups cannot be added if none are currently present, and cannot all be removed once added. If either of these conditions are met, this will force a recreation of the resource. * `preserveHostHeader` - (Optional) Whether the Application Load Balancer should preserve the Host header in the HTTP request and send it to the target without any change. Defaults to `false`. +* `secondaryIpsAutoAssignedPerSubnet` - (Optional) The number of secondary IP addresses to configure for your load balancer nodes. Only valid for Load Balancers of type `network`. The valid range is 0-7. When decreased, this will force a recreation of the resource. Default: `0`. * `subnetMapping` - (Optional) Subnet mapping block. See below. For Load Balancers of type `network` subnet mappings can only be added. * `subnets` - (Optional) List of subnet IDs to attach to the LB. For Load Balancers of type `network` subnets can only be added (see [Availability Zones](https://docs.aws.amazon.com/elasticloadbalancing/latest/network/network-load-balancers.html#availability-zones)), deleting a subnet for load balancers of type `network` will force a recreation of the resource. * `tags` - (Optional) Map of tags to assign to the resource. If configured with a provider [`defaultTags` 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. @@ -219,10 +221,9 @@ This resource supports the following arguments: This resource exports the following attributes in addition to the arguments above: -* `arn` - ARN of the load balancer (matches `id`). +* `arn` - ARN of the load balancer. * `arnSuffix` - ARN suffix for use with CloudWatch Metrics. * `dnsName` - DNS name of the load balancer. -* `id` - ARN of the load balancer (matches `arn`). * `subnet_mapping.*.outpost_id` - ID of the Outpost containing the load balancer. * `tagsAll` - Map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). * `zoneId` - Canonical hosted zone ID of the load balancer (to be used in a Route 53 Alias record). @@ -267,4 +268,4 @@ Using `terraform import`, import LBs using their ARN. For example: % terraform import aws_lb.bar arn:aws:elasticloadbalancing:us-west-2:123456789012:loadbalancer/app/my-load-balancer/50dc6c495c0c9188 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/lb_cookie_stickiness_policy.html.markdown b/website/docs/cdktf/typescript/r/lb_cookie_stickiness_policy.html.markdown index 36d9680ee5ea..aaa090779fef 100644 --- a/website/docs/cdktf/typescript/r/lb_cookie_stickiness_policy.html.markdown +++ b/website/docs/cdktf/typescript/r/lb_cookie_stickiness_policy.html.markdown @@ -54,6 +54,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) The name of the stickiness policy. * `loadBalancer` - (Required) The load balancer to which the policy should be attached. @@ -73,4 +74,4 @@ This resource exports the following attributes in addition to the arguments abov * `lbPort` - The load balancer port to which the policy is applied. * `cookieExpirationPeriod` - The time period after which the session cookie is considered stale, expressed in seconds. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/lb_listener.html.markdown b/website/docs/cdktf/typescript/r/lb_listener.html.markdown index 6d3c9cf306ed..126176bcf43a 100644 --- a/website/docs/cdktf/typescript/r/lb_listener.html.markdown +++ b/website/docs/cdktf/typescript/r/lb_listener.html.markdown @@ -57,6 +57,57 @@ class MyConvertedCode extends TerraformStack { ``` +With weighted target groups: + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { Token, TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { Lb } from "./.gen/providers/aws/lb"; +import { LbListener } from "./.gen/providers/aws/lb-listener"; +import { LbTargetGroup } from "./.gen/providers/aws/lb-target-group"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + const frontEnd = new Lb(this, "front_end", {}); + const frontEndBlue = new LbTargetGroup(this, "front_end_blue", {}); + const frontEndGreen = new LbTargetGroup(this, "front_end_green", {}); + const awsLbListenerFrontEnd = new LbListener(this, "front_end_3", { + certificateArn: + "arn:aws:iam::187416307283:server-certificate/test_cert_rab3wuqwgja25ct3n4jdj2tzu4", + defaultAction: [ + { + forward: { + targetGroup: [ + { + arn: frontEndBlue.arn, + weight: 100, + }, + { + arn: frontEndGreen.arn, + weight: 0, + }, + ], + }, + type: "forward", + }, + ], + loadBalancerArn: frontEnd.arn, + port: Token.asNumber("443"), + protocol: "HTTPS", + sslPolicy: "ELBSecurityPolicy-2016-08", + }); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + awsLbListenerFrontEnd.overrideLogicalId("front_end"); + } +} + +``` + To a NLB: ```typescript @@ -387,6 +438,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `alpnPolicy` - (Optional) Name of the Application-Layer Protocol Negotiation (ALPN) policy. Can be set if `protocol` is `TLS`. Valid values are `HTTP1Only`, `HTTP2Only`, `HTTP2Optional`, `HTTP2Preferred`, and `None`. * `certificateArn` - (Optional) ARN of the default SSL server certificate. Exactly one certificate is required if the protocol is HTTPS. For adding additional SSL certificates, see the [`aws_lb_listener_certificate` resource](/docs/providers/aws/r/lb_listener_certificate.html). * `mutualAuthentication` - (Optional) The mutual authentication configuration information. See below. @@ -425,6 +477,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `authenticateCognito` - (Optional) Configuration block for using Amazon Cognito to authenticate users. Specify only when `type` is `authenticate-cognito`. See below. * `authenticateOidc` - (Optional) Configuration block for an identity provider that is compliant with OpenID Connect (OIDC). Specify only when `type` is `authenticate-oidc`. See below. * `fixedResponse` - (Optional) Information for creating an action that returns a custom HTTP response. Required if `type` is `fixed-response`. @@ -443,6 +496,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `authenticationRequestExtraParams` - (Optional) Query parameters to include in the redirect request to the authorization endpoint. Max: 10. See below. * `onUnauthenticatedRequest` - (Optional) Behavior if the user is not authenticated. Valid values are `deny`, `allow` and `authenticate`. * `scope` - (Optional) Set of user claims to be requested from the IdP. @@ -467,6 +521,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `authenticationRequestExtraParams` - (Optional) Query parameters to include in the redirect request to the authorization endpoint. Max: 10. * `onUnauthenticatedRequest` - (Optional) Behavior if the user is not authenticated. Valid values: `deny`, `allow` and `authenticate` * `scope` - (Optional) Set of user claims to be requested from the IdP. @@ -481,6 +536,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `messageBody` - (Optional) Message body. * `statusCode` - (Optional) HTTP response code. Valid values are `2XX`, `4XX`, or `5XX`. @@ -492,6 +548,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `stickiness` - (Optional) Configuration block for target group stickiness for the rule. See below. ##### target_group @@ -502,6 +559,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `weight` - (Optional) Weight. The range is 0 to 999. ##### stickiness @@ -512,6 +570,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `enabled` - (Optional) Whether target group stickiness is enabled. Default is `false`. #### redirect @@ -524,6 +583,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `host` - (Optional) Hostname. This component is not percent-encoded. The hostname can contain `#{host}`. Defaults to `#{host}`. * `path` - (Optional) Absolute path, starting with the leading "/". This component is not percent-encoded. The path can contain #{host}, #{path}, and #{port}. Defaults to `/#{path}`. * `port` - (Optional) Port. Specify a value from `1` to `65535` or `#{port}`. Defaults to `#{port}`. @@ -532,17 +592,17 @@ The following arguments are optional: ### mutual_authentication -* `advertiseTrustStoreCaNames` - (Optional) Valid values are `off` and `on`. -* `ignoreClientCertificateExpiry` - (Optional) Whether client certificate expiry is ignored. Default is `false`. -* `mode` - (Required) Valid values are `off`, `verify` and `passthrough`. -* `trustStoreArn` - (Required) ARN of the elbv2 Trust Store. +* `advertiseTrustStoreCaNames` - (Optional when `mode` is `verify`, invalid otherwise) Valid values are `off` and `on`. +* `ignoreClientCertificateExpiry` - (Optional when `mode` is `verify`, invalid otherwise) Whether client certificate expiry is ignored. + Default is `false`. +* `mode` - (Required) Valid values are `off`, `passthrough`, and `verify`. +* `trustStoreArn` - (Required when `mode` is `verify`, invalid otherwise) ARN of the elbv2 Trust Store. ## Attribute Reference This resource exports the following attributes in addition to the arguments above: -* `arn` - ARN of the listener (matches `id`). -* `id` - ARN of the listener (matches `arn`). +* `arn` - ARN of the listener. * `tagsAll` - A map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). ~> **Note:** When importing a listener with a forward-type default action, you must include both a top-level target group ARN and a `forward` block with a `targetGroup` and `arn` to avoid import differences. @@ -579,4 +639,4 @@ Using `terraform import`, import listeners using their ARN. For example: % terraform import aws_lb_listener.front_end arn:aws:elasticloadbalancing:us-west-2:187416307283:listener/app/front-end-alb/8e4497da625e2d8a/9ab28ade35828f96 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/lb_listener_certificate.html.markdown b/website/docs/cdktf/typescript/r/lb_listener_certificate.html.markdown index 1d5e807a4c64..3efb39e118f1 100644 --- a/website/docs/cdktf/typescript/r/lb_listener_certificate.html.markdown +++ b/website/docs/cdktf/typescript/r/lb_listener_certificate.html.markdown @@ -64,6 +64,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `listenerArn` - (Required, Forces New Resource) The ARN of the listener to which to attach the certificate. * `certificateArn` - (Required, Forces New Resource) The ARN of the certificate to attach to the listener. @@ -105,4 +106,4 @@ Using `terraform import`, import Listener Certificates using the listener arn an % terraform import aws_lb_listener_certificate.example arn:aws:elasticloadbalancing:us-west-2:123456789012:listener/app/test/8e4497da625e2d8a/9ab28ade35828f96/67b3d2d36dd7c26b_arn:aws:iam::123456789012:server-certificate/tf-acc-test-6453083910015726063 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/lb_listener_rule.html.markdown b/website/docs/cdktf/typescript/r/lb_listener_rule.html.markdown index 3a09d2cc59b1..13647d6f07c2 100644 --- a/website/docs/cdktf/typescript/r/lb_listener_rule.html.markdown +++ b/website/docs/cdktf/typescript/r/lb_listener_rule.html.markdown @@ -228,6 +228,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `listenerArn` - (Required, Forces New Resource) The ARN of the listener to which to attach the rule. * `priority` - (Optional) The priority for the rule between `1` and `50000`. Leaving it unset will automatically set the rule with next available priority after currently existing highest rule. A listener can't have multiple rules with the same priority. * `action` - (Required) An Action block. Action blocks are documented below. @@ -390,4 +391,4 @@ Using `terraform import`, import rules using their ARN. For example: % terraform import aws_lb_listener_rule.front_end arn:aws:elasticloadbalancing:us-west-2:187416307283:listener-rule/app/test/8e4497da625e2d8a/9ab28ade35828f96/67b3d2d36dd7c26b ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/lb_ssl_negotiation_policy.html.markdown b/website/docs/cdktf/typescript/r/lb_ssl_negotiation_policy.html.markdown index 2595c92c9fbe..5b3aa263c5c6 100644 --- a/website/docs/cdktf/typescript/r/lb_ssl_negotiation_policy.html.markdown +++ b/website/docs/cdktf/typescript/r/lb_ssl_negotiation_policy.html.markdown @@ -85,6 +85,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) The name of the SSL negotiation policy. * `loadBalancer` - (Required) The load balancer to which the policy should be attached. @@ -110,4 +111,4 @@ This resource exports the following attributes in addition to the arguments abov * `lbPort` - The load balancer port to which the policy is applied. * `attribute` - The SSL Negotiation policy attributes. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/lb_target_group.html.markdown b/website/docs/cdktf/typescript/r/lb_target_group.html.markdown index bb6c226b8c79..96ac597e240a 100644 --- a/website/docs/cdktf/typescript/r/lb_target_group.html.markdown +++ b/website/docs/cdktf/typescript/r/lb_target_group.html.markdown @@ -193,6 +193,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `connectionTermination` - (Optional) Whether to terminate connections at the end of the deregistration timeout on Network Load Balancers. See [doc](https://docs.aws.amazon.com/elasticloadbalancing/latest/network/load-balancer-target-groups.html#deregistration-delay) for more information. Default is `false`. * `deregistrationDelay` - (Optional) Amount time for Elastic Load Balancing to wait before changing the state of a deregistering target from draining to unused. The range is 0-3600 seconds. The default value is 300 seconds. * `healthCheck` - (Optional, Maximum of 1) Health Check configuration block. Detailed below. @@ -347,4 +348,4 @@ Using `terraform import`, import Target Groups using their ARN. For example: % terraform import aws_lb_target_group.app_front_end arn:aws:elasticloadbalancing:us-west-2:187416307283:targetgroup/app-front-end/20cfe21448b66314 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/lb_target_group_attachment.html.markdown b/website/docs/cdktf/typescript/r/lb_target_group_attachment.html.markdown index 5212e5c0b7f1..ae6cb407f19c 100644 --- a/website/docs/cdktf/typescript/r/lb_target_group_attachment.html.markdown +++ b/website/docs/cdktf/typescript/r/lb_target_group_attachment.html.markdown @@ -175,6 +175,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `availabilityZone` - (Optional) The Availability Zone where the IP address of the target is to be registered. If the private IP address is outside of the VPC scope, this value must be set to `all`. * `port` - (Optional) The port on which targets receive traffic. @@ -188,4 +189,4 @@ This resource exports the following attributes in addition to the arguments abov You cannot import Target Group Attachments. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/lb_trust_store.html.markdown b/website/docs/cdktf/typescript/r/lb_trust_store.html.markdown index bdf55d4a874a..4ba41ef6f619 100644 --- a/website/docs/cdktf/typescript/r/lb_trust_store.html.markdown +++ b/website/docs/cdktf/typescript/r/lb_trust_store.html.markdown @@ -56,10 +56,10 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `caCertificatesBundleS3Bucket` - (Required) S3 Bucket name holding the client certificate CA bundle. * `caCertificatesBundleS3Key` - (Required) S3 object key holding the client certificate CA bundle. * `caCertificatesBundleS3ObjectVersion` - (Optional) Version Id of CA bundle S3 bucket object, if versioned, defaults to latest if omitted. - * `namePrefix` - (Optional, Forces new resource) Creates a unique name beginning with the specified prefix. Conflicts with `name`. Cannot be longer than 6 characters. * `name` - (Optional, Forces new resource) Name of the Trust Store. If omitted, Terraform will assign a random, unique name. This name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, and must not begin or end with a hyphen. * `tags` - (Optional) Map of tags to assign to the resource. If configured with a provider [`defaultTags` 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. @@ -106,4 +106,4 @@ Using `terraform import`, import Target Groups using their ARN. For example: % terraform import aws_lb_trust_store.example arn:aws:elasticloadbalancing:us-west-2:187416307283:truststore/my-trust-store/20cfe21448b66314 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/lb_trust_store_revocation.html.markdown b/website/docs/cdktf/typescript/r/lb_trust_store_revocation.html.markdown index fe13ef856b34..6713bb185e0e 100644 --- a/website/docs/cdktf/typescript/r/lb_trust_store_revocation.html.markdown +++ b/website/docs/cdktf/typescript/r/lb_trust_store_revocation.html.markdown @@ -54,6 +54,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `trustStoreArn` - (Required) Trust Store ARN. * `revocationsS3Bucket` - (Required) S3 Bucket name holding the client certificate CA bundle. * `revocationsS3Key` - (Required) S3 object key holding the client certificate CA bundle. @@ -98,4 +99,4 @@ Using `terraform import`, import Trust Store Revocations using their ARN. For ex % terraform import aws_lb_trust_store_revocation.example arn:aws:elasticloadbalancing:us-west-2:187416307283:truststore/my-trust-store/20cfe21448b66314,6 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/lex_bot.html.markdown b/website/docs/cdktf/typescript/r/lex_bot.html.markdown index 97411aa198af..8b4e9cf515ec 100644 --- a/website/docs/cdktf/typescript/r/lex_bot.html.markdown +++ b/website/docs/cdktf/typescript/r/lex_bot.html.markdown @@ -69,6 +69,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `abortStatement` - (Required) The message that Amazon Lex uses to abort a conversation. Attributes are documented under [statement](#statement). * `childDirected` - (Required) By specifying true, you confirm that your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. For more information see the [Amazon Lex FAQ](https://aws.amazon.com/lex/faqs#data-security) and the [Amazon Lex PutBot API Docs](https://docs.aws.amazon.com/lex/latest/dg/API_PutBot.html#lex-PutBot-request-childDirected). * `clarificationPrompt` - (Required) The message that Amazon Lex uses when it doesn't understand the user's request. Attributes are documented under [prompt](#prompt). @@ -177,4 +178,4 @@ Using `terraform import`, import bots using their name. For example: % terraform import aws_lex_bot.order_flowers_bot OrderFlowers ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/lex_bot_alias.html.markdown b/website/docs/cdktf/typescript/r/lex_bot_alias.html.markdown index 6dbf990864fa..975734f5a20b 100644 --- a/website/docs/cdktf/typescript/r/lex_bot_alias.html.markdown +++ b/website/docs/cdktf/typescript/r/lex_bot_alias.html.markdown @@ -42,6 +42,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `botName` - (Required) The name of the bot. * `botVersion` - (Required) The version of the bot. * `conversationLogs` - (Optional) The settings that determine how Amazon Lex uses conversation logs for the alias. Attributes are documented under [conversation_logs](#conversation_logs). @@ -114,4 +115,4 @@ Using `terraform import`, import bot aliases using an ID with the format `bot_na % terraform import aws_lex_bot_alias.order_flowers_prod OrderFlowers:OrderFlowersProd ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/lex_intent.html.markdown b/website/docs/cdktf/typescript/r/lex_intent.html.markdown index 46a78506b1a1..b2d8ff3ac0ca 100644 --- a/website/docs/cdktf/typescript/r/lex_intent.html.markdown +++ b/website/docs/cdktf/typescript/r/lex_intent.html.markdown @@ -124,6 +124,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `conclusionStatement` - (Optional) The statement that you want Amazon Lex to convey to the user after the intent is successfully fulfilled by the Lambda function. This element is relevant only if you provide a Lambda function in the `fulfillmentActivity`. If you return the intent to the client @@ -296,4 +297,4 @@ Using `terraform import`, import intents using their name. For example: % terraform import aws_lex_intent.order_flowers_intent OrderFlowers ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/lex_slot_type.html.markdown b/website/docs/cdktf/typescript/r/lex_slot_type.html.markdown index 8042db1d492a..104f204023a4 100644 --- a/website/docs/cdktf/typescript/r/lex_slot_type.html.markdown +++ b/website/docs/cdktf/typescript/r/lex_slot_type.html.markdown @@ -52,6 +52,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `enumerationValue` - (Required) A list of EnumerationValue objects that defines the values that the slot type can take. Each value can have a list of synonyms, which are additional values that help train the machine learning model about the values that it resolves for a slot. Attributes are @@ -123,4 +124,4 @@ Using `terraform import`, import slot types using their name. For example: % terraform import aws_lex_slot_type.flower_types FlowerTypes ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/lexv2models_bot.html.markdown b/website/docs/cdktf/typescript/r/lexv2models_bot.html.markdown index 597166682a8e..7aafc984cb28 100644 --- a/website/docs/cdktf/typescript/r/lexv2models_bot.html.markdown +++ b/website/docs/cdktf/typescript/r/lexv2models_bot.html.markdown @@ -83,6 +83,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `members` - List of bot members in a network to be created. See [`bot_members`](#bot-members). * `tags` - List of tags to add to the bot. You can only add tags when you create a bot. * `type` - Type of a bot to create. Possible values are `"Bot"` and `"BotNetwork"`. @@ -143,4 +144,4 @@ Using `terraform import`, import Lex V2 Models Bot using the `id`. For example: % terraform import aws_lexv2models_bot.example bot-id-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/lexv2models_bot_locale.html.markdown b/website/docs/cdktf/typescript/r/lexv2models_bot_locale.html.markdown index 18c8e624b1d7..f08a7b6bf9ef 100644 --- a/website/docs/cdktf/typescript/r/lexv2models_bot_locale.html.markdown +++ b/website/docs/cdktf/typescript/r/lexv2models_bot_locale.html.markdown @@ -81,6 +81,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `description` - Description of the bot locale. Use this to help identify the bot locale in lists. * `voiceSettings` - Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user. See [`voiceSettings`](#voice-settings). @@ -136,4 +137,4 @@ Using `terraform import`, import Lex V2 Models Bot Locale using the `id`. For ex % terraform import aws_lexv2models_bot_locale.example en_US,abcd-12345678,1 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/lexv2models_bot_version.html.markdown b/website/docs/cdktf/typescript/r/lexv2models_bot_version.html.markdown index a3b5c3777c55..0a25ce80f76e 100644 --- a/website/docs/cdktf/typescript/r/lexv2models_bot_version.html.markdown +++ b/website/docs/cdktf/typescript/r/lexv2models_bot_version.html.markdown @@ -47,12 +47,13 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `botId` - (Required) Idientifier of the bot to create the version for. * `localeSpecification` - (Required) Specifies the locales that Amazon Lex adds to this version. You can choose the draft version or any other previously published version for each locale. When you specify a source version, the locale data is copied from the source version to the new version. - - The attribute value is a map with one or more entries, each of which has a locale name as the key and an object with the following attribute as the value: - * `sourceBotVersion` - (Required) The version of a bot used for a bot locale. Valid values: `DRAFT`, a numeric version. * `description` - (Optional) A description of the version. Use the description to help identify the version in lists. +* `sourceBotVersion` - (Required) The version of a bot used for a bot locale. Valid values: `DRAFT`, a numeric version. + +The `localeSpecification` attribute value is a map with one or more entries, each of which has a locale name as the key and an object with the following attribute as the value: ## Attribute Reference @@ -100,4 +101,4 @@ Using `terraform import`, import Lex V2 Models Bot Version using the `id`. For e % terraform import aws_lexv2models_bot_version.example id-12345678,1 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/lexv2models_intent.html.markdown b/website/docs/cdktf/typescript/r/lexv2models_intent.html.markdown index 62225cc1079b..9d5004f94011 100644 --- a/website/docs/cdktf/typescript/r/lexv2models_intent.html.markdown +++ b/website/docs/cdktf/typescript/r/lexv2models_intent.html.markdown @@ -195,6 +195,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `closingSetting` - (Optional) Configuration block for the response that Amazon Lex sends to the user when the intent is closed. See [`closingSetting`](#closing_setting). * `confirmationSetting` - (Optional) Configuration block for prompts that Amazon Lex sends to the user to confirm the completion of an intent. If the user answers "no," the settings contain a statement that is sent to the user to end the intent. If you configure this block without `prompt_specification.*.prompt_attempts_specification`, AWS will provide default configurations for `Initial` and `Retry1` `promptAttemptsSpecification`s. This will cause Terraform to report differences. Use the `confirmationSetting` configuration above in the [Basic Usage](#basic-usage) example to avoid differences resulting from AWS default configuration. See [`confirmationSetting`](#confirmation_setting). * `description` - (Optional) Description of the intent. Use the description to help identify the intent in lists. @@ -606,4 +607,4 @@ Using `terraform import`, import Lex V2 Models Intent using the `intent_id:bot_i % terraform import aws_lexv2models_intent.example intent-42874:bot-11376:DRAFT:en_US ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/lexv2models_slot.html.markdown b/website/docs/cdktf/typescript/r/lexv2models_slot.html.markdown index 50b00211f963..0d433d1b5e31 100644 --- a/website/docs/cdktf/typescript/r/lexv2models_slot.html.markdown +++ b/website/docs/cdktf/typescript/r/lexv2models_slot.html.markdown @@ -182,6 +182,7 @@ See the [`valueElicitationSetting` argument reference](#value_elicitation_settin The following arguments are optional: +* `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). * `description` - (Optional) Description of the slot. * `multipleValuesSetting` - (Optional) Whether the slot returns multiple values in one response. See the [`multipleValuesSetting` argument reference](#multiple_values_setting-argument-reference) below. @@ -335,4 +336,4 @@ Using `terraform import`, import Lex V2 Models Slot using the `id`. For example: % terraform import aws_lexv2models_slot.example bot-1234,1,intent-5678,en-US,slot-9012 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/lexv2models_slot_type.html.markdown b/website/docs/cdktf/typescript/r/lexv2models_slot_type.html.markdown index a575a5f2d41f..8797c87dc2d4 100644 --- a/website/docs/cdktf/typescript/r/lexv2models_slot_type.html.markdown +++ b/website/docs/cdktf/typescript/r/lexv2models_slot_type.html.markdown @@ -107,6 +107,7 @@ All of the bots, slot types, and slots used by the intent must have the same loc The following arguments are optional: +* `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). * `description` - (Optional) Description of the slot type. * `compositeSlotTypeSetting` - (Optional) Specifications for a composite slot type. See [`compositeSlotTypeSetting` argument reference](#composite_slot_type_setting-argument-reference) below. @@ -229,4 +230,4 @@ Using `terraform import`, import Lex V2 Models Slot Type using using a comma-del % terraform import aws_lexv2models_slot_type.example bot-1234,DRAFT,en_US,slot_type-id-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/licensemanager_association.html.markdown b/website/docs/cdktf/typescript/r/licensemanager_association.html.markdown index 826a5efe1aaf..a6a14be79061 100644 --- a/website/docs/cdktf/typescript/r/licensemanager_association.html.markdown +++ b/website/docs/cdktf/typescript/r/licensemanager_association.html.markdown @@ -72,6 +72,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `licenseConfigurationArn` - (Required) ARN of the license configuration. * `resourceArn` - (Required) ARN of the resource associated with the license configuration. @@ -113,4 +114,4 @@ Using `terraform import`, import license configurations using `resource_arn,lice % terraform import aws_licensemanager_association.example arn:aws:ec2:eu-west-1:123456789012:image/ami-123456789abcdef01,arn:aws:license-manager:eu-west-1:123456789012:license-configuration:lic-0123456789abcdef0123456789abcdef ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/licensemanager_grant.html.markdown b/website/docs/cdktf/typescript/r/licensemanager_grant.html.markdown index 4c0bd17a0f08..d9d7cd97498b 100644 --- a/website/docs/cdktf/typescript/r/licensemanager_grant.html.markdown +++ b/website/docs/cdktf/typescript/r/licensemanager_grant.html.markdown @@ -48,6 +48,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) The Name of the grant. * `allowedOperations` - (Required) A list of the allowed operations for the grant. This is a subset of the allowed operations on the license. * `licenseArn` - (Required) The ARN of the license to grant. @@ -96,4 +97,4 @@ Using `terraform import`, import `aws_licensemanager_grant` using the grant arn. % terraform import aws_licensemanager_grant.test arn:aws:license-manager::123456789011:grant:g-01d313393d9e443d8664cc054db1e089 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/licensemanager_grant_accepter.html.markdown b/website/docs/cdktf/typescript/r/licensemanager_grant_accepter.html.markdown index 4c7ba8f18b47..66f688de3d82 100644 --- a/website/docs/cdktf/typescript/r/licensemanager_grant_accepter.html.markdown +++ b/website/docs/cdktf/typescript/r/licensemanager_grant_accepter.html.markdown @@ -39,6 +39,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `grantArn` - (Required) The ARN of the grant to accept. ## Attribute Reference @@ -88,4 +89,4 @@ Using `terraform import`, import `aws_licensemanager_grant_accepter` using the g % terraform import aws_licensemanager_grant_accepter.test arn:aws:license-manager::123456789012:grant:g-1cf9fba4ba2f42dcab11c686c4b4d329 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/licensemanager_license_configuration.html.markdown b/website/docs/cdktf/typescript/r/licensemanager_license_configuration.html.markdown index 8280c3687c4c..9c12f26c0dbe 100644 --- a/website/docs/cdktf/typescript/r/licensemanager_license_configuration.html.markdown +++ b/website/docs/cdktf/typescript/r/licensemanager_license_configuration.html.markdown @@ -48,6 +48,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) Name of the license configuration. * `description` - (Optional) Description of the license configuration. * `licenseCount` - (Optional) Number of licenses managed by the license configuration. @@ -109,4 +110,4 @@ Using `terraform import`, import license configurations using the `id`. For exam % terraform import aws_licensemanager_license_configuration.example arn:aws:license-manager:eu-west-1:123456789012:license-configuration:lic-0123456789abcdef0123456789abcdef ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/lightsail_bucket.html.markdown b/website/docs/cdktf/typescript/r/lightsail_bucket.html.markdown index e99e154c352c..5228ad921169 100644 --- a/website/docs/cdktf/typescript/r/lightsail_bucket.html.markdown +++ b/website/docs/cdktf/typescript/r/lightsail_bucket.html.markdown @@ -45,6 +45,7 @@ The following arguments are required: The following arguments are optional: * `forceDelete` - (Optional) Whether to force delete non-empty buckets using `terraform destroy`. AWS by default will not delete a bucket which is not empty, to prevent losing bucket data and affecting other resources in Lightsail. If `forceDelete` is set to `true` the bucket will be deleted even when not empty. +* `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). * `tags` - (Optional) Map of tags to assign to the resource. To create a key-only tag, use an empty string as the value. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level. ## Attribute Reference @@ -55,7 +56,6 @@ This resource exports the following attributes in addition to the arguments abov * `availabilityZone` - Availability Zone. Follows the format us-east-2a (case-sensitive). * `createdAt` - Date and time when the bucket was created. * `id` - Name used for this bucket (matches `name`). -* `region` - AWS Region name. * `supportCode` - Support code for the resource. Include this code in your email to support when you have questions about a resource in Lightsail. This code enables our support team to look up your Lightsail information more easily. * `tagsAll` - Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block. * `url` - URL of the bucket. @@ -88,4 +88,4 @@ Using `terraform import`, import `aws_lightsail_bucket` using the `name` attribu % terraform import aws_lightsail_bucket.example example-bucket ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/lightsail_bucket_access_key.html.markdown b/website/docs/cdktf/typescript/r/lightsail_bucket_access_key.html.markdown index 2fb118b2666e..3d12537c5d14 100644 --- a/website/docs/cdktf/typescript/r/lightsail_bucket_access_key.html.markdown +++ b/website/docs/cdktf/typescript/r/lightsail_bucket_access_key.html.markdown @@ -50,6 +50,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: * `bucketName` - (Required) Name of the bucket that the access key will belong to and grant access to. +* `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). ## Attribute Reference @@ -93,4 +94,4 @@ Using `terraform import`, import `aws_lightsail_bucket_access_key` using the `id % terraform import aws_lightsail_bucket_access_key.example example-bucket,AKIAIOSFODNN7EXAMPLE ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/lightsail_bucket_resource_access.html.markdown b/website/docs/cdktf/typescript/r/lightsail_bucket_resource_access.html.markdown index a7bb852c3aeb..594ae3968de5 100644 --- a/website/docs/cdktf/typescript/r/lightsail_bucket_resource_access.html.markdown +++ b/website/docs/cdktf/typescript/r/lightsail_bucket_resource_access.html.markdown @@ -61,6 +61,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: * `bucketName` - (Required) Name of the bucket to grant access to. +* `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). * `resourceName` - (Required) Name of the resource to grant bucket access. ## Attribute Reference @@ -101,4 +102,4 @@ Using `terraform import`, import `aws_lightsail_bucket_resource_access` using th % terraform import aws_lightsail_bucket_resource_access.example example-bucket,example-instance ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/lightsail_certificate.html.markdown b/website/docs/cdktf/typescript/r/lightsail_certificate.html.markdown index 376d12de7dda..fe6d704cfcf7 100644 --- a/website/docs/cdktf/typescript/r/lightsail_certificate.html.markdown +++ b/website/docs/cdktf/typescript/r/lightsail_certificate.html.markdown @@ -45,6 +45,7 @@ The following arguments are required: The following arguments are optional: * `domainName` - (Optional) Domain name for which the certificate should be issued. +* `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). * `subjectAlternativeNames` - (Optional) Set of domains that should be SANs in the issued certificate. `domainName` attribute is automatically added as a Subject Alternative Name. * `tags` - (Optional) Map of tags to assign to the resource. To create a key-only tag, use an empty string as the value. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level. @@ -94,4 +95,4 @@ Using `terraform import`, import `aws_lightsail_certificate` using the certifica % terraform import aws_lightsail_certificate.example example-certificate ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/lightsail_container_service.html.markdown b/website/docs/cdktf/typescript/r/lightsail_container_service.html.markdown index 5f70707c0c30..d3a54989901e 100644 --- a/website/docs/cdktf/typescript/r/lightsail_container_service.html.markdown +++ b/website/docs/cdktf/typescript/r/lightsail_container_service.html.markdown @@ -172,6 +172,7 @@ The following arguments are optional: * `isDisabled` - (Optional) Whether to disable the container service. Defaults to `false`. * `privateRegistryAccess` - (Optional) Configuration for the container service to access private container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private repositories. [See below](#private-registry-access). * `publicDomainNames` - (Optional) Public domain names to use with the container service, such as example.com and www.example.com. You can specify up to four public domain names for a container service. The domain names that you specify are used when you create a deployment with a container configured as the public endpoint of your container service. If you don't specify public domain names, then you can use the default domain of the container service. [See below](#public-domain-names). +* `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). * `tags` - (Optional) Map of tags to assign to the resource. To create a key-only tag, use an empty string as the value. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level. ### Private Registry Access @@ -254,4 +255,4 @@ Using `terraform import`, import Lightsail Container Service using the `name`. F % terraform import aws_lightsail_container_service.example container-service-1 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/lightsail_container_service_deployment_version.html.markdown b/website/docs/cdktf/typescript/r/lightsail_container_service_deployment_version.html.markdown index 05f20fa0b9be..002ae7a0c69f 100644 --- a/website/docs/cdktf/typescript/r/lightsail_container_service_deployment_version.html.markdown +++ b/website/docs/cdktf/typescript/r/lightsail_container_service_deployment_version.html.markdown @@ -75,6 +75,7 @@ The following arguments are required: The following arguments are optional: * `publicEndpoint` - (Optional) Configuration block that describes the settings of the public endpoint for the container service. [See below](#public_endpoint). +* `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). ### `container` @@ -152,4 +153,4 @@ Using `terraform import`, import Lightsail Container Service Deployment Version % terraform import aws_lightsail_container_service_deployment_version.example container-service-1/1 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/lightsail_database.html.markdown b/website/docs/cdktf/typescript/r/lightsail_database.html.markdown index 3b9fad69259d..fdacc78d3132 100644 --- a/website/docs/cdktf/typescript/r/lightsail_database.html.markdown +++ b/website/docs/cdktf/typescript/r/lightsail_database.html.markdown @@ -188,6 +188,7 @@ The following arguments are optional: * `preferredBackupWindow` - (Optional) Daily time range during which automated backups are created for your database if automated backups are enabled. Must be in the hh24:mi-hh24:mi format. Example: `16:00-16:30`. Specified in Coordinated Universal Time (UTC). * `preferredMaintenanceWindow` - (Optional) Weekly time range during which system maintenance can occur on your database. Must be in the ddd:hh24:mi-ddd:hh24:mi format. Specified in Coordinated Universal Time (UTC). Example: `Tue:17:00-Tue:17:30` * `publiclyAccessible` - (Optional) Whether the database is accessible to resources outside of your Lightsail account. A value of true specifies a database that is available to resources outside of your Lightsail account. A value of false specifies a database that is available only to your Lightsail resources in the same region as your database. +* `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). * `skipFinalSnapshot` - (Optional) Whether a final database snapshot is created before your database is deleted. If true is specified, no database snapshot is created. If false is specified, a database snapshot is created before your database is deleted. You must specify the final relational database snapshot name parameter if the skip final snapshot parameter is false. * `tags` - (Optional) Map of tags to assign to the resource. To create a key-only tag, use an empty string as the value. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level. @@ -289,4 +290,4 @@ Using `terraform import`, import Lightsail Databases using their name. For examp % terraform import aws_lightsail_database.example example-database ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/lightsail_disk.html.markdown b/website/docs/cdktf/typescript/r/lightsail_disk.html.markdown index a11e8bbc4e23..79c6a35801ed 100644 --- a/website/docs/cdktf/typescript/r/lightsail_disk.html.markdown +++ b/website/docs/cdktf/typescript/r/lightsail_disk.html.markdown @@ -56,6 +56,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `tags` - (Optional) Map of tags to assign to the resource. To create a key-only tag, use an empty string as the value. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level. ## Attribute Reference @@ -96,4 +97,4 @@ Using `terraform import`, import `aws_lightsail_disk` using the name attribute. % terraform import aws_lightsail_disk.example example-disk ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/lightsail_disk_attachment.html.markdown b/website/docs/cdktf/typescript/r/lightsail_disk_attachment.html.markdown index d22e96ce1714..404c135f865c 100644 --- a/website/docs/cdktf/typescript/r/lightsail_disk_attachment.html.markdown +++ b/website/docs/cdktf/typescript/r/lightsail_disk_attachment.html.markdown @@ -80,6 +80,7 @@ This resource supports the following arguments: * `diskName` - (Required) Name of the Lightsail disk. * `diskPath` - (Required) Disk path to expose to the instance. * `instanceName` - (Required) Name of the Lightsail instance to attach to. +* `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). ## Attribute Reference @@ -119,4 +120,4 @@ Using `terraform import`, import `aws_lightsail_disk_attachment` using the id at % terraform import aws_lightsail_disk_attachment.example example-disk,example-instance ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/lightsail_distribution.html.markdown b/website/docs/cdktf/typescript/r/lightsail_distribution.html.markdown index 9107580c9584..d2b64792af35 100644 --- a/website/docs/cdktf/typescript/r/lightsail_distribution.html.markdown +++ b/website/docs/cdktf/typescript/r/lightsail_distribution.html.markdown @@ -243,6 +243,7 @@ The following arguments are optional: * `certificateName` - (Optional) Name of the SSL/TLS certificate attached to the distribution. * `ipAddressType` - (Optional) IP address type of the distribution. Valid values: `dualstack`, `ipv4`. Default: `dualstack`. * `isEnabled` - (Optional) Whether the distribution is enabled. Default: `true`. +* `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). * `tags` - (Optional) Map of tags for the Lightsail Distribution. If configured with a provider [`defaultTags` 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. ### cache_behavior @@ -347,4 +348,4 @@ Using `terraform import`, import Lightsail Distribution using the `name`. For ex % terraform import aws_lightsail_distribution.example example-distribution ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/lightsail_domain.html.markdown b/website/docs/cdktf/typescript/r/lightsail_domain.html.markdown index 0f4018b87381..40dedcf639d4 100644 --- a/website/docs/cdktf/typescript/r/lightsail_domain.html.markdown +++ b/website/docs/cdktf/typescript/r/lightsail_domain.html.markdown @@ -44,6 +44,10 @@ The following arguments are required: * `domainName` - (Required) Name of the Lightsail domain to manage. +The following arguments are optional: + +* `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). + ## Attribute Reference This resource exports the following attributes in addition to the arguments above: @@ -51,4 +55,4 @@ This resource exports the following attributes in addition to the arguments abov * `arn` - ARN of the Lightsail domain. * `id` - Name used for this domain. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/lightsail_domain_entry.html.markdown b/website/docs/cdktf/typescript/r/lightsail_domain_entry.html.markdown index c0636cbfdcbb..4207b328e380 100644 --- a/website/docs/cdktf/typescript/r/lightsail_domain_entry.html.markdown +++ b/website/docs/cdktf/typescript/r/lightsail_domain_entry.html.markdown @@ -61,6 +61,7 @@ The following arguments are required: The following arguments are optional: * `isAlias` - (Optional) Whether the entry should be an alias. Default: `false`. +* `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). ## Attribute Reference @@ -100,4 +101,4 @@ Using `terraform import`, import Lightsail Domain Entry using the id attribute. % terraform import aws_lightsail_domain_entry.example www,example.com,A,127.0.0.1 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/lightsail_instance.html.markdown b/website/docs/cdktf/typescript/r/lightsail_instance.html.markdown index 61ad4dc8f60e..e70d979d38a6 100644 --- a/website/docs/cdktf/typescript/r/lightsail_instance.html.markdown +++ b/website/docs/cdktf/typescript/r/lightsail_instance.html.markdown @@ -121,6 +121,7 @@ The following arguments are optional: * `addOn` - (Optional) Add-on configuration for the instance. [See below](#add_on). * `ipAddressType` - (Optional) IP address type of the Lightsail Instance. Valid values: `dualstack`, `ipv4`, `ipv6`. Default: `dualstack`. * `keyPairName` - (Optional) Name of your key pair. Created in the Lightsail console (cannot use `aws_key_pair` at this time). +* `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). * `tags` - (Optional) Map of tags to assign to the resource. To create a key-only tag, use an empty string as the value. If configured with a provider [`defaultTags` 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. * `userData` - (Optional) Single lined launch script as a string to configure server with additional user data. @@ -176,4 +177,4 @@ Using `terraform import`, import Lightsail Instances using their name. For examp % terraform import aws_lightsail_instance.example 'example' ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/lightsail_instance_public_ports.html.markdown b/website/docs/cdktf/typescript/r/lightsail_instance_public_ports.html.markdown index 1f302813f054..25f09859d68f 100644 --- a/website/docs/cdktf/typescript/r/lightsail_instance_public_ports.html.markdown +++ b/website/docs/cdktf/typescript/r/lightsail_instance_public_ports.html.markdown @@ -75,22 +75,23 @@ class MyConvertedCode extends TerraformStack { The following arguments are required: -* `instanceName` - (Required) Name of the Lightsail Instance. -* `portInfo` - (Required) Configuration block with port information. AWS closes all currently open ports that are not included in the `portInfo`. [See below](#port_info). +* `instanceName` - (Required) Name of the instance for which to open ports. +* `portInfo` - (Required) Descriptor of the ports to open for the specified instance. AWS closes all currently open ports that are not included in this argument. See [`portInfo` Block](#port_info-block) for details. -### port_info +The following arguments are optional: -The following arguments are required: +* `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). -* `fromPort` - (Required) First port in a range of open ports on an instance. -* `protocol` - (Required) IP protocol name. Valid values: `tcp`, `all`, `udp`, `icmp`. -* `toPort` - (Required) Last port in a range of open ports on an instance. +### `portInfo` Block -The following arguments are optional: +The `portInfo` configuration block supports the following arguments: +* `fromPort` - (Required) First port in a range of open ports on an instance. See [PortInfo](https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_PortInfo.html) for details. +* `protocol` - (Required) IP protocol name. Valid values: `tcp`, `all`, `udp`, `icmp`, `icmpv6`. See [PortInfo](https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_PortInfo.html) for details. +* `toPort` - (Required) Last port in a range of open ports on an instance. See [PortInfo](https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_PortInfo.html) for details. * `cidrListAliases` - (Optional) Set of CIDR aliases that define access for a preconfigured range of IP addresses. -* `cidrs` - (Optional) Set of CIDR blocks. -* `ipv6Cidrs` - (Optional) Set of IPv6 CIDR blocks. +* `cidrs` - (Optional) Set of IPv4 addresses or ranges of IPv4 addresses (in CIDR notation) that are allowed to connect to an instance through the ports, and the protocol. +* `ipv6Cidrs` - (Optional) Set of IPv6 addresses or ranges of IPv6 addresses (in CIDR notation) that are allowed to connect to an instance through the ports, and the protocol. ## Attribute Reference @@ -98,4 +99,4 @@ This resource exports the following attributes in addition to the arguments abov * `id` - ID of the resource. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/lightsail_key_pair.html.markdown b/website/docs/cdktf/typescript/r/lightsail_key_pair.html.markdown index 3ccb6941345d..eda566755a24 100644 --- a/website/docs/cdktf/typescript/r/lightsail_key_pair.html.markdown +++ b/website/docs/cdktf/typescript/r/lightsail_key_pair.html.markdown @@ -92,6 +92,7 @@ The following arguments are optional: * `namePrefix` - (Optional) Creates a unique name beginning with the specified prefix. Conflicts with `name`. * `pgpKey` - (Optional) PGP key to encrypt the resulting private key material. Only used when creating a new key pair. * `publicKey` - (Optional) Public key material. This public key will be imported into Lightsail. +* `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). * `tags` - (Optional) Map of tags to assign to the resource. To create a key-only tag, use an empty string as the value. If configured with a provider [`defaultTags` 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. ~> **Note:** A PGP key is not required, however it is strongly encouraged. Without a PGP key, the private key material will be stored in state unencrypted. `pgpKey` is ignored if `publicKey` is supplied. @@ -113,4 +114,4 @@ This resource exports the following attributes in addition to the arguments abov You cannot import Lightsail Key Pairs because the private and public key are only available on initial creation. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/lightsail_lb.html.markdown b/website/docs/cdktf/typescript/r/lightsail_lb.html.markdown index e28c3c84fcfc..e40315efa047 100644 --- a/website/docs/cdktf/typescript/r/lightsail_lb.html.markdown +++ b/website/docs/cdktf/typescript/r/lightsail_lb.html.markdown @@ -52,6 +52,7 @@ The following arguments are optional: * `healthCheckPath` - (Optional) Health check path of the load balancer. Default value `/`. * `ipAddressType` - (Optional) IP address type of the load balancer. Valid values: `dualstack`, `ipv4`. Default value `dualstack`. +* `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). * `tags` - (Optional) Map of tags to assign to the resource. To create a key-only tag, use an empty string as the value. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level. ## Attribute Reference @@ -99,4 +100,4 @@ Using `terraform import`, import `aws_lightsail_lb` using the name attribute. Fo % terraform import aws_lightsail_lb.example example-load-balancer ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/lightsail_lb_attachment.html.markdown b/website/docs/cdktf/typescript/r/lightsail_lb_attachment.html.markdown index fe44b7ef75f5..15d5dc0a6dbf 100644 --- a/website/docs/cdktf/typescript/r/lightsail_lb_attachment.html.markdown +++ b/website/docs/cdktf/typescript/r/lightsail_lb_attachment.html.markdown @@ -82,6 +82,10 @@ The following arguments are required: * `instanceName` - (Required) Name of the instance to attach to the load balancer. * `lbName` - (Required) Name of the Lightsail load balancer. +The following arguments are optional: + +* `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). + ## Attribute Reference This resource exports the following attributes in addition to the arguments above: @@ -120,4 +124,4 @@ Using `terraform import`, import `aws_lightsail_lb_attachment` using the name at % terraform import aws_lightsail_lb_attachment.example example-load-balancer,example-instance ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/lightsail_lb_certificate.html.markdown b/website/docs/cdktf/typescript/r/lightsail_lb_certificate.html.markdown index 54de1b66e97b..2d2e88edbcc8 100644 --- a/website/docs/cdktf/typescript/r/lightsail_lb_certificate.html.markdown +++ b/website/docs/cdktf/typescript/r/lightsail_lb_certificate.html.markdown @@ -63,6 +63,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `subjectAlternativeNames` - (Optional) Set of domains that should be SANs in the issued certificate. `domainName` attribute is automatically added as a Subject Alternative Name. ## Attribute Reference @@ -107,4 +108,4 @@ Using `terraform import`, import `aws_lightsail_lb_certificate` using the id att % terraform import aws_lightsail_lb_certificate.example example-load-balancer,example-load-balancer-certificate ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/lightsail_lb_certificate_attachment.html.markdown b/website/docs/cdktf/typescript/r/lightsail_lb_certificate_attachment.html.markdown index d5afda7c4465..ac21de77fdfa 100644 --- a/website/docs/cdktf/typescript/r/lightsail_lb_certificate_attachment.html.markdown +++ b/website/docs/cdktf/typescript/r/lightsail_lb_certificate_attachment.html.markdown @@ -68,6 +68,10 @@ The following arguments are required: * `certificateName` - (Required) Name of your SSL/TLS certificate. * `lbName` - (Required) Name of the load balancer to which you want to associate the SSL/TLS certificate. +The following arguments are optional: + +* `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). + ## Attribute Reference This resource exports the following attributes in addition to the arguments above: @@ -106,4 +110,4 @@ Using `terraform import`, import `aws_lightsail_lb_certificate_attachment` using % terraform import aws_lightsail_lb_certificate_attachment.example example-load-balancer,example-certificate ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/lightsail_lb_https_redirection_policy.html.markdown b/website/docs/cdktf/typescript/r/lightsail_lb_https_redirection_policy.html.markdown index f99b17c6aa78..e49d70248961 100644 --- a/website/docs/cdktf/typescript/r/lightsail_lb_https_redirection_policy.html.markdown +++ b/website/docs/cdktf/typescript/r/lightsail_lb_https_redirection_policy.html.markdown @@ -76,6 +76,10 @@ The following arguments are required: * `enabled` - (Required) Whether to enable HTTP to HTTPS redirection. `true` to activate HTTP to HTTPS redirection or `false` to deactivate HTTP to HTTPS redirection. * `lbName` - (Required) Name of the load balancer to which you want to enable HTTP to HTTPS redirection. +The following arguments are optional: + +* `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). + ## Attribute Reference This resource exports the following attributes in addition to the arguments above: @@ -114,4 +118,4 @@ Using `terraform import`, import `aws_lightsail_lb_https_redirection_policy` usi % terraform import aws_lightsail_lb_https_redirection_policy.example example-load-balancer ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/lightsail_lb_stickiness_policy.html.markdown b/website/docs/cdktf/typescript/r/lightsail_lb_stickiness_policy.html.markdown index 99f554a2e8dd..77e9562b1f5e 100644 --- a/website/docs/cdktf/typescript/r/lightsail_lb_stickiness_policy.html.markdown +++ b/website/docs/cdktf/typescript/r/lightsail_lb_stickiness_policy.html.markdown @@ -58,6 +58,10 @@ The following arguments are required: * `enabled` - (Required) Whether to enable session stickiness for the load balancer. * `lbName` - (Required) Name of the load balancer to which you want to enable session stickiness. +The following arguments are optional: + +* `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). + ## Attribute Reference This resource exports the following attributes in addition to the arguments above: @@ -96,4 +100,4 @@ Using `terraform import`, import `aws_lightsail_lb_stickiness_policy` using the % terraform import aws_lightsail_lb_stickiness_policy.example example-load-balancer ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/lightsail_static_ip.html.markdown b/website/docs/cdktf/typescript/r/lightsail_static_ip.html.markdown index 0318f47870e9..92f08793b6ae 100644 --- a/website/docs/cdktf/typescript/r/lightsail_static_ip.html.markdown +++ b/website/docs/cdktf/typescript/r/lightsail_static_ip.html.markdown @@ -44,6 +44,10 @@ The following arguments are required: * `name` - (Required) Name for the allocated static IP. +The following arguments are optional: + +* `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). + ## Attribute Reference This resource exports the following attributes in addition to the arguments above: @@ -80,4 +84,4 @@ Using `terraform import`, import `aws_lightsail_static_ip` using the name attrib % terraform import aws_lightsail_static_ip.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/lightsail_static_ip_attachment.html.markdown b/website/docs/cdktf/typescript/r/lightsail_static_ip_attachment.html.markdown index 531dc5e03de7..4c40bcc83659 100644 --- a/website/docs/cdktf/typescript/r/lightsail_static_ip_attachment.html.markdown +++ b/website/docs/cdktf/typescript/r/lightsail_static_ip_attachment.html.markdown @@ -66,6 +66,10 @@ The following arguments are required: * `instanceName` - (Required) Name of the Lightsail instance to attach the IP to. * `staticIpName` - (Required) Name of the allocated static IP. +The following arguments are optional: + +* `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). + ## Attribute Reference This resource exports the following attributes in addition to the arguments above: @@ -104,4 +108,4 @@ Using `terraform import`, import `aws_lightsail_static_ip_attachment` using the % terraform import aws_lightsail_static_ip_attachment.example example-static-ip ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/load_balancer_backend_server_policy.html.markdown b/website/docs/cdktf/typescript/r/load_balancer_backend_server_policy.html.markdown index e35e09e86fdd..c1ccaffb8e30 100644 --- a/website/docs/cdktf/typescript/r/load_balancer_backend_server_policy.html.markdown +++ b/website/docs/cdktf/typescript/r/load_balancer_backend_server_policy.html.markdown @@ -89,6 +89,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `loadBalancerName` - (Required) The load balancer to attach the policy to. * `policyNames` - (Required) List of Policy Names to apply to the backend server. * `instancePort` - (Required) The instance port to apply the policy to. @@ -101,4 +102,4 @@ This resource exports the following attributes in addition to the arguments abov * `loadBalancerName` - The load balancer on which the policy is defined. * `instancePort` - The backend port the policies are applied to - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/load_balancer_listener_policy.html.markdown b/website/docs/cdktf/typescript/r/load_balancer_listener_policy.html.markdown index f92bd5922962..0f73e0bab617 100644 --- a/website/docs/cdktf/typescript/r/load_balancer_listener_policy.html.markdown +++ b/website/docs/cdktf/typescript/r/load_balancer_listener_policy.html.markdown @@ -134,6 +134,7 @@ This example shows how to add a [Predefined Security Policy for ELBs](https://do This resource supports the following arguments: +* `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). * `loadBalancerName` - (Required) The load balancer to attach the policy to. * `loadBalancerPort` - (Required) The load balancer listener port to apply the policy to. * `policyNames` - (Required) List of Policy Names to apply to the backend server. @@ -147,4 +148,4 @@ This resource exports the following attributes in addition to the arguments abov * `loadBalancerName` - The load balancer on which the policy is defined. * `loadBalancerPort` - The load balancer listener port the policies are applied to - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/load_balancer_policy.html.markdown b/website/docs/cdktf/typescript/r/load_balancer_policy.html.markdown index 313a8bd02267..bfdd2cb5488a 100644 --- a/website/docs/cdktf/typescript/r/load_balancer_policy.html.markdown +++ b/website/docs/cdktf/typescript/r/load_balancer_policy.html.markdown @@ -121,6 +121,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `loadBalancerName` - (Required) The load balancer on which the policy is defined. * `policyName` - (Required) The name of the load balancer policy. * `policyTypeName` - (Required) The policy type. @@ -135,4 +136,4 @@ This resource exports the following attributes in addition to the arguments abov * `policyTypeName` - The policy type of the policy. * `loadBalancerName` - The load balancer on which the policy is defined. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/location_geofence_collection.html.markdown b/website/docs/cdktf/typescript/r/location_geofence_collection.html.markdown index d91cdc5e77a8..5d125dff33d6 100644 --- a/website/docs/cdktf/typescript/r/location_geofence_collection.html.markdown +++ b/website/docs/cdktf/typescript/r/location_geofence_collection.html.markdown @@ -42,6 +42,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `description` - (Optional) The optional description for the geofence collection. * `kmsKeyId` - (Optional) A key identifier for an AWS KMS customer managed key assigned to the Amazon Location resource. * `tags` - (Optional) Key-value tags for the geofence collection. If configured with a provider [`defaultTags` 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. @@ -94,4 +95,4 @@ Using `terraform import`, import Location Geofence Collection using the `collect % terraform import aws_location_geofence_collection.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/location_map.html.markdown b/website/docs/cdktf/typescript/r/location_map.html.markdown index 28ce8558aca7..b2d59f3e9cac 100644 --- a/website/docs/cdktf/typescript/r/location_map.html.markdown +++ b/website/docs/cdktf/typescript/r/location_map.html.markdown @@ -46,6 +46,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `description` - (Optional) An optional description for the map resource. * `tags` - (Optional) Key-value tags for the map. If configured with a provider [`defaultTags` 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. @@ -92,4 +93,4 @@ Using `terraform import`, import `aws_location_map` resources using the map name % terraform import aws_location_map.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/location_place_index.html.markdown b/website/docs/cdktf/typescript/r/location_place_index.html.markdown index 8b800071c9b7..bd4ae2f3090a 100644 --- a/website/docs/cdktf/typescript/r/location_place_index.html.markdown +++ b/website/docs/cdktf/typescript/r/location_place_index.html.markdown @@ -44,6 +44,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `dataSourceConfiguration` - (Optional) Configuration block with the data storage option chosen for requesting Places. Detailed below. * `description` - (Optional) The optional description for the place index resource. * `tags` - (Optional) Key-value tags for the place index. If configured with a provider [`defaultTags` 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. @@ -52,6 +53,7 @@ The following arguments are optional: The following arguments are optional: +* `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). * `intendedUse` - (Optional) Specifies how the results of an operation will be stored by the caller. Valid values: `SingleUse`, `Storage`. Default: `SingleUse`. ## Attribute Reference @@ -91,4 +93,4 @@ Using `terraform import`, import `aws_location_place_index` resources using the % terraform import aws_location_place_index.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/location_route_calculator.html.markdown b/website/docs/cdktf/typescript/r/location_route_calculator.html.markdown index c8473d552937..c6be9731cdc1 100644 --- a/website/docs/cdktf/typescript/r/location_route_calculator.html.markdown +++ b/website/docs/cdktf/typescript/r/location_route_calculator.html.markdown @@ -44,6 +44,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `description` - (Optional) The optional description for the route calculator resource. * `tags` - (Optional) Key-value tags for the route calculator. If configured with a provider [`defaultTags` 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. @@ -92,4 +93,4 @@ Using `terraform import`, import `aws_location_route_calculator` using the route % terraform import aws_location_route_calculator.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/location_tracker.html.markdown b/website/docs/cdktf/typescript/r/location_tracker.html.markdown index 0cca7a4e29a5..e616cf8f336e 100644 --- a/website/docs/cdktf/typescript/r/location_tracker.html.markdown +++ b/website/docs/cdktf/typescript/r/location_tracker.html.markdown @@ -42,6 +42,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `description` - (Optional) The optional description for the tracker resource. * `kmsKeyId` - (Optional) A key identifier for an AWS KMS customer managed key assigned to the Amazon Location resource. * `positionFiltering` - (Optional) The position filtering method of the tracker resource. Valid values: `TimeBased`, `DistanceBased`, `AccuracyBased`. Default: `TimeBased`. @@ -84,4 +85,4 @@ Using `terraform import`, import `aws_location_tracker` resources using the trac % terraform import aws_location_tracker.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/location_tracker_association.html.markdown b/website/docs/cdktf/typescript/r/location_tracker_association.html.markdown index b0ade03c9012..70730c775a49 100644 --- a/website/docs/cdktf/typescript/r/location_tracker_association.html.markdown +++ b/website/docs/cdktf/typescript/r/location_tracker_association.html.markdown @@ -53,8 +53,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `consumerArn` - (Required) The Amazon Resource Name (ARN) for the geofence collection to be associated to tracker resource. Used when you need to specify a resource across all AWS. * `trackerName` - (Required) The name of the tracker resource to be associated with a geofence collection. @@ -101,4 +102,4 @@ Using `terraform import`, import Location Tracker Association using the `tracker % terraform import aws_location_tracker_association.example "tracker_name|consumer_arn" ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/m2_application.html.markdown b/website/docs/cdktf/typescript/r/m2_application.html.markdown index f704d0fba107..527018dc5a2b 100644 --- a/website/docs/cdktf/typescript/r/m2_application.html.markdown +++ b/website/docs/cdktf/typescript/r/m2_application.html.markdown @@ -54,6 +54,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `definition` - (Optional) The application definition for this application. You can specify either inline JSON or an S3 bucket location. * `kmsKeyId` - (Optional) KMS Key to use for the Application. * `roleArn` - (Optional) ARN of role for application to use to access AWS resources. @@ -65,6 +66,7 @@ This argument is processed in [attribute-as-blocks mode](https://www.terraform.i The following arguments are optional: +* `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). * `content` - (Optional) JSON application definition. Either this or `s3Location` must be specified. * `s3Location` - (Optional) Location of the application definition in S3. Either this or `content` must be specified. @@ -117,4 +119,4 @@ Using `terraform import`, import Mainframe Modernization Application using the ` % terraform import aws_m2_application.example 01234567890abcdef012345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/m2_deployment.html.markdown b/website/docs/cdktf/typescript/r/m2_deployment.html.markdown index 7061738bd7ed..d264c583e8f8 100644 --- a/website/docs/cdktf/typescript/r/m2_deployment.html.markdown +++ b/website/docs/cdktf/typescript/r/m2_deployment.html.markdown @@ -40,8 +40,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `environmentId` - (Required) Environment to deploy application to. * `applicationId` - (Required) Application to deploy. * `applicationVersion` - (Required) Version to application to deploy @@ -91,4 +92,4 @@ Using `terraform import`, import Mainframe Modernization Deployment using the `A % terraform import aws_m2_deployment.example APPLICATION-ID,DEPLOYMENT-ID ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/m2_environment.html.markdown b/website/docs/cdktf/typescript/r/m2_environment.html.markdown index 73a5a5f12c8a..e2542c3ff389 100644 --- a/website/docs/cdktf/typescript/r/m2_environment.html.markdown +++ b/website/docs/cdktf/typescript/r/m2_environment.html.markdown @@ -152,6 +152,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `engineVersion` - (Optional) The specific version of the engine for the Environment. * `forceUpdate` - (Optional) Force update the environment even if applications are running. * `kmsKeyId` - (Optional) ARN of the KMS key to use for the Environment. @@ -238,4 +239,4 @@ Using `terraform import`, import Mainframe Modernization Environment using the ` % terraform import aws_m2_environment.example 01234567890abcdef012345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/macie2_account.html.markdown b/website/docs/cdktf/typescript/r/macie2_account.html.markdown index b7e974c3ace2..31a7644f183e 100644 --- a/website/docs/cdktf/typescript/r/macie2_account.html.markdown +++ b/website/docs/cdktf/typescript/r/macie2_account.html.markdown @@ -39,6 +39,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `findingPublishingFrequency` - (Optional) Specifies how often to publish updates to policy findings for the account. This includes publishing updates to AWS Security Hub and Amazon EventBridge (formerly called Amazon CloudWatch Events). Valid values are `FIFTEEN_MINUTES`, `ONE_HOUR` or `SIX_HOURS`. * `status` - (Optional) Specifies the status for the account. To enable Amazon Macie and start all Macie activities for the account, set this value to `ENABLED`. Valid values are `ENABLED` or `PAUSED`. @@ -79,4 +80,4 @@ Using `terraform import`, import `aws_macie2_account` using the id. For example: % terraform import aws_macie2_account.example abcd1 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/macie2_classification_export_configuration.html.markdown b/website/docs/cdktf/typescript/r/macie2_classification_export_configuration.html.markdown index 011f262c14e1..d2de233fd84b 100644 --- a/website/docs/cdktf/typescript/r/macie2_classification_export_configuration.html.markdown +++ b/website/docs/cdktf/typescript/r/macie2_classification_export_configuration.html.markdown @@ -50,6 +50,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `s3Destination` - (Required) Configuration block for a S3 Destination. Defined below ### s3_destination Configuration Block @@ -70,7 +71,7 @@ This resource exports the following attributes in addition to the arguments abov ## Import -In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import `aws_macie2_classification_export_configuration` using the account ID and region. For example: +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import `aws_macie2_classification_export_configuration` using the region. For example: ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -87,17 +88,17 @@ class MyConvertedCode extends TerraformStack { Macie2ClassificationExportConfiguration.generateConfigForImport( this, "example", - "123456789012:us-west-2" + "us-west-2" ); } } ``` -Using `terraform import`, import `aws_macie2_classification_export_configuration` using the account ID and region. For example: +Using `terraform import`, import `aws_macie2_classification_export_configuration` using the region. For example: ```console -% terraform import aws_macie2_classification_export_configuration.example 123456789012:us-west-2 +% terraform import aws_macie2_classification_export_configuration.example us-west-2 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/macie2_classification_job.html.markdown b/website/docs/cdktf/typescript/r/macie2_classification_job.html.markdown index 156892a3fcdc..c0e93d1a9b20 100644 --- a/website/docs/cdktf/typescript/r/macie2_classification_job.html.markdown +++ b/website/docs/cdktf/typescript/r/macie2_classification_job.html.markdown @@ -56,6 +56,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `scheduleFrequency` - (Optional) The recurrence pattern for running the job. To run the job only once, don't specify a value for this property and set the value for the `jobType` property to `ONE_TIME`. (documented below) * `customDataIdentifierIds` - (Optional) The custom data identifiers to use for data analysis and classification. * `samplingPercentage` - (Optional) The sampling depth, as a percentage, to apply when processing objects. This value determines the percentage of eligible objects that the job analyzes. If this value is less than 100, Amazon Macie selects the objects to analyze at random, up to the specified percentage, and analyzes all the data in those objects. @@ -185,4 +186,4 @@ Using `terraform import`, import `aws_macie2_classification_job` using the id. F % terraform import aws_macie2_classification_job.example abcd1 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/macie2_custom_data_identifier.html.markdown b/website/docs/cdktf/typescript/r/macie2_custom_data_identifier.html.markdown index 31601987712b..4636b7602b8b 100644 --- a/website/docs/cdktf/typescript/r/macie2_custom_data_identifier.html.markdown +++ b/website/docs/cdktf/typescript/r/macie2_custom_data_identifier.html.markdown @@ -52,6 +52,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `regex` - (Optional) The regular expression (regex) that defines the pattern to match. The expression can contain as many as 512 characters. * `keywords` - (Optional) An array that lists specific character sequences (keywords), one of which must be within proximity (`maximumMatchDistance`) of the regular expression to match. The array can contain as many as 50 keywords. Each keyword can contain 3 - 90 characters. Keywords aren't case sensitive. * `ignoreWords` - (Optional) An array that lists specific character sequences (ignore words) to exclude from the results. If the text matched by the regular expression is the same as any string in this array, Amazon Macie ignores it. The array can contain as many as 10 ignore words. Each ignore word can contain 4 - 90 characters. Ignore words are case sensitive. @@ -103,4 +104,4 @@ Using `terraform import`, import `aws_macie2_custom_data_identifier` using the i % terraform import aws_macie2_custom_data_identifier.example abcd1 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/macie2_findings_filter.html.markdown b/website/docs/cdktf/typescript/r/macie2_findings_filter.html.markdown index 13566e25f97e..bb2f50d2a418 100644 --- a/website/docs/cdktf/typescript/r/macie2_findings_filter.html.markdown +++ b/website/docs/cdktf/typescript/r/macie2_findings_filter.html.markdown @@ -35,7 +35,7 @@ class MyConvertedCode extends TerraformStack { findingCriteria: { criterion: [ { - eq: [Token.asString(current.name)], + eq: [Token.asString(current.region)], field: "region", }, ], @@ -52,6 +52,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `findingCriteria` - (Required) The criteria to use to filter findings. * `name` - (Optional) A custom name for the filter. The name must contain at least 3 characters and can contain as many as 64 characters. If omitted, Terraform will assign a random, unique name. Conflicts with `namePrefix`. * `namePrefix` - (Optional) Creates a unique name beginning with the specified prefix. Conflicts with `name`. @@ -111,4 +112,4 @@ Using `terraform import`, import `aws_macie2_findings_filter` using the id. For % terraform import aws_macie2_findings_filter.example abcd1 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/macie2_invitation_accepter.html.markdown b/website/docs/cdktf/typescript/r/macie2_invitation_accepter.html.markdown index b53c9bdfa9f7..c7e0b7e309ee 100644 --- a/website/docs/cdktf/typescript/r/macie2_invitation_accepter.html.markdown +++ b/website/docs/cdktf/typescript/r/macie2_invitation_accepter.html.markdown @@ -61,6 +61,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `administratorAccountId` - (Required) The AWS account ID for the account that sent the invitation. ## Attribute Reference @@ -102,4 +103,4 @@ Using `terraform import`, import `aws_macie2_invitation_accepter` using the admi % terraform import aws_macie2_invitation_accepter.example 123456789012 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/macie2_member.html.markdown b/website/docs/cdktf/typescript/r/macie2_member.html.markdown index 17132f8dbd32..95f58b7e151d 100644 --- a/website/docs/cdktf/typescript/r/macie2_member.html.markdown +++ b/website/docs/cdktf/typescript/r/macie2_member.html.markdown @@ -47,6 +47,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `accountId` - (Required) The AWS account ID for the account. * `email` - (Required) The email address for the account. * `tags` - (Optional) A map of key-value pairs that specifies the tags to associate with the account in Amazon Macie. @@ -96,4 +97,4 @@ Using `terraform import`, import `aws_macie2_member` using the account ID of the % terraform import aws_macie2_member.example 123456789012 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/macie2_organization_admin_account.html.markdown b/website/docs/cdktf/typescript/r/macie2_organization_admin_account.html.markdown index 7407fd466555..166001a38200 100644 --- a/website/docs/cdktf/typescript/r/macie2_organization_admin_account.html.markdown +++ b/website/docs/cdktf/typescript/r/macie2_organization_admin_account.html.markdown @@ -44,6 +44,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `adminAccountId` - (Required) The AWS account ID for the account to designate as the delegated Amazon Macie administrator account for the organization. ## Attribute Reference @@ -84,4 +85,4 @@ Using `terraform import`, import `aws_macie2_organization_admin_account` using t % terraform import aws_macie2_organization_admin_account.example abcd1 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/macie2_organization_configuration.html.markdown b/website/docs/cdktf/typescript/r/macie2_organization_configuration.html.markdown index d2ceb484a74f..2d06889b49d1 100644 --- a/website/docs/cdktf/typescript/r/macie2_organization_configuration.html.markdown +++ b/website/docs/cdktf/typescript/r/macie2_organization_configuration.html.markdown @@ -38,10 +38,11 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `autoEnable` - (Required) Whether to enable Amazon Macie automatically for accounts that are added to the organization in AWS Organizations. ## Attribute Reference This resource exports no additional attributes. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/main_route_table_association.html.markdown b/website/docs/cdktf/typescript/r/main_route_table_association.html.markdown index 43a989700cba..814e8faae0d5 100644 --- a/website/docs/cdktf/typescript/r/main_route_table_association.html.markdown +++ b/website/docs/cdktf/typescript/r/main_route_table_association.html.markdown @@ -42,6 +42,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `vpcId` - (Required) The ID of the VPC whose main route table should be set * `routeTableId` - (Required) The ID of the Route Table to set as the new main route table for the target VPC @@ -74,4 +75,4 @@ the `main_route_table_association` delete to work properly. [tf-route-tables]: /docs/providers/aws/r/route_table.html [tf-default-route-table]: /docs/providers/aws/r/default_route_table.html - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/media_convert_queue.html.markdown b/website/docs/cdktf/typescript/r/media_convert_queue.html.markdown index 3e01664e8587..631b88a277f2 100644 --- a/website/docs/cdktf/typescript/r/media_convert_queue.html.markdown +++ b/website/docs/cdktf/typescript/r/media_convert_queue.html.markdown @@ -38,8 +38,9 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) A unique identifier describing the queue -* `concurrent_jobs` - (Optional) The maximum number of jobs your queue can process concurrently. For on-demand queues, the value you enter is constrained by your service quotas for Maximum concurrent jobs, per on-demand queue and Maximum concurrent jobs, per account. For reserved queues, specify the number of jobs you can process concurrently in your reservation plan instead. +* `concurrentJobs` - (Optional) The maximum number of jobs your queue can process concurrently. For on-demand queues, the value you enter is constrained by your service quotas for Maximum concurrent jobs, per on-demand queue and Maximum concurrent jobs, per account. For reserved queues, specify the number of jobs you can process concurrently in your reservation plan instead. * `description` - (Optional) A description of the queue * `pricingPlan` - (Optional) Specifies whether the pricing plan for the queue is on-demand or reserved. Valid values are `ON_DEMAND` or `RESERVED`. Default to `ON_DEMAND`. * `reservationPlanSettings` - (Optional) A detail pricing plan of the reserved queue. See below. @@ -90,4 +91,4 @@ Using `terraform import`, import Media Convert Queue using the queue name. For e % terraform import aws_media_convert_queue.test tf-test-queue ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/media_package_channel.html.markdown b/website/docs/cdktf/typescript/r/media_package_channel.html.markdown index 13bbe8bc76ba..4f7802c12e3f 100644 --- a/website/docs/cdktf/typescript/r/media_package_channel.html.markdown +++ b/website/docs/cdktf/typescript/r/media_package_channel.html.markdown @@ -39,6 +39,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `channelId` - (Required) A unique identifier describing the channel * `description` - (Optional) A description of the channel * `tags` - (Optional) A map of tags to assign to the resource. If configured with a provider [`defaultTags` 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. @@ -88,4 +89,4 @@ Using `terraform import`, import Media Package Channels using the channel ID. Fo % terraform import aws_media_package_channel.kittens kittens-channel ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/media_packagev2_channel_group.html.markdown b/website/docs/cdktf/typescript/r/media_packagev2_channel_group.html.markdown index e4f029fcfc10..c03763a1124b 100644 --- a/website/docs/cdktf/typescript/r/media_packagev2_channel_group.html.markdown +++ b/website/docs/cdktf/typescript/r/media_packagev2_channel_group.html.markdown @@ -22,7 +22,7 @@ import { TerraformStack } from "cdktf"; * Provider bindings are generated by running `cdktf get`. * See https://cdk.tf/provider-generation for more details. */ -import { MediaPackagev2ChannelGroup } from "./.gen/providers/aws/"; +import { MediaPackagev2ChannelGroup } from "./.gen/providers/aws/media-packagev2-channel-group"; class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); @@ -39,6 +39,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) A unique identifier naming the channel group * `description` - (Optional) A description of the channel group * `tags` - (Optional) A map of tags to assign to the resource. If configured with a provider [`defaultTags` 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. @@ -49,7 +50,7 @@ This resource exports the following attributes in addition to the arguments abov * `arn` - The ARN of the channel * `description` - The same as `description` -* `egress_domain` - The egress domain of the channel group +* `egressDomain` - The egress domain of the channel group * `tagsAll` - A map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). ## Import @@ -64,7 +65,7 @@ import { TerraformStack } from "cdktf"; * Provider bindings are generated by running `cdktf get`. * See https://cdk.tf/provider-generation for more details. */ -import { MediaPackagev2ChannelGroup } from "./.gen/providers/aws/"; +import { MediaPackagev2ChannelGroup } from "./.gen/providers/aws/media-packagev2-channel-group"; class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); @@ -84,4 +85,4 @@ Using `terraform import`, import Elemental MediaPackage Version 2 Channel Group % terraform import aws_media_packagev2_channel_group.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/media_store_container.html.markdown b/website/docs/cdktf/typescript/r/media_store_container.html.markdown index 54ff64828fe1..c44b7b9041dc 100644 --- a/website/docs/cdktf/typescript/r/media_store_container.html.markdown +++ b/website/docs/cdktf/typescript/r/media_store_container.html.markdown @@ -12,6 +12,8 @@ description: |- Provides a MediaStore Container. +!> **WARNING:** _This resource is deprecated and will be removed in a future version._ AWS has [announced](https://aws.amazon.com/blogs/media/support-for-aws-elemental-mediastore-ending-soon/) the discontinuation of AWS Elemental MediaStore, effective **November 13, 2025**. Users should begin transitioning to alternative solutions as soon as possible. For **simple live streaming workflows**, AWS recommends migrating to **Amazon S3**. For **advanced use cases** that require features such as packaging, DRM, or cross-region redundancy, consider using **AWS Elemental MediaPackage**. + ## Example Usage ```typescript @@ -38,6 +40,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) The name of the container. Must contain alphanumeric characters or underscores. * `tags` - (Optional) A map of tags to assign to the resource. If configured with a provider [`defaultTags` 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. @@ -77,4 +80,4 @@ Using `terraform import`, import MediaStore Container using the MediaStore Conta % terraform import aws_media_store_container.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/media_store_container_policy.html.markdown b/website/docs/cdktf/typescript/r/media_store_container_policy.html.markdown index 21a1e8eedf47..1ac452e38df2 100644 --- a/website/docs/cdktf/typescript/r/media_store_container_policy.html.markdown +++ b/website/docs/cdktf/typescript/r/media_store_container_policy.html.markdown @@ -12,6 +12,8 @@ description: |- Provides a MediaStore Container Policy. +!> **WARNING:** _This resource is deprecated and will be removed in a future version._ AWS has [announced](https://aws.amazon.com/blogs/media/support-for-aws-elemental-mediastore-ending-soon/) the discontinuation of AWS Elemental MediaStore, effective **November 13, 2025**. Users should begin transitioning to alternative solutions as soon as possible. For **simple live streaming workflows**, AWS recommends migrating to **Amazon S3**. For **advanced use cases** that require features such as packaging, DRM, or cross-region redundancy, consider using **AWS Elemental MediaPackage**. + ~> **NOTE:** We suggest using [`jsonencode()`](https://developer.hashicorp.com/terraform/language/functions/jsonencode) or [`aws_iam_policy_document`](/docs/providers/aws/d/iam_policy_document.html) when assigning a value to `policy`. They seamlessly translate Terraform language into JSON, enabling you to maintain consistency within your configuration without the need for context switches. Also, you can sidestep potential complications arising from formatting discrepancies, whitespace inconsistencies, and other nuances inherent to JSON. ## Example Usage @@ -62,7 +64,7 @@ class MyConvertedCode extends TerraformStack { ], resources: [ "arn:aws:mediastore:${" + - dataAwsRegionCurrent.name + + dataAwsRegionCurrent.region + "}:${" + current.accountId + "}:container/${" + @@ -95,6 +97,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `containerName` - (Required) The name of the container. * `policy` - (Required) The contents of the policy. For more information about building AWS IAM policy documents with Terraform, see the [AWS IAM Policy Document Guide](https://learn.hashicorp.com/terraform/aws/iam-policy). @@ -134,4 +137,4 @@ Using `terraform import`, import MediaStore Container Policy using the MediaStor % terraform import aws_media_store_container_policy.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/medialive_channel.html.markdown b/website/docs/cdktf/typescript/r/medialive_channel.html.markdown index 018db8c08010..a63bf8813797 100644 --- a/website/docs/cdktf/typescript/r/medialive_channel.html.markdown +++ b/website/docs/cdktf/typescript/r/medialive_channel.html.markdown @@ -123,6 +123,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `cdiInputSpecification` - (Optional) Specification of CDI inputs for this channel. See [CDI Input Specification](#cdi-input-specification) for more details. * `inputAttachments` - (Optional) Input attachments for the channel. See [Input Attachments](#input-attachments) for more details. * `logLevel` - (Optional) The log level to write to Cloudwatch logs. @@ -247,7 +248,7 @@ The following arguments are optional: ### SCTE 20 Source Settings -* `convert608To708` – (Optional) If upconvert, 608 data is both passed through via the “608 compatibility bytes” fields of the 708 wrapper as well as translated into 708. 708 data present in the source content will be discarded. +* `convert608To708` - (Optional) If upconvert, 608 data is both passed through via the “608 compatibility bytes” fields of the 708 wrapper as well as translated into 708. 708 data present in the source content will be discarded. * `source608ChannelNumber` - (Optional) Specifies the 608/708 channel number within the video track from which to extract captions. Unused for passthrough. ### SCTE 27 Source Settings @@ -596,62 +597,62 @@ The following arguments are optional: * `embeddedPlusScte20DestinationSettings` - (Optional) Embedded Plus SCTE20 Destination Settings. * `rtmpCaptionInfoDestinationSettings` - (Optional) RTMP Caption Info Destination Settings. * `scte20PlusEmbeddedDestinationSettings` - (Optional) SCTE20 Plus Embedded Destination Settings. -* `scte27DestinationSettings` – (Optional) SCTE27 Destination Settings. -* `smpteTtDestinationSettings` – (Optional) SMPTE TT Destination Settings. -* `teletextDestinationSettings` – (Optional) Teletext Destination Settings. -* `ttmlDestinationSettings` – (Optional) TTML Destination Settings. See [TTML Destination Settings](#ttml-destination-settings) for more details. +* `scte27DestinationSettings` - (Optional) SCTE27 Destination Settings. +* `smpteTtDestinationSettings` - (Optional) SMPTE TT Destination Settings. +* `teletextDestinationSettings` - (Optional) Teletext Destination Settings. +* `ttmlDestinationSettings` - (Optional) TTML Destination Settings. See [TTML Destination Settings](#ttml-destination-settings) for more details. * `webvttDestinationSettings` - (Optional) WebVTT Destination Settings. See [WebVTT Destination Settings](#webvtt-destination-settings) for more details. ### Burn In Destination Settings -* `alignment` – (Optional) If no explicit xPosition or yPosition is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. Selecting “smart” justification will left-justify live subtitles and center-justify pre-recorded subtitles. All burn-in and DVB-Sub font settings must match. -* `backgroundColor` – (Optional) Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match. -* `backgroundOpacity` – (Optional) Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter out is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match. -* `font` – (Optional) External font file used for caption burn-in. File extension must be ‘ttf’ or ‘tte’. Although the user can select output fonts for many different types of input captions, embedded, STL and teletext sources use a strict grid system. Using external fonts with these caption sources could cause unexpected display of proportional fonts. All burn-in and DVB-Sub font settings must match. See [Font](#font) for more details. -* `fontColor` – (Optional) Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. -* `fontOpacity` – (Optional) Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent. All burn-in and DVB-Sub font settings must match. -* `fontResolution` – (Optional) Font resolution in DPI (dots per inch); default is 96 dpi. All burn-in and DVB-Sub font settings must match. -* `fontSize` – (Optional) When set to ‘auto’ fontSize will scale depending on the size of the output. Giving a positive integer will specify the exact font size in points. All burn-in and DVB-Sub font settings must match. -* `outlineColor` – (Optional) Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. -* `outlineSize` – (Optional) Specifies font outline size in pixels. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. -* `shadowColor` – (Optional) Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match. -* `shadowOpacity` – (Optional) Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter out is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match. -* `shadowXOffset` – (Optional) Specifies the horizontal offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match. -* `shadowYOffset` – (Optional) Specifies the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match. -* `teletextGridControl` – (Optional) Controls whether a fixed grid size will be used to generate the output subtitles bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in outputs. -* `xPosition` – (Optional) Specifies the horizontal position of the caption relative to the left side of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit xPosition is provided, the horizontal caption position will be determined by the alignment parameter. All burn-in and DVB-Sub font settings must match. -* `yPosition` – (Optional) Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit yPosition is provided, the caption will be positioned towards the bottom of the output. All burn-in and DVB-Sub font settings must match. +* `alignment` - (Optional) If no explicit xPosition or yPosition is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. Selecting “smart” justification will left-justify live subtitles and center-justify pre-recorded subtitles. All burn-in and DVB-Sub font settings must match. +* `backgroundColor` - (Optional) Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match. +* `backgroundOpacity` - (Optional) Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter out is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match. +* `font` - (Optional) External font file used for caption burn-in. File extension must be ‘ttf’ or ‘tte’. Although the user can select output fonts for many different types of input captions, embedded, STL and teletext sources use a strict grid system. Using external fonts with these caption sources could cause unexpected display of proportional fonts. All burn-in and DVB-Sub font settings must match. See [Font](#font) for more details. +* `fontColor` - (Optional) Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. +* `fontOpacity` - (Optional) Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent. All burn-in and DVB-Sub font settings must match. +* `fontResolution` - (Optional) Font resolution in DPI (dots per inch); default is 96 dpi. All burn-in and DVB-Sub font settings must match. +* `fontSize` - (Optional) When set to ‘auto’ fontSize will scale depending on the size of the output. Giving a positive integer will specify the exact font size in points. All burn-in and DVB-Sub font settings must match. +* `outlineColor` - (Optional) Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. +* `outlineSize` - (Optional) Specifies font outline size in pixels. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. +* `shadowColor` - (Optional) Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match. +* `shadowOpacity` - (Optional) Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter out is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match. +* `shadowXOffset` - (Optional) Specifies the horizontal offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match. +* `shadowYOffset` - (Optional) Specifies the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match. +* `teletextGridControl` - (Optional) Controls whether a fixed grid size will be used to generate the output subtitles bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in outputs. +* `xPosition` - (Optional) Specifies the horizontal position of the caption relative to the left side of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit xPosition is provided, the horizontal caption position will be determined by the alignment parameter. All burn-in and DVB-Sub font settings must match. +* `yPosition` - (Optional) Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit yPosition is provided, the caption will be positioned towards the bottom of the output. All burn-in and DVB-Sub font settings must match. ### DVB Sub Destination Settings -* `alignment` – (Optional) If no explicit xPosition or yPosition is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. Selecting “smart” justification will left-justify live subtitles and center-justify pre-recorded subtitles. This option is not valid for source captions that are STL or 608/embedded. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. -* `backgroundColor` – (Optional) Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match. -* `backgroundOpacity` – (Optional) Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match. -* `font` – (Optional) External font file used for caption burn-in. File extension must be ‘ttf’ or ‘tte’. Although the user can select output fonts for many different types of input captions, embedded, STL and teletext sources use a strict grid system. Using external fonts with these caption sources could cause unexpected display of proportional fonts. All burn-in and DVB-Sub font settings must match. See [Font](#font) for more details. -* `fontColor` – (Optional) Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. -* `fontOpacity` – (Optional) Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent. All burn-in and DVB-Sub font settings must match. -* `fontResolution` – (Optional) Font resolution in DPI (dots per inch); default is 96 dpi. All burn-in and DVB-Sub font settings must match. -* `fontSize` – (Optional) When set to auto fontSize will scale depending on the size of the output. Giving a positive integer will specify the exact font size in points. All burn-in and DVB-Sub font settings must match. -* `outlineColor` – (Optional) Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. -* `outlineSize` – (Optional) Specifies font outline size in pixels. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. -* `shadowColor` – (Optional) Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match. -* `shadowOpacity` – (Optional) Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match. -* `shadowXOffset` – (Optional) Specifies the horizontal offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match. -* `shadowYOffset` – (Optional) Specifies the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match. -* `teletextGridControl` – (Optional) Controls whether a fixed grid size will be used to generate the output subtitles bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in outputs. -* `xPosition` – (Optional) Specifies the horizontal position of the caption relative to the left side of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit xPosition is provided, the horizontal caption position will be determined by the alignment parameter. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. -* `yPosition` – (Optional) Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit yPosition is provided, the caption will be positioned towards the bottom of the output. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. +* `alignment` - (Optional) If no explicit xPosition or yPosition is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. Selecting “smart” justification will left-justify live subtitles and center-justify pre-recorded subtitles. This option is not valid for source captions that are STL or 608/embedded. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. +* `backgroundColor` - (Optional) Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match. +* `backgroundOpacity` - (Optional) Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match. +* `font` - (Optional) External font file used for caption burn-in. File extension must be ‘ttf’ or ‘tte’. Although the user can select output fonts for many different types of input captions, embedded, STL and teletext sources use a strict grid system. Using external fonts with these caption sources could cause unexpected display of proportional fonts. All burn-in and DVB-Sub font settings must match. See [Font](#font) for more details. +* `fontColor` - (Optional) Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. +* `fontOpacity` - (Optional) Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent. All burn-in and DVB-Sub font settings must match. +* `fontResolution` - (Optional) Font resolution in DPI (dots per inch); default is 96 dpi. All burn-in and DVB-Sub font settings must match. +* `fontSize` - (Optional) When set to auto fontSize will scale depending on the size of the output. Giving a positive integer will specify the exact font size in points. All burn-in and DVB-Sub font settings must match. +* `outlineColor` - (Optional) Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. +* `outlineSize` - (Optional) Specifies font outline size in pixels. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. +* `shadowColor` - (Optional) Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match. +* `shadowOpacity` - (Optional) Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match. +* `shadowXOffset` - (Optional) Specifies the horizontal offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match. +* `shadowYOffset` - (Optional) Specifies the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match. +* `teletextGridControl` - (Optional) Controls whether a fixed grid size will be used to generate the output subtitles bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in outputs. +* `xPosition` - (Optional) Specifies the horizontal position of the caption relative to the left side of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit xPosition is provided, the horizontal caption position will be determined by the alignment parameter. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. +* `yPosition` - (Optional) Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit yPosition is provided, the caption will be positioned towards the bottom of the output. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. ### EBU TT D Destination Settings -* `copyrightHolder` – (Optional) Complete this field if you want to include the name of the copyright holder in the copyright tag in the captions metadata. -* `fillLineGap` – (Optional) Specifies how to handle the gap between the lines (in multi-line captions). - enabled: Fill with the captions background color (as specified in the input captions). - disabled: Leave the gap unfilled. -* `fontFamily` – (Optional) Specifies the font family to include in the font data attached to the EBU-TT captions. Valid only if styleControl is set to include. If you leave this field empty, the font family is set to “monospaced”. (If styleControl is set to exclude, the font family is always set to “monospaced”.) You specify only the font family. All other style information (color, bold, position and so on) is copied from the input captions. The size is always set to 100% to allow the downstream player to choose the size. - Enter a list of font families, as a comma-separated list of font names, in order of preference. The name can be a font family (such as “Arial”), or a generic font family (such as “serif”), or “default” (to let the downstream player choose the font). - Leave blank to set the family to “monospace”. -* `styleControl` – (Optional) Specifies the style information (font color, font position, and so on) to include in the font data that is attached to the EBU-TT captions. - include: Take the style information (font color, font position, and so on) from the source captions and include that information in the font data attached to the EBU-TT captions. This option is valid only if the source captions are Embedded or Teletext. - exclude: In the font data attached to the EBU-TT captions, set the font family to “monospaced”. Do not include any other style information. +* `copyrightHolder` - (Optional) Complete this field if you want to include the name of the copyright holder in the copyright tag in the captions metadata. +* `fillLineGap` - (Optional) Specifies how to handle the gap between the lines (in multi-line captions). - enabled: Fill with the captions background color (as specified in the input captions). - disabled: Leave the gap unfilled. +* `fontFamily` - (Optional) Specifies the font family to include in the font data attached to the EBU-TT captions. Valid only if styleControl is set to include. If you leave this field empty, the font family is set to “monospaced”. (If styleControl is set to exclude, the font family is always set to “monospaced”.) You specify only the font family. All other style information (color, bold, position and so on) is copied from the input captions. The size is always set to 100% to allow the downstream player to choose the size. - Enter a list of font families, as a comma-separated list of font names, in order of preference. The name can be a font family (such as “Arial”), or a generic font family (such as “serif”), or “default” (to let the downstream player choose the font). - Leave blank to set the family to “monospace”. +* `styleControl` - (Optional) Specifies the style information (font color, font position, and so on) to include in the font data that is attached to the EBU-TT captions. - include: Take the style information (font color, font position, and so on) from the source captions and include that information in the font data attached to the EBU-TT captions. This option is valid only if the source captions are Embedded or Teletext. - exclude: In the font data attached to the EBU-TT captions, set the font family to “monospaced”. Do not include any other style information. ### TTML Destination Settings -* `styleControl` – (Optional) This field is not currently supported and will not affect the output styling. Leave the default value. +* `styleControl` - (Optional) This field is not currently supported and will not affect the output styling. Leave the default value. ### WebVTT Destination Settings @@ -659,38 +660,38 @@ The following arguments are optional: ### Font -* `passwordParam` – (Optional) Key used to extract the password from EC2 Parameter store. -* `uri` – (Required) Path to a file accessible to the live stream. -* `username` – (Optional) Username to be used. +* `passwordParam` - (Optional) Key used to extract the password from EC2 Parameter store. +* `uri` - (Required) Path to a file accessible to the live stream. +* `username` - (Optional) Username to be used. ### Global Configuration -* `initialAudioGain` – (Optional) Value to set the initial audio gain for the Live Event. -* `inputEndAction` – (Optional) Indicates the action to take when the current input completes (e.g. end-of-file). When switchAndLoopInputs is configured the encoder will restart at the beginning of the first input. When “none” is configured the encoder will transcode either black, a solid color, or a user specified slate images per the “Input Loss Behavior” configuration until the next input switch occurs (which is controlled through the Channel Schedule API). +* `initialAudioGain` - (Optional) Value to set the initial audio gain for the Live Event. +* `inputEndAction` - (Optional) Indicates the action to take when the current input completes (e.g. end-of-file). When switchAndLoopInputs is configured the encoder will restart at the beginning of the first input. When “none” is configured the encoder will transcode either black, a solid color, or a user specified slate images per the “Input Loss Behavior” configuration until the next input switch occurs (which is controlled through the Channel Schedule API). * `inputLossBehavior` - (Optional) Settings for system actions when input is lost. See [Input Loss Behavior](#input-loss-behavior) for more details. -* `outputLockingMode` – (Optional) Indicates how MediaLive pipelines are synchronized. PIPELINE\_LOCKING - MediaLive will attempt to synchronize the output of each pipeline to the other. EPOCH\_LOCKING - MediaLive will attempt to synchronize the output of each pipeline to the Unix epoch. -* `outputTimingSource` – (Optional) Indicates whether the rate of frames emitted by the Live encoder should be paced by its system clock (which optionally may be locked to another source via NTP) or should be locked to the clock of the source that is providing the input stream. -* `supportLowFramerateInputs` – (Optional) Adjusts video input buffer for streams with very low video framerates. This is commonly set to enabled for music channels with less than one video frame per second. +* `outputLockingMode` - (Optional) Indicates how MediaLive pipelines are synchronized. PIPELINE\_LOCKING - MediaLive will attempt to synchronize the output of each pipeline to the other. EPOCH\_LOCKING - MediaLive will attempt to synchronize the output of each pipeline to the Unix epoch. +* `outputTimingSource` - (Optional) Indicates whether the rate of frames emitted by the Live encoder should be paced by its system clock (which optionally may be locked to another source via NTP) or should be locked to the clock of the source that is providing the input stream. +* `supportLowFramerateInputs` - (Optional) Adjusts video input buffer for streams with very low video framerates. This is commonly set to enabled for music channels with less than one video frame per second. ### Input Loss Behavior -* `passwordParam` – (Optional) Key used to extract the password from EC2 Parameter store. -* `uri` – (Required) Path to a file accessible to the live stream. -* `username` – (Optional) Username to be used. +* `passwordParam` - (Optional) Key used to extract the password from EC2 Parameter store. +* `uri` - (Required) Path to a file accessible to the live stream. +* `username` - (Optional) Username to be used. ### Motion Graphics Configuration -* `motionGraphicsInsertion` – (Optional) Motion Graphics Insertion. +* `motionGraphicsInsertion` - (Optional) Motion Graphics Insertion. * `motionGraphicsSettings`– (Required) Motion Graphics Settings. See [Motion Graphics Settings](#motion-graphics-settings) for more details. ### Motion Graphics Settings -* `htmlMotionGraphicsSettings` – (Optional) Html Motion Graphics Settings. +* `htmlMotionGraphicsSettings` - (Optional) Html Motion Graphics Settings. ### Nielsen Configuration -* `distributorId` – (Optional) Enter the Distributor ID assigned to your organization by Nielsen. -* `nielsenPcmToId3Tagging` – (Optional) Enables Nielsen PCM to ID3 tagging. +* `distributorId` - (Optional) Enter the Distributor ID assigned to your organization by Nielsen. +* `nielsenPcmToId3Tagging` - (Optional) Enables Nielsen PCM to ID3 tagging. ### Avail Blanking @@ -833,4 +834,4 @@ Using `terraform import`, import MediaLive Channel using the `channelId`. For ex % terraform import aws_medialive_channel.example 1234567 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/medialive_input.html.markdown b/website/docs/cdktf/typescript/r/medialive_input.html.markdown index ca1bfcffb2b4..f1019fcbd9b5 100644 --- a/website/docs/cdktf/typescript/r/medialive_input.html.markdown +++ b/website/docs/cdktf/typescript/r/medialive_input.html.markdown @@ -64,6 +64,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `destinations` - (Optional) Destination settings for PUSH type inputs. See [Destinations](#destinations) for more details. * `inputDevices` - (Optional) Settings for the devices. See [Input Devices](#input-devices) for more details. * `mediaConnectFlows` - (Optional) A list of the MediaConnect Flows. See [Media Connect Flows](#media-connect-flows) for more details. @@ -141,4 +142,4 @@ Using `terraform import`, import MediaLive Input using the `id`. For example: % terraform import aws_medialive_input.example 12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/medialive_input_security_group.html.markdown b/website/docs/cdktf/typescript/r/medialive_input_security_group.html.markdown index 6be8f0f4dc7e..759b5d87ef2b 100644 --- a/website/docs/cdktf/typescript/r/medialive_input_security_group.html.markdown +++ b/website/docs/cdktf/typescript/r/medialive_input_security_group.html.markdown @@ -51,6 +51,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `tags` - (Optional) A map of tags to assign to the InputSecurityGroup. If configured with a provider [`defaultTags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. ### Whitelist Rules @@ -105,4 +106,4 @@ Using `terraform import`, import MediaLive InputSecurityGroup using the `id`. Fo % terraform import aws_medialive_input_security_group.example 123456 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/medialive_multiplex.html.markdown b/website/docs/cdktf/typescript/r/medialive_multiplex.html.markdown index c348038c3fca..46eac8a03a1f 100644 --- a/website/docs/cdktf/typescript/r/medialive_multiplex.html.markdown +++ b/website/docs/cdktf/typescript/r/medialive_multiplex.html.markdown @@ -64,6 +64,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `startMultiplex` - (Optional) Whether to start the Multiplex. Defaults to `false`. * `tags` - (Optional) A map of tags to assign to the Multiplex. If configured with a provider [`defaultTags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. @@ -116,4 +117,4 @@ Using `terraform import`, import MediaLive Multiplex using the `id`. For example % terraform import aws_medialive_multiplex.example 12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/medialive_multiplex_program.html.markdown b/website/docs/cdktf/typescript/r/medialive_multiplex_program.html.markdown index a3538b86e5f4..921e99bd170c 100644 --- a/website/docs/cdktf/typescript/r/medialive_multiplex_program.html.markdown +++ b/website/docs/cdktf/typescript/r/medialive_multiplex_program.html.markdown @@ -86,6 +86,8 @@ The following arguments are required: The following arguments are optional: +* `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). + ### Multiple Program Settings * `programNumber` - (Required) Unique program number. @@ -154,4 +156,4 @@ Using `terraform import`, import MediaLive MultiplexProgram using the `id`, or a % terraform import aws_medialive_multiplex_program.example example_program/1234567 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/memorydb_acl.html.markdown b/website/docs/cdktf/typescript/r/memorydb_acl.html.markdown index 0cfa3e61282b..e263cb24bfdb 100644 --- a/website/docs/cdktf/typescript/r/memorydb_acl.html.markdown +++ b/website/docs/cdktf/typescript/r/memorydb_acl.html.markdown @@ -41,6 +41,7 @@ class MyConvertedCode extends TerraformStack { The following arguments are optional: +* `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). * `name` - (Optional, Forces new resource) Name of the ACL. If omitted, Terraform will assign a random, unique name. Conflicts with `namePrefix`. * `namePrefix` - (Optional, Forces new resource) Creates a unique name beginning with the specified prefix. Conflicts with `name`. * `userNames` - (Optional) Set of MemoryDB user names to be included in this ACL. @@ -83,4 +84,4 @@ Using `terraform import`, import an ACL using the `name`. For example: % terraform import aws_memorydb_acl.example my-acl ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/memorydb_cluster.html.markdown b/website/docs/cdktf/typescript/r/memorydb_cluster.html.markdown index 5647df9736f8..eba4e0694528 100644 --- a/website/docs/cdktf/typescript/r/memorydb_cluster.html.markdown +++ b/website/docs/cdktf/typescript/r/memorydb_cluster.html.markdown @@ -53,6 +53,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `autoMinorVersionUpgrade` - (Optional, Forces new resource) When set to `true`, the cluster will automatically receive minor engine version upgrades after launch. Defaults to `true`. * `dataTiering` - (Optional, Forces new resource) Enables data tiering. This option is not supported by all instance types. For more information, see [Data tiering](https://docs.aws.amazon.com/memorydb/latest/devguide/data-tiering.html). * `description` - (Optional) Description for the cluster. Defaults to `"Managed by Terraform"`. @@ -137,4 +138,4 @@ Using `terraform import`, import a cluster using the `name`. For example: % terraform import aws_memorydb_cluster.example my-cluster ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/memorydb_multi_region_cluster.html.markdown b/website/docs/cdktf/typescript/r/memorydb_multi_region_cluster.html.markdown index 824a763a3030..d55d3f648d24 100644 --- a/website/docs/cdktf/typescript/r/memorydb_multi_region_cluster.html.markdown +++ b/website/docs/cdktf/typescript/r/memorydb_multi_region_cluster.html.markdown @@ -60,6 +60,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `description` - (Optional) description for the multi-region cluster. * `engine` - (Optional) The name of the engine to be used for the multi-region cluster. Valid values are `redis` and `valkey`. * `engineVersion` - (Optional) The version of the engine to be used for the multi-region cluster. Downgrades are not supported. @@ -116,4 +117,4 @@ Using `terraform import`, import a cluster using the `multiRegionClusterName`. F % terraform import aws_memorydb_multi_region_cluster.example virxk-example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/memorydb_parameter_group.html.markdown b/website/docs/cdktf/typescript/r/memorydb_parameter_group.html.markdown index e0b23c3d1c83..f663fce500d5 100644 --- a/website/docs/cdktf/typescript/r/memorydb_parameter_group.html.markdown +++ b/website/docs/cdktf/typescript/r/memorydb_parameter_group.html.markdown @@ -51,6 +51,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `name` - (Optional, Forces new resource) Name of the parameter group. If omitted, Terraform will assign a random, unique name. Conflicts with `namePrefix`. * `namePrefix` - (Optional, Forces new resource) Creates a unique name beginning with the specified prefix. Conflicts with `name`. * `description` - (Optional, Forces new resource) Description for the parameter group. Defaults to `"Managed by Terraform"`. @@ -102,4 +103,4 @@ Using `terraform import`, import a parameter group using the `name`. For example % terraform import aws_memorydb_parameter_group.example my-parameter-group ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/memorydb_snapshot.html.markdown b/website/docs/cdktf/typescript/r/memorydb_snapshot.html.markdown index a698a5ba8784..71a432594c8c 100644 --- a/website/docs/cdktf/typescript/r/memorydb_snapshot.html.markdown +++ b/website/docs/cdktf/typescript/r/memorydb_snapshot.html.markdown @@ -41,6 +41,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `clusterName` - (Required, Forces new resource) Name of the MemoryDB cluster to take a snapshot of. * `name` - (Optional, Forces new resource) Name of the snapshot. If omitted, Terraform will assign a random, unique name. Conflicts with `namePrefix`. * `namePrefix` - (Optional, Forces new resource) Creates a unique name beginning with the specified prefix. Conflicts with `name`. @@ -106,4 +107,4 @@ Using `terraform import`, import a snapshot using the `name`. For example: % terraform import aws_memorydb_snapshot.example my-snapshot ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/memorydb_subnet_group.html.markdown b/website/docs/cdktf/typescript/r/memorydb_subnet_group.html.markdown index 74278d58d020..5f7bd6490ed6 100644 --- a/website/docs/cdktf/typescript/r/memorydb_subnet_group.html.markdown +++ b/website/docs/cdktf/typescript/r/memorydb_subnet_group.html.markdown @@ -63,6 +63,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `name` - (Optional, Forces new resource) Name of the subnet group. If omitted, Terraform will assign a random, unique name. Conflicts with `namePrefix`. * `namePrefix` - (Optional, Forces new resource) Creates a unique name beginning with the specified prefix. Conflicts with `name`. * `description` - (Optional) Description for the subnet group. Defaults to `"Managed by Terraform"`. @@ -109,4 +110,4 @@ Using `terraform import`, import a subnet group using its `name`. For example: % terraform import aws_memorydb_subnet_group.example my-subnet-group ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/memorydb_user.html.markdown b/website/docs/cdktf/typescript/r/memorydb_user.html.markdown index f3c9510392e3..f295bdcb216d 100644 --- a/website/docs/cdktf/typescript/r/memorydb_user.html.markdown +++ b/website/docs/cdktf/typescript/r/memorydb_user.html.markdown @@ -60,6 +60,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `tags` - (Optional) A map of tags to assign to the resource. If configured with a provider [`defaultTags` 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. ### authentication_mode Configuration Block @@ -108,4 +109,4 @@ Using `terraform import`, import a user using the `userName`. For example: The `passwords` are not available for imported resources, as this information cannot be read back from the MemoryDB API. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/mq_broker.html.markdown b/website/docs/cdktf/typescript/r/mq_broker.html.markdown index 9e59b8b7c06d..23a7f535559e 100644 --- a/website/docs/cdktf/typescript/r/mq_broker.html.markdown +++ b/website/docs/cdktf/typescript/r/mq_broker.html.markdown @@ -3,22 +3,22 @@ subcategory: "MQ" layout: "aws" page_title: "AWS: aws_mq_broker" description: |- - Provides an MQ Broker Resource + Manages an AWS MQ broker --- # Resource: aws_mq_broker -Provides an Amazon MQ broker resource. This resources also manages users for the broker. +Manages an AWS MQ broker. Use to create and manage message brokers for ActiveMQ and RabbitMQ engines. -> For more information on Amazon MQ, see [Amazon MQ documentation](https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/welcome.html). -~> **NOTE:** Amazon MQ currently places limits on **RabbitMQ** brokers. For example, a RabbitMQ broker cannot have: instances with an associated IP address of an ENI attached to the broker, an associated LDAP server to authenticate and authorize broker connections, storage type `EFS`, or audit logging. Although this resource allows you to create RabbitMQ users, RabbitMQ users cannot have console access or groups. Also, Amazon MQ does not return information about RabbitMQ users so drift detection is not possible. +!> **Warning:** Amazon MQ currently places limits on **RabbitMQ** brokers. For example, a RabbitMQ broker cannot have: instances with an associated IP address of an ENI attached to the broker, an associated LDAP server to authenticate and authorize broker connections, storage type `EFS`, or audit logging. Although this resource allows you to create RabbitMQ users, RabbitMQ users cannot have console access or groups. Also, Amazon MQ does not return information about RabbitMQ users so drift detection is not possible. -~> **NOTE:** Changes to an MQ Broker can occur when you change a parameter, such as `configuration` or `user`, and are reflected in the next maintenance window. Because of this, Terraform may report a difference in its planning phase because a modification has not yet taken place. You can use the `applyImmediately` flag to instruct the service to apply the change immediately (see documentation below). Using `applyImmediately` can result in a brief downtime as the broker reboots. +!> **Warning:** All arguments including the username and password will be stored in the raw state as plain-text. [Read more about sensitive data in state](https://www.terraform.io/docs/state/sensitive-data.html). -~> **NOTE:** All arguments including the username and password will be stored in the raw state as plain-text. [Read more about sensitive data in state](https://www.terraform.io/docs/state/sensitive-data.html). +~> **Note:** Changes to an MQ Broker can occur when you change a parameter, such as `configuration` or `user`, and are reflected in the next maintenance window. Because of this, Terraform may report a difference in its planning phase because a modification has not yet taken place. You can use the `applyImmediately` flag to instruct the service to apply the change immediately (see documentation below). Using `applyImmediately` can result in a brief downtime as the broker reboots. ## Example Usage @@ -48,8 +48,8 @@ class MyConvertedCode extends TerraformStack { securityGroups: [Token.asString(awsSecurityGroupTest.id)], user: [ { - password: "MindTheGap", - username: "ExampleUser", + password: "", + username: "example_user", }, ], }); @@ -60,8 +60,6 @@ class MyConvertedCode extends TerraformStack { ### High-throughput Optimized Example -This example shows the use of EBS storage for high-throughput optimized performance. - ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug import { Construct } from "constructs"; @@ -87,8 +85,8 @@ class MyConvertedCode extends TerraformStack { storageType: "ebs", user: [ { - password: "MindTheGap", - username: "ExampleUser", + password: "", + username: "example_user", }, ], }); @@ -123,13 +121,13 @@ class MyConvertedCode extends TerraformStack { securityGroups: [Token.asString(awsSecurityGroupExample.id)], user: [ { - password: "MindTheGap", - username: "ExampleUser", + password: "", + username: "example_user", }, { - password: "Example12345", + password: "", replicationUser: true, - username: "ExampleReplicationUser", + username: "example_replication_user", }, ], }); @@ -144,13 +142,13 @@ class MyConvertedCode extends TerraformStack { securityGroups: [Token.asString(awsSecurityGroupExamplePrimary.id)], user: [ { - password: "MindTheGap", - username: "ExampleUser", + password: "", + username: "example_user", }, { - password: "Example12345", + password: "", replicationUser: true, - username: "ExampleReplicationUser", + username: "example_replication_user", }, ], }); @@ -167,26 +165,27 @@ The following arguments are required: * `brokerName` - (Required) Name of the broker. * `engineType` - (Required) Type of broker engine. Valid values are `ActiveMQ` and `RabbitMQ`. -* `engineVersion` - (Required) Version of the broker engine. See the [AmazonMQ Broker Engine docs](https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html) for supported versions. For example, `5.17.6`. +* `engineVersion` - (Required) Version of the broker engine. * `hostInstanceType` - (Required) Broker's instance type. For example, `mq.t3.micro`, `mq.m5.large`. * `user` - (Required) Configuration block for broker users. For `engineType` of `RabbitMQ`, Amazon MQ does not return broker users preventing this resource from making user updates and drift detection. Detailed below. The following arguments are optional: -* `applyImmediately` - (Optional) Specifies whether any broker modifications are applied immediately, or during the next maintenance window. Default is `false`. +* `applyImmediately` - (Optional) Whether to apply broker modifications immediately. Default is `false`. * `authenticationStrategy` - (Optional) Authentication strategy used to secure the broker. Valid values are `simple` and `ldap`. `ldap` is not supported for `engineType` `RabbitMQ`. * `autoMinorVersionUpgrade` - (Optional) Whether to automatically upgrade to new minor versions of brokers as Amazon MQ makes releases available. * `configuration` - (Optional) Configuration block for broker configuration. Applies to `engineType` of `ActiveMQ` and `RabbitMQ` only. Detailed below. -* `dataReplicationMode` - (Optional) Defines whether this broker is a part of a data replication pair. Valid values are `CRDR` and `NONE`. -* `dataReplicationPrimaryBrokerArn` - (Optional) The Amazon Resource Name (ARN) of the primary broker that is used to replicate data from in a data replication pair, and is applied to the replica broker. Must be set when `dataReplicationMode` is `CRDR`. +* `dataReplicationMode` - (Optional) Whether this broker is part of a data replication pair. Valid values are `CRDR` and `NONE`. +* `dataReplicationPrimaryBrokerArn` - (Optional) ARN of the primary broker used to replicate data in a data replication pair. Required when `dataReplicationMode` is `CRDR`. * `deploymentMode` - (Optional) Deployment mode of the broker. Valid values are `SINGLE_INSTANCE`, `ACTIVE_STANDBY_MULTI_AZ`, and `CLUSTER_MULTI_AZ`. Default is `SINGLE_INSTANCE`. * `encryptionOptions` - (Optional) Configuration block containing encryption options. Detailed below. -* `ldapServerMetadata` - (Optional) Configuration block for the LDAP server used to authenticate and authorize connections to the broker. Not supported for `engineType` `RabbitMQ`. Detailed below. (Currently, AWS may not process changes to LDAP server metadata.) -* `logs` - (Optional) Configuration block for the logging configuration of the broker. Detailed below. +* `ldapServerMetadata` - (Optional) Configuration block for the LDAP server used to authenticate and authorize connections. Not supported for `engineType` `RabbitMQ`. Detailed below. +* `logs` - (Optional) Configuration block for the logging configuration. Detailed below. * `maintenanceWindowStartTime` - (Optional) Configuration block for the maintenance window start time. Detailed below. * `publiclyAccessible` - (Optional) Whether to enable connections from applications outside of the VPC that hosts the broker's subnets. +* `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). * `securityGroups` - (Optional) List of security group IDs assigned to the broker. -* `storageType` - (Optional) Storage type of the broker. For `engineType` `ActiveMQ`, the valid values are `efs` and `ebs`, and the AWS-default is `efs`. For `engineType` `RabbitMQ`, only `ebs` is supported. When using `ebs`, only the `mq.m5` broker instance type family is supported. +* `storageType` - (Optional) Storage type of the broker. For `engineType` `ActiveMQ`, valid values are `efs` and `ebs` (AWS-default is `efs`). For `engineType` `RabbitMQ`, only `ebs` is supported. When using `ebs`, only the `mq.m5` broker instance type family is supported. * `subnetIds` - (Optional) List of subnet IDs in which to launch the broker. A `SINGLE_INSTANCE` deployment requires one subnet. An `ACTIVE_STANDBY_MULTI_AZ` deployment requires multiple subnets. * `tags` - (Optional) Map of tags to assign to the broker. If configured with a provider [`defaultTags` 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. @@ -194,29 +193,29 @@ The following arguments are optional: The following arguments are optional: -* `id` - (Optional) The Configuration ID. +* `id` - (Optional) Configuration ID. * `revision` - (Optional) Revision of the Configuration. ### encryption_options The following arguments are optional: -* `kmsKeyId` - (Optional) Amazon Resource Name (ARN) of Key Management Service (KMS) Customer Master Key (CMK) to use for encryption at rest. Requires setting `useAwsOwnedKey` to `false`. To perform drift detection when AWS-managed CMKs or customer-managed CMKs are in use, this value must be configured. -* `useAwsOwnedKey` - (Optional) Whether to enable an AWS-owned KMS CMK that is not in your account. Defaults to `true`. Setting to `false` without configuring `kmsKeyId` will create an AWS-managed CMK aliased to `aws/mq` in your account. +* `kmsKeyId` - (Optional) ARN of KMS CMK to use for encryption at rest. Requires setting `useAwsOwnedKey` to `false`. To perform drift detection when AWS-managed CMKs or customer-managed CMKs are in use, this value must be configured. +* `useAwsOwnedKey` - (Optional) Whether to enable an AWS-owned KMS CMK not in your account. Defaults to `true`. Setting to `false` without configuring `kmsKeyId` creates an AWS-managed CMK aliased to `aws/mq` in your account. ### ldap_server_metadata The following arguments are optional: -* `hosts` - (Optional) List of a fully qualified domain name of the LDAP server and an optional failover server. -* `roleBase` - (Optional) Fully qualified name of the directory to search for a user’s groups. -* `roleName` - (Optional) Specifies the LDAP attribute that identifies the group name attribute in the object returned from the group membership query. +* `hosts` - (Optional) List of fully qualified domain names of the LDAP server and optional failover server. +* `roleBase` - (Optional) Fully qualified name of the directory to search for a user's groups. +* `roleName` - (Optional) LDAP attribute that identifies the group name attribute in the object returned from the group membership query. * `roleSearchMatching` - (Optional) Search criteria for groups. * `roleSearchSubtree` - (Optional) Whether the directory search scope is the entire sub-tree. * `serviceAccountPassword` - (Optional) Service account password. * `serviceAccountUsername` - (Optional) Service account username. * `userBase` - (Optional) Fully qualified name of the directory where you want to search for users. -* `userRoleName` - (Optional) Specifies the name of the LDAP attribute for the user group membership. +* `userRoleName` - (Optional) Name of the LDAP attribute for the user group membership. * `userSearchMatching` - (Optional) Search criteria for users. * `userSearchSubtree` - (Optional) Whether the directory search scope is the entire sub-tree. @@ -224,8 +223,8 @@ The following arguments are optional: The following arguments are optional: -* `audit` - (Optional) Enables audit logging. Auditing is only possible for `engineType` of `ActiveMQ`. User management action made using JMX or the ActiveMQ Web Console is logged. Defaults to `false`. -* `general` - (Optional) Enables general logging via CloudWatch. Defaults to `false`. +* `audit` - (Optional) Whether to enable audit logging. Only possible for `engineType` of `ActiveMQ`. Logs user management actions via JMX or ActiveMQ Web Console. Defaults to `false`. +* `general` - (Optional) Whether to enable general logging via CloudWatch. Defaults to `false`. ### maintenance_window_start_time @@ -237,11 +236,16 @@ The following arguments are required: ### user +The following arguments are required: + +* `password` - (Required) Password of the user. Must be 12 to 250 characters long, contain at least 4 unique characters, and must not contain commas. +* `username` - (Required) Username of the user. + +The following arguments are optional: + * `consoleAccess` - (Optional) Whether to enable access to the [ActiveMQ Web Console](http://activemq.apache.org/web-console.html) for the user. Applies to `engineType` of `ActiveMQ` only. * `groups` - (Optional) List of groups (20 maximum) to which the ActiveMQ user belongs. Applies to `engineType` of `ActiveMQ` only. -* `password` - (Required) Password of the user. It must be 12 to 250 characters long, at least 4 unique characters, and must not contain commas. -* `replicationUser` - (Optional) Whether to set set replication user. Defaults to `false`. -* `username` - (Required) Username of the user. +* `replicationUser` - (Optional) Whether to set replication user. Defaults to `false`. ~> **NOTE:** AWS currently does not support updating RabbitMQ users. Updates to users can only be in the RabbitMQ UI. @@ -252,7 +256,7 @@ This resource exports the following attributes in addition to the arguments abov * `arn` - ARN of the broker. * `id` - Unique ID that Amazon MQ generates for the broker. * `instances` - List of information about allocated brokers (both active & standby). - * `instances.0.console_url` - The URL of the [ActiveMQ Web Console](http://activemq.apache.org/web-console.html) or the [RabbitMQ Management UI](https://www.rabbitmq.com/management.html#external-monitoring) depending on `engineType`. + * `instances.0.console_url` - URL of the [ActiveMQ Web Console](http://activemq.apache.org/web-console.html) or the [RabbitMQ Management UI](https://www.rabbitmq.com/management.html#external-monitoring) depending on `engineType`. * `instances.0.ip_address` - IP Address of the broker. * `instances.0.endpoints` - Broker's wire-level protocol endpoints in the following order & format referenceable e.g., as `instances.0.endpoints.0` (SSL): * For `ActiveMQ`: @@ -263,8 +267,8 @@ This resource exports the following attributes in addition to the arguments abov * `wss://broker-id.mq.us-west-2.amazonaws.com:61619` * For `RabbitMQ`: * `amqps://broker-id.mq.us-west-2.amazonaws.com:5671` -* `pendingDataReplicationMode` - (Optional) The data replication mode that will be applied after reboot. -* `tagsAll` - A map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). +* `pendingDataReplicationMode` - Data replication mode that will be applied after reboot. +* `tagsAll` - Map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). ## Timeouts @@ -306,4 +310,4 @@ Using `terraform import`, import MQ Brokers using their broker id. For example: % terraform import aws_mq_broker.example a1b2c3d4-d5f6-7777-8888-9999aaaabbbbcccc ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/mq_configuration.html.markdown b/website/docs/cdktf/typescript/r/mq_configuration.html.markdown index ccc85435122c..f127ea4e517a 100644 --- a/website/docs/cdktf/typescript/r/mq_configuration.html.markdown +++ b/website/docs/cdktf/typescript/r/mq_configuration.html.markdown @@ -2,17 +2,14 @@ subcategory: "MQ" layout: "aws" page_title: "AWS: aws_mq_configuration" -description: |- - Provides an MQ configuration Resource +description: "Manages an Amazon MQ configuration" --- # Resource: aws_mq_configuration -Provides an MQ Configuration Resource. - -For more information on Amazon MQ, see [Amazon MQ documentation](https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/welcome.html). +Manages an Amazon MQ configuration. Use this resource to create and manage broker configurations for ActiveMQ and RabbitMQ brokers. ## Example Usage @@ -72,16 +69,17 @@ class MyConvertedCode extends TerraformStack { The following arguments are required: -* `data` - (Required) Broker configuration in XML format for `ActiveMQ` or [Cuttlefish](https://github.com/Kyorai/cuttlefish) format for `RabbitMQ`. See [official docs](https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/amazon-mq-broker-configuration-parameters.html) for supported parameters and format of the XML. +* `data` - (Required) Broker configuration in XML format for ActiveMQ or Cuttlefish format for RabbitMQ. See [AWS documentation](https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/amazon-mq-broker-configuration-parameters.html) for supported parameters and format of the XML. * `engineType` - (Required) Type of broker engine. Valid values are `ActiveMQ` and `RabbitMQ`. * `engineVersion` - (Required) Version of the broker engine. * `name` - (Required) Name of the configuration. The following arguments are optional: -* `authenticationStrategy` - (Optional) Authentication strategy associated with the configuration. Valid values are `simple` and `ldap`. `ldap` is not supported for `engineType` `RabbitMQ`. +* `authenticationStrategy` - (Optional) Authentication strategy associated with the configuration. Valid values are `simple` and `ldap`. `ldap` is not supported for RabbitMQ engine type. * `description` - (Optional) Description of the configuration. -* `tags` - (Optional) Map of tags to assign to the resource. If configured with a provider [`defaultTags` 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. +* `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). +* `tags` - (Optional) Key-value map of tags to assign to the resource. If configured with a provider [`defaultTags` 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. ## Attribute Reference @@ -90,7 +88,7 @@ This resource exports the following attributes in addition to the arguments abov * `arn` - ARN of the configuration. * `id` - Unique ID that Amazon MQ generates for the configuration. * `latestRevision` - Latest revision of the configuration. -* `tagsAll` - A map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). +* `tagsAll` - Map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). ## Import @@ -124,4 +122,4 @@ Using `terraform import`, import MQ Configurations using the configuration ID. F % terraform import aws_mq_configuration.example c-0187d1eb-88c8-475a-9b79-16ef5a10c94f ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/msk_cluster.html.markdown b/website/docs/cdktf/typescript/r/msk_cluster.html.markdown index 736b65ce40de..c6ce36d58e7e 100644 --- a/website/docs/cdktf/typescript/r/msk_cluster.html.markdown +++ b/website/docs/cdktf/typescript/r/msk_cluster.html.markdown @@ -212,16 +212,17 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: -* `brokerNodeGroupInfo` - (Required) Configuration block for the broker nodes of the Kafka cluster. +* `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). +* `brokerNodeGroupInfo` - (Required) Configuration block for the broker nodes of the Kafka cluster. See [broker_node_group_info Argument Reference](#broker_node_group_info-argument-reference) below. * `clusterName` - (Required) Name of the MSK cluster. * `kafkaVersion` - (Required) Specify the desired Kafka software version. * `numberOfBrokerNodes` - (Required) The desired total number of broker nodes in the kafka cluster. It must be a multiple of the number of specified client subnets. -* `clientAuthentication` - (Optional) Configuration block for specifying a client authentication. See below. -* `configurationInfo` - (Optional) Configuration block for specifying a MSK Configuration to attach to Kafka brokers. See below. -* `encryptionInfo` - (Optional) Configuration block for specifying encryption. See below. +* `clientAuthentication` - (Optional) Configuration block for specifying a client authentication. See [client_authentication Argument Reference](#client_authentication-argument-reference) below. +* `configurationInfo` - (Optional) Configuration block for specifying an MSK Configuration to attach to Kafka brokers. See [configuration_info Argument Reference](#configuration_info-argument-reference) below. +* `encryptionInfo` - (Optional) Configuration block for specifying encryption. See [encryption_info Argument Reference](#encryption_info-argument-reference) below. * `enhancedMonitoring` - (Optional) Specify the desired enhanced MSK CloudWatch monitoring level. See [Monitoring Amazon MSK with Amazon CloudWatch](https://docs.aws.amazon.com/msk/latest/developerguide/monitoring.html) -* `openMonitoring` - (Optional) Configuration block for JMX and Node monitoring for the MSK cluster. See below. -* `loggingInfo` - (Optional) Configuration block for streaming broker logs to Cloudwatch/S3/Kinesis Firehose. See below. +* `openMonitoring` - (Optional) Configuration block for JMX and Node monitoring for the MSK cluster. See [open_monitoring Argument Reference](#open_monitoring-argument-reference) below. +* `loggingInfo` - (Optional) Configuration block for streaming broker logs to Cloudwatch/S3/Kinesis Firehose. See [logging_info Argument Reference](#logging_info-argument-reference) below. * `storageMode` - (Optional) Controls storage mode for supported storage tiers. Valid values are: `LOCAL` or `TIERED`. * `tags` - (Optional) A map of tags to assign to the resource. If configured with a provider [`defaultTags` 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. @@ -230,14 +231,14 @@ This resource supports the following arguments: * `clientSubnets` - (Required) A list of subnets to connect to in client VPC ([documentation](https://docs.aws.amazon.com/msk/1.0/apireference/clusters.html#clusters-prop-brokernodegroupinfo-clientsubnets)). * `instanceType` - (Required) Specify the instance type to use for the kafka brokersE.g., kafka.m5.large. ([Pricing info](https://aws.amazon.com/msk/pricing/)) * `securityGroups` - (Required) A list of the security groups to associate with the elastic network interfaces to control who can communicate with the cluster. -* `azDistribution` - (Optional) The distribution of broker nodes across availability zones ([documentation](https://docs.aws.amazon.com/msk/1.0/apireference/clusters.html#clusters-model-brokerazdistribution)). Currently the only valid value is `DEFAULT`. -* `connectivityInfo` - (Optional) Information about the cluster access configuration. See below. For security reasons, you can't turn on public access while creating an MSK cluster. However, you can update an existing cluster to make it publicly accessible. You can also create a new cluster and then update it to make it publicly accessible ([documentation](https://docs.aws.amazon.com/msk/latest/developerguide/public-access.html)). -* `storageInfo` - (Optional) A block that contains information about storage volumes attached to MSK broker nodes. See below. +* `azDistribution` - (Optional) The distribution of broker nodes across availability zones ([documentation](https://docs.aws.amazon.com/msk/1.0/apireference/clusters.html#clusters-model-brokerazdistribution)). Currently, the only valid value is `DEFAULT`. +* `connectivityInfo` - (Optional) Information about the cluster access configuration. See [broker_node_group_info connectivity_info Argument Reference](#broker_node_group_info-connectivity_info-argument-reference) below. For security reasons, you can't turn on public access while creating an MSK cluster. However, you can update an existing cluster to make it publicly accessible. You can also create a new cluster and then update it to make it publicly accessible ([documentation](https://docs.aws.amazon.com/msk/latest/developerguide/public-access.html)). +* `storageInfo` - (Optional) A block that contains information about storage volumes attached to MSK broker nodes. See [broker_node_group_info storage_info Argument Reference](#broker_node_group_info-storage_info-argument-reference) below. ### broker_node_group_info connectivity_info Argument Reference -* `publicAccess` - (Optional) Access control settings for brokers. See below. -* `vpcConnectivity` - (Optional) VPC connectivity access control for brokers. See below. +* `publicAccess` - (Optional) Access control settings for brokers. See [connectivity_info public_access Argument Reference](#connectivity_info-public_access-argument-reference) below. +* `vpcConnectivity` - (Optional) VPC connectivity access control for brokers. See [connectivity_info vpc_connectivity Argument Reference](#connectivity_info-vpc_connectivity-argument-reference) below. ### connectivity_info public_access Argument Reference @@ -245,11 +246,11 @@ This resource supports the following arguments: ### connectivity_info vpc_connectivity Argument Reference -* `clientAuthentication` - (Optional) Includes all client authentication information for VPC connectivity. See below. +* `clientAuthentication` - (Optional) Includes all client authentication information for VPC connectivity. See [vpc_connectivity client_authentication Argument Reference](#vpc_connectivity-client_authentication-argument-reference) below. ### vpc_connectivity client_authentication Argument Reference -* `sasl` - (Optional) SASL authentication type details for VPC connectivity. See below. +* `sasl` - (Optional) SASL authentication type details for VPC connectivity. See [vpc_connectivity client_authentication sasl Argument Reference](#vpc_connectivity-client_authentication-sasl-argument-reference) below. * `tls` - (Optional) Enables TLS authentication for VPC connectivity. ### vpc_connectivity client_authentication sasl Argument Reference @@ -259,11 +260,11 @@ This resource supports the following arguments: ### broker_node_group_info storage_info Argument Reference -* `ebsStorageInfo` - (Optional) A block that contains EBS volume information. See below. +* `ebsStorageInfo` - (Optional) A block that contains EBS volume information. See [storage_info ebs_storage_info Argument Reference](#storage_info-ebs_storage_info-argument-reference) below. ### storage_info ebs_storage_info Argument Reference -* `provisionedThroughput` - (Optional) A block that contains EBS volume provisioned throughput information. To provision storage throughput, you must choose broker type kafka.m5.4xlarge or larger. See below. +* `provisionedThroughput` - (Optional) A block that contains EBS volume provisioned throughput information. To provision storage throughput, you must choose broker type kafka.m5.4xlarge or larger. See [ebs_storage_info provisioned_throughput Argument Reference](#ebs_storage_info-provisioned_throughput-argument-reference) below. * `volumeSize` - (Optional) The size in GiB of the EBS volume for the data drive on each broker node. Minimum value of `1` and maximum value of `16384`. ### ebs_storage_info provisioned_throughput Argument Reference @@ -273,8 +274,8 @@ This resource supports the following arguments: ### client_authentication Argument Reference -* `sasl` - (Optional) Configuration block for specifying SASL client authentication. See below. -* `tls` - (Optional) Configuration block for specifying TLS client authentication. See below. +* `sasl` - (Optional) Configuration block for specifying SASL client authentication. See [client_authentication sasl Argument Reference](#client_authentication-sasl-argument-reference) below. +* `tls` - (Optional) Configuration block for specifying TLS client authentication. See [client_authentication tls Argument Reference](#client_authentication-tls-argument-reference) below. * `unauthenticated` - (Optional) Enables unauthenticated access. #### client_authentication sasl Argument Reference @@ -293,7 +294,7 @@ This resource supports the following arguments: ### encryption_info Argument Reference -* `encryptionInTransit` - (Optional) Configuration block to specify encryption in transit. See below. +* `encryptionInTransit` - (Optional) Configuration block to specify encryption in transit. See [encryption_info encryption_in_transit Argument Reference](#encryption_info-encryption_in_transit-argument-reference) below. * `encryptionAtRestKmsKeyArn` - (Optional) You may specify a KMS key short ID or ARN (it will always output an ARN) to use for encrypting your data at rest. If no key is specified, an AWS managed KMS ('aws/msk' managed service) key will be used for encrypting the data at rest. #### encryption_info encryption_in_transit Argument Reference @@ -303,12 +304,12 @@ This resource supports the following arguments: #### open_monitoring Argument Reference -* `prometheus` - (Required) Configuration block for Prometheus settings for open monitoring. See below. +* `prometheus` - (Required) Configuration block for Prometheus settings for open monitoring. See [open_monitoring prometheus Argument Reference](#open_monitoring-prometheus-argument-reference) below. #### open_monitoring prometheus Argument Reference -* `jmxExporter` - (Optional) Configuration block for JMX Exporter. See below. -* `nodeExporter` - (Optional) Configuration block for Node Exporter. See below. +* `jmxExporter` - (Optional) Configuration block for JMX Exporter. See [open_monitoring prometheus jmx_exporter Argument Reference](#open_monitoring-prometheus-jmx_exporter-argument-reference) below. +* `nodeExporter` - (Optional) Configuration block for Node Exporter. See [open_monitoring prometheus node_exporter Argument Reference](#open_monitoring-prometheus-node_exporter-argument-reference) below. #### open_monitoring prometheus jmx_exporter Argument Reference @@ -320,7 +321,13 @@ This resource supports the following arguments: #### logging_info Argument Reference -* `brokerLogs` - (Required) Configuration block for Broker Logs settings for logging info. See below. +* `brokerLogs` - (Required) Configuration block for Broker Logs settings for logging info. See [logging_info broker_logs Argument Reference](#logging_info-broker_logs-argument-reference) below. + +#### logging_info broker_logs Argument Reference + +* `cloudwatchLogs` - (Optional) Configuration block for Cloudwatch Logs settings. See [logging_info broker_logs cloudwatch_logs Argument Reference](#logging_info-broker_logs-cloudwatch_logs-argument-reference) below. +* `firehose` - (Optional) Configuration block for Kinesis Data Firehose settings. See [logging_info broker_logs firehose Argument Reference](#logging_info-broker_logs-firehose-argument-reference) below. +* `s3` - (Optional) Configuration block for S3 settings. See [logging_info broker_logs s3 Argument Reference](#logging_info-broker_logs-s3-argument-reference) below. #### logging_info broker_logs cloudwatch_logs Argument Reference @@ -401,4 +408,4 @@ Using `terraform import`, import MSK clusters using the cluster `arn`. For examp % terraform import aws_msk_cluster.example arn:aws:kafka:us-west-2:123456789012:cluster/example/279c0212-d057-4dba-9aa9-1c4e5a25bfc7-3 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/msk_cluster_policy.html.markdown b/website/docs/cdktf/typescript/r/msk_cluster_policy.html.markdown index c5e37ddcad7b..2da579192d80 100644 --- a/website/docs/cdktf/typescript/r/msk_cluster_policy.html.markdown +++ b/website/docs/cdktf/typescript/r/msk_cluster_policy.html.markdown @@ -69,8 +69,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `clusterArn` - (Required) The Amazon Resource Name (ARN) that uniquely identifies the cluster. * `policy` - (Required) Resource policy for cluster. @@ -112,4 +113,4 @@ Using `terraform import`, import Managed Streaming for Kafka Cluster Policy usin % terraform import aws_msk_cluster_policy.example arn:aws:kafka:us-west-2:123456789012:cluster/example/279c0212-d057-4dba-9aa9-1c4e5a25bfc7-3 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/msk_configuration.html.markdown b/website/docs/cdktf/typescript/r/msk_configuration.html.markdown index 84e3f6617100..b3177722d21a 100644 --- a/website/docs/cdktf/typescript/r/msk_configuration.html.markdown +++ b/website/docs/cdktf/typescript/r/msk_configuration.html.markdown @@ -41,6 +41,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `serverProperties` - (Required) Contents of the server.properties file. Supported properties are documented in the [MSK Developer Guide](https://docs.aws.amazon.com/msk/latest/developerguide/msk-configuration-properties.html). * `kafkaVersions` - (Optional) List of Apache Kafka versions which can use this configuration. * `name` - (Required) Name of the configuration. @@ -85,4 +86,4 @@ Using `terraform import`, import MSK configurations using the configuration ARN. % terraform import aws_msk_configuration.example arn:aws:kafka:us-west-2:123456789012:configuration/example/279c0212-d057-4dba-9aa9-1c4e5a25bfc7-3 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/msk_replicator.html.markdown b/website/docs/cdktf/typescript/r/msk_replicator.html.markdown index 9a463877fd50..4646e5adc30b 100644 --- a/website/docs/cdktf/typescript/r/msk_replicator.html.markdown +++ b/website/docs/cdktf/typescript/r/msk_replicator.html.markdown @@ -87,6 +87,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `replicatorName` - (Required) The name of the replicator. * `kafkaCluster` - (Required) A list of Kafka clusters which are targets of the replicator. * `serviceExecutionRoleArn` - (Required) The ARN of the IAM role used by the replicator to access resources in the customer's account (e.g source and target clusters). @@ -188,4 +189,4 @@ Using `terraform import`, import MSK replicators using the replicator ARN. For e % terraform import aws_msk_replicator.example arn:aws:kafka:us-west-2:123456789012:configuration/example/279c0212-d057-4dba-9aa9-1c4e5a25bfc7-3 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/msk_scram_secret_association.html.markdown b/website/docs/cdktf/typescript/r/msk_scram_secret_association.html.markdown index da8c32992a3b..60f6521b51d7 100644 --- a/website/docs/cdktf/typescript/r/msk_scram_secret_association.html.markdown +++ b/website/docs/cdktf/typescript/r/msk_scram_secret_association.html.markdown @@ -139,6 +139,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `clusterArn` - (Required, Forces new resource) Amazon Resource Name (ARN) of the MSK cluster. * `secretArnList` - (Required) List of AWS Secrets Manager secret ARNs. @@ -180,4 +181,4 @@ Using `terraform import`, import MSK SCRAM Secret Associations using the `id`. F % terraform import aws_msk_scram_secret_association.example arn:aws:kafka:us-west-2:123456789012:cluster/example/279c0212-d057-4dba-9aa9-1c4e5a25bfc7-3 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/msk_serverless_cluster.html.markdown b/website/docs/cdktf/typescript/r/msk_serverless_cluster.html.markdown index cdb780074ee5..39c3fbbd43ae 100644 --- a/website/docs/cdktf/typescript/r/msk_serverless_cluster.html.markdown +++ b/website/docs/cdktf/typescript/r/msk_serverless_cluster.html.markdown @@ -55,6 +55,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `clientAuthentication` - (Required) Specifies client authentication information for the serverless cluster. See below. * `clusterName` - (Required) The name of the serverless cluster. * `tags` - (Optional) A map of tags to assign to the resource. If configured with a provider [`defaultTags` 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. @@ -125,4 +126,4 @@ Using `terraform import`, import MSK serverless clusters using the cluster `arn` % terraform import aws_msk_serverless_cluster.example arn:aws:kafka:us-west-2:123456789012:cluster/example/279c0212-d057-4dba-9aa9-1c4e5a25bfc7-3 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/msk_single_scram_secret_association.html.markdown b/website/docs/cdktf/typescript/r/msk_single_scram_secret_association.html.markdown index c74fb1509c06..9252f6bfc761 100644 --- a/website/docs/cdktf/typescript/r/msk_single_scram_secret_association.html.markdown +++ b/website/docs/cdktf/typescript/r/msk_single_scram_secret_association.html.markdown @@ -39,6 +39,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `clusterArn` - (Required, Forces new resource) Amazon Resource Name (ARN) of the MSK cluster. * `secretArn` - (Required, Forces new resource) AWS Secrets Manager secret ARN. @@ -78,4 +79,4 @@ Using `terraform import`, import an MSK SCRAM Secret Association using the `clus % terraform import aws_msk_single_scram_secret_association.example arn:aws:kafka:us-west-2:123456789012:cluster/example/279c0212-d057-4dba-9aa9-1c4e5a25bfc7-3,arn:aws:secretsmanager:us-east-1:123456789012:secret:example-123456 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/msk_vpc_connection.html.markdown b/website/docs/cdktf/typescript/r/msk_vpc_connection.html.markdown index 6f63c7882208..f690bca54ece 100644 --- a/website/docs/cdktf/typescript/r/msk_vpc_connection.html.markdown +++ b/website/docs/cdktf/typescript/r/msk_vpc_connection.html.markdown @@ -41,6 +41,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `authentication` - (Required) The authentication type for the client VPC connection. Specify one of these auth type strings: SASL_IAM, SASL_SCRAM, or TLS. * `clientSubnets` - (Required) The list of subnets in the client VPC to connect to. * `securityGroups` - (Required) The security groups to attach to the ENIs for the broker nodes. @@ -95,4 +96,4 @@ Using `terraform import`, import MSK configurations using the configuration ARN. % terraform import aws_msk_vpc_connection.example arn:aws:kafka:eu-west-2:123456789012:vpc-connection/123456789012/example/38173259-79cd-4ee8-87f3-682ea6023f48-2 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/mskconnect_connector.html.markdown b/website/docs/cdktf/typescript/r/mskconnect_connector.html.markdown index caca95caa28a..14570fbd3bd6 100644 --- a/website/docs/cdktf/typescript/r/mskconnect_connector.html.markdown +++ b/website/docs/cdktf/typescript/r/mskconnect_connector.html.markdown @@ -100,6 +100,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `description` - (Optional) A summary description of the connector. * `logDelivery` - (Optional) Details about log delivery. See [`logDelivery` Block](#log_delivery-block) for details. * `tags` - (Optional) A map of tags to assign to the resource. If configured with a provider [`defaultTags` 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. @@ -277,4 +278,4 @@ Using `terraform import`, import MSK Connect Connector using the connector's `ar % terraform import aws_mskconnect_connector.example 'arn:aws:kafkaconnect:eu-central-1:123456789012:connector/example/264edee4-17a3-412e-bd76-6681cfc93805-3' ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/mskconnect_custom_plugin.html.markdown b/website/docs/cdktf/typescript/r/mskconnect_custom_plugin.html.markdown index 6cc6aff7b15a..e41cf9929ab2 100644 --- a/website/docs/cdktf/typescript/r/mskconnect_custom_plugin.html.markdown +++ b/website/docs/cdktf/typescript/r/mskconnect_custom_plugin.html.markdown @@ -65,6 +65,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required, Forces new resource) The name of the custom plugin.. * `contentType` - (Required, Forces new resource) The type of the plugin file. Allowed values are `ZIP` and `JAR`. * `description` - (Optional, Forces new resource) A summary description of the custom plugin. @@ -133,4 +134,4 @@ Using `terraform import`, import MSK Connect Custom Plugin using the plugin's `a % terraform import aws_mskconnect_custom_plugin.example 'arn:aws:kafkaconnect:eu-central-1:123456789012:custom-plugin/debezium-example/abcdefgh-1234-5678-9abc-defghijklmno-4' ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/mskconnect_worker_configuration.html.markdown b/website/docs/cdktf/typescript/r/mskconnect_worker_configuration.html.markdown index 8dc6fc4e4e05..a75e5703b188 100644 --- a/website/docs/cdktf/typescript/r/mskconnect_worker_configuration.html.markdown +++ b/website/docs/cdktf/typescript/r/mskconnect_worker_configuration.html.markdown @@ -47,6 +47,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `description` - (Optional, Forces new resource) A summary description of the worker configuration. * `tags` - (Optional) A map of tags to assign to the resource. If configured with a provider [`defaultTags` 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. @@ -96,4 +97,4 @@ Using `terraform import`, import MSK Connect Worker Configuration using the plug % terraform import aws_mskconnect_worker_configuration.example 'arn:aws:kafkaconnect:eu-central-1:123456789012:worker-configuration/example/8848493b-7fcc-478c-a646-4a52634e3378-4' ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/mwaa_environment.html.markdown b/website/docs/cdktf/typescript/r/mwaa_environment.html.markdown index 0322bae5b18d..667ca0502d9b 100644 --- a/website/docs/cdktf/typescript/r/mwaa_environment.html.markdown +++ b/website/docs/cdktf/typescript/r/mwaa_environment.html.markdown @@ -184,15 +184,17 @@ This resource supports the following arguments: * `networkConfiguration` - (Required) Specifies the network configuration for your Apache Airflow Environment. This includes two private subnets as well as security groups for the Airflow environment. Each subnet requires internet connection, otherwise the deployment will fail. See [`networkConfiguration` Block](#network_configuration-block) for details. * `pluginsS3ObjectVersion` - (Optional) The plugins.zip file version you want to use. * `pluginsS3Path` - (Optional) The relative path to the plugins.zip file on your Amazon S3 storage bucket. For example, plugins.zip. If a relative path is provided in the request, then plugins_s3_object_version is required. For more information, see [Importing DAGs on Amazon MWAA](https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-import.html). +* `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). * `requirementsS3ObjectVersion` - (Optional) The requirements.txt file version you want to use. * `requirementsS3Path` - (Optional) The relative path to the requirements.txt file on your Amazon S3 storage bucket. For example, requirements.txt. If a relative path is provided in the request, then requirements_s3_object_version is required. For more information, see [Importing DAGs on Amazon MWAA](https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-import.html). * `schedulers` - (Optional) The number of schedulers that you want to run in your environment. v2.0.2 and above accepts `2` - `5`, default `2`. v1.10.12 accepts `1`. * `sourceBucketArn` - (Required) The Amazon Resource Name (ARN) of your Amazon S3 storage bucket. For example, arn:aws:s3:::airflow-mybucketname. * `startupScriptS3ObjectVersion` - (Optional) The version of the startup shell script you want to use. You must specify the version ID that Amazon S3 assigns to the file every time you update the script. * `startupScriptS3Path` - (Optional) The relative path to the script hosted in your bucket. The script runs as your environment starts before starting the Apache Airflow process. Use this script to install dependencies, modify configuration options, and set environment variables. See [Using a startup script](https://docs.aws.amazon.com/mwaa/latest/userguide/using-startup-script.html). Supported for environment versions 2.x and later. +* `tags` - (Optional) A map of resource tags to associate with the resource. If configured with a provider [`defaultTags` 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. * `webserverAccessMode` - (Optional) Specifies whether the webserver should be accessible over the internet or via your specified VPC. Possible options: `PRIVATE_ONLY` (default) and `PUBLIC_ONLY`. * `weeklyMaintenanceWindowStart` - (Optional) Specifies the start date for the weekly maintenance window. -* `tags` - (Optional) A map of resource tags to associate with the resource. If configured with a provider [`defaultTags` 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. +* `worker_replacement_strategy` - (Optional) Worker replacement strategy. Valid values: `FORCED`, `GRACEFUL`. ### `loggingConfiguration` Block @@ -272,4 +274,4 @@ Using `terraform import`, import MWAA Environment using `Name`. For example: % terraform import aws_mwaa_environment.example MyAirflowEnvironment ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/nat_gateway.html.markdown b/website/docs/cdktf/typescript/r/nat_gateway.html.markdown index 7ea18e5883f7..f7c8a78b2457 100644 --- a/website/docs/cdktf/typescript/r/nat_gateway.html.markdown +++ b/website/docs/cdktf/typescript/r/nat_gateway.html.markdown @@ -12,6 +12,8 @@ description: |- Provides a resource to create a VPC NAT Gateway. +!> **WARNING:** You should not use the `aws_nat_gateway` resource that has `secondaryAllocationIds` in conjunction with an [`aws_nat_gateway_eip_association`](nat_gateway_eip_association.html) resource. Doing so may cause perpetual differences, and result in associations being overwritten. + ## Example Usage ### Public NAT @@ -120,10 +122,11 @@ This resource supports the following arguments: * `allocationId` - (Optional) The Allocation ID of the Elastic IP address for the NAT Gateway. Required for `connectivityType` of `public`. * `connectivityType` - (Optional) Connectivity type for the NAT Gateway. Valid values are `private` and `public`. Defaults to `public`. * `privateIp` - (Optional) The private IPv4 address to assign to the NAT Gateway. If you don't provide an address, a private IPv4 address will be automatically assigned. +* `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). * `subnetId` - (Required) The Subnet ID of the subnet in which to place the NAT Gateway. -* `secondaryAllocationIds` - (Optional) A list of secondary allocation EIP IDs for this NAT Gateway. +* `secondaryAllocationIds` - (Optional) A list of secondary allocation EIP IDs for this NAT Gateway. To remove all secondary allocations an empty list should be specified. * `secondaryPrivateIpAddressCount` - (Optional) [Private NAT Gateway only] The number of secondary private IPv4 addresses you want to assign to the NAT Gateway. -* `secondaryPrivateIpAddresses` - (Optional) A list of secondary private IPv4 addresses to assign to the NAT Gateway. +* `secondaryPrivateIpAddresses` - (Optional) A list of secondary private IPv4 addresses to assign to the NAT Gateway. To remove all secondary private addresses an empty list should be specified. * `tags` - (Optional) A map of tags to assign to the resource. If configured with a provider [`defaultTags` 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. ## Attribute Reference @@ -176,4 +179,4 @@ Using `terraform import`, import NAT Gateways using the `id`. For example: % terraform import aws_nat_gateway.private_gw nat-05dba92075d71c408 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/nat_gateway_eip_association.html.markdown b/website/docs/cdktf/typescript/r/nat_gateway_eip_association.html.markdown new file mode 100644 index 000000000000..69b619ccca49 --- /dev/null +++ b/website/docs/cdktf/typescript/r/nat_gateway_eip_association.html.markdown @@ -0,0 +1,95 @@ +--- +subcategory: "VPC (Virtual Private Cloud)" +layout: "aws" +page_title: "AWS: aws_nat_gateway_eip_association" +description: |- + Terraform resource for managing an AWS VPC NAT Gateway EIP Association. +--- + + +# Resource: aws_nat_gateway_eip_association + +Terraform resource for managing an AWS VPC NAT Gateway EIP Association. + +!> **WARNING:** You should not use the `aws_nat_gateway_eip_association` resource in conjunction with an [`aws_nat_gateway`](aws_nat_gateway.html) resource that has `secondaryAllocationIds` configured. Doing so may cause perpetual differences, and result in associations being overwritten. + +## Example Usage + +### Basic Usage + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { NatGatewayEipAssociation } from "./.gen/providers/aws/"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + new NatGatewayEipAssociation(this, "example", { + allocation_id: awsEipExample.id, + nat_gateway_id: awsNatGatewayExample.id, + }); + } +} + +``` + +## Argument Reference + +The following arguments are required: + +* `allocationId` - (Required) The ID of the Elastic IP Allocation to associate with the NAT Gateway. +* `natGatewayId` - (Required) The ID of the NAT Gateway to associate the Elastic IP Allocation to. + +The following arguments are optional: + +* `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). + +## Attribute Reference + +This resource exports no additional attributes. + +## Timeouts + +[Configuration options](https://developer.hashicorp.com/terraform/language/resources/syntax#operation-timeouts): + +* `create` - (Default `10m`) +* `delete` - (Default `30m`) + +## Import + +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import VPC NAT Gateway EIP Association using the `nat_gateway_id,allocation_id`. For example: + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { NatGatewayEipAssociation } from "./.gen/providers/aws/"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + NatGatewayEipAssociation.generateConfigForImport( + this, + "example", + "nat-1234567890abcdef1,eipalloc-1234567890abcdef1" + ); + } +} + +``` + +Using `terraform import`, import VPC NAT Gateway EIP Association using the `nat_gateway_id,allocation_id`. For example: + +```console +% terraform import aws_nat_gateway_eip_association.example nat-1234567890abcdef1,eipalloc-1234567890abcdef1 +``` + + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/neptune_cluster.html.markdown b/website/docs/cdktf/typescript/r/neptune_cluster.html.markdown index e7aef195783e..fc461224c961 100644 --- a/website/docs/cdktf/typescript/r/neptune_cluster.html.markdown +++ b/website/docs/cdktf/typescript/r/neptune_cluster.html.markdown @@ -62,6 +62,7 @@ This resource supports the following arguments: * `clusterIdentifier` - (Optional, Forces new resources) Cluster identifier. If omitted, Terraform will assign a random, unique identifier. * `clusterIdentifierPrefix` - (Optional, Forces new resource) Creates a unique cluster identifier beginning with the specified prefix. Conflicts with `clusterIdentifier`. * `copyTagsToSnapshot` - (Optional) If set to true, tags are copied to any snapshot of the DB cluster that is created. +* `deletionProtection` - (Optional) Value that indicates whether the DB cluster has deletion protection enabled.The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. * `enableCloudwatchLogsExports` - (Optional) List of the log types this DB cluster is configured to export to Cloudwatch Logs. Currently only supports `audit` and `slowquery`. * `engine` - (Optional) Name of the database engine to be used for this Neptune cluster. Defaults to `neptune`. * `engineVersion` - (Optional) Database engine version. @@ -70,21 +71,21 @@ This resource supports the following arguments: * `iamRoles` - (Optional) List of ARNs for the IAM roles to associate to the Neptune Cluster. * `iamDatabaseAuthenticationEnabled` - (Optional) Whether or not mappings of AWS Identity and Access Management (IAM) accounts to database accounts is enabled. * `kmsKeyArn` - (Optional) ARN for the KMS encryption key. When specifying `kmsKeyArn`, `storageEncrypted` needs to be set to true. -* `neptuneSubnetGroupName` - (Optional) Neptune subnet group to associate with this Neptune instance. * `neptuneClusterParameterGroupName` - (Optional) Cluster parameter group to associate with the cluster. * `neptuneInstanceParameterGroupName` – (Optional) Name of DB parameter group to apply to all instances in the cluster. When upgrading, AWS does not return this value, so do not reference it in other arguments—either leave it unset, configure each instance directly, or ensure it matches the `engineVersion`. -* `storageType` - (Optional) Storage type associated with the cluster `standard/iopt1`. Default: `standard` +* `neptuneSubnetGroupName` - (Optional) Neptune subnet group to associate with this Neptune instance. +* `port` - (Optional) Port on which the Neptune accepts connections. Default is `8182`. * `preferredBackupWindow` - (Optional) Daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter. Time in UTC. Default: A 30-minute window selected at random from an 8-hour block of time per regionE.g., 04:00-09:00 * `preferredMaintenanceWindow` - (Optional) Weekly time range during which system maintenance can occur, in (UTC) e.g., wed:04:00-wed:04:30 -* `port` - (Optional) Port on which the Neptune accepts connections. Default is `8182`. +* `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). * `replicationSourceIdentifier` - (Optional) ARN of a source Neptune cluster or Neptune instance if this Neptune cluster is to be created as a Read Replica. +* `serverlessV2ScalingConfiguration` - (Optional) If set, create the Neptune cluster as a serverless one. See [Serverless](#serverless) for example block attributes. * `skipFinalSnapshot` - (Optional) Whether a final Neptune snapshot is created before the Neptune cluster is deleted. If true is specified, no Neptune snapshot is created. If false is specified, a Neptune snapshot is created before the Neptune cluster is deleted, using the value from `finalSnapshotIdentifier`. Default is `false`. * `snapshotIdentifier` - (Optional) Whether or not to create this cluster from a snapshot. You can use either the name or ARN when specifying a Neptune cluster snapshot, or the ARN when specifying a Neptune snapshot. Automated snapshots **should not** be used for this attribute, unless from a different cluster. Automated snapshots are deleted as part of cluster destruction when the resource is replaced. * `storageEncrypted` - (Optional) Whether the Neptune cluster is encrypted. The default is `false` if not specified. +* `storageType` - (Optional) Storage type associated with the cluster `standard/iopt1`. Default: `standard`. * `tags` - (Optional) Map of tags to assign to the Neptune cluster. If configured with a provider [`defaultTags` 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. * `vpcSecurityGroupIds` - (Optional) List of VPC security groups to associate with the Cluster -* `deletionProtection` - (Optional) Value that indicates whether the DB cluster has deletion protection enabled.The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. -* `serverlessV2ScalingConfiguration` - (Optional) If set, create the Neptune cluster as a serverless one. See [Serverless](#serverless) for example block attributes. ### Serverless @@ -183,4 +184,4 @@ Using `terraform import`, import `aws_neptune_cluster` using the cluster identif % terraform import aws_neptune_cluster.example my-cluster ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/neptune_cluster_endpoint.html.markdown b/website/docs/cdktf/typescript/r/neptune_cluster_endpoint.html.markdown index 2a730a7f15b1..e160c318532b 100644 --- a/website/docs/cdktf/typescript/r/neptune_cluster_endpoint.html.markdown +++ b/website/docs/cdktf/typescript/r/neptune_cluster_endpoint.html.markdown @@ -40,6 +40,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `clusterIdentifier` - (Required, Forces new resources) The DB cluster identifier of the DB cluster associated with the endpoint. * `clusterEndpointIdentifier` - (Required, Forces new resources) The identifier of the endpoint. * `endpointType` - (Required) The type of the endpoint. One of: `READER`, `WRITER`, `ANY`. @@ -88,4 +89,4 @@ Using `terraform import`, import `aws_neptune_cluster_endpoint` using the `clust % terraform import aws_neptune_cluster_endpoint.example my-cluster:my-endpoint ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/neptune_cluster_instance.html.markdown b/website/docs/cdktf/typescript/r/neptune_cluster_instance.html.markdown index caf308dbc258..d41776cc8faf 100644 --- a/website/docs/cdktf/typescript/r/neptune_cluster_instance.html.markdown +++ b/website/docs/cdktf/typescript/r/neptune_cluster_instance.html.markdown @@ -62,6 +62,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `applyImmediately` - (Optional) Specifies whether any instance modifications are applied immediately, or during the next maintenance window. Default is`false`. * `autoMinorVersionUpgrade` - (Optional) Indicates that minor engine upgrades will be applied automatically to the instance during the maintenance window. Default is `true`. @@ -96,7 +97,7 @@ This resource exports the following attributes in addition to the arguments abov * `storageEncrypted` - Specifies whether the neptune cluster is encrypted. * `storageType` - Storage type associated with the cluster `standard/iopt1`. * `tagsAll` - A map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). -* `writer` – Boolean indicating if this instance is writable. `False` indicates this instance is a read replica. +* `writer` - Boolean indicating if this instance is writable. `False` indicates this instance is a read replica. [1]: https://www.terraform.io/docs/configuration/meta-arguments/count.html @@ -140,4 +141,4 @@ Using `terraform import`, import `aws_neptune_cluster_instance` using the instan % terraform import aws_neptune_cluster_instance.example my-instance ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/neptune_cluster_parameter_group.html.markdown b/website/docs/cdktf/typescript/r/neptune_cluster_parameter_group.html.markdown index 5ae608eaf142..d83d951e065d 100644 --- a/website/docs/cdktf/typescript/r/neptune_cluster_parameter_group.html.markdown +++ b/website/docs/cdktf/typescript/r/neptune_cluster_parameter_group.html.markdown @@ -46,6 +46,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Optional, Forces new resource) The name of the neptune cluster parameter group. If omitted, Terraform will assign a random, unique name. * `namePrefix` - (Optional, Forces new resource) Creates a unique name beginning with the specified prefix. Conflicts with `name`. * `family` - (Required) The family of the neptune cluster parameter group. @@ -99,4 +100,4 @@ Using `terraform import`, import Neptune Cluster Parameter Groups using the `nam % terraform import aws_neptune_cluster_parameter_group.cluster_pg production-pg-1 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/neptune_cluster_snapshot.html.markdown b/website/docs/cdktf/typescript/r/neptune_cluster_snapshot.html.markdown index 40245a3c2ba0..91bb648a615b 100644 --- a/website/docs/cdktf/typescript/r/neptune_cluster_snapshot.html.markdown +++ b/website/docs/cdktf/typescript/r/neptune_cluster_snapshot.html.markdown @@ -39,6 +39,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `dbClusterIdentifier` - (Required) The DB Cluster Identifier from which to take the snapshot. * `dbClusterSnapshotIdentifier` - (Required) The Identifier for the snapshot. @@ -54,7 +55,7 @@ This resource exports the following attributes in addition to the arguments abov * `kmsKeyId` - If storage_encrypted is true, the AWS KMS key identifier for the encrypted DB cluster snapshot. * `licenseModel` - License model information for the restored DB cluster. * `port` - Port that the DB cluster was listening on at the time of the snapshot. -* `source_db_cluster_snapshot_identifier` - The DB Cluster Snapshot Arn that the DB Cluster Snapshot was copied from. It only has value in case of cross customer or cross region copy. +* `sourceDbClusterSnapshotIdentifier` - The DB Cluster Snapshot Arn that the DB Cluster Snapshot was copied from. It only has value in case of cross customer or cross region copy. * `storageEncrypted` - Specifies whether the DB cluster snapshot is encrypted. * `status` - The status of this DB Cluster Snapshot. * `vpcId` - The VPC ID associated with the DB cluster snapshot. @@ -97,4 +98,4 @@ Using `terraform import`, import `aws_neptune_cluster_snapshot` using the cluste % terraform import aws_neptune_cluster_snapshot.example my-cluster-snapshot ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/neptune_event_subscription.html.markdown b/website/docs/cdktf/typescript/r/neptune_event_subscription.html.markdown index b480fcf3a88a..4ab272e08390 100644 --- a/website/docs/cdktf/typescript/r/neptune_event_subscription.html.markdown +++ b/website/docs/cdktf/typescript/r/neptune_event_subscription.html.markdown @@ -85,6 +85,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `enabled` - (Optional) A boolean flag to enable/disable the subscription. Defaults to true. * `eventCategories` - (Optional) A list of event categories for a `sourceType` that you want to subscribe to. Run `aws neptune describe-event-categories` to find all the event categories. * `name` - (Optional) The name of the Neptune event subscription. By default generated by Terraform. @@ -143,4 +144,4 @@ Using `terraform import`, import `aws_neptune_event_subscription` using the even % terraform import aws_neptune_event_subscription.example my-event-subscription ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/neptune_global_cluster.html.markdown b/website/docs/cdktf/typescript/r/neptune_global_cluster.html.markdown index e86cd3c8d7ac..b7c3d87a06fb 100644 --- a/website/docs/cdktf/typescript/r/neptune_global_cluster.html.markdown +++ b/website/docs/cdktf/typescript/r/neptune_global_cluster.html.markdown @@ -141,6 +141,7 @@ This resource supports the following arguments: * `deletionProtection` - (Optional) If the Global Cluster should have deletion protection enabled. The database can't be deleted when this value is set to `true`. The default is `false`. * `engine` - (Optional, Forces new resources) Name of the database engine to be used for this DB cluster. Terraform will only perform drift detection if a configuration value is provided. Current Valid values: `neptune`. Conflicts with `sourceDbClusterIdentifier`. * `engineVersion` - (Optional) Engine version of the global database. Upgrading the engine version will result in all cluster members being immediately updated and will. +* `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). * `sourceDbClusterIdentifier` - (Optional) ARN to use as the primary DB Cluster of the Global Cluster on creation. Terraform cannot perform drift detection of this value. * `storageEncrypted` - (Optional, Forces new resources) Whether the DB cluster is encrypted. The default is `false` unless `sourceDbClusterIdentifier` is specified and encrypted. Terraform will only perform drift detection if a configuration value is provided. @@ -219,4 +220,4 @@ class MyConvertedCode extends TerraformStack { ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/neptune_parameter_group.html.markdown b/website/docs/cdktf/typescript/r/neptune_parameter_group.html.markdown index ff4e05bf5cca..c172c20db087 100644 --- a/website/docs/cdktf/typescript/r/neptune_parameter_group.html.markdown +++ b/website/docs/cdktf/typescript/r/neptune_parameter_group.html.markdown @@ -45,6 +45,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Optional, Forces new resource) The name of the Neptune parameter group. * `namePrefix` - (Optional, Forces new resource) Creates a unique name beginning with the specified prefix. Conflicts with `name`. * `family` - (Required) The family of the Neptune parameter group. @@ -94,4 +95,4 @@ Using `terraform import`, import Neptune Parameter Groups using the `name`. For % terraform import aws_neptune_parameter_group.some_pg some-pg ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/neptune_subnet_group.html.markdown b/website/docs/cdktf/typescript/r/neptune_subnet_group.html.markdown index 1a7e55fcf651..8995605ac376 100644 --- a/website/docs/cdktf/typescript/r/neptune_subnet_group.html.markdown +++ b/website/docs/cdktf/typescript/r/neptune_subnet_group.html.markdown @@ -42,6 +42,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Optional, Forces new resource) The name of the neptune subnet group. If omitted, Terraform will assign a random, unique name. * `namePrefix` - (Optional, Forces new resource) Creates a unique name beginning with the specified prefix. Conflicts with `name`. * `description` - (Optional) The description of the neptune subnet group. Defaults to "Managed by Terraform". @@ -88,4 +89,4 @@ Using `terraform import`, import Neptune Subnet groups using the `name`. For exa % terraform import aws_neptune_subnet_group.default production-subnet-group ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/neptunegraph_graph.html.markdown b/website/docs/cdktf/typescript/r/neptunegraph_graph.html.markdown index c0b53e808a49..8da8e8ce3d96 100644 --- a/website/docs/cdktf/typescript/r/neptunegraph_graph.html.markdown +++ b/website/docs/cdktf/typescript/r/neptunegraph_graph.html.markdown @@ -10,7 +10,7 @@ description: |- # Resource: aws_neptunegraph_graph -The aws_neptunegraph_graph resource creates an Amazon Analytics Graph. +The `aws_neptunegraph_graph` resource creates an Amazon Analytics Graph. ## Example Usage @@ -61,19 +61,14 @@ The following arguments are required: The following arguments are optional: +- `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). - `deletionProtection` (Boolean, Default: `true`) Value that indicates whether the Graph has deletion protection enabled. The graph can't be deleted when deletion protection is enabled. - - `graphName` (String, Forces new resource) Contains a user-supplied name for the Graph. If omitted, Terraform will assign a random, unique identifier. - - `publicConnectivity` (Boolean, Default: `false`) Specifies whether the Graph can be reached over the internet. Access to all graphs requires IAM authentication. When the Graph is publicly reachable, its Domain Name System (DNS) endpoint resolves to the public IP address from the internet. When the Graph isn't publicly reachable, you need to create a PrivateGraphEndpoint in a given VPC to ensure the DNS name resolves to a private IP address that is reachable from the VPC. - - `replicaCount` (Number, Default: `1`, Forces new resource) Specifies the number of replicas you want when finished. All replicas will be provisioned in different availability zones. Replica Count should always be less than or equal to 2. - - `kmsKeyIdentifier` (String) The ARN for the KMS encryption key. By Default, Neptune Analytics will use an AWS provided key ("AWS_OWNED_KEY"). This parameter is used if you want to encrypt the graph using a KMS Customer Managed Key (CMK). - - `vectorSearchConfiguration` (Block, Forces new resource) Vector Search Configuration (see below for nested schema of vector_search_configuration) - -- `tags` (Attributes Set) The tags associated with this graph. (see below for nested schema of tags) +- `tags` - (Optional) Key-value tags for the graph. If configured with a provider [`defaultTags` 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. ## Attribute Reference @@ -82,6 +77,7 @@ This resource exports the following attributes in addition to the arguments abov - `endpoint` (String) The connection endpoint for the graph. For example: `g-12a3bcdef4.us-east-1.neptune-graph.amazonaws.com` - `arn` (String) Graph resource ARN - `id` (String) The auto-generated id assigned by the service. +- `tagsAll` - A map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). ## Timeouts @@ -132,4 +128,4 @@ Using `terraform import`, import `aws_neptunegraph_graph` using the graph identi % terraform import aws_neptunegraph_graph.example "graph_id" ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/network_acl.html.markdown b/website/docs/cdktf/typescript/r/network_acl.html.markdown index c05465223a72..9b30e7251fb5 100644 --- a/website/docs/cdktf/typescript/r/network_acl.html.markdown +++ b/website/docs/cdktf/typescript/r/network_acl.html.markdown @@ -72,6 +72,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `vpcId` - (Required) The ID of the associated VPC. * `subnetIds` - (Optional) A list of Subnet IDs to apply the ACL to * `ingress` - (Optional) Specifies an ingress rule. Parameters defined below. @@ -137,4 +138,4 @@ Using `terraform import`, import Network ACLs using the `id`. For example: % terraform import aws_network_acl.main acl-7aaabd18 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/network_acl_association.html.markdown b/website/docs/cdktf/typescript/r/network_acl_association.html.markdown index c5e333f10c7c..8ebef2af2f1d 100644 --- a/website/docs/cdktf/typescript/r/network_acl_association.html.markdown +++ b/website/docs/cdktf/typescript/r/network_acl_association.html.markdown @@ -43,6 +43,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `networkAclId` - (Required) The ID of the network ACL. * `subnetId` - (Required) The ID of the associated Subnet. @@ -84,4 +85,4 @@ Using `terraform import`, import Network ACL associations using the `id`. For ex % terraform import aws_network_acl_association.main aclassoc-02baf37f20966b3e6 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/network_acl_rule.html.markdown b/website/docs/cdktf/typescript/r/network_acl_rule.html.markdown index 8679c81d1062..c962ba6d44ed 100644 --- a/website/docs/cdktf/typescript/r/network_acl_rule.html.markdown +++ b/website/docs/cdktf/typescript/r/network_acl_rule.html.markdown @@ -59,6 +59,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `networkAclId` - (Required) The ID of the network ACL. * `ruleNumber` - (Required) The rule number for the entry (for example, 100). ACL entries are processed in ascending order by rule number. * `egress` - (Optional, bool) Indicates whether this is an egress rule (rule is applied to traffic leaving the subnet). Default `false`. @@ -151,4 +152,4 @@ Using the procotol's decimal value: % terraform import aws_network_acl_rule.my_rule acl-7aaabd18:100:6:false ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/network_interface.html.markdown b/website/docs/cdktf/typescript/r/network_interface.html.markdown index 0138cca2ca32..ff6ab7d9c685 100644 --- a/website/docs/cdktf/typescript/r/network_interface.html.markdown +++ b/website/docs/cdktf/typescript/r/network_interface.html.markdown @@ -67,6 +67,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `attachment` - (Optional) Configuration block to define the attachment of the ENI. See [Attachment](#attachment) below for more details! * `description` - (Optional) Description for the network interface. * `enablePrimaryIpv6` - (Optional) Enables assigning a primary IPv6 Global Unicast Address (GUA) to the network interface (ENI) in dual-stack or IPv6-only subnets. This ensures the instance attached to the ENI retains a consistent IPv6 address. Once enabled, the first IPv6 GUA becomes the primary IPv6 address and cannot be disabled. The primary IPv6 address remains assigned until the instance is terminated or the ENI is detached. Enabling and subsequent disabling forces recreation of the ENI. @@ -93,6 +94,7 @@ The `attachment` block supports the following: * `instance` - (Required) ID of the instance to attach to. * `deviceIndex` - (Required) Integer to define the devices index. +* `networkCardIndex` - (Optional) Index of the network card. Specify a value greater than 0 when using multiple network cards, which are supported by [some instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-eni.html#network-cards). The default is 0. ## Attribute Reference @@ -133,4 +135,4 @@ Using `terraform import`, import Network Interfaces using the `id`. For example: % terraform import aws_network_interface.test eni-e5aa89a3 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/network_interface_attachment.html.markdown b/website/docs/cdktf/typescript/r/network_interface_attachment.html.markdown index 6b7ef9f56138..19c92cd866bb 100644 --- a/website/docs/cdktf/typescript/r/network_interface_attachment.html.markdown +++ b/website/docs/cdktf/typescript/r/network_interface_attachment.html.markdown @@ -40,9 +40,11 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `instanceId` - (Required) Instance ID to attach. * `networkInterfaceId` - (Required) ENI ID to attach. * `deviceIndex` - (Required) Network interface index (int). +* `networkCardIndex` - (Optional) Index of the network card. Specify a value greater than 0 when using multiple network cards, which are supported by [some instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-eni.html#network-cards). The default is 0. ## Attribute Reference @@ -85,4 +87,4 @@ Using `terraform import`, import Elastic network interface (ENI) Attachments usi % terraform import aws_network_interface_attachment.secondary_nic eni-attach-0a33842b4ec347c4c ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/network_interface_permission.html.markdown b/website/docs/cdktf/typescript/r/network_interface_permission.html.markdown index 2826a367ca0f..e74792e9346e 100644 --- a/website/docs/cdktf/typescript/r/network_interface_permission.html.markdown +++ b/website/docs/cdktf/typescript/r/network_interface_permission.html.markdown @@ -56,8 +56,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `networkInterfaceId` - (Required) The ID of the network interface. * `awsAccountId` - (Required) The Amazon Web Services account ID. * `permission` - (Required) The type of permission to grant. Valid values are `INSTANCE-ATTACH` or `EIP-ASSOCIATE`. @@ -100,4 +101,4 @@ Using `terraform import`, import Network Interface Permissions using the `networ % terraform import aws_network_interface_permission.example eni-perm-056ad97ce2ac377ed ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/network_interface_sg_attachment.html.markdown b/website/docs/cdktf/typescript/r/network_interface_sg_attachment.html.markdown index 854ac9a58102..58306b01a0de 100644 --- a/website/docs/cdktf/typescript/r/network_interface_sg_attachment.html.markdown +++ b/website/docs/cdktf/typescript/r/network_interface_sg_attachment.html.markdown @@ -117,6 +117,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `securityGroupId` - (Required) The ID of the security group. * `networkInterfaceId` - (Required) The ID of the network interface to attach to. @@ -164,4 +165,4 @@ Using `terraform import`, import Network Interface Security Group attachments us % terraform import aws_network_interface_sg_attachment.sg_attachment eni-1234567890abcdef0_sg-1234567890abcdef0 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/networkfirewall_firewall.html.markdown b/website/docs/cdktf/typescript/r/networkfirewall_firewall.html.markdown index 352089676818..65dff97b9c4a 100644 --- a/website/docs/cdktf/typescript/r/networkfirewall_firewall.html.markdown +++ b/website/docs/cdktf/typescript/r/networkfirewall_firewall.html.markdown @@ -55,10 +55,65 @@ class MyConvertedCode extends TerraformStack { ``` +### Transit Gateway Attached Firewall + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { Fn, Token, TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { DataAwsAvailabilityZones } from "./.gen/providers/aws/data-aws-availability-zones"; +import { NetworkfirewallFirewall } from "./.gen/providers/aws/networkfirewall-firewall"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + const example = new DataAwsAvailabilityZones(this, "example", { + state: "available", + }); + const awsNetworkfirewallFirewallExample = new NetworkfirewallFirewall( + this, + "example_1", + { + availabilityZoneMapping: [ + { + availabilityZoneId: Token.asString( + Fn.lookupNested(example.zoneIds, ["0"]) + ), + }, + { + availabilityZoneId: Token.asString( + Fn.lookupNested(example.zoneIds, ["1"]) + ), + }, + ], + firewallPolicyArn: Token.asString( + awsNetworkfirewallFirewallPolicyExample.arn + ), + name: "example", + transitGatewayId: Token.asString(awsEc2TransitGatewayExample.id), + } + ); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + awsNetworkfirewallFirewallExample.overrideLogicalId("example"); + } +} + +``` + +### Transit Gateway Attached Firewall (Cross Account) + +A full example of how to create a Transit Gateway in one AWS account, share it with a second AWS account, and create Network Firewall in the second account to the Transit Gateway via the `aws_networkfirewall_firewall` and [`aws_networkfirewall_network_firewall_transit_gateway_attachment_accepter`](/docs/providers/aws/r/networkfirewall_network_firewall_transit_gateway_attachment_accepter.html) resources can be found in [the `./examples/network-firewall-cross-account-transit-gateway` directory within the Github Repository](https://github.com/hashicorp/terraform-provider-aws/tree/main/examples/network-firewall-cross-account-transit-gateway) + ## Argument Reference This resource supports the following arguments: +* `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). +* `availabilityZoneChangeProtection` - (Optional) A setting indicating whether the firewall is protected against changes to its Availability Zone configuration. When set to `true`, you must first disable this protection before adding or removing Availability Zones. +* `availabilityZoneMapping` - (Optional) Required when creating a transit gateway-attached firewall. Set of configuration blocks describing the avaiability availability where you want to create firewall endpoints for a transit gateway-attached firewall. * `deleteProtection` - (Optional) A flag indicating whether the firewall is protected against deletion. Use this setting to protect against accidentally deleting a firewall that is in use. Defaults to `false`. * `description` - (Optional) A friendly description of the firewall. * `enabledAnalysisTypes` - (Optional) Set of types for which to collect analysis metrics. See [Reporting on network traffic in Network Firewall](https://docs.aws.amazon.com/network-firewall/latest/developerguide/reporting.html) for details on how to use the data. Valid values: `TLS_SNI`, `HTTP_HOST`. Defaults to `[]`. @@ -67,9 +122,16 @@ This resource supports the following arguments: * `firewallPolicyChangeProtection` - (Optional) A flag indicating whether the firewall is protected against a change to the firewall policy association. Use this setting to protect against accidentally modifying the firewall policy for a firewall that is in use. Defaults to `false`. * `name` - (Required, Forces new resource) A friendly name of the firewall. * `subnetChangeProtection` - (Optional) A flag indicating whether the firewall is protected against changes to the subnet associations. Use this setting to protect against accidentally modifying the subnet associations for a firewall that is in use. Defaults to `false`. -* `subnetMapping` - (Required) Set of configuration blocks describing the public subnets. Each subnet must belong to a different Availability Zone in the VPC. AWS Network Firewall creates a firewall endpoint in each subnet. See [Subnet Mapping](#subnet-mapping) below for details. +* `subnetMapping` - (Optional) Required when creating a VPC attached firewall. Set of configuration blocks describing the public subnets. Each subnet must belong to a different Availability Zone in the VPC. AWS Network Firewall creates a firewall endpoint in each subnet. See [Subnet Mapping](#subnet-mapping) below for details. * `tags` - (Optional) Map of resource tags to associate with the resource. If configured with a provider [`defaultTags` 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. -* `vpcId` - (Required, Forces new resource) The unique identifier of the VPC where AWS Network Firewall should create the firewall. +* `transitGatewayId` - (Optional, Forces new resource). Required when creating a transit gateway-attached firewall. The unique identifier of the transit gateway to attach to this firewall. You can provide either a transit gateway from your account or one that has been shared with you through AWS Resource Access Manager +* `vpcId` - (Optional, Forces new resource) Required when creating a VPC attached firewall. The unique identifier of the VPC where AWS Network Firewall should create the firewall. + +### Availability Zone Mapping + +The `availabilityZoneMapping` block supports the following arguments: + +* `availabilityZoneId` - (Required)The ID of the Availability Zone where the firewall endpoint is located.. ### Encryption Configuration @@ -97,16 +159,19 @@ This resource exports the following attributes in addition to the arguments abov * `endpointId` - The identifier of the firewall endpoint that AWS Network Firewall has instantiated in the subnet. You use this to identify the firewall endpoint in the VPC route tables, when you redirect the VPC traffic through the endpoint. * `subnetId` - The unique identifier of the subnet that you've specified to be used for a firewall endpoint. * `availabilityZone` - The Availability Zone where the subnet is configured. + * `transit_gateway_attachment_sync_states` - Set of transit gateway configured for use by the firewall. + * `attachmentId` - The unique identifier of the transit gateway attachment. * `tagsAll` - A map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). +* `transitGatewayOwnerAccountId` - The AWS account ID that owns the transit gateway. * `updateToken` - A string token used when updating a firewall. ## Timeouts [Configuration options](https://developer.hashicorp.com/terraform/language/resources/syntax#operation-timeouts): -- `create` - (Default `30m`) -- `update` - (Default `30m`) -- `delete` - (Default `30m`) +- `create` - (Default `60m`) +- `update` - (Default `60m`) +- `delete` - (Default `60m`) ## Import @@ -140,4 +205,4 @@ Using `terraform import`, import Network Firewall Firewalls using their `arn`. F % terraform import aws_networkfirewall_firewall.example arn:aws:network-firewall:us-west-1:123456789012:firewall/example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/networkfirewall_firewall_policy.html.markdown b/website/docs/cdktf/typescript/r/networkfirewall_firewall_policy.html.markdown index 09c2dc4d347d..0537eeee8f75 100644 --- a/website/docs/cdktf/typescript/r/networkfirewall_firewall_policy.html.markdown +++ b/website/docs/cdktf/typescript/r/networkfirewall_firewall_policy.html.markdown @@ -22,10 +22,20 @@ import { Token, TerraformStack } from "cdktf"; * Provider bindings are generated by running `cdktf get`. * See https://cdk.tf/provider-generation for more details. */ +import { DataAwsCallerIdentity } from "./.gen/providers/aws/data-aws-caller-identity"; +import { DataAwsPartition } from "./.gen/providers/aws/data-aws-partition"; +import { DataAwsRegion } from "./.gen/providers/aws/data-aws-region"; import { NetworkfirewallFirewallPolicy } from "./.gen/providers/aws/networkfirewall-firewall-policy"; class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); + const current = new DataAwsCallerIdentity(this, "current", {}); + const dataAwsPartitionCurrent = new DataAwsPartition(this, "current_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.*/ + dataAwsPartitionCurrent.overrideLogicalId("current"); + const dataAwsRegionCurrent = new DataAwsRegion(this, "current_2", {}); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + dataAwsRegionCurrent.overrideLogicalId("current"); new NetworkfirewallFirewallPolicy(this, "example", { firewallPolicy: { statelessDefaultActions: ["aws:pass"], @@ -37,7 +47,13 @@ class MyConvertedCode extends TerraformStack { }, ], tlsInspectionConfigurationArn: - "arn:aws:network-firewall:REGION:ACCT:tls-configuration/example", + "arn:${" + + dataAwsPartitionCurrent.partition + + "}:network-firewall:${" + + dataAwsRegionCurrent.region + + "}:${" + + current.accountId + + "}:tls-configuration/example", }, name: "example", tags: { @@ -110,7 +126,7 @@ import { NetworkfirewallFirewallPolicy } from "./.gen/providers/aws/networkfirew class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); - new NetworkfirewallFirewallPolicy(this, "test", { + new NetworkfirewallFirewallPolicy(this, "example", { firewallPolicy: { statelessCustomAction: [ { @@ -136,18 +152,105 @@ class MyConvertedCode extends TerraformStack { ``` +## Policy with Active Threat Defense in Action Order + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { Token, TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { DataAwsPartition } from "./.gen/providers/aws/data-aws-partition"; +import { DataAwsRegion } from "./.gen/providers/aws/data-aws-region"; +import { NetworkfirewallFirewallPolicy } from "./.gen/providers/aws/networkfirewall-firewall-policy"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + const current = new DataAwsPartition(this, "current", {}); + const dataAwsRegionCurrent = new DataAwsRegion(this, "current_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.*/ + dataAwsRegionCurrent.overrideLogicalId("current"); + new NetworkfirewallFirewallPolicy(this, "example", { + firewallPolicy: { + statefulRuleGroupReference: [ + { + deepThreatInspection: Token.asString(true), + resourceArn: + "arn:${" + + current.partition + + "}:network-firewall:${" + + dataAwsRegionCurrent.region + + "}:aws-managed:stateful-rulegroup/AttackInfrastructureActionOrder", + }, + ], + statelessDefaultActions: ["aws:pass"], + statelessFragmentDefaultActions: ["aws:drop"], + }, + name: "example", + }); + } +} + +``` + +## Policy with Active Threat Defense in Strict Order + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { Token, TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { DataAwsPartition } from "./.gen/providers/aws/data-aws-partition"; +import { DataAwsRegion } from "./.gen/providers/aws/data-aws-region"; +import { NetworkfirewallFirewallPolicy } from "./.gen/providers/aws/networkfirewall-firewall-policy"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + const current = new DataAwsPartition(this, "current", {}); + const dataAwsRegionCurrent = new DataAwsRegion(this, "current_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.*/ + dataAwsRegionCurrent.overrideLogicalId("current"); + new NetworkfirewallFirewallPolicy(this, "example", { + firewallPolicy: { + statefulEngineOptions: { + ruleOrder: "STRICT_ORDER", + }, + statefulRuleGroupReference: [ + { + deepThreatInspection: Token.asString(false), + priority: 1, + resourceArn: + "arn:${" + + current.partition + + "}:network-firewall:${" + + dataAwsRegionCurrent.region + + "}:aws-managed:stateful-rulegroup/AttackInfrastructureStrictOrder", + }, + ], + statelessDefaultActions: ["aws:pass"], + statelessFragmentDefaultActions: ["aws:drop"], + }, + name: "example", + }); + } +} + +``` + ## Argument Reference This resource supports the following arguments: +* `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). * `description` - (Optional) A friendly description of the firewall policy. - * `encryptionConfiguration` - (Optional) KMS encryption configuration settings. See [Encryption Configuration](#encryption-configuration) below for details. - * `firewallPolicy` - (Required) A configuration block describing the rule groups and policy actions to use in the firewall policy. See [Firewall Policy](#firewall-policy) below for details. - * `name` - (Required, Forces new resource) A friendly name of the firewall policy. - * `tags` - (Optional) Map of resource tags to associate with the resource. If configured with a provider [`defaultTags` 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. ### Encryption Configuration @@ -201,7 +304,7 @@ The `statefulEngineOptions` block supports the following argument: ~> **NOTE:** If the `STRICT_ORDER` rule order is specified, this firewall policy can only reference stateful rule groups that utilize `STRICT_ORDER`. -* `flow_timeouts` - (Optional) Amount of time that can pass without any traffic sent through the firewall before the firewall determines that the connection is idle. +* `flowTimeouts` - (Optional) Amount of time that can pass without any traffic sent through the firewall before the firewall determines that the connection is idle. * `ruleOrder` - Indicates how to manage the order of stateful rule evaluation for the policy. Default value: `DEFAULT_ACTION_ORDER`. Valid values: `DEFAULT_ACTION_ORDER`, `STRICT_ORDER`. @@ -209,7 +312,7 @@ The `statefulEngineOptions` block supports the following argument: ### Flow Timeouts -The `flow_timeouts` block supports the following argument: +The `flowTimeouts` block supports the following argument: * `tcpIdleTimeoutSeconds` - Number of seconds that can pass without any TCP traffic sent through the firewall before the firewall determines that the connection is idle. After the idle timeout passes, data packets are dropped, however, the next TCP SYN packet is considered a new flow and is processed by the firewall. Clients or targets can use TCP keepalive packets to reset the idle timeout. Default value: `350`. @@ -217,6 +320,9 @@ The `flow_timeouts` block supports the following argument: The `statefulRuleGroupReference` block supports the following arguments: +* `deepThreatInspection` - (Optional) Whether to enable deep threat inspection, which allows AWS to analyze service logs of network traffic processed by these rule groups to identify threat indicators across customers. AWS will use these threat indicators to improve the active threat defense managed rule groups and protect the security of AWS customers and services. This only applies to active threat defense maanaged rule groups. + + For details, refer to [AWS active threat defense for AWS Network Firewall](https://docs.aws.amazon.com/network-firewall/latest/developerguide/aws-managed-rule-groups-atd.html) in the AWS Network Firewall Developer Guide. * `priority` - (Optional) An integer setting that indicates the order in which to apply the stateful rule groups in a single policy. This argument must be specified if the policy has a `statefulEngineOptions` block with a `ruleOrder` value of `STRICT_ORDER`. AWS Network Firewall applies each stateful rule group to a packet starting with the group that has the lowest priority setting. * `resourceArn` - (Required) The Amazon Resource Name (ARN) of the stateful rule group. @@ -305,4 +411,4 @@ Using `terraform import`, import Network Firewall Policies using their `arn`. Fo % terraform import aws_networkfirewall_firewall_policy.example arn:aws:network-firewall:us-west-1:123456789012:firewall-policy/example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/networkfirewall_firewall_transit_gateway_attachment_accepter.html.markdown b/website/docs/cdktf/typescript/r/networkfirewall_firewall_transit_gateway_attachment_accepter.html.markdown new file mode 100644 index 000000000000..42e0efefcc83 --- /dev/null +++ b/website/docs/cdktf/typescript/r/networkfirewall_firewall_transit_gateway_attachment_accepter.html.markdown @@ -0,0 +1,107 @@ +--- +subcategory: "Network Firewall" +layout: "aws" +page_title: "AWS: aws_networkfirewall_firewall_transit_gateway_attachment_accepter" +description: |- + Manages an AWS Network Firewall Firewall Transit Gateway Attachment Accepter. +--- + + + +# Resource: aws_networkfirewall_firewall_transit_gateway_attachment_accepter + +Manages an AWS Network Firewall Firewall Transit Gateway Attachment Accepter. + +When a cross-account (requester's AWS account differs from the accepter's AWS account) requester creates a Network Firewall with Transit Gateway ID using `aws_networkfirewall_firewall`. Then an EC2 Transit Gateway VPC Attachment resource is automatically created in the accepter's account. +The accepter can use the `aws_networkfirewall_firewall_transit_gateway_attachment_accepter` resource to "adopt" its side of the connection into management. + +~> **NOTE:** If the `transitGatewayId` argument in the `aws_networkfirewall_firewall` resource is used to attach a firewall to a transit gateway in a cross-account setup (where **Auto accept shared attachments** is disabled), the resource will be considered created when the transit gateway attachment is in the *Pending Acceptance* state and the firewall is in the *Provisioning* status. At this point, you can use the `aws_networkfirewall_firewall_transit_gateway_attachment_accepter` resource to finalize the network firewall deployment. Once the transit gateway attachment reaches the *Available* state, the firewall status *Ready*. + +## Example Usage + +### Basic Usage + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { Fn, Token, TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { NetworkfirewallFirewallTransitGatewayAttachmentAccepter } from "./.gen/providers/aws/networkfirewall-firewall-transit-gateway-attachment-accepter"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + new NetworkfirewallFirewallTransitGatewayAttachmentAccepter( + this, + "example", + { + transitGatewayAttachmentId: Token.asString( + Fn.lookupNested(awsNetworkfirewallFirewallExample.firewallStatus, [ + "0", + "transit_gateway_attachment_sync_state", + "0", + "attachment_id", + ]) + ), + } + ); + } +} + +``` + +A full example of how to create a Transit Gateway in one AWS account, share it with a second AWS account, and create Network Firewall in the second account to the Transit Gateway via the `aws_networkfirewall_firewall` and `aws_networkfirewall_firewall_transit_gateway_attachment_accepter` resources can be found in [the `./examples/network-firewall-cross-account-transit-gateway` directory within the Github Repository](https://github.com/hashicorp/terraform-provider-aws/tree/main/examples/network-firewall-cross-account-transit-gateway) + +## Argument Reference + +This resource supports the following arguments: + +* `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). +* `transitGatewayAttachmentId` - (Required) The unique identifier of the transit gateway attachment to accept. This ID is returned in the response when creating a transit gateway-attached firewall. + +## Attribute Reference + +This resource exports no additional attributes. + +## Timeouts + +[Configuration options](https://developer.hashicorp.com/terraform/language/resources/syntax#operation-timeouts): + +* `create` - (Default `60m`) +* `delete` - (Default `60m`) + +## Import + +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import Network Firewall Firewall Transit Gateway Attachment Accepter using the `transitGatewayAttachmentId`. For example: + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { NetworkfirewallFirewallTransitGatewayAttachmentAccepter } from "./.gen/providers/aws/networkfirewall-firewall-transit-gateway-attachment-accepter"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + NetworkfirewallFirewallTransitGatewayAttachmentAccepter.generateConfigForImport( + this, + "example", + "tgw-attach-0c3b7e9570eee089c" + ); + } +} + +``` + +Using `terraform import`, import Network Firewall Firewall Transit Gateway Attachment Accepter using the `transitGatewayAttachmentId`. For example: + +```console +% terraform import aws_networkfirewall_firewall_transit_gateway_attachment_accepter.example tgw-attach-0c3b7e9570eee089c +``` + + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/networkfirewall_logging_configuration.html.markdown b/website/docs/cdktf/typescript/r/networkfirewall_logging_configuration.html.markdown index 7c693459d44a..b867d467a49a 100644 --- a/website/docs/cdktf/typescript/r/networkfirewall_logging_configuration.html.markdown +++ b/website/docs/cdktf/typescript/r/networkfirewall_logging_configuration.html.markdown @@ -120,8 +120,8 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `firewallArn` - (Required, Forces new resource) The Amazon Resource Name (ARN) of the Network Firewall firewall. - * `loggingConfiguration` - (Required) A configuration block describing how AWS Network Firewall performs logging for a firewall. See [Logging Configuration](#logging-configuration) below for details. ### Logging Configuration @@ -181,4 +181,4 @@ Using `terraform import`, import Network Firewall Logging Configurations using t % terraform import aws_networkfirewall_logging_configuration.example arn:aws:network-firewall:us-west-1:123456789012:firewall/example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/networkfirewall_resource_policy.html.markdown b/website/docs/cdktf/typescript/r/networkfirewall_resource_policy.html.markdown index 290a3c58e21a..db44cc6f0a7a 100644 --- a/website/docs/cdktf/typescript/r/networkfirewall_resource_policy.html.markdown +++ b/website/docs/cdktf/typescript/r/networkfirewall_resource_policy.html.markdown @@ -101,8 +101,8 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `policy` - (Required) JSON formatted policy document that controls access to the Network Firewall resource. The policy must be provided **without whitespaces**. We recommend using [jsonencode](https://www.terraform.io/docs/configuration/functions/jsonencode.html) for formatting as seen in the examples above. For more details, including available policy statement Actions, see the [Policy](https://docs.aws.amazon.com/network-firewall/latest/APIReference/API_PutResourcePolicy.html#API_PutResourcePolicy_RequestSyntax) parameter in the AWS API documentation. - * `resourceArn` - (Required, Forces new resource) The Amazon Resource Name (ARN) of the rule group or firewall policy. ## Attribute Reference @@ -143,4 +143,4 @@ Using `terraform import`, import Network Firewall Resource Policies using the `r % terraform import aws_networkfirewall_resource_policy.example aws_networkfirewall_rule_group.example arn:aws:network-firewall:us-west-1:123456789012:stateful-rulegroup/example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/networkfirewall_rule_group.html.markdown b/website/docs/cdktf/typescript/r/networkfirewall_rule_group.html.markdown index 8fdf40b8359b..591f6cded45e 100644 --- a/website/docs/cdktf/typescript/r/networkfirewall_rule_group.html.markdown +++ b/website/docs/cdktf/typescript/r/networkfirewall_rule_group.html.markdown @@ -443,20 +443,14 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `capacity` - (Required, Forces new resource) The maximum number of operating resources that this rule group can use. For a stateless rule group, the capacity required is the sum of the capacity requirements of the individual rules. For a stateful rule group, the minimum capacity required is the number of individual rules. - * `description` - (Optional) A friendly description of the rule group. - * `encryptionConfiguration` - (Optional) KMS encryption configuration settings. See [Encryption Configuration](#encryption-configuration) below for details. - * `name` - (Required, Forces new resource) A friendly name of the rule group. - * `ruleGroup` - (Optional) A configuration block that defines the rule group rules. Required unless `rules` is specified. See [Rule Group](#rule-group) below for details. - * `rules` - (Optional) The stateful rule group rules specifications in Suricata file format, with one rule per line. Use this to import your existing Suricata compatible rule groups. Required unless `ruleGroup` is specified. - * `tags` - (Optional) A map of key:value pairs to associate with the resource. If configured with a provider [`defaultTags` 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. - * `type` - (Required) Whether the rule group is stateless (containing stateless rules) or stateful (containing stateful rules). Valid values include: `STATEFUL` or `STATELESS`. ### Encryption Configuration @@ -742,4 +736,4 @@ Using `terraform import`, import Network Firewall Rule Groups using their `arn`. % terraform import aws_networkfirewall_rule_group.example arn:aws:network-firewall:us-west-1:123456789012:stateful-rulegroup/example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/networkfirewall_tls_inspection_configuration.html.markdown b/website/docs/cdktf/typescript/r/networkfirewall_tls_inspection_configuration.html.markdown index ee63d75975a9..f824b7efaccd 100644 --- a/website/docs/cdktf/typescript/r/networkfirewall_tls_inspection_configuration.html.markdown +++ b/website/docs/cdktf/typescript/r/networkfirewall_tls_inspection_configuration.html.markdown @@ -401,6 +401,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `description` - (Optional) Description of the TLS inspection configuration. * `encryptionConfiguration` - (Optional) Encryption configuration block. Detailed below. @@ -542,4 +543,4 @@ Using `terraform import`, import Network Firewall TLS Inspection Configuration u % terraform import aws_networkfirewall_tls_inspection_configuration.example arn:aws:network-firewall::::tls-configuration/example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/networkfirewall_vpc_endpoint_association.html.markdown b/website/docs/cdktf/typescript/r/networkfirewall_vpc_endpoint_association.html.markdown new file mode 100644 index 000000000000..1daf95a944a7 --- /dev/null +++ b/website/docs/cdktf/typescript/r/networkfirewall_vpc_endpoint_association.html.markdown @@ -0,0 +1,124 @@ +--- +subcategory: "Network Firewall" +layout: "aws" +page_title: "AWS: aws_networkfirewall_vpc_endpoint_association" +description: |- + Manages a firewall endpoint for an AWS Network Firewall firewall. +--- + + + +# Resource: aws_networkfirewall_vpc_endpoint_association + +Manages a firewall endpoint for an AWS Network Firewall firewall. + +Use `aws_networkfirewall_vpc_endpoint_association` to establish new firewall endpoints in any Availability Zone where the firewall is already being used. The first use of a firewall in an Availability Zone must be defined by `aws_networkfirewall_firewall` resource and `subnetMapping` argument. + +## Example Usage + +### Basic Usage + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { Token, TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { NetworkfirewallVpcEndpointAssociation } from "./.gen/providers/aws/networkfirewall-vpc-endpoint-association"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + new NetworkfirewallVpcEndpointAssociation(this, "example", { + firewallArn: Token.asString(awsNetworkfirewallFirewallExample.arn), + subnetMapping: [ + { + subnetId: Token.asString(awsSubnetExample.id), + }, + { + subnetId: exampleTwo.id, + }, + ], + tags: { + Name: "example endpoint", + }, + vpcId: Token.asString(awsVpcExample.id), + }); + } +} + +``` + +## Argument Reference + +This resource supports the following arguments: + +* `description` (Optional) - A description of the VPC endpoint association. +* `firewallArn` (Required) - The Amazon Resource Name (ARN) that identifies the firewall. +* `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). +* `subnetMapping` (Required) - The ID for a subnet that's used in an association with a firewall. See [Subnet Mapping](#subnet-mapping) below for details. +* `tags` - (Optional) Map of resource tags to associate with the resource. If configured with a provider [`defaultTags` 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. +* `vpcId` (Required) - The unique identifier of the VPC for the endpoint association. + +### Subnet Mapping + +The `subnetMapping` block supports the following arguments: + +* `ipAddressType` - (Optional) The subnet's IP address type. Valid values: `"DUALSTACK"`, `"IPV4"`. +* `subnetId` - (Required) The unique identifier for the subnet. + +## Attribute Reference + +This resource exports the following attributes in addition to the arguments above: + +* `tagsAll` - A map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). +* `vpcEndpointAssociationArn` - ARN of the VPC Endpoint Association. +* `vpcEndpointAssociationId` - The unique identifier of the VPC endpoint association. +* `vpcEndpointAssociationStatus` - Nested list of information about the current status of the VPC Endpoint Association. + * `association_sync_states` - Set of subnets configured for use by the VPC Endpoint Association. + * `attachment` - Nested list describing the attachment status of the firewall's VPC Endpoint Association with a single VPC subnet. + * `endpointId` - The identifier of the VPC endpoint that AWS Network Firewall has instantiated in the subnet. You use this to identify the firewall endpoint in the VPC route tables, when you redirect the VPC traffic through the endpoint. + * `subnetId` - The unique identifier of the subnet that you've specified to be used for a VPC Endpoint Association endpoint. + * `availabilityZone` - The Availability Zone where the subnet is configured. + +## Timeouts + +[Configuration options](https://developer.hashicorp.com/terraform/language/resources/syntax#operation-timeouts): + +* `create` - (Default `30m`) +* `delete` - (Default `30m`) + +## Import + +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import Network Firewall VPC Endpoint Association using the `vpcEndpointAssociationArn`. For example: + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { NetworkfirewallVpcEndpointAssociation } from "./.gen/providers/aws/networkfirewall-vpc-endpoint-association"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + NetworkfirewallVpcEndpointAssociation.generateConfigForImport( + this, + "example", + "arn:aws:network-firewall:us-west-1:123456789012:vpc-endpoint-association/example" + ); + } +} + +``` + +Using `terraform import`, import Network Firewall VPC Endpoint Association using the `vpcEndpointAssociationArn`. For example: + +```console +% terraform import aws_networkfirewall_vpc_endpoint_association.example arn:aws:network-firewall:us-west-1:123456789012:vpc-endpoint-association/example +``` + + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/networkmanager_attachment_accepter.html.markdown b/website/docs/cdktf/typescript/r/networkmanager_attachment_accepter.html.markdown index 4fe219fd240d..5241d350fa13 100644 --- a/website/docs/cdktf/typescript/r/networkmanager_attachment_accepter.html.markdown +++ b/website/docs/cdktf/typescript/r/networkmanager_attachment_accepter.html.markdown @@ -3,23 +3,50 @@ subcategory: "Network Manager" layout: "aws" page_title: "AWS: aws_networkmanager_attachment_accepter" description: |- - Terraform resource for managing an AWS Network Manager Attachment Accepter. + Manages an AWS Network Manager Attachment Accepter. --- # Resource: aws_networkmanager_attachment_accepter -Terraform resource for managing an AWS Network Manager Attachment Accepter. +Manages an AWS Network Manager Attachment Accepter. + +Use this resource to accept cross-account attachments in AWS Network Manager. When an attachment is created in one account and needs to be accepted by another account that owns the core network, this resource handles the acceptance process. ## Example Usage -### Example with VPC attachment +### VPC Attachment + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { Token, TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { NetworkmanagerAttachmentAccepter } from "./.gen/providers/aws/networkmanager-attachment-accepter"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + new NetworkmanagerAttachmentAccepter(this, "example", { + attachmentId: Token.asString(awsNetworkmanagerVpcAttachmentExample.id), + attachmentType: Token.asString( + awsNetworkmanagerVpcAttachmentExample.attachmentType + ), + }); + } +} + +``` + +### Site-to-Site VPN Attachment ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug import { Construct } from "constructs"; -import { TerraformStack } from "cdktf"; +import { Token, TerraformStack } from "cdktf"; /* * Provider bindings are generated by running `cdktf get`. * See https://cdk.tf/provider-generation for more details. @@ -28,21 +55,25 @@ import { NetworkmanagerAttachmentAccepter } from "./.gen/providers/aws/networkma class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); - new NetworkmanagerAttachmentAccepter(this, "test", { - attachmentId: vpc.id, - attachmentType: vpc.attachmentType, + new NetworkmanagerAttachmentAccepter(this, "example", { + attachmentId: Token.asString( + awsNetworkmanagerSiteToSiteVpnAttachmentExample.id + ), + attachmentType: Token.asString( + awsNetworkmanagerSiteToSiteVpnAttachmentExample.attachmentType + ), }); } } ``` -### Example with site-to-site VPN attachment +### Connect Attachment ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug import { Construct } from "constructs"; -import { TerraformStack } from "cdktf"; +import { Token, TerraformStack } from "cdktf"; /* * Provider bindings are generated by running `cdktf get`. * See https://cdk.tf/provider-generation for more details. @@ -51,9 +82,67 @@ import { NetworkmanagerAttachmentAccepter } from "./.gen/providers/aws/networkma class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); - new NetworkmanagerAttachmentAccepter(this, "test", { - attachmentId: vpn.id, - attachmentType: vpn.attachmentType, + new NetworkmanagerAttachmentAccepter(this, "example", { + attachmentId: Token.asString( + awsNetworkmanagerConnectAttachmentExample.id + ), + attachmentType: Token.asString( + awsNetworkmanagerConnectAttachmentExample.attachmentType + ), + }); + } +} + +``` + +### Transit Gateway Route Table Attachment + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { Token, TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { NetworkmanagerAttachmentAccepter } from "./.gen/providers/aws/networkmanager-attachment-accepter"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + new NetworkmanagerAttachmentAccepter(this, "example", { + attachmentId: Token.asString( + awsNetworkmanagerTransitGatewayRouteTableAttachmentExample.id + ), + attachmentType: Token.asString( + awsNetworkmanagerTransitGatewayRouteTableAttachmentExample.attachmentType + ), + }); + } +} + +``` + +### Direct Connect Gateway Attachment + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { Token, TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { NetworkmanagerAttachmentAccepter } from "./.gen/providers/aws/networkmanager-attachment-accepter"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + new NetworkmanagerAttachmentAccepter(this, "example", { + attachmentId: Token.asString( + awsNetworkmanagerDxGatewayAttachmentExample.id + ), + attachmentType: Token.asString( + awsNetworkmanagerDxGatewayAttachmentExample.attachmentType + ), }); } } @@ -64,21 +153,27 @@ class MyConvertedCode extends TerraformStack { The following arguments are required: -- `attachmentId` - (Required) The ID of the attachment. -- `attachmentType` - (Required) The type of attachment. Valid values can be found in the [AWS Documentation](https://docs.aws.amazon.com/networkmanager/latest/APIReference/API_ListAttachments.html#API_ListAttachments_RequestSyntax) +* `attachmentId` - (Required) ID of the attachment. +* `attachmentType` - (Required) Type of attachment. Valid values: `CONNECT`, `DIRECT_CONNECT_GATEWAY`, `SITE_TO_SITE_VPN`, `TRANSIT_GATEWAY_ROUTE_TABLE`, `VPC`. ## Attribute Reference This resource exports the following attributes in addition to the arguments above: -- `attachmentPolicyRuleNumber` - The policy rule number associated with the attachment. -- `coreNetworkArn` - The ARN of a core network. -- `coreNetworkId` - The id of a core network. -- `edgeLocation` - The Region where the edge is located. This is returned for all attachment types except a Direct Connect gateway attachment, which instead returns `edgeLocations`. -- `edgeLocations` - The edge locations that the Direct Connect gateway is associated with. This is returned only for Direct Connect gateway attachments. All other attachment types return `edgeLocation` -- `ownerAccountId` - The ID of the attachment account owner. -- `resourceArn` - The attachment resource ARN. -- `segmentName` - The name of the segment attachment. -- `state` - The state of the attachment. - - \ No newline at end of file +* `attachmentPolicyRuleNumber` - Policy rule number associated with the attachment. +* `coreNetworkArn` - ARN of the core network. +* `coreNetworkId` - ID of the core network. +* `edgeLocation` - Region where the edge is located. This is returned for all attachment types except Direct Connect gateway attachments, which instead return `edgeLocations`. +* `edgeLocations` - Edge locations that the Direct Connect gateway is associated with. This is returned only for Direct Connect gateway attachments. All other attachment types return `edgeLocation`. +* `ownerAccountId` - ID of the attachment account owner. +* `resourceArn` - Attachment resource ARN. +* `segmentName` - Name of the segment attachment. +* `state` - State of the attachment. + +## Timeouts + +[Configuration options](https://developer.hashicorp.com/terraform/language/resources/syntax#operation-timeouts): + +* `create` - (Default `15m`) + + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/networkmanager_connect_attachment.html.markdown b/website/docs/cdktf/typescript/r/networkmanager_connect_attachment.html.markdown index ba8914a289d3..47fcf16eccaf 100644 --- a/website/docs/cdktf/typescript/r/networkmanager_connect_attachment.html.markdown +++ b/website/docs/cdktf/typescript/r/networkmanager_connect_attachment.html.markdown @@ -3,14 +3,16 @@ subcategory: "Network Manager" layout: "aws" page_title: "AWS: aws_networkmanager_connect_attachment" description: |- - Terraform resource for managing an AWS Network Manager ConnectAttachment. + Manages an AWS Network Manager Connect Attachment. --- # Resource: aws_networkmanager_connect_attachment -Terraform resource for managing an AWS Network Manager ConnectAttachment. +Manages an AWS Network Manager Connect Attachment. + +Use this resource to create a Connect attachment in AWS Network Manager. Connect attachments enable you to connect your on-premises networks to your core network through a VPC or Transit Gateway attachment. ## Example Usage @@ -81,7 +83,7 @@ class MyConvertedCode extends TerraformStack { const awsNetworkmanagerConnectAttachmentExample = new NetworkmanagerConnectAttachment(this, "example_2", { coreNetworkId: Token.asString(awsccNetworkmanagerCoreNetworkExample.id), - dependsOn: ["aws_networkmanager_attachment_accepter.test"], + dependsOn: [awsNetworkmanagerAttachmentAccepterExample], edgeLocation: example.edgeLocation, options: { protocol: "GRE", @@ -107,35 +109,40 @@ class MyConvertedCode extends TerraformStack { The following arguments are required: -- `coreNetworkId` - (Required) The ID of a core network where you want to create the attachment. -- `transportAttachmentId` - (Required) The ID of the attachment between the two connections. -- `edgeLocation` - (Required) The Region where the edge is located. -- `options` - (Required) Options block. See [options](#options) for more information. +* `coreNetworkId` - (Required) ID of a core network where you want to create the attachment. +* `edgeLocation` - (Required) Region where the edge is located. +* `options` - (Required) Options block. See [options](#options) for more information. +* `transportAttachmentId` - (Required) ID of the attachment between the two connections. The following arguments are optional: -- `tags` - (Optional) Key-value tags for the attachment. If configured with a provider [`defaultTags` 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. +* `tags` - (Optional) Key-value tags for the attachment. If configured with a provider [`defaultTags` 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. ### options -* `protocol` - (Required) The protocol used for the attachment connection. Possible values are `GRE` and `NO_ENCAP`. +* `protocol` - (Optional) Protocol used for the attachment connection. Valid values: `GRE`, `NO_ENCAP`. ## Attribute Reference This resource exports the following attributes in addition to the arguments above: -- `arn` - The ARN of the attachment. -- `attachmentPolicyRuleNumber` - The policy rule number associated with the attachment. -- `attachmentType` - The type of attachment. -- `coreNetworkArn` - The ARN of a core network. -- `coreNetworkId` - The ID of a core network -- `edgeLocation` - The Region where the edge is located. -- `id` - The ID of the attachment. -- `ownerAccountId` - The ID of the attachment account owner. -- `resourceArn` - The attachment resource ARN. -- `segmentName` - The name of the segment attachment. -- `state` - The state of the attachment. -- `tagsAll` - A map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). +* `arn` - ARN of the attachment. +* `attachmentId` - ID of the attachment. +* `attachmentPolicyRuleNumber` - Policy rule number associated with the attachment. +* `attachmentType` - Type of attachment. +* `coreNetworkArn` - ARN of a core network. +* `ownerAccountId` - ID of the attachment account owner. +* `resourceArn` - Attachment resource ARN. +* `segmentName` - Name of the segment attachment. +* `state` - State of the attachment. +* `tagsAll` - Map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). + +## Timeouts + +[Configuration options](https://developer.hashicorp.com/terraform/language/resources/syntax#operation-timeouts): + +* `create` - (Default `10m`) +* `delete` - (Default `10m`) ## Import @@ -169,4 +176,4 @@ Using `terraform import`, import `aws_networkmanager_connect_attachment` using t % terraform import aws_networkmanager_connect_attachment.example attachment-0f8fa60d2238d1bd8 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/networkmanager_connect_peer.html.markdown b/website/docs/cdktf/typescript/r/networkmanager_connect_peer.html.markdown index 93ebe01fc9b6..13b46720bad6 100644 --- a/website/docs/cdktf/typescript/r/networkmanager_connect_peer.html.markdown +++ b/website/docs/cdktf/typescript/r/networkmanager_connect_peer.html.markdown @@ -3,14 +3,16 @@ subcategory: "Network Manager" layout: "aws" page_title: "AWS: aws_networkmanager_connect_peer" description: |- - Terraform resource for managing an AWS Network Manager Connect Peer. + Manages an AWS Network Manager Connect Peer. --- # Resource: aws_networkmanager_connect_peer -Terraform resource for managing an AWS Network Manager Connect Peer. +Manages an AWS Network Manager Connect Peer. + +Use this resource to create a Connect peer in AWS Network Manager. Connect peers establish BGP sessions with your on-premises networks through Connect attachments, enabling dynamic routing between your core network and external networks. ## Example Usage @@ -99,7 +101,7 @@ class MyConvertedCode extends TerraformStack { const awsNetworkmanagerConnectAttachmentExample = new NetworkmanagerConnectAttachment(this, "example_2", { coreNetworkId: Token.asString(awsccNetworkmanagerCoreNetworkExample.id), - dependsOn: ["aws_networkmanager_attachment_accepter.test"], + dependsOn: [awsNetworkmanagerAttachmentAccepterExample], edgeLocation: example.edgeLocation, options: { protocol: "GRE", @@ -108,9 +110,17 @@ class MyConvertedCode extends TerraformStack { }); /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ awsNetworkmanagerConnectAttachmentExample.overrideLogicalId("example"); + const example2 = new NetworkmanagerAttachmentAccepter(this, "example2", { + attachmentId: Token.asString( + awsNetworkmanagerConnectAttachmentExample.id + ), + attachmentType: Token.asString( + awsNetworkmanagerConnectAttachmentExample.attachmentType + ), + }); const awsNetworkmanagerConnectPeerExample = new NetworkmanagerConnectPeer( this, - "example_3", + "example_4", { bgpOptions: { peerAsn: 65500, @@ -118,21 +128,13 @@ class MyConvertedCode extends TerraformStack { connectAttachmentId: Token.asString( awsNetworkmanagerConnectAttachmentExample.id ), - dependsOn: ["aws_networkmanager_attachment_accepter.example2"], + dependsOn: [example2], insideCidrBlocks: ["172.16.0.0/16"], peerAddress: "127.0.0.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.*/ awsNetworkmanagerConnectPeerExample.overrideLogicalId("example"); - new NetworkmanagerAttachmentAccepter(this, "example2", { - attachmentId: Token.asString( - awsNetworkmanagerConnectAttachmentExample.id - ), - attachmentType: Token.asString( - awsNetworkmanagerConnectAttachmentExample.attachmentType - ), - }); } } @@ -181,7 +183,7 @@ class MyConvertedCode extends TerraformStack { awsNetworkmanagerConnectAttachmentExample.id ), peerAddress: "127.0.0.1", - subnetArn: test2.arn, + subnetArn: example2.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.*/ @@ -195,28 +197,40 @@ class MyConvertedCode extends TerraformStack { The following arguments are required: -- `connectAttachmentId` - (Required) The ID of the connection attachment. -- `peerAddress` - (Required) The Connect peer address. +* `connectAttachmentId` - (Required) ID of the connection attachment. +* `peerAddress` - (Required) Connect peer address. The following arguments are optional: -- `bgpOptions` (Optional) The Connect peer BGP options. -- `coreNetworkAddress` (Optional) A Connect peer core network address. -- `insideCidrBlocks` - (Optional) The inside IP addresses used for BGP peering. Required when the Connect attachment protocol is `GRE`. See [`aws_networkmanager_connect_attachment`](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/networkmanager_connect_attachment) for details. -- `subnetArn` - (Optional) The subnet ARN for the Connect peer. Required when the Connect attachment protocol is `NO_ENCAP`. See [`aws_networkmanager_connect_attachment`](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/networkmanager_connect_attachment) for details. -- `tags` - (Optional) Key-value tags for the attachment. If configured with a provider [`defaultTags` 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. +* `bgpOptions` - (Optional) Connect peer BGP options. See [bgp_options](#bgp_options) for more information. +* `coreNetworkAddress` - (Optional) Connect peer core network address. +* `insideCidrBlocks` - (Optional) Inside IP addresses used for BGP peering. Required when the Connect attachment protocol is `GRE`. See [`aws_networkmanager_connect_attachment`](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/networkmanager_connect_attachment) for details. +* `subnetArn` - (Optional) Subnet ARN for the Connect peer. Required when the Connect attachment protocol is `NO_ENCAP`. See [`aws_networkmanager_connect_attachment`](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/networkmanager_connect_attachment) for details. +* `tags` - (Optional) Key-value tags for the attachment. If configured with a provider [`defaultTags` 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. + +### bgp_options + +* `peerAsn` - (Optional) Peer ASN. ## Attribute Reference This resource exports the following attributes in addition to the arguments above: -- `arn` - The ARN of the attachment. -- `configuration` - The configuration of the Connect peer. -- `coreNetworkId` - The ID of a core network. -- `edgeLocation` - The Region where the peer is located. -- `id` - The ID of the Connect peer. -- `state` - The state of the Connect peer. -- `tagsAll` - A map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). +* `arn` - ARN of the Connect peer. +* `configuration` - Configuration of the Connect peer. +* `connectPeerId` - ID of the Connect peer. +* `coreNetworkId` - ID of a core network. +* `createdAt` - Timestamp when the Connect peer was created. +* `edgeLocation` - Region where the peer is located. +* `state` - State of the Connect peer. +* `tagsAll` - Map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). + +## Timeouts + +[Configuration options](https://developer.hashicorp.com/terraform/language/resources/syntax#operation-timeouts): + +* `create` - (Default `10m`) +* `delete` - (Default `15m`) ## Import @@ -250,4 +264,4 @@ Using `terraform import`, import `aws_networkmanager_connect_peer` using the con % terraform import aws_networkmanager_connect_peer.example connect-peer-061f3e96275db1acc ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/networkmanager_connection.html.markdown b/website/docs/cdktf/typescript/r/networkmanager_connection.html.markdown index baeda9d40ae4..29de416e9e04 100644 --- a/website/docs/cdktf/typescript/r/networkmanager_connection.html.markdown +++ b/website/docs/cdktf/typescript/r/networkmanager_connection.html.markdown @@ -3,15 +3,16 @@ subcategory: "Network Manager" layout: "aws" page_title: "AWS: aws_networkmanager_connection" description: |- - Creates a connection between two devices. + Manages a Network Manager Connection. --- # Resource: aws_networkmanager_connection -Creates a connection between two devices. -The devices can be a physical or virtual appliance that connects to a third-party appliance in a VPC, or a physical appliance that connects to another physical appliance in an on-premises network. +Manages a Network Manager Connection. + +Use this resource to create a connection between two devices in your global network. ## Example Usage @@ -39,22 +40,33 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -This resource supports the following arguments: +The following arguments are required: + +* `connectedDeviceId` - (Required) ID of the second device in the connection. +* `deviceId` - (Required) ID of the first device in the connection. +* `globalNetworkId` - (Required) ID of the global network. + +The following arguments are optional: -* `connectedDeviceId` - (Required) The ID of the second device in the connection. -* `connectedLinkId` - (Optional) The ID of the link for the second device. -* `description` - (Optional) A description of the connection. -* `deviceId` - (Required) The ID of the first device in the connection. -* `globalNetworkId` - (Required) The ID of the global network. -* `linkId` - (Optional) The ID of the link for the first device. +* `connectedLinkId` - (Optional) ID of the link for the second device. +* `description` - (Optional) Description of the connection. +* `linkId` - (Optional) ID of the link for the first device. * `tags` - (Optional) Key-value tags for the connection. If configured with a provider [`defaultTags` 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. ## Attribute Reference This resource exports the following attributes in addition to the arguments above: -* `arn` - The Amazon Resource Name (ARN) of the connection. -* `tagsAll` - A map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). +* `arn` - ARN of the connection. +* `tagsAll` - Map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). + +## Timeouts + +[Configuration options](https://developer.hashicorp.com/terraform/language/resources/syntax#operation-timeouts): + +* `create` - (Default `10m`) +* `delete` - (Default `10m`) +* `update` - (Default `10m`) ## Import @@ -88,4 +100,4 @@ Using `terraform import`, import `aws_networkmanager_connection` using the conne % terraform import aws_networkmanager_connection.example arn:aws:networkmanager::123456789012:device/global-network-0d47f6t230mz46dy4/connection-07f6fd08867abc123 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/networkmanager_core_network.html.markdown b/website/docs/cdktf/typescript/r/networkmanager_core_network.html.markdown index eac2b17ee894..22effd7ea872 100644 --- a/website/docs/cdktf/typescript/r/networkmanager_core_network.html.markdown +++ b/website/docs/cdktf/typescript/r/networkmanager_core_network.html.markdown @@ -3,14 +3,16 @@ subcategory: "Network Manager" layout: "aws" page_title: "AWS: aws_networkmanager_core_network" description: |- - Provides a core network resource. + Manages a Network Manager Core Network. --- # Resource: aws_networkmanager_core_network -Provides a core network resource. +Manages a Network Manager Core Network. + +Use this resource to create and manage a core network within a global network. ## Example Usage @@ -550,13 +552,15 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -This resource supports the following arguments: +The following arguments are required: -* `description` - (Optional) Description of the Core Network. -* `basePolicyDocument` - (Optional, conflicts with `basePolicyRegion`, `basePolicyRegions`) Sets the base policy document for the core network. Refer to the [Core network policies documentation](https://docs.aws.amazon.com/network-manager/latest/cloudwan/cloudwan-policy-change-sets.html) for more information. -* `basePolicyRegion` - (Optional, **Deprecated** use the `basePolicyRegions` or `basePolicyDocument` argument instead) The base policy created by setting the `createBasePolicy` argument to `true` requires a region to be set in the `edge-locations`, `location` key. If `basePolicyRegion` is not specified, the region used in the base policy defaults to the region specified in the `provider` block. -* `basePolicyRegions` - (Optional, conflicts with `basePolicyRegion`, `basePolicyDocument`) A list of regions to add to the base policy. The base policy created by setting the `createBasePolicy` argument to `true` requires one or more regions to be set in the `edge-locations`, `location` key. If `basePolicyRegions` is not specified, the region used in the base policy defaults to the region specified in the `provider` block. -* `createBasePolicy` - (Optional) Specifies whether to create a base policy when a core network is created or updated. A base policy is created and set to `LIVE` to allow attachments to the core network (e.g. VPC Attachments) before applying a policy document provided using the [`aws_networkmanager_core_network_policy_attachment` resource](/docs/providers/aws/r/networkmanager_core_network_policy_attachment.html). This base policy is needed if your core network does not have any `LIVE` policies and your policy document has static routes pointing to VPC attachments and you want to attach your VPCs to the core network before applying the desired policy document. Valid values are `true` or `false`. An example of this Terraform snippet can be found above [for VPC Attachment in a single region](#with-vpc-attachment-single-region) and [for VPC Attachment multi-region](#with-vpc-attachment-multi-region). An example base policy is shown below. This base policy is overridden with the policy that you specify in the [`aws_networkmanager_core_network_policy_attachment` resource](/docs/providers/aws/r/networkmanager_core_network_policy_attachment.html). +* `globalNetworkId` - (Required) ID of the global network that a core network will be a part of. + +The following arguments are optional: + +* `basePolicyDocument` - (Optional, conflicts with `basePolicyRegions`) Sets the base policy document for the core network. Refer to the [Core network policies documentation](https://docs.aws.amazon.com/network-manager/latest/cloudwan/cloudwan-policy-change-sets.html) for more information. +* `basePolicyRegions` - (Optional, conflicts with `basePolicyDocument`) List of regions to add to the base policy. The base policy created by setting the `createBasePolicy` argument to `true` requires one or more regions to be set in the `edge-locations`, `location` key. If `basePolicyRegions` is not specified, the region used in the base policy defaults to the region specified in the `provider` block. +* `createBasePolicy` - (Optional) Whether to create a base policy when a core network is created or updated. A base policy is created and set to `LIVE` to allow attachments to the core network (e.g. VPC Attachments) before applying a policy document provided using the [`aws_networkmanager_core_network_policy_attachment` resource](/docs/providers/aws/r/networkmanager_core_network_policy_attachment.html). This base policy is needed if your core network does not have any `LIVE` policies and your policy document has static routes pointing to VPC attachments and you want to attach your VPCs to the core network before applying the desired policy document. Valid values are `true` or `false`. An example of this Terraform snippet can be found above [for VPC Attachment in a single region](#with-vpc-attachment-single-region) and [for VPC Attachment multi-region](#with-vpc-attachment-multi-region). An example base policy is shown below. This base policy is overridden with the policy that you specify in the [`aws_networkmanager_core_network_policy_attachment` resource](/docs/providers/aws/r/networkmanager_core_network_policy_attachment.html). ```json { @@ -583,28 +587,20 @@ This resource supports the following arguments: } ``` -* `globalNetworkId` - (Required) The ID of the global network that a core network will be a part of. +* `description` - (Optional) Description of the Core Network. * `tags` - (Optional) Key-value tags for the Core Network. If configured with a provider [`defaultTags` 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. -## Timeouts - -[Configuration options](https://developer.hashicorp.com/terraform/language/resources/syntax#operation-timeouts): - -* `create` - (Default `30m`) -* `delete` - (Default `30m`) -* `update` - (Default `30m`) - ## Attribute Reference This resource exports the following attributes in addition to the arguments above: -* `arn` - Core Network Amazon Resource Name (ARN). +* `arn` - Core Network ARN. * `createdAt` - Timestamp when a core network was created. * `edges` - One or more blocks detailing the edges within a core network. [Detailed below](#edges). * `id` - Core Network ID. * `segments` - One or more blocks detailing the segments within a core network. [Detailed below](#segments). * `state` - Current state of a core network. -* `tagsAll` - A map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). +* `tagsAll` - Map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). ### `edges` @@ -622,6 +618,14 @@ The `segments` configuration block supports the following arguments: * `name` - Name of a core network segment. * `shared_segments` - Shared segments of a core network. +## Timeouts + +[Configuration options](https://developer.hashicorp.com/terraform/language/resources/syntax#operation-timeouts): + +* `create` - (Default `30m`) +* `delete` - (Default `30m`) +* `update` - (Default `30m`) + ## Import In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import `aws_networkmanager_core_network` using the core network ID. For example: @@ -654,4 +658,4 @@ Using `terraform import`, import `aws_networkmanager_core_network` using the cor % terraform import aws_networkmanager_core_network.example core-network-0d47f6t230mz46dy4 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/networkmanager_core_network_policy_attachment.html.markdown b/website/docs/cdktf/typescript/r/networkmanager_core_network_policy_attachment.html.markdown index 8c3762590e60..daab57dda2d7 100644 --- a/website/docs/cdktf/typescript/r/networkmanager_core_network_policy_attachment.html.markdown +++ b/website/docs/cdktf/typescript/r/networkmanager_core_network_policy_attachment.html.markdown @@ -3,14 +3,16 @@ subcategory: "Network Manager" layout: "aws" page_title: "AWS: aws_networkmanager_core_network_policy_attachment" description: |- - Provides a Core Network Policy Attachment resource. + Manages a Network Manager Core Network Policy Attachment. --- # Resource: aws_networkmanager_core_network_policy_attachment -Provides a Core Network Policy Attachment resource. This puts a Core Network Policy to an existing Core Network and executes the change set, which deploys changes globally based on the policy submitted (Sets the policy to `LIVE`). +Manages a Network Manager Core Network Policy Attachment. + +Use this resource to attach a Core Network Policy to an existing Core Network and execute the change set, which deploys changes globally based on the policy submitted (sets the policy to `LIVE`). ~> **NOTE:** Deleting this resource will not delete the current policy defined in this resource. Deleting this resource will also not revert the current `LIVE` policy to the previous version. @@ -514,23 +516,23 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -This resource supports the following arguments: +The following arguments are required: -* `coreNetworkId` - (Required) The ID of the core network that a policy will be attached to and made `LIVE`. +* `coreNetworkId` - (Required) ID of the core network that a policy will be attached to and made `LIVE`. * `policyDocument` - (Required) Policy document for creating a core network. Note that updating this argument will result in the new policy document version being set as the `LATEST` and `LIVE` policy document. Refer to the [Core network policies documentation](https://docs.aws.amazon.com/network-manager/latest/cloudwan/cloudwan-policy-change-sets.html) for more information. -## Timeouts - -[Configuration options](https://developer.hashicorp.com/terraform/language/resources/syntax#operation-timeouts): - -* `update` - (Default `30m`). If this is the first time attaching a policy to a core network then this timeout value is also used as the `create` timeout value. - ## Attribute Reference This resource exports the following attributes in addition to the arguments above: * `state` - Current state of a core network. +## Timeouts + +[Configuration options](https://developer.hashicorp.com/terraform/language/resources/syntax#operation-timeouts): + +* `update` - (Default `30m`). If this is the first time attaching a policy to a core network then this timeout value is also used as the `create` timeout value. + ## Import In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import `aws_networkmanager_core_network_policy_attachment` using the core network ID. For example: @@ -563,4 +565,4 @@ Using `terraform import`, import `aws_networkmanager_core_network_policy_attachm % terraform import aws_networkmanager_core_network_policy_attachment.example core-network-0d47f6t230mz46dy4 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/networkmanager_customer_gateway_association.html.markdown b/website/docs/cdktf/typescript/r/networkmanager_customer_gateway_association.html.markdown index 1d34d927559e..e179f8c21983 100644 --- a/website/docs/cdktf/typescript/r/networkmanager_customer_gateway_association.html.markdown +++ b/website/docs/cdktf/typescript/r/networkmanager_customer_gateway_association.html.markdown @@ -3,15 +3,16 @@ subcategory: "Network Manager" layout: "aws" page_title: "AWS: aws_networkmanager_customer_gateway_association" description: |- - Associates a customer gateway with a device and optionally, with a link. + Manages a Network Manager Customer Gateway Association. --- # Resource: aws_networkmanager_customer_gateway_association -Associates a customer gateway with a device and optionally, with a link. -If you specify a link, it must be associated with the specified device. +Manages a Network Manager Customer Gateway Association. + +Use this resource to associate a customer gateway with a device and optionally, with a link. If you specify a link, it must be associated with the specified device. ## Example Usage @@ -115,17 +116,27 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -This resource supports the following arguments: +The following arguments are required: + +* `customerGatewayArn` - (Required) ARN of the customer gateway. +* `deviceId` - (Required) ID of the device. +* `globalNetworkId` - (Required) ID of the global network. + +The following arguments are optional: -* `customerGatewayArn` - (Required) The Amazon Resource Name (ARN) of the customer gateway. -* `deviceId` - (Required) The ID of the device. -* `globalNetworkId` - (Required) The ID of the global network. -* `linkId` - (Optional) The ID of the link. +* `linkId` - (Optional) ID of the link. ## Attribute Reference This resource exports no additional attributes. +## Timeouts + +[Configuration options](https://developer.hashicorp.com/terraform/language/resources/syntax#operation-timeouts): + +* `create` - (Default `10m`) +* `delete` - (Default `10m`) + ## Import In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import `aws_networkmanager_customer_gateway_association` using the global network ID and customer gateway ARN. For example: @@ -158,4 +169,4 @@ Using `terraform import`, import `aws_networkmanager_customer_gateway_associatio % terraform import aws_networkmanager_customer_gateway_association.example global-network-0d47f6t230mz46dy4,arn:aws:ec2:us-west-2:123456789012:customer-gateway/cgw-123abc05e04123abc ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/networkmanager_device.html.markdown b/website/docs/cdktf/typescript/r/networkmanager_device.html.markdown index 63929fca89d5..c3c5c2470785 100644 --- a/website/docs/cdktf/typescript/r/networkmanager_device.html.markdown +++ b/website/docs/cdktf/typescript/r/networkmanager_device.html.markdown @@ -3,15 +3,16 @@ subcategory: "Network Manager" layout: "aws" page_title: "AWS: aws_networkmanager_device" description: |- - Creates a device in a global network. + Manages a Network Manager Device. --- # Resource: aws_networkmanager_device -Creates a device in a global network. If you specify both a site ID and a location, -the location of the site is used for visualization in the Network Manager console. +Manages a Network Manager Device. + +Use this resource to create a device in a global network. If you specify both a site ID and a location, the location of the site is used for visualization in the Network Manager console. ## Example Usage @@ -38,36 +39,47 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -This resource supports the following arguments: +The following arguments are required: + +* `globalNetworkId` - (Required) ID of the global network. + +The following arguments are optional: -* `awsLocation` - (Optional) The AWS location of the device. Documented below. -* `description` - (Optional) A description of the device. -* `globalNetworkId` - (Required) The ID of the global network. -* `location` - (Optional) The location of the device. Documented below. -* `model` - (Optional) The model of device. -* `serialNumber` - (Optional) The serial number of the device. -* `siteId` - (Optional) The ID of the site. +* `awsLocation` - (Optional) AWS location of the device. Documented below. +* `description` - (Optional) Description of the device. +* `location` - (Optional) Location of the device. Documented below. +* `model` - (Optional) Model of device. +* `serialNumber` - (Optional) Serial number of the device. +* `siteId` - (Optional) ID of the site. * `tags` - (Optional) Key-value tags for the device. If configured with a provider [`defaultTags` 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. -* `type` - (Optional) The type of device. -* `vendor` - (Optional) The vendor of the device. +* `type` - (Optional) Type of device. +* `vendor` - (Optional) Vendor of the device. The `awsLocation` object supports the following: -* `subnetArn` - (Optional) The Amazon Resource Name (ARN) of the subnet that the device is located in. -* `zone` - (Optional) The Zone that the device is located in. Specify the ID of an Availability Zone, Local Zone, Wavelength Zone, or an Outpost. +* `subnetArn` - (Optional) ARN of the subnet that the device is located in. +* `zone` - (Optional) Zone that the device is located in. Specify the ID of an Availability Zone, Local Zone, Wavelength Zone, or an Outpost. The `location` object supports the following: -* `address` - (Optional) The physical address. -* `latitude` - (Optional) The latitude. -* `longitude` - (Optional) The longitude. +* `address` - (Optional) Physical address. +* `latitude` - (Optional) Latitude. +* `longitude` - (Optional) Longitude. ## Attribute Reference This resource exports the following attributes in addition to the arguments above: -* `arn` - The Amazon Resource Name (ARN) of the device. -* `tagsAll` - A map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). +* `arn` - ARN of the device. +* `tagsAll` - Map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). + +## Timeouts + +[Configuration options](https://developer.hashicorp.com/terraform/language/resources/syntax#operation-timeouts): + +* `create` - (Default `10m`) +* `delete` - (Default `10m`) +* `update` - (Default `10m`) ## Import @@ -101,4 +113,4 @@ Using `terraform import`, import `aws_networkmanager_device` using the device AR % terraform import aws_networkmanager_device.example arn:aws:networkmanager::123456789012:device/global-network-0d47f6t230mz46dy4/device-07f6fd08867abc123 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/networkmanager_dx_gateway_attachment.html.markdown b/website/docs/cdktf/typescript/r/networkmanager_dx_gateway_attachment.html.markdown index b54b7b296f2f..1ae168479dd0 100644 --- a/website/docs/cdktf/typescript/r/networkmanager_dx_gateway_attachment.html.markdown +++ b/website/docs/cdktf/typescript/r/networkmanager_dx_gateway_attachment.html.markdown @@ -3,13 +3,15 @@ subcategory: "Network Manager" layout: "aws" page_title: "AWS: aws_networkmanager_dx_gateway_attachment" description: |- - Terraform resource for managing an AWS Network Manager Direct Connect Gateway Attachment. + Manages a Network Manager Direct Connect Gateway Attachment. --- # Resource: aws_networkmanager_dx_gateway_attachment -Terraform resource for managing an AWS Network Manager Direct Connect (DX) Gateway Attachment. +Manages a Network Manager Direct Connect Gateway Attachment. + +Use this resource to create and manage a Direct Connect Gateway attachment to a Cloud WAN core network. ## Example Usage @@ -37,7 +39,7 @@ class MyConvertedCode extends TerraformStack { "}:dx-gateway/${" + awsDxGatewayTest.id + "}", - edgeLocations: [Token.asString(dataAwsRegionCurrent.name)], + edgeLocations: [Token.asString(dataAwsRegionCurrent.region)], }); } } @@ -60,14 +62,15 @@ The following arguments are optional: This resource exports the following attributes in addition to the arguments above: +* `arn` - ARN of the attachment. * `attachmentPolicyRuleNumber` - Policy rule number associated with the attachment. * `attachmentType` - Type of attachment. * `coreNetworkArn` - ARN of the core network for the attachment. -* `id` - The ID of the attachment. +* `id` - ID of the attachment. * `ownerAccountId` - ID of the attachment account owner. * `segmentName` - Name of the segment attachment. * `state` - State of the attachment. -* `tagsAll` - A map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). +* `tagsAll` - Map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). ## Timeouts @@ -109,4 +112,4 @@ Using `terraform import`, import Network Manager DX Gateway Attachment using the % terraform import aws_networkmanager_dx_gateway_attachment.example attachment-1a2b3c4d5e6f7g ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/networkmanager_global_network.html.markdown b/website/docs/cdktf/typescript/r/networkmanager_global_network.html.markdown index 036088de455d..90e3b315ca37 100644 --- a/website/docs/cdktf/typescript/r/networkmanager_global_network.html.markdown +++ b/website/docs/cdktf/typescript/r/networkmanager_global_network.html.markdown @@ -3,14 +3,16 @@ subcategory: "Network Manager" layout: "aws" page_title: "AWS: aws_networkmanager_global_network" description: |- - Provides a global network resource. + Manages a Network Manager Global Network. --- # Resource: aws_networkmanager_global_network -Provides a global network resource. +Manages a Network Manager Global Network. + +Use this resource to create and manage a global network, which is a single private network that acts as the high-level container for your network objects. ## Example Usage @@ -36,7 +38,7 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -This resource supports the following arguments: +The following arguments are optional: * `description` - (Optional) Description of the Global Network. * `tags` - (Optional) Key-value tags for the Global Network. If configured with a provider [`defaultTags` 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. @@ -45,8 +47,16 @@ This resource supports the following arguments: This resource exports the following attributes in addition to the arguments above: -* `arn` - Global Network Amazon Resource Name (ARN) -* `tagsAll` - A map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). +* `arn` - Global Network ARN. +* `tagsAll` - Map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). + +## Timeouts + +[Configuration options](https://developer.hashicorp.com/terraform/language/resources/syntax#operation-timeouts): + +* `create` - (Default `10m`) +* `delete` - (Default `10m`) +* `update` - (Default `10m`) ## Import @@ -80,4 +90,4 @@ Using `terraform import`, import `aws_networkmanager_global_network` using the g % terraform import aws_networkmanager_global_network.example global-network-0d47f6t230mz46dy4 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/networkmanager_link.html.markdown b/website/docs/cdktf/typescript/r/networkmanager_link.html.markdown index 03e93283265f..afa6f81742f4 100644 --- a/website/docs/cdktf/typescript/r/networkmanager_link.html.markdown +++ b/website/docs/cdktf/typescript/r/networkmanager_link.html.markdown @@ -3,14 +3,14 @@ subcategory: "Network Manager" layout: "aws" page_title: "AWS: aws_networkmanager_link" description: |- - Creates a link for a site. + Manages a Network Manager link. --- # Resource: aws_networkmanager_link -Creates a link for a site. +Manages a Network Manager link. Use this resource to create a link for a site. ## Example Usage @@ -42,17 +42,20 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -This resource supports the following arguments: +The following arguments are required: -* `bandwidth` - (Required) The upload speed and download speed in Mbps. Documented below. -* `description` - (Optional) A description of the link. -* `globalNetworkId` - (Required) The ID of the global network. -* `providerName` - (Optional) The provider of the link. -* `siteId` - (Required) The ID of the site. +* `bandwidth` - (Required) Upload speed and download speed in Mbps. [See below](#bandwidth). +* `globalNetworkId` - (Required) ID of the global network. +* `siteId` - (Required) ID of the site. + +The following arguments are optional: + +* `description` - (Optional) Description of the link. +* `providerName` - (Optional) Provider of the link. * `tags` - (Optional) Key-value tags for the link. If configured with a provider [`defaultTags` 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. -* `type` - (Optional) The type of the link. +* `type` - (Optional) Type of the link. -The `bandwidth` object supports the following: +### bandwidth * `downloadSpeed` - (Optional) Download speed in Mbps. * `uploadSpeed` - (Optional) Upload speed in Mbps. @@ -61,8 +64,16 @@ The `bandwidth` object supports the following: This resource exports the following attributes in addition to the arguments above: -* `arn` - Link Amazon Resource Name (ARN). -* `tagsAll` - A map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). +* `arn` - Link ARN. +* `tagsAll` - Map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). + +## Timeouts + +[Configuration options](https://developer.hashicorp.com/terraform/language/resources/syntax#operation-timeouts): + +* `create` - (Default `10m`) +* `delete` - (Default `10m`) +* `update` - (Default `10m`) ## Import @@ -96,4 +107,4 @@ Using `terraform import`, import `aws_networkmanager_link` using the link ARN. F % terraform import aws_networkmanager_link.example arn:aws:networkmanager::123456789012:link/global-network-0d47f6t230mz46dy4/link-444555aaabbb11223 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/networkmanager_link_association.html.markdown b/website/docs/cdktf/typescript/r/networkmanager_link_association.html.markdown index 702394dc2e7d..9cfe68a766c7 100644 --- a/website/docs/cdktf/typescript/r/networkmanager_link_association.html.markdown +++ b/website/docs/cdktf/typescript/r/networkmanager_link_association.html.markdown @@ -3,16 +3,14 @@ subcategory: "Network Manager" layout: "aws" page_title: "AWS: aws_networkmanager_link_association" description: |- - Associates a link to a device. + Manages a Network Manager link association. --- # Resource: aws_networkmanager_link_association -Associates a link to a device. -A device can be associated to multiple links and a link can be associated to multiple devices. -The device and link must be in the same global network and the same site. +Manages a Network Manager link association. Associates a link to a device. A device can be associated to multiple links and a link can be associated to multiple devices. The device and link must be in the same global network and the same site. ## Example Usage @@ -40,16 +38,23 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -This resource supports the following arguments: +The following arguments are required: -* `deviceId` - (Required) The ID of the device. -* `globalNetworkId` - (Required) The ID of the global network. -* `linkId` - (Required) The ID of the link. +* `deviceId` - (Required) ID of the device. +* `globalNetworkId` - (Required) ID of the global network. +* `linkId` - (Required) ID of the link. ## Attribute Reference This resource exports no additional attributes. +## Timeouts + +[Configuration options](https://developer.hashicorp.com/terraform/language/resources/syntax#operation-timeouts): + +* `create` - (Default `10m`) +* `delete` - (Default `10m`) + ## Import In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import `aws_networkmanager_link_association` using the global network ID, link ID and device ID. For example: @@ -82,4 +87,4 @@ Using `terraform import`, import `aws_networkmanager_link_association` using the % terraform import aws_networkmanager_link_association.example global-network-0d47f6t230mz46dy4,link-444555aaabbb11223,device-07f6fd08867abc123 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/networkmanager_site.html.markdown b/website/docs/cdktf/typescript/r/networkmanager_site.html.markdown index f1a780295fa9..6955c3c3c472 100644 --- a/website/docs/cdktf/typescript/r/networkmanager_site.html.markdown +++ b/website/docs/cdktf/typescript/r/networkmanager_site.html.markdown @@ -3,14 +3,14 @@ subcategory: "Network Manager" layout: "aws" page_title: "AWS: aws_networkmanager_site" description: |- - Creates a site in a global network. + Manages a Network Manager site. --- # Resource: aws_networkmanager_site -Creates a site in a global network. +Manages a Network Manager site. Use this resource to create a site in a global network. ## Example Usage @@ -44,14 +44,17 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -This resource supports the following arguments: +The following arguments are required: + +* `globalNetworkId` - (Required) ID of the Global Network to create the site in. + +The following arguments are optional: -* `globalNetworkId` - (Required) The ID of the Global Network to create the site in. * `description` - (Optional) Description of the Site. -* `location` - (Optional) The site location as documented below. +* `location` - (Optional) Site location. [See below](#location). * `tags` - (Optional) Key-value tags for the Site. If configured with a provider [`defaultTags` 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 `location` object supports the following: +### location * `address` - (Optional) Address of the location. * `latitude` - (Optional) Latitude of the location. @@ -61,8 +64,16 @@ The `location` object supports the following: This resource exports the following attributes in addition to the arguments above: -* `arn` - Site Amazon Resource Name (ARN) -* `tagsAll` - A map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). +* `arn` - Site ARN. +* `tagsAll` - Map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). + +## Timeouts + +[Configuration options](https://developer.hashicorp.com/terraform/language/resources/syntax#operation-timeouts): + +* `create` - (Default `10m`) +* `delete` - (Default `10m`) +* `update` - (Default `10m`) ## Import @@ -96,4 +107,4 @@ Using `terraform import`, import `aws_networkmanager_site` using the site ARN. F % terraform import aws_networkmanager_site.example arn:aws:networkmanager::123456789012:site/global-network-0d47f6t230mz46dy4/site-444555aaabbb11223 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/networkmanager_site_to_site_vpn_attachment.html.markdown b/website/docs/cdktf/typescript/r/networkmanager_site_to_site_vpn_attachment.html.markdown index ac2227d555fe..42af97f5dcd3 100644 --- a/website/docs/cdktf/typescript/r/networkmanager_site_to_site_vpn_attachment.html.markdown +++ b/website/docs/cdktf/typescript/r/networkmanager_site_to_site_vpn_attachment.html.markdown @@ -3,14 +3,14 @@ subcategory: "Network Manager" layout: "aws" page_title: "AWS: aws_networkmanager_site_to_site_vpn_attachment" description: |- - Terraform resource for managing an AWS Network Manager SiteToSiteAttachment. + Manages a Network Manager site-to-site VPN attachment. --- # Resource: aws_networkmanager_site_to_site_vpn_attachment -Terraform resource for managing an AWS Network Manager SiteToSiteAttachment. +Manages a Network Manager site-to-site VPN attachment. ## Example Usage @@ -110,7 +110,7 @@ class MyConvertedCode extends TerraformStack { edgeLocations: [ { asn: Token.asString(64512), - location: Token.asString(current.name), + location: Token.asString(current.region), }, ], vpnEcmpSupport: false, @@ -182,29 +182,36 @@ class MyConvertedCode extends TerraformStack { The following arguments are required: -- `coreNetworkId` - (Required) The ID of a core network for the VPN attachment. -- `vpnConnectionArn` - (Required) The ARN of the site-to-site VPN connection. +* `coreNetworkId` - (Required) ID of a core network for the VPN attachment. +* `vpnConnectionArn` - (Required) ARN of the site-to-site VPN connection. The following arguments are optional: -- `tags` - (Optional) Key-value tags for the attachment. If configured with a provider [`defaultTags` 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. +* `tags` - (Optional) Key-value tags for the attachment. If configured with a provider [`defaultTags` 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. ## Attribute Reference This resource exports the following attributes in addition to the arguments above: -- `arn` - The ARN of the attachment. -- `attachmentPolicyRuleNumber` - The policy rule number associated with the attachment. -- `attachmentType` - The type of attachment. -- `coreNetworkArn` - The ARN of a core network. -- `coreNetworkId` - The ID of a core network -- `edgeLocation` - The Region where the edge is located. -- `id` - The ID of the attachment. -- `ownerAccountId` - The ID of the attachment account owner. -- `resourceArn` - The attachment resource ARN. -- `segmentName` - The name of the segment attachment. -- `state` - The state of the attachment. -- `tagsAll` - A map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). +* `arn` - ARN of the attachment. +* `attachmentPolicyRuleNumber` - Policy rule number associated with the attachment. +* `attachmentType` - Type of attachment. +* `coreNetworkArn` - ARN of a core network. +* `edgeLocation` - Region where the edge is located. +* `id` - ID of the attachment. +* `ownerAccountId` - ID of the attachment account owner. +* `resourceArn` - Attachment resource ARN. +* `segmentName` - Name of the segment attachment. +* `state` - State of the attachment. +* `tagsAll` - Map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). + +## Timeouts + +[Configuration options](https://developer.hashicorp.com/terraform/language/resources/syntax#operation-timeouts): + +* `create` - (Default `10m`) +* `delete` - (Default `10m`) +* `update` - (Default `10m`) ## Import @@ -238,4 +245,4 @@ Using `terraform import`, import `aws_networkmanager_site_to_site_vpn_attachment % terraform import aws_networkmanager_site_to_site_vpn_attachment.example attachment-0f8fa60d2238d1bd8 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/networkmanager_transit_gateway_connect_peer_association.html.markdown b/website/docs/cdktf/typescript/r/networkmanager_transit_gateway_connect_peer_association.html.markdown index e8c0a11517e5..c87b9091911a 100644 --- a/website/docs/cdktf/typescript/r/networkmanager_transit_gateway_connect_peer_association.html.markdown +++ b/website/docs/cdktf/typescript/r/networkmanager_transit_gateway_connect_peer_association.html.markdown @@ -3,15 +3,14 @@ subcategory: "Network Manager" layout: "aws" page_title: "AWS: aws_networkmanager_transit_gateway_connect_peer_association" description: |- - Associates a transit gateway Connect peer with a device, and optionally, with a link. + Manages a Network Manager transit gateway Connect peer association. --- # Resource: aws_networkmanager_transit_gateway_connect_peer_association -Associates a transit gateway Connect peer with a device, and optionally, with a link. -If you specify a link, it must be associated with the specified device. +Manages a Network Manager transit gateway Connect peer association. Associates a transit gateway Connect peer with a device, and optionally, with a link. If you specify a link, it must be associated with the specified device. ## Example Usage @@ -41,20 +40,30 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -This resource supports the following arguments: +The following arguments are required: -* `deviceId` - (Required) The ID of the device. -* `globalNetworkId` - (Required) The ID of the global network. -* `linkId` - (Optional) The ID of the link. -* `transitGatewayConnectPeerArn` - (Required) The Amazon Resource Name (ARN) of the Connect peer. +* `deviceId` - (Required) ID of the device. +* `globalNetworkId` - (Required) ID of the global network. +* `transitGatewayConnectPeerArn` - (Required) ARN of the Connect peer. + +The following arguments are optional: + +* `linkId` - (Optional) ID of the link. ## Attribute Reference This resource exports no additional attributes. +## Timeouts + +[Configuration options](https://developer.hashicorp.com/terraform/language/resources/syntax#operation-timeouts): + +* `create` - (Default `10m`) +* `delete` - (Default `10m`) + ## Import -In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import `aws_networkmanager_transit_gateway_connect_peer_association` using the global network ID and customer gateway ARN. For example: +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import `aws_networkmanager_transit_gateway_connect_peer_association` using the global network ID and Connect peer ARN. For example: ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -78,10 +87,10 @@ class MyConvertedCode extends TerraformStack { ``` -Using `terraform import`, import `aws_networkmanager_transit_gateway_connect_peer_association` using the global network ID and customer gateway ARN. For example: +Using `terraform import`, import `aws_networkmanager_transit_gateway_connect_peer_association` using the global network ID and Connect peer ARN. For example: ```console % terraform import aws_networkmanager_transit_gateway_connect_peer_association.example global-network-0d47f6t230mz46dy4,arn:aws:ec2:us-west-2:123456789012:transit-gateway-connect-peer/tgw-connect-peer-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/networkmanager_transit_gateway_peering.html.markdown b/website/docs/cdktf/typescript/r/networkmanager_transit_gateway_peering.html.markdown index 541a9f6fce01..b59e967f898f 100644 --- a/website/docs/cdktf/typescript/r/networkmanager_transit_gateway_peering.html.markdown +++ b/website/docs/cdktf/typescript/r/networkmanager_transit_gateway_peering.html.markdown @@ -3,14 +3,14 @@ subcategory: "Network Manager" layout: "aws" page_title: "AWS: aws_networkmanager_transit_gateway_peering" description: |- - Creates a peering connection between an AWS Cloud WAN core network and an AWS Transit Gateway. + Manages a Network Manager transit gateway peering connection. --- # Resource: aws_networkmanager_transit_gateway_peering -Creates a peering connection between an AWS Cloud WAN core network and an AWS Transit Gateway. +Manages a Network Manager transit gateway peering connection. Creates a peering connection between an AWS Cloud WAN core network and an AWS Transit Gateway. ## Example Usage @@ -28,6 +28,10 @@ class MyConvertedCode extends TerraformStack { super(scope, name); new NetworkmanagerTransitGatewayPeering(this, "example", { coreNetworkId: Token.asString(awsccNetworkmanagerCoreNetworkExample.id), + dependsOn: [ + awsEc2TransitGatewayPolicyTableExample, + awsNetworkmanagerCoreNetworkPolicyAttachmentExample, + ], transitGatewayArn: Token.asString(awsEc2TransitGatewayExample.arn), }); } @@ -37,25 +41,35 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -This resource supports the following arguments: +The following arguments are required: + +* `coreNetworkId` - (Required) ID of a core network. +* `transitGatewayArn` - (Required) ARN of the transit gateway for the peering request. + +The following arguments are optional: -* `coreNetworkId` - (Required) The ID of a core network. * `tags` - (Optional) Key-value tags for the peering. If configured with a provider [`defaultTags` 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. -* `transitGatewayArn` - (Required) The ARN of the transit gateway for the peering request. ## Attribute Reference This resource exports the following attributes in addition to the arguments above: -* `arn` - Peering Amazon Resource Name (ARN). -* `coreNetworkArn` - The ARN of the core network. -* `edgeLocation` - The edge location for the peer. +* `arn` - Peering ARN. +* `coreNetworkArn` - ARN of the core network. +* `edgeLocation` - Edge location for the peer. * `id` - Peering ID. -* `ownerAccountId` - The ID of the account owner. -* `peeringType` - The type of peering. This will be `TRANSIT_GATEWAY`. -* `resourceArn` - The resource ARN of the peer. -* `tagsAll` - A map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). -* `transitGatewayPeeringAttachmentId` - The ID of the transit gateway peering attachment. +* `ownerAccountId` - ID of the account owner. +* `peeringType` - Type of peering. This will be `TRANSIT_GATEWAY`. +* `resourceArn` - Resource ARN of the peer. +* `tagsAll` - Map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). +* `transitGatewayPeeringAttachmentId` - ID of the transit gateway peering attachment. + +## Timeouts + +[Configuration options](https://developer.hashicorp.com/terraform/language/resources/syntax#operation-timeouts): + +* `create` - (Default `20m`) +* `delete` - (Default `20m`) ## Import @@ -89,4 +103,4 @@ Using `terraform import`, import `aws_networkmanager_transit_gateway_peering` us % terraform import aws_networkmanager_transit_gateway_peering.example peering-444555aaabbb11223 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/networkmanager_transit_gateway_registration.html.markdown b/website/docs/cdktf/typescript/r/networkmanager_transit_gateway_registration.html.markdown index 741a8f14d9b1..491dc53cecb7 100644 --- a/website/docs/cdktf/typescript/r/networkmanager_transit_gateway_registration.html.markdown +++ b/website/docs/cdktf/typescript/r/networkmanager_transit_gateway_registration.html.markdown @@ -3,16 +3,14 @@ subcategory: "Network Manager" layout: "aws" page_title: "AWS: aws_networkmanager_transit_gateway_registration" description: |- - Registers a transit gateway to a global network. + Manages a Network Manager transit gateway registration. --- # Resource: aws_networkmanager_transit_gateway_registration -Registers a transit gateway to a global network. The transit gateway can be in any AWS Region, -but it must be owned by the same AWS account that owns the global network. -You cannot register a transit gateway in more than one global network. +Manages a Network Manager transit gateway registration. Registers a transit gateway to a global network. The transit gateway can be in any AWS Region, but it must be owned by the same AWS account that owns the global network. You cannot register a transit gateway in more than one global network. ## Example Usage @@ -55,15 +53,22 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -This resource supports the following arguments: +The following arguments are required: -* `globalNetworkId` - (Required) The ID of the Global Network to register to. -* `transitGatewayArn` - (Required) The ARN of the Transit Gateway to register. +* `globalNetworkId` - (Required) ID of the Global Network to register to. +* `transitGatewayArn` - (Required) ARN of the Transit Gateway to register. ## Attribute Reference This resource exports no additional attributes. +## Timeouts + +[Configuration options](https://developer.hashicorp.com/terraform/language/resources/syntax#operation-timeouts): + +* `create` - (Default `10m`) +* `delete` - (Default `10m`) + ## Import In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import `aws_networkmanager_transit_gateway_registration` using the global network ID and transit gateway ARN. For example: @@ -96,4 +101,4 @@ Using `terraform import`, import `aws_networkmanager_transit_gateway_registratio % terraform import aws_networkmanager_transit_gateway_registration.example global-network-0d47f6t230mz46dy4,arn:aws:ec2:us-west-2:123456789012:transit-gateway/tgw-123abc05e04123abc ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/networkmanager_transit_gateway_route_table_attachment.html.markdown b/website/docs/cdktf/typescript/r/networkmanager_transit_gateway_route_table_attachment.html.markdown index 0f2b026130c9..df2359cf445d 100644 --- a/website/docs/cdktf/typescript/r/networkmanager_transit_gateway_route_table_attachment.html.markdown +++ b/website/docs/cdktf/typescript/r/networkmanager_transit_gateway_route_table_attachment.html.markdown @@ -3,14 +3,14 @@ subcategory: "Network Manager" layout: "aws" page_title: "AWS: aws_networkmanager_transit_gateway_route_table_attachment" description: |- - Creates a transit gateway route table attachment. + Manages a Network Manager transit gateway route table attachment. --- # Resource: aws_networkmanager_transit_gateway_route_table_attachment -Creates a transit gateway route table attachment. +Manages a Network Manager transit gateway route table attachment. ## Example Usage @@ -41,28 +41,38 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -This resource supports the following arguments: +The following arguments are required: + +* `peeringId` - (Required) ID of the peer for the attachment. +* `transitGatewayRouteTableArn` - (Required) ARN of the transit gateway route table for the attachment. + +The following arguments are optional: -* `peeringId` - (Required) The ID of the peer for the attachment. * `tags` - (Optional) Key-value tags for the attachment. If configured with a provider [`defaultTags` 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. -* `transitGatewayRouteTableArn` - (Required) The ARN of the transit gateway route table for the attachment. ## Attribute Reference This resource exports the following attributes in addition to the arguments above: -* `arn` - Attachment Amazon Resource Name (ARN). -* `attachmentPolicyRuleNumber` - The policy rule number associated with the attachment. -* `attachmentType` - The type of attachment. -* `coreNetworkArn` - The ARN of the core network. -* `coreNetworkId` - The ID of the core network. -* `edgeLocation` - The edge location for the peer. -* `id` - The ID of the attachment. -* `ownerAccountId` - The ID of the attachment account owner. -* `resourceArn` - The attachment resource ARN. -* `segmentName` - The name of the segment attachment. -* `state` - The state of the attachment. -* `tagsAll` - A map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). +* `arn` - Attachment ARN. +* `attachmentPolicyRuleNumber` - Policy rule number associated with the attachment. +* `attachmentType` - Type of attachment. +* `coreNetworkArn` - ARN of the core network. +* `coreNetworkId` - ID of the core network. +* `edgeLocation` - Edge location for the peer. +* `id` - ID of the attachment. +* `ownerAccountId` - ID of the attachment account owner. +* `resourceArn` - Attachment resource ARN. +* `segmentName` - Name of the segment attachment. +* `state` - State of the attachment. +* `tagsAll` - Map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). + +## Timeouts + +[Configuration options](https://developer.hashicorp.com/terraform/language/resources/syntax#operation-timeouts): + +* `create` - (Default `10m`) +* `delete` - (Default `10m`) ## Import @@ -96,4 +106,4 @@ Using `terraform import`, import `aws_networkmanager_transit_gateway_route_table % terraform import aws_networkmanager_transit_gateway_route_table_attachment.example attachment-0f8fa60d2238d1bd8 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/networkmanager_vpc_attachment.html.markdown b/website/docs/cdktf/typescript/r/networkmanager_vpc_attachment.html.markdown index ee8a80cf0f22..54b473954214 100644 --- a/website/docs/cdktf/typescript/r/networkmanager_vpc_attachment.html.markdown +++ b/website/docs/cdktf/typescript/r/networkmanager_vpc_attachment.html.markdown @@ -3,14 +3,14 @@ subcategory: "Network Manager" layout: "aws" page_title: "AWS: aws_networkmanager_vpc_attachment" description: |- - Terraform resource for managing an AWS Network Manager VPC Attachment. + Manages a Network Manager VPC attachment. --- # Resource: aws_networkmanager_vpc_attachment -Terraform resource for managing an AWS Network Manager VPC Attachment. +Manages a Network Manager VPC attachment. ## Example Usage @@ -42,38 +42,43 @@ class MyConvertedCode extends TerraformStack { The following arguments are required: -* `coreNetworkId` - (Required) The ID of a core network for the VPC attachment. -* `subnetArns` - (Required) The subnet ARN of the VPC attachment. -* `vpcArn` - (Required) The ARN of the VPC. +* `coreNetworkId` - (Required) ID of a core network for the VPC attachment. +* `subnetArns` - (Required) Subnet ARNs of the VPC attachment. +* `vpcArn` - (Required) ARN of the VPC. The following arguments are optional: -* `options` - (Optional) Options for the VPC attachment. +* `options` - (Optional) Options for the VPC attachment. [See below](#options). * `tags` - (Optional) Key-value tags for the attachment. If configured with a provider [`defaultTags` 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. ### options -* `applianceModeSupport` - (Optional) Indicates whether appliance mode is supported. - If enabled, traffic flow between a source and destination use the same Availability Zone for the VPC attachment for the lifetime of that flow. - If the VPC attachment is pending acceptance, changing this value will recreate the resource. -* `ipv6Support` - (Optional) Indicates whether IPv6 is supported. - If the VPC attachment is pending acceptance, changing this value will recreate the resource. +* `applianceModeSupport` - (Optional) Whether to enable appliance mode support. If enabled, traffic flow between a source and destination use the same Availability Zone for the VPC attachment for the lifetime of that flow. If the VPC attachment is pending acceptance, changing this value will recreate the resource. +* `ipv6Support` - (Optional) Whether to enable IPv6 support. If the VPC attachment is pending acceptance, changing this value will recreate the resource. ## Attribute Reference This resource exports the following attributes in addition to the arguments above: -* `arn` - The ARN of the attachment. -* `attachmentPolicyRuleNumber` - The policy rule number associated with the attachment. -* `attachmentType` - The type of attachment. -* `coreNetworkArn` - The ARN of a core network. -* `edgeLocation` - The Region where the edge is located. -* `id` - The ID of the attachment. -* `ownerAccountId` - The ID of the attachment account owner. -* `resourceArn` - The attachment resource ARN. -* `segmentName` - The name of the segment attachment. -* `state` - The state of the attachment. -* `tagsAll` - A map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). +* `arn` - ARN of the attachment. +* `attachmentPolicyRuleNumber` - Policy rule number associated with the attachment. +* `attachmentType` - Type of attachment. +* `coreNetworkArn` - ARN of a core network. +* `edgeLocation` - Region where the edge is located. +* `id` - ID of the attachment. +* `ownerAccountId` - ID of the attachment account owner. +* `resourceArn` - Attachment resource ARN. +* `segmentName` - Name of the segment attachment. +* `state` - State of the attachment. +* `tagsAll` - Map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). + +## Timeouts + +[Configuration options](https://developer.hashicorp.com/terraform/language/resources/syntax#operation-timeouts): + +* `create` - (Default `15m`) +* `delete` - (Default `10m`) +* `update` - (Default `10m`) ## Import @@ -107,4 +112,4 @@ Using `terraform import`, import `aws_networkmanager_vpc_attachment` using the a % terraform import aws_networkmanager_vpc_attachment.example attachment-0f8fa60d2238d1bd8 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/networkmonitor_monitor.html.markdown b/website/docs/cdktf/typescript/r/networkmonitor_monitor.html.markdown index 0e5ec409a978..4fd9da276bf6 100644 --- a/website/docs/cdktf/typescript/r/networkmonitor_monitor.html.markdown +++ b/website/docs/cdktf/typescript/r/networkmonitor_monitor.html.markdown @@ -45,6 +45,7 @@ The following arguments are required: The following arguments are optional: +- `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). - `aggregationPeriod` - (Optional) The time, in seconds, that metrics are aggregated and sent to Amazon CloudWatch. Valid values are either 30 or 60. - `tags` - (Optional) Key-value tags for the monitor. If configured with a provider [`defaultTags` 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. @@ -87,4 +88,4 @@ Using `terraform import`, import `aws_networkmonitor_monitor` using the monitor % terraform import aws_networkmonitor_monitor.example monitor-7786087912324693644 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/networkmonitor_probe.html.markdown b/website/docs/cdktf/typescript/r/networkmonitor_probe.html.markdown index e1b56ab176c8..efa83df1beb3 100644 --- a/website/docs/cdktf/typescript/r/networkmonitor_probe.html.markdown +++ b/website/docs/cdktf/typescript/r/networkmonitor_probe.html.markdown @@ -56,6 +56,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +- `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). - `destination` - (Required) The destination IP address. This must be either IPV4 or IPV6. - `destinationPort` - (Optional) The port associated with the destination. This is required only if the protocol is TCP and must be a number between 1 and 65536. - `monitorName` - (Required) The name of the monitor. @@ -104,4 +105,4 @@ Using `terraform import`, import `aws_networkmonitor_probe` using the monitor na % terraform import aws_networkmonitor_probe.example monitor-7786087912324693644,probe-3qm8p693i4fi1h8lqylzkbp42e ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/oam_link.html.markdown b/website/docs/cdktf/typescript/r/oam_link.html.markdown index f2027b6827f0..bc8d76ac0f26 100644 --- a/website/docs/cdktf/typescript/r/oam_link.html.markdown +++ b/website/docs/cdktf/typescript/r/oam_link.html.markdown @@ -132,6 +132,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `linkConfiguration` - (Optional) Configuration for creating filters that specify that only some metric namespaces or log groups are to be shared from the source account to the monitoring account. See [`linkConfiguration` Block](#link_configuration-block) for details. * `tags` - (Optional) A map of tags to assign to the resource. If configured with a provider [`defaultTags` 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. @@ -204,4 +205,4 @@ Using `terraform import`, import CloudWatch Observability Access Manager Link us % terraform import aws_oam_link.example arn:aws:oam:us-west-2:123456789012:link/link-id ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/oam_sink.html.markdown b/website/docs/cdktf/typescript/r/oam_sink.html.markdown index 4fc32545b777..64fe1d15643b 100644 --- a/website/docs/cdktf/typescript/r/oam_sink.html.markdown +++ b/website/docs/cdktf/typescript/r/oam_sink.html.markdown @@ -47,6 +47,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `tags` - (Optional) A map of tags to assign to the resource. If configured with a provider [`defaultTags` 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. ## Attribute Reference @@ -97,4 +98,4 @@ Using `terraform import`, import CloudWatch Observability Access Manager Sink us % terraform import aws_oam_sink.example arn:aws:oam:us-west-2:123456789012:sink/sink-id ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/oam_sink_policy.html.markdown b/website/docs/cdktf/typescript/r/oam_sink_policy.html.markdown index 2198236de769..d1c7f8cb81d9 100644 --- a/website/docs/cdktf/typescript/r/oam_sink_policy.html.markdown +++ b/website/docs/cdktf/typescript/r/oam_sink_policy.html.markdown @@ -67,8 +67,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `sinkIdentifier` - (Required) ARN of the sink to attach this policy to. * `policy` - (Required) JSON policy to use. If you are updating an existing policy, the entire existing policy is replaced by what you specify here. @@ -118,4 +119,4 @@ Using `terraform import`, import CloudWatch Observability Access Manager Sink Po % terraform import aws_oam_sink_policy.example arn:aws:oam:us-west-2:123456789012:sink/sink-id ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/opensearch_authorize_vpc_endpoint_access.html.markdown b/website/docs/cdktf/typescript/r/opensearch_authorize_vpc_endpoint_access.html.markdown index 187afcb63929..8820d6c36761 100644 --- a/website/docs/cdktf/typescript/r/opensearch_authorize_vpc_endpoint_access.html.markdown +++ b/website/docs/cdktf/typescript/r/opensearch_authorize_vpc_endpoint_access.html.markdown @@ -41,8 +41,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `account` - (Required) AWS account ID to grant access to. * `domainName` - (Required) Name of OpenSearch Service domain to provide access to. @@ -59,7 +60,7 @@ This resource exports the following attributes in addition to the arguments abov ## Import -In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import OpenSearch Authorize Vpc Endpoint Access using the `example_id_arg`. For example: +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import OpenSearch Authorize Vpc Endpoint Access using the `domainName`. For example: ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -83,10 +84,10 @@ class MyConvertedCode extends TerraformStack { ``` -Using `terraform import`, import OpenSearch Authorize Vpc Endpoint Access using the `example_id_arg`. For example: +Using `terraform import`, import OpenSearch Authorize Vpc Endpoint Access using the `domainName`. For example: ```console % terraform import aws_opensearch_authorize_vpc_endpoint_access.example authorize_vpc_endpoint_access-id-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/opensearch_domain.html.markdown b/website/docs/cdktf/typescript/r/opensearch_domain.html.markdown index 3f59ea372f74..d40324d6bca5 100644 --- a/website/docs/cdktf/typescript/r/opensearch_domain.html.markdown +++ b/website/docs/cdktf/typescript/r/opensearch_domain.html.markdown @@ -108,7 +108,7 @@ class MyConvertedCode extends TerraformStack { ], resources: [ "arn:aws:es:${" + - dataAwsRegionCurrent.name + + dataAwsRegionCurrent.region + "}:${" + current.accountId + "}:domain/${" + @@ -272,7 +272,7 @@ class MyConvertedCode extends TerraformStack { ], resources: [ "arn:aws:es:${" + - dataAwsRegionCurrent.name + + dataAwsRegionCurrent.region + "}:${" + current.accountId + "}:domain/${" + @@ -440,6 +440,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `accessPolicies` - (Optional) IAM policy document specifying the access policies for the domain. * `advancedOptions` - (Optional) Key-value string pairs to specify advanced configuration options. Note that the values for these configuration options must be strings (wrapped in quotes) or they may be wrong and cause a perpetual diff, causing Terraform to want to recreate your OpenSearch domain on every apply. * `advancedSecurityOptions` - (Optional) Configuration block for [fine-grained access control](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/fgac.html). Detailed below. @@ -616,7 +617,6 @@ This resource exports the following attributes in addition to the arguments abov * `endpointV2` - V2 domain endpoint that works with both IPv4 and IPv6 addresses, used to submit index, search, and data upload requests. * `dashboardEndpoint` - Domain-specific endpoint for Dashboard without https scheme. * `dashboardEndpointV2` - V2 domain endpoint for Dashboard that works with both IPv4 and IPv6 addresses, without https scheme. -* `kibanaEndpoint` - (**Deprecated**) Domain-specific endpoint for kibana without https scheme. Use the `dashboardEndpoint` attribute instead. * `tagsAll` - Map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). * `vpc_options.0.availability_zones` - If the domain was created inside a VPC, the names of the availability zones the configured `subnetIds` were created inside. * `vpc_options.0.vpc_id` - If the domain was created inside a VPC, the ID of the VPC. @@ -657,4 +657,4 @@ Using `terraform import`, import OpenSearch domains using the `domainName`. For % terraform import aws_opensearch_domain.example domain_name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/opensearch_domain_policy.html.markdown b/website/docs/cdktf/typescript/r/opensearch_domain_policy.html.markdown index 3fc1bbde729e..ee4addad1e42 100644 --- a/website/docs/cdktf/typescript/r/opensearch_domain_policy.html.markdown +++ b/website/docs/cdktf/typescript/r/opensearch_domain_policy.html.markdown @@ -73,6 +73,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `accessPolicies` - (Optional) IAM policy document specifying the access policies for the domain * `domainName` - (Required) Name of the domain. @@ -87,4 +88,36 @@ This resource exports no additional attributes. * `update` - (Default `180m`) * `delete` - (Default `90m`) - \ No newline at end of file +## Import + +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import OpenSearch Domain Policy using `domainName` prefixed with `esd-policy-`. For example: + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { OpensearchDomainPolicy } from "./.gen/providers/aws/opensearch-domain-policy"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + OpensearchDomainPolicy.generateConfigForImport( + this, + "example", + "esd-policy-tf-test" + ); + } +} + +``` + +Using `terraform import`, import OpenSearch Domain Policy using `domainName` prefixed with `esd-policy-`. For example: + +```console +% terraform import aws_opensearch_domain_policy.example esd-policy-tf-test +``` + + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/opensearch_domain_saml_options.html.markdown b/website/docs/cdktf/typescript/r/opensearch_domain_saml_options.html.markdown index 2df67d7d695e..736357b851cd 100644 --- a/website/docs/cdktf/typescript/r/opensearch_domain_saml_options.html.markdown +++ b/website/docs/cdktf/typescript/r/opensearch_domain_saml_options.html.markdown @@ -68,6 +68,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `samlOptions` - (Optional) SAML authentication options for an AWS OpenSearch Domain. ### saml_options @@ -130,4 +131,4 @@ Using `terraform import`, import OpenSearch domains using the `domainName`. For % terraform import aws_opensearch_domain_saml_options.example domain_name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/opensearch_inbound_connection_accepter.html.markdown b/website/docs/cdktf/typescript/r/opensearch_inbound_connection_accepter.html.markdown index 459a1d9d14c0..d89094327717 100644 --- a/website/docs/cdktf/typescript/r/opensearch_inbound_connection_accepter.html.markdown +++ b/website/docs/cdktf/typescript/r/opensearch_inbound_connection_accepter.html.markdown @@ -40,12 +40,12 @@ class MyConvertedCode extends TerraformStack { localDomainInfo: { domainName: localDomain.domainName, ownerId: Token.asString(current.accountId), - region: Token.asString(dataAwsRegionCurrent.name), + region: Token.asString(dataAwsRegionCurrent.region), }, remoteDomainInfo: { domainName: remoteDomain.domainName, ownerId: Token.asString(current.accountId), - region: Token.asString(dataAwsRegionCurrent.name), + region: Token.asString(dataAwsRegionCurrent.region), }, }); const awsOpensearchInboundConnectionAccepterFoo = @@ -63,6 +63,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `connectionId` - (Required, Forces new resource) Specifies the ID of the connection to accept. ## Attribute Reference @@ -111,4 +112,4 @@ Using `terraform import`, import AWS Opensearch Inbound Connection Accepters usi % terraform import aws_opensearch_inbound_connection_accepter.foo connection-id ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/opensearch_outbound_connection.html.markdown b/website/docs/cdktf/typescript/r/opensearch_outbound_connection.html.markdown index cdfa5a902181..02067561cc58 100644 --- a/website/docs/cdktf/typescript/r/opensearch_outbound_connection.html.markdown +++ b/website/docs/cdktf/typescript/r/opensearch_outbound_connection.html.markdown @@ -40,12 +40,12 @@ class MyConvertedCode extends TerraformStack { localDomainInfo: { domainName: localDomain.domainName, ownerId: Token.asString(current.accountId), - region: Token.asString(dataAwsRegionCurrent.name), + region: Token.asString(dataAwsRegionCurrent.region), }, remoteDomainInfo: { domainName: remoteDomain.domainName, ownerId: Token.asString(current.accountId), - region: Token.asString(dataAwsRegionCurrent.name), + region: Token.asString(dataAwsRegionCurrent.region), }, }); } @@ -57,6 +57,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `connectionAlias` - (Required, Forces new resource) Specifies the connection alias that will be used by the customer for this connection. * `connectionMode` - (Required, Forces new resource) Specifies the connection mode. Accepted values are `DIRECT` or `VPC_ENDPOINT`. * `acceptConnection` - (Optional, Forces new resource) Accepts the connection. @@ -134,4 +135,4 @@ Using `terraform import`, import AWS Opensearch Outbound Connections using the O % terraform import aws_opensearch_outbound_connection.foo connection-id ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/opensearch_package.html.markdown b/website/docs/cdktf/typescript/r/opensearch_package.html.markdown index cd4793bab4c4..76313420fe53 100644 --- a/website/docs/cdktf/typescript/r/opensearch_package.html.markdown +++ b/website/docs/cdktf/typescript/r/opensearch_package.html.markdown @@ -62,6 +62,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `packageName` - (Required, Forces new resource) Unique name for the package. * `packageType` - (Required, Forces new resource) The type of package. * `packageSource` - (Required, Forces new resource) Configuration block for the package source options. @@ -107,4 +108,4 @@ Using `terraform import`, import AWS Opensearch Packages using the Package ID. F % terraform import aws_opensearch_package.example package-id ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/opensearch_package_association.html.markdown b/website/docs/cdktf/typescript/r/opensearch_package_association.html.markdown index 013748ed86c5..03f579d23928 100644 --- a/website/docs/cdktf/typescript/r/opensearch_package_association.html.markdown +++ b/website/docs/cdktf/typescript/r/opensearch_package_association.html.markdown @@ -61,6 +61,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `packageId` - (Required, Forces new resource) Internal ID of the package to associate with a domain. * `domainName` - (Required, Forces new resource) Name of the domain to associate the package with. @@ -77,4 +78,4 @@ This resource exports the following attributes in addition to the arguments abov * `create` - (Default `10m`) * `delete` - (Default `10m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/opensearch_vpc_endpoint.html.markdown b/website/docs/cdktf/typescript/r/opensearch_vpc_endpoint.html.markdown index eb8f330870cc..b093c33d4b31 100644 --- a/website/docs/cdktf/typescript/r/opensearch_vpc_endpoint.html.markdown +++ b/website/docs/cdktf/typescript/r/opensearch_vpc_endpoint.html.markdown @@ -47,6 +47,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `domainArn` - (Required, Forces new resource) Specifies the Amazon Resource Name (ARN) of the domain to create the endpoint for * `vpcOptions` - (Required) Options to specify the subnets and security groups for the endpoint. @@ -102,4 +103,4 @@ Using `terraform import`, import OpenSearch VPC endpoint connections using the ` % terraform import aws_opensearch_vpc_endpoint_connection.example endpoint-id ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/opensearchserverless_access_policy.html.markdown b/website/docs/cdktf/typescript/r/opensearchserverless_access_policy.html.markdown index 55afb353f767..22d1cce5761e 100644 --- a/website/docs/cdktf/typescript/r/opensearchserverless_access_policy.html.markdown +++ b/website/docs/cdktf/typescript/r/opensearchserverless_access_policy.html.markdown @@ -160,6 +160,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `description` - (Optional) Description of the policy. Typically used to store information about the permissions defined in the policy. ## Attribute Reference @@ -200,4 +201,4 @@ Using `terraform import`, import OpenSearchServerless Access Policy using the `n % terraform import aws_opensearchserverless_access_policy.example example/data ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/opensearchserverless_collection.html.markdown b/website/docs/cdktf/typescript/r/opensearchserverless_collection.html.markdown index e84ade8324af..e42ecc5f3515 100644 --- a/website/docs/cdktf/typescript/r/opensearchserverless_collection.html.markdown +++ b/website/docs/cdktf/typescript/r/opensearchserverless_collection.html.markdown @@ -68,6 +68,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `description` - (Optional) Description of the collection. * `standbyReplicas` - (Optional) Indicates whether standby replicas should be used for a collection. One of `ENABLED` or `DISABLED`. Defaults to `ENABLED`. * `tags` - (Optional) A map of tags to assign to the collection. If configured with a provider [`defaultTags` 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. @@ -122,4 +123,4 @@ Using `terraform import`, import OpenSearchServerless Collection using the `id`. % terraform import aws_opensearchserverless_collection.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/opensearchserverless_lifecycle_policy.html.markdown b/website/docs/cdktf/typescript/r/opensearchserverless_lifecycle_policy.html.markdown index 534430f4255e..ad8c5cfd24ee 100644 --- a/website/docs/cdktf/typescript/r/opensearchserverless_lifecycle_policy.html.markdown +++ b/website/docs/cdktf/typescript/r/opensearchserverless_lifecycle_policy.html.markdown @@ -63,6 +63,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `description` - (Optional) Description of the policy. ## Attribute Reference @@ -103,4 +104,4 @@ Using `terraform import`, import OpenSearch Serverless Lifecycle Policy using th % terraform import aws_opensearchserverless_lifecycle_policy.example example/retention ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/opensearchserverless_security_config.html.markdown b/website/docs/cdktf/typescript/r/opensearchserverless_security_config.html.markdown index 2ab1e037ce39..b00d5f243b77 100644 --- a/website/docs/cdktf/typescript/r/opensearchserverless_security_config.html.markdown +++ b/website/docs/cdktf/typescript/r/opensearchserverless_security_config.html.markdown @@ -52,6 +52,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `description` - (Optional) Description of the security configuration. ### saml_options @@ -99,4 +100,4 @@ Using `terraform import`, import OpenSearchServerless Access Policy using the `n % terraform import aws_opensearchserverless_security_config.example saml/123456789012/example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/opensearchserverless_security_policy.html.markdown b/website/docs/cdktf/typescript/r/opensearchserverless_security_policy.html.markdown index a873d28a3b86..ce8c7dbf1766 100644 --- a/website/docs/cdktf/typescript/r/opensearchserverless_security_policy.html.markdown +++ b/website/docs/cdktf/typescript/r/opensearchserverless_security_policy.html.markdown @@ -276,6 +276,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `description` - (Optional) Description of the policy. Typically used to store information about the permissions defined in the policy. ## Attribute Reference @@ -316,4 +317,4 @@ Using `terraform import`, import OpenSearchServerless Security Policy using the % terraform import aws_opensearchserverless_security_policy.example example/encryption ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/opensearchserverless_vpc_endpoint.html.markdown b/website/docs/cdktf/typescript/r/opensearchserverless_vpc_endpoint.html.markdown index e844f1440a95..948c60733bd3 100644 --- a/website/docs/cdktf/typescript/r/opensearchserverless_vpc_endpoint.html.markdown +++ b/website/docs/cdktf/typescript/r/opensearchserverless_vpc_endpoint.html.markdown @@ -48,6 +48,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `securityGroupIds` - (Optional) One or more security groups that define the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint. Up to 5 security groups can be provided. ## Attribute Reference @@ -96,4 +97,4 @@ Using `terraform import`, import OpenSearchServerless Vpc Endpointa using the `i % terraform import aws_opensearchserverless_vpc_endpoint.example vpce-8012925589 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/osis_pipeline.html.markdown b/website/docs/cdktf/typescript/r/osis_pipeline.html.markdown index 15fcb9181cd6..b53ada9c389d 100644 --- a/website/docs/cdktf/typescript/r/osis_pipeline.html.markdown +++ b/website/docs/cdktf/typescript/r/osis_pipeline.html.markdown @@ -55,7 +55,7 @@ class MyConvertedCode extends TerraformStack { 'version: "2"\nexample-pipeline:\n source:\n http:\n path: "/example"\n sink:\n - s3:\n aws:\n sts_role_arn: "${' + example.arn + '}"\n region: "${' + - current.name + + current.region + '}"\n bucket: "example"\n threshold:\n event_collect_timeout: "60s"\n codec:\n ndjson:\n\n', pipelineName: "example", }); @@ -102,6 +102,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `bufferOptions` - (Optional) Key-value pairs to configure persistent buffering for the pipeline. See [`bufferOptions`](#buffer_options) below. * `encryptionAtRestOptions` - (Optional) Key-value pairs to configure encryption for data that is written to a persistent buffer. See [`encryptionAtRestOptions`](#encryption_at_rest_options) below. * `logPublishingOptions` - (Optional) Key-value pairs to configure log publishing. See [`logPublishingOptions`](#log_publishing_options) below. @@ -175,4 +176,4 @@ Using `terraform import`, import OpenSearch Ingestion Pipeline using the `id`. F % terraform import aws_osis_pipeline.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/paymentcryptography_key.html.markdown b/website/docs/cdktf/typescript/r/paymentcryptography_key.html.markdown index 52cf2d8d8317..71c3461a1710 100644 --- a/website/docs/cdktf/typescript/r/paymentcryptography_key.html.markdown +++ b/website/docs/cdktf/typescript/r/paymentcryptography_key.html.markdown @@ -59,6 +59,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `enabled` - (Optional) Whether to enable the key. * `keyCheckValueAlgorithm` - (Optional) Algorithm that AWS Payment Cryptography uses to calculate the key check value (KCV). * `tags` - (Optional) Map of tags assigned to the WorkSpaces Connection Alias. If configured with a provider [`defaultTags` 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. @@ -76,6 +77,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `decrypt` - (Optional) Whether an AWS Payment Cryptography key can be used to decrypt data. * `deriveKey` - (Optional) Whether an AWS Payment Cryptography key can be used to derive new keys. * `encrypt` - (Optional) Whether an AWS Payment Cryptography key can be used to encrypt data. @@ -136,4 +138,4 @@ Using `terraform import`, import Payment Cryptography Control Plane Key using th % terraform import aws_paymentcryptography_key.example arn:aws:payment-cryptography:us-east-1:123456789012:key/qtbojf64yshyvyzf ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/paymentcryptography_key_alias.html.markdown b/website/docs/cdktf/typescript/r/paymentcryptography_key_alias.html.markdown index 1c0f4b2aa2c1..c00b9714bd28 100644 --- a/website/docs/cdktf/typescript/r/paymentcryptography_key_alias.html.markdown +++ b/website/docs/cdktf/typescript/r/paymentcryptography_key_alias.html.markdown @@ -69,6 +69,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `keyArn` - (Optional) ARN of the key. ## Attribute Reference @@ -107,4 +108,4 @@ Using `terraform import`, import Payment Cryptography Control Plane Key Alias us % terraform import aws_paymentcryptography_key_alias.example alias/4681482429376900170 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/pinpoint_adm_channel.html.markdown b/website/docs/cdktf/typescript/r/pinpoint_adm_channel.html.markdown index 1bef135d9321..777d2e30c1e4 100644 --- a/website/docs/cdktf/typescript/r/pinpoint_adm_channel.html.markdown +++ b/website/docs/cdktf/typescript/r/pinpoint_adm_channel.html.markdown @@ -46,6 +46,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `applicationId` - (Required) The application ID. * `clientId` - (Required) Client ID (part of OAuth Credentials) obtained via Amazon Developer Account. * `clientSecret` - (Required) Client Secret (part of OAuth Credentials) obtained via Amazon Developer Account. @@ -87,4 +88,4 @@ Using `terraform import`, import Pinpoint ADM Channel using the `application-id` % terraform import aws_pinpoint_adm_channel.channel application-id ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/pinpoint_apns_channel.html.markdown b/website/docs/cdktf/typescript/r/pinpoint_apns_channel.html.markdown index 01418725d7ed..7f503c5c4969 100644 --- a/website/docs/cdktf/typescript/r/pinpoint_apns_channel.html.markdown +++ b/website/docs/cdktf/typescript/r/pinpoint_apns_channel.html.markdown @@ -45,6 +45,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `applicationId` - (Required) The application ID. * `enabled` - (Optional) Whether the channel is enabled or disabled. Defaults to `true`. * `defaultAuthenticationMethod` - (Optional) The default authentication method used for APNs. @@ -98,4 +99,4 @@ Using `terraform import`, import Pinpoint APNs Channel using the `application-id % terraform import aws_pinpoint_apns_channel.apns application-id ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/pinpoint_apns_sandbox_channel.html.markdown b/website/docs/cdktf/typescript/r/pinpoint_apns_sandbox_channel.html.markdown index ddd730a31b3d..a0fbbe3263db 100644 --- a/website/docs/cdktf/typescript/r/pinpoint_apns_sandbox_channel.html.markdown +++ b/website/docs/cdktf/typescript/r/pinpoint_apns_sandbox_channel.html.markdown @@ -45,6 +45,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `applicationId` - (Required) The application ID. * `enabled` - (Optional) Whether the channel is enabled or disabled. Defaults to `true`. * `defaultAuthenticationMethod` - (Optional) The default authentication method used for APNs Sandbox. @@ -102,4 +103,4 @@ Using `terraform import`, import Pinpoint APNs Sandbox Channel using the `applic % terraform import aws_pinpoint_apns_sandbox_channel.apns_sandbox application-id ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/pinpoint_apns_voip_channel.html.markdown b/website/docs/cdktf/typescript/r/pinpoint_apns_voip_channel.html.markdown index 44a7e1423685..29ca21cfdb42 100644 --- a/website/docs/cdktf/typescript/r/pinpoint_apns_voip_channel.html.markdown +++ b/website/docs/cdktf/typescript/r/pinpoint_apns_voip_channel.html.markdown @@ -45,6 +45,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `applicationId` - (Required) The application ID. * `enabled` - (Optional) Whether the channel is enabled or disabled. Defaults to `true`. * `defaultAuthenticationMethod` - (Optional) The default authentication method used for APNs. @@ -102,4 +103,4 @@ Using `terraform import`, import Pinpoint APNs VoIP Channel using the `applicati % terraform import aws_pinpoint_apns_voip_channel.apns_voip application-id ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/pinpoint_apns_voip_sandbox_channel.html.markdown b/website/docs/cdktf/typescript/r/pinpoint_apns_voip_sandbox_channel.html.markdown index f8623afe41ae..0cbdef0359aa 100644 --- a/website/docs/cdktf/typescript/r/pinpoint_apns_voip_sandbox_channel.html.markdown +++ b/website/docs/cdktf/typescript/r/pinpoint_apns_voip_sandbox_channel.html.markdown @@ -45,6 +45,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `applicationId` - (Required) The application ID. * `enabled` - (Optional) Whether the channel is enabled or disabled. Defaults to `true`. * `defaultAuthenticationMethod` - (Optional) The default authentication method used for APNs. @@ -102,4 +103,4 @@ Using `terraform import`, import Pinpoint APNs VoIP Sandbox Channel using the `a % terraform import aws_pinpoint_apns_voip_sandbox_channel.apns_voip_sandbox application-id ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/pinpoint_app.html.markdown b/website/docs/cdktf/typescript/r/pinpoint_app.html.markdown index 06b758b9751a..9f51e92d2215 100644 --- a/website/docs/cdktf/typescript/r/pinpoint_app.html.markdown +++ b/website/docs/cdktf/typescript/r/pinpoint_app.html.markdown @@ -45,6 +45,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Optional) The application name. By default generated by Terraform * `namePrefix` - (Optional) The name of the Pinpoint application. Conflicts with `name` * `campaignHook` - (Optional) Specifies settings for invoking an AWS Lambda function that customizes a segment for a campaign @@ -106,4 +107,4 @@ Using `terraform import`, import Pinpoint App using the `application-id`. For ex % terraform import aws_pinpoint_app.name application-id ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/pinpoint_baidu_channel.html.markdown b/website/docs/cdktf/typescript/r/pinpoint_baidu_channel.html.markdown index c1385fbc8581..92251732fce0 100644 --- a/website/docs/cdktf/typescript/r/pinpoint_baidu_channel.html.markdown +++ b/website/docs/cdktf/typescript/r/pinpoint_baidu_channel.html.markdown @@ -45,6 +45,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `applicationId` - (Required) The application ID. * `enabled` - (Optional) Specifies whether to enable the channel. Defaults to `true`. * `apiKey` - (Required) Platform credential API key from Baidu. @@ -86,4 +87,4 @@ Using `terraform import`, import Pinpoint Baidu Channel using the `application-i % terraform import aws_pinpoint_baidu_channel.channel application-id ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/pinpoint_email_channel.html.markdown b/website/docs/cdktf/typescript/r/pinpoint_email_channel.html.markdown index 43fe66bcbfe2..0bf43df7abec 100644 --- a/website/docs/cdktf/typescript/r/pinpoint_email_channel.html.markdown +++ b/website/docs/cdktf/typescript/r/pinpoint_email_channel.html.markdown @@ -90,12 +90,13 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `applicationId` - (Required) The application ID. * `enabled` - (Optional) Whether the channel is enabled or disabled. Defaults to `true`. * `configurationSet` - (Optional) The ARN of the Amazon SES configuration set that you want to apply to messages that you send through the channel. * `fromAddress` - (Required) The email address used to send emails from. You can use email only (`user@example.com`) or friendly address (`User `). This field comply with [RFC 5322](https://www.ietf.org/rfc/rfc5322.txt). * `identity` - (Required) The ARN of an identity verified with SES. -* `orchestration_sending_role_arn` - (Optional) The ARN of an IAM role for Amazon Pinpoint to use to send email from your campaigns or journeys through Amazon SES. +* `orchestrationSendingRoleArn` - (Optional) The ARN of an IAM role for Amazon Pinpoint to use to send email from your campaigns or journeys through Amazon SES. * `roleArn` - (Optional) *Deprecated* The ARN of an IAM Role used to submit events to Mobile Analytics' event ingestion service. ## Attribute Reference @@ -136,4 +137,4 @@ Using `terraform import`, import Pinpoint Email Channel using the `application-i % terraform import aws_pinpoint_email_channel.email application-id ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/pinpoint_email_template.markdown b/website/docs/cdktf/typescript/r/pinpoint_email_template.markdown index e6deedd89024..4aa828ba464d 100644 --- a/website/docs/cdktf/typescript/r/pinpoint_email_template.markdown +++ b/website/docs/cdktf/typescript/r/pinpoint_email_template.markdown @@ -48,8 +48,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `templateName` - (Required) name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive. * `emailTemplate` - (Required) Specifies the content and settings for a message template that can be used in messages that are sent through the email channel. See [Email Template](#email-template) @@ -107,4 +108,4 @@ Using `terraform import`, import Pinpoint Email Template using the `templateName % terraform import aws_pinpoint_email_template.reset template_name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/pinpoint_event_stream.html.markdown b/website/docs/cdktf/typescript/r/pinpoint_event_stream.html.markdown index d691c1e8d39c..470587307094 100644 --- a/website/docs/cdktf/typescript/r/pinpoint_event_stream.html.markdown +++ b/website/docs/cdktf/typescript/r/pinpoint_event_stream.html.markdown @@ -91,6 +91,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `applicationId` - (Required) The application ID. * `destinationStreamArn` - (Required) The Amazon Resource Name (ARN) of the Amazon Kinesis stream or Firehose delivery stream to which you want to publish events. * `roleArn` - (Required) The IAM role that authorizes Amazon Pinpoint to publish events to the stream in your account. @@ -131,4 +132,4 @@ Using `terraform import`, import Pinpoint Event Stream using the `application-id % terraform import aws_pinpoint_event_stream.stream application-id ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/pinpoint_gcm_channel.html.markdown b/website/docs/cdktf/typescript/r/pinpoint_gcm_channel.html.markdown index ff587950d0e8..2002e4c32da2 100644 --- a/website/docs/cdktf/typescript/r/pinpoint_gcm_channel.html.markdown +++ b/website/docs/cdktf/typescript/r/pinpoint_gcm_channel.html.markdown @@ -45,6 +45,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `applicationId` - (Required) The application ID. * `apiKey` - (Required) Platform credential API key from Google. * `enabled` - (Optional) Whether the channel is enabled or disabled. Defaults to `true`. @@ -81,4 +82,4 @@ Using `terraform import`, import Pinpoint GCM Channel using the `application-id` % terraform import aws_pinpoint_gcm_channel.gcm application-id ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/pinpoint_sms_channel.html.markdown b/website/docs/cdktf/typescript/r/pinpoint_sms_channel.html.markdown index 4f12430270e1..ff2cadc0b3d4 100644 --- a/website/docs/cdktf/typescript/r/pinpoint_sms_channel.html.markdown +++ b/website/docs/cdktf/typescript/r/pinpoint_sms_channel.html.markdown @@ -40,6 +40,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `applicationId` - (Required) ID of the application. * `enabled` - (Optional) Whether the channel is enabled or disabled. By default, it is set to `true`. * `senderId` - (Optional) Identifier of the sender for your messages. @@ -80,4 +81,4 @@ Using `terraform import`, import the Pinpoint SMS Channel using the `application % terraform import aws_pinpoint_sms_channel.sms application-id ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/pinpointsmsvoicev2_configuration_set.html.markdown b/website/docs/cdktf/typescript/r/pinpointsmsvoicev2_configuration_set.html.markdown index 9f6ad507fbf0..0228e5c3f847 100644 --- a/website/docs/cdktf/typescript/r/pinpointsmsvoicev2_configuration_set.html.markdown +++ b/website/docs/cdktf/typescript/r/pinpointsmsvoicev2_configuration_set.html.markdown @@ -40,6 +40,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) The name of the configuration set. * `defaultSenderId` - (Optional) The default sender ID to use for this configuration set. * `defaultMessageType` - (Optional) The default message type. Must either be "TRANSACTIONAL" or "PROMOTIONAL" @@ -84,4 +85,4 @@ Using `terraform import`, import configuration sets using the `name`. For exampl % terraform import aws_pinpointsmsvoicev2_configuration_set.example example-configuration-set ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/pinpointsmsvoicev2_opt_out_list.html.markdown b/website/docs/cdktf/typescript/r/pinpointsmsvoicev2_opt_out_list.html.markdown index 5f9c2002968f..3de7fb60abe2 100644 --- a/website/docs/cdktf/typescript/r/pinpointsmsvoicev2_opt_out_list.html.markdown +++ b/website/docs/cdktf/typescript/r/pinpointsmsvoicev2_opt_out_list.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) The name of the opt-out list. * `tags` - (Optional) Key-value map of resource tags. If configured with a provider [`defaultTags` 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. @@ -80,4 +81,4 @@ Using `terraform import`, import opt-out lists using the `name`. For example: % terraform import aws_pinpointsmsvoicev2_opt_out_list.example example-opt-out-list ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/pinpointsmsvoicev2_phone_number.html.markdown b/website/docs/cdktf/typescript/r/pinpointsmsvoicev2_phone_number.html.markdown index 9b0fc4904342..a947e394c9b9 100644 --- a/website/docs/cdktf/typescript/r/pinpointsmsvoicev2_phone_number.html.markdown +++ b/website/docs/cdktf/typescript/r/pinpointsmsvoicev2_phone_number.html.markdown @@ -41,6 +41,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `deletionProtectionEnabled` - (Optional) By default this is set to `false`. When set to true the phone number can’t be deleted. * `isoCountryCode` - (Required) The two-character code, in ISO 3166-1 alpha-2 format, for the country or region. * `messageType` - (Required) The type of message. Valid values are `TRANSACTIONAL` for messages that are critical or time-sensitive and `PROMOTIONAL` for messages that aren’t critical or time-sensitive. @@ -95,4 +96,4 @@ Using `terraform import`, import phone numbers using the `id`. For example: % terraform import aws_pinpointsmsvoicev2_phone_number.example phone-abcdef0123456789abcdef0123456789 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/pipes_pipe.html.markdown b/website/docs/cdktf/typescript/r/pipes_pipe.html.markdown index 07bd90239bf1..d6a5f6299b52 100644 --- a/website/docs/cdktf/typescript/r/pipes_pipe.html.markdown +++ b/website/docs/cdktf/typescript/r/pipes_pipe.html.markdown @@ -275,6 +275,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `description` - (Optional) A description of the pipe. At most 512 characters. * `desiredState` - (Optional) The state the pipe should be in. One of: `RUNNING`, `STOPPED`. * `enrichment` - (Optional) Enrichment resource of the pipe (typically an ARN). Read more about enrichment in the [User Guide](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes.html#pipes-enrichment). @@ -687,4 +688,4 @@ Using `terraform import`, import pipes using the `name`. For example: % terraform import aws_pipes_pipe.example my-pipe ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/placement_group.html.markdown b/website/docs/cdktf/typescript/r/placement_group.html.markdown index b64bd1843613..f426cc779eb6 100644 --- a/website/docs/cdktf/typescript/r/placement_group.html.markdown +++ b/website/docs/cdktf/typescript/r/placement_group.html.markdown @@ -40,6 +40,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) The name of the placement group. * `partitionCount` - (Optional) The number of partitions to create in the placement group. Can only be specified when the `strategy` is set to @@ -90,4 +91,4 @@ Using `terraform import`, import placement groups using the `name`. For example: % terraform import aws_placement_group.prod_pg production-placement-group ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/prometheus_alert_manager_definition.html.markdown b/website/docs/cdktf/typescript/r/prometheus_alert_manager_definition.html.markdown index 98e9ee3921d5..4243ad5126f0 100644 --- a/website/docs/cdktf/typescript/r/prometheus_alert_manager_definition.html.markdown +++ b/website/docs/cdktf/typescript/r/prometheus_alert_manager_definition.html.markdown @@ -45,6 +45,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `workspaceId` - (Required) ID of the prometheus workspace the alert manager definition should be linked to * `definition` - (Required) the alert manager definition that you want to be applied. See more [in AWS Docs](https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-alert-manager.html). @@ -84,4 +85,4 @@ Using `terraform import`, import the prometheus alert manager definition using t % terraform import aws_prometheus_alert_manager_definition.demo ws-C6DCB907-F2D7-4D96-957B-66691F865D8B ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/prometheus_query_logging_configuration.html.markdown b/website/docs/cdktf/typescript/r/prometheus_query_logging_configuration.html.markdown new file mode 100644 index 000000000000..ee4450269594 --- /dev/null +++ b/website/docs/cdktf/typescript/r/prometheus_query_logging_configuration.html.markdown @@ -0,0 +1,130 @@ +--- +subcategory: "AMP (Managed Prometheus)" +layout: "aws" +page_title: "AWS: aws_prometheus_query_logging_configuration" +description: |- + Manages an Amazon Managed Service for Prometheus (AMP) Query Logging Configuration. +--- + + + +# Resource: aws_prometheus_query_logging_configuration + +Manages an Amazon Managed Service for Prometheus (AMP) Query Logging Configuration. + +## Example Usage + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { Token, TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { CloudwatchLogGroup } from "./.gen/providers/aws/cloudwatch-log-group"; +import { PrometheusQueryLoggingConfiguration } from "./.gen/providers/aws/prometheus-query-logging-configuration"; +import { PrometheusWorkspace } from "./.gen/providers/aws/prometheus-workspace"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + const example = new CloudwatchLogGroup(this, "example", { + name: "/aws/prometheus/query-logs/example", + }); + const awsPrometheusWorkspaceExample = new PrometheusWorkspace( + this, + "example_1", + { + alias: "example", + } + ); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + awsPrometheusWorkspaceExample.overrideLogicalId("example"); + const awsPrometheusQueryLoggingConfigurationExample = + new PrometheusQueryLoggingConfiguration(this, "example_2", { + destination: [ + { + cloudwatchLogs: [ + { + logGroupArn: "${" + example.arn + "}:*", + }, + ], + filters: [ + { + qspThreshold: 1000, + }, + ], + }, + ], + workspaceId: Token.asString(awsPrometheusWorkspaceExample.id), + }); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + awsPrometheusQueryLoggingConfigurationExample.overrideLogicalId("example"); + } +} + +``` + +## Argument Reference + +This resource supports the following arguments: + +* `destination` - (Required) Configuration block for the logging destinations. See [`destinations`](#destinations). +* `workspaceId` - (Required) The ID of the AMP workspace for which to configure query logging. + +The following arguments are optional: + +* `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). + +### `destination` + +* `cloudwatchLogs` - (Required) Configuration block for CloudWatch Logs destination. See [`cloudwatchLogs`](#cloudwatch_logs). +* `filters` - (Required) A list of filter configurations that specify which logs should be sent to the destination. See [`filters`](#filters). + +#### `cloudwatchLogs` + +* `logGroupArn` - (Required) The ARN of the CloudWatch log group to which query logs will be sent. + +#### `filters` + +* `qspThreshold` - (Required) The Query Samples Processed (QSP) threshold above which queries will be logged. Queries processing more samples than this threshold will be captured in logs. + +## 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 the Query Logging Configuration using the workspace ID. For example: + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { PrometheusQueryLoggingConfiguration } from "./.gen/providers/aws/prometheus-query-logging-configuration"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + PrometheusQueryLoggingConfiguration.generateConfigForImport( + this, + "example", + "ws-12345678-90ab-cdef-1234-567890abcdef" + ); + } +} + +``` + +## Timeouts + +[Configuration options](https://developer.hashicorp.com/terraform/language/resources/syntax#operation-timeouts): + +- `create` - (Default `5m`) +- `update` - (Default `5m`) +- `delete` - (Default `5m`) + + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/prometheus_rule_group_namespace.html.markdown b/website/docs/cdktf/typescript/r/prometheus_rule_group_namespace.html.markdown index 29819cb05d20..60de529f8d57 100644 --- a/website/docs/cdktf/typescript/r/prometheus_rule_group_namespace.html.markdown +++ b/website/docs/cdktf/typescript/r/prometheus_rule_group_namespace.html.markdown @@ -45,6 +45,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `data` - (Required) the rule group namespace data that you want to be applied. See more [in AWS Docs](https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-Ruler.html). * `name` - (Required) The name of the rule group namespace. * `tags` - (Optional) Map of tags assigned to the resource. If configured with a provider [`defaultTags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. @@ -89,4 +90,4 @@ Using `terraform import`, import the prometheus rule group namespace using the a % terraform import aws_prometheus_rule_group_namespace.demo arn:aws:aps:us-west-2:123456789012:rulegroupsnamespace/IDstring/namespace_name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/prometheus_scraper.html.markdown b/website/docs/cdktf/typescript/r/prometheus_scraper.html.markdown index 33d7e04072fa..5c7e99020c01 100644 --- a/website/docs/cdktf/typescript/r/prometheus_scraper.html.markdown +++ b/website/docs/cdktf/typescript/r/prometheus_scraper.html.markdown @@ -259,14 +259,16 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `destination` - (Required) Configuration block for the managed scraper to send metrics to. See [`destination`](#destination). * `scrapeConfiguration` - (Required) The configuration file to use in the new scraper. For more information, see [Scraper configuration](https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-collector-how-to.html#AMP-collector-configuration). * `source` - (Required) Configuration block to specify where the managed scraper will collect metrics from. See [`source`](#source). The following arguments are optional: +* `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). * `alias` - (Optional) a name to associate with the managed scraper. This is for your use, and does not need to be unique. * `roleConfiguration` - (Optional) Configuration block to enable writing to an Amazon Managed Service for Prometheus workspace in a different account. See [`roleConfiguration`](#role_configuration) below. @@ -344,4 +346,4 @@ For example: % terraform import aws_prometheus_scraper.example s-0123abc-0000-0123-a000-000000000000 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/prometheus_workspace.html.markdown b/website/docs/cdktf/typescript/r/prometheus_workspace.html.markdown index ec7997e4cd4f..531c0d27e19a 100644 --- a/website/docs/cdktf/typescript/r/prometheus_workspace.html.markdown +++ b/website/docs/cdktf/typescript/r/prometheus_workspace.html.markdown @@ -109,6 +109,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `alias` - (Optional) The alias of the prometheus workspace. See more [in AWS Docs](https://docs.aws.amazon.com/prometheus/latest/userguide/AMP-onboard-create-workspace.html). * `kmsKeyArn` - (Optional) The ARN for the KMS encryption key. If this argument is not provided, then the AWS owned encryption key will be used to encrypt the data in the workspace. See more [in AWS Docs](https://docs.aws.amazon.com/prometheus/latest/userguide/encryption-at-rest-Amazon-Service-Prometheus.html) * `loggingConfiguration` - (Optional) Logging configuration for the workspace. See [Logging Configuration](#logging-configuration) below for details. @@ -161,4 +162,4 @@ Using `terraform import`, import AMP Workspaces using the identifier. For exampl % terraform import aws_prometheus_workspace.demo ws-C6DCB907-F2D7-4D96-957B-66691F865D8B ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/prometheus_workspace_configuration.html.markdown b/website/docs/cdktf/typescript/r/prometheus_workspace_configuration.html.markdown index 522e53dccd8b..67b8005b9a93 100644 --- a/website/docs/cdktf/typescript/r/prometheus_workspace_configuration.html.markdown +++ b/website/docs/cdktf/typescript/r/prometheus_workspace_configuration.html.markdown @@ -23,42 +23,38 @@ import { TerraformStack } from "cdktf"; * Provider bindings are generated by running `cdktf get`. * See https://cdk.tf/provider-generation for more details. */ -import { PrometheusWorkspaceConfiguration } from "./.gen/providers/aws/"; import { PrometheusWorkspace } from "./.gen/providers/aws/prometheus-workspace"; +import { PrometheusWorkspaceConfiguration } from "./.gen/providers/aws/prometheus-workspace-configuration"; class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); const example = new PrometheusWorkspace(this, "example", {}); const awsPrometheusWorkspaceConfigurationExample = new PrometheusWorkspaceConfiguration(this, "example_1", { - limits_per_label_set: [ + limitsPerLabelSet: [ { - label_set: [ - { - env: "dev", - }, - ], + labelSet: { + env: "dev", + }, limits: [ { - max_series: 100000, + maxSeries: 100000, }, ], }, { - label_set: [ - { - env: "prod", - }, - ], + labelSet: { + env: "prod", + }, limits: [ { - max_series: 400000, + maxSeries: 400000, }, ], }, ], - retention_period_in_days: 60, - workspace_id: example.id, + retentionPeriodInDays: 60, + workspaceId: example.id, }); /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ awsPrometheusWorkspaceConfigurationExample.overrideLogicalId("example"); @@ -81,25 +77,25 @@ import { TerraformStack } from "cdktf"; * Provider bindings are generated by running `cdktf get`. * See https://cdk.tf/provider-generation for more details. */ -import { PrometheusWorkspaceConfiguration } from "./.gen/providers/aws/"; import { PrometheusWorkspace } from "./.gen/providers/aws/prometheus-workspace"; +import { PrometheusWorkspaceConfiguration } from "./.gen/providers/aws/prometheus-workspace-configuration"; class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); const example = new PrometheusWorkspace(this, "example", {}); const awsPrometheusWorkspaceConfigurationExample = new PrometheusWorkspaceConfiguration(this, "example_1", { - limits_per_label_set: [ + limitsPerLabelSet: [ { - label_set: [{}], + labelSet: {}, limits: [ { - max_series: 50000, + maxSeries: 50000, }, ], }, ], - workspace_id: example.id, + workspaceId: example.id, }); /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ awsPrometheusWorkspaceConfigurationExample.overrideLogicalId("example"); @@ -116,22 +112,22 @@ The following arguments are required: The following arguments are optional: +* `limitsPerLabelSet` - (Optional) Configuration block for setting limits on metrics with specific label sets. Detailed below. +* `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). * `retentionPeriodInDays` - (Optional) Number of days to retain metric data in the workspace. -* `limits_per_label_set` - (Optional) Configuration block for setting limits on metrics with specific label sets. Detailed below. - -### `limits_per_label_set` -The `limits_per_label_set` configuration block supports the following arguments: +### `limitsPerLabelSet` -* `label_set` - (Required) Map of label key-value pairs that identify the metrics to which the limits apply. An empty map represents the default bucket for metrics that don't match any other label set. +The `limitsPerLabelSet` configuration block supports the following arguments: +* `labelSet` - (Required) Map of label key-value pairs that identify the metrics to which the limits apply. An empty map represents the default bucket for metrics that don't match any other label set. * `limits` - (Required) Configuration block for the limits to apply to the specified label set. Detailed below. #### `limits` The `limits` configuration block supports the following arguments: -* `max_series` - (Required) Maximum number of active time series that can be ingested for metrics matching the label set. +* `maxSeries` - (Required) Maximum number of active time series that can be ingested for metrics matching the label set. ## Attribute Reference @@ -156,7 +152,7 @@ import { TerraformStack } from "cdktf"; * Provider bindings are generated by running `cdktf get`. * See https://cdk.tf/provider-generation for more details. */ -import { PrometheusWorkspaceConfiguration } from "./.gen/providers/aws/"; +import { PrometheusWorkspaceConfiguration } from "./.gen/providers/aws/prometheus-workspace-configuration"; class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); @@ -176,4 +172,4 @@ Using `terraform import`, import AMP (Managed Prometheus) Workspace Configuratio % terraform import aws_prometheus_workspace_configuration.example ws-12345678-abcd-1234-abcd-123456789012 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/proxy_protocol_policy.html.markdown b/website/docs/cdktf/typescript/r/proxy_protocol_policy.html.markdown index 73abf47b731f..f4f05e3de819 100644 --- a/website/docs/cdktf/typescript/r/proxy_protocol_policy.html.markdown +++ b/website/docs/cdktf/typescript/r/proxy_protocol_policy.html.markdown @@ -58,6 +58,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `loadBalancer` - (Required) The load balancer to which the policy should be attached. * `instancePorts` - (Required) List of instance ports to which the policy @@ -70,4 +71,4 @@ This resource exports the following attributes in addition to the arguments abov * `id` - The ID of the policy. * `loadBalancer` - The load balancer to which the policy is attached. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/qbusiness_application.html.markdown b/website/docs/cdktf/typescript/r/qbusiness_application.html.markdown index 6dbcbf3f3902..3a0d09ffc47c 100644 --- a/website/docs/cdktf/typescript/r/qbusiness_application.html.markdown +++ b/website/docs/cdktf/typescript/r/qbusiness_application.html.markdown @@ -54,6 +54,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `description` - (Optional) Description of the Amazon Q application. * `encryptionConfiguration` - (Optional) Information about encryption configuration. See [`encryptionConfiguration`](#encryption_configuration) below. @@ -114,4 +115,4 @@ Using `terraform import`, import a Q Business Application using the `id`. For ex % terraform import aws_qbusiness_application.example id-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/qldb_ledger.html.markdown b/website/docs/cdktf/typescript/r/qldb_ledger.html.markdown index 11c7acdec4fa..f62c999b6693 100644 --- a/website/docs/cdktf/typescript/r/qldb_ledger.html.markdown +++ b/website/docs/cdktf/typescript/r/qldb_ledger.html.markdown @@ -41,6 +41,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `deletionProtection` - (Optional) The deletion protection for the QLDB Ledger instance. By default it is `true`. To delete this resource via Terraform, this value must be configured to `false` and applied first before attempting deletion. * `kmsKey` - (Optional) The key in AWS Key Management Service (AWS KMS) to use for encryption of data at rest in the ledger. For more information, see the [AWS documentation](https://docs.aws.amazon.com/qldb/latest/developerguide/encryption-at-rest.html). Valid values are `"AWS_OWNED_KMS_KEY"` to use an AWS KMS key that is owned and managed by AWS on your behalf, or the ARN of a valid symmetric customer managed KMS key. * `name` - (Optional) The friendly name for the QLDB Ledger instance. By default generated by Terraform. @@ -90,4 +91,4 @@ Using `terraform import`, import QLDB Ledgers using the `name`. For example: % terraform import aws_qldb_ledger.sample-ledger sample-ledger ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/qldb_stream.html.markdown b/website/docs/cdktf/typescript/r/qldb_stream.html.markdown index 4c93061ba334..c9a216663ba2 100644 --- a/website/docs/cdktf/typescript/r/qldb_stream.html.markdown +++ b/website/docs/cdktf/typescript/r/qldb_stream.html.markdown @@ -49,6 +49,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `exclusiveEndTime` - (Optional) The exclusive date and time that specifies when the stream ends. If you don't define this parameter, the stream runs indefinitely until you cancel it. It must be in ISO 8601 date and time format and in Universal Coordinated Time (UTC). For example: `"2019-06-13T21:36:34Z"`. * `inclusiveStartTime` - (Required) The inclusive start date and time from which to start streaming journal data. This parameter must be in ISO 8601 date and time format and in Universal Coordinated Time (UTC). For example: `"2019-06-13T21:36:34Z"`. This cannot be in the future and must be before `exclusiveEndTime`. If you provide a value that is before the ledger's `CreationDateTime`, QLDB effectively defaults it to the ledger's `CreationDateTime`. * `kinesisConfiguration` - (Required) The configuration settings of the Kinesis Data Streams destination for your stream request. Documented below. @@ -79,4 +80,4 @@ This resource exports the following attributes in addition to the arguments abov - `create` - (Default `8m`) - `delete` - (Default `5m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/quicksight_account_settings.html.markdown b/website/docs/cdktf/typescript/r/quicksight_account_settings.html.markdown index 9625e1ebd5c7..d4ea70bd8518 100644 --- a/website/docs/cdktf/typescript/r/quicksight_account_settings.html.markdown +++ b/website/docs/cdktf/typescript/r/quicksight_account_settings.html.markdown @@ -24,7 +24,7 @@ import { TerraformStack } from "cdktf"; * Provider bindings are generated by running `cdktf get`. * See https://cdk.tf/provider-generation for more details. */ -import { QuicksightAccountSettings } from "./.gen/providers/aws/"; +import { QuicksightAccountSettings } from "./.gen/providers/aws/quicksight-account-settings"; import { QuicksightAccountSubscription } from "./.gen/providers/aws/quicksight-account-subscription"; class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { @@ -41,7 +41,7 @@ class MyConvertedCode extends TerraformStack { ); new QuicksightAccountSettings(this, "example", { dependsOn: [subscription], - termination_protection_enabled: false, + terminationProtectionEnabled: false, }); } } @@ -52,14 +52,13 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: -* `default_namespace` - (Optional) The default namespace for this Amazon Web Services account. Currently, the default is `default`. +* `awsAccountId` - (Optional, Forces new resource) AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider. +* `defaultNamespace` - (Optional) The default namespace for this Amazon Web Services account. Currently, the default is `default`. * `terminationProtectionEnabled` - (Optional) A boolean value that determines whether or not an Amazon QuickSight account can be deleted. If `true`, it does not allow the account to be deleted and results in an error message if a user tries to make a DeleteAccountSubscription request. If `false`, it will allow the account to be deleted. ## Attribute Reference -This resource exports the following attributes in addition to the arguments above: - -* `awsAccountId` - The ID for the AWS account that contains the settings. +This resource exports no additional attributes. ## Import @@ -73,7 +72,7 @@ import { TerraformStack } from "cdktf"; * Provider bindings are generated by running `cdktf get`. * See https://cdk.tf/provider-generation for more details. */ -import { QuicksightAccountSettings } from "./.gen/providers/aws/"; +import { QuicksightAccountSettings } from "./.gen/providers/aws/quicksight-account-settings"; class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); @@ -93,4 +92,4 @@ Using `terraform import`, import QuickSight Account Settings using the AWS accou % terraform import aws_quicksight_account_settings.example "012345678901" ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/quicksight_account_subscription.html.markdown b/website/docs/cdktf/typescript/r/quicksight_account_subscription.html.markdown index 9a66e092fb86..cc1f28264d41 100644 --- a/website/docs/cdktf/typescript/r/quicksight_account_subscription.html.markdown +++ b/website/docs/cdktf/typescript/r/quicksight_account_subscription.html.markdown @@ -53,7 +53,7 @@ The following arguments are optional: * `activeDirectoryName` - (Optional) Name of your Active Directory. This field is required if `ACTIVE_DIRECTORY` is the selected authentication method of the new Amazon QuickSight account. * `adminGroup` - (Optional) Admin group associated with your Active Directory or IAM Identity Center account. This field is required if `ACTIVE_DIRECTORY` or `IAM_IDENTITY_CENTER` is the selected authentication method of the new Amazon QuickSight account. * `authorGroup` - (Optional) Author group associated with your Active Directory or IAM Identity Center account. -* `awsAccountId` - (Optional) AWS account ID hosting the QuickSight account. Default to provider account. +* `awsAccountId` - (Optional, Forces new resource) AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider. * `contactNumber` - (Optional) A 10-digit phone number for the author of the Amazon QuickSight account to use for future communications. This field is required if `ENTERPPRISE_AND_Q` is the selected edition of the new Amazon QuickSight account. * `directoryId` - (Optional) Active Directory ID that is associated with your Amazon QuickSight account. * `emailAddress` - (Optional) Email address of the author of the Amazon QuickSight account to use for future communications. This field is required if `ENTERPPRISE_AND_Q` is the selected edition of the new Amazon QuickSight account. @@ -62,6 +62,7 @@ The following arguments are optional: * `lastName` - (Optional) Last name of the author of the Amazon QuickSight account to use for future communications. This field is required if `ENTERPPRISE_AND_Q` is the selected edition of the new Amazon QuickSight account. * `readerGroup` - (Optional) Reader group associated with your Active Directory or IAM Identity Center account. * `realm` - (Optional) Realm of the Active Directory that is associated with your Amazon QuickSight account. +* `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). ## Attribute Reference @@ -78,6 +79,36 @@ This resource exports the following attributes in addition to the arguments abov ## Import -You cannot import this resource. +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import a QuickSight Account Subscription using `awsAccountId`. For example: - \ No newline at end of file +~> Due to the absence of required arguments in the [`DescribeAccountSettings`](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_DescribeAccountSettings.html) API response, importing an existing account subscription will result in a planned replacement on the subsequent `apply` operation. Until the Describe API response in extended to include all configurable arguments, an [`ignore_changes` lifecycle argument](https://developer.hashicorp.com/terraform/language/meta-arguments/lifecycle#ignore_changes) can be used to suppress differences on arguments not read into state. + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { QuicksightAccountSubscription } from "./.gen/providers/aws/quicksight-account-subscription"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + QuicksightAccountSubscription.generateConfigForImport( + this, + "example", + "012345678901" + ); + } +} + +``` + +Using `terraform import`, import a QuickSight Account Subscription using `awsAccountId`. For example: + +```console +% terraform import aws_quicksight_account_subscription.example "012345678901" +``` + + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/quicksight_analysis.html.markdown b/website/docs/cdktf/typescript/r/quicksight_analysis.html.markdown index eff9453baca5..e078145c6ee2 100644 --- a/website/docs/cdktf/typescript/r/quicksight_analysis.html.markdown +++ b/website/docs/cdktf/typescript/r/quicksight_analysis.html.markdown @@ -135,11 +135,12 @@ The following arguments are required: The following arguments are optional: -* `awsAccountId` - (Optional, Forces new resource) AWS account ID. +* `awsAccountId` - (Optional, Forces new resource) AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider. * `definition` - (Optional) A detailed analysis definition. Only one of `definition` or `sourceEntity` should be configured. See [definition](#definition). * `parameters` - (Optional) The parameters for the creation of the analysis, which you want to use to override the default settings. An analysis can have any type of parameters, and some parameters might accept multiple values. See [parameters](#parameters). * `permissions` - (Optional) A set of resource permissions on the analysis. Maximum of 64 items. See [permissions](#permissions). * `recoveryWindowInDays` - (Optional) A value that specifies the number of days that Amazon QuickSight waits before it deletes the analysis. Use `0` to force deletion without recovery. Minimum value of `7`. Maximum value of `30`. Default to `30`. +* `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). * `sourceEntity` - (Optional) The entity that you are using as a source when you create the analysis (template). Only one of `definition` or `sourceEntity` should be configured. See [source_entity](#source_entity). * `tags` - (Optional) Key-value map of resource tags. If configured with a provider [`defaultTags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. * `themeArn` - (Optional) The Amazon Resource Name (ARN) of the theme that is being used for this analysis. The theme ARN must exist in the same AWS account where you create the analysis. @@ -231,4 +232,4 @@ Using `terraform import`, import a QuickSight Analysis using the AWS account ID % terraform import aws_quicksight_analysis.example 123456789012,example-id ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/quicksight_custom_permissions.html.markdown b/website/docs/cdktf/typescript/r/quicksight_custom_permissions.html.markdown new file mode 100644 index 000000000000..e69a0bcfd91e --- /dev/null +++ b/website/docs/cdktf/typescript/r/quicksight_custom_permissions.html.markdown @@ -0,0 +1,104 @@ +--- +subcategory: "QuickSight" +layout: "aws" +page_title: "AWS: aws_quicksight_custom_permissions" +description: |- + Manages a QuickSight custom permissions profile. +--- + + + +# Resource: aws_quicksight_custom_permissions + +Manages a QuickSight custom permissions profile. + +## Example Usage + +resource "aws_quicksight_custom_permissions" "example" { + custom_permissions_name = "example-permissions" + + capabilities { + print_reports = "DENY" + share_dashboards = "DENY" + } +} + +## Argument Reference + +The following arguments are required: + +* `capabilities` - (Required) Actions to include in the custom permissions profile. See [capabilities](#capabilities). +* `customPermissionsName` - (Required, Forces new resource) Custom permissions profile name. + +The following arguments are optional: + +* `awsAccountId` - (Optional, Forces new resource) AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider. +* `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). +* `tags` - (Optional) Key-value map of resource tags. If configured with a provider [`defaultTags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. + +### capabilities + +* `addOrRunAnomalyDetectionForAnalyses` - (Optional) The ability to add or run anomaly detection. Valid values: `DENY`. +* `createAndUpdateDashboardEmailReports` - (Optional) The ability to create and update email reports. Valid values: `DENY`. +* `createAndUpdateDatasets` - (Optional) The ability to create and update datasets. Valid values: `DENY`. +* `createAndUpdateDataSources` - (Optional) The ability to create and update data sources. Valid values: `DENY`. +* `createAndUpdateThemes` - (Optional) The ability to export to create and update themes. Valid values: `DENY`. +* `createAndUpdateThresholdAlerts` - (Optional) The ability to create and update threshold alerts. Valid values: `DENY`. +* `createSharedFolders` - (Optional) The ability to create shared folders. Valid values: `DENY`. +* `createSpiceDataset` - (Optional) The ability to create a SPICE dataset. Valid values: `DENY`. +* `exportToCsv` - (Optional) The ability to export to CSV files from the UI. Valid values: `DENY`. +* `exportToCsvInScheduledReports` - (Optional) The ability to export to CSV files in scheduled email reports. Valid values: `DENY`. +* `exportToExcel` - (Optional) The ability to export to Excel files from the UI. Valid values: `DENY`. +* `exportToExcelInScheduledReports` - (Optional) The ability to export to Excel files in scheduled email reports. Valid values: `DENY`. +* `exportToPdf` - (Optional) The ability to export to PDF files from the UI. Valid values: `DENY`. +* `exportToPdfInScheduledReports` - (Optional) The ability to export to PDF files in scheduled email reports. Valid values: `DENY`. +* `includeContentInScheduledReportsEmail` - (Optional) The ability to include content in scheduled email reports. Valid values: `DENY`. +* `printReports` - (Optional) The ability to print reports. Valid values: `DENY`. +* `renameSharedFolders` - (Optional) The ability to rename shared folders. Valid values: `DENY`. +* `shareAnalyses` - (Optional) The ability to share analyses. Valid values: `DENY`. +* `shareDashboards` - (Optional) The ability to share dashboards. Valid values: `DENY`. +* `shareDatasets` - (Optional) The ability to share datasets. Valid values: `DENY`. +* `shareDataSources` - (Optional) The ability to share data sources. Valid values: `DENY`. +* `subscribeDashboardEmailReports` - (Optional) The ability to subscribe to email reports. Valid values: `DENY`. +* `viewAccountSpiceCapacity` - (Optional) The ability to view account SPICE capacity. Valid values: `DENY`. + +## Attribute Reference + +This resource exports the following attributes in addition to the arguments above: + +* `arn` - ARN of the custom permissions profile. +* `tagsAll` - A map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block). + +## Import + +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import a QuickSight custom permissions profile using the AWS account ID and custom permissions profile name separated by a comma (`,`). For example: + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { QuicksightCustomPermissions } from "./.gen/providers/aws/quicksight-custom-permissions"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + QuicksightCustomPermissions.generateConfigForImport( + this, + "example", + "123456789012,example-permissions" + ); + } +} + +``` + +Using `terraform import`, import a QuickSight custom permissions profile using the AWS account ID and custom permissions profile name separated by a comma (`,`). For example: + +```console +% terraform import aws_quicksight_custom_permissions.example 123456789012,example-permissions +``` + + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/quicksight_dashboard.html.markdown b/website/docs/cdktf/typescript/r/quicksight_dashboard.html.markdown index 0a54c7419b24..6acb55a676c2 100644 --- a/website/docs/cdktf/typescript/r/quicksight_dashboard.html.markdown +++ b/website/docs/cdktf/typescript/r/quicksight_dashboard.html.markdown @@ -138,11 +138,12 @@ The following arguments are required: The following arguments are optional: -* `awsAccountId` - (Optional, Forces new resource) AWS account ID. +* `awsAccountId` - (Optional, Forces new resource) AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider. * `dashboardPublishOptions` - (Optional) Options for publishing the dashboard. See [dashboard_publish_options](#dashboard_publish_options). * `definition` - (Optional) A detailed dashboard definition. Only one of `definition` or `sourceEntity` should be configured. See [definition](#definition). * `parameters` - (Optional) The parameters for the creation of the dashboard, which you want to use to override the default settings. A dashboard can have any type of parameters, and some parameters might accept multiple values. See [parameters](#parameters). * `permissions` - (Optional) A set of resource permissions on the dashboard. Maximum of 64 items. See [permissions](#permissions). +* `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). * `sourceEntity` - (Optional) The entity that you are using as a source when you create the dashboard (template). Only one of `definition` or `sourceEntity` should be configured. See [source_entity](#source_entity). * `tags` - (Optional) Key-value map of resource tags. If configured with a provider [`defaultTags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. * `themeArn` - (Optional) The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. The theme ARN must exist in the same AWS account where you create the dashboard. @@ -289,4 +290,4 @@ Using `terraform import`, import a QuickSight Dashboard using the AWS account ID % terraform import aws_quicksight_dashboard.example 123456789012,example-id ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/quicksight_data_set.html.markdown b/website/docs/cdktf/typescript/r/quicksight_data_set.html.markdown index 38b76f5d4669..84f201d13cec 100644 --- a/website/docs/cdktf/typescript/r/quicksight_data_set.html.markdown +++ b/website/docs/cdktf/typescript/r/quicksight_data_set.html.markdown @@ -265,7 +265,7 @@ The following arguments are required: The following arguments are optional: -* `awsAccountId` - (Optional, Forces new resource) AWS account ID. +* `awsAccountId` - (Optional, Forces new resource) AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider. * `columnGroups` - (Optional) Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported. See [column_groups](#column_groups). * `columnLevelPermissionRules` - (Optional) A set of 1 or more definitions of a [ColumnLevelPermissionRule](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_ColumnLevelPermissionRule.html). See [column_level_permission_rules](#column_level_permission_rules). * `dataSetUsageConfiguration` - (Optional) The usage configuration to apply to child datasets that reference this dataset as a source. See [data_set_usage_configuration](#data_set_usage_configuration). @@ -273,6 +273,7 @@ The following arguments are optional: * `logicalTableMap` - (Optional) Configures the combination and transformation of the data from the physical tables. Maximum of 1 entry. See [logical_table_map](#logical_table_map). * `permissions` - (Optional) A set of resource permissions on the data source. Maximum of 64 items. See [permissions](#permissions). * `physicalTableMap` - (Optional) Declares the physical tables that are available in the underlying data sources. See [physical_table_map](#physical_table_map). +* `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). * `rowLevelPermissionDataSet` - (Optional) The row-level security configuration for the data that you want to create. See [row_level_permission_data_set](#row_level_permission_data_set). * `rowLevelPermissionTagConfiguration` - (Optional) The configuration of tags on a dataset to set row-level security. Row-level security tags are currently supported for anonymous embedding only. See [row_level_permission_tag_configuration](#row_level_permission_tag_configuration). * `refreshProperties` - (Optional) The refresh properties for the data set. **NOTE**: Only valid when `importMode` is set to `SPICE`. See [refresh_properties](#refresh_properties). @@ -523,4 +524,4 @@ Using `terraform import`, import a QuickSight Data Set using the AWS account ID % terraform import aws_quicksight_data_set.example 123456789012,example-id ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/quicksight_data_source.html.markdown b/website/docs/cdktf/typescript/r/quicksight_data_source.html.markdown index fb60cce66d4a..0382e2c84f84 100644 --- a/website/docs/cdktf/typescript/r/quicksight_data_source.html.markdown +++ b/website/docs/cdktf/typescript/r/quicksight_data_source.html.markdown @@ -110,7 +110,7 @@ class MyConvertedCode extends TerraformStack { "https://${" + example.id + "}.s3-${" + - dataAwsRegionCurrent.name + + dataAwsRegionCurrent.region + "}.${" + dataAwsPartitionCurrent.dnsSuffix + "}", @@ -199,9 +199,10 @@ The following arguments are required: The following arguments are optional: -* `awsAccountId` - (Optional, Forces new resource) The ID for the AWS account that the data source is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account. +* `awsAccountId` - (Optional, Forces new resource) AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider. * `credentials` - (Optional) The credentials Amazon QuickSight uses to connect to your underlying source. See [Credentials](#credentials-argument-reference) below for more details. * `permission` - (Optional) A set of resource permissions on the data source. Maximum of 64 items. See [Permission](#permission-argument-reference) below for more details. +* `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). * `sslProperties` - (Optional) Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source. See [SSL Properties](#ssl_properties-argument-reference) below for more details. * `tags` - (Optional) Key-value map of resource tags. If configured with a provider [`defaultTags` 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. * `vpcConnectionProperties`- (Optional) Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source. See [VPC Connection Properties](#vpc_connection_properties-argument-reference) below for more details. @@ -414,4 +415,4 @@ Using `terraform import`, import a QuickSight data source using the AWS account % terraform import aws_quicksight_data_source.example 123456789123/my-data-source-id ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/quicksight_folder.html.markdown b/website/docs/cdktf/typescript/r/quicksight_folder.html.markdown index 1da8b321b4a3..c815d9044e9c 100644 --- a/website/docs/cdktf/typescript/r/quicksight_folder.html.markdown +++ b/website/docs/cdktf/typescript/r/quicksight_folder.html.markdown @@ -112,10 +112,11 @@ The following arguments are required: The following arguments are optional: -* `awsAccountId` - (Optional, Forces new resource) AWS account ID. +* `awsAccountId` - (Optional, Forces new resource) AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider. * `folderType` - (Optional) The type of folder. By default, it is `SHARED`. Valid values are: `SHARED`. * `parentFolderArn` - (Optional) The Amazon Resource Name (ARN) for the parent folder. If not set, creates a root-level folder. * `permissions` - (Optional) A set of resource permissions on the folder. Maximum of 64 items. See [permissions](#permissions). +* `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). * `tags` - (Optional) Key-value map of resource tags. If configured with a provider [`defaultTags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. ### permissions @@ -175,4 +176,4 @@ Using `terraform import`, import a QuickSight folder using the AWS account ID an % terraform import aws_quicksight_folder.example 123456789012,example-id ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/quicksight_folder_membership.html.markdown b/website/docs/cdktf/typescript/r/quicksight_folder_membership.html.markdown index 7a681cb552f9..611d7891138a 100644 --- a/website/docs/cdktf/typescript/r/quicksight_folder_membership.html.markdown +++ b/website/docs/cdktf/typescript/r/quicksight_folder_membership.html.markdown @@ -48,7 +48,8 @@ The following arguments are required: The following arguments are optional: -* `awsAccountId` - (Optional, Forces new resource) AWS account ID. +* `awsAccountId` - (Optional, Forces new resource) AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider. +* `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). ## Attribute Reference @@ -88,4 +89,4 @@ Using `terraform import`, import QuickSight Folder Membership using the AWS acco % terraform import aws_quicksight_folder_membership.example 123456789012,example-folder,DATASET,example-dataset ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/quicksight_group.html.markdown b/website/docs/cdktf/typescript/r/quicksight_group.html.markdown index 3cd7e65f94e9..b45cdf4d9dc0 100644 --- a/website/docs/cdktf/typescript/r/quicksight_group.html.markdown +++ b/website/docs/cdktf/typescript/r/quicksight_group.html.markdown @@ -38,10 +38,11 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: -* `groupName` - (Required) A name for the group. -* `awsAccountId` - (Optional) The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account. +* `awsAccountId` - (Optional, Forces new resource) AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider. * `description` - (Optional) A description for the group. +* `groupName` - (Required) A name for the group. * `namespace` - (Optional) The namespace. Currently, you should set this to `default`. +* `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). ## Attribute Reference @@ -81,4 +82,4 @@ Using `terraform import`, import QuickSight Group using the aws account id, name % terraform import aws_quicksight_group.example 123456789123/default/tf-example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/quicksight_group_membership.html.markdown b/website/docs/cdktf/typescript/r/quicksight_group_membership.html.markdown index bb85c00f49aa..d1345e38d438 100644 --- a/website/docs/cdktf/typescript/r/quicksight_group_membership.html.markdown +++ b/website/docs/cdktf/typescript/r/quicksight_group_membership.html.markdown @@ -39,10 +39,11 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `awsAccountId` - (Optional, Forces new resource) AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider. * `groupName` - (Required) The name of the group in which the member will be added. * `memberName` - (Required) The name of the member to add to the group. -* `awsAccountId` - (Optional) The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account. -* `namespace` - (Required) The namespace that you want the user to be a part of. Defaults to `default`. +* `namespace` - (Optional) The namespace that you want the user to be a part of. Defaults to `default`. +* `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). ## Attribute Reference @@ -80,4 +81,4 @@ Using `terraform import`, import QuickSight Group membership using the AWS accou % terraform import aws_quicksight_group_membership.example 123456789123/default/all-access-users/john_smith ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/quicksight_iam_policy_assignment.html.markdown b/website/docs/cdktf/typescript/r/quicksight_iam_policy_assignment.html.markdown index 92aaf4725427..79c76a1551a6 100644 --- a/website/docs/cdktf/typescript/r/quicksight_iam_policy_assignment.html.markdown +++ b/website/docs/cdktf/typescript/r/quicksight_iam_policy_assignment.html.markdown @@ -52,10 +52,11 @@ The following arguments are required: The following arguments are optional: -* `awsAccountId` - (Optional) AWS account ID. +* `awsAccountId` - (Optional, Forces new resource) AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider. * `identities` - (Optional) Amazon QuickSight users, groups, or both to assign the policy to. See [`identities` block](#identities-block). * `namespace` - (Optional) Namespace that contains the assignment. Defaults to `default`. * `policyArn` - (Optional) ARN of the IAM policy to apply to the Amazon QuickSight users and groups specified in this assignment. +* `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). ### `identities` block @@ -101,4 +102,4 @@ Using `terraform import`, import QuickSight IAM Policy Assignment using the AWS % terraform import aws_quicksight_iam_policy_assignment.example 123456789012,default,example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/quicksight_ingestion.html.markdown b/website/docs/cdktf/typescript/r/quicksight_ingestion.html.markdown index 717fa5dbf94f..f652375979f4 100644 --- a/website/docs/cdktf/typescript/r/quicksight_ingestion.html.markdown +++ b/website/docs/cdktf/typescript/r/quicksight_ingestion.html.markdown @@ -48,7 +48,8 @@ The following arguments are required: The following arguments are optional: -* `awsAccountId` - (Optional) AWS account ID. +* `awsAccountId` - (Optional, Forces new resource) AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider. +* `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). ## Attribute Reference @@ -90,4 +91,4 @@ Using `terraform import`, import QuickSight Ingestion using the AWS account ID, % terraform import aws_quicksight_ingestion.example 123456789012,example-dataset-id,example-ingestion-id ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/quicksight_ip_restriction.html.markdown b/website/docs/cdktf/typescript/r/quicksight_ip_restriction.html.markdown new file mode 100644 index 000000000000..01016f088299 --- /dev/null +++ b/website/docs/cdktf/typescript/r/quicksight_ip_restriction.html.markdown @@ -0,0 +1,92 @@ +--- +subcategory: "QuickSight" +layout: "aws" +page_title: "AWS: aws_quicksight_ip_restriction" +description: |- + Manages the content and status of IP rules. +--- + + + +# Resource: aws_quicksight_ip_restriction + +Manages the content and status of IP rules. + +~> Deletion of this resource clears all IP restrictions from a QuickSight account. + +## Example Usage + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { QuicksightIpRestriction } from "./.gen/providers/aws/quicksight-ip-restriction"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + new QuicksightIpRestriction(this, "example", { + enabled: true, + ipRestrictionRuleMap: { + "108.56.166.202/32": "Allow self", + }, + vpcIdRestrictionRuleMap: { + "${(aws_vpc.example.id)}": "Main VPC", + }, + }); + } +} + +``` + +## Argument Reference + +This resource supports the following arguments: + +* `awsAccountId` - (Optional, Forces new resource) AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider. +* `enabled` - (Required) Whether IP rules are turned on. +* `ipRestrictionRuleMap` - (Optional) Map of allowed IPv4 CIDR ranges and descriptions. +* `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). +* `vpcEndpointIdRestrictionRuleMap` - (Optional) Map of allowed VPC endpoint IDs and descriptions. +* `vpcIdRestrictionRuleMap` - (Optional) Map of VPC IDs and descriptions. Traffic from all VPC endpoints that are present in the specified VPC is allowed. + +## 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 QuickSight IP restriction using the AWS account ID. For example: + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { QuicksightIpRestriction } from "./.gen/providers/aws/quicksight-ip-restriction"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + QuicksightIpRestriction.generateConfigForImport( + this, + "example", + "012345678901" + ); + } +} + +``` + +Using `terraform import`, import QuickSight IP restriction using the AWS account ID. For example: + +```console +% terraform import aws_quicksight_ip_restriction.example "012345678901" +``` + + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/quicksight_key_registration.html.markdown b/website/docs/cdktf/typescript/r/quicksight_key_registration.html.markdown new file mode 100644 index 000000000000..592b4aa3ec0d --- /dev/null +++ b/website/docs/cdktf/typescript/r/quicksight_key_registration.html.markdown @@ -0,0 +1,96 @@ +--- +subcategory: "QuickSight" +layout: "aws" +page_title: "AWS: aws_quicksight_key_registration" +description: |- + Registers customer managed keys in a Amazon QuickSight account. +--- + + + +# Resource: aws_quicksight_key_registration + +Registers customer managed keys in a Amazon QuickSight account. + +~> Deletion of this resource clears all CMK registrations from a QuickSight account. QuickSight then uses AWS owned keys to encrypt your resources. + +## Example Usage + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { QuicksightKeyRegistration } from "./.gen/providers/aws/quicksight-key-registration"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + new QuicksightKeyRegistration(this, "example", { + keyRegistration: [ + { + keyArn: example1.arn, + }, + { + defaultKey: true, + keyArn: example2.arn, + }, + ], + }); + } +} + +``` + +## Argument Reference + +This resource supports the following arguments: + +* `awsAccountId` - (Optional, Forces new resource) AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider. +* `keyRegistration` - (Required) Registered keys. See [key_registration](#key_registration). +* `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). + +### key_registration + +* `defaultKey` - (Optional) Whether the key is set as the default key for encryption and decryption use. +* `keyArn` - (Required) ARN of the AWS KMS key that is registered for encryption and decryption use. + +## 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 QuickSight key registration using the AWS account ID. For example: + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { QuicksightKeyRegistration } from "./.gen/providers/aws/quicksight-key-registration"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + QuicksightKeyRegistration.generateConfigForImport( + this, + "example", + "012345678901" + ); + } +} + +``` + +Using `terraform import`, import QuickSight key registration using the AWS account ID. For example: + +```console +% terraform import aws_quicksight_key_registration.example "012345678901" +``` + + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/quicksight_namespace.html.markdown b/website/docs/cdktf/typescript/r/quicksight_namespace.html.markdown index 58aad988531c..c46712570be9 100644 --- a/website/docs/cdktf/typescript/r/quicksight_namespace.html.markdown +++ b/website/docs/cdktf/typescript/r/quicksight_namespace.html.markdown @@ -44,8 +44,9 @@ The following arguments are required: The following arguments are optional: -* `awsAccountId` - (Optional) AWS account ID. +* `awsAccountId` - (Optional, Forces new resource) AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider. * `identityStore` - (Optional) User identity directory type. Defaults to `QUICKSIGHT`, the only current valid value. +* `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). * `tags` - (Optional) Key-value map of resource tags. If configured with a provider [`defaultTags` 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. ## Attribute Reference @@ -97,4 +98,4 @@ Using `terraform import`, import QuickSight Namespace using the AWS account ID a % terraform import aws_quicksight_namespace.example 123456789012,example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/quicksight_refresh_schedule.html.markdown b/website/docs/cdktf/typescript/r/quicksight_refresh_schedule.html.markdown index 0c47d49a1ff8..101f64f2b465 100644 --- a/website/docs/cdktf/typescript/r/quicksight_refresh_schedule.html.markdown +++ b/website/docs/cdktf/typescript/r/quicksight_refresh_schedule.html.markdown @@ -137,7 +137,8 @@ The following arguments are required: The following arguments are optional: -* `awsAccountId` - (Optional, Forces new resource) AWS account ID. +* `awsAccountId` - (Optional, Forces new resource) AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider. +* `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). ### schedule @@ -196,4 +197,4 @@ Using `terraform import`, import a QuickSight Refresh Schedule using the AWS acc % terraform import aws_quicksight_refresh_schedule.example 123456789012,dataset-id,schedule-id ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/quicksight_role_custom_permission.html.markdown b/website/docs/cdktf/typescript/r/quicksight_role_custom_permission.html.markdown new file mode 100644 index 000000000000..d729bdd4aef2 --- /dev/null +++ b/website/docs/cdktf/typescript/r/quicksight_role_custom_permission.html.markdown @@ -0,0 +1,89 @@ +--- +subcategory: "QuickSight" +layout: "aws" +page_title: "AWS: aws_quicksight_role_custom_permission" +description: |- + Manages the custom permissions that are associated with a role. +--- + + + +# Resource: aws_quicksight_role_custom_permission + +Manages the custom permissions that are associated with a role. + +## Example Usage + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { Token, TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { QuicksightRoleCustomPermission } from "./.gen/providers/aws/quicksight-role-custom-permission"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + new QuicksightRoleCustomPermission(this, "example", { + customPermissionsName: Token.asString( + awsQuicksightCustomPermissionsExample.customPermissionsName + ), + role: "READER", + }); + } +} + +``` + +## Argument Reference + +The following arguments are required: + +* `customPermissionsName` - (Required, Forces new resource) Custom permissions profile name. +* `role` - (Required, Forces new resource) Role. Valid values are `ADMIN`, `AUTHOR`, `READER`, `ADMIN_PRO`, `AUTHOR_PRO`, and `READER_PRO`. + +The following arguments are optional: + +* `awsAccountId` - (Optional, Forces new resource) AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider. +* `namespace` - (Optional, Forces new resource) Namespace containing the role. Defaults to `default`. +* `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). + +## 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 QuickSight role custom permissions using a comma-delimited string combining the `awsAccountId`, `namespace` and `role`. For example: + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { QuicksightRoleCustomPermission } from "./.gen/providers/aws/quicksight-role-custom-permission"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + QuicksightRoleCustomPermission.generateConfigForImport( + this, + "example", + "012345678901,default,READER" + ); + } +} + +``` + +Using `terraform import`, import QuickSight role custom permissions using a comma-delimited string combining the `awsAccountId`, `namespace`, and `role`. For example: + +```console +% terraform import aws_quicksight_role_custom_permission.example 012345678901,default,READER +``` + + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/quicksight_role_membership.html.markdown b/website/docs/cdktf/typescript/r/quicksight_role_membership.html.markdown index b854f38fd0e0..b64639de339e 100644 --- a/website/docs/cdktf/typescript/r/quicksight_role_membership.html.markdown +++ b/website/docs/cdktf/typescript/r/quicksight_role_membership.html.markdown @@ -47,8 +47,9 @@ The following arguments are required: The following arguments are optional: -* `awsAccountId` - (Optional) AWS account ID. Defaults to the account of the caller identity if not configured. +* `awsAccountId` - (Optional, Forces new resource) AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider. * `namespace` - (Optional) Name of the namespace. Defaults to `default`. +* `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). ## Attribute Reference @@ -86,4 +87,4 @@ Using `terraform import`, import QuickSight Role Membership using a comma-delimi % terraform import aws_quicksight_role_membership.example 012345678901,default,READER,example-group ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/quicksight_template.html.markdown b/website/docs/cdktf/typescript/r/quicksight_template.html.markdown index 31c491920c9e..844b887971b6 100644 --- a/website/docs/cdktf/typescript/r/quicksight_template.html.markdown +++ b/website/docs/cdktf/typescript/r/quicksight_template.html.markdown @@ -140,9 +140,10 @@ The following arguments are required: The following arguments are optional: -* `awsAccountId` - (Optional, Forces new resource) AWS account ID. +* `awsAccountId` - (Optional, Forces new resource) AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider. * `definition` - (Optional) A detailed template definition. Only one of `definition` or `sourceEntity` should be configured. See [definition](#definition). * `permissions` - (Optional) A set of resource permissions on the template. Maximum of 64 items. See [permissions](#permissions). +* `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). * `sourceEntity` - (Optional) The entity that you are using as a source when you create the template (analysis or template). Only one of `definition` or `sourceEntity` should be configured. See [source_entity](#source_entity). * `tags` - (Optional) Key-value map of resource tags. If configured with a provider [`defaultTags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. @@ -233,4 +234,4 @@ Using `terraform import`, import a QuickSight Template using the AWS account ID % terraform import aws_quicksight_template.example 123456789012,example-id ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/quicksight_template_alias.html.markdown b/website/docs/cdktf/typescript/r/quicksight_template_alias.html.markdown index 42e71d59419d..93f9c98525b7 100644 --- a/website/docs/cdktf/typescript/r/quicksight_template_alias.html.markdown +++ b/website/docs/cdktf/typescript/r/quicksight_template_alias.html.markdown @@ -48,7 +48,8 @@ The following arguments are required: The following arguments are optional: -* `awsAccountId` - (Optional, Forces new resource) AWS account ID. +* `awsAccountId` - (Optional, Forces new resource) AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider. +* `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). ## Attribute Reference @@ -89,4 +90,4 @@ Using `terraform import`, import QuickSight Template Alias using the AWS account % terraform import aws_quicksight_template_alias.example 123456789012,example-id,example-alias ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/quicksight_theme.html.markdown b/website/docs/cdktf/typescript/r/quicksight_theme.html.markdown index 40066844b508..4cf6cb64315b 100644 --- a/website/docs/cdktf/typescript/r/quicksight_theme.html.markdown +++ b/website/docs/cdktf/typescript/r/quicksight_theme.html.markdown @@ -60,15 +60,16 @@ class MyConvertedCode extends TerraformStack { The following arguments are required: -* `themeId` - (Required, Forces new resource) Identifier of the theme. * `baseThemeId` - (Required) The ID of the theme that a custom theme will inherit from. All themes inherit from one of the starting themes defined by Amazon QuickSight. For a list of the starting themes, use ListThemes or choose Themes from within an analysis. -* `name` - (Required) Display name of the theme. * `configuration` - (Required) The theme configuration, which contains the theme display properties. See [configuration](#configuration). +* `name` - (Required) Display name of the theme. +* `themeId` - (Required, Forces new resource) Identifier of the theme. The following arguments are optional: -* `awsAccountId` - (Optional, Forces new resource) AWS account ID. +* `awsAccountId` - (Optional, Forces new resource) AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider. * `permissions` - (Optional) A set of resource permissions on the theme. Maximum of 64 items. See [permissions](#permissions). +* `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). * `tags` - (Optional) Key-value map of resource tags. If configured with a provider [`defaultTags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. * `versionDescription` - (Optional) A description of the current theme version being created/updated. @@ -195,4 +196,4 @@ Using `terraform import`, import a QuickSight Theme using the AWS account ID and % terraform import aws_quicksight_theme.example 123456789012,example-id ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/quicksight_user.html.markdown b/website/docs/cdktf/typescript/r/quicksight_user.html.markdown index 332609b7826e..347e44e774e3 100644 --- a/website/docs/cdktf/typescript/r/quicksight_user.html.markdown +++ b/website/docs/cdktf/typescript/r/quicksight_user.html.markdown @@ -96,14 +96,15 @@ class MyConvertedCode extends TerraformStack { The following arguments are required: * `email` - (Required) Email address of the user that you want to register. -* `identityType` - (Required) Identity type that your Amazon QuickSight account uses to manage the identity of users. Valid values: `IAM`, `QUICKSIGHT`. -* `userRole` - (Required) Amazon QuickSight role for the user. Value values: `READER`, `AUTHOR`, `ADMIN`, `READER_PRO`, `AUTHOR_PRO`, `ADMIN_PRO`. +* `identityType` - (Required) Identity type that your Amazon QuickSight account uses to manage the identity of users. Valid values: `IAM`, `QUICKSIGHT`, `IAM_IDENTITY_CENTER`. +* `userRole` - (Required) Amazon QuickSight role for the user. Valid values: `READER`, `AUTHOR`, `ADMIN`, `READER_PRO`, `AUTHOR_PRO`, `ADMIN_PRO`, `RESTRICTED_AUTHOR`, `RESTRICTED_READER`. The following arguments are optional: -* `awsAccountId` - (Optional) ID for the AWS account that the user is in. Use the ID for the AWS account that contains your Amazon QuickSight account. +* `awsAccountId` - (Optional, Forces new resource) AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider. * `iamArn` - (Optional) ARN of the IAM user or role that you are registering with Amazon QuickSight. Required only for users with an identity type of `IAM`. * `namespace` - (Optional) The Amazon Quicksight namespace to create the user in. Defaults to `default`. +* `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). * `sessionName` - (Optional) Name of the IAM session to use when assuming roles that can embed QuickSight dashboards. Only valid for registering users using an assumed IAM role. Additionally, if registering multiple users using the same IAM role, each user needs to have a unique session name. * `userName` - (Optional) Amazon QuickSight user name that you want to create for the user you are registering. Required only for users with an identity type of `QUICKSIGHT`. @@ -119,4 +120,4 @@ This resource exports the following attributes in addition to the arguments abov You cannot import this resource. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/quicksight_user_custom_permission.html.markdown b/website/docs/cdktf/typescript/r/quicksight_user_custom_permission.html.markdown new file mode 100644 index 000000000000..938f502a9957 --- /dev/null +++ b/website/docs/cdktf/typescript/r/quicksight_user_custom_permission.html.markdown @@ -0,0 +1,89 @@ +--- +subcategory: "QuickSight" +layout: "aws" +page_title: "AWS: aws_quicksight_user_custom_permission" +description: |- + Manages the custom permissions profile for a user. +--- + + + +# Resource: aws_quicksight_user_custom_permission + +Manages the custom permissions profile for a user. + +## Example Usage + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { Token, TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { QuicksightUserCustomPermission } from "./.gen/providers/aws/quicksight-user-custom-permission"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + new QuicksightUserCustomPermission(this, "example", { + customPermissionsName: Token.asString( + awsQuicksightCustomPermissionsExample.customPermissionsName + ), + userName: Token.asString(awsQuicksightUserExample.userName), + }); + } +} + +``` + +## Argument Reference + +The following arguments are required: + +* `customPermissionsName` - (Required, Forces new resource) Custom permissions profile name. +* `userName` - (Required, Forces new resource) Username of the user. + +The following arguments are optional: + +* `awsAccountId` - (Optional, Forces new resource) AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider. +* `namespace` - (Optional, Forces new resource) Namespace that the user belongs to. Defaults to `default`. +* `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). + +## 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 QuickSight user custom permissions using a comma-delimited string combining the `awsAccountId`, `namespace` and `userName`. For example: + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { QuicksightUserCustomPermission } from "./.gen/providers/aws/quicksight-user-custom-permission"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + QuicksightUserCustomPermission.generateConfigForImport( + this, + "example", + "012345678901,default,user1" + ); + } +} + +``` + +Using `terraform import`, import QuickSight user custom permissions using a comma-delimited string combining the `awsAccountId`, `namespace`, and `userName`. For example: + +```console +% terraform import aws_quicksight_user_custom_permission.example 012345678901,default,user1 +``` + + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/quicksight_vpc_connection.html.markdown b/website/docs/cdktf/typescript/r/quicksight_vpc_connection.html.markdown index 651c0fe78e1e..7b97708ab26a 100644 --- a/website/docs/cdktf/typescript/r/quicksight_vpc_connection.html.markdown +++ b/website/docs/cdktf/typescript/r/quicksight_vpc_connection.html.markdown @@ -92,8 +92,9 @@ The following arguments are required: The following arguments are optional: -* `awsAccountId` - (Optional) AWS account ID. +* `awsAccountId` - (Optional, Forces new resource) AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider. * `dnsResolvers` - (Optional) A list of IP addresses of DNS resolver endpoints for the VPC connection. +* `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). * `tags` - (Optional) Key-value map of resource tags. If configured with a provider [`defaultTags` 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. ## Attribute Reference @@ -145,4 +146,4 @@ Using `terraform import`, import QuickSight VPC connection using the AWS account % terraform import aws_quicksight_vpc_connection.example 123456789012,example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ram_principal_association.html.markdown b/website/docs/cdktf/typescript/r/ram_principal_association.html.markdown index 790dfeea6bd7..3a4068ce4e15 100644 --- a/website/docs/cdktf/typescript/r/ram_principal_association.html.markdown +++ b/website/docs/cdktf/typescript/r/ram_principal_association.html.markdown @@ -88,6 +88,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `principal` - (Required) The principal to associate with the resource share. Possible values are an AWS account ID, an AWS Organizations Organization ARN, or an AWS Organizations Organization Unit ARN. * `resourceShareArn` - (Required) The Amazon Resource Name (ARN) of the resource share. @@ -129,4 +130,4 @@ Using `terraform import`, import RAM Principal Associations using their Resource % terraform import aws_ram_principal_association.example arn:aws:ram:eu-west-1:123456789012:resource-share/73da1ab9-b94a-4ba3-8eb4-45917f7f4b12,123456789012 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ram_resource_association.html.markdown b/website/docs/cdktf/typescript/r/ram_resource_association.html.markdown index 62afb971763c..d31edcff1b0e 100644 --- a/website/docs/cdktf/typescript/r/ram_resource_association.html.markdown +++ b/website/docs/cdktf/typescript/r/ram_resource_association.html.markdown @@ -41,6 +41,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `resourceArn` - (Required) Amazon Resource Name (ARN) of the resource to associate with the RAM Resource Share. * `resourceShareArn` - (Required) Amazon Resource Name (ARN) of the RAM Resource Share. @@ -82,4 +83,4 @@ Using `terraform import`, import RAM Resource Associations using their Resource % terraform import aws_ram_resource_association.example arn:aws:ram:eu-west-1:123456789012:resource-share/73da1ab9-b94a-4ba3-8eb4-45917f7f4b12,arn:aws:ec2:eu-west-1:123456789012:subnet/subnet-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ram_resource_share.html.markdown b/website/docs/cdktf/typescript/r/ram_resource_share.html.markdown index 3c899e898487..fb7b3be880ef 100644 --- a/website/docs/cdktf/typescript/r/ram_resource_share.html.markdown +++ b/website/docs/cdktf/typescript/r/ram_resource_share.html.markdown @@ -42,6 +42,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) The name of the resource share. * `allowExternalPrincipals` - (Optional) Indicates whether principals outside your organization can be associated with a resource share. * `permissionArns` - (Optional) Specifies the Amazon Resource Names (ARNs) of the RAM permission to associate with the resource share. If you do not specify an ARN for the permission, RAM automatically attaches the default version of the permission for each resource type. You can associate only one permission with each resource type included in the resource share. @@ -87,4 +88,4 @@ Using `terraform import`, import resource shares using the `arn` of the resource % terraform import aws_ram_resource_share.example arn:aws:ram:eu-west-1:123456789012:resource-share/73da1ab9-b94a-4ba3-8eb4-45917f7f4b12 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ram_resource_share_accepter.html.markdown b/website/docs/cdktf/typescript/r/ram_resource_share_accepter.html.markdown index 9b48cd9c19b3..ffc7c1b616d4 100644 --- a/website/docs/cdktf/typescript/r/ram_resource_share_accepter.html.markdown +++ b/website/docs/cdktf/typescript/r/ram_resource_share_accepter.html.markdown @@ -67,6 +67,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `shareArn` - (Required) The ARN of the resource share. ## Attribute Reference @@ -113,4 +114,4 @@ Using `terraform import`, import resource share accepters using the resource sha % terraform import aws_ram_resource_share_accepter.example arn:aws:ram:us-east-1:123456789012:resource-share/c4b56393-e8d9-89d9-6dc9-883752de4767 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/rbin_rule.html.markdown b/website/docs/cdktf/typescript/r/rbin_rule.html.markdown index baf43519c027..a721c9e5433c 100644 --- a/website/docs/cdktf/typescript/r/rbin_rule.html.markdown +++ b/website/docs/cdktf/typescript/r/rbin_rule.html.markdown @@ -29,7 +29,7 @@ class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); new RbinRule(this, "example", { - description: "example_rule", + description: "Example tag-level retention rule", resourceTags: [ { resourceTagKey: "tag_key", @@ -50,35 +50,73 @@ class MyConvertedCode extends TerraformStack { ``` +### Region-Level Retention Rule + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { RbinRule } from "./.gen/providers/aws/rbin-rule"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + new RbinRule(this, "example", { + description: "Example region-level retention rule with exclusion tags", + excludeResourceTags: [ + { + resourceTagKey: "tag_key", + resourceTagValue: "tag_value", + }, + ], + resourceType: "EC2_IMAGE", + retentionPeriod: { + retentionPeriodUnit: "DAYS", + retentionPeriodValue: 10, + }, + tags: { + test_tag_key: "test_tag_value", + }, + }); + } +} + +``` + ## Argument Reference The following arguments are required: -* `resourceType` - (Required) The resource type to be retained by the retention rule. Valid values are `EBS_SNAPSHOT` and `EC2_IMAGE`. +* `resourceType` - (Required) Resource type to be retained by the retention rule. Valid values are `EBS_SNAPSHOT` and `EC2_IMAGE`. * `retentionPeriod` - (Required) Information about the retention period for which the retention rule is to retain resources. See [`retentionPeriod`](#retention_period) below. The following arguments are optional: -* `description` - (Optional) The retention rule description. -* `resourceTags` - (Optional) Specifies the resource tags to use to identify resources that are to be retained by a tag-level retention rule. See [`resourceTags`](#resource_tags) below. +* `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). +* `description` - (Optional) Retention rule description. +* `excludeResourceTags` - (Optional) Exclusion tags to use to identify resources that are to be excluded, or ignored, by a Region-level retention rule. See [`excludeResourceTags`](#exclude_resource_tags) below. * `lockConfiguration` - (Optional) Information about the retention rule lock configuration. See [`lockConfiguration`](#lock_configuration) below. +* `resourceTags` - (Optional) Resource tags to use to identify resources that are to be retained by a tag-level retention rule. See [`resourceTags`](#resource_tags) below. ### retention_period The following arguments are required: -* `retentionPeriodUnit` - (Required) The unit of time in which the retention period is measured. Currently, only DAYS is supported. -* `retentionPeriodValue` - (Required) The period value for which the retention rule is to retain resources. The period is measured using the unit specified for RetentionPeriodUnit. +* `retentionPeriodUnit` - (Required) Unit of time in which the retention period is measured. Currently, only DAYS is supported. +* `retentionPeriodValue` - (Required) Period value for which the retention rule is to retain resources. The period is measured using the unit specified for RetentionPeriodUnit. -### resource_tags +### exclude_resource_tags The following argument is required: -* `resourceTagKey` - (Required) The tag key. +* `resourceTagKey` - (Required) Tag key. The following argument is optional: -* `resourceTagValue` - (Optional) The tag value. +* `resourceTagValue` - (Optional) Tag value. ### lock_configuration @@ -90,17 +128,27 @@ The following argument is required: The following arguments are required: -* `unlockDelayUnit` - (Required) The unit of time in which to measure the unlock delay. Currently, the unlock delay can be measure only in days. -* `unlockDelayValue` - (Required) The unlock delay period, measured in the unit specified for UnlockDelayUnit. +* `unlockDelayUnit` - (Required) Unit of time in which to measure the unlock delay. Currently, the unlock delay can be measure only in days. +* `unlockDelayValue` - (Required) Unlock delay period, measured in the unit specified for UnlockDelayUnit. + +### resource_tags + +The following argument is required: + +* `resourceTagKey` - (Required) Tag key. + +The following argument is optional: + +* `resourceTagValue` - (Optional) Tag value. ## Attribute Reference This resource exports the following attributes in addition to the arguments above: * `id` - (String) ID of the Rule. -* `lockEndTime` - (Timestamp) The date and time at which the unlock delay is set to expire. Only returned for retention rules that have been unlocked and that are still within the unlock delay period. -* `lockState` - (Optional) The lock state of the retention rules to list. Only retention rules with the specified lock state are returned. Valid values are `locked`, `pending_unlock`, `unlocked`. -* `status` - (String) The state of the retention rule. Only retention rules that are in the `available` state retain resources. Valid values include `pending` and `available`. +* `lockEndTime` - (Timestamp) Date and time at which the unlock delay is set to expire. Only returned for retention rules that have been unlocked and that are still within the unlock delay period. +* `lockState` - (Optional) Lock state of the retention rules to list. Only retention rules with the specified lock state are returned. Valid values are `locked`, `pending_unlock`, `unlocked`. +* `status` - (String) State of the retention rule. Only retention rules that are in the `available` state retain resources. Valid values include `pending` and `available`. ## Import @@ -130,4 +178,4 @@ Using `terraform import`, import RBin Rule using the `id`. For example: % terraform import aws_rbin_rule.example examplerule ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/rds_certificate.html.markdown b/website/docs/cdktf/typescript/r/rds_certificate.html.markdown index 4994af788d98..79f149732332 100644 --- a/website/docs/cdktf/typescript/r/rds_certificate.html.markdown +++ b/website/docs/cdktf/typescript/r/rds_certificate.html.markdown @@ -38,8 +38,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `certificateIdentifier` - (Required) Certificate identifier. For example, `rds-ca-rsa4096-g1`. Refer to [AWS RDS (Relational Database) Certificate Identifier](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html#UsingWithRDS.SSL.CertificateIdentifier) for more information. ## Attribute Reference @@ -74,4 +75,4 @@ Using `terraform import`, import the RDS certificate override using the `region` % terraform import aws_rds_certificate.example us-west-2 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/rds_cluster.html.markdown b/website/docs/cdktf/typescript/r/rds_cluster.html.markdown index 8caea45b2056..8e95c580b63f 100644 --- a/website/docs/cdktf/typescript/r/rds_cluster.html.markdown +++ b/website/docs/cdktf/typescript/r/rds_cluster.html.markdown @@ -27,7 +27,7 @@ Changes to an RDS Cluster can occur when you manually change a parameter, such a ~> **NOTE on RDS Clusters and RDS Cluster Role Associations:** Terraform provides both a standalone [RDS Cluster Role Association](rds_cluster_role_association.html) - (an association between an RDS Cluster and a single IAM Role) and an RDS Cluster resource with `iamRoles` attributes. Use one resource or the other to associate IAM Roles and RDS Clusters. Not doing so will cause a conflict of associations and will result in the association being overwritten. --> **Note:** Write-Only argument `masterPasswordWo` is available to use in place of `masterPassword`. Write-Only arguments are supported in HashiCorp Terraform 1.11.0 and later. [Learn more](https://developer.hashicorp.com/terraform/language/v1.11.x/resources/ephemeral#write-only-arguments). +-> **Note:** Write-Only argument `masterPasswordWo` is available to use in place of `masterPassword`. Write-Only arguments are supported in HashiCorp Terraform 1.11.0 and later. [Learn more](https://developer.hashicorp.com/terraform/language/resources/ephemeral#write-only-arguments). ## Example Usage @@ -328,6 +328,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `allocatedStorage` - (Optional, Required for Multi-AZ DB cluster) The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster. * `allowMajorVersionUpgrade` - (Optional) Enable to allow major engine version upgrades when changing engine versions. Defaults to `false`. * `applyImmediately` - (Optional) Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is `false`. See [Amazon RDS Documentation for more information.](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.DBInstance.Modifying.html) @@ -341,7 +342,7 @@ This resource supports the following arguments: * `clusterIdentifier` - (Optional, Forces new resources) The cluster identifier. If omitted, Terraform will assign a random, unique identifier. * `clusterIdentifierPrefix` - (Optional, Forces new resource) Creates a unique cluster identifier beginning with the specified prefix. Conflicts with `clusterIdentifier`. * `clusterScalabilityType` - (Optional, Forces new resources) Specifies the scalability mode of the Aurora DB cluster. When set to `limitless`, the cluster operates as an Aurora Limitless Database. When set to `standard` (the default), the cluster uses normal DB instance creation. Valid values: `limitless`, `standard`. -* `copyTagsToSnapshot` – (Optional, boolean) Copy all Cluster `tags` to snapshots. Default is `false`. +* `copyTagsToSnapshot` - (Optional, boolean) Copy all Cluster `tags` to snapshots. Default is `false`. * `databaseInsightsMode` - (Optional) The mode of Database Insights to enable for the DB cluster. Valid values: `standard`, `advanced`. * `databaseName` - (Optional) Name for an automatically created database on cluster creation. There are different naming restrictions per database engine: [RDS Naming Constraints][5] * `dbClusterInstanceClass` - (Optional, Required for Multi-AZ DB cluster) The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example `db.m6g.xlarge`. Not all DB instance classes are available in all AWS Regions, or for all database engines. For the full list of DB instance classes and availability for your engine, see [DB instance class](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) in the Amazon RDS User Guide. @@ -359,7 +360,7 @@ This resource supports the following arguments: * `enableGlobalWriteForwarding` - (Optional) Whether cluster should forward writes to an associated global cluster. Applied to secondary clusters to enable them to forward writes to an [`aws_rds_global_cluster`](/docs/providers/aws/r/rds_global_cluster.html)'s primary cluster. See the [User Guide for Aurora](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database-write-forwarding.html) for more information. * `enableHttpEndpoint` - (Optional) Enable HTTP endpoint (data API). Only valid for some combinations of `engineMode`, `engine` and `engineVersion` and only available in some regions. See the [Region and version availability](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html#data-api.regions) section of the documentation. This option also does not work with any of these options specified: `snapshotIdentifier`, `replicationSourceIdentifier`, `s3Import`. * `enableLocalWriteForwarding` - (Optional) Whether read replicas can forward write operations to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.. See the [User Guide for Aurora](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-mysql-write-forwarding.html) for more information. **NOTE:** Local write forwarding requires Aurora MySQL version 3.04 or higher. -* `enabledCloudwatchLogsExports` - (Optional) Set of log types to export to cloudwatch. If omitted, no logs will be exported. The following log types are supported: `audit`, `error`, `general`, `slowquery`, `iam-db-auth-error`, `postgresql` (PostgreSQL). +* `enabledCloudwatchLogsExports` - (Optional) Set of log types to export to cloudwatch. If omitted, no logs will be exported. The following log types are supported: `audit`, `error`, `general`, `iam-db-auth-error`, `instance`, `postgresql` (PostgreSQL), `slowquery`. * `engineMode` - (Optional) Database engine mode. Valid values: `global` (only valid for Aurora MySQL 1.21 and earlier), `parallelquery`, `provisioned`, `serverless`. Defaults to: `provisioned`. Specify an empty value (`""`) for no engine mode. See the [RDS User Guide](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html) for limitations when using `serverless`. * `engineLifecycleSupport` - (Optional) The life cycle type for this DB instance. This setting is valid for cluster types Aurora DB clusters and Multi-AZ DB clusters. Valid values are `open-source-rds-extended-support`, `open-source-rds-extended-support-disabled`. Default value is `open-source-rds-extended-support`. [Using Amazon RDS Extended Support]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/extended-support.html * `engineVersion` - (Optional) Database engine version. Updating this argument results in an outage. See the [Aurora MySQL](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Updates.html) and [Aurora Postgres](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraPostgreSQL.Updates.html) documentation for your configured engine to determine this value, or by running `aws rds describe-db-engine-versions`. For example with Aurora MySQL 2, a potential value for this argument is `5.7.mysql_aurora.2.03.2`. The value can contain a partial version where supported by the API. The actual engine version used is returned in the attribute `engineVersionActual`, , see [Attribute Reference](#attribute-reference) below. @@ -579,7 +580,7 @@ This resource exports the following attributes in addition to the arguments abov * `id` - RDS Cluster Identifier * `clusterIdentifier` - RDS Cluster Identifier * `clusterResourceId` - RDS Cluster Resource ID -* `clusterMembers` – List of RDS Instances that are a part of this cluster +* `clusterMembers` - List of RDS Instances that are a part of this cluster * `availabilityZones` - Availability zone of the instance * `backupRetentionPeriod` - Backup retention period * `caCertificateIdentifier` - CA identifier of the CA certificate used for the DB instance's server certificate @@ -658,4 +659,4 @@ Using `terraform import`, import RDS Clusters using the `clusterIdentifier`. For % terraform import aws_rds_cluster.aurora_cluster aurora-prod-cluster ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/rds_cluster_activity_stream.html.markdown b/website/docs/cdktf/typescript/r/rds_cluster_activity_stream.html.markdown index b2f35bfa5708..f1d528823f0b 100644 --- a/website/docs/cdktf/typescript/r/rds_cluster_activity_stream.html.markdown +++ b/website/docs/cdktf/typescript/r/rds_cluster_activity_stream.html.markdown @@ -86,6 +86,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `resourceArn` - (Required, Forces new resources) The Amazon Resource Name (ARN) of the DB cluster. * `mode` - (Required, Forces new resources) Specifies the mode of the database activity stream. Database events such as a change or access generate an activity stream event. The database session can handle these events either synchronously or asynchronously. One of: `sync`, `async`. * `kmsKeyId` - (Required, Forces new resources) The AWS KMS key identifier for encrypting messages in the database activity stream. The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. @@ -137,4 +138,4 @@ Using `terraform import`, import RDS Aurora Cluster Database Activity Streams us [2]: https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_StartActivityStream.html [3]: https://docs.aws.amazon.com/cli/latest/reference/rds/start-activity-stream.html - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/rds_cluster_endpoint.html.markdown b/website/docs/cdktf/typescript/r/rds_cluster_endpoint.html.markdown index 02024174010b..676a17add15a 100644 --- a/website/docs/cdktf/typescript/r/rds_cluster_endpoint.html.markdown +++ b/website/docs/cdktf/typescript/r/rds_cluster_endpoint.html.markdown @@ -87,6 +87,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `clusterIdentifier` - (Required, Forces new resources) The cluster identifier. * `clusterEndpointIdentifier` - (Required, Forces new resources) The identifier to use for the new endpoint. This parameter is stored as a lowercase string. * `customEndpointType` - (Required) The type of the endpoint. One of: READER , ANY . @@ -140,4 +141,4 @@ Using `terraform import`, import RDS Clusters Endpoint using the `clusterEndpoin [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Overview.Endpoints.html#Aurora.Endpoints.Cluster - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/rds_cluster_instance.html.markdown b/website/docs/cdktf/typescript/r/rds_cluster_instance.html.markdown index 4f2fec687240..a70425888f8e 100644 --- a/website/docs/cdktf/typescript/r/rds_cluster_instance.html.markdown +++ b/website/docs/cdktf/typescript/r/rds_cluster_instance.html.markdown @@ -75,12 +75,13 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `applyImmediately` - (Optional) Specifies whether any database modifications are applied immediately, or during the next maintenance window. Default is`false`. * `autoMinorVersionUpgrade` - (Optional) Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window. Default `true`. * `availabilityZone` - (Optional, Computed, Forces new resource) EC2 Availability Zone that the DB instance is created in. See [docs](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html) about the details. * `caCertIdentifier` - (Optional) Identifier of the CA certificate for the DB instance. * `clusterIdentifier` - (Required, Forces new resource) Identifier of the [`aws_rds_cluster`](/docs/providers/aws/r/rds_cluster.html) in which to launch this instance. -* `copyTagsToSnapshot` – (Optional, boolean) Indicates whether to copy all of the user-defined tags from the DB instance to snapshots of the DB instance. Default `false`. +* `copyTagsToSnapshot` - (Optional, boolean) Indicates whether to copy all of the user-defined tags from the DB instance to snapshots of the DB instance. Default `false`. * `customIamInstanceProfile` - (Optional) Instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. * `dbParameterGroupName` - (Optional) Name of the DB parameter group to associate with this instance. * `dbSubnetGroupName` - (Optional, Forces new resource) Specifies the DB subnet group to associate with this DB instance. The default behavior varies depending on whether `dbSubnetGroupName` is specified. Please refer to official [AWS documentation](https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-instance.html) to understand how `dbSubnetGroupName` and `publiclyAccessible` parameters affect DB instance behaviour. **NOTE:** This must match the `dbSubnetGroupName` of the attached [`aws_rds_cluster`](/docs/providers/aws/r/rds_cluster.html). @@ -113,7 +114,7 @@ This resource exports the following attributes in addition to the arguments abov * `clusterIdentifier` - RDS Cluster Identifier * `identifier` - Instance identifier * `id` - Instance identifier -* `writer` – Boolean indicating if this instance is writable. `False` indicates this instance is a read replica. +* `writer` - Boolean indicating if this instance is writable. `False` indicates this instance is a read replica. * `availabilityZone` - Availability zone of the instance * `endpoint` - DNS address for this instance. May not be writable * `engine` - Database engine @@ -174,4 +175,4 @@ Using `terraform import`, import RDS Cluster Instances using the `identifier`. F % terraform import aws_rds_cluster_instance.prod_instance_1 aurora-cluster-instance-1 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/rds_cluster_parameter_group.html.markdown b/website/docs/cdktf/typescript/r/rds_cluster_parameter_group.html.markdown index 39b8958c8873..5d01b9ff240c 100644 --- a/website/docs/cdktf/typescript/r/rds_cluster_parameter_group.html.markdown +++ b/website/docs/cdktf/typescript/r/rds_cluster_parameter_group.html.markdown @@ -53,6 +53,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Optional, Forces new resource) The name of the DB cluster parameter group. If omitted, Terraform will assign a random, unique name. * `namePrefix` - (Optional, Forces new resource) Creates a unique name beginning with the specified prefix. Conflicts with `name`. * `family` - (Required) The family of the DB cluster parameter group. @@ -108,4 +109,4 @@ Using `terraform import`, import RDS Cluster Parameter Groups using the `name`. % terraform import aws_rds_cluster_parameter_group.cluster_pg production-pg-1 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/rds_cluster_role_association.html.markdown b/website/docs/cdktf/typescript/r/rds_cluster_role_association.html.markdown index 4bc2aeaacb20..1291d813cd30 100644 --- a/website/docs/cdktf/typescript/r/rds_cluster_role_association.html.markdown +++ b/website/docs/cdktf/typescript/r/rds_cluster_role_association.html.markdown @@ -43,6 +43,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `dbClusterIdentifier` - (Required) DB Cluster Identifier to associate with the IAM Role. * `featureName` - (Required) Name of the feature for association. This can be found in the AWS documentation relevant to the integration or a full list is available in the `SupportedFeatureNames` list returned by [AWS CLI rds describe-db-engine-versions](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-engine-versions.html). * `roleArn` - (Required) Amazon Resource Name (ARN) of the IAM Role to associate with the DB Cluster. @@ -92,4 +93,4 @@ Using `terraform import`, import `aws_rds_cluster_role_association` using the DB % terraform import aws_rds_cluster_role_association.example my-db-cluster,arn:aws:iam::123456789012:role/my-role ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/rds_cluster_snapshot_copy.html.markdown b/website/docs/cdktf/typescript/r/rds_cluster_snapshot_copy.html.markdown index 4720b03dca07..ac16a44a6be0 100644 --- a/website/docs/cdktf/typescript/r/rds_cluster_snapshot_copy.html.markdown +++ b/website/docs/cdktf/typescript/r/rds_cluster_snapshot_copy.html.markdown @@ -17,14 +17,14 @@ Manages an RDS database cluster snapshot copy. For managing RDS database instanc ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug import { Construct } from "constructs"; -import { TerraformStack } from "cdktf"; +import { Token, TerraformStack } from "cdktf"; /* * Provider bindings are generated by running `cdktf get`. * See https://cdk.tf/provider-generation for more details. */ -import { RdsClusterSnapshotCopy } from "./.gen/providers/aws/"; import { DbClusterSnapshot } from "./.gen/providers/aws/db-cluster-snapshot"; import { RdsCluster } from "./.gen/providers/aws/rds-cluster"; +import { RdsClusterSnapshotCopy } from "./.gen/providers/aws/rds-cluster-snapshot-copy"; class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); @@ -50,9 +50,10 @@ class MyConvertedCode extends TerraformStack { this, "example_2", { - source_db_cluster_snapshot_identifier: - awsDbClusterSnapshotExample.dbClusterSnapshotArn, - target_db_cluster_snapshot_identifier: "example-copy", + sourceDbClusterSnapshotIdentifier: Token.asString( + awsDbClusterSnapshotExample.dbClusterSnapshotArn + ), + targetDbClusterSnapshotIdentifier: "example-copy", } ); /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ @@ -66,11 +67,12 @@ class MyConvertedCode extends TerraformStack { The following arguments are required: -* `source_db_cluster_snapshot_identifier` - (Required) Identifier of the source snapshot. -* `target_db_cluster_snapshot_identifier` - (Required) Identifier for the snapshot. +* `sourceDbClusterSnapshotIdentifier` - (Required) Identifier of the source snapshot. +* `targetDbClusterSnapshotIdentifier` - (Required) Identifier for the snapshot. The following arguments are optional: +* `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). * `copyTags` - (Optional) Whether to copy existing tags. Defaults to `false`. * `destinationRegion` - (Optional) The Destination region to place snapshot copy. * `kmsKeyId` - (Optional) KMS key ID. @@ -91,7 +93,7 @@ This resource exports the following attributes in addition to the arguments abov * `kmsKeyId` - ARN for the KMS encryption key. * `licenseModel` - License model information for the restored DB instance. * `sharedAccounts` - (Optional) List of AWS Account IDs to share the snapshot with. Use `all` to make the snapshot public. -* `source_db_cluster_snapshot_identifier` - DB snapshot ARN that the DB cluster snapshot was copied from. It only has value in case of cross customer or cross region copy. +* `sourceDbClusterSnapshotIdentifier` - DB snapshot ARN that the DB cluster snapshot was copied from. It only has value in case of cross customer or cross region copy. * `storageEncrypted` - Specifies whether the DB cluster snapshot is encrypted. * `storageType` - Specifies the storage type associated with DB cluster snapshot. * `tagsAll` - A map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). @@ -115,7 +117,7 @@ import { TerraformStack } from "cdktf"; * Provider bindings are generated by running `cdktf get`. * See https://cdk.tf/provider-generation for more details. */ -import { RdsClusterSnapshotCopy } from "./.gen/providers/aws/"; +import { RdsClusterSnapshotCopy } from "./.gen/providers/aws/rds-cluster-snapshot-copy"; class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); @@ -135,4 +137,4 @@ Using `terraform import`, import `aws_rds_cluster_snapshot_copy` using the `id`. % terraform import aws_rds_cluster_snapshot_copy.example my-snapshot ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/rds_custom_db_engine_version.markdown b/website/docs/cdktf/typescript/r/rds_custom_db_engine_version.markdown index f40926006028..8e0282cbad82 100644 --- a/website/docs/cdktf/typescript/r/rds_custom_db_engine_version.markdown +++ b/website/docs/cdktf/typescript/r/rds_custom_db_engine_version.markdown @@ -157,6 +157,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `databaseInstallationFilesS3BucketName` - (Required) The name of the Amazon S3 bucket that contains the database installation files. * `databaseInstallationFilesS3Prefix` - (Required) The prefix for the Amazon S3 bucket that contains the database installation files. * `description` - (Optional) The description of the CEV. @@ -222,4 +223,4 @@ Using `terraform import`, import custom engine versions for Amazon RDS custom us % terraform import aws_rds_custom_db_engine_version.example custom-oracle-ee-cdb:19.cdb_cev1 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/rds_export_task.html.markdown b/website/docs/cdktf/typescript/r/rds_export_task.html.markdown index b436c4fe2dce..8ac310cb7037 100644 --- a/website/docs/cdktf/typescript/r/rds_export_task.html.markdown +++ b/website/docs/cdktf/typescript/r/rds_export_task.html.markdown @@ -184,6 +184,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `exportOnly` - (Optional) Data to be exported from the snapshot. If this parameter is not provided, all the snapshot data is exported. Valid values are documented in the [AWS StartExportTask API documentation](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_StartExportTask.html#API_StartExportTask_RequestParameters). * `s3Prefix` - (Optional) Amazon S3 bucket prefix to use as the file name and path of the exported snapshot. @@ -229,4 +230,4 @@ Using `terraform import`, import a RDS (Relational Database) Export Task using t % terraform import aws_rds_export_task.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/rds_global_cluster.html.markdown b/website/docs/cdktf/typescript/r/rds_global_cluster.html.markdown index c89d9167b87b..f134a686643e 100644 --- a/website/docs/cdktf/typescript/r/rds_global_cluster.html.markdown +++ b/website/docs/cdktf/typescript/r/rds_global_cluster.html.markdown @@ -283,6 +283,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `globalClusterIdentifier` - (Required, Forces new resources) Global cluster identifier. * `databaseName` - (Optional, Forces new resources) Name for an automatically created database on cluster creation. Terraform will only perform drift detection if a configuration value is provided. * `deletionProtection` - (Optional) If the Global Cluster should have deletion protection enabled. The database can't be deleted when this value is set to `true`. The default is `false`. @@ -373,4 +374,4 @@ class MyConvertedCode extends TerraformStack { ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/rds_instance_state.html.markdown b/website/docs/cdktf/typescript/r/rds_instance_state.html.markdown index cc68f4f2b475..2bd7f59cc907 100644 --- a/website/docs/cdktf/typescript/r/rds_instance_state.html.markdown +++ b/website/docs/cdktf/typescript/r/rds_instance_state.html.markdown @@ -41,16 +41,15 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `identifier` - (Required) DB Instance Identifier * `state` - (Required) Configured state of the DB Instance. Valid values are `available` and `stopped`. ## Attribute Reference -This resource exports the following attributes in addition to the arguments above: - -* `identifier` - DB Instance Identifier +This resource exports no additional attributes. ## Timeouts @@ -61,7 +60,7 @@ This resource exports the following attributes in addition to the arguments abov ## Import -In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import RDS (Relational Database) RDS Instance State using the `example_id_arg`. For example: +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import RDS (Relational Database) RDS Instance State using the `identifier`. For example: ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -85,10 +84,10 @@ class MyConvertedCode extends TerraformStack { ``` -Using `terraform import`, import RDS (Relational Database) RDS Instance State using the `example_id_arg`. For example: +Using `terraform import`, import RDS (Relational Database) RDS Instance State using the `identifier`. For example: ```console % terraform import aws_rds_instance_state.example rds_instance_state-id-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/rds_integration.html.markdown b/website/docs/cdktf/typescript/r/rds_integration.html.markdown index aeb8b172dac3..62a1361bc811 100644 --- a/website/docs/cdktf/typescript/r/rds_integration.html.markdown +++ b/website/docs/cdktf/typescript/r/rds_integration.html.markdown @@ -136,6 +136,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `additionalEncryptionContext` - (Optional, Forces new resources) Set of non-secret key–value pairs that contains additional contextual information about the data. For more information, see the [User Guide](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context). You can only include this parameter if you specify the `kmsKeyId` parameter. @@ -156,7 +157,7 @@ For more detailed documentation about each argument, refer to the [AWS official This resource exports the following attributes in addition to the arguments above: * `arn` - ARN of the Integration. -* `id` - ID of the Integration. +* `id` - (**Deprecated**, use `arn` instead) ARN of the Integration. * `tagsAll` - A map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). ## Timeouts @@ -199,4 +200,4 @@ Using `terraform import`, import RDS (Relational Database) Integration using the % terraform import aws_rds_integration.example arn:aws:rds:us-west-2:123456789012:integration:abcdefgh-0000-1111-2222-123456789012 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/rds_reserved_instance.html.markdown b/website/docs/cdktf/typescript/r/rds_reserved_instance.html.markdown index 70be4344ac62..77d777d6d9d7 100644 --- a/website/docs/cdktf/typescript/r/rds_reserved_instance.html.markdown +++ b/website/docs/cdktf/typescript/r/rds_reserved_instance.html.markdown @@ -56,6 +56,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `instanceCount` - (Optional) Number of instances to reserve. Default value is `1`. * `reservationId` - (Optional) Customer-specified identifier to track this reservation. * `tags` - (Optional) Map of tags to assign to the DB reservation. If configured with a provider [`defaultTags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. @@ -68,7 +69,7 @@ This resource exports the following attributes in addition to the arguments abov * `id` - Unique identifier for the reservation. same as `reservationId`. * `currencyCode` - Currency code for the reserved DB instance. * `duration` - Duration of the reservation in seconds. -* `fixedPrice` – Fixed price charged for this reserved DB instance. +* `fixedPrice` - Fixed price charged for this reserved DB instance. * `dbInstanceClass` - DB instance class for the reserved DB instance. * `leaseId` - Unique identifier for the lease associated with the reserved DB instance. Amazon Web Services Support might request the lease ID for an issue related to a reserved DB instance. * `multiAz` - Whether the reservation applies to Multi-AZ deployments. @@ -120,4 +121,4 @@ Using `terraform import`, import RDS DB Instance Reservations using the `instanc % terraform import aws_rds_reserved_instance.reservation_instance CustomReservationID ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/rds_shard_group.html.markdown b/website/docs/cdktf/typescript/r/rds_shard_group.html.markdown index a6f8b085b0b1..50c702764041 100644 --- a/website/docs/cdktf/typescript/r/rds_shard_group.html.markdown +++ b/website/docs/cdktf/typescript/r/rds_shard_group.html.markdown @@ -60,6 +60,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `computeRedundancy` - (Optional) Specifies whether to create standby DB shard groups for the DB shard group. Valid values are: * `0` - Creates a DB shard group without a standby DB shard group. This is the default value. * `1` - Creates a DB shard group with a standby DB shard group in a different Availability Zone (AZ). @@ -122,4 +123,4 @@ Using `terraform import`, import shard group using the `dbShardGroupIdentifier`. % terraform import aws_rds_shard_group.example example-shard-group ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/redshift_authentication_profile.html.markdown b/website/docs/cdktf/typescript/r/redshift_authentication_profile.html.markdown index 3d9764292a18..0fd4168a6688 100644 --- a/website/docs/cdktf/typescript/r/redshift_authentication_profile.html.markdown +++ b/website/docs/cdktf/typescript/r/redshift_authentication_profile.html.markdown @@ -45,6 +45,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `authenticationProfileName` - (Required, Forces new resource) The name of the authentication profile. * `authenticationProfileContent` - (Required) The content of the authentication profile in JSON format. The maximum length of the JSON string is determined by a quota for your account. @@ -86,4 +87,4 @@ Using `terraform import`, import Redshift Authentication by `authenticationProfi % terraform import aws_redshift_authentication_profile.test example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/redshift_cluster.html.markdown b/website/docs/cdktf/typescript/r/redshift_cluster.html.markdown index ebea869c8010..e350df7eca22 100644 --- a/website/docs/cdktf/typescript/r/redshift_cluster.html.markdown +++ b/website/docs/cdktf/typescript/r/redshift_cluster.html.markdown @@ -17,7 +17,7 @@ Provides a Redshift Cluster Resource. ~> **NOTE:** A Redshift cluster's default IAM role can be managed both by this resource's `defaultIamRoleArn` argument and the [`aws_redshift_cluster_iam_roles`](redshift_cluster_iam_roles.html) resource's `defaultIamRoleArn` argument. Do not configure different values for both arguments. Doing so will cause a conflict of default IAM roles. --> **Note:** Write-Only argument `masterPasswordWo` is available to use in place of `masterPassword`. Write-Only arguments are supported in HashiCorp Terraform 1.11.0 and later. [Learn more](https://developer.hashicorp.com/terraform/language/v1.11.x/resources/ephemeral#write-only-arguments). +-> **Note:** Write-Only argument `masterPasswordWo` is available to use in place of `masterPassword`. Write-Only arguments are supported in HashiCorp Terraform 1.11.0 and later. [Learn more](https://developer.hashicorp.com/terraform/language/resources/ephemeral#write-only-arguments). ## Example Usage @@ -79,6 +79,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `clusterIdentifier` - (Required) The Cluster Identifier. Must be a lower case string. * `databaseName` - (Optional) The name of the first database to be created when the cluster is created. If you do not provide a name, Amazon Redshift will create a default database called `dev`. @@ -122,8 +123,9 @@ This resource supports the following arguments: No longer supported by the AWS API. Always returns `auto`. * `numberOfNodes` - (Optional) The number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as multi-node. Default is 1. -* `publiclyAccessible` - (Optional) If true, the cluster can be accessed from a public network. Default is `true`. +* `publiclyAccessible` - (Optional) If true, the cluster can be accessed from a public network. Default is `false`. * `encrypted` - (Optional) If true , the data in the cluster is encrypted at rest. + Default is `true`. * `enhancedVpcRouting` - (Optional) If true , enhanced VPC routing is enabled. * `kmsKeyId` - (Optional) The ARN for the KMS encryption key. When specifying `kmsKeyId`, `encrypted` needs to be set to true. * `elasticIp` - (Optional) The Elastic IP (EIP) address for the cluster. @@ -134,36 +136,13 @@ This resource supports the following arguments: * `snapshotClusterIdentifier` - (Optional) The name of the cluster the source snapshot was created from. * `ownerAccount` - (Optional) The AWS customer account used to create or copy the snapshot. Required if you are restoring a snapshot you do not own, optional if you own the snapshot. * `iamRoles` - (Optional) A list of IAM Role ARNs to associate with the cluster. A Maximum of 10 can be associated to the cluster at any time. -* `logging` - (Optional, **Deprecated**) Logging, documented below. * `maintenanceTrackName` - (Optional) The name of the maintenance track for the restored cluster. When you take a snapshot, the snapshot inherits the MaintenanceTrack value from the cluster. The snapshot might be on a different track than the cluster that was the source for the snapshot. For example, suppose that you take a snapshot of a cluster that is on the current track and then change the cluster to be on the trailing track. In this case, the snapshot and the source cluster are on different tracks. Default value is `current`. * `manualSnapshotRetentionPeriod` - (Optional) The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots. Valid values are between `-1` and `3653`. Default value is `-1`. -* `snapshotCopy` - (Optional, **Deprecated**) Configuration of automatic copy of snapshots from one region to another. Documented below. * `tags` - (Optional) A map of tags to assign to the resource. If configured with a provider [`defaultTags` 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. For more detailed documentation about each argument, refer to the [AWS official documentation](http://docs.aws.amazon.com/cli/latest/reference/redshift/index.html#cli-aws-redshift). -### Nested Blocks - -#### `logging` - -~> The `logging` argument is deprecated. Use the [`aws_redshift_logging`](./redshift_logging.html.markdown) resource instead. This argument will be removed in a future major version. - -* `enable` - (Required) Enables logging information such as queries and connection attempts, for the specified Amazon Redshift cluster. -* `bucketName` - (Optional, required when `enable` is `true` and `logDestinationType` is `s3`) The name of an existing S3 bucket where the log files are to be stored. Must be in the same region as the cluster and the cluster must have read bucket and put object permissions. -For more information on the permissions required for the bucket, please read the AWS [documentation](http://docs.aws.amazon.com/redshift/latest/mgmt/db-auditing.html#db-auditing-enable-logging) -* `s3KeyPrefix` - (Optional) The prefix applied to the log file names. -* `logDestinationType` - (Optional) The log destination type. An enum with possible values of `s3` and `cloudwatch`. -* `logExports` - (Optional) The collection of exported log types. Log types include the connection log, user log and user activity log. Required when `logDestinationType` is `cloudwatch`. Valid log types are `connectionlog`, `userlog`, and `useractivitylog`. - -#### `snapshotCopy` - -~> The `snapshotCopy` argument is deprecated. Use the [`aws_redshift_snapshot_copy`](./redshift_snapshot_copy.html.markdown) resource instead. This argument will be removed in a future major version. - -* `destinationRegion` - (Required) The destination region that you want to copy snapshots to. -* `retentionPeriod` - (Optional) The number of days to retain automated snapshots in the destination region after they are copied from the source region. Defaults to `7`. -* `grantName` - (Optional) The name of the snapshot copy grant to use when snapshots of an AWS KMS-encrypted cluster are copied to the destination region. - ## Attribute Reference This resource exports the following attributes in addition to the arguments above: @@ -238,4 +217,4 @@ Using `terraform import`, import Redshift Clusters using the `clusterIdentifier` % terraform import aws_redshift_cluster.myprodcluster tf-redshift-cluster-12345 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/redshift_cluster_iam_roles.html.markdown b/website/docs/cdktf/typescript/r/redshift_cluster_iam_roles.html.markdown index 5d3d7cf17f23..5867f2dcde23 100644 --- a/website/docs/cdktf/typescript/r/redshift_cluster_iam_roles.html.markdown +++ b/website/docs/cdktf/typescript/r/redshift_cluster_iam_roles.html.markdown @@ -43,6 +43,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `clusterIdentifier` - (Required) The name of the Redshift Cluster IAM Roles. * `iamRoleArns` - (Optional) A list of IAM Role ARNs to associate with the cluster. A Maximum of 10 can be associated to the cluster at any time. * `defaultIamRoleArn` - (Optional) The Amazon Resource Name (ARN) for the IAM role that was set as default for the cluster when the cluster was created. @@ -85,4 +86,4 @@ Using `terraform import`, import Redshift Cluster IAM Roless using the `clusterI % terraform import aws_redshift_cluster_iam_roles.examplegroup1 example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/redshift_cluster_snapshot.html.markdown b/website/docs/cdktf/typescript/r/redshift_cluster_snapshot.html.markdown index ab3905d89fa0..e52556bacf25 100644 --- a/website/docs/cdktf/typescript/r/redshift_cluster_snapshot.html.markdown +++ b/website/docs/cdktf/typescript/r/redshift_cluster_snapshot.html.markdown @@ -49,6 +49,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `clusterIdentifier` - (Required, Forces new resource) The cluster identifier for which you want a snapshot. * `snapshotIdentifier` - (Required, Forces new resource) A unique identifier for the snapshot that you are requesting. This identifier must be unique for all snapshots within the Amazon Web Services account. * `manualSnapshotRetentionPeriod` - (Optional) The number of days that a manual snapshot is retained. If the value is `-1`, the manual snapshot is retained indefinitely. Valid values are -1 and between `1` and `3653`. @@ -92,4 +93,4 @@ Using `terraform import`, import Redshift Cluster Snapshots using `snapshotIdent % terraform import aws_redshift_cluster_snapshot.test example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/redshift_data_share_authorization.html.markdown b/website/docs/cdktf/typescript/r/redshift_data_share_authorization.html.markdown index ca7337748244..cc521705e802 100644 --- a/website/docs/cdktf/typescript/r/redshift_data_share_authorization.html.markdown +++ b/website/docs/cdktf/typescript/r/redshift_data_share_authorization.html.markdown @@ -46,6 +46,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `allowWrites` - (Optional) Whether to allow write operations for a datashare. ## Attribute Reference @@ -88,4 +89,4 @@ Using `terraform import`, import Redshift Data Share Authorization using the `id % terraform import aws_redshift_data_share_authorization.example arn:aws:redshift:us-west-2:123456789012:datashare:3072dae5-022b-4d45-9cd3-01f010aae4b2/example_share,123456789012 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/redshift_data_share_consumer_association.html.markdown b/website/docs/cdktf/typescript/r/redshift_data_share_consumer_association.html.markdown index 63c6497ba9c4..8c5819a022c2 100644 --- a/website/docs/cdktf/typescript/r/redshift_data_share_consumer_association.html.markdown +++ b/website/docs/cdktf/typescript/r/redshift_data_share_consumer_association.html.markdown @@ -69,6 +69,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `allowWrites` - (Optional) Whether to allow write operations for a datashare. * `associateEntireAccount` - (Optional) Whether the datashare is associated with the entire account. Conflicts with `consumerArn` and `consumerRegion`. * `consumerArn` - (Optional) Amazon Resource Name (ARN) of the consumer that is associated with the datashare. Conflicts with `associateEntireAccount` and `consumerRegion`. @@ -114,4 +115,4 @@ Using `terraform import`, import Redshift Data Share Consumer Association using % terraform import aws_redshift_data_share_consumer_association.example arn:aws:redshift:us-west-2:123456789012:datashare:b3bfde75-73fd-408b-9086-d6fccfd6d588/example,,,us-west-2 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/redshift_endpoint_access.html.markdown b/website/docs/cdktf/typescript/r/redshift_endpoint_access.html.markdown index fe912d5eea04..4520ff968ef0 100644 --- a/website/docs/cdktf/typescript/r/redshift_endpoint_access.html.markdown +++ b/website/docs/cdktf/typescript/r/redshift_endpoint_access.html.markdown @@ -42,6 +42,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `clusterIdentifier` - (Required) The cluster identifier of the cluster to access. * `endpointName` - (Required) The Redshift-managed VPC endpoint name. * `resourceOwner` - (Optional) The Amazon Web Services account ID of the owner of the cluster. This is only required if the cluster is in another Amazon Web Services account. @@ -98,4 +99,4 @@ Using `terraform import`, import Redshift endpoint access using the `name`. For % terraform import aws_redshift_endpoint_access.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/redshift_endpoint_authorization.html.markdown b/website/docs/cdktf/typescript/r/redshift_endpoint_authorization.html.markdown index 5abbd8f4d67f..4cd9bc60df7b 100644 --- a/website/docs/cdktf/typescript/r/redshift_endpoint_authorization.html.markdown +++ b/website/docs/cdktf/typescript/r/redshift_endpoint_authorization.html.markdown @@ -41,6 +41,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `account` - (Required) The Amazon Web Services account ID to grant access to. * `clusterIdentifier` - (Required) The cluster identifier of the cluster to grant access to. * `forceDelete` - (Optional) Indicates whether to force the revoke action. If true, the Redshift-managed VPC endpoints associated with the endpoint authorization are also deleted. Default value is `false`. @@ -88,4 +89,4 @@ Using `terraform import`, import Redshift endpoint authorization using the `id`. % terraform import aws_redshift_endpoint_authorization.example 01234567910:cluster-example-id ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/redshift_event_subscription.html.markdown b/website/docs/cdktf/typescript/r/redshift_event_subscription.html.markdown index adb14cbe00f2..4e96a45377f0 100644 --- a/website/docs/cdktf/typescript/r/redshift_event_subscription.html.markdown +++ b/website/docs/cdktf/typescript/r/redshift_event_subscription.html.markdown @@ -72,6 +72,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) The name of the Redshift event subscription. * `snsTopicArn` - (Required) The ARN of the SNS topic to send events to. * `sourceIds` - (Optional) A list of identifiers of the event sources for which events will be returned. If not specified, then all sources are included in the response. If specified, a `sourceType` must also be specified. @@ -122,4 +123,4 @@ Using `terraform import`, import Redshift Event Subscriptions using the `name`. % terraform import aws_redshift_event_subscription.default redshift-event-sub ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/redshift_hsm_client_certificate.html.markdown b/website/docs/cdktf/typescript/r/redshift_hsm_client_certificate.html.markdown index 3f051d800ad5..a3e5b71e3303 100644 --- a/website/docs/cdktf/typescript/r/redshift_hsm_client_certificate.html.markdown +++ b/website/docs/cdktf/typescript/r/redshift_hsm_client_certificate.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `hsmClientCertificateIdentifier` - (Required, Forces new resource) The identifier of the HSM client certificate. * `tags` - (Optional) A map of tags to assign to the resource. If configured with a provider [`defaultTags` 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. @@ -81,4 +82,4 @@ Using `terraform import`, import Redshift HSM Client Certificates using `hsmClie % terraform import aws_redshift_hsm_client_certificate.test example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/redshift_hsm_configuration.html.markdown b/website/docs/cdktf/typescript/r/redshift_hsm_configuration.html.markdown index c7bda39cecf4..52bb8dcc439b 100644 --- a/website/docs/cdktf/typescript/r/redshift_hsm_configuration.html.markdown +++ b/website/docs/cdktf/typescript/r/redshift_hsm_configuration.html.markdown @@ -43,6 +43,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `description` - (Required, Forces new resource) A text description of the HSM configuration to be created. * `hsmConfigurationIdentifier` - (Required, Forces new resource) The identifier to be assigned to the new Amazon Redshift HSM configuration. * `hsmIpAddress` - (Required, Forces new resource) The IP address that the Amazon Redshift cluster must use to access the HSM. @@ -87,4 +88,4 @@ Using `terraform import`, import Redshift HSM Client Certificates using `hsmConf % terraform import aws_redshift_hsm_configuration.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/redshift_integration.html.markdown b/website/docs/cdktf/typescript/r/redshift_integration.html.markdown index 3b286d82f366..e3ad759f91a9 100644 --- a/website/docs/cdktf/typescript/r/redshift_integration.html.markdown +++ b/website/docs/cdktf/typescript/r/redshift_integration.html.markdown @@ -177,6 +177,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `additionalEncryptionContext` - (Optional, Forces new resources) Set of non-secret key–value pairs that contains additional contextual information about the data. For more information, see the [User Guide](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context). You can only include this parameter if you specify the `kmsKeyId` parameter. @@ -235,4 +236,4 @@ Using `terraform import`, import Redshift Integration using the `arn`. For examp % terraform import aws_redshift_integration.example arn:aws:redshift:us-west-2:123456789012:integration:abcdefgh-0000-1111-2222-123456789012 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/redshift_logging.html.markdown b/website/docs/cdktf/typescript/r/redshift_logging.html.markdown index 4b436171a74d..ddcfbaf5fe6e 100644 --- a/website/docs/cdktf/typescript/r/redshift_logging.html.markdown +++ b/website/docs/cdktf/typescript/r/redshift_logging.html.markdown @@ -70,6 +70,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `bucketName` - (Optional) Name of an existing S3 bucket where the log files are to be stored. Required when `logDestinationType` is `s3`. Must be in the same region as the cluster and the cluster must have read bucket and put object permissions. For more information on the permissions required for the bucket, please read the AWS [documentation](http://docs.aws.amazon.com/redshift/latest/mgmt/db-auditing.html#db-auditing-enable-logging) * `logDestinationType` - (Optional) Log destination type. Valid values are `s3` and `cloudwatch`. * `logExports` - (Optional) Collection of exported log types. Required when `logDestinationType` is `cloudwatch`. Valid values are `connectionlog`, `useractivitylog`, and `userlog`. @@ -79,7 +80,7 @@ The following arguments are optional: This resource exports the following attributes in addition to the arguments above: -* `id` - Identifier of the source cluster. +* `id` - (**Deprecated**, use `clusterIdentifier` instead) Identifier of the source cluster. ## Import @@ -113,4 +114,4 @@ Using `terraform import`, import Redshift Logging using the `id`. For example: % terraform import aws_redshift_logging.example cluster-id-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/redshift_parameter_group.html.markdown b/website/docs/cdktf/typescript/r/redshift_parameter_group.html.markdown index b04b6d96e92c..f526e0f9bbc3 100644 --- a/website/docs/cdktf/typescript/r/redshift_parameter_group.html.markdown +++ b/website/docs/cdktf/typescript/r/redshift_parameter_group.html.markdown @@ -53,6 +53,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) The name of the Redshift parameter group. * `family` - (Required) The family of the Redshift parameter group. * `description` - (Optional) The description of the Redshift parameter group. Defaults to "Managed by Terraform". @@ -106,4 +107,4 @@ Using `terraform import`, import Redshift Parameter Groups using the `name`. For % terraform import aws_redshift_parameter_group.paramgroup1 parameter-group-test-terraform ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/redshift_partner.html.markdown b/website/docs/cdktf/typescript/r/redshift_partner.html.markdown index 37c79ef5a025..3d158ada262a 100644 --- a/website/docs/cdktf/typescript/r/redshift_partner.html.markdown +++ b/website/docs/cdktf/typescript/r/redshift_partner.html.markdown @@ -41,6 +41,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `accountId` - (Required) The Amazon Web Services account ID that owns the cluster. * `clusterIdentifier` - (Required) The cluster identifier of the cluster that receives data from the partner. * `databaseName` - (Required) The name of the database that receives data from the partner. @@ -86,4 +87,4 @@ Using `terraform import`, import Redshift usage limits using the `id`. For examp % terraform import aws_redshift_partner.example 01234567910:cluster-example-id:example:example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/redshift_resource_policy.html.markdown b/website/docs/cdktf/typescript/r/redshift_resource_policy.html.markdown index 62fb5b04e2e8..0c77ad4c8bbc 100644 --- a/website/docs/cdktf/typescript/r/redshift_resource_policy.html.markdown +++ b/website/docs/cdktf/typescript/r/redshift_resource_policy.html.markdown @@ -56,6 +56,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `resourceArn` - (Required) The Amazon Resource Name (ARN) of the account to create or update a resource policy for. * `policy` - (Required) The content of the resource policy being updated. @@ -93,4 +94,4 @@ Using `terraform import`, import Redshift Resource Policies using the `resourceA % terraform import aws_redshift_resource_policy.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/redshift_scheduled_action.html.markdown b/website/docs/cdktf/typescript/r/redshift_scheduled_action.html.markdown index 66a9a0b7d06f..614a7d343a33 100644 --- a/website/docs/cdktf/typescript/r/redshift_scheduled_action.html.markdown +++ b/website/docs/cdktf/typescript/r/redshift_scheduled_action.html.markdown @@ -136,6 +136,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) The scheduled action name. * `description` - (Optional) The description of the scheduled action. * `enable` - (Optional) Whether to enable the scheduled action. Default is `true` . @@ -207,4 +208,4 @@ Using `terraform import`, import Redshift Scheduled Action using the `name`. For % terraform import aws_redshift_scheduled_action.example tf-redshift-scheduled-action ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/redshift_snapshot_copy.html.markdown b/website/docs/cdktf/typescript/r/redshift_snapshot_copy.html.markdown index 710cc72cbc84..e514e31ae981 100644 --- a/website/docs/cdktf/typescript/r/redshift_snapshot_copy.html.markdown +++ b/website/docs/cdktf/typescript/r/redshift_snapshot_copy.html.markdown @@ -45,6 +45,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `manualSnapshotRetentionPeriod` - (Optional) Number of days to retain newly copied snapshots in the destination AWS Region after they are copied from the source AWS Region. If the value is `-1`, the manual snapshot is retained indefinitely. * `retentionPeriod` - (Optional) Number of days to retain automated snapshots in the destination region after they are copied from the source region. * `snapshotCopyGrantName` - (Optional) Name of the snapshot copy grant to use when snapshots of an AWS KMS-encrypted cluster are copied to the destination region. @@ -87,4 +88,4 @@ Using `terraform import`, import Redshift Snapshot Copy using the `id`. For exam % terraform import aws_redshift_snapshot_copy.example cluster-id-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/redshift_snapshot_copy_grant.html.markdown b/website/docs/cdktf/typescript/r/redshift_snapshot_copy_grant.html.markdown index 80246a8e8cd4..9284c58139e0 100644 --- a/website/docs/cdktf/typescript/r/redshift_snapshot_copy_grant.html.markdown +++ b/website/docs/cdktf/typescript/r/redshift_snapshot_copy_grant.html.markdown @@ -37,10 +37,12 @@ class MyConvertedCode extends TerraformStack { snapshotCopyGrantName: "my-grant", }); const awsRedshiftClusterTest = new RedshiftCluster(this, "test_1", { - snapshotCopy: { - destinationRegion: "us-east-2", - grantName: test.snapshotCopyGrantName, - }, + snapshot_copy: [ + { + destination_region: "us-east-2", + grant_name: test.snapshotCopyGrantName, + }, + ], clusterIdentifier: config.clusterIdentifier, nodeType: config.nodeType, }); @@ -55,6 +57,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `snapshotCopyGrantName` - (Required, Forces new resource) A friendly name for identifying the grant. * `kmsKeyId` - (Optional, Forces new resource) The unique identifier for the customer master key (CMK) that the grant applies to. Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS account, you must use the key ARN. If not specified, the default key is used. * `tags` - (Optional) A map of tags to assign to the resource. If configured with a provider [`defaultTags` 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. @@ -94,4 +97,4 @@ Using `terraform import`, import Redshift Snapshot Copy Grants by name. For exam % terraform import aws_redshift_snapshot_copy_grant.test my-grant ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/redshift_snapshot_schedule.html.markdown b/website/docs/cdktf/typescript/r/redshift_snapshot_schedule.html.markdown index 273477ebaff9..e172b72b4ec1 100644 --- a/website/docs/cdktf/typescript/r/redshift_snapshot_schedule.html.markdown +++ b/website/docs/cdktf/typescript/r/redshift_snapshot_schedule.html.markdown @@ -37,6 +37,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `identifier` - (Optional, Forces new resource) The snapshot schedule identifier. If omitted, Terraform will assign a random, unique identifier. * `identifierPrefix` - (Optional, Forces new resource) Creates a unique identifier beginning with the specified prefix. Conflicts with `identifier`. @@ -84,4 +85,4 @@ Using `terraform import`, import Redshift Snapshot Schedule using the `identifie % terraform import aws_redshift_snapshot_schedule.default tf-redshift-snapshot-schedule ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/redshift_snapshot_schedule_association.html.markdown b/website/docs/cdktf/typescript/r/redshift_snapshot_schedule_association.html.markdown index 37039ec064bd..66cec7d90846 100644 --- a/website/docs/cdktf/typescript/r/redshift_snapshot_schedule_association.html.markdown +++ b/website/docs/cdktf/typescript/r/redshift_snapshot_schedule_association.html.markdown @@ -62,6 +62,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `clusterIdentifier` - (Required, Forces new resource) The cluster identifier. * `scheduleIdentifier` - (Required, Forces new resource) The snapshot schedule identifier. @@ -101,4 +102,4 @@ Using `terraform import`, import Redshift Snapshot Schedule Association using th % terraform import aws_redshift_snapshot_schedule_association.default tf-redshift-cluster/tf-redshift-snapshot-schedule ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/redshift_subnet_group.html.markdown b/website/docs/cdktf/typescript/r/redshift_subnet_group.html.markdown index fd3bb8d8ddc1..70bb7b9c47b1 100644 --- a/website/docs/cdktf/typescript/r/redshift_subnet_group.html.markdown +++ b/website/docs/cdktf/typescript/r/redshift_subnet_group.html.markdown @@ -67,6 +67,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) The name of the Redshift Subnet group. * `description` - (Optional) The description of the Redshift Subnet group. Defaults to "Managed by Terraform". * `subnetIds` - (Required) An array of VPC subnet IDs. @@ -112,4 +113,4 @@ Using `terraform import`, import Redshift subnet groups using the `name`. For ex % terraform import aws_redshift_subnet_group.testgroup1 test-cluster-subnet-group ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/redshift_usage_limit.html.markdown b/website/docs/cdktf/typescript/r/redshift_usage_limit.html.markdown index 62fb089076ea..24b3edac722d 100644 --- a/website/docs/cdktf/typescript/r/redshift_usage_limit.html.markdown +++ b/website/docs/cdktf/typescript/r/redshift_usage_limit.html.markdown @@ -41,6 +41,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `amount` - (Required) The limit amount. If time-based, this amount is in minutes. If data-based, this amount is in terabytes (TB). The value must be a positive number. * `breachAction` - (Optional) The action that Amazon Redshift takes when the limit is reached. The default is `log`. Valid values are `log`, `emit-metric`, and `disable`. * `clusterIdentifier` - (Required) The identifier of the cluster that you want to limit usage. @@ -85,4 +86,4 @@ Using `terraform import`, import Redshift usage limits using the `id`. For examp % terraform import aws_redshift_usage_limit.example example-id ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/redshiftdata_statement.html.markdown b/website/docs/cdktf/typescript/r/redshiftdata_statement.html.markdown index 94f0f22175c7..ae6b849468d5 100644 --- a/website/docs/cdktf/typescript/r/redshiftdata_statement.html.markdown +++ b/website/docs/cdktf/typescript/r/redshiftdata_statement.html.markdown @@ -76,6 +76,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `clusterIdentifier` - (Optional) The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials. * `dbUser` - (Optional) The database user name. * `secretArn` - (Optional) The name or ARN of the secret that enables access to the database. @@ -117,4 +118,4 @@ Using `terraform import`, import Redshift Data Statements using the `id`. For ex % terraform import aws_redshiftdata_statement.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/redshiftserverless_custom_domain_association.html.markdown b/website/docs/cdktf/typescript/r/redshiftserverless_custom_domain_association.html.markdown index 2d2a8bad4aa5..e211efc6b621 100644 --- a/website/docs/cdktf/typescript/r/redshiftserverless_custom_domain_association.html.markdown +++ b/website/docs/cdktf/typescript/r/redshiftserverless_custom_domain_association.html.markdown @@ -65,8 +65,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `workgroupName` - (Required) Name of the workgroup. * `customDomainName` - (Required) Custom domain to associate with the workgroup. * `customDomainCertificateArn` - (Required) ARN of the certificate for the custom domain association. @@ -109,4 +110,4 @@ Using `terraform import`, import Redshift Serverless Custom Domain Association u % terraform import aws_redshiftserverless_custom_domain_association.example example-workgroup,example.com ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/redshiftserverless_endpoint_access.html.markdown b/website/docs/cdktf/typescript/r/redshiftserverless_endpoint_access.html.markdown index e8a481cd1fbf..48441c454a13 100644 --- a/website/docs/cdktf/typescript/r/redshiftserverless_endpoint_access.html.markdown +++ b/website/docs/cdktf/typescript/r/redshiftserverless_endpoint_access.html.markdown @@ -43,6 +43,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `endpointName` - (Required) The name of the endpoint. * `ownerAccount` - (Optional) The owner Amazon Web Services account for the Amazon Redshift Serverless workgroup. * `subnetIds` - (Required) An array of VPC subnet IDs to associate with the endpoint. @@ -104,4 +105,4 @@ Using `terraform import`, import Redshift Serverless Endpoint Access using the ` % terraform import aws_redshiftserverless_endpoint_access.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/redshiftserverless_namespace.html.markdown b/website/docs/cdktf/typescript/r/redshiftserverless_namespace.html.markdown index f0ec36d6a812..0ea3c99eb387 100644 --- a/website/docs/cdktf/typescript/r/redshiftserverless_namespace.html.markdown +++ b/website/docs/cdktf/typescript/r/redshiftserverless_namespace.html.markdown @@ -12,7 +12,7 @@ description: |- Creates a new Amazon Redshift Serverless Namespace. --> **Note:** Write-Only argument `admin_password_wo` is available to use in place of `admin_password`. Write-Only arguments are supported in HashiCorp Terraform 1.11.0 and later. [Learn more](https://developer.hashicorp.com/terraform/language/v1.11.x/resources/ephemeral#write-only-arguments). +-> **Note:** Write-Only argument `admin_password_wo` is available to use in place of `admin_password`. Write-Only arguments are supported in HashiCorp Terraform 1.11.0 and later. [Learn more](https://developer.hashicorp.com/terraform/language/resources/ephemeral#write-only-arguments). ## Example Usage @@ -40,6 +40,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `adminPasswordSecretKmsKeyId` - (Optional) ID of the KMS key used to encrypt the namespace's admin credentials secret. * `adminUserPassword` - (Optional) The password of the administrator for the first database created in the namespace. Conflicts with `manageAdminPassword` and `adminUserPasswordWo`. @@ -99,4 +100,4 @@ Using `terraform import`, import Redshift Serverless Namespaces using the `names % terraform import aws_redshiftserverless_namespace.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/redshiftserverless_resource_policy.html.markdown b/website/docs/cdktf/typescript/r/redshiftserverless_resource_policy.html.markdown index 14e2ef9dd358..96da022bb449 100644 --- a/website/docs/cdktf/typescript/r/redshiftserverless_resource_policy.html.markdown +++ b/website/docs/cdktf/typescript/r/redshiftserverless_resource_policy.html.markdown @@ -53,6 +53,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `resourceArn` - (Required) The Amazon Resource Name (ARN) of the account to create or update a resource policy for. * `policy` - (Required) The policy to create or update. For example, the following policy grants a user authorization to restore a snapshot. @@ -94,4 +95,4 @@ Using `terraform import`, import Redshift Serverless Resource Policies using the % terraform import aws_redshiftserverless_resource_policy.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/redshiftserverless_snapshot.html.markdown b/website/docs/cdktf/typescript/r/redshiftserverless_snapshot.html.markdown index 9b5b21196327..f062224cad24 100644 --- a/website/docs/cdktf/typescript/r/redshiftserverless_snapshot.html.markdown +++ b/website/docs/cdktf/typescript/r/redshiftserverless_snapshot.html.markdown @@ -41,6 +41,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `namespaceName` - (Required) The namespace to create a snapshot for. * `snapshotName` - (Required) The name of the snapshot. * `retentionPeriod` - (Optional) How long to retain the created snapshot. Default value is `-1`. @@ -90,4 +91,4 @@ Using `terraform import`, import Redshift Serverless Snapshots using the `snapsh % terraform import aws_redshiftserverless_snapshot.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/redshiftserverless_usage_limit.html.markdown b/website/docs/cdktf/typescript/r/redshiftserverless_usage_limit.html.markdown index 99d827efde69..b87c8e65a17b 100644 --- a/website/docs/cdktf/typescript/r/redshiftserverless_usage_limit.html.markdown +++ b/website/docs/cdktf/typescript/r/redshiftserverless_usage_limit.html.markdown @@ -50,6 +50,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `amount` - (Required) The limit amount. If time-based, this amount is in Redshift Processing Units (RPU) consumed per hour. If data-based, this amount is in terabytes (TB) of data transferred between Regions in cross-account sharing. The value must be a positive number. * `breachAction` - (Optional) The action that Amazon Redshift Serverless takes when the limit is reached. Valid values are `log`, `emit-metric`, and `deactivate`. The default is `log`. * `period` - (Optional) The time period that the amount applies to. A weekly period begins on Sunday. Valid values are `daily`, `weekly`, and `monthly`. The default is `monthly`. @@ -95,4 +96,4 @@ Using `terraform import`, import Redshift Serverless Usage Limits using the `id` % terraform import aws_redshiftserverless_usage_limit.example example-id ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/redshiftserverless_workgroup.html.markdown b/website/docs/cdktf/typescript/r/redshiftserverless_workgroup.html.markdown index 5f793edcbd62..430c84e24715 100644 --- a/website/docs/cdktf/typescript/r/redshiftserverless_workgroup.html.markdown +++ b/website/docs/cdktf/typescript/r/redshiftserverless_workgroup.html.markdown @@ -44,6 +44,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `baseCapacity` - (Optional) The base data warehouse capacity of the workgroup in Redshift Processing Units (RPUs). * `pricePerformanceTarget` - (Optional) Price-performance scaling for the workgroup. See `Price Performance Target` below. * `configParameter` - (Optional) An array of parameters to set for more control over a serverless database. See `Config Parameter` below. @@ -53,7 +54,7 @@ The following arguments are optional: * `publiclyAccessible` - (Optional) A value that specifies whether the workgroup can be accessed from a public network. * `securityGroupIds` - (Optional) An array of security group IDs to associate with the workgroup. * `subnetIds` - (Optional) An array of VPC subnet IDs to associate with the workgroup. When set, must contain at least three subnets spanning three Availability Zones. A minimum number of IP addresses is required and scales with the Base Capacity. For more information, see the following [AWS document](https://docs.aws.amazon.com/redshift/latest/mgmt/serverless-known-issues.html). -* `track_name` - (Optional) The name of the track for the workgroup. If it is `current`, you get the most up-to-date certified release version with the latest features, security updates, and performance enhancements. If it is `trailing`, you will be on the previous certified release. For more information, see the following [AWS document](https://docs.aws.amazon.com/redshift/latest/mgmt/tracks.html). +* `trackName` - (Optional) The name of the track for the workgroup. If it is `current`, you get the most up-to-date certified release version with the latest features, security updates, and performance enhancements. If it is `trailing`, you will be on the previous certified release. For more information, see the following [AWS document](https://docs.aws.amazon.com/redshift/latest/mgmt/tracks.html). * `tags` - (Optional) A map of tags to assign to the resource. If configured with a provider [`defaultTags` 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. ### Price Performance Target @@ -135,4 +136,4 @@ Using `terraform import`, import Redshift Serverless Workgroups using the `workg % terraform import aws_redshiftserverless_workgroup.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/rekognition_collection.html.markdown b/website/docs/cdktf/typescript/r/rekognition_collection.html.markdown index e4eea22b4b86..88d7c8b4883a 100644 --- a/website/docs/cdktf/typescript/r/rekognition_collection.html.markdown +++ b/website/docs/cdktf/typescript/r/rekognition_collection.html.markdown @@ -45,6 +45,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `tags` - (Optional) Map of tags assigned to the resource. If configured with a provider [`defaultTags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. ## Attribute Reference @@ -63,7 +64,7 @@ This resource exports the following attributes in addition to the arguments abov ## Import -In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import Rekognition Collection using the `example_id_arg`. For example: +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import Rekognition Collection using the `collectionId`. For example: ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -87,10 +88,10 @@ class MyConvertedCode extends TerraformStack { ``` -Using `terraform import`, import Rekognition Collection using the `example_id_arg`. For example: +Using `terraform import`, import Rekognition Collection using the `collectionId`. For example: ```console % terraform import aws_rekognition_collection.example collection-id-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/rekognition_project.html.markdown b/website/docs/cdktf/typescript/r/rekognition_project.html.markdown index d092b2e452fa..701b068462d5 100644 --- a/website/docs/cdktf/typescript/r/rekognition_project.html.markdown +++ b/website/docs/cdktf/typescript/r/rekognition_project.html.markdown @@ -14,6 +14,8 @@ Terraform resource for managing an AWS Rekognition Project. ## Example Usage +### Content Moderation + ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug import { Construct } from "constructs"; @@ -36,6 +38,29 @@ class MyConvertedCode extends TerraformStack { ``` +### Custom Labels + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { RekognitionProject } from "./.gen/providers/aws/rekognition-project"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + new RekognitionProject(this, "example", { + feature: "CUSTOM_LABELS", + name: "example-project", + }); + } +} + +``` + ## Argument Reference The following arguments are required: @@ -44,7 +69,8 @@ The following arguments are required: The following arguments are optional: -* `autoUpdate` - (Optional) Specify if automatic retraining should occur. Valid values are `ENABLED` or `DISABLED`. Defaults to `DISABLED`. +* `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). +* `autoUpdate` - (Optional) Specify if automatic retraining should occur. Valid values are `ENABLED` or `DISABLED`. Must be set when `feature` is `CONTENT_MODERATION`, but do not set otherwise. * `feature` - (Optional) Specify the feature being customized. Valid values are `CONTENT_MODERATION` or `CUSTOM_LABELS`. Defaults to `CUSTOM_LABELS`. * `tags` - (Optional) Map of tags assigned to the resource. If configured with a provider [`defaultTags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. @@ -64,7 +90,7 @@ This resource exports the following attributes in addition to the arguments abov ## Import -In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import Rekognition Project using the `example_id_arg`. For example: +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import Rekognition Project using the `name`. For example: ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -94,4 +120,4 @@ Using `terraform import`, import Rekognition Project using the `name`. For examp % terraform import aws_rekognition_project.example project-id-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/rekognition_stream_processor.html.markdown b/website/docs/cdktf/typescript/r/rekognition_stream_processor.html.markdown index c6329ae6b544..9a50e939177c 100644 --- a/website/docs/cdktf/typescript/r/rekognition_stream_processor.html.markdown +++ b/website/docs/cdktf/typescript/r/rekognition_stream_processor.html.markdown @@ -313,6 +313,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `dataSharingPreference` - (Optional) See [`dataSharingPreference`](#data_sharing_preference). * `kmsKeyId` - (Optional) Optional parameter for label detection stream processors. * `notificationChannel` - (Optional) The Amazon Simple Notification Service topic to which Amazon Rekognition publishes the completion status. See [`notificationChannel`](#notification_channel). @@ -434,4 +435,4 @@ Using `terraform import`, import Rekognition Stream Processor using the `name`. % terraform import aws_rekognition_stream_processor.example my-stream ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/resiliencehub_resiliency_policy.html.markdown b/website/docs/cdktf/typescript/r/resiliencehub_resiliency_policy.html.markdown index 5e65b5bfeb6f..2114a64c6583 100644 --- a/website/docs/cdktf/typescript/r/resiliencehub_resiliency_policy.html.markdown +++ b/website/docs/cdktf/typescript/r/resiliencehub_resiliency_policy.html.markdown @@ -78,6 +78,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `description` (String) Description of Resiliency Policy. * `dataLocationConstraint` (String) Data Location Constraint of the Policy. Valid values are `AnyLocation`, `SameContinent`, and `SameCountry`. @@ -93,6 +94,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `region` - (Attributes) Specifies Region failure policy. [`policy.region`](#policyregion) ### `policy.az` @@ -179,4 +181,4 @@ Using `terraform import`, import Resilience Hub Resiliency Policy using the `arn % terraform import aws_resiliencehub_resiliency_policy.example arn:aws:resiliencehub:us-east-1:123456789012:resiliency-policy/8c1cfa29-d1dd-4421-aa68-c9f64cced4c2 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/resourceexplorer2_index.html.markdown b/website/docs/cdktf/typescript/r/resourceexplorer2_index.html.markdown index 154c3f7c7a38..69f56d2aef94 100644 --- a/website/docs/cdktf/typescript/r/resourceexplorer2_index.html.markdown +++ b/website/docs/cdktf/typescript/r/resourceexplorer2_index.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `type` - (Required) The type of the index. Valid values: `AGGREGATOR`, `LOCAL`. To understand the difference between `LOCAL` and `AGGREGATOR`, see the [_AWS Resource Explorer User Guide_](https://docs.aws.amazon.com/resource-explorer/latest/userguide/manage-aggregator-region.html). * `tags` - (Optional) Key-value map of resource tags. If configured with a provider [`defaultTags` 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. @@ -88,4 +89,4 @@ Using `terraform import`, import Resource Explorer indexes using the `arn`. For % terraform import aws_resourceexplorer2_index.example arn:aws:resource-explorer-2:us-east-1:123456789012:index/6047ac4e-207e-4487-9bcf-cb53bb0ff5cc ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/resourceexplorer2_view.html.markdown b/website/docs/cdktf/typescript/r/resourceexplorer2_view.html.markdown index 70339b17dd4d..7a1d10368734 100644 --- a/website/docs/cdktf/typescript/r/resourceexplorer2_view.html.markdown +++ b/website/docs/cdktf/typescript/r/resourceexplorer2_view.html.markdown @@ -59,6 +59,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `defaultView` - (Optional) Specifies whether the view is the [_default view_](https://docs.aws.amazon.com/resource-explorer/latest/userguide/manage-views-about.html#manage-views-about-default) for the AWS Region. Default: `false`. * `filters` - (Optional) Specifies which resources are included in the results of queries made using this view. See [Filters](#filters) below for more details. * `includedProperty` - (Optional) Optional fields to be included in search results from this view. See [Included Properties](#included-properties) below for more details. @@ -117,4 +118,4 @@ Using `terraform import`, import Resource Explorer views using the `arn`. For ex % terraform import aws_resourceexplorer2_view.example arn:aws:resource-explorer-2:us-west-2:123456789012:view/exampleview/e0914f6c-6c27-4b47-b5d4-6b28381a2421 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/resourcegroups_group.html.markdown b/website/docs/cdktf/typescript/r/resourcegroups_group.html.markdown index 1c13bf519c88..2dca403491c3 100644 --- a/website/docs/cdktf/typescript/r/resourcegroups_group.html.markdown +++ b/website/docs/cdktf/typescript/r/resourcegroups_group.html.markdown @@ -42,6 +42,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) The resource group's name. A resource group name can have a maximum of 127 characters, including letters, numbers, hyphens, dots, and underscores. The name cannot start with `AWS` or `aws`. * `configuration` - (Optional) A configuration associates the resource group with an AWS service and specifies how the service can interact with the resources in the group. See below for details. * `description` - (Optional) A description of the resource group. @@ -102,4 +103,4 @@ Using `terraform import`, import resource groups using the `name`. For example: % terraform import aws_resourcegroups_group.foo resource-group-name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/resourcegroups_resource.html.markdown b/website/docs/cdktf/typescript/r/resourcegroups_resource.html.markdown index 6298fdb9a2f2..b2b702ca8d7c 100644 --- a/website/docs/cdktf/typescript/r/resourcegroups_resource.html.markdown +++ b/website/docs/cdktf/typescript/r/resourcegroups_resource.html.markdown @@ -62,8 +62,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `groupArn` - (Required) Name or ARN of the resource group to add resources to. * `resourceArn` - (Required) ARN of the resource to be added to the group. @@ -113,4 +114,4 @@ Using `terraform import`, import an AWS Resource Groups Resource using `groupArn % terraform import aws_resourcegroups_resource.example arn:aws:resource-groups:us-west-2:012345678901:group/example,arn:aws:lambda:us-west-2:012345678901:function:example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/route.html.markdown b/website/docs/cdktf/typescript/r/route.html.markdown index 20f092e7cc39..26231fe10f63 100644 --- a/website/docs/cdktf/typescript/r/route.html.markdown +++ b/website/docs/cdktf/typescript/r/route.html.markdown @@ -79,6 +79,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `routeTableId` - (Required) The ID of the routing table. One of the following destination arguments must be supplied: @@ -124,6 +125,46 @@ This resource exports the following attributes in addition to the arguments abov ## Import +In Terraform v1.12.0 and later, the [`import` block](https://developer.hashicorp.com/terraform/language/import) can be used with the `identity` attribute. For example: + +```terraform +import { + to = aws_route.example + identity = { + route_table_id = "rtb-656C65616E6F72" + destination_cidr_block = "10.42.0.0/16" + + ### OR by IPv6 CIDR block + # destination_ipv6_cidr_block = "10.42.0.0/16" + + ### OR by prefix list ID + # destination_prefix_list_id = "pl-0570a1d2d725c16be" + } +} + +resource "aws_route" "example" { + route_table_id = "rtb-656C65616E6F72" + destination_cidr_block = "10.42.0.0/16" + vpc_peering_connection_id = "pcx-45ff3dc1" +} +``` + +### Identity Schema + +#### Required + +- `routeTableId` - (String) ID of the route table. + +#### Optional + +~> Exactly one of of `destinationCidrBlock`, `destinationIpv6CidrBlock`, or `destinationPrefixListId` is required. + +- `accountId` (String) AWS Account where this resource is managed. +- `destinationCidrBlock` - (String) Destination IPv4 CIDR block. +- `destinationIpv6CidrBlock` - (String) Destination IPv6 CIDR block. +- `destinationPrefixListId` - (String) Destination IPv6 CIDR block. +- `region` (String) Region where this resource is managed. + In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import individual routes using `ROUTETABLEID_DESTINATION`. Import [local routes](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Route_Tables.html#RouteTables) using the VPC's IPv4 or IPv6 CIDR blocks. For example: Import a route in route table `rtb-656C65616E6F72` with an IPv4 destination CIDR of `10.42.0.0/16`: @@ -218,4 +259,4 @@ Import a route in route table `rtb-656C65616E6F72` with a managed prefix list de % terraform import aws_route.my_route rtb-656C65616E6F72_pl-0570a1d2d725c16be ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/route53_resolver_config.html.markdown b/website/docs/cdktf/typescript/r/route53_resolver_config.html.markdown index 19e16138527f..7e278e0aa848 100644 --- a/website/docs/cdktf/typescript/r/route53_resolver_config.html.markdown +++ b/website/docs/cdktf/typescript/r/route53_resolver_config.html.markdown @@ -51,6 +51,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `resourceId` - (Required) The ID of the VPC that the configuration is for. * `autodefinedReverseFlag` - (Required) Indicates whether or not the Resolver will create autodefined rules for reverse DNS lookups. Valid values: `ENABLE`, `DISABLE`. @@ -93,4 +94,4 @@ Using `terraform import`, import Route 53 Resolver configs using the Route 53 Re % terraform import aws_route53_resolver_config.example rslvr-rc-715aa20c73a23da7 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/route53_resolver_dnssec_config.html.markdown b/website/docs/cdktf/typescript/r/route53_resolver_dnssec_config.html.markdown index b7e17923ad52..2bb60cdb09ed 100644 --- a/website/docs/cdktf/typescript/r/route53_resolver_dnssec_config.html.markdown +++ b/website/docs/cdktf/typescript/r/route53_resolver_dnssec_config.html.markdown @@ -47,6 +47,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `resourceId` - (Required) The ID of the virtual private cloud (VPC) that you're updating the DNSSEC validation status for. ## Attribute Reference @@ -90,4 +91,4 @@ Using `terraform import`, import Route 53 Resolver DNSSEC configs using the Rou % terraform import aws_route53_resolver_dnssec_config.example rdsc-be1866ecc1683e95 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/route53_resolver_endpoint.html.markdown b/website/docs/cdktf/typescript/r/route53_resolver_endpoint.html.markdown index 96cc0a82bbc4..6d116454f9ad 100644 --- a/website/docs/cdktf/typescript/r/route53_resolver_endpoint.html.markdown +++ b/website/docs/cdktf/typescript/r/route53_resolver_endpoint.html.markdown @@ -54,9 +54,9 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `direction` - (Required) Direction of DNS queries to or from the Route 53 Resolver endpoint. -Valid values are `INBOUND` (resolver forwards DNS queries to the DNS service for a VPC from your network or another VPC) -or `OUTBOUND` (resolver forwards DNS queries from the DNS service for a VPC to your network or another VPC). +Valid values are `INBOUND` (resolver forwards DNS queries to the DNS service for a VPC from your network or another VPC), `OUTBOUND` (resolver forwards DNS queries from the DNS service for a VPC to your network or another VPC) or `INBOUND_DELEGATION` (resolver delegates queries to Route 53 private hosted zones from your network). * `ipAddress` - (Required) Subnets and IP addresses in your VPC that you want DNS queries to pass through on the way from your VPCs to your network (for outbound endpoints) or on the way from your network to your VPCs (for inbound endpoints). Described below. * `name` - (Optional) Friendly name of the Route 53 Resolver endpoint. @@ -122,4 +122,4 @@ Using `terraform import`, import Route 53 Resolver endpoints using the Route 53 % terraform import aws_route53_resolver_endpoint.foo rslvr-in-abcdef01234567890 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/route53_resolver_firewall_config.html.markdown b/website/docs/cdktf/typescript/r/route53_resolver_firewall_config.html.markdown index 85adf5f7f503..491f1210ca1c 100644 --- a/website/docs/cdktf/typescript/r/route53_resolver_firewall_config.html.markdown +++ b/website/docs/cdktf/typescript/r/route53_resolver_firewall_config.html.markdown @@ -48,6 +48,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `resourceId` - (Required) The ID of the VPC that the configuration is for. * `firewallFailOpen` - (Required) Determines how Route 53 Resolver handles queries during failures, for example when all traffic that is sent to DNS Firewall fails to receive a reply. By default, fail open is disabled, which means the failure mode is closed. This approach favors security over availability. DNS Firewall blocks queries that it is unable to evaluate properly. If you enable this option, the failure mode is open. This approach favors availability over security. DNS Firewall allows queries to proceed if it is unable to properly evaluate them. Valid values: `ENABLED`, `DISABLED`. @@ -90,4 +91,4 @@ Using `terraform import`, import Route 53 Resolver DNS Firewall configs using th % terraform import aws_route53_resolver_firewall_config.example rdsc-be1866ecc1683e95 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/route53_resolver_firewall_domain_list.html.markdown b/website/docs/cdktf/typescript/r/route53_resolver_firewall_domain_list.html.markdown index af80547764e3..c77375efdaa1 100644 --- a/website/docs/cdktf/typescript/r/route53_resolver_firewall_domain_list.html.markdown +++ b/website/docs/cdktf/typescript/r/route53_resolver_firewall_domain_list.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) A name that lets you identify the domain list, to manage and use it. * `domains` - (Optional) A array of domains for the firewall domain list. * `tags` - (Optional) A map of tags to assign to the resource. f configured with a provider [`defaultTags` 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. @@ -82,4 +83,4 @@ Using `terraform import`, import Route 53 Resolver DNS Firewall domain lists us % terraform import aws_route53_resolver_firewall_domain_list.example rslvr-fdl-0123456789abcdef ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/route53_resolver_firewall_rule.html.markdown b/website/docs/cdktf/typescript/r/route53_resolver_firewall_rule.html.markdown index 37b91e528acb..9351f4cf4571 100644 --- a/website/docs/cdktf/typescript/r/route53_resolver_firewall_rule.html.markdown +++ b/website/docs/cdktf/typescript/r/route53_resolver_firewall_rule.html.markdown @@ -65,6 +65,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) A name that lets you identify the rule, to manage and use it. * `action` - (Required) The action that DNS Firewall should take on a DNS query when it matches one of the domains in the rule's domain list. Valid values: `ALLOW`, `BLOCK`, `ALERT`. * `blockOverrideDnsType` - (Required if `blockResponse` is `OVERRIDE`) The DNS record's type. This determines the format of the record value that you provided in BlockOverrideDomain. Value values: `CNAME`. @@ -115,4 +116,4 @@ Using `terraform import`, import Route 53 Resolver DNS Firewall rules using the % terraform import aws_route53_resolver_firewall_rule.example rslvr-frg-0123456789abcdef:rslvr-fdl-0123456789abcdef ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/route53_resolver_firewall_rule_group.html.markdown b/website/docs/cdktf/typescript/r/route53_resolver_firewall_rule_group.html.markdown index 2e47e71faa72..0d7dfa126717 100644 --- a/website/docs/cdktf/typescript/r/route53_resolver_firewall_rule_group.html.markdown +++ b/website/docs/cdktf/typescript/r/route53_resolver_firewall_rule_group.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) A name that lets you identify the rule group, to manage and use it. * `tags` - (Optional) A map of tags to assign to the resource. If configured with a provider [`defaultTags` 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. @@ -83,4 +84,4 @@ Using `terraform import`, import Route 53 Resolver DNS Firewall rule groups usi % terraform import aws_route53_resolver_firewall_rule_group.example rslvr-frg-0123456789abcdef ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/route53_resolver_firewall_rule_group_association.html.markdown b/website/docs/cdktf/typescript/r/route53_resolver_firewall_rule_group_association.html.markdown index d6212a1255a6..dd5963c9b157 100644 --- a/website/docs/cdktf/typescript/r/route53_resolver_firewall_rule_group_association.html.markdown +++ b/website/docs/cdktf/typescript/r/route53_resolver_firewall_rule_group_association.html.markdown @@ -50,6 +50,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) A name that lets you identify the rule group association, to manage and use it. * `firewallRuleGroupId` - (Required) The unique identifier of the firewall rule group. * `mutationProtection` - (Optional) If enabled, this setting disallows modification or removal of the association, to help prevent against accidentally altering DNS firewall protections. Valid values: `ENABLED`, `DISABLED`. @@ -97,4 +98,4 @@ Using `terraform import`, import Route 53 Resolver DNS Firewall rule group assoc % terraform import aws_route53_resolver_firewall_rule_group_association.example rslvr-frgassoc-0123456789abcdef ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/route53_resolver_query_log_config.html.markdown b/website/docs/cdktf/typescript/r/route53_resolver_query_log_config.html.markdown index 423c8baeae61..81323f65c375 100644 --- a/website/docs/cdktf/typescript/r/route53_resolver_query_log_config.html.markdown +++ b/website/docs/cdktf/typescript/r/route53_resolver_query_log_config.html.markdown @@ -42,6 +42,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `destinationArn` - (Required) The ARN of the resource that you want Route 53 Resolver to send query logs. You can send query logs to an [S3 bucket](s3_bucket.html), a [CloudWatch Logs log group](cloudwatch_log_group.html), or a [Kinesis Data Firehose delivery stream](kinesis_firehose_delivery_stream.html). * `name` - (Required) The name of the Route 53 Resolver query logging configuration. @@ -91,4 +92,4 @@ Using `terraform import`, import Route 53 Resolver query logging configurations % terraform import aws_route53_resolver_query_log_config.example rqlc-92edc3b1838248bf ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/route53_resolver_query_log_config_association.html.markdown b/website/docs/cdktf/typescript/r/route53_resolver_query_log_config_association.html.markdown index 6e1d4a7d5533..f8d4e6ddfab4 100644 --- a/website/docs/cdktf/typescript/r/route53_resolver_query_log_config_association.html.markdown +++ b/website/docs/cdktf/typescript/r/route53_resolver_query_log_config_association.html.markdown @@ -41,6 +41,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `resolverQueryLogConfigId` - (Required) The ID of the [Route 53 Resolver query logging configuration](route53_resolver_query_log_config.html) that you want to associate a VPC with. * `resourceId` - (Required) The ID of a VPC that you want this query logging configuration to log queries for. @@ -82,4 +83,4 @@ Using `terraform import`, import Route 53 Resolver query logging configuration % terraform import aws_route53_resolver_query_log_config_association.example rqlca-b320624fef3c4d70 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/route53_resolver_rule.html.markdown b/website/docs/cdktf/typescript/r/route53_resolver_rule.html.markdown index 2ac5230661ee..88a471db3699 100644 --- a/website/docs/cdktf/typescript/r/route53_resolver_rule.html.markdown +++ b/website/docs/cdktf/typescript/r/route53_resolver_rule.html.markdown @@ -107,6 +107,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `domainName` - (Required) DNS queries for this domain name are forwarded to the IP addresses that are specified using `targetIp`. * `ruleType` - (Required) Rule type. Valid values are `FORWARD`, `SYSTEM` and `RECURSIVE`. * `name` - (Optional) Friendly name that lets you easily find a rule in the Resolver dashboard in the Route 53 console. @@ -136,6 +137,32 @@ Values are `NOT_SHARED`, `SHARED_BY_ME` or `SHARED_WITH_ME` ## Import +In Terraform v1.12.0 and later, the [`import` block](https://developer.hashicorp.com/terraform/language/import) can be used with the `identity` attribute. For example: + +```terraform +import { + to = aws_route53_resolver_rule.example + identity = { + id = "rslvr-rr-0123456789abcdef0" + } +} + +resource "aws_route53_resolver_rule" "example" { + ### Configuration omitted for brevity ### +} +``` + +### Identity Schema + +#### Required + +* `id` - (String) ID of the Route53 Resolver rule. + +#### Optional + +- `accountId` (String) AWS Account where this resource is managed. +- `region` (String) Region where this resource is managed. + In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import Route53 Resolver rules using the `id`. For example: ```typescript @@ -152,7 +179,7 @@ class MyConvertedCode extends TerraformStack { super(scope, name); Route53ResolverRule.generateConfigForImport( this, - "sys", + "example", "rslvr-rr-0123456789abcdef0" ); } @@ -163,7 +190,7 @@ class MyConvertedCode extends TerraformStack { Using `terraform import`, import Route53 Resolver rules using the `id`. For example: ```console -% terraform import aws_route53_resolver_rule.sys rslvr-rr-0123456789abcdef0 +% terraform import aws_route53_resolver_rule.example rslvr-rr-0123456789abcdef0 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/route53_resolver_rule_association.html.markdown b/website/docs/cdktf/typescript/r/route53_resolver_rule_association.html.markdown index 2c542a0d6823..7e84268a404a 100644 --- a/website/docs/cdktf/typescript/r/route53_resolver_rule_association.html.markdown +++ b/website/docs/cdktf/typescript/r/route53_resolver_rule_association.html.markdown @@ -39,6 +39,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `resolverRuleId` - (Required) The ID of the resolver rule that you want to associate with the VPC. * `vpcId` - (Required) The ID of the VPC that you want to associate the resolver rule with. * `name` - (Optional) A name for the association that you're creating between a resolver rule and a VPC. @@ -51,6 +52,32 @@ This resource exports the following attributes in addition to the arguments abov ## Import +In Terraform v1.12.0 and later, the [`import` block](https://developer.hashicorp.com/terraform/language/import) can be used with the `identity` attribute. For example: + +```terraform +import { + to = aws_route53_resolver_rule_association.example + identity = { + id = "rslvr-rrassoc-97242eaf88example" + } +} + +resource "aws_route53_resolver_rule_association" "example" { + ### Configuration omitted for brevity ### +} +``` + +### Identity Schema + +#### Required + +* `id` - (String) ID of the Route53 Resolver rule association. + +#### Optional + +- `accountId` (String) AWS Account where this resource is managed. +- `region` (String) Region where this resource is managed. + In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import Route53 Resolver rule associations using the `id`. For example: ```typescript @@ -81,4 +108,4 @@ Using `terraform import`, import Route53 Resolver rule associations using the `i % terraform import aws_route53_resolver_rule_association.example rslvr-rrassoc-97242eaf88example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/route53profiles_association.html.markdown b/website/docs/cdktf/typescript/r/route53profiles_association.html.markdown index 3d3421b807bf..c18dd50d261e 100644 --- a/website/docs/cdktf/typescript/r/route53profiles_association.html.markdown +++ b/website/docs/cdktf/typescript/r/route53profiles_association.html.markdown @@ -61,6 +61,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) Name of the Profile Association. Must match a regex of `(?!^[0-9]+$)([a-zA-Z0-9\\-_' ']+)`. * `profileId` - (Required) ID of the profile associated with the VPC. * `resourceId` - (Required) Resource ID of the VPC the profile to be associated with. @@ -109,10 +110,10 @@ class MyConvertedCode extends TerraformStack { ``` -Using `terraform import`, import Route 53 Profiles Association using the `example_id_arg`. For example: +Using `terraform import`, import Route 53 Profiles Association using the `id`. For example: ```console % terraform import aws_route53profiles_association.example rpa-id-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/route53profiles_profile.html.markdown b/website/docs/cdktf/typescript/r/route53profiles_profile.html.markdown index fb5b1aeeb9bc..49fe3fcd54a1 100644 --- a/website/docs/cdktf/typescript/r/route53profiles_profile.html.markdown +++ b/website/docs/cdktf/typescript/r/route53profiles_profile.html.markdown @@ -43,6 +43,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) Name of the Profile. * `tags` - (Optional) Map of tags to assign to the resource. If configured with a provider [`defaultTags` 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. @@ -69,7 +70,7 @@ This resource exports the following attributes in addition to the arguments abov ## Import -In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import Route 53 Profiles Profile using the `example_id_arg`. For example: +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import Route 53 Profiles Profile using the `id`. For example: ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -93,10 +94,10 @@ class MyConvertedCode extends TerraformStack { ``` -Using `terraform import`, import Route 53 Profiles Profile using the `example`. For example: +Using `terraform import`, import Route 53 Profiles Profile using the `id`. For example: ```console % terraform import aws_route53profiles_profile.example rp-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/route53profiles_resource_association.html.markdown b/website/docs/cdktf/typescript/r/route53profiles_resource_association.html.markdown index 5e00ad174255..c84bd2282851 100644 --- a/website/docs/cdktf/typescript/r/route53profiles_resource_association.html.markdown +++ b/website/docs/cdktf/typescript/r/route53profiles_resource_association.html.markdown @@ -66,6 +66,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) Name of the Profile Resource Association. * `profileId` - (Required) ID of the profile associated with the VPC. * `resourceArn` - (Required) Resource ID of the resource to be associated with the profile. @@ -115,10 +116,10 @@ class MyConvertedCode extends TerraformStack { ``` -Using `terraform import`, import Route 53 Profiles Resource Association using the `example_id_arg`. For example: +Using `terraform import`, import Route 53 Profiles Resource Association using the `id`. For example: ```console % terraform import aws_route53profiles_resource_association.example rpa-id-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/route_table.html.markdown b/website/docs/cdktf/typescript/r/route_table.html.markdown index d25fa477f385..0738480c420f 100644 --- a/website/docs/cdktf/typescript/r/route_table.html.markdown +++ b/website/docs/cdktf/typescript/r/route_table.html.markdown @@ -187,6 +187,7 @@ The target could then be updated again back to `local`. This resource supports the following arguments: +* `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). * `vpcId` - (Required) The VPC ID. * `route` - (Optional) A list of route objects. Their keys are documented below. This argument is processed in [attribute-as-blocks mode](https://www.terraform.io/docs/configuration/attr-as-blocks.html). This means that omitting this argument is interpreted as ignoring any existing routes. To remove all managed routes an empty list should be specified. See the example above. @@ -240,6 +241,32 @@ attribute once the route resource is created. ## Import +In Terraform v1.12.0 and later, the [`import` block](https://developer.hashicorp.com/terraform/language/import) can be used with the `identity` attribute. For example: + +```terraform +import { + to = aws_route_table.example + identity = { + id = "rtb-4e616f6d69" + } +} + +resource "aws_route_table" "example" { + ### Configuration omitted for brevity ### +} +``` + +### Identity Schema + +#### Required + +* `id` - (String) ID of the routing table. + +#### Optional + +- `accountId` (String) AWS Account where this resource is managed. +- `region` (String) Region where this resource is managed. + In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import Route Tables using the route table `id`. For example: ```typescript @@ -266,4 +293,4 @@ Using `terraform import`, import Route Tables using the route table `id`. For ex % terraform import aws_route_table.public_rt rtb-4e616f6d69 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/route_table_association.html.markdown b/website/docs/cdktf/typescript/r/route_table_association.html.markdown index b0f95a4c58bd..7c6985ea4acd 100644 --- a/website/docs/cdktf/typescript/r/route_table_association.html.markdown +++ b/website/docs/cdktf/typescript/r/route_table_association.html.markdown @@ -61,6 +61,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `subnetId` - (Optional) The subnet ID to create an association. Conflicts with `gatewayId`. * `gatewayId` - (Optional) The gateway ID to create an association. Conflicts with `subnetId`. * `routeTableId` - (Required) The ID of the routing table to associate with. @@ -149,4 +150,4 @@ With EC2 Internet Gateways: % terraform import aws_route_table_association.assoc igw-01b3a60780f8d034a/rtb-656c65616e6f72 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/rum_app_monitor.html.markdown b/website/docs/cdktf/typescript/r/rum_app_monitor.html.markdown index 020c870c6ca7..f207d4c427ea 100644 --- a/website/docs/cdktf/typescript/r/rum_app_monitor.html.markdown +++ b/website/docs/cdktf/typescript/r/rum_app_monitor.html.markdown @@ -39,6 +39,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) The name of the log stream. * `appMonitorConfiguration` - (Optional) configuration data for the app monitor. See [app_monitor_configuration](#app_monitor_configuration) below. * `cwLogEnabled` - (Optional) Data collected by RUM is kept by RUM for 30 days and then deleted. This parameter specifies whether RUM sends a copy of this telemetry data to Amazon CloudWatch Logs in your account. This enables you to keep the telemetry data for more than 30 days, but it does incur Amazon CloudWatch Logs charges. Default value is `false`. @@ -48,8 +49,8 @@ This resource supports the following arguments: ### app_monitor_configuration * `allowCookies` - (Optional) If you set this to `true`, RUM web client sets two cookies, a session cookie and a user cookie. The cookies allow the RUM web client to collect data relating to the number of users an application has and the behavior of the application across a sequence of events. Cookies are stored in the top-level domain of the current page. -* `domain` - (Optional) The top-level internet domain name for which your application has administrative authority. Exactly one of `domain` or `domain_list` must be specified. -* `domain_list` - (Optional) A list of internet domain names for which your application has administrative authority. Exactly one of `domain` or `domain_list` must be specified. +* `domain` - (Optional) The top-level internet domain name for which your application has administrative authority. Exactly one of `domain` or `domainList` must be specified. +* `domainList` - (Optional) A list of internet domain names for which your application has administrative authority. Exactly one of `domain` or `domainList` must be specified. * `enableXray` - (Optional) If you set this to `true`, RUM enables X-Ray tracing for the user sessions that RUM samples. RUM adds an X-Ray trace header to allowed HTTP requests. It also records an X-Ray segment for allowed HTTP requests. * `excludedPages` - (Optional) A list of URLs in your website or application to exclude from RUM data collection. * `favoritePages` - (Optional) A list of pages in the CloudWatch RUM console that are to be displayed with a "favorite" icon. @@ -101,4 +102,4 @@ Using `terraform import`, import Cloudwatch RUM App Monitor using the `name`. Fo % terraform import aws_rum_app_monitor.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/rum_metrics_destination.html.markdown b/website/docs/cdktf/typescript/r/rum_metrics_destination.html.markdown index ddafdfe8faa5..88afed1a97b4 100644 --- a/website/docs/cdktf/typescript/r/rum_metrics_destination.html.markdown +++ b/website/docs/cdktf/typescript/r/rum_metrics_destination.html.markdown @@ -39,6 +39,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `appMonitorName` - (Required) The name of the CloudWatch RUM app monitor that will send the metrics. * `destination` - (Required) Defines the destination to send the metrics to. Valid values are `CloudWatch` and `Evidently`. If you specify `Evidently`, you must also specify the ARN of the CloudWatchEvidently experiment that is to be the destination and an IAM role that has permission to write to the experiment. * `destinationArn` - (Optional) Use this parameter only if Destination is Evidently. This parameter specifies the ARN of the Evidently experiment that will receive the extended metrics. @@ -78,4 +79,4 @@ Using `terraform import`, import Cloudwatch RUM Metrics Destination using the `i % terraform import aws_rum_metrics_destination.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/s3_access_point.html.markdown b/website/docs/cdktf/typescript/r/s3_access_point.html.markdown index b5932dc50e90..69dedafdebf9 100644 --- a/website/docs/cdktf/typescript/r/s3_access_point.html.markdown +++ b/website/docs/cdktf/typescript/r/s3_access_point.html.markdown @@ -146,6 +146,8 @@ The following arguments are optional: * `bucketAccountId` - (Optional) AWS account ID associated with the S3 bucket associated with this access point. * `policy` - (Optional) Valid JSON document that specifies the policy that you want to apply to this access point. Removing `policy` from your configuration or setting `policy` to null or an empty string (i.e., `policy = ""`) _will not_ delete the policy since it could have been set by `aws_s3control_access_point_policy`. To remove the `policy`, set it to `"{}"` (an empty JSON document). * `publicAccessBlockConfiguration` - (Optional) Configuration block to manage the `PublicAccessBlock` configuration that you want to apply to this Amazon S3 bucket. You can enable the configuration options in any combination. Detailed below. +* `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). +* `tags` - (Optional) Map of tags to assign to the bucket. If configured with a provider [`defaultTags` 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. * `vpcConfiguration` - (Optional) Configuration block to restrict access to this access point to requests from the specified Virtual Private Cloud (VPC). Required for S3 on Outposts. Detailed below. ### public_access_block_configuration Configuration Block @@ -181,6 +183,7 @@ Note: S3 access points only support secure access by HTTPS. HTTP isn't supported * `hasPublicAccessPolicy` - Indicates whether this access point currently has a policy that allows public access. * `id` - For Access Point of an AWS Partition S3 Bucket, the AWS account ID and access point name separated by a colon (`:`). For S3 on Outposts Bucket, the ARN of the Access Point. * `networkOrigin` - Indicates whether this access point allows access from the public Internet. Values are `VPC` (the access point doesn't allow access from the public Internet) and `Internet` (the access point allows access from the public Internet, subject to the access point and bucket access policies). +* `tagsAll` - Map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). ## Import @@ -248,4 +251,4 @@ Import using the ARN for Access Points associated with an S3 on Outposts Bucket: % terraform import aws_s3_access_point.example arn:aws:s3-outposts:us-east-1:123456789012:outpost/op-1234567890123456/accesspoint/example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/s3_bucket.html.markdown b/website/docs/cdktf/typescript/r/s3_bucket.html.markdown index 2fd3d5c33c3b..705efb1772f5 100644 --- a/website/docs/cdktf/typescript/r/s3_bucket.html.markdown +++ b/website/docs/cdktf/typescript/r/s3_bucket.html.markdown @@ -48,6 +48,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `bucket` - (Optional, Forces new resource) Name of the bucket. If omitted, Terraform will assign a random, unique name. Must be lowercase and less than or equal to 63 characters in length. A full list of bucket naming rules [may be found here](https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html). The name must not be in the format `[bucket_name]--[azid]--x-s3`. Use the [`aws_s3_directory_bucket`](s3_directory_bucket.html) resource to manage S3 Express buckets. * `bucketPrefix` - (Optional, Forces new resource) Creates a unique bucket name beginning with the specified prefix. Conflicts with `bucket`. Must be lowercase and less than or equal to 37 characters in length. A full list of bucket naming rules [may be found here](https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html). * `forceDestroy` - (Optional, Default:`false`) Boolean that indicates all objects (including any [locked objects](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock-overview.html)) should be deleted from the bucket *when the bucket is destroyed* so that the bucket can be destroyed without error. These objects are *not* recoverable. This only deletes objects when the bucket is destroyed, *not* when setting this parameter to `true`. Once this parameter is set to `true`, there must be a successful `terraform apply` run before a destroy is required to update this value in the resource state. Without a successful `terraform apply` after this parameter is set, this flag will have no effect. If setting this field in the same operation that would require replacing the bucket or destroying the bucket, this flag will not work. Additionally when importing a bucket, a successful `terraform apply` is required to set this value in state before it will take effect on a destroy operation. @@ -321,9 +322,9 @@ This resource exports the following attributes in addition to the arguments abov * `id` - Name of the bucket. * `arn` - ARN of the bucket. Will be of format `arn:aws:s3:::bucketname`. * `bucketDomainName` - Bucket domain name. Will be of format `bucketname.s3.amazonaws.com`. +* `bucketRegion` - AWS region this bucket resides in. * `bucketRegionalDomainName` - The bucket region-specific domain name. The bucket domain name including the region name. Please refer to the [S3 endpoints reference](https://docs.aws.amazon.com/general/latest/gr/s3.html#s3_region) for format. Note: AWS CloudFront allows specifying an S3 region-specific endpoint when creating an S3 origin. This will prevent redirect issues from CloudFront to the S3 Origin URL. For more information, see the [Virtual Hosted-Style Requests for Other Regions](https://docs.aws.amazon.com/AmazonS3/latest/userguide/VirtualHosting.html#deprecated-global-endpoint) section in the AWS S3 User Guide. * `hostedZoneId` - [Route 53 Hosted Zone ID](https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_website_region_endpoints) for this bucket's region. -* `region` - AWS region this bucket resides in. * `tagsAll` - Map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). * `websiteEndpoint` - (**Deprecated**) Website endpoint, if the bucket is configured with a website. If not, this will be an empty string. Use the resource [`aws_s3_bucket_website_configuration`](s3_bucket_website_configuration.html.markdown) instead. * `websiteDomain` - (**Deprecated**) Domain of the website endpoint, if the bucket is configured with a website. If not, this will be an empty string. This is used to create Route 53 alias records. Use the resource [`aws_s3_bucket_website_configuration`](s3_bucket_website_configuration.html.markdown) instead. @@ -365,4 +366,4 @@ Using `terraform import`, import S3 bucket using the `bucket`. For example: % terraform import aws_s3_bucket.bucket bucket-name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/s3_bucket_accelerate_configuration.html.markdown b/website/docs/cdktf/typescript/r/s3_bucket_accelerate_configuration.html.markdown index 690ce240b24a..7ddfa440bdbf 100644 --- a/website/docs/cdktf/typescript/r/s3_bucket_accelerate_configuration.html.markdown +++ b/website/docs/cdktf/typescript/r/s3_bucket_accelerate_configuration.html.markdown @@ -45,6 +45,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `bucket` - (Required, Forces new resource) Name of the bucket. * `expectedBucketOwner` - (Optional, Forces new resource) Account ID of the expected bucket owner. * `status` - (Required) Transfer acceleration state of the bucket. Valid values: `Enabled`, `Suspended`. @@ -121,4 +122,4 @@ If the owner (account ID) of the source bucket differs from the account used to % terraform import aws_s3_bucket_accelerate_configuration.example bucket-name,123456789012 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/s3_bucket_acl.html.markdown b/website/docs/cdktf/typescript/r/s3_bucket_acl.html.markdown index 97966f4bc7c7..1563a6ae0a98 100644 --- a/website/docs/cdktf/typescript/r/s3_bucket_acl.html.markdown +++ b/website/docs/cdktf/typescript/r/s3_bucket_acl.html.markdown @@ -193,6 +193,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `acl` - (Optional, either `accessControlPolicy` or `acl` is required) Specifies the Canned ACL to apply to the bucket. Valid values: `private`, `public-read`, `public-read-write`, `aws-exec-read`, `authenticated-read`, `bucket-owner-read`, `bucket-owner-full-control`, `log-delivery-write`. Full details are available on the [AWS documentation](https://docs.aws.amazon.com/AmazonS3/latest/userguide/acl-overview.html#canned-acl). * `accessControlPolicy` - (Optional, either `accessControlPolicy` or `acl` is required) Configuration block that sets the ACL permissions for an object per grantee. [See below](#access_control_policy). * `bucket` - (Required, Forces new resource) Bucket to which to apply the ACL. @@ -358,4 +359,4 @@ If the owner (account ID) of the source bucket _differs_ from the account used t [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/acl-overview.html#canned-acl - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/s3_bucket_analytics_configuration.html.markdown b/website/docs/cdktf/typescript/r/s3_bucket_analytics_configuration.html.markdown index 987f6116b14a..62e6a6848b27 100644 --- a/website/docs/cdktf/typescript/r/s3_bucket_analytics_configuration.html.markdown +++ b/website/docs/cdktf/typescript/r/s3_bucket_analytics_configuration.html.markdown @@ -93,6 +93,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `bucket` - (Required) Name of the bucket this analytics configuration is associated with. * `name` - (Required) Unique identifier of the analytics configuration for the bucket. * `filter` - (Optional) Object filtering that accepts a prefix, tags, or a logical AND of prefix and tags (documented below). @@ -159,4 +160,4 @@ Using `terraform import`, import S3 bucket analytics configurations using `bucke % terraform import aws_s3_bucket_analytics_configuration.my-bucket-entire-bucket my-bucket:EntireBucket ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/s3_bucket_cors_configuration.html.markdown b/website/docs/cdktf/typescript/r/s3_bucket_cors_configuration.html.markdown index 901803d57c85..616953c15338 100644 --- a/website/docs/cdktf/typescript/r/s3_bucket_cors_configuration.html.markdown +++ b/website/docs/cdktf/typescript/r/s3_bucket_cors_configuration.html.markdown @@ -65,6 +65,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `bucket` - (Required, Forces new resource) Name of the bucket. * `expectedBucketOwner` - (Optional, Forces new resource) Account ID of the expected bucket owner. * `corsRule` - (Required) Set of origins and methods (cross-origin access that you want to allow). [See below](#cors_rule). You can configure up to 100 rules. @@ -152,4 +153,4 @@ If the owner (account ID) of the source bucket differs from the account used to % terraform import aws_s3_bucket_cors_configuration.example bucket-name,123456789012 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/s3_bucket_intelligent_tiering_configuration.html.markdown b/website/docs/cdktf/typescript/r/s3_bucket_intelligent_tiering_configuration.html.markdown index ad982f6dd904..ef9eda5bae23 100644 --- a/website/docs/cdktf/typescript/r/s3_bucket_intelligent_tiering_configuration.html.markdown +++ b/website/docs/cdktf/typescript/r/s3_bucket_intelligent_tiering_configuration.html.markdown @@ -98,6 +98,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `bucket` - (Required) Name of the bucket this intelligent tiering configuration is associated with. * `name` - (Required) Unique name used to identify the S3 Intelligent-Tiering configuration for the bucket. * `status` - (Optional) Specifies the status of the configuration. Valid values: `Enabled`, `Disabled`. @@ -150,4 +151,4 @@ Using `terraform import`, import S3 bucket intelligent tiering configurations us % terraform import aws_s3_bucket_intelligent_tiering_configuration.my-bucket-entire-bucket my-bucket:EntireBucket ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/s3_bucket_inventory.html.markdown b/website/docs/cdktf/typescript/r/s3_bucket_inventory.html.markdown index a7f439b769f0..e9edc74e1df8 100644 --- a/website/docs/cdktf/typescript/r/s3_bucket_inventory.html.markdown +++ b/website/docs/cdktf/typescript/r/s3_bucket_inventory.html.markdown @@ -106,6 +106,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `bucket` - (Required) Name of the source bucket that inventory lists the objects for. * `name` - (Required) Unique identifier of the inventory configuration for the bucket. * `includedObjectVersions` - (Required) Object versions to include in the inventory list. Valid values: `All`, `Current`. @@ -180,4 +181,4 @@ Using `terraform import`, import S3 bucket inventory configurations using `bucke % terraform import aws_s3_bucket_inventory.my-bucket-entire-bucket my-bucket:EntireBucket ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/s3_bucket_lifecycle_configuration.html.markdown b/website/docs/cdktf/typescript/r/s3_bucket_lifecycle_configuration.html.markdown index 20957dcd5b1e..d7425ebce823 100644 --- a/website/docs/cdktf/typescript/r/s3_bucket_lifecycle_configuration.html.markdown +++ b/website/docs/cdktf/typescript/r/s3_bucket_lifecycle_configuration.html.markdown @@ -503,6 +503,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `bucket` - (Required) Name of the source S3 bucket you want Amazon S3 to monitor. * `expectedBucketOwner` - (Optional) Account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error. * `rule` - (Required) List of configuration blocks describing the rules managing the replication. [See below](#rule). @@ -675,4 +676,4 @@ If the owner (account ID) of the source bucket differs from the account used to % terraform import aws_s3_bucket_lifecycle_configuration.example bucket-name,123456789012 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/s3_bucket_logging.html.markdown b/website/docs/cdktf/typescript/r/s3_bucket_logging.html.markdown index cf19bcc336e4..21e523034dc4 100644 --- a/website/docs/cdktf/typescript/r/s3_bucket_logging.html.markdown +++ b/website/docs/cdktf/typescript/r/s3_bucket_logging.html.markdown @@ -20,6 +20,83 @@ to decide which method meets your requirements. ## Example Usage +### Grant permission by using bucket policy + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { Token, TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { DataAwsCallerIdentity } from "./.gen/providers/aws/data-aws-caller-identity"; +import { DataAwsIamPolicyDocument } from "./.gen/providers/aws/data-aws-iam-policy-document"; +import { S3Bucket } from "./.gen/providers/aws/s3-bucket"; +import { S3BucketLoggingA } from "./.gen/providers/aws/s3-bucket-logging"; +import { S3BucketPolicy } from "./.gen/providers/aws/s3-bucket-policy"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + const example = new S3Bucket(this, "example", { + bucket: "example-bucket", + }); + const logging = new S3Bucket(this, "logging", { + bucket: "access-logging-bucket", + }); + const awsS3BucketLoggingExample = new S3BucketLoggingA(this, "example_2", { + bucket: example.bucket, + targetBucket: logging.bucket, + targetObjectKeyFormat: { + partitionedPrefix: { + partitionDateSource: "EventTime", + }, + }, + targetPrefix: "log/", + }); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + awsS3BucketLoggingExample.overrideLogicalId("example"); + const current = new DataAwsCallerIdentity(this, "current", {}); + const loggingBucketPolicy = new DataAwsIamPolicyDocument( + this, + "logging_bucket_policy", + { + statement: [ + { + actions: ["s3:PutObject"], + condition: [ + { + test: "StringEquals", + values: [Token.asString(current.accountId)], + variable: "aws:SourceAccount", + }, + ], + principals: [ + { + identifiers: ["logging.s3.amazonaws.com"], + type: "Service", + }, + ], + resources: ["${" + logging.arn + "}/*"], + }, + ], + } + ); + const awsS3BucketPolicyLogging = new S3BucketPolicy(this, "logging_5", { + bucket: logging.bucket, + policy: Token.asString(loggingBucketPolicy.json), + }); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + awsS3BucketPolicyLogging.overrideLogicalId("logging"); + } +} + +``` + +### Grant permission by using bucket ACL + +The [AWS Documentation](https://docs.aws.amazon.com/AmazonS3/latest/userguide/enable-server-access-logging.html) does not recommend using the ACL. + ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug import { Construct } from "constructs"; @@ -66,6 +143,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `bucket` - (Required, Forces new resource) Name of the bucket. * `expectedBucketOwner` - (Optional, Forces new resource) Account ID of the expected bucket owner. * `targetBucket` - (Required) Name of the bucket where you want Amazon S3 to store server access logs. @@ -93,8 +171,8 @@ The `grantee` configuration block supports the following arguments: The `targetObjectKeyFormat` configuration block supports the following arguments: -* `partitionedPrefix` - (Optional) Partitioned S3 key for log objects. [See below](#partitioned_prefix). -* `simplePrefix` - (Optional) Use the simple format for S3 keys for log objects. To use, set `simple_prefix {}`. +* `partitionedPrefix` - (Optional) Partitioned S3 key for log objects, in the form `[target_prefix][SourceAccountId]/[SourceRegion]/[SourceBucket]/[YYYY]/[MM]/[DD]/[YYYY]-[MM]-[DD]-[hh]-[mm]-[ss]-[UniqueString]`. Conflicts with `simplePrefix`. [See below](#partitioned_prefix). +* `simplePrefix` - (Optional) Use the simple format for S3 keys for log objects, in the form `[target_prefix][YYYY]-[MM]-[DD]-[hh]-[mm]-[ss]-[UniqueString]`. To use, set `simple_prefix {}`. Conflicts with `partitionedPrefix`. ### partitioned_prefix @@ -170,4 +248,4 @@ If the owner (account ID) of the source bucket differs from the account used to % terraform import aws_s3_bucket_logging.example bucket-name,123456789012 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/s3_bucket_metadata_configuration.html.markdown b/website/docs/cdktf/typescript/r/s3_bucket_metadata_configuration.html.markdown new file mode 100644 index 000000000000..a9dbed965f85 --- /dev/null +++ b/website/docs/cdktf/typescript/r/s3_bucket_metadata_configuration.html.markdown @@ -0,0 +1,189 @@ +--- +subcategory: "S3 (Simple Storage)" +layout: "aws" +page_title: "AWS: aws_s3_bucket_metadata_configuration" +description: |- + Manages Amazon S3 Metadata for a bucket. +--- + + + +# Resource: aws_s3_bucket_metadata_configuration + +Manages Amazon S3 Metadata for a bucket. + +## Example Usage + +### Basic Usage + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { Token, TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { S3BucketMetadataConfiguration } from "./.gen/providers/aws/s3-bucket-metadata-configuration"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + new S3BucketMetadataConfiguration(this, "example", { + bucket: Token.asString(awsS3BucketExample.bucket), + metadataConfiguration: [ + { + inventoryTableConfiguration: [ + { + configurationState: "ENABLED", + }, + ], + journalTableConfiguration: [ + { + recordExpiration: [ + { + days: 7, + expiration: "ENABLED", + }, + ], + }, + ], + }, + ], + }); + } +} + +``` + +## Argument Reference + +The following arguments are required: + +* `bucket` - (Required) General purpose bucket that you want to create the metadata configuration for. +* `metadataConfiguration` - (Required) Metadata configuration. See [`metadataConfiguration` Block](#metadata_configuration-block) for details. + +The following arguments are optional: + +* `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). + +### `metadataConfiguration` Block + +The `metadataConfiguration` configuration block supports the following arguments: + +* `inventoryTableConfiguration` - (Required) Inventory table configuration. See [`inventoryTableConfiguration` Block](#inventory_table_configuration-block) for details. +* `journalTableConfiguration` - (Required) Journal table configuration. See [`journalTableConfiguration` Block](#journal_table_configuration-block) for details. + +### `inventoryTableConfiguration` Block + +The `inventoryTableConfiguration` configuration block supports the following arguments: + +* `configurationState` - (Required) Configuration state of the inventory table, indicating whether the inventory table is enabled or disabled. Valid values: `ENABLED`, `DISABLED`. +* `encryptionConfiguration` - (Optional) Encryption configuration for the inventory table. See [`encryptionConfiguration` Block](#encryption_configuration-block) for details. + +### `journalTableConfiguration` Block + +The `journalTableConfiguration` configuration block supports the following arguments: + +* `encryptionConfiguration` - (Optional) Encryption configuration for the journal table. See [`encryptionConfiguration` Block](#encryption_configuration-block) for details. +* `recordExpiration` - (Required) Journal table record expiration settings. See [`recordExpiration` Block](#record_expiration-block) for details. + +### `encryptionConfiguration` Block + +The `encryptionConfiguration` configuration block supports the following arguments: + +* `kmsKeyArn` - (Optional) KMS key ARN when `sseAlgorithm` is `aws:kms`. +* `sseAlgorithm` - (Required) Encryption type for the metadata table. Valid values: `aws:kms`, `AES256`. + +### `recordExpiration` Block + +The `recordExpiration` configuration block supports the following arguments: + +* `days` - (Optional) Number of days to retain journal table records. +* `expiration` - (Required) Whether journal table record expiration is enabled or disabled. Valid values: `ENABLED`, `DISABLED`. + +## Attribute Reference + +This resource exports the following attributes in addition to the arguments above: + +* `metadata_configuration.0.destination` - Destination information for the S3 Metadata configuration. + * `tableBucketArn` - ARN of the table bucket where the metadata configuration is stored. + * `table_bucket_type` - Type of the table bucket where the metadata configuration is stored. + * `table_namespace` - Namespace in the table bucket where the metadata tables for the metadata configuration are stored. +* `metadata_configuration.0.inventory_table_configuration.0.table_arn` - Inventory table ARN. +* `metadata_configuration.0.inventory_table_configuration.0.table_name` - Inventory table name. +* `metadata_configuration.0.journal_table_configuration.0.table_arn` - Journal table ARN. +* `metadata_configuration.0.journal_table_configuration.0.table_name` - Journal table name. + +## Timeouts + +[Configuration options](https://developer.hashicorp.com/terraform/language/resources/syntax#operation-timeouts): + +* `create` - (Default `30m`) + +## Import + +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import S3 bucket metadata configuration using the `bucket` or using the `bucket` and `expectedBucketOwner` separated by a comma (`,`). For example: + +If the owner (account ID) of the source bucket is the same account used to configure the Terraform AWS Provider, import using the `bucket`: + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { S3BucketMetadataConfiguration } from "./.gen/providers/aws/s3-bucket-metadata-configuration"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + S3BucketMetadataConfiguration.generateConfigForImport( + this, + "example", + "bucket-name" + ); + } +} + +``` + +If the owner (account ID) of the source bucket differs from the account used to configure the Terraform AWS Provider, import using the `bucket` and `expectedBucketOwner` separated by a comma (`,`): + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { S3BucketMetadataConfiguration } from "./.gen/providers/aws/s3-bucket-metadata-configuration"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + S3BucketMetadataConfiguration.generateConfigForImport( + this, + "example", + "bucket-name,123456789012" + ); + } +} + +``` + +**Using `terraform import` to import** S3 bucket metadata configuration using the `bucket` or using the `bucket` and `expectedBucketOwner` separated by a comma (`,`). For example: + +If the owner (account ID) of the source bucket is the same account used to configure the Terraform AWS Provider, import using the `bucket`: + +```console +% terraform import aws_s3_bucket_metadata_configuration.example bucket-name +``` + +If the owner (account ID) of the source bucket differs from the account used to configure the Terraform AWS Provider, import using the `bucket` and `expectedBucketOwner` separated by a comma (`,`): + +```console +% terraform import aws_s3_bucket_metadata_configuration.example bucket-name,123456789012 +``` + + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/s3_bucket_metric.html.markdown b/website/docs/cdktf/typescript/r/s3_bucket_metric.html.markdown index f60cdb18da17..8cc6cdf5b99a 100644 --- a/website/docs/cdktf/typescript/r/s3_bucket_metric.html.markdown +++ b/website/docs/cdktf/typescript/r/s3_bucket_metric.html.markdown @@ -120,6 +120,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `bucket` - (Required) Name of the bucket to put metric configuration. * `name` - (Required) Unique identifier of the metrics configuration for the bucket. Must be less than or equal to 64 characters in length. * `filter` - (Optional) [Object filtering](http://docs.aws.amazon.com/AmazonS3/latest/dev/metrics-configurations.html#metrics-configurations-filter) that accepts a prefix, tags, or a logical AND of prefix and tags (documented below). @@ -168,4 +169,4 @@ Using `terraform import`, import S3 bucket metric configurations using `bucket:m % terraform import aws_s3_bucket_metric.my-bucket-entire-bucket my-bucket:EntireBucket ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/s3_bucket_notification.html.markdown b/website/docs/cdktf/typescript/r/s3_bucket_notification.html.markdown index 72681113ef72..ca814820baf2 100644 --- a/website/docs/cdktf/typescript/r/s3_bucket_notification.html.markdown +++ b/website/docs/cdktf/typescript/r/s3_bucket_notification.html.markdown @@ -432,6 +432,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `eventbridge` - (Optional) Whether to enable Amazon EventBridge notifications. Defaults to `false`. * `lambdaFunction` - (Optional, Multiple) Used to configure notifications to a Lambda Function. See below. * `queue` - (Optional) Notification configuration to SQS Queue. See below. @@ -497,4 +498,4 @@ Using `terraform import`, import S3 bucket notification using the `bucket`. For % terraform import aws_s3_bucket_notification.bucket_notification bucket-name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/s3_bucket_object.html.markdown b/website/docs/cdktf/typescript/r/s3_bucket_object.html.markdown index d76c7c6e4368..770b7c6801f9 100644 --- a/website/docs/cdktf/typescript/r/s3_bucket_object.html.markdown +++ b/website/docs/cdktf/typescript/r/s3_bucket_object.html.markdown @@ -217,6 +217,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `acl` - (Optional) [Canned ACL](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl) to apply. Valid values are `private`, `public-read`, `public-read-write`, `aws-exec-read`, `authenticated-read`, `bucket-owner-read`, and `bucket-owner-full-control`. Defaults to `private`. * `bucketKeyEnabled` - (Optional) Whether or not to use [Amazon S3 Bucket Keys](https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-key.html) for SSE-KMS. * `cacheControl` - (Optional) Caching behavior along the request/reply chain Read [w3c cache_control](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9) for further details. @@ -321,4 +322,4 @@ Import using S3 URL syntax: % terraform import aws_s3_bucket_object.example s3://some-bucket-name/some/key.txt ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/s3_bucket_object_lock_configuration.html.markdown b/website/docs/cdktf/typescript/r/s3_bucket_object_lock_configuration.html.markdown index 0e93f6154c06..48a8501f848f 100644 --- a/website/docs/cdktf/typescript/r/s3_bucket_object_lock_configuration.html.markdown +++ b/website/docs/cdktf/typescript/r/s3_bucket_object_lock_configuration.html.markdown @@ -70,6 +70,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `bucket` - (Required, Forces new resource) Name of the bucket. * `expectedBucketOwner` - (Optional, Forces new resource) Account ID of the expected bucket owner. * `objectLockEnabled` - (Optional, Forces new resource) Indicates whether this bucket has an Object Lock configuration enabled. Defaults to `Enabled`. Valid values: `Enabled`. @@ -159,4 +160,4 @@ If the owner (account ID) of the source bucket differs from the account used to % terraform import aws_s3_bucket_object_lock_configuration.example bucket-name,123456789012 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/s3_bucket_ownership_controls.html.markdown b/website/docs/cdktf/typescript/r/s3_bucket_ownership_controls.html.markdown index c85d43b0899d..2505c384f0ef 100644 --- a/website/docs/cdktf/typescript/r/s3_bucket_ownership_controls.html.markdown +++ b/website/docs/cdktf/typescript/r/s3_bucket_ownership_controls.html.markdown @@ -51,15 +51,17 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `bucket` - (Required) Name of the bucket that you want to associate this access point with. * `rule` - (Required) Configuration block(s) with Ownership Controls rules. Detailed below. ### rule Configuration Block -The following arguments are required: +This resource supports the following arguments: +* `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). * `objectOwnership` - (Required) Object ownership. Valid values: `BucketOwnerPreferred`, `ObjectWriter` or `BucketOwnerEnforced` * `BucketOwnerPreferred` - Objects uploaded to the bucket change ownership to the bucket owner if the objects are uploaded with the `bucket-owner-full-control` canned ACL. * `ObjectWriter` - Uploading account will own the object if the object is uploaded with the `bucket-owner-full-control` canned ACL. @@ -103,4 +105,4 @@ Using `terraform import`, import S3 Bucket Ownership Controls using S3 Bucket na % terraform import aws_s3_bucket_ownership_controls.example my-bucket ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/s3_bucket_policy.html.markdown b/website/docs/cdktf/typescript/r/s3_bucket_policy.html.markdown index 109ff95ed719..65a57cd9abbb 100644 --- a/website/docs/cdktf/typescript/r/s3_bucket_policy.html.markdown +++ b/website/docs/cdktf/typescript/r/s3_bucket_policy.html.markdown @@ -70,10 +70,13 @@ class MyConvertedCode extends TerraformStack { ``` +-> Only one `aws_s3_bucket_policy` resource should be defined per S3 bucket. Defining multiple `aws_s3_bucket_policy` resources with different Terraform names but the same `bucket` value may result in unexpected policy overwrites. Each resource uses the `PutBucketPolicy` API, which replaces the entire existing policy without error or warning. Because Terraform treats each resource independently, the policy applied last will silently override any previously applied policy. + ## Argument Reference This resource supports the following arguments: +* `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). * `bucket` - (Required) Name of the bucket to which to apply the policy. * `policy` - (Required) Text of the policy. Although this is a bucket policy rather than an IAM policy, the [`aws_iam_policy_document`](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) data source may be used, so long as it specifies a principal. For more information about building AWS IAM policy documents with Terraform, see the [AWS IAM Policy Document Guide](https://learn.hashicorp.com/terraform/aws/iam-policy). Note: Bucket policies are limited to 20 KB in size. @@ -113,4 +116,4 @@ Using `terraform import`, import S3 bucket policies using the bucket name. For e % terraform import aws_s3_bucket_policy.allow_access_from_another_account my-tf-test-bucket ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/s3_bucket_public_access_block.html.markdown b/website/docs/cdktf/typescript/r/s3_bucket_public_access_block.html.markdown index 5000c0a8ec02..91b90b445c1b 100644 --- a/website/docs/cdktf/typescript/r/s3_bucket_public_access_block.html.markdown +++ b/website/docs/cdktf/typescript/r/s3_bucket_public_access_block.html.markdown @@ -14,6 +14,8 @@ Manages S3 bucket-level Public Access Block configuration. For more information -> This resource cannot be used with S3 directory buckets. +~> Setting `skipDestroy` to `true` means that the AWS Provider will not destroy a public access block, even when running `terraform destroy`. The configuration is thus an intentional dangling resource that is not managed by Terraform and will remain in-place in your AWS account. + ## Example Usage ```typescript @@ -54,9 +56,10 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `bucket` - (Required) S3 Bucket to which this Public Access Block configuration should be applied. * `blockPublicAcls` - (Optional) Whether Amazon S3 should block public ACLs for this bucket. Defaults to `false`. Enabling this setting does not affect existing policies or ACLs. When set to `true` causes the following behavior: - * PUT Bucket acl and PUT Object acl calls will fail if the specified ACL allows public access. + * PUT Bucket ACL and PUT Object ACL calls will fail if the specified ACL allows public access. * PUT Object calls will fail if the request includes an object ACL. * `blockPublicPolicy` - (Optional) Whether Amazon S3 should block public bucket policies for this bucket. Defaults to `false`. Enabling this setting does not affect the existing bucket policy. When set to `true` causes Amazon S3 to: * Reject calls to PUT Bucket policy if the specified bucket policy allows public access. @@ -64,6 +67,7 @@ This resource supports the following arguments: * Ignore public ACLs on this bucket and any objects that it contains. * `restrictPublicBuckets` - (Optional) Whether Amazon S3 should restrict public bucket policies for this bucket. Defaults to `false`. Enabling this setting does not affect the previously stored bucket policy, except that public and cross-account access within the public bucket policy, including non-public delegation to specific accounts, is blocked. When set to `true`: * Only the bucket owner and AWS Services can access this buckets if it has a public policy. +* `skipDestroy` - (Optional) Whether to retain the public access block upon destruction. If set to `true`, the resource is simply removed from state instead. This may be desirable in certain scenarios to prevent the removal of a public access block before deletion of the associated bucket. ## Attribute Reference @@ -103,4 +107,4 @@ Using `terraform import`, import `aws_s3_bucket_public_access_block` using the b % terraform import aws_s3_bucket_public_access_block.example my-bucket ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/s3_bucket_replication_configuration.html.markdown b/website/docs/cdktf/typescript/r/s3_bucket_replication_configuration.html.markdown index fdcb80642d7c..0382b38c7221 100644 --- a/website/docs/cdktf/typescript/r/s3_bucket_replication_configuration.html.markdown +++ b/website/docs/cdktf/typescript/r/s3_bucket_replication_configuration.html.markdown @@ -20,6 +20,8 @@ Provides an independent configuration resource for S3 bucket [replication config ### Using replication configuration +#### Terraform AWS Provider v5 (and below) + ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug import { Construct } from "constructs"; @@ -160,9 +162,163 @@ class MyConvertedCode extends TerraformStack { storageClass: "STANDARD", }, filter: { - prefix: "foo", + prefix: "example", + }, + id: "examplerule", + status: "Enabled", + }, + ], + }); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + awsS3BucketReplicationConfigurationReplication.overrideLogicalId( + "replication" + ); + } +} + +``` + +#### Terraform AWS Provider v6 (and above) + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { Token, TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { DataAwsIamPolicyDocument } from "./.gen/providers/aws/data-aws-iam-policy-document"; +import { IamPolicy } from "./.gen/providers/aws/iam-policy"; +import { IamRole } from "./.gen/providers/aws/iam-role"; +import { IamRolePolicyAttachment } from "./.gen/providers/aws/iam-role-policy-attachment"; +import { AwsProvider } from "./.gen/providers/aws/provider"; +import { S3Bucket } from "./.gen/providers/aws/s3-bucket"; +import { S3BucketAcl } from "./.gen/providers/aws/s3-bucket-acl"; +import { S3BucketReplicationConfigurationA } from "./.gen/providers/aws/s3-bucket-replication-configuration"; +import { S3BucketVersioningA } from "./.gen/providers/aws/s3-bucket-versioning"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + new AwsProvider(this, "aws", { + region: "eu-west-1", + }); + const destination = new S3Bucket(this, "destination", { + bucket: "tf-test-bucket-destination-12345", + }); + const source = new S3Bucket(this, "source", { + bucket: "tf-test-bucket-source-12345", + region: "eu-central-1", + }); + new S3BucketAcl(this, "source_bucket_acl", { + acl: "private", + bucket: source.id, + region: "eu-central-1", + }); + const awsS3BucketVersioningDestination = new S3BucketVersioningA( + this, + "destination_4", + { + bucket: destination.id, + versioningConfiguration: { + status: "Enabled", + }, + } + ); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + awsS3BucketVersioningDestination.overrideLogicalId("destination"); + const awsS3BucketVersioningSource = new S3BucketVersioningA( + this, + "source_5", + { + bucket: source.id, + region: "eu-central-1", + versioningConfiguration: { + status: "Enabled", + }, + } + ); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + awsS3BucketVersioningSource.overrideLogicalId("source"); + const assumeRole = new DataAwsIamPolicyDocument(this, "assume_role", { + statement: [ + { + actions: ["sts:AssumeRole"], + effect: "Allow", + principals: [ + { + identifiers: ["s3.amazonaws.com"], + type: "Service", + }, + ], + }, + ], + }); + const replication = new DataAwsIamPolicyDocument(this, "replication", { + statement: [ + { + actions: ["s3:GetReplicationConfiguration", "s3:ListBucket"], + effect: "Allow", + resources: [source.arn], + }, + { + actions: [ + "s3:GetObjectVersionForReplication", + "s3:GetObjectVersionAcl", + "s3:GetObjectVersionTagging", + ], + effect: "Allow", + resources: ["${" + source.arn + "}/*"], + }, + { + actions: [ + "s3:ReplicateObject", + "s3:ReplicateDelete", + "s3:ReplicateTags", + ], + effect: "Allow", + resources: ["${" + destination.arn + "}/*"], + }, + ], + }); + const awsIamPolicyReplication = new IamPolicy(this, "replication_8", { + name: "tf-iam-role-policy-replication-12345", + policy: Token.asString(replication.json), + }); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + awsIamPolicyReplication.overrideLogicalId("replication"); + const awsIamRoleReplication = new IamRole(this, "replication_9", { + assumeRolePolicy: Token.asString(assumeRole.json), + name: "tf-iam-role-replication-12345", + }); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + awsIamRoleReplication.overrideLogicalId("replication"); + const awsIamRolePolicyAttachmentReplication = new IamRolePolicyAttachment( + this, + "replication_10", + { + policyArn: Token.asString(awsIamPolicyReplication.arn), + role: Token.asString(awsIamRoleReplication.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.*/ + awsIamRolePolicyAttachmentReplication.overrideLogicalId("replication"); + const awsS3BucketReplicationConfigurationReplication = + new S3BucketReplicationConfigurationA(this, "replication_11", { + bucket: source.id, + dependsOn: [awsS3BucketVersioningSource], + region: "eu-central-1", + role: Token.asString(awsIamRoleReplication.arn), + rule: [ + { + destination: { + bucket: destination.arn, + storageClass: "STANDARD", + }, + filter: { + prefix: "example", }, - id: "foobar", + id: "examplerule", status: "Enabled", }, ], @@ -262,6 +418,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `bucket` - (Required) Name of the source S3 bucket you want Amazon S3 to monitor. * `role` - (Required) ARN of the IAM role for Amazon S3 to assume when replicating the objects. * `rule` - (Required) List of configuration blocks describing the rules managing the replication. [See below](#rule). @@ -522,4 +679,4 @@ Using `terraform import`, import S3 bucket replication configuration using the ` % terraform import aws_s3_bucket_replication_configuration.replication bucket-name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/s3_bucket_request_payment_configuration.html.markdown b/website/docs/cdktf/typescript/r/s3_bucket_request_payment_configuration.html.markdown index e65a5d014309..ec3dc96d83bb 100644 --- a/website/docs/cdktf/typescript/r/s3_bucket_request_payment_configuration.html.markdown +++ b/website/docs/cdktf/typescript/r/s3_bucket_request_payment_configuration.html.markdown @@ -43,6 +43,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `bucket` - (Required, Forces new resource) Name of the bucket. * `expectedBucketOwner` - (Optional, Forces new resource) Account ID of the expected bucket owner. * `payer` - (Required) Specifies who pays for the download and request fees. Valid values: `BucketOwner`, `Requester`. @@ -119,4 +120,4 @@ If the owner (account ID) of the source bucket differs from the account used to % terraform import aws_s3_bucket_request_payment_configuration.example bucket-name,123456789012 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/s3_bucket_server_side_encryption_configuration.html.markdown b/website/docs/cdktf/typescript/r/s3_bucket_server_side_encryption_configuration.html.markdown index 9511b8c633e1..8f11a4d5ddb6 100644 --- a/website/docs/cdktf/typescript/r/s3_bucket_server_side_encryption_configuration.html.markdown +++ b/website/docs/cdktf/typescript/r/s3_bucket_server_side_encryption_configuration.html.markdown @@ -57,6 +57,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `bucket` - (Required, Forces new resource) ID (name) of the bucket. * `expectedBucketOwner` - (Optional, Forces new resource) Account ID of the expected bucket owner. * `rule` - (Required) Set of server-side encryption configuration rules. [See below](#rule). Currently, only a single rule is supported. @@ -147,4 +148,4 @@ If the owner (account ID) of the source bucket differs from the account used to % terraform import aws_s3_bucket_server_side_encryption_configuration.example bucket-name,123456789012 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/s3_bucket_versioning.html.markdown b/website/docs/cdktf/typescript/r/s3_bucket_versioning.html.markdown index b9278168ba4c..a268c29b5af5 100644 --- a/website/docs/cdktf/typescript/r/s3_bucket_versioning.html.markdown +++ b/website/docs/cdktf/typescript/r/s3_bucket_versioning.html.markdown @@ -147,6 +147,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `bucket` - (Required, Forces new resource) Name of the S3 bucket. * `versioningConfiguration` - (Required) Configuration block for the versioning parameters. [See below](#versioning_configuration). * `expectedBucketOwner` - (Optional, Forces new resource) Account ID of the expected bucket owner. @@ -230,4 +231,4 @@ If the owner (account ID) of the source bucket differs from the account used to % terraform import aws_s3_bucket_versioning.example bucket-name,123456789012 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/s3_bucket_website_configuration.html.markdown b/website/docs/cdktf/typescript/r/s3_bucket_website_configuration.html.markdown index d525a0d3cb43..26422ec5b655 100644 --- a/website/docs/cdktf/typescript/r/s3_bucket_website_configuration.html.markdown +++ b/website/docs/cdktf/typescript/r/s3_bucket_website_configuration.html.markdown @@ -88,6 +88,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `bucket` - (Required, Forces new resource) Name of the bucket. * `errorDocument` - (Optional, Conflicts with `redirectAllRequestsTo`) Name of the error document for the website. [See below](#error_document). * `expectedBucketOwner` - (Optional, Forces new resource) Account ID of the expected bucket owner. @@ -216,4 +217,4 @@ If the owner (account ID) of the source bucket differs from the account used to % terraform import aws_s3_bucket_website_configuration.example bucket-name,123456789012 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/s3_directory_bucket.html.markdown b/website/docs/cdktf/typescript/r/s3_directory_bucket.html.markdown index e55143743af4..662251843aa9 100644 --- a/website/docs/cdktf/typescript/r/s3_directory_bucket.html.markdown +++ b/website/docs/cdktf/typescript/r/s3_directory_bucket.html.markdown @@ -73,10 +73,12 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `bucket` - (Required) Name of the bucket. The name must be in the format `[bucket_name]--[azid]--x-s3`. Use the [`aws_s3_bucket`](s3_bucket.html) resource to manage general purpose buckets. * `dataRedundancy` - (Optional) Data redundancy. Valid values: `SingleAvailabilityZone`, `SingleLocalZone`. The default value depends on the value of the `location.type` attribute. * `forceDestroy` - (Optional, Default:`false`) Boolean that indicates all objects should be deleted from the bucket *when the bucket is destroyed* so that the bucket can be destroyed without error. These objects are *not* recoverable. This only deletes objects when the bucket is destroyed, *not* when setting this parameter to `true`. Once this parameter is set to `true`, there must be a successful `terraform apply` run before a destroy is required to update this value in the resource state. Without a successful `terraform apply` after this parameter is set, this flag will have no effect. If setting this field in the same operation that would require replacing the bucket or destroying the bucket, this flag will not work. Additionally when importing a bucket, a successful `terraform apply` is required to set this value in state before it will take effect on a destroy operation. * `location` - (Required) Bucket location. See [Location](#location) below for more details. +* `tags` - (Optional) Map of tags to assign to the bucket. If configured with a provider [`defaultTags` 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. * `type` - (Optional, Default:`Directory`) Bucket type. Valid values: `Directory`. ### Location @@ -92,6 +94,7 @@ This resource exports the following attributes in addition to the arguments abov * `id` - (**Deprecated**, use `bucket` instead) Name of the bucket. * `arn` - ARN of the bucket. +* `tagsAll` - Map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). ## Import @@ -125,4 +128,4 @@ Using `terraform import`, import S3 bucket using `bucket`. For example: % terraform import aws_s3_directory_bucket.example example--usw2-az1--x-s3 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/s3_object.html.markdown b/website/docs/cdktf/typescript/r/s3_object.html.markdown index 2b81f23ec30c..98937df965d5 100644 --- a/website/docs/cdktf/typescript/r/s3_object.html.markdown +++ b/website/docs/cdktf/typescript/r/s3_object.html.markdown @@ -272,10 +272,11 @@ The following arguments are optional: * `objectLockMode` - (Optional) Object lock [retention mode](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock-overview.html#object-lock-retention-modes) that you want to apply to this object. Valid values are `GOVERNANCE` and `COMPLIANCE`. * `objectLockRetainUntilDate` - (Optional) Date and time, in [RFC3339 format](https://tools.ietf.org/html/rfc3339#section-5.8), when this object's object lock will [expire](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock-overview.html#object-lock-retention-periods). * `overrideProvider` - (Optional) Override provider-level configuration options. See [Override Provider](#override-provider) below for more details. -* `serverSideEncryption` - (Optional) Server-side encryption of the object in S3. Valid values are "`AES256`" and "`aws:kms`". +* `serverSideEncryption` - (Optional) Server-side encryption of the object in S3. Valid values are `"AES256"`, `"aws:kms"`, `"aws:kms:dsse"`, and `"aws:fsx"`. * `sourceHash` - (Optional) Triggers updates like `etag` but useful to address `etag` encryption limitations. Set using `filemd5("path/to/source")` (Terraform 0.11.12 or later). (The value is only stored in state and not saved by AWS.) * `source` - (Optional, conflicts with `content` and `contentBase64`) Path to a file that will be read and uploaded as raw bytes for the object content. * `storageClass` - (Optional) [Storage Class](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html#AmazonS3-PutObject-request-header-StorageClass) for the object. Defaults to "`STANDARD`". +* `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). * `tags` - (Optional) Map of tags to assign to the object. If configured with a provider [`defaultTags` 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. * `websiteRedirect` - (Optional) Target URL for [website redirect](http://docs.aws.amazon.com/AmazonS3/latest/dev/how-to-page-redirect.html). @@ -371,4 +372,4 @@ Import using S3 URL syntax: % terraform import aws_s3_object.example s3://some-bucket-name/some/key.txt ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/s3_object_copy.html.markdown b/website/docs/cdktf/typescript/r/s3_object_copy.html.markdown index 8a1969a48e58..2477836646f2 100644 --- a/website/docs/cdktf/typescript/r/s3_object_copy.html.markdown +++ b/website/docs/cdktf/typescript/r/s3_object_copy.html.markdown @@ -85,6 +85,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `acl` - (Optional) [Canned ACL](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl) to apply. Valid values are `private`, `public-read`, `public-read-write`, `authenticated-read`, `aws-exec-read`, `bucket-owner-read`, and `bucket-owner-full-control`. Conflicts with `grant`. * `cacheControl` - (Optional) Specifies caching behavior along the request/reply chain Read [w3c cache_control](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9) for further details. * `checksumAlgorithm` - (Optional) Indicates the algorithm used to create the checksum for the object. If a value is specified and the object is encrypted with KMS, you must have permission to use the `kms:Decrypt` action. Valid values: `CRC32`, `CRC32C`, `CRC64NVME` `SHA1`, `SHA256`. @@ -162,4 +163,4 @@ This resource exports the following attributes in addition to the arguments abov * `tagsAll` - Map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). * `versionId` - Version ID of the newly created copy. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/s3control_access_grant.html.markdown b/website/docs/cdktf/typescript/r/s3control_access_grant.html.markdown index 2d5e62764d77..9ec8007a10d7 100644 --- a/website/docs/cdktf/typescript/r/s3control_access_grant.html.markdown +++ b/website/docs/cdktf/typescript/r/s3control_access_grant.html.markdown @@ -71,6 +71,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `accessGrantsLocationConfiguration` - (Optional) See [Location Configuration](#location-configuration) below for more details. * `accessGrantsLocationId` - (Required) The ID of the S3 Access Grants location to with the access grant is giving access. * `accountId` - (Optional) The AWS account ID for the S3 Access Grants location. Defaults to automatically determined account ID of the Terraform AWS provider. @@ -133,4 +134,4 @@ Using `terraform import`, import S3 Access Grants using the `accountId` and `acc % terraform import aws_s3control_access_grants_location.example 123456789012,04549c5e-2f3c-4a07-824d-2cafe720aa22 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/s3control_access_grants_instance.html.markdown b/website/docs/cdktf/typescript/r/s3control_access_grants_instance.html.markdown index ac4ff1cf9e44..e84d5f7f0b92 100644 --- a/website/docs/cdktf/typescript/r/s3control_access_grants_instance.html.markdown +++ b/website/docs/cdktf/typescript/r/s3control_access_grants_instance.html.markdown @@ -61,6 +61,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `accountId` - (Optional) The AWS account ID for the S3 Access Grants instance. Defaults to automatically determined account ID of the Terraform AWS provider. * `identityCenterArn` - (Optional) The ARN of the AWS IAM Identity Center instance associated with the S3 Access Grants instance. * `tags` - (Optional) Key-value map of resource tags. If configured with a provider [`defaultTags` 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. @@ -106,4 +107,4 @@ Using `terraform import`, import S3 Access Grants instances using the `accountId % terraform import aws_s3control_access_grants_instance.example 123456789012 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/s3control_access_grants_instance_resource_policy.html.markdown b/website/docs/cdktf/typescript/r/s3control_access_grants_instance_resource_policy.html.markdown index 95d055a76958..be8f6e58e03c 100644 --- a/website/docs/cdktf/typescript/r/s3control_access_grants_instance_resource_policy.html.markdown +++ b/website/docs/cdktf/typescript/r/s3control_access_grants_instance_resource_policy.html.markdown @@ -49,6 +49,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `accountId` - (Optional) The AWS account ID for the S3 Access Grants instance. Defaults to automatically determined account ID of the Terraform AWS provider. * `policy` - (Optional) The policy document. @@ -88,4 +89,4 @@ Using `terraform import`, import S3 Access Grants instance resource policies usi % terraform import aws_s3control_access_grants_instance_resource_policy.example 123456789012 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/s3control_access_grants_location.html.markdown b/website/docs/cdktf/typescript/r/s3control_access_grants_location.html.markdown index 08ee54a1b431..9fe38a36c4c1 100644 --- a/website/docs/cdktf/typescript/r/s3control_access_grants_location.html.markdown +++ b/website/docs/cdktf/typescript/r/s3control_access_grants_location.html.markdown @@ -48,6 +48,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `accountId` - (Optional) The AWS account ID for the S3 Access Grants location. Defaults to automatically determined account ID of the Terraform AWS provider. * `iamRoleArn` - (Required) The ARN of the IAM role that S3 Access Grants should use when fulfilling runtime access requests to the location. @@ -94,4 +95,4 @@ Using `terraform import`, import S3 Access Grants locations using the `accountId % terraform import aws_s3control_access_grants_location.example 123456789012,default ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/s3control_access_point_policy.html.markdown b/website/docs/cdktf/typescript/r/s3control_access_point_policy.html.markdown index 5a2b85b3c50f..25a617448d64 100644 --- a/website/docs/cdktf/typescript/r/s3control_access_point_policy.html.markdown +++ b/website/docs/cdktf/typescript/r/s3control_access_point_policy.html.markdown @@ -81,6 +81,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `accessPointArn` - (Required) The ARN of the access point that you want to associate with the specified policy. * `policy` - (Required) The policy that you want to apply to the specified access point. @@ -123,4 +124,4 @@ Using `terraform import`, import Access Point policies using the `accessPointArn % terraform import aws_s3control_access_point_policy.example arn:aws:s3:us-west-2:123456789012:accesspoint/example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/s3control_bucket.html.markdown b/website/docs/cdktf/typescript/r/s3control_bucket.html.markdown index 2537eb369ea8..ac53bf8a2053 100644 --- a/website/docs/cdktf/typescript/r/s3control_bucket.html.markdown +++ b/website/docs/cdktf/typescript/r/s3control_bucket.html.markdown @@ -41,6 +41,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `bucket` - (Required) Name of the bucket. * `outpostId` - (Required) Identifier of the Outpost to contain this bucket. * `tags` - (Optional) Key-value map of resource tags. If configured with a provider [`defaultTags` 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. @@ -87,4 +88,4 @@ Using `terraform import`, import S3 Control Buckets using Amazon Resource Name ( % terraform import aws_s3control_bucket.example arn:aws:s3-outposts:us-east-1:123456789012:outpost/op-12345678/bucket/example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/s3control_bucket_lifecycle_configuration.html.markdown b/website/docs/cdktf/typescript/r/s3control_bucket_lifecycle_configuration.html.markdown index e0d9d2b93175..4a739260a7f8 100644 --- a/website/docs/cdktf/typescript/r/s3control_bucket_lifecycle_configuration.html.markdown +++ b/website/docs/cdktf/typescript/r/s3control_bucket_lifecycle_configuration.html.markdown @@ -62,6 +62,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `bucket` - (Required) Amazon Resource Name (ARN) of the bucket. * `rule` - (Required) Configuration block(s) containing lifecycle rules for the bucket. * `abortIncompleteMultipartUpload` - (Optional) Configuration block containing settings for abort incomplete multipart upload. @@ -114,4 +115,4 @@ Using `terraform import`, import S3 Control Bucket Lifecycle Configurations usin % terraform import aws_s3control_bucket_lifecycle_configuration.example arn:aws:s3-outposts:us-east-1:123456789012:outpost/op-12345678/bucket/example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/s3control_bucket_policy.html.markdown b/website/docs/cdktf/typescript/r/s3control_bucket_policy.html.markdown index f1d9f1466ba4..66f11de226bb 100644 --- a/website/docs/cdktf/typescript/r/s3control_bucket_policy.html.markdown +++ b/website/docs/cdktf/typescript/r/s3control_bucket_policy.html.markdown @@ -55,8 +55,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `bucket` - (Required) Amazon Resource Name (ARN) of the bucket. * `policy` - (Required) JSON string of the resource policy. For more information about building AWS IAM policy documents with Terraform, see the [AWS IAM Policy Document Guide](https://learn.hashicorp.com/terraform/aws/iam-policy). @@ -98,4 +99,4 @@ Using `terraform import`, import S3 Control Bucket Policies using the Amazon Res % terraform import aws_s3control_bucket_policy.example arn:aws:s3-outposts:us-east-1:123456789012:outpost/op-12345678/bucket/example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/s3control_directory_bucket_access_point_scope.html.markdown b/website/docs/cdktf/typescript/r/s3control_directory_bucket_access_point_scope.html.markdown index cf76b01d59f4..0576963f8f14 100644 --- a/website/docs/cdktf/typescript/r/s3control_directory_bucket_access_point_scope.html.markdown +++ b/website/docs/cdktf/typescript/r/s3control_directory_bucket_access_point_scope.html.markdown @@ -30,15 +30,15 @@ import { Fn, Token, TerraformStack } from "cdktf"; * Provider bindings are generated by running `cdktf get`. * See https://cdk.tf/provider-generation for more details. */ -import { S3ControlDirectoryBucketAccessPointScope } from "./.gen/providers/aws/"; import { DataAwsAvailabilityZones } from "./.gen/providers/aws/data-aws-availability-zones"; import { S3AccessPoint } from "./.gen/providers/aws/s3-access-point"; +import { S3ControlDirectoryBucketAccessPointScope } from "./.gen/providers/aws/s3-control-directory-bucket-access-point-scope"; import { S3DirectoryBucket } from "./.gen/providers/aws/s3-directory-bucket"; class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); new S3ControlDirectoryBucketAccessPointScope(this, "example", { - account_id: "123456789012", + accountId: "123456789012", name: "example--zoneId--xa-s3", scope: [ { @@ -79,8 +79,9 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: -* `name` - (Required) The name of the access point that you want to apply the scope to. * `accountId` - (Required) The AWS account ID that owns the specified access point. +* `name` - (Required) The name of the access point that you want to apply the scope to. +* `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). * `scope` - (Optional). Scope is used to restrict access to specific prefixes, API operations, or a combination of both. To remove the `scope`, set it to `{permissions=[] prefixes=[]}`. The default scope is `{permissions=[] prefixes=[]}`. ### Scope Configuration block @@ -108,7 +109,7 @@ import { TerraformStack } from "cdktf"; * Provider bindings are generated by running `cdktf get`. * See https://cdk.tf/provider-generation for more details. */ -import { S3ControlDirectoryBucketAccessPointScope } from "./.gen/providers/aws/"; +import { S3ControlDirectoryBucketAccessPointScope } from "./.gen/providers/aws/s3-control-directory-bucket-access-point-scope"; class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); @@ -128,4 +129,4 @@ Using `terraform import`, import Access Point Scope using access point name and % terraform import aws_s3control_directory_bucket_access_point_scope.example example--zoneid--xa-s3,123456789012 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/s3control_multi_region_access_point.html.markdown b/website/docs/cdktf/typescript/r/s3control_multi_region_access_point.html.markdown index 685a69a901ce..bbee11ab2e20 100644 --- a/website/docs/cdktf/typescript/r/s3control_multi_region_access_point.html.markdown +++ b/website/docs/cdktf/typescript/r/s3control_multi_region_access_point.html.markdown @@ -70,6 +70,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `accountId` - (Optional) The AWS account ID for the owner of the buckets for which you want to create a Multi-Region Access Point. Defaults to automatically determined account ID of the Terraform AWS provider. * `details` - (Required) A configuration block containing details about the Multi-Region Access Point. See [Details Configuration Block](#details-configuration) below for more details @@ -154,4 +155,4 @@ Using `terraform import`, import Multi-Region Access Points using the `accountId % terraform import aws_s3control_multi_region_access_point.example 123456789012:example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/s3control_multi_region_access_point_policy.html.markdown b/website/docs/cdktf/typescript/r/s3control_multi_region_access_point_policy.html.markdown index c2d388fe6ac9..e13d3579de08 100644 --- a/website/docs/cdktf/typescript/r/s3control_multi_region_access_point_policy.html.markdown +++ b/website/docs/cdktf/typescript/r/s3control_multi_region_access_point_policy.html.markdown @@ -91,6 +91,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `accountId` - (Optional) The AWS account ID for the owner of the Multi-Region Access Point. Defaults to automatically determined account ID of the Terraform AWS provider. * `details` - (Required) A configuration block containing details about the policy for the Multi-Region Access Point. See [Details Configuration Block](#details-configuration) below for more details @@ -150,4 +151,4 @@ Using `terraform import`, import Multi-Region Access Point Policies using the `a % terraform import aws_s3control_multi_region_access_point_policy.example 123456789012:example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/s3control_object_lambda_access_point.html.markdown b/website/docs/cdktf/typescript/r/s3control_object_lambda_access_point.html.markdown index 311d8e911b3f..f2272a78ed3a 100644 --- a/website/docs/cdktf/typescript/r/s3control_object_lambda_access_point.html.markdown +++ b/website/docs/cdktf/typescript/r/s3control_object_lambda_access_point.html.markdown @@ -66,6 +66,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `accountId` - (Optional) The AWS account ID for the owner of the bucket for which you want to create an Object Lambda Access Point. Defaults to automatically determined account ID of the Terraform AWS provider. * `configuration` - (Required) A configuration block containing details about the Object Lambda Access Point. See [Configuration](#configuration) below for more details. * `name` - (Required) The name for this Object Lambda Access Point. @@ -139,4 +140,4 @@ Using `terraform import`, import Object Lambda Access Points using the `accountI % terraform import aws_s3control_object_lambda_access_point.example 123456789012:example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/s3control_object_lambda_access_point_policy.html.markdown b/website/docs/cdktf/typescript/r/s3control_object_lambda_access_point_policy.html.markdown index dcb844e95795..0013ed31621d 100644 --- a/website/docs/cdktf/typescript/r/s3control_object_lambda_access_point_policy.html.markdown +++ b/website/docs/cdktf/typescript/r/s3control_object_lambda_access_point_policy.html.markdown @@ -89,6 +89,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `accountId` - (Optional) The AWS account ID for the account that owns the Object Lambda Access Point. Defaults to automatically determined account ID of the Terraform AWS provider. * `name` - (Required) The name of the Object Lambda Access Point. * `policy` - (Required) The Object Lambda Access Point resource policy document. @@ -132,4 +133,4 @@ Using `terraform import`, import Object Lambda Access Point policies using the ` % terraform import aws_s3control_object_lambda_access_point_policy.example 123456789012:example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/s3control_storage_lens_configuration.html.markdown b/website/docs/cdktf/typescript/r/s3control_storage_lens_configuration.html.markdown index 2f8283eb098b..1bb32d63b0e3 100644 --- a/website/docs/cdktf/typescript/r/s3control_storage_lens_configuration.html.markdown +++ b/website/docs/cdktf/typescript/r/s3control_storage_lens_configuration.html.markdown @@ -71,6 +71,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `accountId` - (Optional) The AWS account ID for the S3 Storage Lens configuration. Defaults to automatically determined account ID of the Terraform AWS provider. * `configId` - (Required) The ID of the S3 Storage Lens configuration. * `storageLensConfiguration` - (Required) The S3 Storage Lens configuration. See [Storage Lens Configuration](#storage-lens-configuration) below for more details. @@ -248,4 +249,4 @@ Using `terraform import`, import S3 Storage Lens configurations using the `accou % terraform import aws_s3control_storage_lens_configuration.example 123456789012:example-1 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/s3outposts_endpoint.html.markdown b/website/docs/cdktf/typescript/r/s3outposts_endpoint.html.markdown index 1a5e718498dc..70d9259d9f2e 100644 --- a/website/docs/cdktf/typescript/r/s3outposts_endpoint.html.markdown +++ b/website/docs/cdktf/typescript/r/s3outposts_endpoint.html.markdown @@ -40,6 +40,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `outpostId` - (Required) Identifier of the Outpost to contain this endpoint. * `securityGroupId` - (Required) Identifier of the EC2 Security Group. * `subnetId` - (Required) Identifier of the EC2 Subnet. @@ -89,4 +90,4 @@ Using `terraform import`, import S3 Outposts Endpoints using Amazon Resource Nam % terraform import aws_s3outposts_endpoint.example arn:aws:s3-outposts:us-east-1:123456789012:outpost/op-12345678/endpoint/0123456789abcdef,sg-12345678,subnet-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/s3tables_namespace.html.markdown b/website/docs/cdktf/typescript/r/s3tables_namespace.html.markdown index 0cb2c46f4e09..ce00ebedadd3 100644 --- a/website/docs/cdktf/typescript/r/s3tables_namespace.html.markdown +++ b/website/docs/cdktf/typescript/r/s3tables_namespace.html.markdown @@ -49,8 +49,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `namespace` - (Required, Forces new resource) Name of the namespace. Must be between 1 and 255 characters in length. Can consist of lowercase letters, numbers, and underscores, and must begin and end with a lowercase letter or number. @@ -96,4 +97,4 @@ Using `terraform import`, import S3 Tables Namespace using the `tableBucketArn` % terraform import aws_s3tables_namespace.example 'arn:aws:s3tables:us-west-2:123456789012:bucket/example-bucket;example-namespace' ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/s3tables_table.html.markdown b/website/docs/cdktf/typescript/r/s3tables_table.html.markdown index 36d7b9ad632e..89af35e1e437 100644 --- a/website/docs/cdktf/typescript/r/s3tables_table.html.markdown +++ b/website/docs/cdktf/typescript/r/s3tables_table.html.markdown @@ -58,6 +58,84 @@ class MyConvertedCode extends TerraformStack { ``` +### With Metadata Schema + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { Token, TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { S3TablesNamespace } from "./.gen/providers/aws/s3-tables-namespace"; +import { S3TablesTable } from "./.gen/providers/aws/s3-tables-table"; +import { S3TablesTableBucket } from "./.gen/providers/aws/s3-tables-table-bucket"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + const example = new S3TablesTableBucket(this, "example", { + name: "example-bucket", + }); + const awsS3TablesNamespaceExample = new S3TablesNamespace( + this, + "example_1", + { + namespace: "example_namespace", + tableBucketArn: 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.*/ + awsS3TablesNamespaceExample.overrideLogicalId("example"); + const awsS3TablesTableExample = new S3TablesTable(this, "example_2", { + format: "ICEBERG", + metadata: [ + { + iceberg: [ + { + schema: [ + { + field: [ + { + name: "id", + required: true, + type: "long", + }, + { + name: "name", + required: true, + type: "string", + }, + { + name: "created_at", + required: false, + type: "timestamp", + }, + { + name: "price", + required: false, + type: "decimal(10,2)", + }, + ], + }, + ], + }, + ], + }, + ], + name: "example_table", + namespace: Token.asString(awsS3TablesNamespaceExample.namespace), + tableBucketArn: Token.asString( + awsS3TablesNamespaceExample.tableBucketArn + ), + }); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + awsS3TablesTableExample.overrideLogicalId("example"); + } +} + +``` + ## Argument Reference The following arguments are required: @@ -75,10 +153,13 @@ The following arguments are required: The following arguments are optional: +* `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). * `encryptionConfiguration` - (Optional) A single table bucket encryption configuration object. [See `encryptionConfiguration` below](#encryption_configuration). * `maintenanceConfiguration` - (Optional) A single table bucket maintenance configuration object. [See `maintenanceConfiguration` below](#maintenance_configuration). +* `metadata` - (Optional) Contains details about the table metadata. This configuration specifies the metadata format and schema for the table. Currently only supports Iceberg format. + [See `metadata` below](#metadata). ### `encryptionConfiguration` @@ -130,6 +211,35 @@ The `iceberg_snapshot_management.settings` object supports the following argumen * `min_snapshots_to_keep` - (Required) Minimum number of snapshots to keep. Must be at least `1`. +### `metadata` + +The `metadata` configuration block supports the following argument: + +* `iceberg` - (Optional) Contains details about the metadata for an Iceberg table. This block defines the schema structure for the Apache Iceberg table format. + [See `iceberg` below](#iceberg). + +### `iceberg` + +The `iceberg` configuration block supports the following argument: + +* `schema` - (Required) Schema configuration for the Iceberg table. + [See `schema` below](#schema). + +### `schema` + +The `schema` configuration block supports the following argument: + +* `field` - (Required) List of schema fields for the Iceberg table. Each field defines a column in the table schema. + [See `field` below](#field). + +### `field` + +The `field` configuration block supports the following arguments: + +* `name` - (Required) The name of the field. +* `type` - (Required) The field type. S3 Tables supports all Apache Iceberg primitive types including: `boolean`, `int`, `long`, `float`, `double`, `decimal(precision,scale)`, `date`, `time`, `timestamp`, `timestamptz`, `string`, `uuid`, `fixed(length)`, `binary`. +* `required` - (Optional) A Boolean value that specifies whether values are required for each row in this field. Defaults to `false`. + ## Attribute Reference This resource exports the following attributes in addition to the arguments above: @@ -178,4 +288,4 @@ Using `terraform import`, import S3 Tables Table using the `tableBucketArn`, the % terraform import aws_s3tables_table.example 'arn:aws:s3tables:us-west-2:123456789012:bucket/example-bucket;example-namespace;example-table' ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/s3tables_table_bucket.html.markdown b/website/docs/cdktf/typescript/r/s3tables_table_bucket.html.markdown index a00a8cd6890b..9cdff4920e4d 100644 --- a/website/docs/cdktf/typescript/r/s3tables_table_bucket.html.markdown +++ b/website/docs/cdktf/typescript/r/s3tables_table_bucket.html.markdown @@ -49,8 +49,10 @@ The following arguments are optional: * `encryptionConfiguration` - (Optional) A single table bucket encryption configuration object. [See `encryptionConfiguration` below](#encryption_configuration). +* `forceDestroy` - (Optional, Default:`false`) Whether all tables and namespaces within the table bucket should be deleted *when the table bucket is destroyed* so that the table bucket can be destroyed without error. These tables and namespaces are *not* recoverable. This only deletes tables and namespaces when the table bucket is destroyed, *not* when setting this parameter to `true`. Once this parameter is set to `true`, there must be a successful `terraform apply` run before a destroy is required to update this value in the resource state. Without a successful `terraform apply` after this parameter is set, this flag will have no effect. If setting this field in the same operation that would require replacing the table bucket or destroying the table bucket, this flag will not work. Additionally when importing a table bucket, a successful `terraform apply` is required to set this value in state before it will take effect on a destroy operation. * `maintenanceConfiguration` - (Optional) A single table bucket maintenance configuration object. [See `maintenanceConfiguration` below](#maintenance_configuration). +* `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). ### `encryptionConfiguration` @@ -124,4 +126,4 @@ Using `terraform import`, import S3 Tables Table Bucket using the `arn`. For exa % terraform import aws_s3tables_table_bucket.example arn:aws:s3tables:us-west-2:123456789012:bucket/example-bucket ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/s3tables_table_bucket_policy.html.markdown b/website/docs/cdktf/typescript/r/s3tables_table_bucket_policy.html.markdown index fed23f56eef8..875afb818705 100644 --- a/website/docs/cdktf/typescript/r/s3tables_table_bucket_policy.html.markdown +++ b/website/docs/cdktf/typescript/r/s3tables_table_bucket_policy.html.markdown @@ -53,8 +53,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `resourcePolicy` - (Required) Amazon Web Services resource-based policy document in JSON format. * `tableBucketArn` - (Required, Forces new resource) ARN referencing the Table Bucket that owns this policy. @@ -94,4 +95,4 @@ Using `terraform import`, import S3 Tables Table Bucket Policy using the `tableB % terraform import aws_s3tables_table_bucket_policy.example 'arn:aws:s3tables:us-west-2:123456789012:bucket/example-bucket;example-namespace' ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/s3tables_table_policy.html.markdown b/website/docs/cdktf/typescript/r/s3tables_table_policy.html.markdown index a41f0c655a45..e294ddec65bc 100644 --- a/website/docs/cdktf/typescript/r/s3tables_table_policy.html.markdown +++ b/website/docs/cdktf/typescript/r/s3tables_table_policy.html.markdown @@ -83,8 +83,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `resourcePolicy` - (Required) Amazon Web Services resource-based policy document in JSON format. * `name` - (Required, Forces new resource) Name of the table. Must be between 1 and 255 characters in length. @@ -130,4 +131,4 @@ Using `terraform import`, import S3 Tables Table Policy using the `tableBucketAr % terraform import aws_s3tables_table_policy.example 'arn:aws:s3tables:us-west-2:123456789012:bucket/example-bucket;example-namespace;example-table' ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/sagemaker_app.html.markdown b/website/docs/cdktf/typescript/r/sagemaker_app.html.markdown index 397120dedb17..e5324737ec86 100644 --- a/website/docs/cdktf/typescript/r/sagemaker_app.html.markdown +++ b/website/docs/cdktf/typescript/r/sagemaker_app.html.markdown @@ -45,6 +45,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `appName` - (Required) The name of the app. * `appType` - (Required) The type of app. Valid values are `JupyterServer`, `KernelGateway`, `RStudioServerPro`, `RSessionGateway`, `TensorBoard`, `CodeEditor`, `JupyterLab`, `DetailedProfiler`, and `Canvas`. * `domainId` - (Required) The domain ID. @@ -101,4 +102,4 @@ Using `terraform import`, import SageMaker AI Apps using the `id`. For example: % terraform import aws_sagemaker_app.example arn:aws:sagemaker:us-west-2:012345678912:app/domain-id/user-profile-name/app-type/app-name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/sagemaker_app_image_config.html.markdown b/website/docs/cdktf/typescript/r/sagemaker_app_image_config.html.markdown index 7e970d39fc6d..3bc854950f4c 100644 --- a/website/docs/cdktf/typescript/r/sagemaker_app_image_config.html.markdown +++ b/website/docs/cdktf/typescript/r/sagemaker_app_image_config.html.markdown @@ -43,6 +43,29 @@ class MyConvertedCode extends TerraformStack { ``` +### Using Code Editor with empty configuration + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { SagemakerAppImageConfig } from "./.gen/providers/aws/sagemaker-app-image-config"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + new SagemakerAppImageConfig(this, "test", { + appImageConfigName: "example", + codeEditorAppImageConfig: {}, + }); + } +} + +``` + ### Default File System Config ```typescript @@ -77,12 +100,15 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `appImageConfigName` - (Required) The name of the App Image Config. -* `codeEditorAppImageConfig` - (Optional) The CodeEditorAppImageConfig. You can only specify one image kernel in the AppImageConfig API. This kernel is shown to users before the image starts. After the image runs, all kernels are visible in Code Editor. See [Code Editor App Image Config](#code-editor-app-image-config) details below. -* `jupyterLabImageConfig` - (Optional) The JupyterLabAppImageConfig. You can only specify one image kernel in the AppImageConfig API. This kernel is shown to users before the image starts. After the image runs, all kernels are visible in JupyterLab. See [Jupyter Lab Image Config](#jupyter-lab-image-config) details below. +* `codeEditorAppImageConfig` - (Optional) The CodeEditorAppImageConfig. See [Code Editor App Image Config](#code-editor-app-image-config) details below. +* `jupyterLabImageConfig` - (Optional) The JupyterLabAppImageConfig. See [Jupyter Lab Image Config](#jupyter-lab-image-config) details below. * `kernelGatewayImageConfig` - (Optional) The configuration for the file system and kernels in a SageMaker AI image running as a KernelGateway app. See [Kernel Gateway Image Config](#kernel-gateway-image-config) details below. * `tags` - (Optional) A map of tags to assign to the resource. If configured with a provider [`defaultTags` 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. +~> **NOTE:** Exactly one of `codeEditorAppImageConfig`, `jupyterLabImageConfig`, or `kernelGatewayImageConfig` must be configured. Empty blocks (e.g., `code_editor_app_image_config {}`) are valid configurations. + ### Code Editor App Image Config * `containerConfig` - (Optional) The configuration used to run the application image container. See [Container Config](#container-config) details below. @@ -153,4 +179,4 @@ Using `terraform import`, import SageMaker AI App Image Configs using the `name` % terraform import aws_sagemaker_app_image_config.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/sagemaker_code_repository.html.markdown b/website/docs/cdktf/typescript/r/sagemaker_code_repository.html.markdown index e842fbd332ee..ef1b988c1985 100644 --- a/website/docs/cdktf/typescript/r/sagemaker_code_repository.html.markdown +++ b/website/docs/cdktf/typescript/r/sagemaker_code_repository.html.markdown @@ -95,6 +95,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `codeRepositoryName` - (Required) The name of the Code Repository (must be unique). * `gitConfig` - (Required) Specifies details about the repository. see [Git Config](#git-config) details below. * `tags` - (Optional) A map of tags to assign to the resource. If configured with a provider [`defaultTags` 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. @@ -145,4 +146,4 @@ Using `terraform import`, import SageMaker AI Code Repositories using the `name` % terraform import aws_sagemaker_code_repository.test_code_repository my-code-repo ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/sagemaker_data_quality_job_definition.html.markdown b/website/docs/cdktf/typescript/r/sagemaker_data_quality_job_definition.html.markdown index 473efd827ca2..266e609ff979 100644 --- a/website/docs/cdktf/typescript/r/sagemaker_data_quality_job_definition.html.markdown +++ b/website/docs/cdktf/typescript/r/sagemaker_data_quality_job_definition.html.markdown @@ -64,6 +64,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `dataQualityAppSpecification` - (Required) Specifies the container that runs the monitoring job. Fields are documented below. * `dataQualityBaselineConfig` - (Optional) Configures the constraints and baselines for the monitoring job. Fields are documented below. * `dataQualityJobInput` - (Required) A list of inputs for the monitoring job. Fields are documented below. @@ -209,4 +210,4 @@ Using `terraform import`, import data quality job definitions using the `name`. % terraform import aws_sagemaker_data_quality_job_definition.test_data_quality_job_definition data-quality-job-definition-foo ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/sagemaker_device.html.markdown b/website/docs/cdktf/typescript/r/sagemaker_device.html.markdown index bb165cb7e0dd..4a2f0d229ed7 100644 --- a/website/docs/cdktf/typescript/r/sagemaker_device.html.markdown +++ b/website/docs/cdktf/typescript/r/sagemaker_device.html.markdown @@ -45,6 +45,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `deviceFleetName` - (Required) The name of the Device Fleet. * `device` - (Required) The device to register with SageMaker AI Edge Manager. See [Device](#device) details below. @@ -93,4 +94,4 @@ Using `terraform import`, import SageMaker AI Devices using the `device-fleet-na % terraform import aws_sagemaker_device.example my-fleet/my-device ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/sagemaker_device_fleet.html.markdown b/website/docs/cdktf/typescript/r/sagemaker_device_fleet.html.markdown index 620fbac8590e..88e978550aba 100644 --- a/website/docs/cdktf/typescript/r/sagemaker_device_fleet.html.markdown +++ b/website/docs/cdktf/typescript/r/sagemaker_device_fleet.html.markdown @@ -44,6 +44,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `deviceFleetName` - (Required) The name of the Device Fleet (must be unique). * `roleArn` - (Required) The Amazon Resource Name (ARN) that has access to AWS Internet of Things (IoT). * `outputConfig` - (Required) Specifies details about the repository. see [Output Config](#output-config) details below. @@ -92,4 +93,4 @@ Using `terraform import`, import SageMaker AI Device Fleets using the `name`. Fo % terraform import aws_sagemaker_device_fleet.example my-fleet ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/sagemaker_domain.html.markdown b/website/docs/cdktf/typescript/r/sagemaker_domain.html.markdown index 6d144505ea79..c147d68e1ffd 100644 --- a/website/docs/cdktf/typescript/r/sagemaker_domain.html.markdown +++ b/website/docs/cdktf/typescript/r/sagemaker_domain.html.markdown @@ -148,6 +148,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `appNetworkAccessType` - (Optional) Specifies the VPC used for non-EFS traffic. The default value is `PublicInternetOnly`. Valid values are `PublicInternetOnly` and `VpcOnly`. * `appSecurityGroupManagement` - (Optional) The entity that creates and manages the required security groups for inter-app communication in `VPCOnly` mode. Valid values are `Service` and `Customer`. * `domainSettings` - (Optional) The domain settings. See [`domainSettings` Block](#domain_settings-block) below. @@ -413,4 +414,4 @@ Using `terraform import`, import SageMaker AI Domains using the `id`. For exampl % terraform import aws_sagemaker_domain.test_domain d-8jgsjtilstu8 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/sagemaker_endpoint.html.markdown b/website/docs/cdktf/typescript/r/sagemaker_endpoint.html.markdown index 9a74680b60d8..ec48625410aa 100644 --- a/website/docs/cdktf/typescript/r/sagemaker_endpoint.html.markdown +++ b/website/docs/cdktf/typescript/r/sagemaker_endpoint.html.markdown @@ -44,6 +44,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `endpointConfigName` - (Required) The name of the endpoint configuration to use. * `deploymentConfig` - (Optional) The deployment configuration for an endpoint, which contains the desired deployment strategy and rollback configurations. See [Deployment Config](#deployment-config). * `name` - (Optional) The name of the endpoint. If omitted, Terraform will assign a random, unique name. @@ -143,4 +144,4 @@ Using `terraform import`, import endpoints using the `name`. For example: % terraform import aws_sagemaker_endpoint.test_endpoint my-endpoint ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/sagemaker_endpoint_configuration.html.markdown b/website/docs/cdktf/typescript/r/sagemaker_endpoint_configuration.html.markdown index 856f5555ef1f..6346921010b8 100644 --- a/website/docs/cdktf/typescript/r/sagemaker_endpoint_configuration.html.markdown +++ b/website/docs/cdktf/typescript/r/sagemaker_endpoint_configuration.html.markdown @@ -51,6 +51,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `productionVariants` - (Required) An list of ProductionVariant objects, one for each model that you want to host at this endpoint. Fields are documented below. * `kmsKeyArn` - (Optional) Amazon Resource Name (ARN) of a AWS Key Management Service key that Amazon SageMaker AI uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint. * `name` - (Optional) The name of the endpoint configuration. If omitted, Terraform will assign a random, unique name. Conflicts with `namePrefix`. @@ -182,4 +183,4 @@ Using `terraform import`, import endpoint configurations using the `name`. For e % terraform import aws_sagemaker_endpoint_configuration.test_endpoint_config endpoint-config-foo ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/sagemaker_feature_group.html.markdown b/website/docs/cdktf/typescript/r/sagemaker_feature_group.html.markdown index 87390070dec0..d45992759ffb 100644 --- a/website/docs/cdktf/typescript/r/sagemaker_feature_group.html.markdown +++ b/website/docs/cdktf/typescript/r/sagemaker_feature_group.html.markdown @@ -52,6 +52,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `featureGroupName` - (Required) The name of the Feature Group. The name must be unique within an AWS Region in an AWS account. * `recordIdentifierFeatureName` - (Required) The name of the Feature whose value uniquely identifies a Record defined in the Feature Store. Only the latest record per identifier value will be stored in the Online Store. * `eventTimeFeatureName` - (Required) The name of the feature that stores the EventTime of a Record in a Feature Group. @@ -142,4 +143,4 @@ Using `terraform import`, import Feature Groups using the `name`. For example: % terraform import aws_sagemaker_feature_group.test_feature_group feature_group-foo ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/sagemaker_flow_definition.html.markdown b/website/docs/cdktf/typescript/r/sagemaker_flow_definition.html.markdown index d4c802e07f62..d3d2298a4a00 100644 --- a/website/docs/cdktf/typescript/r/sagemaker_flow_definition.html.markdown +++ b/website/docs/cdktf/typescript/r/sagemaker_flow_definition.html.markdown @@ -78,7 +78,7 @@ class MyConvertedCode extends TerraformStack { taskTitle: "example", workteamArn: "arn:aws:sagemaker:${" + - current.name + + current.region + "}:394669845002:workteam/public-crowd/default", }, outputConfig: { @@ -139,6 +139,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `flowDefinitionName` - (Required) The name of your flow definition. * `humanLoopConfig` - (Required) An object containing information about the tasks the human reviewers will perform. See [Human Loop Config](#human-loop-config) details below. * `roleArn` - (Required) The Amazon Resource Name (ARN) of the role needed to call other services on your behalf. @@ -222,4 +223,4 @@ Using `terraform import`, import SageMaker AI Flow Definitions using the `flowDe % terraform import aws_sagemaker_flow_definition.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/sagemaker_hub.html.markdown b/website/docs/cdktf/typescript/r/sagemaker_hub.html.markdown index 8d36f1b0b7f2..5ef4c5616724 100644 --- a/website/docs/cdktf/typescript/r/sagemaker_hub.html.markdown +++ b/website/docs/cdktf/typescript/r/sagemaker_hub.html.markdown @@ -41,6 +41,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `hubName` - (Required) The name of the hub. * `hubDescription` - (Required) A description of the hub. * `hubDisplayName` - (Optional) The display name of the hub. @@ -88,4 +89,4 @@ Using `terraform import`, import SageMaker AI Hubs using the `name`. For example % terraform import aws_sagemaker_hub.test_hub my-code-repo ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/sagemaker_human_task_ui.html.markdown b/website/docs/cdktf/typescript/r/sagemaker_human_task_ui.html.markdown index 6babf4eafdca..e329ded08b96 100644 --- a/website/docs/cdktf/typescript/r/sagemaker_human_task_ui.html.markdown +++ b/website/docs/cdktf/typescript/r/sagemaker_human_task_ui.html.markdown @@ -43,6 +43,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `humanTaskUiName` - (Required) The name of the Human Task UI. * `tags` - (Optional) A map of tags to assign to the resource. If configured with a provider [`defaultTags` 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. * `uiTemplate` - (Required) The Liquid template for the worker user interface. See [UI Template](#ui-template) below. @@ -93,4 +94,4 @@ Using `terraform import`, import SageMaker AI Human Task UIs using the `humanTas % terraform import aws_sagemaker_human_task_ui.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/sagemaker_image.html.markdown b/website/docs/cdktf/typescript/r/sagemaker_image.html.markdown index 65a067953fe7..beb3dc89d3bb 100644 --- a/website/docs/cdktf/typescript/r/sagemaker_image.html.markdown +++ b/website/docs/cdktf/typescript/r/sagemaker_image.html.markdown @@ -41,6 +41,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `imageName` - (Required) The name of the image. Must be unique to your account. * `roleArn` - (Required) The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker AI to perform tasks on your behalf. * `displayName` - (Optional) The display name of the image. When the image is added to a domain (must be unique to the domain). @@ -83,4 +84,4 @@ Using `terraform import`, import SageMaker AI Code Images using the `name`. For % terraform import aws_sagemaker_image.test_image my-code-repo ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/sagemaker_image_version.html.markdown b/website/docs/cdktf/typescript/r/sagemaker_image_version.html.markdown index b4ad81a3d90a..2c47e4127d15 100644 --- a/website/docs/cdktf/typescript/r/sagemaker_image_version.html.markdown +++ b/website/docs/cdktf/typescript/r/sagemaker_image_version.html.markdown @@ -16,6 +16,29 @@ Provides a SageMaker AI Image Version resource. ### Basic usage +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { SagemakerImageVersion } from "./.gen/providers/aws/sagemaker-image-version"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + new SagemakerImageVersion(this, "example", { + baseImage: "012345678912.dkr.ecr.us-west-2.amazonaws.com/image:latest", + imageName: test.id, + }); + } +} + +``` + +### With Aliases + ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug import { Construct } from "constructs"; @@ -29,6 +52,7 @@ class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); new SagemakerImageVersion(this, "test", { + aliases: ["latest", "stable"], baseImage: "012345678912.dkr.ecr.us-west-2.amazonaws.com/image:latest", imageName: Token.asString(awsSagemakerImageTest.id), }); @@ -41,28 +65,29 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `imageName` - (Required) The name of the image. Must be unique to your account. * `baseImage` - (Required) The registry path of the container image on which this image version is based. +* `aliases` - (Optional) A list of aliases for the image version. * `horovod` - (Optional) Indicates Horovod compatibility. * `jobType` - (Optional) Indicates SageMaker AI job type compatibility. Valid values are: `TRAINING`, `INFERENCE`, and `NOTEBOOK_KERNEL`. -* `ml_framework` - (Optional) The machine learning framework vended in the image version. +* `mlFramework` - (Optional) The machine learning framework vended in the image version. * `processor` - (Optional) Indicates CPU or GPU compatibility. Valid values are: `CPU` and `GPU`. -* `programming_lang` - (Optional) The supported programming language and its version. -* `release_notes` - (Optional) The maintainer description of the image version. -* `vendor_guidance` - (Optional) The stability of the image version, specified by the maintainer. Valid values are: `NOT_PROVIDED`, `STABLE`, `TO_BE_ARCHIVED`, and `ARCHIVED`. +* `programmingLang` - (Optional) The supported programming language and its version. +* `releaseNotes` - (Optional) The maintainer description of the image version. +* `vendorGuidance` - (Optional) The stability of the image version, specified by the maintainer. Valid values are: `NOT_PROVIDED`, `STABLE`, `TO_BE_ARCHIVED`, and `ARCHIVED`. ## Attribute Reference This resource exports the following attributes in addition to the arguments above: -* `id` - The name of the Image. * `arn` - The Amazon Resource Name (ARN) assigned by AWS to this Image Version. * `version`- The version of the image. If not specified, the latest version is described. * `containerImage` - The registry path of the container image that contains this image version. ## Import -In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import SageMaker AI Image Versions using the `name`. For example: +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import SageMaker AI Image Versions using a comma-delimited string concatenating `imageName` and `version`. For example: ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -78,18 +103,18 @@ class MyConvertedCode extends TerraformStack { super(scope, name); SagemakerImageVersion.generateConfigForImport( this, - "testImage", - "my-code-repo" + "example", + "example-name,1" ); } } ``` -Using `terraform import`, import SageMaker AI Image Versions using the `name`. For example: +Using `terraform import`, import SageMaker AI Image Versions using a comma-delimited string concatenating `imageName` and `version`. For example: ```console -% terraform import aws_sagemaker_image_version.test_image my-code-repo +% terraform import aws_sagemaker_image_version.example example-name,1 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/sagemaker_mlflow_tracking_server.html.markdown b/website/docs/cdktf/typescript/r/sagemaker_mlflow_tracking_server.html.markdown index d278afb0fb4d..d76e69f35634 100644 --- a/website/docs/cdktf/typescript/r/sagemaker_mlflow_tracking_server.html.markdown +++ b/website/docs/cdktf/typescript/r/sagemaker_mlflow_tracking_server.html.markdown @@ -42,6 +42,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `artifactStoreUri` - (Required) The S3 URI for a general purpose bucket to use as the MLflow Tracking Server artifact store. * `roleArn` - (Required) The Amazon Resource Name (ARN) for an IAM role in your account that the MLflow Tracking Server uses to access the artifact store in Amazon S3. The role should have AmazonS3FullAccess permissions. For more information on IAM permissions for tracking server creation, see [Set up IAM permissions for MLflow](https://docs.aws.amazon.com/sagemaker/latest/dg/mlflow-create-tracking-server-iam.html). * `trackingServerName` - (Required) A unique string identifying the tracking server name. This string is part of the tracking server ARN. @@ -92,4 +93,4 @@ Using `terraform import`, import SageMaker AI MLFlow Tracking Servers using the % terraform import aws_sagemaker_mlflow_tracking_server.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/sagemaker_model.html.markdown b/website/docs/cdktf/typescript/r/sagemaker_model.html.markdown index d2aab574588a..93cf3770faec 100644 --- a/website/docs/cdktf/typescript/r/sagemaker_model.html.markdown +++ b/website/docs/cdktf/typescript/r/sagemaker_model.html.markdown @@ -68,6 +68,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Optional) The name of the model (must be unique). If omitted, Terraform will assign a random, unique name. * `primaryContainer` - (Optional) The primary docker image containing inference code that is used when the model is deployed for predictions. If not specified, the `container` argument is required. Fields are documented below. * `executionRoleArn` - (Required) A role that SageMaker AI can assume to access model artifacts and docker images for deployment. @@ -159,4 +160,4 @@ Using `terraform import`, import models using the `name`. For example: % terraform import aws_sagemaker_model.test_model model-foo ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/sagemaker_model_package_group.html.markdown b/website/docs/cdktf/typescript/r/sagemaker_model_package_group.html.markdown index 52e26204e966..a4e3e9a0c0d7 100644 --- a/website/docs/cdktf/typescript/r/sagemaker_model_package_group.html.markdown +++ b/website/docs/cdktf/typescript/r/sagemaker_model_package_group.html.markdown @@ -40,6 +40,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `modelPackageGroupName` - (Required) The name of the model group. * `modelPackageGroupDescription` - (Optional) A description for the model group. * `tags` - (Optional) A map of tags to assign to the resource. If configured with a provider [`defaultTags` 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. @@ -84,4 +85,4 @@ Using `terraform import`, import SageMaker AI Model Package Groups using the `na % terraform import aws_sagemaker_model_package_group.test_model_package_group my-code-repo ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/sagemaker_model_package_group_policy.html.markdown b/website/docs/cdktf/typescript/r/sagemaker_model_package_group_policy.html.markdown index 614fe106280c..61432239fc2d 100644 --- a/website/docs/cdktf/typescript/r/sagemaker_model_package_group_policy.html.markdown +++ b/website/docs/cdktf/typescript/r/sagemaker_model_package_group_policy.html.markdown @@ -79,6 +79,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `modelPackageGroupName` - (Required) The name of the model package group. ## Attribute Reference @@ -119,4 +120,4 @@ Using `terraform import`, import SageMaker AI Model Package Groups using the `na % terraform import aws_sagemaker_model_package_group_policy.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/sagemaker_monitoring_schedule.html.markdown b/website/docs/cdktf/typescript/r/sagemaker_monitoring_schedule.html.markdown index b594823fc060..f31013dd0829 100644 --- a/website/docs/cdktf/typescript/r/sagemaker_monitoring_schedule.html.markdown +++ b/website/docs/cdktf/typescript/r/sagemaker_monitoring_schedule.html.markdown @@ -46,6 +46,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `monitoringScheduleConfig` - (Required) The configuration object that specifies the monitoring schedule and defines the monitoring job. Fields are documented below. * `name` - (Optional) The name of the monitoring schedule. The name must be unique within an AWS Region within an AWS account. If omitted, Terraform will assign a random, unique name. * `tags` - (Optional) A mapping of tags to assign to the resource. If configured with a provider [`defaultTags` 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. @@ -100,4 +101,4 @@ Using `terraform import`, import monitoring schedules using the `name`. For exam % terraform import aws_sagemaker_monitoring_schedule.test_monitoring_schedule monitoring-schedule-foo ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/sagemaker_notebook_instance.html.markdown b/website/docs/cdktf/typescript/r/sagemaker_notebook_instance.html.markdown index 258c93865da6..af8327f72a40 100644 --- a/website/docs/cdktf/typescript/r/sagemaker_notebook_instance.html.markdown +++ b/website/docs/cdktf/typescript/r/sagemaker_notebook_instance.html.markdown @@ -81,6 +81,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) The name of the notebook instance (must be unique). * `roleArn` - (Required) The ARN of the IAM role to be used by the notebook instance which allows SageMaker AI to call other services on your behalf. * `instanceType` - (Required) The name of ML compute instance type. @@ -88,7 +89,6 @@ This resource supports the following arguments: * `volumeSize` - (Optional) The size, in GB, of the ML storage volume to attach to the notebook instance. The default value is 5 GB. * `subnetId` - (Optional) The VPC subnet ID. * `securityGroups` - (Optional) The associated security groups. -* `acceleratorTypes` - (Optional, Deprecated) A list of Elastic Inference (EI) instance types to associate with this notebook instance. See [Elastic Inference Accelerator](https://docs.aws.amazon.com/sagemaker/latest/dg/ei.html) for more details. Valid values: `ml.eia1.medium`, `ml.eia1.large`, `ml.eia1.xlarge`, `ml.eia2.medium`, `ml.eia2.large`, `ml.eia2.xlarge`. * `additionalCodeRepositories` - (Optional) An array of up to three Git repositories to associate with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in [AWS CodeCommit](https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html) or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. * `defaultCodeRepository` - (Optional) The Git repository associated with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in [AWS CodeCommit](https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html) or in any other Git repository. @@ -145,4 +145,4 @@ Using `terraform import`, import SageMaker AI Notebook Instances using the `name % terraform import aws_sagemaker_notebook_instance.test_notebook_instance my-notebook-instance ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/sagemaker_notebook_instance_lifecycle_configuration.html.markdown b/website/docs/cdktf/typescript/r/sagemaker_notebook_instance_lifecycle_configuration.html.markdown index 37f68ac76da3..9971d807a9a3 100644 --- a/website/docs/cdktf/typescript/r/sagemaker_notebook_instance_lifecycle_configuration.html.markdown +++ b/website/docs/cdktf/typescript/r/sagemaker_notebook_instance_lifecycle_configuration.html.markdown @@ -42,6 +42,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Optional) The name of the lifecycle configuration (must be unique). If omitted, Terraform will assign a random, unique name. * `onCreate` - (Optional) A shell script (base64-encoded) that runs only once when the SageMaker AI Notebook Instance is created. * `onStart` - (Optional) A shell script (base64-encoded) that runs every time the SageMaker AI Notebook Instance is started including the time it's created. @@ -86,4 +87,4 @@ Using `terraform import`, import models using the `name`. For example: % terraform import aws_sagemaker_notebook_instance_lifecycle_configuration.lc foo ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/sagemaker_pipeline.html.markdown b/website/docs/cdktf/typescript/r/sagemaker_pipeline.html.markdown index f5f462dfc82d..fa3b41fb3bd0 100644 --- a/website/docs/cdktf/typescript/r/sagemaker_pipeline.html.markdown +++ b/website/docs/cdktf/typescript/r/sagemaker_pipeline.html.markdown @@ -56,6 +56,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `pipelineName` - (Required) The name of the pipeline. * `pipelineDescription` - (Optional) A description of the pipeline. * `pipelineDisplayName` - (Required) The display name of the pipeline. @@ -111,4 +112,4 @@ Using `terraform import`, import pipelines using the `pipelineName`. For example % terraform import aws_sagemaker_pipeline.test_pipeline pipeline ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/sagemaker_project.html.markdown b/website/docs/cdktf/typescript/r/sagemaker_project.html.markdown index 2bfbc8eb7d79..7109c211b832 100644 --- a/website/docs/cdktf/typescript/r/sagemaker_project.html.markdown +++ b/website/docs/cdktf/typescript/r/sagemaker_project.html.markdown @@ -43,6 +43,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `projectName` - (Required) The name of the Project. * `projectDescription` - (Optional) A description for the project. * `serviceCatalogProvisioningDetails` - (Required) The product ID and provisioning artifact ID to provision a service catalog. See [Service Catalog Provisioning Details](#service-catalog-provisioning-details) below. @@ -97,4 +98,4 @@ Using `terraform import`, import SageMaker AI Projects using the `projectName`. % terraform import aws_sagemaker_project.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/sagemaker_servicecatalog_portfolio_status.html.markdown b/website/docs/cdktf/typescript/r/sagemaker_servicecatalog_portfolio_status.html.markdown index 9108e90d82d2..1091fe2fa937 100644 --- a/website/docs/cdktf/typescript/r/sagemaker_servicecatalog_portfolio_status.html.markdown +++ b/website/docs/cdktf/typescript/r/sagemaker_servicecatalog_portfolio_status.html.markdown @@ -40,6 +40,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `status` - (Required) Whether Service Catalog is enabled or disabled in SageMaker. Valid values are `Enabled` and `Disabled`. ## Attribute Reference @@ -80,4 +81,4 @@ Using `terraform import`, import models using the `id`. For example: % terraform import aws_sagemaker_servicecatalog_portfolio_status.example us-east-1 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/sagemaker_space.html.markdown b/website/docs/cdktf/typescript/r/sagemaker_space.html.markdown index 2a8878f0140b..552a46c3ad2d 100644 --- a/website/docs/cdktf/typescript/r/sagemaker_space.html.markdown +++ b/website/docs/cdktf/typescript/r/sagemaker_space.html.markdown @@ -41,6 +41,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `domainId` - (Required) The ID of the associated Domain. * `ownershipSettings` - (Optional) A collection of ownership settings. Required if `spaceSharingSettings` is set. See [`ownershipSettings` Block](#ownership_settings-block) below. * `spaceDisplayName` - (Optional) The name of the space that appears in the SageMaker AI Studio UI. @@ -206,4 +207,4 @@ Using `terraform import`, import SageMaker AI Spaces using the `id`. For example % terraform import aws_sagemaker_space.test_space arn:aws:sagemaker:us-west-2:123456789012:space/domain-id/space-name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/sagemaker_studio_lifecycle_config.html.markdown b/website/docs/cdktf/typescript/r/sagemaker_studio_lifecycle_config.html.markdown index 4bad4addef6f..8d1b412a965b 100644 --- a/website/docs/cdktf/typescript/r/sagemaker_studio_lifecycle_config.html.markdown +++ b/website/docs/cdktf/typescript/r/sagemaker_studio_lifecycle_config.html.markdown @@ -44,6 +44,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +- `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). - `studioLifecycleConfigName` - (Required) The name of the Studio Lifecycle Configuration to create. - `studioLifecycleConfigAppType` - (Required) The App type that the Lifecycle Configuration is attached to. Valid values are `JupyterServer`, `JupyterLab`, `CodeEditor` and `KernelGateway`. - `studioLifecycleConfigContent` - (Required) The content of your Studio Lifecycle Configuration script. This content must be base64 encoded. @@ -89,4 +90,4 @@ Using `terraform import`, import SageMaker AI Studio Lifecycle Configs using the % terraform import aws_sagemaker_studio_lifecycle_config.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/sagemaker_user_profile.html.markdown b/website/docs/cdktf/typescript/r/sagemaker_user_profile.html.markdown index c76ab135a2bd..5c09445494fd 100644 --- a/website/docs/cdktf/typescript/r/sagemaker_user_profile.html.markdown +++ b/website/docs/cdktf/typescript/r/sagemaker_user_profile.html.markdown @@ -41,6 +41,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `domainId` - (Required) The ID of the associated Domain. * `singleSignOnUserIdentifier` - (Optional) A specifier for the type of value specified in `singleSignOnUserValue`. Currently, the only supported value is `UserName`. If the Domain's AuthMode is SSO, this field is required. If the Domain's AuthMode is not SSO, this field cannot be specified. * `singleSignOnUserValue` - (Required) The username of the associated AWS Single Sign-On User for this User Profile. If the Domain's AuthMode is SSO, this field is required, and must match a valid username of a user in your directory. If the Domain's AuthMode is not SSO, this field cannot be specified. @@ -239,7 +240,6 @@ This resource supports the following arguments: This resource exports the following attributes in addition to the arguments above: -* `id` - The user profile Amazon Resource Name (ARN). * `arn` - The user profile Amazon Resource Name (ARN). * `homeEfsFileSystemUid` - The ID of the user's profile in the Amazon Elastic File System (EFS) volume. * `tagsAll` - A map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). @@ -276,4 +276,4 @@ Using `terraform import`, import SageMaker AI User Profiles using the `arn`. For % terraform import aws_sagemaker_user_profile.test_user_profile arn:aws:sagemaker:us-west-2:123456789012:user-profile/domain-id/profile-name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/sagemaker_workforce.html.markdown b/website/docs/cdktf/typescript/r/sagemaker_workforce.html.markdown index cfd32bc055dd..b7e08a32f03d 100644 --- a/website/docs/cdktf/typescript/r/sagemaker_workforce.html.markdown +++ b/website/docs/cdktf/typescript/r/sagemaker_workforce.html.markdown @@ -109,6 +109,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `workforceName` - (Required) The name of the Workforce (must be unique). * `cognitoConfig` - (Optional) Use this parameter to configure an Amazon Cognito private workforce. A single Cognito workforce is created using and corresponds to a single Amazon Cognito user pool. Conflicts with `oidcConfig`. see [Cognito Config](#cognito-config) details below. * `oidcConfig` - (Optional) Use this parameter to configure a private workforce using your own OIDC Identity Provider. Conflicts with `cognitoConfig`. see [OIDC Config](#oidc-config) details below. @@ -180,4 +181,4 @@ Using `terraform import`, import SageMaker AI Workforces using the `workforceNam % terraform import aws_sagemaker_workforce.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/sagemaker_workteam.html.markdown b/website/docs/cdktf/typescript/r/sagemaker_workteam.html.markdown index b77d5fcd2f85..29747f032619 100644 --- a/website/docs/cdktf/typescript/r/sagemaker_workteam.html.markdown +++ b/website/docs/cdktf/typescript/r/sagemaker_workteam.html.markdown @@ -84,6 +84,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `description` - (Required) A description of the work team. * `workforceName` - (Optional) The name of the workforce. * `workteamName` - (Required) The name of the Workteam (must be unique). @@ -161,4 +162,4 @@ Using `terraform import`, import SageMaker AI Workteams using the `workteamName` % terraform import aws_sagemaker_workteam.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/scheduler_schedule.html.markdown b/website/docs/cdktf/typescript/r/scheduler_schedule.html.markdown index 436020ac31f5..6aa04da3fa14 100644 --- a/website/docs/cdktf/typescript/r/scheduler_schedule.html.markdown +++ b/website/docs/cdktf/typescript/r/scheduler_schedule.html.markdown @@ -103,6 +103,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `description` - (Optional) Brief description of the schedule. * `endDate` - (Optional) The date, in UTC, before which the schedule can invoke its target. Depending on the schedule's recurrence expression, invocations might stop on, or before, the end date you specify. EventBridge Scheduler ignores the end date for one-time schedules. Example: `2030-01-01T01:00:00Z`. * `groupName` - (Optional, Forces new resource) Name of the schedule group to associate with this schedule. When omitted, the `default` schedule group is used. @@ -127,6 +128,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `deadLetterConfig` - (Optional) Information about an Amazon SQS queue that EventBridge Scheduler uses as a dead-letter queue for your schedule. If specified, EventBridge Scheduler delivers failed events that could not be successfully delivered to a target to the queue. Detailed below. * `ecsParameters` - (Optional) Templated target type for the Amazon ECS [`RunTask`](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html) API operation. Detailed below. * `eventbridgeParameters` - (Optional) Templated target type for the EventBridge [`PutEvents`](https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_PutEvents.html) API operation. Detailed below. @@ -148,6 +150,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `capacityProviderStrategy` - (Optional) Up to `6` capacity provider strategies to use for the task. Detailed below. * `enableEcsManagedTags` - (Optional) Specifies whether to enable Amazon ECS managed tags for the task. For more information, see [Tagging Your Amazon ECS Resources](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html) in the Amazon ECS Developer Guide. * `enableExecuteCommand` - (Optional) Specifies whether to enable the execute command functionality for the containers in this task. @@ -250,4 +253,4 @@ Using `terraform import`, import schedules using the combination `group_name/nam % terraform import aws_scheduler_schedule.example my-schedule-group/my-schedule ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/scheduler_schedule_group.html.markdown b/website/docs/cdktf/typescript/r/scheduler_schedule_group.html.markdown index 1af58c98b8c7..fd345ede33c2 100644 --- a/website/docs/cdktf/typescript/r/scheduler_schedule_group.html.markdown +++ b/website/docs/cdktf/typescript/r/scheduler_schedule_group.html.markdown @@ -42,6 +42,7 @@ class MyConvertedCode extends TerraformStack { The following arguments are optional: +* `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). * `name` - (Optional, Forces new resource) Name of the schedule group. If omitted, Terraform will assign a random, unique name. Conflicts with `namePrefix`. * `namePrefix` - (Optional, Forces new resource) Creates a unique name beginning with the specified prefix. Conflicts with `name`. * `tags` - (Optional) Key-value mapping of resource tags. If configured with a provider [`defaultTags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. @@ -96,4 +97,4 @@ Using `terraform import`, import schedule groups using the `name`. For example: % terraform import aws_scheduler_schedule_group.example my-schedule-group ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/schemas_discoverer.html.markdown b/website/docs/cdktf/typescript/r/schemas_discoverer.html.markdown index 95282c8b84b1..8ae96bcc5a66 100644 --- a/website/docs/cdktf/typescript/r/schemas_discoverer.html.markdown +++ b/website/docs/cdktf/typescript/r/schemas_discoverer.html.markdown @@ -45,6 +45,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `sourceArn` - (Required) The ARN of the event bus to discover event schemas on. * `description` - (Optional) The description of the discoverer. Maximum of 256 characters. * `tags` - (Optional) A map of tags to assign to the resource. If configured with a provider [`defaultTags` 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. @@ -85,4 +86,4 @@ Using `terraform import`, import EventBridge discoverers using the `id`. For exa % terraform import aws_schemas_discoverer.test 123 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/schemas_registry.html.markdown b/website/docs/cdktf/typescript/r/schemas_registry.html.markdown index 923609c64e33..0697576110d8 100644 --- a/website/docs/cdktf/typescript/r/schemas_registry.html.markdown +++ b/website/docs/cdktf/typescript/r/schemas_registry.html.markdown @@ -41,6 +41,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) The name of the custom event schema registry. Maximum of 64 characters consisting of lower case letters, upper case letters, 0-9, ., -, _. * `description` - (Optional) The description of the discoverer. Maximum of 256 characters. * `tags` - (Optional) A map of tags to assign to the resource. If configured with a provider [`defaultTags` 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. @@ -80,4 +81,4 @@ Using `terraform import`, import EventBridge schema registries using the `name`. % terraform import aws_schemas_registry.test my_own_registry ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/schemas_registry_policy.html.markdown b/website/docs/cdktf/typescript/r/schemas_registry_policy.html.markdown index 5ba98c36b6c7..c962fcc33f87 100644 --- a/website/docs/cdktf/typescript/r/schemas_registry_policy.html.markdown +++ b/website/docs/cdktf/typescript/r/schemas_registry_policy.html.markdown @@ -65,8 +65,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `registryName` - (Required) Name of EventBridge Schema Registry * `policy` - (Required) Resource Policy for EventBridge Schema Registry @@ -110,4 +111,4 @@ Using `terraform import`, import EventBridge Schema Registry Policy using the `r % terraform import aws_schemas_registry_policy.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/schemas_schema.html.markdown b/website/docs/cdktf/typescript/r/schemas_schema.html.markdown index 14b25d2cbfb5..dc6f2eed9ff4 100644 --- a/website/docs/cdktf/typescript/r/schemas_schema.html.markdown +++ b/website/docs/cdktf/typescript/r/schemas_schema.html.markdown @@ -71,6 +71,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) The name of the schema. Maximum of 385 characters consisting of lower case letters, upper case letters, ., -, _, @. * `content` - (Required) The schema specification. Must be a valid Open API 3.0 spec. * `registryName` - (Required) The name of the registry in which this schema belongs. @@ -116,4 +117,4 @@ Using `terraform import`, import EventBridge schema using the `name` and `regist % terraform import aws_schemas_schema.test name/registry ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/secretsmanager_secret.html.markdown b/website/docs/cdktf/typescript/r/secretsmanager_secret.html.markdown index 62c2b2c025b4..82777db57af3 100644 --- a/website/docs/cdktf/typescript/r/secretsmanager_secret.html.markdown +++ b/website/docs/cdktf/typescript/r/secretsmanager_secret.html.markdown @@ -40,6 +40,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `description` - (Optional) Description of the secret. * `kmsKeyId` - (Optional) ARN or Id of the AWS KMS key to be used to encrypt the secret values in the versions stored in this secret. If you need to reference a CMK in a different account, you can use only the key ARN. If you don't specify this value, then Secrets Manager defaults to using the AWS account's default KMS key (the one named `aws/secretsmanager`). If the default KMS key with that name doesn't yet exist, then AWS Secrets Manager creates it for you automatically the first time. * `namePrefix` - (Optional) Creates a unique name beginning with the specified prefix. Conflicts with `name`. @@ -102,4 +103,4 @@ Using `terraform import`, import `aws_secretsmanager_secret` using the secret Am % terraform import aws_secretsmanager_secret.example arn:aws:secretsmanager:us-east-1:123456789012:secret:example-123456 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/secretsmanager_secret_policy.html.markdown b/website/docs/cdktf/typescript/r/secretsmanager_secret_policy.html.markdown index 35412b46032b..3931fac2577e 100644 --- a/website/docs/cdktf/typescript/r/secretsmanager_secret_policy.html.markdown +++ b/website/docs/cdktf/typescript/r/secretsmanager_secret_policy.html.markdown @@ -79,6 +79,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `blockPublicPolicy` - (Optional) Makes an optional API call to Zelkova to validate the Resource Policy to prevent broad access to your secret. ## Attribute Reference @@ -119,4 +120,4 @@ Using `terraform import`, import `aws_secretsmanager_secret_policy` using the se % terraform import aws_secretsmanager_secret_policy.example arn:aws:secretsmanager:us-east-1:123456789012:secret:example-123456 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/secretsmanager_secret_rotation.html.markdown b/website/docs/cdktf/typescript/r/secretsmanager_secret_rotation.html.markdown index be7e13444051..93a1d18c6b51 100644 --- a/website/docs/cdktf/typescript/r/secretsmanager_secret_rotation.html.markdown +++ b/website/docs/cdktf/typescript/r/secretsmanager_secret_rotation.html.markdown @@ -52,6 +52,7 @@ To enable automatic secret rotation, the Secrets Manager service requires usage This resource supports the following arguments: +* `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). * `secretId` - (Required) Specifies the secret to which you want to add a new version. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret. The secret must already exist. * `rotateImmediately` - (Optional) Specifies whether to rotate the secret immediately or wait until the next scheduled rotation window. The rotation schedule is defined in `rotationRules`. For secrets that use a Lambda rotation function to rotate, if you don't immediately rotate the secret, Secrets Manager tests the rotation configuration by running the testSecret step (https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotate-secrets_how.html) of the Lambda rotation function. The test creates an AWSPENDING version of the secret and then removes it. Defaults to `true`. * `rotationLambdaArn` - (Optional) Specifies the ARN of the Lambda function that can rotate the secret. Must be supplied if the secret is not managed by AWS. @@ -103,4 +104,4 @@ Using `terraform import`, import `aws_secretsmanager_secret_rotation` using the % terraform import aws_secretsmanager_secret_rotation.example arn:aws:secretsmanager:us-east-1:123456789012:secret:example-123456 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/secretsmanager_secret_version.html.markdown b/website/docs/cdktf/typescript/r/secretsmanager_secret_version.html.markdown index 7c98ffcc68f0..d10f5b34727c 100644 --- a/website/docs/cdktf/typescript/r/secretsmanager_secret_version.html.markdown +++ b/website/docs/cdktf/typescript/r/secretsmanager_secret_version.html.markdown @@ -14,7 +14,7 @@ Provides a resource to manage AWS Secrets Manager secret version including its s ~> **NOTE:** If the `AWSCURRENT` staging label is present on this version during resource deletion, that label cannot be removed and will be skipped to prevent errors when fully deleting the secret. That label will leave this secret version active even after the resource is deleted from Terraform unless the secret itself is deleted. Move the `AWSCURRENT` staging label before or after deleting this resource from Terraform to fully trigger version deprecation if necessary. --> **Note:** Write-Only argument `secretStringWo` is available to use in place of `secretString`. Write-Only argumentss are supported in HashiCorp Terraform 1.11.0 and later. [Learn more](https://developer.hashicorp.com/terraform/language/v1.11.x/resources/ephemeral#write-only-arguments). +-> **Note:** Write-Only argument `secretStringWo` is available to use in place of `secretString`. Write-Only argumentss are supported in HashiCorp Terraform 1.11.0 and later. [Learn more](https://developer.hashicorp.com/terraform/language/resources/ephemeral#write-only-arguments). ## Example Usage @@ -109,6 +109,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `secretId` - (Required) Specifies the secret to which you want to add a new version. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret. The secret must already exist. * `secretString` - (Optional) Specifies text data that you want to encrypt and store in this version of the secret. This is required if `secretBinary` or `secretStringWo` is not set. * `secretStringWo` - (Optional) Specifies text data that you want to encrypt and store in this version of the secret. This is required if `secretBinary` or `secretString` is not set. @@ -128,6 +129,34 @@ This resource exports the following attributes in addition to the arguments abov ## Import +In Terraform v1.12.0 and later, the [`import` block](https://developer.hashicorp.com/terraform/language/import) can be used with the `identity` attribute. For example: + +```terraform +import { + to = aws_secretsmanager_secret_version.example + identity = { + secret_id = "arn:aws:secretsmanager:us-east-1:123456789012:secret:example-123456" + version_id = "xxxxx-xxxxxxx-xxxxxxx-xxxxx" + } +} + +resource "aws_secretsmanager_secret_version" "example" { + ### Configuration omitted for brevity ### +} +``` + +### Identity Schema + +#### Required + +* `secretId` - (String) ID of the secret. +* `versionId` - (String) ID of the secret version. + +#### Optional + +- `accountId` (String) AWS Account where this resource is managed. +- `region` (String) Region where this resource is managed. + In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import `aws_secretsmanager_secret_version` using the secret ID and version ID. For example: ```typescript @@ -158,4 +187,4 @@ Using `terraform import`, import `aws_secretsmanager_secret_version` using the s % terraform import aws_secretsmanager_secret_version.example 'arn:aws:secretsmanager:us-east-1:123456789012:secret:example-123456|xxxxx-xxxxxxx-xxxxxxx-xxxxx' ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/security_group.html.markdown b/website/docs/cdktf/typescript/r/security_group.html.markdown index b4ed6bb24f75..2c25691e4669 100644 --- a/website/docs/cdktf/typescript/r/security_group.html.markdown +++ b/website/docs/cdktf/typescript/r/security_group.html.markdown @@ -125,14 +125,12 @@ import { TerraformStack } from "cdktf"; import { SecurityGroup } from "./.gen/providers/aws/security-group"; import { VpcEndpoint } from "./.gen/providers/aws/vpc-endpoint"; interface MyConfig { - serviceName: any; vpcId: any; } class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string, config: MyConfig) { super(scope, name); const myEndpoint = new VpcEndpoint(this, "my_endpoint", { - serviceName: config.serviceName, vpcId: config.vpcId, }); new SecurityGroup(this, "example", { @@ -338,6 +336,7 @@ resource "null_resource" "example" { This resource supports the following arguments: +* `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). * `description` - (Optional, Forces new resource) Security group description. Defaults to `Managed by Terraform`. Cannot be `""`. **NOTE**: This field maps to the AWS `GroupDescription` attribute, for which there is no Update API. If you'd like to classify your security groups in a way that can be updated, use `tags`. * `egress` - (Optional, VPC only) Configuration block for egress rules. Can be specified multiple times for each egress rule. Each egress block supports fields documented below. This argument is processed in [attribute-as-blocks mode](https://www.terraform.io/docs/configuration/attr-as-blocks.html). * `ingress` - (Optional) Configuration block for ingress rules. Can be specified multiple times for each ingress rule. Each ingress block supports fields documented below. This argument is processed in [attribute-as-blocks mode](https://www.terraform.io/docs/configuration/attr-as-blocks.html). @@ -433,4 +432,4 @@ Using `terraform import`, import Security Groups using the security group `id`. % terraform import aws_security_group.elb_sg sg-903004f8 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/security_group_rule.html.markdown b/website/docs/cdktf/typescript/r/security_group_rule.html.markdown index 5b128e248e97..986269ee517b 100644 --- a/website/docs/cdktf/typescript/r/security_group_rule.html.markdown +++ b/website/docs/cdktf/typescript/r/security_group_rule.html.markdown @@ -69,14 +69,12 @@ import { TerraformStack } from "cdktf"; import { SecurityGroupRule } from "./.gen/providers/aws/security-group-rule"; import { VpcEndpoint } from "./.gen/providers/aws/vpc-endpoint"; interface MyConfig { - serviceName: any; vpcId: any; } class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string, config: MyConfig) { super(scope, name); const myEndpoint = new VpcEndpoint(this, "my_endpoint", { - serviceName: config.serviceName, vpcId: config.vpcId, }); new SecurityGroupRule(this, "allow_all", { @@ -111,7 +109,7 @@ class MyConvertedCode extends TerraformStack { super(scope, name); const current = new DataAwsRegion(this, "current", {}); const s3 = new DataAwsPrefixList(this, "s3", { - name: "com.amazonaws.${" + current.name + "}.s3", + name: "com.amazonaws.${" + current.region + "}.s3", }); new SecurityGroupRule(this, "s3_gateway_egress", { description: "S3 Gateway Egress", @@ -129,8 +127,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `fromPort` - (Required) Start port (or ICMP type number if protocol is "icmp" or "icmpv6"). * `protocol` - (Required) Protocol. If not icmp, icmpv6, tcp, udp, or all use the [protocol number](https://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml) * `securityGroupId` - (Required) Security group to apply this rule to. @@ -140,6 +139,7 @@ or `egress` (outbound). The following arguments are optional: +* `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). ~> **Note** Although `cidrBlocks`, `ipv6CidrBlocks`, `prefixListIds`, and `sourceSecurityGroupId` are all marked as optional, you _must_ provide one of them in order to configure the source of the traffic. * `cidrBlocks` - (Optional) List of CIDR blocks. Cannot be specified with `sourceSecurityGroupId` or `self`. @@ -382,4 +382,4 @@ Import a rule that has itself and an IPv6 CIDR block as sources: % terraform import aws_security_group_rule.rule_name sg-656c65616e6f72_ingress_tcp_80_80_self_2001:db8::/48 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/securityhub_account.html.markdown b/website/docs/cdktf/typescript/r/securityhub_account.html.markdown index 95466c8b9e41..c9e590433461 100644 --- a/website/docs/cdktf/typescript/r/securityhub_account.html.markdown +++ b/website/docs/cdktf/typescript/r/securityhub_account.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `enableDefaultStandards` - (Optional) Whether to enable the security standards that Security Hub has designated as automatically enabled including: ` AWS Foundational Security Best Practices v1.0.0` and `CIS AWS Foundations Benchmark v1.2.0`. Defaults to `true`. * `controlFindingGenerator` - (Optional) Updates whether the calling account has consolidated control findings turned on. If the value for this field is set to `SECURITY_CONTROL`, Security Hub generates a single finding for a control check even when the check applies to multiple enabled standards. If the value for this field is set to `STANDARD_CONTROL`, Security Hub generates separate findings for a control check when the check applies to multiple enabled standards. For accounts that are part of an organization, this value can only be updated in the administrator account. * `autoEnableControls` - (Optional) Whether to automatically enable new controls when they are added to standards that are enabled. By default, this is set to true, and new controls are enabled automatically. To not automatically enable new controls, set this to false. @@ -77,4 +78,4 @@ Using `terraform import`, import an existing Security Hub enabled account using % terraform import aws_securityhub_account.example 123456789012 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/securityhub_action_target.html.markdown b/website/docs/cdktf/typescript/r/securityhub_action_target.html.markdown index bf3da5cb9672..23468d3233e0 100644 --- a/website/docs/cdktf/typescript/r/securityhub_action_target.html.markdown +++ b/website/docs/cdktf/typescript/r/securityhub_action_target.html.markdown @@ -49,6 +49,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) The description for the custom action target. * `identifier` - (Required) The ID for the custom action target. * `description` - (Required) The name of the custom action target. @@ -91,4 +92,4 @@ Using `terraform import`, import Security Hub custom action using the action tar % terraform import aws_securityhub_action_target.example arn:aws:securityhub:eu-west-1:312940875350:action/custom/a ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/securityhub_automation_rule.html.markdown b/website/docs/cdktf/typescript/r/securityhub_automation_rule.html.markdown index 62fe04dae2d7..21bf467e05a1 100644 --- a/website/docs/cdktf/typescript/r/securityhub_automation_rule.html.markdown +++ b/website/docs/cdktf/typescript/r/securityhub_automation_rule.html.markdown @@ -81,6 +81,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `actions` - (Required) A block that specifies one or more actions to update finding fields if a finding matches the conditions specified in `Criteria`. [Documented below](#actions). * `criteria` - (Required) A block that specifies a set of ASFF finding field attributes and corresponding expected values that Security Hub uses to filter findings. [Documented below](#criteria). * `description` - (Required) The description of the rule. @@ -259,4 +260,4 @@ Using `terraform import`, import Security Hub automation rule using their ARN. F % terraform import aws_securityhub_automation_rule.example arn:aws:securityhub:us-west-2:123456789012:automation-rule/473eddde-f5c4-4ae5-85c7-e922f271fffc ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/securityhub_configuration_policy.html.markdown b/website/docs/cdktf/typescript/r/securityhub_configuration_policy.html.markdown index 20b07987a320..081a41f0bfb2 100644 --- a/website/docs/cdktf/typescript/r/securityhub_configuration_policy.html.markdown +++ b/website/docs/cdktf/typescript/r/securityhub_configuration_policy.html.markdown @@ -168,6 +168,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `configurationPolicy` - (Required) Defines how Security Hub is configured. See [below](#configuration_policy). * `description` - (Optional) The description of the configuration policy. * `name` - (Required) The name of the configuration policy. @@ -250,4 +251,4 @@ Using `terraform import`, import an existing Security Hub enabled account using % terraform import aws_securityhub_configuration_policy.example "00000000-1111-2222-3333-444444444444" ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/securityhub_configuration_policy_association.markdown b/website/docs/cdktf/typescript/r/securityhub_configuration_policy_association.markdown index 49c949d319d6..2de4be4d37c5 100644 --- a/website/docs/cdktf/typescript/r/securityhub_configuration_policy_association.markdown +++ b/website/docs/cdktf/typescript/r/securityhub_configuration_policy_association.markdown @@ -84,6 +84,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `policyId` - (Required) The universally unique identifier (UUID) of the configuration policy. * `targetId` - (Required, Forces new resource) The identifier of the target account, organizational unit, or the root to associate with the specified configuration. @@ -132,4 +133,4 @@ Using `terraform import`, import an existing Security Hub enabled account using % terraform import aws_securityhub_configuration_policy_association.example_account_association 123456789012 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/securityhub_finding_aggregator.html.markdown b/website/docs/cdktf/typescript/r/securityhub_finding_aggregator.html.markdown index c5b6d035d397..22cfeaee8c71 100644 --- a/website/docs/cdktf/typescript/r/securityhub_finding_aggregator.html.markdown +++ b/website/docs/cdktf/typescript/r/securityhub_finding_aggregator.html.markdown @@ -140,6 +140,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +- `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). - `linkingMode` - (Required) Indicates whether to aggregate findings from all of the available Regions or from a specified list. The options are `ALL_REGIONS`, `ALL_REGIONS_EXCEPT_SPECIFIED`, `SPECIFIED_REGIONS` or `NO_REGIONS`. When `ALL_REGIONS` or `ALL_REGIONS_EXCEPT_SPECIFIED` are used, Security Hub will automatically aggregate findings from new Regions as Security Hub supports them and you opt into them. - `specifiedRegions` - (Optional) List of regions to include or exclude (required if `linkingMode` is set to `ALL_REGIONS_EXCEPT_SPECIFIED` or `SPECIFIED_REGIONS`) @@ -181,4 +182,4 @@ Using `terraform import`, import an existing Security Hub finding aggregator usi % terraform import aws_securityhub_finding_aggregator.example arn:aws:securityhub:eu-west-1:123456789098:finding-aggregator/abcd1234-abcd-1234-1234-abcdef123456 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/securityhub_insight.html.markdown b/website/docs/cdktf/typescript/r/securityhub_insight.html.markdown index 111398b81899..590556723f55 100644 --- a/website/docs/cdktf/typescript/r/securityhub_insight.html.markdown +++ b/website/docs/cdktf/typescript/r/securityhub_insight.html.markdown @@ -221,8 +221,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `filters` - (Required) A configuration block including one or more (up to 10 distinct) attributes used to filter the findings included in the insight. The insight only includes findings that match criteria defined in the filters. See [filters](#filters) below for more details. * `groupByAttribute` - (Required) The attribute used to group the findings for the insight e.g., if an insight is grouped by `ResourceId`, then the insight produces a list of resource identifiers. * `name` - (Required) The name of the custom insight. @@ -420,4 +421,4 @@ Using `terraform import`, import Security Hub insights using the ARN. For exampl % terraform import aws_securityhub_insight.example arn:aws:securityhub:us-west-2:1234567890:insight/1234567890/custom/91299ed7-abd0-4e44-a858-d0b15e37141a ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/securityhub_invite_accepter.html.markdown b/website/docs/cdktf/typescript/r/securityhub_invite_accepter.html.markdown index 039b6e351d18..738cc03dc843 100644 --- a/website/docs/cdktf/typescript/r/securityhub_invite_accepter.html.markdown +++ b/website/docs/cdktf/typescript/r/securityhub_invite_accepter.html.markdown @@ -65,6 +65,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `masterId` - (Required) The account ID of the master Security Hub account whose invitation you're accepting. ## Attribute Reference @@ -105,4 +106,4 @@ Using `terraform import`, import Security Hub invite acceptance using the accoun % terraform import aws_securityhub_invite_accepter.example 123456789012 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/securityhub_member.html.markdown b/website/docs/cdktf/typescript/r/securityhub_member.html.markdown index 5214905a015e..43656176875f 100644 --- a/website/docs/cdktf/typescript/r/securityhub_member.html.markdown +++ b/website/docs/cdktf/typescript/r/securityhub_member.html.markdown @@ -49,6 +49,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `accountId` - (Required) The ID of the member AWS account. * `email` - (Optional) The email of the member AWS account. * `invite` - (Optional) Boolean whether to invite the account to Security Hub as a member. Defaults to `false`. @@ -89,4 +90,4 @@ Using `terraform import`, import Security Hub members using their account ID. Fo % terraform import aws_securityhub_member.example 123456789012 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/securityhub_organization_admin_account.html.markdown b/website/docs/cdktf/typescript/r/securityhub_organization_admin_account.html.markdown index 59b33e032992..8b22aeb20d00 100644 --- a/website/docs/cdktf/typescript/r/securityhub_organization_admin_account.html.markdown +++ b/website/docs/cdktf/typescript/r/securityhub_organization_admin_account.html.markdown @@ -62,6 +62,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `adminAccountId` - (Required) The AWS account identifier of the account to designate as the Security Hub administrator account. ## Attribute Reference @@ -102,4 +103,4 @@ Using `terraform import`, import Security Hub Organization Admin Accounts using % terraform import aws_securityhub_organization_admin_account.example 123456789012 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/securityhub_organization_configuration.html.markdown b/website/docs/cdktf/typescript/r/securityhub_organization_configuration.html.markdown index b0cf9f18cc8b..07247d49c492 100644 --- a/website/docs/cdktf/typescript/r/securityhub_organization_configuration.html.markdown +++ b/website/docs/cdktf/typescript/r/securityhub_organization_configuration.html.markdown @@ -107,6 +107,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `autoEnable` - (Required) Whether to automatically enable Security Hub for new accounts in the organization. * `autoEnableStandards` - (Optional) Whether to automatically enable Security Hub default standards for new member accounts in the organization. By default, this parameter is equal to `DEFAULT`, and new member accounts are automatically enabled with default Security Hub standards. To opt out of enabling default standards for new member accounts, set this parameter equal to `NONE`. * `organizationConfiguration` - (Optional) Provides information about the way an organization is configured in Security Hub. @@ -161,4 +162,4 @@ Using `terraform import`, import an existing Security Hub enabled account using % terraform import aws_securityhub_organization_configuration.example 123456789012 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/securityhub_product_subscription.html.markdown b/website/docs/cdktf/typescript/r/securityhub_product_subscription.html.markdown index 414c5149059d..0fdc2f3d43b3 100644 --- a/website/docs/cdktf/typescript/r/securityhub_product_subscription.html.markdown +++ b/website/docs/cdktf/typescript/r/securityhub_product_subscription.html.markdown @@ -35,7 +35,7 @@ class MyConvertedCode extends TerraformStack { dependsOn: [example], productArn: "arn:aws:securityhub:${" + - current.name + + current.region + "}:733251395267:product/alertlogic/althreatmanagement", }); /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ @@ -49,6 +49,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `productArn` - (Required) The ARN of the product that generates findings that you want to import into Security Hub - see below. Amazon maintains a list of [Product integrations in AWS Security Hub](https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-findings-providers.html) that changes over time. Any of the products on the linked [Available AWS service integrations](https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-internal-providers.html) or [Available third-party partner product integrations](https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-partner-providers.html) can be configured using `aws_securityhub_product_subscription`. @@ -127,4 +128,4 @@ Using `terraform import`, import Security Hub product subscriptions using `produ % terraform import aws_securityhub_product_subscription.example arn:aws:securityhub:eu-west-1:733251395267:product/alertlogic/althreatmanagement,arn:aws:securityhub:eu-west-1:123456789012:product-subscription/alertlogic/althreatmanagement ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/securityhub_standards_control.html.markdown b/website/docs/cdktf/typescript/r/securityhub_standards_control.html.markdown index 8ddc8905df61..2a22c3f28aaa 100644 --- a/website/docs/cdktf/typescript/r/securityhub_standards_control.html.markdown +++ b/website/docs/cdktf/typescript/r/securityhub_standards_control.html.markdown @@ -62,21 +62,22 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `standardsControlArn` - (Required) The standards control ARN. See the AWS documentation for how to list existing controls using [`get-enabled-standards`](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/securityhub/get-enabled-standards.html) and [`describe-standards-controls`](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/securityhub/describe-standards-controls.html). -* `controlStatus` – (Required) The control status could be `ENABLED` or `DISABLED`. You have to specify `disabledReason` argument for `DISABLED` control status. -* `disabledReason` – (Optional) A description of the reason why you are disabling a security standard control. If you specify this attribute, `controlStatus` will be set to `DISABLED` automatically. +* `controlStatus` - (Required) The control status could be `ENABLED` or `DISABLED`. You have to specify `disabledReason` argument for `DISABLED` control status. +* `disabledReason` - (Optional) A description of the reason why you are disabling a security standard control. If you specify this attribute, `controlStatus` will be set to `DISABLED` automatically. ## Attribute Reference This resource exports the following attributes in addition to the arguments above: * `id` - The standard control ARN. -* `controlId` – The identifier of the security standard control. -* `controlStatusUpdatedAt` – The date and time that the status of the security standard control was most recently updated. -* `description` – The standard control longer description. Provides information about what the control is checking for. -* `relatedRequirements` – The list of requirements that are related to this control. -* `remediationUrl` – A link to remediation information for the control in the Security Hub user documentation. -* `severityRating` – The severity of findings generated from this security standard control. -* `title` – The standard control title. +* `controlId` - The identifier of the security standard control. +* `controlStatusUpdatedAt` - The date and time that the status of the security standard control was most recently updated. +* `description` - The standard control longer description. Provides information about what the control is checking for. +* `relatedRequirements` - The list of requirements that are related to this control. +* `remediationUrl` - A link to remediation information for the control in the Security Hub user documentation. +* `severityRating` - The severity of findings generated from this security standard control. +* `title` - The standard control title. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/securityhub_standards_control_association.html.markdown b/website/docs/cdktf/typescript/r/securityhub_standards_control_association.html.markdown index 774f3e6ee8f7..7386cf9d1ecb 100644 --- a/website/docs/cdktf/typescript/r/securityhub_standards_control_association.html.markdown +++ b/website/docs/cdktf/typescript/r/securityhub_standards_control_association.html.markdown @@ -125,10 +125,11 @@ The following arguments are required: The following arguments are optional: +* `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). * `updatedReason` - (Optional) The reason for updating the control's enablement status in the standard. Required when `associationStatus` is `DISABLED`. ## Attribute Reference This resource exports no additional attributes. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/securityhub_standards_subscription.html.markdown b/website/docs/cdktf/typescript/r/securityhub_standards_subscription.html.markdown index c2217ee8e8c4..3ec8f533dcfe 100644 --- a/website/docs/cdktf/typescript/r/securityhub_standards_subscription.html.markdown +++ b/website/docs/cdktf/typescript/r/securityhub_standards_subscription.html.markdown @@ -39,7 +39,7 @@ class MyConvertedCode extends TerraformStack { dependsOn: [example], standardsArn: "arn:aws:securityhub:${" + - current.name + + current.region + "}::standards/pci-dss/v/3.2.1", }); } @@ -51,6 +51,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `standardsArn` - (Required) The ARN of a standard - see below. Currently available standards (remember to replace `${var.partition}` and `${var.region}` as appropriate): @@ -63,7 +64,9 @@ Currently available standards (remember to replace `${var.partition}` and `${var | CIS AWS Foundations Benchmark v1.4.0 | `arn:${var.partition}:securityhub:${var.region}::standards/cis-aws-foundations-benchmark/v/1.4.0` | | CIS AWS Foundations Benchmark v3.0.0 | `arn:${var.partition}:securityhub:${var.region}::standards/cis-aws-foundations-benchmark/v/3.0.0` | | NIST SP 800-53 Rev. 5 | `arn:${var.partition}:securityhub:${var.region}::standards/nist-800-53/v/5.0.0` | -| PCI DSS | `arn:${var.partition}:securityhub:${var.region}::standards/pci-dss/v/3.2.1` | +| NIST SP 800-171 Rev. 2 | `arn:${var.partition}:securityhub:${var.region}::standards/nist-800-171/v/2.0.0` | +| PCI DSS v3.2.1 | `arn:${var.partition}:securityhub:${var.region}::standards/pci-dss/v/3.2.1` | +| PCI DSS v4.0.1 | `arn:${var.partition}:securityhub:${var.region}::standards/pci-dss/v/4.0.1` | ## Attribute Reference @@ -162,4 +165,4 @@ Using `terraform import`, import Security Hub standards subscriptions using the % terraform import aws_securityhub_standards_subscription.nist_800_53_rev_5 arn:aws:securityhub:eu-west-1:123456789012:subscription/nist-800-53/v/5.0.0 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/securitylake_aws_log_source.html.markdown b/website/docs/cdktf/typescript/r/securitylake_aws_log_source.html.markdown index 1c94f55de038..928d410ed240 100644 --- a/website/docs/cdktf/typescript/r/securitylake_aws_log_source.html.markdown +++ b/website/docs/cdktf/typescript/r/securitylake_aws_log_source.html.markdown @@ -51,6 +51,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `source` - (Required) Specify the natively-supported AWS service to add as a source in Security Lake. `source` supports the following: @@ -99,4 +100,4 @@ Using `terraform import`, import AWS log sources using the source name. For exam % terraform import aws_securitylake_aws_log_source.example ROUTE53 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/securitylake_custom_log_source.html.markdown b/website/docs/cdktf/typescript/r/securitylake_custom_log_source.html.markdown index d0c86258a6ae..ee55c7a13ded 100644 --- a/website/docs/cdktf/typescript/r/securitylake_custom_log_source.html.markdown +++ b/website/docs/cdktf/typescript/r/securitylake_custom_log_source.html.markdown @@ -60,6 +60,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `configuration` - (Required) The configuration for the third-party custom source. * `crawlerConfiguration` - (Required) The configuration for the Glue Crawler for the third-party custom source. * `roleArn` - (Required) The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role to be used by the AWS Glue crawler. @@ -116,4 +117,4 @@ Using `terraform import`, import Custom log sources using the source name. For e % terraform import aws_securitylake_custom_log_source.example example-name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/securitylake_data_lake.html.markdown b/website/docs/cdktf/typescript/r/securitylake_data_lake.html.markdown index e2271a334c17..8ced813fbdd6 100644 --- a/website/docs/cdktf/typescript/r/securitylake_data_lake.html.markdown +++ b/website/docs/cdktf/typescript/r/securitylake_data_lake.html.markdown @@ -101,6 +101,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `metaStoreManagerRoleArn` - (Required) The Amazon Resource Name (ARN) used to create and update the AWS Glue table. This table contains partitions generated by the ingestion and normalization of AWS log sources and custom sources. * `configuration` - (Required) Specify the Region or Regions that will contribute data to the rollup region. * `tags` - (Optional) Key-value map of resource tags. If configured with a provider [`defaultTags` 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. @@ -183,4 +184,4 @@ Using `terraform import`, import Security Hub standards subscriptions using the % terraform import aws_securitylake_data_lake.example arn:aws:securitylake:eu-west-1:123456789012:data-lake/default ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/securitylake_subscriber.html.markdown b/website/docs/cdktf/typescript/r/securitylake_subscriber.html.markdown index 34fa2ea0f25e..09031aee2f9d 100644 --- a/website/docs/cdktf/typescript/r/securitylake_subscriber.html.markdown +++ b/website/docs/cdktf/typescript/r/securitylake_subscriber.html.markdown @@ -58,6 +58,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `accessType` - (Optional) The Amazon S3 or Lake Formation access type. * `source` - (Required) The supported AWS services from which logs and events are collected. Security Lake supports log and event collection for natively supported AWS services. See [`source` Blocks](#source-blocks) below. * `subscriberIdentity` - (Required) The AWS identity used to access your data. See [`subscriberIdentity` Block](#subscriber_identity-block) below. @@ -169,4 +170,4 @@ Using `terraform import`, import Security Lake subscriber using the subscriber I % terraform import aws_securitylake_subscriber.example 9f3bfe79-d543-474d-a93c-f3846805d208 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/securitylake_subscriber_notification.html.markdown b/website/docs/cdktf/typescript/r/securitylake_subscriber_notification.html.markdown index f1c3568b192d..70cf9d8013fd 100644 --- a/website/docs/cdktf/typescript/r/securitylake_subscriber_notification.html.markdown +++ b/website/docs/cdktf/typescript/r/securitylake_subscriber_notification.html.markdown @@ -77,6 +77,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `subscriberId` - (Required) The subscriber ID for the notification subscription. * `configuration` - (Required) Specify the configuration using which you want to create the subscriber notification.. @@ -112,4 +113,4 @@ This resource exports the following attributes in addition to the arguments abov * `update` - (Default `180m`) * `delete` - (Default `90m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/serverlessapplicationrepository_cloudformation_stack.html.markdown b/website/docs/cdktf/typescript/r/serverlessapplicationrepository_cloudformation_stack.html.markdown index 22f89ee32185..97e67bc66b7a 100644 --- a/website/docs/cdktf/typescript/r/serverlessapplicationrepository_cloudformation_stack.html.markdown +++ b/website/docs/cdktf/typescript/r/serverlessapplicationrepository_cloudformation_stack.html.markdown @@ -43,7 +43,7 @@ class MyConvertedCode extends TerraformStack { parameters: { endpoint: "secretsmanager.${" + - dataAwsRegionCurrent.name + + dataAwsRegionCurrent.region + "}.${" + current.dnsSuffix + "}", @@ -60,6 +60,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) The name of the stack to create. The resource deployed in AWS will be prefixed with `serverlessrepo-` * `applicationId` - (Required) The ARN of the application from the Serverless Application Repository. * `capabilities` - (Required) A list of capabilities. Valid values are `CAPABILITY_IAM`, `CAPABILITY_NAMED_IAM`, `CAPABILITY_RESOURCE_POLICY`, or `CAPABILITY_AUTO_EXPAND` @@ -107,4 +108,4 @@ Using `terraform import`, import Serverless Application Repository Stack using t % terraform import aws_serverlessapplicationrepository_cloudformation_stack.example serverlessrepo-postgres-rotator ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/service_discovery_http_namespace.html.markdown b/website/docs/cdktf/typescript/r/service_discovery_http_namespace.html.markdown index 7418d4ffe019..f2bc2e76e56f 100644 --- a/website/docs/cdktf/typescript/r/service_discovery_http_namespace.html.markdown +++ b/website/docs/cdktf/typescript/r/service_discovery_http_namespace.html.markdown @@ -37,6 +37,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) The name of the http namespace. * `description` - (Optional) The description that you specify for the namespace when you create it. * `tags` - (Optional) A map of tags to assign to the namespace. If configured with a provider [`defaultTags` 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. @@ -82,4 +83,4 @@ Using `terraform import`, import Service Discovery HTTP Namespace using the name % terraform import aws_service_discovery_http_namespace.example ns-1234567890 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/service_discovery_instance.html.markdown b/website/docs/cdktf/typescript/r/service_discovery_instance.html.markdown index b774de7ff6e5..ef4cb6e8118b 100644 --- a/website/docs/cdktf/typescript/r/service_discovery_instance.html.markdown +++ b/website/docs/cdktf/typescript/r/service_discovery_instance.html.markdown @@ -135,6 +135,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `instanceId` - (Required, ForceNew) The ID of the service instance. * `serviceId` - (Required, ForceNew) The ID of the service that you want to use to create the instance. * `attributes` - (Required) A map contains the attributes of the instance. Check the [doc](https://docs.aws.amazon.com/cloud-map/latest/api/API_RegisterInstance.html#API_RegisterInstance_RequestSyntax) for the supported attributes and syntax. @@ -177,4 +178,4 @@ Using `terraform import`, import Service Discovery Instance using the service ID % terraform import aws_service_discovery_instance.example 0123456789/i-0123 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/service_discovery_private_dns_namespace.html.markdown b/website/docs/cdktf/typescript/r/service_discovery_private_dns_namespace.html.markdown index 256f20b03361..3594cb1609d4 100644 --- a/website/docs/cdktf/typescript/r/service_discovery_private_dns_namespace.html.markdown +++ b/website/docs/cdktf/typescript/r/service_discovery_private_dns_namespace.html.markdown @@ -47,6 +47,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) The name of the namespace. * `vpc` - (Required) The ID of VPC that you want to associate the namespace with. * `description` - (Optional) The description that you specify for the namespace when you create it. @@ -93,4 +94,4 @@ Using `terraform import`, import Service Discovery Private DNS Namespace using t % terraform import aws_service_discovery_private_dns_namespace.example 0123456789:vpc-123345 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/service_discovery_public_dns_namespace.html.markdown b/website/docs/cdktf/typescript/r/service_discovery_public_dns_namespace.html.markdown index 3bdb54d7fac5..470b8536e978 100644 --- a/website/docs/cdktf/typescript/r/service_discovery_public_dns_namespace.html.markdown +++ b/website/docs/cdktf/typescript/r/service_discovery_public_dns_namespace.html.markdown @@ -39,6 +39,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) The name of the namespace. * `description` - (Optional) The description that you specify for the namespace when you create it. * `tags` - (Optional) A map of tags to assign to the namespace. If configured with a provider [`defaultTags` 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. @@ -84,4 +85,4 @@ Using `terraform import`, import Service Discovery Public DNS Namespace using th % terraform import aws_service_discovery_public_dns_namespace.example 0123456789 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/service_discovery_service.html.markdown b/website/docs/cdktf/typescript/r/service_discovery_service.html.markdown index c36a40923687..60507434c6b6 100644 --- a/website/docs/cdktf/typescript/r/service_discovery_service.html.markdown +++ b/website/docs/cdktf/typescript/r/service_discovery_service.html.markdown @@ -119,6 +119,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required, Forces new resource) The name of the service. * `description` - (Optional) The description of the service. * `dnsConfig` - (Optional) A complex type that contains information about the resource record sets that you want Amazon Route 53 to create when you register an instance. See [`dnsConfig` Block](#dns_config-block) for details. @@ -156,7 +157,7 @@ The `healthCheckConfig` configuration block supports the following arguments: The `healthCheckCustomConfig` configuration block supports the following arguments: -* `failureThreshold` - (Optional, Forces new resource) The number of 30-second intervals that you want service discovery to wait before it changes the health status of a service instance. Maximum value of 10. +* `failureThreshold` - (Optional, **Deprecated** Forces new resource) The number of 30-second intervals that you want service discovery to wait before it changes the health status of a service instance. Value is always set to 1. ## Attribute Reference @@ -164,7 +165,6 @@ This resource exports the following attributes in addition to the arguments abov * `id` - The ID of the service. * `arn` - The ARN of the service. -* `tagsAll` - A map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). ## Import @@ -198,4 +198,4 @@ Using `terraform import`, import Service Discovery Service using the service ID. % terraform import aws_service_discovery_service.example 0123456789 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/servicecatalog_budget_resource_association.html.markdown b/website/docs/cdktf/typescript/r/servicecatalog_budget_resource_association.html.markdown index 0b72e1138878..785986e9d565 100644 --- a/website/docs/cdktf/typescript/r/servicecatalog_budget_resource_association.html.markdown +++ b/website/docs/cdktf/typescript/r/servicecatalog_budget_resource_association.html.markdown @@ -41,8 +41,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `budgetName` - (Required) Budget name. * `resourceId` - (Required) Resource identifier. @@ -92,4 +93,4 @@ Using `terraform import`, import `aws_servicecatalog_budget_resource_association % terraform import aws_servicecatalog_budget_resource_association.example budget-pjtvyakdlyo3m:prod-dnigbtea24ste ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/servicecatalog_constraint.html.markdown b/website/docs/cdktf/typescript/r/servicecatalog_constraint.html.markdown index d14ca2af8ed3..7e9884fc3a8c 100644 --- a/website/docs/cdktf/typescript/r/servicecatalog_constraint.html.markdown +++ b/website/docs/cdktf/typescript/r/servicecatalog_constraint.html.markdown @@ -57,6 +57,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `acceptLanguage` - (Optional) Language code. Valid values: `en` (English), `jp` (Japanese), `zh` (Chinese). Default value is `en`. * `description` - (Optional) Description of the constraint. @@ -142,4 +143,4 @@ Using `terraform import`, import `aws_servicecatalog_constraint` using the const % terraform import aws_servicecatalog_constraint.example cons-nmdkb6cgxfcrs ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/servicecatalog_portfolio.html.markdown b/website/docs/cdktf/typescript/r/servicecatalog_portfolio.html.markdown index 58fe9400bddd..80bc4fabd515 100644 --- a/website/docs/cdktf/typescript/r/servicecatalog_portfolio.html.markdown +++ b/website/docs/cdktf/typescript/r/servicecatalog_portfolio.html.markdown @@ -40,6 +40,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) The name of the portfolio. * `description` - (Required) Description of the portfolio * `providerName` - (Required) Name of the person or organization who owns the portfolio. @@ -93,4 +94,4 @@ Using `terraform import`, import Service Catalog Portfolios using the Service Ca % terraform import aws_servicecatalog_portfolio.testfolio port-12344321 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/servicecatalog_portfolio_share.html.markdown b/website/docs/cdktf/typescript/r/servicecatalog_portfolio_share.html.markdown index 825f7e410d05..f73762248bb3 100644 --- a/website/docs/cdktf/typescript/r/servicecatalog_portfolio_share.html.markdown +++ b/website/docs/cdktf/typescript/r/servicecatalog_portfolio_share.html.markdown @@ -56,6 +56,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `acceptLanguage` - (Optional) Language code. Valid values: `en` (English), `jp` (Japanese), `zh` (Chinese). Default value is `en`. * `sharePrincipals` - (Optional) Enables or disables Principal sharing when creating the portfolio share. If this flag is not provided, principal sharing is disabled. * `shareTagOptions` - (Optional) Whether to enable sharing of `aws_servicecatalog_tag_option` resources when creating the portfolio share. @@ -108,4 +109,4 @@ Using `terraform import`, import `aws_servicecatalog_portfolio_share` using the % terraform import aws_servicecatalog_portfolio_share.example port-12344321:ACCOUNT:123456789012 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/servicecatalog_principal_portfolio_association.html.markdown b/website/docs/cdktf/typescript/r/servicecatalog_principal_portfolio_association.html.markdown index 23de99525afd..fd69fb02392e 100644 --- a/website/docs/cdktf/typescript/r/servicecatalog_principal_portfolio_association.html.markdown +++ b/website/docs/cdktf/typescript/r/servicecatalog_principal_portfolio_association.html.markdown @@ -46,6 +46,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `acceptLanguage` - (Optional) Language code. Valid values: `en` (English), `jp` (Japanese), `zh` (Chinese). Default value is `en`. * `principalType` - (Optional) Principal type. Setting this argument empty (e.g., `principal_type = ""`) will result in an error. Valid values are `IAM` and `IAM_PATTERN`. Default is `IAM`. @@ -95,4 +96,4 @@ Using `terraform import`, import `aws_servicecatalog_principal_portfolio_associa % terraform import aws_servicecatalog_principal_portfolio_association.example en,arn:aws:iam::123456789012:user/Eleanor,port-68656c6c6f,IAM ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/servicecatalog_product.html.markdown b/website/docs/cdktf/typescript/r/servicecatalog_product.html.markdown index 754cf8534c65..20d697d6e5d9 100644 --- a/website/docs/cdktf/typescript/r/servicecatalog_product.html.markdown +++ b/website/docs/cdktf/typescript/r/servicecatalog_product.html.markdown @@ -60,6 +60,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `acceptLanguage` - (Optional) Language code. Valid values: `en` (English), `jp` (Japanese), `zh` (Chinese). Default value is `en`. * `description` - (Optional) Description of the product. * `distributor` - (Optional) Distributor (i.e., vendor) of the product. @@ -131,4 +132,4 @@ Using `terraform import`, import `aws_servicecatalog_product` using the product % terraform import aws_servicecatalog_product.example prod-dnigbtea24ste ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/servicecatalog_product_portfolio_association.html.markdown b/website/docs/cdktf/typescript/r/servicecatalog_product_portfolio_association.html.markdown index ff4f409c243b..292cc8c641ed 100644 --- a/website/docs/cdktf/typescript/r/servicecatalog_product_portfolio_association.html.markdown +++ b/website/docs/cdktf/typescript/r/servicecatalog_product_portfolio_association.html.markdown @@ -46,6 +46,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `acceptLanguage` - (Optional) Language code. Valid values: `en` (English), `jp` (Japanese), `zh` (Chinese). Default value is `en`. * `sourcePortfolioId` - (Optional) Identifier of the source portfolio. @@ -93,4 +94,4 @@ Using `terraform import`, import `aws_servicecatalog_product_portfolio_associati % terraform import aws_servicecatalog_product_portfolio_association.example en:port-68656c6c6f:prod-dnigbtea24ste ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/servicecatalog_provisioned_product.html.markdown b/website/docs/cdktf/typescript/r/servicecatalog_provisioned_product.html.markdown index eae9f68d505d..82394e065cef 100644 --- a/website/docs/cdktf/typescript/r/servicecatalog_provisioned_product.html.markdown +++ b/website/docs/cdktf/typescript/r/servicecatalog_provisioned_product.html.markdown @@ -63,6 +63,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `acceptLanguage` - (Optional) Language code. Valid values: `en` (English), `jp` (Japanese), `zh` (Chinese). Default value is `en`. * `ignoreErrors` - (Optional) _Only applies to deleting._ If set to `true`, AWS Service Catalog stops managing the specified provisioned product even if it cannot delete the underlying resources. The default value is `false`. * `notificationArns` - (Optional) Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related events. @@ -168,4 +169,4 @@ Using `terraform import`, import `aws_servicecatalog_provisioned_product` using % terraform import aws_servicecatalog_provisioned_product.example pp-dnigbtea24ste ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/servicecatalog_provisioning_artifact.html.markdown b/website/docs/cdktf/typescript/r/servicecatalog_provisioning_artifact.html.markdown index d936bb516b0c..3dd4d73ca7bf 100644 --- a/website/docs/cdktf/typescript/r/servicecatalog_provisioning_artifact.html.markdown +++ b/website/docs/cdktf/typescript/r/servicecatalog_provisioning_artifact.html.markdown @@ -60,6 +60,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `acceptLanguage` - (Optional) Language code. Valid values: `en` (English), `jp` (Japanese), `zh` (Chinese). The default value is `en`. * `active` - (Optional) Whether the product version is active. Inactive provisioning artifacts are invisible to end users. End users cannot launch or update a provisioned product from an inactive provisioning artifact. Default is `true`. * `description` - (Optional) Description of the provisioning artifact (i.e., version), including how it differs from the previous provisioning artifact. @@ -118,4 +119,4 @@ Using `terraform import`, import `aws_servicecatalog_provisioning_artifact` usin % terraform import aws_servicecatalog_provisioning_artifact.example pa-ij2b6lusy6dec:prod-el3an0rma3 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/servicecatalog_service_action.html.markdown b/website/docs/cdktf/typescript/r/servicecatalog_service_action.html.markdown index 2e4a3173a2c9..b5fe73122c8a 100644 --- a/website/docs/cdktf/typescript/r/servicecatalog_service_action.html.markdown +++ b/website/docs/cdktf/typescript/r/servicecatalog_service_action.html.markdown @@ -53,6 +53,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `acceptLanguage` - (Optional) Language code. Valid values are `en` (English), `jp` (Japanese), and `zh` (Chinese). Default is `en`. * `description` - (Optional) Self-service action description. @@ -113,4 +114,4 @@ Using `terraform import`, import `aws_servicecatalog_service_action` using the s % terraform import aws_servicecatalog_service_action.example act-f1w12eperfslh ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/servicecatalog_tag_option.html.markdown b/website/docs/cdktf/typescript/r/servicecatalog_tag_option.html.markdown index fe1d3c3f6232..a3d4fe30ce90 100644 --- a/website/docs/cdktf/typescript/r/servicecatalog_tag_option.html.markdown +++ b/website/docs/cdktf/typescript/r/servicecatalog_tag_option.html.markdown @@ -46,6 +46,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `active` - (Optional) Whether tag option is active. Default is `true`. ## Attribute Reference @@ -96,4 +97,4 @@ Using `terraform import`, import `aws_servicecatalog_tag_option` using the tag o % terraform import aws_servicecatalog_tag_option.example tag-pjtvagohlyo3m ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/servicecatalog_tag_option_resource_association.html.markdown b/website/docs/cdktf/typescript/r/servicecatalog_tag_option_resource_association.html.markdown index 0daf24cc5797..2e80613ccd8f 100644 --- a/website/docs/cdktf/typescript/r/servicecatalog_tag_option_resource_association.html.markdown +++ b/website/docs/cdktf/typescript/r/servicecatalog_tag_option_resource_association.html.markdown @@ -41,8 +41,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `resourceId` - (Required) Resource identifier. * `tagOptionId` - (Required) Tag Option identifier. @@ -96,4 +97,4 @@ Using `terraform import`, import `aws_servicecatalog_tag_option_resource_associa % terraform import aws_servicecatalog_tag_option_resource_association.example tag-pjtvyakdlyo3m:prod-dnigbtea24ste ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/servicecatalogappregistry_application.html.markdown b/website/docs/cdktf/typescript/r/servicecatalogappregistry_application.html.markdown index 85802f6778e2..b4b36b50d9d3 100644 --- a/website/docs/cdktf/typescript/r/servicecatalogappregistry_application.html.markdown +++ b/website/docs/cdktf/typescript/r/servicecatalogappregistry_application.html.markdown @@ -72,6 +72,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `description` - (Optional) Description of the application. * `tags` - (Optional) A map of tags assigned to the Application. If configured with a provider [`defaultTags` 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. @@ -116,4 +117,4 @@ Using `terraform import`, import AWS Service Catalog AppRegistry Application usi % terraform import aws_servicecatalogappregistry_application.example application-id-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/servicecatalogappregistry_attribute_group.html.markdown b/website/docs/cdktf/typescript/r/servicecatalogappregistry_attribute_group.html.markdown index d90248ea5388..13cc432a149e 100644 --- a/website/docs/cdktf/typescript/r/servicecatalogappregistry_attribute_group.html.markdown +++ b/website/docs/cdktf/typescript/r/servicecatalogappregistry_attribute_group.html.markdown @@ -18,20 +18,22 @@ Terraform resource for managing an AWS Service Catalog AppRegistry Attribute Gro ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug import { Construct } from "constructs"; -import { Fn, TerraformStack } from "cdktf"; +import { Fn, Token, TerraformStack } from "cdktf"; /* * Provider bindings are generated by running `cdktf get`. * See https://cdk.tf/provider-generation for more details. */ -import { ServicecatalogappregistryAttributeGroup } from "./.gen/providers/aws/"; +import { ServicecatalogappregistryAttributeGroup } from "./.gen/providers/aws/servicecatalogappregistry-attribute-group"; class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); new ServicecatalogappregistryAttributeGroup(this, "example", { - attributes: Fn.jsonencode({ - app: "exampleapp", - group: "examplegroup", - }), + attributes: Token.asString( + Fn.jsonencode({ + app: "exampleapp", + group: "examplegroup", + }) + ), description: "example description", name: "example", }); @@ -49,6 +51,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `description` - (Optional) Description of the Attribute Group. * `tags` - (Optional) A map of tags assigned to the Attribute Group. If configured with a provider [`defaultTags` 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. @@ -72,7 +75,7 @@ import { TerraformStack } from "cdktf"; * Provider bindings are generated by running `cdktf get`. * See https://cdk.tf/provider-generation for more details. */ -import { ServicecatalogappregistryAttributeGroup } from "./.gen/providers/aws/"; +import { ServicecatalogappregistryAttributeGroup } from "./.gen/providers/aws/servicecatalogappregistry-attribute-group"; class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); @@ -92,4 +95,4 @@ Using `terraform import`, import Service Catalog AppRegistry Attribute Group usi % terraform import aws_servicecatalogappregistry_attribute_group.example 1234567890abcfedhijk09876s ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/servicecatalogappregistry_attribute_group_association.html.markdown b/website/docs/cdktf/typescript/r/servicecatalogappregistry_attribute_group_association.html.markdown index 07988fcdd4cf..0acf327b8492 100644 --- a/website/docs/cdktf/typescript/r/servicecatalogappregistry_attribute_group_association.html.markdown +++ b/website/docs/cdktf/typescript/r/servicecatalogappregistry_attribute_group_association.html.markdown @@ -69,8 +69,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `applicationId` - (Required) ID of the application. * `attributeGroupId` - (Required) ID of the attribute group to associate with the application. @@ -110,4 +111,4 @@ Using `terraform import`, import Service Catalog AppRegistry Attribute Group Ass % terraform import aws_servicecatalogappregistry_attribute_group_association.example 12456778723424sdffsdfsdq34,12234t3564dsfsdf34asff4ww3 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/servicequotas_service_quota.html.markdown b/website/docs/cdktf/typescript/r/servicequotas_service_quota.html.markdown index 19a1483eac82..e3459b5552f8 100644 --- a/website/docs/cdktf/typescript/r/servicequotas_service_quota.html.markdown +++ b/website/docs/cdktf/typescript/r/servicequotas_service_quota.html.markdown @@ -42,6 +42,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `quotaCode` - (Required) Code of the service quota to track. For example: `L-F678F1CE`. Available values can be found with the [AWS CLI service-quotas list-service-quotas command](https://docs.aws.amazon.com/cli/latest/reference/service-quotas/list-service-quotas.html). * `serviceCode` - (Required) Code of the service to track. For example: `vpc`. Available values can be found with the [AWS CLI service-quotas list-services command](https://docs.aws.amazon.com/cli/latest/reference/service-quotas/list-services.html). * `value` - (Required) Float specifying the desired value for the service quota. If the desired value is higher than the current value, a quota increase request is submitted. When a known request is submitted and pending, the value reflects the desired value of the pending request. @@ -102,4 +103,4 @@ Using `terraform import`, import `aws_servicequotas_service_quota` using the ser % terraform import aws_servicequotas_service_quota.example vpc/L-F678F1CE ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/servicequotas_template.html.markdown b/website/docs/cdktf/typescript/r/servicequotas_template.html.markdown index e1271a83c21c..a02e63e29ecf 100644 --- a/website/docs/cdktf/typescript/r/servicequotas_template.html.markdown +++ b/website/docs/cdktf/typescript/r/servicequotas_template.html.markdown @@ -6,6 +6,7 @@ description: |- Terraform resource for managing an AWS Service Quotas Template. --- + # Resource: aws_servicequotas_template @@ -30,8 +31,8 @@ class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); new ServicequotasTemplate(this, "example", { + awsRegion: "us-east-1", quotaCode: "L-2ACBD22F", - region: "us-east-1", serviceCode: "lambda", value: Token.asNumber("80"), }); @@ -42,9 +43,10 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This resource supports the following arguments: -* `region` - (Required) AWS Region to which the template applies. +* `awsRegion` - (Optional) AWS Region to which the template applies. +* `region` - (Optional, **Deprecated**) AWS Region to which the template applies. Use `awsRegion` instead. * `quotaCode` - (Required) Quota identifier. To find the quota code for a specific quota, use the [aws_servicequotas_service_quota](../d/servicequotas_service_quota.html.markdown) data source. * `serviceCode` - (Required) Service identifier. To find the service code value for an AWS service, use the [aws_servicequotas_service](../d/servicequotas_service.html.markdown) data source. * `value` - (Required) The new, increased value for the quota. @@ -91,4 +93,4 @@ Using `terraform import`, import Service Quotas Template using the `id`. For exa % terraform import aws_servicequotas_template.example us-east-1,L-2ACBD22F,lambda ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/servicequotas_template_association.html.markdown b/website/docs/cdktf/typescript/r/servicequotas_template_association.html.markdown index d8ea3080759b..7a2a813672d7 100644 --- a/website/docs/cdktf/typescript/r/servicequotas_template_association.html.markdown +++ b/website/docs/cdktf/typescript/r/servicequotas_template_association.html.markdown @@ -39,6 +39,7 @@ class MyConvertedCode extends TerraformStack { The following arguments are optional: +* `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). * `skipDestroy` - (Optional) Skip disassociating the quota increase template upon destruction. This will remove the resource from Terraform state, but leave the remote association in place. ## Attribute Reference @@ -80,4 +81,4 @@ Using `terraform import`, import Service Quotas Template Association using the ` % terraform import aws_servicequotas_template_association.example 123456789012 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ses_active_receipt_rule_set.html.markdown b/website/docs/cdktf/typescript/r/ses_active_receipt_rule_set.html.markdown index fb7d38f39ee9..49c0c1258ac0 100644 --- a/website/docs/cdktf/typescript/r/ses_active_receipt_rule_set.html.markdown +++ b/website/docs/cdktf/typescript/r/ses_active_receipt_rule_set.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `ruleSetName` - (Required) The name of the rule set ## Attribute Reference @@ -79,4 +80,4 @@ Using `terraform import`, import active SES receipt rule sets using the rule set % terraform import aws_ses_active_receipt_rule_set.my_rule_set my_rule_set_name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ses_configuration_set.html.markdown b/website/docs/cdktf/typescript/r/ses_configuration_set.html.markdown index cc136657e441..e428cdbbc2a1 100644 --- a/website/docs/cdktf/typescript/r/ses_configuration_set.html.markdown +++ b/website/docs/cdktf/typescript/r/ses_configuration_set.html.markdown @@ -94,6 +94,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `deliveryOptions` - (Optional) Whether messages that use the configuration set are required to use TLS. See below. * `reputationMetricsEnabled` - (Optional) Whether or not Amazon SES publishes reputation metrics for the configuration set, such as bounce and complaint rates, to Amazon CloudWatch. The default value is `false`. * `sendingEnabled` - (Optional) Whether email sending is enabled or disabled for the configuration set. The default value is `true`. @@ -147,4 +148,4 @@ Using `terraform import`, import SES Configuration Sets using their `name`. For % terraform import aws_ses_configuration_set.test some-configuration-set-test ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ses_domain_dkim.html.markdown b/website/docs/cdktf/typescript/r/ses_domain_dkim.html.markdown index f86ff5786d60..ad3cc2f2cca7 100644 --- a/website/docs/cdktf/typescript/r/ses_domain_dkim.html.markdown +++ b/website/docs/cdktf/typescript/r/ses_domain_dkim.html.markdown @@ -18,6 +18,7 @@ Domain ownership needs to be confirmed first using [ses_domain_identity Resource This resource supports the following arguments: +* `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). * `domain` - (Required) Verified domain name to generate DKIM tokens for. ## Attribute Reference @@ -114,4 +115,4 @@ Using `terraform import`, import DKIM tokens using the `domain` attribute. For e % terraform import aws_ses_domain_dkim.example example.com ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ses_domain_identity.html.markdown b/website/docs/cdktf/typescript/r/ses_domain_identity.html.markdown index 551c811759c3..beb6b417a7c5 100644 --- a/website/docs/cdktf/typescript/r/ses_domain_identity.html.markdown +++ b/website/docs/cdktf/typescript/r/ses_domain_identity.html.markdown @@ -70,6 +70,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `domain` - (Required) The domain name to assign to SES ## Attribute Reference @@ -107,4 +108,4 @@ Using `terraform import`, import SES domain identities using the domain name. Fo % terraform import aws_ses_domain_identity.example example.com ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ses_domain_identity_verification.html.markdown b/website/docs/cdktf/typescript/r/ses_domain_identity_verification.html.markdown index 0ffb2314b1df..9e07485832b0 100644 --- a/website/docs/cdktf/typescript/r/ses_domain_identity_verification.html.markdown +++ b/website/docs/cdktf/typescript/r/ses_domain_identity_verification.html.markdown @@ -61,6 +61,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `domain` - (Required) The domain name of the SES domain identity to verify. ## Attribute Reference @@ -76,4 +77,4 @@ This resource exports the following attributes in addition to the arguments abov - `create` - (Default `45m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ses_domain_mail_from.html.markdown b/website/docs/cdktf/typescript/r/ses_domain_mail_from.html.markdown index 71ca596a0c7f..dfbaf8bcd855 100644 --- a/website/docs/cdktf/typescript/r/ses_domain_mail_from.html.markdown +++ b/website/docs/cdktf/typescript/r/ses_domain_mail_from.html.markdown @@ -106,6 +106,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `behaviorOnMxFailure` - (Optional) The action that you want Amazon SES to take if it cannot successfully read the required MX record when you send an email. Defaults to `UseDefaultValue`. See the [SES API documentation](https://docs.aws.amazon.com/ses/latest/APIReference/API_SetIdentityMailFromDomain.html) for more information. ## Attribute Reference @@ -142,4 +143,4 @@ Using `terraform import`, import MAIL FROM domain using the `domain` attribute. % terraform import aws_ses_domain_mail_from.example example.com ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ses_email_identity.html.markdown b/website/docs/cdktf/typescript/r/ses_email_identity.html.markdown index 0e050588029b..d02e4d634fdf 100644 --- a/website/docs/cdktf/typescript/r/ses_email_identity.html.markdown +++ b/website/docs/cdktf/typescript/r/ses_email_identity.html.markdown @@ -16,6 +16,7 @@ Provides an SES email identity resource This resource supports the following arguments: +* `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). * `email` - (Required) The email address to assign to SES. ## Attribute Reference @@ -78,4 +79,4 @@ Using `terraform import`, import SES email identities using the email address. F % terraform import aws_ses_email_identity.example email@example.com ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ses_event_destination.html.markdown b/website/docs/cdktf/typescript/r/ses_event_destination.html.markdown index 85fc8c9589ad..e1f3898b4b31 100644 --- a/website/docs/cdktf/typescript/r/ses_event_destination.html.markdown +++ b/website/docs/cdktf/typescript/r/ses_event_destination.html.markdown @@ -107,6 +107,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) The name of the event destination * `configurationSetName` - (Required) The name of the configuration set * `enabled` - (Optional) If true, the event destination will be enabled @@ -171,4 +172,4 @@ Using `terraform import`, import SES event destinations using `configurationSetN % terraform import aws_ses_event_destination.sns some-configuration-set-test/event-destination-sns ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ses_identity_notification_topic.html.markdown b/website/docs/cdktf/typescript/r/ses_identity_notification_topic.html.markdown index bbfe04f0249d..ddfe2b88bdbd 100644 --- a/website/docs/cdktf/typescript/r/ses_identity_notification_topic.html.markdown +++ b/website/docs/cdktf/typescript/r/ses_identity_notification_topic.html.markdown @@ -41,6 +41,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `topicArn` - (Optional) The Amazon Resource Name (ARN) of the Amazon SNS topic. Can be set to `""` (an empty string) to disable publishing. * `notificationType` - (Required) The type of notifications that will be published to the specified Amazon SNS topic. Valid Values: `Bounce`, `Complaint` or `Delivery`. * `identity` - (Required) The identity for which the Amazon SNS topic will be set. You can specify an identity by using its name or by using its Amazon Resource Name (ARN). @@ -82,4 +83,4 @@ Using `terraform import`, import Identity Notification Topics using the ID of th % terraform import aws_ses_identity_notification_topic.test 'example.com|Bounce' ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ses_identity_policy.html.markdown b/website/docs/cdktf/typescript/r/ses_identity_policy.html.markdown index 56a872d934e0..3a970aa58b90 100644 --- a/website/docs/cdktf/typescript/r/ses_identity_policy.html.markdown +++ b/website/docs/cdktf/typescript/r/ses_identity_policy.html.markdown @@ -71,6 +71,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `identity` - (Required) Name or Amazon Resource Name (ARN) of the SES Identity. * `name` - (Required) Name of the policy. * `policy` - (Required) JSON string of the policy. For more information about building AWS IAM policy documents with Terraform, see the [AWS IAM Policy Document Guide](https://learn.hashicorp.com/terraform/aws/iam-policy). @@ -111,4 +112,4 @@ Using `terraform import`, import SES Identity Policies using the identity and po % terraform import aws_ses_identity_policy.example 'example.com|example' ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ses_receipt_filter.html.markdown b/website/docs/cdktf/typescript/r/ses_receipt_filter.html.markdown index 1916da35e658..d8544292af55 100644 --- a/website/docs/cdktf/typescript/r/ses_receipt_filter.html.markdown +++ b/website/docs/cdktf/typescript/r/ses_receipt_filter.html.markdown @@ -40,6 +40,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) The name of the filter * `cidr` - (Required) The IP address or address range to filter, in CIDR notation * `policy` - (Required) Block or Allow @@ -79,4 +80,4 @@ Using `terraform import`, import SES Receipt Filter using their `name`. For exam % terraform import aws_ses_receipt_filter.test some-filter ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ses_receipt_rule.html.markdown b/website/docs/cdktf/typescript/r/ses_receipt_rule.html.markdown index 6f6023a193f8..4da9ae75358f 100644 --- a/website/docs/cdktf/typescript/r/ses_receipt_rule.html.markdown +++ b/website/docs/cdktf/typescript/r/ses_receipt_rule.html.markdown @@ -55,6 +55,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) The name of the rule * `ruleSetName` - (Required) The name of the rule set * `after` - (Optional) The name of the rule to place this rule after @@ -158,4 +159,4 @@ Using `terraform import`, import SES receipt rules using the ruleset name and ru % terraform import aws_ses_receipt_rule.my_rule my_rule_set:my_rule ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ses_receipt_rule_set.html.markdown b/website/docs/cdktf/typescript/r/ses_receipt_rule_set.html.markdown index 8a4403239c0d..3b87c76043af 100644 --- a/website/docs/cdktf/typescript/r/ses_receipt_rule_set.html.markdown +++ b/website/docs/cdktf/typescript/r/ses_receipt_rule_set.html.markdown @@ -38,6 +38,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `ruleSetName` - (Required) Name of the rule set. ## Attribute Reference @@ -79,4 +80,4 @@ Using `terraform import`, import SES receipt rule sets using the rule set name. % terraform import aws_ses_receipt_rule_set.my_rule_set my_rule_set_name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ses_template.html.markdown b/website/docs/cdktf/typescript/r/ses_template.html.markdown index 813e14f40c80..f6bde4884279 100644 --- a/website/docs/cdktf/typescript/r/ses_template.html.markdown +++ b/website/docs/cdktf/typescript/r/ses_template.html.markdown @@ -41,6 +41,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) The name of the template. Cannot exceed 64 characters. You will refer to this name when you send email. * `html` - (Optional) The HTML body of the email. Must be less than 500KB in size, including both the text and HTML parts. * `subject` - (Optional) The subject line of the email. @@ -81,4 +82,4 @@ Using `terraform import`, import SES templates using the template name. For exam % terraform import aws_ses_template.MyTemplate MyTemplate ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/sesv2_account_suppression_attributes.html.markdown b/website/docs/cdktf/typescript/r/sesv2_account_suppression_attributes.html.markdown index 41db2e5ab239..d5cf5d29081f 100644 --- a/website/docs/cdktf/typescript/r/sesv2_account_suppression_attributes.html.markdown +++ b/website/docs/cdktf/typescript/r/sesv2_account_suppression_attributes.html.markdown @@ -36,8 +36,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `suppressedReasons` - (Required) A list that contains the reasons that email addresses will be automatically added to the suppression list for your account. Valid values: `COMPLAINT`, `BOUNCE`. ## Attribute Reference @@ -76,4 +77,4 @@ Using `terraform import`, import account-level suppression attributes using the % terraform import aws_sesv2_account_suppression_attributes.example 123456789012 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/sesv2_account_vdm_attributes.html.markdown b/website/docs/cdktf/typescript/r/sesv2_account_vdm_attributes.html.markdown index 6a8ffad05209..70a9f2a6e60c 100644 --- a/website/docs/cdktf/typescript/r/sesv2_account_vdm_attributes.html.markdown +++ b/website/docs/cdktf/typescript/r/sesv2_account_vdm_attributes.html.markdown @@ -50,6 +50,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `dashboardAttributes` - (Optional) Specifies additional settings for your VDM configuration as applicable to the Dashboard. * `guardianAttributes` - (Optional) Specifies additional settings for your VDM configuration as applicable to the Guardian. @@ -97,4 +98,4 @@ Using `terraform import`, import SESv2 (Simple Email V2) Account VDM Attributes % terraform import aws_sesv2_account_vdm_attributes.example ses-account-vdm-attributes ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/sesv2_configuration_set.html.markdown b/website/docs/cdktf/typescript/r/sesv2_configuration_set.html.markdown index bf167638ff95..05ff88b8d2b8 100644 --- a/website/docs/cdktf/typescript/r/sesv2_configuration_set.html.markdown +++ b/website/docs/cdktf/typescript/r/sesv2_configuration_set.html.markdown @@ -57,6 +57,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `configurationSetName` - (Required) The name of the configuration set. * `deliveryOptions` - (Optional) An object that defines the dedicated IP pool that is used to send emails that you send using the configuration set. See [`deliveryOptions` Block](#delivery_options-block) for details. * `reputationOptions` - (Optional) An object that defines whether or not Amazon SES collects reputation metrics for the emails that you send that use the configuration set. See [`reputationOptions` Block](#reputation_options-block) for details. @@ -154,4 +155,4 @@ Using `terraform import`, import SESv2 (Simple Email V2) Configuration Set using % terraform import aws_sesv2_configuration_set.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/sesv2_configuration_set_event_destination.html.markdown b/website/docs/cdktf/typescript/r/sesv2_configuration_set_event_destination.html.markdown index 45ac055eb7eb..d5d5239c3199 100644 --- a/website/docs/cdktf/typescript/r/sesv2_configuration_set_event_destination.html.markdown +++ b/website/docs/cdktf/typescript/r/sesv2_configuration_set_event_destination.html.markdown @@ -217,8 +217,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `configurationSetName` - (Required) The name of the configuration set. * `eventDestination` - (Required) A name that identifies the event destination within the configuration set. * `eventDestinationName` - (Required) An object that defines the event destination. See [`eventDestination` Block](#event_destination-block) for details. @@ -230,7 +231,7 @@ The `eventDestination` configuration block supports the following arguments: * `matchingEventTypes` - (Required) - An array that specifies which events the Amazon SES API v2 should send to the destinations. Valid values: `SEND`, `REJECT`, `BOUNCE`, `COMPLAINT`, `DELIVERY`, `OPEN`, `CLICK`, `RENDERING_FAILURE`, `DELIVERY_DELAY`, `SUBSCRIPTION`. * `cloudWatchDestination` - (Optional) An object that defines an Amazon CloudWatch destination for email events. See [`cloudWatchDestination` Block](#cloud_watch_destination-block) for details. * `enabled` - (Optional) When the event destination is enabled, the specified event types are sent to the destinations. Default: `false`. -* `event_bridge_configuration` - (Optional) An object that defines an Amazon EventBridge destination for email events. You can use Amazon EventBridge to send notifications when certain email events occur. See [`event_bridge_configuration` Block](#event_bridge_configuration-block) for details. +* `eventBridgeDestination` - (Optional) An object that defines an Amazon EventBridge destination for email events. You can use Amazon EventBridge to send notifications when certain email events occur. See [`eventBridgeDestination` Block](#event_bridge_destination-block) for details. * `kinesisFirehoseDestination` - (Optional) An object that defines an Amazon Kinesis Data Firehose destination for email events. See [`kinesisFirehoseDestination` Block](#kinesis_firehose_destination-block) for details. * `pinpointDestination` - (Optional) An object that defines an Amazon Pinpoint project destination for email events. See [`pinpointDestination` Block](#pinpoint_destination-block) for details. * `snsDestination` - (Optional) An object that defines an Amazon SNS destination for email events. See [`snsDestination` Block](#sns_destination-block) for details. @@ -249,9 +250,9 @@ The `dimensionConfiguration` configuration block supports the following argument * `dimensionName` - (Required) The name of an Amazon CloudWatch dimension associated with an email sending metric. * `dimensionValueSource` - (Required) The location where the Amazon SES API v2 finds the value of a dimension to publish to Amazon CloudWatch. Valid values: `MESSAGE_TAG`, `EMAIL_HEADER`, `LINK_TAG`. -### `event_bridge_configuration` Block +### `eventBridgeDestination` Block -The `event_bridge_configuration` configuration block supports the following arguments: +The `eventBridgeDestination` configuration block supports the following arguments: * `eventBusArn` - (Required) The Amazon Resource Name (ARN) of the Amazon EventBridge bus to publish email events to. Only the default bus is supported. @@ -312,4 +313,4 @@ Using `terraform import`, import SESv2 (Simple Email V2) Configuration Set Event % terraform import aws_sesv2_configuration_set_event_destination.example example_configuration_set|example_event_destination ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/sesv2_contact_list.html.markdown b/website/docs/cdktf/typescript/r/sesv2_contact_list.html.markdown index cfad306a3918..472d345d4b20 100644 --- a/website/docs/cdktf/typescript/r/sesv2_contact_list.html.markdown +++ b/website/docs/cdktf/typescript/r/sesv2_contact_list.html.markdown @@ -75,6 +75,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `description` - (Optional) Description of what the contact list is about. * `tags` - (Optional) Key-value map of resource tags for the contact list. If configured with a provider [`defaultTags` 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. * `topic` - (Optional) Configuration block(s) with topic for the contact list. Detailed below. @@ -89,6 +90,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `description` - (Optional) Description of what the topic is about, which the contact will see. ## Attribute Reference @@ -127,4 +129,4 @@ Using `terraform import`, import SESv2 (Simple Email V2) Contact List using the % terraform import aws_sesv2_contact_list.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/sesv2_dedicated_ip_assignment.html.markdown b/website/docs/cdktf/typescript/r/sesv2_dedicated_ip_assignment.html.markdown index 6978b0894460..bf97c9fd70ea 100644 --- a/website/docs/cdktf/typescript/r/sesv2_dedicated_ip_assignment.html.markdown +++ b/website/docs/cdktf/typescript/r/sesv2_dedicated_ip_assignment.html.markdown @@ -41,8 +41,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `ip` - (Required) Dedicated IP address. * `destinationPoolName` - (Required) Dedicated IP address. @@ -84,4 +85,4 @@ Using `terraform import`, import SESv2 (Simple Email V2) Dedicated IP Assignment % terraform import aws_sesv2_dedicated_ip_assignment.example "0.0.0.0,my-pool" ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/sesv2_dedicated_ip_pool.html.markdown b/website/docs/cdktf/typescript/r/sesv2_dedicated_ip_pool.html.markdown index ecb173763229..ea6734a9379a 100644 --- a/website/docs/cdktf/typescript/r/sesv2_dedicated_ip_pool.html.markdown +++ b/website/docs/cdktf/typescript/r/sesv2_dedicated_ip_pool.html.markdown @@ -67,6 +67,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `scalingMode` - (Optional) IP pool scaling mode. Valid values: `STANDARD`, `MANAGED`. If omitted, the AWS API will default to a standard pool. * `tags` - (Optional) A map of tags to assign to the pool. If configured with a provider [`defaultTags` 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. @@ -104,4 +105,4 @@ Using `terraform import`, import SESv2 (Simple Email V2) Dedicated IP Pool using % terraform import aws_sesv2_dedicated_ip_pool.example my-pool ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/sesv2_email_identity.html.markdown b/website/docs/cdktf/typescript/r/sesv2_email_identity.html.markdown index 1425b9723afd..93863be49f20 100644 --- a/website/docs/cdktf/typescript/r/sesv2_email_identity.html.markdown +++ b/website/docs/cdktf/typescript/r/sesv2_email_identity.html.markdown @@ -128,6 +128,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `configurationSetName` - (Optional) The configuration set to use by default when sending from this identity. Note that any configuration set defined in the email sending request takes precedence. * `dkimSigningAttributes` - (Optional) The configuration of the DKIM authentication settings for an email domain identity. * `tags` - (Optional) Key-value mapping of resource tags. If configured with a provider [`defaultTags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. @@ -155,6 +156,7 @@ This resource exports the following attributes in addition to the arguments abov * `tokens` - If you used Easy DKIM to configure DKIM authentication for the domain, then this object contains a set of unique strings that you use to create a set of CNAME records that you add to the DNS configuration for your domain. When Amazon SES detects these records in the DNS configuration for your domain, the DKIM authentication process is complete. If you configured DKIM authentication for the domain by providing your own public-private key pair, then this object contains the selector for the public key. * `identityType` - The email identity type. Valid values: `EMAIL_ADDRESS`, `DOMAIN`. * `tagsAll` - Map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block). +* `verificationStatus` - The verification status of the identity. The status can be one of the following: `PENDING`, `SUCCESS`, `FAILED`, `TEMPORARY_FAILURE`, and `NOT_STARTED`. * `verifiedForSendingStatus` - Specifies whether or not the identity is verified. ## Import @@ -185,4 +187,4 @@ Using `terraform import`, import SESv2 (Simple Email V2) Email Identity using th % terraform import aws_sesv2_email_identity.example example.com ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/sesv2_email_identity_feedback_attributes.html.markdown b/website/docs/cdktf/typescript/r/sesv2_email_identity_feedback_attributes.html.markdown index 17ee3f2614a9..fe0233e6edae 100644 --- a/website/docs/cdktf/typescript/r/sesv2_email_identity_feedback_attributes.html.markdown +++ b/website/docs/cdktf/typescript/r/sesv2_email_identity_feedback_attributes.html.markdown @@ -48,6 +48,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `emailIdentity` - (Required) The email identity. * `emailForwardingEnabled` - (Optional) Sets the feedback forwarding configuration for the identity. @@ -87,4 +88,4 @@ Using `terraform import`, import SESv2 (Simple Email V2) Email Identity Feedback % terraform import aws_sesv2_email_identity_feedback_attributes.example example.com ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/sesv2_email_identity_mail_from_attributes.html.markdown b/website/docs/cdktf/typescript/r/sesv2_email_identity_mail_from_attributes.html.markdown index 42bc5663a580..9366d622dd1d 100644 --- a/website/docs/cdktf/typescript/r/sesv2_email_identity_mail_from_attributes.html.markdown +++ b/website/docs/cdktf/typescript/r/sesv2_email_identity_mail_from_attributes.html.markdown @@ -49,6 +49,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `emailIdentity` - (Required) The verified email identity. * `behaviorOnMxFailure` - (Optional) The action to take if the required MX record isn't found when you send an email. Valid values: `USE_DEFAULT_VALUE`, `REJECT_MESSAGE`. * `mailFromDomain` - (Optional) The custom MAIL FROM domain that you want the verified identity to use. Required if `behaviorOnMxFailure` is `REJECT_MESSAGE`. @@ -89,4 +90,4 @@ Using `terraform import`, import SESv2 (Simple Email V2) Email Identity Mail Fro % terraform import aws_sesv2_email_identity_mail_from_attributes.example example.com ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/sesv2_email_identity_policy.html.markdown b/website/docs/cdktf/typescript/r/sesv2_email_identity_policy.html.markdown index d5a3faa37ed6..85a90970c88a 100644 --- a/website/docs/cdktf/typescript/r/sesv2_email_identity_policy.html.markdown +++ b/website/docs/cdktf/typescript/r/sesv2_email_identity_policy.html.markdown @@ -52,8 +52,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `emailIdentity` - (Required) The email identity. * `policyName` - (Required) - The name of the policy. * `policy` - (Required) - The text of the policy in JSON format. @@ -64,7 +65,7 @@ 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 SESv2 (Simple Email V2) Email Identity Policy using the `id` (`email_identity|policy_name`). For example: +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import SESv2 (Simple Email V2) Email Identity Policy using the `emailIdentity` and `policyName` separated by `|`. For example: ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -88,10 +89,10 @@ class MyConvertedCode extends TerraformStack { ``` -Using `terraform import`, import SESv2 (Simple Email V2) Email Identity Policy using the `example_id_arg`. For example: +Using `terraform import`, import SESv2 (Simple Email V2) Email Identity Policy using the `emailIdentity` and `policyName` separated by `|`. For example: ```console % terraform import aws_sesv2_email_identity_policy.example example_email_identity|example_policy_name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/sfn_activity.html.markdown b/website/docs/cdktf/typescript/r/sfn_activity.html.markdown index 7c24af9b756d..17c79aef2e59 100644 --- a/website/docs/cdktf/typescript/r/sfn_activity.html.markdown +++ b/website/docs/cdktf/typescript/r/sfn_activity.html.markdown @@ -69,6 +69,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `encryptionConfiguration` - (Optional) Defines what encryption configuration is used to encrypt data in the Activity. For more information see the section [Data at rest encyption](https://docs.aws.amazon.com/step-functions/latest/dg/encryption-at-rest.html) in the AWS Step Functions User Guide. * `name` - (Required) The name of the activity to create. * `tags` - (Optional) Key-value map of resource tags. If configured with a provider [`defaultTags` 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. @@ -120,4 +121,4 @@ Using `terraform import`, import activities using the `arn`. For example: % terraform import aws_sfn_activity.foo arn:aws:states:eu-west-1:123456789098:activity:bar ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/sfn_alias.html.markdown b/website/docs/cdktf/typescript/r/sfn_alias.html.markdown index 92d08766684c..a706d2906673 100644 --- a/website/docs/cdktf/typescript/r/sfn_alias.html.markdown +++ b/website/docs/cdktf/typescript/r/sfn_alias.html.markdown @@ -61,6 +61,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) Name for the alias you are creating. * `description` - (Optional) Description of the alias. * `routingConfiguration` - (Required) The StateMachine alias' route configuration settings. Fields documented below @@ -109,4 +110,4 @@ Using `terraform import`, import SFN (Step Functions) Alias using the `arn`. For % terraform import aws_sfn_alias.foo arn:aws:states:us-east-1:123456789098:stateMachine:myStateMachine:foo ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/sfn_state_machine.html.markdown b/website/docs/cdktf/typescript/r/sfn_state_machine.html.markdown index 99ec5fa80044..405a86a7d3e0 100644 --- a/website/docs/cdktf/typescript/r/sfn_state_machine.html.markdown +++ b/website/docs/cdktf/typescript/r/sfn_state_machine.html.markdown @@ -170,6 +170,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `definition` - (Required) The [Amazon States Language](https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html) definition of the state machine. * `encryptionConfiguration` - (Optional) Defines what encryption configuration is used to encrypt data in the State Machine. For more information see [TBD] in the AWS Step Functions User Guide. * `loggingConfiguration` - (Optional) Defines what execution history events are logged and where they are logged. The `loggingConfiguration` parameter is valid when `type` is set to `STANDARD` or `EXPRESS`. Defaults to `OFF`. For more information see [Logging Express Workflows](https://docs.aws.amazon.com/step-functions/latest/dg/cw-logs.html), [Log Levels](https://docs.aws.amazon.com/step-functions/latest/dg/cloudwatch-log-level.html) and [Logging Configuration](https://docs.aws.amazon.com/step-functions/latest/apireference/API_CreateStateMachine.html) in the AWS Step Functions User Guide. @@ -248,4 +249,4 @@ Using `terraform import`, import State Machines using the `arn`. For example: % terraform import aws_sfn_state_machine.foo arn:aws:states:eu-west-1:123456789098:stateMachine:bar ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/shield_drt_access_log_bucket_association.html.markdown b/website/docs/cdktf/typescript/r/shield_drt_access_log_bucket_association.html.markdown index d07cd20bc76f..579248961f41 100644 --- a/website/docs/cdktf/typescript/r/shield_drt_access_log_bucket_association.html.markdown +++ b/website/docs/cdktf/typescript/r/shield_drt_access_log_bucket_association.html.markdown @@ -33,7 +33,7 @@ class MyConvertedCode extends TerraformStack { const test = new ShieldDrtAccessRoleArnAssociation(this, "test", { roleArn: "arn:aws:iam:${" + - current.name + + current.region + "}:${" + dataAwsCallerIdentityCurrent.accountId + "}:${" + @@ -102,4 +102,4 @@ Using `terraform import`, import Shield DRT access log bucket associations using % terraform import aws_shield_drt_access_log_bucket_association.example example-bucket ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/shield_protection.html.markdown b/website/docs/cdktf/typescript/r/shield_protection.html.markdown index 883dccc59fb0..e72a5965992b 100644 --- a/website/docs/cdktf/typescript/r/shield_protection.html.markdown +++ b/website/docs/cdktf/typescript/r/shield_protection.html.markdown @@ -45,7 +45,7 @@ class MyConvertedCode extends TerraformStack { name: "example", resourceArn: "arn:aws:ec2:${" + - dataAwsRegionCurrent.name + + dataAwsRegionCurrent.region + "}:${" + current.accountId + "}:eip-allocation/${" + @@ -110,4 +110,4 @@ Using `terraform import`, import Shield protection resources using specifying th % terraform import aws_shield_protection.example ff9592dc-22f3-4e88-afa1-7b29fde9669a ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/shield_protection_group.html.markdown b/website/docs/cdktf/typescript/r/shield_protection_group.html.markdown index d56da1c0a178..f4794cc3dd3d 100644 --- a/website/docs/cdktf/typescript/r/shield_protection_group.html.markdown +++ b/website/docs/cdktf/typescript/r/shield_protection_group.html.markdown @@ -69,7 +69,7 @@ class MyConvertedCode extends TerraformStack { name: "example", resourceArn: "arn:aws:ec2:${" + - dataAwsRegionCurrent.name + + dataAwsRegionCurrent.region + "}:${" + current.accountId + "}:eip-allocation/${" + @@ -86,7 +86,7 @@ class MyConvertedCode extends TerraformStack { dependsOn: [awsShieldProtectionExample], members: [ "arn:aws:ec2:${" + - dataAwsRegionCurrent.name + + dataAwsRegionCurrent.region + "}:${" + current.accountId + "}:eip-allocation/${" + @@ -175,4 +175,4 @@ Using `terraform import`, import Shield protection group resources using their p % terraform import aws_shield_protection_group.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/shield_protection_health_check_association.html.markdown b/website/docs/cdktf/typescript/r/shield_protection_health_check_association.html.markdown index 9d811206f1ff..57fd8a9c4d38 100644 --- a/website/docs/cdktf/typescript/r/shield_protection_health_check_association.html.markdown +++ b/website/docs/cdktf/typescript/r/shield_protection_health_check_association.html.markdown @@ -73,7 +73,7 @@ class MyConvertedCode extends TerraformStack { "arn:${" + dataAwsPartitionCurrent.partition + "}:ec2:${" + - dataAwsRegionCurrent.name + + dataAwsRegionCurrent.region + "}:${" + current.accountId + "}:eip-allocation/${" + @@ -141,4 +141,4 @@ Using `terraform import`, import Shield protection health check association reso % terraform import aws_shield_protection_health_check_association.example ff9592dc-22f3-4e88-afa1-7b29fde9669a+arn:aws:route53:::healthcheck/3742b175-edb9-46bc-9359-f53e3b794b1b ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/signer_signing_job.html.markdown b/website/docs/cdktf/typescript/r/signer_signing_job.html.markdown index 0a53f3240ead..6c45f683db4c 100644 --- a/website/docs/cdktf/typescript/r/signer_signing_job.html.markdown +++ b/website/docs/cdktf/typescript/r/signer_signing_job.html.markdown @@ -56,6 +56,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `profileName` - (Required) The name of the profile to initiate the signing operation. * `source` - (Required) The S3 bucket that contains the object to sign. See [Source](#source) below for details. * `destination` - (Required) The S3 bucket in which to save your signed object. See [Destination](#destination) below for details. @@ -139,4 +140,4 @@ Using `terraform import`, import Signer signing jobs using the `jobId`. For exam % terraform import aws_signer_signing_job.test_signer_signing_job 9ed7e5c3-b8d4-4da0-8459-44e0b068f7ee ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/signer_signing_profile.html.markdown b/website/docs/cdktf/typescript/r/signer_signing_profile.html.markdown index 34f84ef3c3dd..ee7e736a971c 100644 --- a/website/docs/cdktf/typescript/r/signer_signing_profile.html.markdown +++ b/website/docs/cdktf/typescript/r/signer_signing_profile.html.markdown @@ -50,11 +50,13 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `platformId` - (Required, Forces new resource) The ID of the platform that is used by the target signing profile. * `name` - (Optional, Forces new resource) A unique signing profile name. By default generated by Terraform. Signing profile names are immutable and cannot be reused after canceled. * `namePrefix` - (Optional, Forces new resource) A signing profile name prefix. Terraform will generate a unique suffix. Conflicts with `name`. * `signatureValidityPeriod` - (Optional, Forces new resource) The validity period for a signing job. See [`signatureValidityPeriod` Block](#signature_validity_period-block) below for details. * `signingMaterial` - (Optional, Forces new resource) The AWS Certificate Manager certificate that will be used to sign code with the new signing profile. See [`signingMaterial` Block](#signing_material-block) below for details. +* `signing_parameters` - (Optional, Forces new resource) Map of key-value pairs for signing. These can include any information that you want to use during signing. * `tags` - (Optional) A list of tags associated with the signing profile. If configured with a provider [`defaultTags` 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. ### `signatureValidityPeriod` Block @@ -123,4 +125,4 @@ Using `terraform import`, import Signer signing profiles using the `name`. For e % terraform import aws_signer_signing_profile.test_signer_signing_profile test_sp_DdW3Mk1foYL88fajut4mTVFGpuwfd4ACO6ANL0D1uIj7lrn8adK ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/signer_signing_profile_permission.html.markdown b/website/docs/cdktf/typescript/r/signer_signing_profile_permission.html.markdown index 4900e3721caa..6c40b51c7df6 100644 --- a/website/docs/cdktf/typescript/r/signer_signing_profile_permission.html.markdown +++ b/website/docs/cdktf/typescript/r/signer_signing_profile_permission.html.markdown @@ -66,6 +66,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `profileName` - (Required) Name of the signing profile to add the cross-account permissions. * `action` - (Required) An AWS Signer action permitted as part of cross-account permissions. Valid values: `signer:StartSigningJob`, `signer:GetSigningProfile`, `signer:RevokeSignature`, or `signer:SignPayload`. * `principal` - (Required) The AWS principal to be granted a cross-account permission. @@ -109,4 +110,4 @@ Using `terraform import`, import Signer signing profile permission statements us % terraform import aws_signer_signing_profile_permission.test_signer_signing_profile_permission prod_profile_DdW3Mk1foYL88fajut4mTVFGpuwfd4ACO6ANL0D1uIj7lrn8adK/ProdAccountStartSigningJobStatementId ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/snapshot_create_volume_permission.html.markdown b/website/docs/cdktf/typescript/r/snapshot_create_volume_permission.html.markdown index 6ec31f8bbb76..97ff166c5b91 100644 --- a/website/docs/cdktf/typescript/r/snapshot_create_volume_permission.html.markdown +++ b/website/docs/cdktf/typescript/r/snapshot_create_volume_permission.html.markdown @@ -48,6 +48,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `snapshotId` - (Required) A snapshot ID * `accountId` - (Required) An AWS Account ID to add create volume permissions. The AWS Account cannot be the snapshot's owner @@ -57,4 +58,4 @@ This resource exports the following attributes in addition to the arguments abov * `id` - A combination of "`snapshotId`-`accountId`". - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/sns_platform_application.html.markdown b/website/docs/cdktf/typescript/r/sns_platform_application.html.markdown index 4c8610b9b501..0886dcf7fb98 100644 --- a/website/docs/cdktf/typescript/r/sns_platform_application.html.markdown +++ b/website/docs/cdktf/typescript/r/sns_platform_application.html.markdown @@ -94,6 +94,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) The friendly name for the SNS platform application * `platform` - (Required) The platform that the app is registered with. See [Platform][1] for supported platforms. * `platformCredential` - (Required) Application Platform credential. See [Credential][1] for type of credential required for platform. The value of this attribute when stored into the Terraform state is only a hash of the real value, so therefore it is not practical to use this as an attribute for other resources. @@ -153,4 +154,4 @@ Using `terraform import`, import SNS platform applications using the ARN. For ex % terraform import aws_sns_platform_application.gcm_application arn:aws:sns:us-west-2:123456789012:app/GCM/gcm_application ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/sns_sms_preferences.html.markdown b/website/docs/cdktf/typescript/r/sns_sms_preferences.html.markdown index 14ed8f82560e..27bc4d205509 100644 --- a/website/docs/cdktf/typescript/r/sns_sms_preferences.html.markdown +++ b/website/docs/cdktf/typescript/r/sns_sms_preferences.html.markdown @@ -36,6 +36,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `monthlySpendLimit` - (Optional) The maximum amount in USD that you are willing to spend each month to send SMS messages. * `deliveryStatusIamRoleArn` - (Optional) The ARN of the IAM role that allows Amazon SNS to write logs about SMS deliveries in CloudWatch Logs. * `deliveryStatusSuccessSamplingRate` - (Optional) The percentage of successful SMS deliveries for which Amazon SNS will write logs in CloudWatch Logs. The value must be between 0 and 100. @@ -51,4 +52,4 @@ This resource exports no additional attributes. You cannot import the SMS preferences. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/sns_topic.html.markdown b/website/docs/cdktf/typescript/r/sns_topic.html.markdown index a123275bdd5e..a9fb2715d9a2 100644 --- a/website/docs/cdktf/typescript/r/sns_topic.html.markdown +++ b/website/docs/cdktf/typescript/r/sns_topic.html.markdown @@ -113,6 +113,7 @@ The `_success_feedback_role_arn` and `_failure_feedback_role This resource supports the following arguments: +* `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). * `name` - (Optional) The name of the topic. Topic names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long. For a FIFO (first-in-first-out) topic, the name must end with the `.fifo` suffix. If omitted, Terraform will assign a random, unique name. Conflicts with `namePrefix` * `namePrefix` - (Optional) Creates a unique name beginning with the specified prefix. Conflicts with `name` * `displayName` - (Optional) The display name for the topic @@ -127,7 +128,7 @@ This resource supports the following arguments: * `kmsMasterKeyId` - (Optional) The ID of an AWS-managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see [Key Terms](https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html#sse-key-terms) * `signatureVersion` - (Optional) If `SignatureVersion` should be [1 (SHA1) or 2 (SHA256)](https://docs.aws.amazon.com/sns/latest/dg/sns-verify-signature-of-message.html). The signature version corresponds to the hashing algorithm used while creating the signature of the notifications, subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS. * `tracingConfig` - (Optional) Tracing mode of an Amazon SNS topic. Valid values: `"PassThrough"`, `"Active"`. -* `fifo_throughput_scope` - (Optional) Enables higher throughput for FIFO topics by adjusting the scope of deduplication. This attribute has two possible values, `Topic` and `MessageGroup`. For more information, see the [related documentation](https://docs.aws.amazon.com/sns/latest/dg/fifo-high-throughput.html#enable-high-throughput-on-fifo-topic). +* `fifoThroughputScope` - (Optional) Enables higher throughput for FIFO topics by adjusting the scope of deduplication. This attribute has two possible values, `Topic` and `MessageGroup`. For more information, see the [related documentation](https://docs.aws.amazon.com/sns/latest/dg/fifo-high-throughput.html#enable-high-throughput-on-fifo-topic). * `fifoTopic` - (Optional) Boolean indicating whether or not to create a FIFO (first-in-first-out) topic. FIFO topics can't deliver messages to customer managed endpoints, such as email addresses, mobile apps, SMS, or HTTP(S) endpoints. These endpoint types aren't guaranteed to preserve strict message ordering. Default is `false`. * `archivePolicy` - (Optional) The message archive policy for FIFO topics. More details in the [AWS documentation](https://docs.aws.amazon.com/sns/latest/dg/message-archiving-and-replay-topic-owner.html). * `contentBasedDeduplication` - (Optional) Enables content-based deduplication for FIFO topics. For more information, see the [related documentation](https://docs.aws.amazon.com/sns/latest/dg/fifo-message-dedup.html) @@ -184,4 +185,4 @@ Using `terraform import`, import SNS Topics using the topic `arn`. For example: % terraform import aws_sns_topic.user_updates arn:aws:sns:us-west-2:123456789012:my-topic ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/sns_topic_data_protection_policy.html.markdown b/website/docs/cdktf/typescript/r/sns_topic_data_protection_policy.html.markdown index dd155b2b7d77..c6242f845893 100644 --- a/website/docs/cdktf/typescript/r/sns_topic_data_protection_policy.html.markdown +++ b/website/docs/cdktf/typescript/r/sns_topic_data_protection_policy.html.markdown @@ -65,6 +65,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `arn` - (Required) The ARN of the SNS topic * `policy` - (Required) The fully-formed AWS policy as JSON. For more information about building AWS IAM policy documents with Terraform, see the [AWS IAM Policy Document Guide](https://learn.hashicorp.com/terraform/aws/iam-policy). @@ -104,4 +105,4 @@ Using `terraform import`, import SNS Data Protection Topic Policy using the topi % terraform import aws_sns_topic_data_protection_policy.example arn:aws:sns:us-west-2:123456789012:example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/sns_topic_policy.html.markdown b/website/docs/cdktf/typescript/r/sns_topic_policy.html.markdown index 83020f084540..88e7941cf9f4 100644 --- a/website/docs/cdktf/typescript/r/sns_topic_policy.html.markdown +++ b/website/docs/cdktf/typescript/r/sns_topic_policy.html.markdown @@ -84,6 +84,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `arn` - (Required) The ARN of the SNS topic * `policy` - (Required) The fully-formed AWS policy as JSON. For more information about building AWS IAM policy documents with Terraform, see the [AWS IAM Policy Document Guide](https://learn.hashicorp.com/terraform/aws/iam-policy). @@ -125,4 +126,4 @@ Using `terraform import`, import SNS Topic Policy using the topic ARN. For examp % terraform import aws_sns_topic_policy.user_updates arn:aws:sns:us-west-2:123456789012:my-topic ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/sns_topic_subscription.html.markdown b/website/docs/cdktf/typescript/r/sns_topic_subscription.html.markdown index c15a35308e30..848303d44f7d 100644 --- a/website/docs/cdktf/typescript/r/sns_topic_subscription.html.markdown +++ b/website/docs/cdktf/typescript/r/sns_topic_subscription.html.markdown @@ -380,6 +380,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `confirmationTimeoutInMinutes` - (Optional) Integer indicating number of minutes to wait in retrying mode for fetching subscription arn before marking it as failure. Only applicable for http and https protocols. Default is `1`. * `deliveryPolicy` - (Optional) JSON String with the delivery policy (retries, backoff, etc.) that will be used in the subscription - this only applies to HTTP/S subscriptions. Refer to the [SNS docs](https://docs.aws.amazon.com/sns/latest/dg/DeliveryPolicies.html) for more details. * `endpointAutoConfirms` - (Optional) Whether the endpoint is capable of [auto confirming subscription](http://docs.aws.amazon.com/sns/latest/dg/SendMessageToHttp.html#SendMessageToHttp.prepare) (e.g., PagerDuty). Default is `false`. @@ -451,4 +452,4 @@ Using `terraform import`, import SNS Topic Subscriptions using the subscription % terraform import aws_sns_topic_subscription.user_updates_sqs_target arn:aws:sns:us-west-2:123456789012:my-topic:8a21d249-4329-4871-acc6-7be709c6ea7f ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/spot_datafeed_subscription.html.markdown b/website/docs/cdktf/typescript/r/spot_datafeed_subscription.html.markdown index c1b22408a1be..bc74f9fd8280 100644 --- a/website/docs/cdktf/typescript/r/spot_datafeed_subscription.html.markdown +++ b/website/docs/cdktf/typescript/r/spot_datafeed_subscription.html.markdown @@ -52,6 +52,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `bucket` - (Required) The Amazon S3 bucket in which to store the Spot instance data feed. * `prefix` - (Optional) Path of folder inside bucket to place spot pricing data. @@ -91,4 +92,4 @@ Using `terraform import`, import a Spot Datafeed Subscription using the word `sp % terraform import aws_spot_datafeed_subscription.mysubscription spot-datafeed-subscription ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/spot_fleet_request.html.markdown b/website/docs/cdktf/typescript/r/spot_fleet_request.html.markdown index 77cf41961d9d..a51e897de78c 100644 --- a/website/docs/cdktf/typescript/r/spot_fleet_request.html.markdown +++ b/website/docs/cdktf/typescript/r/spot_fleet_request.html.markdown @@ -291,6 +291,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `iamFleetRole` - (Required) Grants the Spot fleet permission to terminate Spot instances on your behalf when you cancel its Spot fleet request using CancelSpotFleetRequests or when the Spot fleet request expires, if you set @@ -538,4 +539,4 @@ Using `terraform import`, import Spot Fleet Requests using `id`. For example: % terraform import aws_spot_fleet_request.fleet sfr-005e9ec8-5546-4c31-b317-31a62325411e ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/spot_instance_request.html.markdown b/website/docs/cdktf/typescript/r/spot_instance_request.html.markdown index 855493596846..19a3570d3c03 100644 --- a/website/docs/cdktf/typescript/r/spot_instance_request.html.markdown +++ b/website/docs/cdktf/typescript/r/spot_instance_request.html.markdown @@ -27,8 +27,8 @@ price availability or by a user. ~> **NOTE:** Because their behavior depends on the live status of the spot market, Spot Instance Requests have a unique lifecycle that makes them behave -differently than other Terraform resources. Most importantly: there is __no -guarantee__ that a Spot Instance exists to fulfill the request at any given +differently than other Terraform resources. Most importantly: there is **no +guarantee** that a Spot Instance exists to fulfill the request at any given point in time. See the [AWS Spot Instance documentation](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-spot-instances.html) for more information. @@ -67,6 +67,8 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). + Spot Instance Requests support all the same arguments as [`aws_instance`](instance.html), with the addition of: * `spotPrice` - (Optional; Default: On-demand price) The maximum price to request on the spot market. @@ -77,9 +79,6 @@ Spot Instance Requests support all the same arguments as [`aws_instance`](instan the instance is terminated, the spot request will be closed. * `launchGroup` - (Optional) A launch group is a group of spot instances that launch together and terminate together. If left empty instances are launched and terminated individually. -* `blockDurationMinutes` - (Optional) The required duration for the Spot instances, in minutes. This value must be a multiple of 60 (60, 120, 180, 240, 300, or 360). - The duration period starts as soon as your Spot instance receives its instance ID. At the end of the duration period, Amazon EC2 marks the Spot instance for termination and provides a Spot instance termination notice, which gives the instance a two-minute warning before it terminates. - Note that you can't specify an Availability Zone group or a launch group if you specify a duration. * `instanceInterruptionBehavior` - (Optional) Indicates Spot instance behavior when it is interrupted. Valid values are `terminate`, `stop`, or `hibernate`. Default value is `terminate`. * `validUntil` - (Optional) The end date and time of the request, in UTC [RFC3339](https://tools.ietf.org/html/rfc3339#section-5.8) format(for example, YYYY-MM-DDTHH:MM:SSZ). At this point, no new Spot instance requests are placed or enabled to fulfill the request. The default end date is 7 days from the current date. * `validFrom` - (Optional) The start date and time of the request, in UTC [RFC3339](https://tools.ietf.org/html/rfc3339#section-5.8) format(for example, YYYY-MM-DDTHH:MM:SSZ). The default is to start fulfilling the request immediately. @@ -90,9 +89,9 @@ Spot Instance Requests support all the same arguments as [`aws_instance`](instan This resource exports the following attributes in addition to the arguments above: * `id` - The Spot Instance Request ID. +* `tagsAll` - A map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). -These attributes are exported, but they are expected to change over time and so -should only be used for informational purposes, not for resource dependencies: +The following attributes are exported, but they are expected to change over time and so should only be used for informational purposes, not for resource dependencies: * `spotBidStatus` - The current [bid status](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-bid-status.html) @@ -109,7 +108,6 @@ should only be used for informational purposes, not for resource dependencies: used inside the Amazon EC2, and only available if you've enabled DNS hostnames for your VPC * `privateIp` - The private IP address assigned to the instance -* `tagsAll` - A map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). ## Timeouts @@ -119,4 +117,4 @@ should only be used for informational purposes, not for resource dependencies: * `read` - (Default `15m`) * `delete` - (Default `20m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/sqs_queue.html.markdown b/website/docs/cdktf/typescript/r/sqs_queue.html.markdown index 23bb0623c3be..686a2e531bf4 100644 --- a/website/docs/cdktf/typescript/r/sqs_queue.html.markdown +++ b/website/docs/cdktf/typescript/r/sqs_queue.html.markdown @@ -200,6 +200,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `contentBasedDeduplication` - (Optional) Enables content-based deduplication for FIFO queues. For more information, see the [related documentation](http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-exactly-once-processing). * `deduplicationScope` - (Optional) Specifies whether message deduplication occurs at the message group or queue level. Valid values are `messageGroup` and `queue` (default). * `delaySeconds` - (Optional) Time in seconds that the delivery of all messages in the queue will be delayed. An integer from 0 to 900 (15 minutes). The default for this attribute is 0 seconds. @@ -207,7 +208,7 @@ This resource supports the following arguments: * `fifoThroughputLimit` - (Optional) Specifies whether the FIFO queue throughput quota applies to the entire queue or per message group. Valid values are `perQueue` (default) and `perMessageGroupId`. * `kmsDataKeyReusePeriodSeconds` - (Optional) Length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again. An integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). The default is 300 (5 minutes). * `kmsMasterKeyId` - (Optional) ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see [Key Terms](http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms). -* `maxMessageSize` - (Optional) Limit of how many bytes a message can contain before Amazon SQS rejects it. An integer from 1024 bytes (1 KiB) up to 262144 bytes (256 KiB). The default for this attribute is 262144 (256 KiB). +* `maxMessageSize` - (Optional) Limit of how many bytes a message can contain before Amazon SQS rejects it. An integer from 1024 bytes (1 KiB) up to 1048576 bytes (1024 KiB). The default for this attribute is 262144 (256 KiB). * `messageRetentionSeconds` - (Optional) Number of seconds Amazon SQS retains a message. Integer representing seconds, from 60 (1 minute) to 1209600 (14 days). The default for this attribute is 345600 (4 days). * `name` - (Optional) Name of the queue. Queue names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 80 characters long. For a FIFO (first-in-first-out) queue, the name must end with the `.fifo` suffix. If omitted, Terraform will assign a random, unique name. Conflicts with `namePrefix`. * `namePrefix` - (Optional) Creates a unique name beginning with the specified prefix. Conflicts with `name`. @@ -268,4 +269,4 @@ Using `terraform import`, import SQS Queues using the queue `url`. For example: % terraform import aws_sqs_queue.public_queue https://queue.amazonaws.com/80398EXAMPLE/MyQueue ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/sqs_queue_policy.html.markdown b/website/docs/cdktf/typescript/r/sqs_queue_policy.html.markdown index 2cbcc1fd5900..7ec663821ba6 100644 --- a/website/docs/cdktf/typescript/r/sqs_queue_policy.html.markdown +++ b/website/docs/cdktf/typescript/r/sqs_queue_policy.html.markdown @@ -130,6 +130,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `policy` - (Required) JSON policy for the SQS queue. For more information about building AWS IAM policy documents with Terraform, see the [AWS IAM Policy Document Guide](https://learn.hashicorp.com/terraform/aws/iam-policy). Ensure that `Version = "2012-10-17"` is set in the policy or AWS may hang in creating the queue. * `queueUrl` - (Required) URL of the SQS Queue to which to attach the policy. @@ -169,4 +170,4 @@ Using `terraform import`, import SQS Queue Policies using the queue URL. For exa % terraform import aws_sqs_queue_policy.test https://queue.amazonaws.com/123456789012/myqueue ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/sqs_queue_redrive_allow_policy.html.markdown b/website/docs/cdktf/typescript/r/sqs_queue_redrive_allow_policy.html.markdown index 85bbdd48c120..907233070b78 100644 --- a/website/docs/cdktf/typescript/r/sqs_queue_redrive_allow_policy.html.markdown +++ b/website/docs/cdktf/typescript/r/sqs_queue_redrive_allow_policy.html.markdown @@ -63,6 +63,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `queueUrl` - (Required) The URL of the SQS Queue to which to attach the policy * `redriveAllowPolicy` - (Required) The JSON redrive allow policy for the SQS queue. Learn more in the [Amazon SQS dead-letter queues documentation](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html). @@ -102,4 +103,4 @@ Using `terraform import`, import SQS Queue Redrive Allow Policies using the queu % terraform import aws_sqs_queue_redrive_allow_policy.test https://queue.amazonaws.com/123456789012/myqueue ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/sqs_queue_redrive_policy.html.markdown b/website/docs/cdktf/typescript/r/sqs_queue_redrive_policy.html.markdown index 1234f58690c0..9b6f4314228b 100644 --- a/website/docs/cdktf/typescript/r/sqs_queue_redrive_policy.html.markdown +++ b/website/docs/cdktf/typescript/r/sqs_queue_redrive_policy.html.markdown @@ -64,6 +64,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `queueUrl` - (Required) The URL of the SQS Queue to which to attach the policy * `redrivePolicy` - (Required) The JSON redrive policy for the SQS queue. Accepts two key/val pairs: `deadLetterTargetArn` and `maxReceiveCount`. Learn more in the [Amazon SQS dead-letter queues documentation](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html). @@ -103,4 +104,4 @@ Using `terraform import`, import SQS Queue Redrive Policies using the queue URL. % terraform import aws_sqs_queue_redrive_policy.test https://queue.amazonaws.com/123456789012/myqueue ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ssm_activation.html.markdown b/website/docs/cdktf/typescript/r/ssm_activation.html.markdown index d6cc465d4415..004795a08d3c 100644 --- a/website/docs/cdktf/typescript/r/ssm_activation.html.markdown +++ b/website/docs/cdktf/typescript/r/ssm_activation.html.markdown @@ -67,6 +67,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Optional) The default name of the registered managed instance. * `description` - (Optional) The description of the resource that you want to register. * `expirationDate` - (Optional) UTC timestamp in [RFC3339 format](https://tools.ietf.org/html/rfc3339#section-5.8) by which this activation request should expire. The default value is 24 hours from resource creation time. Terraform will only perform drift detection of its value when present in a configuration. @@ -123,4 +124,4 @@ Using `terraform import`, import AWS SSM Activation using the `id`. For example: -> **Note:** The `activationCode` attribute cannot be imported. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ssm_association.html.markdown b/website/docs/cdktf/typescript/r/ssm_association.html.markdown index d9da775391ac..0326e3aecb9f 100644 --- a/website/docs/cdktf/typescript/r/ssm_association.html.markdown +++ b/website/docs/cdktf/typescript/r/ssm_association.html.markdown @@ -227,7 +227,7 @@ class MyConvertedCode extends TerraformStack { new Instance(this, "database_server", { ami: Token.asString(amazonLinux.id), iamInstanceProfile: ec2SsmProfile.name, - instanceType: instanceType.stringValue, + instanceType: "t3.micro", subnetId: Token.asString(defaultVar.id), tags: { Environment: environment.stringValue, @@ -245,7 +245,7 @@ class MyConvertedCode extends TerraformStack { new Instance(this, "web_server", { ami: Token.asString(amazonLinux.id), iamInstanceProfile: ec2SsmProfile.name, - instanceType: instanceType.stringValue, + instanceType: "t3.micro", subnetId: Token.asString(defaultVar.id), tags: { Environment: environment.stringValue, @@ -285,13 +285,13 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) The name of the SSM document to apply. * `applyOnlyAtCronInterval` - (Optional) By default, when you create a new or update associations, the system runs it immediately and then according to the schedule you specified. Enable this option if you do not want an association to run immediately after you create or update it. This parameter is not supported for rate expressions. Default: `false`. * `associationName` - (Optional) The descriptive name for the association. * `automationTargetParameterName` - (Optional) Specify the target for the association. This target is required for associations that use an `Automation` document and target resources by using rate controls. This should be set to the SSM document `parameter` that will define how your automation will branch out. * `complianceSeverity` - (Optional) The compliance severity for the association. Can be one of the following: `UNSPECIFIED`, `LOW`, `MEDIUM`, `HIGH` or `CRITICAL` * `documentVersion` - (Optional) The document version you want to associate with the target(s). Can be a specific version or the default version. -* `instanceId` - (Optional, **Deprecated**) The instance ID to apply an SSM document to. Use `targets` with key `InstanceIds` for document schema versions 2.0 and above. Use the `targets` attribute instead. * `maxConcurrency` - (Optional) The maximum number of targets allowed to run the association at the same time. You can specify a number, for example 10, or a percentage of the target set, for example 10%. * `maxErrors` - (Optional) The number of errors that are allowed before the system stops sending requests to run the association on additional targets. You can specify a number, for example 10, or a percentage of the target set, for example 10%. If you specify a threshold of 3, the stop command is sent when the fourth error is returned. If you specify a threshold of 10% for 50 associations, the stop command is sent when the sixth error is returned. * `outputLocation` - (Optional) An output location block. Output Location is documented below. @@ -319,13 +319,38 @@ This resource exports the following attributes in addition to the arguments abov * `arn` - The ARN of the SSM association * `associationId` - The ID of the SSM association. -* `instanceId` - The instance id that the SSM document was applied to. * `name` - The name of the SSM document to apply. * `parameters` - Additional parameters passed to the SSM document. * `tagsAll` - A map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). ## Import +In Terraform v1.12.0 and later, the [`import` block](https://developer.hashicorp.com/terraform/language/import) can be used with the `identity` attribute. For example: + +```terraform +import { + to = aws_ssm_association.example + identity = { + association_id = "10abcdef-0abc-1234-5678-90abcdef123456" + } +} + +resource "aws_ssm_association" "example" { + ### Configuration omitted for brevity ### +} +``` + +### Identity Schema + +#### Required + +* `associationId` - (String) ID of the SSM association. + +#### Optional + +- `accountId` (String) AWS Account where this resource is managed. +- `region` (String) Region where this resource is managed. + In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import SSM associations using the `associationId`. For example: ```typescript @@ -342,7 +367,7 @@ class MyConvertedCode extends TerraformStack { super(scope, name); SsmAssociation.generateConfigForImport( this, - "testAssociation", + "example", "10abcdef-0abc-1234-5678-90abcdef123456" ); } @@ -353,7 +378,7 @@ class MyConvertedCode extends TerraformStack { Using `terraform import`, import SSM associations using the `associationId`. For example: ```console -% terraform import aws_ssm_association.test-association 10abcdef-0abc-1234-5678-90abcdef123456 +% terraform import aws_ssm_association.example 10abcdef-0abc-1234-5678-90abcdef123456 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ssm_default_patch_baseline.html.markdown b/website/docs/cdktf/typescript/r/ssm_default_patch_baseline.html.markdown index 9591fad197b9..d3974091dc41 100644 --- a/website/docs/cdktf/typescript/r/ssm_default_patch_baseline.html.markdown +++ b/website/docs/cdktf/typescript/r/ssm_default_patch_baseline.html.markdown @@ -50,8 +50,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `baselineId` - (Required) ID of the patch baseline. Can be an ID or an ARN. When specifying an AWS-provided patch baseline, must be the ARN. @@ -167,4 +168,4 @@ Using the operating system value: % terraform import aws_ssm_default_patch_baseline.example CENTOS ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ssm_document.html.markdown b/website/docs/cdktf/typescript/r/ssm_document.html.markdown index fd00a8173702..575ce9b0d68b 100644 --- a/website/docs/cdktf/typescript/r/ssm_document.html.markdown +++ b/website/docs/cdktf/typescript/r/ssm_document.html.markdown @@ -72,6 +72,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) The name of the document. * `attachmentsSource` - (Optional) One or more configuration blocks describing attachments sources to a version of a document. See [`attachmentsSource` block](#attachments_source-block) below for details. * `content` - (Required) The content for the SSM document in JSON or YAML format. The content of the document must not exceed 64KB. This quota also includes the content specified for input parameters at runtime. We recommend storing the contents for your new document in an external JSON or YAML file and referencing the file in a command. @@ -133,6 +134,32 @@ The `parameter` configuration block provides the following attributes: ## Import +In Terraform v1.12.0 and later, the [`import` block](https://developer.hashicorp.com/terraform/language/import) can be used with the `identity` attribute. For example: + +```terraform +import { + to = aws_ssm_document.example + identity = { + name = "example" + } +} + +resource "aws_ssm_document" "example" { + ### Configuration omitted for brevity ### +} +``` + +### Identity Schema + +#### Required + +* `name` - (String) Name of the SSM document. + +#### Optional + +- `accountId` (String) AWS Account where this resource is managed. +- `region` (String) Region where this resource is managed. + In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import SSM Documents using the name. For example: ```typescript @@ -195,4 +222,4 @@ class MyConvertedCode extends TerraformStack { ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ssm_maintenance_window.html.markdown b/website/docs/cdktf/typescript/r/ssm_maintenance_window.html.markdown index e2ef1296e6aa..e88905977b32 100644 --- a/website/docs/cdktf/typescript/r/ssm_maintenance_window.html.markdown +++ b/website/docs/cdktf/typescript/r/ssm_maintenance_window.html.markdown @@ -41,6 +41,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) The name of the maintenance window. * `schedule` - (Required) The schedule of the Maintenance Window in the form of a [cron or rate expression](https://docs.aws.amazon.com/systems-manager/latest/userguide/reference-cron-and-rate-expressions.html). * `cutoff` - (Required) The number of hours before the end of the Maintenance Window that Systems Manager stops scheduling new tasks for execution. @@ -63,6 +64,32 @@ This resource exports the following attributes in addition to the arguments abov ## Import +In Terraform v1.12.0 and later, the [`import` block](https://developer.hashicorp.com/terraform/language/import) can be used with the `identity` attribute. For example: + +```terraform +import { + to = aws_ssm_maintenance_window.example + identity = { + id = "mw-0123456789" + } +} + +resource "aws_ssm_maintenance_window" "example" { + ### Configuration omitted for brevity ### +} +``` + +### Identity Schema + +#### Required + +* `id` - (String) ID of the maintenance window. + +#### Optional + +- `accountId` (String) AWS Account where this resource is managed. +- `region` (String) Region where this resource is managed. + In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import SSM Maintenance Windows using the maintenance window `id`. For example: ```typescript @@ -79,7 +106,7 @@ class MyConvertedCode extends TerraformStack { super(scope, name); SsmMaintenanceWindow.generateConfigForImport( this, - "importedWindow", + "example", "mw-0123456789" ); } @@ -90,7 +117,7 @@ class MyConvertedCode extends TerraformStack { Using `terraform import`, import SSM Maintenance Windows using the maintenance window `id`. For example: ```console -% terraform import aws_ssm_maintenance_window.imported-window mw-0123456789 +% terraform import aws_ssm_maintenance_window.example mw-0123456789 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ssm_maintenance_window_target.html.markdown b/website/docs/cdktf/typescript/r/ssm_maintenance_window_target.html.markdown index 2377b825eb9c..1e5932a11f8f 100644 --- a/website/docs/cdktf/typescript/r/ssm_maintenance_window_target.html.markdown +++ b/website/docs/cdktf/typescript/r/ssm_maintenance_window_target.html.markdown @@ -94,6 +94,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `windowId` - (Required) The Id of the maintenance window to register the target with. * `name` - (Optional) The name of the maintenance window target. * `description` - (Optional) The description of the maintenance window target. @@ -110,6 +111,34 @@ This resource exports the following attributes in addition to the arguments abov ## Import +In Terraform v1.12.0 and later, the [`import` block](https://developer.hashicorp.com/terraform/language/import) can be used with the `identity` attribute. For example: + +```terraform +import { + to = aws_ssm_maintenance_window_target.example + identity = { + window_id = "mw-0c50858d01EXAMPLE" + id = "23639a0b-ddbc-4bca-9e72-78d96EXAMPLE" + } +} + +resource "aws_ssm_maintenance_window_target" "example" { + ### Configuration omitted for brevity ### +} +``` + +### Identity Schema + +#### Required + +* `windowId` - (String) ID of the maintenance window. +* `id` - (String) ID of the maintenance window target. + +#### Optional + +- `accountId` (String) AWS Account where this resource is managed. +- `region` (String) Region where this resource is managed. + In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import SSM Maintenance Window targets using `WINDOW_ID/WINDOW_TARGET_ID`. For example: ```typescript @@ -140,4 +169,4 @@ Using `terraform import`, import SSM Maintenance Window targets using `WINDOW_ID % terraform import aws_ssm_maintenance_window_target.example mw-0c50858d01EXAMPLE/23639a0b-ddbc-4bca-9e72-78d96EXAMPLE ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ssm_maintenance_window_task.html.markdown b/website/docs/cdktf/typescript/r/ssm_maintenance_window_task.html.markdown index 5f5ab78abcdb..e11ab1623d0e 100644 --- a/website/docs/cdktf/typescript/r/ssm_maintenance_window_task.html.markdown +++ b/website/docs/cdktf/typescript/r/ssm_maintenance_window_task.html.markdown @@ -194,6 +194,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `windowId` - (Required) The Id of the maintenance window to register the task with. * `maxConcurrency` - (Optional) The maximum number of targets this task can be run for in parallel. * `maxErrors` - (Optional) The maximum number of errors allowed before this task stops being scheduled. @@ -269,6 +270,34 @@ This resource exports the following attributes in addition to the arguments abov ## Import +In Terraform v1.12.0 and later, the [`import` block](https://developer.hashicorp.com/terraform/language/import) can be used with the `identity` attribute. For example: + +```terraform +import { + to = aws_ssm_maintenance_window_task.example + identity = { + window_id = "mw-0c50858d01EXAMPLE" + id = "4f7ca192-7e9a-40fe-9192-5cb15EXAMPLE" + } +} + +resource "aws_ssm_maintenance_window_task" "example" { + ### Configuration omitted for brevity ### +} +``` + +### Identity Schema + +#### Required + +* `windowId` - (String) ID of the maintenance window. +* `id` - (String) ID of the maintenance window task. + +#### Optional + +- `accountId` (String) AWS Account where this resource is managed. +- `region` (String) Region where this resource is managed. + In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import AWS Maintenance Window Task using the `windowId` and `windowTaskId` separated by `/`. For example: ```typescript @@ -285,7 +314,7 @@ class MyConvertedCode extends TerraformStack { super(scope, name); SsmMaintenanceWindowTask.generateConfigForImport( this, - "task", + "example", "/" ); } @@ -296,7 +325,7 @@ class MyConvertedCode extends TerraformStack { Using `terraform import`, import AWS Maintenance Window Task using the `windowId` and `windowTaskId` separated by `/`. For example: ```console -% terraform import aws_ssm_maintenance_window_task.task / +% terraform import aws_ssm_maintenance_window_task.example / ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ssm_parameter.html.markdown b/website/docs/cdktf/typescript/r/ssm_parameter.html.markdown index 373124ef7922..c843e02e7657 100644 --- a/website/docs/cdktf/typescript/r/ssm_parameter.html.markdown +++ b/website/docs/cdktf/typescript/r/ssm_parameter.html.markdown @@ -14,7 +14,7 @@ Provides an SSM Parameter resource. ~> **Note:** The `overwrite` argument makes it possible to overwrite an existing SSM Parameter created outside of Terraform. --> **Note:** Write-Only argument `valueWo` is available to use in place of `value`. Write-Only arguments are supported in HashiCorp Terraform 1.11.0 and later. [Learn more](https://developer.hashicorp.com/terraform/language/v1.11.x/resources/ephemeral#write-only-arguments). +-> **Note:** Write-Only argument `valueWo` is available to use in place of `value`. Write-Only arguments are supported in HashiCorp Terraform 1.11.0 and later. [Learn more](https://developer.hashicorp.com/terraform/language/resources/ephemeral#write-only-arguments). ## Example Usage @@ -95,6 +95,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `allowedPattern` - (Optional) Regular expression used to validate the parameter value. * `dataType` - (Optional) Data type of the parameter. Valid values: `text`, `aws:ssm:integration` and `aws:ec2:image` for AMI format, see the [Native parameter support for Amazon Machine Image IDs](https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-ec2-aliases.html). * `description` - (Optional) Description of the parameter. @@ -120,6 +121,32 @@ This resource exports the following attributes in addition to the arguments abov ## Import +In Terraform v1.12.0 and later, the [`import` block](https://developer.hashicorp.com/terraform/language/import) can be used with the `identity` attribute. For example: + +```terraform +import { + to = aws_ssm_parameter.example + identity = { + name = "/my_path/my_paramname" + } +} + +resource "aws_ssm_parameter" "example" { + ### Configuration omitted for brevity ### +} +``` + +### Identity Schema + +#### Required + +* `name` - (String) Name of the parameter. + +#### Optional + +- `accountId` (String) AWS Account where this resource is managed. +- `region` (String) Region where this resource is managed. + In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import SSM Parameters using the parameter store `name`. For example: ```typescript @@ -136,7 +163,7 @@ class MyConvertedCode extends TerraformStack { super(scope, name); SsmParameter.generateConfigForImport( this, - "myParam", + "example", "/my_path/my_paramname" ); } @@ -147,7 +174,7 @@ class MyConvertedCode extends TerraformStack { Using `terraform import`, import SSM Parameters using the parameter store `name`. For example: ```console -% terraform import aws_ssm_parameter.my_param /my_path/my_paramname +% terraform import aws_ssm_parameter.example /my_path/my_paramname ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ssm_patch_baseline.html.markdown b/website/docs/cdktf/typescript/r/ssm_patch_baseline.html.markdown index cdbf9c849272..b470d2157c0e 100644 --- a/website/docs/cdktf/typescript/r/ssm_patch_baseline.html.markdown +++ b/website/docs/cdktf/typescript/r/ssm_patch_baseline.html.markdown @@ -211,10 +211,12 @@ The following arguments are required: The following arguments are optional: +* `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). * `approvalRule` - (Optional) Set of rules used to include patches in the baseline. Up to 10 approval rules can be specified. See [`approvalRule`](#approval_rule-block) below. * `approvedPatchesComplianceLevel` - (Optional) Compliance level for approved patches. This means that if an approved patch is reported as missing, this is the severity of the compliance violation. Valid values are `CRITICAL`, `HIGH`, `MEDIUM`, `LOW`, `INFORMATIONAL`, `UNSPECIFIED`. The default value is `UNSPECIFIED`. * `approvedPatchesEnableNonSecurity` - (Optional) Whether the list of approved patches includes non-security updates that should be applied to the instances. Applies to Linux instances only. * `approvedPatches` - (Optional) List of explicitly approved patches for the baseline. Cannot be specified with `approvalRule`. +* `availableSecurityUpdatesComplianceStatus` - (Optional) Indicates the compliance status of managed nodes for which security-related patches are available but were not approved. Supported for Windows Server managed nodes only. Valid values are `COMPLIANT`, `NON_COMPLIANT`. * `description` - (Optional) Description of the patch baseline. * `globalFilter` - (Optional) Set of global filters used to exclude patches from the baseline. Up to 4 global filters can be specified using Key/Value pairs. Valid Keys are `PRODUCT`, `CLASSIFICATION`, `MSRC_SEVERITY`, and `PATCH_ID`. * `operatingSystem` - (Optional) Operating system the patch baseline applies to. Valid values are `ALMA_LINUX`, `AMAZON_LINUX`, `AMAZON_LINUX_2`, `AMAZON_LINUX_2022`, `AMAZON_LINUX_2023`, `CENTOS`, `DEBIAN`, `MACOS`, `ORACLE_LINUX`, `RASPBIAN`, `REDHAT_ENTERPRISE_LINUX`, `ROCKY_LINUX`, `SUSE`, `UBUNTU`, and `WINDOWS`. The default value is `WINDOWS`. @@ -252,6 +254,32 @@ This resource exports the following attributes in addition to the arguments abov ## Import +In Terraform v1.12.0 and later, the [`import` block](https://developer.hashicorp.com/terraform/language/import) can be used with the `identity` attribute. For example: + +```terraform +import { + to = aws_ssm_patch_baseline.example + identity = { + id = "pb-12345678" + } +} + +resource "aws_ssm_patch_baseline" "example" { + ### Configuration omitted for brevity ### +} +``` + +### Identity Schema + +#### Required + +* `id` - (String) ID of the patch baseline. + +#### Optional + +- `accountId` (String) AWS Account where this resource is managed. +- `region` (String) Region where this resource is managed. + In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import SSM Patch Baselines using their baseline ID. For example: ```typescript @@ -278,4 +306,4 @@ Using `terraform import`, import SSM Patch Baselines using their baseline ID. Fo % terraform import aws_ssm_patch_baseline.example pb-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ssm_patch_group.html.markdown b/website/docs/cdktf/typescript/r/ssm_patch_group.html.markdown index a355b4d615bc..dcd29a103d25 100644 --- a/website/docs/cdktf/typescript/r/ssm_patch_group.html.markdown +++ b/website/docs/cdktf/typescript/r/ssm_patch_group.html.markdown @@ -44,6 +44,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `baselineId` - (Required) The ID of the patch baseline to register the patch group with. * `patchGroup` - (Required) The name of the patch group that should be registered with the patch baseline. @@ -53,4 +54,4 @@ This resource exports the following attributes in addition to the arguments abov * `id` - The name of the patch group and ID of the patch baseline separated by a comma (`,`). - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ssm_resource_data_sync.html.markdown b/website/docs/cdktf/typescript/r/ssm_resource_data_sync.html.markdown index 2a576f2c74f1..1bf18237fdf7 100644 --- a/website/docs/cdktf/typescript/r/ssm_resource_data_sync.html.markdown +++ b/website/docs/cdktf/typescript/r/ssm_resource_data_sync.html.markdown @@ -95,6 +95,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) Name for the configuration. * `s3Destination` - (Required) Amazon S3 configuration details for the sync. @@ -144,4 +145,4 @@ Using `terraform import`, import SSM resource data sync using the `name`. For ex % terraform import aws_ssm_resource_data_sync.example example-name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ssm_service_setting.html.markdown b/website/docs/cdktf/typescript/r/ssm_service_setting.html.markdown index eb2a67fcf967..ba56bbb07c02 100644 --- a/website/docs/cdktf/typescript/r/ssm_service_setting.html.markdown +++ b/website/docs/cdktf/typescript/r/ssm_service_setting.html.markdown @@ -40,7 +40,8 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: -* `settingId` - (Required) ID of the service setting. +* `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). +* `settingId` - (Required) ID of the service setting. Valid values are shown in the [AWS documentation](https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_GetServiceSetting.html#API_GetServiceSetting_RequestSyntax). * `settingValue` - (Required) Value of the service setting. ## Attribute Reference @@ -82,4 +83,4 @@ Using `terraform import`, import AWS SSM Service Setting using the `settingId`. % terraform import aws_ssm_service_setting.example arn:aws:ssm:us-east-1:123456789012:servicesetting/ssm/parameter-store/high-throughput-enabled ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ssmcontacts_contact.html.markdown b/website/docs/cdktf/typescript/r/ssmcontacts_contact.html.markdown index d6d720b4fb09..743fe6ea316c 100644 --- a/website/docs/cdktf/typescript/r/ssmcontacts_contact.html.markdown +++ b/website/docs/cdktf/typescript/r/ssmcontacts_contact.html.markdown @@ -78,8 +78,9 @@ The following arguments are required: The following arguments are optional: +- `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). - `displayName` - (Optional) Full friendly name of the contact or escalation plan. If set, must be between 1 and 255 characters, and may contain alphanumerics, underscores (`_`), hyphens (`-`), periods (`.`), and spaces. -- `tags` - (Optional) Map of tags to assign to the resource. +- `tags` - (Optional) Key-value tags for the monitor. If configured with a provider [`defaultTags` 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. ## Attribute Reference @@ -116,4 +117,4 @@ Using `terraform import`, import SSM Contact using the `ARN`. For example: % terraform import aws_ssmcontacts_contact.example {ARNValue} ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ssmcontacts_contact_channel.html.markdown b/website/docs/cdktf/typescript/r/ssmcontacts_contact_channel.html.markdown index 6f953af61586..ca563d05e208 100644 --- a/website/docs/cdktf/typescript/r/ssmcontacts_contact_channel.html.markdown +++ b/website/docs/cdktf/typescript/r/ssmcontacts_contact_channel.html.markdown @@ -78,8 +78,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +- `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). - `contactId` - (Required) Amazon Resource Name (ARN) of the AWS SSM Contact that the contact channel belongs to. - `deliveryAddress` - (Required) Block that contains contact engagement details. See details below. - `name` - (Required) Name of the contact channel. Must be between 1 and 255 characters, and may contain alphanumerics, underscores (`_`), hyphens (`-`), periods (`.`), and spaces. @@ -128,4 +129,4 @@ Using `terraform import`, import SSM Contact Channel using the `ARN`. For exampl % terraform import aws_ssmcontacts_contact_channel.example arn:aws:ssm-contacts:us-west-2:123456789012:contact-channel/example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ssmcontacts_plan.html.markdown b/website/docs/cdktf/typescript/r/ssmcontacts_plan.html.markdown index 0c061c15febd..84d62b673be7 100644 --- a/website/docs/cdktf/typescript/r/ssmcontacts_plan.html.markdown +++ b/website/docs/cdktf/typescript/r/ssmcontacts_plan.html.markdown @@ -136,8 +136,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +- `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). - `contactId` - (Required) The Amazon Resource Name (ARN) of the contact or escalation plan. - `stage` - (Required) One or more configuration blocks for specifying a list of stages that the escalation plan or engagement plan uses to engage contacts and contact methods. See [Stage](#stage) below for more details. @@ -209,4 +210,4 @@ Using `terraform import`, import SSM Contact Plan using the Contact ARN. For exa % terraform import aws_ssmcontacts_plan.example {ARNValue} ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ssmcontacts_rotation.html.markdown b/website/docs/cdktf/typescript/r/ssmcontacts_rotation.html.markdown index 22b0e6c0edec..a8b3c0fd9b48 100644 --- a/website/docs/cdktf/typescript/r/ssmcontacts_rotation.html.markdown +++ b/website/docs/cdktf/typescript/r/ssmcontacts_rotation.html.markdown @@ -192,6 +192,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `startTime` - (Optional) The date and time, in RFC 3339 format, that the rotation goes into effect. * `tags` - (Optional) A map of tags to assign to the resource. If configured with a provider [`defaultTags` 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. @@ -273,4 +274,4 @@ Using `terraform import`, import CodeGuru Profiler Profiling Group using the `ar % terraform import aws_ssmcontacts_rotation.example arn:aws:ssm-contacts:us-east-1:012345678910:rotation/example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ssmincidents_replication_set.html.markdown b/website/docs/cdktf/typescript/r/ssmincidents_replication_set.html.markdown index 3edae00919fc..8b8565875956 100644 --- a/website/docs/cdktf/typescript/r/ssmincidents_replication_set.html.markdown +++ b/website/docs/cdktf/typescript/r/ssmincidents_replication_set.html.markdown @@ -33,7 +33,7 @@ class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); new SsmincidentsReplicationSet(this, "replicationSetName", { - region: [ + regions: [ { name: "us-west-2", }, @@ -62,7 +62,7 @@ class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); new SsmincidentsReplicationSet(this, "replicationSetName", { - region: [ + regions: [ { name: "us-west-2", }, @@ -91,7 +91,7 @@ class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); new SsmincidentsReplicationSet(this, "replicationSetName", { - region: [ + regions: [ { name: "us-west-2", }, @@ -121,7 +121,7 @@ class MyConvertedCode extends TerraformStack { super(scope, name); const exampleKey = new KmsKey(this, "example_key", {}); new SsmincidentsReplicationSet(this, "replicationSetName", { - region: [ + regions: [ { kmsKeyArn: exampleKey.arn, name: "us-west-2", @@ -140,7 +140,8 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: -* `region` - (Required) The Regions that Incident Manager replicates your data to. You can have up to three Regions in your replication set. +* `region` - (Optional, **Deprecated**) The replication set's Regions. Use `regions` instead. +* `regions` - (Optional) The replication set's Regions. * `tags` - (Optional) Key-value map of resource tags. If configured with a provider [`defaultTags` 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. For information about the maximum allowed number of Regions and tag value constraints, see [CreateReplicationSet in the *AWS Systems Manager Incident Manager API Reference*](https://docs.aws.amazon.com/incident-manager/latest/APIReference/API_CreateReplicationSet.html). @@ -155,7 +156,7 @@ For information about the maximum allowed number of Regions and tag value constr ~> **NOTE:** If possible, create all the customer managed keys you need (using the `terraform apply` command) before you create the replication set, or create the keys and replication set in the same `terraform apply` command. Otherwise, to delete a replication set, you must run one `terraform apply` command to delete the replication set and another to delete the AWS KMS keys used by the replication set. Deleting the AWS KMS keys before deleting the replication set results in an error. In that case, you must manually reenable the deleted key using the AWS Management Console before you can delete the replication set. -The `region` configuration block supports the following arguments: +The `regions` configuration block supports the following arguments: * `name` - (Required) The name of the Region, such as `ap-southeast-2`. * `kmsKeyArn` - (Optional) The Amazon Resource name (ARN) of the customer managed key. If omitted, AWS manages the AWS KMS keys for you, using an AWS owned key, as indicated by a default value of `DefaultKey`. @@ -174,7 +175,7 @@ This resource exports the following attributes in addition to the arguments abov * `status` - The overall status of a replication set. * Valid Values: `ACTIVE` | `CREATING` | `UPDATING` | `DELETING` | `FAILED` -In addition to the preceding arguments, the `region` configuration block exports the following attributes for each Region: +In addition to the preceding arguments, the `regions` configuration block exports the following attributes for each Region: * `status` - The current status of the Region. * Valid Values: `ACTIVE` | `CREATING` | `UPDATING` | `DELETING` | `FAILED` @@ -225,4 +226,4 @@ Using `terraform import`, import an Incident Manager replication. For example: % terraform import aws_ssmincidents_replication_set.replicationSetName import ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ssmincidents_response_plan.html.markdown b/website/docs/cdktf/typescript/r/ssmincidents_response_plan.html.markdown index 937f9c80ae6d..7a91fe10e6d3 100644 --- a/website/docs/cdktf/typescript/r/ssmincidents_response_plan.html.markdown +++ b/website/docs/cdktf/typescript/r/ssmincidents_response_plan.html.markdown @@ -131,6 +131,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) The name of the response plan. * `incidentTemplate` - (Required) The `incidentTemplate` configuration block is required and supports the following arguments: * `title` - (Required) The title of a generated incident. @@ -206,4 +207,4 @@ Using `terraform import`, import an Incident Manager response plan using the res % terraform import aws_ssmincidents_response_plan.responsePlanName ARNValue ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ssmquicksetup_configuration_manager.html.markdown b/website/docs/cdktf/typescript/r/ssmquicksetup_configuration_manager.html.markdown index 1d0696c44620..92cf0b4ab15c 100644 --- a/website/docs/cdktf/typescript/r/ssmquicksetup_configuration_manager.html.markdown +++ b/website/docs/cdktf/typescript/r/ssmquicksetup_configuration_manager.html.markdown @@ -64,14 +64,14 @@ class MyConvertedCode extends TerraformStack { ConfigurationOptionsScanValue: "cron(0 1 * * ? *)", IsPolicyAttachAllowed: "false", OutputLogEnableS3: "false", - PatchBaselineRegion: Token.asString(dataAwsRegionCurrent.name), + PatchBaselineRegion: Token.asString(dataAwsRegionCurrent.region), PatchBaselineUseDefault: "default", PatchPolicyName: "example", RateControlConcurrency: "10%", RateControlErrorThreshold: "2%", SelectedPatchBaselines: selectedPatchBaselines, TargetAccounts: Token.asString(current.accountId), - TargetRegions: Token.asString(dataAwsRegionCurrent.name), + TargetRegions: Token.asString(dataAwsRegionCurrent.region), TargetType: "*", }, type: "AWSQuickSetupType-PatchPolicy", @@ -95,6 +95,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `description` - (Optional) Description of the configuration manager. * `tags` - (Optional) Map of tags assigned to the resource. If configured with a provider [`defaultTags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. @@ -160,4 +161,4 @@ Using `terraform import`, import SSM Quick Setup Configuration Manager using the % terraform import aws_ssmquicksetup_configuration_manager.example arn:aws:ssm-quicksetup:us-east-1:012345678901:configuration-manager/abcd-1234 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ssoadmin_account_assignment.html.markdown b/website/docs/cdktf/typescript/r/ssoadmin_account_assignment.html.markdown index 59b086cd470c..96232a211b9e 100644 --- a/website/docs/cdktf/typescript/r/ssoadmin_account_assignment.html.markdown +++ b/website/docs/cdktf/typescript/r/ssoadmin_account_assignment.html.markdown @@ -157,6 +157,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `instanceArn` - (Required, Forces new resource) The Amazon Resource Name (ARN) of the SSO Instance. * `permissionSetArn` - (Required, Forces new resource) The Amazon Resource Name (ARN) of the Permission Set that the admin wants to grant the principal access to. * `principalId` - (Required, Forces new resource) An identifier for an object in SSO, such as a user or group. PrincipalIds are GUIDs (For example, `f81d4fae-7dec-11d0-a765-00a0c91e6bf6`). @@ -209,4 +210,4 @@ Using `terraform import`, import SSO Account Assignments using the `principalId` % terraform import aws_ssoadmin_account_assignment.example f81d4fae-7dec-11d0-a765-00a0c91e6bf6,GROUP,1234567890,AWS_ACCOUNT,arn:aws:sso:::permissionSet/ssoins-0123456789abcdef/ps-0123456789abcdef,arn:aws:sso:::instance/ssoins-0123456789abcdef ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ssoadmin_application.html.markdown b/website/docs/cdktf/typescript/r/ssoadmin_application.html.markdown index c95ea888b031..98ebe8092e2f 100644 --- a/website/docs/cdktf/typescript/r/ssoadmin_application.html.markdown +++ b/website/docs/cdktf/typescript/r/ssoadmin_application.html.markdown @@ -106,6 +106,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `clientToken` - (Optional) A unique, case-sensitive ID that you provide to ensure the idempotency of the request. AWS generates a random value when not provided. * `description` - (Optional) Description of the application. * `portalOptions` - (Optional) Options for the portal associated with an application. See [`portalOptions`](#portal_options-argument-reference) below. @@ -130,8 +131,9 @@ If `IDENTITY_CENTER` is set, IAM Identity Center uses SAML identity-provider ini This resource exports the following attributes in addition to the arguments above: * `applicationAccount` - AWS account ID. -* `applicationArn` - ARN of the application. -* `id` - ARN of the application. +* `applicationArn` - (**Deprecated** Reference `arn` instead) ARN of the application. +* `arn` - ARN of the application. +* `id` - (**Deprecated** Reference `arn` instead) ARN of the application. * `tagsAll` - Map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block). ## Import @@ -166,4 +168,4 @@ Using `terraform import`, import SSO Admin Application using the `id`. For examp % terraform import aws_ssoadmin_application.example arn:aws:sso::123456789012:application/id-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ssoadmin_application_access_scope.html.markdown b/website/docs/cdktf/typescript/r/ssoadmin_application_access_scope.html.markdown index cede520ae640..2aa4e85e28ae 100644 --- a/website/docs/cdktf/typescript/r/ssoadmin_application_access_scope.html.markdown +++ b/website/docs/cdktf/typescript/r/ssoadmin_application_access_scope.html.markdown @@ -45,9 +45,7 @@ class MyConvertedCode extends TerraformStack { awsSsoadminApplicationExample.overrideLogicalId("example"); const awsSsoadminApplicationAccessScopeExample = new SsoadminApplicationAccessScope(this, "example_2", { - applicationArn: Token.asString( - awsSsoadminApplicationExample.applicationArn - ), + applicationArn: Token.asString(awsSsoadminApplicationExample.arn), authorizedTargets: [ "arn:aws:sso::123456789012:application/ssoins-123456789012/apl-123456789012", ], @@ -69,6 +67,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `authorizedTargets` - (Optional) Specifies an array list of ARNs that represent the authorized targets for this access scope. ## Attribute Reference @@ -109,4 +108,4 @@ Using `terraform import`, import SSO Admin Application Access Scope using the `i % terraform import aws_ssoadmin_application_access_scope.example arn:aws:sso::123456789012:application/ssoins-123456789012/apl-123456789012,sso:account:access ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ssoadmin_application_assignment.html.markdown b/website/docs/cdktf/typescript/r/ssoadmin_application_assignment.html.markdown index f4f328640fe7..af9899ee31f7 100644 --- a/website/docs/cdktf/typescript/r/ssoadmin_application_assignment.html.markdown +++ b/website/docs/cdktf/typescript/r/ssoadmin_application_assignment.html.markdown @@ -28,9 +28,7 @@ class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); new SsoadminApplicationAssignment(this, "example", { - applicationArn: Token.asString( - awsSsoadminApplicationExample.applicationArn - ), + applicationArn: Token.asString(awsSsoadminApplicationExample.arn), principalId: Token.asString(awsIdentitystoreUserExample.userId), principalType: "USER", }); @@ -54,9 +52,7 @@ class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); new SsoadminApplicationAssignment(this, "example", { - applicationArn: Token.asString( - awsSsoadminApplicationExample.applicationArn - ), + applicationArn: Token.asString(awsSsoadminApplicationExample.arn), principalId: Token.asString(awsIdentitystoreGroupExample.groupId), principalType: "GROUP", }); @@ -67,8 +63,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `applicationArn` - (Required) ARN of the application. * `principalId` - (Required) An identifier for an object in IAM Identity Center, such as a user or group. * `principalType` - (Required) Entity type for which the assignment will be created. Valid values are `USER` or `GROUP`. @@ -111,4 +108,4 @@ Using `terraform import`, import SSO Admin Application Assignment using the `id` % terraform import aws_ssoadmin_application_assignment.example arn:aws:sso::123456789012:application/id-12345678,abcd1234,USER ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ssoadmin_application_assignment_configuration.html.markdown b/website/docs/cdktf/typescript/r/ssoadmin_application_assignment_configuration.html.markdown index 07192d33638a..5704217d0d15 100644 --- a/website/docs/cdktf/typescript/r/ssoadmin_application_assignment_configuration.html.markdown +++ b/website/docs/cdktf/typescript/r/ssoadmin_application_assignment_configuration.html.markdown @@ -33,9 +33,7 @@ class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); new SsoadminApplicationAssignmentConfiguration(this, "example", { - applicationArn: Token.asString( - awsSsoadminApplicationExample.applicationArn - ), + applicationArn: Token.asString(awsSsoadminApplicationExample.arn), assignmentRequired: true, }); } @@ -45,8 +43,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `applicationArn` - (Required) ARN of the application. * `assignmentRequired` - (Required) Indicates whether users must have an explicit assignment to access the application. If `false`, all users have access to the application. @@ -88,4 +87,4 @@ Using `terraform import`, import SSO Admin Application Assignment Configuration % terraform import aws_ssoadmin_application_assignment_configuration.example arn:aws:sso::123456789012:application/id-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ssoadmin_customer_managed_policy_attachment.html.markdown b/website/docs/cdktf/typescript/r/ssoadmin_customer_managed_policy_attachment.html.markdown index 555b7541405e..0fa37fc4eb80 100644 --- a/website/docs/cdktf/typescript/r/ssoadmin_customer_managed_policy_attachment.html.markdown +++ b/website/docs/cdktf/typescript/r/ssoadmin_customer_managed_policy_attachment.html.markdown @@ -92,6 +92,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `instanceArn` - (Required, Forces new resource) The Amazon Resource Name (ARN) of the SSO Instance under which the operation will be executed. * `permissionSetArn` - (Required, Forces new resource) The Amazon Resource Name (ARN) of the Permission Set. * `customerManagedPolicyReference` - (Required, Forces new resource) Specifies the name and path of a customer managed policy. See below. @@ -148,4 +149,4 @@ Using `terraform import`, import SSO Managed Policy Attachments using the `name` % terraform import aws_ssoadmin_customer_managed_policy_attachment.example TestPolicy,/,arn:aws:sso:::permissionSet/ssoins-2938j0x8920sbj72/ps-80383020jr9302rk,arn:aws:sso:::instance/ssoins-2938j0x8920sbj72 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ssoadmin_instance_access_control_attributes.html.markdown b/website/docs/cdktf/typescript/r/ssoadmin_instance_access_control_attributes.html.markdown index b3aa9cc2dff9..6001b44a3406 100644 --- a/website/docs/cdktf/typescript/r/ssoadmin_instance_access_control_attributes.html.markdown +++ b/website/docs/cdktf/typescript/r/ssoadmin_instance_access_control_attributes.html.markdown @@ -65,6 +65,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `instanceArn` - (Required, Forces new resource) The Amazon Resource Name (ARN) of the SSO Instance. * `attribute` - (Required) See [AccessControlAttribute](#accesscontrolattribute) for more details. @@ -115,4 +116,4 @@ Using `terraform import`, import SSO Account Assignments using the `instanceArn` % terraform import aws_ssoadmin_instance_access_control_attributes.example arn:aws:sso:::instance/ssoins-0123456789abcdef ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ssoadmin_managed_policy_attachment.html.markdown b/website/docs/cdktf/typescript/r/ssoadmin_managed_policy_attachment.html.markdown index bc94e068d13b..6dc23d821a24 100644 --- a/website/docs/cdktf/typescript/r/ssoadmin_managed_policy_attachment.html.markdown +++ b/website/docs/cdktf/typescript/r/ssoadmin_managed_policy_attachment.html.markdown @@ -142,6 +142,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `instanceArn` - (Required, Forces new resource) The Amazon Resource Name (ARN) of the SSO Instance under which the operation will be executed. * `managedPolicyArn` - (Required, Forces new resource) The IAM managed policy Amazon Resource Name (ARN) to be attached to the Permission Set. * `permissionSetArn` - (Required, Forces new resource) The Amazon Resource Name (ARN) of the Permission Set. @@ -192,4 +193,4 @@ Using `terraform import`, import SSO Managed Policy Attachments using the `manag % terraform import aws_ssoadmin_managed_policy_attachment.example arn:aws:iam::aws:policy/AlexaForBusinessDeviceSetup,arn:aws:sso:::permissionSet/ssoins-2938j0x8920sbj72/ps-80383020jr9302rk,arn:aws:sso:::instance/ssoins-2938j0x8920sbj72 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ssoadmin_permission_set.html.markdown b/website/docs/cdktf/typescript/r/ssoadmin_permission_set.html.markdown index a0c106523117..bbed4de0a38a 100644 --- a/website/docs/cdktf/typescript/r/ssoadmin_permission_set.html.markdown +++ b/website/docs/cdktf/typescript/r/ssoadmin_permission_set.html.markdown @@ -55,6 +55,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `description` - (Optional) The description of the Permission Set. * `instanceArn` - (Required, Forces new resource) The Amazon Resource Name (ARN) of the SSO Instance under which the operation will be executed. * `name` - (Required, Forces new resource) The name of the Permission Set. @@ -109,4 +110,4 @@ Using `terraform import`, import SSO Permission Sets using the `arn` and `instan % terraform import aws_ssoadmin_permission_set.example arn:aws:sso:::permissionSet/ssoins-2938j0x8920sbj72/ps-80383020jr9302rk,arn:aws:sso:::instance/ssoins-2938j0x8920sbj72 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ssoadmin_permission_set_inline_policy.html.markdown b/website/docs/cdktf/typescript/r/ssoadmin_permission_set_inline_policy.html.markdown index 310afb6b234e..eb0beadcd511 100644 --- a/website/docs/cdktf/typescript/r/ssoadmin_permission_set_inline_policy.html.markdown +++ b/website/docs/cdktf/typescript/r/ssoadmin_permission_set_inline_policy.html.markdown @@ -85,6 +85,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `inlinePolicy` - (Required) The IAM inline policy to attach to a Permission Set. * `instanceArn` - (Required, Forces new resource) The Amazon Resource Name (ARN) of the SSO Instance under which the operation will be executed. * `permissionSetArn` - (Required, Forces new resource) The Amazon Resource Name (ARN) of the Permission Set. @@ -134,4 +135,4 @@ Using `terraform import`, import SSO Permission Set Inline Policies using the `p % terraform import aws_ssoadmin_permission_set_inline_policy.example arn:aws:sso:::permissionSet/ssoins-2938j0x8920sbj72/ps-80383020jr9302rk,arn:aws:sso:::instance/ssoins-2938j0x8920sbj72 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ssoadmin_permissions_boundary_attachment.html.markdown b/website/docs/cdktf/typescript/r/ssoadmin_permissions_boundary_attachment.html.markdown index 2c971742f637..970ff0c955fb 100644 --- a/website/docs/cdktf/typescript/r/ssoadmin_permissions_boundary_attachment.html.markdown +++ b/website/docs/cdktf/typescript/r/ssoadmin_permissions_boundary_attachment.html.markdown @@ -120,8 +120,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `instanceArn` - (Required, Forces new resource) The Amazon Resource Name (ARN) of the SSO Instance under which the operation will be executed. * `permissionSetArn` - (Required, Forces new resource) The Amazon Resource Name (ARN) of the Permission Set. * `permissionsBoundary` - (Required, Forces new resource) The permissions boundary policy. See below. @@ -185,4 +186,4 @@ Using `terraform import`, import SSO Admin Permissions Boundary Attachments usin % terraform import aws_ssoadmin_permissions_boundary_attachment.example arn:aws:sso:::permissionSet/ssoins-2938j0x8920sbj72/ps-80383020jr9302rk,arn:aws:sso:::instance/ssoins-2938j0x8920sbj72 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/ssoadmin_trusted_token_issuer.html.markdown b/website/docs/cdktf/typescript/r/ssoadmin_trusted_token_issuer.html.markdown index 353dc599528b..bf2e4466f3ae 100644 --- a/website/docs/cdktf/typescript/r/ssoadmin_trusted_token_issuer.html.markdown +++ b/website/docs/cdktf/typescript/r/ssoadmin_trusted_token_issuer.html.markdown @@ -70,6 +70,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `clientToken` - (Optional) A unique, case-sensitive ID that you provide to ensure the idempotency of the request. AWS generates a random value when not provided. * `tags` - (Optional) Key-value mapping of resource tags. If configured with a provider [`defaultTags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. @@ -124,4 +125,4 @@ Using `terraform import`, import SSO Admin Trusted Token Issuer using the `id`. % terraform import aws_ssoadmin_trusted_token_issuer.example arn:aws:sso::123456789012:trustedTokenIssuer/ssoins-lu1ye3gew4mbc7ju/tti-2657c556-9707-11ee-b9d1-0242ac120002 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/storagegateway_cache.html.markdown b/website/docs/cdktf/typescript/r/storagegateway_cache.html.markdown index 15c0c50e25e4..2a95cd476189 100644 --- a/website/docs/cdktf/typescript/r/storagegateway_cache.html.markdown +++ b/website/docs/cdktf/typescript/r/storagegateway_cache.html.markdown @@ -41,6 +41,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `diskId` - (Required) Local disk identifier. For example, `pci-0000:03:00.0-scsi-0:0:0:0`. * `gatewayArn` - (Required) The Amazon Resource Name (ARN) of the gateway. @@ -82,4 +83,4 @@ Using `terraform import`, import `aws_storagegateway_cache` using the gateway Am % terraform import aws_storagegateway_cache.example arn:aws:storagegateway:us-east-1:123456789012:gateway/sgw-12345678:pci-0000:03:00.0-scsi-0:0:0:0 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/storagegateway_cached_iscsi_volume.html.markdown b/website/docs/cdktf/typescript/r/storagegateway_cached_iscsi_volume.html.markdown index 116808244987..8b72d144aeff 100644 --- a/website/docs/cdktf/typescript/r/storagegateway_cached_iscsi_volume.html.markdown +++ b/website/docs/cdktf/typescript/r/storagegateway_cached_iscsi_volume.html.markdown @@ -106,6 +106,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `gatewayArn` - (Required) The Amazon Resource Name (ARN) of the gateway. * `networkInterfaceId` - (Required) The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted. * `targetName` - (Required) The name of the iSCSI target used by initiators to connect to the target and as a suffix for the target ARN. The target name must be unique across all volumes of a gateway. @@ -162,4 +163,4 @@ Using `terraform import`, import `aws_storagegateway_cached_iscsi_volume` using % terraform import aws_storagegateway_cached_iscsi_volume.example arn:aws:storagegateway:us-east-1:123456789012:gateway/sgw-12345678/volume/vol-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/storagegateway_file_system_association.html.markdown b/website/docs/cdktf/typescript/r/storagegateway_file_system_association.html.markdown index 0bb9d5b2ce68..ef0955939f97 100644 --- a/website/docs/cdktf/typescript/r/storagegateway_file_system_association.html.markdown +++ b/website/docs/cdktf/typescript/r/storagegateway_file_system_association.html.markdown @@ -119,6 +119,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `gatewayArn` - (Required) The Amazon Resource Name (ARN) of the gateway. * `locationArn` - (Required) The Amazon Resource Name (ARN) of the Amazon FSx file system to associate with the FSx File Gateway. * `username` - (Required) The user name of the user credential that has permission to access the root share of the Amazon FSx file system. The user account must belong to the Amazon FSx delegated admin user group. @@ -181,4 +182,4 @@ Using `terraform import`, import `aws_storagegateway_file_system_association` us % terraform import aws_storagegateway_file_system_association.example arn:aws:storagegateway:us-east-1:123456789012:fs-association/fsa-0DA347732FDB40125 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/storagegateway_gateway.html.markdown b/website/docs/cdktf/typescript/r/storagegateway_gateway.html.markdown index 7ddab12005b2..0f571bbbe1ac 100644 --- a/website/docs/cdktf/typescript/r/storagegateway_gateway.html.markdown +++ b/website/docs/cdktf/typescript/r/storagegateway_gateway.html.markdown @@ -191,6 +191,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `gatewayName` - (Required) Name of the gateway. * `gatewayTimezone` - (Required) Time zone for the gateway. The time zone is of the format "GMT", "GMT-hr:mm", or "GMT+hr:mm". For example, `GMT-4:00` indicates the time is 4 hours behind GMT. The time zone is used, for example, for scheduling snapshots and your gateway's maintenance schedule. * `activationKey` - (Optional) Gateway activation key during resource creation. Conflicts with `gatewayIpAddress`. Additional information is available in the [Storage Gateway User Guide](https://docs.aws.amazon.com/storagegateway/latest/userguide/get-activation-key.html). @@ -321,4 +322,4 @@ class MyConvertedCode extends TerraformStack { ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/storagegateway_nfs_file_share.html.markdown b/website/docs/cdktf/typescript/r/storagegateway_nfs_file_share.html.markdown index f98b36f512b6..2233d4515138 100644 --- a/website/docs/cdktf/typescript/r/storagegateway_nfs_file_share.html.markdown +++ b/website/docs/cdktf/typescript/r/storagegateway_nfs_file_share.html.markdown @@ -41,6 +41,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `clientList` - (Required) The list of clients that are allowed to access the file gateway. The list must contain either valid IP addresses or valid CIDR blocks. Set to `["0.0.0.0/0"]` to not limit access. Minimum 1 item. Maximum 100 items. * `gatewayArn` - (Required) Amazon Resource Name (ARN) of the file gateway. * `locationArn` - (Required) The ARN of the backed storage used for storing file data. @@ -127,4 +128,4 @@ Using `terraform import`, import `aws_storagegateway_nfs_file_share` using the N % terraform import aws_storagegateway_nfs_file_share.example arn:aws:storagegateway:us-east-1:123456789012:share/share-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/storagegateway_smb_file_share.html.markdown b/website/docs/cdktf/typescript/r/storagegateway_smb_file_share.html.markdown index 31a7344ddbf0..484a2445a80d 100644 --- a/website/docs/cdktf/typescript/r/storagegateway_smb_file_share.html.markdown +++ b/website/docs/cdktf/typescript/r/storagegateway_smb_file_share.html.markdown @@ -72,6 +72,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `gatewayArn` - (Required) Amazon Resource Name (ARN) of the file gateway. * `locationArn` - (Required) The ARN of the backed storage used for storing file data. * `vpcEndpointDnsName` - (Optional) The DNS name of the VPC endpoint for S3 private link. @@ -89,8 +90,6 @@ This resource supports the following arguments: * `objectAcl` - (Optional) Access Control List permission for S3 objects. Defaults to `private`. * `oplocksEnabled` - (Optional) Boolean to indicate Opportunistic lock (oplock) status. Defaults to `true`. * `cacheAttributes` - (Optional) Refresh cache information. see [`cacheAttributes` Block](#cache_attributes-block) for more details. - - **Note:** If you have previously included a `cacheAttributes` block in your configuration, removing it will not reset the refresh cache value and the previous value will remain. You must explicitly set a new value to change it. * `readOnly` - (Optional) Boolean to indicate write status of file share. File share does not accept writes if `true`. Defaults to `false`. * `requesterPays` - (Optional) Boolean who pays the cost of the request and the data download from the Amazon S3 bucket. Set this value to `true` if you want the requester to pay instead of the bucket owner. Defaults to `false`. * `smbAclEnabled` - (Optional) Set this value to `true` to enable ACL (access control list) on the SMB fileshare. Set it to `false` to map file and directory permissions to the POSIX permissions. This setting applies only to `ActiveDirectory` authentication type. @@ -100,6 +99,8 @@ This resource supports the following arguments: * `notificationPolicy` - (Optional) The notification policy of the file share. For more information see the [AWS Documentation](https://docs.aws.amazon.com/storagegateway/latest/APIReference/API_CreateNFSFileShare.html#StorageGateway-CreateNFSFileShare-request-NotificationPolicy). Default value is `{}`. * `tags` - (Optional) Key-value map of resource tags. If configured with a provider [`defaultTags` 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. +**Note:** If you have previously included a `cacheAttributes` block in your configuration, removing it will not reset the refresh cache value and the previous value will remain. You must explicitly set a new value to change it. + ### `cacheAttributes` Block The `cacheAttributes` configuration block supports the following arguments: @@ -158,4 +159,4 @@ Using `terraform import`, import `aws_storagegateway_smb_file_share` using the S % terraform import aws_storagegateway_smb_file_share.example arn:aws:storagegateway:us-east-1:123456789012:share/share-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/storagegateway_stored_iscsi_volume.html.markdown b/website/docs/cdktf/typescript/r/storagegateway_stored_iscsi_volume.html.markdown index 41129cb559e0..9d07127270c5 100644 --- a/website/docs/cdktf/typescript/r/storagegateway_stored_iscsi_volume.html.markdown +++ b/website/docs/cdktf/typescript/r/storagegateway_stored_iscsi_volume.html.markdown @@ -73,6 +73,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `gatewayArn` - (Required) The Amazon Resource Name (ARN) of the gateway. * `networkInterfaceId` - (Required) The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted. * `targetName` - (Required) The name of the iSCSI target used by initiators to connect to the target and as a suffix for the target ARN. The target name must be unique across all volumes of a gateway. @@ -133,4 +134,4 @@ Using `terraform import`, import `aws_storagegateway_stored_iscsi_volume` using % terraform import aws_storagegateway_stored_iscsi_volume.example arn:aws:storagegateway:us-east-1:123456789012:gateway/sgw-12345678/volume/vol-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/storagegateway_tape_pool.html.markdown b/website/docs/cdktf/typescript/r/storagegateway_tape_pool.html.markdown index 895f794eae4c..4f237add56a5 100644 --- a/website/docs/cdktf/typescript/r/storagegateway_tape_pool.html.markdown +++ b/website/docs/cdktf/typescript/r/storagegateway_tape_pool.html.markdown @@ -39,6 +39,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `poolName` - (Required) The name of the new custom tape pool. * `storageClass` - (Required) The storage class that is associated with the new custom pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class that corresponds to the pool. Possible values are `DEEP_ARCHIVE` or `GLACIER`. * `retentionLockType` - (Required) Tape retention lock can be configured in two modes. When configured in governance mode, AWS accounts with specific IAM permissions are authorized to remove the tape retention lock from archived virtual tapes. When configured in compliance mode, the tape retention lock cannot be removed by any user, including the root AWS account. Possible values are `COMPLIANCE`, `GOVERNANCE`, and `NONE`. Default value is `NONE`. @@ -84,4 +85,4 @@ Using `terraform import`, import `aws_storagegateway_tape_pool` using the volume % terraform import aws_storagegateway_tape_pool.example arn:aws:storagegateway:us-east-1:123456789012:tapepool/pool-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/storagegateway_upload_buffer.html.markdown b/website/docs/cdktf/typescript/r/storagegateway_upload_buffer.html.markdown index 4214e7409e6f..b111a7bae12f 100644 --- a/website/docs/cdktf/typescript/r/storagegateway_upload_buffer.html.markdown +++ b/website/docs/cdktf/typescript/r/storagegateway_upload_buffer.html.markdown @@ -82,6 +82,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `diskId` - (Optional) Local disk identifier. For example, `pci-0000:03:00.0-scsi-0:0:0:0`. * `diskPath` - (Optional) Local disk path. For example, `/dev/nvme1n1`. * `gatewayArn` - (Required) The Amazon Resource Name (ARN) of the gateway. @@ -124,4 +125,4 @@ Using `terraform import`, import `aws_storagegateway_upload_buffer` using the ga % terraform import aws_storagegateway_upload_buffer.example arn:aws:storagegateway:us-east-1:123456789012:gateway/sgw-12345678:pci-0000:03:00.0-scsi-0:0:0:0 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/storagegateway_working_storage.html.markdown b/website/docs/cdktf/typescript/r/storagegateway_working_storage.html.markdown index 3d00cf6433d6..89a109c3f7c2 100644 --- a/website/docs/cdktf/typescript/r/storagegateway_working_storage.html.markdown +++ b/website/docs/cdktf/typescript/r/storagegateway_working_storage.html.markdown @@ -41,6 +41,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `diskId` - (Required) Local disk identifier. For example, `pci-0000:03:00.0-scsi-0:0:0:0`. * `gatewayArn` - (Required) The Amazon Resource Name (ARN) of the gateway. @@ -82,4 +83,4 @@ Using `terraform import`, import `aws_storagegateway_working_storage` using the % terraform import aws_storagegateway_working_storage.example arn:aws:storagegateway:us-east-1:123456789012:gateway/sgw-12345678:pci-0000:03:00.0-scsi-0:0:0:0 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/subnet.html.markdown b/website/docs/cdktf/typescript/r/subnet.html.markdown index 795a55bb1d9a..278dc4a813ac 100644 --- a/website/docs/cdktf/typescript/r/subnet.html.markdown +++ b/website/docs/cdktf/typescript/r/subnet.html.markdown @@ -81,6 +81,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `assignIpv6AddressOnCreation` - (Optional) Specify true to indicate that network interfaces created in the specified subnet should be assigned an IPv6 address. Default is `false` @@ -149,4 +150,4 @@ Using `terraform import`, import subnets using the subnet `id`. For example: % terraform import aws_subnet.public_subnet subnet-9d4a7b6c ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/swf_domain.html.markdown b/website/docs/cdktf/typescript/r/swf_domain.html.markdown index eafc2452a214..cb317b4fe231 100644 --- a/website/docs/cdktf/typescript/r/swf_domain.html.markdown +++ b/website/docs/cdktf/typescript/r/swf_domain.html.markdown @@ -42,6 +42,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Optional, Forces new resource) The name of the domain. If omitted, Terraform will assign a random, unique name. * `namePrefix` - (Optional, Forces new resource) Creates a unique name beginning with the specified prefix. Conflicts with `name`. * `description` - (Optional, Forces new resource) The domain description. @@ -84,4 +85,4 @@ Using `terraform import`, import SWF Domains using the `name`. For example: % terraform import aws_swf_domain.foo test-domain ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/synthetics_canary.html.markdown b/website/docs/cdktf/typescript/r/synthetics_canary.html.markdown index 788372e6f1a4..289fc2396cc7 100644 --- a/website/docs/cdktf/typescript/r/synthetics_canary.html.markdown +++ b/website/docs/cdktf/typescript/r/synthetics_canary.html.markdown @@ -51,12 +51,13 @@ The following arguments are required: * `artifactS3Location` - (Required) Location in Amazon S3 where Synthetics stores artifacts from the test runs of this canary. * `executionRoleArn` - (Required) ARN of the IAM role to be used to run the canary. see [AWS Docs](https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_CreateCanary.html#API_CreateCanary_RequestSyntax) for permissions needs for IAM Role. * `handler` - (Required) Entry point to use for the source code when running the canary. This value must end with the string `.handler` . -* `name` - (Required) Name for this canary. Has a maximum length of 21 characters. Valid characters are lowercase alphanumeric, hyphen, or underscore. +* `name` - (Required) Name for this canary. Has a maximum length of 255 characters. Valid characters are lowercase alphanumeric, hyphen, or underscore. * `runtimeVersion` - (Required) Runtime version to use for the canary. Versions change often so consult the [Amazon CloudWatch documentation](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Library.html) for the latest valid versions. Values include `syn-python-selenium-1.0`, `syn-nodejs-puppeteer-3.0`, `syn-nodejs-2.2`, `syn-nodejs-2.1`, `syn-nodejs-2.0`, and `syn-1.0`. * `schedule` - (Required) Configuration block providing how often the canary is to run and when these test runs are to stop. Detailed below. The following arguments are optional: +* `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). * `deleteLambda` - (Optional) Specifies whether to also delete the Lambda functions and layers used by this canary. The default is `false`. * `vpcConfig` - (Optional) Configuration block. Detailed below. * `failureRetentionPeriod` - (Optional) Number of days to retain data about failed runs of this canary. If you omit this field, the default of 31 days is used. The valid range is 1 to 455 days. @@ -97,6 +98,7 @@ If this canary tests an endpoint in a VPC, this structure contains information a * `subnetIds` - (Required) IDs of the subnets where this canary is to run. * `securityGroupIds` - (Required) IDs of the security groups for this canary. +* `ipv6AllowedForDualStack` - (Optional) If `true`, allow outbound IPv6 traffic on VPC canaries that are connected to dual-stack subnets. The default is `false`. ## Attribute Reference @@ -149,4 +151,4 @@ Using `terraform import`, import Synthetics Canaries using the `name`. For examp % terraform import aws_synthetics_canary.some some-canary ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/synthetics_group.html.markdown b/website/docs/cdktf/typescript/r/synthetics_group.html.markdown index 38d47ad3e94f..99a1ee207683 100644 --- a/website/docs/cdktf/typescript/r/synthetics_group.html.markdown +++ b/website/docs/cdktf/typescript/r/synthetics_group.html.markdown @@ -44,6 +44,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `tags` - (Optional) Key-value mapping of resource tags. If configured with a provider [`defaultTags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. ## Attribute Reference @@ -82,4 +83,4 @@ Using `terraform import`, import CloudWatch Synthetics Group using the `name`. F % terraform import aws_synthetics_group.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/synthetics_group_association.html.markdown b/website/docs/cdktf/typescript/r/synthetics_group_association.html.markdown index 1eb79b1e410b..83b91d656c6f 100644 --- a/website/docs/cdktf/typescript/r/synthetics_group_association.html.markdown +++ b/website/docs/cdktf/typescript/r/synthetics_group_association.html.markdown @@ -39,8 +39,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `groupName` - (Required) Name of the group that the canary will be associated with. * `canaryArn` - (Required) ARN of the canary. @@ -83,4 +84,4 @@ Using `terraform import`, import CloudWatch Synthetics Group Association using t % terraform import aws_synthetics_group_association.example arn:aws:synthetics:us-west-2:123456789012:canary:tf-acc-test-abcd1234,examplename ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/timestreaminfluxdb_db_cluster.html.markdown b/website/docs/cdktf/typescript/r/timestreaminfluxdb_db_cluster.html.markdown new file mode 100644 index 000000000000..378b53ad0403 --- /dev/null +++ b/website/docs/cdktf/typescript/r/timestreaminfluxdb_db_cluster.html.markdown @@ -0,0 +1,364 @@ +--- +subcategory: "Timestream for InfluxDB" +layout: "aws" +page_title: "AWS: aws_timestreaminfluxdb_db_cluster" +description: |- + Terraform resource for managing an Amazon Timestream for InfluxDB read-replica cluster. +--- + + + +# Resource: aws_timestreaminfluxdb_db_cluster + +Terraform resource for managing an Amazon Timestream for InfluxDB read-replica cluster. + +~> **NOTE:** This resource requires a subscription to [Timestream for InfluxDB Read Replicas (Add-On) on the AWS Marketplace](https://aws.amazon.com/marketplace/pp/prodview-lftzfxtb5xlv4?applicationId=AWS-Marketplace-Console&ref_=beagle&sr=0-2). + +## Example Usage + +### Basic Usage + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { Token, TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { TimestreaminfluxdbDbCluster } from "./.gen/providers/aws/timestreaminfluxdb-db-cluster"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + new TimestreaminfluxdbDbCluster(this, "example", { + allocatedStorage: 20, + bucket: "example-bucket-name", + dbInstanceType: "db.influx.medium", + failoverMode: "AUTOMATIC", + name: "example-db-cluster", + organization: "organization", + password: "example-password", + port: 8086, + username: "admin", + vpcSecurityGroupIds: [Token.asString(awsSecurityGroupExample.id)], + vpcSubnetIds: [example1.id, example2.id], + }); + } +} + +``` + +### Usage with Prerequisite Resources + +All Timestream for InfluxDB clusters require a VPC, at least two subnets, and a security group. The following example shows how these prerequisite resources can be created and used with `aws_timestreaminfluxdb_db_cluster`. + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { Token, TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { SecurityGroup } from "./.gen/providers/aws/security-group"; +import { Subnet } from "./.gen/providers/aws/subnet"; +import { TimestreaminfluxdbDbCluster } from "./.gen/providers/aws/timestreaminfluxdb-db-cluster"; +import { Vpc } from "./.gen/providers/aws/vpc"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + const example = new Vpc(this, "example", { + cidrBlock: "10.0.0.0/16", + }); + const awsSecurityGroupExample = new SecurityGroup(this, "example_1", { + name: "example", + vpcId: example.id, + }); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + awsSecurityGroupExample.overrideLogicalId("example"); + const example1 = new Subnet(this, "example_1_2", { + cidrBlock: "10.0.1.0/24", + vpcId: example.id, + }); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + example1.overrideLogicalId("example_1"); + const example2 = new Subnet(this, "example_2", { + cidrBlock: "10.0.2.0/24", + vpcId: example.id, + }); + const awsTimestreaminfluxdbDbClusterExample = + new TimestreaminfluxdbDbCluster(this, "example_4", { + allocatedStorage: 20, + bucket: "example-bucket-name", + dbInstanceType: "db.influx.medium", + name: "example-db-cluster", + organization: "organization", + password: "example-password", + username: "admin", + vpcSecurityGroupIds: [Token.asString(awsSecurityGroupExample.id)], + vpcSubnetIds: [example1.id, example2.id], + }); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + awsTimestreaminfluxdbDbClusterExample.overrideLogicalId("example"); + } +} + +``` + +### Usage with Public Internet Access Enabled + +The following configuration shows how to define the necessary resources and arguments to allow public internet access on your Timestream for InfluxDB read-replica cluster's primary endpoint (simply referred to as "endpoint") and read endpoint on port `8086`. After applying this configuration, the cluster's InfluxDB UI can be accessed by visiting your cluster's primary endpoint at port `8086`. + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { Token, Op, TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { InternetGateway } from "./.gen/providers/aws/internet-gateway"; +import { Route } from "./.gen/providers/aws/route"; +import { RouteTableAssociation } from "./.gen/providers/aws/route-table-association"; +import { SecurityGroup } from "./.gen/providers/aws/security-group"; +import { Subnet } from "./.gen/providers/aws/subnet"; +import { TimestreaminfluxdbDbCluster } from "./.gen/providers/aws/timestreaminfluxdb-db-cluster"; +import { Vpc } from "./.gen/providers/aws/vpc"; +import { VpcSecurityGroupIngressRule } from "./.gen/providers/aws/vpc-security-group-ingress-rule"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + const example = new Vpc(this, "example", { + cidrBlock: "10.0.0.0/16", + }); + const awsInternetGatewayExample = new InternetGateway(this, "example_1", { + tags: { + Name: "example", + }, + vpcId: example.id, + }); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + awsInternetGatewayExample.overrideLogicalId("example"); + new Route(this, "test_route", { + destinationCidrBlock: "0.0.0.0/0", + gatewayId: Token.asString(awsInternetGatewayExample.id), + routeTableId: example.mainRouteTableId, + }); + new RouteTableAssociation(this, "test_route_table_association", { + routeTableId: example.mainRouteTableId, + subnetId: testSubnet.id, + }); + const awsSecurityGroupExample = new SecurityGroup(this, "example_4", { + name: "example", + vpcId: example.id, + }); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + awsSecurityGroupExample.overrideLogicalId("example"); + const example1 = new Subnet(this, "example_1_5", { + cidrBlock: "10.0.1.0/24", + vpcId: example.id, + }); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + example1.overrideLogicalId("example_1"); + const example2 = new Subnet(this, "example_2", { + cidrBlock: "10.0.2.0/24", + vpcId: example.id, + }); + const awsTimestreaminfluxdbDbClusterExample = + new TimestreaminfluxdbDbCluster(this, "example_7", { + allocatedStorage: 20, + bucket: "example-bucket-name", + dbInstanceType: "db.influx.medium", + name: "example-db-cluster", + organization: "organization", + password: "example-password", + publiclyAccessible: true, + username: "admin", + vpcSecurityGroupIds: [Token.asString(awsSecurityGroupExample.id)], + vpcSubnetIds: [example1.id, example2.id], + }); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + awsTimestreaminfluxdbDbClusterExample.overrideLogicalId("example"); + const awsVpcSecurityGroupIngressRuleExample = + new VpcSecurityGroupIngressRule(this, "example_8", { + ipProtocol: Token.asString(Op.negate(1)), + referencedSecurityGroupId: Token.asString(awsSecurityGroupExample.id), + securityGroupId: Token.asString(awsSecurityGroupExample.id), + }); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + awsVpcSecurityGroupIngressRuleExample.overrideLogicalId("example"); + } +} + +``` + +### Usage with S3 Log Delivery Enabled + +You can use an S3 bucket to store logs generated by your Timestream for InfluxDB cluster. The following example shows what resources and arguments are required to configure an S3 bucket for logging, including the IAM policy that needs to be set in order to allow Timestream for InfluxDB to place logs in your S3 bucket. The configuration of the required VPC, security group, and subnets have been left out of the example for brevity. + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { Token, TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { DataAwsIamPolicyDocument } from "./.gen/providers/aws/data-aws-iam-policy-document"; +import { S3Bucket } from "./.gen/providers/aws/s3-bucket"; +import { S3BucketPolicy } from "./.gen/providers/aws/s3-bucket-policy"; +import { TimestreaminfluxdbDbCluster } from "./.gen/providers/aws/timestreaminfluxdb-db-cluster"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + const example = new S3Bucket(this, "example", { + bucket: "example-s3-bucket", + forceDestroy: true, + }); + const awsTimestreaminfluxdbDbClusterExample = + new TimestreaminfluxdbDbCluster(this, "example_1", { + allocatedStorage: 20, + bucket: "example-bucket-name", + dbInstanceType: "db.influx.medium", + logDeliveryConfiguration: [ + { + s3Configuration: [ + { + bucketName: example.bucket, + enabled: true, + }, + ], + }, + ], + name: "example-db-cluster", + organization: "organization", + password: "example-password", + username: "admin", + vpcSecurityGroupIds: [Token.asString(awsSecurityGroupExample.id)], + vpcSubnetIds: [example1.id, example2.id], + }); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + awsTimestreaminfluxdbDbClusterExample.overrideLogicalId("example"); + const dataAwsIamPolicyDocumentExample = new DataAwsIamPolicyDocument( + this, + "example_2", + { + statement: [ + { + actions: ["s3:PutObject"], + principals: [ + { + identifiers: ["timestream-influxdb.amazonaws.com"], + type: "Service", + }, + ], + resources: ["${" + 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.*/ + dataAwsIamPolicyDocumentExample.overrideLogicalId("example"); + const awsS3BucketPolicyExample = new S3BucketPolicy(this, "example_3", { + bucket: example.id, + policy: Token.asString(dataAwsIamPolicyDocumentExample.json), + }); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + awsS3BucketPolicyExample.overrideLogicalId("example"); + } +} + +``` + +## Argument Reference + +The following arguments are required: + +* `allocatedStorage` - (Required) Amount of storage in GiB (gibibytes). The minimum value is `20`, the maximum value is `16384`. The argument `dbStorageType` places restrictions on this argument's minimum value. The following is a list of `dbStorageType` values and the corresponding minimum value for `allocatedStorage`: `"InfluxIOIncludedT1": `20`, `"InfluxIOIncludedT2" and `"InfluxIOIncludedT3": `400`. +* `bucket` - (Required) Name of the initial InfluxDB bucket. All InfluxDB data is stored in a bucket. A bucket combines the concept of a database and a retention period (the duration of time that each data point persists). A bucket belongs to an organization. Along with `organization`, `username`, and `password`, this argument will be stored in the secret referred to by the `influxAuthParametersSecretArn` attribute. +* `dbInstanceType` - (Required) Timestream for InfluxDB DB instance type to run InfluxDB on. Valid options are: `"db.influx.medium"`, `"db.influx.large"`, `"db.influx.xlarge"`, `"db.influx.2xlarge"`, `"db.influx.4xlarge"`, `"db.influx.8xlarge"`, `"db.influx.12xlarge"`, and `"db.influx.16xlarge"`. This argument is updatable. +* `name` - (Required) Name that uniquely identifies the DB cluster when interacting with the Amazon Timestream for InfluxDB API and CLI commands. This name will also be a prefix included in the endpoint. Cluster names must be unique per customer and per region. The argument must start with a letter, cannot contain consecutive hyphens (`-`) and cannot end with a hyphen. +* `password` - (Required) Password of the initial admin user created in InfluxDB. This password will allow you to access the InfluxDB UI to perform various administrative tasks and also use the InfluxDB CLI to create an operator token. Along with `bucket`, `username`, and `organization`, this argument will be stored in the secret referred to by the `influxAuthParametersSecretArn` attribute. +* `organization` - (Required) Name of the initial organization for the initial admin user in InfluxDB. An InfluxDB organization is a workspace for a group of users. Along with `bucket`, `username`, and `password`, this argument will be stored in the secret referred to by the `influxAuthParametersSecretArn` attribute. +* `username` - (Required) Username of the initial admin user created in InfluxDB. Must start with a letter and can't end with a hyphen or contain two consecutive hyphens. This username will allow you to access the InfluxDB UI to perform various administrative tasks and also use the InfluxDB CLI to create an operator token. Along with `bucket`, `organization`, and `password`, this argument will be stored in the secret referred to by the `influxAuthParametersSecretArn` attribute. +* `vpcSecurityGroupIds` - (Required) List of VPC security group IDs to associate with the cluster. +* `vpcSubnetIds` - (Required) List of VPC subnet IDs to associate with the cluster. Provide at least two VPC subnet IDs in different availability zones when deploying with a Multi-AZ standby. + +The following arguments are optional: + +* `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). +* `dbParameterGroupIdentifier` - (Optional) ID of the DB parameter group assigned to your cluster. This argument is updatable. If added to an existing Timestream for InfluxDB cluster or given a new value, will cause an in-place update to the cluster. However, if a cluster already has a value for `dbParameterGroupIdentifier`, removing `dbParameterGroupIdentifier` will cause the cluster to be destroyed and recreated. +* `dbStorageType` - (Default `"InfluxIOIncludedT1"`) Timestream for InfluxDB DB storage type to read and write InfluxDB data. You can choose between 3 different types of provisioned Influx IOPS included storage according to your workloads requirements: Influx IO Included 3000 IOPS, Influx IO Included 12000 IOPS, Influx IO Included 16000 IOPS. Valid options are: `"InfluxIOIncludedT1"`, `"InfluxIOIncludedT2"`, and `"InfluxIOIncludedT3"`. If you use `"InfluxIOIncludedT2" or "InfluxIOIncludedT3", the minimum value for `allocated_storage` is 400. +* `deploymentType` - (Default `"MULTI_NODE_READ_REPLICAS"`) Specifies the type of cluster to create. Valid options are: `"MULTI_NODE_READ_REPLICAS"`. +* `failoverMode` - (Default `"AUTOMATIC"`) Specifies the behavior of failure recovery when the primary node of the cluster fails. Valid options are: `"AUTOMATIC"` and `"NO_FAILOVER"`. +* `logDeliveryConfiguration` - (Optional) Configuration for sending InfluxDB engine logs to a specified S3 bucket. This argument is updatable. +* `networkType` - (Optional) Specifies whether the network type of the Timestream for InfluxDB cluster is IPV4, which can communicate over IPv4 protocol only, or DUAL, which can communicate over both IPv4 and IPv6 protocols. +* `port` - (Default `8086`) The port on which the cluster accepts connections. Valid values: `1024`-`65535`. Cannot be `2375`-`2376`, `7788`-`7799`, `8090`, or `51678`-`51680`. This argument is updatable. +* `publiclyAccessible` - (Default `false`) Configures the DB cluster with a public IP to facilitate access. Other resources, such as a VPC, a subnet, an internet gateway, and a route table with routes, are also required to enabled public access, in addition to this argument. See "[Usage with Public Internet Access Enabled](#usage-with-public-internet-access-enabled)" for an example configuration with all required resources for public internet access. +* `tags` - (Optional) Map of tags assigned to the resource. If configured with a provider [`defaultTags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. + +### Nested Fields + +#### `logDeliveryConfiguration` + +* `s3Configuration` - (Required) Configuration for S3 bucket log delivery. + +#### `s3Configuration` + +* `bucketName` - (Required) Name of the S3 bucket to deliver logs to. +* `enabled` - (Required) Indicates whether log delivery to the S3 bucket is enabled. + +**Note**: The following arguments do updates in-place: `dbParameterGroupIdentifier`, `logDeliveryConfiguration`, `port`, `dbInstanceType`, `failoverMode`, and `tags`. Changes to any other argument after a cluster has been deployed will cause destruction and re-creation of the cluster. Additionally, when `dbParameterGroupIdentifier` is added to a cluster or modified, the cluster will be updated in-place but if `dbParameterGroupIdentifier` is removed from a cluster, the cluster will be destroyed and re-created. + +## Attribute Reference + +This resource exports the following attributes in addition to the arguments above: + +* `arn` - ARN of the Timestream for InfluxDB cluster. +* `endpoint` - Endpoint used to connect to InfluxDB. The default InfluxDB port is 8086. +* `id` - ID of the Timestream for InfluxDB cluster. +* `influxAuthParametersSecretArn` - ARN of the AWS Secrets Manager secret containing the initial InfluxDB authorization parameters. The secret value is a JSON formatted key-value pair holding InfluxDB authorization values: organization, bucket, username, and password. +* `readerEndpoint` - The endpoint used to connect to the Timestream for InfluxDB cluster for read-only operations. +* `tagsAll` - Map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). + +## Timeouts + +[Configuration options](https://developer.hashicorp.com/terraform/language/resources/syntax#operation-timeouts): + +* `create` - (Default `30m`) +* `update` - (Default `30m`) +* `delete` - (Default `30m`) + +## Import + +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import Timestream for InfluxDB cluster using its identifier. For example: + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { TimestreaminfluxdbDbCluster } from "./.gen/providers/aws/timestreaminfluxdb-db-cluster"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + TimestreaminfluxdbDbCluster.generateConfigForImport( + this, + "example", + "12345abcde" + ); + } +} + +``` + +Using `terraform import`, import Timestream for InfluxDB cluster using its identifier. For example: + +```console +% terraform import aws_timestreaminfluxdb_db_cluster.example 12345abcde +``` + + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/timestreaminfluxdb_db_instance.html.markdown b/website/docs/cdktf/typescript/r/timestreaminfluxdb_db_instance.html.markdown index 63996f8d4a84..b44468542083 100644 --- a/website/docs/cdktf/typescript/r/timestreaminfluxdb_db_instance.html.markdown +++ b/website/docs/cdktf/typescript/r/timestreaminfluxdb_db_instance.html.markdown @@ -319,6 +319,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `dbParameterGroupIdentifier` - (Optional) ID of the DB parameter group assigned to your DB instance. This argument is updatable. If added to an existing Timestream for InfluxDB instance or given a new value, will cause an in-place update to the instance. However, if an instance already has a value for `dbParameterGroupIdentifier`, removing `dbParameterGroupIdentifier` will cause the instance to be destroyed and recreated. * `dbStorageType` - (Default `"InfluxIOIncludedT1"`) Timestream for InfluxDB DB storage type to read and write InfluxDB data. You can choose between 3 different types of provisioned Influx IOPS included storage according to your workloads requirements: Influx IO Included 3000 IOPS, Influx IO Included 12000 IOPS, Influx IO Included 16000 IOPS. Valid options are: `"InfluxIOIncludedT1"`, `"InfluxIOIncludedT2"`, and `"InfluxIOIncludedT3"`. If you use `"InfluxIOIncludedT2" or "InfluxIOIncludedT3", the minimum value for `allocated_storage` is 400. This argument is updatable. For a single instance, after this argument has been updated once, it can only be updated again after 6 hours have passed. * `deploymentType` - (Default `"SINGLE_AZ"`) Specifies whether the DB instance will be deployed as a standalone instance or with a Multi-AZ standby for high availability. Valid options are: `"SINGLE_AZ"`, `"WITH_MULTIAZ_STANDBY"`. This argument is updatable. @@ -349,7 +350,7 @@ This resource exports the following attributes in addition to the arguments abov * `availabilityZone` - Availability Zone in which the DB instance resides. * `endpoint` - Endpoint used to connect to InfluxDB. The default InfluxDB port is 8086. * `id` - ID of the Timestream for InfluxDB instance. -* `influxAuthParametersSecretArn` - ARN of the AWS Secrets Manager secret containing the initial InfluxDB authorization parameters. The secret value is a JSON formatted key-value pair holding InfluxDB authorization values: organization, bucket, username, and password. This secret will be read by the `aws_timestreaminfluxdb_db_instance` resource in order to support importing: deleting the secret or secret values can cause errors. +* `influxAuthParametersSecretArn` - ARN of the AWS Secrets Manager secret containing the initial InfluxDB authorization parameters. The secret value is a JSON formatted key-value pair holding InfluxDB authorization values: organization, bucket, username, and password. * `secondaryAvailabilityZone` - Availability Zone in which the standby instance is located when deploying with a MultiAZ standby instance. * `tagsAll` - Map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). @@ -393,4 +394,4 @@ Using `terraform import`, import Timestream for InfluxDB Db Instance using its i % terraform import aws_timestreaminfluxdb_db_instance.example 12345abcde ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/timestreamquery_scheduled_query.html.markdown b/website/docs/cdktf/typescript/r/timestreamquery_scheduled_query.html.markdown index 857658e6119b..1d9a8b641d83 100644 --- a/website/docs/cdktf/typescript/r/timestreamquery_scheduled_query.html.markdown +++ b/website/docs/cdktf/typescript/r/timestreamquery_scheduled_query.html.markdown @@ -23,87 +23,89 @@ If your infrastructure is already set up—including the source database and tab ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug import { Construct } from "constructs"; -import { TerraformStack } from "cdktf"; +import { Token, TerraformStack } from "cdktf"; /* * Provider bindings are generated by running `cdktf get`. * See https://cdk.tf/provider-generation for more details. */ -import { TimestreamqueryScheduledQuery } from "./.gen/providers/aws/"; +import { TimestreamqueryScheduledQuery } from "./.gen/providers/aws/timestreamquery-scheduled-query"; class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); new TimestreamqueryScheduledQuery(this, "example", { - error_report_configuration: [ + errorReportConfiguration: [ { - s3_configuration: [ + s3Configuration: [ { - bucket_name: awsS3BucketExample.bucket, + bucketName: Token.asString(awsS3BucketExample.bucket), }, ], }, ], - execution_role_arn: awsIamRoleExample.arn, - name: awsTimestreamwriteTableExample.tableName, - notification_configuration: [ + executionRoleArn: Token.asString(awsIamRoleExample.arn), + name: Token.asString(awsTimestreamwriteTableExample.tableName), + notificationConfiguration: [ { - sns_configuration: [ + snsConfiguration: [ { - topic_arn: awsSnsTopicExample.arn, + topicArn: Token.asString(awsSnsTopicExample.arn), }, ], }, ], - query_string: + queryString: "SELECT region, az, hostname, BIN(time, 15s) AS binned_timestamp,\n\tROUND(AVG(cpu_utilization), 2) AS avg_cpu_utilization,\n\tROUND(APPROX_PERCENTILE(cpu_utilization, 0.9), 2) AS p90_cpu_utilization,\n\tROUND(APPROX_PERCENTILE(cpu_utilization, 0.95), 2) AS p95_cpu_utilization,\n\tROUND(APPROX_PERCENTILE(cpu_utilization, 0.99), 2) AS p99_cpu_utilization\nFROM exampledatabase.exampletable\nWHERE measure_name = 'metrics' AND time > ago(2h)\nGROUP BY region, hostname, az, BIN(time, 15s)\nORDER BY binned_timestamp ASC\nLIMIT 5\n\n", - schedule_configuration: [ + scheduleConfiguration: [ { - schedule_expression: "rate(1 hour)", + scheduleExpression: "rate(1 hour)", }, ], - target_configuration: [ + targetConfiguration: [ { - timestream_configuration: [ + timestreamConfiguration: [ { - database_name: results.databaseName, - dimension_mapping: [ + databaseName: results.databaseName, + dimensionMapping: [ { - dimension_value_type: "VARCHAR", + dimensionValueType: "VARCHAR", name: "az", }, { - dimension_value_type: "VARCHAR", + dimensionValueType: "VARCHAR", name: "region", }, { - dimension_value_type: "VARCHAR", + dimensionValueType: "VARCHAR", name: "hostname", }, ], - multi_measure_mappings: [ + multiMeasureMappings: [ { - multi_measure_attribute_mapping: [ + multiMeasureAttributeMapping: [ { - measure_value_type: "DOUBLE", - source_column: "avg_cpu_utilization", + measureValueType: "DOUBLE", + sourceColumn: "avg_cpu_utilization", }, { - measure_value_type: "DOUBLE", - source_column: "p90_cpu_utilization", + measureValueType: "DOUBLE", + sourceColumn: "p90_cpu_utilization", }, { - measure_value_type: "DOUBLE", - source_column: "p95_cpu_utilization", + measureValueType: "DOUBLE", + sourceColumn: "p95_cpu_utilization", }, { - measure_value_type: "DOUBLE", - source_column: "p99_cpu_utilization", + measureValueType: "DOUBLE", + sourceColumn: "p99_cpu_utilization", }, ], - target_multi_measure_name: "multi-metrics", + targetMultiMeasureName: "multi-metrics", }, ], - table_name: awsTimestreamwriteTableResults.tableName, - time_column: "binned_timestamp", + tableName: Token.asString( + awsTimestreamwriteTableResults.tableName + ), + timeColumn: "binned_timestamp", }, ], }, @@ -305,87 +307,89 @@ This is done with Amazon Timestream Write [WriteRecords](https://docs.aws.amazon ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug import { Construct } from "constructs"; -import { TerraformStack } from "cdktf"; +import { Token, TerraformStack } from "cdktf"; /* * Provider bindings are generated by running `cdktf get`. * See https://cdk.tf/provider-generation for more details. */ -import { TimestreamqueryScheduledQuery } from "./.gen/providers/aws/"; +import { TimestreamqueryScheduledQuery } from "./.gen/providers/aws/timestreamquery-scheduled-query"; class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); new TimestreamqueryScheduledQuery(this, "example", { - error_report_configuration: [ + errorReportConfiguration: [ { - s3_configuration: [ + s3Configuration: [ { - bucket_name: awsS3BucketExample.bucket, + bucketName: Token.asString(awsS3BucketExample.bucket), }, ], }, ], - execution_role_arn: awsIamRoleExample.arn, - name: awsTimestreamwriteTableExample.tableName, - notification_configuration: [ + executionRoleArn: Token.asString(awsIamRoleExample.arn), + name: Token.asString(awsTimestreamwriteTableExample.tableName), + notificationConfiguration: [ { - sns_configuration: [ + snsConfiguration: [ { - topic_arn: awsSnsTopicExample.arn, + topicArn: Token.asString(awsSnsTopicExample.arn), }, ], }, ], - query_string: + queryString: "SELECT region, az, hostname, BIN(time, 15s) AS binned_timestamp,\n\tROUND(AVG(cpu_utilization), 2) AS avg_cpu_utilization,\n\tROUND(APPROX_PERCENTILE(cpu_utilization, 0.9), 2) AS p90_cpu_utilization,\n\tROUND(APPROX_PERCENTILE(cpu_utilization, 0.95), 2) AS p95_cpu_utilization,\n\tROUND(APPROX_PERCENTILE(cpu_utilization, 0.99), 2) AS p99_cpu_utilization\nFROM exampledatabase.exampletable\nWHERE measure_name = 'metrics' AND time > ago(2h)\nGROUP BY region, hostname, az, BIN(time, 15s)\nORDER BY binned_timestamp ASC\nLIMIT 5\n\n", - schedule_configuration: [ + scheduleConfiguration: [ { - schedule_expression: "rate(1 hour)", + scheduleExpression: "rate(1 hour)", }, ], - target_configuration: [ + targetConfiguration: [ { - timestream_configuration: [ + timestreamConfiguration: [ { - database_name: results.databaseName, - dimension_mapping: [ + databaseName: results.databaseName, + dimensionMapping: [ { - dimension_value_type: "VARCHAR", + dimensionValueType: "VARCHAR", name: "az", }, { - dimension_value_type: "VARCHAR", + dimensionValueType: "VARCHAR", name: "region", }, { - dimension_value_type: "VARCHAR", + dimensionValueType: "VARCHAR", name: "hostname", }, ], - multi_measure_mappings: [ + multiMeasureMappings: [ { - multi_measure_attribute_mapping: [ + multiMeasureAttributeMapping: [ { - measure_value_type: "DOUBLE", - source_column: "avg_cpu_utilization", + measureValueType: "DOUBLE", + sourceColumn: "avg_cpu_utilization", }, { - measure_value_type: "DOUBLE", - source_column: "p90_cpu_utilization", + measureValueType: "DOUBLE", + sourceColumn: "p90_cpu_utilization", }, { - measure_value_type: "DOUBLE", - source_column: "p95_cpu_utilization", + measureValueType: "DOUBLE", + sourceColumn: "p95_cpu_utilization", }, { - measure_value_type: "DOUBLE", - source_column: "p99_cpu_utilization", + measureValueType: "DOUBLE", + sourceColumn: "p99_cpu_utilization", }, ], - target_multi_measure_name: "multi-metrics", + targetMultiMeasureName: "multi-metrics", }, ], - table_name: awsTimestreamwriteTableResults.tableName, - time_column: "binned_timestamp", + tableName: Token.asString( + awsTimestreamwriteTableResults.tableName + ), + timeColumn: "binned_timestamp", }, ], }, @@ -400,20 +404,21 @@ class MyConvertedCode extends TerraformStack { The following arguments are required: -* `error_report_configuration` - (Required) Configuration block for error reporting configuration. [See below.](#error_report_configuration) +* `errorReportConfiguration` - (Required) Configuration block for error reporting configuration. [See below.](#error_report_configuration) * `executionRoleArn` - (Required) ARN for the IAM role that Timestream will assume when running the scheduled query. * `name` - (Required) Name of the scheduled query. * `notificationConfiguration` - (Required) Configuration block for notification configuration for a scheduled query. A notification is sent by Timestream when a scheduled query is created, its state is updated, or when it is deleted. [See below.](#notification_configuration) -* `queryString` - (Required) Query string to run. Parameter names can be specified in the query string using the `@` character followed by an identifier. The named parameter `@scheduled_runtime` is reserved and can be used in the query to get the time at which the query is scheduled to run. The timestamp calculated according to the `schedule_configuration` parameter, will be the value of `@scheduled_runtime` paramater for each query run. For example, consider an instance of a scheduled query executing on 2021-12-01 00:00:00. For this instance, the `@scheduled_runtime` parameter is initialized to the timestamp 2021-12-01 00:00:00 when invoking the query. -* `schedule_configuration` - (Required) Configuration block for schedule configuration for the query. [See below.](#schedule_configuration) -* `target_configuration` - (Required) Configuration block for writing the result of a query. [See below.](#target_configuration) +* `queryString` - (Required) Query string to run. Parameter names can be specified in the query string using the `@` character followed by an identifier. The named parameter `@scheduled_runtime` is reserved and can be used in the query to get the time at which the query is scheduled to run. The timestamp calculated according to the `scheduleConfiguration` parameter, will be the value of `@scheduled_runtime` paramater for each query run. For example, consider an instance of a scheduled query executing on 2021-12-01 00:00:00. For this instance, the `@scheduled_runtime` parameter is initialized to the timestamp 2021-12-01 00:00:00 when invoking the query. +* `scheduleConfiguration` - (Required) Configuration block for schedule configuration for the query. [See below.](#schedule_configuration) +* `targetConfiguration` - (Required) Configuration block for writing the result of a query. [See below.](#target_configuration) The following arguments are optional: -* `kmsKeyId` - (Optional) Amazon KMS key used to encrypt the scheduled query resource, at-rest. If not specified, the scheduled query resource will be encrypted with a Timestream owned Amazon KMS key. To specify a KMS key, use the key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix the name with "alias/". If `error_report_configuration` uses `SSE_KMS` as the encryption type, the same `kmsKeyId` is used to encrypt the error report at rest. +* `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). +* `kmsKeyId` - (Optional) Amazon KMS key used to encrypt the scheduled query resource, at-rest. If not specified, the scheduled query resource will be encrypted with a Timestream owned Amazon KMS key. To specify a KMS key, use the key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix the name with "alias/". If `errorReportConfiguration` uses `SSE_KMS` as the encryption type, the same `kmsKeyId` is used to encrypt the error report at rest. * `tags` - (Optional) Map of tags assigned to the resource. If configured with a provider [`defaultTags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. -### `error_report_configuration` +### `errorReportConfiguration` * `s3Configuration` - (Required) Configuration block for the S3 configuration for the error reports. [See below.](#s3_configuration) @@ -425,53 +430,53 @@ The following arguments are optional: ### `notificationConfiguration` -* `sns_configuration` - (Required) Configuration block for details about the Amazon Simple Notification Service (SNS) configuration. [See below.](#sns_configuration) +* `snsConfiguration` - (Required) Configuration block for details about the Amazon Simple Notification Service (SNS) configuration. [See below.](#sns_configuration) -#### `sns_configuration` +#### `snsConfiguration` * `topicArn` - (Required) SNS topic ARN that the scheduled query status notifications will be sent to. -### `schedule_configuration` +### `scheduleConfiguration` * `scheduleExpression` - (Required) When to trigger the scheduled query run. This can be a cron expression or a rate expression. -### `target_configuration` +### `targetConfiguration` -* `timestream_configuration` - (Required) Configuration block for information needed to write data into the Timestream database and table. [See below.](#timestream_configuration) +* `timestreamConfiguration` - (Required) Configuration block for information needed to write data into the Timestream database and table. [See below.](#timestream_configuration) -#### `timestream_configuration` +#### `timestreamConfiguration` * `databaseName` - (Required) Name of Timestream database to which the query result will be written. -* `dimension_mapping` - (Required) Configuration block for mapping of column(s) from the query result to the dimension in the destination table. [See below.](#dimension_mapping) +* `dimensionMapping` - (Required) Configuration block for mapping of column(s) from the query result to the dimension in the destination table. [See below.](#dimension_mapping) * `tableName` - (Required) Name of Timestream table that the query result will be written to. The table should be within the same database that is provided in Timestream configuration. -* `time_column` - (Required) Column from query result that should be used as the time column in destination table. Column type for this should be TIMESTAMP. -* `measure_name_column` - (Optional) Name of the measure column. -* `mixed_measure_mapping` - (Optional) Configuration block for how to map measures to multi-measure records. [See below.](#mixed_measure_mapping) -* `multi_measure_mappings` - (Optional) Configuration block for multi-measure mappings. Only one of `mixed_measure_mappings` or `multi_measure_mappings` can be provided. `multi_measure_mappings` can be used to ingest data as multi measures in the derived table. [See below.](#multi_measure_mappings) +* `timeColumn` - (Required) Column from query result that should be used as the time column in destination table. Column type for this should be TIMESTAMP. +* `measureNameColumn` - (Optional) Name of the measure column. +* `mixedMeasureMapping` - (Optional) Configuration block for how to map measures to multi-measure records. [See below.](#mixed_measure_mapping) +* `multiMeasureMappings` - (Optional) Configuration block for multi-measure mappings. Only one of `mixed_measure_mappings` or `multiMeasureMappings` can be provided. `multiMeasureMappings` can be used to ingest data as multi measures in the derived table. [See below.](#multi_measure_mappings) -##### `dimension_mapping` +##### `dimensionMapping` -* `dimension_value_type` - (Required) Type for the dimension. Valid value: `VARCHAR`. +* `dimensionValueType` - (Required) Type for the dimension. Valid value: `VARCHAR`. * `name` - (Required) Column name from query result. -##### `mixed_measure_mapping` +##### `mixedMeasureMapping` -* `measure_name` - (Optional) Refers to the value of measure_name in a result row. This field is required if `measure_name_column` is provided. -* `multi_measure_attribute_mapping` - (Optional) Configuration block for attribute mappings for `MULTI` value measures. Required when `measure_value_type` is `MULTI`. [See below.](#multi_measure_attribute_mapping) -* `measure_value_type` - (Required) Type of the value that is to be read from `source_column`. Valid values are `BIGINT`, `BOOLEAN`, `DOUBLE`, `VARCHAR`, `MULTI`. -* `source_column` - (Optional) Source column from which measure-value is to be read for result materialization. -* `target_measure_name` - (Optional) Target measure name to be used. If not provided, the target measure name by default is `measure_name`, if provided, or `source_column` otherwise. +* `measureName` - (Optional) Refers to the value of measure_name in a result row. This field is required if `measureNameColumn` is provided. +* `multiMeasureAttributeMapping` - (Optional) Configuration block for attribute mappings for `MULTI` value measures. Required when `measureValueType` is `MULTI`. [See below.](#multi_measure_attribute_mapping) +* `measureValueType` - (Required) Type of the value that is to be read from `sourceColumn`. Valid values are `BIGINT`, `BOOLEAN`, `DOUBLE`, `VARCHAR`, `MULTI`. +* `sourceColumn` - (Optional) Source column from which measure-value is to be read for result materialization. +* `targetMeasureName` - (Optional) Target measure name to be used. If not provided, the target measure name by default is `measureName`, if provided, or `sourceColumn` otherwise. -##### `multi_measure_attribute_mapping` +##### `multiMeasureAttributeMapping` -* `measure_value_type` - (Required) Type of the attribute to be read from the source column. Valid values are `BIGINT`, `BOOLEAN`, `DOUBLE`, `VARCHAR`, `TIMESTAMP`. -* `source_column` - (Required) Source column from where the attribute value is to be read. -* `target_multi_measure_attribute_name` - (Optional) Custom name to be used for attribute name in derived table. If not provided, `source_column` is used. +* `measureValueType` - (Required) Type of the attribute to be read from the source column. Valid values are `BIGINT`, `BOOLEAN`, `DOUBLE`, `VARCHAR`, `TIMESTAMP`. +* `sourceColumn` - (Required) Source column from where the attribute value is to be read. +* `targetMultiMeasureAttributeName` - (Optional) Custom name to be used for attribute name in derived table. If not provided, `sourceColumn` is used. -##### `multi_measure_mappings` +##### `multiMeasureMappings` -* `multi_measure_attribute_mapping` - (Required) Attribute mappings to be used for mapping query results to ingest data for multi-measure attributes. [See above.](#multi_measure_attribute_mapping) -* `target_multi_measure_name` - (Optional) Name of the target multi-measure name in the derived table. This input is required when `measure_name_column` is not provided. If `measure_name_column` is provided, then the value from that column will be used as the multi-measure name. +* `multiMeasureAttributeMapping` - (Required) Attribute mappings to be used for mapping query results to ingest data for multi-measure attributes. [See above.](#multi_measure_attribute_mapping) +* `targetMultiMeasureName` - (Optional) Name of the target multi-measure name in the derived table. This input is required when `measureNameColumn` is not provided. If `measureNameColumn` is provided, then the value from that column will be used as the multi-measure name. ## Attribute Reference @@ -479,67 +484,67 @@ This resource exports the following attributes in addition to the arguments abov * `arn` - ARN of the Scheduled Query. * `creationTime` - Creation time for the scheduled query. -* `next_invocation_time` - Next time the scheduled query is scheduled to run. -* `previous_invocation_time` - Last time the scheduled query was run. +* `nextInvocationTime` - Next time the scheduled query is scheduled to run. +* `previousInvocationTime` - Last time the scheduled query was run. * `state` - State of the scheduled query, either `ENABLED` or `DISABLED`. -* `last_run_summary` - Runtime summary for the last scheduled query run. - * `error_report_location` - Contains the location of the error report for a single scheduled query call. - * `s3_report_location` - S3 report location for the scheduled query run. +* `lastRunSummary` - Runtime summary for the last scheduled query run. + * `errorReportLocation` - Contains the location of the error report for a single scheduled query call. + * `s3ReportLocation` - S3 report location for the scheduled query run. * `bucketName` - S3 bucket name. * `objectKey` - S3 key. - * `execution_stats` - Statistics for a single scheduled query run. - * `bytes_metered` - Bytes metered for a single scheduled query run. - * `cumulative_bytes_scanned` - Bytes scanned for a single scheduled query run. - * `data_writes` - Data writes metered for records ingested in a single scheduled query run. - * `execution_time_in_millis` - Total time, measured in milliseconds, that was needed for the scheduled query run to complete. - * `query_result_rows` - Number of rows present in the output from running a query before ingestion to destination data source. - * `records_ingested` - Number of records ingested for a single scheduled query run. + * `executionStats` - Statistics for a single scheduled query run. + * `bytesMetered` - Bytes metered for a single scheduled query run. + * `cumulativeBytesScanned` - Bytes scanned for a single scheduled query run. + * `dataWrites` - Data writes metered for records ingested in a single scheduled query run. + * `executionTimeInMillis` - Total time, measured in milliseconds, that was needed for the scheduled query run to complete. + * `queryResultRows` - Number of rows present in the output from running a query before ingestion to destination data source. + * `recordsIngested` - Number of records ingested for a single scheduled query run. * `failureReason` - Error message for the scheduled query in case of failure. You might have to look at the error report to get more detailed error reasons. - * `invocation_time` - InvocationTime for this run. This is the time at which the query is scheduled to run. Parameter `@scheduled_runtime` can be used in the query to get the value. - * `query_insights_response` - Provides various insights and metrics related to the run summary of the scheduled query. - * `output_bytes` - Size of query result set in bytes. You can use this data to validate if the result set has changed as part of the query tuning exercise. - * `output_rows` - Total number of rows returned as part of the query result set. You can use this data to validate if the number of rows in the result set have changed as part of the query tuning exercise. - * `query_spatial_coverage` - Insights into the spatial coverage of the query, including the table with sub-optimal (max) spatial pruning. This information can help you identify areas for improvement in your partitioning strategy to enhance spatial pruning. + * `invocationTime` - InvocationTime for this run. This is the time at which the query is scheduled to run. Parameter `@scheduled_runtime` can be used in the query to get the value. + * `queryInsightsResponse` - Provides various insights and metrics related to the run summary of the scheduled query. + * `outputBytes` - Size of query result set in bytes. You can use this data to validate if the result set has changed as part of the query tuning exercise. + * `outputRows` - Total number of rows returned as part of the query result set. You can use this data to validate if the number of rows in the result set have changed as part of the query tuning exercise. + * `querySpatialCoverage` - Insights into the spatial coverage of the query, including the table with sub-optimal (max) spatial pruning. This information can help you identify areas for improvement in your partitioning strategy to enhance spatial pruning. * `max` - Insights into the spatial coverage of the executed query and the table with the most inefficient spatial pruning. * `partitionKey` - Partition key used for partitioning, which can be a default measure_name or a customer defined partition key. * `tableArn` - ARN of the table with the most sub-optimal spatial pruning. * `value` - Maximum ratio of spatial coverage. - * `query_table_count` - Number of tables in the query. - * `query_temporal_range` - Insights into the temporal range of the query, including the table with the largest (max) time range. Following are some of the potential options for optimizing time-based pruning: add missing time-predicates, remove functions around the time predicates, add time predicates to all the sub-queries. + * `queryTableCount` - Number of tables in the query. + * `queryTemporalRange` - Insights into the temporal range of the query, including the table with the largest (max) time range. Following are some of the potential options for optimizing time-based pruning: add missing time-predicates, remove functions around the time predicates, add time predicates to all the sub-queries. * `max` - Insights into the temporal range of the query, including the table with the largest (max) time range. * `tableArn` - ARN of the table table which is queried with the largest time range. * `value` - Maximum duration in nanoseconds between the start and end of the query. - * `run_status` - Status of a scheduled query run. Valid values: `AUTO_TRIGGER_SUCCESS`, `AUTO_TRIGGER_FAILURE`, `MANUAL_TRIGGER_SUCCESS`, `MANUAL_TRIGGER_FAILURE`. - * `trigger_time` - Actual time when the query was run. -* `recently_failed_runs` - Runtime summary for the last five failed scheduled query runs. - * `error_report_location` - S3 location for error report. - * `s3_report_location` - S3 location where error reports are written. + * `runStatus` - Status of a scheduled query run. Valid values: `AUTO_TRIGGER_SUCCESS`, `AUTO_TRIGGER_FAILURE`, `MANUAL_TRIGGER_SUCCESS`, `MANUAL_TRIGGER_FAILURE`. + * `triggerTime` - Actual time when the query was run. +* `recentlyFailedRuns` - Runtime summary for the last five failed scheduled query runs. + * `errorReportLocation` - S3 location for error report. + * `s3ReportLocation` - S3 location where error reports are written. * `bucketName` - S3 bucket name. * `objectKey` - S3 key. - * `execution_stats` - Statistics for a single scheduled query run. - * `bytes_metered` - Bytes metered for a single scheduled query run. - * `cumulative_bytes_scanned` - Bytes scanned for a single scheduled query run. - * `data_writes` - Data writes metered for records ingested in a single scheduled query run. - * `execution_time_in_millis` - Total time, measured in milliseconds, that was needed for the scheduled query run to complete. - * `query_result_rows` - Number of rows present in the output from running a query before ingestion to destination data source. - * `records_ingested` - Number of records ingested for a single scheduled query run. + * `executionStats` - Statistics for a single scheduled query run. + * `bytesMetered` - Bytes metered for a single scheduled query run. + * `cumulativeBytesScanned` - Bytes scanned for a single scheduled query run. + * `dataWrites` - Data writes metered for records ingested in a single scheduled query run. + * `executionTimeInMillis` - Total time, measured in milliseconds, that was needed for the scheduled query run to complete. + * `queryResultRows` - Number of rows present in the output from running a query before ingestion to destination data source. + * `recordsIngested` - Number of records ingested for a single scheduled query run. * `failureReason` - Error message for the scheduled query in case of failure. You might have to look at the error report to get more detailed error reasons. - * `invocation_time` - InvocationTime for this run. This is the time at which the query is scheduled to run. Parameter `@scheduled_runtime` can be used in the query to get the value. - * `query_insights_response` - Various insights and metrics related to the run summary of the scheduled query. - * `output_bytes` - Size of query result set in bytes. You can use this data to validate if the result set has changed as part of the query tuning exercise. - * `output_rows` - Total number of rows returned as part of the query result set. You can use this data to validate if the number of rows in the result set have changed as part of the query tuning exercise. - * `query_spatial_coverage` - Insights into the spatial coverage of the query, including the table with sub-optimal (max) spatial pruning. This information can help you identify areas for improvement in your partitioning strategy to enhance spatial pruning. + * `invocationTime` - InvocationTime for this run. This is the time at which the query is scheduled to run. Parameter `@scheduled_runtime` can be used in the query to get the value. + * `queryInsightsResponse` - Various insights and metrics related to the run summary of the scheduled query. + * `outputBytes` - Size of query result set in bytes. You can use this data to validate if the result set has changed as part of the query tuning exercise. + * `outputRows` - Total number of rows returned as part of the query result set. You can use this data to validate if the number of rows in the result set have changed as part of the query tuning exercise. + * `querySpatialCoverage` - Insights into the spatial coverage of the query, including the table with sub-optimal (max) spatial pruning. This information can help you identify areas for improvement in your partitioning strategy to enhance spatial pruning. * `max` - Insights into the spatial coverage of the executed query and the table with the most inefficient spatial pruning. * `partitionKey` - Partition key used for partitioning, which can be a default measure_name or a customer defined partition key. * `tableArn` - ARN of the table with the most sub-optimal spatial pruning. * `value` - Maximum ratio of spatial coverage. - * `query_table_count` - Number of tables in the query. - * `query_temporal_range` - Insights into the temporal range of the query, including the table with the largest (max) time range. Following are some of the potential options for optimizing time-based pruning: add missing time-predicates, remove functions around the time predicates, add time predicates to all the sub-queries. + * `queryTableCount` - Number of tables in the query. + * `queryTemporalRange` - Insights into the temporal range of the query, including the table with the largest (max) time range. Following are some of the potential options for optimizing time-based pruning: add missing time-predicates, remove functions around the time predicates, add time predicates to all the sub-queries. * `max` - Insights into the most sub-optimal performing table on the temporal axis: * `tableArn` - ARN of the table which is queried with the largest time range. * `value` - Maximum duration in nanoseconds between the start and end of the query. - * `run_status` - Status of a scheduled query run. Valid values: `AUTO_TRIGGER_SUCCESS`, `AUTO_TRIGGER_FAILURE`, `MANUAL_TRIGGER_SUCCESS`, `MANUAL_TRIGGER_FAILURE`. - * `trigger_time` - Actual time when the query was run. + * `runStatus` - Status of a scheduled query run. Valid values: `AUTO_TRIGGER_SUCCESS`, `AUTO_TRIGGER_FAILURE`, `MANUAL_TRIGGER_SUCCESS`, `MANUAL_TRIGGER_FAILURE`. + * `triggerTime` - Actual time when the query was run. * `tagsAll` - Map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). ## Timeouts @@ -562,7 +567,7 @@ import { TerraformStack } from "cdktf"; * Provider bindings are generated by running `cdktf get`. * See https://cdk.tf/provider-generation for more details. */ -import { TimestreamqueryScheduledQuery } from "./.gen/providers/aws/"; +import { TimestreamqueryScheduledQuery } from "./.gen/providers/aws/timestreamquery-scheduled-query"; class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); @@ -582,4 +587,4 @@ Using `terraform import`, import Timestream Query Scheduled Query using the `arn % terraform import aws_timestreamquery_scheduled_query.example arn:aws:timestream:us-west-2:012345678901:scheduled-query/tf-acc-test-7774188528604787105-e13659544fe66c8d ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/timestreamwrite_database.html.markdown b/website/docs/cdktf/typescript/r/timestreamwrite_database.html.markdown index 1a292113092a..d7b0e5cb2b15 100644 --- a/website/docs/cdktf/typescript/r/timestreamwrite_database.html.markdown +++ b/website/docs/cdktf/typescript/r/timestreamwrite_database.html.markdown @@ -66,7 +66,8 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: -* `databaseName` – (Required) The name of the Timestream database. Minimum length of 3. Maximum length of 64. +* `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). +* `databaseName` - (Required) The name of the Timestream database. Minimum length of 3. Maximum length of 64. * `kmsKeyId` - (Optional) The ARN (not Alias ARN) of the KMS key to be used to encrypt the data stored in the database. If the KMS key is not specified, the database will be encrypted with a Timestream managed KMS key located in your account. Refer to [AWS managed KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk) for more info. * `tags` - (Optional) Map of tags to assign to this resource. If configured with a provider [`defaultTags` 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. @@ -108,4 +109,4 @@ Using `terraform import`, import Timestream databases using the `databaseName`. % terraform import aws_timestreamwrite_database.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/timestreamwrite_table.html.markdown b/website/docs/cdktf/typescript/r/timestreamwrite_table.html.markdown index 90dfcf3957d9..eeb05d7bd120 100644 --- a/website/docs/cdktf/typescript/r/timestreamwrite_table.html.markdown +++ b/website/docs/cdktf/typescript/r/timestreamwrite_table.html.markdown @@ -107,7 +107,8 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: -* `databaseName` – (Required) The name of the Timestream database. +* `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). +* `databaseName` - (Required) The name of the Timestream database. * `magneticStoreWriteProperties` - (Optional) Contains properties to set on the table when enabling magnetic store writes. See [Magnetic Store Write Properties](#magnetic-store-write-properties) below for more details. * `retentionProperties` - (Optional) The retention duration for the memory store and magnetic store. See [Retention Properties](#retention-properties) below for more details. If not provided, `magneticStoreRetentionPeriodInDays` default to 73000 and `memoryStoreRetentionPeriodInHours` defaults to 6. * `schema` - (Optional) The schema of the table. See [Schema](#schema) below for more details. @@ -197,4 +198,4 @@ Using `terraform import`, import Timestream tables using the `tableName` and `da % terraform import aws_timestreamwrite_table.example ExampleTable:ExampleDatabase ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/transcribe_language_model.html.markdown b/website/docs/cdktf/typescript/r/transcribe_language_model.html.markdown index 7310f16d27a3..598e525df72c 100644 --- a/website/docs/cdktf/typescript/r/transcribe_language_model.html.markdown +++ b/website/docs/cdktf/typescript/r/transcribe_language_model.html.markdown @@ -110,8 +110,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `baseModelName` - (Required) Name of reference base model. * `inputDataConfig` - (Required) The input data config for the LanguageModel. See [Input Data Config](#input-data-config) for more details. * `languageCode` - (Required) The language code you selected for your language model. Refer to the [supported languages](https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html) page for accepted codes. @@ -172,4 +173,4 @@ Using `terraform import`, import Transcribe LanguageModel using the `modelName`. % terraform import aws_transcribe_language_model.example example-name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/transcribe_medical_vocabulary.html.markdown b/website/docs/cdktf/typescript/r/transcribe_medical_vocabulary.html.markdown index 1170810f5004..de4344aed11e 100644 --- a/website/docs/cdktf/typescript/r/transcribe_medical_vocabulary.html.markdown +++ b/website/docs/cdktf/typescript/r/transcribe_medical_vocabulary.html.markdown @@ -67,6 +67,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `tags` - (Optional) A map of tags to assign to the MedicalVocabulary. If configured with a provider [`defaultTags` 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. ## Attribute Reference @@ -117,4 +118,4 @@ Using `terraform import`, import Transcribe MedicalVocabulary using the `vocabul % terraform import aws_transcribe_medical_vocabulary.example example-name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/transcribe_vocabulary.html.markdown b/website/docs/cdktf/typescript/r/transcribe_vocabulary.html.markdown index 1f4269e36a98..03dd0e6a2f1e 100644 --- a/website/docs/cdktf/typescript/r/transcribe_vocabulary.html.markdown +++ b/website/docs/cdktf/typescript/r/transcribe_vocabulary.html.markdown @@ -65,11 +65,11 @@ class MyConvertedCode extends TerraformStack { The following arguments are required: * `languageCode` - (Required) The language code you selected for your vocabulary. -* `vocabularyFileUri` - (Required) The Amazon S3 location (URI) of the text file that contains your custom vocabulary. * `vocabularyName` - (Required) The name of the Vocabulary. The following arguments are optional: +* `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). * `phrases` - (Optional) - A list of terms to include in the vocabulary. Conflicts with `vocabularyFileUri` * `vocabularyFileUri` - (Optional) The Amazon S3 location (URI) of the text file that contains your custom vocabulary. Conflicts wth `phrases`. * `tags` - (Optional) A map of tags to assign to the Vocabulary. If configured with a provider [`defaultTags` 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. @@ -122,4 +122,4 @@ Using `terraform import`, import Transcribe Vocabulary using the `vocabularyName % terraform import aws_transcribe_vocabulary.example example-name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/transcribe_vocabulary_filter.html.markdown b/website/docs/cdktf/typescript/r/transcribe_vocabulary_filter.html.markdown index efa284575ca6..c2759970e1fb 100644 --- a/website/docs/cdktf/typescript/r/transcribe_vocabulary_filter.html.markdown +++ b/website/docs/cdktf/typescript/r/transcribe_vocabulary_filter.html.markdown @@ -51,6 +51,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `vocabularyFilterFileUri` - (Optional) The Amazon S3 location (URI) of the text file that contains your custom VocabularyFilter. Conflicts with `words` argument. * `tags` - (Optional) A map of tags to assign to the VocabularyFilter. If configured with a provider [`defaultTags` 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. * `words` - (Optional) - A list of terms to include in the vocabulary. Conflicts with `vocabularyFilterFileUri` argument. @@ -95,4 +96,4 @@ Using `terraform import`, import Transcribe VocabularyFilter using the `vocabula % terraform import aws_transcribe_vocabulary_filter.example example-name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/transfer_access.html.markdown b/website/docs/cdktf/typescript/r/transfer_access.html.markdown index 667ed93ab55a..71220337c10c 100644 --- a/website/docs/cdktf/typescript/r/transfer_access.html.markdown +++ b/website/docs/cdktf/typescript/r/transfer_access.html.markdown @@ -74,6 +74,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `externalId` - (Required) The SID of a group in the directory connected to the Transfer Server (e.g., `S-1-1-12-1234567890-123456789-1234567890-1234`) * `serverId` - (Required) The Server ID of the Transfer Server (e.g., `s-12345678`) * `homeDirectory` - (Optional) The landing directory (folder) for a user when they log in to the server using their SFTP client. It should begin with a `/`. The first item in the path is the name of the home bucket (accessible as `${Transfer:HomeBucket}` in the policy) and the rest is the home directory (accessible as `${Transfer:HomeDirectory}` in the policy). For example, `/example-bucket-1234/username` would set the home bucket to `example-bucket-1234` and the home directory to `username`. @@ -132,4 +133,4 @@ Using `terraform import`, import Transfer Accesses using the `serverId` and `ext % terraform import aws_transfer_access.example s-12345678/S-1-1-12-1234567890-123456789-1234567890-1234 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/transfer_agreement.html.markdown b/website/docs/cdktf/typescript/r/transfer_agreement.html.markdown index dce8add5f27c..2e6561fb234f 100644 --- a/website/docs/cdktf/typescript/r/transfer_agreement.html.markdown +++ b/website/docs/cdktf/typescript/r/transfer_agreement.html.markdown @@ -45,6 +45,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `accessRole` - (Required) The IAM Role which provides read and write access to the parent directory of the file location mentioned in the StartFileTransfer request. * `baseDirectory` - (Required) The landing directory for the files transferred by using the AS2 protocol. * `description` - (Optional) The Optional description of the transdfer. @@ -93,4 +94,4 @@ Using `terraform import`, import Transfer AS2 Agreement using the `server_id/agr % terraform import aws_transfer_agreement.example s-4221a88afd5f4362a/a-4221a88afd5f4362a ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/transfer_certificate.html.markdown b/website/docs/cdktf/typescript/r/transfer_certificate.html.markdown index 99705d00a1d5..cedf7df8b849 100644 --- a/website/docs/cdktf/typescript/r/transfer_certificate.html.markdown +++ b/website/docs/cdktf/typescript/r/transfer_certificate.html.markdown @@ -50,6 +50,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `certificate` - (Required) The valid certificate file required for the transfer. * `certificateChain` - (Optional) The optional list of certificate that make up the chain for the certificate that is being imported. * `description` - (Optional) A short description that helps identify the certificate. @@ -98,4 +99,4 @@ Using `terraform import`, import Transfer AS2 Certificate using the `certificate % terraform import aws_transfer_certificate.example c-4221a88afd5f4362a ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/transfer_connector.html.markdown b/website/docs/cdktf/typescript/r/transfer_connector.html.markdown index 93145bfb70c2..7c295cda25d3 100644 --- a/website/docs/cdktf/typescript/r/transfer_connector.html.markdown +++ b/website/docs/cdktf/typescript/r/transfer_connector.html.markdown @@ -78,6 +78,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `accessRole` - (Required) The IAM Role which provides read and write access to the parent directory of the file location mentioned in the StartFileTransfer request. * `as2Config` - (Optional) Either SFTP or AS2 is configured.The parameters to configure for the connector object. Fields documented below. * `loggingRole` - (Optional) The IAM Role which is required for allowing the connector to turn on CloudWatch logging for Amazon S3 events. @@ -141,4 +142,4 @@ Using `terraform import`, import Transfer AS2 Connector using the `connectorId`. % terraform import aws_transfer_connector.example c-4221a88afd5f4362a ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/transfer_profile.html.markdown b/website/docs/cdktf/typescript/r/transfer_profile.html.markdown index 7ced30289f0a..bdfabbbd8003 100644 --- a/website/docs/cdktf/typescript/r/transfer_profile.html.markdown +++ b/website/docs/cdktf/typescript/r/transfer_profile.html.markdown @@ -48,6 +48,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `as2Id` - (Required) The As2Id is the AS2 name as defined in the RFC 4130. For inbound ttransfers this is the AS2 From Header for the AS2 messages sent from the partner. For Outbound messages this is the AS2 To Header for the AS2 messages sent to the partner. his ID cannot include spaces. * `certificateIds` - (Optional) The list of certificate Ids from the imported certificate operation. * `profileType` - (Required) The profile type should be LOCAL or PARTNER. @@ -92,4 +93,4 @@ Using `terraform import`, import Transfer AS2 Profile using the `profileId`. For % terraform import aws_transfer_profile.example p-4221a88afd5f4362a ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/transfer_server.html.markdown b/website/docs/cdktf/typescript/r/transfer_server.html.markdown index ac35ebe01708..27f250dbf03e 100644 --- a/website/docs/cdktf/typescript/r/transfer_server.html.markdown +++ b/website/docs/cdktf/typescript/r/transfer_server.html.markdown @@ -234,6 +234,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `certificate` - (Optional) The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) certificate. This is required when `protocols` is set to `FTPS` * `domain` - (Optional) The domain of the storage system that is used for file transfers. Valid values are: `S3` and `EFS`. The default value is `S3`. * `protocols` - (Optional) Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. This defaults to `SFTP` . The available protocols are: @@ -368,4 +369,4 @@ Using `terraform import`, import Transfer Servers using the server `id`. For exa Certain resource arguments, such as `hostKey`, cannot be read via the API and imported into Terraform. Terraform will display a difference for these arguments the first run after import if declared in the Terraform configuration for an imported resource. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/transfer_ssh_key.html.markdown b/website/docs/cdktf/typescript/r/transfer_ssh_key.html.markdown index af2203c3f5f0..77b160a93f0c 100644 --- a/website/docs/cdktf/typescript/r/transfer_ssh_key.html.markdown +++ b/website/docs/cdktf/typescript/r/transfer_ssh_key.html.markdown @@ -117,6 +117,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `serverId` - (Requirement) The Server ID of the Transfer Server (e.g., `s-12345678`) * `userName` - (Requirement) The name of the user account that is assigned to one or more servers. * `body` - (Requirement) The public key portion of an SSH key pair. @@ -157,4 +158,4 @@ Using `terraform import`, import Transfer SSH Public Key using the `serverId` an % terraform import aws_transfer_ssh_key.bar s-12345678/test-username/key-12345 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/transfer_tag.html.markdown b/website/docs/cdktf/typescript/r/transfer_tag.html.markdown index 79212658dc42..b04d76fe1a3f 100644 --- a/website/docs/cdktf/typescript/r/transfer_tag.html.markdown +++ b/website/docs/cdktf/typescript/r/transfer_tag.html.markdown @@ -53,6 +53,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `resourceArn` - (Required) Amazon Resource Name (ARN) of the Transfer Family resource to tag. * `key` - (Required) Tag name. * `value` - (Required) Tag value. @@ -95,4 +96,4 @@ Using `terraform import`, import `aws_transfer_tag` using the Transfer Family re % terraform import aws_transfer_tag.example arn:aws:transfer:us-east-1:123456789012:server/s-1234567890abcdef0,Name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/transfer_user.html.markdown b/website/docs/cdktf/typescript/r/transfer_user.html.markdown index fd874316ede0..7aae2dc970ff 100644 --- a/website/docs/cdktf/typescript/r/transfer_user.html.markdown +++ b/website/docs/cdktf/typescript/r/transfer_user.html.markdown @@ -104,6 +104,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `serverId` - (Required) The Server ID of the Transfer Server (e.g., `s-12345678`) * `userName` - (Required) The name used for log in to your SFTP server. * `homeDirectory` - (Optional) The landing directory (folder) for a user when they log in to the server using their SFTP client. It should begin with a `/`. The first item in the path is the name of the home bucket (accessible as `${Transfer:HomeBucket}` in the policy) and the rest is the home directory (accessible as `${Transfer:HomeDirectory}` in the policy). For example, `/example-bucket-1234/username` would set the home bucket to `example-bucket-1234` and the home directory to `username`. @@ -184,4 +185,4 @@ Using `terraform import`, import Transfer Users using the `serverId` and `userNa % terraform import aws_transfer_user.bar s-12345678/test-username ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/transfer_workflow.html.markdown b/website/docs/cdktf/typescript/r/transfer_workflow.html.markdown index cfac42e8d9b8..790c2a3e62ac 100644 --- a/website/docs/cdktf/typescript/r/transfer_workflow.html.markdown +++ b/website/docs/cdktf/typescript/r/transfer_workflow.html.markdown @@ -93,6 +93,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `description` - (Optional) A textual description for the workflow. * `onExceptionSteps` - (Optional) Specifies the steps (actions) to take if errors are encountered during execution of the workflow. See Workflow Steps below. * `steps` - (Required) Specifies the details for the steps that are in the specified workflow. See Workflow Steps below. @@ -196,4 +197,4 @@ Using `terraform import`, import Transfer Workflows using the `worflow_id`. For % terraform import aws_transfer_workflow.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/verifiedaccess_endpoint.html.markdown b/website/docs/cdktf/typescript/r/verifiedaccess_endpoint.html.markdown index ab8834fe80ba..0348d8b8d9d9 100644 --- a/website/docs/cdktf/typescript/r/verifiedaccess_endpoint.html.markdown +++ b/website/docs/cdktf/typescript/r/verifiedaccess_endpoint.html.markdown @@ -135,6 +135,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `applicationDomain` - (Optional) The DNS name for users to reach your application. This parameter is required if the endpoint type is `load-balancer` or `network-interface`. * `description` - (Optional) A description for the Verified Access endpoint. * `domainCertificateArn` - (Optional) - The ARN of the public TLS/SSL certificate in AWS Certificate Manager to associate with the endpoint. The CN in the certificate must match the DNS name your end users will use to reach your application. This parameter is required if the endpoint type is `load-balancer` or `network-interface`. @@ -194,4 +195,4 @@ Using `terraform import`, import Verified Access Instances using the `id`. For % terraform import aws_verifiedaccess_endpoint.example vae-8012925589 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/verifiedaccess_group.html.markdown b/website/docs/cdktf/typescript/r/verifiedaccess_group.html.markdown index 3fe7947a3300..621a6903771e 100644 --- a/website/docs/cdktf/typescript/r/verifiedaccess_group.html.markdown +++ b/website/docs/cdktf/typescript/r/verifiedaccess_group.html.markdown @@ -77,6 +77,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `description` - (Optional) Description of the verified access group. * `policyDocument` - (Optional) The policy document that is associated with this resource. * `sseConfiguration` - (Optional) Configuration block to use KMS keys for server-side encryption. @@ -103,4 +104,4 @@ This resource exports the following attributes in addition to the arguments abov * `update` - (Default `180m`) * `delete` - (Default `90m`) - + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/verifiedaccess_instance.html.markdown b/website/docs/cdktf/typescript/r/verifiedaccess_instance.html.markdown index e2c6643e3003..5b57fc85bf31 100644 --- a/website/docs/cdktf/typescript/r/verifiedaccess_instance.html.markdown +++ b/website/docs/cdktf/typescript/r/verifiedaccess_instance.html.markdown @@ -87,6 +87,7 @@ class MyConvertedCode extends TerraformStack { The following arguments are optional: +* `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). * `description` - (Optional) A description for the AWS Verified Access Instance. * `fipsEnabled` - (Optional, Forces new resource) Enable or disable support for Federal Information Processing Standards (FIPS) on the AWS Verified Access Instance. * `cidrEndpointsCustomSubdomain` - (Optional) The custom subdomain for the CIDR endpoints. @@ -143,4 +144,4 @@ Using `terraform import`, import Verified Access Instances using the `id`. For % terraform import aws_verifiedaccess_instance.example vai-1234567890abcdef0 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/verifiedaccess_instance_logging_configuration.html.markdown b/website/docs/cdktf/typescript/r/verifiedaccess_instance_logging_configuration.html.markdown index eba821c06e9d..53eb19e8139b 100644 --- a/website/docs/cdktf/typescript/r/verifiedaccess_instance_logging_configuration.html.markdown +++ b/website/docs/cdktf/typescript/r/verifiedaccess_instance_logging_configuration.html.markdown @@ -205,6 +205,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `accessLogs` - (Required) A block that specifies the configuration options for Verified Access instances. [Detailed below](#access_logs). * `verifiedaccessInstanceId` - (Required - Forces New resource) The ID of the Verified Access instance. @@ -277,4 +278,4 @@ Using `terraform import`, import Verified Access Logging Configuration using the % terraform import aws_verifiedaccess_instance_logging_configuration.example vai-1234567890abcdef0 ``` - + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/verifiedaccess_instance_trust_provider_attachment.html.markdown b/website/docs/cdktf/typescript/r/verifiedaccess_instance_trust_provider_attachment.html.markdown index 184d8b1e9d6c..1c863615ffc4 100644 --- a/website/docs/cdktf/typescript/r/verifiedaccess_instance_trust_provider_attachment.html.markdown +++ b/website/docs/cdktf/typescript/r/verifiedaccess_instance_trust_provider_attachment.html.markdown @@ -58,8 +58,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `verifiedaccessInstanceId` - (Required) The ID of the Verified Access instance to attach the Trust Provider to. * `verifiedaccessTrustProviderId` - (Required) The ID of the Verified Access trust provider. @@ -101,4 +102,4 @@ Using `terraform import`, import Verified Access Instance Trust Provider Attachm % terraform import aws_verifiedaccess_instance_trust_provider_attachment.example vai-1234567890abcdef0/vatp-8012925589 ``` - + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/verifiedaccess_trust_provider.html.markdown b/website/docs/cdktf/typescript/r/verifiedaccess_trust_provider.html.markdown index 6af5fb52b888..c78640e92412 100644 --- a/website/docs/cdktf/typescript/r/verifiedaccess_trust_provider.html.markdown +++ b/website/docs/cdktf/typescript/r/verifiedaccess_trust_provider.html.markdown @@ -45,6 +45,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `description` - (Optional) A description for the AWS Verified Access trust provider. * `deviceOptions` - (Optional) A block of options for device identity based trust providers. * `deviceTrustProviderType` (Optional) The type of device-based trust provider. @@ -99,4 +100,4 @@ Using `terraform import`, import Transfer Workflows using the `id`. For example % terraform import aws_verifiedaccess_trust_provider.example vatp-8012925589 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/verifiedpermissions_identity_source.html.markdown b/website/docs/cdktf/typescript/r/verifiedpermissions_identity_source.html.markdown index e3ea82d309a7..97c3a4449043 100644 --- a/website/docs/cdktf/typescript/r/verifiedpermissions_identity_source.html.markdown +++ b/website/docs/cdktf/typescript/r/verifiedpermissions_identity_source.html.markdown @@ -142,6 +142,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `policyStoreId` - (Required) Specifies the ID of the policy store in which you want to store this identity source. * `configuration`- (Required) Specifies the details required to communicate with the identity provider (IdP) associated with this identity source. See [Configuration](#configuration) below. * `principalEntityType`- (Optional) Specifies the namespace and data type of the principals generated for identities authenticated by the new identity source. @@ -226,4 +227,4 @@ Using `terraform import`, import Verified Permissions Identity Source using the % terraform import aws_verifiedpermissions_identity_source.example policy-store-id-12345678:identity-source-id-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/verifiedpermissions_policy.html.markdown b/website/docs/cdktf/typescript/r/verifiedpermissions_policy.html.markdown index 36917b2d1fdb..f0a235fe3a23 100644 --- a/website/docs/cdktf/typescript/r/verifiedpermissions_policy.html.markdown +++ b/website/docs/cdktf/typescript/r/verifiedpermissions_policy.html.markdown @@ -48,8 +48,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `policyStoreId` - (Required) The Policy Store ID of the policy store. * `definition`- (Required) The definition of the policy. See [Definition](#definition) below. @@ -112,4 +113,4 @@ Using `terraform import`, import Verified Permissions Policy using the `policy_i % terraform import aws_verifiedpermissions_policy.example policy-id-12345678,policy-store-id-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/verifiedpermissions_policy_store.html.markdown b/website/docs/cdktf/typescript/r/verifiedpermissions_policy_store.html.markdown index ebcbe0c6e3ce..33bb4b927697 100644 --- a/website/docs/cdktf/typescript/r/verifiedpermissions_policy_store.html.markdown +++ b/website/docs/cdktf/typescript/r/verifiedpermissions_policy_store.html.markdown @@ -49,6 +49,8 @@ The following arguments are required: The following arguments are optional: +* `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). +* `deletionProtection` - (Optional) Specifies whether the policy store can be deleted. If enabled, the policy store can't be deleted. Valid Values: `ENABLED`, `DISABLED`. Default value: `DISABLED`. * `description` - (Optional) A description of the Policy Store. * `tags` - (Optional) Key-value mapping of resource tags. If configured with a provider [`defaultTags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. @@ -92,4 +94,4 @@ Using `terraform import`, import Verified Permissions Policy Store using the `po % terraform import aws_verifiedpermissions_policy_store.example DxQg2j8xvXJQ1tQCYNWj9T ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/verifiedpermissions_policy_template.html.markdown b/website/docs/cdktf/typescript/r/verifiedpermissions_policy_template.html.markdown index 2f59b06d3776..8fa6287a92a6 100644 --- a/website/docs/cdktf/typescript/r/verifiedpermissions_policy_template.html.markdown +++ b/website/docs/cdktf/typescript/r/verifiedpermissions_policy_template.html.markdown @@ -48,6 +48,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `description` - (Optional) Provides a description for the policy template. ## Attribute Reference @@ -89,4 +90,4 @@ Using `terraform import`, import Verified Permissions Policy Store using the `po % terraform import aws_verifiedpermissions_policy_template.example policyStoreId:policyTemplateId ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/verifiedpermissions_schema.html.markdown b/website/docs/cdktf/typescript/r/verifiedpermissions_schema.html.markdown index 7ff85b68c9b6..0cc40625829f 100644 --- a/website/docs/cdktf/typescript/r/verifiedpermissions_schema.html.markdown +++ b/website/docs/cdktf/typescript/r/verifiedpermissions_schema.html.markdown @@ -52,8 +52,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `policyStoreId` - (Required) The ID of the Policy Store. * `definition` - (Required) The definition of the schema. * `value` - (Required) A JSON string representation of the schema. @@ -96,4 +97,4 @@ Using `terraform import`, import Verified Permissions Policy Store Schema using % terraform import aws_verifiedpermissions_schema.example DxQg2j8xvXJQ1tQCYNWj9T ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/volume_attachment.html.markdown b/website/docs/cdktf/typescript/r/volume_attachment.html.markdown index beb83515a32f..98cbef13832d 100644 --- a/website/docs/cdktf/typescript/r/volume_attachment.html.markdown +++ b/website/docs/cdktf/typescript/r/volume_attachment.html.markdown @@ -57,6 +57,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `deviceName` - (Required) The device name to expose to the instance (for example, `/dev/sdh` or `xvdh`). See [Device Naming on Linux Instances][1] and [Device Naming on Windows Instances][2] for more information. * `instanceId` - (Required) ID of the Instance to attach to @@ -117,4 +118,4 @@ Using `terraform import`, import EBS Volume Attachments using `DEVICE_NAME:VOLUM [2]: https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/device_naming.html#available-ec2-device-names [3]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-detaching-volume.html - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/vpc.html.markdown b/website/docs/cdktf/typescript/r/vpc.html.markdown index fc72daccc8dc..96a5319843f3 100644 --- a/website/docs/cdktf/typescript/r/vpc.html.markdown +++ b/website/docs/cdktf/typescript/r/vpc.html.markdown @@ -84,14 +84,14 @@ class MyConvertedCode extends TerraformStack { const test = new VpcIpam(this, "test", { operatingRegions: [ { - regionName: Token.asString(current.name), + regionName: Token.asString(current.region), }, ], }); const awsVpcIpamPoolTest = new VpcIpamPool(this, "test_2", { addressFamily: "ipv4", ipamScopeId: test.privateDefaultScopeId, - locale: Token.asString(current.name), + locale: Token.asString(current.region), }); /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ awsVpcIpamPoolTest.overrideLogicalId("test"); @@ -117,6 +117,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `cidrBlock` - (Optional) The IPv4 CIDR block for the VPC. CIDR can be explicitly set or it can be derived from IPAM using `ipv4NetmaskLength`. * `instanceTenancy` - (Optional) A tenancy option for instances launched into the VPC. Default is `default`, which ensures that EC2 instances launched in this VPC use the EC2 instance tenancy attribute specified when the EC2 instance is launched. The only other option is `dedicated`, which ensures that EC2 instances launched in this VPC are run on dedicated tenancy instances regardless of the tenancy attribute specified at launch. This has a dedicated per region fee of $2 per hour, plus an hourly per instance usage fee. * `ipv4IpamPoolId` - (Optional) The ID of an IPv4 IPAM pool you want to use for allocating this VPC's CIDR. IPAM is a VPC feature that you can use to automate your IP address management workflows including assigning, tracking, troubleshooting, and auditing IP addresses across AWS Regions and accounts. Using IPAM you can monitor IP address usage throughout your AWS Organization. @@ -181,4 +182,4 @@ Using `terraform import`, import VPCs using the VPC `id`. For example: % terraform import aws_vpc.test_vpc vpc-a01106c2 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/vpc_block_public_access_exclusion.html.markdown b/website/docs/cdktf/typescript/r/vpc_block_public_access_exclusion.html.markdown index 4d4dd369cc88..8038bb839e2d 100644 --- a/website/docs/cdktf/typescript/r/vpc_block_public_access_exclusion.html.markdown +++ b/website/docs/cdktf/typescript/r/vpc_block_public_access_exclusion.html.markdown @@ -24,8 +24,8 @@ import { TerraformStack } from "cdktf"; * Provider bindings are generated by running `cdktf get`. * See https://cdk.tf/provider-generation for more details. */ -import { VpcBlockPublicAccessExclusion } from "./.gen/providers/aws/"; import { Vpc } from "./.gen/providers/aws/vpc"; +import { VpcBlockPublicAccessExclusion } from "./.gen/providers/aws/vpc-block-public-access-exclusion"; class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); @@ -34,8 +34,8 @@ class MyConvertedCode extends TerraformStack { }); const awsVpcBlockPublicAccessExclusionTest = new VpcBlockPublicAccessExclusion(this, "test_1", { - internet_gateway_exclusion_mode: "allow-bidirectional", - vpc_id: test.id, + internetGatewayExclusionMode: "allow-bidirectional", + vpcId: test.id, }); /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ awsVpcBlockPublicAccessExclusionTest.overrideLogicalId("test"); @@ -49,14 +49,14 @@ class MyConvertedCode extends TerraformStack { ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug import { Construct } from "constructs"; -import { TerraformStack } from "cdktf"; +import { Token, TerraformStack } from "cdktf"; /* * Provider bindings are generated by running `cdktf get`. * See https://cdk.tf/provider-generation for more details. */ -import { VpcBlockPublicAccessExclusion } from "./.gen/providers/aws/"; import { Subnet } from "./.gen/providers/aws/subnet"; import { Vpc } from "./.gen/providers/aws/vpc"; +import { VpcBlockPublicAccessExclusion } from "./.gen/providers/aws/vpc-block-public-access-exclusion"; class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); @@ -71,8 +71,8 @@ class MyConvertedCode extends TerraformStack { awsSubnetTest.overrideLogicalId("test"); const awsVpcBlockPublicAccessExclusionTest = new VpcBlockPublicAccessExclusion(this, "test_2", { - internet_gateway_exclusion_mode: "allow-egress", - subnet_id: awsSubnetTest.id, + internetGatewayExclusionMode: "allow-egress", + subnetId: Token.asString(awsSubnetTest.id), }); /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ awsVpcBlockPublicAccessExclusionTest.overrideLogicalId("test"); @@ -85,10 +85,11 @@ class MyConvertedCode extends TerraformStack { The following arguments are required: -* `internet_gateway_exclusion_mode` - (Required) Mode of exclusion from Block Public Access. The allowed values are `allow-egress` and `allow-bidirectional`. +* `internetGatewayExclusionMode` - (Required) Mode of exclusion from Block Public Access. The allowed values are `allow-egress` and `allow-bidirectional`. The following arguments are optional: +* `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). * `vpcId` - (Optional) Id of the VPC to which this exclusion applies. Either this or the subnet_id needs to be provided. * `subnetId` - (Optional) Id of the subnet to which this exclusion applies. Either this or the vpc_id needs to be provided. * `tags` - (Optional) A map of tags to assign to the exclusion. If configured with a provider [`defaultTags` 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. @@ -121,7 +122,7 @@ import { TerraformStack } from "cdktf"; * Provider bindings are generated by running `cdktf get`. * See https://cdk.tf/provider-generation for more details. */ -import { VpcBlockPublicAccessExclusion } from "./.gen/providers/aws/"; +import { VpcBlockPublicAccessExclusion } from "./.gen/providers/aws/vpc-block-public-access-exclusion"; class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); @@ -141,4 +142,4 @@ Using `terraform import`, import EC2 (Elastic Compute Cloud) VPC Block Public Ac % terraform import aws_vpc_block_public_access_exclusion.example vpcbpa-exclude-1234abcd ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/vpc_block_public_access_options.html.markdown b/website/docs/cdktf/typescript/r/vpc_block_public_access_options.html.markdown index 684ea54225ee..03dcf9e80fb5 100644 --- a/website/docs/cdktf/typescript/r/vpc_block_public_access_options.html.markdown +++ b/website/docs/cdktf/typescript/r/vpc_block_public_access_options.html.markdown @@ -24,12 +24,12 @@ import { TerraformStack } from "cdktf"; * Provider bindings are generated by running `cdktf get`. * See https://cdk.tf/provider-generation for more details. */ -import { VpcBlockPublicAccessOptions } from "./.gen/providers/aws/"; +import { VpcBlockPublicAccessOptions } from "./.gen/providers/aws/vpc-block-public-access-options"; class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); new VpcBlockPublicAccessOptions(this, "example", { - internet_gateway_block_mode: "block-bidirectional", + internetGatewayBlockMode: "block-bidirectional", }); } } @@ -38,9 +38,10 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This resource supports the following arguments: -* `internet_gateway_block_mode` - (Required) Block mode. Needs to be one of `block-bidirectional`, `block-ingress`, `off`. If this resource is deleted, then this value will be set to `off` in the AWS account and region. +* `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). +* `internetGatewayBlockMode` - (Required) Block mode. Needs to be one of `block-bidirectional`, `block-ingress`, `off`. If this resource is deleted, then this value will be set to `off` in the AWS account and region. ## Attribute Reference @@ -69,7 +70,7 @@ import { TerraformStack } from "cdktf"; * Provider bindings are generated by running `cdktf get`. * See https://cdk.tf/provider-generation for more details. */ -import { VpcBlockPublicAccessOptions } from "./.gen/providers/aws/"; +import { VpcBlockPublicAccessOptions } from "./.gen/providers/aws/vpc-block-public-access-options"; class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); @@ -89,4 +90,4 @@ Using `terraform import`, import VPC Block Public Access Options using the `awsR % terraform import aws_vpc_block_public_access_options.example us-east-1 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/vpc_dhcp_options.html.markdown b/website/docs/cdktf/typescript/r/vpc_dhcp_options.html.markdown index f6442a39f933..4d9069052744 100644 --- a/website/docs/cdktf/typescript/r/vpc_dhcp_options.html.markdown +++ b/website/docs/cdktf/typescript/r/vpc_dhcp_options.html.markdown @@ -70,6 +70,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `domainName` - (Optional) the suffix domain name to use by default when resolving non Fully Qualified Domain Names. In other words, this is what ends up being the `search` value in the `/etc/resolv.conf` file. * `domainNameServers` - (Optional) List of name servers to configure in `/etc/resolv.conf`. If you want to use the default AWS nameservers you should set this to `AmazonProvidedDNS`. * `ipv6AddressPreferredLeaseTime` - (Optional) How frequently, in seconds, a running instance with an IPv6 assigned to it goes through DHCPv6 lease renewal. Acceptable values are between 140 and 2147483647 (approximately 68 years). If no value is entered, the default lease time is 140 seconds. If you use long-term addressing for EC2 instances, you can increase the lease time and avoid frequent lease renewal requests. Lease renewal typically occurs when half of the lease time has elapsed. @@ -126,4 +127,4 @@ Using `terraform import`, import VPC DHCP Options using the DHCP Options `id`. F % terraform import aws_vpc_dhcp_options.my_options dopt-d9070ebb ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/vpc_dhcp_options_association.html.markdown b/website/docs/cdktf/typescript/r/vpc_dhcp_options_association.html.markdown index e40385522b52..6edec271efb5 100644 --- a/website/docs/cdktf/typescript/r/vpc_dhcp_options_association.html.markdown +++ b/website/docs/cdktf/typescript/r/vpc_dhcp_options_association.html.markdown @@ -39,6 +39,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `vpcId` - (Required) The ID of the VPC to which we would like to associate a DHCP Options Set. * `dhcpOptionsId` - (Required) The ID of the DHCP Options Set to associate to the VPC. @@ -85,4 +86,4 @@ Using `terraform import`, import DHCP associations using the VPC ID associated w % terraform import aws_vpc_dhcp_options_association.imported vpc-0f001273ec18911b1 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/vpc_endpoint.html.markdown b/website/docs/cdktf/typescript/r/vpc_endpoint.html.markdown index f93fc6bac2fe..f3cf28dabf75 100644 --- a/website/docs/cdktf/typescript/r/vpc_endpoint.html.markdown +++ b/website/docs/cdktf/typescript/r/vpc_endpoint.html.markdown @@ -276,6 +276,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `vpcId` - (Required) The ID of the VPC in which the endpoint will be used. * `autoAccept` - (Optional) Accept the VPC endpoint (the VPC endpoint and service need to be in the same AWS account). * `policy` - (Optional) A policy to attach to the endpoint that controls access to the service. This is a JSON formatted string. Defaults to full access. All `Gateway` and some `Interface` endpoints support policies - see the [relevant AWS documentation](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-endpoints-access.html) for more details. For more information about building AWS IAM policy documents with Terraform, see the [AWS IAM Policy Document Guide](https://learn.hashicorp.com/terraform/aws/iam-policy). @@ -304,7 +305,7 @@ If no security groups are specified, the VPC's [default security group](https:// * `ipv4` - (Optional) The IPv4 address to assign to the endpoint network interface in the subnet. You must provide an IPv4 address if the VPC endpoint supports IPv4. * `ipv6` - (Optional) The IPv6 address to assign to the endpoint network interface in the subnet. You must provide an IPv6 address if the VPC endpoint supports IPv6. -* `subnet` - (Optional) The ID of the subnet. Must have a corresponding subnet in the `subnetIds` argument. +* `subnetId` - (Optional) The ID of the subnet. Must have a corresponding subnet in the `subnetIds` argument. ## Timeouts @@ -362,4 +363,4 @@ Using `terraform import`, import VPC Endpoints using the VPC endpoint `id`. For % terraform import aws_vpc_endpoint.endpoint1 vpce-3ecf2a57 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/vpc_endpoint_connection_accepter.html.markdown b/website/docs/cdktf/typescript/r/vpc_endpoint_connection_accepter.html.markdown index c8c6dde79b02..cbb6eebdb83a 100644 --- a/website/docs/cdktf/typescript/r/vpc_endpoint_connection_accepter.html.markdown +++ b/website/docs/cdktf/typescript/r/vpc_endpoint_connection_accepter.html.markdown @@ -64,6 +64,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `vpcEndpointId` - (Required) AWS VPC Endpoint ID. * `vpcEndpointServiceId` - (Required) AWS VPC Endpoint Service ID. @@ -106,4 +107,4 @@ Using `terraform import`, import VPC Endpoint Services using ID of the connectio % terraform import aws_vpc_endpoint_connection_accepter.foo vpce-svc-0f97a19d3fa8220bc_vpce-010601a6db371e263 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/vpc_endpoint_connection_notification.html.markdown b/website/docs/cdktf/typescript/r/vpc_endpoint_connection_notification.html.markdown index 31bb57612398..5c1b805d3dea 100644 --- a/website/docs/cdktf/typescript/r/vpc_endpoint_connection_notification.html.markdown +++ b/website/docs/cdktf/typescript/r/vpc_endpoint_connection_notification.html.markdown @@ -72,6 +72,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `vpcEndpointServiceId` - (Optional) The ID of the VPC Endpoint Service to receive notifications for. * `vpcEndpointId` - (Optional) The ID of the VPC Endpoint to receive notifications for. * `connectionNotificationArn` - (Required) The ARN of the SNS topic for the notifications. @@ -119,4 +120,4 @@ Using `terraform import`, import VPC Endpoint connection notifications using the % terraform import aws_vpc_endpoint_connection_notification.foo vpce-nfn-09e6ed3b4efba2263 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/vpc_endpoint_policy.html.markdown b/website/docs/cdktf/typescript/r/vpc_endpoint_policy.html.markdown index 1b23f58e4970..660a0923db40 100644 --- a/website/docs/cdktf/typescript/r/vpc_endpoint_policy.html.markdown +++ b/website/docs/cdktf/typescript/r/vpc_endpoint_policy.html.markdown @@ -81,6 +81,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `vpcEndpointId` - (Required) The VPC Endpoint ID. * `policy` - (Optional) A policy to attach to the endpoint that controls access to the service. Defaults to full access. All `Gateway` and some `Interface` endpoints support policies - see the [relevant AWS documentation](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-endpoints-access.html) for more details. For more information about building AWS IAM policy documents with Terraform, see the [AWS IAM Policy Document Guide](https://learn.hashicorp.com/terraform/aws/iam-policy). @@ -118,4 +119,4 @@ Using `terraform import`, import VPC Endpoint Policies using the `id`. For examp % terraform import aws_vpc_endpoint_policy.example vpce-3ecf2a57 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/vpc_endpoint_private_dns.html.markdown b/website/docs/cdktf/typescript/r/vpc_endpoint_private_dns.html.markdown index 28c494e79338..492285224d37 100644 --- a/website/docs/cdktf/typescript/r/vpc_endpoint_private_dns.html.markdown +++ b/website/docs/cdktf/typescript/r/vpc_endpoint_private_dns.html.markdown @@ -41,8 +41,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `privateDnsEnabled` - (Required) Indicates whether a private hosted zone is associated with the VPC. Only applicable for `Interface` endpoints. * `vpcEndpointId` - (Required) VPC endpoint identifier. @@ -82,4 +83,4 @@ Using `terraform import`, import a VPC (Virtual Private Cloud) Endpoint Private % terraform import aws_vpc_endpoint_private_dns.example vpce-abcd-1234 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/vpc_endpoint_route_table_association.html.markdown b/website/docs/cdktf/typescript/r/vpc_endpoint_route_table_association.html.markdown index 160a445a8f85..f39f894c251e 100644 --- a/website/docs/cdktf/typescript/r/vpc_endpoint_route_table_association.html.markdown +++ b/website/docs/cdktf/typescript/r/vpc_endpoint_route_table_association.html.markdown @@ -39,6 +39,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `routeTableId` - (Required) Identifier of the EC2 Route Table to be associated with the VPC Endpoint. * `vpcEndpointId` - (Required) Identifier of the VPC Endpoint with which the EC2 Route Table will be associated. @@ -80,4 +81,4 @@ Using `terraform import`, import VPC Endpoint Route Table Associations using `vp % terraform import aws_vpc_endpoint_route_table_association.example vpce-aaaaaaaa/rtb-bbbbbbbb ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/vpc_endpoint_security_group_association.html.markdown b/website/docs/cdktf/typescript/r/vpc_endpoint_security_group_association.html.markdown index f3649b4a5281..0a4a78660288 100644 --- a/website/docs/cdktf/typescript/r/vpc_endpoint_security_group_association.html.markdown +++ b/website/docs/cdktf/typescript/r/vpc_endpoint_security_group_association.html.markdown @@ -47,6 +47,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `securityGroupId` - (Required) The ID of the security group to be associated with the VPC endpoint. * `vpcEndpointId` - (Required) The ID of the VPC endpoint with which the security group will be associated. * `replaceDefaultAssociation` - (Optional) Whether this association should replace the association with the VPC's default security group that is created when no security groups are specified during VPC endpoint creation. At most 1 association per-VPC endpoint should be configured with `replace_default_association = true`. `false` should be used when importing resources. @@ -89,4 +90,4 @@ Using `terraform import`, import VPC Endpoint Security Group Associations using % terraform import aws_vpc_endpoint_security_group_association.example vpce-aaaaaaaa/sg-bbbbbbbbbbbbbbbbb ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/vpc_endpoint_service.html.markdown b/website/docs/cdktf/typescript/r/vpc_endpoint_service.html.markdown index fb7a197da5fa..afe7132600fa 100644 --- a/website/docs/cdktf/typescript/r/vpc_endpoint_service.html.markdown +++ b/website/docs/cdktf/typescript/r/vpc_endpoint_service.html.markdown @@ -71,6 +71,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `acceptanceRequired` - (Required) Whether or not VPC endpoint connection requests to the service must be accepted by the service owner - `true` or `false`. * `allowedPrincipals` - (Optional) The ARNs of one or more principals allowed to discover the endpoint service. * `gatewayLoadBalancerArns` - (Optional) Amazon Resource Names (ARNs) of one or more Gateway Load Balancers for the endpoint service. @@ -131,4 +132,4 @@ Using `terraform import`, import VPC Endpoint Services using the VPC endpoint se % terraform import aws_vpc_endpoint_service.foo vpce-svc-0f97a19d3fa8220bc ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/vpc_endpoint_service_allowed_principal.html.markdown b/website/docs/cdktf/typescript/r/vpc_endpoint_service_allowed_principal.html.markdown index 8e5060ee6d95..c531d85cd9a9 100644 --- a/website/docs/cdktf/typescript/r/vpc_endpoint_service_allowed_principal.html.markdown +++ b/website/docs/cdktf/typescript/r/vpc_endpoint_service_allowed_principal.html.markdown @@ -49,6 +49,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `vpcEndpointServiceId` - (Required) The ID of the VPC endpoint service to allow permission. * `principalArn` - (Required) The ARN of the principal to allow permissions. @@ -58,4 +59,4 @@ This resource exports the following attributes in addition to the arguments abov * `id` - The ID of the association. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/vpc_endpoint_service_private_dns_verification.html.markdown b/website/docs/cdktf/typescript/r/vpc_endpoint_service_private_dns_verification.html.markdown index 5cbc967fac84..cd4b1d79267b 100644 --- a/website/docs/cdktf/typescript/r/vpc_endpoint_service_private_dns_verification.html.markdown +++ b/website/docs/cdktf/typescript/r/vpc_endpoint_service_private_dns_verification.html.markdown @@ -49,6 +49,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `waitForVerification` - (Optional) Whether to wait until the endpoint service returns a `Verified` status for the configured private DNS name. ## Attribute Reference @@ -65,4 +66,4 @@ This resource exports no additional attributes. You cannot import this resource. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/vpc_endpoint_subnet_association.html.markdown b/website/docs/cdktf/typescript/r/vpc_endpoint_subnet_association.html.markdown index 4a6d94b8b48a..278b8e8c8e3f 100644 --- a/website/docs/cdktf/typescript/r/vpc_endpoint_subnet_association.html.markdown +++ b/website/docs/cdktf/typescript/r/vpc_endpoint_subnet_association.html.markdown @@ -47,6 +47,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `vpcEndpointId` - (Required) The ID of the VPC endpoint with which the subnet will be associated. * `subnetId` - (Required) The ID of the subnet to be associated with the VPC endpoint. @@ -95,4 +96,4 @@ Using `terraform import`, import VPC Endpoint Subnet Associations using `vpcEndp % terraform import aws_vpc_endpoint_subnet_association.example vpce-aaaaaaaa/subnet-bbbbbbbbbbbbbbbbb ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/vpc_ipam.html.markdown b/website/docs/cdktf/typescript/r/vpc_ipam.html.markdown index 043d3cdb3956..4c11c3bcfa54 100644 --- a/website/docs/cdktf/typescript/r/vpc_ipam.html.markdown +++ b/website/docs/cdktf/typescript/r/vpc_ipam.html.markdown @@ -34,7 +34,7 @@ class MyConvertedCode extends TerraformStack { description: "My IPAM", operatingRegions: [ { - regionName: Token.asString(current.name), + regionName: Token.asString(current.region), }, ], tags: { @@ -76,7 +76,7 @@ class MyConvertedCode extends TerraformStack { }); const current = new DataAwsRegion(this, "current", {}); const allIpamRegions = Fn.distinct( - Token.asAny(Fn.concat([[current.name], ipamRegions.value])) + Token.asAny(Fn.concat([[current.region], ipamRegions.value])) ); /*In most cases loops should be handled in the programming language context and not inside of the Terraform context. If you are looping over something external, e.g. a variable or a file input @@ -100,9 +100,11 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `cascade` - (Optional) Enables you to quickly delete an IPAM, private scopes, pools in private scopes, and any allocations in the pools in private scopes. * `description` - (Optional) A description for the IPAM. * `enablePrivateGua` - (Optional) Enable this option to use your own GUA ranges as private IPv6 addresses. Default: `false`. +* `metered_account` - (Optional) AWS account that is charged for active IP addresses managed in IPAM. Valid values are `ipam-owner` (default) and `resource-owner`. * `operatingRegions` - (Required) Determines which locales can be chosen when you create pools. Locale is the Region where you want to make an IPAM pool available for allocations. You can only create pools with locales that match the operating Regions of the IPAM. You can only create VPCs from a pool whose locale matches the VPC's Region. You specify a region using the [region_name](#operating_regions) parameter. You **must** set your provider block region as an operating_region. * `tier` - (Optional) specifies the IPAM tier. Valid options include `free` and `advanced`. Default is `advanced`. * `tags` - (Optional) A map of tags to assign to the resource. If configured with a provider [`defaultTags` 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. @@ -153,4 +155,4 @@ Using `terraform import`, import IPAMs using the IPAM `id`. For example: % terraform import aws_vpc_ipam.example ipam-0178368ad2146a492 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/vpc_ipam_pool.html.markdown b/website/docs/cdktf/typescript/r/vpc_ipam_pool.html.markdown index 3d0c456d2145..17448ebfb55a 100644 --- a/website/docs/cdktf/typescript/r/vpc_ipam_pool.html.markdown +++ b/website/docs/cdktf/typescript/r/vpc_ipam_pool.html.markdown @@ -34,14 +34,14 @@ class MyConvertedCode extends TerraformStack { const example = new VpcIpam(this, "example", { operatingRegions: [ { - regionName: Token.asString(current.name), + regionName: Token.asString(current.region), }, ], }); const awsVpcIpamPoolExample = new VpcIpamPool(this, "example_2", { addressFamily: "ipv4", ipamScopeId: example.privateDefaultScopeId, - locale: Token.asString(current.name), + locale: Token.asString(current.region), }); /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ awsVpcIpamPoolExample.overrideLogicalId("example"); @@ -71,7 +71,7 @@ class MyConvertedCode extends TerraformStack { const example = new VpcIpam(this, "example", { operatingRegions: [ { - regionName: Token.asString(current.name), + regionName: Token.asString(current.region), }, ], }); @@ -86,7 +86,7 @@ class MyConvertedCode extends TerraformStack { const child = new VpcIpamPool(this, "child", { addressFamily: "ipv4", ipamScopeId: example.privateDefaultScopeId, - locale: Token.asString(current.name), + locale: Token.asString(current.region), sourceIpamPoolId: parent.id, }); new VpcIpamPoolCidr(this, "child_test", { @@ -102,6 +102,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `addressFamily` - (Required) The IP protocol assigned to this pool. You must choose either IPv4 or IPv6 protocol for a pool. * `allocationDefaultNetmaskLength` - (Optional) A default netmask length for allocations added to this pool. If, for example, the CIDR assigned to this pool is 10.0.0.0/8 and you enter 16 here, new allocations will default to 10.0.0.0/16 (unless you provide a different netmask value when you create the new allocation). * `allocationMaxNetmaskLength` - (Optional) The maximum netmask length that will be required for CIDR allocations in this pool. @@ -160,4 +161,4 @@ Using `terraform import`, import IPAMs using the IPAM pool `id`. For example: % terraform import aws_vpc_ipam_pool.example ipam-pool-0958f95207d978e1e ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/vpc_ipam_pool_cidr.html.markdown b/website/docs/cdktf/typescript/r/vpc_ipam_pool_cidr.html.markdown index 5eb290309c70..20c2fe001284 100644 --- a/website/docs/cdktf/typescript/r/vpc_ipam_pool_cidr.html.markdown +++ b/website/docs/cdktf/typescript/r/vpc_ipam_pool_cidr.html.markdown @@ -40,14 +40,14 @@ class MyConvertedCode extends TerraformStack { const example = new VpcIpam(this, "example", { operatingRegions: [ { - regionName: Token.asString(current.name), + regionName: Token.asString(current.region), }, ], }); const awsVpcIpamPoolExample = new VpcIpamPool(this, "example_2", { addressFamily: "ipv4", ipamScopeId: example.privateDefaultScopeId, - locale: Token.asString(current.name), + locale: Token.asString(current.region), }); /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ awsVpcIpamPoolExample.overrideLogicalId("example"); @@ -83,7 +83,7 @@ class MyConvertedCode extends TerraformStack { const example = new VpcIpam(this, "example", { operatingRegions: [ { - regionName: Token.asString(current.name), + regionName: Token.asString(current.region), }, ], }); @@ -115,6 +115,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `cidr` - (Optional) The CIDR you want to assign to the pool. Conflicts with `netmaskLength`. * `cidrAuthorizationContext` - (Optional) A signed document that proves that you are authorized to bring the specified IP address range to Amazon using BYOIP. This is not stored in the state file. See [cidr_authorization_context](#cidr_authorization_context) for more information. * `ipamPoolId` - (Required) The ID of the pool to which you want to assign a CIDR. @@ -168,4 +169,4 @@ Using `terraform import`, import IPAMs using the `_`. For ex % terraform import aws_vpc_ipam_pool_cidr.example 172.20.0.0/24_ipam-pool-0e634f5a1517cccdc ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/vpc_ipam_pool_cidr_allocation.html.markdown b/website/docs/cdktf/typescript/r/vpc_ipam_pool_cidr_allocation.html.markdown index 1b10b339fd3e..d45cdb0b2bbf 100644 --- a/website/docs/cdktf/typescript/r/vpc_ipam_pool_cidr_allocation.html.markdown +++ b/website/docs/cdktf/typescript/r/vpc_ipam_pool_cidr_allocation.html.markdown @@ -36,14 +36,14 @@ class MyConvertedCode extends TerraformStack { const example = new VpcIpam(this, "example", { operatingRegions: [ { - regionName: Token.asString(current.name), + regionName: Token.asString(current.region), }, ], }); const awsVpcIpamPoolExample = new VpcIpamPool(this, "example_2", { addressFamily: "ipv4", ipamScopeId: example.privateDefaultScopeId, - locale: Token.asString(current.name), + locale: Token.asString(current.region), }); /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ awsVpcIpamPoolExample.overrideLogicalId("example"); @@ -91,14 +91,14 @@ class MyConvertedCode extends TerraformStack { const example = new VpcIpam(this, "example", { operatingRegions: [ { - regionName: Token.asString(current.name), + regionName: Token.asString(current.region), }, ], }); const awsVpcIpamPoolExample = new VpcIpamPool(this, "example_2", { addressFamily: "ipv4", ipamScopeId: example.privateDefaultScopeId, - locale: Token.asString(current.name), + locale: Token.asString(current.region), }); /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ awsVpcIpamPoolExample.overrideLogicalId("example"); @@ -129,6 +129,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `cidr` - (Optional, Forces new resource) The CIDR you want to assign to the pool. * `description` - (Optional, Forces new resource) The description for the allocation. * `disallowedCidrs` - (Optional, Forces new resource) Exclude a particular CIDR range from being returned by the pool. @@ -176,4 +177,4 @@ Using `terraform import`, import IPAM allocations using the allocation `id` and % terraform import aws_vpc_ipam_pool_cidr_allocation.example ipam-pool-alloc-0dc6d196509c049ba8b549ff99f639736_ipam-pool-07cfb559e0921fcbe ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/vpc_ipam_preview_next_cidr.html.markdown b/website/docs/cdktf/typescript/r/vpc_ipam_preview_next_cidr.html.markdown index 9ce999287c46..60c90c663909 100644 --- a/website/docs/cdktf/typescript/r/vpc_ipam_preview_next_cidr.html.markdown +++ b/website/docs/cdktf/typescript/r/vpc_ipam_preview_next_cidr.html.markdown @@ -36,14 +36,14 @@ class MyConvertedCode extends TerraformStack { const example = new VpcIpam(this, "example", { operatingRegions: [ { - regionName: Token.asString(current.name), + regionName: Token.asString(current.region), }, ], }); const awsVpcIpamPoolExample = new VpcIpamPool(this, "example_2", { addressFamily: "ipv4", ipamScopeId: example.privateDefaultScopeId, - locale: Token.asString(current.name), + locale: Token.asString(current.region), }); /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ awsVpcIpamPoolExample.overrideLogicalId("example"); @@ -74,6 +74,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `disallowedCidrs` - (Optional) Exclude a particular CIDR range from being returned by the pool. * `ipamPoolId` - (Required) The ID of the pool to which you want to assign a CIDR. * `netmaskLength` - (Optional) The netmask length of the CIDR you would like to preview from the IPAM pool. @@ -85,4 +86,4 @@ This resource exports the following attributes in addition to the arguments abov * `cidr` - The previewed CIDR from the pool. * `id` - The ID of the preview. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/vpc_ipam_resource_discovery.html.markdown b/website/docs/cdktf/typescript/r/vpc_ipam_resource_discovery.html.markdown index 39a053f163f7..5224e002f966 100644 --- a/website/docs/cdktf/typescript/r/vpc_ipam_resource_discovery.html.markdown +++ b/website/docs/cdktf/typescript/r/vpc_ipam_resource_discovery.html.markdown @@ -34,7 +34,7 @@ class MyConvertedCode extends TerraformStack { description: "My IPAM Resource Discovery", operatingRegions: [ { - regionName: Token.asString(current.name), + regionName: Token.asString(current.region), }, ], tags: { @@ -50,6 +50,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `description` - (Optional) A description for the IPAM Resource Discovery. * `operatingRegions` - (Required) Determines which regions the Resource Discovery will enable IPAM features for usage and monitoring. Locale is the Region where you want to make an IPAM pool available for allocations. You can only create pools with locales that match the operating Regions of the IPAM Resource Discovery. You can only create VPCs from a pool whose locale matches the VPC's Region. You specify a region using the [region_name](#operating_regions) parameter. **You must set your provider block region as an operating_region.** * `tags` - (Optional) A map of tags to assign to the resource. If configured with a provider [`defaultTags` 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. @@ -101,4 +102,4 @@ Using `terraform import`, import IPAMs using the IPAM resource discovery `id`. F % terraform import aws_vpc_ipam_resource_discovery.example ipam-res-disco-0178368ad2146a492 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/vpc_ipam_resource_discovery_association.html.markdown b/website/docs/cdktf/typescript/r/vpc_ipam_resource_discovery_association.html.markdown index 552a3b1e6222..7556b4b2da3e 100644 --- a/website/docs/cdktf/typescript/r/vpc_ipam_resource_discovery_association.html.markdown +++ b/website/docs/cdktf/typescript/r/vpc_ipam_resource_discovery_association.html.markdown @@ -48,6 +48,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `ipamId` - (Required) The ID of the IPAM to associate. * `ipamResourceDiscoveryId` - (Required) The ID of the Resource Discovery to associate. * `tags` - (Optional) A map of tags to add to the IPAM resource discovery association resource. @@ -97,4 +98,4 @@ Using `terraform import`, import IPAMs using the IPAM resource discovery associa % terraform import aws_vpc_ipam_resource_discovery_association.example ipam-res-disco-assoc-0178368ad2146a492 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/vpc_ipam_scope.html.markdown b/website/docs/cdktf/typescript/r/vpc_ipam_scope.html.markdown index 4627b72fd656..f1f056a3ba00 100644 --- a/website/docs/cdktf/typescript/r/vpc_ipam_scope.html.markdown +++ b/website/docs/cdktf/typescript/r/vpc_ipam_scope.html.markdown @@ -34,7 +34,7 @@ class MyConvertedCode extends TerraformStack { const example = new VpcIpam(this, "example", { operatingRegions: [ { - regionName: Token.asString(current.name), + regionName: Token.asString(current.region), }, ], }); @@ -53,6 +53,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `ipamId` - The ID of the IPAM for which you're creating this scope. * `description` - (Optional) A description for the scope you're creating. * `tags` - (Optional) Key-value mapping of resource tags. If configured with a provider [`defaultTags` 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. @@ -100,4 +101,4 @@ Using `terraform import`, import IPAMs using the `scope_id`. For example: % terraform import aws_vpc_ipam_scope.example ipam-scope-0513c69f283d11dfb ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/vpc_ipv4_cidr_block_association.html.markdown b/website/docs/cdktf/typescript/r/vpc_ipv4_cidr_block_association.html.markdown index a9593411f749..87b87fdeb8ea 100644 --- a/website/docs/cdktf/typescript/r/vpc_ipv4_cidr_block_association.html.markdown +++ b/website/docs/cdktf/typescript/r/vpc_ipv4_cidr_block_association.html.markdown @@ -46,6 +46,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `cidrBlock` - (Optional) The IPv4 CIDR block for the VPC. CIDR can be explicitly set or it can be derived from IPAM using `ipv4NetmaskLength`. * `ipv4IpamPoolId` - (Optional) The ID of an IPv4 IPAM pool you want to use for allocating this VPC's CIDR. IPAM is a VPC feature that you can use to automate your IP address management workflows including assigning, tracking, troubleshooting, and auditing IP addresses across AWS Regions and accounts. Using IPAM you can monitor IP address usage throughout your AWS Organization. * `ipv4NetmaskLength` - (Optional) The netmask length of the IPv4 CIDR you want to allocate to this VPC. Requires specifying a `ipv4IpamPoolId`. @@ -156,4 +157,4 @@ or % terraform import aws_vpc_ipv4_cidr_block_association.example vpc-cidr-assoc-021e8461d70ed08be,ipam-pool-0a07c432810393463,28 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/vpc_ipv6_cidr_block_association.html.markdown b/website/docs/cdktf/typescript/r/vpc_ipv6_cidr_block_association.html.markdown index a06c18c3f8fb..775621a635a8 100644 --- a/website/docs/cdktf/typescript/r/vpc_ipv6_cidr_block_association.html.markdown +++ b/website/docs/cdktf/typescript/r/vpc_ipv6_cidr_block_association.html.markdown @@ -51,6 +51,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `assignGeneratedIpv6CidrBlock` - (Optional) Requests an Amazon-provided IPv6 CIDR block with a /56 prefix length for the VPC. You cannot specify the range of IPv6 addresses, or the size of the CIDR block. Default is `false`. Conflicts with `ipv6IpamPoolId`, `ipv6Pool`, `ipv6CidrBlock` and `ipv6NetmaskLength`. * `ipv6CidrBlock` - (Optional) The IPv6 CIDR block for the VPC. CIDR can be explicitly set or it can be derived from IPAM using `ipv6NetmaskLength`. This parameter is required if `ipv6NetmaskLength` is not set and the IPAM pool does not have `allocation_default_netmask` set. Conflicts with `assignGeneratedIpv6CidrBlock`. * `ipv6IpamPoolId` - (Optional) The ID of an IPv6 IPAM pool you want to use for allocating this VPC's CIDR. IPAM is a VPC feature that you can use to automate your IP address management workflows including assigning, tracking, troubleshooting, and auditing IP addresses across AWS Regions and accounts. Conflict with `assignGeneratedIpv6CidrBlock` and `ipv6Pool`. @@ -165,4 +166,4 @@ or % terraform import aws_vpc_ipv6_cidr_block_association.example vpc-cidr-assoc-0754129087e149dcd,ipam-pool-0611d1d6bbc05ce60,56 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/vpc_network_performance_metric_subscription.html.markdown b/website/docs/cdktf/typescript/r/vpc_network_performance_metric_subscription.html.markdown index 67526eb764e4..d70301d4c0a6 100644 --- a/website/docs/cdktf/typescript/r/vpc_network_performance_metric_subscription.html.markdown +++ b/website/docs/cdktf/typescript/r/vpc_network_performance_metric_subscription.html.markdown @@ -39,6 +39,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `destination` - (Required) The target Region or Availability Zone that the metric subscription is enabled for. For example, `eu-west-1`. * `metric` - (Optional) The metric used for the enabled subscription. Valid values: `aggregate-latency`. Default: `aggregate-latency`. * `source` - (Required) The source Region or Availability Zone that the metric subscription is enabled for. For example, `us-east-1`. @@ -50,4 +51,4 @@ This resource exports the following attributes in addition to the arguments abov * `period` - The data aggregation time for the subscription. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/vpc_peering_connection.html.markdown b/website/docs/cdktf/typescript/r/vpc_peering_connection.html.markdown index d8328d857052..0fd6d08d6e8e 100644 --- a/website/docs/cdktf/typescript/r/vpc_peering_connection.html.markdown +++ b/website/docs/cdktf/typescript/r/vpc_peering_connection.html.markdown @@ -162,6 +162,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `peerOwnerId` - (Optional) The AWS account ID of the target peer VPC. Defaults to the account ID the [AWS provider][1] is currently connected to, so must be managed if connecting cross-account. * `peerVpcId` - (Required) The ID of the target VPC with which you are creating the VPC Peering Connection. @@ -239,4 +240,4 @@ Using `terraform import`, import VPC Peering resources using the VPC peering `id [1]: /docs/providers/aws/index.html - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/vpc_peering_connection_accepter.html.markdown b/website/docs/cdktf/typescript/r/vpc_peering_connection_accepter.html.markdown index 7dd96330373a..b2bbc9ab761f 100644 --- a/website/docs/cdktf/typescript/r/vpc_peering_connection_accepter.html.markdown +++ b/website/docs/cdktf/typescript/r/vpc_peering_connection_accepter.html.markdown @@ -21,6 +21,8 @@ connection into management. ## Example Usage +### Cross-Account Peering Or Cross-Region Peering Terraform AWS Provider v5 (and below) + ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug import { Construct } from "constructs"; @@ -92,10 +94,69 @@ class MyConvertedCode extends TerraformStack { ``` +### Cross-Region Peering (Same Account) Terraform AWS Provider v6 (and above) + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { Token, TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { AwsProvider } from "./.gen/providers/aws/provider"; +import { Vpc } from "./.gen/providers/aws/vpc"; +import { VpcPeeringConnection } from "./.gen/providers/aws/vpc-peering-connection"; +import { VpcPeeringConnectionAccepterA } from "./.gen/providers/aws/vpc-peering-connection-accepter"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + new AwsProvider(this, "aws", { + region: "us-east-1", + }); + const main = new Vpc(this, "main", { + cidrBlock: "10.0.0.0/16", + }); + const peer = new Vpc(this, "peer", { + cidrBlock: "10.1.0.0/16", + region: "us-west-2", + }); + const awsVpcPeeringConnectionPeer = new VpcPeeringConnection( + this, + "peer_3", + { + autoAccept: false, + peerRegion: "us-west-2", + peerVpcId: peer.id, + tags: { + Side: "Requester", + }, + vpcId: main.id, + } + ); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + awsVpcPeeringConnectionPeer.overrideLogicalId("peer"); + const awsVpcPeeringConnectionAccepterPeer = + new VpcPeeringConnectionAccepterA(this, "peer_4", { + autoAccept: true, + region: "us-west-2", + tags: { + Side: "Accepter", + }, + vpcPeeringConnectionId: Token.asString(awsVpcPeeringConnectionPeer.id), + }); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + awsVpcPeeringConnectionAccepterPeer.overrideLogicalId("peer"); + } +} + +``` + ## Argument Reference This resource supports the following arguments: +* `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). * `vpcPeeringConnectionId` - (Required) The VPC Peering Connection ID to manage. * `autoAccept` - (Optional) Whether or not to accept the peering request. Defaults to `false`. * `tags` - (Optional) A map of tags to assign to the resource. If configured with a provider [`defaultTags` 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. @@ -189,4 +250,4 @@ class MyConvertedCode extends TerraformStack { ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/vpc_peering_connection_options.html.markdown b/website/docs/cdktf/typescript/r/vpc_peering_connection_options.html.markdown index 0a4b3db43442..316c39f1e649 100644 --- a/website/docs/cdktf/typescript/r/vpc_peering_connection_options.html.markdown +++ b/website/docs/cdktf/typescript/r/vpc_peering_connection_options.html.markdown @@ -169,6 +169,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `vpcPeeringConnectionId` - (Required) The ID of the requester VPC peering connection. * `accepter` (Optional) - An optional configuration block that allows for [VPC Peering Connection](https://docs.aws.amazon.com/vpc/latest/peering/what-is-vpc-peering.html) options to be set for the VPC that accepts the peering connection (a maximum of one). * `requester` (Optional) - A optional configuration block that allows for [VPC Peering Connection](https://docs.aws.amazon.com/vpc/latest/peering/what-is-vpc-peering.html) options to be set for the VPC that requests the peering connection (a maximum of one). @@ -217,4 +218,4 @@ Using `terraform import`, import VPC Peering Connection Options using the VPC pe % terraform import aws_vpc_peering_connection_options.foo pcx-111aaa111 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/vpc_route_server.html.markdown b/website/docs/cdktf/typescript/r/vpc_route_server.html.markdown index 0c93e893551e..30db235333a1 100644 --- a/website/docs/cdktf/typescript/r/vpc_route_server.html.markdown +++ b/website/docs/cdktf/typescript/r/vpc_route_server.html.markdown @@ -23,12 +23,12 @@ import { TerraformStack } from "cdktf"; * Provider bindings are generated by running `cdktf get`. * See https://cdk.tf/provider-generation for more details. */ -import { VpcRouteServer } from "./.gen/providers/aws/"; +import { VpcRouteServer } from "./.gen/providers/aws/vpc-route-server"; class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); new VpcRouteServer(this, "test", { - amazon_side_asn: 65534, + amazonSideAsn: 65534, tags: { Name: "Test", }, @@ -48,15 +48,15 @@ import { TerraformStack } from "cdktf"; * Provider bindings are generated by running `cdktf get`. * See https://cdk.tf/provider-generation for more details. */ -import { VpcRouteServer } from "./.gen/providers/aws/"; +import { VpcRouteServer } from "./.gen/providers/aws/vpc-route-server"; class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); new VpcRouteServer(this, "test", { - amazon_side_asn: 65534, - persist_routes: "enable", - persist_routes_duration: 2, - sns_notifications_enabled: true, + amazonSideAsn: 65534, + persistRoutes: "enable", + persistRoutesDuration: 2, + snsNotificationsEnabled: true, tags: { Name: "Main Route Server", }, @@ -74,9 +74,10 @@ The following arguments are required: The following arguments are optional: -* `persist_routes` - (Optional) Indicates whether routes should be persisted after all BGP sessions are terminated. Valid values are `enable`, `disable`, `reset` -* `persist_routes_duration` - (Optional) The number of minutes a route server will wait after BGP is re-established to unpersist the routes in the FIB and RIB. Value must be in the range of 1-5. Required if `persist_routes` is enabled. -* `sns_notifications_enabled` - (Optional) Indicates whether SNS notifications should be enabled for route server events. Enabling SNS notifications persists BGP status changes to an SNS topic provisioned by AWS`. +* `persistRoutes` - (Optional) Indicates whether routes should be persisted after all BGP sessions are terminated. Valid values are `enable`, `disable`, `reset` +* `persistRoutesDuration` - (Optional) The number of minutes a route server will wait after BGP is re-established to unpersist the routes in the FIB and RIB. Value must be in the range of 1-5. Required if `persistRoutes` is enabled. +* `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). +* `snsNotificationsEnabled` - (Optional) Indicates whether SNS notifications should be enabled for route server events. Enabling SNS notifications persists BGP status changes to an SNS topic provisioned by AWS`. * `tags` - (Optional) A map of tags to assign to the resource. If configured with a provider [`defaultTags` 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. ## Attribute Reference @@ -84,7 +85,7 @@ The following arguments are optional: This resource exports the following attributes in addition to the arguments above: * `arn` - The ARN of the route server. -* `route_server_id` - The unique identifier of the route server. +* `routeServerId` - The unique identifier of the route server. * `snsTopicArn` - The ARN of the SNS topic where notifications are published. * `tagsAll` - A map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). @@ -98,7 +99,7 @@ This resource exports the following attributes in addition to the arguments abov ## Import -In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import VPC (Virtual Private Cloud) Route Server using the `route_server_id`. For example: +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import VPC (Virtual Private Cloud) Route Server using the `routeServerId`. For example: ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -108,7 +109,7 @@ import { TerraformStack } from "cdktf"; * Provider bindings are generated by running `cdktf get`. * See https://cdk.tf/provider-generation for more details. */ -import { VpcRouteServer } from "./.gen/providers/aws/"; +import { VpcRouteServer } from "./.gen/providers/aws/vpc-route-server"; class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); @@ -118,10 +119,10 @@ class MyConvertedCode extends TerraformStack { ``` -Using `terraform import`, import VPC (Virtual Private Cloud) Route Server using the `route_server_id`. For example: +Using `terraform import`, import VPC (Virtual Private Cloud) Route Server using the `routeServerId`. For example: ```console % terraform import aws_vpc_route_server.example rs-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/vpc_route_server_endpoint.html.markdown b/website/docs/cdktf/typescript/r/vpc_route_server_endpoint.html.markdown index 28d0da4233a5..e58b9327efa7 100644 --- a/website/docs/cdktf/typescript/r/vpc_route_server_endpoint.html.markdown +++ b/website/docs/cdktf/typescript/r/vpc_route_server_endpoint.html.markdown @@ -23,13 +23,13 @@ import { TerraformStack } from "cdktf"; * Provider bindings are generated by running `cdktf get`. * See https://cdk.tf/provider-generation for more details. */ -import { VpcRouteServerEndpoint } from "./.gen/providers/aws/"; +import { VpcRouteServerEndpoint } from "./.gen/providers/aws/vpc-route-server-endpoint"; class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); new VpcRouteServerEndpoint(this, "test", { - route_server_id: example.routeServerId, - subnet_id: main.id, + routeServerId: example.routeServerId, + subnetId: main.id, tags: { Name: "Endpoint A", }, @@ -43,11 +43,12 @@ class MyConvertedCode extends TerraformStack { The following arguments are required: -* `route_server_id` - (Required) The ID of the route server for which to create an endpoint. +* `routeServerId` - (Required) The ID of the route server for which to create an endpoint. * `subnetId` - (Required) The ID of the subnet in which to create the route server endpoint. The following arguments are optional: +* `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). * `tags` - (Optional) A map of tags to assign to the resource. If configured with a provider [`defaultTags` 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. ## Attribute Reference @@ -55,9 +56,9 @@ The following arguments are optional: This resource exports the following attributes in addition to the arguments above: * `arn` - The ARN of the route server endpoint. -* `route_server_endpoint_id` - The unique identifier of the route server endpoint. +* `routeServerEndpointId` - The unique identifier of the route server endpoint. * `eniId` - The ID of the Elastic network interface for the endpoint. -* `eni_address` - The IP address of the Elastic network interface for the endpoint. +* `eniAddress` - The IP address of the Elastic network interface for the endpoint. * `vpcId` - The ID of the VPC containing the endpoint. * `tagsAll` - A map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). @@ -70,7 +71,7 @@ This resource exports the following attributes in addition to the arguments abov ## Import -In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import VPC (Virtual Private Cloud) Route Server Endpoint using the `route_server_endpoint_id`. For example: +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import VPC (Virtual Private Cloud) Route Server Endpoint using the `routeServerEndpointId`. For example: ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -80,7 +81,7 @@ import { TerraformStack } from "cdktf"; * Provider bindings are generated by running `cdktf get`. * See https://cdk.tf/provider-generation for more details. */ -import { VpcRouteServerEndpoint } from "./.gen/providers/aws/"; +import { VpcRouteServerEndpoint } from "./.gen/providers/aws/vpc-route-server-endpoint"; class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); @@ -94,10 +95,10 @@ class MyConvertedCode extends TerraformStack { ``` -Using `terraform import`, import VPC (Virtual Private Cloud) Route Server Endpoint using the `route_server_endpoint_id`. For example: +Using `terraform import`, import VPC (Virtual Private Cloud) Route Server Endpoint using the `routeServerEndpointId`. For example: ```console % terraform import aws_vpc_route_server_endpoint.example rse-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/vpc_route_server_peer.html.markdown b/website/docs/cdktf/typescript/r/vpc_route_server_peer.html.markdown index d7aa211c2aca..32460c0d6af4 100644 --- a/website/docs/cdktf/typescript/r/vpc_route_server_peer.html.markdown +++ b/website/docs/cdktf/typescript/r/vpc_route_server_peer.html.markdown @@ -23,18 +23,18 @@ import { TerraformStack } from "cdktf"; * Provider bindings are generated by running `cdktf get`. * See https://cdk.tf/provider-generation for more details. */ -import { VpcRouteServerPeer } from "./.gen/providers/aws/"; +import { VpcRouteServerPeer } from "./.gen/providers/aws/vpc-route-server-peer"; class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); new VpcRouteServerPeer(this, "test", { - bgp_options: [ + bgpOptions: [ { - peer_asn: 65200, + peerAsn: 65200, }, ], - peer_address: "10.0.1.250", - route_server_endpoint_id: example.routeServerEndpointId, + peerAddress: "10.0.1.250", + routeServerEndpointId: example.routeServerEndpointId, tags: { Name: "Appliance 1", }, @@ -49,23 +49,21 @@ class MyConvertedCode extends TerraformStack { ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug import { Construct } from "constructs"; -import { TerraformStack } from "cdktf"; +import { Token, TerraformStack } from "cdktf"; /* * Provider bindings are generated by running `cdktf get`. * See https://cdk.tf/provider-generation for more details. */ -import { - VpcRouteServer, - VpcRouteServerAssociation, - VpcRouteServerEndpoint, - VpcRouteServerPeer, - VpcRouteServerPropagation, -} from "./.gen/providers/aws/"; +import { VpcRouteServerAssociation } from "./.gen/providers/aws/"; +import { VpcRouteServer } from "./.gen/providers/aws/vpc-route-server"; +import { VpcRouteServerEndpoint } from "./.gen/providers/aws/vpc-route-server-endpoint"; +import { VpcRouteServerPeer } from "./.gen/providers/aws/vpc-route-server-peer"; +import { VpcRouteServerPropagation } from "./.gen/providers/aws/vpc-route-server-propagation"; class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); const test = new VpcRouteServer(this, "test", { - amazon_side_asn: 4294967294, + amazonSideAsn: 4294967294, tags: { Name: "Test", }, @@ -85,8 +83,8 @@ class MyConvertedCode extends TerraformStack { "test_2", { dependsOn: [awsVpcRouteServerAssociationTest], - route_server_id: test.routeServerId, - subnet_id: awsSubnetTest.id, + routeServerId: test.routeServerId, + subnetId: Token.asString(awsSubnetTest.id), tags: { Name: "Test Endpoint", }, @@ -95,15 +93,16 @@ class MyConvertedCode extends TerraformStack { /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ awsVpcRouteServerEndpointTest.overrideLogicalId("test"); const awsVpcRouteServerPeerTest = new VpcRouteServerPeer(this, "test_3", { - bgp_options: [ + bgpOptions: [ { - peer_asn: 65000, - peer_liveness_detection: "bgp-keepalive", + peerAsn: 65000, + peerLivenessDetection: "bgp-keepalive", }, ], - peer_address: "10.0.1.250", - route_server_endpoint_id: - awsVpcRouteServerEndpointTest.routeServerEndpointId, + peerAddress: "10.0.1.250", + routeServerEndpointId: Token.asString( + awsVpcRouteServerEndpointTest.routeServerEndpointId + ), tags: { Name: "Test Appliance", }, @@ -115,8 +114,8 @@ class MyConvertedCode extends TerraformStack { "test_4", { dependsOn: [awsVpcRouteServerAssociationTest], - route_server_id: test.routeServerId, - route_table_id: awsRouteTableTest.id, + routeServerId: test.routeServerId, + routeTableId: Token.asString(awsRouteTableTest.id), } ); /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ @@ -130,28 +129,29 @@ class MyConvertedCode extends TerraformStack { The following arguments are required: -* `route_server_endpoint_id` - (Required) The ID of the route server endpoint for which to create a peer. +* `bgpOptions` - (Required) The BGP options for the peer, including ASN (Autonomous System Number) and BFD (Bidrectional Forwarding Detection) settings. Configuration block with BGP Options configuration Detailed below * `peerAddress` - (Required) The IPv4 address of the peer device. -* `bgpOptions` - The BGP options for the peer, including ASN (Autonomous System Number) and BFD (Bidrectional Forwarding Detection) settings. Configuration block with BGP Options configuration Detailed below - -### bgp_options - -* `peerAsn` - (Required) The Border Gateway Protocol (BGP) Autonomous System Number (ASN) for the appliance. Valid values are from 1 to 4294967295. We recommend using a private ASN in the 64512–65534 (16-bit ASN) or 4200000000–4294967294 (32-bit ASN) range. -* `peer_liveness_detection` (Optional) The requested liveness detection protocol for the BGP peer. Valid values are `bgp-keepalive` and `bfd`. Default value is `bgp-keepalive`. +* `routeServerEndpointId` - (Required) The ID of the route server endpoint for which to create a peer. The following arguments are optional: +* `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). * `tags` - (Optional) A map of tags to assign to the resource. If configured with a provider [`defaultTags` 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. +### bgp_options + +* `peerAsn` - (Required) The Border Gateway Protocol (BGP) Autonomous System Number (ASN) for the appliance. Valid values are from 1 to 4294967295. We recommend using a private ASN in the 64512–65534 (16-bit ASN) or 4200000000–4294967294 (32-bit ASN) range. +* `peerLivenessDetection` (Optional) The requested liveness detection protocol for the BGP peer. Valid values are `bgp-keepalive` and `bfd`. Default value is `bgp-keepalive`. + ## Attribute Reference This resource exports the following attributes in addition to the arguments above: * `arn` - The ARN of the route server peer. -* `route_server_peer_id` - The unique identifier of the route server peer. -* `route_server_id` - The ID of the route server associated with this peer. -* `endpoint_eni_address` - The IP address of the Elastic network interface for the route server endpoint. -* `endpoint_eni_id` - The ID of the Elastic network interface for the route server endpoint. +* `routeServerPeerId` - The unique identifier of the route server peer. +* `routeServerId` - The ID of the route server associated with this peer. +* `endpointEniAddress` - The IP address of the Elastic network interface for the route server endpoint. +* `endpointEniId` - The ID of the Elastic network interface for the route server endpoint. * `subnetId` - The ID of the subnet containing the route server peer. * `vpcId` - The ID of the VPC containing the route server peer. * `tagsAll` - A map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). @@ -165,7 +165,7 @@ This resource exports the following attributes in addition to the arguments abov ## Import -In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import VPC (Virtual Private Cloud) Route Server using the `route_server_peer_id`. For example: +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import VPC (Virtual Private Cloud) Route Server using the `routeServerPeerId`. For example: ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -175,7 +175,7 @@ import { TerraformStack } from "cdktf"; * Provider bindings are generated by running `cdktf get`. * See https://cdk.tf/provider-generation for more details. */ -import { VpcRouteServerPeer } from "./.gen/providers/aws/"; +import { VpcRouteServerPeer } from "./.gen/providers/aws/vpc-route-server-peer"; class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); @@ -185,10 +185,10 @@ class MyConvertedCode extends TerraformStack { ``` -Using `terraform import`, import VPC (Virtual Private Cloud) Route Server using the `route_server_peer_id`. For example: +Using `terraform import`, import VPC (Virtual Private Cloud) Route Server using the `routeServerPeerId`. For example: ```console % terraform import aws_vpc_route_server_peer.example rsp-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/vpc_route_server_propagation.html.markdown b/website/docs/cdktf/typescript/r/vpc_route_server_propagation.html.markdown index b76bf222b759..8f2ae2ae29f0 100644 --- a/website/docs/cdktf/typescript/r/vpc_route_server_propagation.html.markdown +++ b/website/docs/cdktf/typescript/r/vpc_route_server_propagation.html.markdown @@ -18,18 +18,18 @@ description: |- ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug import { Construct } from "constructs"; -import { TerraformStack } from "cdktf"; +import { Token, TerraformStack } from "cdktf"; /* * Provider bindings are generated by running `cdktf get`. * See https://cdk.tf/provider-generation for more details. */ -import { VpcRouteServerPropagation } from "./.gen/providers/aws/"; +import { VpcRouteServerPropagation } from "./.gen/providers/aws/vpc-route-server-propagation"; class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); new VpcRouteServerPropagation(this, "example", { - route_server_id: awsVpcRouteServerExample.routeServerId, - route_table_id: awsRouteTableExample.id, + routeServerId: Token.asString(awsVpcRouteServerExample.routeServerId), + routeTableId: Token.asString(awsRouteTableExample.id), }); } } @@ -40,9 +40,13 @@ class MyConvertedCode extends TerraformStack { The following arguments are required: -* `route_server_id` - (Required) The unique identifier for the route server to be associated. +* `routeServerId` - (Required) The unique identifier for the route server to be associated. * `routeTableId` - (Required) The ID of the route table to which route server will propagate routes. +The following arguments are optional: + +* `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). + ## Attribute Reference This resource exports no additional attributes. @@ -66,7 +70,7 @@ import { TerraformStack } from "cdktf"; * Provider bindings are generated by running `cdktf get`. * See https://cdk.tf/provider-generation for more details. */ -import { VpcRouteServerPropagation } from "./.gen/providers/aws/"; +import { VpcRouteServerPropagation } from "./.gen/providers/aws/vpc-route-server-propagation"; class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); @@ -86,4 +90,4 @@ Using `terraform import`, to to import VPC (Virtual Private Cloud) Route Server % terraform import aws_vpc_route_server_propagation.example rs-12345678,rtb-656c65616e6f72 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/vpc_route_server_vpc_association.html.markdown b/website/docs/cdktf/typescript/r/vpc_route_server_vpc_association.html.markdown index b2e601bff9f3..b167e4dd9cf2 100644 --- a/website/docs/cdktf/typescript/r/vpc_route_server_vpc_association.html.markdown +++ b/website/docs/cdktf/typescript/r/vpc_route_server_vpc_association.html.markdown @@ -18,18 +18,18 @@ description: |- ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug import { Construct } from "constructs"; -import { TerraformStack } from "cdktf"; +import { Token, TerraformStack } from "cdktf"; /* * Provider bindings are generated by running `cdktf get`. * See https://cdk.tf/provider-generation for more details. */ -import { VpcRouteServerVpcAssociation } from "./.gen/providers/aws/"; +import { VpcRouteServerVpcAssociation } from "./.gen/providers/aws/vpc-route-server-vpc-association"; class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); new VpcRouteServerVpcAssociation(this, "example", { - route_server_id: awsVpcRouteServerExample.routeServerId, - vpc_id: awsVpcExample.id, + routeServerId: Token.asString(awsVpcRouteServerExample.routeServerId), + vpcId: Token.asString(awsVpcExample.id), }); } } @@ -40,9 +40,13 @@ class MyConvertedCode extends TerraformStack { The following arguments are required: -* `route_server_id` - (Required) The unique identifier for the route server to be associated. +* `routeServerId` - (Required) The unique identifier for the route server to be associated. * `vpcId` - (Required) The ID of the VPC to associate with the route server. +The following arguments are optional: + +* `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). + ## Attribute Reference This resource exports no additional attributes. @@ -66,7 +70,7 @@ import { TerraformStack } from "cdktf"; * Provider bindings are generated by running `cdktf get`. * See https://cdk.tf/provider-generation for more details. */ -import { VpcRouteServerVpcAssociation } from "./.gen/providers/aws/"; +import { VpcRouteServerVpcAssociation } from "./.gen/providers/aws/vpc-route-server-vpc-association"; class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); @@ -86,4 +90,4 @@ Using `terraform import`, to to import VPC (Virtual Private Cloud) Route Server % terraform import aws_vpc_route_server_vpc_association.example rs-12345678,vpc-0f001273ec18911b1 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/vpc_security_group_egress_rule.html.markdown b/website/docs/cdktf/typescript/r/vpc_security_group_egress_rule.html.markdown index de9e16e7b3f0..accc459e5636 100644 --- a/website/docs/cdktf/typescript/r/vpc_security_group_egress_rule.html.markdown +++ b/website/docs/cdktf/typescript/r/vpc_security_group_egress_rule.html.markdown @@ -48,6 +48,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `cidrIpv4` - (Optional) The destination IPv4 CIDR range. * `cidrIpv6` - (Optional) The destination IPv6 CIDR range. * `description` - (Optional) The security group rule description. @@ -101,4 +102,4 @@ Using `terraform import`, import security group egress rules using the `security % terraform import aws_vpc_security_group_egress_rule.example sgr-02108b27edd666983 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/vpc_security_group_ingress_rule.html.markdown b/website/docs/cdktf/typescript/r/vpc_security_group_ingress_rule.html.markdown index d6c9abcb9b5c..4f4fc6a0e8ab 100644 --- a/website/docs/cdktf/typescript/r/vpc_security_group_ingress_rule.html.markdown +++ b/website/docs/cdktf/typescript/r/vpc_security_group_ingress_rule.html.markdown @@ -60,8 +60,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: -~> **Note** Although `cidrIpv4`, `cidrIpv6`, `prefixListId`, and `referencedSecurityGroupId` are all marked as optional, you *must* provide one of them in order to configure the destination of the traffic. The `fromPort` and `toPort` arguments are required unless `ipProtocol` is set to `-1` or `icmpv6`. - +* `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). * `cidrIpv4` - (Optional) The source IPv4 CIDR range. * `cidrIpv6` - (Optional) The source IPv6 CIDR range. * `description` - (Optional) The security group rule description. @@ -73,6 +72,8 @@ This resource supports the following arguments: * `tags` - (Optional) A map of tags to assign to the resource. If configured with a provider [`defaultTags` 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. * `toPort` - (Optional) The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. +~> **Note** Although `cidrIpv4`, `cidrIpv6`, `prefixListId`, and `referencedSecurityGroupId` are all marked as optional, you *must* provide one of them in order to configure the destination of the traffic. The `fromPort` and `toPort` arguments are required unless `ipProtocol` is set to `-1` or `icmpv6`. + ## Attribute Reference This resource exports the following attributes in addition to the arguments above: @@ -113,4 +114,4 @@ Using `terraform import`, import security group ingress rules using the `securit % terraform import aws_vpc_security_group_ingress_rule.example sgr-02108b27edd666983 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/vpc_security_group_vpc_association.html.markdown b/website/docs/cdktf/typescript/r/vpc_security_group_vpc_association.html.markdown index 0360b6a75056..603049ef910a 100644 --- a/website/docs/cdktf/typescript/r/vpc_security_group_vpc_association.html.markdown +++ b/website/docs/cdktf/typescript/r/vpc_security_group_vpc_association.html.markdown @@ -37,8 +37,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `securityGroupId` - (Required) The ID of the security group. * `vpcId` - (Required) The ID of the VPC to make the association with. @@ -87,4 +88,4 @@ Using `terraform import`, import a Security Group VPC Association using the `sec % terraform import aws_vpc_security_group_vpc_association.example sg-12345,vpc-67890 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/vpclattice_access_log_subscription.html.markdown b/website/docs/cdktf/typescript/r/vpclattice_access_log_subscription.html.markdown index fe6681179d9d..3b2deb73c3d1 100644 --- a/website/docs/cdktf/typescript/r/vpclattice_access_log_subscription.html.markdown +++ b/website/docs/cdktf/typescript/r/vpclattice_access_log_subscription.html.markdown @@ -46,6 +46,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `serviceNetworkLogType` - (Optional, Forces new resource) Type of log that monitors your Amazon VPC Lattice service networks. Valid values are: `SERVICE`, `RESOURCE`. Defaults to `SERVICE`. ## Attribute Reference @@ -88,4 +89,4 @@ Using `terraform import`, import VPC Lattice Access Log Subscription using the a % terraform import aws_vpclattice_access_log_subscription.example rft-8012925589 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/vpclattice_auth_policy.html.markdown b/website/docs/cdktf/typescript/r/vpclattice_auth_policy.html.markdown index 571e66bc78be..4246d2f4bdee 100644 --- a/website/docs/cdktf/typescript/r/vpclattice_auth_policy.html.markdown +++ b/website/docs/cdktf/typescript/r/vpclattice_auth_policy.html.markdown @@ -68,8 +68,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `resourceIdentifier` - (Required) The ID or Amazon Resource Name (ARN) of the service network or service for which the policy is created. * `policy` - (Required) The auth policy. The policy string in JSON must not contain newlines or blank lines. @@ -121,4 +122,4 @@ Using `terraform import`, import VPC Lattice Auth Policy using the `id`. For exa % terraform import aws_vpclattice_auth_policy.example abcd-12345678 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/vpclattice_listener.html.markdown b/website/docs/cdktf/typescript/r/vpclattice_listener.html.markdown index 794ad58d43e9..e5cf609d19ad 100644 --- a/website/docs/cdktf/typescript/r/vpclattice_listener.html.markdown +++ b/website/docs/cdktf/typescript/r/vpclattice_listener.html.markdown @@ -189,6 +189,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `defaultAction` - (Required) Default action block for the default listener rule. Default action blocks are defined below. * `name` - (Required, Forces new resource) Name of the listener. A listener name must be unique within a service. Valid characters are a-z, 0-9, and hyphens (-). You can't use a hyphen as the first or last character, or immediately after another hyphen. * `port` - (Optional, Forces new resource) Listener port. You can specify a value from 1 to 65535. If `port` is not specified and `protocol` is HTTP, the value will default to 80. If `port` is not specified and `protocol` is HTTPS, the value will default to 443. @@ -268,4 +269,4 @@ Using `terraform import`, import VPC Lattice Listener using the `listenerId` of % terraform import aws_vpclattice_listener.example svc-1a2b3c4d/listener-987654321 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/vpclattice_listener_rule.html.markdown b/website/docs/cdktf/typescript/r/vpclattice_listener_rule.html.markdown index 5a9800ed820d..bd9ab7d557f3 100644 --- a/website/docs/cdktf/typescript/r/vpclattice_listener_rule.html.markdown +++ b/website/docs/cdktf/typescript/r/vpclattice_listener_rule.html.markdown @@ -131,6 +131,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `tags` - (Optional) Key-value mapping of resource tags. If configured with a provider [`defaultTags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. ### `action` Block @@ -266,4 +267,4 @@ Using `terraform import`, import VPC Lattice Listener Rule using the `id`. For e % terraform import aws_vpclattice_listener_rule.example service123/listener456/rule789 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/vpclattice_resource_configuration.html.markdown b/website/docs/cdktf/typescript/r/vpclattice_resource_configuration.html.markdown index e6a1e5a0421e..9a5a3157517d 100644 --- a/website/docs/cdktf/typescript/r/vpclattice_resource_configuration.html.markdown +++ b/website/docs/cdktf/typescript/r/vpclattice_resource_configuration.html.markdown @@ -137,6 +137,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `allowAssociationToShareableServiceNetwork` (Optional) Allow or Deny the association of this resource to a shareable service network. * `protocol` - (Optional) Protocol for the Resource `TCP` is currently the only supported value. MUST be specified if `resourceConfigurationGroupId` is not. * `resourceConfigurationGroupId` (Optional) ID of Resource Configuration where `type` is `CHILD`. @@ -150,6 +151,7 @@ One of `dnsResource`, `ipResource`, `arnResource` must be specified. The following arguments are optional: +* `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). * `arnResource` - (Optional) Resource DNS Configuration. See [`arnResource` Block](#arn_resource-block) for details. * `dnsResource` - (Optional) Resource DNS Configuration. See [`dnsResource` Block](#dns_resource-block) for details. * `ipResource` - (Optional) Resource DNS Configuration. See [`ipResource` Block](#ip_resource-block) for details. @@ -221,4 +223,4 @@ Using `terraform import`, import VPC Lattice Resource Configuration using the `i % terraform import aws_vpclattice_resource_configuration.example rcfg-1234567890abcdef1 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/vpclattice_resource_gateway.html.markdown b/website/docs/cdktf/typescript/r/vpclattice_resource_gateway.html.markdown index 3286ce69cd15..60572a862dbf 100644 --- a/website/docs/cdktf/typescript/r/vpclattice_resource_gateway.html.markdown +++ b/website/docs/cdktf/typescript/r/vpclattice_resource_gateway.html.markdown @@ -103,6 +103,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `ipAddressType` - (Optional) IP address type used by the resource gateway. Valid values are `IPV4`, `IPV6`, and `DUALSTACK`. The IP address type of a resource gateway must be compatible with the subnets of the resource gateway and the IP address type of the resource. * `securityGroupIds` - (Optional) Security group IDs associated with the resource gateway. The security groups must be in the same VPC. * `tags` - (Optional) Key-value mapping of resource tags. If configured with a provider [`defaultTags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. @@ -148,4 +149,4 @@ Using `terraform import`, import VPC Lattice Resource Gateway using the `id`. Fo % terraform import aws_vpclattice_resource_gateway.example rgw-0a1b2c3d4e5f ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/vpclattice_resource_policy.html.markdown b/website/docs/cdktf/typescript/r/vpclattice_resource_policy.html.markdown index d5ea78f6b56a..bf134fcf9a6b 100644 --- a/website/docs/cdktf/typescript/r/vpclattice_resource_policy.html.markdown +++ b/website/docs/cdktf/typescript/r/vpclattice_resource_policy.html.markdown @@ -79,8 +79,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `resourceArn` - (Required) The ID or Amazon Resource Name (ARN) of the service network or service for which the policy is created. * `policy` - (Required) An IAM policy. The policy string in JSON must not contain newlines or blank lines. @@ -120,4 +121,4 @@ Using `terraform import`, import VPC Lattice Resource Policy using the `resource % terraform import aws_vpclattice_resource_policy.example rft-8012925589 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/vpclattice_service.html.markdown b/website/docs/cdktf/typescript/r/vpclattice_service.html.markdown index 43e7b5932356..dd26da96078a 100644 --- a/website/docs/cdktf/typescript/r/vpclattice_service.html.markdown +++ b/website/docs/cdktf/typescript/r/vpclattice_service.html.markdown @@ -46,6 +46,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `authType` - (Optional) Type of IAM policy. Either `NONE` or `AWS_IAM`. * `certificateArn` - (Optional) Amazon Resource Name (ARN) of the certificate. * `customDomainName` - (Optional) Custom domain name of the service. @@ -100,4 +101,4 @@ Using `terraform import`, import VPC Lattice Service using the `id`. For example % terraform import aws_vpclattice_service.example svc-06728e2357ea55f8a ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/vpclattice_service_network.html.markdown b/website/docs/cdktf/typescript/r/vpclattice_service_network.html.markdown index e125935f0c16..5eca00942c41 100644 --- a/website/docs/cdktf/typescript/r/vpclattice_service_network.html.markdown +++ b/website/docs/cdktf/typescript/r/vpclattice_service_network.html.markdown @@ -45,6 +45,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `authType` - (Optional) Type of IAM policy. Either `NONE` or `AWS_IAM`. * `tags` - (Optional) Key-value mapping of resource tags. If configured with a provider [`defaultTags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. @@ -87,4 +88,4 @@ Using `terraform import`, import VPC Lattice Service Network using the `id`. For % terraform import aws_vpclattice_service_network.example sn-0158f91c1e3358dba ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/vpclattice_service_network_resource_association.html.markdown b/website/docs/cdktf/typescript/r/vpclattice_service_network_resource_association.html.markdown index 5fd79426f7d3..3d0407e32a51 100644 --- a/website/docs/cdktf/typescript/r/vpclattice_service_network_resource_association.html.markdown +++ b/website/docs/cdktf/typescript/r/vpclattice_service_network_resource_association.html.markdown @@ -18,19 +18,22 @@ Terraform resource for managing an AWS VPC Lattice Service Network Resource Asso ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug import { Construct } from "constructs"; -import { TerraformStack } from "cdktf"; +import { Token, TerraformStack } from "cdktf"; /* * Provider bindings are generated by running `cdktf get`. * See https://cdk.tf/provider-generation for more details. */ -import { VpclatticeServiceNetworkResourceAssociation } from "./.gen/providers/aws/"; +import { VpclatticeServiceNetworkResourceAssociation } from "./.gen/providers/aws/vpclattice-service-network-resource-association"; class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); new VpclatticeServiceNetworkResourceAssociation(this, "example", { - resource_configuration_identifier: - awsVpclatticeResourceConfigurationExample.id, - service_network_identifier: awsVpclatticeServiceNetworkExample.id, + resourceConfigurationIdentifier: Token.asString( + awsVpclatticeResourceConfigurationExample.id + ), + serviceNetworkIdentifier: Token.asString( + awsVpclatticeServiceNetworkExample.id + ), tags: { Name: "Example", }, @@ -44,11 +47,12 @@ class MyConvertedCode extends TerraformStack { The following arguments are required: -* `resource_configuration_identifier` - (Required) Identifier of Resource Configuration to associate to the Service Network. +* `resourceConfigurationIdentifier` - (Required) Identifier of Resource Configuration to associate to the Service Network. * `serviceNetworkIdentifier` - (Required) Identifier of the Service Network to associate the Resource to. The following arguments are optional: +* `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). * `tags` - (Optional) Map of tags assigned to the resource. If configured with a provider [`defaultTags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. ## Attribute Reference @@ -81,7 +85,7 @@ import { TerraformStack } from "cdktf"; * Provider bindings are generated by running `cdktf get`. * See https://cdk.tf/provider-generation for more details. */ -import { VpclatticeServiceNetworkResourceAssociation } from "./.gen/providers/aws/"; +import { VpclatticeServiceNetworkResourceAssociation } from "./.gen/providers/aws/vpclattice-service-network-resource-association"; class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); @@ -101,4 +105,4 @@ Using `terraform import`, import VPC Lattice Service Network Resource Associatio % terraform import aws_vpclattice_service_network_resource_association.example snra-1234567890abcef12 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/vpclattice_service_network_service_association.html.markdown b/website/docs/cdktf/typescript/r/vpclattice_service_network_service_association.html.markdown index 3150b11b0657..2d308c658933 100644 --- a/website/docs/cdktf/typescript/r/vpclattice_service_network_service_association.html.markdown +++ b/website/docs/cdktf/typescript/r/vpclattice_service_network_service_association.html.markdown @@ -41,12 +41,11 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `serviceIdentifier` - (Required) The ID or Amazon Resource Identifier (ARN) of the service. * `serviceNetworkIdentifier` - (Required) The ID or Amazon Resource Identifier (ARN) of the service network. You must use the ARN if the resources specified in the operation are in different accounts. -The following arguments are optional: - * `tags` - (Optional) Key-value mapping of resource tags. If configured with a provider [`defaultTags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. ## Attribute Reference @@ -102,4 +101,4 @@ Using `terraform import`, import VPC Lattice Service Network Service Association % terraform import aws_vpclattice_service_network_service_association.example snsa-05e2474658a88f6ba ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/vpclattice_service_network_vpc_association.html.markdown b/website/docs/cdktf/typescript/r/vpclattice_service_network_vpc_association.html.markdown index 29e7da5dae13..3c3999b27e2c 100644 --- a/website/docs/cdktf/typescript/r/vpclattice_service_network_vpc_association.html.markdown +++ b/website/docs/cdktf/typescript/r/vpclattice_service_network_vpc_association.html.markdown @@ -42,12 +42,12 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `vpcIdentifier` - (Required) The ID of the VPC. * `serviceNetworkIdentifier` - (Required) The ID or Amazon Resource Identifier (ARN) of the service network. You must use the ARN if the resources specified in the operation are in different accounts. The following arguments are optional: - * `tags` - (Optional) Key-value mapping of resource tags. If configured with a provider [`defaultTags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. * `securityGroupIds` - (Optional) The IDs of the security groups. @@ -100,4 +100,4 @@ Using `terraform import`, import VPC Lattice Service Network VPC Association usi % terraform import aws_vpclattice_service_network_vpc_association.example snsa-05e2474658a88f6ba ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/vpclattice_target_group.html.markdown b/website/docs/cdktf/typescript/r/vpclattice_target_group.html.markdown index 998363fe8efe..afad6e09d60d 100644 --- a/website/docs/cdktf/typescript/r/vpclattice_target_group.html.markdown +++ b/website/docs/cdktf/typescript/r/vpclattice_target_group.html.markdown @@ -151,6 +151,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `config` - (Optional) The target group configuration. * `tags` - (Optional) Key-value mapping of resource tags. If configured with a provider [`defaultTags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. @@ -226,4 +227,4 @@ Using `terraform import`, import VPC Lattice Target Group using the `id`. For ex % terraform import aws_vpclattice_target_group.example tg-0c11d4dc16ed96bdb ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/vpclattice_target_group_attachment.html.markdown b/website/docs/cdktf/typescript/r/vpclattice_target_group_attachment.html.markdown index bdbdb734f83e..978d4c26a5ad 100644 --- a/website/docs/cdktf/typescript/r/vpclattice_target_group_attachment.html.markdown +++ b/website/docs/cdktf/typescript/r/vpclattice_target_group_attachment.html.markdown @@ -44,6 +44,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +- `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). - `targetGroupIdentifier` - (Required) The ID or Amazon Resource Name (ARN) of the target group. - `target` - (Required) The target. @@ -56,4 +57,4 @@ This resource supports the following arguments: This resource exports no additional attributes. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/vpn_connection.html.markdown b/website/docs/cdktf/typescript/r/vpn_connection.html.markdown index 27cdaae44d19..d8be02653a14 100644 --- a/website/docs/cdktf/typescript/r/vpn_connection.html.markdown +++ b/website/docs/cdktf/typescript/r/vpn_connection.html.markdown @@ -188,13 +188,14 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `customerGatewayId` - (Required) The ID of the customer gateway. * `type` - (Required) The type of VPN connection. The only type AWS supports at this time is "ipsec.1". * `transitGatewayId` - (Optional) The ID of the EC2 Transit Gateway. * `vpnGatewayId` - (Optional) The ID of the Virtual Private Gateway. * `staticRoutesOnly` - (Optional, Default `false`) Whether the VPN connection uses static routes exclusively. Static routes must be used for devices that don't support BGP. * `enableAcceleration` - (Optional, Default `false`) Indicate whether to enable acceleration for the VPN connection. Supports only EC2 Transit Gateway. -* `preshared_key_storage` - (Optional) Storage mode for the pre-shared key (PSK). Valid values are `Standard` (stored in the Site-to-Site VPN service) or `SecretsManager` (stored in AWS Secrets Manager). +* `presharedKeyStorage` - (Optional) Storage mode for the pre-shared key (PSK). Valid values are `Standard` (stored in the Site-to-Site VPN service) or `SecretsManager` (stored in AWS Secrets Manager). * `tags` - (Optional) Tags to apply to the connection. If configured with a provider [`defaultTags` 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. * `localIpv4NetworkCidr` - (Optional, Default `0.0.0.0/0`) The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection. * `localIpv6NetworkCidr` - (Optional, Default `::/0`) The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection. @@ -269,20 +270,20 @@ This resource exports the following attributes in addition to the arguments abov * `customerGatewayConfiguration` - The configuration information for the VPN connection's customer gateway (in the native XML format). * `customerGatewayId` - The ID of the customer gateway to which the connection is attached. * `routes` - The static routes associated with the VPN connection. Detailed below. -* `preshared_key_arn` - ARN of the Secrets Manager secret storing the pre-shared key(s) for the VPN connection. Note that even if it returns a valid Secrets Manager ARN, the pre-shared key(s) will not be stored in Secrets Manager unless the `preshared_key_storage` argument is set to `SecretsManager`. +* `presharedKeyArn` - ARN of the Secrets Manager secret storing the pre-shared key(s) for the VPN connection. Note that even if it returns a valid Secrets Manager ARN, the pre-shared key(s) will not be stored in Secrets Manager unless the `presharedKeyStorage` argument is set to `SecretsManager`. * `staticRoutesOnly` - Whether the VPN connection uses static routes exclusively. * `tagsAll` - A map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). * `transitGatewayAttachmentId` - When associated with an EC2 Transit Gateway (`transitGatewayId` argument), the attachment ID. See also the [`aws_ec2_tag` resource](/docs/providers/aws/r/ec2_tag.html) for tagging the EC2 Transit Gateway VPN Attachment. * `tunnel1Address` - The public IP address of the first VPN tunnel. * `tunnel1CgwInsideAddress` - The RFC 6890 link-local address of the first VPN tunnel (Customer Gateway Side). * `tunnel1VgwInsideAddress` - The RFC 6890 link-local address of the first VPN tunnel (VPN Gateway Side). -* `tunnel1PresharedKey` - The preshared key of the first VPN tunnel. If `preshared_key_storage` is set to `SecretsManager`, it returns strings indicating the keys are redacted and the actual values are stored in Secrets Manager. +* `tunnel1PresharedKey` - The preshared key of the first VPN tunnel. If `presharedKeyStorage` is set to `SecretsManager`, it returns strings indicating the keys are redacted and the actual values are stored in Secrets Manager. * `tunnel1BgpAsn` - The bgp asn number of the first VPN tunnel. * `tunnel1BgpHoldtime` - The bgp holdtime of the first VPN tunnel. * `tunnel2Address` - The public IP address of the second VPN tunnel. * `tunnel2CgwInsideAddress` - The RFC 6890 link-local address of the second VPN tunnel (Customer Gateway Side). * `tunnel2VgwInsideAddress` - The RFC 6890 link-local address of the second VPN tunnel (VPN Gateway Side). -* `tunnel2PresharedKey` - The preshared key of the second VPN tunnel. If `preshared_key_storage` is set to `SecretsManager`, it returns strings indicating the keys are redacted and the actual values are stored in Secrets Manager. +* `tunnel2PresharedKey` - The preshared key of the second VPN tunnel. If `presharedKeyStorage` is set to `SecretsManager`, it returns strings indicating the keys are redacted and the actual values are stored in Secrets Manager. * `tunnel2BgpAsn` - The bgp asn number of the second VPN tunnel. * `tunnel2BgpHoldtime` - The bgp holdtime of the second VPN tunnel. * `vgwTelemetry` - Telemetry for the VPN tunnels. Detailed below. @@ -335,4 +336,4 @@ Using `terraform import`, import VPN Connections using the VPN connection `id`. % terraform import aws_vpn_connection.testvpnconnection vpn-40f41529 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/vpn_connection_route.html.markdown b/website/docs/cdktf/typescript/r/vpn_connection_route.html.markdown index 7764590de974..fb0ff06544f3 100644 --- a/website/docs/cdktf/typescript/r/vpn_connection_route.html.markdown +++ b/website/docs/cdktf/typescript/r/vpn_connection_route.html.markdown @@ -60,6 +60,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `destinationCidrBlock` - (Required) The CIDR block associated with the local subnet of the customer network. * `vpnConnectionId` - (Required) The ID of the VPN connection. @@ -70,4 +71,4 @@ This resource exports the following attributes in addition to the arguments abov * `destinationCidrBlock` - The CIDR block associated with the local subnet of the customer network. * `vpnConnectionId` - The ID of the VPN connection. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/vpn_gateway.html.markdown b/website/docs/cdktf/typescript/r/vpn_gateway.html.markdown index 5662fb66818f..da56b64fe6d4 100644 --- a/website/docs/cdktf/typescript/r/vpn_gateway.html.markdown +++ b/website/docs/cdktf/typescript/r/vpn_gateway.html.markdown @@ -41,6 +41,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `vpcId` - (Optional) The VPC ID to create in. * `availabilityZone` - (Optional) The Availability Zone for the virtual private gateway. * `tags` - (Optional) A map of tags to assign to the resource. If configured with a provider [`defaultTags` 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. @@ -82,4 +83,4 @@ Using `terraform import`, import VPN Gateways using the VPN gateway `id`. For ex % terraform import aws_vpn_gateway.testvpngateway vgw-9a4cacf3 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/vpn_gateway_attachment.html.markdown b/website/docs/cdktf/typescript/r/vpn_gateway_attachment.html.markdown index 65553fca3936..495ec8545528 100644 --- a/website/docs/cdktf/typescript/r/vpn_gateway_attachment.html.markdown +++ b/website/docs/cdktf/typescript/r/vpn_gateway_attachment.html.markdown @@ -58,6 +58,7 @@ guides for more information. This resource supports the following arguments: +* `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). * `vpcId` - (Required) The ID of the VPC. * `vpnGatewayId` - (Required) The ID of the Virtual Private Gateway. @@ -72,4 +73,4 @@ This resource exports the following attributes in addition to the arguments abov You cannot import this resource. - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/vpn_gateway_route_propagation.html.markdown b/website/docs/cdktf/typescript/r/vpn_gateway_route_propagation.html.markdown index d954040c75c5..3aaa26f764f9 100644 --- a/website/docs/cdktf/typescript/r/vpn_gateway_route_propagation.html.markdown +++ b/website/docs/cdktf/typescript/r/vpn_gateway_route_propagation.html.markdown @@ -41,8 +41,9 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `vpnGatewayId` - The id of the `aws_vpn_gateway` to propagate routes from. * `routeTableId` - The id of the `aws_route_table` to propagate routes into. @@ -57,4 +58,4 @@ This resource exports no additional attributes. - `create` - (Default `2m`) - `delete` - (Default `2m`) - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/wafregional_byte_match_set.html.markdown b/website/docs/cdktf/typescript/r/wafregional_byte_match_set.html.markdown index 9c085c01f15e..a0debc51d838 100644 --- a/website/docs/cdktf/typescript/r/wafregional_byte_match_set.html.markdown +++ b/website/docs/cdktf/typescript/r/wafregional_byte_match_set.html.markdown @@ -49,6 +49,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) The name or description of the ByteMatchSet. * `byteMatchTuples` - (Optional)Settings for the ByteMatchSet, such as the bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to search for in web requests. ByteMatchTuple documented below. @@ -104,4 +105,4 @@ Using `terraform import`, import WAF Regional Byte Match Set using the id. For e % terraform import aws_wafregional_byte_match_set.byte_set a1b2c3d4-d5f6-7777-8888-9999aaaabbbbcccc ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/wafregional_geo_match_set.html.markdown b/website/docs/cdktf/typescript/r/wafregional_geo_match_set.html.markdown index 8304a9034a05..cdc40d0c8f8b 100644 --- a/website/docs/cdktf/typescript/r/wafregional_geo_match_set.html.markdown +++ b/website/docs/cdktf/typescript/r/wafregional_geo_match_set.html.markdown @@ -48,6 +48,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) The name or description of the Geo Match Set. * `geoMatchConstraint` - (Optional) The Geo Match Constraint objects which contain the country that you want AWS WAF to search for. @@ -100,4 +101,4 @@ Using `terraform import`, import WAF Regional Geo Match Set using the id. For ex % terraform import aws_wafregional_geo_match_set.geo_match_set a1b2c3d4-d5f6-7777-8888-9999aaaabbbbcccc ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/wafregional_ipset.html.markdown b/website/docs/cdktf/typescript/r/wafregional_ipset.html.markdown index 31efcae4bdc8..0d9f43ca1935 100644 --- a/website/docs/cdktf/typescript/r/wafregional_ipset.html.markdown +++ b/website/docs/cdktf/typescript/r/wafregional_ipset.html.markdown @@ -48,6 +48,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) The name or description of the IPSet. * `ipSetDescriptor` - (Optional) One or more pairs specifying the IP address type (IPV4 or IPV6) and the IP address range (in CIDR notation) from which web requests originate. @@ -101,4 +102,4 @@ Using `terraform import`, import WAF Regional IPSets using their ID. For example % terraform import aws_wafregional_ipset.example a1b2c3d4-d5f6-7777-8888-9999aaaabbbbcccc ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/wafregional_rate_based_rule.html.markdown b/website/docs/cdktf/typescript/r/wafregional_rate_based_rule.html.markdown index 5c68d6a41b31..40416ce60d23 100644 --- a/website/docs/cdktf/typescript/r/wafregional_rate_based_rule.html.markdown +++ b/website/docs/cdktf/typescript/r/wafregional_rate_based_rule.html.markdown @@ -59,6 +59,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `metricName` - (Required) The name or description for the Amazon CloudWatch metric of this rule. * `name` - (Required) The name or description of the rule. * `rateKey` - (Required) Valid value is IP. @@ -121,4 +122,4 @@ Using `terraform import`, import WAF Regional Rate Based Rule using the id. For % terraform import aws_wafregional_rate_based_rule.wafrule a1b2c3d4-d5f6-7777-8888-9999aaaabbbbcccc ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/wafregional_regex_match_set.html.markdown b/website/docs/cdktf/typescript/r/wafregional_regex_match_set.html.markdown index a77641fcb3ff..625cb45c24dd 100644 --- a/website/docs/cdktf/typescript/r/wafregional_regex_match_set.html.markdown +++ b/website/docs/cdktf/typescript/r/wafregional_regex_match_set.html.markdown @@ -59,6 +59,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) The name or description of the Regex Match Set. * `regexMatchTuple` - (Required) The regular expression pattern that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings. See below. @@ -120,4 +121,4 @@ Using `terraform import`, import WAF Regional Regex Match Set using the id. For % terraform import aws_wafregional_regex_match_set.example a1b2c3d4-d5f6-7777-8888-9999aaaabbbbcccc ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/wafregional_regex_pattern_set.html.markdown b/website/docs/cdktf/typescript/r/wafregional_regex_pattern_set.html.markdown index 8689dc18a9f2..980b754a24d8 100644 --- a/website/docs/cdktf/typescript/r/wafregional_regex_pattern_set.html.markdown +++ b/website/docs/cdktf/typescript/r/wafregional_regex_pattern_set.html.markdown @@ -39,6 +39,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) The name or description of the Regex Pattern Set. * `regexPatternStrings` - (Optional) A list of regular expression (regex) patterns that you want AWS WAF to search for, such as `B[a@]dB[o0]t`. @@ -80,4 +81,4 @@ Using `terraform import`, import WAF Regional Regex Pattern Set using the id. Fo % terraform import aws_wafregional_regex_pattern_set.example a1b2c3d4-d5f6-7777-8888-9999aaaabbbbcccc ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/wafregional_rule.html.markdown b/website/docs/cdktf/typescript/r/wafregional_rule.html.markdown index c81c01d931bd..ed4bb52fd901 100644 --- a/website/docs/cdktf/typescript/r/wafregional_rule.html.markdown +++ b/website/docs/cdktf/typescript/r/wafregional_rule.html.markdown @@ -56,6 +56,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) The name or description of the rule. * `metricName` - (Required) The name or description for the Amazon CloudWatch metric of this rule. * `predicate` - (Optional) The objects to include in a rule (documented below). @@ -115,4 +116,4 @@ Using `terraform import`, import WAF Regional Rule using the id. For example: % terraform import aws_wafregional_rule.wafrule a1b2c3d4-d5f6-7777-8888-9999aaaabbbbcccc ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/wafregional_rule_group.html.markdown b/website/docs/cdktf/typescript/r/wafregional_rule_group.html.markdown index 527d6704e4c7..916b83dfdb02 100644 --- a/website/docs/cdktf/typescript/r/wafregional_rule_group.html.markdown +++ b/website/docs/cdktf/typescript/r/wafregional_rule_group.html.markdown @@ -59,6 +59,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) A friendly name of the rule group * `metricName` - (Required) A friendly name for the metrics from the rule group * `activatedRule` - (Optional) A list of activated rules, see below @@ -116,4 +117,4 @@ Using `terraform import`, import WAF Regional Rule Group using the id. For examp % terraform import aws_wafregional_rule_group.example a1b2c3d4-d5f6-7777-8888-9999aaaabbbbcccc ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/wafregional_size_constraint_set.html.markdown b/website/docs/cdktf/typescript/r/wafregional_size_constraint_set.html.markdown index b695cd29a346..3056fcb18cf9 100644 --- a/website/docs/cdktf/typescript/r/wafregional_size_constraint_set.html.markdown +++ b/website/docs/cdktf/typescript/r/wafregional_size_constraint_set.html.markdown @@ -48,6 +48,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) The name or description of the Size Constraint Set. * `sizeConstraints` - (Optional) Specifies the parts of web requests that you want to inspect the size of. @@ -119,4 +120,4 @@ Using `terraform import`, import WAF Size Constraint Set using the id. For examp % terraform import aws_wafregional_size_constraint_set.size_constraint_set a1b2c3d4-d5f6-7777-8888-9999aaaabbbbcccc ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/wafregional_sql_injection_match_set.html.markdown b/website/docs/cdktf/typescript/r/wafregional_sql_injection_match_set.html.markdown index 408219ab0572..52885ba3fd02 100644 --- a/website/docs/cdktf/typescript/r/wafregional_sql_injection_match_set.html.markdown +++ b/website/docs/cdktf/typescript/r/wafregional_sql_injection_match_set.html.markdown @@ -46,6 +46,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) The name or description of the SizeConstraintSet. * `sqlInjectionMatchTuple` - (Optional) The parts of web requests that you want AWS WAF to inspect for malicious SQL code and, if you want AWS WAF to inspect a header, the name of the header. @@ -107,4 +108,4 @@ Using `terraform import`, import WAF Regional Sql Injection Match Set using the % terraform import aws_wafregional_sql_injection_match_set.sql_injection_match_set a1b2c3d4-d5f6-7777-8888-9999aaaabbbbcccc ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/wafregional_web_acl.html.markdown b/website/docs/cdktf/typescript/r/wafregional_web_acl.html.markdown index 13d0705379e0..9b216a2d3584 100644 --- a/website/docs/cdktf/typescript/r/wafregional_web_acl.html.markdown +++ b/website/docs/cdktf/typescript/r/wafregional_web_acl.html.markdown @@ -159,6 +159,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `defaultAction` - (Required) The action that you want AWS WAF Regional to take when a request doesn't match the criteria in any of the rules that are associated with the web ACL. * `metricName` - (Required) The name or description for the Amazon CloudWatch metric of this web ACL. * `name` - (Required) The name or description of the web ACL. @@ -241,4 +242,4 @@ Using `terraform import`, import WAF Regional Web ACL using the id. For example: % terraform import aws_wafregional_web_acl.wafacl a1b2c3d4-d5f6-7777-8888-9999aaaabbbbcccc ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/wafregional_web_acl_association.html.markdown b/website/docs/cdktf/typescript/r/wafregional_web_acl_association.html.markdown index 522e6c4ba56d..c10e2c17b860 100644 --- a/website/docs/cdktf/typescript/r/wafregional_web_acl_association.html.markdown +++ b/website/docs/cdktf/typescript/r/wafregional_web_acl_association.html.markdown @@ -207,6 +207,7 @@ resource "aws_wafregional_web_acl_association" "association" { This resource supports the following arguments: +* `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). * `webAclId` - (Required) The ID of the WAF Regional WebACL to create an association. * `resourceArn` - (Required) ARN of the resource to associate with. For example, an Application Load Balancer or API Gateway Stage. @@ -254,4 +255,4 @@ Using `terraform import`, import WAF Regional Web ACL Association using their `w % terraform import aws_wafregional_web_acl_association.foo web_acl_id:resource_arn ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/wafregional_xss_match_set.html.markdown b/website/docs/cdktf/typescript/r/wafregional_xss_match_set.html.markdown index 5ba30178f82a..fe34b8407bd5 100644 --- a/website/docs/cdktf/typescript/r/wafregional_xss_match_set.html.markdown +++ b/website/docs/cdktf/typescript/r/wafregional_xss_match_set.html.markdown @@ -52,6 +52,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) The name of the set * `xssMatchTuple` - (Optional) The parts of web requests that you want to inspect for cross-site scripting attacks. @@ -105,4 +106,4 @@ Using `terraform import`, import AWS WAF Regional XSS Match using the `id`. For % terraform import aws_wafregional_xss_match_set.example 12345abcde ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/wafv2_api_key.html.markdown b/website/docs/cdktf/typescript/r/wafv2_api_key.html.markdown index 4ac62861ffc1..07fa23d3e9a8 100644 --- a/website/docs/cdktf/typescript/r/wafv2_api_key.html.markdown +++ b/website/docs/cdktf/typescript/r/wafv2_api_key.html.markdown @@ -39,6 +39,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +- `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). - `scope` - (Required) Specifies whether this is for an AWS CloudFront distribution or for a regional application. Valid values are `CLOUDFRONT` or `REGIONAL`. Changing this forces a new resource to be created. **NOTE:** WAFv2 API Keys deployed for `CLOUDFRONT` must be created within the `us-east-1` region. - `tokenDomains` - (Required) The domains that you want to be able to use the API key with, for example `example.com`. You can specify up to 5 domains. Changing this forces a new resource to be created. @@ -80,4 +81,4 @@ Using `terraform import`, import WAFv2 API Key using `api_key,scope`. For exampl % terraform import aws_wafv2_api_key.example a1b2c3d4-5678-90ab-cdef-EXAMPLE11111,REGIONAL ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/wafv2_ip_set.html.markdown b/website/docs/cdktf/typescript/r/wafv2_ip_set.html.markdown index 0716244302c1..e691426b02c5 100644 --- a/website/docs/cdktf/typescript/r/wafv2_ip_set.html.markdown +++ b/website/docs/cdktf/typescript/r/wafv2_ip_set.html.markdown @@ -46,6 +46,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Optional, Forces new resource) A friendly name of the IP set. If omitted, Terraform will assign a random, unique name. Conflicts with `namePrefix`. * `namePrefix` - (Optional) Creates a unique name beginning with the specified prefix. Conflicts with `name`. * `description` - (Optional) A friendly description of the IP set. @@ -94,4 +95,4 @@ Using `terraform import`, import WAFv2 IP Sets using `ID/name/scope`. For exampl % terraform import aws_wafv2_ip_set.example a1b2c3d4-d5f6-7777-8888-9999aaaabbbbcccc/example/REGIONAL ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/wafv2_regex_pattern_set.html.markdown b/website/docs/cdktf/typescript/r/wafv2_regex_pattern_set.html.markdown index 3f40bc570509..4656a8043d08 100644 --- a/website/docs/cdktf/typescript/r/wafv2_regex_pattern_set.html.markdown +++ b/website/docs/cdktf/typescript/r/wafv2_regex_pattern_set.html.markdown @@ -52,11 +52,12 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Optional, Forces new resource) A friendly name of the regular expression pattern set. If omitted, Terraform will assign a random, unique name. Conflicts with `namePrefix`. * `namePrefix` - (Optional) Creates a unique name beginning with the specified prefix. Conflicts with `name`. * `description` - (Optional) A friendly description of the regular expression pattern set. * `scope` - (Required) Specifies whether this is for an AWS CloudFront distribution or for a regional application. Valid values are `CLOUDFRONT` or `REGIONAL`. To work with CloudFront, you must also specify the region `us-east-1` (N. Virginia) on the AWS provider. -* `regularExpression` - (Optional) One or more blocks of regular expression patterns that you want AWS WAF to search for, such as `B[a@]dB[o0]t`. See [Regular Expression](#regular-expression) below for details. A maximum of 10 `regularExpression` blocks may be specified. +* `regularExpression` - (Optional) One or more blocks of regular expression patterns that you want AWS WAF to search for, such as `B[a@]dB[o0]t`. See [Regular Expression](#regular-expression) below for details. * `tags` - (Optional) An array of key:value pairs to associate with the resource. If configured with a provider [`defaultTags` 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. ### Regular Expression @@ -103,4 +104,4 @@ Using `terraform import`, import WAFv2 Regex Pattern Sets using `ID/name/scope`. % terraform import aws_wafv2_regex_pattern_set.example a1b2c3d4-d5f6-7777-8888-9999aaaabbbbcccc/example/REGIONAL ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/wafv2_rule_group.html.markdown b/website/docs/cdktf/typescript/r/wafv2_rule_group.html.markdown index 6a95fcecffa8..9f48860606b0 100644 --- a/website/docs/cdktf/typescript/r/wafv2_rule_group.html.markdown +++ b/website/docs/cdktf/typescript/r/wafv2_rule_group.html.markdown @@ -319,16 +319,76 @@ class MyConvertedCode extends TerraformStack { ``` +### Using rule_json + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { Fn, TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { Wafv2RuleGroup } from "./.gen/providers/aws/wafv2-rule-group"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + new Wafv2RuleGroup(this, "example", { + capacity: 100, + name: "example-rule-group", + rule_json: Fn.jsonencode([ + { + Action: { + Count: {}, + }, + Name: "rule-1", + Priority: 1, + Statement: { + ByteMatchStatement: { + FieldToMatch: { + UriPath: {}, + }, + PositionalConstraint: "CONTAINS", + SearchString: "badbot", + TextTransformations: [ + { + Priority: 1, + Type: "NONE", + }, + ], + }, + }, + VisibilityConfig: { + CloudwatchMetricsEnabled: false, + MetricName: "friendly-rule-metric-name", + SampledRequestsEnabled: false, + }, + }, + ]), + scope: "REGIONAL", + visibilityConfig: { + cloudwatchMetricsEnabled: false, + metricName: "friendly-metric-name", + sampledRequestsEnabled: false, + }, + }); + } +} + +``` + ## Argument Reference This resource supports the following arguments: +* `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). * `capacity` - (Required, Forces new resource) The web ACL capacity units (WCUs) required for this rule group. See [here](https://docs.aws.amazon.com/waf/latest/APIReference/API_CreateRuleGroup.html#API_CreateRuleGroup_RequestSyntax) for general information and [here](https://docs.aws.amazon.com/waf/latest/developerguide/waf-rule-statements-list.html) for capacity specific information. * `customResponseBody` - (Optional) Defines custom response bodies that can be referenced by `customResponse` actions. See [Custom Response Body](#custom-response-body) below for details. * `description` - (Optional) A friendly description of the rule group. * `name` - (Required, Forces new resource) A friendly name of the rule group. * `namePrefix` - (Optional) Creates a unique name beginning with the specified prefix. Conflicts with `name`. * `rule` - (Optional) The rule blocks used to identify the web requests that you want to `allow`, `block`, or `count`. See [Rules](#rules) below for details. +* `ruleJson` - (Optional) Raw JSON string to allow more than three nested statements. Conflicts with `rule` attribute. This is for advanced use cases where more than 3 levels of nested statements are required. **There is no drift detection at this time**. If you use this attribute instead of `rule`, you will be foregoing drift detection. Additionally, importing an existing rule group into a configuration with `ruleJson` set will result in a one time in-place update as the remote rule configuration is initially written to the `rule` attribute. See the AWS [documentation](https://docs.aws.amazon.com/waf/latest/APIReference/API_CreateRuleGroup.html) for the JSON structure. * `scope` - (Required, Forces new resource) Specifies whether this is for an AWS CloudFront distribution or for a regional application. Valid values are `CLOUDFRONT` or `REGIONAL`. To work with CloudFront, you must also specify the region `us-east-1` (N. Virginia) on the AWS provider. * `tags` - (Optional) An array of key:value pairs to associate with the resource. If configured with a provider [`defaultTags` 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. * `visibilityConfig` - (Required) Defines and enables Amazon CloudWatch metrics and web request sample collection. See [Visibility Configuration](#visibility-configuration) below for details. @@ -884,4 +944,4 @@ Using `terraform import`, import WAFv2 Rule Group using `ID/name/scope`. For exa % terraform import aws_wafv2_rule_group.example a1b2c3d4-d5f6-7777-8888-9999aaaabbbbcccc/example/REGIONAL ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/wafv2_web_acl.html.markdown b/website/docs/cdktf/typescript/r/wafv2_web_acl.html.markdown index ba4552504444..371ec32882ba 100644 --- a/website/docs/cdktf/typescript/r/wafv2_web_acl.html.markdown +++ b/website/docs/cdktf/typescript/r/wafv2_web_acl.html.markdown @@ -14,6 +14,8 @@ Creates a WAFv2 Web ACL resource. ~> **Note** In `fieldToMatch` blocks, _e.g._, in `byteMatchStatement`, the `body` block includes an optional argument `oversizeHandling`. AWS indicates this argument will be required starting February 2023. To avoid configurations breaking when that change happens, treat the `oversizeHandling` argument as **required** as soon as possible. +!> **Warning:** If you use the `aws_wafv2_web_acl_rule_group_association` resource to associate rule groups with this Web ACL, you must add `lifecycle { ignore_changes = [rule] }` to this resource to prevent configuration drift. The association resource modifies the Web ACL's rules outside of this resource's direct management. + ## Example Usage This resource is based on `aws_wafv2_rule_group`, check the documentation of the `aws_wafv2_rule_group` resource to see examples of the various available statements. @@ -494,6 +496,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `associationConfig` - (Optional) Specifies custom configurations for the associations between the web ACL and protected resources. See [`associationConfig`](#association_config-block) below for details. * `captchaConfig` - (Optional) Specifies how AWS WAF should handle CAPTCHA evaluations on the ACL level (used by [AWS Bot Control](https://docs.aws.amazon.com/waf/latest/developerguide/aws-managed-rule-groups-bot.html)). See [`captchaConfig`](#captcha_config-block) below for details. * `challengeConfig` - (Optional) Specifies how AWS WAF should handle Challenge evaluations on the ACL level (used by [AWS Bot Control](https://docs.aws.amazon.com/waf/latest/developerguide/aws-managed-rule-groups-bot.html)). See [`challengeConfig`](#challenge_config-block) below for details. @@ -855,6 +858,7 @@ The `managedRuleGroupConfigs` block support the following arguments: * `awsManagedRulesBotControlRuleSet` - (Optional) Additional configuration for using the Bot Control managed rule group. Use this to specify the inspection level that you want to use. See [`awsManagedRulesBotControlRuleSet`](#aws_managed_rules_bot_control_rule_set-block) for more details * `awsManagedRulesAcfpRuleSet` - (Optional) Additional configuration for using the Account Creation Fraud Prevention managed rule group. Use this to specify information such as the registration page of your application and the type of content to accept or reject from the client. +* `awsManagedRulesAntiDdosRuleSet` - (Optional) Configuration for using the anti-DDoS managed rule group. See [`awsManagedRulesAntiDdosRuleSet`](#aws_managed_rules_anti_ddos_rule_set-block) for more details. * `awsManagedRulesAtpRuleSet` - (Optional) Additional configuration for using the Account Takeover Protection managed rule group. Use this to specify information such as the sign-in page of your application and the type of content to accept or reject from the client. * `loginPath` - (Optional, **Deprecated**) The path of the login endpoint for your application. * `passwordField` - (Optional, **Deprecated**) Details about your login page password field. See [`passwordField`](#password_field-block) for more details. @@ -874,6 +878,19 @@ The `managedRuleGroupConfigs` block support the following arguments: * `requestInspection` - (Optional) The criteria for inspecting login requests, used by the ATP rule group to validate credentials usage. See [`requestInspection`](#request_inspection-block) for more details. * `responseInspection` - (Optional) The criteria for inspecting responses to login requests, used by the ATP rule group to track login failure rates. Note that Response Inspection is available only on web ACLs that protect CloudFront distributions. See [`responseInspection`](#response_inspection-block) for more details. +### `awsManagedRulesAntiDdosRuleSet` Block + +* `clientSideActionConfig` - (Required) Configuration for the request handling that's applied by the managed rule group rules `ChallengeAllDuringEvent` and `ChallengeDDoSRequests` during a distributed denial of service (DDoS) attack. See [`clientSideActionConfig`](#client_side_action_config-block) for more details. +* `sensitivityToBlock` - (Optional) Sensitivity that the rule group rule DDoSRequests uses when matching against the DDoS suspicion labeling on a request. Valid values are `LOW` (Default), `MEDIUM`, and `HIGH`. + +### `clientSideActionConfig` Block + +* `challenge` - (Required) Configuration for the use of the `AWSManagedRulesAntiDDoSRuleSet` rules `ChallengeAllDuringEvent` and `ChallengeDDoSRequests`. + * `exemptUriRegularExpression` - (Optional) Block for the list of the regular expressions to match against the web request URI, used to identify requests that can't handle a silent browser challenge. + * `regexString` - (Optional) Regular expression string. + * `sensitivity` - (Optional) Sensitivity that the rule group rule ChallengeDDoSRequests uses when matching against the DDoS suspicion labeling on a request. Valid values are `LOW`, `MEDIUM` and `HIGH` (Default). + * `usageOfAction` - (Required) Configuration whether to use the `AWSManagedRulesAntiDDoSRuleSet` rules `ChallengeAllDuringEvent` and `ChallengeDDoSRequests` in the rule group evaluation. Valid values are `ENABLED` and `DISABLED`. + ### `awsManagedRulesAtpRuleSet` Block * `enableRegexInPath` - (Optional) Whether or not to allow the use of regular expressions in the login page path. @@ -1142,6 +1159,7 @@ Aggregate the request counts using one or more web request components as the agg The `customKey` block supports the following arguments: +* `asn` - (Optional) Use an Autonomous System Number (ASN) derived from the request's originating or forwarded IP address as an aggregate key. See [RateLimit `asn`](#ratelimit-asn-block) below for details. * `cookie` - (Optional) Use the value of a cookie in the request as an aggregate key. See [RateLimit `cookie`](#ratelimit-cookie-block) below for details. * `forwardedIp` - (Optional) Use the first IP address in an HTTP header as an aggregate key. See [`forwardedIp`](#ratelimit-forwarded_ip-block) below for details. * `httpMethod` - (Optional) Use the request's HTTP method as an aggregate key. See [RateLimit `httpMethod`](#ratelimit-http_method-block) below for details. @@ -1154,6 +1172,12 @@ The `customKey` block supports the following arguments: * `queryString` - (Optional) Use the request's query string as an aggregate key. See [RateLimit `queryString`](#ratelimit-query_string-block) below for details. * `uriPath` - (Optional) Use the request's URI path as an aggregate key. See [RateLimit `uriPath`](#ratelimit-uri_path-block) below for details. +### RateLimit `asn` Block + +Use an Autonomous System Number (ASN) derived from the request's originating or forwarded IP address as an aggregate key. Each distinct ASN contributes to the aggregation instance. + +The `asn` block is configured as an empty block `{}`. + ### RateLimit `cookie` Block Use the value of a cookie in the request as an aggregate key. Each distinct value in the cookie contributes to the aggregation instance. If you use a single cookie as your custom key, then each value fully defines an aggregation instance. @@ -1281,4 +1305,4 @@ Using `terraform import`, import WAFv2 Web ACLs using `ID/Name/Scope`. For examp % terraform import aws_wafv2_web_acl.example a1b2c3d4-d5f6-7777-8888-9999aaaabbbbcccc/example/REGIONAL ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/wafv2_web_acl_association.html.markdown b/website/docs/cdktf/typescript/r/wafv2_web_acl_association.html.markdown index cd214108d937..ea687251d39d 100644 --- a/website/docs/cdktf/typescript/r/wafv2_web_acl_association.html.markdown +++ b/website/docs/cdktf/typescript/r/wafv2_web_acl_association.html.markdown @@ -116,6 +116,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `resourceArn` - (Required) The Amazon Resource Name (ARN) of the resource to associate with the web ACL. This must be an ARN of an Application Load Balancer, an Amazon API Gateway stage (REST only, HTTP is unsupported), an Amazon Cognito User Pool, an Amazon AppSync GraphQL API, an Amazon App Runner service, or an Amazon Verified Access instance. * `webAclArn` - (Required) The Amazon Resource Name (ARN) of the Web ACL that you want to associate with the resource. @@ -161,4 +162,4 @@ Using `terraform import`, import WAFv2 Web ACL Association using `WEB_ACL_ARN,RE % terraform import aws_wafv2_web_acl_association.example arn:aws:wafv2:...7ce849ea,arn:aws:apigateway:...ages/name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/wafv2_web_acl_logging_configuration.html.markdown b/website/docs/cdktf/typescript/r/wafv2_web_acl_logging_configuration.html.markdown index bb4d926ec772..d56df2537f17 100644 --- a/website/docs/cdktf/typescript/r/wafv2_web_acl_logging_configuration.html.markdown +++ b/website/docs/cdktf/typescript/r/wafv2_web_acl_logging_configuration.html.markdown @@ -151,7 +151,7 @@ class MyConvertedCode extends TerraformStack { test: "ArnLike", values: [ "arn:aws:logs:${" + - dataAwsRegionCurrent.name + + dataAwsRegionCurrent.region + "}:${" + current.accountId + "}:*", @@ -195,6 +195,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `logDestinationConfigs` - (Required) Configuration block that allows you to associate Amazon Kinesis Data Firehose, Cloudwatch Log log group, or S3 bucket Amazon Resource Names (ARNs) with the web ACL. **Note:** data firehose, log group, or bucket name **must** be prefixed with `aws-waf-logs-`, e.g. `aws-waf-logs-example-firehose`, `aws-waf-logs-example-log-group`, or `aws-waf-logs-example-bucket`. * `loggingFilter` - (Optional) Configuration block that specifies which web requests are kept in the logs and which are dropped. It allows filtering based on the rule action and the web request labels applied by matching rules during web ACL evaluation. For more details, refer to the [Logging Filter](#logging-filter) section below. * `redactedFields` - (Optional) Configuration for parts of the request that you want to keep out of the logs. Up to 100 `redactedFields` blocks are supported. See [Redacted Fields](#redacted-fields) below for more details. @@ -293,4 +294,4 @@ Using `terraform import`, import WAFv2 Web ACL Logging Configurations using the % terraform import aws_wafv2_web_acl_logging_configuration.example arn:aws:wafv2:us-west-2:123456789012:regional/webacl/test-logs/a1b2c3d4-5678-90ab-cdef ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/wafv2_web_acl_rule_group_association.html.markdown b/website/docs/cdktf/typescript/r/wafv2_web_acl_rule_group_association.html.markdown new file mode 100644 index 000000000000..7598cc13ce33 --- /dev/null +++ b/website/docs/cdktf/typescript/r/wafv2_web_acl_rule_group_association.html.markdown @@ -0,0 +1,663 @@ +--- +subcategory: "WAF" +layout: "aws" +page_title: "AWS: aws_wafv2_web_acl_rule_group_association" +description: |- + Associates a WAFv2 Rule Group with a Web ACL by adding a rule that references the Rule Group. +--- + + + +# Resource: aws_wafv2_web_acl_rule_group_association + +Associates a WAFv2 Rule Group (custom or managed) with a Web ACL by adding a rule that references the Rule Group. Use this resource to apply the rules defined in a Rule Group to a Web ACL without duplicating rule definitions. + +This resource supports both: + +- **Custom Rule Groups**: User-created rule groups that you manage within your AWS account +- **Managed Rule Groups**: Pre-configured rule groups provided by AWS or third-party vendors + +!> **Warning:** Verify the rule names in your `ruleActionOverride`s carefully. With managed rule groups, WAF silently ignores any override that uses an invalid rule name. With customer-owned rule groups, invalid rule names in your overrides will cause web ACL updates to fail. An invalid rule name is any name that doesn't exactly match the case-sensitive name of an existing rule in the rule group. + +!> **Warning:** Using this resource will cause the associated Web ACL resource to show configuration drift in the `rule` argument unless you add `lifecycle { ignore_changes = [rule] }` to the Web ACL resource configuration. This is because this resource modifies the Web ACL's rules outside of the Web ACL resource's direct management. + +~> **Note:** This resource creates a rule within the Web ACL that references the entire Rule Group. The rule group's individual rules are evaluated as a unit when requests are processed by the Web ACL. + +## Example Usage + +### Custom Rule Group - Basic Usage + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { Token, TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { Wafv2RuleGroup } from "./.gen/providers/aws/wafv2-rule-group"; +import { Wafv2WebAcl } from "./.gen/providers/aws/wafv2-web-acl"; +import { Wafv2WebAclRuleGroupAssociation } from "./.gen/providers/aws/wafv2-web-acl-rule-group-association"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + const example = new Wafv2RuleGroup(this, "example", { + capacity: 10, + name: "example-rule-group", + rule: [ + { + action: { + block: {}, + }, + name: "block-suspicious-requests", + priority: 1, + statement: { + geoMatchStatement: { + countryCodes: ["CN", "RU"], + }, + }, + visibilityConfig: { + cloudwatchMetricsEnabled: true, + metricName: "block-suspicious-requests", + sampledRequestsEnabled: true, + }, + }, + ], + scope: "REGIONAL", + visibilityConfig: { + cloudwatchMetricsEnabled: true, + metricName: "example-rule-group", + sampledRequestsEnabled: true, + }, + }); + const awsWafv2WebAclExample = new Wafv2WebAcl(this, "example_1", { + defaultAction: { + allow: {}, + }, + lifecycle: { + ignoreChanges: [rule], + }, + name: "example-web-acl", + scope: "REGIONAL", + visibilityConfig: { + cloudwatchMetricsEnabled: true, + metricName: "example-web-acl", + sampledRequestsEnabled: true, + }, + }); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + awsWafv2WebAclExample.overrideLogicalId("example"); + const awsWafv2WebAclRuleGroupAssociationExample = + new Wafv2WebAclRuleGroupAssociation(this, "example_2", { + priority: 100, + ruleGroupReference: [ + { + arn: example.arn, + }, + ], + ruleName: "example-rule-group-rule", + webAclArn: Token.asString(awsWafv2WebAclExample.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.*/ + awsWafv2WebAclRuleGroupAssociationExample.overrideLogicalId("example"); + } +} + +``` + +### Managed Rule Group - Basic Usage + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { Wafv2WebAcl } from "./.gen/providers/aws/wafv2-web-acl"; +import { Wafv2WebAclRuleGroupAssociation } from "./.gen/providers/aws/wafv2-web-acl-rule-group-association"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + const example = new Wafv2WebAcl(this, "example", { + defaultAction: { + allow: {}, + }, + lifecycle: { + ignoreChanges: [rule], + }, + name: "example-web-acl", + scope: "REGIONAL", + visibilityConfig: { + cloudwatchMetricsEnabled: true, + metricName: "example-web-acl", + sampledRequestsEnabled: true, + }, + }); + new Wafv2WebAclRuleGroupAssociation(this, "managed_example", { + managedRuleGroup: [ + { + name: "AWSManagedRulesCommonRuleSet", + vendorName: "AWS", + }, + ], + priority: 50, + ruleName: "aws-common-rule-set", + webAclArn: example.arn, + }); + } +} + +``` + +### Managed Rule Group - With Version + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { Wafv2WebAclRuleGroupAssociation } from "./.gen/providers/aws/wafv2-web-acl-rule-group-association"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + new Wafv2WebAclRuleGroupAssociation(this, "managed_versioned", { + managedRuleGroup: [ + { + name: "AWSManagedRulesCommonRuleSet", + vendorName: "AWS", + version: "Version_1.0", + }, + ], + priority: 60, + ruleName: "aws-common-rule-set-versioned", + webAclArn: example.arn, + }); + } +} + +``` + +### Managed Rule Group - With Rule Action Overrides + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { Wafv2WebAclRuleGroupAssociation } from "./.gen/providers/aws/wafv2-web-acl-rule-group-association"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + new Wafv2WebAclRuleGroupAssociation(this, "managed_with_overrides", { + managedRuleGroup: [ + { + name: "AWSManagedRulesCommonRuleSet", + ruleActionOverride: [ + { + actionToUse: [ + { + count: [ + { + customRequestHandling: [ + { + insertHeader: [ + { + name: "X-RFI-Override", + value: "counted", + }, + ], + }, + ], + }, + ], + }, + ], + name: "GenericRFI_BODY", + }, + { + actionToUse: [ + { + captcha: [{}], + }, + ], + name: "SizeRestrictions_BODY", + }, + ], + vendorName: "AWS", + }, + ], + priority: 70, + ruleName: "aws-common-rule-set-with-overrides", + webAclArn: example.arn, + }); + } +} + +``` + +### Custom Rule Group - With Override Action + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { Token, TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { Wafv2WebAclRuleGroupAssociation } from "./.gen/providers/aws/wafv2-web-acl-rule-group-association"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + new Wafv2WebAclRuleGroupAssociation(this, "example", { + overrideAction: "count", + priority: 100, + ruleGroupReference: [ + { + arn: Token.asString(awsWafv2RuleGroupExample.arn), + }, + ], + ruleName: "example-rule-group-rule", + webAclArn: Token.asString(awsWafv2WebAclExample.arn), + }); + } +} + +``` + +### Custom Rule Group - With Rule Action Overrides + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { Token, TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { Wafv2RuleGroup } from "./.gen/providers/aws/wafv2-rule-group"; +import { Wafv2WebAcl } from "./.gen/providers/aws/wafv2-web-acl"; +import { Wafv2WebAclRuleGroupAssociation } from "./.gen/providers/aws/wafv2-web-acl-rule-group-association"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + const example = new Wafv2RuleGroup(this, "example", { + capacity: 10, + name: "example-rule-group", + rule: [ + { + action: { + block: {}, + }, + name: "geo-block-rule", + priority: 1, + statement: { + geoMatchStatement: { + countryCodes: ["CN", "RU"], + }, + }, + visibilityConfig: { + cloudwatchMetricsEnabled: true, + metricName: "geo-block-rule", + sampledRequestsEnabled: true, + }, + }, + { + action: { + block: {}, + }, + name: "rate-limit-rule", + priority: 2, + statement: { + rateBasedStatement: { + aggregateKeyType: "IP", + limit: 1000, + }, + }, + visibilityConfig: { + cloudwatchMetricsEnabled: true, + metricName: "rate-limit-rule", + sampledRequestsEnabled: true, + }, + }, + ], + scope: "REGIONAL", + visibilityConfig: { + cloudwatchMetricsEnabled: true, + metricName: "example-rule-group", + sampledRequestsEnabled: true, + }, + }); + const awsWafv2WebAclExample = new Wafv2WebAcl(this, "example_1", { + defaultAction: { + allow: {}, + }, + lifecycle: { + ignoreChanges: [rule], + }, + name: "example-web-acl", + scope: "REGIONAL", + visibilityConfig: { + cloudwatchMetricsEnabled: true, + metricName: "example-web-acl", + sampledRequestsEnabled: true, + }, + }); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + awsWafv2WebAclExample.overrideLogicalId("example"); + const awsWafv2WebAclRuleGroupAssociationExample = + new Wafv2WebAclRuleGroupAssociation(this, "example_2", { + priority: 100, + ruleGroupReference: [ + { + arn: example.arn, + ruleActionOverride: [ + { + actionToUse: [ + { + count: [ + { + customRequestHandling: [ + { + insertHeader: [ + { + name: "X-Geo-Block-Override", + value: "counted", + }, + ], + }, + ], + }, + ], + }, + ], + name: "geo-block-rule", + }, + { + actionToUse: [ + { + captcha: [ + { + customRequestHandling: [ + { + insertHeader: [ + { + name: "X-Rate-Limit-Override", + value: "captcha-required", + }, + ], + }, + ], + }, + ], + }, + ], + name: "rate-limit-rule", + }, + ], + }, + ], + ruleName: "example-rule-group-rule", + webAclArn: Token.asString(awsWafv2WebAclExample.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.*/ + awsWafv2WebAclRuleGroupAssociationExample.overrideLogicalId("example"); + } +} + +``` + +### Custom Rule Group - CloudFront Web ACL + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { Token, TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { Wafv2RuleGroup } from "./.gen/providers/aws/wafv2-rule-group"; +import { Wafv2WebAcl } from "./.gen/providers/aws/wafv2-web-acl"; +import { Wafv2WebAclRuleGroupAssociation } from "./.gen/providers/aws/wafv2-web-acl-rule-group-association"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + const cloudfrontExample = new Wafv2RuleGroup(this, "cloudfront_example", { + capacity: 10, + name: "cloudfront-rule-group", + rule: [ + { + action: { + block: {}, + }, + name: "rate-limit", + priority: 1, + statement: { + rateBasedStatement: { + aggregateKeyType: "IP", + limit: 2000, + }, + }, + visibilityConfig: { + cloudwatchMetricsEnabled: true, + metricName: "rate-limit", + sampledRequestsEnabled: true, + }, + }, + ], + scope: "CLOUDFRONT", + visibilityConfig: { + cloudwatchMetricsEnabled: true, + metricName: "cloudfront-rule-group", + sampledRequestsEnabled: true, + }, + }); + const awsWafv2WebAclCloudfrontExample = new Wafv2WebAcl( + this, + "cloudfront_example_1", + { + defaultAction: { + allow: {}, + }, + lifecycle: { + ignoreChanges: [rule], + }, + name: "cloudfront-web-acl", + scope: "CLOUDFRONT", + visibilityConfig: { + cloudwatchMetricsEnabled: true, + metricName: "cloudfront-web-acl", + sampledRequestsEnabled: true, + }, + } + ); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + awsWafv2WebAclCloudfrontExample.overrideLogicalId("cloudfront_example"); + const awsWafv2WebAclRuleGroupAssociationCloudfrontExample = + new Wafv2WebAclRuleGroupAssociation(this, "cloudfront_example_2", { + priority: 50, + ruleGroupReference: [ + { + arn: cloudfrontExample.arn, + }, + ], + ruleName: "cloudfront-rule-group-rule", + webAclArn: Token.asString(awsWafv2WebAclCloudfrontExample.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.*/ + awsWafv2WebAclRuleGroupAssociationCloudfrontExample.overrideLogicalId( + "cloudfront_example" + ); + } +} + +``` + +## Argument Reference + +The following arguments are required: + +* `ruleName` - (Required) Name of the rule to create in the Web ACL that references the rule group. Must be between 1 and 128 characters. +* `priority` - (Required) Priority of the rule within the Web ACL. Rules are evaluated in order of priority, with lower numbers evaluated first. +* `webAclArn` - (Required) ARN of the Web ACL to associate the Rule Group with. + +The following arguments are optional: + +* `managedRuleGroup` - (Optional) Managed Rule Group configuration. One of `ruleGroupReference` or `managedRuleGroup` is required. Conflicts with `ruleGroupReference`. [See below](#managed_rule_group). +* `overrideAction` - (Optional) Override action for the rule group. Valid values are `none` and `count`. Defaults to `none`. When set to `count`, the actions defined in the rule group rules are overridden to count matches instead of blocking or allowing requests. +* `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). +* `ruleGroupReference` - (Optional) Custom Rule Group reference configuration. One of `ruleGroupReference` or `managedRuleGroup` is required. Conflicts with `managedRuleGroup`. [See below](#rule_group_reference). + +### rule_group_reference + +* `arn` - (Required) ARN of the Rule Group to associate with the Web ACL. +* `ruleActionOverride` - (Optional) Override actions for specific rules within the rule group. [See below](#rule_action_override). + +### managed_rule_group + +* `name` - (Required) Name of the managed rule group. +* `vendorName` - (Required) Name of the managed rule group vendor. For AWS managed rule groups, this is `AWS`. +* `version` - (Optional) Version of the managed rule group. If not specified, the default version is used. +* `ruleActionOverride` - (Optional) Override actions for specific rules within the rule group. [See below](#rule_action_override). + +### rule_action_override + +* `name` - (Required) Name of the rule to override within the rule group. Verify the name carefully. With managed rule groups, WAF silently ignores any override that uses an invalid rule name. With customer-owned rule groups, invalid rule names in your overrides will cause web ACL updates to fail. An invalid rule name is any name that doesn't exactly match the case-sensitive name of an existing rule in the rule group. +* `actionToUse` - (Required) Action to use instead of the rule's original action. [See below](#action_to_use). + +### action_to_use + +Exactly one of the following action blocks must be specified: + +* `allow` - (Optional) Allow the request. [See below](#allow). +* `block` - (Optional) Block the request. [See below](#block). +* `captcha` - (Optional) Require CAPTCHA verification. [See below](#captcha). +* `challenge` - (Optional) Require challenge verification. [See below](#challenge). +* `count` - (Optional) Count the request without taking action. [See below](#count). + +### allow + +* `customRequestHandling` - (Optional) Custom handling for allowed requests. [See below](#custom_request_handling). + +### block + +* `customResponse` - (Optional) Custom response for blocked requests. [See below](#custom_response). + +### captcha + +* `customRequestHandling` - (Optional) Custom handling for CAPTCHA requests. [See below](#custom_request_handling). + +### challenge + +* `customRequestHandling` - (Optional) Custom handling for challenge requests. [See below](#custom_request_handling). + +### count + +* `customRequestHandling` - (Optional) Custom handling for counted requests. [See below](#custom_request_handling). + +### custom_request_handling + +* `insertHeader` - (Required) Headers to insert into the request. [See below](#insert_header). + +### custom_response + +* `customResponseBodyKey` - (Optional) Key of a custom response body to use. +* `responseCode` - (Required) HTTP response code to return (200-599). +* `responseHeader` - (Optional) Headers to include in the response. [See below](#response_header). + +### insert_header + +* `name` - (Required) Name of the header to insert. +* `value` - (Required) Value of the header to insert. + +### response_header + +* `name` - (Required) Name of the response header. +* `value` - (Required) Value of the response header. + +## Attribute Reference + +This resource exports the following attributes in addition to the arguments above: + +None. + +## Timeouts + +[Configuration options](https://developer.hashicorp.com/terraform/language/resources/syntax#operation-timeouts): + +* `create` - (Default `30m`) +* `update` - (Default `30m`) +* `delete` - (Default `30m`) + +## Import + +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import WAFv2 web ACL custom rule group associations using `WebACLARN,RuleGroupARN,RuleName`. For example: + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { Wafv2WebAclRuleGroupAssociation } from "./.gen/providers/aws/wafv2-web-acl-rule-group-association"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + Wafv2WebAclRuleGroupAssociation.generateConfigForImport( + this, + "example", + "arn:aws:wafv2:us-east-1:123456789012:regional/webacl/example-web-acl/12345678-1234-1234-1234-123456789012,arn:aws:wafv2:us-east-1:123456789012:regional/rulegroup/example-rule-group/87654321-4321-4321-4321-210987654321,example-rule-group-rule" + ); + } +} + +``` + +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import WAFv2 web ACL managed rule group associations using `WebACLARN,VendorName:RuleGroupName[:Version],RuleName`. For example: + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { Wafv2WebAclRuleGroupAssociation } from "./.gen/providers/aws/wafv2-web-acl-rule-group-association"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + Wafv2WebAclRuleGroupAssociation.generateConfigForImport( + this, + "managedExample", + "arn:aws:wafv2:us-east-1:123456789012:regional/webacl/example-web-acl/12345678-1234-1234-1234-123456789012,AWS:AWSManagedRulesCommonRuleSet,aws-common-rule-set" + ); + } +} + +``` + +Using `terraform import`, import WAFv2 web ACL custom rule group associations using `WebACLARN,RuleGroupARN,RuleName`. For example: + +```console +% terraform import aws_wafv2_web_acl_rule_group_association.example "arn:aws:wafv2:us-east-1:123456789012:regional/webacl/example-web-acl/12345678-1234-1234-1234-123456789012,arn:aws:wafv2:us-east-1:123456789012:regional/rulegroup/example-rule-group/87654321-4321-4321-4321-210987654321,example-rule-group-rule" +``` + +Using `terraform import`, import WAFv2 web ACL managed rule group associations using `WebACLARN,VendorName:RuleGroupName[:Version],RuleName`. For example: + +```console +% terraform import aws_wafv2_web_acl_rule_group_association.managed_example "arn:aws:wafv2:us-east-1:123456789012:regional/webacl/example-web-acl/12345678-1234-1234-1234-123456789012,AWS:AWSManagedRulesCommonRuleSet,aws-common-rule-set" +``` + + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/workspaces_connection_alias.html.markdown b/website/docs/cdktf/typescript/r/workspaces_connection_alias.html.markdown index 1239a8aae868..2ca13e874ab9 100644 --- a/website/docs/cdktf/typescript/r/workspaces_connection_alias.html.markdown +++ b/website/docs/cdktf/typescript/r/workspaces_connection_alias.html.markdown @@ -38,10 +38,11 @@ class MyConvertedCode extends TerraformStack { ## Argument Reference -The following arguments are required: +This resource supports the following arguments: +* `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). * `connectionString` - (Required) The connection string specified for the connection alias. The connection string must be in the form of a fully qualified domain name (FQDN), such as www.example.com. -* `tags` – (Optional) A map of tags assigned to the WorkSpaces Connection Alias. If configured with a provider [`defaultTags` 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. +* `tags` - (Optional) A map of tags assigned to the WorkSpaces Connection Alias. If configured with a provider [`defaultTags` 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. ## Attribute Reference @@ -92,4 +93,4 @@ Using `terraform import`, import WorkSpaces Connection Alias using the connectio % terraform import aws_workspaces_connection_alias.example rft-8012925589 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/workspaces_directory.html.markdown b/website/docs/cdktf/typescript/r/workspaces_directory.html.markdown index af2b4ef3fb41..d948c220338c 100644 --- a/website/docs/cdktf/typescript/r/workspaces_directory.html.markdown +++ b/website/docs/cdktf/typescript/r/workspaces_directory.html.markdown @@ -171,26 +171,23 @@ import { Token, TerraformStack } from "cdktf"; * See https://cdk.tf/provider-generation for more details. */ import { WorkspacesDirectory } from "./.gen/providers/aws/workspaces-directory"; -interface MyConfig { - directoryId: any; -} class MyConvertedCode extends TerraformStack { - constructor(scope: Construct, name: string, config: MyConfig) { + constructor(scope: Construct, name: string) { super(scope, name); new WorkspacesDirectory(this, "example", { - active_directory_config: [ - { - domain_name: "example.internal", - service_account_secret_arn: awsSecretsmanagerSecretExample.arn, - }, - ], + activeDirectoryConfig: { + domainName: "example.internal", + serviceAccountSecretArn: Token.asString( + awsSecretsmanagerSecretExample.arn + ), + }, samlProperties: { relayStateParameterName: "RelayState", status: "ENABLED", userAccessUrl: "https://sso.example.com/", }, subnetIds: [exampleC.id, exampleD.id], - user_identity_type: "CUSTOMER_MANAGED", + userIdentityType: "CUSTOMER_MANAGED", workspaceAccessProperties: { deviceTypeAndroid: "ALLOW", deviceTypeChromeos: "ALLOW", @@ -206,10 +203,9 @@ class MyConvertedCode extends TerraformStack { defaultOu: "OU=AWS,DC=Workgroup,DC=Example,DC=com", enableInternetAccess: true, }, - workspace_directory_description: "WorkSpaces Pools directory", - workspace_directory_name: "Pool directory", - workspace_type: "POOLS", - directoryId: config.directoryId, + workspaceDirectoryDescription: "WorkSpaces Pools directory", + workspaceDirectoryName: "Pool directory", + workspaceType: "POOLS", }); } } @@ -253,22 +249,23 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `directoryId` - (Optional) The directory identifier for registration in WorkSpaces service. * `subnetIds` - (Optional) The identifiers of the subnets where the directory resides. -* `ipGroupIds` – (Optional) The identifiers of the IP access control groups associated with the directory. -* `tags` – (Optional) A map of tags assigned to the WorkSpaces directory. If configured with a provider [`defaultTags` 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. +* `ipGroupIds` - (Optional) The identifiers of the IP access control groups associated with the directory. +* `tags` - (Optional) A map of tags assigned to the WorkSpaces directory. If configured with a provider [`defaultTags` 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. * `certificateBasedAuthProperties` - (Optional) Configuration of certificate-based authentication (CBA) integration. Requires SAML authentication to be enabled. Defined below. -* `samlProperties` – (Optional) Configuration of SAML authentication integration. Defined below. -* `selfServicePermissions` – (Optional) Permissions to enable or disable self-service capabilities when `workspace_type` is set to `PERSONAL`.. Defined below. -* `workspaceAccessProperties` – (Optional) Specifies which devices and operating systems users can use to access their WorkSpaces. Defined below. -* `workspaceCreationProperties` – (Optional) Default properties that are used for creating WorkSpaces. Defined below. -* `workspace_type` - (Optional) Specifies the type of WorkSpaces directory. Valid values are `PERSONAL` and `POOLS`. Default is `PERSONAL`. -* `active_directory_config` – (Optional) Configuration for Active Directory integration when `workspace_type` is set to `POOLS`. Defined below. -* `workspace_directory_name` - (Required for `POOLS`) The name of the WorkSpaces directory when `workspace_type` is set to `POOLS`. -* `workspace_directory_description` - (Required for `POOLS`) The description of the WorkSpaces directory when `workspace_type` is set to `POOLS`. -* `user_identity_type` - (Required for `POOLS`) Specifies the user identity type for the WorkSpaces directory. Valid values are `CUSTOMER_MANAGED`, `AWS_DIRECTORY_SERVICE`, `AWS_IAM_IDENTITY_CENTER`. - --> **Note:** When `workspace_type` is set to `POOLS`, the `directoryId` is automatically generated and cannot be manually set. +* `samlProperties` - (Optional) Configuration of SAML authentication integration. Defined below. +* `selfServicePermissions` - (Optional) Permissions to enable or disable self-service capabilities when `workspaceType` is set to `PERSONAL`.. Defined below. +* `workspaceAccessProperties` - (Optional) Specifies which devices and operating systems users can use to access their WorkSpaces. Defined below. +* `workspaceCreationProperties` - (Optional) Default properties that are used for creating WorkSpaces. Defined below. +* `workspaceType` - (Optional) Specifies the type of WorkSpaces directory. Valid values are `PERSONAL` and `POOLS`. Default is `PERSONAL`. +* `activeDirectoryConfig` - (Optional) Configuration for Active Directory integration when `workspaceType` is set to `POOLS`. Defined below. +* `workspaceDirectoryName` - (Required for `POOLS`) The name of the WorkSpaces directory when `workspaceType` is set to `POOLS`. +* `workspaceDirectoryDescription` - (Required for `POOLS`) The description of the WorkSpaces directory when `workspaceType` is set to `POOLS`. +* `userIdentityType` - (Required for `POOLS`) Specifies the user identity type for the WorkSpaces directory. Valid values are `CUSTOMER_MANAGED`, `AWS_DIRECTORY_SERVICE`, `AWS_IAM_IDENTITY_CENTER`. + +-> **Note:** When `workspaceType` is set to `POOLS`, the `directoryId` is automatically generated and cannot be manually set. ### certificate_based_auth_properties @@ -283,39 +280,39 @@ This resource supports the following arguments: ### self_service_permissions -* `changeComputeType` – (Optional) Whether WorkSpaces directory users can change the compute type (bundle) for their workspace. Default `false`. -* `increaseVolumeSize` – (Optional) Whether WorkSpaces directory users can increase the volume size of the drives on their workspace. Default `false`. -* `rebuildWorkspace` – (Optional) Whether WorkSpaces directory users can rebuild the operating system of a workspace to its original state. Default `false`. -* `restartWorkspace` – (Optional) Whether WorkSpaces directory users can restart their workspace. Default `true`. -* `switchRunningMode` – (Optional) Whether WorkSpaces directory users can switch the running mode of their workspace. Default `false`. +* `changeComputeType` - (Optional) Whether WorkSpaces directory users can change the compute type (bundle) for their workspace. Default `false`. +* `increaseVolumeSize` - (Optional) Whether WorkSpaces directory users can increase the volume size of the drives on their workspace. Default `false`. +* `rebuildWorkspace` - (Optional) Whether WorkSpaces directory users can rebuild the operating system of a workspace to its original state. Default `false`. +* `restartWorkspace` - (Optional) Whether WorkSpaces directory users can restart their workspace. Default `true`. +* `switchRunningMode` - (Optional) Whether WorkSpaces directory users can switch the running mode of their workspace. Default `false`. ### workspace_access_properties -* `deviceTypeAndroid` – (Optional) Indicates whether users can use Android devices to access their WorkSpaces. -* `deviceTypeChromeos` – (Optional) Indicates whether users can use Chromebooks to access their WorkSpaces. -* `deviceTypeIos` – (Optional) Indicates whether users can use iOS devices to access their WorkSpaces. -* `deviceTypeLinux` – (Optional) Indicates whether users can use Linux clients to access their WorkSpaces. -* `deviceTypeOsx` – (Optional) Indicates whether users can use macOS clients to access their WorkSpaces. -* `deviceTypeWeb` – (Optional) Indicates whether users can access their WorkSpaces through a web browser. -* `deviceTypeWindows` – (Optional) Indicates whether users can use Windows clients to access their WorkSpaces. -* `deviceTypeZeroclient` – (Optional) Indicates whether users can use zero client devices to access their WorkSpaces. +* `deviceTypeAndroid` - (Optional) Indicates whether users can use Android devices to access their WorkSpaces. +* `deviceTypeChromeos` - (Optional) Indicates whether users can use Chromebooks to access their WorkSpaces. +* `deviceTypeIos` - (Optional) Indicates whether users can use iOS devices to access their WorkSpaces. +* `deviceTypeLinux` - (Optional) Indicates whether users can use Linux clients to access their WorkSpaces. +* `deviceTypeOsx` - (Optional) Indicates whether users can use macOS clients to access their WorkSpaces. +* `deviceTypeWeb` - (Optional) Indicates whether users can access their WorkSpaces through a web browser. +* `deviceTypeWindows` - (Optional) Indicates whether users can use Windows clients to access their WorkSpaces. +* `deviceTypeZeroclient` - (Optional) Indicates whether users can use zero client devices to access their WorkSpaces. ### workspace_creation_properties -> **Note:** Once you specified `customSecurityGroupId` or `defaultOu`, there is no way to delete these attributes. If you cleanup them from the configuration, they still be present in state. -* `customSecurityGroupId` – (Optional) The identifier of your custom security group. Should relate to the same VPC, where workspaces reside in. -* `defaultOu` – (Optional) The default organizational unit (OU) for your WorkSpace directories. Should conform `"OU=,DC=,...,DC="` pattern. -* `enableInternetAccess` – (Optional) Indicates whether internet access is enabled for your WorkSpaces. -* `enableMaintenanceMode` – (Optional) Indicates whether maintenance mode is enabled for your WorkSpaces. Valid only if `workspace_type` is set to `PERSONAL`. -* `userEnabledAsLocalAdministrator` – (Optional) Indicates whether users are local administrators of their WorkSpaces. Valid only if `workspace_type` is set to `PERSONAL`. +* `customSecurityGroupId` - (Optional) The identifier of your custom security group. Should relate to the same VPC, where workspaces reside in. +* `defaultOu` - (Optional) The default organizational unit (OU) for your WorkSpace directories. Should conform `"OU=,DC=,...,DC="` pattern. +* `enableInternetAccess` - (Optional) Indicates whether internet access is enabled for your WorkSpaces. +* `enableMaintenanceMode` - (Optional) Indicates whether maintenance mode is enabled for your WorkSpaces. Valid only if `workspaceType` is set to `PERSONAL`. +* `userEnabledAsLocalAdministrator` - (Optional) Indicates whether users are local administrators of their WorkSpaces. Valid only if `workspaceType` is set to `PERSONAL`. ### active_directory_config --> **Note:** `active_directory_config` is only valid if `workspaces_type` is set to `POOLS`. +-> **Note:** `activeDirectoryConfig` is only valid if `workspaces_type` is set to `POOLS`. -* `domainName` – Fully qualified domain name of the AWS Directory Service directory. -* `service_account_secret_arn` – ARN of the Secrets Manager secret that contains the credentials for the service account. For more information, see [Service Account Details](https://docs.aws.amazon.com/workspaces/latest/adminguide/pools-service-account-details.html). +* `domainName` - Fully qualified domain name of the AWS Directory Service directory. +* `serviceAccountSecretArn` - ARN of the Secrets Manager secret that contains the credentials for the service account. For more information, see [Service Account Details](https://docs.aws.amazon.com/workspaces/latest/adminguide/pools-service-account-details.html). ## Attribute Reference @@ -361,4 +358,4 @@ Using `terraform import`, import Workspaces directory using the directory ID. Fo % terraform import aws_workspaces_directory.main d-4444444444 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/workspaces_ip_group.html.markdown b/website/docs/cdktf/typescript/r/workspaces_ip_group.html.markdown index 91e0bda8176c..98af26cf1164 100644 --- a/website/docs/cdktf/typescript/r/workspaces_ip_group.html.markdown +++ b/website/docs/cdktf/typescript/r/workspaces_ip_group.html.markdown @@ -53,10 +53,11 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `name` - (Required) The name of the IP group. * `description` - (Optional) The description of the IP group. * `rules` - (Optional) One or more pairs specifying the IP group rule (in CIDR format) from which web requests originate. -* `tags` – (Optional) A map of tags assigned to the WorkSpaces directory. If configured with a provider [`defaultTags` 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. +* `tags` - (Optional) A map of tags assigned to the WorkSpaces directory. If configured with a provider [`defaultTags` 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. ## Nested Blocks @@ -106,4 +107,4 @@ Using `terraform import`, import WorkSpaces IP groups using their GroupID. For e % terraform import aws_workspaces_ip_group.example wsipg-488lrtl3k ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/workspaces_workspace.html.markdown b/website/docs/cdktf/typescript/r/workspaces_workspace.html.markdown index 04e7440b2dd7..85ceb37aa557 100644 --- a/website/docs/cdktf/typescript/r/workspaces_workspace.html.markdown +++ b/website/docs/cdktf/typescript/r/workspaces_workspace.html.markdown @@ -67,22 +67,23 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `directoryId` - (Required) The ID of the directory for the WorkSpace. * `bundleId` - (Required) The ID of the bundle for the WorkSpace. -* `userName` – (Required) The user name of the user for the WorkSpace. This user name must exist in the directory for the WorkSpace. +* `userName` - (Required) The user name of the user for the WorkSpace. This user name must exist in the directory for the WorkSpace. * `rootVolumeEncryptionEnabled` - (Optional) Indicates whether the data stored on the root volume is encrypted. -* `userVolumeEncryptionEnabled` – (Optional) Indicates whether the data stored on the user volume is encrypted. -* `volumeEncryptionKey` – (Optional) The ARN of a symmetric AWS KMS customer master key (CMK) used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric CMKs. +* `userVolumeEncryptionEnabled` - (Optional) Indicates whether the data stored on the user volume is encrypted. +* `volumeEncryptionKey` - (Optional) The ARN of a symmetric AWS KMS customer master key (CMK) used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric CMKs. * `tags` - (Optional) The tags for the WorkSpace. If configured with a provider [`defaultTags` 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. -* `workspaceProperties` – (Optional) The WorkSpace properties. +* `workspaceProperties` - (Optional) The WorkSpace properties. `workspaceProperties` supports the following: -* `computeTypeName` – (Optional) The compute type. For more information, see [Amazon WorkSpaces Bundles](http://aws.amazon.com/workspaces/details/#Amazon_WorkSpaces_Bundles). Valid values are `VALUE`, `STANDARD`, `PERFORMANCE`, `POWER`, `GRAPHICS`, `POWERPRO`, `GRAPHICSPRO`, `GRAPHICS_G4DN`, and `GRAPHICSPRO_G4DN`. -* `rootVolumeSizeGib` – (Optional) The size of the root volume. -* `runningMode` – (Optional) The running mode. For more information, see [Manage the WorkSpace Running Mode](https://docs.aws.amazon.com/workspaces/latest/adminguide/running-mode.html). Valid values are `AUTO_STOP` and `ALWAYS_ON`. -* `runningModeAutoStopTimeoutInMinutes` – (Optional) The time after a user logs off when WorkSpaces are automatically stopped. Configured in 60-minute intervals. -* `userVolumeSizeGib` – (Optional) The size of the user storage. +* `computeTypeName` - (Optional) The compute type. For more information, see [Amazon WorkSpaces Bundles](http://aws.amazon.com/workspaces/details/#Amazon_WorkSpaces_Bundles). Valid values are `VALUE`, `STANDARD`, `PERFORMANCE`, `POWER`, `GRAPHICS`, `POWERPRO`, `GRAPHICSPRO`, `GRAPHICS_G4DN`, and `GRAPHICSPRO_G4DN`. +* `rootVolumeSizeGib` - (Optional) The size of the root volume. +* `runningMode` - (Optional) The running mode. For more information, see [Manage the WorkSpace Running Mode](https://docs.aws.amazon.com/workspaces/latest/adminguide/running-mode.html). Valid values are `AUTO_STOP` and `ALWAYS_ON`. +* `runningModeAutoStopTimeoutInMinutes` - (Optional) The time after a user logs off when WorkSpaces are automatically stopped. Configured in 60-minute intervals. +* `userVolumeSizeGib` - (Optional) The size of the user storage. ## Attribute Reference @@ -134,4 +135,4 @@ Using `terraform import`, import Workspaces using their ID. For example: % terraform import aws_workspaces_workspace.example ws-9z9zmbkhv ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/workspacesweb_browser_settings.html.markdown b/website/docs/cdktf/typescript/r/workspacesweb_browser_settings.html.markdown index 78c3f079e0c8..ff4ab8f216f3 100644 --- a/website/docs/cdktf/typescript/r/workspacesweb_browser_settings.html.markdown +++ b/website/docs/cdktf/typescript/r/workspacesweb_browser_settings.html.markdown @@ -97,6 +97,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `additionalEncryptionContext` - (Optional) Additional encryption context for the browser settings. * `customerManagedKey` - (Optional) ARN of the customer managed KMS key. * `tags` - (Optional) Map of tags assigned to the resource. If configured with a provider [`defaultTags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. @@ -141,4 +142,4 @@ Using `terraform import`, import WorkSpaces Web Browser Settings using the `brow % terraform import aws_workspacesweb_browser_settings.example arn:aws:workspacesweb:us-west-2:123456789012:browsersettings/abcdef12345 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/workspacesweb_browser_settings_association.html.markdown b/website/docs/cdktf/typescript/r/workspacesweb_browser_settings_association.html.markdown new file mode 100644 index 000000000000..86cccd9e828e --- /dev/null +++ b/website/docs/cdktf/typescript/r/workspacesweb_browser_settings_association.html.markdown @@ -0,0 +1,114 @@ +--- +subcategory: "WorkSpaces Web" +layout: "aws" +page_title: "AWS: aws_workspacesweb_browser_settings_association" +description: |- + Terraform resource for managing an AWS WorkSpaces Web Browser Settings Association. +--- + + + +# Resource: aws_workspacesweb_browser_settings_association + +Terraform resource for managing an AWS WorkSpaces Web Browser Settings Association. + +## Example Usage + +### Basic Usage + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { Fn, Token, TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { WorkspaceswebBrowserSettings } from "./.gen/providers/aws/workspacesweb-browser-settings"; +import { WorkspaceswebBrowserSettingsAssociation } from "./.gen/providers/aws/workspacesweb-browser-settings-association"; +import { WorkspaceswebPortal } from "./.gen/providers/aws/workspacesweb-portal"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + const example = new WorkspaceswebBrowserSettings(this, "example", { + browserPolicy: Token.asString( + Fn.jsonencode({ + chromePolicies: { + DefaultDownloadDirectory: { + value: "/home/as2-streaming-user/MyFiles/TemporaryFiles1", + }, + }, + }) + ), + }); + const awsWorkspaceswebPortalExample = new WorkspaceswebPortal( + this, + "example_1", + { + displayName: "example", + } + ); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + awsWorkspaceswebPortalExample.overrideLogicalId("example"); + const awsWorkspaceswebBrowserSettingsAssociationExample = + new WorkspaceswebBrowserSettingsAssociation(this, "example_2", { + browserSettingsArn: example.browserSettingsArn, + portalArn: Token.asString(awsWorkspaceswebPortalExample.portalArn), + }); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + awsWorkspaceswebBrowserSettingsAssociationExample.overrideLogicalId( + "example" + ); + } +} + +``` + +## Argument Reference + +The following arguments are required: + +* `browserSettingsArn` - (Required) ARN of the browser settings to associate with the portal. Forces replacement if changed. +* `portalArn` - (Required) ARN of the portal to associate with the browser settings. Forces replacement if changed. + +The following arguments are optional: + +* `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). + +## 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 WorkSpaces Web Browser Settings Association using the `browser_settings_arn,portal_arn`. For example: + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { WorkspaceswebBrowserSettingsAssociation } from "./.gen/providers/aws/workspacesweb-browser-settings-association"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + WorkspaceswebBrowserSettingsAssociation.generateConfigForImport( + this, + "example", + "arn:aws:workspaces-web:us-west-2:123456789012:browserSettings/browser_settings-id-12345678,arn:aws:workspaces-web:us-west-2:123456789012:portal/portal-id-12345678" + ); + } +} + +``` + +Using `terraform import`, import WorkSpaces Web Browser Settings Association using the `browser_settings_arn,portal_arn`. For example: + +```console +% terraform import aws_workspacesweb_browser_settings_association.example arn:aws:workspaces-web:us-west-2:123456789012:browserSettings/browser_settings-id-12345678,arn:aws:workspaces-web:us-west-2:123456789012:portal/portal-id-12345678 +``` + + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/workspacesweb_data_protection_settings.html.markdown b/website/docs/cdktf/typescript/r/workspacesweb_data_protection_settings.html.markdown index 75259faf786e..b368908ca319 100644 --- a/website/docs/cdktf/typescript/r/workspacesweb_data_protection_settings.html.markdown +++ b/website/docs/cdktf/typescript/r/workspacesweb_data_protection_settings.html.markdown @@ -24,12 +24,12 @@ import { TerraformStack } from "cdktf"; * Provider bindings are generated by running `cdktf get`. * See https://cdk.tf/provider-generation for more details. */ -import { WorkspaceswebDataProtectionSettings } from "./.gen/providers/aws/"; +import { WorkspaceswebDataProtectionSettings } from "./.gen/providers/aws/workspacesweb-data-protection-settings"; class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); new WorkspaceswebDataProtectionSettings(this, "example", { - display_name: "example", + displayName: "example", }); } } @@ -46,25 +46,25 @@ import { TerraformStack } from "cdktf"; * Provider bindings are generated by running `cdktf get`. * See https://cdk.tf/provider-generation for more details. */ -import { WorkspaceswebDataProtectionSettings } from "./.gen/providers/aws/"; +import { WorkspaceswebDataProtectionSettings } from "./.gen/providers/aws/workspacesweb-data-protection-settings"; class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); new WorkspaceswebDataProtectionSettings(this, "example", { description: "Example data protection settings", - display_name: "example", - inline_redaction_configuration: [ + displayName: "example", + inlineRedactionConfiguration: [ { - global_confidence_level: 2, - global_enforced_urls: ["https://example.com"], - inline_redaction_pattern: [ + globalConfidenceLevel: 2, + globalEnforcedUrls: ["https://example.com"], + inlineRedactionPattern: [ { - built_in_pattern_id: "ssn", - confidence_level: 3, - redaction_place_holder: [ + builtInPatternId: "ssn", + confidenceLevel: 3, + redactionPlaceHolder: [ { - redaction_place_holder_text: "REDACTED", - redaction_place_holder_type: "CustomText", + redactionPlaceHolderText: "REDACTED", + redactionPlaceHolderType: "CustomText", }, ], }, @@ -141,48 +141,49 @@ The following arguments are optional: * `additionalEncryptionContext` - (Optional) Additional encryption context for the data protection settings. * `customerManagedKey` - (Optional) ARN of the customer managed KMS key. * `description` - (Optional) The description of the data protection settings. -* `inline_redaction_configuration` - (Optional) The inline redaction configuration of the data protection settings. Detailed below. +* `inlineRedactionConfiguration` - (Optional) The inline redaction configuration of the data protection settings. Detailed below. +* `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). * `tags` - (Optional) Map of tags assigned to the resource. If configured with a provider [`defaultTags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. ### inline_redaction_configuration -* `global_confidence_level` - (Optional) The global confidence level for the inline redaction configuration. This indicates the certainty of data type matches in the redaction process. Values range from 1 (low confidence) to 3 (high confidence). -* `global_enforced_urls` - (Optional) The global enforced URL configuration for the inline redaction configuration. -* `global_exempt_urls` - (Optional) The global exempt URL configuration for the inline redaction configuration. -* `inline_redaction_pattern` - (Optional) The inline redaction patterns to be enabled for the inline redaction configuration. Detailed below. +* `globalConfidenceLevel` - (Optional) The global confidence level for the inline redaction configuration. This indicates the certainty of data type matches in the redaction process. Values range from 1 (low confidence) to 3 (high confidence). +* `globalEnforcedUrls` - (Optional) The global enforced URL configuration for the inline redaction configuration. +* `globalExemptUrls` - (Optional) The global exempt URL configuration for the inline redaction configuration. +* `inlineRedactionPattern` - (Optional) The inline redaction patterns to be enabled for the inline redaction configuration. Detailed below. ### inline_redaction_pattern -* `built_in_pattern_id` - (Optional) The built-in pattern from the list of preconfigured patterns. Either a `custom_pattern` or `built_in_pattern_id` is required. -* `confidence_level` - (Optional) The confidence level for inline redaction pattern. This indicates the certainty of data type matches in the redaction process. Values range from 1 (low confidence) to 3 (high confidence). -* `custom_pattern` - (Optional) The configuration for a custom pattern. Either a `custom_pattern` or `built_in_pattern_id` is required. Detailed below. -* `enforced_urls` - (Optional) The enforced URL configuration for the inline redaction pattern. -* `exempt_urls` - (Optional) The exempt URL configuration for the inline redaction pattern. -* `redaction_place_holder` - (Required) The redaction placeholder that will replace the redacted text in session. Detailed below. +* `builtInPatternId` - (Optional) The built-in pattern from the list of preconfigured patterns. Either a `customPattern` or `builtInPatternId` is required. +* `confidenceLevel` - (Optional) The confidence level for inline redaction pattern. This indicates the certainty of data type matches in the redaction process. Values range from 1 (low confidence) to 3 (high confidence). +* `customPattern` - (Optional) The configuration for a custom pattern. Either a `customPattern` or `builtInPatternId` is required. Detailed below. +* `enforcedUrls` - (Optional) The enforced URL configuration for the inline redaction pattern. +* `exemptUrls` - (Optional) The exempt URL configuration for the inline redaction pattern. +* `redactionPlaceHolder` - (Required) The redaction placeholder that will replace the redacted text in session. Detailed below. ### custom_pattern -* `pattern_name` - (Required) The pattern name for the custom pattern. -* `pattern_regex` - (Required) The pattern regex for the customer pattern. The format must follow JavaScript regex format. -* `keyword_regex` - (Optional) The keyword regex for the customer pattern. -* `pattern_description` - (Optional) The pattern description for the customer pattern. +* `patternName` - (Required) The pattern name for the custom pattern. +* `patternRegex` - (Required) The pattern regex for the customer pattern. The format must follow JavaScript regex format. +* `keywordRegex` - (Optional) The keyword regex for the customer pattern. +* `patternDescription` - (Optional) The pattern description for the customer pattern. ### redaction_place_holder -* `redaction_place_holder_type` - (Required) The redaction placeholder type that will replace the redacted text in session. Currently, only `CustomText` is supported. -* `redaction_place_holder_text` - (Optional) The redaction placeholder text that will replace the redacted text in session for the custom text redaction placeholder type. +* `redactionPlaceHolderType` - (Required) The redaction placeholder type that will replace the redacted text in session. Currently, only `CustomText` is supported. +* `redactionPlaceHolderText` - (Optional) The redaction placeholder text that will replace the redacted text in session for the custom text redaction placeholder type. ## Attribute Reference This resource exports the following attributes in addition to the arguments above: -* `data_protection_settings_arn` - ARN of the data protection settings resource. +* `dataProtectionSettingsArn` - ARN of the data protection settings resource. * `associatedPortalArns` - List of web portal ARNs that this data protection settings resource is associated with. * `tagsAll` - Map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block). ## Import -In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import WorkSpaces Web Data Protection Settings using the `data_protection_settings_arn`. For example: +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import WorkSpaces Web Data Protection Settings using the `dataProtectionSettingsArn`. For example: ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -192,7 +193,7 @@ import { TerraformStack } from "cdktf"; * Provider bindings are generated by running `cdktf get`. * See https://cdk.tf/provider-generation for more details. */ -import { WorkspaceswebDataProtectionSettings } from "./.gen/providers/aws/"; +import { WorkspaceswebDataProtectionSettings } from "./.gen/providers/aws/workspacesweb-data-protection-settings"; class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); @@ -206,10 +207,10 @@ class MyConvertedCode extends TerraformStack { ``` -Using `terraform import`, import WorkSpaces Web Data Protection Settings using the `data_protection_settings_arn`. For example: +Using `terraform import`, import WorkSpaces Web Data Protection Settings using the `dataProtectionSettingsArn`. For example: ```console % terraform import aws_workspacesweb_data_protection_settings.example arn:aws:workspaces-web:us-west-2:123456789012:dataprotectionsettings/abcdef12345 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/workspacesweb_data_protection_settings_association.html.markdown b/website/docs/cdktf/typescript/r/workspacesweb_data_protection_settings_association.html.markdown new file mode 100644 index 000000000000..5ad2f6955cf3 --- /dev/null +++ b/website/docs/cdktf/typescript/r/workspacesweb_data_protection_settings_association.html.markdown @@ -0,0 +1,100 @@ +--- +subcategory: "WorkSpaces Web" +layout: "aws" +page_title: "AWS: aws_workspacesweb_data_protection_settings_association" +description: |- + Terraform resource for managing an AWS WorkSpaces Web Data Protection Settings Association. +--- + + + +# Resource: aws_workspacesweb_data_protection_settings_association + +Terraform resource for managing an AWS WorkSpaces Web Data Protection Settings Association. + +## Example Usage + +### Basic Usage + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { Token, TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { WorkspaceswebDataProtectionSettings } from "./.gen/providers/aws/workspacesweb-data-protection-settings"; +import { WorkspaceswebDataProtectionSettingsAssociation } from "./.gen/providers/aws/workspacesweb-data-protection-settings-association"; +import { WorkspaceswebPortal } from "./.gen/providers/aws/workspacesweb-portal"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + const example = new WorkspaceswebDataProtectionSettings(this, "example", { + displayName: "example", + }); + const awsWorkspaceswebPortalExample = new WorkspaceswebPortal( + this, + "example_1", + { + displayName: "example", + } + ); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + awsWorkspaceswebPortalExample.overrideLogicalId("example"); + const awsWorkspaceswebDataProtectionSettingsAssociationExample = + new WorkspaceswebDataProtectionSettingsAssociation(this, "example_2", { + dataProtectionSettingsArn: example.dataProtectionSettingsArn, + portalArn: Token.asString(awsWorkspaceswebPortalExample.portalArn), + }); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + awsWorkspaceswebDataProtectionSettingsAssociationExample.overrideLogicalId( + "example" + ); + } +} + +``` + +## Argument Reference + +The following arguments are required: + +* `dataProtectionSettingsArn` - (Required) ARN of the data protection settings to associate with the portal. Forces replacement if changed. +* `portalArn` - (Required) ARN of the portal to associate with the data protection settings. Forces replacement if changed. + +The following arguments are optional: + +* `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). + +## 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 WorkSpaces Web Data Protection Settings Association using the `data_protection_settings_arn,portal_arn`. For example: + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { WorkspaceswebDataProtectionSettingsAssociation } from "./.gen/providers/aws/workspacesweb-data-protection-settings-association"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + WorkspaceswebDataProtectionSettingsAssociation.generateConfigForImport( + this, + "example", + "arn:aws:workspaces-web:us-west-2:123456789012:dataProtectionSettings/data_protection_settings-id-12345678,arn:aws:workspaces-web:us-west-2:123456789012:portal/portal-id-12345678" + ); + } +} + +``` + + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/workspacesweb_identity_provider.html.markdown b/website/docs/cdktf/typescript/r/workspacesweb_identity_provider.html.markdown new file mode 100644 index 000000000000..3553c1002637 --- /dev/null +++ b/website/docs/cdktf/typescript/r/workspacesweb_identity_provider.html.markdown @@ -0,0 +1,173 @@ +--- +subcategory: "WorkSpaces Web" +layout: "aws" +page_title: "AWS: aws_workspacesweb_identity_provider" +description: |- + Terraform resource for managing an AWS WorkSpaces Web Identity Provider. +--- + + + +# Resource: aws_workspacesweb_identity_provider + +Terraform resource for managing an AWS WorkSpaces Web Identity Provider. + +## Example Usage + +### Basic Usage with SAML + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { WorkspaceswebIdentityProvider } from "./.gen/providers/aws/workspacesweb-identity-provider"; +import { WorkspaceswebPortal } from "./.gen/providers/aws/workspacesweb-portal"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + const example = new WorkspaceswebPortal(this, "example", { + displayName: "example", + }); + const awsWorkspaceswebIdentityProviderExample = + new WorkspaceswebIdentityProvider(this, "example_1", { + identityProviderDetails: { + MetadataURL: "https://example.com/metadata", + }, + identityProviderName: "example-saml", + identityProviderType: "SAML", + portalArn: example.portalArn, + }); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + awsWorkspaceswebIdentityProviderExample.overrideLogicalId("example"); + } +} + +``` + +### OIDC Identity Provider + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { WorkspaceswebIdentityProvider } from "./.gen/providers/aws/workspacesweb-identity-provider"; +import { WorkspaceswebPortal } from "./.gen/providers/aws/workspacesweb-portal"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + const test = new WorkspaceswebPortal(this, "test", { + displayName: "test", + }); + const awsWorkspaceswebIdentityProviderTest = + new WorkspaceswebIdentityProvider(this, "test_1", { + identityProviderDetails: { + attributes_request_method: "POST", + authorize_scopes: "openid, email", + client_id: "test-client-id", + client_secret: "test-client-secret", + oidc_issuer: "https://accounts.google.com", + }, + identityProviderName: "test-updated", + identityProviderType: "OIDC", + portalArn: test.portalArn, + }); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + awsWorkspaceswebIdentityProviderTest.overrideLogicalId("test"); + } +} + +``` + +## Argument Reference + +The following arguments are required: + +* `identityProviderDetails` - (Required) Identity provider details. The following list describes the provider detail keys for each identity provider type: + * For Google and Login with Amazon: + * `clientId` + * `clientSecret` + * `authorize_scopes` + * For Facebook: + * `clientId` + * `clientSecret` + * `authorize_scopes` + * `apiVersion` + * For Sign in with Apple: + * `clientId` + * `teamId` + * `keyId` + * `privateKey` + * `authorize_scopes` + * For OIDC providers: + * `clientId` + * `clientSecret` + * `attributes_request_method` + * `oidc_issuer` + * `authorize_scopes` + * `authorize_url` if not available from discovery URL specified by `oidc_issuer` key + * `tokenUrl` if not available from discovery URL specified by `oidc_issuer` key + * `attributes_url` if not available from discovery URL specified by `oidc_issuer` key + * `jwksUri` if not available from discovery URL specified by `oidc_issuer` key + * For SAML providers: + * `MetadataFile` OR `MetadataURL` + * `IDPSignout` (boolean) optional + * `IDPInit` (boolean) optional + * `RequestSigningAlgorithm` (string) optional - Only accepts rsa-sha256 + * `EncryptedResponses` (boolean) optional +* `identityProviderName` - (Required) Identity provider name. +* `identityProviderType` - (Required) Identity provider type. Valid values: `SAML`, `Facebook`, `Google`, `LoginWithAmazon`, `SignInWithApple`, `OIDC`. +* `portalArn` - (Required) ARN of the web portal. Forces replacement if changed. + +The following arguments are optional: + +* `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). +* `tags` - (Optional) Map of tags to assign to the resource. If configured with a provider [`defaultTags` 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. + +## Attribute Reference + +This resource exports the following attributes in addition to the arguments above: + +* `identityProviderArn` - ARN of the identity provider. +* `tagsAll` - Map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). + +## Import + +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import WorkSpaces Web Identity Provider using the `identityProviderArn`. For example: + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { WorkspaceswebIdentityProvider } from "./.gen/providers/aws/workspacesweb-identity-provider"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + WorkspaceswebIdentityProvider.generateConfigForImport( + this, + "example", + "arn:aws:workspaces-web:us-west-2:123456789012:identityprovider/abcdef12345678/12345678-1234-1234-1234-123456789012" + ); + } +} + +``` + +Using `terraform import`, import WorkSpaces Web Identity Provider using the `identityProviderArn`. For example: + +```console +% terraform import aws_workspacesweb_identity_provider.example arn:aws:workspaces-web:us-west-2:123456789012:identityprovider/abcdef12345678/12345678-1234-1234-1234-123456789012 +``` + + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/workspacesweb_ip_access_settings.html.markdown b/website/docs/cdktf/typescript/r/workspacesweb_ip_access_settings.html.markdown index b07fe90c4623..04368fd4ed62 100644 --- a/website/docs/cdktf/typescript/r/workspacesweb_ip_access_settings.html.markdown +++ b/website/docs/cdktf/typescript/r/workspacesweb_ip_access_settings.html.markdown @@ -24,15 +24,15 @@ import { TerraformStack } from "cdktf"; * Provider bindings are generated by running `cdktf get`. * See https://cdk.tf/provider-generation for more details. */ -import { WorkspaceswebIpAccessSettings } from "./.gen/providers/aws/"; +import { WorkspaceswebIpAccessSettings } from "./.gen/providers/aws/workspacesweb-ip-access-settings"; class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); new WorkspaceswebIpAccessSettings(this, "example", { - display_name: "example", - ip_rule: [ + displayName: "example", + ipRule: [ { - ip_range: "10.0.0.0/16", + ipRange: "10.0.0.0/16", }, ], }); @@ -51,21 +51,21 @@ import { TerraformStack } from "cdktf"; * Provider bindings are generated by running `cdktf get`. * See https://cdk.tf/provider-generation for more details. */ -import { WorkspaceswebIpAccessSettings } from "./.gen/providers/aws/"; +import { WorkspaceswebIpAccessSettings } from "./.gen/providers/aws/workspacesweb-ip-access-settings"; class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); new WorkspaceswebIpAccessSettings(this, "example", { description: "Example IP access settings", - display_name: "example", - ip_rule: [ + displayName: "example", + ipRule: [ { description: "Main office", - ip_range: "10.0.0.0/16", + ipRange: "10.0.0.0/16", }, { description: "Branch office", - ip_range: "192.168.0.0/24", + ipRange: "192.168.0.0/24", }, ], }); @@ -84,8 +84,8 @@ import { TerraformStack } from "cdktf"; * Provider bindings are generated by running `cdktf get`. * See https://cdk.tf/provider-generation for more details. */ -import { WorkspaceswebIpAccessSettings } from "./.gen/providers/aws/"; import { KmsKey } from "./.gen/providers/aws/kms-key"; +import { WorkspaceswebIpAccessSettings } from "./.gen/providers/aws/workspacesweb-ip-access-settings"; class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); @@ -95,22 +95,20 @@ class MyConvertedCode extends TerraformStack { }); const awsWorkspaceswebIpAccessSettingsExample = new WorkspaceswebIpAccessSettings(this, "example_1", { - additional_encryption_context: [ - { - Environment: "Production", - }, - ], - customer_managed_key: example.arn, + additionalEncryptionContext: { + Environment: "Production", + }, + customerManagedKey: example.arn, description: "Example IP access settings", - display_name: "example", - ip_rule: [ + displayName: "example", + ipRule: [ { description: "Main office", - ip_range: "10.0.0.0/16", + ipRange: "10.0.0.0/16", }, { description: "Branch office", - ip_range: "192.168.0.0/24", + ipRange: "192.168.0.0/24", }, ], tags: { @@ -129,13 +127,14 @@ class MyConvertedCode extends TerraformStack { The following arguments are required: * `displayName` - (Required) The display name of the IP access settings. -* `ip_rule` - (Required) The IP rules of the IP access settings. See [IP Rule](#ip-rules) below. +* `ipRule` - (Required) The IP rules of the IP access settings. See [IP Rule](#ip-rules) below. The following arguments are optional: * `additionalEncryptionContext` - (Optional) Additional encryption context for the IP access settings. * `customerManagedKey` - (Optional) ARN of the customer managed KMS key. * `description` - (Optional) The description of the IP access settings. +* `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). * `tags` - (Optional) Map of tags assigned to the resource. If configured with a provider [`defaultTags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. ### IP Rules @@ -148,12 +147,12 @@ The following arguments are optional: This resource exports the following attributes in addition to the arguments above: * `associatedPortalArns` - List of web portal ARNs that this IP access settings resource is associated with. -* `ip_access_settings_arn` - ARN of the IP access settings resource. +* `ipAccessSettingsArn` - ARN of the IP access settings resource. * `tagsAll` - Map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block). ## Import -In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import WorkSpaces Web IP Access Settings using the `ip_access_settings_arn`. For example: +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import WorkSpaces Web IP Access Settings using the `ipAccessSettingsArn`. For example: ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -163,7 +162,7 @@ import { TerraformStack } from "cdktf"; * Provider bindings are generated by running `cdktf get`. * See https://cdk.tf/provider-generation for more details. */ -import { WorkspaceswebIpAccessSettings } from "./.gen/providers/aws/"; +import { WorkspaceswebIpAccessSettings } from "./.gen/providers/aws/workspacesweb-ip-access-settings"; class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); @@ -177,10 +176,10 @@ class MyConvertedCode extends TerraformStack { ``` -Using `terraform import`, import WorkSpaces Web IP Access Settings using the `ip_access_settings_arn`. For example: +Using `terraform import`, import WorkSpaces Web IP Access Settings using the `ipAccessSettingsArn`. For example: ```console % terraform import aws_workspacesweb_ip_access_settings.example arn:aws:workspaces-web:us-west-2:123456789012:ipAccessSettings/abcdef12345 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/workspacesweb_ip_access_settings_association.html.markdown b/website/docs/cdktf/typescript/r/workspacesweb_ip_access_settings_association.html.markdown new file mode 100644 index 000000000000..5e97cc87f4dd --- /dev/null +++ b/website/docs/cdktf/typescript/r/workspacesweb_ip_access_settings_association.html.markdown @@ -0,0 +1,105 @@ +--- +subcategory: "WorkSpaces Web" +layout: "aws" +page_title: "AWS: aws_workspacesweb_ip_access_settings_association" +description: |- + Terraform resource for managing an AWS WorkSpaces Web IP Access Settings Association. +--- + + + +# Resource: aws_workspacesweb_ip_access_settings_association + +Terraform resource for managing an AWS WorkSpaces Web IP Access Settings Association. + +## Example Usage + +### Basic Usage + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { Token, TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { WorkspaceswebIpAccessSettings } from "./.gen/providers/aws/workspacesweb-ip-access-settings"; +import { WorkspaceswebIpAccessSettingsAssociation } from "./.gen/providers/aws/workspacesweb-ip-access-settings-association"; +import { WorkspaceswebPortal } from "./.gen/providers/aws/workspacesweb-portal"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + const example = new WorkspaceswebIpAccessSettings(this, "example", { + displayName: "example", + ipRule: [ + { + ipRange: "10.0.0.0/16", + }, + ], + }); + const awsWorkspaceswebPortalExample = new WorkspaceswebPortal( + this, + "example_1", + { + displayName: "example", + } + ); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + awsWorkspaceswebPortalExample.overrideLogicalId("example"); + const awsWorkspaceswebIpAccessSettingsAssociationExample = + new WorkspaceswebIpAccessSettingsAssociation(this, "example_2", { + ipAccessSettingsArn: example.ipAccessSettingsArn, + portalArn: Token.asString(awsWorkspaceswebPortalExample.portalArn), + }); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + awsWorkspaceswebIpAccessSettingsAssociationExample.overrideLogicalId( + "example" + ); + } +} + +``` + +## Argument Reference + +The following arguments are required: + +* `ipAccessSettingsArn` - (Required) ARN of the IP access settings to associate with the portal. Forces replacement if changed. +* `portalArn` - (Required) ARN of the portal to associate with the IP access settings. Forces replacement if changed. + +The following arguments are optional: + +* `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). + +## 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 WorkSpaces Web IP Access Settings Association using the `ip_access_settings_arn,portal_arn`. For example: + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { WorkspaceswebIpAccessSettingsAssociation } from "./.gen/providers/aws/workspacesweb-ip-access-settings-association"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + WorkspaceswebIpAccessSettingsAssociation.generateConfigForImport( + this, + "example", + "arn:aws:workspaces-web:us-west-2:123456789012:ipAccessSettings/ip_access_settings-id-12345678,arn:aws:workspaces-web:us-west-2:123456789012:portal/portal-id-12345678" + ); + } +} + +``` + + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/workspacesweb_network_settings.html.markdown b/website/docs/cdktf/typescript/r/workspacesweb_network_settings.html.markdown index 728e5d6ad8fb..09ca55066503 100644 --- a/website/docs/cdktf/typescript/r/workspacesweb_network_settings.html.markdown +++ b/website/docs/cdktf/typescript/r/workspacesweb_network_settings.html.markdown @@ -90,6 +90,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `tags` - (Optional) Map of tags assigned to the resource. If configured with a provider [`defaultTags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. ## Attribute Reference @@ -132,4 +133,4 @@ Using `terraform import`, import WorkSpaces Web Network Settings using the `netw % terraform import aws_workspacesweb_network_settings.example arn:aws:workspacesweb:us-west-2:123456789012:networksettings/abcdef12345 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/workspacesweb_network_settings_association.html.markdown b/website/docs/cdktf/typescript/r/workspacesweb_network_settings_association.html.markdown new file mode 100644 index 000000000000..eab09affcb23 --- /dev/null +++ b/website/docs/cdktf/typescript/r/workspacesweb_network_settings_association.html.markdown @@ -0,0 +1,171 @@ +--- +subcategory: "WorkSpaces Web" +layout: "aws" +page_title: "AWS: aws_workspacesweb_network_settings_association" +description: |- + Terraform resource for managing an AWS WorkSpaces Web Network Settings Association. +--- + + + +# Resource: aws_workspacesweb_network_settings_association + +Terraform resource for managing an AWS WorkSpaces Web Network Settings Association. + +## Example Usage + +### Basic Usage + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { Token, TerraformCount, Fn, TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { DataAwsAvailabilityZones } from "./.gen/providers/aws/data-aws-availability-zones"; +import { SecurityGroup } from "./.gen/providers/aws/security-group"; +import { Subnet } from "./.gen/providers/aws/subnet"; +import { Vpc } from "./.gen/providers/aws/vpc"; +import { WorkspaceswebNetworkSettings } from "./.gen/providers/aws/workspacesweb-network-settings"; +import { WorkspaceswebNetworkSettingsAssociation } from "./.gen/providers/aws/workspacesweb-network-settings-association"; +import { WorkspaceswebPortal } from "./.gen/providers/aws/workspacesweb-portal"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + const example = new Vpc(this, "example", { + cidrBlock: "10.0.0.0/16", + tags: { + Name: "example", + }, + }); + const awsWorkspaceswebPortalExample = new WorkspaceswebPortal( + this, + "example_1", + { + displayName: "example", + } + ); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + awsWorkspaceswebPortalExample.overrideLogicalId("example"); + const available = new DataAwsAvailabilityZones(this, "available", { + filter: [ + { + name: "opt-in-status", + values: ["opt-in-not-required"], + }, + ], + state: "available", + }); + /*In most cases loops should be handled in the programming language context and + not inside of the Terraform context. If you are looping over something external, e.g. a variable or a file input + you should consider using a for loop. If you are looping over something only known to Terraform, e.g. a result of a data source + you need to keep this like it is.*/ + const exampleCount = TerraformCount.of(Token.asNumber("2")); + const awsSecurityGroupExample = new SecurityGroup(this, "example_3", { + name: "example-${" + exampleCount.index + "}", + tags: { + Name: "example", + }, + vpcId: example.id, + count: exampleCount, + }); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + awsSecurityGroupExample.overrideLogicalId("example"); + /*In most cases loops should be handled in the programming language context and + not inside of the Terraform context. If you are looping over something external, e.g. a variable or a file input + you should consider using a for loop. If you are looping over something only known to Terraform, e.g. a result of a data source + you need to keep this like it is.*/ + const awsSubnetExampleCount = TerraformCount.of(Token.asNumber("2")); + const awsSubnetExample = new Subnet(this, "example_4", { + availabilityZone: Token.asString( + Fn.lookupNested(available.names, [awsSubnetExampleCount.index]) + ), + cidrBlock: Token.asString( + Fn.cidrsubnet( + example.cidrBlock, + 8, + Token.asNumber(awsSubnetExampleCount.index) + ) + ), + tags: { + Name: "example", + }, + vpcId: example.id, + count: awsSubnetExampleCount, + }); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + awsSubnetExample.overrideLogicalId("example"); + const awsWorkspaceswebNetworkSettingsExample = + new WorkspaceswebNetworkSettings(this, "example_5", { + securityGroupIds: [ + Token.asString(Fn.lookupNested(awsSecurityGroupExample, ["0", "id"])), + Token.asString(Fn.lookupNested(awsSecurityGroupExample, ["1", "id"])), + ], + subnetIds: [ + Token.asString(Fn.lookupNested(awsSubnetExample, ["0", "id"])), + Token.asString(Fn.lookupNested(awsSubnetExample, ["1", "id"])), + ], + vpcId: example.id, + }); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + awsWorkspaceswebNetworkSettingsExample.overrideLogicalId("example"); + const awsWorkspaceswebNetworkSettingsAssociationExample = + new WorkspaceswebNetworkSettingsAssociation(this, "example_6", { + networkSettingsArn: Token.asString( + awsWorkspaceswebNetworkSettingsExample.networkSettingsArn + ), + portalArn: Token.asString(awsWorkspaceswebPortalExample.portalArn), + }); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + awsWorkspaceswebNetworkSettingsAssociationExample.overrideLogicalId( + "example" + ); + } +} + +``` + +## Argument Reference + +The following arguments are required: + +* `networkSettingsArn` - (Required) ARN of the network settings to associate with the portal. Forces replacement if changed. +* `portalArn` - (Required) ARN of the portal to associate with the network settings. Forces replacement if changed. + +The following arguments are optional: + +* `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). + +## 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 WorkSpaces Web Network Settings Association using the `network_settings_arn,portal_arn`. For example: + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { WorkspaceswebNetworkSettingsAssociation } from "./.gen/providers/aws/workspacesweb-network-settings-association"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + WorkspaceswebNetworkSettingsAssociation.generateConfigForImport( + this, + "example", + "arn:aws:workspaces-web:us-west-2:123456789012:networkSettings/network_settings-id-12345678,arn:aws:workspaces-web:us-west-2:123456789012:portal/portal-id-12345678" + ); + } +} + +``` + + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/workspacesweb_portal.html.markdown b/website/docs/cdktf/typescript/r/workspacesweb_portal.html.markdown new file mode 100644 index 000000000000..3a6d45d94ef2 --- /dev/null +++ b/website/docs/cdktf/typescript/r/workspacesweb_portal.html.markdown @@ -0,0 +1,164 @@ +--- +subcategory: "WorkSpaces Web" +layout: "aws" +page_title: "AWS: aws_workspacesweb_portal" +description: |- + Terraform resource for managing an AWS WorkSpaces Web Portal. +--- + + + +# Resource: aws_workspacesweb_portal + +Terraform resource for managing an AWS WorkSpaces Web Portal. + +## Example Usage + +### Basic Usage + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { WorkspaceswebPortal } from "./.gen/providers/aws/workspacesweb-portal"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + new WorkspaceswebPortal(this, "example", { + displayName: "example-portal", + instanceType: "standard.regular", + }); + } +} + +``` + +### Complete Usage + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { KmsKey } from "./.gen/providers/aws/kms-key"; +import { WorkspaceswebPortal } from "./.gen/providers/aws/workspacesweb-portal"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + const example = new KmsKey(this, "example", { + deletionWindowInDays: 7, + description: "KMS key for WorkSpaces Web Portal", + }); + const awsWorkspaceswebPortalExample = new WorkspaceswebPortal( + this, + "example_1", + { + additionalEncryptionContext: { + Environment: "Production", + }, + authenticationType: "IAM_Identity_Center", + customerManagedKey: example.arn, + displayName: "example-portal", + instanceType: "standard.large", + maxConcurrentSessions: 10, + tags: { + Name: "example-portal", + }, + timeouts: [ + { + create: "10m", + delete: "10m", + update: "10m", + }, + ], + } + ); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + awsWorkspaceswebPortalExample.overrideLogicalId("example"); + } +} + +``` + +## Argument Reference + +The following arguments are optional: + +* `additionalEncryptionContext` - (Optional) Additional encryption context for the customer managed key. Forces replacement if changed. +* `authenticationType` - (Optional) Authentication type for the portal. Valid values: `Standard`, `IAM_Identity_Center`. +* `browserSettingsArn` - (Optional) ARN of the browser settings to use for the portal. +* `customerManagedKey` - (Optional) ARN of the customer managed key. Forces replacement if changed. +* `displayName` - (Optional) Display name of the portal. +* `instanceType` - (Optional) Instance type for the portal. Valid values: `standard.regular`, `standard.large`. +* `maxConcurrentSessions` - (Optional) Maximum number of concurrent sessions for the portal. +* `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). +* `tags` - (Optional) Key-value map of resource tags. If configured with a provider [`defaultTags` 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. + +## Attribute Reference + +This resource exports the following attributes in addition to the arguments above: + +* `browserType` - Browser type of the portal. +* `creationDate` - Creation date of the portal. +* `dataProtectionSettingsArn` - ARN of the data protection settings associated with the portal. +* `ipAccessSettingsArn` - ARN of the IP access settings associated with the portal. +* `networkSettingsArn` - ARN of the network settings associated with the portal. +* `portalArn` - ARN of the portal. +* `portalEndpoint` - Endpoint URL of the portal. +* `portalStatus` - Status of the portal. +* `rendererType` - Renderer type of the portal. +* `sessionLoggerArn` - ARN of the session logger associated with the portal. +* `statusReason` - Reason for the current status of the portal. +* `tagsAll` - Map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). +* `trustStoreArn` - ARN of the trust store associated with the portal. +* `userAccessLoggingSettingsArn` - ARN of the user access logging settings associated with the portal. +* `userSettingsArn` - ARN of the user settings associated with the portal. + +## Timeouts + +[Configuration options](https://developer.hashicorp.com/terraform/language/resources/syntax#operation-timeouts): + +* `create` - (Default `5m`) +* `update` - (Default `5m`) +* `delete` - (Default `5m`) + +## Import + +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import WorkSpaces Web Portal using the `portalArn`. For example: + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { WorkspaceswebPortal } from "./.gen/providers/aws/workspacesweb-portal"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + WorkspaceswebPortal.generateConfigForImport( + this, + "example", + "arn:aws:workspaces-web:us-west-2:123456789012:portal/abcdef12345678" + ); + } +} + +``` + +Using `terraform import`, import WorkSpaces Web Portal using the `portalArn`. For example: + +```console +% terraform import aws_workspacesweb_portal.example arn:aws:workspaces-web:us-west-2:123456789012:portal/abcdef12345678 +``` + + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/workspacesweb_session_logger.html.markdown b/website/docs/cdktf/typescript/r/workspacesweb_session_logger.html.markdown new file mode 100644 index 000000000000..3e3e182279c8 --- /dev/null +++ b/website/docs/cdktf/typescript/r/workspacesweb_session_logger.html.markdown @@ -0,0 +1,309 @@ +--- +subcategory: "WorkSpaces Web" +layout: "aws" +page_title: "AWS: aws_workspacesweb_session_logger" +description: |- + Terraform resource for managing an AWS WorkSpaces Web Session Logger. +--- + + + +# Resource: aws_workspacesweb_session_logger + +Terraform resource for managing an AWS WorkSpaces Web Session Logger. + +## Example Usage + +### Basic Usage + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { Token, TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { DataAwsIamPolicyDocument } from "./.gen/providers/aws/data-aws-iam-policy-document"; +import { S3Bucket } from "./.gen/providers/aws/s3-bucket"; +import { S3BucketPolicy } from "./.gen/providers/aws/s3-bucket-policy"; +import { WorkspaceswebSessionLogger } from "./.gen/providers/aws/workspacesweb-session-logger"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + const example = new S3Bucket(this, "example", { + bucket: "example-session-logs", + }); + const dataAwsIamPolicyDocumentExample = new DataAwsIamPolicyDocument( + this, + "example_1", + { + statement: [ + { + actions: ["s3:PutObject"], + effect: "Allow", + principals: [ + { + identifiers: ["workspaces-web.amazonaws.com"], + type: "Service", + }, + ], + resources: ["${" + 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.*/ + dataAwsIamPolicyDocumentExample.overrideLogicalId("example"); + const awsS3BucketPolicyExample = new S3BucketPolicy(this, "example_2", { + bucket: example.id, + policy: Token.asString(dataAwsIamPolicyDocumentExample.json), + }); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + awsS3BucketPolicyExample.overrideLogicalId("example"); + const awsWorkspaceswebSessionLoggerExample = new WorkspaceswebSessionLogger( + this, + "example_3", + { + dependsOn: [awsS3BucketPolicyExample], + displayName: "example-session-logger", + eventFilter: [ + { + all: [{}], + }, + ], + logConfiguration: [ + { + s3: [ + { + bucket: example.id, + folderStructure: "Flat", + logFileFormat: "Json", + }, + ], + }, + ], + } + ); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + awsWorkspaceswebSessionLoggerExample.overrideLogicalId("example"); + } +} + +``` + +### Complete Configuration with KMS Encryption + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { Token, TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { DataAwsCallerIdentity } from "./.gen/providers/aws/data-aws-caller-identity"; +import { DataAwsIamPolicyDocument } from "./.gen/providers/aws/data-aws-iam-policy-document"; +import { DataAwsPartition } from "./.gen/providers/aws/data-aws-partition"; +import { KmsKey } from "./.gen/providers/aws/kms-key"; +import { S3Bucket } from "./.gen/providers/aws/s3-bucket"; +import { S3BucketPolicy } from "./.gen/providers/aws/s3-bucket-policy"; +import { WorkspaceswebSessionLogger } from "./.gen/providers/aws/workspacesweb-session-logger"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + const example = new S3Bucket(this, "example", { + bucket: "example-session-logs", + forceDestroy: true, + }); + const current = new DataAwsCallerIdentity(this, "current", {}); + const dataAwsIamPolicyDocumentExample = new DataAwsIamPolicyDocument( + this, + "example_2", + { + statement: [ + { + actions: ["s3:PutObject"], + effect: "Allow", + principals: [ + { + identifiers: ["workspaces-web.amazonaws.com"], + type: "Service", + }, + ], + resources: [example.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.*/ + dataAwsIamPolicyDocumentExample.overrideLogicalId("example"); + const dataAwsPartitionCurrent = new DataAwsPartition(this, "current_3", {}); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + dataAwsPartitionCurrent.overrideLogicalId("current"); + const awsS3BucketPolicyExample = new S3BucketPolicy(this, "example_4", { + bucket: example.id, + policy: Token.asString(dataAwsIamPolicyDocumentExample.json), + }); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + awsS3BucketPolicyExample.overrideLogicalId("example"); + const kmsKeyPolicy = new DataAwsIamPolicyDocument(this, "kms_key_policy", { + statement: [ + { + actions: ["kms:*"], + principals: [ + { + identifiers: [ + "arn:${" + + dataAwsPartitionCurrent.partition + + "}:iam::${" + + current.accountId + + "}:root", + ], + type: "AWS", + }, + ], + resources: ["*"], + }, + { + actions: [ + "kms:Encrypt", + "kms:GenerateDataKey*", + "kms:ReEncrypt*", + "kms:Decrypt", + ], + principals: [ + { + identifiers: ["workspaces-web.amazonaws.com"], + type: "Service", + }, + ], + resources: ["*"], + }, + ], + }); + const awsKmsKeyExample = new KmsKey(this, "example_6", { + description: "KMS key for WorkSpaces Web Session Logger", + policy: Token.asString(kmsKeyPolicy.json), + }); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + awsKmsKeyExample.overrideLogicalId("example"); + const awsWorkspaceswebSessionLoggerExample = new WorkspaceswebSessionLogger( + this, + "example_7", + { + additionalEncryptionContext: { + Application: "WorkSpacesWeb", + Environment: "Production", + }, + customerManagedKey: Token.asString(awsKmsKeyExample.arn), + dependsOn: [awsS3BucketPolicyExample, awsKmsKeyExample], + displayName: "example-session-logger", + eventFilter: [ + { + include: ["SessionStart", "SessionEnd"], + }, + ], + logConfiguration: [ + { + s3: [ + { + bucket: example.id, + bucketOwner: Token.asString(current.accountId), + folderStructure: "NestedByDate", + keyPrefix: "workspaces-web-logs/", + logFileFormat: "JsonLines", + }, + ], + }, + ], + tags: { + Environment: "Production", + Name: "example-session-logger", + }, + } + ); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + awsWorkspaceswebSessionLoggerExample.overrideLogicalId("example"); + } +} + +``` + +## Argument Reference + +The following arguments are required: + +* `eventFilter` - (Required) Event filter that determines which events are logged. See [Event Filter](#event-filter) below. +* `logConfiguration` - (Required) Configuration block for specifying where logs are delivered. See [Log Configuration](#log-configuration) below. + +The following arguments are optional: + +* `additionalEncryptionContext` - (Optional) Map of additional encryption context key-value pairs. +* `customerManagedKey` - (Optional) ARN of the customer managed KMS key used to encrypt sensitive information. +* `displayName` - (Optional) Human-readable display name for the session logger resource. Forces replacement if changed. +* `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). +* `tags` - (Optional) Map of tags to assign to the resource. If configured with a provider [`defaultTags` 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. + +### Log Configuration + +* `s3` - (Required) Configuration block for S3 log delivery. See [S3 Configuration](#s3-configuration) below. + +### Event Filter + +Exactly one of the following must be specified: + +* `all` - (Optional) Block that specifies to monitor all events. Set to `{}` to monitor all events. +* `include` - (Optional) List of specific events to monitor. Valid values include session events like `SessionStart`, `SessionEnd`, etc. + +### S3 Configuration + +* `bucket` - (Required) S3 bucket name where logs are delivered. +* `folderStructure` - (Required) Folder structure that defines the organizational structure for log files in S3. Valid values: `FlatStructure`, `DateBasedStructure`. +* `logFileFormat` - (Required) Format of the log file written to S3. Valid values: `Json`, `Parquet`. +* `bucketOwner` - (Optional) Expected bucket owner of the target S3 bucket. +* `keyPrefix` - (Optional) S3 path prefix that determines where log files are stored. + +## Attribute Reference + +This resource exports the following attributes in addition to the arguments above: + +* `associatedPortalArns` - List of ARNs of the web portals associated with the session logger. +* `sessionLoggerArn` - ARN of the session logger. +* `tagsAll` - Map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). + +~> **Note:** The `additionalEncryptionContext` and `customerManagedKey` attributes are computed when not specified and will be populated with values from the AWS API response. + +## Import + +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import WorkSpaces Web Session Logger using the `sessionLoggerArn`. For example: + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { WorkspaceswebSessionLogger } from "./.gen/providers/aws/workspacesweb-session-logger"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + WorkspaceswebSessionLogger.generateConfigForImport( + this, + "example", + "arn:aws:workspaces-web:us-west-2:123456789012:sessionLogger/session_logger-id-12345678" + ); + } +} + +``` + +Using `terraform import`, import WorkSpaces Web Session Logger using the `sessionLoggerArn`. For example: + +```console +% terraform import aws_workspacesweb_session_logger.example arn:aws:workspaces-web:us-west-2:123456789012:sessionLogger/session_logger-id-12345678 +``` + + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/workspacesweb_session_logger_association.html.markdown b/website/docs/cdktf/typescript/r/workspacesweb_session_logger_association.html.markdown new file mode 100644 index 000000000000..6b8d467ef3a4 --- /dev/null +++ b/website/docs/cdktf/typescript/r/workspacesweb_session_logger_association.html.markdown @@ -0,0 +1,165 @@ +--- +subcategory: "WorkSpaces Web" +layout: "aws" +page_title: "AWS: aws_workspacesweb_session_logger_association" +description: |- + Terraform resource for managing an AWS WorkSpaces Web Session Logger Association. +--- + + + +# Resource: aws_workspacesweb_session_logger_association + +Terraform resource for managing an AWS WorkSpaces Web Session Logger Association. + +## Example Usage + +### Basic Usage + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { Token, TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { DataAwsIamPolicyDocument } from "./.gen/providers/aws/data-aws-iam-policy-document"; +import { S3Bucket } from "./.gen/providers/aws/s3-bucket"; +import { S3BucketPolicy } from "./.gen/providers/aws/s3-bucket-policy"; +import { WorkspaceswebPortal } from "./.gen/providers/aws/workspacesweb-portal"; +import { WorkspaceswebSessionLogger } from "./.gen/providers/aws/workspacesweb-session-logger"; +import { WorkspaceswebSessionLoggerAssociation } from "./.gen/providers/aws/workspacesweb-session-logger-association"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + const example = new S3Bucket(this, "example", { + bucket: "example-session-logs", + forceDestroy: true, + }); + const awsWorkspaceswebPortalExample = new WorkspaceswebPortal( + this, + "example_1", + { + displayName: "example", + } + ); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + awsWorkspaceswebPortalExample.overrideLogicalId("example"); + const dataAwsIamPolicyDocumentExample = new DataAwsIamPolicyDocument( + this, + "example_2", + { + statement: [ + { + actions: ["s3:PutObject"], + effect: "Allow", + principals: [ + { + identifiers: ["workspaces-web.amazonaws.com"], + type: "Service", + }, + ], + resources: ["${" + 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.*/ + dataAwsIamPolicyDocumentExample.overrideLogicalId("example"); + const awsS3BucketPolicyExample = new S3BucketPolicy(this, "example_3", { + bucket: example.id, + policy: Token.asString(dataAwsIamPolicyDocumentExample.json), + }); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + awsS3BucketPolicyExample.overrideLogicalId("example"); + const awsWorkspaceswebSessionLoggerExample = new WorkspaceswebSessionLogger( + this, + "example_4", + { + dependsOn: [awsS3BucketPolicyExample], + displayName: "example", + eventFilter: [ + { + all: [{}], + }, + ], + logConfiguration: [ + { + s3: [ + { + bucket: example.id, + folderStructure: "Flat", + logFileFormat: "Json", + }, + ], + }, + ], + } + ); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + awsWorkspaceswebSessionLoggerExample.overrideLogicalId("example"); + const awsWorkspaceswebSessionLoggerAssociationExample = + new WorkspaceswebSessionLoggerAssociation(this, "example_5", { + portalArn: Token.asString(awsWorkspaceswebPortalExample.portalArn), + sessionLoggerArn: Token.asString( + awsWorkspaceswebSessionLoggerExample.sessionLoggerArn + ), + }); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + awsWorkspaceswebSessionLoggerAssociationExample.overrideLogicalId( + "example" + ); + } +} + +``` + +## Argument Reference + +The following arguments are required: + +* `portalArn` - (Required) ARN of the web portal. +* `sessionLoggerArn` - (Required) ARN of the session logger. + +The following arguments are optional: + +* `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). + +## 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 WorkSpaces Web Session Logger Association using the `session_logger_arn,portal_arn`. For example: + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { WorkspaceswebSessionLoggerAssociation } from "./.gen/providers/aws/workspacesweb-session-logger-association"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + WorkspaceswebSessionLoggerAssociation.generateConfigForImport( + this, + "example", + "arn:aws:workspaces-web:us-west-2:123456789012:sessionLogger/session_logger-id-12345678,arn:aws:workspaces-web:us-west-2:123456789012:portal/portal-id-12345678" + ); + } +} + +``` + +Using `terraform import`, import WorkSpaces Web Session Logger Association using the `session_logger_arn,portal_arn`. For example: + +```console +% terraform import aws_workspacesweb_session_logger_association.example arn:aws:workspaces-web:us-west-2:123456789012:sessionLogger/session_logger-id-12345678,arn:aws:workspaces-web:us-west-2:123456789012:portal/portal-id-12345678 +``` + + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/workspacesweb_trust_store.html.markdown b/website/docs/cdktf/typescript/r/workspacesweb_trust_store.html.markdown new file mode 100644 index 000000000000..517b7f0a959f --- /dev/null +++ b/website/docs/cdktf/typescript/r/workspacesweb_trust_store.html.markdown @@ -0,0 +1,135 @@ +--- +subcategory: "WorkSpaces Web" +layout: "aws" +page_title: "AWS: aws_workspacesweb_trust_store" +description: |- + Terraform resource for managing an AWS WorkSpaces Web Trust Store. +--- + + + +# Resource: aws_workspacesweb_trust_store + +Terraform resource for managing an AWS WorkSpaces Web Trust Store. + +## Example Usage + +### Basic Usage + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { Fn, Token, TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { WorkspaceswebTrustStore } from "./.gen/providers/aws/workspacesweb-trust-store"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + new WorkspaceswebTrustStore(this, "example", { + certificate: [ + { + body: Token.asString(Fn.file("certificate.pem")), + }, + ], + }); + } +} + +``` + +### Multiple Certificates + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { Fn, Token, TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { WorkspaceswebTrustStore } from "./.gen/providers/aws/workspacesweb-trust-store"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + new WorkspaceswebTrustStore(this, "example", { + certificate: [ + { + body: Token.asString(Fn.file("certificate1.pem")), + }, + { + body: Token.asString(Fn.file("certificate2.pem")), + }, + ], + tags: { + Name: "example-trust-store", + }, + }); + } +} + +``` + +## Argument Reference + +The following arguments are optional: + +* `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). +* `certificate` - (Optional) Set of certificates to include in the trust store. See [Certificate](#certificate) below. +* `tags` - (Optional) Map of tags to assign to the resource. If configured with a provider [`defaultTags` 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. + +### Certificate + +* `body` - (Required) Certificate body in PEM format. + +## Attribute Reference + +This resource exports the following attributes in addition to the arguments above: + +* `associatedPortalArns` - List of ARNs of the web portals associated with the trust store. +* `trustStoreArn` - ARN of the trust store. +* `tagsAll` - Map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). + +The `certificate` block exports the following additional attributes: + +* `issuer` - Certificate issuer. +* `notValidAfter` - Date and time when the certificate expires in RFC3339 format. +* `notValidBefore` - Date and time when the certificate becomes valid in RFC3339 format. +* `subject` - Certificate subject. +* `thumbprint` - Certificate thumbprint. + +## Import + +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import WorkSpaces Web Trust Store using the `trustStoreArn`. For example: + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { WorkspaceswebTrustStore } from "./.gen/providers/aws/workspacesweb-trust-store"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + WorkspaceswebTrustStore.generateConfigForImport( + this, + "example", + "arn:aws:workspaces-web:us-west-2:123456789012:trustStore/trust_store-id-12345678" + ); + } +} + +``` + +Using `terraform import`, import WorkSpaces Web Trust Store using the `trustStoreArn`. For example: + +```console +% terraform import aws_workspacesweb_trust_store.example arn:aws:workspaces-web:us-west-2:123456789012:trustStore/trust_store-id-12345678 +``` + + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/workspacesweb_trust_store_association.html.markdown b/website/docs/cdktf/typescript/r/workspacesweb_trust_store_association.html.markdown new file mode 100644 index 000000000000..678715521d1d --- /dev/null +++ b/website/docs/cdktf/typescript/r/workspacesweb_trust_store_association.html.markdown @@ -0,0 +1,108 @@ +--- +subcategory: "WorkSpaces Web" +layout: "aws" +page_title: "AWS: aws_workspacesweb_trust_store_association" +description: |- + Terraform resource for managing an AWS WorkSpaces Web Trust Store Association. +--- + + + +# Resource: aws_workspacesweb_trust_store_association + +Terraform resource for managing an AWS WorkSpaces Web Trust Store Association. + +## Example Usage + +### Basic Usage + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { Fn, Token, TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { WorkspaceswebPortal } from "./.gen/providers/aws/workspacesweb-portal"; +import { WorkspaceswebTrustStore } from "./.gen/providers/aws/workspacesweb-trust-store"; +import { WorkspaceswebTrustStoreAssociation } from "./.gen/providers/aws/workspacesweb-trust-store-association"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + const example = new WorkspaceswebPortal(this, "example", { + displayName: "example", + }); + const awsWorkspaceswebTrustStoreExample = new WorkspaceswebTrustStore( + this, + "example_1", + { + certificate_list: [ + Fn.base64encode(Token.asString(Fn.file("certificate.pem"))), + ], + } + ); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + awsWorkspaceswebTrustStoreExample.overrideLogicalId("example"); + const awsWorkspaceswebTrustStoreAssociationExample = + new WorkspaceswebTrustStoreAssociation(this, "example_2", { + portalArn: example.portalArn, + trustStoreArn: Token.asString( + awsWorkspaceswebTrustStoreExample.trustStoreArn + ), + }); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + awsWorkspaceswebTrustStoreAssociationExample.overrideLogicalId("example"); + } +} + +``` + +## Argument Reference + +The following arguments are required: + +* `trustStoreArn` - (Required) ARN of the trust store to associate with the portal. Forces replacement if changed. +* `portalArn` - (Required) ARN of the portal to associate with the trust store. Forces replacement if changed. + +The following arguments are optional: + +* `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). + +## 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 WorkSpaces Web Trust Store Association using the `trust_store_arn,portal_arn`. For example: + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { WorkspaceswebTrustStoreAssociation } from "./.gen/providers/aws/workspacesweb-trust-store-association"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + WorkspaceswebTrustStoreAssociation.generateConfigForImport( + this, + "example", + "arn:aws:workspaces-web:us-west-2:123456789012:trustStore/trust_store-id-12345678,arn:aws:workspaces-web:us-west-2:123456789012:portal/portal-id-12345678" + ); + } +} + +``` + +Using `terraform import`, import WorkSpaces Web Trust Store Association using the `trust_store_arn,portal_arn`. For example: + +```console +% terraform import aws_workspacesweb_trust_store_association.example arn:aws:workspaces-web:us-west-2:123456789012:trustStore/trust_store-id-12345678,arn:aws:workspaces-web:us-west-2:123456789012:portal/portal-id-12345678 +``` + + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/workspacesweb_user_access_logging_settings.html.markdown b/website/docs/cdktf/typescript/r/workspacesweb_user_access_logging_settings.html.markdown index 5b20aa3d2d49..bf5c59fe7a1b 100644 --- a/website/docs/cdktf/typescript/r/workspacesweb_user_access_logging_settings.html.markdown +++ b/website/docs/cdktf/typescript/r/workspacesweb_user_access_logging_settings.html.markdown @@ -24,8 +24,8 @@ import { TerraformStack } from "cdktf"; * Provider bindings are generated by running `cdktf get`. * See https://cdk.tf/provider-generation for more details. */ -import { WorkspaceswebUserAccessLoggingSettings } from "./.gen/providers/aws/"; import { KinesisStream } from "./.gen/providers/aws/kinesis-stream"; +import { WorkspaceswebUserAccessLoggingSettings } from "./.gen/providers/aws/workspacesweb-user-access-logging-settings"; class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); @@ -35,7 +35,7 @@ class MyConvertedCode extends TerraformStack { }); const awsWorkspaceswebUserAccessLoggingSettingsExample = new WorkspaceswebUserAccessLoggingSettings(this, "example_1", { - kinesis_stream_arn: example.arn, + kinesisStreamArn: 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.*/ awsWorkspaceswebUserAccessLoggingSettingsExample.overrideLogicalId( @@ -56,8 +56,8 @@ import { TerraformStack } from "cdktf"; * Provider bindings are generated by running `cdktf get`. * See https://cdk.tf/provider-generation for more details. */ -import { WorkspaceswebUserAccessLoggingSettings } from "./.gen/providers/aws/"; import { KinesisStream } from "./.gen/providers/aws/kinesis-stream"; +import { WorkspaceswebUserAccessLoggingSettings } from "./.gen/providers/aws/workspacesweb-user-access-logging-settings"; class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); @@ -67,7 +67,7 @@ class MyConvertedCode extends TerraformStack { }); const awsWorkspaceswebUserAccessLoggingSettingsExample = new WorkspaceswebUserAccessLoggingSettings(this, "example_1", { - kinesis_stream_arn: example.arn, + kinesisStreamArn: example.arn, tags: { Environment: "Production", Name: "example-user-access-logging-settings", @@ -90,6 +90,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `tags` - (Optional) Map of tags assigned to the resource. If configured with a provider [`defaultTags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. ## Attribute Reference @@ -97,12 +98,12 @@ The following arguments are optional: This resource exports the following attributes in addition to the arguments above: * `associatedPortalArns` - List of web portal ARNs that this user access logging settings resource is associated with. -* `user_access_logging_settings_arn` - ARN of the user access logging settings resource. +* `userAccessLoggingSettingsArn` - ARN of the user access logging settings resource. * `tagsAll` - Map of tags assigned to the resource, including those inherited from the provider [`defaultTags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block). ## Import -In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import WorkSpaces Web User Access Logging Settings using the `user_access_logging_settings_arn`. For example: +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import WorkSpaces Web User Access Logging Settings using the `userAccessLoggingSettingsArn`. For example: ```typescript // DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug @@ -112,7 +113,7 @@ import { TerraformStack } from "cdktf"; * Provider bindings are generated by running `cdktf get`. * See https://cdk.tf/provider-generation for more details. */ -import { WorkspaceswebUserAccessLoggingSettings } from "./.gen/providers/aws/"; +import { WorkspaceswebUserAccessLoggingSettings } from "./.gen/providers/aws/workspacesweb-user-access-logging-settings"; class MyConvertedCode extends TerraformStack { constructor(scope: Construct, name: string) { super(scope, name); @@ -126,10 +127,10 @@ class MyConvertedCode extends TerraformStack { ``` -Using `terraform import`, import WorkSpaces Web User Access Logging Settings using the `user_access_logging_settings_arn`. For example: +Using `terraform import`, import WorkSpaces Web User Access Logging Settings using the `userAccessLoggingSettingsArn`. For example: ```console % terraform import aws_workspacesweb_user_access_logging_settings.example arn:aws:workspaces-web:us-west-2:123456789012:userAccessLoggingSettings/abcdef12345 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/workspacesweb_user_access_logging_settings_association.html.markdown b/website/docs/cdktf/typescript/r/workspacesweb_user_access_logging_settings_association.html.markdown new file mode 100644 index 000000000000..5fa647393129 --- /dev/null +++ b/website/docs/cdktf/typescript/r/workspacesweb_user_access_logging_settings_association.html.markdown @@ -0,0 +1,112 @@ +--- +subcategory: "WorkSpaces Web" +layout: "aws" +page_title: "AWS: aws_workspacesweb_user_access_logging_settings_association" +description: |- + Terraform resource for managing an AWS WorkSpaces Web User Access Logging Settings Association. +--- + + + +# Resource: aws_workspacesweb_user_access_logging_settings_association + +Terraform resource for managing an AWS WorkSpaces Web User Access Logging Settings Association. + +## Example Usage + +### Basic Usage + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { Token, TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { KinesisStream } from "./.gen/providers/aws/kinesis-stream"; +import { WorkspaceswebPortal } from "./.gen/providers/aws/workspacesweb-portal"; +import { WorkspaceswebUserAccessLoggingSettings } from "./.gen/providers/aws/workspacesweb-user-access-logging-settings"; +import { WorkspaceswebUserAccessLoggingSettingsAssociation } from "./.gen/providers/aws/workspacesweb-user-access-logging-settings-association"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + const example = new KinesisStream(this, "example", { + name: "amazon-workspaces-web-example", + shardCount: 1, + }); + const awsWorkspaceswebPortalExample = new WorkspaceswebPortal( + this, + "example_1", + { + displayName: "example", + } + ); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + awsWorkspaceswebPortalExample.overrideLogicalId("example"); + const awsWorkspaceswebUserAccessLoggingSettingsExample = + new WorkspaceswebUserAccessLoggingSettings(this, "example_2", { + kinesisStreamArn: 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.*/ + awsWorkspaceswebUserAccessLoggingSettingsExample.overrideLogicalId( + "example" + ); + const awsWorkspaceswebUserAccessLoggingSettingsAssociationExample = + new WorkspaceswebUserAccessLoggingSettingsAssociation(this, "example_3", { + portalArn: Token.asString(awsWorkspaceswebPortalExample.portalArn), + userAccessLoggingSettingsArn: Token.asString( + awsWorkspaceswebUserAccessLoggingSettingsExample.userAccessLoggingSettingsArn + ), + }); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + awsWorkspaceswebUserAccessLoggingSettingsAssociationExample.overrideLogicalId( + "example" + ); + } +} + +``` + +## Argument Reference + +The following arguments are required: + +* `userAccessLoggingSettingsArn` - (Required) ARN of the user access logging settings to associate with the portal. Forces replacement if changed. +* `portalArn` - (Required) ARN of the portal to associate with the user access logging settings. Forces replacement if changed. + +The following arguments are optional: + +* `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). + +## 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 WorkSpaces Web User Access Logging Settings Association using the `user_access_logging_settings_arn,portal_arn`. For example: + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { WorkspaceswebUserAccessLoggingSettingsAssociation } from "./.gen/providers/aws/workspacesweb-user-access-logging-settings-association"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + WorkspaceswebUserAccessLoggingSettingsAssociation.generateConfigForImport( + this, + "example", + "arn:aws:workspaces-web:us-west-2:123456789012:userAccessLoggingSettings/user_access_logging_settings-id-12345678,arn:aws:workspaces-web:us-west-2:123456789012:portal/portal-id-12345678" + ); + } +} + +``` + + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/workspacesweb_user_settings.html.markdown b/website/docs/cdktf/typescript/r/workspacesweb_user_settings.html.markdown index 46ae3438a1b8..e5cd02a11f16 100644 --- a/website/docs/cdktf/typescript/r/workspacesweb_user_settings.html.markdown +++ b/website/docs/cdktf/typescript/r/workspacesweb_user_settings.html.markdown @@ -155,6 +155,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `additionalEncryptionContext` - (Optional) Additional encryption context for the user settings. * `associatedPortalArns` - (Optional) List of web portal ARNs to associate with the user settings. * `cookieSynchronizationConfiguration` - (Optional) Configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser. Detailed below. @@ -222,4 +223,4 @@ Using `terraform import`, import WorkSpaces Web User Settings using the `userSet % terraform import aws_workspacesweb_user_settings.example arn:aws:workspacesweb:us-west-2:123456789012:usersettings/abcdef12345 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/workspacesweb_user_settings_association.html.markdown b/website/docs/cdktf/typescript/r/workspacesweb_user_settings_association.html.markdown new file mode 100644 index 000000000000..396f6f63b0c7 --- /dev/null +++ b/website/docs/cdktf/typescript/r/workspacesweb_user_settings_association.html.markdown @@ -0,0 +1,104 @@ +--- +subcategory: "WorkSpaces Web" +layout: "aws" +page_title: "AWS: aws_workspacesweb_user_settings_association" +description: |- + Terraform resource for managing an AWS WorkSpaces Web User Settings Association. +--- + + + +# Resource: aws_workspacesweb_user_settings_association + +Terraform resource for managing an AWS WorkSpaces Web User Settings Association. + +## Example Usage + +### Basic Usage + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { Token, TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { WorkspaceswebPortal } from "./.gen/providers/aws/workspacesweb-portal"; +import { WorkspaceswebUserSettings } from "./.gen/providers/aws/workspacesweb-user-settings"; +import { WorkspaceswebUserSettingsAssociation } from "./.gen/providers/aws/workspacesweb-user-settings-association"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + const example = new WorkspaceswebPortal(this, "example", { + displayName: "example", + }); + const awsWorkspaceswebUserSettingsExample = new WorkspaceswebUserSettings( + this, + "example_1", + { + copyAllowed: "Enabled", + downloadAllowed: "Enabled", + pasteAllowed: "Enabled", + printAllowed: "Enabled", + uploadAllowed: "Enabled", + } + ); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + awsWorkspaceswebUserSettingsExample.overrideLogicalId("example"); + const awsWorkspaceswebUserSettingsAssociationExample = + new WorkspaceswebUserSettingsAssociation(this, "example_2", { + portalArn: example.portalArn, + userSettingsArn: Token.asString( + awsWorkspaceswebUserSettingsExample.userSettingsArn + ), + }); + /*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/ + awsWorkspaceswebUserSettingsAssociationExample.overrideLogicalId("example"); + } +} + +``` + +## Argument Reference + +The following arguments are required: + +* `userSettingsArn` - (Required) ARN of the user settings to associate with the portal. Forces replacement if changed. +* `portalArn` - (Required) ARN of the portal to associate with the user settings. Forces replacement if changed. + +The following arguments are optional: + +* `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). + +## 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 WorkSpaces Web User Settings Association using the `user_settings_arn,portal_arn`. For example: + +```typescript +// DO NOT EDIT. Code generated by 'cdktf convert' - Please report bugs at https://cdk.tf/bug +import { Construct } from "constructs"; +import { TerraformStack } from "cdktf"; +/* + * Provider bindings are generated by running `cdktf get`. + * See https://cdk.tf/provider-generation for more details. + */ +import { WorkspaceswebUserSettingsAssociation } from "./.gen/providers/aws/workspacesweb-user-settings-association"; +class MyConvertedCode extends TerraformStack { + constructor(scope: Construct, name: string) { + super(scope, name); + WorkspaceswebUserSettingsAssociation.generateConfigForImport( + this, + "example", + "arn:aws:workspaces-web:us-west-2:123456789012:userSettings/user_settings-id-12345678,arn:aws:workspaces-web:us-west-2:123456789012:portal/portal-id-12345678" + ); + } +} + +``` + + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/xray_encryption_config.html.markdown b/website/docs/cdktf/typescript/r/xray_encryption_config.html.markdown index 42e7a608a011..115a9ff649c0 100644 --- a/website/docs/cdktf/typescript/r/xray_encryption_config.html.markdown +++ b/website/docs/cdktf/typescript/r/xray_encryption_config.html.markdown @@ -96,6 +96,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `type` - (Required) The type of encryption. Set to `KMS` to use your own key for encryption. Set to `NONE` for default encryption. * `keyId` - (Optional) An AWS KMS customer master key (CMK) ARN. @@ -133,4 +134,4 @@ Using `terraform import`, import XRay Encryption Config using the region name. F % terraform import aws_xray_encryption_config.example us-west-2 ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/xray_group.html.markdown b/website/docs/cdktf/typescript/r/xray_group.html.markdown index 11f53f15a80a..edc46fd78770 100644 --- a/website/docs/cdktf/typescript/r/xray_group.html.markdown +++ b/website/docs/cdktf/typescript/r/xray_group.html.markdown @@ -43,6 +43,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `groupName` - (Required) The name of the group. * `filterExpression` - (Required) The filter expression defining criteria by which to group traces. more info can be found in official [docs](https://docs.aws.amazon.com/xray/latest/devguide/xray-console-filters.html). * `insightsConfiguration` - (Optional) Configuration options for enabling insights. @@ -95,4 +96,4 @@ Using `terraform import`, import XRay Groups using the ARN. For example: % terraform import aws_xray_group.example arn:aws:xray:us-west-2:1234567890:group/example-group/TNGX7SW5U6QY36T4ZMOUA3HVLBYCZTWDIOOXY3CJAXTHSS3YCWUA ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/xray_resource_policy.html.markdown b/website/docs/cdktf/typescript/r/xray_resource_policy.html.markdown index 420a99645900..09b74aa5689d 100644 --- a/website/docs/cdktf/typescript/r/xray_resource_policy.html.markdown +++ b/website/docs/cdktf/typescript/r/xray_resource_policy.html.markdown @@ -48,6 +48,7 @@ The following arguments are required: The following arguments are optional: +* `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). * `policyRevisionId` - (Optional) Specifies a specific policy revision, to ensure an atomic create operation. By default the resource policy is created if it does not exist, or updated with an incremented revision id. The revision id is unique to each policy in the account. If the policy revision id does not match the latest revision id, the operation will fail with an InvalidPolicyRevisionIdException exception. You can also provide a PolicyRevisionId of 0. In this case, the operation will fail with an InvalidPolicyRevisionIdException exception if a resource policy with the same name already exists. * `bypassPolicyLockoutCheck` - (Optional) Flag to indicate whether to bypass the resource policy lockout safety check. Setting this value to true increases the risk that the policy becomes unmanageable. Do not set this value to true indiscriminately. Use this parameter only when you include a policy in the request and you intend to prevent the principal that is making the request from making a subsequent PutResourcePolicy request. The default value is `false`. @@ -90,4 +91,4 @@ Using `terraform import`, import X-Ray Resource Policy using the `policyName`. F % terraform import aws_xray_resource_policy.example resource_policy-name ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/cdktf/typescript/r/xray_sampling_rule.html.markdown b/website/docs/cdktf/typescript/r/xray_sampling_rule.html.markdown index 53f62a78ce24..548731df5e8c 100644 --- a/website/docs/cdktf/typescript/r/xray_sampling_rule.html.markdown +++ b/website/docs/cdktf/typescript/r/xray_sampling_rule.html.markdown @@ -51,6 +51,7 @@ class MyConvertedCode extends TerraformStack { This resource supports the following arguments: +* `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). * `ruleName` - (Required) The name of the sampling rule. * `resourceArn` - (Required) Matches the ARN of the AWS resource on which the service runs. * `priority` - (Required) The priority of the sampling rule. @@ -101,4 +102,4 @@ Using `terraform import`, import XRay Sampling Rules using the name. For example % terraform import aws_xray_sampling_rule.example example ``` - \ No newline at end of file + \ No newline at end of file diff --git a/website/docs/d/bedrock_inference_profiles.html.markdown b/website/docs/d/bedrock_inference_profiles.html.markdown index 4f14e295c556..7a3a80b89467 100644 --- a/website/docs/d/bedrock_inference_profiles.html.markdown +++ b/website/docs/d/bedrock_inference_profiles.html.markdown @@ -8,7 +8,7 @@ description: |- # Data Source: aws_bedrock_inference_profiles -Terraform data source for managing AWS Bedrock AWS Bedrock Inference Profiles. +Terraform data source for managing AWS Bedrock Inference Profiles. ## Example Usage @@ -18,11 +18,20 @@ Terraform data source for managing AWS Bedrock AWS Bedrock Inference Profiles. data "aws_bedrock_inference_profiles" "test" {} ``` +### Filter by Type + +```terraform +data "aws_bedrock_inference_profiles" "test" { + type = "APPLICATION" +} +``` + ## Argument Reference This data source supports the following arguments: * `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). +* `type` - (Optional) Filters for inference profiles that match the type you specify. Valid values are: `SYSTEM_DEFINED`, `APPLICATION`. ## Attribute Reference @@ -32,16 +41,16 @@ This data source exports the following attributes in addition to the arguments a ### `inference_profile_summaries` -- `created_at` - The time at which the inference profile was created. -- `description` - The description of the inference profile. -- `inference_profile_arn` - The Amazon Resource Name (ARN) of the inference profile. -- `inference_profile_id` - The unique identifier of the inference profile. -- `inference_profile_name` - The name of the inference profile. -- `models` - A list of information about each model in the inference profile. See [`models`](#models). -- `status` - The status of the inference profile. `ACTIVE` means that the inference profile is available to use. -- `type` - The type of the inference profile. `SYSTEM_DEFINED` means that the inference profile is defined by Amazon Bedrock. -- `updated_at` - The time at which the inference profile was last updated. +- `created_at` - Time at which the inference profile was created. +- `description` - Description of the inference profile. +- `inference_profile_arn` - Amazon Resource Name (ARN) of the inference profile. +- `inference_profile_id` - Unique identifier of the inference profile. +- `inference_profile_name` - Name of the inference profile. +- `models` - List of information about each model in the inference profile. See [`models` Block](#models). +- `status` - Status of the inference profile. `ACTIVE` means that the inference profile is available to use. +- `type` - Type of the inference profile. `SYSTEM_DEFINED` means that the inference profile is defined by Amazon Bedrock. `APPLICATION` means the inference profile was created by a user. +- `updated_at` - Time at which the inference profile was last updated. ### `models` -- `model_arn` - The Amazon Resource Name (ARN) of the model. +- `model_arn` - Amazon Resource Name (ARN) of the model. diff --git a/website/docs/d/cloudwatch_event_bus.html.markdown b/website/docs/d/cloudwatch_event_bus.html.markdown index 896c62d3c784..5b06ca96ddac 100644 --- a/website/docs/d/cloudwatch_event_bus.html.markdown +++ b/website/docs/d/cloudwatch_event_bus.html.markdown @@ -37,3 +37,6 @@ This data source exports the following attributes in addition to the arguments a * `description` - Event bus description. * `id` - Name of the event bus. * `kms_key_identifier` - Identifier of the AWS KMS customer managed key for EventBridge to use to encrypt events on this event bus, if one has been specified. +* `log_config` - Block for logging configuration settings for the event bus. + * `include_detail` - Whether EventBridge include detailed event information in the records it generates. + * `level` - Level of logging detail to include. diff --git a/website/docs/d/codebuild_fleet.html.markdown b/website/docs/d/codebuild_fleet.html.markdown index 0b92ff3ec7d3..7a5fc9f1f264 100644 --- a/website/docs/d/codebuild_fleet.html.markdown +++ b/website/docs/d/codebuild_fleet.html.markdown @@ -59,6 +59,7 @@ This data source exports the following attributes in addition to the arguments a * `base_capacity` - Number of machines allocated to the fleet. * `compute_configuration` - Compute configuration of the compute fleet. * `disk` - Amount of disk space of the instance type included in the fleet. + * `instance_type` - EC2 instance type in the fleet. * `machine_type` - Machine type of the instance type included in the fleet. * `memory` - Amount of memory of the instance type included in the fleet. * `vcpu` - Number of vCPUs of the instance type included in the fleet. diff --git a/website/docs/d/ebs_volume.html.markdown b/website/docs/d/ebs_volume.html.markdown index fab12e98468e..61c72f4ed06a 100644 --- a/website/docs/d/ebs_volume.html.markdown +++ b/website/docs/d/ebs_volume.html.markdown @@ -59,6 +59,7 @@ This data source exports the following attributes in addition to the arguments a * `throughput` - Throughput that the volume supports, in MiB/s. * `volume_id` - Volume ID (e.g., vol-59fcb34e). * `volume_type` - Type of EBS volume. +* `volume_initialization_rate` - EBS provisioned rate for volume initialization, in MiB/s, at which to download the snapshot blocks from Amazon S3 to the volume. ## Timeouts diff --git a/website/docs/d/ec2_client_vpn_endpoint.html.markdown b/website/docs/d/ec2_client_vpn_endpoint.html.markdown index 137f449b759d..41c5e318cb56 100644 --- a/website/docs/d/ec2_client_vpn_endpoint.html.markdown +++ b/website/docs/d/ec2_client_vpn_endpoint.html.markdown @@ -63,12 +63,14 @@ This data source exports the following attributes in addition to the arguments a * `description` - Brief description of the endpoint. * `dns_name` - DNS name to be used by clients when connecting to the Client VPN endpoint. * `dns_servers` - Information about the DNS servers to be used for DNS resolution. +* `endpoint_ip_address_type` - IP address type for the Client VPN endpoint. * `security_group_ids` - IDs of the security groups for the target network associated with the Client VPN endpoint. * `self_service_portal` - Whether the self-service portal for the Client VPN endpoint is enabled. * `self_service_portal_url` - The URL of the self-service portal. * `server_certificate_arn` - The ARN of the server certificate. * `session_timeout_hours` - The maximum VPN session duration time in hours. * `split_tunnel` - Whether split-tunnel is enabled in the AWS Client VPN endpoint. +* `traffic_ip_address_type` - IP address type for traffic within the Client VPN tunnel. * `transport_protocol` - Transport protocol used by the Client VPN endpoint. * `vpc_id` - ID of the VPC associated with the Client VPN endpoint. * `vpn_port` - Port number for the Client VPN endpoint. diff --git a/website/docs/d/ecr_images.html.markdown b/website/docs/d/ecr_images.html.markdown new file mode 100644 index 000000000000..d6e2db4ab312 --- /dev/null +++ b/website/docs/d/ecr_images.html.markdown @@ -0,0 +1,43 @@ +--- +subcategory: "ECR (Elastic Container Registry)" +layout: "aws" +page_title: "AWS: aws_ecr_images" +description: |- + Provides a list of images for a specified ECR Repository +--- + +# Data Source: aws_ecr_images + +The ECR Images data source allows the list of images in a specified repository to be retrieved. + +## Example Usage + +```terraform +data "aws_ecr_images" "example" { + repository_name = "my-repository" +} + +output "image_digests" { + value = [for img in data.aws_ecr_images.example.image_ids : img.image_digest if img.image_digest != null] +} + +output "image_tags" { + value = [for img in data.aws_ecr_images.example.image_ids : img.image_tag if img.image_tag != null] +} +``` + +## Argument Reference + +This data source supports the following arguments: + +* `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). +* `registry_id` - (Optional) ID of the Registry where the repository resides. +* `repository_name` - (Required) Name of the ECR Repository. + +## Attribute Reference + +This data source exports the following attributes in addition to the arguments above: + +* `image_ids` - List of image objects containing image digest and tags. Each object has the following attributes: + * `image_digest` - The sha256 digest of the image manifest. + * `image_tag` - The tag associated with the image. diff --git a/website/docs/d/ecr_repository.html.markdown b/website/docs/d/ecr_repository.html.markdown index 8b42b6122ca6..e6bcc7efce5e 100644 --- a/website/docs/d/ecr_repository.html.markdown +++ b/website/docs/d/ecr_repository.html.markdown @@ -34,6 +34,7 @@ This data source exports the following attributes in addition to the arguments a * `encryption_configuration` - Encryption configuration for the repository. See [Encryption Configuration](#encryption-configuration) below. * `image_scanning_configuration` - Configuration block that defines image scanning configuration for the repository. See [Image Scanning Configuration](#image-scanning-configuration) below. * `image_tag_mutability` - The tag mutability setting for the repository. +* `image_tag_mutability_exclusion_filter` - Block that defines filters to specify which image tags can override the default tag mutability setting. * `most_recent_image_tags` - List of image tags associated with the most recently pushed image in the repository. * `repository_url` - URL of the repository (in the form `aws_account_id.dkr.ecr.region.amazonaws.com/repositoryName`). * `tags` - Map of tags assigned to the resource. @@ -43,6 +44,11 @@ This data source exports the following attributes in addition to the arguments a * `encryption_type` - Encryption type to use for the repository, either `AES256` or `KMS`. * `kms_key` - If `encryption_type` is `KMS`, the ARN of the KMS key used. +### Image Tag Mutability Exclusion Filter + +* `filter` - The filter pattern to use for excluding image tags from the mutability setting. +* `filter_type` - The type of filter to use. + ### Image Scanning Configuration * `scan_on_push` - Whether images are scanned after being pushed to the repository. diff --git a/website/docs/d/ecr_repository_creation_template.html.markdown b/website/docs/d/ecr_repository_creation_template.html.markdown index 7a66b35c3346..9a984d8653aa 100644 --- a/website/docs/d/ecr_repository_creation_template.html.markdown +++ b/website/docs/d/ecr_repository_creation_template.html.markdown @@ -34,6 +34,7 @@ This data source exports the following attributes in addition to the arguments a * `description` - The description for this template. * `encryption_configuration` - Encryption configuration for any created repositories. See [Encryption Configuration](#encryption-configuration) below. * `image_tag_mutability` - The tag mutability setting for any created repositories. +* `image_tag_mutability_exclusion_filter` - Block that defines filters to specify which image tags can override the default tag mutability setting. * `lifecycle_policy` - The lifecycle policy document to apply to any created repositories. * `registry_id` - The registry ID the repository creation template applies to. * `repository_policy` - The registry policy document to apply to any created repositories. @@ -43,3 +44,8 @@ This data source exports the following attributes in addition to the arguments a * `encryption_type` - Encryption type to use for any created repositories, either `AES256` or `KMS`. * `kms_key` - If `encryption_type` is `KMS`, the ARN of the KMS key used. + +### Image Tag Mutability Exclusion Filter + +* `filter` - The filter pattern to use for excluding image tags from the mutability setting. +* `filter_type` - The type of filter to use. diff --git a/website/docs/d/ecs_service.html.markdown b/website/docs/d/ecs_service.html.markdown index f1022035e991..e524834186ac 100644 --- a/website/docs/d/ecs_service.html.markdown +++ b/website/docs/d/ecs_service.html.markdown @@ -35,6 +35,26 @@ This data source exports the following attributes in addition to the arguments a * `arn` - ARN of the ECS Service * `desired_count` - Number of tasks for the ECS Service * `launch_type` - Launch type for the ECS Service +* `load_balancer` - Load balancers for the ECS Service. See [`load_balancer` Block](#load_balancer-block) for details. * `scheduling_strategy` - Scheduling strategy for the ECS Service * `task_definition` - Family for the latest ACTIVE revision or full ARN of the task definition. * `tags` - Resource tags. + +### `load_balancer` Block + +The `load_balancer` block exports the following attributes: + +* `advanced_configuration` - Settings for Blue/Green deployment. See [`advanced_configuration` Block](#advanced_configuration-block) for details. +* `container_name` - Name of the container to associate with the load balancer. +* `container_port` - Port on the container to associate with the load balancer. +* `elb_name` - Name of the load balancer. +* `target_group_arn` - ARN of the target group to associate with the load balancer. + +### `advanced_configuration` Block + +The `advanced_configuration` block exports the following attributes: + +* `alternate_target_group_arn` - ARN of the alternate target group to use for Blue/Green deployments. +* `production_listener_rule` - ARN of the listener rule that routes production traffic. +* `role_arn` - ARN of the IAM role that allows ECS to manage the target groups. +* `test_listener_rule` - ARN of the listener rule that routes test traffic. diff --git a/website/docs/d/efs_mount_target.html.markdown b/website/docs/d/efs_mount_target.html.markdown index 02028a405b30..f7104cedb91d 100644 --- a/website/docs/d/efs_mount_target.html.markdown +++ b/website/docs/d/efs_mount_target.html.markdown @@ -39,6 +39,8 @@ This data source exports the following attributes in addition to the arguments a * `file_system_arn` - Amazon Resource Name of the file system for which the mount target is intended. * `subnet_id` - ID of the mount target's subnet. * `ip_address` - Address at which the file system may be mounted via the mount target. +* `ip_address_type` - IP address type for the mount target. +* `ipv6_address` - IPv6 address at which the file system may be mounted via the mount target. * `security_groups` - List of VPC security group IDs attached to the mount target. * `dns_name` - DNS name for the EFS file system. * `mount_target_dns_name` - The DNS name for the given subnet/AZ per [documented convention](http://docs.aws.amazon.com/efs/latest/ug/mounting-fs-mount-cmd-dns-name.html). diff --git a/website/docs/d/eks_cluster.html.markdown b/website/docs/d/eks_cluster.html.markdown index f270a5e54d6a..57234661b176 100644 --- a/website/docs/d/eks_cluster.html.markdown +++ b/website/docs/d/eks_cluster.html.markdown @@ -50,6 +50,7 @@ This data source exports the following attributes in addition to the arguments a * `data` - The base64 encoded certificate data required to communicate with your cluster. Add this to the `certificate-authority-data` section of the `kubeconfig` file for your cluster. * `cluster_id` - The ID of your local Amazon EKS cluster on the AWS Outpost. This attribute isn't available for an AWS EKS cluster on AWS cloud. * `created_at` - Unix epoch time stamp in seconds for when the cluster was created. +* `deletion_protection` - Whether deletion protection for the cluster is enabled. * `enabled_cluster_log_types` - The enabled control plane logs. * `endpoint` - Endpoint for your Kubernetes API server. * `identity` - Nested attribute containing identity provider information for your cluster. Only available on Kubernetes version 1.13 and 1.14 clusters created or upgraded on or after September 3, 2019. For an example using this information to enable IAM Roles for Service Accounts, see the [`aws_eks_cluster` resource documentation](/docs/providers/aws/r/eks_cluster.html). diff --git a/website/docs/d/eks_cluster_versions.html.markdown b/website/docs/d/eks_cluster_versions.html.markdown index 7a9a17f39a36..f363e7c612ec 100644 --- a/website/docs/d/eks_cluster_versions.html.markdown +++ b/website/docs/d/eks_cluster_versions.html.markdown @@ -16,6 +16,18 @@ Terraform data source for managing AWS EKS (Elastic Kubernetes) Cluster Versions ```terraform data "aws_eks_cluster_versions" "example" {} + +output "eks_cluster_versions" { + value = data.aws_eks_cluster_versions.example.cluster_versions +} + +output "eks_cluster_version_filtered" { + value = [for version in data.aws_eks_cluster_versions.example.cluster_versions : version if version.cluster_version == "1.33"] +} + +output "eks_cluster_version_list" { + value = [for version in data.aws_eks_cluster_versions.example.cluster_versions : version.cluster_version] +} ``` ### Filter by Cluster Type @@ -41,7 +53,6 @@ The following arguments are optional: * `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). * `cluster_type` - (Optional) Type of clusters to filter by. Currently, the only valid value is `eks`. -* `cluster_versions` - (Optional) A list of Kubernetes versions that you can use to check if EKS supports it. * `default_only` - (Optional) Whether to show only the default versions of Kubernetes supported by EKS. * `include_all` - (Optional) Whether to include all kubernetes versions in the response. * `version_status` - (Optional) Status of the EKS cluster versions to list. @@ -51,12 +62,13 @@ Valid values are `STANDARD_SUPPORT` or `UNSUPPORTED` or `EXTENDED_SUPPORT`. This data source exports the following attributes in addition to the arguments above: -* `cluster_type` - Type of cluster that the version belongs to. -* `cluster_version` - Kubernetes version supported by EKS. -* `default_platform_version` - Default eks platform version for the cluster version. -* `default_version` - Default Kubernetes version for the cluster version. -* `end_of_extended_support_date` - End of extended support date for the cluster version. -* `end_of_standard_support_date` - End of standard support date for the cluster version. -* `kubernetes_patch_version` - Kubernetes patch version for the cluster version. -* `release_date` - Release date of the cluster version. -* `version_status` - Status of the EKS cluster version. +* `cluster_versions` - A list of Kubernetes version information. + * `cluster_type` - Type of cluster that the version belongs to. + * `cluster_version` - Kubernetes version supported by EKS. + * `default_platform_version` - Default eks platform version for the cluster version. + * `default_version` - Default Kubernetes version for the cluster version. + * `end_of_extended_support_date` - End of extended support date for the cluster version. + * `end_of_standard_support_date` - End of standard support date for the cluster version. + * `kubernetes_patch_version` - Kubernetes patch version for the cluster version. + * `release_date` - Release date of the cluster version. + * `version_status` - Status of the EKS cluster version. diff --git a/website/docs/d/glue_catalog_table.html.markdown b/website/docs/d/glue_catalog_table.html.markdown index 212c212071c9..3c33b1d2b6ea 100644 --- a/website/docs/d/glue_catalog_table.html.markdown +++ b/website/docs/d/glue_catalog_table.html.markdown @@ -57,6 +57,7 @@ This data source exports the following attributes in addition to the arguments a * `comment` - Free-form text comment. * `name` - Name of the Partition Key. +* `parameters` - Map of key-value pairs. * `type` - Datatype of data in the Partition Key. ### storage_descriptor diff --git a/website/docs/d/iam_principal_policy_simulation.html.markdown b/website/docs/d/iam_principal_policy_simulation.html.markdown index 430a9299bc29..9575c826cfaa 100644 --- a/website/docs/d/iam_principal_policy_simulation.html.markdown +++ b/website/docs/d/iam_principal_policy_simulation.html.markdown @@ -49,7 +49,7 @@ data "aws_iam_principal_policy_simulation" "s3_object_access" { If you intend to use this data source to quickly raise an error when the given credentials are insufficient then you must use [`depends_on`](https://www.terraform.io/language/meta-arguments/depends_on) inside any resource which would require those credentials, to ensure that the policy check will run first: ```terraform -resource "aws_s3_bucket_object" "example" { +resource "aws_s3_object" "example" { bucket = "my-test-bucket" # ... diff --git a/website/docs/d/instance.html.markdown b/website/docs/d/instance.html.markdown index 0d94af8bee0d..0e7b0b08b58b 100644 --- a/website/docs/d/instance.html.markdown +++ b/website/docs/d/instance.html.markdown @@ -101,6 +101,7 @@ interpolation. * `outpost_arn` - ARN of the Outpost. * `password_data` - Base-64 encoded encrypted password data for the instance. Useful for getting the administrator password for instances running Microsoft Windows. This attribute is only exported if `get_password_data` is true. See [GetPasswordData](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetPasswordData.html) for more information. * `placement_group` - Placement group of the Instance. +* `placement_group_id` - Placement group ID of the Instance. * `placement_partition_number` - Number of the partition the instance is in. * `private_dns` - Private DNS name assigned to the Instance. Can only be used inside the Amazon EC2, and only available if you've enabled DNS hostnames for your VPC. * `private_dns_name_options` - Options for the instance hostname. diff --git a/website/docs/d/lakeformation_resource.html.markdown b/website/docs/d/lakeformation_resource.html.markdown index 8ae41ca5000c..72d1cb90ad7b 100644 --- a/website/docs/d/lakeformation_resource.html.markdown +++ b/website/docs/d/lakeformation_resource.html.markdown @@ -29,5 +29,8 @@ This data source supports the following arguments: This data source exports the following attributes in addition to the arguments above: +* `hybrid_access_enabled` - Flag to enable AWS LakeFormation hybrid access permission mode. * `last_modified` - Date and time the resource was last modified in [RFC 3339 format](https://tools.ietf.org/html/rfc3339#section-5.8). * `role_arn` - Role that the resource was registered with. +* `with_federation` - Whether the resource is a federated resource. +* `with_privileged_access` - Boolean to grant the calling principal the permissions to perform all supported Lake Formation operations on the registered data location. diff --git a/website/docs/d/lambda_function.html.markdown b/website/docs/d/lambda_function.html.markdown index 61b8c1a3cbc1..c0108877d25e 100644 --- a/website/docs/d/lambda_function.html.markdown +++ b/website/docs/d/lambda_function.html.markdown @@ -142,6 +142,7 @@ This data source exports the following attributes in addition to the arguments a * `signing_profile_version_arn` - ARN for a signing profile version. * `source_code_hash` - (**Deprecated** use `code_sha256` instead) Base64-encoded representation of raw SHA-256 sum of the zip file. * `source_code_size` - Size in bytes of the function .zip file. +* `source_kms_key_arn` - ARN of the AWS Key Management Service key used to encrypt the function's `.zip` deployment package. * `tags` - Map of tags assigned to the Lambda Function. * `timeout` - Function execution time at which Lambda should terminate the function. * `tracing_config` - Tracing settings of the function. [See below](#tracing_config-attribute-reference). diff --git a/website/docs/d/network_interface.html.markdown b/website/docs/d/network_interface.html.markdown index ed611309037f..8307d52f6741 100644 --- a/website/docs/d/network_interface.html.markdown +++ b/website/docs/d/network_interface.html.markdown @@ -31,7 +31,8 @@ This data source supports the following arguments: This data source exports the following attributes in addition to the arguments above: * `arn` - ARN of the network interface. -* `association` - Association information for an Elastic IP address (IPv4) associated with the network interface. See supported fields below. +* `association` - Association information for an Elastic IP address (IPv4) associated with the network interface. See [association](#association) below. +* `attachment` - Attachment of the ENI. See [attachment](#attachment) below. * `availability_zone` - Availability Zone. * `description` - Description of the network interface. * `interface_type` - Type of interface. @@ -58,6 +59,14 @@ This data source exports the following attributes in addition to the arguments a * `public_dns_name` - Public DNS name. * `public_ip` - Address of the Elastic IP address bound to the network interface. +### `attachment` + +* `attachment_id` - ID of the network interface attachment. +* `device_index` - Device index of the network interface attachment on the instance. +* `instance_id` - ID of the instance. +* `instance_owner_id` - AWS account ID of the owner of the instance. +* `network_card_index` - Index of the network card. + ## Timeouts [Configuration options](https://developer.hashicorp.com/terraform/language/resources/syntax#operation-timeouts): diff --git a/website/docs/d/networkfirewall_firewall.html.markdown b/website/docs/d/networkfirewall_firewall.html.markdown index cbc70c3df2cd..6a6cd36c0236 100644 --- a/website/docs/d/networkfirewall_firewall.html.markdown +++ b/website/docs/d/networkfirewall_firewall.html.markdown @@ -52,6 +52,9 @@ One or more of these arguments is required. This data source exports the following attributes in addition to the arguments above: * `arn` - ARN of the firewall. +* `availability_zone_change_protection` - Indicates whether the firewall is protected against changes to its Availability Zone configuration. +* `availability_zone_mapping` - Set of Availability Zones where the firewall endpoints are created for a transit gateway-attached firewall. + * `availability_zone_id` - The ID of the Availability Zone where the firewall endpoint is located. * `delete_protection` - A flag indicating whether the firewall is protected against deletion. * `description` - Description of the firewall. * `enabled_analysis_types` - Set of types for which to collect analysis metrics. @@ -64,6 +67,8 @@ This data source exports the following attributes in addition to the arguments a * `sync_states` - Set of subnets configured for use by the firewall. * `attachment` - Nested list describing the attachment status of the firewall's association with a single VPC subnet. * `endpoint_id` - The identifier of the firewall endpoint that AWS Network Firewall has instantiated in the subnet. You use this to identify the firewall endpoint in the VPC route tables, when you redirect the VPC traffic through the endpoint. + * `status` - The current status of the firewall endpoint instantiation in the subnet. + * `status_message` - It populates this with the reason for the error or failure and how to resolve it. A FAILED status indicates a non-recoverable state, and a ERROR status indicates an issue that you can fix. * `subnet_id` - The unique identifier of the subnet that you've specified to be used for a firewall endpoint. * `availability_zone` - The Availability Zone where the subnet is configured. * `capacity_usage_summary` - Aggregated count of all resources used by reference sets in a firewall. @@ -73,6 +78,10 @@ This data source exports the following attributes in addition to the arguments a * `resolved_cidr_count` - Total number of CIDR blocks used by the IP set references in a firewall. * `utilized_cidr_count` - Number of CIDR blocks used by the IP set references in a firewall. * `configuration_sync_state_summary` - Summary of sync states for all availability zones in which the firewall is configured. + * `transit_gateway_attachment_sync_states` - Set of transit gateway configured for use by the firewall. + * `attachment_id` - The unique identifier of the transit gateway attachment. + * `status_message` - A message providing additional information about the current status. + * `transit_gateway_attachment_status` - The current status of the transit gateway attachment. * `id` - ARN that identifies the firewall. * `name` - Descriptive name of the firewall. * `subnet_change_protection` - A flag indicating whether the firewall is protected against changes to the subnet associations. @@ -80,4 +89,6 @@ This data source exports the following attributes in addition to the arguments a * `subnet_id` - The unique identifier for the subnet. * `tags` - Map of resource tags to associate with the resource. If configured with a provider [`default_tags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. * `update_token` - String token used when updating a firewall. +* `transit_gateway_id` - The unique identifier of the transit gateway associated with this firewall. +* `transit_gateway_owner_account_id` - The AWS account ID that owns the transit gateway. * `vpc_id` - Unique identifier of the VPC where AWS Network Firewall should create the firewall. diff --git a/website/docs/d/quicksight_analysis.html.markdown b/website/docs/d/quicksight_analysis.html.markdown index 0ba1c342ed68..19ded3ac070c 100644 --- a/website/docs/d/quicksight_analysis.html.markdown +++ b/website/docs/d/quicksight_analysis.html.markdown @@ -24,9 +24,9 @@ data "aws_quicksight_analysis" "example" { This data source supports the following arguments: -* `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). * `analysis_id` - (Required) Identifier for the analysis. -* `aws_account_id` - (Optional) AWS account ID. +* `aws_account_id` - (Optional) AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider. +* `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). ## Attribute Reference diff --git a/website/docs/d/quicksight_data_set.html.markdown b/website/docs/d/quicksight_data_set.html.markdown index fce943b46428..81f870982808 100644 --- a/website/docs/d/quicksight_data_set.html.markdown +++ b/website/docs/d/quicksight_data_set.html.markdown @@ -24,9 +24,9 @@ data "aws_quicksight_data_set" "example" { This data source supports the following arguments: -* `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). +* `aws_account_id` - (Optional) AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider. * `data_set_id` - (Required) Identifier for the data set. -* `aws_account_id` - (Optional) AWS account ID. +* `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). ## Attribute Reference diff --git a/website/docs/d/quicksight_group.html.markdown b/website/docs/d/quicksight_group.html.markdown index 5be1cc4e9bf3..27f064df37ae 100644 --- a/website/docs/d/quicksight_group.html.markdown +++ b/website/docs/d/quicksight_group.html.markdown @@ -30,9 +30,9 @@ The following arguments are required: The following arguments are optional: -* `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). -* `aws_account_id` - (Optional) AWS account ID. +* `aws_account_id` - (Optional) AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider. * `namespace` - (Optional) QuickSight namespace. Defaults to `default`. +* `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). ## Attribute Reference diff --git a/website/docs/d/quicksight_theme.html.markdown b/website/docs/d/quicksight_theme.html.markdown index 732b934e848f..75b4d736b389 100644 --- a/website/docs/d/quicksight_theme.html.markdown +++ b/website/docs/d/quicksight_theme.html.markdown @@ -28,8 +28,8 @@ The following arguments are required: The following arguments are optional: +* `aws_account_id` - AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider. * `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). -* `aws_account_id` - AWS account ID. ## Attribute Reference diff --git a/website/docs/d/quicksight_user.html.markdown b/website/docs/d/quicksight_user.html.markdown index 526f8d56bcdb..aec9e82c9579 100644 --- a/website/docs/d/quicksight_user.html.markdown +++ b/website/docs/d/quicksight_user.html.markdown @@ -30,9 +30,9 @@ The following arguments are required: The following arguments are optional: -* `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). -* `aws_account_id` - (Optional) AWS account ID. +* `aws_account_id` - (Optional) AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider. * `namespace` - (Optional) QuickSight namespace. Defaults to `default`. +* `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). ## Attribute Reference @@ -40,6 +40,7 @@ This data source exports the following attributes in addition to the arguments a * `active` - The active status of user. When you create an Amazon QuickSight user that’s not an IAM user or an Active Directory user, that user is inactive until they sign in and provide a password. * `arn` - The Amazon Resource Name (ARN) for the user. +* `custom_permissions_name` - The custom permissions profile associated with this user. * `email` - The user's email address. * `identity_type` - The type of identity authentication used by the user. * `principal_id` - The principal ID of the user. diff --git a/website/docs/d/ram_resource_share.html.markdown b/website/docs/d/ram_resource_share.html.markdown index 8a310e31297c..b00590488668 100644 --- a/website/docs/d/ram_resource_share.html.markdown +++ b/website/docs/d/ram_resource_share.html.markdown @@ -39,7 +39,7 @@ This data source supports the following arguments: * `name` - (Optional) Name of the resource share to retrieve. * `resource_owner` (Required) Owner of the resource share. Valid values are `SELF` or `OTHER-ACCOUNTS`. * `resource_share_status` (Optional) Specifies that you want to retrieve details of only those resource shares that have this status. Valid values are `PENDING`, `ACTIVE`, `FAILED`, `DELETING`, and `DELETED`. -* `filter` - (Optional) Filter used to scope the list e.g., by tags. See [related docs] (https://docs.aws.amazon.com/ram/latest/APIReference/API_TagFilter.html). +* `filter` - (Optional) Filter used to scope the list of owned shares e.g., by tags. See [related docs] (https://docs.aws.amazon.com/ram/latest/APIReference/API_TagFilter.html). * `name` - (Required) Name of the tag key to filter on. * `values` - (Required) Value of the tag key. diff --git a/website/docs/d/rds_reserved_instance_offering.html.markdown b/website/docs/d/rds_reserved_instance_offering.html.markdown index aadde1b6727d..983d2ed94270 100644 --- a/website/docs/d/rds_reserved_instance_offering.html.markdown +++ b/website/docs/d/rds_reserved_instance_offering.html.markdown @@ -31,7 +31,7 @@ This data source supports the following arguments: * `duration` - (Required) Duration of the reservation in years or seconds. Valid values are `1`, `3`, `31536000`, `94608000` * `multi_az` - (Required) Whether the reservation applies to Multi-AZ deployments. * `offering_type` - (Required) Offering type of this reserved DB instance. Valid values are `No Upfront`, `Partial Upfront`, `All Upfront`. -* `product_description` - (Required) Description of the reserved DB instance. +* `product_description` - (Required) Description of the reserved DB instance. Example values are `postgresql`, `aurora-postgresql`, `mysql`, `aurora-mysql`, `mariadb`. ## Attribute Reference diff --git a/website/docs/d/s3_access_point.html.markdown b/website/docs/d/s3_access_point.html.markdown new file mode 100644 index 000000000000..a0c4c98e3925 --- /dev/null +++ b/website/docs/d/s3_access_point.html.markdown @@ -0,0 +1,48 @@ +--- +subcategory: "S3 Control" +layout: "aws" +page_title: "AWS: aws_s3_access_point" +description: |- + Provides details about a specific S3 access point +--- + +# Data Source: aws_s3_access_point + +Provides details about a specific S3 access point. + +## Example Usage + +```terraform +data "aws_s3_access_point" "example" { + name = "example-access-point" +} +``` + +## Argument Reference + +This data source supports the following arguments: + +* `account_id` - (Optional) AWS account ID for the account that owns the specified access point. +* `name` - (Required) Name of the access point. +* `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). + +## Attribute Reference + +This data source exports the following attributes in addition to the arguments above: + +* `alias` - Access point alias. +* `arn` - Access point ARN. +* `bucket` - Name of the bucket associated with the access point. +* `bucket_account_id` - AWS account ID associated with the S3 bucket associated with the access point. +* `data_source_id` - Unique identifier for the data source of the access point. +* `data_source_type` - Type of the data source that the access point is attached to. +* `endpoints` - VPC endpoint for the access point. +* `network_origin` - Indicates whether the access point allows access from the public Internet. +* `public_access_block_configuration` - `PublicAccessBlock` configuration for the access point. + * `block_public_acls` - Whether Amazon S3 blocks public ACLs for buckets in this account. + * `block_public_policy` - Whether Amazon S3 blocks public bucket policies for buckets in this account. + * `ignore_public_acls` - Whether Amazon S3 ignores public ACLs for buckets in this account. + * `restrict_public_buckets` - Whether Amazon S3 restricts public bucket policies for buckets in this account. +* `tags` - Tags assigned to the access point. +* `vpc_configuration` - VPC configuration for the access point. + * `vpc_id` - Access point will only allow connections from this VPC. diff --git a/website/docs/d/secretsmanager_secret_rotation.html.markdown b/website/docs/d/secretsmanager_secret_rotation.html.markdown index 5525ed0b175f..86da4794170a 100644 --- a/website/docs/d/secretsmanager_secret_rotation.html.markdown +++ b/website/docs/d/secretsmanager_secret_rotation.html.markdown @@ -31,6 +31,12 @@ This data source supports the following arguments: This data source exports the following attributes in addition to the arguments above: -* `rotation_enabled` - ARN of the secret. -* `rotation_lambda_arn` - Decrypted part of the protected secret information that was originally provided as a string. -* `rotation_rules` - Decrypted part of the protected secret information that was originally provided as a binary. Base64 encoded. +* `rotation_enabled` - Specifies whether automatic rotation is enabled for this secret. +* `rotation_lambda_arn` - Amazon Resource Name (ARN) of the lambda function used for rotation. +* `rotation_rules` - Configuration block for rotation rules. See [`rotation_rules`](#rotation_rules) below. + +### rotation_rules + +* `automatically_after_days` - Number of days between automatic scheduled rotations of the secret. +* `duration` - Length of the rotation window in hours. +* `schedule_expression` - A `cron()` or `rate()` expression that defines the schedule for rotating the secret. diff --git a/website/docs/d/sesv2_email_identity.html.markdown b/website/docs/d/sesv2_email_identity.html.markdown index c751b2992a88..61a995bbe7db 100644 --- a/website/docs/d/sesv2_email_identity.html.markdown +++ b/website/docs/d/sesv2_email_identity.html.markdown @@ -41,4 +41,5 @@ This data source exports the following attributes in addition to the arguments a * `tokens` - If you used Easy DKIM to configure DKIM authentication for the domain, then this object contains a set of unique strings that you use to create a set of CNAME records that you add to the DNS configuration for your domain. When Amazon SES detects these records in the DNS configuration for your domain, the DKIM authentication process is complete. If you configured DKIM authentication for the domain by providing your own public-private key pair, then this object contains the selector for the public key. * `identity_type` - The email identity type. Valid values: `EMAIL_ADDRESS`, `DOMAIN`. * `tags` - Key-value mapping of resource tags. +* `verification_status` - The verification status of the identity. The status can be one of the following: `PENDING`, `SUCCESS`, `FAILED`, `TEMPORARY_FAILURE`, and `NOT_STARTED`. * `verified_for_sending_status` - Specifies whether or not the identity is verified. diff --git a/website/docs/d/signer_signing_profile.html.markdown b/website/docs/d/signer_signing_profile.html.markdown index bc6ae22f6259..897dae9e71bf 100644 --- a/website/docs/d/signer_signing_profile.html.markdown +++ b/website/docs/d/signer_signing_profile.html.markdown @@ -34,6 +34,9 @@ This data source exports the following attributes in addition to the arguments a * `platform_id` - ID of the platform that is used by the target signing profile. * `revocation_record` - Revocation information for a signing profile. * `signature_validity_period` - The validity period for a signing job. +* `signing_material` - AWS Certificate Manager certificate that will be used to sign code with the new signing profile. + * `certificate_arn` - ARN of the certificate used for signing. +* `signing_parameters` - Map of key-value pairs for signing. * `status` - Status of the target signing profile. * `tags` - List of tags associated with the signing profile. * `version` - Current version of the signing profile. diff --git a/website/docs/d/ssm_patch_baseline.html.markdown b/website/docs/d/ssm_patch_baseline.html.markdown index 01f32b663e6b..77e528816d50 100644 --- a/website/docs/d/ssm_patch_baseline.html.markdown +++ b/website/docs/d/ssm_patch_baseline.html.markdown @@ -61,6 +61,7 @@ This data source exports the following attributes in addition to the arguments a * `patch_filter` - Patch filter group that defines the criteria for the rule. * `key` - Key for the filter. * `values` - Value for the filter. +* `available_security_updates_compliance_status` - Indicates the compliance status of managed nodes for which security-related patches are available but were not approved. Supported for Windows Server managed nodes only. * `global_filter` - Set of global filters used to exclude patches from the baseline. * `key` - Key for the filter. * `values` - Value for the filter. diff --git a/website/docs/d/verifiedpermissions_policy_store.html.markdown b/website/docs/d/verifiedpermissions_policy_store.html.markdown index 969fd41898c4..54e916770bb1 100644 --- a/website/docs/d/verifiedpermissions_policy_store.html.markdown +++ b/website/docs/d/verifiedpermissions_policy_store.html.markdown @@ -33,6 +33,7 @@ This data source exports the following attributes in addition to the arguments a * `arn` - The ARN of the Policy Store. * `created_date` - The date the Policy Store was created. +* `deletion_protection` - Whether the policy store can be deleted. * `last_updated_date` - The date the Policy Store was last updated. * `tags` - Map of key-value pairs associated with the policy store. * `validation_settings` - Validation settings for the policy store. diff --git a/website/docs/d/vpc_ipam.html.markdown b/website/docs/d/vpc_ipam.html.markdown index 028d4f3e91c7..157e1bbf37a5 100644 --- a/website/docs/d/vpc_ipam.html.markdown +++ b/website/docs/d/vpc_ipam.html.markdown @@ -38,6 +38,7 @@ This data source exports the following attributes in addition to the arguments a * `enable_private_gua` - If private GUA is enabled. * `id` - ID of the IPAM resource. * `ipam_region` - Region that the IPAM exists in. +* `metered_account` - AWS account that is charged for active IP addresses managed in IPAM. * `operating_regions` - Regions that the IPAM is configured to operate in. * `owner_id` - ID of the account that owns this IPAM. * `private_default_scope_id` - ID of the default private scope. diff --git a/website/docs/d/wafv2_web_acl.html.markdown b/website/docs/d/wafv2_web_acl.html.markdown index e7818cad9a91..563337705f42 100644 --- a/website/docs/d/wafv2_web_acl.html.markdown +++ b/website/docs/d/wafv2_web_acl.html.markdown @@ -12,6 +12,8 @@ Retrieves the summary of a WAFv2 Web ACL. ## Example Usage +### Lookup by name + ```terraform data "aws_wafv2_web_acl" "example" { name = "some-web-acl" @@ -19,12 +21,27 @@ data "aws_wafv2_web_acl" "example" { } ``` +### Lookup by associated resource + +```terraform +data "aws_wafv2_web_acl" "alb_example" { + resource_arn = "arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/app/my-alb/xxxxx" + scope = "REGIONAL" +} + +data "aws_wafv2_web_acl" "cloudfront_example" { + resource_arn = "arn:aws:cloudfront::123456789012:distribution/XXX" + scope = "CLOUDFRONT" +} +``` + ## Argument Reference This data source supports the following arguments: +* `name` - (Optional) Name of the WAFv2 Web ACL. Exactly one of `name` or `resource_arn` must be specified. * `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). -* `name` - (Required) Name of the WAFv2 Web ACL. +* `resource_arn` - (Optional) ARN of the AWS resource associated with the Web ACL. This can be an ARN of an Application Load Balancer, Amazon API Gateway REST API, AWS AppSync GraphQL API, Amazon Cognito user pool, AWS App Runner service, AWS Verified Access instance, or AWS Amplify application. Exactly one of `name` or `resource_arn` must be specified. * `scope` - (Required) Specifies whether this is for an AWS CloudFront distribution or for a regional application. Valid values are `CLOUDFRONT` or `REGIONAL`. To work with CloudFront, you must also specify the region `us-east-1` (N. Virginia) on the AWS provider. ## Attribute Reference diff --git a/website/docs/guides/custom-service-endpoints.html.markdown b/website/docs/guides/custom-service-endpoints.html.markdown index 1bc7580337e4..9d363d48e057 100644 --- a/website/docs/guides/custom-service-endpoints.html.markdown +++ b/website/docs/guides/custom-service-endpoints.html.markdown @@ -102,6 +102,7 @@ provider "aws" { |App Runner|`apprunner`|`AWS_ENDPOINT_URL_APPRUNNER`|`apprunner`| |AppStream 2.0|`appstream`|`AWS_ENDPOINT_URL_APPSTREAM`|`appstream`| |AppSync|`appsync`|`AWS_ENDPOINT_URL_APPSYNC`|`appsync`| +|Application Resilience Controller Region Switch|`arcregionswitch`|`AWS_ENDPOINT_URL_ARC_REGION_SWITCH`|`arc_region_switch`| |Athena|`athena`|`AWS_ENDPOINT_URL_ATHENA`|`athena`| |Audit Manager|`auditmanager`|`AWS_ENDPOINT_URL_AUDITMANAGER`|`auditmanager`| |Auto Scaling|`autoscaling`|`AWS_ENDPOINT_URL_AUTO_SCALING`|`auto_scaling`| @@ -111,6 +112,7 @@ provider "aws" { |BCM Data Exports|`bcmdataexports`|`AWS_ENDPOINT_URL_BCM_DATA_EXPORTS`|`bcm_data_exports`| |Bedrock|`bedrock`|`AWS_ENDPOINT_URL_BEDROCK`|`bedrock`| |Bedrock Agents|`bedrockagent`|`AWS_ENDPOINT_URL_BEDROCK_AGENT`|`bedrock_agent`| +|Bedrock AgentCore|`bedrockagentcore`|`AWS_ENDPOINT_URL_BEDROCK_AGENTCORE_CONTROL`|`bedrock_agentcore_control`| |Billing|`billing`|`AWS_ENDPOINT_URL_BILLING`|`billing`| |Web Services Budgets|`budgets`|`AWS_ENDPOINT_URL_BUDGETS`|`budgets`| |CE (Cost Explorer)|`ce`(or `costexplorer`)|`AWS_ENDPOINT_URL_COST_EXPLORER`|`cost_explorer`| @@ -250,6 +252,7 @@ provider "aws" { |User Notifications|`notifications`|`AWS_ENDPOINT_URL_NOTIFICATIONS`|`notifications`| |User Notifications Contacts|`notificationscontacts`|`AWS_ENDPOINT_URL_NOTIFICATIONSCONTACTS`|`notificationscontacts`| |CloudWatch Observability Access Manager|`oam`(or `cloudwatchobservabilityaccessmanager`)|`AWS_ENDPOINT_URL_OAM`|`oam`| +|Oracle Database@AWS|`odb`|`AWS_ENDPOINT_URL_ODB`|`odb`| |OpenSearch|`opensearch`(or `opensearchservice`)|`AWS_ENDPOINT_URL_OPENSEARCH`|`opensearch`| |OpenSearch Serverless|`opensearchserverless`|`AWS_ENDPOINT_URL_OPENSEARCHSERVERLESS`|`opensearchserverless`| |Organizations|`organizations`|`AWS_ENDPOINT_URL_ORGANIZATIONS`|`organizations`| @@ -289,6 +292,7 @@ provider "aws" { |S3 Control|`s3control`|`AWS_ENDPOINT_URL_S3_CONTROL`|`s3_control`| |S3 on Outposts|`s3outposts`|`AWS_ENDPOINT_URL_S3OUTPOSTS`|`s3outposts`| |S3 Tables|`s3tables`|`AWS_ENDPOINT_URL_S3TABLES`|`s3tables`| +|S3 Vectors|`s3vectors`|`AWS_ENDPOINT_URL_S3VECTORS`|`s3vectors`| |SageMaker AI|`sagemaker`|`AWS_ENDPOINT_URL_SAGEMAKER`|`sagemaker`| |EventBridge Scheduler|`scheduler`|`AWS_ENDPOINT_URL_SCHEDULER`|`scheduler`| |EventBridge Schemas|`schemas`|`AWS_ENDPOINT_URL_SCHEMAS`|`schemas`| @@ -330,6 +334,7 @@ provider "aws" { |WAF Classic Regional|`wafregional`|`AWS_ENDPOINT_URL_WAF_REGIONAL`|`waf_regional`| |WAF|`wafv2`|`AWS_ENDPOINT_URL_WAFV2`|`wafv2`| |Well-Architected Tool|`wellarchitected`|`AWS_ENDPOINT_URL_WELLARCHITECTED`|`wellarchitected`| +|WorkMail|`workmail`|`AWS_ENDPOINT_URL_WORKMAIL`|`workmail`| |WorkSpaces|`workspaces`|`AWS_ENDPOINT_URL_WORKSPACES`|`workspaces`| |WorkSpaces Web|`workspacesweb`|`AWS_ENDPOINT_URL_WORKSPACES_WEB`|`workspaces_web`| |X-Ray|`xray`|`AWS_ENDPOINT_URL_XRAY`|`xray`| diff --git a/website/docs/index.html.markdown b/website/docs/index.html.markdown index 16961f1e80d8..71cc4b407f39 100644 --- a/website/docs/index.html.markdown +++ b/website/docs/index.html.markdown @@ -7,18 +7,13 @@ description: |- # AWS Provider -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. +The Amazon Web Services (AWS) provider is Terraform’s most widely-used provider and the industry-standard way to manage AWS infrastructure as code. It is an indispensable part of how leading technology companies, global banks, government agencies, and some of the largest enterprises in the world build and operate in the cloud. Every day, it provisions and orchestrates billions of dollars of AWS infrastructure across thousands of organizations. -Use the navigation to the left to read about the available resources. There are currently 1506 resources and 607 data sources available in the provider. +With 1,536 resources and 609 data sources, the AWS provider spans the full breadth of AWS services—from foundational capabilities like compute, storage, networking, and identity management to advanced services for AI, analytics, and event-driven architectures, including Lambda, RDS, SageMaker, and Bedrock. Whether automating a single S3 bucket or orchestrating a multi-region, enterprise-scale environment, the provider delivers consistent, reliable workflows that scale with your needs. -To learn the basics of Terraform using this provider, follow the -hands-on [get started tutorials](https://developer.hashicorp.com/terraform/tutorials/aws-get-started/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, -including Lambda, RDS, and IAM by following the [AWS services -tutorials](https://developer.hashicorp.com/terraform/tutorials/aws?utm_source=WEBSITE&utm_medium=WEB_IO&utm_offer=ARTICLE_PAGE&utm_content=DOCS). +Configure the provider with your AWS credentials, and you can immediately begin creating and managing infrastructure in a safe, repeatable way. Use the navigation on the left to explore the available resources, or start with our [Get Started tutorials](https://developer.hashicorp.com/terraform/tutorials/aws-get-started/infrastructure-as-code?in=terraform/aws-get-started&utm_source=WEBSITE&utm_medium=WEB_IO&utm_offer=ARTICLE_PAGE&utm_content=DOCS) to learn the fundamentals. For deeper guidance on specific AWS services, visit the [AWS services tutorials](https://developer.hashicorp.com/terraform/tutorials/aws?utm_source=WEBSITE&utm_medium=WEB_IO&utm_offer=ARTICLE_PAGE&utm_content=DOCS). -Some AWS services do not support IPv6. As a result, the provider may not be able to interact with AWS APIs using IPv6 addresses. +Note: Some AWS services do not yet support IPv6. In those cases, the provider may not be able to connect to AWS APIs over IPv6 addresses. ## Example Usage diff --git a/website/docs/r/acm_certificate.html.markdown b/website/docs/r/acm_certificate.html.markdown index c8676bbf09c8..674c96860493 100644 --- a/website/docs/r/acm_certificate.html.markdown +++ b/website/docs/r/acm_certificate.html.markdown @@ -168,6 +168,7 @@ This resource supports the following arguments: Supported nested arguments for the `options` configuration block: * `certificate_transparency_logging_preference` - (Optional) Whether certificate details should be added to a certificate transparency log. Valid values are `ENABLED` or `DISABLED`. See https://docs.aws.amazon.com/acm/latest/userguide/acm-concepts.html#concept-transparency for more details. +* `export` - (Optional) Whether the certificate can be exported. Valid values are `ENABLED` or `DISABLED` (default). **Note** Issuing an exportable certificate is subject to additional charges. See [AWS Certificate Manager pricing](https://aws.amazon.com/certificate-manager/pricing/) for more details. ## validation_option Configuration Block diff --git a/website/docs/r/amplify_app.html.markdown b/website/docs/r/amplify_app.html.markdown index 01da90432542..d4ffd08b0b13 100644 --- a/website/docs/r/amplify_app.html.markdown +++ b/website/docs/r/amplify_app.html.markdown @@ -194,7 +194,7 @@ This resource supports the following arguments: * `enable_branch_auto_deletion` - (Optional) Automatically disconnects a branch in the Amplify Console when you delete a branch from your Git repository. * `environment_variables` - (Optional) Environment variables map for an Amplify app. * `iam_service_role_arn` - (Optional) AWS Identity and Access Management (IAM) service role for an Amplify app. -* `job_config` - (Optional) Used to configure the [Amplify Application build settings](https://docs.aws.amazon.com/amplify/latest/userguide/build-settings.html). See [`job_config` Block](#job_config-block) for details. +* `job_config` - (Optional) Used to configure the [Amplify Application build instance compute type](https://docs.aws.amazon.com/amplify/latest/APIReference/API_JobConfig.html#amplify-Type-JobConfig-buildComputeType). See [`job_config` Block](#job_config-block) for details. * `oauth_token` - (Optional) OAuth token for a third-party source control system for an Amplify app. The OAuth token is used to create a webhook and a read-only deploy key. The OAuth token is not stored. * `platform` - (Optional) Platform or framework for an Amplify app. Valid values: `WEB`, `WEB_COMPUTE`. Default value: `WEB`. * `repository` - (Optional) Repository for an Amplify app. diff --git a/website/docs/r/api_gateway_gateway_response.html.markdown b/website/docs/r/api_gateway_gateway_response.html.markdown index 94bdcedde45f..a6cf7d03c7be 100644 --- a/website/docs/r/api_gateway_gateway_response.html.markdown +++ b/website/docs/r/api_gateway_gateway_response.html.markdown @@ -36,9 +36,9 @@ resource "aws_api_gateway_gateway_response" "test" { This resource supports the following arguments: -* `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). +* `region` - (Optional) Region where this resource will be managed. See the [AWS Documentation](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints) for supported values. Defaults to the Region set in the [provider configuration](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#aws-configuration-reference). * `rest_api_id` - (Required) String identifier of the associated REST API. -* `response_type` - (Required) Response type of the associated GatewayResponse. +* `response_type` - (Required) Response type of the associated GatewayResponse. See the [AWS Documentation](https://docs.aws.amazon.com/apigateway/latest/developerguide/supported-gateway-response-types.html) for supported values. * `status_code` - (Optional) HTTP status code of the Gateway Response. * `response_templates` - (Optional) Map of templates used to transform the response body. * `response_parameters` - (Optional) Map of parameters (paths, query strings and headers) of the Gateway Response. diff --git a/website/docs/r/appsync_api.html.markdown b/website/docs/r/appsync_api.html.markdown new file mode 100644 index 000000000000..bdbd1e030c92 --- /dev/null +++ b/website/docs/r/appsync_api.html.markdown @@ -0,0 +1,202 @@ +--- +subcategory: "AppSync" +layout: "aws" +page_title: "AWS: aws_appsync_api" +description: |- + Manages an AWS AppSync Event API. +--- + +# Resource: aws_appsync_api + +Manages an [AWS AppSync Event API](https://docs.aws.amazon.com/appsync/latest/eventapi/event-api-concepts.html#API). Event APIs enable real-time subscriptions and event-driven communication in AppSync applications. + +## Example Usage + +### Basic Usage + +```terraform +resource "aws_appsync_api" "example" { + name = "example-event-api" + + event_config { + auth_provider { + auth_type = "API_KEY" + } + + connection_auth_mode { + auth_type = "API_KEY" + } + + default_publish_auth_mode { + auth_type = "API_KEY" + } + + default_subscribe_auth_mode { + auth_type = "API_KEY" + } + } +} +``` + +### With Cognito Authentication + +```terraform +resource "aws_cognito_user_pool" "example" { + name = "example-user-pool" +} + +resource "aws_appsync_api" "example" { + name = "example-event-api" + + event_config { + auth_provider { + auth_type = "AMAZON_COGNITO_USER_POOLS" + cognito_config { + user_pool_id = aws_cognito_user_pool.example.id + aws_region = data.aws_region.current.name + } + } + + connection_auth_mode { + auth_type = "AMAZON_COGNITO_USER_POOLS" + } + + default_publish_auth_mode { + auth_type = "AMAZON_COGNITO_USER_POOLS" + } + + default_subscribe_auth_mode { + auth_type = "AMAZON_COGNITO_USER_POOLS" + } + } +} + +data "aws_region" "current" {} +``` + +### With Lambda Authorizer + +```terraform +resource "aws_appsync_api" "example" { + name = "example-event-api" + + event_config { + auth_provider { + auth_type = "AWS_LAMBDA" + lambda_authorizer_config { + authorizer_uri = aws_lambda_function.example.invoke_arn + authorizer_result_ttl_in_seconds = 300 + } + } + + connection_auth_mode { + auth_type = "AWS_LAMBDA" + } + + default_publish_auth_mode { + auth_type = "AWS_LAMBDA" + } + + default_subscribe_auth_mode { + auth_type = "AWS_LAMBDA" + } + } +} +``` + +## Argument Reference + +The following arguments are required: + +* `event_config` - (Required) Configuration for the Event API. See [Event Config](#event-config) below. +* `name` - (Required) Name of the Event API. + +The following arguments are optional: + +* `owner_contact` - (Optional) Contact information for the owner of the Event API. +* `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). +* `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. + +### Event Config + +The `event_config` block supports the following: + +* `auth_provider` - (Required) List of authentication providers. See [Auth Providers](#auth-providers) below. +* `connection_auth_mode` - (Required) List of authentication modes for connections. See [Auth Modes](#auth-modes) below. +* `default_publish_auth_mode` - (Required) List of default authentication modes for publishing. See [Auth Modes](#auth-modes) below. +* `default_subscribe_auth_mode` - (Required) List of default authentication modes for subscribing. See [Auth Modes](#auth-modes) below. +* `log_config` - (Optional) Logging configuration. See [Log Config](#log-config) below. + +### Auth Providers + +The `auth_provider` block supports the following: + +* `auth_type` - (Required) Type of authentication provider. Valid values: `AMAZON_COGNITO_USER_POOLS`, `AWS_LAMBDA`, `OPENID_CONNECT`, `API_KEY`. +* `cognito_config` - (Optional) Configuration for Cognito user pool authentication. Required when `auth_type` is `AMAZON_COGNITO_USER_POOLS`. See [Cognito Config](#cognito-config) below. +* `lambda_authorizer_config` - (Optional) Configuration for Lambda authorization. Required when `auth_type` is `AWS_LAMBDA`. See [Lambda Authorizer Config](#lambda-authorizer-config) below. +* `openid_connect_config` - (Optional) Configuration for OpenID Connect. Required when `auth_type` is `OPENID_CONNECT`. See [OpenID Connect Config](#openid-connect-config) below. + +### Cognito Config + +The `cognito_config` block supports the following: + +* `app_id_client_regex` - (Optional) Regular expression for matching the client ID. +* `aws_region` - (Required) AWS region where the user pool is located. +* `user_pool_id` - (Required) ID of the Cognito user pool. + +### Lambda Authorizer Config + +The `lambda_authorizer_config` block supports the following: + +* `authorizer_result_ttl_in_seconds` - (Optional) TTL in seconds for the authorization result cache. +* `authorizer_uri` - (Required) URI of the Lambda function for authorization. +* `identity_validation_expression` - (Optional) Regular expression for identity validation. + +### OpenID Connect Config + +The `openid_connect_config` block supports the following: + +* `auth_ttl` - (Optional) TTL in seconds for the authentication token. +* `client_id` - (Optional) Client ID for the OpenID Connect provider. +* `iat_ttl` - (Optional) TTL in seconds for the issued at time. +* `issuer` - (Required) Issuer URL for the OpenID Connect provider. + +### Auth Modes + +The `connection_auth_mode`, `default_publish_auth_mode`, and `default_subscribe_auth_mode` blocks support the following: + +* `auth_type` - (Required) Type of authentication. Valid values: `API_KEY`, `AWS_IAM`, `AMAZON_COGNITO_USER_POOLS`, `OPENID_CONNECT`, `AWS_LAMBDA`. + +### Log Config + +The `log_config` block supports the following: + +* `cloudwatch_logs_role_arn` - (Required) ARN of the IAM role for CloudWatch logs. +* `log_level` - (Required) Log level. Valid values: `NONE`, `ERROR`, `ALL`, `INFO`, `DEBUG`. + +## Attribute Reference + +This resource exports the following attributes in addition to the arguments above: + +* `api_id` - ID of the Event API. +* `api_arn` - ARN of the Event API. +* `dns` - DNS configuration for the Event API. +* `tags_all` - Map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). +* `waf_web_acl_arn` - ARN of the associated WAF web ACL. + +## Import + +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import AppSync Event API using the `api_id`. For example: + +```terraform +import { + to = aws_appsync_api.example + id = "example-api-id" +} +``` + +Using `terraform import`, import AppSync Event API using the `api_id`. For example: + +```console +% terraform import aws_appsync_api.example example-api-id +``` diff --git a/website/docs/r/appsync_channel_namespace.html.markdown b/website/docs/r/appsync_channel_namespace.html.markdown new file mode 100644 index 000000000000..6b8ad380738f --- /dev/null +++ b/website/docs/r/appsync_channel_namespace.html.markdown @@ -0,0 +1,95 @@ +--- +subcategory: "AppSync" +layout: "aws" +page_title: "AWS: aws_appsync_channel_namespace" +description: |- + Manages an AWS AppSync Channel Namespace. +--- + +# Resource: aws_appsync_channel_namespace + +Manages an [AWS AppSync Channel Namespace](https://docs.aws.amazon.com/appsync/latest/eventapi/event-api-concepts.html#namespace). + +## Example Usage + +### Basic Usage + +```terraform +resource "aws_appsync_channel_namespace" "example" { + name = "example-channel-namespace" + api_id = aws_appsync_api.example.api_id +} +``` + +## Argument Reference + +The following arguments are required: + +* `api_id` - (Required) Event API ID. +* `name` - (Required) Name of the channel namespace. + +The following arguments are optional: + +* `code_handlers` - (Optional) Event handler functions that run custom business logic to process published events and subscribe requests. +* `handler_configs` - (Optional) Configuration for the `on_publish` and `on_subscribe` handlers. See [Handler Configs](#handler-configs) below. +* `publish_auth_mode` - (Optional) Authorization modes to use for publishing messages on the channel namespace. This configuration overrides the default API authorization configuration. See [Auth Modes](#auth-modes) below. +* `subscribe_auth_mode` - (Optional) Authorization modes to use for subscribing to messages on the channel namespace. This configuration overrides the default API authorization configuration. See [Auth Modes](#auth-modes) below. +* `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). +* `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. + +### Auth Modes + +The `publish_auth_mode`, and `subscribe_auth_mode` blocks support the following: + +* `auth_type` - (Required) Type of authentication. Valid values: `API_KEY`, `AWS_IAM`, `AMAZON_COGNITO_USER_POOLS`, `OPENID_CONNECT`, `AWS_LAMBDA`. + +### Handler Configs + +The `handler_configs` block support the following: + +* `on_publish` - (Optional) Handler configuration. See [Handler Config](#handler-config) below. +* `on_subscribe` - (Optional) Handler configuration. See [Handler Config](#handler-config) below. + +### Handler Config + +The `on_publish` and `on_subscribe` blocks support the following: + +* `behavior` - (Required) Behavior for the handler. Valid values: `CODE`, `DIRECT`. +* `integration` - (Required) Integration data source configuration for the handler. See [Integration](#integration) below. + +### Integration + +The `integration` block support the following: + +* `data_source_name` - (Required) Unique name of the data source that has been configured on the API. +* `lambda_config` - (Optional) Configuration for a Lambda data source. See [Lambda Config](#lambda-config) below. + +### Lambad Config + +The `lambda_config` block support the following: + +* `invoke_type` - (Optional) Invocation type for a Lambda data source. Valid values: `REQUEST_RESPONSE`, `EVENT`. + +## Attribute Reference + +This resource exports the following attributes in addition to the arguments above: + +* `channel_namespace_arn` - ARN of the channel namespace. +* `tags_all` - Map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). + +## Import + +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import AppSync Channel Namespace using the `api_id` and `name` separated by a comma (`,`). For example: + +```terraform +import { + to = aws_appsync_channel_namespace.example + id = "example-api-id,example-channel-namespace" +} +``` + +Using `terraform import`, import AppSync Channel Namespace using the `api_id` and `name` separated by a comma (`,`). For example: + +```console +% terraform import aws_appsync_channel_namespace.example example-api-id,example-channel-namespace +``` diff --git a/website/docs/r/appsync_source_api_association.html.markdown b/website/docs/r/appsync_source_api_association.html.markdown index 802f6e4f5869..48847f954096 100644 --- a/website/docs/r/appsync_source_api_association.html.markdown +++ b/website/docs/r/appsync_source_api_association.html.markdown @@ -3,11 +3,11 @@ subcategory: "AppSync" layout: "aws" page_title: "AWS: aws_appsync_source_api_association" description: |- - Terraform resource for managing an AWS AppSync Source Api Association. + Terraform resource for managing an AWS AppSync Source API Association. --- # Resource: aws_appsync_source_api_association -Terraform resource for managing an AWS AppSync Source Api Association. +Terraform resource for managing an AWS AppSync Source API Association. ## Example Usage @@ -42,9 +42,9 @@ The `source_api_association_config` configuration block supports the following a This resource exports the following attributes in addition to the arguments above: -* `arn` - ARN of the Source Api Association. -* `association_id` - ID of the Source Api Association. -* `id` - Combined ID of the Source Api Association and Merge Api. +* `arn` - ARN of the Source API Association. +* `association_id` - ID of the Source API Association. +* `id` - Combined ID of the Source API Association and Merge API. ## Timeouts @@ -56,7 +56,7 @@ This resource exports the following attributes in addition to the arguments abov ## Import -In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import AppSync Source Api Association using the `example_id_arg`. For example: +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import AppSync Source API Association using the `association_id` and `merged_api_id` separated by `,`. For example: ```terraform import { @@ -65,7 +65,7 @@ import { } ``` -Using `terraform import`, import AppSync Source Api Association using the `gzos6bteufdunffzzifiowisoe,243685a0-9347-4a1a-89c1-9b57dea01e31`. For example: +Using `terraform import`, import AppSync Source API Association using the `association_id` and `merged_api_id` separated by `,`. For example: ```console % terraform import aws_appsync_source_api_association.example gzos6bteufdunffzzifiowisoe,243685a0-9347-4a1a-89c1-9b57dea01e31 diff --git a/website/docs/r/athena_database.html.markdown b/website/docs/r/athena_database.html.markdown index 6ad5bbbedc84..e3541b013021 100644 --- a/website/docs/r/athena_database.html.markdown +++ b/website/docs/r/athena_database.html.markdown @@ -36,6 +36,7 @@ This resource supports the following arguments: * `expected_bucket_owner` - (Optional) AWS account ID that you expect to be the owner of the Amazon S3 bucket. * `force_destroy` - (Optional, Default: false) Boolean that indicates all tables should be deleted from the database so that the database can be destroyed without error. The tables are *not* recoverable. * `properties` - (Optional) Key-value map of custom metadata properties for the database definition. +* `workgroup` - (Optional) Name of the workgroup. ### ACL Configuration diff --git a/website/docs/r/athena_workgroup.html.markdown b/website/docs/r/athena_workgroup.html.markdown index 814c2f4f7e90..cbd782a8911c 100644 --- a/website/docs/r/athena_workgroup.html.markdown +++ b/website/docs/r/athena_workgroup.html.markdown @@ -49,19 +49,25 @@ This resource supports the following arguments: * `bytes_scanned_cutoff_per_query` - (Optional) Integer for the upper data usage limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan. Must be at least `10485760`. * `enforce_workgroup_configuration` - (Optional) Boolean whether the settings for the workgroup override client-side settings. For more information, see [Workgroup Settings Override Client-Side Settings](https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html). Defaults to `true`. * `engine_version` - (Optional) Configuration block for the Athena Engine Versioning. For more information, see [Athena Engine Versioning](https://docs.aws.amazon.com/athena/latest/ug/engine-versions.html). See [Engine Version](#engine-version) below. -* `execution_role` - (Optional) Role used in a notebook session for accessing the user's resources. +* `execution_role` - (Optional) Role used to access user resources in notebook sessions and IAM Identity Center enabled workgroups. The property is required for IAM Identity Center enabled workgroups. +* `identity_center_configuration` - (Optional) Configuration block to set up an IAM Identity Center enabled workgroup. See [Identity Center Configuration](#identity-center-configuration) below. * `publish_cloudwatch_metrics_enabled` - (Optional) Boolean whether Amazon CloudWatch metrics are enabled for the workgroup. Defaults to `true`. -* `result_configuration` - (Optional) Configuration block with result settings. See [Result Configuration](#result-configuration) below. * `requester_pays_enabled` - (Optional) If set to true , allows members assigned to a workgroup to reference Amazon S3 Requester Pays buckets in queries. If set to false , workgroup members cannot query data from Requester Pays buckets, and queries that retrieve data from Requester Pays buckets cause an error. The default is false . For more information about Requester Pays buckets, see [Requester Pays Buckets](https://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html) in the Amazon Simple Storage Service Developer Guide. +* `result_configuration` - (Optional) Configuration block with result settings. See [Result Configuration](#result-configuration) below. #### Engine Version * `selected_engine_version` - (Optional) Requested engine version. Defaults to `AUTO`. +#### Identity Center Configuration + +* `enable_identity_center` - (Optional) Specifies whether the workgroup is IAM Identity Center supported. +* `identity_center_instance_arn` - (Optional) The IAM Identity Center instance ARN that the workgroup associates to. + #### Result Configuration -* `encryption_configuration` - (Optional) Configuration block with encryption settings. See [Encryption Configuration](#encryption-configuration) below. * `acl_configuration` - (Optional) That an Amazon S3 canned ACL should be set to control ownership of stored query results. See [ACL Configuration](#acl-configuration) below. +* `encryption_configuration` - (Optional) Configuration block with encryption settings. See [Encryption Configuration](#encryption-configuration) below. * `expected_bucket_owner` - (Optional) AWS account ID that you expect to be the owner of the Amazon S3 bucket. * `output_location` - (Optional) Location in Amazon S3 where your query results are stored, such as `s3://path/to/query/bucket/`. For more information, see [Queries and Query Result Files](https://docs.aws.amazon.com/athena/latest/ug/querying.html). diff --git a/website/docs/r/autoscaling_lifecycle_hook.html.markdown b/website/docs/r/autoscaling_lifecycle_hook.html.markdown index 3d950744e831..361b67466c53 100644 --- a/website/docs/r/autoscaling_lifecycle_hook.html.markdown +++ b/website/docs/r/autoscaling_lifecycle_hook.html.markdown @@ -65,7 +65,7 @@ This resource supports the following arguments: * `heartbeat_timeout` - (Optional) Defines the amount of time, in seconds, that can elapse before the lifecycle hook times out. When the lifecycle hook times out, Auto Scaling performs the action defined in the DefaultResult parameter * `lifecycle_transition` - (Required) Instance state to which you want to attach the lifecycle hook. For a list of lifecycle hook types, see [describe-lifecycle-hook-types](https://docs.aws.amazon.com/cli/latest/reference/autoscaling/describe-lifecycle-hook-types.html#examples) * `notification_metadata` - (Optional) Contains additional information that you want to include any time Auto Scaling sends a message to the notification target. -* `notification_target_arn` - (Optional) ARN of the notification target that Auto Scaling will use to notify you when an instance is in the transition state for the lifecycle hook. This ARN target can be either an SQS queue or an SNS topic. +* `notification_target_arn` - (Optional) ARN of the notification target that Auto Scaling will use to notify you when an instance is in the transition state for the lifecycle hook. This ARN target can be either an SQS queue, an SNS topic, or a Lambda function. * `role_arn` - (Optional) ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target. ## Attribute Reference diff --git a/website/docs/r/batch_compute_environment.html.markdown b/website/docs/r/batch_compute_environment.html.markdown index 2d4a0bc3daea..8f2f49b9f334 100644 --- a/website/docs/r/batch_compute_environment.html.markdown +++ b/website/docs/r/batch_compute_environment.html.markdown @@ -225,6 +225,7 @@ This resource supports the following arguments: `ec2_configuration` supports the following: * `image_id_override` - (Optional) The AMI ID used for instances launched in the compute environment that match the image type. This setting overrides the `image_id` argument in the [`compute_resources`](#compute_resources) block. +* `image_kubernetes_version` - (Optional) The Kubernetes version for the compute environment. If you don't specify a value, the latest version that AWS Batch supports is used. See [Supported Kubernetes versions](https://docs.aws.amazon.com/batch/latest/userguide/supported_kubernetes_version.html) for the list of Kubernetes versions supported by AWS Batch on Amazon EKS. * `image_type` - (Optional) The image type to match with the instance type to select an AMI. If the `image_id_override` parameter isn't specified, then a recent [Amazon ECS-optimized Amazon Linux 2 AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#al2ami) (`ECS_AL2`) is used. ### launch_template @@ -247,7 +248,7 @@ This resource supports the following arguments: `update_policy` supports the following: * `job_execution_timeout_minutes` - (Required) Specifies the job timeout (in minutes) when the compute environment infrastructure is updated. -* `terminate_jobs_on_update` - (Required) Specifies whether jobs are automatically terminated when the computer environment infrastructure is updated. +* `terminate_jobs_on_update` - (Required) Specifies whether jobs are automatically terminated when the compute environment infrastructure is updated. ## Attribute Reference diff --git a/website/docs/r/batch_job_definition.html.markdown b/website/docs/r/batch_job_definition.html.markdown index 7a3e03875298..5585e30e0559 100644 --- a/website/docs/r/batch_job_definition.html.markdown +++ b/website/docs/r/batch_job_definition.html.markdown @@ -344,7 +344,7 @@ The following arguments are optional: #### eks_metadata -* `labels` - Key-value pairs used to identify, sort, and organize cube resources. +* `labels` - Key-value pairs used to identify, sort, and organize kubernetes resources. #### `eks_secret` diff --git a/website/docs/r/bcmdataexports_export.html.markdown b/website/docs/r/bcmdataexports_export.html.markdown index 90a2e5cca33a..4b0578ace7ca 100644 --- a/website/docs/r/bcmdataexports_export.html.markdown +++ b/website/docs/r/bcmdataexports_export.html.markdown @@ -15,6 +15,9 @@ Terraform resource for managing an AWS BCM Data Exports Export. ### Basic Usage ```terraform +data "aws_caller_identity" "current" {} +data "aws_partition" "current" {} + resource "aws_bcmdataexports_export" "test" { export { name = "testexample" @@ -22,6 +25,7 @@ resource "aws_bcmdataexports_export" "test" { query_statement = "SELECT identity_line_item_id, identity_time_interval, line_item_product_code,line_item_unblended_cost FROM COST_AND_USAGE_REPORT" table_configurations = { COST_AND_USAGE_REPORT = { + BILLING_VIEW_ARN = "arn:${data.aws_partition.current.partition}:billing::${data.aws_caller_identity.current.account_id}:billingview/primary" TIME_GRANULARITY = "HOURLY", INCLUDE_RESOURCES = "FALSE", INCLUDE_MANUAL_DISCOUNT_COMPATIBILITY = "FALSE", @@ -66,8 +70,8 @@ The following arguments are required: ### `data_query` Argument Reference -* `query_statement` - (Required) Query statement. -* `table_configurations` - (Optional) Table configuration. +* `query_statement` - (Required) Query statement. The SQL table name for CUR 2.0 is `COST_AND_USAGE_REPORT`. See the [AWS documentation](https://docs.aws.amazon.com/cur/latest/userguide/table-dictionary-cur2.html) for a list of available columns. +* `table_configurations` - (Optional) Table configuration. See the [AWS documentation](https://docs.aws.amazon.com/cur/latest/userguide/table-dictionary-cur2.html#cur2-table-configurations) for the available configurations. In addition to those listed in the documentation, `BILLING_VIEW_ARN` must also be included, as shown in the example above. ### `destination_configurations` Argument Reference diff --git a/website/docs/r/bedrock_guardrail.html.markdown b/website/docs/r/bedrock_guardrail.html.markdown index b5a7b08b8754..8d01928ef910 100644 --- a/website/docs/r/bedrock_guardrail.html.markdown +++ b/website/docs/r/bedrock_guardrail.html.markdown @@ -27,19 +27,30 @@ resource "aws_bedrock_guardrail" "example" { output_strength = "MEDIUM" type = "HATE" } + tier_config { + tier_name = "STANDARD" + } } sensitive_information_policy_config { pii_entities_config { - action = "BLOCK" - type = "NAME" + action = "BLOCK" + input_action = "BLOCK" + output_action = "ANONYMIZE" + input_enabled = true + output_enabled = true + type = "NAME" } regexes_config { - action = "BLOCK" - description = "example regex" - name = "regex_example" - pattern = "^\\d{3}-\\d{2}-\\d{4}$" + action = "BLOCK" + input_action = "BLOCK" + output_action = "BLOCK" + input_enabled = true + output_enabled = false + description = "example regex" + name = "regex_example" + pattern = "^\\d{3}-\\d{2}-\\d{4}$" } } @@ -50,6 +61,9 @@ resource "aws_bedrock_guardrail" "example" { type = "DENY" definition = "Investment advice refers to inquiries, guidance, or recommendations regarding the management or allocation of funds or assets with the goal of generating returns ." } + tier_config { + tier_name = "CLASSIC" + } } word_policy_config { @@ -89,6 +103,7 @@ The `content_policy_config` configuration block supports the following arguments * `filters_config` - (Optional) Set of content filter configs in content policy. See [Filters Config](#content-filters-config) for more information. +* `tier_config` - (Optional) Configuration block for the content policy tier. See [Tier Config](#content-tier-config) for more information. #### Content Filters Config @@ -98,6 +113,12 @@ The `filters_config` configuration block supports the following arguments: * `output_strength` - (Optional) Strength for filters. * `type` - (Optional) Type of filter in content policy. +#### Content Tier Config + +The `tier_config` configuration block supports the following arguments: + +* `tier_name` - (Required) The name of the content policy tier. Valid values include STANDARD or CLASSIC. + ### Contextual Grounding Policy Config * `filters_config` (Required) List of contextual grounding filter configs. See [Contextual Grounding Filters Config](#contextual-grounding-filters-config) for more information. @@ -109,8 +130,17 @@ The `filters_config` configuration block supports the following arguments: * `threshold` - (Required) The threshold for this filter. * `type` - (Required) Type of contextual grounding filter. +### Cross Region Inference + +* `cross_region_config` (Optional) Configuration block to enable cross-region routing for bedrock guardrails. See [Cross Region Config](#cross-region-config for more information. Note see [available regions](https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-cross-region.html) here. + +#### Cross Region Config + +* `guardrail_profile_identifier` (Required) Guardrail profile ARN. + ### Topic Policy Config +* `tier_config` - (Optional) Configuration block for the topic policy tier. See [Tier Config](#topics-tier-config) for more information. * `topics_config` (Required) List of topic configs in topic policy. See [Topics Config](#topics-config) for more information. #### Topics Config @@ -120,6 +150,12 @@ The `filters_config` configuration block supports the following arguments: * `type` (Required) Type of topic in a policy. * `examples` (Optional) List of text examples. +#### Topics Tier Config + +The `tier_config` configuration block supports the following arguments: + +* `tier_name` - (Required) The name of the content policy tier. Valid values include STANDARD or CLASSIC. + ### Sensitive Information Policy Config * `pii_entities_config` (Optional) List of entities. See [PII Entities Config](#pii-entities-config) for more information. @@ -127,13 +163,21 @@ The `filters_config` configuration block supports the following arguments: #### PII Entities Config -* `action` (Required) Options for sensitive information action. +* `action` (Required) Options for sensitive information action. Valid values: `BLOCK`, `ANONYMIZE`, `NONE`. +* `input_action` (Optional) Action to take when harmful content is detected in the input. Valid values: `BLOCK`, `ANONYMIZE`, `NONE`. +* `input_enabled` (Optional) Whether to enable guardrail evaluation on the input. When disabled, you aren't charged for the evaluation. +* `output_action` (Optional) Action to take when harmful content is detected in the output. Valid values: `BLOCK`, `ANONYMIZE`, `NONE`. +* `output_enabled` (Optional) Whether to enable guardrail evaluation on the output. When disabled, you aren't charged for the evaluation. * `type` (Required) The currently supported PII entities. #### Regexes Config -* `action` (Required) Options for sensitive information action. +* `action` (Required) Options for sensitive information action. Valid values: `BLOCK`, `ANONYMIZE`, `NONE`. +* `input_action` (Optional) Action to take when harmful content is detected in the input. Valid values: `BLOCK`, `ANONYMIZE`, `NONE`. +* `input_enabled` (Optional) Whether to enable guardrail evaluation on the input. When disabled, you aren't charged for the evaluation. * `name` (Required) The regex name. +* `output_action` (Optional) Action to take when harmful content is detected in the output. Valid values: `BLOCK`, `ANONYMIZE`, `NONE`. +* `output_enabled` (Optional) Whether to enable guardrail evaluation on the output. When disabled, you aren't charged for the evaluation. * `pattern` (Required) The regex pattern. * `description` (Optional) The regex description. diff --git a/website/docs/r/bedrock_inference_profile.html.markdown b/website/docs/r/bedrock_inference_profile.html.markdown index c7fe84deea70..5ab1bdc9e701 100644 --- a/website/docs/r/bedrock_inference_profile.html.markdown +++ b/website/docs/r/bedrock_inference_profile.html.markdown @@ -79,7 +79,7 @@ This resource exports the following attributes in addition to the arguments abov ## Import -In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import Bedrock Inference Profile using the `example_id_arg`. For example: +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import Bedrock Inference Profile using the `name`. For example: ```terraform import { @@ -88,7 +88,7 @@ import { } ``` -Using `terraform import`, import Bedrock Inference Profile using the `example_id_arg`. For example: +Using `terraform import`, import Bedrock Inference Profile using the `name`. For example: ```console % terraform import aws_bedrock_inference_profile.example inference_profile-id-12345678 diff --git a/website/docs/r/bedrockagent_agent_collaborator.html.markdown b/website/docs/r/bedrockagent_agent_collaborator.html.markdown index 7698f25c5201..d0b27f058014 100644 --- a/website/docs/r/bedrockagent_agent_collaborator.html.markdown +++ b/website/docs/r/bedrockagent_agent_collaborator.html.markdown @@ -108,7 +108,7 @@ The following arguments are required: * `agent_id` - (Required) ID if the agent to associate the collaborator. * `collaboration_instruction` - (Required) Instruction to give the collaborator. -* `collbaorator_name` - (Required) Name of this collaborator. +* `collaborator_name` - (Required) Name of this collaborator. The following arguments are optional: diff --git a/website/docs/r/bedrockagent_flow.html.markdown b/website/docs/r/bedrockagent_flow.html.markdown new file mode 100644 index 000000000000..200c760cbb81 --- /dev/null +++ b/website/docs/r/bedrockagent_flow.html.markdown @@ -0,0 +1,408 @@ +--- +subcategory: "Bedrock Agents" +layout: "aws" +page_title: "AWS: aws_bedrockagent_flow" +description: |- + Terraform resource for managing an AWS Bedrock Agents Flow. +--- + +# Resource: aws_bedrockagent_flow + +Terraform resource for managing an AWS Bedrock Agents Flow. + +### Basic Usage + +```terraform +resource "aws_bedrockagent_flow" "example" { + name = "example-flow" + execution_role_arn = aws_iam_role.example.arn +} +``` + +## Example Usage + +The default definition: + +```terraform +resource "aws_bedrockagent_flow" "example" { + name = "example" + execution_role_arn = aws_iam_role.example.arn + + definition { + connection { + name = "FlowInputNodeFlowInputNode0ToPrompt_1PromptsNode0" + source = "FlowInputNode" + target = "Prompt_1" + type = "Data" + + configuration { + data { + source_output = "document" + target_input = "topic" + } + } + } + connection { + name = "Prompt_1PromptsNode0ToFlowOutputNodeFlowOutputNode0" + source = "Prompt_1" + target = "FlowOutputNode" + type = "Data" + + configuration { + data { + source_output = "modelCompletion" + target_input = "document" + } + } + } + node { + name = "FlowInputNode" + type = "Input" + + configuration { + input {} + } + + output { + name = "document" + type = "String" + } + } + node { + name = "Prompt_1" + type = "Prompt" + + configuration { + prompt { + source_configuration { + inline { + model_id = "amazon.titan-text-express-v1" + template_type = "TEXT" + + inference_configuration { + text { + max_tokens = 2048 + stop_sequences = ["User:"] + temperature = 0 + top_p = 0.8999999761581421 + } + } + + template_configuration { + text { + text = "Write a paragraph about {{topic}}." + + input_variable { + name = "topic" + } + } + } + } + } + } + } + + input { + expression = "$.data" + name = "topic" + type = "String" + } + + output { + name = "modelCompletion" + type = "String" + } + } + node { + name = "FlowOutputNode" + type = "Output" + + configuration { + output {} + } + + input { + expression = "$.data" + name = "document" + type = "String" + } + } + } +} +``` + +## Argument Reference + +The following arguments are required: + +* `name` - (Required) A name for the flow. +* `execution_role_arn` - (Required) The Amazon Resource Name (ARN) of the service role with permissions to create and manage a flow. For more information, see [Create a service role for flows in Amazon Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/flows-permissions.html) in the Amazon Bedrock User Guide. + +The following arguments are optional: + +* `description` - (Optional) A description for the flow. +* `customer_encryption_key_arn` - (Optional) The Amazon Resource Name (ARN) of the KMS key to encrypt the flow. +* `definition` - (Optional) A definition of the nodes and connections between nodes in the flow. See [Definition](#definition) for more information. +* `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). +* `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. + +### Definition + +* `connection` - (Optional) A list of connection definitions in the flow. See [Connection](#connection) for more information. +* `node` - (Optional) A list of node definitions in the flow. See [Node](#node) for more information. + +### Connection + +* `name` - (Required) A name for the connection that you can reference. +* `source` - (Required) The node that the connection starts at. +* `target` - (Required) The node that the connection ends at. +* `type` - (Required) Whether the source node that the connection begins from is a condition node `Conditional` or not `Data`. +* `configuration` - (Required) Configuration of the connection. See [Connection Configuration](#connection-configuration) for more information. + +### Connection Configuration + +* `data` - (Optional) The configuration of a connection originating from a node that isn’t a Condition node. See [Data Connection Configuration](#data-connection-configuration) for more information. +* `conditional` - (Optional) The configuration of a connection originating from a Condition node. See [Conditional Connection Configuration](#conditional-connection-configuration) for more information. + +#### Data Connection Configuration + +* `source_output` - (Required) The name of the output in the source node that the connection begins from. +* `target_input` - (Required) The name of the input in the target node that the connection ends at. + +#### Conditional Connection Configuration + +* `condition` - (Required) The condition that triggers this connection. For more information about how to write conditions, see the Condition node type in the [Node types](https://docs.aws.amazon.com/bedrock/latest/userguide/node-types.html) topic in the Amazon Bedrock User Guide. + +### Node + +* `name` - (Required) A name for the node. +* `type` - (Required) The type of node. This value must match the name of the key that you provide in the configuration. Valid values: `Agent`, `Collector`, `Condition`, `Input`, `Iterator`, `KnowledgeBase`, `LambdaFunction`, `Lex`, `Output`, `Prompt`, `Retrieval`, `Storage` +* `configuration` - (Required) Contains configurations for the node. See [Node Configuration](#node-configuration) for more information. +* `input` - (Optional) A list of objects containing information about an input into the node. See [Node Input](#node-input) for more information. +* `output` - (Optional) A list of objects containing information about an output from the node. See [Node Output](#node-output) for more information. + +### Node Input + +* `name` - (Required) A name for the input that you can reference. +* `type` - (Required) The data type of the input. If the input doesn’t match this type at runtime, a validation error will be thrown. +* `expression` - (Required) An expression that formats the input for the node. For an explanation of how to create expressions, see [Expressions in Prompt flows in Amazon Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/flows-expressions.html). +* `category` - (Optional) How input data flows between iterations in a DoWhile loop. + +### Node Output + +* `name` - (Required) A name for the output that you can reference. +* `type` - (Required) The data type of the output. If the output doesn’t match this type at runtime, a validation error will be thrown. + +### Node Configuration + +* `agent` - (Optional) Contains configurations for an agent node in your flow. Invokes an alias of an agent and returns the response. See [Agent Node Configuration](#agent-node-configuration) for more information. +* `collector` - (Optional) Contains configurations for a collector node in your flow. Collects an iteration of inputs and consolidates them into an array of outputs. This object has no fields. +* `condition` - (Optional) Contains configurations for a Condition node in your flow. Defines conditions that lead to different branches of the flow. See [Condition Node Configuration](#condition-node-configuration) for more information. +* `inline_code` - (Optional) Contains configurations for an inline code node in your flow. See [Inline Code Node Configuration](#inline-code-node-configuration) for more information. +* `input` - (Optional) Contains configurations for an input flow node in your flow. The node `inputs` can’t be specified for this node. This object has no fields. +* `iterator` - (Optional) Contains configurations for an iterator node in your flow. Takes an input that is an array and iteratively sends each item of the array as an output to the following node. The size of the array is also returned in the output. The output flow node at the end of the flow iteration will return a response for each member of the array. To return only one response, you can include a collector node downstream from the iterator node. This object has no fields. +* `knowledge_base` - (Optional) Contains configurations for a knowledge base node in your flow. Queries a knowledge base and returns the retrieved results or generated response. See [Knowledge Base Node Configuration](#knowledge-base-node-configuration) for more information. +* `lambda_function` - (Optional) Contains configurations for a Lambda function node in your flow. Invokes a Lambda function. See [Lambda Function Node Configuration](#lambda-function-node-configuration) for more information. +* `lex` - (Optional) Contains configurations for a Lex node in your flow. Invokes an Amazon Lex bot to identify the intent of the input and return the intent as the output. See [Lex Node Configuration](#lex-node-configuration) for more information. +* `output` - (Optional) Contains configurations for an output flow node in your flow. The node `outputs` can’t be specified for this node. This object has no fields. +* `prompt` - (Optional) Contains configurations for a prompt node in your flow. Runs a prompt and generates the model response as the output. You can use a prompt from Prompt management or you can configure one in this node. See [Prompt Node Configuration](#prompt-node-configuration) for more information. +* `retrieval` - (Optional) Contains configurations for a Retrieval node in your flow. Retrieves data from an Amazon S3 location and returns it as the output. See [Retrieval Node Configuration](#retrieval-node-configuration) for more information. +* `storage` - (Optional) Contains configurations for a Storage node in your flow. Stores an input in an Amazon S3 location. See [Storage Node Configuration](#storage-node-configuration) for more information. + +### Agent Node Configuration + +* `agent_alias_arn` - (Required) The Amazon Resource Name (ARN) of the alias of the agent to invoke. + +### Condition Node Configuration + +* `condition` - (Optional) A list of conditions. See [Condition Config](#condition-config) for more information. + +#### Condition Config + +* `name` - (Required) A name for the condition that you can reference. +* `expression` - (Optional) Defines the condition. You must refer to at least one of the inputs in the condition. For more information, expand the Condition node section in [Node types in prompt flows](https://docs.aws.amazon.com/bedrock/latest/userguide/flows-how-it-works.html#flows-nodes). + +### Inline Code Node Configuration + +* `code` - (Required) The code that's executed in your inline code node. +* `language` - (Required) The programming language used by your inline code node. + +### Knowledge Base Node Configuration + +* `knowledge_base_id` - (Required) The unique identifier of the knowledge base to query. +* `model_id` - (Required) The unique identifier of the model or inference profile to use to generate a response from the query results. Omit this field if you want to return the retrieved results as an array. +* `guardrail_configuration` - (Required) Contains configurations for a guardrail to apply during query and response generation for the knowledge base in this configuration. See [Guardrail Configuration](#guardrail-configuration) for more information. + +#### Guardrail Configuration + +* `guardrail_identifier` - (Required) The unique identifier of the guardrail. +* `guardrail_version` - (Required) The version of the guardrail. + +### Lambda Function Node Configuration + +* `lambda_arn` - (Required) The Amazon Resource Name (ARN) of the Lambda function to invoke. + +### Lex Node Configuration + +* `bot_alias_arn` - (Required) The Amazon Resource Name (ARN) of the Amazon Lex bot alias to invoke. +* `locale_id` - (Required) The Region to invoke the Amazon Lex bot in + +### Prompt Node Configuration + +* `resource` - (Optional) Contains configurations for a prompt from Prompt management. See [Prompt Resource Configuration](#prompt-resource-configuration) for more information. +* `inline` - (Optional) Contains configurations for a prompt that is defined inline. See [Prompt Inline Configuration](#prompt-inline-configuration) for more information. + +#### Prompt Resource Configuration + +* `prompt_arn` - (Required) The Amazon Resource Name (ARN) of the prompt from Prompt management. + +#### Prompt Inline Configuration + +* `additional_model_request_fields` - (Optional) Additional fields to be included in the model request for the Prompt node. +* `inference_configuration` - (Optional) Contains inference configurations for the prompt. See [Prompt Inference Configuration](#prompt-inference-configuration) for more information. +* `model_id` - (Required) The unique identifier of the model or [inference profile](https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference.html) to run inference with. +* `template_type` - (Required) The type of prompt template. Valid values: `TEXT`, `CHAT`. +* `template_configuration` - (Required) Contains a prompt and variables in the prompt that can be replaced with values at runtime. See [Prompt Template Configuration](#prompt-template-configuration) for more information. + +#### Prompt Inference Configuration + +* `text` - (Optional) Contains inference configurations for a text prompt. See [Text Inference Configuration](#text-inference-configuration) for more information. + +#### Text Inference Configuration + +* `max_tokens` - (Optional) Maximum number of tokens to return in the response. +* `stop_sequences` - (Optional) List of strings that define sequences after which the model will stop generating. +* `temperature` - (Optional) Controls the randomness of the response. Choose a lower value for more predictable outputs and a higher value for more surprising outputs. +* `top_p` - (Optional) Percentage of most-likely candidates that the model considers for the next token. + +#### Prompt Template Configuration + +* `text` - (Optional) Contains configurations for the text in a message for a prompt. See [Text Template Configuration](#text-template-configuration) +* `chat` - (Optional) Contains configurations to use the prompt in a conversational format. See [Chat Template Configuration](#chat-template-configuration) for more information. + +#### Text Template Configuration + +* `text` - (Required) The message for the prompt. +* `input_variable` - (Optional) A list of variables in the prompt template. See [Input Variable](#input-variable) for more information. +* `cache_point` - (Optional) A cache checkpoint within a template configuration. See [Cache Point](#cache-point) for more information. + +#### Chat Template Configuration + +* `input_variable` - (Optional) A list of variables in the prompt template. See [Input Variable](#input-variable) for more information. +* `message` - (Optional) A list of messages in the chat for the prompt. See [Message](#message) for more information. +* `system` - (Optional) A list of system prompts to provide context to the model or to describe how it should behave. See [System](#system) for more information. +* `tool_configuration` - (Optional) Configuration information for the tools that the model can use when generating a response. See [Tool Configuration](#tool-configuration) for more information. + +#### Message + +* `role` - (Required) The role that the message belongs to. +* `content` - (Required) Contains the content for the message you pass to, or receive from a model. See [Message Content] for more information. + +#### Message Content + +* `cache_point` - (Optional) Creates a cache checkpoint within a message. See [Cache Point](#cache-point) for more information. +* `text` - (Optional) The text in the message. + +#### System + +* `cache_point` - (Optional) Creates a cache checkpoint within a tool designation. See [Cache Point](#cache-point) for more information. +* `text` - (Optional) The text in the system prompt. + +#### Tool Configuration + +* `tool_choice` - (Optional) Defines which tools the model should request when invoked. See [Tool Choice](#tool-choice) for more information. +* `tool` - (Optional) A list of tools to pass to a model. See [Tool](#tool) for more information. + +#### Tool Choice + +* `any` - (Optional) Defines tools, at least one of which must be requested by the model. No text is generated but the results of tool use are sent back to the model to help generate a response. This object has no fields. +* `auto` - (Optional) Defines tools. The model automatically decides whether to call a tool or to generate text instead. This object has no fields. +* `tool` - (Optional) Defines a specific tool that the model must request. No text is generated but the results of tool use are sent back to the model to help generate a response. See [Named Tool](#named-tool) for more information. + +#### Named Tool + +* `name` - (Required) The name of the tool. + +#### Tool + +* `cache_point` - (Optional) Creates a cache checkpoint within a tool designation. See [Cache Point](#cache-point) for more information. +* `tool_spec` - (Optional) The specification for the tool. See [Tool Specification](#tool-specification) for more information. + +#### Tool Specification + +* `name` - (Required) The name of the tool. +* `description` - (Optional) The description of the tool. +* `input_schema` - (Optional) The input schema of the tool. See [Tool Input Schema](#tool-input-schema) for more information. + +#### Tool Input Schema + +* `json` - (Optional) A JSON object defining the input schema for the tool. + +#### Input Variable + +* `name` - (Required) The name of the variable. + +#### Cache Point + +* `type` - (Required) Indicates that the CachePointBlock is of the default type. Valid values: `default`. + +### Retrieval Node Configuration + +* `service_configuration` - (Required) Contains configurations for the service to use for retrieving data to return as the output from the node. See [Retrieval Service Configuration](#retrieval-service-configuration) for more information. + +#### Retrieval Service Configuration + +* `s3` - (Optional) Contains configurations for the Amazon S3 location from which to retrieve data to return as the output from the node. See [Retrieval S3 Service Configuration](#retrieval-s3-service-configuration) for more information. + +#### Retrieval S3 Service Configuration + +* `bucket_name` - (Required) The name of the Amazon S3 bucket from which to retrieve data. + +### Storage Node Configuration + +* `service_configuration` - (Required) Contains configurations for a Storage node in your flow. Stores an input in an Amazon S3 location. See [Storage Service Configuration](#storage-service-configuration) for more information. + +#### Storage Service Configuration + +* `s3` - (Optional) Contains configurations for the service to use for storing the input into the node. See [Storage S3 Service Configuration](#storage-s3-service-configuration) for more information. + +#### Storage S3 Service Configuration + +* `bucket_name` - (Required) The name of the Amazon S3 bucket in which to store the input into the node. + +## Attribute Reference + +This resource exports the following attributes in addition to the arguments above: + +* `arn` - The Amazon Resource Name (ARN) of the flow. +* `id` - The unique identifier of the flow. +* `created_at` - The time at which the flow was created. +* `updated_at` - The time at which the flow was last updated. +* `version` - The version of the flow. +* `status` - The status of the flow. +* `tags_all` - A map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). + +## Timeouts + +[Configuration options](https://developer.hashicorp.com/terraform/language/resources/syntax#operation-timeouts): + +* `create` - (Default `5m`) +* `update` - (Default `5m`) +* `delete` - (Default `5m`) + +## Import + +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import Bedrock Agents Flow using the `id`. For example: + +```terraform +import { + to = aws_bedrockagent_flow.example + id = "ABCDEFGHIJ" +} +``` + +Using `terraform import`, import Bedrock Agents Flow using the `id`. For example: + +```console +% terraform import aws_bedrockagent_flow.example ABCDEFGHIJ +``` diff --git a/website/docs/r/cleanrooms_collaboration.html.markdown b/website/docs/r/cleanrooms_collaboration.html.markdown index 4f6c3b9b80ff..03b07b4a6233 100644 --- a/website/docs/r/cleanrooms_collaboration.html.markdown +++ b/website/docs/r/cleanrooms_collaboration.html.markdown @@ -8,13 +8,11 @@ description: |- # Resource: aws_cleanrooms_collaboration -Provides a AWS Clean Rooms collaboration. All members included in the definition will be invited to -join the collaboration and can create memberships. +Provides a AWS Clean Rooms collaboration. +All members included in the definition will be invited to join the collaboration and can create memberships. ## Example Usage -### Collaboration with tags - ```terraform resource "aws_cleanrooms_collaboration" "test_collaboration" { name = "terraform-example-collaboration" @@ -22,6 +20,7 @@ resource "aws_cleanrooms_collaboration" "test_collaboration" { creator_display_name = "Creator " description = "I made this collaboration with terraform!" query_log_status = "DISABLED" + analytics_engine = "SPARK" data_encryption_metadata { allow_clear_text = true @@ -39,21 +38,23 @@ resource "aws_cleanrooms_collaboration" "test_collaboration" { tags = { Project = "Terraform" } - } ``` ## Argument Reference -This resource supports the following arguments: +The following arguments are required: -* `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). * `name` - (Required) - The name of the collaboration. Collaboration names do not need to be unique. * `description` - (Required) - A description for a collaboration. * `creator_member_abilities` - (Required - Forces new resource) - The list of member abilities for the creator of the collaboration. Valid values [may be found here](https://docs.aws.amazon.com/clean-rooms/latest/apireference/API_CreateCollaboration.html#API-CreateCollaboration-request-creatorMemberAbilities). * `creator_display_name` - (Required - Forces new resource) - The name for the member record for the collaboration creator. * `query_log_status` - (Required - Forces new resource) - Determines if members of the collaboration can enable query logs within their own. emberships. Valid values [may be found here](https://docs.aws.amazon.com/clean-rooms/latest/apireference/API_CreateCollaboration.html#API-CreateCollaboration-request-queryLogStatus). + +The following arguments are optional: + +* `analytics_engine` - (Optional) Analytics engine used by the collaboration. Valid values are `CLEAN_ROOMS_SQL` (deprecated) and `SPARK`. * `data_encryption_metadata` - (Required - Forces new resource) - a collection of settings which determine how the [c3r client](https://docs.aws.amazon.com/clean-rooms/latest/userguide/crypto-computing.html) will encrypt data for use within this collaboration. * `data_encryption_metadata.allow_clear_text` - (Required - Forces new resource) - Indicates whether encrypted tables can contain cleartext data. This is a boolea field. @@ -67,17 +68,18 @@ or cryptographically processed (false). * `member.account_id` - (Required - Forces new resource) - The account id for the invited member. * `member.display_name` - (Required - Forces new resource) - The display name for the invited member. * `member.member_abilities` - (Required - Forces new resource) - The list of abilities for the invited member. Valid values [may be found here](https://docs.aws.amazon.com/clean-rooms/latest/apireference/API_CreateCollaboration.html#API-CreateCollaboration-request-creatorMemberAbilities). +* `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). * `tags` - (Optional) - Key value pairs which tag the collaboration. ## Attribute Reference This resource exports the following attributes in addition to the arguments above: -* `arn` - The arn of the collaboration. -* `id` - The id of the collaboration. -* `create_time` - The date and time the collaboration was created. +* `arn` - ARN of the collaboration. +* `id` - ID of the collaboration. +* `create_time` - Date and time the collaboration was created. * `member status` - For each member included in the collaboration an additional computed attribute of status is added. These values [may be found here](https://docs.aws.amazon.com/clean-rooms/latest/apireference/API_MemberSummary.html#API-Type-MemberSummary-status). -* `updated_time` - The date and time the collaboration was last updated. +* `updated_time` - Date and time the collaboration was last updated. ## Timeouts diff --git a/website/docs/r/cloudfront_distribution.html.markdown b/website/docs/r/cloudfront_distribution.html.markdown index b6c0dd3be379..dd60ea8bd36e 100644 --- a/website/docs/r/cloudfront_distribution.html.markdown +++ b/website/docs/r/cloudfront_distribution.html.markdown @@ -216,9 +216,11 @@ resource "aws_cloudfront_distribution" "s3_distribution" { # AWS Managed Caching Policy (CachingDisabled) default_cache_behavior { # Using the CachingDisabled managed policy ID: - cache_policy_id = "4135ea2d-6df8-44a3-9df3-4b5a84be39ad" - allowed_methods = ["GET", "HEAD", "OPTIONS"] - target_origin_id = local.s3_origin_id + cache_policy_id = "4135ea2d-6df8-44a3-9df3-4b5a84be39ad" + allowed_methods = ["GET", "HEAD", "OPTIONS"] + cached_methods = ["GET", "HEAD"] + target_origin_id = local.s3_origin_id + viewer_protocol_policy = "allow-all" } restrictions { @@ -241,23 +243,12 @@ resource "aws_cloudfront_distribution" "s3_distribution" { The example below creates a CloudFront distribution with [standard logging V2 to S3](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/standard-logging.html#enable-access-logging-api). ```terraform -provider "aws" { - region = var.region -} - -provider "aws" { - region = "us-east-1" - alias = "us_east_1" -} - resource "aws_cloudfront_distribution" "example" { - provider = aws.us_east_1 - # other config... } resource "aws_cloudwatch_log_delivery_source" "example" { - provider = aws.us_east_1 + region = "us-east-1" name = "example" log_type = "ACCESS_LOGS" @@ -270,7 +261,7 @@ resource "aws_s3_bucket" "example" { } resource "aws_cloudwatch_log_delivery_destination" "example" { - provider = aws.us_east_1 + region = "us-east-1" name = "s3-destination" output_format = "parquet" @@ -281,7 +272,7 @@ resource "aws_cloudwatch_log_delivery_destination" "example" { } resource "aws_cloudwatch_log_delivery" "example" { - provider = aws.us_east_1 + region = "us-east-1" delivery_source_name = aws_cloudwatch_log_delivery_source.example.name delivery_destination_arn = aws_cloudwatch_log_delivery_destination.example.arn @@ -292,6 +283,52 @@ resource "aws_cloudwatch_log_delivery" "example" { } ``` +### With V2 logging to Data Firehose + +The example below creates a CloudFront distribution with [standard logging V2 to Data Firehose](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/standard-logging.html#enable-access-logging-api). + +```terraform +resource "aws_cloudfront_distribution" "example" { + # other config +} + +resource "aws_kinesis_firehose_delivery_stream" "cloudfront_logs" { + region = "us-east-1" + # The tag named "LogDeliveryEnabled" must be set to "true" to allow the service-linked role "AWSServiceRoleForLogDelivery" + # to perform permitted actions on your behalf. + # See: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AWS-logs-and-resource-policy.html#AWS-logs-infrastructure-Firehose + tags = { + LogDeliveryEnabled = "true" + } + + # other config +} + +resource "aws_cloudwatch_log_delivery_source" "example" { + region = "us-east-1" + + name = "cloudfront-logs-source" + log_type = "ACCESS_LOGS" + resource_arn = aws_cloudfront_distribution.example.arn +} + +resource "aws_cloudwatch_log_delivery_destination" "example" { + region = "us-east-1" + + name = "firehose-destination" + output_format = "json" + delivery_destination_configuration { + destination_resource_arn = aws_kinesis_firehose_delivery_stream.cloudfront_logs.arn + } +} +resource "aws_cloudwatch_log_delivery" "example" { + region = "us-east-1" + + delivery_source_name = aws_cloudwatch_log_delivery_source.example.name + delivery_destination_arn = aws_cloudwatch_log_delivery_destination.example.arn +} +``` + ## Argument Reference This resource supports the following arguments: @@ -419,6 +456,8 @@ resource "aws_cloudfront_distribution" "example" { #### Custom Error Response Arguments +~> **NOTE:** When specifying either `response_page_path` or `response_code`, **both** must be set. + * `error_caching_min_ttl` (Optional) - Minimum amount of time you want HTTP error codes to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated. * `error_code` (Required) - 4xx or 5xx HTTP status code that you want to customize. * `response_code` (Optional) - HTTP status code that you want CloudFront to return with the custom error page to the viewer. diff --git a/website/docs/r/cloudfront_function.html.markdown b/website/docs/r/cloudfront_function.html.markdown index f51aa9c0383e..57ae88b8c086 100644 --- a/website/docs/r/cloudfront_function.html.markdown +++ b/website/docs/r/cloudfront_function.html.markdown @@ -40,7 +40,7 @@ The following arguments are optional: * `comment` - (Optional) Comment. * `publish` - (Optional) Whether to publish creation/change as Live CloudFront Function Version. Defaults to `true`. -* `key_value_store_associations` - (Optional) List of `aws_cloudfront_key_value_store` ARNs to be associated to the function. AWS limits associations to on key value store per function. +* `key_value_store_associations` - (Optional) List of `aws_cloudfront_key_value_store` ARNs to be associated to the function. AWS limits associations to one key value store per function. ## Attribute Reference diff --git a/website/docs/r/cloudfrontkeyvaluestore_key.html.markdown b/website/docs/r/cloudfrontkeyvaluestore_key.html.markdown index cfc452fe6f91..3b3399c9973f 100644 --- a/website/docs/r/cloudfrontkeyvaluestore_key.html.markdown +++ b/website/docs/r/cloudfrontkeyvaluestore_key.html.markdown @@ -46,7 +46,7 @@ This resource exports the following attributes in addition to the arguments abov ## Import -In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import CloudFront KeyValueStore Key using the `example_id_arg`. For example: +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import CloudFront KeyValueStore Key using the `key_value_store_arn` and 'key' separated by `,`. For example: ```terraform import { @@ -55,7 +55,7 @@ import { } ``` -Using `terraform import`, import CloudFront KeyValueStore Key using the `id`. For example: +Using `terraform import`, import CloudFront KeyValueStore Key using the `key_value_store_arn` and 'key' separated by `,`. For example: ```console % terraform import aws_cloudfrontkeyvaluestore_key.example arn:aws:cloudfront::111111111111:key-value-store/8562g61f-caba-2845-9d99-b97diwae5d3c,someKey diff --git a/website/docs/r/cloudwatch_event_bus.html.markdown b/website/docs/r/cloudwatch_event_bus.html.markdown index 0ac4961c3b05..db7c01e4d169 100644 --- a/website/docs/r/cloudwatch_event_bus.html.markdown +++ b/website/docs/r/cloudwatch_event_bus.html.markdown @@ -14,6 +14,8 @@ Provides an EventBridge event bus resource. ## Example Usage +### Basic Usages + ```terraform resource "aws_cloudwatch_event_bus" "messenger" { name = "chat-messages" @@ -32,6 +34,257 @@ resource "aws_cloudwatch_event_bus" "examplepartner" { } ``` +### Logging to CloudWatch Logs, S3, and Data Firehose + +See [Configuring logs for Amazon EventBridge event buses](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-bus-logs.html) for more details. + +#### Required Resources + +* EventBridge Event Bus with `log_config` configured +* Log destinations: + + * CloudWatch Logs log group + * S3 bucket + * Data Firehose delivery stream + +* Resource-based policy or tagging for the service-linked role: + + * CloudWatch Logs log group - `aws_cloudwatch_log_resource_policy` to allow `delivery.logs.amazonaws.com` to put logs into the log group + * S3 bucket - `aws_s3_bucket_policy` to allow `delivery.logs.amazonaws.com` to put logs into the bucket + * Data Firehose delivery stream - tagging the delivery stream with `LogDeliveryEnabled = "true"` to allow the service-linked role `AWSServiceRoleForLogDelivery` to deliver logs + +* CloudWatch Logs Delivery: + + * `aws_cloudwatch_log_delivery_source` for each log type (INFO, ERROR, TRACE) + * `aws_cloudwatch_log_delivery_destination` for the log destination (S3 bucket, CloudWatch Logs log group, or Data Firehose delivery stream) + * `aws_cloudwatch_log_delivery` to link each log type’s delivery source to the delivery destination + +#### Example Usage + +The following example demonstrates how to set up logging for an EventBridge event bus to all three destinations: CloudWatch Logs, S3, and Data Firehose. + +```terraform +data "aws_caller_identity" "current" {} + +resource "aws_cloudwatch_event_bus" "example" { + name = "example-event-bus" + log_config { + include_detail = "FULL" + level = "TRACE" + } +} + +# CloudWatch Log Delivery Sources for INFO, ERROR, and TRACE logs +resource "aws_cloudwatch_log_delivery_source" "info_logs" { + name = "EventBusSource-${aws_cloudwatch_event_bus.example.name}-INFO_LOGS" + log_type = "INFO_LOGS" + resource_arn = aws_cloudwatch_event_bus.example.arn +} + +resource "aws_cloudwatch_log_delivery_source" "error_logs" { + name = "EventBusSource-${aws_cloudwatch_event_bus.example.name}-ERROR_LOGS" + log_type = "ERROR_LOGS" + resource_arn = aws_cloudwatch_event_bus.example.arn +} + +resource "aws_cloudwatch_log_delivery_source" "trace_logs" { + name = "EventBusSource-${aws_cloudwatch_event_bus.example.name}-TRACE_LOGS" + log_type = "TRACE_LOGS" + resource_arn = aws_cloudwatch_event_bus.example.arn +} + +# Logging to S3 Bucket +resource "aws_s3_bucket" "example" { + bucket = "example-event-bus-logs" +} + +data "aws_iam_policy_document" "bucket" { + statement { + effect = "Allow" + principals { + type = "Service" + identifiers = ["delivery.logs.amazonaws.com"] + } + actions = [ + "s3:PutObject" + ] + resources = [ + "${aws_s3_bucket.example.arn}/AWSLogs/${data.aws_caller_identity.current.account_id}/EventBusLogs/*" + ] + condition { + test = "StringEquals" + variable = "s3:x-amz-acl" + values = ["bucket-owner-full-control"] + } + condition { + test = "StringEquals" + variable = "aws:SourceAccount" + values = [data.aws_caller_identity.current.account_id] + } + condition { + test = "ArnLike" + variable = "aws:SourceArn" + values = [ + aws_cloudwatch_log_delivery_source.info_logs.arn, + aws_cloudwatch_log_delivery_source.error_logs.arn, + aws_cloudwatch_log_delivery_source.trace_logs.arn + ] + } + } +} + +resource "aws_s3_bucket_policy" "example" { + bucket = aws_s3_bucket.example.bucket + policy = data.aws_iam_policy_document.bucket.json +} + +resource "aws_cloudwatch_log_delivery_destination" "s3" { + name = "EventsDeliveryDestination-${aws_cloudwatch_event_bus.example.name}-S3" + delivery_destination_configuration { + destination_resource_arn = aws_s3_bucket.example.arn + } +} + +resource "aws_cloudwatch_log_delivery" "s3_info_logs" { + delivery_destination_arn = aws_cloudwatch_log_delivery_destination.s3.arn + delivery_source_name = aws_cloudwatch_log_delivery_source.info_logs.name +} +resource "aws_cloudwatch_log_delivery" "s3_error_logs" { + delivery_destination_arn = aws_cloudwatch_log_delivery_destination.s3.arn + delivery_source_name = aws_cloudwatch_log_delivery_source.error_logs.name + # to avoid operation conflict for the same delivery_destination_arn + depends_on = [ + aws_cloudwatch_log_delivery.s3_info_logs + ] +} +resource "aws_cloudwatch_log_delivery" "s3_trace_logs" { + delivery_destination_arn = aws_cloudwatch_log_delivery_destination.s3.arn + delivery_source_name = aws_cloudwatch_log_delivery_source.trace_logs.name + depends_on = [ + aws_cloudwatch_log_delivery.s3_error_logs + ] +} + +# Logging to CloudWatch Log Group +resource "aws_cloudwatch_log_group" "event_bus_logs" { + name = "/aws/vendedlogs/events/event-bus/${aws_cloudwatch_event_bus.example.name}" +} + +data "aws_iam_policy_document" "cwlogs" { + statement { + effect = "Allow" + principals { + type = "Service" + identifiers = ["delivery.logs.amazonaws.com"] + } + actions = [ + "logs:CreateLogStream", + "logs:PutLogEvents" + ] + resources = [ + "${aws_cloudwatch_log_group.event_bus_logs.arn}:log-stream:*" + ] + condition { + test = "StringEquals" + variable = "aws:SourceAccount" + values = [data.aws_caller_identity.current.account_id] + } + condition { + test = "ArnLike" + variable = "aws:SourceArn" + values = [ + aws_cloudwatch_log_delivery_source.info_logs.arn, + aws_cloudwatch_log_delivery_source.error_logs.arn, + aws_cloudwatch_log_delivery_source.trace_logs.arn + ] + } + } +} + +resource "aws_cloudwatch_log_resource_policy" "example" { + policy_document = data.aws_iam_policy_document.cwlogs.json + policy_name = "AWSLogDeliveryWrite-${aws_cloudwatch_event_bus.example.name}" +} + +resource "aws_cloudwatch_log_delivery_destination" "cwlogs" { + name = "EventsDeliveryDestination-${aws_cloudwatch_event_bus.example.name}-CWLogs" + delivery_destination_configuration { + destination_resource_arn = aws_cloudwatch_log_group.event_bus_logs.arn + } +} + +resource "aws_cloudwatch_log_delivery" "cwlogs_info_logs" { + delivery_destination_arn = aws_cloudwatch_log_delivery_destination.cwlogs.arn + delivery_source_name = aws_cloudwatch_log_delivery_source.info_logs.name + depends_on = [ + aws_cloudwatch_log_delivery.s3_info_logs + ] +} + +resource "aws_cloudwatch_log_delivery" "cwlogs_error_logs" { + delivery_destination_arn = aws_cloudwatch_log_delivery_destination.cwlogs.arn + delivery_source_name = aws_cloudwatch_log_delivery_source.error_logs.name + depends_on = [ + aws_cloudwatch_log_delivery.s3_error_logs, + aws_cloudwatch_log_delivery.cwlogs_info_logs + ] +} + +resource "aws_cloudwatch_log_delivery" "cwlogs_trace_logs" { + delivery_destination_arn = aws_cloudwatch_log_delivery_destination.cwlogs.arn + delivery_source_name = aws_cloudwatch_log_delivery_source.trace_logs.name + depends_on = [ + aws_cloudwatch_log_delivery.s3_trace_logs, + aws_cloudwatch_log_delivery.cwlogs_error_logs + ] +} + +# Logging to Data Firehose +resource "aws_kinesis_firehose_delivery_stream" "cloudfront_logs" { + # The tag named "LogDeliveryEnabled" must be set to "true" to allow the service-linked role "AWSServiceRoleForLogDelivery" + # to perform permitted actions on your behalf. + # See: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AWS-logs-and-resource-policy.html#AWS-logs-infrastructure-V2-Firehose + tags = { + LogDeliveryEnabled = "true" + } + + # other config... +} + +resource "aws_cloudwatch_log_delivery_destination" "firehose" { + name = "EventsDeliveryDestination-${aws_cloudwatch_event_bus.example.name}-Firehose" + delivery_destination_configuration { + destination_resource_arn = aws_kinesis_firehose_delivery_stream.cloudfront_logs.arn + } +} + +resource "aws_cloudwatch_log_delivery" "firehose_info_logs" { + delivery_destination_arn = aws_cloudwatch_log_delivery_destination.firehose.arn + delivery_source_name = aws_cloudwatch_log_delivery_source.info_logs.name + depends_on = [ + aws_cloudwatch_log_delivery.cwlogs_info_logs + ] +} + +resource "aws_cloudwatch_log_delivery" "firehose_error_logs" { + delivery_destination_arn = aws_cloudwatch_log_delivery_destination.firehose.arn + delivery_source_name = aws_cloudwatch_log_delivery_source.error_logs.name + depends_on = [ + aws_cloudwatch_log_delivery.cwlogs_error_logs, + aws_cloudwatch_log_delivery.firehose_info_logs + ] +} + +resource "aws_cloudwatch_log_delivery" "firehose_trace_logs" { + delivery_destination_arn = aws_cloudwatch_log_delivery_destination.firehose.arn + delivery_source_name = aws_cloudwatch_log_delivery_source.trace_logs.name + depends_on = [ + aws_cloudwatch_log_delivery.cwlogs_trace_logs, + aws_cloudwatch_log_delivery.firehose_error_logs + ] +} +``` + ## Argument Reference This resource supports the following arguments: @@ -49,6 +302,9 @@ The following arguments are optional: * `description` - (Optional) Event bus description. * `event_source_name` - (Optional) Partner event source that the new event bus will be matched with. Must match `name`. * `kms_key_identifier` - (Optional) Identifier of the AWS KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt events on this event bus. The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN. +* `log_config` - (Optional) Block for logging configuration settings for the event bus. + * `include_detail` - (Optional) Whether EventBridge include detailed event information in the records it generates. Valid values are `NONE` and `FULL`. + * `level` - (Optional) Level of logging detail to include. Valid values are `OFF`, `ERROR`, `INFO`, and `TRACE`. * `tags` - (Optional) Map of tags assigned to the resource. If configured with a provider [`default_tags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. ## Attribute Reference diff --git a/website/docs/r/cloudwatch_log_anomaly_detector.html.markdown b/website/docs/r/cloudwatch_log_anomaly_detector.html.markdown index fe702ac22b2d..5b80038b8f6c 100644 --- a/website/docs/r/cloudwatch_log_anomaly_detector.html.markdown +++ b/website/docs/r/cloudwatch_log_anomaly_detector.html.markdown @@ -66,7 +66,7 @@ import { } ``` -Using `terraform import`, import CloudWatch Log Anomaly Detector using the `example_id_arg`. For example: +Using `terraform import`, import CloudWatch Log Anomaly Detector using the `arn`. For example: ```console % terraform import aws_cloudwatch_log_anomaly_detector.example log_anomaly_detector-arn-12345678 diff --git a/website/docs/r/cloudwatch_log_metric_filter.html.markdown b/website/docs/r/cloudwatch_log_metric_filter.html.markdown index e8a819de8dec..083f25310b79 100644 --- a/website/docs/r/cloudwatch_log_metric_filter.html.markdown +++ b/website/docs/r/cloudwatch_log_metric_filter.html.markdown @@ -40,6 +40,7 @@ This resource supports the following arguments: for extracting metric data out of ingested log events. * `log_group_name` - (Required) The name of the log group to associate the metric filter with. * `metric_transformation` - (Required) A block defining collection of information needed to define how metric data gets emitted. See below. +* `apply_on_transformed_logs` - (Optional) Whether the metric filter will be applied on the transformed version of the log events instead of the original ingested log events. Defaults to `false`. Valid only for log groups that have an active log transformer. The `metric_transformation` block supports the following arguments: diff --git a/website/docs/r/codebuild_fleet.html.markdown b/website/docs/r/codebuild_fleet.html.markdown index acf66bd39c72..8ec6f76bc40b 100644 --- a/website/docs/r/codebuild_fleet.html.markdown +++ b/website/docs/r/codebuild_fleet.html.markdown @@ -52,7 +52,7 @@ The following arguments are required: The following arguments are optional: * `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). -* `compute_configuration` - (Optional) The compute configuration of the compute fleet. This is only required if `compute_type` is set to `ATTRIBUTE_BASED_COMPUTE`. See [`compute_configuration`](#compute_configuration) below. +* `compute_configuration` - (Optional) The compute configuration of the compute fleet. This is only required if `compute_type` is set to `ATTRIBUTE_BASED_COMPUTE` or `CUSTOM_INSTANCE_TYPE`. See [`compute_configuration`](#compute_configuration) below. * `fleet_service_role` - (Optional) The service role associated with the compute fleet. * `image_id` - (Optional) The Amazon Machine Image (AMI) of the compute fleet. * `overflow_behavior` - (Optional) Overflow behavior for compute fleet. Valid values: `ON_DEMAND`, `QUEUE`. @@ -63,9 +63,10 @@ The following arguments are optional: ### compute_configuration * `disk` - (Optional) Amount of disk space of the instance type included in the fleet. -* `machine_type` - (Optional) Machine type of the instance type included in the fleet. Valid values: `GENERAL`, `NVME`. -* `memory` - (Optional) Amount of memory of the instance type included in the fleet. -* `vcpu` - (Optional) Number of vCPUs of the instance type included in the fleet. +* `instance_type` - (Optional) EC2 instance type to be launched in the fleet. Specify only if `compute_type` is set to `CUSTOM_INSTANCE_TYPE`. See [Supported instance families](https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-compute-types.html#environment-reserved-capacity.instance-types). +* `machine_type` - (Optional) Machine type of the instance type included in the fleet. Valid values: `GENERAL`, `NVME`. Specify only if `compute_type` is set to `ATTRIBUTE_BASED_COMPUTE`. +* `memory` - (Optional) Amount of memory of the instance type included in the fleet. Specify only if `compute_type` is set to `ATTRIBUTE_BASED_COMPUTE`. +* `vcpu` - (Optional) Number of vCPUs of the instance type included in the fleet. Specify only if `compute_type` is set to `ATTRIBUTE_BASED_COMPUTE`. ### scaling_configuration diff --git a/website/docs/r/codebuild_project.html.markdown b/website/docs/r/codebuild_project.html.markdown index 68023663b338..027e983256a7 100755 --- a/website/docs/r/codebuild_project.html.markdown +++ b/website/docs/r/codebuild_project.html.markdown @@ -14,6 +14,8 @@ source (e.g., the "rebuild every time a code change is pushed" option in the Cod ## Example Usage +### Basic Usage + ```terraform resource "aws_s3_bucket" "example" { bucket = "example" @@ -260,6 +262,11 @@ resource "aws_codebuild_project" "project-using-github-app" { } ``` +### Runner Project + +While no special configuration is required for `aws_codebuild_project` to create a project as a Runner Project, an `aws_codebuild_webhook` resource with an appropriate `filter_group` is required. +See the [`aws_codebuild_webhook` resource documentation example](/docs/providers/aws/r/codebuild_webhook.html#for-codebuild-runner-project) for more details. + ## Argument Reference The following arguments are required: diff --git a/website/docs/r/codebuild_webhook.html.markdown b/website/docs/r/codebuild_webhook.html.markdown index 79da76f115bf..f7b06dbebbe2 100644 --- a/website/docs/r/codebuild_webhook.html.markdown +++ b/website/docs/r/codebuild_webhook.html.markdown @@ -64,6 +64,24 @@ resource "github_repository_webhook" "example" { } ``` +### For CodeBuild Runner Project + +To create a CodeBuild project as a Runner Project, the following `aws_codebuild_webhook` resource is required for the project. +See thr [AWS Documentation](https://docs.aws.amazon.com/codebuild/latest/userguide/action-runner.html) for more information about CodeBuild Runner Projects. + +```terraform +resource "aws_codebuild_webhook" "example" { + project_name = aws_codebuild_project.example.name + build_type = "BUILD" + filter_group { + filter { + type = "EVENT" + pattern = "WORKFLOW_JOB_QUEUED" + } + } +} +``` + ## Argument Reference This resource supports the following arguments: diff --git a/website/docs/r/cognito_log_delivery_configuration.html.markdown b/website/docs/r/cognito_log_delivery_configuration.html.markdown new file mode 100644 index 000000000000..60962f8d0a3d --- /dev/null +++ b/website/docs/r/cognito_log_delivery_configuration.html.markdown @@ -0,0 +1,218 @@ +--- +subcategory: "Cognito IDP (Identity Provider)" +layout: "aws" +page_title: "AWS: aws_cognito_log_delivery_configuration" +description: |- + Manages an AWS Cognito IDP (Identity Provider) Log Delivery Configuration. +--- + +# Resource: aws_cognito_log_delivery_configuration + +Manages an AWS Cognito IDP (Identity Provider) Log Delivery Configuration. + +## Example Usage + +### Basic Usage with CloudWatch Logs + +```terraform +resource "aws_cognito_user_pool" "example" { + name = "example" +} + +resource "aws_cloudwatch_log_group" "example" { + name = "example" +} + +resource "aws_cognito_log_delivery_configuration" "example" { + user_pool_id = aws_cognito_user_pool.example.id + + log_configurations { + event_source = "userNotification" + log_level = "ERROR" + + cloud_watch_logs_configuration { + log_group_arn = aws_cloudwatch_log_group.example.arn + } + } +} +``` + +### Multiple Log Configurations with Different Destinations + +```terraform +resource "aws_cognito_user_pool" "example" { + name = "example" +} + +resource "aws_cloudwatch_log_group" "example" { + name = "example" +} + +resource "aws_s3_bucket" "example" { + bucket = "example-bucket" + force_destroy = true +} + +resource "aws_iam_role" "firehose" { + name = "firehose-role" + + assume_role_policy = jsonencode({ + Version = "2012-10-17" + Statement = [ + { + Action = "sts:AssumeRole" + Effect = "Allow" + Principal = { + Service = "firehose.amazonaws.com" + } + } + ] + }) +} + +resource "aws_iam_role_policy" "firehose" { + name = "firehose-policy" + role = aws_iam_role.firehose.id + + policy = jsonencode({ + Version = "2012-10-17" + Statement = [ + { + Effect = "Allow" + Action = [ + "s3:AbortMultipartUpload", + "s3:GetBucketLocation", + "s3:GetObject", + "s3:ListBucket", + "s3:ListBucketMultipartUploads", + "s3:PutObject" + ] + Resource = [ + aws_s3_bucket.example.arn, + "${aws_s3_bucket.example.arn}/*" + ] + } + ] + }) +} + +resource "aws_kinesis_firehose_delivery_stream" "example" { + name = "example-stream" + destination = "extended_s3" + + extended_s3_configuration { + role_arn = aws_iam_role.firehose.arn + bucket_arn = aws_s3_bucket.example.arn + } +} + +resource "aws_cognito_log_delivery_configuration" "example" { + user_pool_id = aws_cognito_user_pool.example.id + + log_configurations { + event_source = "userNotification" + log_level = "INFO" + + cloud_watch_logs_configuration { + log_group_arn = aws_cloudwatch_log_group.example.arn + } + } + + log_configurations { + event_source = "userAuthEvents" + log_level = "ERROR" + + firehose_configuration { + stream_arn = aws_kinesis_firehose_delivery_stream.example.arn + } + } +} +``` + +### S3 Configuration + +```terraform +resource "aws_cognito_user_pool" "example" { + name = "example" +} + +resource "aws_s3_bucket" "example" { + bucket = "example-bucket" + force_destroy = true +} + +resource "aws_cognito_log_delivery_configuration" "example" { + user_pool_id = aws_cognito_user_pool.example.id + + log_configurations { + event_source = "userNotification" + log_level = "ERROR" + + s3_configuration { + bucket_arn = aws_s3_bucket.example.arn + } + } +} +``` + +## Argument Reference + +The following arguments are required: + +* `user_pool_id` - (Required) The ID of the user pool for which to configure log delivery. + +The following arguments are optional: + +* `log_configurations` - (Optional) Configuration block for log delivery. At least one configuration block is required. See [Log Configurations](#log-configurations) below. +* `region` - (Optional) The AWS region. + +### Log Configurations + +The `log_configurations` block supports the following: + +* `event_source` - (Required) The event source to configure logging for. Valid values are `userNotification` and `userAuthEvents`. +* `log_level` - (Required) The log level to set for the event source. Valid values are `ERROR` and `INFO`. +* `cloud_watch_logs_configuration` - (Optional) Configuration for CloudWatch Logs delivery. See [CloudWatch Logs Configuration](#cloudwatch-logs-configuration) below. +* `firehose_configuration` - (Optional) Configuration for Kinesis Data Firehose delivery. See [Firehose Configuration](#firehose-configuration) below. +* `s3_configuration` - (Optional) Configuration for S3 delivery. See [S3 Configuration](#s3-configuration) below. + +~> **Note:** At least one destination configuration (`cloud_watch_logs_configuration`, `firehose_configuration`, or `s3_configuration`) must be specified for each log configuration. + +#### CloudWatch Logs Configuration + +The `cloud_watch_logs_configuration` block supports the following: + +* `log_group_arn` - (Optional) The ARN of the CloudWatch Logs log group to which the logs should be delivered. + +#### Firehose Configuration + +The `firehose_configuration` block supports the following: + +* `stream_arn` - (Optional) The ARN of the Kinesis Data Firehose delivery stream to which the logs should be delivered. + +#### S3 Configuration + +The `s3_configuration` block supports the following: + +* `bucket_arn` - (Optional) The ARN of the S3 bucket to which the logs should be delivered. + +## Attribute Reference + +This resource exports the following attributes in addition to the arguments above: + +## Import + +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import Cognito IDP (Identity Provider) Log Delivery Configuration using the `user_pool_id`. For example: + +```terraform +import { + to = aws_cognito_log_delivery_configuration.example + id = "us-west-2_example123" +} +``` + +Using `terraform import`, import Cognito IDP (Identity Provider) Log Delivery Configuration using the `user_pool_id`. For example: + +```console +% terraform import aws_cognito_log_delivery_configuration.example us-west-2_example123 +``` diff --git a/website/docs/r/cognito_managed_login_branding.html.markdown b/website/docs/r/cognito_managed_login_branding.html.markdown new file mode 100644 index 000000000000..ca6e6a9ca987 --- /dev/null +++ b/website/docs/r/cognito_managed_login_branding.html.markdown @@ -0,0 +1,90 @@ +--- +subcategory: "Cognito IDP (Identity Provider)" +layout: "aws" +page_title: "AWS: aws_cognito_managed_login_branding" +description: |- + Manages branding settings for a user pool style and associates it with an app client. +--- + +# Resource: aws_cognito_managed_login_branding + +Manages branding settings for a user pool style and associates it with an app client. + +## Example Usage + +### Default Branding Style + +```terraform +resource "aws_cognito_managed_login_branding" "client" { + client_id = aws_cognito_user_pool_client.example.id + user_pool_id = aws_cognito_user_pool.example.id + + use_cognito_provided_values = true +} +``` + +### Custom Branding Style + +```terraform +resource "aws_cognito_managed_login_branding" "client" { + client_id = aws_cognito_user_pool_client.example.id + user_pool_id = aws_cognito_user_pool.example.id + + asset { + bytes = filebase64("login_branding_asset.svg") + category = "PAGE_HEADER_BACKGROUND" + color_mode = "DARK" + extension = "SVG" + } + + settings = jsonencode({ + # Your settings here. + }) +} +``` + +## Argument Reference + +The following arguments are required: + +* `client_id` - (Required) App client that the branding style is for. +* `user_pool_id` - (Required) User pool the client belongs to. + +The following arguments are optional: + +* `asset` - (Optional) Image files to apply to roles like backgrounds, logos, and icons. See [details below](#asset). +* `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). +* `settings` - (Optional) JSON document with the the settings to apply to the style. +* `use_cognito_provided_values` - (Optional) When `true`, applies the default branding style options. + +### asset + +* `bytes` - (Optional) Image file, in Base64-encoded binary. +* `category` - (Required) Category that the image corresponds to. See [AWS documentation](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AssetType.html#CognitoUserPools-Type-AssetType-Category) for valid values. +* `color_mode` - (Required) Display-mode target of the asset. Valid values: `LIGHT`, `DARK`, `DYNAMIC`. +* `extensions` - (Required) File type of the image file. See [AWS documentation](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AssetType.html#CognitoUserPools-Type-AssetType-Extension) for valid values. +* `resource_id` - (Optional) Asset ID. + +## Attribute Reference + +This resource exports the following attributes in addition to the arguments above: + +* `managed_login_branding_id` - ID of the managed login branding style. +* `settings_all` - Settings including Amazon Cognito defaults. + +## Import + +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import Cognito branding settings using `user_pool_id` and `managed_login_branding_id` separated by `,`. For example: + +```terraform +import { + to = aws_cognito_managed_login_branding.example + id = "us-west-2_rSss9Zltr,06c6ae7b-1e66-46d2-87a9-1203ea3307bd" +} +``` + +Using `terraform import`, import Cognito branding settings using `user_pool_id` and `managed_login_branding_id` separated by `,`. For example: + +```console +% terraform import aws_cognito_managed_login_branding.example us-west-2_rSss9Zltr,06c6ae7b-1e66-46d2-87a9-1203ea3307bd +``` diff --git a/website/docs/r/cognito_user_pool.html.markdown b/website/docs/r/cognito_user_pool.html.markdown index 9a195017a094..d41a179d3923 100644 --- a/website/docs/r/cognito_user_pool.html.markdown +++ b/website/docs/r/cognito_user_pool.html.markdown @@ -74,18 +74,18 @@ This resource supports the following arguments: * `deletion_protection` - (Optional) When active, DeletionProtection prevents accidental deletion of your user pool. Before you can delete a user pool that you have protected against deletion, you must deactivate this feature. Valid values are `ACTIVE` and `INACTIVE`, Default value is `INACTIVE`. * `device_configuration` - (Optional) Configuration block for the user pool's device tracking. [Detailed below](#device_configuration). * `email_configuration` - (Optional) Configuration block for configuring email. [Detailed below](#email_configuration). -* `email_mfa_configuration` - (Optional) Configuration block for configuring email Multi-Factor Authentication (MFA); requires at least 2 `account_recovery_setting` entries; requires an `email_configuration` configuration block. [Detailed below](#email_mfa_configuration). +* `email_mfa_configuration` - (Optional) Configuration block for configuring email Multi-Factor Authentication (MFA); requires at least 2 `account_recovery_setting` entries; requires an `email_configuration` configuration block. Effective only when `mfa_configuration` is `ON` or `OPTIONAL`. [Detailed below](#email_mfa_configuration). * `email_verification_message` - (Optional) String representing the email verification message. Conflicts with `verification_message_template` configuration block `email_message` argument. * `email_verification_subject` - (Optional) String representing the email verification subject. Conflicts with `verification_message_template` configuration block `email_subject` argument. * `lambda_config` - (Optional) Configuration block for the AWS Lambda triggers associated with the user pool. [Detailed below](#lambda_config). -* `mfa_configuration` - (Optional) Multi-Factor Authentication (MFA) configuration for the User Pool. Defaults of `OFF`. Valid values are `OFF` (MFA Tokens are not required), `ON` (MFA is required for all users to sign in; requires at least one of `sms_configuration` or `software_token_mfa_configuration` to be configured), or `OPTIONAL` (MFA Will be required only for individual users who have MFA Enabled; requires at least one of `sms_configuration` or `software_token_mfa_configuration` to be configured). +* `mfa_configuration` - (Optional) Multi-Factor Authentication (MFA) configuration for the User Pool. Defaults of `OFF`. Valid values are `OFF` (MFA Tokens are not required), `ON` (MFA is required for all users to sign in; requires at least one of `email_mfa_configuration`, `sms_configuration` or `software_token_mfa_configuration` to be configured), or `OPTIONAL` (MFA Will be required only for individual users who have MFA Enabled; requires at least one of `email_mfa_configuration`, `sms_configuration` or `software_token_mfa_configuration` to be configured). * `password_policy` - (Optional) Configuration block for information about the user pool password policy. [Detailed below](#password_policy). * `schema` - (Optional) Configuration block for the schema attributes of a user pool. [Detailed below](#schema). Schema attributes from the [standard attribute set](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html#cognito-user-pools-standard-attributes) only need to be specified if they are different from the default configuration. Attributes can be added, but not modified or removed. Maximum of 50 attributes. * `sign_in_policy` - (Optional) Configuration block for information about the user pool sign in policy. [Detailed below](#sign_in_policy). * `sms_authentication_message` - (Optional) String representing the SMS authentication message. The Message must contain the `{####}` placeholder, which will be replaced with the code. -* `sms_configuration` - (Optional) Configuration block for Short Message Service (SMS) settings. [Detailed below](#sms_configuration). These settings apply to SMS user verification and SMS Multi-Factor Authentication (MFA). Due to Cognito API restrictions, the SMS configuration cannot be removed without recreating the Cognito User Pool. For user data safety, this resource will ignore the removal of this configuration by disabling drift detection. To force resource recreation after this configuration has been applied, see the [`taint` command](https://www.terraform.io/docs/commands/taint.html). +* `sms_configuration` - (Optional) Configuration block for Short Message Service (SMS) settings. [Detailed below](#sms_configuration). These settings apply to SMS user verification and SMS Multi-Factor Authentication (MFA). SMS MFA is activated only when `mfa_configuration` is set to `ON` or `OPTIONAL` along with this block. Due to Cognito API restrictions, the SMS configuration cannot be removed without recreating the Cognito User Pool. For user data safety, this resource will ignore the removal of this configuration by disabling drift detection. To force resource recreation after this configuration has been applied, see the [`taint` command](https://www.terraform.io/docs/commands/taint.html). * `sms_verification_message` - (Optional) String representing the SMS verification message. Conflicts with `verification_message_template` configuration block `sms_message` argument. -* `software_token_mfa_configuration` - (Optional) Configuration block for software token Mult-Factor Authentication (MFA) settings. [Detailed below](#software_token_mfa_configuration). +* `software_token_mfa_configuration` - (Optional) Configuration block for software token Mult-Factor Authentication (MFA) settings. Effective only when `mfa_configuration` is `ON` or `OPTIONAL`. [Detailed below](#software_token_mfa_configuration). * `tags` - (Optional) Map of tags to assign to the User Pool. 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. * `user_attribute_update_settings` - (Optional) Configuration block for user attribute update settings. [Detailed below](#user_attribute_update_settings). * `user_pool_add_ons` - (Optional) Configuration block for user pool add-ons to enable user pool advanced security mode features. [Detailed below](#user_pool_add_ons). diff --git a/website/docs/r/comprehend_document_classifier.html.markdown b/website/docs/r/comprehend_document_classifier.html.markdown index c3d031067f29..be82905106c9 100644 --- a/website/docs/r/comprehend_document_classifier.html.markdown +++ b/website/docs/r/comprehend_document_classifier.html.markdown @@ -22,7 +22,7 @@ resource "aws_comprehend_document_classifier" "example" { language_code = "en" input_data_config { - s3_uri = "s3://${aws_s3_bucket.test.bucket}/${aws_s3_object.documents.id}" + s3_uri = "s3://${aws_s3_bucket.test.bucket}/${aws_s3_object.documents.key}" } depends_on = [ diff --git a/website/docs/r/comprehend_entity_recognizer.html.markdown b/website/docs/r/comprehend_entity_recognizer.html.markdown index 6434224eb6ae..e7818437a07b 100644 --- a/website/docs/r/comprehend_entity_recognizer.html.markdown +++ b/website/docs/r/comprehend_entity_recognizer.html.markdown @@ -30,11 +30,11 @@ resource "aws_comprehend_entity_recognizer" "example" { } documents { - s3_uri = "s3://${aws_s3_bucket.documents.bucket}/${aws_s3_object.documents.id}" + s3_uri = "s3://${aws_s3_bucket.documents.bucket}/${aws_s3_object.documents.key}" } entity_list { - s3_uri = "s3://${aws_s3_bucket.entities.bucket}/${aws_s3_object.entities.id}" + s3_uri = "s3://${aws_s3_bucket.entities.bucket}/${aws_s3_object.entities.key}" } } diff --git a/website/docs/r/computeoptimizer_recommendation_preferences.html.markdown b/website/docs/r/computeoptimizer_recommendation_preferences.html.markdown index 7d36ebfc58b9..2d5a166f658e 100644 --- a/website/docs/r/computeoptimizer_recommendation_preferences.html.markdown +++ b/website/docs/r/computeoptimizer_recommendation_preferences.html.markdown @@ -59,7 +59,7 @@ This resource supports the following arguments: * `inferred_workload_types` - (Optional) The status of the inferred workload types recommendation preference. Valid values: `Active`, `Inactive`. * `look_back_period` - (Optional) The preference to control the number of days the utilization metrics of the AWS resource are analyzed. Valid values: `DAYS_14`, `DAYS_32`, `DAYS_93`. * `preferred_resource` - (Optional) The preference to control which resource type values are considered when generating rightsizing recommendations. See [Preferred Resources](#preferred-resources) below. -* `resource_type` - (Required) The target resource type of the recommendation preferences. Valid values: `Ec2Instance`, `AutoScalingGroup`, `RdsDBInstance`. +* `resource_type` - (Required) The target resource type of the recommendation preferences. Valid values: `Ec2Instance`, `AutoScalingGroup`, `RdsDBInstance`, `AuroraDBClusterStorage`. * `savings_estimation_mode` - (Optional) The status of the savings estimation mode preference. Valid values: `AfterDiscounts`, `BeforeDiscounts`. * `scope` - (Required) The scope of the recommendation preferences. See [Scope](#scope) below. * `utilization_preference` - (Optional) The preference to control the resource’s CPU utilization threshold, CPU utilization headroom, and memory utilization headroom. See [Utilization Preferences](#utilization-preferences) below. diff --git a/website/docs/r/config_organization_custom_policy_rule.html.markdown b/website/docs/r/config_organization_custom_policy_rule.html.markdown index 00b2f79be7cf..084d7fea2d24 100644 --- a/website/docs/r/config_organization_custom_policy_rule.html.markdown +++ b/website/docs/r/config_organization_custom_policy_rule.html.markdown @@ -45,29 +45,29 @@ resource "aws_config_organization_custom_policy_rule" "example" { The following arguments are required: -* `name` - (Required) name of the rule -* `policy_text` - (Required) policy definition containing the logic for your organization AWS Config Custom Policy rule -* `policy_runtime` - (Required) runtime system for your organization AWS Config Custom Policy rules -* `trigger_types` - (Required) List of notification types that trigger AWS Config to run an evaluation for the rule. Valid values: `ConfigurationItemChangeNotification`, `OversizedConfigurationItemChangeNotification` +* `name` - (Required) Name of the rule. +* `policy_text` - (Required) Policy definition containing the rule logic. +* `policy_runtime` - (Required) Runtime system for policy rules. +* `trigger_types` - (Required) List of notification types that trigger AWS Config to run an evaluation for the rule. Valid values: `ConfigurationItemChangeNotification`, `OversizedConfigurationItemChangeNotification`. The following arguments are optional: * `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). -* `description` - (Optional) Description of the rule -* `debug_log_delivery_accounts` - (Optional) List of AWS account identifiers to exclude from the rule -* `excluded_accounts` - (Optional) List of AWS account identifiers to exclude from the rule -* `input_parameters` - (Optional) A string in JSON format that is passed to the AWS Config Rule Lambda Function +* `description` - (Optional) Description of the rule. +* `debug_log_delivery_accounts` - (Optional) List of accounts that you can enable debug logging for. The list is null when debug logging is enabled for all accounts. +* `excluded_accounts` - (Optional) List of AWS account identifiers to exclude from the rule. +* `input_parameters` - (Optional) A string in JSON format that is passed to the AWS Config Rule Lambda Function. * `maximum_execution_frequency` - (Optional) Maximum frequency with which AWS Config runs evaluations for a rule, if the rule is triggered at a periodic frequency. Defaults to `TwentyFour_Hours` for periodic frequency triggered rules. Valid values: `One_Hour`, `Three_Hours`, `Six_Hours`, `Twelve_Hours`, or `TwentyFour_Hours`. -* `resource_id_scope` - (Optional) Identifier of the AWS resource to evaluate -* `resource_types_scope` - (Optional) List of types of AWS resources to evaluate -* `tag_key_scope` - (Optional, Required if `tag_value_scope` is configured) Tag key of AWS resources to evaluate -* `tag_value_scope` - (Optional) Tag value of AWS resources to evaluate +* `resource_id_scope` - (Optional) Identifier of the AWS resource to evaluate. +* `resource_types_scope` - (Optional) List of types of AWS resources to evaluate. +* `tag_key_scope` - (Optional, Required if `tag_value_scope` is configured) Tag key of AWS resources to evaluate. +* `tag_value_scope` - (Optional) Tag value of AWS resources to evaluate. ## Attribute Reference This resource exports the following attributes in addition to the arguments above: -* `arn` - Amazon Resource Name (ARN) of the rule +* `arn` - Amazon Resource Name (ARN) of the rule. ## Timeouts diff --git a/website/docs/r/connect_phone_number_contact_flow_association.html.markdown b/website/docs/r/connect_phone_number_contact_flow_association.html.markdown new file mode 100644 index 000000000000..ba63b0640e94 --- /dev/null +++ b/website/docs/r/connect_phone_number_contact_flow_association.html.markdown @@ -0,0 +1,51 @@ +--- +subcategory: "Connect" +layout: "aws" +page_title: "AWS: aws_connect_phone_number_contact_flow_association" +description: |- + Associates a flow with a phone number claimed to an Amazon Connect instance. +--- + +# Resource: aws_connect_phone_number_contact_flow_association + +Associates a flow with a phone number claimed to an Amazon Connect instance. + +## Example Usage + +```terraform +resource "aws_connect_phone_number_contact_flow_association" "example" { + phone_number_id = aws_connect_phone_number.example.id + instance_id = aws_connect_instance.example.id + contact_flow_id = aws_connect_contact_flow.example.contact_flow_id +} +``` + +## Argument Reference + +This resource supports the following arguments: + +* `contact_flow_id` - (Required) Contact flow ID. +* `instance_id` - (Required) Amazon Connect instance ID. +* `phone_number_id` - (Required) Phone number ID. +* `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). + +## 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 `aws_connect_phone_number_contact_flow_association` using the `phone_number_id`, `instance_id` and `contact_flow_id` separated by a comma (`,`). For example: + +```terraform +import { + to = aws_connect_phone_number_contact_flow_association.example + id = "36727a4c-4683-4e49-880c-3347c61110a4,fa6c1691-e2eb-4487-bdb9-1aaed6268ebd,c4acdc79-395e-4280-a294-9062f56b07bb" +} +``` + +Using `terraform import`, import `aws_connect_phone_number_contact_flow_association` using the `phone_number_id`, `instance_id` and `contact_flow_id` separated by a comma (`,`). For example: + +```console +% terraform import aws_connect_phone_number_contact_flow_association.example 36727a4c-4683-4e49-880c-3347c61110a4,fa6c1691-e2eb-4487-bdb9-1aaed6268ebd,c4acdc79-395e-4280-a294-9062f56b07bb +``` diff --git a/website/docs/r/datazone_domain.html.markdown b/website/docs/r/datazone_domain.html.markdown index 1f22ee998d47..a0ddac37bc99 100644 --- a/website/docs/r/datazone_domain.html.markdown +++ b/website/docs/r/datazone_domain.html.markdown @@ -36,26 +36,26 @@ resource "aws_iam_role" "domain_execution_role" { }, ] }) +} - inline_policy { - name = "domain_execution_policy" - policy = jsonencode({ - Version = "2012-10-17" - Statement = [ - { - # Consider scoping down - Action = [ - "datazone:*", - "ram:*", - "sso:*", - "kms:*", - ] - Effect = "Allow" - Resource = "*" - }, - ] - }) - } +resource "aws_iam_role_policy" "domain_execution_role" { + role = aws_iam_role.domain_execution_role.name + policy = jsonencode({ + Version = "2012-10-17" + Statement = [ + { + # Consider scoping down + Action = [ + "datazone:*", + "ram:*", + "sso:*", + "kms:*", + ] + Effect = "Allow" + Resource = "*" + }, + ] + }) } resource "aws_datazone_domain" "example" { @@ -64,6 +64,90 @@ resource "aws_datazone_domain" "example" { } ``` +### V2 Domain + +```terraform +data "aws_caller_identity" "current" {} + +# IAM role for Domain Execution +data "aws_iam_policy_document" "assume_role_domain_execution" { + statement { + actions = [ + "sts:AssumeRole", + "sts:TagSession", + "sts:SetContext" + ] + principals { + type = "Service" + identifiers = ["datazone.amazonaws.com"] + } + condition { + test = "StringEquals" + values = [data.aws_caller_identity.current.account_id] + variable = "aws:SourceAccount" + } + condition { + test = "ForAllValues:StringLike" + values = ["datazone*"] + variable = "aws:TagKeys" + } + } +} + +resource "aws_iam_role" "domain_execution" { + assume_role_policy = data.aws_iam_policy_document.assume_role_domain_execution.json + name = "example-domain-execution-role" +} + +data "aws_iam_policy" "domain_execution_role" { + name = "SageMakerStudioDomainExecutionRolePolicy" +} + +resource "aws_iam_role_policy_attachment" "domain_execution" { + policy_arn = data.aws_iam_policy.domain_execution_role.arn + role = aws_iam_role.domain_execution.name +} + +# IAM role for Domain Service +data "aws_iam_policy_document" "assume_role_domain_service" { + statement { + actions = ["sts:AssumeRole"] + + principals { + type = "Service" + identifiers = ["datazone.amazonaws.com"] + } + condition { + test = "StringEquals" + values = [data.aws_caller_identity.current.account_id] + variable = "aws:SourceAccount" + } + } +} + +resource "aws_iam_role" "domain_service" { + assume_role_policy = data.aws_iam_policy_document.assume_role_domain_service.json + name = "example-domain-service-role" +} + +data "aws_iam_policy" "domain_service_role" { + name = "SageMakerStudioDomainServiceRolePolicy" +} + +resource "aws_iam_role_policy_attachment" "domain_service" { + policy_arn = data.aws_iam_policy.domain_service_role.arn + role = aws_iam_role.domain_service.name +} + +# DataZone Domain V2 +resource "aws_datazone_domain" "example" { + name = "example-domain" + domain_execution_role = aws_iam_role.domain_execution.arn + domain_version = "V2" + service_role = aws_iam_role.domain_service.arn +} +``` + ## Argument Reference The following arguments are required: @@ -75,7 +159,9 @@ The following arguments are optional: * `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). * `description` - (Optional) Description of the Domain. +* `domain_version` - (Optional) Version of the Domain. Valid values are `V1` and `V2`. Defaults to `V1`. * `kms_key_identifier` - (Optional) ARN of the KMS key used to encrypt the Amazon DataZone domain, metadata and reporting data. +* `service_role` - (Optional) ARN of the service role used by DataZone. Required when `domain_version` is set to `V2`. * `single_sign_on` - (Optional) Single sign on options, used to [enable AWS IAM Identity Center](https://docs.aws.amazon.com/datazone/latest/userguide/enable-IAM-identity-center-for-datazone.html) for DataZone. * `skip_deletion_check` - (Optional) Whether to skip the deletion check for the Domain. diff --git a/website/docs/r/datazone_glossary.html.markdown b/website/docs/r/datazone_glossary.html.markdown index a517396c8b30..0bd7f7cd1e78 100644 --- a/website/docs/r/datazone_glossary.html.markdown +++ b/website/docs/r/datazone_glossary.html.markdown @@ -115,7 +115,7 @@ This resource exports the following attributes in addition to the arguments abov ## Import -In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import DataZone Glossary using the `example_id_arg`. For example: +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import DataZone Glossary using a comma-delimited string combining the domain id, glossary id, and the id of the project it's under. For example: ```terraform import { diff --git a/website/docs/r/dlm_lifecycle_policy.html.markdown b/website/docs/r/dlm_lifecycle_policy.html.markdown index b9e439506634..378c445731d0 100644 --- a/website/docs/r/dlm_lifecycle_policy.html.markdown +++ b/website/docs/r/dlm_lifecycle_policy.html.markdown @@ -97,6 +97,30 @@ resource "aws_dlm_lifecycle_policy" "example" { } ``` +### Example Default Policy + +``` +resource "aws_dlm_lifecycle_policy" "example" { + description = "tf-acc-basic" + execution_role_arn = aws_iam_role.example.arn + default_policy = "VOLUME" + + policy_details { + create_interval = 5 + resource_type = "VOLUME" + policy_language = "SIMPLIFIED" + + exclusions { + exclude_boot_volumes = false + exclude_tags = { + test = "exclude" + } + exclude_volume_types = ["gp2"] + } + } +} +``` + ### Example Cross-Region Snapshot Copy Usage ```terraform @@ -216,6 +240,49 @@ resource "aws_iam_role_policy_attachment" "example" { } ``` +### Example Post/Pre Scripts + +``` +data "aws_iam_policy" "test" { + name = "AWSDataLifecycleManagerSSMFullAccess" +} + +resource "aws_iam_role_policy_attachment" "example" { + role = aws_iam_role.test.id + policy_arn = data.aws_iam_policy.example.arn +} + +resource "aws_dlm_lifecycle_policy" "example" { + description = "tf-acc-basic" + execution_role_arn = aws_iam_role.example.arn + + policy_details { + resource_types = ["INSTANCE"] + + schedule { + name = "Windows VSS" + + create_rule { + interval = 12 + scripts { + execute_operation_on_script_failure = false + execution_handler = "AWS_VSS_BACKUP" + maximum_retry_count = 2 + } + } + + retain_rule { + count = 10 + } + } + + target_tags = { + tag1 = "Windows" + } + } +} +``` + ## Argument Reference This resource supports the following arguments: @@ -223,6 +290,7 @@ This resource supports the following arguments: * `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). * `description` - (Required) A description for the DLM lifecycle policy. * `execution_role_arn` - (Required) The ARN of an IAM role that is able to be assumed by the DLM service. +* `default_policy` - (Required) Specify the type of default policy to create. valid values are `VOLUME` or `INSTANCE`. * `policy_details` - (Required) See the [`policy_details` configuration](#policy-details-arguments) block. Max of 1. * `state` - (Optional) Whether the lifecycle policy should be enabled or disabled. `ENABLED` or `DISABLED` are valid values. Defaults to `ENABLED`. * `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. @@ -230,13 +298,20 @@ This resource supports the following arguments: #### Policy Details arguments * `action` - (Optional) The actions to be performed when the event-based policy is triggered. You can specify only one action per policy. This parameter is required for event-based policies only. If you are creating a snapshot or AMI policy, omit this parameter. See the [`action` configuration](#action-arguments) block. +* `copy_tags` - (Optional, Default policies only) Indicates whether the policy should copy tags from the source resource to the snapshot or AMI. Default value is `false`. +* `create_interval` - (Optional, Default policies only) How often the policy should run and create snapshots or AMIs. valid values range from `1` to `7`. Default value is `1`. +* `exclusions` - (Optional, Default policies only) Specifies exclusion parameters for volumes or instances for which you do not want to create snapshots or AMIs. See the [`exclusions` configuration](#exclusions-arguments) block. +* `extend_deletion` - (Optional, Default policies only) snapshot or AMI retention behavior for the policy if the source volume or instance is deleted, or if the policy enters the error, disabled, or deleted state. Default value is `false`. +* `retain_interval` - (Optional, Default policies only) Specifies how long the policy should retain snapshots or AMIs before deleting them. valid values range from `2` to `14`. Default value is `7`. * `event_source` - (Optional) The event that triggers the event-based policy. This parameter is required for event-based policies only. If you are creating a snapshot or AMI policy, omit this parameter. See the [`event_source` configuration](#event-source-arguments) block. +* `resource_type` - (Optional, Default policies only) Type of default policy to create. Valid values are `VOLUME` and `INSTANCE`. * `resource_types` - (Optional) A list of resource types that should be targeted by the lifecycle policy. Valid values are `VOLUME` and `INSTANCE`. -* `resource_locations` - (Optional) The location of the resources to backup. If the source resources are located in an AWS Region, specify `CLOUD`. If the source resources are located on an Outpost in your account, specify `OUTPOST`. If you specify `OUTPOST`, Amazon Data Lifecycle Manager backs up all resources of the specified type with matching target tags across all of the Outposts in your account. Valid values are `CLOUD` and `OUTPOST`. +* `resource_locations` - (Optional) The location of the resources to backup. If the source resources are located in an AWS Region, specify `CLOUD`. If the source resources are located on an Outpost in your account, specify `OUTPOST`. If the source resources are located in a Local Zone, specify `LOCAL_ZONE`. Valid values are `CLOUD`, `LOCAL_ZONE`, and `OUTPOST`. +* `policy_language` - (Optional) Type of policy to create. `SIMPLIFIED` To create a default policy. `STANDARD` To create a custom policy. * `policy_type` - (Optional) The valid target resource types and actions a policy can manage. Specify `EBS_SNAPSHOT_MANAGEMENT` to create a lifecycle policy that manages the lifecycle of Amazon EBS snapshots. Specify `IMAGE_MANAGEMENT` to create a lifecycle policy that manages the lifecycle of EBS-backed AMIs. Specify `EVENT_BASED_POLICY` to create an event-based policy that performs specific actions when a defined event occurs in your AWS account. Default value is `EBS_SNAPSHOT_MANAGEMENT`. * `parameters` - (Optional) A set of optional parameters for snapshot and AMI lifecycle policies. See the [`parameters` configuration](#parameters-arguments) block. * `schedule` - (Optional) See the [`schedule` configuration](#schedule-arguments) block. -* `target_tags` (Optional) A map of tag keys and their values. Any resources that match the `resource_types` and are tagged with _any_ of these tags will be targeted. +* `target_tags` (Optional) A map of tag keys and their values. Any resources that match the `resource_types` and are tagged with _any_ of these tags will be targeted. Required when `policy_type` is `EBS_SNAPSHOT_MANAGEMENT` or `IMAGE_MANAGEMENT`. Must not be specified when `policy_type` is `EVENT_BASED_POLICY`. ~> Note: You cannot have overlapping lifecycle policies that share the same `target_tags`. Terraform is unable to detect this at plan time but it will fail during apply. @@ -267,6 +342,12 @@ This resource supports the following arguments: * `event_type` - (Required) The type of event. Currently, only `shareSnapshot` events are supported. * `snapshot_owner` - (Required) The IDs of the AWS accounts that can trigger policy by sharing snapshots with your account. The policy only runs if one of the specified AWS accounts shares a snapshot with your account. +#### Exclusions arguments + +* `exclude_boot_volumes` - (Optional) Indicates whether to exclude volumes that are attached to instances as the boot volume. To exclude boot volumes, specify `true`. +* `exclude_tags` - (Optional) Map specifies whether to exclude volumes that have specific tags. +* `exclude_volume_types` - (Optional) List specifies the volume types to exclude. + #### Parameters arguments * `exclude_boot_volume` - (Optional) Indicates whether to exclude the root volume from snapshots created using CreateSnapshots. The default is `false`. @@ -274,6 +355,7 @@ This resource supports the following arguments: #### Schedule arguments +* `archive_rule` - (Optional) Specifies a snapshot archiving rule for a schedule. See [`archive_rule`](#archive-rule-arguments) block. * `copy_tags` - (Optional) Copy all user-defined tags on a source volume to snapshots of the volume created by this policy. * `create_rule` - (Required) See the [`create_rule`](#create-rule-arguments) block. Max of 1 per schedule. * `cross_region_copy_rule` (Optional) - See the [`cross_region_copy_rule`](#cross-region-copy-rule-arguments) block. Max of 3 per schedule. @@ -285,12 +367,21 @@ This resource supports the following arguments: * `tags_to_add` - (Optional) A map of tag keys and their values. DLM lifecycle policies will already tag the snapshot with the tags on the volume. This configuration adds extra tags on top of these. * `variable_tags` - (Optional) A map of tag keys and variable values, where the values are determined when the policy is executed. Only `$(instance-id)` or `$(timestamp)` are valid values. Can only be used when `resource_types` is `INSTANCE`. +#### Archive Rule Arguments + +* `archive_retain_rule` - (Required) Information about the retention period for the snapshot archiving rule. See the [`archive_retain_rule`](#archive-retain-rule-arguments) block. + +#### Archive Retain Rule Arguments + +* `retention_archive_tier` - (Required) Information about retention period in the Amazon EBS Snapshots Archive. See the [`retention_archive_tier`](#retention-archive-tier-arguments) block. + #### Create Rule arguments * `cron_expression` - (Optional) The schedule, as a Cron expression. The schedule interval must be between 1 hour and 1 year. Conflicts with `interval`, `interval_unit`, and `times`. * `interval` - (Optional) How often this lifecycle policy should be evaluated. `1`, `2`,`3`,`4`,`6`,`8`,`12` or `24` are valid values. Conflicts with `cron_expression`. If set, `interval_unit` and `times` must also be set. * `interval_unit` - (Optional) The unit for how often the lifecycle policy should be evaluated. `HOURS` is currently the only allowed value and also the default value. Conflicts with `cron_expression`. Must be set if `interval` is set. * `location` - (Optional) Specifies the destination for snapshots created by the policy. To create snapshots in the same Region as the source resource, specify `CLOUD`. To create snapshots on the same Outpost as the source resource, specify `OUTPOST_LOCAL`. If you omit this parameter, `CLOUD` is used by default. If the policy targets resources in an AWS Region, then you must create snapshots in the same Region as the source resource. If the policy targets resources on an Outpost, then you can create snapshots on the same Outpost as the source resource, or in the Region of that Outpost. Valid values are `CLOUD` and `OUTPOST_LOCAL`. +* `scripts` - (Optional) Specifies pre and/or post scripts for a snapshot lifecycle policy that targets instances. Valid only when `resource_type` is INSTANCE. See the [`scripts` configuration](#scripts-rule-arguments) block. * `times` - (Optional) A list of times in 24 hour clock format that sets when the lifecycle policy should be evaluated. Max of 1. Conflicts with `cron_expression`. Must be set if `interval` is set. #### Deprecate Rule arguments @@ -325,7 +416,8 @@ This resource supports the following arguments: * `deprecate_rule` - (Optional) The AMI deprecation rule for cross-Region AMI copies created by the rule. See the [`deprecate_rule`](#cross-region-copy-rule-deprecate-rule-arguments) block. * `encrypted` - (Required) To encrypt a copy of an unencrypted snapshot if encryption by default is not enabled, enable encryption using this parameter. Copies of encrypted snapshots are encrypted, even if this parameter is false or if encryption by default is not enabled. * `retain_rule` - (Required) The retention rule that indicates how long snapshot copies are to be retained in the destination Region. See the [`retain_rule`](#cross-region-copy-rule-retain-rule-arguments) block. Max of 1 per schedule. -* `target` - (Required) The target Region or the Amazon Resource Name (ARN) of the target Outpost for the snapshot copies. +* `target` - Use only for DLM policies of `policy_type=EBS_SNAPSHOT_MANAGEMENT`. The target Region or the Amazon Resource Name (ARN) of the target Outpost for the snapshot copies. +* `target_region` - Use only for DLM policies of `policy_type=IMAGE_MANAGEMENT`. The target Region or the Amazon Resource Name (ARN) of the target Outpost for the snapshot copies. #### Cross Region Copy Rule Deprecate Rule arguments @@ -337,6 +429,26 @@ This resource supports the following arguments: * `interval` - (Required) The amount of time to retain each snapshot. The maximum is 100 years. This is equivalent to 1200 months, 5200 weeks, or 36500 days. * `interval_unit` - (Required) The unit of time for time-based retention. Valid values: `DAYS`, `WEEKS`, `MONTHS`, or `YEARS`. +#### Scripts Rule arguments + +* `execute_operation_on_script_failure` - (Optional) Indicates whether Amazon Data Lifecycle Manager should default to crash-consistent snapshots if the pre script fails. The default is `true`. + +* `execution_handler` - (Required) The SSM document that includes the pre and/or post scripts to run. In case automating VSS backups, specify `AWS_VSS_BACKUP`. In case automating application-consistent snapshots for SAP HANA workloads, specify `AWSSystemsManagerSAP-CreateDLMSnapshotForSAPHANA`. If you are using a custom SSM document that you own, specify either the name or ARN of the SSM document. + +* `execution_handler_service` - (Optional) Indicates the service used to execute the pre and/or post scripts. If using custom SSM documents or automating application-consistent snapshots of SAP HANA workloads, specify `AWS_SYSTEMS_MANAGER`. In case automating VSS Backups, omit this parameter. The default is `AWS_SYSTEMS_MANAGER`. + +* `execution_timeout` - (Optional) Specifies a timeout period, in seconds, after which Amazon Data Lifecycle Manager fails the script run attempt if it has not completed. In case automating VSS Backups, omit this parameter. The default is `10`. + +* `maximum_retry_count` - (Optional) Specifies the number of times Amazon Data Lifecycle Manager should retry scripts that fail. Must be an integer between `0` and `3`. The default is `0`. + +* `stages` - (Optional) List to indicate which scripts Amazon Data Lifecycle Manager should run on target instances. Pre scripts run before Amazon Data Lifecycle Manager initiates snapshot creation. Post scripts run after Amazon Data Lifecycle Manager initiates snapshot creation. Valid values: `PRE` and `POST`. The default is `PRE` and `POST` + +#### Retention Archive Tier Arguments + +* `count` - (Optional)The maximum number of snapshots to retain in the archive storage tier for each volume. Must be an integer between `1` and `1000`. Conflicts with `interval` and `interval_unit`. +* `interval` - (Optional) Specifies the period of time to retain snapshots in the archive tier. After this period expires, the snapshot is permanently deleted. Conflicts with `count`. If set, `interval_unit` must also be set. +* `interval_unit` - (Optional) The unit of time for time-based retention. Valid values are `DAYS`, `WEEKS`, `MONTHS`, `YEARS`. Conflicts with `count`. Must be set if `interval` is set. + ## Attribute Reference This resource exports the following attributes in addition to the arguments above: diff --git a/website/docs/r/dms_endpoint.html.markdown b/website/docs/r/dms_endpoint.html.markdown index 127af1968b03..b9c4a1b75289 100644 --- a/website/docs/r/dms_endpoint.html.markdown +++ b/website/docs/r/dms_endpoint.html.markdown @@ -57,6 +57,7 @@ The following arguments are optional: * `kafka_settings` - (Optional) Configuration block for Kafka settings. See below. * `kinesis_settings` - (Optional) Configuration block for Kinesis settings. See below. * `mongodb_settings` - (Optional) Configuration block for MongoDB settings. See below. +* `oracle_settings` - (Optional) Configuration block for Oracle settings. See below. * `password` - (Optional) Password to be used to login to the endpoint database. * `postgres_settings` - (Optional) Configuration block for Postgres settings. See below. * `pause_replication_tasks` - (Optional) Whether to pause associated running replication tasks, regardless if they are managed by Terraform, prior to modifying the endpoint. Only tasks paused by the resource will be restarted after the modification completes. Default is `false`. @@ -133,11 +134,18 @@ The following arguments are optional: * `extract_doc_id` - (Optional) Document ID. Use this setting when `nesting_level` is set to `none`. Default is `false`. * `nesting_level` - (Optional) Specifies either document or table mode. Default is `none`. Valid values are `one` (table mode) and `none` (document mode). +### oracle_settings + +-> Additional information can be found in the [Using Oracle as a Source for AWS DMS documentation](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html). + +* `authentication_method` - (Optional) Authentication mechanism to access the Oracle source endpoint. Default is `password`. Valid values are `password` and `kerberos`. + ### postgres_settings -> Additional information can be found in the [Using PostgreSQL as a Source for AWS DMS documentation](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.PostgreSQL.html). * `after_connect_script` - (Optional) For use with change data capture (CDC) only, this attribute has AWS DMS bypass foreign keys and user triggers to reduce the time it takes to bulk load data. +* `authentication_method` - (Optional) Specifies the authentication method. Valid values: `password`, `iam`. * `babelfish_database_name` - (Optional) The Babelfish for Aurora PostgreSQL database name for the endpoint. * `capture_ddls` - (Optional) To capture DDL events, AWS DMS creates various artifacts in the PostgreSQL database when the task starts. * `database_mode` - (Optional) Specifies the default behavior of the replication's handling of PostgreSQL- compatible endpoints that require some additional configuration, such as Babelfish endpoints. @@ -152,6 +160,7 @@ The following arguments are optional: * `map_long_varchar_as` - Optional When true, DMS migrates LONG values as VARCHAR. * `max_file_size` - (Optional) Specifies the maximum size (in KB) of any .csv file used to transfer data to PostgreSQL. Default is `32,768 KB`. * `plugin_name` - (Optional) Specifies the plugin to use to create a replication slot. Valid values: `pglogical`, `test_decoding`. +* `service_access_role_arn` - (Optional) Specifies the IAM role to use to authenticate the connection. * `slot_name` - (Optional) Sets the name of a previously created logical replication slot for a CDC load of the PostgreSQL source instance. ### redis_settings diff --git a/website/docs/r/dms_replication_instance.html.markdown b/website/docs/r/dms_replication_instance.html.markdown index 45aeb25bf929..0cabad042b26 100644 --- a/website/docs/r/dms_replication_instance.html.markdown +++ b/website/docs/r/dms_replication_instance.html.markdown @@ -104,7 +104,9 @@ This resource supports the following arguments: * `apply_immediately` - (Optional, Default: false) Indicates whether the changes should be applied immediately or during the next maintenance window. Only used when updating an existing resource. * `auto_minor_version_upgrade` - (Optional, Default: false) Indicates that minor engine upgrades will be applied automatically to the replication instance during the maintenance window. * `availability_zone` - (Optional) The EC2 Availability Zone that the replication instance will be created in. +* `dns_name_servers` - (Optional) A list of custom DNS name servers supported for the replication instance to access your on-premise source or target database. This list overrides the default name servers supported by the replication instance. You can specify a comma-separated list of internet addresses for up to four on-premise DNS name servers. * `engine_version` - (Optional) The engine version number of the replication instance. +* `kerberos_authentication_settings` - (Optional) Configuration block for settings required for Kerberos authentication. See below. * `kms_key_arn` - (Optional) The Amazon Resource Name (ARN) for the KMS key that will be used to encrypt the connection parameters. If you do not specify a value for `kms_key_arn`, then AWS DMS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS region. * `multi_az` - (Optional) Specifies if the replication instance is a multi-az deployment. You cannot set the `availability_zone` parameter if the `multi_az` parameter is set to `true`. * `network_type` - (Optional) The type of IP address protocol used by a replication instance. Valid values: `IPV4`, `DUAL`. @@ -116,6 +118,14 @@ This resource supports the following arguments: * `tags` - (Optional) A 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. * `vpc_security_group_ids` - (Optional) A list of VPC security group IDs to be used with the replication instance. The VPC security groups must work with the VPC containing the replication instance. +## kerberos_authentication_settings + +-> Additional information can be found in the [Using Kerberos Authentication with AWS Database Migration Service documentation](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.Kerberos.html). + +* `key_cache_secret_iam_arn` - (Required) ARN of the IAM role that grants AWS DMS access to the secret containing key cache file for the Kerberos authentication. +* `key_cache_secret_id` - (Required) Secret ID that stores the key cache file required for Kerberos authentication. +* `krb5_file_contents` - (Required) Contents of krb5 configuration file required for Kerberos authentication. + ## Attribute Reference This resource exports the following attributes in addition to the arguments above: diff --git a/website/docs/r/docdb_cluster.html.markdown b/website/docs/r/docdb_cluster.html.markdown index 63ec86bedd4b..0e43dfb151a9 100644 --- a/website/docs/r/docdb_cluster.html.markdown +++ b/website/docs/r/docdb_cluster.html.markdown @@ -75,6 +75,7 @@ This resource supports the following arguments: Default: A 30-minute window selected at random from an 8-hour block of time per regionE.g., 04:00-09:00 * `preferred_maintenance_window` - (Optional) The weekly time range during which system maintenance can occur, in (UTC) e.g., wed:04:00-wed:04:30 * `restore_to_point_in_time` - (Optional, Forces new resource) A configuration block for restoring a DB instance to an arbitrary point in time. Requires the `identifier` argument to be set with the name of the new DB instance to be created. See [Restore To Point In Time](#restore-to-point-in-time) below for details. +* `serverless_v2_scaling_configuration` - (Optional) Scaling configuration of an Amazon DocumentDB Serverless cluster. See [Serverless V2 Scaling Configuration](#serverless-v2-scaling-configuration) below for details. * `skip_final_snapshot` - (Optional) Determines whether a final DB snapshot is created before the DB cluster is deleted. If true is specified, no DB snapshot is created. If false is specified, a DB snapshot is created before the DB cluster is deleted, using the value from `final_snapshot_identifier`. Default is `false`. * `snapshot_identifier` - (Optional) Specifies whether or not to create this cluster from a snapshot. You can use either the name or ARN when specifying a DB cluster snapshot, or the ARN when specifying a DB snapshot. Automated snapshots **should not** be used for this attribute, unless from a different cluster. Automated snapshots are deleted as part of cluster destruction when the resource is replaced. * `storage_encrypted` - (Optional) Specifies whether the DB cluster is encrypted. The default is `false`. @@ -95,6 +96,14 @@ The `restore_to_point_in_time` block supports the following arguments: * `source_cluster_identifier` - (Required) The identifier of the source DB cluster from which to restore. Must match the identifier of an existing DB cluster. * `use_latest_restorable_time` - (Optional) A boolean value that indicates whether the DB cluster is restored from the latest backup time. Defaults to `false`. Cannot be specified with `restore_to_time`. +### Serverless V2 Scaling Configuration + +The `serverless_v2_scaling_configuration` block supports the following arguments. +Adding this block (i.e. switching to serverless) or removing it (i.e. switching from serverless) will trigger cluster replacement. + +* `max_capacity` - (Required) Maximum number of Amazon DocumentDB capacity units (DCUs) for an instance in an Amazon DocumentDB Serverless cluster. Valid values are multiples of 0.5 between 1 and 256. +* `min_capacity` - (Required) Minimum number of Amazon DocumentDB capacity units (DCUs) for an instance in an Amazon DocumentDB Serverless cluster. Valid values are multiples of 0.5 between 0.5 and 256. + ## Attribute Reference This resource exports the following attributes in addition to the arguments above: diff --git a/website/docs/r/dx_gateway_association.html.markdown b/website/docs/r/dx_gateway_association.html.markdown index 7d1002427268..0317a5e9a6d1 100644 --- a/website/docs/r/dx_gateway_association.html.markdown +++ b/website/docs/r/dx_gateway_association.html.markdown @@ -114,6 +114,7 @@ This resource exports the following attributes in addition to the arguments abov * `associated_gateway_type` - The type of the associated gateway, `transitGateway` or `virtualPrivateGateway`. * `dx_gateway_association_id` - The ID of the Direct Connect gateway association. * `dx_gateway_owner_account_id` - The ID of the AWS account that owns the Direct Connect gateway. +* `transit_gateway_attachment_id` - The ID of the Transit Gateway Attachment when the type is `transitGateway`. ## Timeouts diff --git a/website/docs/r/dx_hosted_connection.html.markdown b/website/docs/r/dx_hosted_connection.html.markdown index b4b8c5ee474e..eaedb8faef50 100644 --- a/website/docs/r/dx_hosted_connection.html.markdown +++ b/website/docs/r/dx_hosted_connection.html.markdown @@ -39,7 +39,7 @@ This resource exports the following attributes in addition to the arguments abov * `aws_device` - The Direct Connect endpoint on which the physical connection terminates. * `connection_region` - The AWS Region where the connection is located. * `has_logical_redundancy` - Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6). -* `id` - The ID of the connection. +* `id` - The ID of the hosted connection. * `jumbo_frame_capable` - Boolean value representing if jumbo frames have been enabled for this connection. * `lag_id` - The ID of the LAG. * `loa_issue_time` - The time of the most recent call to [DescribeLoa](https://docs.aws.amazon.com/directconnect/latest/APIReference/API_DescribeLoa.html) for this connection. diff --git a/website/docs/r/dynamodb_contributor_insights.html.markdown b/website/docs/r/dynamodb_contributor_insights.html.markdown index 2055410ff2d2..8439028df109 100644 --- a/website/docs/r/dynamodb_contributor_insights.html.markdown +++ b/website/docs/r/dynamodb_contributor_insights.html.markdown @@ -25,6 +25,7 @@ This resource supports the following arguments: * `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). * `table_name` - (Required) The name of the table to enable contributor insights * `index_name` - (Optional) The global secondary index name +* `mode` - (Optional) argument to specify the [CloudWatch contributor insights mode](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/contributorinsights_HowItWorks.html#contributorinsights_HowItWorks.Modes) ## Attribute Reference diff --git a/website/docs/r/dynamodb_resource_policy.html.markdown b/website/docs/r/dynamodb_resource_policy.html.markdown index 58b57a130156..7ef0961f209a 100644 --- a/website/docs/r/dynamodb_resource_policy.html.markdown +++ b/website/docs/r/dynamodb_resource_policy.html.markdown @@ -42,7 +42,7 @@ This resource exports the following attributes in addition to the arguments abov ## Import -In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import DynamoDB Resource Policy using the `example_id_arg`. For example: +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import DynamoDB Resource Policy using the `resource_arn`. For example: ```terraform import { @@ -51,7 +51,7 @@ import { } ``` -Using `terraform import`, import DynamoDB Resource Policy using the `example_id_arg`. For example: +Using `terraform import`, import DynamoDB Resource Policy using the `resource_arn`. For example: ```console % terraform import aws_dynamodb_resource_policy.example arn:aws:dynamodb:us-east-1:1234567890:table/my-table diff --git a/website/docs/r/dynamodb_table.html.markdown b/website/docs/r/dynamodb_table.html.markdown index 9db105d0aec8..5d7fc23a7af9 100644 --- a/website/docs/r/dynamodb_table.html.markdown +++ b/website/docs/r/dynamodb_table.html.markdown @@ -297,6 +297,7 @@ The following arguments are optional: **Note:** This attribute will _not_ be populated with the ARN of _default_ keys. **Note:** Changing this value will recreate the replica. * `point_in_time_recovery` - (Optional) Whether to enable Point In Time Recovery for the replica. Default is `false`. +* `deletion_protection_enabled` - (Optional) Whether deletion protection is enabled (true) or disabled (false) on the replica. Default is `false`. * `propagate_tags` - (Optional) Whether to propagate the global table's tags to a replica. Default is `false`. Changes to tags only move in one direction: from global (source) to replica. diff --git a/website/docs/r/ebs_fast_snapshot_restore.html.markdown b/website/docs/r/ebs_fast_snapshot_restore.html.markdown index e8898ac5d37e..d92628db70b2 100644 --- a/website/docs/r/ebs_fast_snapshot_restore.html.markdown +++ b/website/docs/r/ebs_fast_snapshot_restore.html.markdown @@ -45,7 +45,7 @@ This resource exports the following attributes in addition to the arguments abov ## Import -In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import EC2 (Elastic Compute Cloud) EBS Fast Snapshot Restore using the `example_id_arg`. For example: +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import EC2 (Elastic Compute Cloud) EBS Fast Snapshot Restore using the `availability_zone` and `snapshot_id` separated by `,`. For example: ```terraform import { @@ -54,7 +54,7 @@ import { } ``` -Using `terraform import`, import EC2 (Elastic Compute Cloud) EBS Fast Snapshot Restore using the `id`. For example: +Using `terraform import`, import EC2 (Elastic Compute Cloud) EBS Fast Snapshot Restore using the `availability_zone` and `snapshot_id` separated by `,`. For example: ```console % terraform import aws_ebs_fast_snapshot_restore.example us-west-2a,snap-abcdef123456 diff --git a/website/docs/r/ebs_volume.html.markdown b/website/docs/r/ebs_volume.html.markdown index bd40ab063d42..eef54cefd99c 100644 --- a/website/docs/r/ebs_volume.html.markdown +++ b/website/docs/r/ebs_volume.html.markdown @@ -40,6 +40,7 @@ This resource supports the following arguments: * `tags` - (Optional) A 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. * `throughput` - (Optional) Throughput that the volume supports, in MiB/s. Only valid for `type` of `gp3`. * `type` - (Optional) Type of EBS volume. Can be `standard`, `gp2`, `gp3`, `io1`, `io2`, `sc1` or `st1` (Default: `gp2`). +* `volume_initialization_rate` - (Optional) EBS provisioned rate for volume initialization, in MiB/s, at which to download the snapshot blocks from Amazon S3 to the volume. This argument can only be set if `snapshot_id` is specified. ~> **NOTE:** At least one of `size` or `snapshot_id` is required. diff --git a/website/docs/r/ec2_client_vpn_endpoint.html.markdown b/website/docs/r/ec2_client_vpn_endpoint.html.markdown index da5f9d0a4149..aaae7b1bfbc5 100644 --- a/website/docs/r/ec2_client_vpn_endpoint.html.markdown +++ b/website/docs/r/ec2_client_vpn_endpoint.html.markdown @@ -38,7 +38,7 @@ This resource supports the following arguments: * `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). * `authentication_options` - (Required) Information about the authentication method to be used to authenticate clients. -* `client_cidr_block` - (Required) The IPv4 address range, in CIDR notation, from which to assign client IP addresses. The address range cannot overlap with the local CIDR of the VPC in which the associated subnet is located, or the routes that you add manually. The address range cannot be changed after the Client VPN endpoint has been created. The CIDR block should be /22 or greater. +* `client_cidr_block` - (Optional) The IPv4 address range, in CIDR notation, from which to assign client IP addresses. The address range cannot overlap with the local CIDR of the VPC in which the associated subnet is located, or the routes that you add manually. The address range cannot be changed after the Client VPN endpoint has been created. The CIDR block should be /22 or greater. When `traffic_ip_address_type` is set to `ipv6`, it must not be specified. Otherwise, it is required. * `client_connect_options` - (Optional) The options for managing connection authorization for new client connections. * `client_login_banner_options` - (Optional) Options for enabling a customizable text banner that will be displayed on AWS provided clients when a VPN session is established. * `client_route_enforcement_options` - (Optional) Options for enforce administrator defined routes on devices connected through the VPN. @@ -46,12 +46,14 @@ This resource supports the following arguments: * `description` - (Optional) A brief description of the Client VPN endpoint. * `disconnect_on_session_timeout` - (Optional) Indicates whether the client VPN session is disconnected after the maximum `session_timeout_hours` is reached. If `true`, users are prompted to reconnect client VPN. If `false`, client VPN attempts to reconnect automatically. The default value is `false`. * `dns_servers` - (Optional) Information about the DNS servers to be used for DNS resolution. A Client VPN endpoint can have up to two DNS servers. If no DNS server is specified, the DNS address of the connecting device is used. +* `endpoint_ip_address_type` - (Optional) IP address type for the Client VPN endpoint. Valid values are `ipv4`, `ipv6`, or `dual-stack`. Defaults to `ipv4`. * `security_group_ids` - (Optional) The IDs of one or more security groups to apply to the target network. You must also specify the ID of the VPC that contains the security groups. * `self_service_portal` - (Optional) Specify whether to enable the self-service portal for the Client VPN endpoint. Values can be `enabled` or `disabled`. Default value is `disabled`. * `server_certificate_arn` - (Required) The ARN of the ACM server certificate. * `session_timeout_hours` - (Optional) The maximum session duration is a trigger by which end-users are required to re-authenticate prior to establishing a VPN session. Default value is `24` - Valid values: `8 | 10 | 12 | 24` * `split_tunnel` - (Optional) Indicates whether split-tunnel is enabled on VPN endpoint. Default value is `false`. * `tags` - (Optional) A mapping 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. +* `traffic_ip_address_type` - (Optional) IP address type for traffic within the Client VPN tunnel. Valid values are `ipv4`, `ipv6`, or `dual-stack`. Defaults to `ipv4`. When it is set to `ipv6`, `client_cidr_block` must not be specified. * `transport_protocol` - (Optional) The transport protocol to be used by the VPN session. Default value is `udp`. * `vpc_id` - (Optional) The ID of the VPC to associate with the Client VPN endpoint. If no security group IDs are specified in the request, the default security group for the VPC is applied. * `vpn_port` - (Optional) The port number for the Client VPN endpoint. Valid values are `443` and `1194`. Default value is `443`. diff --git a/website/docs/r/ecr_lifecycle_policy.html.markdown b/website/docs/r/ecr_lifecycle_policy.html.markdown index 360b6d424809..70b550592db1 100644 --- a/website/docs/r/ecr_lifecycle_policy.html.markdown +++ b/website/docs/r/ecr_lifecycle_policy.html.markdown @@ -97,6 +97,32 @@ This resource exports the following attributes in addition to the arguments abov ## Import +In Terraform v1.12.0 and later, the [`import` block](https://developer.hashicorp.com/terraform/language/import) can be used with the `identity` attribute. For example: + +```terraform +import { + to = aws_ecr_lifecycle_policy.example + identity = { + repository = "tf-example" + } +} + +resource "aws_ecr_lifecycle_policy" "example" { + ### Configuration omitted for brevity ### +} +``` + +### Identity Schema + +#### Required + +* `repository` - (String) Name of the ECR repository. + +#### Optional + +- `account_id` (String) AWS Account where this resource is managed. +- `region` (String) Region where this resource is managed. + In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import ECR Lifecycle Policy using the name of the repository. For example: ```terraform diff --git a/website/docs/r/ecr_repository.html.markdown b/website/docs/r/ecr_repository.html.markdown index 07704c2e4538..d2f527fa08fb 100644 --- a/website/docs/r/ecr_repository.html.markdown +++ b/website/docs/r/ecr_repository.html.markdown @@ -23,6 +23,25 @@ resource "aws_ecr_repository" "foo" { } ``` +### With Image Tag Mutability Exclusion + +```terraform +resource "aws_ecr_repository" "example" { + name = "example-repo" + image_tag_mutability = "IMMUTABLE_WITH_EXCLUSION" + + image_tag_mutability_exclusion_filter { + filter = "latest*" + filter_type = "WILDCARD" + } + + image_tag_mutability_exclusion_filter { + filter = "dev-*" + filter_type = "WILDCARD" + } +} +``` + ## Argument Reference This resource supports the following arguments: @@ -32,7 +51,8 @@ This resource supports the following arguments: * `encryption_configuration` - (Optional) Encryption configuration for the repository. See [below for schema](#encryption_configuration). * `force_delete` - (Optional) If `true`, will delete the repository even if it contains images. Defaults to `false`. -* `image_tag_mutability` - (Optional) The tag mutability setting for the repository. Must be one of: `MUTABLE` or `IMMUTABLE`. Defaults to `MUTABLE`. +* `image_tag_mutability` - (Optional) The tag mutability setting for the repository. Must be one of: `MUTABLE`, `IMMUTABLE`, `IMMUTABLE_WITH_EXCLUSION`, or `MUTABLE_WITH_EXCLUSION`. Defaults to `MUTABLE`. +* `image_tag_mutability_exclusion_filter` - (Optional) Configuration block that defines filters to specify which image tags can override the default tag mutability setting. Only applicable when `image_tag_mutability` is set to `IMMUTABLE_WITH_EXCLUSION` or `MUTABLE_WITH_EXCLUSION`. See [below for schema](#image_tag_mutability_exclusion_filter). * `image_scanning_configuration` - (Optional) Configuration block that defines image scanning configuration for the repository. By default, image scanning must be manually triggered. See the [ECR User Guide](https://docs.aws.amazon.com/AmazonECR/latest/userguide/image-scanning.html) for more information about image scanning. * `scan_on_push` - (Required) Indicates whether images are scanned after being pushed to the repository (true) or not scanned (false). * `tags` - (Optional) A 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. @@ -42,6 +62,11 @@ This resource supports the following arguments: * `encryption_type` - (Optional) The encryption type to use for the repository. Valid values are `AES256` or `KMS`. Defaults to `AES256`. * `kms_key` - (Optional) The ARN of the KMS key to use when `encryption_type` is `KMS`. If not specified, uses the default AWS managed key for ECR. +### image_tag_mutability_exclusion_filter + +* `filter` - (Required) The filter pattern to use for excluding image tags from the mutability setting. Must contain only letters, numbers, and special characters (._*-). Each filter can be up to 128 characters long and can contain a maximum of 2 wildcards (*). +* `filter_type` - (Required) The type of filter to use. Must be `WILDCARD`. + ## Attribute Reference This resource exports the following attributes in addition to the arguments above: @@ -59,6 +84,32 @@ This resource exports the following attributes in addition to the arguments abov ## Import +In Terraform v1.12.0 and later, the [`import` block](https://developer.hashicorp.com/terraform/language/import) can be used with the `identity` attribute. For example: + +```terraform +import { + to = aws_ecr_repository.service + identity = { + name = "test-service" + } +} + +resource "aws_ecr_repository" "service" { + ### Configuration omitted for brevity ### +} +``` + +### Identity Schema + +#### Required + +* `name` - (String) Name of the ECR repository. + +#### Optional + +- `account_id` (String) AWS Account where this resource is managed. +- `region` (String) Region where this resource is managed. + In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import ECR Repositories using the `name`. For example: ```terraform diff --git a/website/docs/r/ecr_repository_creation_template.html.markdown b/website/docs/r/ecr_repository_creation_template.html.markdown index 5f7508c004bb..21b059546106 100644 --- a/website/docs/r/ecr_repository_creation_template.html.markdown +++ b/website/docs/r/ecr_repository_creation_template.html.markdown @@ -95,6 +95,7 @@ This resource supports the following arguments: * `description` - (Optional) The description for this template. * `encryption_configuration` - (Optional) Encryption configuration for any created repositories. See [below for schema](#encryption_configuration). * `image_tag_mutability` - (Optional) The tag mutability setting for any created repositories. Must be one of: `MUTABLE` or `IMMUTABLE`. Defaults to `MUTABLE`. +* `image_tag_mutability_exclusion_filter` - (Optional) Configuration block that defines filters to specify which image tags can override the default tag mutability setting. Only applicable when `image_tag_mutability` is set to `IMMUTABLE_WITH_EXCLUSION` or `MUTABLE_WITH_EXCLUSION`. See [below for schema](#image_tag_mutability_exclusion_filter). * `lifecycle_policy` - (Optional) The lifecycle policy document to apply to any created repositories. See more details about [Policy Parameters](http://docs.aws.amazon.com/AmazonECR/latest/userguide/LifecyclePolicies.html#lifecycle_policy_parameters) in the official AWS docs. Consider using the [`aws_ecr_lifecycle_policy_document` data_source](/docs/providers/aws/d/ecr_lifecycle_policy_document.html) to generate/manage the JSON document used for the `lifecycle_policy` argument. * `repository_policy` - (Optional) The registry policy document to apply to any created repositories. This is a JSON formatted string. For more information about building IAM policy documents with Terraform, see the [AWS IAM Policy Document Guide](https://learn.hashicorp.com/terraform/aws/iam-policy). * `resource_tags` - (Optional) A map of tags to assign to any created repositories. @@ -104,6 +105,11 @@ This resource supports the following arguments: * `encryption_type` - (Optional) The encryption type to use for any created repositories. Valid values are `AES256` or `KMS`. Defaults to `AES256`. * `kms_key` - (Optional) The ARN of the KMS key to use when `encryption_type` is `KMS`. If not specified, uses the default AWS managed key for ECR. +### image_tag_mutability_exclusion_filter + +* `filter` - (Required) The filter pattern to use for excluding image tags from the mutability setting. Must contain only letters, numbers, and special characters (._*-). Each filter can be up to 128 characters long and can contain a maximum of 2 wildcards (*). +* `filter_type` - (Required) The type of filter to use. Must be `WILDCARD`. + ## Attribute Reference This resource exports the following attributes in addition to the arguments above: diff --git a/website/docs/r/ecr_repository_policy.html.markdown b/website/docs/r/ecr_repository_policy.html.markdown index 7450fd70047c..0026e49106fd 100644 --- a/website/docs/r/ecr_repository_policy.html.markdown +++ b/website/docs/r/ecr_repository_policy.html.markdown @@ -71,6 +71,32 @@ This resource exports the following attributes in addition to the arguments abov ## Import +In Terraform v1.12.0 and later, the [`import` block](https://developer.hashicorp.com/terraform/language/import) can be used with the `identity` attribute. For example: + +```terraform +import { + to = aws_ecr_repository_policy.example + identity = { + repository = "example" + } +} + +resource "aws_ecr_repository_policy" "example" { + ### Configuration omitted for brevity ### +} +``` + +### Identity Schema + +#### Required + +* `repository` - (String) Name of the ECR repository. + +#### Optional + +- `account_id` (String) AWS Account where this resource is managed. +- `region` (String) Region where this resource is managed. + In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import ECR Repository Policy using the repository name. For example: ```terraform diff --git a/website/docs/r/ecs_service.html.markdown b/website/docs/r/ecs_service.html.markdown index 4e0af7f0f23f..9120dc9f7f0c 100644 --- a/website/docs/r/ecs_service.html.markdown +++ b/website/docs/r/ecs_service.html.markdown @@ -102,6 +102,24 @@ resource "aws_ecs_service" "example" { } ``` +### Blue/Green Deployment with SIGINT Rollback + +```terraform +resource "aws_ecs_service" "example" { + name = "example" + cluster = aws_ecs_cluster.example.id + + # ... other configurations ... + + deployment_configuration { + strategy = "BLUE_GREEN" + } + + sigint_rollback = true + wait_for_steady_state = true +} +``` + ### Redeploy Service On Every Apply The key used with `triggers` is arbitrary. @@ -128,10 +146,11 @@ The following arguments are optional: * `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). * `alarms` - (Optional) Information about the CloudWatch alarms. [See below](#alarms). -* `availability_zone_rebalancing` - (Optional) ECS automatically redistributes tasks within a service across Availability Zones (AZs) to mitigate the risk of impaired application availability due to underlying infrastructure failures and task lifecycle activities. The valid values are `ENABLED` and `DISABLED`. Defaults to `DISABLED`. +* `availability_zone_rebalancing` - (Optional) ECS automatically redistributes tasks within a service across Availability Zones (AZs) to mitigate the risk of impaired application availability due to underlying infrastructure failures and task lifecycle activities. The valid values are `ENABLED` and `DISABLED`. When creating a new service, if no value is specified, it defaults to `ENABLED` if the service is compatible with AvailabilityZoneRebalancing. When updating an existing service, if no value is specified it defaults to the existing service's AvailabilityZoneRebalancing value. If the service never had an AvailabilityZoneRebalancing value set, Amazon ECS treats this as `DISABLED`. * `capacity_provider_strategy` - (Optional) Capacity provider strategies to use for the service. Can be one or more. These can be updated without destroying and recreating the service only if `force_new_deployment = true` and not changing from 0 `capacity_provider_strategy` blocks to greater than 0, or vice versa. [See below](#capacity_provider_strategy). Conflicts with `launch_type`. * `cluster` - (Optional) ARN of an ECS cluster. * `deployment_circuit_breaker` - (Optional) Configuration block for deployment circuit breaker. [See below](#deployment_circuit_breaker). +* `deployment_configuration` - (Optional) Configuration block for deployment settings. [See below](#deployment_configuration). * `deployment_controller` - (Optional) Configuration block for deployment controller configuration. [See below](#deployment_controller). * `deployment_maximum_percent` - (Optional) Upper limit (as a percentage of the service's desiredCount) of the number of running tasks that can be running in a service during a deployment. Not valid when using the `DAEMON` scheduling strategy. * `deployment_minimum_healthy_percent` - (Optional) Lower limit (as a percentage of the service's desiredCount) of the number of running tasks that must remain running and healthy in a service during a deployment. @@ -152,6 +171,7 @@ The following arguments are optional: * `scheduling_strategy` - (Optional) Scheduling strategy to use for the service. The valid values are `REPLICA` and `DAEMON`. Defaults to `REPLICA`. Note that [*Tasks using the Fargate launch type or the `CODE_DEPLOY` or `EXTERNAL` deployment controller types don't support the `DAEMON` scheduling strategy*](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html). * `service_connect_configuration` - (Optional) ECS Service Connect configuration for this service to discover and connect to services, and be discovered by, and connected from, other services within a namespace. [See below](#service_connect_configuration). * `service_registries` - (Optional) Service discovery registries for the service. The maximum number of `service_registries` blocks is `1`. [See below](#service_registries). +* `sigint_rollback` - (Optional) Whether to enable graceful termination of deployments using SIGINT signals. When enabled, allows customers to safely cancel an in-progress deployment and automatically trigger a rollback to the previous stable state. Defaults to `false`. Only applicable when using `ECS` deployment controller and requires `wait_for_steady_state = true`. * `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. * `task_definition` - (Optional) Family and revision (`family:revision`) or full ARN of the task definition that you want to run in your service. Required unless using the `EXTERNAL` deployment controller. If a revision is not specified, the latest `ACTIVE` revision is used. * `triggers` - (Optional) Map of arbitrary keys and values that, when changed, will trigger an in-place update (redeployment). Useful with `plantimestamp()`. See example above. @@ -206,6 +226,22 @@ The `capacity_provider_strategy` configuration block supports the following: * `capacity_provider` - (Required) Short name of the capacity provider. * `weight` - (Required) Relative percentage of the total number of launched tasks that should use the specified capacity provider. +### deployment_configuration + +The `deployment_configuration` configuration block supports the following: + +* `strategy` - (Optional) Type of deployment strategy. Valid values: `ROLLING`, `BLUE_GREEN`. Default: `ROLLING`. +* `bake_time_in_minutes` - (Optional) Number of minutes to wait after a new deployment is fully provisioned before terminating the old deployment. Only used when `strategy` is set to `BLUE_GREEN`. +* `lifecycle_hook` - (Optional) Configuration block for lifecycle hooks that are invoked during deployments. [See below](#lifecycle_hook). + +### lifecycle_hook + +The `lifecycle_hook` configuration block supports the following: + +* `hook_target_arn` - (Required) ARN of the Lambda function to invoke for the lifecycle hook. +* `role_arn` - (Required) ARN of the IAM role that grants the service permission to invoke the Lambda function. +* `lifecycle_stages` - (Required) Stages during the deployment when the hook should be invoked. Valid values: `RECONCILE_SERVICE`, `PRE_SCALE_UP`, `POST_SCALE_UP`, `TEST_TRAFFIC_SHIFT`, `POST_TEST_TRAFFIC_SHIFT`, `PRODUCTION_TRAFFIC_SHIFT`, `POST_PRODUCTION_TRAFFIC_SHIFT`. + ### deployment_circuit_breaker The `deployment_circuit_breaker` configuration block supports the following: @@ -227,9 +263,19 @@ The `deployment_controller` configuration block supports the following: * `target_group_arn` - (Required for ALB/NLB) ARN of the Load Balancer target group to associate with the service. * `container_name` - (Required) Name of the container to associate with the load balancer (as it appears in a container definition). * `container_port` - (Required) Port on the container to associate with the load balancer. +* `advanced_configuration` - (Optional) Configuration block for Blue/Green deployment settings. Required when using `BLUE_GREEN` deployment strategy. [See below](#advanced_configuration). -> **Version note:** Multiple `load_balancer` configuration block support was added in Terraform AWS Provider version 2.22.0. This allows configuration of [ECS service support for multiple target groups](https://aws.amazon.com/about-aws/whats-new/2019/07/amazon-ecs-services-now-support-multiple-load-balancer-target-groups/). +### advanced_configuration + +The `advanced_configuration` configuration block supports the following: + +* `alternate_target_group_arn` - (Required) ARN of the alternate target group to use for Blue/Green deployments. +* `production_listener_rule` - (Required) ARN of the listener rule that routes production traffic. +* `role_arn` - (Required) ARN of the IAM role that allows ECS to manage the target groups. +* `test_listener_rule` - (Optional) ARN of the listener rule that routes test traffic. + ### network_configuration `network_configuration` support the following: @@ -296,7 +342,7 @@ For more information, see [Task Networking](https://docs.aws.amazon.com/AmazonEC `service` supports the following: -* `client_alias` - (Optional) List of client aliases for this Service Connect service. You use these to assign names that can be used by client applications. The maximum number of client aliases that you can have in this list is 1. [See below](#client_alias). +* `client_alias` - (Optional) List of client aliases for this Service Connect service. You use these to assign names that can be used by client applications. For each service block where enabled is true, exactly one `client_alias` with one `port` should be specified. [See below](#client_alias). * `discovery_name` - (Optional) Name of the new AWS Cloud Map service that Amazon ECS creates for this Amazon ECS service. * `ingress_port_override` - (Optional) Port number for the Service Connect proxy to listen on. * `port_name` - (Required) Name of one of the `portMappings` from all the containers in the task definition of this Amazon ECS service. @@ -330,6 +376,26 @@ For more information, see [Task Networking](https://docs.aws.amazon.com/AmazonEC * `dns_name` - (Optional) Name that you use in the applications of client tasks to connect to this service. * `port` - (Required) Listening port number for the Service Connect proxy. This port is available inside of all of the tasks within the same namespace. +* `test_traffic_rules` - (Optional) Configuration block for test traffic routing rules. [See below](#test_traffic_rules). + +### test_traffic_rules + +The `test_traffic_rules` configuration block supports the following: + +* `header` - (Optional) Configuration block for header-based routing rules. [See below](#header). + +### header + +The `header` configuration block supports the following: + +* `name` - (Required) Name of the HTTP header to match. +* `value` - (Required) Configuration block for header value matching criteria. [See below](#value). + +### value + +The `value` configuration block supports the following: + +* `exact` - (Required) Exact string value to match in the header. ### tag_specifications diff --git a/website/docs/r/efs_mount_target.html.markdown b/website/docs/r/efs_mount_target.html.markdown index 51c03ab784ed..95d1d65048fb 100644 --- a/website/docs/r/efs_mount_target.html.markdown +++ b/website/docs/r/efs_mount_target.html.markdown @@ -38,6 +38,8 @@ This resource supports the following arguments: * `subnet_id` - (Required) The ID of the subnet to add the mount target in. * `ip_address` - (Optional) The address (within the address range of the specified subnet) at which the file system may be mounted via the mount target. +* `ip_address_type` - (Optional) IP address type for the mount target. Valid values are `IPV4_ONLY` (only IPv4 addresses), `IPV6_ONLY` (only IPv6 addresses), and `DUAL_STACK` (dual-stack, both IPv4 and IPv6 addresses). Defaults to `IPV4_ONLY`. +* `ipv6_address` - (Optional) IPv6 address to use. Valid only when `ip_address_type` is set to `IPV6_ONLY` or `DUAL_STACK`. * `security_groups` - (Optional) A list of up to 5 VPC security group IDs (that must be for the same VPC as subnet specified) in effect for the mount target. diff --git a/website/docs/r/eks_cluster.html.markdown b/website/docs/r/eks_cluster.html.markdown index 0790104dac30..389c2e193bd2 100644 --- a/website/docs/r/eks_cluster.html.markdown +++ b/website/docs/r/eks_cluster.html.markdown @@ -344,15 +344,16 @@ The following arguments are required: The following arguments are optional: -* `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). * `access_config` - (Optional) Configuration block for the access config associated with your cluster, see [Amazon EKS Access Entries](https://docs.aws.amazon.com/eks/latest/userguide/access-entries.html). [Detailed](#access_config) below. * `bootstrap_self_managed_addons` - (Optional) Install default unmanaged add-ons, such as `aws-cni`, `kube-proxy`, and CoreDNS during cluster creation. If `false`, you must manually install desired add-ons. Changing this value will force a new cluster to be created. Defaults to `true`. * `compute_config` - (Optional) Configuration block with compute configuration for EKS Auto Mode. [Detailed](#compute_config) below. +* `deletion_protection` - (Optional) Whether to enable deletion protection for the cluster. When enabled, the cluster cannot be deleted unless deletion protection is first disabled. Default: `false`. * `enabled_cluster_log_types` - (Optional) List of the desired control plane logging to enable. For more information, see [Amazon EKS Control Plane Logging](https://docs.aws.amazon.com/eks/latest/userguide/control-plane-logs.html). * `encryption_config` - (Optional) Configuration block with encryption configuration for the cluster. [Detailed](#encryption_config) below. * `force_update_version` - (Optional) Force version update by overriding upgrade-blocking readiness checks when updating a cluster. * `kubernetes_network_config` - (Optional) Configuration block with kubernetes network configuration for the cluster. [Detailed](#kubernetes_network_config) below. If removed, Terraform will only perform drift detection if a configuration value is provided. * `outpost_config` - (Optional) Configuration block representing the configuration of your local Amazon EKS cluster on an AWS Outpost. This block isn't available for creating Amazon EKS clusters on the AWS cloud. +* `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). * `remote_network_config` - (Optional) Configuration block with remote network configuration for EKS Hybrid Nodes. [Detailed](#remote_network_config) below. * `storage_config` - (Optional) Configuration block with storage configuration for EKS Auto Mode. [Detailed](#storage_config) below. * `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. @@ -365,7 +366,7 @@ The following arguments are optional: The `access_config` configuration block supports the following arguments: * `authentication_mode` - (Optional) The authentication mode for the cluster. Valid values are `CONFIG_MAP`, `API` or `API_AND_CONFIG_MAP` -* `bootstrap_cluster_creator_admin_permissions` - (Optional) Whether or not to bootstrap the access config values to the cluster. Default is `false`. +* `bootstrap_cluster_creator_admin_permissions` - (Optional) Whether or not to bootstrap the access config values to the cluster. Default is `true`. ### compute_config diff --git a/website/docs/r/elastic_beanstalk_application_version.html.markdown b/website/docs/r/elastic_beanstalk_application_version.html.markdown index 7025c44d9a0b..0cc4baeb8a7e 100644 --- a/website/docs/r/elastic_beanstalk_application_version.html.markdown +++ b/website/docs/r/elastic_beanstalk_application_version.html.markdown @@ -43,7 +43,7 @@ resource "aws_elastic_beanstalk_application_version" "default" { application = "tf-test-name" description = "application version created by terraform" bucket = aws_s3_bucket.default.id - key = aws_s3_object.default.id + key = aws_s3_object.default.key } ``` diff --git a/website/docs/r/elasticache_global_replication_group.html.markdown b/website/docs/r/elasticache_global_replication_group.html.markdown index 5e2ddaa606c4..7e77665e01e1 100644 --- a/website/docs/r/elasticache_global_replication_group.html.markdown +++ b/website/docs/r/elasticache_global_replication_group.html.markdown @@ -50,8 +50,7 @@ The initial Redis version is determined by the version set on the primary replic However, once it is part of a Global Replication Group, the Global Replication Group manages the version of all member replication groups. -The member replication groups must have [`lifecycle.ignore_changes[engine_version]`](https://www.terraform.io/language/meta-arguments/lifecycle) set, -or Terraform will always return a diff. +The provider is configured to ignore changes to `engine`, `engine_version` and `parameter_group_name` inside `aws_elasticache_replication_group` resources if they belong to a global replication group. In this example, the primary replication group will be created with Redis 6.0, @@ -75,10 +74,6 @@ resource "aws_elasticache_replication_group" "primary" { node_type = "cache.m5.large" num_cache_clusters = 1 - - lifecycle { - ignore_changes = [engine_version] - } } resource "aws_elasticache_replication_group" "secondary" { @@ -89,10 +84,6 @@ resource "aws_elasticache_replication_group" "secondary" { global_replication_group_id = aws_elasticache_global_replication_group.example.global_replication_group_id num_cache_clusters = 1 - - lifecycle { - ignore_changes = [engine_version] - } } ``` @@ -107,7 +98,12 @@ This resource supports the following arguments: See AWS documentation for information on [supported node types](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/CacheNodes.SupportedTypes.html) and [guidance on selecting node types](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/nodes-select-size.html). When creating, by default the Global Replication Group inherits the node type of the primary replication group. -* `engine_version` - (Optional) Redis version to use for the Global Replication Group. +* `engine` - (Optional) The name of the cache engine to be used for the clusters in this global replication group. + When creating, by default the Global Replication Group inherits the engine of the primary replication group. + If an engine is specified, the Global Replication Group and all member replication groups will be upgraded to this engine. + Valid values are `redis` or `valkey`. + Default is `redis` if `engine_version` is specified. +* `engine_version` - (Optional) Engine version to use for the Global Replication Group. When creating, by default the Global Replication Group inherits the version of the primary replication group. If a version is specified, the Global Replication Group and all member replication groups will be upgraded to this version. Cannot be downgraded without replacing the Global Replication Group and all member replication groups. @@ -120,7 +116,7 @@ This resource supports the following arguments: * `global_replication_group_description` - (Optional) A user-created description for the global replication group. * `num_node_groups` - (Optional) The number of node groups (shards) on the global replication group. * `parameter_group_name` - (Optional) An ElastiCache Parameter Group to use for the Global Replication Group. - Required when upgrading a major engine version, but will be ignored if left configured after the upgrade is complete. + Required when upgrading an engine or major engine version, but will be ignored if left configured after the upgrade is complete. Specifying without a major version upgrade will fail. Note that ElastiCache creates a copy of this parameter group for each member replication group. @@ -134,7 +130,6 @@ This resource exports the following attributes in addition to the arguments abov * `at_rest_encryption_enabled` - A flag that indicate whether the encryption at rest is enabled. * `auth_token_enabled` - A flag that indicate whether AuthToken (password) is enabled. * `cluster_enabled` - Indicates whether the Global Datastore is cluster enabled. -* `engine` - The name of the cache engine to be used for the clusters in this global replication group. * `global_replication_group_id` - The full ID of the global replication group. * `global_node_groups` - Set of node groups (shards) on the global replication group. Has the values: diff --git a/website/docs/r/emr_cluster.html.markdown b/website/docs/r/emr_cluster.html.markdown index 61000f843276..96a7c2853fe2 100644 --- a/website/docs/r/emr_cluster.html.markdown +++ b/website/docs/r/emr_cluster.html.markdown @@ -668,6 +668,8 @@ EOF * `unhealthy_node_replacement` - (Optional) Whether whether Amazon EMR should gracefully replace core nodes that have degraded within the cluster. Default value is `false`. * `visible_to_all_users` - (Optional) Whether the job flow is visible to all IAM users of the AWS account associated with the job flow. Default value is `true`. + **NOTE:** As per the [Amazon EMR API Reference](https://docs.aws.amazon.com/emr/latest/APIReference/API_RunJobFlow.html#EMR-RunJobFlow-request-VisibleToAllUsers), this argument is no longer supported. Do not set this argument, particularly to `false`, as it would lead to perpetual differences. + ### bootstrap_action * `args` - (Optional) List of command line arguments to pass to the bootstrap action script. @@ -834,7 +836,6 @@ This resource exports the following attributes in addition to the arguments abov * `release_label` - Release label for the Amazon EMR release. * `service_role` - IAM role that will be assumed by the Amazon EMR service to access AWS resources on your behalf. * `tags_all` - Map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). -* `visible_to_all_users` - Indicates whether the job flow is visible to all IAM users of the AWS account associated with the job flow. ## Import diff --git a/website/docs/r/finspace_kx_volume.html.markdown b/website/docs/r/finspace_kx_volume.html.markdown index e96a0edb147d..50f5cc1665ff 100644 --- a/website/docs/r/finspace_kx_volume.html.markdown +++ b/website/docs/r/finspace_kx_volume.html.markdown @@ -18,7 +18,7 @@ Terraform resource for managing an AWS FinSpace Kx Volume. resource "aws_finspace_kx_volume" "example" { name = "my-tf-kx-volume" environment_id = aws_finspace_kx_environment.example.id - availability_zones = "use1-az2" + availability_zones = ["use1-az2"] az_mode = "SINGLE" type = "NAS_1" nas1_configuration { diff --git a/website/docs/r/flow_log.html.markdown b/website/docs/r/flow_log.html.markdown index c0ef726e4d38..1f4ee4d517f1 100644 --- a/website/docs/r/flow_log.html.markdown +++ b/website/docs/r/flow_log.html.markdown @@ -9,7 +9,7 @@ description: |- # Resource: aws_flow_log Provides a VPC/Subnet/ENI/Transit Gateway/Transit Gateway Attachment Flow Log to capture IP traffic for a specific network -interface, subnet, or VPC. Logs are sent to a CloudWatch Log Group, a S3 Bucket, or Amazon Kinesis Data Firehose +interface, subnet, or VPC. Logs are sent to a CloudWatch Log Group, a S3 Bucket, or Amazon Data Firehose ## Example Usage @@ -68,7 +68,7 @@ resource "aws_iam_role_policy" "example" { } ``` -### Amazon Kinesis Data Firehose logging +### Amazon Data Firehose logging ```terraform resource "aws_flow_log" "example" { @@ -174,15 +174,152 @@ resource "aws_s3_bucket" "example" { } ``` +### Cross-Account Amazon Data Firehose Logging + +The following example shows how to set up a flow log in one AWS account (source) that sends logs to an Amazon Data Firehose delivery stream in another AWS account (destination). +See the [AWS Documentation](https://docs.aws.amazon.com/vpc/latest/userguide/flow-logs-firehose.html). + +```terraform +# Provider configurations +provider "aws" { + profile = "admin-src" +} + +provider "aws" { + alias = "destination_account" + profile = "admin-dst" +} + +# For source account +resource "aws_vpc" "src" { + # config... +} + +data "aws_iam_policy_document" "src_assume_role_policy" { + statement { + actions = ["sts:AssumeRole"] + effect = "Allow" + principals { + type = "Service" + identifiers = ["delivery.logs.amazonaws.com"] + } + } +} + +resource "aws_iam_role" "src" { + name = "tf-example-mySourceRole" + assume_role_policy = data.aws_iam_policy_document.src_assume_role_policy.json +} + +data "aws_iam_policy_document" "src_role_policy" { + statement { + effect = "Allow" + actions = ["iam:PassRole"] + resources = [aws_iam_role.src.arn] + + condition { + test = "StringEquals" + variable = "iam:PassedToService" + values = ["delivery.logs.amazonaws.com"] + } + + condition { + test = "StringLike" + variable = "iam:AssociatedResourceARN" + values = [aws_vpc.src.arn] + } + } + + statement { + effect = "Allow" + actions = [ + "logs:CreateLogDelivery", + "logs:DeleteLogDelivery", + "logs:ListLogDeliveries", + "logs:GetLogDelivery" + ] + resources = ["*"] + } + + statement { + effect = "Allow" + actions = ["sts:AssumeRole"] + resources = [aws_iam_role.dst.arn] + } +} + +resource "aws_iam_role_policy" "src_policy" { + name = "tf-example-mySourceRolePolicy" + role = aws_iam_role.src.name + policy = data.aws_iam_policy_document.src_role_policy.json +} + +resource "aws_flow_log" "src" { + log_destination_type = "kinesis-data-firehose" + log_destination = aws_kinesis_firehose_delivery_stream.dst.arn + traffic_type = "ALL" + vpc_id = aws_vpc.src.id + iam_role_arn = aws_iam_role.src.arn + deliver_cross_account_role = aws_iam_role.dst.arn +} + +# For destination account +data "aws_iam_policy_document" "dst_assume_role_policy" { + statement { + actions = ["sts:AssumeRole"] + effect = "Allow" + principals { + type = "AWS" + identifiers = [aws_iam_role.src.arn] + } + } +} + +resource "aws_iam_role" "dst" { + provider = aws.destination_account + name = "AWSLogDeliveryFirehoseCrossAccountRole" # must start with "AWSLogDeliveryFirehoseCrossAccountRolePolicy" + assume_role_policy = data.aws_iam_policy_document.dst_assume_role_policy.json +} + +data "aws_iam_policy_document" "dst_role_policy" { + statement { + effect = "Allow" + actions = [ + "iam:CreateServiceLinkedRole", + "firehose:TagDeliveryStream" + ] + resources = ["*"] + } +} + +resource "aws_iam_role_policy" "dst" { + provider = aws.destination_account + name = "AWSLogDeliveryFirehoseCrossAccountRolePolicy" + role = aws_iam_role.dst.name + policy = data.aws_iam_policy_document.dst_role_policy.json +} + +resource "aws_kinesis_firehose_delivery_stream" "dst" { + provider = aws.destination_account + # The tag named "LogDeliveryEnabled" must be set to "true" to allow the service-linked role "AWSServiceRoleForLogDelivery" + # to perform permitted actions on your behalf. + # See: https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/AWS-logs-infrastructure-Firehose.html + tags = { + LogDeliveryEnabled = "true" + } + # other config... +} +``` + ## Argument Reference This resource supports the following arguments: * `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). * `traffic_type` - (Required) The type of traffic to capture. Valid values: `ACCEPT`,`REJECT`, `ALL`. -* `deliver_cross_account_role` - (Optional) ARN of the IAM role that allows Amazon EC2 to publish flow logs across accounts. +* `deliver_cross_account_role` - (Optional) ARN of the IAM role in the destination account used for cross-account delivery of flow logs. * `eni_id` - (Optional) Elastic Network Interface ID to attach to. -* `iam_role_arn` - (Optional) ARN of the IAM role that's used to post flow logs to a CloudWatch Logs log group. +* `iam_role_arn` - (Optional) ARN of the IAM role used to post flow logs. Corresponds to `DeliverLogsPermissionArn` in the [AWS API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFlowLogs.html). * `log_destination_type` - (Optional) Logging destination type. Valid values: `cloud-watch-logs`, `s3`, `kinesis-data-firehose`. Default: `cloud-watch-logs`. * `log_destination` - (Optional) ARN of the logging destination. * `subnet_id` - (Optional) Subnet ID to attach to. diff --git a/website/docs/r/fsx_openzfs_file_system.html.markdown b/website/docs/r/fsx_openzfs_file_system.html.markdown index 9bcba93aa133..6637dcb91e56 100644 --- a/website/docs/r/fsx_openzfs_file_system.html.markdown +++ b/website/docs/r/fsx_openzfs_file_system.html.markdown @@ -50,6 +50,7 @@ The following arguments are optional: * `security_group_ids` - (Optional) A list of IDs for the security groups that apply to the specified network interfaces created for file system access. These security groups will apply to all network interfaces. * `skip_final_backup` - (Optional) When enabled, will skip the default final backup taken when the file system is deleted. This configuration must be applied separately before attempting to delete the resource to have the desired behavior. Defaults to `false`. * `storage_type` - (Optional) The filesystem storage type. Only `SSD` is supported. +* `user_and_group_quotas` - (Optional) - Specify how much storage users or groups can use on the filesystem. Maximum number of items defined by [FSx for OpenZFS Resource quota](https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/limits.html#limits-openzfs-resources-file-system). See [`user_and_group_quotas` Block](#user_and_group_quotas-block) Below. * `tags` - (Optional) A map of tags to assign to the file system. 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. * `weekly_maintenance_start_time` - (Optional) The preferred start time (in `d:HH:MM` format) to perform weekly maintenance, in the UTC time zone. diff --git a/website/docs/r/fsx_openzfs_volume.html.markdown b/website/docs/r/fsx_openzfs_volume.html.markdown index 2e10f5ab1993..71514449609c 100644 --- a/website/docs/r/fsx_openzfs_volume.html.markdown +++ b/website/docs/r/fsx_openzfs_volume.html.markdown @@ -36,7 +36,7 @@ This resource supports the following arguments: * `origin_snapshot` - (Optional) Specifies the configuration to use when creating the OpenZFS volume. See [`origin_snapshot` Block](#origin_snapshot-block) below for details. * `storage_capacity_quota_gib` - (Optional) The maximum amount of storage in gibibytes (GiB) that the volume can use from its parent. * `storage_capacity_reservation_gib` - (Optional) The amount of storage in gibibytes (GiB) to reserve from the parent volume. -* `user_and_group_quotas` - (Optional) - Specify how much storage users or groups can use on the volume. Maximum of 100 items. See [`user_and_group_quotas` Block](#user_and_group_quotas-block) Below. +* `user_and_group_quotas` - (Optional) - Specify how much storage users or groups can use on the volume. Maximum number of items defined by [FSx for OpenZFS Resource quota](https://docs.aws.amazon.com/fsx/latest/OpenZFSGuide/limits.html#limits-openzfs-resources-file-system). See [`user_and_group_quotas` Block](#user_and_group_quotas-block) Below. * `tags` - (Optional) A map of tags to assign to the file system. 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. ### `nfs_exports` Block diff --git a/website/docs/r/fsx_s3_access_point_attachment.html.markdown b/website/docs/r/fsx_s3_access_point_attachment.html.markdown new file mode 100644 index 000000000000..ed6a91d469ea --- /dev/null +++ b/website/docs/r/fsx_s3_access_point_attachment.html.markdown @@ -0,0 +1,112 @@ +--- +subcategory: "FSx" +layout: "aws" +page_title: "AWS: aws_fsx_s3_access_point_attachment" +description: |- + Manages an Amazon FSx S3 Access Point attachment. +--- + +# Resource: aws_fsx_s3_access_point_attachment + +Manages an Amazon FSx S3 Access Point attachment. + +## Example Usage + +```terraform +resource "aws_fsx_s3_access_point_attachment" "example" { + name = "example-attachment" + type = "OPENZFS" + + openzfs_configuration { + volume_id = aws_fsx_openzfs_volume.example.id + + file_system_identity { + type = "POSIX" + + posix_user { + uid = 1001 + gid = 1001 + } + } + } +} +``` + +## Argument Reference + +The following arguments are required: + +* `name` - (Required) Name of the S3 access point. +* `openzfs_configuration` - (Required) Configuration to use when creating and attaching an S3 access point to an FSx for OpenZFS volume. See [`openzfs_configuration` Block](#openzfs_configuration-block) for details. +* `type` - (Required) Type of S3 access point. Valid values: `OpenZFS`. + +The following arguments are optional: + +* `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). +* `s3_access_point` - (Optional) S3 access point configuration. See [`s3_access_point` Block](#s3_access_point-block) for details. + +### `openzfs_configuration` Block + +The `openzfs_configuration` configuration block supports the following arguments: + +* `file_system_identity` - (Required) File system user identity to use for authorizing file read and write requests that are made using the S3 access point. See [`file_system_identity` Block](#file_system_identity-block) for details. +* `volume_id` - (Required) ID of the FSx for OpenZFS volume to which the S3 access point is attached. + +### `file_system_identity` Block + +The `file_system_identity` configuration block supports the following arguments: + +* `posix_user` - (Required) UID and GIDs of the file system POSIX user. See [`posix_user` Block](#posix_user-block) for details. +* `type` - (Required) FSx for OpenZFS user identity type. Valid values: `POSIX`. + +### `posix_user` Block + +The `posix_user` configuration block supports the following arguments: + +* `gid` - (Required) GID of the file system user. +* `secondary_gids` - (Optional) List of secondary GIDs for the file system user.. +* `uid` - (Required) UID of the file system user. + +### `s3_access_point` Block + +The `s3_access_point` configuration block supports the following arguments: + +* `policy` - (Required) Access policy associated with the S3 access point configuration. +* `vpc_configuration` - (Optional) Amazon S3 restricts access to the S3 access point to requests made from the specified VPC. See [`vpc_configuration` Block](#vpc_configuration-block) for details. + +### `vpc_configuration` Block + +The `vpc_configuration` configuration block supports the following arguments: + +* `vpc_id` - (Required) VPC ID. + +## Attribute Reference + +This resource exports the following attributes in addition to the arguments above: + +* `s3_access_point_alias` - S3 access point's alias. +* `s3_access_point_arn` - S3 access point's ARN. + +## Timeouts + +[Configuration options](https://developer.hashicorp.com/terraform/language/resources/syntax#operation-timeouts): + +* `create` - (Default `15m`) +* `delete` - (Default `15m`) + +## Import + +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import FSx S3 Access Point attachments using the `name`. For example: + +```terraform +import { + to = aws_fsx_s3_access_point_attachment.example + id = "example-attachment" +} +``` + +Using `terraform import`, import FSx S3 Access Point attachments using the `name`. For example: + +```console +% terraform import aws_fsx_s3_access_point_attachment.example example-attachment +``` diff --git a/website/docs/r/gamelift_fleet.html.markdown b/website/docs/r/gamelift_fleet.html.markdown index 9caa1e1326ca..48c4cb65ddc7 100644 --- a/website/docs/r/gamelift_fleet.html.markdown +++ b/website/docs/r/gamelift_fleet.html.markdown @@ -33,7 +33,7 @@ resource "aws_gamelift_fleet" "example" { This resource supports the following arguments: * `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). -* `build_id` - (Optional) ID of the GameLift Build to be deployed on the fleet. +* `build_id` - (Optional) ID of the GameLift Build to be deployed on the fleet. Conflicts with `script_id`. * `certificate_configuration` - (Optional) Prompts GameLift to generate a TLS/SSL certificate for the fleet. See [certificate_configuration](#certificate_configuration). * `description` - (Optional) Human-readable description of the fleet. * `ec2_inbound_permission` - (Optional) Range of IP addresses and port settings that permit inbound traffic to access server processes running on the fleet. See below. @@ -45,7 +45,7 @@ This resource supports the following arguments: * `new_game_session_protection_policy` - (Optional) Game session protection policy to apply to all instances in this fleetE.g., `FullProtection`. Defaults to `NoProtection`. * `resource_creation_limit_policy` - (Optional) Policy that limits the number of game sessions an individual player can create over a span of time for this fleet. See below. * `runtime_configuration` - (Optional) Instructions for launching server processes on each instance in the fleet. See below. -* `script_id` - (Optional) ID of the GameLift Script to be deployed on the fleet. +* `script_id` - (Optional) ID of the GameLift Script to be deployed on the fleet. Conflicts with `build_id`. * `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. ### Nested Fields diff --git a/website/docs/r/globalaccelerator_cross_account_attachment.html.markdown b/website/docs/r/globalaccelerator_cross_account_attachment.html.markdown index 9c4bbaa89697..363fb3d86dde 100644 --- a/website/docs/r/globalaccelerator_cross_account_attachment.html.markdown +++ b/website/docs/r/globalaccelerator_cross_account_attachment.html.markdown @@ -69,7 +69,7 @@ This resource exports the following attributes in addition to the arguments abov ## Import -In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import Global Accelerator Cross Account Attachment using the `example_id_arg`. For example: +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import Global Accelerator Cross Account Attachment using the `arn`. For example: ```terraform import { @@ -78,7 +78,7 @@ import { } ``` -Using `terraform import`, import Global Accelerator Cross Account Attachment using the `example_id_arg`. For example: +Using `terraform import`, import Global Accelerator Cross Account Attachment using the `arn`. For example: ```console % terraform import aws_globalaccelerator_cross_account_attachment.example arn:aws:globalaccelerator::012345678910:attachment/01234567-abcd-8910-efgh-123456789012 diff --git a/website/docs/r/glue_catalog_table.html.markdown b/website/docs/r/glue_catalog_table.html.markdown index 36433bc535b3..41dd1fe3a0ec 100644 --- a/website/docs/r/glue_catalog_table.html.markdown +++ b/website/docs/r/glue_catalog_table.html.markdown @@ -132,6 +132,7 @@ To add an index to an existing table, see the [`glue_partition_index` resource]( * `comment` - (Optional) Free-form text comment. * `name` - (Required) Name of the Partition Key. +* `parameters` - (Optional) Map of key-value pairs. * `type` - (Optional) Datatype of data in the Partition Key. ### storage_descriptor diff --git a/website/docs/r/glue_job.html.markdown b/website/docs/r/glue_job.html.markdown index 8574bbd4065f..dd65cf9cf575 100644 --- a/website/docs/r/glue_job.html.markdown +++ b/website/docs/r/glue_job.html.markdown @@ -216,36 +216,29 @@ resource "aws_glue_job" "example" { This resource supports the following arguments: -* `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). * `command` - (Required) The command of the job. Defined below. * `connections` - (Optional) The list of connections used for this job. * `default_arguments` - (Optional) The map of default arguments for this job. You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes. For information about how to specify and consume your own Job arguments, see the [Calling AWS Glue APIs in Python](http://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-calling.html) topic in the developer guide. For information about the key-value pairs that AWS Glue consumes to set up your job, see the [Special Parameters Used by AWS Glue](http://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-glue-arguments.html) topic in the developer guide. -* `non_overridable_arguments` - (Optional) Non-overridable arguments for this job, specified as name-value pairs. * `description` - (Optional) Description of the job. +* `execution_class` - (Optional) Indicates whether the job is run with a standard or flexible execution class. The standard execution class is ideal for time-sensitive workloads that require fast job startup and dedicated resources. Valid value: `FLEX`, `STANDARD`. * `execution_property` - (Optional) Execution property of the job. Defined below. * `glue_version` - (Optional) The version of glue to use, for example "1.0". Ray jobs should set this to 4.0 or greater. For information about available versions, see the [AWS Glue Release Notes](https://docs.aws.amazon.com/glue/latest/dg/release-notes.html). * `job_mode` - (Optional) Describes how a job was created. Valid values are `SCRIPT`, `NOTEBOOK` and `VISUAL`. * `job_run_queuing_enabled` - (Optional) Specifies whether job run queuing is enabled for the job runs for this job. A value of true means job run queuing is enabled for the job runs. If false or not populated, the job runs will not be considered for queueing. -* `execution_class` - (Optional) Indicates whether the job is run with a standard or flexible execution class. The standard execution class is ideal for time-sensitive workloads that require fast job startup and dedicated resources. Valid value: `FLEX`, `STANDARD`. * `maintenance_window` - (Optional) Specifies the day of the week and hour for the maintenance window for streaming jobs. * `max_capacity` - (Optional) The maximum number of AWS Glue data processing units (DPUs) that can be allocated when this job runs. `Required` when `pythonshell` is set, accept either `0.0625` or `1.0`. Use `number_of_workers` and `worker_type` arguments instead with `glue_version` `2.0` and above. * `max_retries` - (Optional) The maximum number of times to retry this job if it fails. * `name` - (Required) The name you assign to this job. It must be unique in your account. +* `non_overridable_arguments` - (Optional) Non-overridable arguments for this job, specified as name-value pairs. * `notification_property` - (Optional) Notification property of the job. Defined below. +* `number_of_workers` - (Optional) The number of workers of a defined workerType that are allocated when a job runs. +* `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). * `role_arn` - (Required) The ARN of the IAM role associated with this job. * `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) The job timeout in minutes. The default is 2880 minutes (48 hours) for `glueetl` and `pythonshell` jobs, and null (unlimited) for `gluestreaming` jobs. * `security_configuration` - (Optional) The name of the Security Configuration to be associated with the job. * `source_control_details` - (Optional) The details for a source control configuration for a job, allowing synchronization of job artifacts to or from a remote repository. Defined below. -* `worker_type` - (Optional) The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, G.2X, or G.025X for Spark jobs. Accepts the value Z.2X for Ray jobs. - * For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker. - * For the G.1X worker type, each worker maps to 1 DPU (4 vCPU, 16 GB of memory, 64 GB disk), and provides 1 executor per worker. Recommended for memory-intensive jobs. - * For the G.2X worker type, each worker maps to 2 DPU (8 vCPU, 32 GB of memory, 128 GB disk), and provides 1 executor per worker. Recommended for memory-intensive jobs. - * For the G.4X worker type, each worker maps to 4 DPU (16 vCPUs, 64 GB of memory) with 256GB disk (approximately 235GB free), and provides 1 executor per worker. Recommended for memory-intensive jobs. Only available for Glue version 3.0. Available AWS Regions: US East (Ohio), US East (N. Virginia), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe (Stockholm). - * For the G.8X worker type, each worker maps to 8 DPU (32 vCPUs, 128 GB of memory) with 512GB disk (approximately 487GB free), and provides 1 executor per worker. Recommended for memory-intensive jobs. Only available for Glue version 3.0. Available AWS Regions: US East (Ohio), US East (N. Virginia), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe (Stockholm). - * For the G.025X worker type, each worker maps to 0.25 DPU (2 vCPU, 4GB of memory, 64 GB disk), and provides 1 executor per worker. Recommended for low volume streaming jobs. Only available for Glue version 3.0. - * For the Z.2X worker type, each worker maps to 2 M-DPU (8vCPU, 64 GB of m emory, 128 GB disk), and provides up to 8 Ray workers based on the autoscaler. -* `number_of_workers` - (Optional) The number of workers of a defined workerType that are allocated when a job runs. +* `worker_type` - (Optional) The type of predefined worker that is allocated when a job runs. Valid values: `Standard`, `G.1X`, `G.2X`, `G.025X`, `G.4X`, `G.8X`, `G.12X`, `G.16X`, `R.1X`, `R.2X`, `R.4X`, `R.8X`, `Z.2X` (Ray jobs). See the [AWS documentation](https://docs.aws.amazon.com/glue/latest/dg/worker-types.html) for details. ### command Argument Reference diff --git a/website/docs/r/imagebuilder_workflow.html.markdown b/website/docs/r/imagebuilder_workflow.html.markdown index a1acbe63929b..41b9a8eaa13e 100644 --- a/website/docs/r/imagebuilder_workflow.html.markdown +++ b/website/docs/r/imagebuilder_workflow.html.markdown @@ -80,7 +80,7 @@ This resource exports the following attributes in addition to the arguments abov ## Import -In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import EC2 Image Builder Workflow using the `example_id_arg`. For example: +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import EC2 Image Builder Workflow using the `arn`. For example: ```terraform import { @@ -89,7 +89,7 @@ import { } ``` -Using `terraform import`, import EC2 Image Builder Workflow using the `example_id_arg`. For example: +Using `terraform import`, import EC2 Image Builder Workflow using the `arn`. For example: ```console % terraform import aws_imagebuilder_workflow.example arn:aws:imagebuilder:us-east-1:aws:workflow/test/example/1.0.1/1 diff --git a/website/docs/r/inspector2_enabler.html.markdown b/website/docs/r/inspector2_enabler.html.markdown index 6962dcce2d17..d2b363718df8 100644 --- a/website/docs/r/inspector2_enabler.html.markdown +++ b/website/docs/r/inspector2_enabler.html.markdown @@ -42,7 +42,7 @@ This resource supports the following arguments: * `account_ids` - (Required) Set of account IDs. Can contain one of: the Organization's Administrator Account, or one or more Member Accounts. * `resource_types` - (Required) Type of resources to scan. - Valid values are `EC2`, `ECR`, `LAMBDA` and `LAMBDA_CODE`. + Valid values are `EC2`, `ECR`, `LAMBDA`, `LAMBDA_CODE` and `CODE_REPOSITORY`. At least one item is required. ## Attribute Reference @@ -56,3 +56,20 @@ This resource exports no additional attributes. * `create` - (Default `5m`) * `update` - (Default `5m`) * `delete` - (Default `5m`) + +## Import + +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import Inspector Enabler using `account_ids` and `region_types` formatted as `[account_id1]:[account_id2]:...-[resource_type1]:[resource_type2]:...`, where `account_ids` are sorted in ascending order and `resource_types` are sorted in alphabetical order. For example: + +```terraform +import { + to = aws_inspector2_enabler.example + id = "123456789012:234567890123-EC2:ECR" +} +``` + +Using `terraform import`, import Inspector Enabler using using `account_ids` and `region_types` formatted as `[account_id1]:[account_id2]:...-[resource_type1]:[resource_type2]:...`, where `account_ids` are sorted in ascending order and `resource_types` are sorted in alphabetical order. For example: + +```console +% terraform import aws_inspector2_enabler.example 123456789012:234567890123-EC2:ECR +``` diff --git a/website/docs/r/inspector2_filter.html.markdown b/website/docs/r/inspector2_filter.html.markdown index b2544b0f7b75..1bf2b3f53b90 100644 --- a/website/docs/r/inspector2_filter.html.markdown +++ b/website/docs/r/inspector2_filter.html.markdown @@ -54,6 +54,8 @@ This resource exports the following attributes in addition to the arguments abov The `filter_criteria` configuration block supports the following attributes: * `aws_account_id` - (Optional) The AWS account ID in which the finding was generated. [Documented below](#string-filter). +* `code_repository_project_name` - (Optional) The project name in a code repository. [Documented below](#string-filter). +* `code_repository_provider_type` - (Optional) The repository provider type (such as GitHub, GitLab, etc.) [Documented below](#string-filter). * `code_vulnerability_detector_name` - (Optional) The ID of the component. [Documented below](#string-filter). * `code_vulnerability_detector_tags` - (Optional) The ID of the component. [Documented below](#string-filter). * `code_vulnerability_file_path` - (Optional) The ID of the component. [Documented below](#string-filter). @@ -63,6 +65,8 @@ The `filter_criteria` configuration block supports the following attributes: * `ec2_instance_subnet_id` - (Optional) The ID of the subnet. [Documented below](#string-filter). * `ec2_instance_vpc_id` - (Optional) The ID of the VPC. [Documented below](#string-filter). * `ecr_image_architecture` - (Optional) The architecture of the ECR image. [Documented below](#string-filter). +* `ecr_image_in_use_count` - (Optional) The number of the ECR images in use. [Documented below](#number-filter). +* `ecr_image_last_in_use_at` - (Optional) The date range when an ECR image was last used in an ECS cluster task or EKS cluster pod. [Documented below](#date-filter). * `ecr_image_hash` - (Optional) The SHA256 hash of the ECR image. [Documented below](#string-filter). * `ecr_image_pushed_at` - (Optional) The date range when the image was pushed. [Documented below](#date-filter). * `ecr_image_registry` - (Optional) The registry of the ECR image. [Documented below](#string-filter). @@ -156,7 +160,7 @@ import { } ``` -Using `terraform import`, import Inspector Filter using the `example_id_arg`. For example: +Using `terraform import`, import Inspector Filter using the `arn`. For example: ```console % terraform import aws_inspector2_filter.example "arn:aws:inspector2:us-east-1:111222333444:owner/111222333444/filter/abcdefgh12345678" diff --git a/website/docs/r/inspector2_organization_configuration.html.markdown b/website/docs/r/inspector2_organization_configuration.html.markdown index e7f2e48f1c9c..76292ec041fc 100644 --- a/website/docs/r/inspector2_organization_configuration.html.markdown +++ b/website/docs/r/inspector2_organization_configuration.html.markdown @@ -21,10 +21,11 @@ Terraform resource for managing an Amazon Inspector Organization Configuration. ```terraform resource "aws_inspector2_organization_configuration" "example" { auto_enable { - ec2 = true - ecr = false - lambda = true - lambda_code = true + ec2 = true + ecr = false + code_repository = false + lambda = true + lambda_code = true } } ``` @@ -40,6 +41,7 @@ This resource supports the following arguments: * `ec2` - (Required) Whether Amazon EC2 scans are automatically enabled for new members of your Amazon Inspector organization. * `ecr` - (Required) Whether Amazon ECR scans are automatically enabled for new members of your Amazon Inspector organization. +* `code_repository` - (Optional) Whether code repository scans are automatically enabled for new members of your Amazon Inspector organization. * `lambda` - (Optional) Whether Lambda Function scans are automatically enabled for new members of your Amazon Inspector organization. * `lambda_code` - (Optional) Whether AWS Lambda code scans are automatically enabled for new members of your Amazon Inspector organization. **Note:** Lambda code scanning requires Lambda standard scanning to be activated. Consequently, if you are setting this argument to `true`, you must also set the `lambda` argument to `true`. See [Scanning AWS Lambda functions with Amazon Inspector](https://docs.aws.amazon.com/inspector/latest/user/scanning-lambda.html#lambda-code-scans) for more information. diff --git a/website/docs/r/instance.html.markdown b/website/docs/r/instance.html.markdown index d8a46ec4b08a..914628b9675c 100644 --- a/website/docs/r/instance.html.markdown +++ b/website/docs/r/instance.html.markdown @@ -33,7 +33,7 @@ data "aws_ami" "ubuntu" { owners = ["099720109477"] # Canonical } -resource "aws_instance" "web" { +resource "aws_instance" "example" { ami = data.aws_ami.ubuntu.id instance_type = "t3.micro" @@ -46,7 +46,7 @@ resource "aws_instance" "web" { Using AWS Systems Manager Parameter Store ```terraform -resource "aws_instance" "web" { +resource "aws_instance" "example" { ami = "resolve:ssm:/aws/service/ami-amazon-linux-latest/al2023-ami-kernel-default-x86_64" instance_type = "t3.micro" @@ -59,7 +59,7 @@ resource "aws_instance" "web" { ### Spot instance example ```terraform -data "aws_ami" "this" { +data "aws_ami" "example" { most_recent = true owners = ["amazon"] filter { @@ -72,8 +72,8 @@ data "aws_ami" "this" { } } -resource "aws_instance" "this" { - ami = data.aws_ami.this.id +resource "aws_instance" "example" { + ami = data.aws_ami.example.id instance_market_options { market_type = "spot" spot_options { @@ -108,7 +108,7 @@ resource "aws_subnet" "my_subnet" { } } -resource "aws_network_interface" "foo" { +resource "aws_network_interface" "example" { subnet_id = aws_subnet.my_subnet.id private_ips = ["172.16.10.100"] @@ -117,13 +117,12 @@ resource "aws_network_interface" "foo" { } } -resource "aws_instance" "foo" { +resource "aws_instance" "example" { ami = "ami-005e54dee72cc1d00" # us-west-2 instance_type = "t2.micro" - network_interface { - network_interface_id = aws_network_interface.foo.id - device_index = 0 + primary_network_interface { + network_interface_id = aws_network_interface.example.id } credit_specification { @@ -224,6 +223,7 @@ This resource supports the following arguments: * `enable_primary_ipv6` - (Optional) Whether to assign a primary IPv6 Global Unicast Address (GUA) to the instance when launched in a dual-stack or IPv6-only subnet. A primary IPv6 address ensures a consistent IPv6 address for the instance and is automatically assigned by AWS to the ENI. Once enabled, the first IPv6 GUA becomes the primary IPv6 address and cannot be disabled. The primary IPv6 address remains until the instance is terminated or the ENI is detached. Disabling `enable_primary_ipv6` after it has been enabled forces recreation of the instance. * `enclave_options` - (Optional) Enable Nitro Enclaves on launched instances. See [Enclave Options](#enclave-options) below for more details. * `ephemeral_block_device` - (Optional) One or more configuration blocks to customize Ephemeral (also known as "Instance Store") volumes on the instance. See [Block Devices](#ebs-ephemeral-and-root-block-devices) below for details. When accessing this as an attribute reference, it is a set of objects. +* `force_destroy` - (Optional) Destroys instance even if `disable_api_termination` or `disable_api_stop` is set to `true`. Defaults to `false`. Once this parameter is set to `true`, a successful `terraform apply` run before a destroy is required to update this value in the resource state. Without a successful `terraform apply` after this parameter is set, this flag will have no effect. If setting this field in the same operation that would require replacing the instance or destroying the instance, this flag will not work. Additionally when importing an instance, a successful `terraform apply` is required to set this value in state before it will take effect on a destroy operation. * `get_password_data` - (Optional) If true, wait for password data to become available and retrieve it. Useful for getting the administrator password for instances running Microsoft Windows. The password data is exported to the `password_data` attribute. See [GetPasswordData](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetPasswordData.html) for more information. * `hibernation` - (Optional) If true, the launched EC2 instance will support hibernation. * `host_id` - (Optional) ID of a dedicated host that the instance will be assigned to. Use when an instance is to be launched on a specific dedicated host. @@ -239,9 +239,11 @@ This resource supports the following arguments: * `maintenance_options` - (Optional) Maintenance and recovery options for the instance. See [Maintenance Options](#maintenance-options) below for more details. * `metadata_options` - (Optional) Customize the metadata options of the instance. See [Metadata Options](#metadata-options) below for more details. * `monitoring` - (Optional) If true, the launched EC2 instance will have detailed monitoring enabled. (Available since v0.6.0) -* `network_interface` - (Optional) Customize network interfaces to be attached at instance boot time. See [Network Interfaces](#network-interfaces) below for more details. -* `placement_group` - (Optional) Placement Group to start the instance in. +* `network_interface` - (Optional, **Deprecated** to specify the primary network interface, use `primary_network_interface`, to attach additional network interfaces, use `aws_network_interface_attachment` resources) Customize network interfaces to be attached at instance boot time. See [Network Interfaces](#network-interfaces) below for more details. +* `placement_group` - (Optional) Placement Group to start the instance in. Conflicts with `placement_group_id`. +* `placement_group_id` - (Optional) Placement Group ID to start the instance in. Conflicts with `placement_group`. * `placement_partition_number` - (Optional) Number of the partition the instance is in. Valid only if [the `aws_placement_group` resource's](placement_group.html) `strategy` argument is set to `"partition"`. +* `primary_network_interface` - (Optional) The primary network interface. See [Primary Network Interface](#primary-network-interface) below. * `private_dns_name_options` - (Optional) Options for the instance hostname. The default values are inherited from the subnet. See [Private DNS Name Options](#private-dns-name-options) below for more details. * `private_ip` - (Optional) Private IP address to associate with the instance in a VPC. * `root_block_device` - (Optional) Configuration block to customize details about the root block device of the instance. See [Block Devices](#ebs-ephemeral-and-root-block-devices) below for details. When accessing this as an attribute reference, it is a list containing one object. @@ -388,7 +390,11 @@ For more information, see the documentation on the [Instance Metadata Service](h ### Network Interfaces -Each of the `network_interface` blocks attach a network interface to an EC2 Instance during boot time. However, because the network interface is attached at boot-time, replacing/modifying the network interface **WILL** trigger a recreation of the EC2 Instance. If you should need at any point to detach/modify/re-attach a network interface to the instance, use the `aws_network_interface` or `aws_network_interface_attachment` resources instead. +`network_interface` is **deprecated**. +Use `primary_network_interface` to specify the primary network interface. +To attach additional network interfaces, use [`aws_network_interface_attachment`](docs/r/network_interface_attachment.html.markdown) resources. + +Each of the `network_interface` blocks attach a network interface to an EC2 Instance during boot time. However, because the network interface is attached at boot-time, replacing/modifying the network interface **WILL** trigger a recreation of the EC2 Instance. If you should need at any point to detach/modify/re-attach a network interface to the instance, use [`aws_network_interface_attachment`](docs/r/network_interface_attachment.html.markdown) resources instead. The `network_interface` configuration block _does_, however, allow users to supply their own network interface to be used as the default network interface on an EC2 Instance, attached at `eth0`. @@ -399,6 +405,16 @@ Each `network_interface` block supports the following: * `network_card_index` - (Optional) Integer index of the network card. Limited by instance type. The default index is `0`. * `network_interface_id` - (Required) ID of the network interface to attach. +### Primary Network Interface + +Represents the primary network interface on the EC2 Instance. +To manage additional network interfaces, use [`aws_network_interface_attachment`](docs/r/network_interface_attachment.html.markdown) resources. + +Each `primary_network_interface` block supports the following: + +* `delete_on_termination` - (Read-Only) Whether the network interface will be deleted when the instance terminates. +* `network_interface_id` - (Required) ID of the network interface to attach. + ### Private DNS Name Options The `private_dns_name_options` block supports the following: @@ -472,6 +488,32 @@ For `instance_market_options`, in addition to the arguments above, the following ## Import +In Terraform v1.12.0 and later, the [`import` block](https://developer.hashicorp.com/terraform/language/import) can be used with the `identity` attribute. For example: + +```terraform +import { + to = aws_instance.example + identity = { + id = "i-12345678" + } +} + +resource "aws_instance" "example" { + ### Configuration omitted for brevity ### +} +``` + +### Identity Schema + +#### Required + +* `id` - (String) ID of the instance. + +#### Optional + +- `account_id` (String) AWS Account where this resource is managed. +- `region` (String) Region where this resource is managed. + In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import instances using the `id`. For example: ```terraform diff --git a/website/docs/r/iot_thing_principal_attachment.html.markdown b/website/docs/r/iot_thing_principal_attachment.html.markdown index 457170b54803..9c8ff59afdaf 100644 --- a/website/docs/r/iot_thing_principal_attachment.html.markdown +++ b/website/docs/r/iot_thing_principal_attachment.html.markdown @@ -35,6 +35,7 @@ This resource supports the following arguments: * `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). * `principal` - (Required) The AWS IoT Certificate ARN or Amazon Cognito Identity ID. * `thing` - (Required) The name of the thing. +* `thing_principal_type` - (Optional) The type of relationship to specify when attaching a principal to a thing. Valid values are `EXCLUSIVE_THING` (the thing will be the only one attached to the principal) or `NON_EXCLUSIVE_THING` (multiple things can be attached to the principal). Defaults to `NON_EXCLUSIVE_THING`. ## Attribute Reference diff --git a/website/docs/r/kms_alias.html.markdown b/website/docs/r/kms_alias.html.markdown index d5a62d006cee..135c7686598b 100644 --- a/website/docs/r/kms_alias.html.markdown +++ b/website/docs/r/kms_alias.html.markdown @@ -42,6 +42,32 @@ This resource exports the following attributes in addition to the arguments abov ## Import +In Terraform v1.12.0 and later, the [`import` block](https://developer.hashicorp.com/terraform/language/import) can be used with the `identity` attribute. For example: + +```terraform +import { + to = aws_kms_alias.example + identity = { + name = "alias/my-key-alias" + } +} + +resource "aws_kms_alias" "example" { + ### Configuration omitted for brevity ### +} +``` + +### Identity Schema + +#### Required + +* `name` - (String) Name of the KMS key alias. + +#### Optional + +- `account_id` (String) AWS Account where this resource is managed. +- `region` (String) Region where this resource is managed. + In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import KMS aliases using the `name`. For example: ```terraform diff --git a/website/docs/r/kms_external_key.html.markdown b/website/docs/r/kms_external_key.html.markdown index 9fe2e10a4f1e..902d35c51144 100644 --- a/website/docs/r/kms_external_key.html.markdown +++ b/website/docs/r/kms_external_key.html.markdown @@ -25,14 +25,16 @@ resource "aws_kms_external_key" "example" { This resource supports the following arguments: -* `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). * `bypass_policy_lockout_safety_check` - (Optional) Specifies whether to disable the policy lockout check performed when creating or updating the key's policy. Setting this value to `true` increases the risk that the key becomes unmanageable. For more information, refer to the scenario in the [Default Key Policy](https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam) section in the AWS Key Management Service Developer Guide. Defaults to `false`. * `deletion_window_in_days` - (Optional) Duration in days after which the key is deleted after destruction of the resource. Must be between `7` and `30` days. Defaults to `30`. * `description` - (Optional) Description of the key. * `enabled` - (Optional) Specifies whether the key is enabled. Keys pending import can only be `false`. Imported keys default to `true` unless expired. * `key_material_base64` - (Optional) Base64 encoded 256-bit symmetric encryption key material to import. The CMK is permanently associated with this key material. The same key material can be reimported, but you cannot import different key material. +* `key_spec` - (Optional) Specifies whether the key contains a symmetric key or an asymmetric key pair and the encryption algorithms or signing algorithms that the key supports. Valid values: `SYMMETRIC_DEFAULT`, `RSA_2048`, `RSA_3072`, `RSA_4096`, `HMAC_224`, `HMAC_256`, `HMAC_384`, `HMAC_512`, `ECC_NIST_P256`, `ECC_NIST_P384`, `ECC_NIST_P521`, `ECC_SECG_P256K1`, `ML_DSA_44`, `ML_DSA_65`, `ML_DSA_87`, or `SM2` (China Regions only). Defaults to `SYMMETRIC_DEFAULT`. For help with choosing a key spec, see the [AWS KMS Developer Guide](https://docs.aws.amazon.com/kms/latest/developerguide/symm-asymm-choose.html). +* `key_usage` - (Optional) Specifies the intended use of the key. Valid values: `ENCRYPT_DECRYPT`, `SIGN_VERIFY`, or `GENERATE_VERIFY_MAC`. Defaults to `ENCRYPT_DECRYPT`. * `multi_region` - (Optional) Indicates whether the KMS key is a multi-Region (`true`) or regional (`false`) key. Defaults to `false`. * `policy` - (Optional) A key policy JSON document. If you do not provide a key policy, AWS KMS attaches a default key policy to the CMK. +* `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). * `tags` - (Optional) A key-value map of tags to assign to the key. 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. * `valid_to` - (Optional) Time at which the imported key material expires. When the key material expires, AWS KMS deletes the key material and the CMK becomes unusable. If not specified, key material does not expire. Valid values: [RFC3339 time string](https://tools.ietf.org/html/rfc3339#section-5.8) (`YYYY-MM-DDTHH:MM:SSZ`) @@ -44,7 +46,6 @@ This resource exports the following attributes in addition to the arguments abov * `expiration_model` - Whether the key material expires. Empty when pending key material import, otherwise `KEY_MATERIAL_EXPIRES` or `KEY_MATERIAL_DOES_NOT_EXPIRE`. * `id` - The unique identifier for the key. * `key_state` - The state of the CMK. -* `key_usage` - The cryptographic operations for which you can use the CMK. * `tags_all` - A map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). ## Import diff --git a/website/docs/r/kms_key.html.markdown b/website/docs/r/kms_key.html.markdown index ceb047817c49..c7f54f75a90c 100644 --- a/website/docs/r/kms_key.html.markdown +++ b/website/docs/r/kms_key.html.markdown @@ -353,6 +353,32 @@ This resource exports the following attributes in addition to the arguments abov ## Import +In Terraform v1.12.0 and later, the [`import` block](https://developer.hashicorp.com/terraform/language/import) can be used with the `identity` attribute. For example: + +```terraform +import { + to = aws_kms_key.example + identity = { + id = "1234abcd-12ab-34cd-56ef-1234567890ab" + } +} + +resource "aws_kms_key" "example" { + ### Configuration omitted for brevity ### +} +``` + +### Identity Schema + +#### Required + +* `id` - (String) ID of the KMS key. + +#### Optional + +- `account_id` (String) AWS Account where this resource is managed. +- `region` (String) Region where this resource is managed. + In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import KMS Keys using the `id`. For example: ```terraform diff --git a/website/docs/r/lakeformation_data_cells_filter.html.markdown b/website/docs/r/lakeformation_data_cells_filter.html.markdown index 243db10cdb46..77536786c4f2 100644 --- a/website/docs/r/lakeformation_data_cells_filter.html.markdown +++ b/website/docs/r/lakeformation_data_cells_filter.html.markdown @@ -71,7 +71,7 @@ This resource exports the following attributes in addition to the arguments abov ## Import -In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import Lake Formation Data Cells Filter using the `example_id_arg`. For example: +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import Lake Formation Data Cells Filter using the `database_name`, `name`, `table_catalog_id`, and `table_name` separated by `,`. For example: ```terraform import { @@ -80,7 +80,7 @@ import { } ``` -Using `terraform import`, import Lake Formation Data Cells Filter using the `id`. For example: +Using `terraform import`, import Lake Formation Data Cells Filter using the `database_name`, `name`, `table_catalog_id`, and `table_name` separated by `,`. For example: ```console % terraform import aws_lakeformation_data_cells_filter.example database_name,name,table_catalog_id,table_name diff --git a/website/docs/r/lakeformation_resource.html.markdown b/website/docs/r/lakeformation_resource.html.markdown index 5b03f9fa0569..314e95b5887a 100644 --- a/website/docs/r/lakeformation_resource.html.markdown +++ b/website/docs/r/lakeformation_resource.html.markdown @@ -40,6 +40,7 @@ The following arguments are optional: * `use_service_linked_role` - (Optional) Designates an AWS Identity and Access Management (IAM) service-linked role by registering this role with the Data Catalog. * `hybrid_access_enabled` - (Optional) Flag to enable AWS LakeFormation hybrid access permission mode. * `with_federation`- (Optional) Whether or not the resource is a federated resource. Set to true when registering AWS Glue connections for federated catalog functionality. +* `with_privileged_access` - (Optional) Boolean to grant the calling principal the permissions to perform all supported Lake Formation operations on the registered data location. ~> **NOTE:** AWS does not support registering an S3 location with an IAM role and subsequently updating the S3 location registration to a service-linked role. diff --git a/website/docs/r/lambda_function.html.markdown b/website/docs/r/lambda_function.html.markdown index 841ace6f5dad..6bf2fc2d71bd 100644 --- a/website/docs/r/lambda_function.html.markdown +++ b/website/docs/r/lambda_function.html.markdown @@ -257,6 +257,101 @@ resource "aws_lambda_function" "example" { } ``` +### Function with logging to S3 or Data Firehose + +#### Required Resources + +* An S3 bucket or Data Firehose delivery stream to store the logs. +* A CloudWatch Log Group with: + + * `log_group_class = "DELIVERY"` + * A subscription filter whose `destination_arn` points to the S3 bucket or the Data Firehose delivery stream. + +* IAM roles: + + * Assumed by the `logs.amazonaws.com` service to deliver logs to the S3 bucket or Data Firehose delivery stream. + * Assumed by the `lambda.amazonaws.com` service to send logs to CloudWatch Logs + +* A Lambda function: + + * In the `logging_configuration`, specify the name of the Log Group created above using the `log_group` field + * No special configuration is required to use S3 or Firehose as the log destination + +For more details, see [Sending Lambda function logs to Amazon S3](https://docs.aws.amazon.com/lambda/latest/dg/logging-with-s3.html). + +#### Example: Exporting Lambda Logs to S3 Bucket + +```terraform +locals { + lambda_function_name = "lambda-log-export-example" +} + +resource "aws_s3_bucket" "lambda_log_export" { + bucket = "${local.lambda_function_name}-bucket" +} + +resource "aws_cloudwatch_log_group" "export" { + name = "/aws/lambda/${local.lambda_function_name}" + log_group_class = "DELIVERY" +} + +data "aws_iam_policy_document" "logs_assume_role" { + statement { + actions = ["sts:AssumeRole"] + effect = "Allow" + principals { + type = "Service" + identifiers = ["logs.amazonaws.com"] + } + } +} + +resource "aws_iam_role" "logs_log_export" { + name = "${local.lambda_function_name}-lambda-log-export-role" + assume_role_policy = data.aws_iam_policy_document.logs_assume_role.json +} + +data "aws_iam_policy_document" "lambda_log_export" { + statement { + actions = [ + "s3:PutObject", + ] + effect = "Allow" + resources = [ + "${aws_s3_bucket.lambda_log_export.arn}/*" + ] + } +} + +resource "aws_iam_role_policy" "lambda_log_export" { + policy = data.aws_iam_policy_document.lambda_log_export.json + role = aws_iam_role.logs_log_export.name +} + +resource "aws_cloudwatch_log_subscription_filter" "lambda_log_export" { + name = "${local.lambda_function_name}-filter" + log_group_name = aws_cloudwatch_log_group.export.name + filter_pattern = "" + destination_arn = aws_s3_bucket.lambda_log_export.arn + role_arn = aws_iam_role.logs_log_export.arn +} + +resource "aws_lambda_function" "log_export" { + function_name = local.lambda_function_name + handler = "index.lambda_handler" + runtime = "python3.13" + role = aws_iam_role.example.arn + filename = "function.zip" + logging_config { + log_format = "Text" + log_group = aws_cloudwatch_log_group.export.name + } + depends_on = [ + aws_cloudwatch_log_group.export + ] +} +``` + ### Function with Error Handling ```terraform @@ -426,6 +521,7 @@ The following arguments are optional: * `skip_destroy` - (Optional) Whether to retain the old version of a previously deployed Lambda Layer. Default is `false`. * `snap_start` - (Optional) Configuration block for snap start settings. [See below](#snap_start-configuration-block). * `source_code_hash` - (Optional) Base64-encoded SHA256 hash of the package file. Used to trigger updates when source code changes. +* `source_kms_key_arn` - (Optional) ARN of the AWS Key Management Service key used to encrypt the function's `.zip` deployment package. Conflicts with `image_uri`. * `tags` - (Optional) Key-value map of tags for the Lambda function. 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) Amount of time your Lambda Function has to run in seconds. Defaults to 3. Valid between 1 and 900. * `tracing_config` - (Optional) Configuration block for X-Ray tracing. [See below](#tracing_config-configuration-block). diff --git a/website/docs/r/lambda_permission.html.markdown b/website/docs/r/lambda_permission.html.markdown index fb7840db8095..1209ab582c4f 100644 --- a/website/docs/r/lambda_permission.html.markdown +++ b/website/docs/r/lambda_permission.html.markdown @@ -215,7 +215,7 @@ resource "aws_lambda_permission" "logging" { The following arguments are required: * `action` - (Required) Lambda action to allow in this statement (e.g., `lambda:InvokeFunction`) -* `function_name` - (Required) Name of the Lambda function +* `function_name` - (Required) Name or ARN of the Lambda function * `principal` - (Required) AWS service or account that invokes the function (e.g., `s3.amazonaws.com`, `sns.amazonaws.com`, AWS account ID, or AWS IAM principal) The following arguments are optional: diff --git a/website/docs/r/launch_template.html.markdown b/website/docs/r/launch_template.html.markdown index e904ec8a1234..009d6a8a9ea8 100644 --- a/website/docs/r/launch_template.html.markdown +++ b/website/docs/r/launch_template.html.markdown @@ -186,7 +186,7 @@ The `ebs` block supports the following: The `capacity_reservation_specification` block supports the following: -* `capacity_reservation_preference` - Indicates the instance's Capacity Reservation preferences. Can be `open` or `none`. (Default `none`). +* `capacity_reservation_preference` - Indicates the instance's Capacity Reservation preferences. Can be `capacity-reservations-only`, `open` or `none`. If `capacity_reservation_id` or `capacity_reservation_resource_group_arn` is specified in `capacity_reservation_target` block, either omit `capacity_reservation_preference` or set it to `capacity-reservations-only`. * `capacity_reservation_target` - Used to target a specific Capacity Reservation: The `capacity_reservation_target` block supports the following: @@ -461,7 +461,8 @@ The `placement` block supports the following: * `affinity` - (Optional) The affinity setting for an instance on a Dedicated Host. * `availability_zone` - (Optional) The Availability Zone for the instance. -* `group_name` - (Optional) The name of the placement group for the instance. +* `group_id` - (Optional) The ID of the placement group for the instance. Conflicts with `group_name`. +* `group_name` - (Optional) The name of the placement group for the instance. Conflicts with `group_id`. * `host_id` - (Optional) The ID of the Dedicated Host for the instance. * `host_resource_group_arn` - (Optional) The ARN of the Host Resource Group in which to launch instances. * `spread_domain` - (Optional) Reserved for future use. diff --git a/website/docs/r/lb.html.markdown b/website/docs/r/lb.html.markdown index 8d740d37bf72..4c08f55c5eaa 100644 --- a/website/docs/r/lb.html.markdown +++ b/website/docs/r/lb.html.markdown @@ -123,6 +123,7 @@ This resource supports the following arguments: * `name_prefix` - (Optional) Creates a unique name beginning with the specified prefix. Conflicts with `name`. * `security_groups` - (Optional) List of security group IDs to assign to the LB. Only valid for Load Balancers of type `application` or `network`. For load balancers of type `network` security groups cannot be added if none are currently present, and cannot all be removed once added. If either of these conditions are met, this will force a recreation of the resource. * `preserve_host_header` - (Optional) Whether the Application Load Balancer should preserve the Host header in the HTTP request and send it to the target without any change. Defaults to `false`. +* `secondary_ips_auto_assigned_per_subnet` - (Optional) The number of secondary IP addresses to configure for your load balancer nodes. Only valid for Load Balancers of type `network`. The valid range is 0-7. When decreased, this will force a recreation of the resource. Default: `0`. * `subnet_mapping` - (Optional) Subnet mapping block. See below. For Load Balancers of type `network` subnet mappings can only be added. * `subnets` - (Optional) List of subnet IDs to attach to the LB. For Load Balancers of type `network` subnets can only be added (see [Availability Zones](https://docs.aws.amazon.com/elasticloadbalancing/latest/network/network-load-balancers.html#availability-zones)), deleting a subnet for load balancers of type `network` will force a recreation of the resource. * `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. diff --git a/website/docs/r/lb_listener.html.markdown b/website/docs/r/lb_listener.html.markdown index f163ab2cc78c..dce235c56b31 100644 --- a/website/docs/r/lb_listener.html.markdown +++ b/website/docs/r/lb_listener.html.markdown @@ -39,6 +39,45 @@ resource "aws_lb_listener" "front_end" { } ``` +With weighted target groups: + +```terraform +resource "aws_lb" "front_end" { + # ... +} + +resource "aws_lb_target_group" "front_end_blue" { + # ... +} + +resource "aws_lb_target_group" "front_end_green" { + # ... +} + +resource "aws_lb_listener" "front_end" { + load_balancer_arn = aws_lb.front_end.arn + port = "443" + protocol = "HTTPS" + ssl_policy = "ELBSecurityPolicy-2016-08" + certificate_arn = "arn:aws:iam::187416307283:server-certificate/test_cert_rab3wuqwgja25ct3n4jdj2tzu4" + + default_action { + type = "forward" + + forward { + target_group { + arn = aws_lb_target_group.front_end_blue.arn + weight = 100 + } + target_group { + arn = aws_lb_target_group.front_end_green.arn + weight = 0 + } + } + } +} +``` + To a NLB: ```terraform diff --git a/website/docs/r/msk_cluster.html.markdown b/website/docs/r/msk_cluster.html.markdown index 3580ab60c116..35ad4c1ae792 100644 --- a/website/docs/r/msk_cluster.html.markdown +++ b/website/docs/r/msk_cluster.html.markdown @@ -204,16 +204,16 @@ resource "aws_msk_cluster" "example" { This resource supports the following arguments: * `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). -* `broker_node_group_info` - (Required) Configuration block for the broker nodes of the Kafka cluster. +* `broker_node_group_info` - (Required) Configuration block for the broker nodes of the Kafka cluster. See [broker_node_group_info Argument Reference](#broker_node_group_info-argument-reference) below. * `cluster_name` - (Required) Name of the MSK cluster. * `kafka_version` - (Required) Specify the desired Kafka software version. * `number_of_broker_nodes` - (Required) The desired total number of broker nodes in the kafka cluster. It must be a multiple of the number of specified client subnets. -* `client_authentication` - (Optional) Configuration block for specifying a client authentication. See below. -* `configuration_info` - (Optional) Configuration block for specifying a MSK Configuration to attach to Kafka brokers. See below. -* `encryption_info` - (Optional) Configuration block for specifying encryption. See below. +* `client_authentication` - (Optional) Configuration block for specifying a client authentication. See [client_authentication Argument Reference](#client_authentication-argument-reference) below. +* `configuration_info` - (Optional) Configuration block for specifying an MSK Configuration to attach to Kafka brokers. See [configuration_info Argument Reference](#configuration_info-argument-reference) below. +* `encryption_info` - (Optional) Configuration block for specifying encryption. See [encryption_info Argument Reference](#encryption_info-argument-reference) below. * `enhanced_monitoring` - (Optional) Specify the desired enhanced MSK CloudWatch monitoring level. See [Monitoring Amazon MSK with Amazon CloudWatch](https://docs.aws.amazon.com/msk/latest/developerguide/monitoring.html) -* `open_monitoring` - (Optional) Configuration block for JMX and Node monitoring for the MSK cluster. See below. -* `logging_info` - (Optional) Configuration block for streaming broker logs to Cloudwatch/S3/Kinesis Firehose. See below. +* `open_monitoring` - (Optional) Configuration block for JMX and Node monitoring for the MSK cluster. See [open_monitoring Argument Reference](#open_monitoring-argument-reference) below. +* `logging_info` - (Optional) Configuration block for streaming broker logs to Cloudwatch/S3/Kinesis Firehose. See [logging_info Argument Reference](#logging_info-argument-reference) below. * `storage_mode` - (Optional) Controls storage mode for supported storage tiers. Valid values are: `LOCAL` or `TIERED`. * `tags` - (Optional) A 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. @@ -222,14 +222,14 @@ This resource supports the following arguments: * `client_subnets` - (Required) A list of subnets to connect to in client VPC ([documentation](https://docs.aws.amazon.com/msk/1.0/apireference/clusters.html#clusters-prop-brokernodegroupinfo-clientsubnets)). * `instance_type` - (Required) Specify the instance type to use for the kafka brokersE.g., kafka.m5.large. ([Pricing info](https://aws.amazon.com/msk/pricing/)) * `security_groups` - (Required) A list of the security groups to associate with the elastic network interfaces to control who can communicate with the cluster. -* `az_distribution` - (Optional) The distribution of broker nodes across availability zones ([documentation](https://docs.aws.amazon.com/msk/1.0/apireference/clusters.html#clusters-model-brokerazdistribution)). Currently the only valid value is `DEFAULT`. -* `connectivity_info` - (Optional) Information about the cluster access configuration. See below. For security reasons, you can't turn on public access while creating an MSK cluster. However, you can update an existing cluster to make it publicly accessible. You can also create a new cluster and then update it to make it publicly accessible ([documentation](https://docs.aws.amazon.com/msk/latest/developerguide/public-access.html)). -* `storage_info` - (Optional) A block that contains information about storage volumes attached to MSK broker nodes. See below. +* `az_distribution` - (Optional) The distribution of broker nodes across availability zones ([documentation](https://docs.aws.amazon.com/msk/1.0/apireference/clusters.html#clusters-model-brokerazdistribution)). Currently, the only valid value is `DEFAULT`. +* `connectivity_info` - (Optional) Information about the cluster access configuration. See [broker_node_group_info connectivity_info Argument Reference](#broker_node_group_info-connectivity_info-argument-reference) below. For security reasons, you can't turn on public access while creating an MSK cluster. However, you can update an existing cluster to make it publicly accessible. You can also create a new cluster and then update it to make it publicly accessible ([documentation](https://docs.aws.amazon.com/msk/latest/developerguide/public-access.html)). +* `storage_info` - (Optional) A block that contains information about storage volumes attached to MSK broker nodes. See [broker_node_group_info storage_info Argument Reference](#broker_node_group_info-storage_info-argument-reference) below. ### broker_node_group_info connectivity_info Argument Reference -* `public_access` - (Optional) Access control settings for brokers. See below. -* `vpc_connectivity` - (Optional) VPC connectivity access control for brokers. See below. +* `public_access` - (Optional) Access control settings for brokers. See [connectivity_info public_access Argument Reference](#connectivity_info-public_access-argument-reference) below. +* `vpc_connectivity` - (Optional) VPC connectivity access control for brokers. See [connectivity_info vpc_connectivity Argument Reference](#connectivity_info-vpc_connectivity-argument-reference) below. ### connectivity_info public_access Argument Reference @@ -237,11 +237,11 @@ This resource supports the following arguments: ### connectivity_info vpc_connectivity Argument Reference -* `client_authentication` - (Optional) Includes all client authentication information for VPC connectivity. See below. +* `client_authentication` - (Optional) Includes all client authentication information for VPC connectivity. See [vpc_connectivity client_authentication Argument Reference](#vpc_connectivity-client_authentication-argument-reference) below. ### vpc_connectivity client_authentication Argument Reference -* `sasl` - (Optional) SASL authentication type details for VPC connectivity. See below. +* `sasl` - (Optional) SASL authentication type details for VPC connectivity. See [vpc_connectivity client_authentication sasl Argument Reference](#vpc_connectivity-client_authentication-sasl-argument-reference) below. * `tls` - (Optional) Enables TLS authentication for VPC connectivity. ### vpc_connectivity client_authentication sasl Argument Reference @@ -251,11 +251,11 @@ This resource supports the following arguments: ### broker_node_group_info storage_info Argument Reference -* `ebs_storage_info` - (Optional) A block that contains EBS volume information. See below. +* `ebs_storage_info` - (Optional) A block that contains EBS volume information. See [storage_info ebs_storage_info Argument Reference](#storage_info-ebs_storage_info-argument-reference) below. ### storage_info ebs_storage_info Argument Reference -* `provisioned_throughput` - (Optional) A block that contains EBS volume provisioned throughput information. To provision storage throughput, you must choose broker type kafka.m5.4xlarge or larger. See below. +* `provisioned_throughput` - (Optional) A block that contains EBS volume provisioned throughput information. To provision storage throughput, you must choose broker type kafka.m5.4xlarge or larger. See [ebs_storage_info provisioned_throughput Argument Reference](#ebs_storage_info-provisioned_throughput-argument-reference) below. * `volume_size` - (Optional) The size in GiB of the EBS volume for the data drive on each broker node. Minimum value of `1` and maximum value of `16384`. ### ebs_storage_info provisioned_throughput Argument Reference @@ -265,8 +265,8 @@ This resource supports the following arguments: ### client_authentication Argument Reference -* `sasl` - (Optional) Configuration block for specifying SASL client authentication. See below. -* `tls` - (Optional) Configuration block for specifying TLS client authentication. See below. +* `sasl` - (Optional) Configuration block for specifying SASL client authentication. See [client_authentication sasl Argument Reference](#client_authentication-sasl-argument-reference) below. +* `tls` - (Optional) Configuration block for specifying TLS client authentication. See [client_authentication tls Argument Reference](#client_authentication-tls-argument-reference) below. * `unauthenticated` - (Optional) Enables unauthenticated access. #### client_authentication sasl Argument Reference @@ -285,7 +285,7 @@ This resource supports the following arguments: ### encryption_info Argument Reference -* `encryption_in_transit` - (Optional) Configuration block to specify encryption in transit. See below. +* `encryption_in_transit` - (Optional) Configuration block to specify encryption in transit. See [encryption_info encryption_in_transit Argument Reference](#encryption_info-encryption_in_transit-argument-reference) below. * `encryption_at_rest_kms_key_arn` - (Optional) You may specify a KMS key short ID or ARN (it will always output an ARN) to use for encrypting your data at rest. If no key is specified, an AWS managed KMS ('aws/msk' managed service) key will be used for encrypting the data at rest. #### encryption_info encryption_in_transit Argument Reference @@ -295,12 +295,12 @@ This resource supports the following arguments: #### open_monitoring Argument Reference -* `prometheus` - (Required) Configuration block for Prometheus settings for open monitoring. See below. +* `prometheus` - (Required) Configuration block for Prometheus settings for open monitoring. See [open_monitoring prometheus Argument Reference](#open_monitoring-prometheus-argument-reference) below. #### open_monitoring prometheus Argument Reference -* `jmx_exporter` - (Optional) Configuration block for JMX Exporter. See below. -* `node_exporter` - (Optional) Configuration block for Node Exporter. See below. +* `jmx_exporter` - (Optional) Configuration block for JMX Exporter. See [open_monitoring prometheus jmx_exporter Argument Reference](#open_monitoring-prometheus-jmx_exporter-argument-reference) below. +* `node_exporter` - (Optional) Configuration block for Node Exporter. See [open_monitoring prometheus node_exporter Argument Reference](#open_monitoring-prometheus-node_exporter-argument-reference) below. #### open_monitoring prometheus jmx_exporter Argument Reference @@ -312,7 +312,13 @@ This resource supports the following arguments: #### logging_info Argument Reference -* `broker_logs` - (Required) Configuration block for Broker Logs settings for logging info. See below. +* `broker_logs` - (Required) Configuration block for Broker Logs settings for logging info. See [logging_info broker_logs Argument Reference](#logging_info-broker_logs-argument-reference) below. + +#### logging_info broker_logs Argument Reference + +* `cloudwatch_logs` - (Optional) Configuration block for Cloudwatch Logs settings. See [logging_info broker_logs cloudwatch_logs Argument Reference](#logging_info-broker_logs-cloudwatch_logs-argument-reference) below. +* `firehose` - (Optional) Configuration block for Kinesis Data Firehose settings. See [logging_info broker_logs firehose Argument Reference](#logging_info-broker_logs-firehose-argument-reference) below. +* `s3` - (Optional) Configuration block for S3 settings. See [logging_info broker_logs s3 Argument Reference](#logging_info-broker_logs-s3-argument-reference) below. #### logging_info broker_logs cloudwatch_logs Argument Reference diff --git a/website/docs/r/mwaa_environment.html.markdown b/website/docs/r/mwaa_environment.html.markdown index fdbd254f9b6d..8c5e7ae1106d 100644 --- a/website/docs/r/mwaa_environment.html.markdown +++ b/website/docs/r/mwaa_environment.html.markdown @@ -126,7 +126,6 @@ resource "aws_mwaa_environment" "example" { This resource supports the following arguments: -* `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). * `airflow_configuration_options` - (Optional) The `airflow_configuration_options` parameter specifies airflow override options. Check the [Official documentation](https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-env-variables.html#configuring-env-variables-reference) for all possible configuration options. * `airflow_version` - (Optional) Airflow version of your environment, will be set by default to the latest version that MWAA supports. * `dag_s3_path` - (Required) The relative path to the DAG folder on your Amazon S3 storage bucket. For example, dags. For more information, see [Importing DAGs on Amazon MWAA](https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-import.html). @@ -143,15 +142,17 @@ This resource supports the following arguments: * `network_configuration` - (Required) Specifies the network configuration for your Apache Airflow Environment. This includes two private subnets as well as security groups for the Airflow environment. Each subnet requires internet connection, otherwise the deployment will fail. See [`network_configuration` Block](#network_configuration-block) for details. * `plugins_s3_object_version` - (Optional) The plugins.zip file version you want to use. * `plugins_s3_path` - (Optional) The relative path to the plugins.zip file on your Amazon S3 storage bucket. For example, plugins.zip. If a relative path is provided in the request, then plugins_s3_object_version is required. For more information, see [Importing DAGs on Amazon MWAA](https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-import.html). +* `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). * `requirements_s3_object_version` - (Optional) The requirements.txt file version you want to use. * `requirements_s3_path` - (Optional) The relative path to the requirements.txt file on your Amazon S3 storage bucket. For example, requirements.txt. If a relative path is provided in the request, then requirements_s3_object_version is required. For more information, see [Importing DAGs on Amazon MWAA](https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-import.html). * `schedulers` - (Optional) The number of schedulers that you want to run in your environment. v2.0.2 and above accepts `2` - `5`, default `2`. v1.10.12 accepts `1`. * `source_bucket_arn` - (Required) The Amazon Resource Name (ARN) of your Amazon S3 storage bucket. For example, arn:aws:s3:::airflow-mybucketname. * `startup_script_s3_object_version` - (Optional) The version of the startup shell script you want to use. You must specify the version ID that Amazon S3 assigns to the file every time you update the script. * `startup_script_s3_path` - (Optional) The relative path to the script hosted in your bucket. The script runs as your environment starts before starting the Apache Airflow process. Use this script to install dependencies, modify configuration options, and set environment variables. See [Using a startup script](https://docs.aws.amazon.com/mwaa/latest/userguide/using-startup-script.html). Supported for environment versions 2.x and later. +* `tags` - (Optional) A map of resource tags to associate with 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. * `webserver_access_mode` - (Optional) Specifies whether the webserver should be accessible over the internet or via your specified VPC. Possible options: `PRIVATE_ONLY` (default) and `PUBLIC_ONLY`. * `weekly_maintenance_window_start` - (Optional) Specifies the start date for the weekly maintenance window. -* `tags` - (Optional) A map of resource tags to associate with 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. +* `worker_replacement_strategy` - (Optional) Worker replacement strategy. Valid values: `FORCED`, `GRACEFUL`. ### `logging_configuration` Block diff --git a/website/docs/r/nat_gateway.html.markdown b/website/docs/r/nat_gateway.html.markdown index c98b5ec09ed2..c107209442b1 100644 --- a/website/docs/r/nat_gateway.html.markdown +++ b/website/docs/r/nat_gateway.html.markdown @@ -10,6 +10,8 @@ description: |- Provides a resource to create a VPC NAT Gateway. +!> **WARNING:** You should not use the `aws_nat_gateway` resource that has `secondary_allocation_ids` in conjunction with an [`aws_nat_gateway_eip_association`](nat_gateway_eip_association.html) resource. Doing so may cause perpetual differences, and result in associations being overwritten. + ## Example Usage ### Public NAT @@ -63,14 +65,14 @@ resource "aws_nat_gateway" "example" { This resource supports the following arguments: -* `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). * `allocation_id` - (Optional) The Allocation ID of the Elastic IP address for the NAT Gateway. Required for `connectivity_type` of `public`. * `connectivity_type` - (Optional) Connectivity type for the NAT Gateway. Valid values are `private` and `public`. Defaults to `public`. * `private_ip` - (Optional) The private IPv4 address to assign to the NAT Gateway. If you don't provide an address, a private IPv4 address will be automatically assigned. +* `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). * `subnet_id` - (Required) The Subnet ID of the subnet in which to place the NAT Gateway. -* `secondary_allocation_ids` - (Optional) A list of secondary allocation EIP IDs for this NAT Gateway. +* `secondary_allocation_ids` - (Optional) A list of secondary allocation EIP IDs for this NAT Gateway. To remove all secondary allocations an empty list should be specified. * `secondary_private_ip_address_count` - (Optional) [Private NAT Gateway only] The number of secondary private IPv4 addresses you want to assign to the NAT Gateway. -* `secondary_private_ip_addresses` - (Optional) A list of secondary private IPv4 addresses to assign to the NAT Gateway. +* `secondary_private_ip_addresses` - (Optional) A list of secondary private IPv4 addresses to assign to the NAT Gateway. To remove all secondary private addresses an empty list should be specified. * `tags` - (Optional) A 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. ## Attribute Reference diff --git a/website/docs/r/nat_gateway_eip_association.html.markdown b/website/docs/r/nat_gateway_eip_association.html.markdown new file mode 100644 index 000000000000..f7a7c6007bf0 --- /dev/null +++ b/website/docs/r/nat_gateway_eip_association.html.markdown @@ -0,0 +1,62 @@ +--- +subcategory: "VPC (Virtual Private Cloud)" +layout: "aws" +page_title: "AWS: aws_nat_gateway_eip_association" +description: |- + Terraform resource for managing an AWS VPC NAT Gateway EIP Association. +--- +# Resource: aws_nat_gateway_eip_association + +Terraform resource for managing an AWS VPC NAT Gateway EIP Association. + +!> **WARNING:** You should not use the `aws_nat_gateway_eip_association` resource in conjunction with an [`aws_nat_gateway`](aws_nat_gateway.html) resource that has `secondary_allocation_ids` configured. Doing so may cause perpetual differences, and result in associations being overwritten. + +## Example Usage + +### Basic Usage + +```terraform +resource "aws_nat_gateway_eip_association" "example" { + allocation_id = aws_eip.example.id + nat_gateway_id = aws_nat_gateway.example.id +} +``` + +## Argument Reference + +The following arguments are required: + +* `allocation_id` - (Required) The ID of the Elastic IP Allocation to associate with the NAT Gateway. +* `nat_gateway_id` - (Required) The ID of the NAT Gateway to associate the Elastic IP Allocation to. + +The following arguments are optional: + +* `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). + +## Attribute Reference + +This resource exports no additional attributes. + +## Timeouts + +[Configuration options](https://developer.hashicorp.com/terraform/language/resources/syntax#operation-timeouts): + +* `create` - (Default `10m`) +* `delete` - (Default `30m`) + +## Import + +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import VPC NAT Gateway EIP Association using the `nat_gateway_id,allocation_id`. For example: + +```terraform +import { + to = aws_nat_gateway_eip_association.example + id = "nat-1234567890abcdef1,eipalloc-1234567890abcdef1" +} +``` + +Using `terraform import`, import VPC NAT Gateway EIP Association using the `nat_gateway_id,allocation_id`. For example: + +```console +% terraform import aws_nat_gateway_eip_association.example nat-1234567890abcdef1,eipalloc-1234567890abcdef1 +``` diff --git a/website/docs/r/network_interface.html.markdown b/website/docs/r/network_interface.html.markdown index f783129e37bf..a07837aaffc9 100644 --- a/website/docs/r/network_interface.html.markdown +++ b/website/docs/r/network_interface.html.markdown @@ -77,6 +77,7 @@ The `attachment` block supports the following: * `instance` - (Required) ID of the instance to attach to. * `device_index` - (Required) Integer to define the devices index. +* `network_card_index` - (Optional) Index of the network card. Specify a value greater than 0 when using multiple network cards, which are supported by [some instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-eni.html#network-cards). The default is 0. ## Attribute Reference diff --git a/website/docs/r/network_interface_attachment.html.markdown b/website/docs/r/network_interface_attachment.html.markdown index ef3750b6ee08..649d43179ea0 100644 --- a/website/docs/r/network_interface_attachment.html.markdown +++ b/website/docs/r/network_interface_attachment.html.markdown @@ -28,6 +28,7 @@ This resource supports the following arguments: * `instance_id` - (Required) Instance ID to attach. * `network_interface_id` - (Required) ENI ID to attach. * `device_index` - (Required) Network interface index (int). +* `network_card_index` - (Optional) Index of the network card. Specify a value greater than 0 when using multiple network cards, which are supported by [some instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-eni.html#network-cards). The default is 0. ## Attribute Reference diff --git a/website/docs/r/networkfirewall_firewall.html.markdown b/website/docs/r/networkfirewall_firewall.html.markdown index 61031e84908c..756969b76bd2 100644 --- a/website/docs/r/networkfirewall_firewall.html.markdown +++ b/website/docs/r/networkfirewall_firewall.html.markdown @@ -35,11 +35,39 @@ resource "aws_networkfirewall_firewall" "example" { } ``` +### Transit Gateway Attached Firewall + +```terraform +data "aws_availability_zones" "example" { + state = "available" +} + +resource "aws_networkfirewall_firewall" "example" { + name = "example" + firewall_policy_arn = aws_networkfirewall_firewall_policy.example.arn + transit_gateway_id = aws_ec2_transit_gateway.example.id + + availability_zone_mapping { + availability_zone_id = data.aws_availability_zones.example.zone_ids[0] + } + + availability_zone_mapping { + availability_zone_id = data.aws_availability_zones.example.zone_ids[1] + } +} +``` + +### Transit Gateway Attached Firewall (Cross Account) + +A full example of how to create a Transit Gateway in one AWS account, share it with a second AWS account, and create Network Firewall in the second account to the Transit Gateway via the `aws_networkfirewall_firewall` and [`aws_networkfirewall_network_firewall_transit_gateway_attachment_accepter`](/docs/providers/aws/r/networkfirewall_network_firewall_transit_gateway_attachment_accepter.html) resources can be found in [the `./examples/network-firewall-cross-account-transit-gateway` directory within the Github Repository](https://github.com/hashicorp/terraform-provider-aws/tree/main/examples/network-firewall-cross-account-transit-gateway) + ## Argument Reference This resource supports the following arguments: * `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). +* `availability_zone_change_protection` - (Optional) A setting indicating whether the firewall is protected against changes to its Availability Zone configuration. When set to `true`, you must first disable this protection before adding or removing Availability Zones. +* `availability_zone_mapping` - (Optional) Required when creating a transit gateway-attached firewall. Set of configuration blocks describing the avaiability availability where you want to create firewall endpoints for a transit gateway-attached firewall. * `delete_protection` - (Optional) A flag indicating whether the firewall is protected against deletion. Use this setting to protect against accidentally deleting a firewall that is in use. Defaults to `false`. * `description` - (Optional) A friendly description of the firewall. * `enabled_analysis_types` - (Optional) Set of types for which to collect analysis metrics. See [Reporting on network traffic in Network Firewall](https://docs.aws.amazon.com/network-firewall/latest/developerguide/reporting.html) for details on how to use the data. Valid values: `TLS_SNI`, `HTTP_HOST`. Defaults to `[]`. @@ -48,9 +76,16 @@ This resource supports the following arguments: * `firewall_policy_change_protection` - (Optional) A flag indicating whether the firewall is protected against a change to the firewall policy association. Use this setting to protect against accidentally modifying the firewall policy for a firewall that is in use. Defaults to `false`. * `name` - (Required, Forces new resource) A friendly name of the firewall. * `subnet_change_protection` - (Optional) A flag indicating whether the firewall is protected against changes to the subnet associations. Use this setting to protect against accidentally modifying the subnet associations for a firewall that is in use. Defaults to `false`. -* `subnet_mapping` - (Required) Set of configuration blocks describing the public subnets. Each subnet must belong to a different Availability Zone in the VPC. AWS Network Firewall creates a firewall endpoint in each subnet. See [Subnet Mapping](#subnet-mapping) below for details. +* `subnet_mapping` - (Optional) Required when creating a VPC attached firewall. Set of configuration blocks describing the public subnets. Each subnet must belong to a different Availability Zone in the VPC. AWS Network Firewall creates a firewall endpoint in each subnet. See [Subnet Mapping](#subnet-mapping) below for details. * `tags` - (Optional) Map of resource tags to associate with 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. -* `vpc_id` - (Required, Forces new resource) The unique identifier of the VPC where AWS Network Firewall should create the firewall. +* `transit_gateway_id` - (Optional, Forces new resource). Required when creating a transit gateway-attached firewall. The unique identifier of the transit gateway to attach to this firewall. You can provide either a transit gateway from your account or one that has been shared with you through AWS Resource Access Manager +* `vpc_id` - (Optional, Forces new resource) Required when creating a VPC attached firewall. The unique identifier of the VPC where AWS Network Firewall should create the firewall. + +### Availability Zone Mapping + +The `availability_zone_mapping` block supports the following arguments: + +* `availability_zone_id` - (Required)The ID of the Availability Zone where the firewall endpoint is located.. ### Encryption Configuration @@ -78,16 +113,19 @@ This resource exports the following attributes in addition to the arguments abov * `endpoint_id` - The identifier of the firewall endpoint that AWS Network Firewall has instantiated in the subnet. You use this to identify the firewall endpoint in the VPC route tables, when you redirect the VPC traffic through the endpoint. * `subnet_id` - The unique identifier of the subnet that you've specified to be used for a firewall endpoint. * `availability_zone` - The Availability Zone where the subnet is configured. + * `transit_gateway_attachment_sync_states` - Set of transit gateway configured for use by the firewall. + * `attachment_id` - The unique identifier of the transit gateway attachment. * `tags_all` - A map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). +* `transit_gateway_owner_account_id` - The AWS account ID that owns the transit gateway. * `update_token` - A string token used when updating a firewall. ## Timeouts [Configuration options](https://developer.hashicorp.com/terraform/language/resources/syntax#operation-timeouts): -- `create` - (Default `30m`) -- `update` - (Default `30m`) -- `delete` - (Default `30m`) +- `create` - (Default `60m`) +- `update` - (Default `60m`) +- `delete` - (Default `60m`) ## Import diff --git a/website/docs/r/networkfirewall_firewall_transit_gateway_attachment_accepter.html.markdown b/website/docs/r/networkfirewall_firewall_transit_gateway_attachment_accepter.html.markdown new file mode 100644 index 000000000000..da51ea778fcb --- /dev/null +++ b/website/docs/r/networkfirewall_firewall_transit_gateway_attachment_accepter.html.markdown @@ -0,0 +1,63 @@ +--- +subcategory: "Network Firewall" +layout: "aws" +page_title: "AWS: aws_networkfirewall_firewall_transit_gateway_attachment_accepter" +description: |- + Manages an AWS Network Firewall Firewall Transit Gateway Attachment Accepter. +--- + +# Resource: aws_networkfirewall_firewall_transit_gateway_attachment_accepter + +Manages an AWS Network Firewall Firewall Transit Gateway Attachment Accepter. + +When a cross-account (requester's AWS account differs from the accepter's AWS account) requester creates a Network Firewall with Transit Gateway ID using `aws_networkfirewall_firewall`. Then an EC2 Transit Gateway VPC Attachment resource is automatically created in the accepter's account. +The accepter can use the `aws_networkfirewall_firewall_transit_gateway_attachment_accepter` resource to "adopt" its side of the connection into management. + +~> **NOTE:** If the `transit_gateway_id` argument in the `aws_networkfirewall_firewall` resource is used to attach a firewall to a transit gateway in a cross-account setup (where **Auto accept shared attachments** is disabled), the resource will be considered created when the transit gateway attachment is in the *Pending Acceptance* state and the firewall is in the *Provisioning* status. At this point, you can use the `aws_networkfirewall_firewall_transit_gateway_attachment_accepter` resource to finalize the network firewall deployment. Once the transit gateway attachment reaches the *Available* state, the firewall status *Ready*. + +## Example Usage + +### Basic Usage + +```terraform +resource "aws_networkfirewall_firewall_transit_gateway_attachment_accepter" "example" { + transit_gateway_attachment_id = aws_networkfirewall_firewall.example.firewall_status[0].transit_gateway_attachment_sync_state[0].attachment_id +} +``` + +A full example of how to create a Transit Gateway in one AWS account, share it with a second AWS account, and create Network Firewall in the second account to the Transit Gateway via the `aws_networkfirewall_firewall` and `aws_networkfirewall_firewall_transit_gateway_attachment_accepter` resources can be found in [the `./examples/network-firewall-cross-account-transit-gateway` directory within the Github Repository](https://github.com/hashicorp/terraform-provider-aws/tree/main/examples/network-firewall-cross-account-transit-gateway) + +## Argument Reference + +This resource supports the following arguments: + +* `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). +* `transit_gateway_attachment_id` - (Required) The unique identifier of the transit gateway attachment to accept. This ID is returned in the response when creating a transit gateway-attached firewall. + +## Attribute Reference + +This resource exports no additional attributes. + +## Timeouts + +[Configuration options](https://developer.hashicorp.com/terraform/language/resources/syntax#operation-timeouts): + +* `create` - (Default `60m`) +* `delete` - (Default `60m`) + +## Import + +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import Network Firewall Firewall Transit Gateway Attachment Accepter using the `transit_gateway_attachment_id`. For example: + +```terraform +import { + to = aws_networkfirewall_firewall_transit_gateway_attachment_accepter.example + id = "tgw-attach-0c3b7e9570eee089c" +} +``` + +Using `terraform import`, import Network Firewall Firewall Transit Gateway Attachment Accepter using the `transit_gateway_attachment_id`. For example: + +```console +% terraform import aws_networkfirewall_firewall_transit_gateway_attachment_accepter.example tgw-attach-0c3b7e9570eee089c +``` diff --git a/website/docs/r/networkfirewall_vpc_endpoint_association.html.markdown b/website/docs/r/networkfirewall_vpc_endpoint_association.html.markdown new file mode 100644 index 000000000000..8ee056c71140 --- /dev/null +++ b/website/docs/r/networkfirewall_vpc_endpoint_association.html.markdown @@ -0,0 +1,92 @@ +--- +subcategory: "Network Firewall" +layout: "aws" +page_title: "AWS: aws_networkfirewall_vpc_endpoint_association" +description: |- + Manages a firewall endpoint for an AWS Network Firewall firewall. +--- + +# Resource: aws_networkfirewall_vpc_endpoint_association + +Manages a firewall endpoint for an AWS Network Firewall firewall. + +Use `aws_networkfirewall_vpc_endpoint_association` to establish new firewall endpoints in any Availability Zone where the firewall is already being used. The first use of a firewall in an Availability Zone must be defined by `aws_networkfirewall_firewall` resource and `subnet_mapping` argument. + +## Example Usage + +### Basic Usage + +```terraform +resource "aws_networkfirewall_vpc_endpoint_association" "example" { + firewall_arn = aws_networkfirewall_firewall.example.arn + vpc_id = aws_vpc.example.id + + subnet_mapping { + subnet_id = aws_subnet.example.id + } + + subnet_mapping { + subnet_id = aws_subnet.example_two.id + } + + tags = { + Name = "example endpoint" + } +} +``` + +## Argument Reference + +This resource supports the following arguments: + +* `description` (Optional) - A description of the VPC endpoint association. +* `firewall_arn` (Required) - The Amazon Resource Name (ARN) that identifies the firewall. +* `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). +* `subnet_mapping` (Required) - The ID for a subnet that's used in an association with a firewall. See [Subnet Mapping](#subnet-mapping) below for details. +* `tags` - (Optional) Map of resource tags to associate with 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. +* `vpc_id` (Required) - The unique identifier of the VPC for the endpoint association. + +### Subnet Mapping + +The `subnet_mapping` block supports the following arguments: + +* `ip_address_type` - (Optional) The subnet's IP address type. Valid values: `"DUALSTACK"`, `"IPV4"`. +* `subnet_id` - (Required) The unique identifier for the subnet. + +## Attribute Reference + +This resource exports the following attributes in addition to the arguments above: + +* `tags_all` - A map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). +* `vpc_endpoint_association_arn` - ARN of the VPC Endpoint Association. +* `vpc_endpoint_association_id` - The unique identifier of the VPC endpoint association. +* `vpc_endpoint_association_status` - Nested list of information about the current status of the VPC Endpoint Association. + * `association_sync_states` - Set of subnets configured for use by the VPC Endpoint Association. + * `attachment` - Nested list describing the attachment status of the firewall's VPC Endpoint Association with a single VPC subnet. + * `endpoint_id` - The identifier of the VPC endpoint that AWS Network Firewall has instantiated in the subnet. You use this to identify the firewall endpoint in the VPC route tables, when you redirect the VPC traffic through the endpoint. + * `subnet_id` - The unique identifier of the subnet that you've specified to be used for a VPC Endpoint Association endpoint. + * `availability_zone` - The Availability Zone where the subnet is configured. + +## Timeouts + +[Configuration options](https://developer.hashicorp.com/terraform/language/resources/syntax#operation-timeouts): + +* `create` - (Default `30m`) +* `delete` - (Default `30m`) + +## Import + +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import Network Firewall VPC Endpoint Association using the `vpc_endpoint_association_arn`. For example: + +```terraform +import { + to = aws_networkfirewall_vpc_endpoint_association.example + id = "arn:aws:network-firewall:us-west-1:123456789012:vpc-endpoint-association/example" +} +``` + +Using `terraform import`, import Network Firewall VPC Endpoint Association using the `vpc_endpoint_association_arn`. For example: + +```console +% terraform import aws_networkfirewall_vpc_endpoint_association.example arn:aws:network-firewall:us-west-1:123456789012:vpc-endpoint-association/example +``` diff --git a/website/docs/r/networkmanager_transit_gateway_peering.html.markdown b/website/docs/r/networkmanager_transit_gateway_peering.html.markdown index 455407514f67..7f65eda9818d 100644 --- a/website/docs/r/networkmanager_transit_gateway_peering.html.markdown +++ b/website/docs/r/networkmanager_transit_gateway_peering.html.markdown @@ -16,6 +16,11 @@ Manages a Network Manager transit gateway peering connection. Creates a peering resource "aws_networkmanager_transit_gateway_peering" "example" { core_network_id = awscc_networkmanager_core_network.example.id transit_gateway_arn = aws_ec2_transit_gateway.example.arn + + depends_on = [ + aws_ec2_transit_gateway_policy_table.example, + aws_networkmanager_core_network_policy_attachment.example, + ] } ``` diff --git a/website/docs/r/opensearch_authorize_vpc_endpoint_access.html.markdown b/website/docs/r/opensearch_authorize_vpc_endpoint_access.html.markdown index c459e11c9901..0141e58c7006 100644 --- a/website/docs/r/opensearch_authorize_vpc_endpoint_access.html.markdown +++ b/website/docs/r/opensearch_authorize_vpc_endpoint_access.html.markdown @@ -44,7 +44,7 @@ This resource exports the following attributes in addition to the arguments abov ## Import -In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import OpenSearch Authorize Vpc Endpoint Access using the `example_id_arg`. For example: +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import OpenSearch Authorize Vpc Endpoint Access using the `domain_name`. For example: ```terraform import { @@ -53,7 +53,7 @@ import { } ``` -Using `terraform import`, import OpenSearch Authorize Vpc Endpoint Access using the `example_id_arg`. For example: +Using `terraform import`, import OpenSearch Authorize Vpc Endpoint Access using the `domain_name`. For example: ```console % terraform import aws_opensearch_authorize_vpc_endpoint_access.example authorize_vpc_endpoint_access-id-12345678 diff --git a/website/docs/r/opensearch_domain_policy.html.markdown b/website/docs/r/opensearch_domain_policy.html.markdown index c857add58802..f3ace154298d 100644 --- a/website/docs/r/opensearch_domain_policy.html.markdown +++ b/website/docs/r/opensearch_domain_policy.html.markdown @@ -62,3 +62,20 @@ This resource exports no additional attributes. * `update` - (Default `180m`) * `delete` - (Default `90m`) + +## Import + +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import OpenSearch Domain Policy using `domain_name` prefixed with `esd-policy-`. For example: + +```terraform +import { + to = aws_opensearch_domain_policy.example + id = "esd-policy-tf-test" +} +``` + +Using `terraform import`, import OpenSearch Domain Policy using `domain_name` prefixed with `esd-policy-`. For example: + +```console +% terraform import aws_opensearch_domain_policy.example esd-policy-tf-test +``` diff --git a/website/docs/r/quicksight_account_settings.html.markdown b/website/docs/r/quicksight_account_settings.html.markdown index 24fa9d832005..0fd7fcdea3f0 100644 --- a/website/docs/r/quicksight_account_settings.html.markdown +++ b/website/docs/r/quicksight_account_settings.html.markdown @@ -33,14 +33,13 @@ resource "aws_quicksight_account_settings" "example" { This resource supports the following arguments: +* `aws_account_id` - (Optional, Forces new resource) AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider. * `default_namespace` - (Optional) The default namespace for this Amazon Web Services account. Currently, the default is `default`. * `termination_protection_enabled` - (Optional) A boolean value that determines whether or not an Amazon QuickSight account can be deleted. If `true`, it does not allow the account to be deleted and results in an error message if a user tries to make a DeleteAccountSubscription request. If `false`, it will allow the account to be deleted. ## Attribute Reference -This resource exports the following attributes in addition to the arguments above: - -* `aws_account_id` - The ID for the AWS account that contains the settings. +This resource exports no additional attributes. ## Import diff --git a/website/docs/r/quicksight_account_subscription.html.markdown b/website/docs/r/quicksight_account_subscription.html.markdown index 4571c652b11e..42adb2c206c0 100644 --- a/website/docs/r/quicksight_account_subscription.html.markdown +++ b/website/docs/r/quicksight_account_subscription.html.markdown @@ -34,11 +34,10 @@ The following arguments are required: The following arguments are optional: -* `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). * `active_directory_name` - (Optional) Name of your Active Directory. This field is required if `ACTIVE_DIRECTORY` is the selected authentication method of the new Amazon QuickSight account. * `admin_group` - (Optional) Admin group associated with your Active Directory or IAM Identity Center account. This field is required if `ACTIVE_DIRECTORY` or `IAM_IDENTITY_CENTER` is the selected authentication method of the new Amazon QuickSight account. * `author_group` - (Optional) Author group associated with your Active Directory or IAM Identity Center account. -* `aws_account_id` - (Optional) AWS account ID hosting the QuickSight account. Default to provider account. +* `aws_account_id` - (Optional, Forces new resource) AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider. * `contact_number` - (Optional) A 10-digit phone number for the author of the Amazon QuickSight account to use for future communications. This field is required if `ENTERPPRISE_AND_Q` is the selected edition of the new Amazon QuickSight account. * `directory_id` - (Optional) Active Directory ID that is associated with your Amazon QuickSight account. * `email_address` - (Optional) Email address of the author of the Amazon QuickSight account to use for future communications. This field is required if `ENTERPPRISE_AND_Q` is the selected edition of the new Amazon QuickSight account. @@ -47,6 +46,7 @@ The following arguments are optional: * `last_name` - (Optional) Last name of the author of the Amazon QuickSight account to use for future communications. This field is required if `ENTERPPRISE_AND_Q` is the selected edition of the new Amazon QuickSight account. * `reader_group` - (Optional) Reader group associated with your Active Directory or IAM Identity Center account. * `realm` - (Optional) Realm of the Active Directory that is associated with your Amazon QuickSight account. +* `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). ## Attribute Reference @@ -63,4 +63,19 @@ This resource exports the following attributes in addition to the arguments abov ## Import -You cannot import this resource. +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import a QuickSight Account Subscription using `aws_account_id`. For example: + +~> Due to the absence of required arguments in the [`DescribeAccountSettings`](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_DescribeAccountSettings.html) API response, importing an existing account subscription will result in a planned replacement on the subsequent `apply` operation. Until the Describe API response in extended to include all configurable arguments, an [`ignore_changes` lifecycle argument](https://developer.hashicorp.com/terraform/language/meta-arguments/lifecycle#ignore_changes) can be used to suppress differences on arguments not read into state. + +```terraform +import { + to = aws_quicksight_account_subscription.example + id = "012345678901" +} +``` + +Using `terraform import`, import a QuickSight Account Subscription using `aws_account_id`. For example: + +```console +% terraform import aws_quicksight_account_subscription.example "012345678901" +``` diff --git a/website/docs/r/quicksight_analysis.html.markdown b/website/docs/r/quicksight_analysis.html.markdown index 584984f581b1..831d91e2fd81 100644 --- a/website/docs/r/quicksight_analysis.html.markdown +++ b/website/docs/r/quicksight_analysis.html.markdown @@ -93,12 +93,12 @@ The following arguments are required: The following arguments are optional: -* `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). -* `aws_account_id` - (Optional, Forces new resource) AWS account ID. +* `aws_account_id` - (Optional, Forces new resource) AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider. * `definition` - (Optional) A detailed analysis definition. Only one of `definition` or `source_entity` should be configured. See [definition](#definition). * `parameters` - (Optional) The parameters for the creation of the analysis, which you want to use to override the default settings. An analysis can have any type of parameters, and some parameters might accept multiple values. See [parameters](#parameters). * `permissions` - (Optional) A set of resource permissions on the analysis. Maximum of 64 items. See [permissions](#permissions). * `recovery_window_in_days` - (Optional) A value that specifies the number of days that Amazon QuickSight waits before it deletes the analysis. Use `0` to force deletion without recovery. Minimum value of `7`. Maximum value of `30`. Default to `30`. +* `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). * `source_entity` - (Optional) The entity that you are using as a source when you create the analysis (template). Only one of `definition` or `source_entity` should be configured. See [source_entity](#source_entity). * `tags` - (Optional) Key-value map of resource tags. If configured with a provider [`default_tags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. * `theme_arn` - (Optional) The Amazon Resource Name (ARN) of the theme that is being used for this analysis. The theme ARN must exist in the same AWS account where you create the analysis. diff --git a/website/docs/r/quicksight_custom_permissions.html.markdown b/website/docs/r/quicksight_custom_permissions.html.markdown new file mode 100644 index 000000000000..7ea7ab857dd8 --- /dev/null +++ b/website/docs/r/quicksight_custom_permissions.html.markdown @@ -0,0 +1,85 @@ +--- +subcategory: "QuickSight" +layout: "aws" +page_title: "AWS: aws_quicksight_custom_permissions" +description: |- + Manages a QuickSight custom permissions profile. +--- + +# Resource: aws_quicksight_custom_permissions + +Manages a QuickSight custom permissions profile. + +## Example Usage + +resource "aws_quicksight_custom_permissions" "example" { + custom_permissions_name = "example-permissions" + + capabilities { + print_reports = "DENY" + share_dashboards = "DENY" + } +} + +## Argument Reference + +The following arguments are required: + +* `capabilities` - (Required) Actions to include in the custom permissions profile. See [capabilities](#capabilities). +* `custom_permissions_name` - (Required, Forces new resource) Custom permissions profile name. + +The following arguments are optional: + +* `aws_account_id` - (Optional, Forces new resource) AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider. +* `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). +* `tags` - (Optional) Key-value map of resource tags. If configured with a provider [`default_tags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. + +### capabilities + +* `add_or_run_anomaly_detection_for_analyses` - (Optional) The ability to add or run anomaly detection. Valid values: `DENY`. +* `create_and_update_dashboard_email_reports` - (Optional) The ability to create and update email reports. Valid values: `DENY`. +* `create_and_update_datasets` - (Optional) The ability to create and update datasets. Valid values: `DENY`. +* `create_and_update_data_sources` - (Optional) The ability to create and update data sources. Valid values: `DENY`. +* `create_and_update_themes` - (Optional) The ability to export to create and update themes. Valid values: `DENY`. +* `create_and_update_threshold_alerts` - (Optional) The ability to create and update threshold alerts. Valid values: `DENY`. +* `create_shared_folders` - (Optional) The ability to create shared folders. Valid values: `DENY`. +* `create_spice_dataset` - (Optional) The ability to create a SPICE dataset. Valid values: `DENY`. +* `export_to_csv` - (Optional) The ability to export to CSV files from the UI. Valid values: `DENY`. +* `export_to_csv_in_scheduled_reports` - (Optional) The ability to export to CSV files in scheduled email reports. Valid values: `DENY`. +* `export_to_excel` - (Optional) The ability to export to Excel files from the UI. Valid values: `DENY`. +* `export_to_excel_in_scheduled_reports` - (Optional) The ability to export to Excel files in scheduled email reports. Valid values: `DENY`. +* `export_to_pdf` - (Optional) The ability to export to PDF files from the UI. Valid values: `DENY`. +* `export_to_pdf_in_scheduled_reports` - (Optional) The ability to export to PDF files in scheduled email reports. Valid values: `DENY`. +* `include_content_in_scheduled_reports_email` - (Optional) The ability to include content in scheduled email reports. Valid values: `DENY`. +* `print_reports` - (Optional) The ability to print reports. Valid values: `DENY`. +* `rename_shared_folders` - (Optional) The ability to rename shared folders. Valid values: `DENY`. +* `share_analyses` - (Optional) The ability to share analyses. Valid values: `DENY`. +* `share_dashboards` - (Optional) The ability to share dashboards. Valid values: `DENY`. +* `share_datasets` - (Optional) The ability to share datasets. Valid values: `DENY`. +* `share_data_sources` - (Optional) The ability to share data sources. Valid values: `DENY`. +* `subscribe_dashboard_email_reports` - (Optional) The ability to subscribe to email reports. Valid values: `DENY`. +* `view_account_spice_capacity` - (Optional) The ability to view account SPICE capacity. Valid values: `DENY`. + +## Attribute Reference + +This resource exports the following attributes in addition to the arguments above: + +* `arn` - ARN of the custom permissions profile. +* `tags_all` - A map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block). + +## Import + +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import a QuickSight custom permissions profile using the AWS account ID and custom permissions profile name separated by a comma (`,`). For example: + +```terraform +import { + to = aws_quicksight_custom_permissions.example + id = "123456789012,example-permissions" +} +``` + +Using `terraform import`, import a QuickSight custom permissions profile using the AWS account ID and custom permissions profile name separated by a comma (`,`). For example: + +```console +% terraform import aws_quicksight_custom_permissions.example 123456789012,example-permissions +``` diff --git a/website/docs/r/quicksight_dashboard.html.markdown b/website/docs/r/quicksight_dashboard.html.markdown index 4a15ff87aaa0..8ac5df4020f8 100644 --- a/website/docs/r/quicksight_dashboard.html.markdown +++ b/website/docs/r/quicksight_dashboard.html.markdown @@ -96,12 +96,12 @@ The following arguments are required: The following arguments are optional: -* `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). -* `aws_account_id` - (Optional, Forces new resource) AWS account ID. +* `aws_account_id` - (Optional, Forces new resource) AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider. * `dashboard_publish_options` - (Optional) Options for publishing the dashboard. See [dashboard_publish_options](#dashboard_publish_options). * `definition` - (Optional) A detailed dashboard definition. Only one of `definition` or `source_entity` should be configured. See [definition](#definition). * `parameters` - (Optional) The parameters for the creation of the dashboard, which you want to use to override the default settings. A dashboard can have any type of parameters, and some parameters might accept multiple values. See [parameters](#parameters). * `permissions` - (Optional) A set of resource permissions on the dashboard. Maximum of 64 items. See [permissions](#permissions). +* `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). * `source_entity` - (Optional) The entity that you are using as a source when you create the dashboard (template). Only one of `definition` or `source_entity` should be configured. See [source_entity](#source_entity). * `tags` - (Optional) Key-value map of resource tags. If configured with a provider [`default_tags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. * `theme_arn` - (Optional) The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. The theme ARN must exist in the same AWS account where you create the dashboard. diff --git a/website/docs/r/quicksight_data_set.html.markdown b/website/docs/r/quicksight_data_set.html.markdown index e7e318654dba..882b720e0d14 100644 --- a/website/docs/r/quicksight_data_set.html.markdown +++ b/website/docs/r/quicksight_data_set.html.markdown @@ -170,8 +170,7 @@ The following arguments are required: The following arguments are optional: -* `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). -* `aws_account_id` - (Optional, Forces new resource) AWS account ID. +* `aws_account_id` - (Optional, Forces new resource) AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider. * `column_groups` - (Optional) Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported. See [column_groups](#column_groups). * `column_level_permission_rules` - (Optional) A set of 1 or more definitions of a [ColumnLevelPermissionRule](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_ColumnLevelPermissionRule.html). See [column_level_permission_rules](#column_level_permission_rules). * `data_set_usage_configuration` - (Optional) The usage configuration to apply to child datasets that reference this dataset as a source. See [data_set_usage_configuration](#data_set_usage_configuration). @@ -179,6 +178,7 @@ The following arguments are optional: * `logical_table_map` - (Optional) Configures the combination and transformation of the data from the physical tables. Maximum of 1 entry. See [logical_table_map](#logical_table_map). * `permissions` - (Optional) A set of resource permissions on the data source. Maximum of 64 items. See [permissions](#permissions). * `physical_table_map` - (Optional) Declares the physical tables that are available in the underlying data sources. See [physical_table_map](#physical_table_map). +* `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). * `row_level_permission_data_set` - (Optional) The row-level security configuration for the data that you want to create. See [row_level_permission_data_set](#row_level_permission_data_set). * `row_level_permission_tag_configuration` - (Optional) The configuration of tags on a dataset to set row-level security. Row-level security tags are currently supported for anonymous embedding only. See [row_level_permission_tag_configuration](#row_level_permission_tag_configuration). * `refresh_properties` - (Optional) The refresh properties for the data set. **NOTE**: Only valid when `import_mode` is set to `SPICE`. See [refresh_properties](#refresh_properties). diff --git a/website/docs/r/quicksight_data_source.html.markdown b/website/docs/r/quicksight_data_source.html.markdown index f394f1dd34ba..f1607d480937 100644 --- a/website/docs/r/quicksight_data_source.html.markdown +++ b/website/docs/r/quicksight_data_source.html.markdown @@ -139,10 +139,10 @@ The following arguments are required: The following arguments are optional: -* `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). -* `aws_account_id` - (Optional, Forces new resource) The ID for the AWS account that the data source is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account. +* `aws_account_id` - (Optional, Forces new resource) AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider. * `credentials` - (Optional) The credentials Amazon QuickSight uses to connect to your underlying source. See [Credentials](#credentials-argument-reference) below for more details. * `permission` - (Optional) A set of resource permissions on the data source. Maximum of 64 items. See [Permission](#permission-argument-reference) below for more details. +* `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). * `ssl_properties` - (Optional) Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source. See [SSL Properties](#ssl_properties-argument-reference) below for more details. * `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. * `vpc_connection_properties`- (Optional) Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source. See [VPC Connection Properties](#vpc_connection_properties-argument-reference) below for more details. diff --git a/website/docs/r/quicksight_folder.html.markdown b/website/docs/r/quicksight_folder.html.markdown index f612a952c620..875e938b4bad 100644 --- a/website/docs/r/quicksight_folder.html.markdown +++ b/website/docs/r/quicksight_folder.html.markdown @@ -69,11 +69,11 @@ The following arguments are required: The following arguments are optional: -* `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). -* `aws_account_id` - (Optional, Forces new resource) AWS account ID. +* `aws_account_id` - (Optional, Forces new resource) AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider. * `folder_type` - (Optional) The type of folder. By default, it is `SHARED`. Valid values are: `SHARED`. * `parent_folder_arn` - (Optional) The Amazon Resource Name (ARN) for the parent folder. If not set, creates a root-level folder. * `permissions` - (Optional) A set of resource permissions on the folder. Maximum of 64 items. See [permissions](#permissions). +* `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). * `tags` - (Optional) Key-value map of resource tags. If configured with a provider [`default_tags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. ### permissions diff --git a/website/docs/r/quicksight_folder_membership.html.markdown b/website/docs/r/quicksight_folder_membership.html.markdown index 6d9049427828..364759489305 100644 --- a/website/docs/r/quicksight_folder_membership.html.markdown +++ b/website/docs/r/quicksight_folder_membership.html.markdown @@ -32,8 +32,8 @@ The following arguments are required: The following arguments are optional: +* `aws_account_id` - (Optional, Forces new resource) AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider. * `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). -* `aws_account_id` - (Optional, Forces new resource) AWS account ID. ## Attribute Reference diff --git a/website/docs/r/quicksight_group.html.markdown b/website/docs/r/quicksight_group.html.markdown index 4d8f9829f97a..a7e0f021842f 100644 --- a/website/docs/r/quicksight_group.html.markdown +++ b/website/docs/r/quicksight_group.html.markdown @@ -22,11 +22,11 @@ resource "aws_quicksight_group" "example" { This resource supports the following arguments: -* `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). -* `group_name` - (Required) A name for the group. -* `aws_account_id` - (Optional) The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account. +* `aws_account_id` - (Optional, Forces new resource) AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider. * `description` - (Optional) A description for the group. +* `group_name` - (Required) A name for the group. * `namespace` - (Optional) The namespace. Currently, you should set this to `default`. +* `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). ## Attribute Reference diff --git a/website/docs/r/quicksight_group_membership.html.markdown b/website/docs/r/quicksight_group_membership.html.markdown index 4cc1792af56c..b7d268befcc2 100644 --- a/website/docs/r/quicksight_group_membership.html.markdown +++ b/website/docs/r/quicksight_group_membership.html.markdown @@ -23,11 +23,11 @@ resource "aws_quicksight_group_membership" "example" { This resource supports the following arguments: -* `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). +* `aws_account_id` - (Optional, Forces new resource) AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider. * `group_name` - (Required) The name of the group in which the member will be added. * `member_name` - (Required) The name of the member to add to the group. -* `aws_account_id` - (Optional) The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account. -* `namespace` - (Required) The namespace that you want the user to be a part of. Defaults to `default`. +* `namespace` - (Optional) The namespace that you want the user to be a part of. Defaults to `default`. +* `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). ## Attribute Reference diff --git a/website/docs/r/quicksight_iam_policy_assignment.html.markdown b/website/docs/r/quicksight_iam_policy_assignment.html.markdown index a41873c94cf0..e728117c5aef 100644 --- a/website/docs/r/quicksight_iam_policy_assignment.html.markdown +++ b/website/docs/r/quicksight_iam_policy_assignment.html.markdown @@ -34,11 +34,11 @@ The following arguments are required: The following arguments are optional: -* `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). -* `aws_account_id` - (Optional) AWS account ID. +* `aws_account_id` - (Optional, Forces new resource) AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider. * `identities` - (Optional) Amazon QuickSight users, groups, or both to assign the policy to. See [`identities` block](#identities-block). * `namespace` - (Optional) Namespace that contains the assignment. Defaults to `default`. * `policy_arn` - (Optional) ARN of the IAM policy to apply to the Amazon QuickSight users and groups specified in this assignment. +* `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). ### `identities` block diff --git a/website/docs/r/quicksight_ingestion.html.markdown b/website/docs/r/quicksight_ingestion.html.markdown index b1bcaa1889c6..e0163853303d 100644 --- a/website/docs/r/quicksight_ingestion.html.markdown +++ b/website/docs/r/quicksight_ingestion.html.markdown @@ -32,8 +32,8 @@ The following arguments are required: The following arguments are optional: +* `aws_account_id` - (Optional, Forces new resource) AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider. * `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). -* `aws_account_id` - (Optional) AWS account ID. ## Attribute Reference diff --git a/website/docs/r/quicksight_ip_restriction.html.markdown b/website/docs/r/quicksight_ip_restriction.html.markdown new file mode 100644 index 000000000000..3948608d845c --- /dev/null +++ b/website/docs/r/quicksight_ip_restriction.html.markdown @@ -0,0 +1,61 @@ +--- +subcategory: "QuickSight" +layout: "aws" +page_title: "AWS: aws_quicksight_ip_restriction" +description: |- + Manages the content and status of IP rules. +--- + +# Resource: aws_quicksight_ip_restriction + +Manages the content and status of IP rules. + +~> Deletion of this resource clears all IP restrictions from a QuickSight account. + +## Example Usage + +```terraform +resource "aws_quicksight_ip_restriction" "example" { + enabled = true + + ip_restriction_rule_map = { + "108.56.166.202/32" = "Allow self" + } + + vpc_id_restriction_rule_map = { + (aws_vpc.example.id) = "Main VPC" + } +} +``` + +## Argument Reference + +This resource supports the following arguments: + +* `aws_account_id` - (Optional, Forces new resource) AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider. +* `enabled` - (Required) Whether IP rules are turned on. +* `ip_restriction_rule_map` - (Optional) Map of allowed IPv4 CIDR ranges and descriptions. +* `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). +* `vpc_endpoint_id_restriction_rule_map` - (Optional) Map of allowed VPC endpoint IDs and descriptions. +* `vpc_id_restriction_rule_map` - (Optional) Map of VPC IDs and descriptions. Traffic from all VPC endpoints that are present in the specified VPC is allowed. + +## 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 QuickSight IP restriction using the AWS account ID. For example: + +```terraform +import { + to = aws_quicksight_ip_restriction.example + id = "012345678901" +} +``` + +Using `terraform import`, import QuickSight IP restriction using the AWS account ID. For example: + +```console +% terraform import aws_quicksight_ip_restriction.example "012345678901" +``` diff --git a/website/docs/r/quicksight_key_registration.html.markdown b/website/docs/r/quicksight_key_registration.html.markdown new file mode 100644 index 000000000000..ad835fb88fdb --- /dev/null +++ b/website/docs/r/quicksight_key_registration.html.markdown @@ -0,0 +1,62 @@ +--- +subcategory: "QuickSight" +layout: "aws" +page_title: "AWS: aws_quicksight_key_registration" +description: |- + Registers customer managed keys in a Amazon QuickSight account. +--- + +# Resource: aws_quicksight_key_registration + +Registers customer managed keys in a Amazon QuickSight account. + +~> Deletion of this resource clears all CMK registrations from a QuickSight account. QuickSight then uses AWS owned keys to encrypt your resources. + +## Example Usage + +```terraform +resource "aws_quicksight_key_registration" "example" { + key_registration { + key_arn = aws_kms_key.example1.arn + } + + key_registration { + key_arn = aws_kms_key.example2.arn + default_key = true + } +} +``` + +## Argument Reference + +This resource supports the following arguments: + +* `aws_account_id` - (Optional, Forces new resource) AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider. +* `key_registration` - (Required) Registered keys. See [key_registration](#key_registration). +* `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). + +### key_registration + +* `default_key` - (Optional) Whether the key is set as the default key for encryption and decryption use. +* `key_arn` - (Required) ARN of the AWS KMS key that is registered for encryption and decryption use. + +## 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 QuickSight key registration using the AWS account ID. For example: + +```terraform +import { + to = aws_quicksight_key_registration.example + id = "012345678901" +} +``` + +Using `terraform import`, import QuickSight key registration using the AWS account ID. For example: + +```console +% terraform import aws_quicksight_key_registration.example "012345678901" +``` diff --git a/website/docs/r/quicksight_namespace.html.markdown b/website/docs/r/quicksight_namespace.html.markdown index 27b8e2fea11c..c2128d32efd7 100644 --- a/website/docs/r/quicksight_namespace.html.markdown +++ b/website/docs/r/quicksight_namespace.html.markdown @@ -28,9 +28,9 @@ The following arguments are required: The following arguments are optional: -* `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). -* `aws_account_id` - (Optional) AWS account ID. +* `aws_account_id` - (Optional, Forces new resource) AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider. * `identity_store` - (Optional) User identity directory type. Defaults to `QUICKSIGHT`, the only current valid value. +* `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). * `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. ## Attribute Reference diff --git a/website/docs/r/quicksight_refresh_schedule.html.markdown b/website/docs/r/quicksight_refresh_schedule.html.markdown index 2b56486f3ccf..3dad1806e0ea 100644 --- a/website/docs/r/quicksight_refresh_schedule.html.markdown +++ b/website/docs/r/quicksight_refresh_schedule.html.markdown @@ -83,8 +83,8 @@ The following arguments are required: The following arguments are optional: +* `aws_account_id` - (Optional, Forces new resource) AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider. * `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). -* `aws_account_id` - (Optional, Forces new resource) AWS account ID. ### schedule diff --git a/website/docs/r/quicksight_role_custom_permission.html.markdown b/website/docs/r/quicksight_role_custom_permission.html.markdown new file mode 100644 index 000000000000..c1d1514cbdff --- /dev/null +++ b/website/docs/r/quicksight_role_custom_permission.html.markdown @@ -0,0 +1,54 @@ +--- +subcategory: "QuickSight" +layout: "aws" +page_title: "AWS: aws_quicksight_role_custom_permission" +description: |- + Manages the custom permissions that are associated with a role. +--- + +# Resource: aws_quicksight_role_custom_permission + +Manages the custom permissions that are associated with a role. + +## Example Usage + +```terraform +resource "aws_quicksight_role_custom_permission" "example" { + role = "READER" + custom_permissions_name = aws_quicksight_custom_permissions.example.custom_permissions_name +} +``` + +## Argument Reference + +The following arguments are required: + +* `custom_permissions_name` - (Required, Forces new resource) Custom permissions profile name. +* `role` - (Required, Forces new resource) Role. Valid values are `ADMIN`, `AUTHOR`, `READER`, `ADMIN_PRO`, `AUTHOR_PRO`, and `READER_PRO`. + +The following arguments are optional: + +* `aws_account_id` - (Optional, Forces new resource) AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider. +* `namespace` - (Optional, Forces new resource) Namespace containing the role. Defaults to `default`. +* `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). + +## 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 QuickSight role custom permissions using a comma-delimited string combining the `aws_account_id`, `namespace` and `role`. For example: + +```terraform +import { + to = aws_quicksight_role_custom_permission.example + id = "012345678901,default,READER" +} +``` + +Using `terraform import`, import QuickSight role custom permissions using a comma-delimited string combining the `aws_account_id`, `namespace`, and `role`. For example: + +```console +% terraform import aws_quicksight_role_custom_permission.example 012345678901,default,READER +``` diff --git a/website/docs/r/quicksight_role_membership.html.markdown b/website/docs/r/quicksight_role_membership.html.markdown index acf0cb23268e..3b03a95ed7c3 100644 --- a/website/docs/r/quicksight_role_membership.html.markdown +++ b/website/docs/r/quicksight_role_membership.html.markdown @@ -31,9 +31,9 @@ The following arguments are required: The following arguments are optional: -* `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). -* `aws_account_id` - (Optional) AWS account ID. Defaults to the account of the caller identity if not configured. +* `aws_account_id` - (Optional, Forces new resource) AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider. * `namespace` - (Optional) Name of the namespace. Defaults to `default`. +* `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). ## Attribute Reference diff --git a/website/docs/r/quicksight_template.html.markdown b/website/docs/r/quicksight_template.html.markdown index bbf9dafe862f..1ad3aa2ae421 100644 --- a/website/docs/r/quicksight_template.html.markdown +++ b/website/docs/r/quicksight_template.html.markdown @@ -98,10 +98,10 @@ The following arguments are required: The following arguments are optional: -* `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). -* `aws_account_id` - (Optional, Forces new resource) AWS account ID. +* `aws_account_id` - (Optional, Forces new resource) AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider. * `definition` - (Optional) A detailed template definition. Only one of `definition` or `source_entity` should be configured. See [definition](#definition). * `permissions` - (Optional) A set of resource permissions on the template. Maximum of 64 items. See [permissions](#permissions). +* `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). * `source_entity` - (Optional) The entity that you are using as a source when you create the template (analysis or template). Only one of `definition` or `source_entity` should be configured. See [source_entity](#source_entity). * `tags` - (Optional) Key-value map of resource tags. If configured with a provider [`default_tags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. diff --git a/website/docs/r/quicksight_template_alias.html.markdown b/website/docs/r/quicksight_template_alias.html.markdown index 21141245a7c1..bf60a905e994 100644 --- a/website/docs/r/quicksight_template_alias.html.markdown +++ b/website/docs/r/quicksight_template_alias.html.markdown @@ -32,8 +32,8 @@ The following arguments are required: The following arguments are optional: +* `aws_account_id` - (Optional, Forces new resource) AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider. * `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). -* `aws_account_id` - (Optional, Forces new resource) AWS account ID. ## Attribute Reference diff --git a/website/docs/r/quicksight_theme.html.markdown b/website/docs/r/quicksight_theme.html.markdown index 75376f861e03..b8d374344bed 100644 --- a/website/docs/r/quicksight_theme.html.markdown +++ b/website/docs/r/quicksight_theme.html.markdown @@ -49,16 +49,16 @@ resource "aws_quicksight_theme" "example" { The following arguments are required: -* `theme_id` - (Required, Forces new resource) Identifier of the theme. * `base_theme_id` - (Required) The ID of the theme that a custom theme will inherit from. All themes inherit from one of the starting themes defined by Amazon QuickSight. For a list of the starting themes, use ListThemes or choose Themes from within an analysis. -* `name` - (Required) Display name of the theme. * `configuration` - (Required) The theme configuration, which contains the theme display properties. See [configuration](#configuration). +* `name` - (Required) Display name of the theme. +* `theme_id` - (Required, Forces new resource) Identifier of the theme. The following arguments are optional: -* `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). -* `aws_account_id` - (Optional, Forces new resource) AWS account ID. +* `aws_account_id` - (Optional, Forces new resource) AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider. * `permissions` - (Optional) A set of resource permissions on the theme. Maximum of 64 items. See [permissions](#permissions). +* `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). * `tags` - (Optional) Key-value map of resource tags. If configured with a provider [`default_tags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. * `version_description` - (Optional) A description of the current theme version being created/updated. diff --git a/website/docs/r/quicksight_user.html.markdown b/website/docs/r/quicksight_user.html.markdown index 50e63f087a99..566db96c8ab3 100644 --- a/website/docs/r/quicksight_user.html.markdown +++ b/website/docs/r/quicksight_user.html.markdown @@ -52,15 +52,15 @@ resource "aws_quicksight_user" "example" { The following arguments are required: * `email` - (Required) Email address of the user that you want to register. -* `identity_type` - (Required) Identity type that your Amazon QuickSight account uses to manage the identity of users. Valid values: `IAM`, `QUICKSIGHT`. -* `user_role` - (Required) Amazon QuickSight role for the user. Value values: `READER`, `AUTHOR`, `ADMIN`, `READER_PRO`, `AUTHOR_PRO`, `ADMIN_PRO`. +* `identity_type` - (Required) Identity type that your Amazon QuickSight account uses to manage the identity of users. Valid values: `IAM`, `QUICKSIGHT`, `IAM_IDENTITY_CENTER`. +* `user_role` - (Required) Amazon QuickSight role for the user. Valid values: `READER`, `AUTHOR`, `ADMIN`, `READER_PRO`, `AUTHOR_PRO`, `ADMIN_PRO`, `RESTRICTED_AUTHOR`, `RESTRICTED_READER`. The following arguments are optional: -* `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). -* `aws_account_id` - (Optional) ID for the AWS account that the user is in. Use the ID for the AWS account that contains your Amazon QuickSight account. +* `aws_account_id` - (Optional, Forces new resource) AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider. * `iam_arn` - (Optional) ARN of the IAM user or role that you are registering with Amazon QuickSight. Required only for users with an identity type of `IAM`. * `namespace` - (Optional) The Amazon Quicksight namespace to create the user in. Defaults to `default`. +* `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). * `session_name` - (Optional) Name of the IAM session to use when assuming roles that can embed QuickSight dashboards. Only valid for registering users using an assumed IAM role. Additionally, if registering multiple users using the same IAM role, each user needs to have a unique session name. * `user_name` - (Optional) Amazon QuickSight user name that you want to create for the user you are registering. Required only for users with an identity type of `QUICKSIGHT`. diff --git a/website/docs/r/quicksight_user_custom_permission.html.markdown b/website/docs/r/quicksight_user_custom_permission.html.markdown new file mode 100644 index 000000000000..0056be62211a --- /dev/null +++ b/website/docs/r/quicksight_user_custom_permission.html.markdown @@ -0,0 +1,54 @@ +--- +subcategory: "QuickSight" +layout: "aws" +page_title: "AWS: aws_quicksight_user_custom_permission" +description: |- + Manages the custom permissions profile for a user. +--- + +# Resource: aws_quicksight_user_custom_permission + +Manages the custom permissions profile for a user. + +## Example Usage + +```terraform +resource "aws_quicksight_user_custom_permission" "example" { + user_name = aws_quicksight_user.example.user_name + custom_permissions_name = aws_quicksight_custom_permissions.example.custom_permissions_name +} +``` + +## Argument Reference + +The following arguments are required: + +* `custom_permissions_name` - (Required, Forces new resource) Custom permissions profile name. +* `user_name` - (Required, Forces new resource) Username of the user. + +The following arguments are optional: + +* `aws_account_id` - (Optional, Forces new resource) AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider. +* `namespace` - (Optional, Forces new resource) Namespace that the user belongs to. Defaults to `default`. +* `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). + +## 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 QuickSight user custom permissions using a comma-delimited string combining the `aws_account_id`, `namespace` and `user_name`. For example: + +```terraform +import { + to = aws_quicksight_user_custom_permission.example + id = "012345678901,default,user1" +} +``` + +Using `terraform import`, import QuickSight user custom permissions using a comma-delimited string combining the `aws_account_id`, `namespace`, and `user_name`. For example: + +```console +% terraform import aws_quicksight_user_custom_permission.example 012345678901,default,user1 +``` diff --git a/website/docs/r/quicksight_vpc_connection.html.markdown b/website/docs/r/quicksight_vpc_connection.html.markdown index c6a50639d3f5..0e7d8005f0c2 100644 --- a/website/docs/r/quicksight_vpc_connection.html.markdown +++ b/website/docs/r/quicksight_vpc_connection.html.markdown @@ -74,9 +74,9 @@ The following arguments are required: The following arguments are optional: -* `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). -* `aws_account_id` - (Optional) AWS account ID. +* `aws_account_id` - (Optional, Forces new resource) AWS account ID. Defaults to automatically determined account ID of the Terraform AWS provider. * `dns_resolvers` - (Optional) A list of IP addresses of DNS resolver endpoints for the VPC connection. +* `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). * `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. ## Attribute Reference diff --git a/website/docs/r/rds_cluster.html.markdown b/website/docs/r/rds_cluster.html.markdown index b22316877068..4e97073660e3 100644 --- a/website/docs/r/rds_cluster.html.markdown +++ b/website/docs/r/rds_cluster.html.markdown @@ -230,7 +230,7 @@ This resource supports the following arguments: * `enable_global_write_forwarding` - (Optional) Whether cluster should forward writes to an associated global cluster. Applied to secondary clusters to enable them to forward writes to an [`aws_rds_global_cluster`](/docs/providers/aws/r/rds_global_cluster.html)'s primary cluster. See the [User Guide for Aurora](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database-write-forwarding.html) for more information. * `enable_http_endpoint` - (Optional) Enable HTTP endpoint (data API). Only valid for some combinations of `engine_mode`, `engine` and `engine_version` and only available in some regions. See the [Region and version availability](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html#data-api.regions) section of the documentation. This option also does not work with any of these options specified: `snapshot_identifier`, `replication_source_identifier`, `s3_import`. * `enable_local_write_forwarding` - (Optional) Whether read replicas can forward write operations to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.. See the [User Guide for Aurora](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-mysql-write-forwarding.html) for more information. **NOTE:** Local write forwarding requires Aurora MySQL version 3.04 or higher. -* `enabled_cloudwatch_logs_exports` - (Optional) Set of log types to export to cloudwatch. If omitted, no logs will be exported. The following log types are supported: `audit`, `error`, `general`, `slowquery`, `iam-db-auth-error`, `postgresql` (PostgreSQL). +* `enabled_cloudwatch_logs_exports` - (Optional) Set of log types to export to cloudwatch. If omitted, no logs will be exported. The following log types are supported: `audit`, `error`, `general`, `iam-db-auth-error`, `instance`, `postgresql` (PostgreSQL), `slowquery`. * `engine_mode` - (Optional) Database engine mode. Valid values: `global` (only valid for Aurora MySQL 1.21 and earlier), `parallelquery`, `provisioned`, `serverless`. Defaults to: `provisioned`. Specify an empty value (`""`) for no engine mode. See the [RDS User Guide](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html) for limitations when using `serverless`. * `engine_lifecycle_support` - (Optional) The life cycle type for this DB instance. This setting is valid for cluster types Aurora DB clusters and Multi-AZ DB clusters. Valid values are `open-source-rds-extended-support`, `open-source-rds-extended-support-disabled`. Default value is `open-source-rds-extended-support`. [Using Amazon RDS Extended Support]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/extended-support.html * `engine_version` - (Optional) Database engine version. Updating this argument results in an outage. See the [Aurora MySQL](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Updates.html) and [Aurora Postgres](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraPostgreSQL.Updates.html) documentation for your configured engine to determine this value, or by running `aws rds describe-db-engine-versions`. For example with Aurora MySQL 2, a potential value for this argument is `5.7.mysql_aurora.2.03.2`. The value can contain a partial version where supported by the API. The actual engine version used is returned in the attribute `engine_version_actual`, , see [Attribute Reference](#attribute-reference) below. diff --git a/website/docs/r/rds_instance_state.html.markdown b/website/docs/r/rds_instance_state.html.markdown index 3ecc6cbefece..56de232f09b7 100644 --- a/website/docs/r/rds_instance_state.html.markdown +++ b/website/docs/r/rds_instance_state.html.markdown @@ -33,9 +33,7 @@ This resource supports the following arguments: ## Attribute Reference -This resource exports the following attributes in addition to the arguments above: - -* `identifier` - DB Instance Identifier +This resource exports no additional attributes. ## Timeouts @@ -46,7 +44,7 @@ This resource exports the following attributes in addition to the arguments abov ## Import -In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import RDS (Relational Database) RDS Instance State using the `example_id_arg`. For example: +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import RDS (Relational Database) RDS Instance State using the `identifier`. For example: ```terraform import { @@ -55,7 +53,7 @@ import { } ``` -Using `terraform import`, import RDS (Relational Database) RDS Instance State using the `example_id_arg`. For example: +Using `terraform import`, import RDS (Relational Database) RDS Instance State using the `identifier`. For example: ```console % terraform import aws_rds_instance_state.example rds_instance_state-id-12345678 diff --git a/website/docs/r/rekognition_collection.html.markdown b/website/docs/r/rekognition_collection.html.markdown index cf8859799a02..d617aad1e126 100644 --- a/website/docs/r/rekognition_collection.html.markdown +++ b/website/docs/r/rekognition_collection.html.markdown @@ -49,7 +49,7 @@ This resource exports the following attributes in addition to the arguments abov ## Import -In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import Rekognition Collection using the `example_id_arg`. For example: +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import Rekognition Collection using the `collection_id`. For example: ```terraform import { @@ -58,7 +58,7 @@ import { } ``` -Using `terraform import`, import Rekognition Collection using the `example_id_arg`. For example: +Using `terraform import`, import Rekognition Collection using the `collection_id`. For example: ```console % terraform import aws_rekognition_collection.example collection-id-12345678 diff --git a/website/docs/r/rekognition_project.html.markdown b/website/docs/r/rekognition_project.html.markdown index ce0392432bcf..4b4deaa4d211 100644 --- a/website/docs/r/rekognition_project.html.markdown +++ b/website/docs/r/rekognition_project.html.markdown @@ -12,6 +12,8 @@ Terraform resource for managing an AWS Rekognition Project. ## Example Usage +### Content Moderation + ```terraform resource "aws_rekognition_project" "example" { name = "example-project" @@ -20,6 +22,16 @@ resource "aws_rekognition_project" "example" { } ``` +### Custom Labels + +```terraform +resource "aws_rekognition_project" "example" { + # Do not set auto_update when feature is "CUSTOM_LABELS" + name = "example-project" + feature = "CUSTOM_LABELS" +} +``` + ## Argument Reference The following arguments are required: @@ -29,7 +41,7 @@ The following arguments are required: The following arguments are optional: * `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). -* `auto_update` - (Optional) Specify if automatic retraining should occur. Valid values are `ENABLED` or `DISABLED`. Defaults to `DISABLED`. +* `auto_update` - (Optional) Specify if automatic retraining should occur. Valid values are `ENABLED` or `DISABLED`. Must be set when `feature` is `CONTENT_MODERATION`, but do not set otherwise. * `feature` - (Optional) Specify the feature being customized. Valid values are `CONTENT_MODERATION` or `CUSTOM_LABELS`. Defaults to `CUSTOM_LABELS`. * `tags` - (Optional) Map of tags assigned to the resource. If configured with a provider [`default_tags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. @@ -49,7 +61,7 @@ This resource exports the following attributes in addition to the arguments abov ## Import -In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import Rekognition Project using the `example_id_arg`. For example: +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import Rekognition Project using the `name`. For example: ```terraform import { diff --git a/website/docs/r/route.html.markdown b/website/docs/r/route.html.markdown index 3c9a3197f876..25eaf0958d4b 100644 --- a/website/docs/r/route.html.markdown +++ b/website/docs/r/route.html.markdown @@ -95,6 +95,46 @@ This resource exports the following attributes in addition to the arguments abov ## Import +In Terraform v1.12.0 and later, the [`import` block](https://developer.hashicorp.com/terraform/language/import) can be used with the `identity` attribute. For example: + +```terraform +import { + to = aws_route.example + identity = { + route_table_id = "rtb-656C65616E6F72" + destination_cidr_block = "10.42.0.0/16" + + ### OR by IPv6 CIDR block + # destination_ipv6_cidr_block = "10.42.0.0/16" + + ### OR by prefix list ID + # destination_prefix_list_id = "pl-0570a1d2d725c16be" + } +} + +resource "aws_route" "example" { + route_table_id = "rtb-656C65616E6F72" + destination_cidr_block = "10.42.0.0/16" + vpc_peering_connection_id = "pcx-45ff3dc1" +} +``` + +### Identity Schema + +#### Required + +- `route_table_id` - (String) ID of the route table. + +#### Optional + +~> Exactly one of of `destination_cidr_block`, `destination_ipv6_cidr_block`, or `destination_prefix_list_id` is required. + +- `account_id` (String) AWS Account where this resource is managed. +- `destination_cidr_block` - (String) Destination IPv4 CIDR block. +- `destination_ipv6_cidr_block` - (String) Destination IPv6 CIDR block. +- `destination_prefix_list_id` - (String) Destination IPv6 CIDR block. +- `region` (String) Region where this resource is managed. + In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import individual routes using `ROUTETABLEID_DESTINATION`. Import [local routes](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Route_Tables.html#RouteTables) using the VPC's IPv4 or IPv6 CIDR blocks. For example: Import a route in route table `rtb-656C65616E6F72` with an IPv4 destination CIDR of `10.42.0.0/16`: diff --git a/website/docs/r/route53_resolver_endpoint.html.markdown b/website/docs/r/route53_resolver_endpoint.html.markdown index 751add9f6f38..df302b87f679 100644 --- a/website/docs/r/route53_resolver_endpoint.html.markdown +++ b/website/docs/r/route53_resolver_endpoint.html.markdown @@ -46,8 +46,7 @@ This resource supports the following arguments: * `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). * `direction` - (Required) Direction of DNS queries to or from the Route 53 Resolver endpoint. -Valid values are `INBOUND` (resolver forwards DNS queries to the DNS service for a VPC from your network or another VPC) -or `OUTBOUND` (resolver forwards DNS queries from the DNS service for a VPC to your network or another VPC). +Valid values are `INBOUND` (resolver forwards DNS queries to the DNS service for a VPC from your network or another VPC), `OUTBOUND` (resolver forwards DNS queries from the DNS service for a VPC to your network or another VPC) or `INBOUND_DELEGATION` (resolver delegates queries to Route 53 private hosted zones from your network). * `ip_address` - (Required) Subnets and IP addresses in your VPC that you want DNS queries to pass through on the way from your VPCs to your network (for outbound endpoints) or on the way from your network to your VPCs (for inbound endpoints). Described below. * `name` - (Optional) Friendly name of the Route 53 Resolver endpoint. diff --git a/website/docs/r/route53_resolver_rule.html.markdown b/website/docs/r/route53_resolver_rule.html.markdown index 1cec8dc1ebeb..d84f7a463212 100644 --- a/website/docs/r/route53_resolver_rule.html.markdown +++ b/website/docs/r/route53_resolver_rule.html.markdown @@ -93,11 +93,37 @@ Values are `NOT_SHARED`, `SHARED_BY_ME` or `SHARED_WITH_ME` ## Import +In Terraform v1.12.0 and later, the [`import` block](https://developer.hashicorp.com/terraform/language/import) can be used with the `identity` attribute. For example: + +```terraform +import { + to = aws_route53_resolver_rule.example + identity = { + id = "rslvr-rr-0123456789abcdef0" + } +} + +resource "aws_route53_resolver_rule" "example" { + ### Configuration omitted for brevity ### +} +``` + +### Identity Schema + +#### Required + +* `id` - (String) ID of the Route53 Resolver rule. + +#### Optional + +- `account_id` (String) AWS Account where this resource is managed. +- `region` (String) Region where this resource is managed. + In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import Route53 Resolver rules using the `id`. For example: ```terraform import { - to = aws_route53_resolver_rule.sys + to = aws_route53_resolver_rule.example id = "rslvr-rr-0123456789abcdef0" } ``` @@ -105,5 +131,5 @@ import { Using `terraform import`, import Route53 Resolver rules using the `id`. For example: ```console -% terraform import aws_route53_resolver_rule.sys rslvr-rr-0123456789abcdef0 +% terraform import aws_route53_resolver_rule.example rslvr-rr-0123456789abcdef0 ``` diff --git a/website/docs/r/route53_resolver_rule_association.html.markdown b/website/docs/r/route53_resolver_rule_association.html.markdown index 70849bc6bc6a..8030615f3ebe 100644 --- a/website/docs/r/route53_resolver_rule_association.html.markdown +++ b/website/docs/r/route53_resolver_rule_association.html.markdown @@ -36,6 +36,32 @@ This resource exports the following attributes in addition to the arguments abov ## Import +In Terraform v1.12.0 and later, the [`import` block](https://developer.hashicorp.com/terraform/language/import) can be used with the `identity` attribute. For example: + +```terraform +import { + to = aws_route53_resolver_rule_association.example + identity = { + id = "rslvr-rrassoc-97242eaf88example" + } +} + +resource "aws_route53_resolver_rule_association" "example" { + ### Configuration omitted for brevity ### +} +``` + +### Identity Schema + +#### Required + +* `id` - (String) ID of the Route53 Resolver rule association. + +#### Optional + +- `account_id` (String) AWS Account where this resource is managed. +- `region` (String) Region where this resource is managed. + In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import Route53 Resolver rule associations using the `id`. For example: ```terraform diff --git a/website/docs/r/route53profiles_association.html.markdown b/website/docs/r/route53profiles_association.html.markdown index 038a1def3c90..ed8fb921b297 100644 --- a/website/docs/r/route53profiles_association.html.markdown +++ b/website/docs/r/route53profiles_association.html.markdown @@ -72,7 +72,7 @@ import { } ``` -Using `terraform import`, import Route 53 Profiles Association using the `example_id_arg`. For example: +Using `terraform import`, import Route 53 Profiles Association using the `id`. For example: ```console % terraform import aws_route53profiles_association.example rpa-id-12345678 diff --git a/website/docs/r/route53profiles_profile.html.markdown b/website/docs/r/route53profiles_profile.html.markdown index 1eb323762bdc..aa5a067a226b 100644 --- a/website/docs/r/route53profiles_profile.html.markdown +++ b/website/docs/r/route53profiles_profile.html.markdown @@ -54,7 +54,7 @@ This resource exports the following attributes in addition to the arguments abov ## Import -In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import Route 53 Profiles Profile using the `example_id_arg`. For example: +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import Route 53 Profiles Profile using the `id`. For example: ```terraform import { @@ -63,7 +63,7 @@ import { } ``` -Using `terraform import`, import Route 53 Profiles Profile using the `example`. For example: +Using `terraform import`, import Route 53 Profiles Profile using the `id`. For example: ```console % terraform import aws_route53profiles_profile.example rp-12345678 diff --git a/website/docs/r/route53profiles_resource_association.html.markdown b/website/docs/r/route53profiles_resource_association.html.markdown index 1e2b01996900..995ba99fb3d3 100644 --- a/website/docs/r/route53profiles_resource_association.html.markdown +++ b/website/docs/r/route53profiles_resource_association.html.markdown @@ -77,7 +77,7 @@ import { } ``` -Using `terraform import`, import Route 53 Profiles Resource Association using the `example_id_arg`. For example: +Using `terraform import`, import Route 53 Profiles Resource Association using the `id`. For example: ```console % terraform import aws_route53profiles_resource_association.example rpa-id-12345678 diff --git a/website/docs/r/route_table.html.markdown b/website/docs/r/route_table.html.markdown index 1e1db59ae66b..a17951bc2fc8 100644 --- a/website/docs/r/route_table.html.markdown +++ b/website/docs/r/route_table.html.markdown @@ -175,6 +175,32 @@ attribute once the route resource is created. ## Import +In Terraform v1.12.0 and later, the [`import` block](https://developer.hashicorp.com/terraform/language/import) can be used with the `identity` attribute. For example: + +```terraform +import { + to = aws_route_table.example + identity = { + id = "rtb-4e616f6d69" + } +} + +resource "aws_route_table" "example" { + ### Configuration omitted for brevity ### +} +``` + +### Identity Schema + +#### Required + +* `id` - (String) ID of the routing table. + +#### Optional + +- `account_id` (String) AWS Account where this resource is managed. +- `region` (String) Region where this resource is managed. + In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import Route Tables using the route table `id`. For example: ```terraform diff --git a/website/docs/r/s3_access_point.html.markdown b/website/docs/r/s3_access_point.html.markdown index f64bfac08817..bd8324242849 100644 --- a/website/docs/r/s3_access_point.html.markdown +++ b/website/docs/r/s3_access_point.html.markdown @@ -82,18 +82,18 @@ The following arguments are required: The following arguments are optional: -* `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). * `account_id` - (Optional) AWS account ID for the owner of the bucket for which you want to create an access point. Defaults to automatically determined account ID of the Terraform AWS provider. * `bucket_account_id` - (Optional) AWS account ID associated with the S3 bucket associated with this access point. * `policy` - (Optional) Valid JSON document that specifies the policy that you want to apply to this access point. Removing `policy` from your configuration or setting `policy` to null or an empty string (i.e., `policy = ""`) _will not_ delete the policy since it could have been set by `aws_s3control_access_point_policy`. To remove the `policy`, set it to `"{}"` (an empty JSON document). * `public_access_block_configuration` - (Optional) Configuration block to manage the `PublicAccessBlock` configuration that you want to apply to this Amazon S3 bucket. You can enable the configuration options in any combination. Detailed below. +* `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). +* `tags` - (Optional) Map of tags to assign to the bucket. 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. * `vpc_configuration` - (Optional) Configuration block to restrict access to this access point to requests from the specified Virtual Private Cloud (VPC). Required for S3 on Outposts. Detailed below. ### public_access_block_configuration Configuration Block The following arguments are optional: -* `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). * `block_public_acls` - (Optional) Whether Amazon S3 should block public ACLs for buckets in this account. Defaults to `true`. Enabling this setting does not affect existing policies or ACLs. When set to `true` causes the following behavior: * PUT Bucket acl and PUT Object acl calls fail if the specified ACL is public. * PUT Object calls fail if the request includes a public ACL. @@ -123,6 +123,7 @@ Note: S3 access points only support secure access by HTTPS. HTTP isn't supported * `has_public_access_policy` - Indicates whether this access point currently has a policy that allows public access. * `id` - For Access Point of an AWS Partition S3 Bucket, the AWS account ID and access point name separated by a colon (`:`). For S3 on Outposts Bucket, the ARN of the Access Point. * `network_origin` - Indicates whether this access point allows access from the public Internet. Values are `VPC` (the access point doesn't allow access from the public Internet) and `Internet` (the access point allows access from the public Internet, subject to the access point and bucket access policies). +* `tags_all` - Map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). ## Import diff --git a/website/docs/r/s3_bucket_logging.html.markdown b/website/docs/r/s3_bucket_logging.html.markdown index 241dd10166d2..bee87410c69b 100644 --- a/website/docs/r/s3_bucket_logging.html.markdown +++ b/website/docs/r/s3_bucket_logging.html.markdown @@ -18,6 +18,57 @@ to decide which method meets your requirements. ## Example Usage +### Grant permission by using bucket policy + +```terraform +data "aws_caller_identity" "current" {} + +resource "aws_s3_bucket" "logging" { + bucket = "access-logging-bucket" +} + +data "aws_iam_policy_document" "logging_bucket_policy" { + statement { + principals { + identifiers = ["logging.s3.amazonaws.com"] + type = "Service" + } + actions = ["s3:PutObject"] + resources = ["${aws_s3_bucket.logging.arn}/*"] + condition { + test = "StringEquals" + variable = "aws:SourceAccount" + values = [data.aws_caller_identity.current.account_id] + } + } +} + +resource "aws_s3_bucket_policy" "logging" { + bucket = aws_s3_bucket.logging.bucket + policy = data.aws_iam_policy_document.logging_bucket_policy.json +} + +resource "aws_s3_bucket" "example" { + bucket = "example-bucket" +} + +resource "aws_s3_bucket_logging" "example" { + bucket = aws_s3_bucket.example.bucket + + target_bucket = aws_s3_bucket.logging.bucket + target_prefix = "log/" + target_object_key_format { + partitioned_prefix { + partition_date_source = "EventTime" + } + } +} +``` + +### Grant permission by using bucket ACL + +The [AWS Documentation](https://docs.aws.amazon.com/AmazonS3/latest/userguide/enable-server-access-logging.html) does not recommend using the ACL. + ```terraform resource "aws_s3_bucket" "example" { bucket = "my-tf-example-bucket" @@ -77,8 +128,8 @@ The `grantee` configuration block supports the following arguments: The `target_object_key_format` configuration block supports the following arguments: -* `partitioned_prefix` - (Optional) Partitioned S3 key for log objects. [See below](#partitioned_prefix). -* `simple_prefix` - (Optional) Use the simple format for S3 keys for log objects. To use, set `simple_prefix {}`. +* `partitioned_prefix` - (Optional) Partitioned S3 key for log objects, in the form `[target_prefix][SourceAccountId]/[SourceRegion]/[SourceBucket]/[YYYY]/[MM]/[DD]/[YYYY]-[MM]-[DD]-[hh]-[mm]-[ss]-[UniqueString]`. Conflicts with `simple_prefix`. [See below](#partitioned_prefix). +* `simple_prefix` - (Optional) Use the simple format for S3 keys for log objects, in the form `[target_prefix][YYYY]-[MM]-[DD]-[hh]-[mm]-[ss]-[UniqueString]`. To use, set `simple_prefix {}`. Conflicts with `partitioned_prefix`. ### partitioned_prefix diff --git a/website/docs/r/s3_bucket_metadata_configuration.html.markdown b/website/docs/r/s3_bucket_metadata_configuration.html.markdown new file mode 100644 index 000000000000..b9ef2ba3673c --- /dev/null +++ b/website/docs/r/s3_bucket_metadata_configuration.html.markdown @@ -0,0 +1,135 @@ +--- +subcategory: "S3 (Simple Storage)" +layout: "aws" +page_title: "AWS: aws_s3_bucket_metadata_configuration" +description: |- + Manages Amazon S3 Metadata for a bucket. +--- + +# Resource: aws_s3_bucket_metadata_configuration + +Manages Amazon S3 Metadata for a bucket. + +## Example Usage + +### Basic Usage + +```terraform +resource "aws_s3_bucket_metadata_configuration" "example" { + bucket = aws_s3_bucket.example.bucket + + metadata_configuration { + inventory_table_configuration { + configuration_state = "ENABLED" + } + + journal_table_configuration { + record_expiration { + days = 7 + expiration = "ENABLED" + } + } + } +} +``` + +## Argument Reference + +The following arguments are required: + +* `bucket` - (Required) General purpose bucket that you want to create the metadata configuration for. +* `metadata_configuration` - (Required) Metadata configuration. See [`metadata_configuration` Block](#metadata_configuration-block) for details. + +The following arguments are optional: + +* `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). + +### `metadata_configuration` Block + +The `metadata_configuration` configuration block supports the following arguments: + +* `inventory_table_configuration` - (Required) Inventory table configuration. See [`inventory_table_configuration` Block](#inventory_table_configuration-block) for details. +* `journal_table_configuration` - (Required) Journal table configuration. See [`journal_table_configuration` Block](#journal_table_configuration-block) for details. + +### `inventory_table_configuration` Block + +The `inventory_table_configuration` configuration block supports the following arguments: + +* `configuration_state` - (Required) Configuration state of the inventory table, indicating whether the inventory table is enabled or disabled. Valid values: `ENABLED`, `DISABLED`. +* `encryption_configuration` - (Optional) Encryption configuration for the inventory table. See [`encryption_configuration` Block](#encryption_configuration-block) for details. + +### `journal_table_configuration` Block + +The `journal_table_configuration` configuration block supports the following arguments: + +* `encryption_configuration` - (Optional) Encryption configuration for the journal table. See [`encryption_configuration` Block](#encryption_configuration-block) for details. +* `record_expiration` - (Required) Journal table record expiration settings. See [`record_expiration` Block](#record_expiration-block) for details. + +### `encryption_configuration` Block + +The `encryption_configuration` configuration block supports the following arguments: + +* `kms_key_arn` - (Optional) KMS key ARN when `sse_algorithm` is `aws:kms`. +* `sse_algorithm` - (Required) Encryption type for the metadata table. Valid values: `aws:kms`, `AES256`. + +### `record_expiration` Block + +The `record_expiration` configuration block supports the following arguments: + +* `days` - (Optional) Number of days to retain journal table records. +* `expiration` - (Required) Whether journal table record expiration is enabled or disabled. Valid values: `ENABLED`, `DISABLED`. + +## Attribute Reference + +This resource exports the following attributes in addition to the arguments above: + +* `metadata_configuration.0.destination` - Destination information for the S3 Metadata configuration. + * `table_bucket_arn` - ARN of the table bucket where the metadata configuration is stored. + * `table_bucket_type` - Type of the table bucket where the metadata configuration is stored. + * `table_namespace` - Namespace in the table bucket where the metadata tables for the metadata configuration are stored. +* `metadata_configuration.0.inventory_table_configuration.0.table_arn` - Inventory table ARN. +* `metadata_configuration.0.inventory_table_configuration.0.table_name` - Inventory table name. +* `metadata_configuration.0.journal_table_configuration.0.table_arn` - Journal table ARN. +* `metadata_configuration.0.journal_table_configuration.0.table_name` - Journal table name. + +## Timeouts + +[Configuration options](https://developer.hashicorp.com/terraform/language/resources/syntax#operation-timeouts): + +* `create` - (Default `30m`) + +## Import + +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import S3 bucket metadata configuration using the `bucket` or using the `bucket` and `expected_bucket_owner` separated by a comma (`,`). For example: + +If the owner (account ID) of the source bucket is the same account used to configure the Terraform AWS Provider, import using the `bucket`: + +```terraform +import { + to = aws_s3_bucket_metadata_configuration.example + id = "bucket-name" +} +``` + +If the owner (account ID) of the source bucket differs from the account used to configure the Terraform AWS Provider, import using the `bucket` and `expected_bucket_owner` separated by a comma (`,`): + +```terraform +import { + to = aws_s3_bucket_metadata_configuration.example + id = "bucket-name,123456789012" +} +``` + +**Using `terraform import` to import** S3 bucket metadata configuration using the `bucket` or using the `bucket` and `expected_bucket_owner` separated by a comma (`,`). For example: + +If the owner (account ID) of the source bucket is the same account used to configure the Terraform AWS Provider, import using the `bucket`: + +```console +% terraform import aws_s3_bucket_metadata_configuration.example bucket-name +``` + +If the owner (account ID) of the source bucket differs from the account used to configure the Terraform AWS Provider, import using the `bucket` and `expected_bucket_owner` separated by a comma (`,`): + +```console +% terraform import aws_s3_bucket_metadata_configuration.example bucket-name,123456789012 +``` diff --git a/website/docs/r/s3_bucket_public_access_block.html.markdown b/website/docs/r/s3_bucket_public_access_block.html.markdown index 8eba3d2ec02b..ce15d23dabdc 100644 --- a/website/docs/r/s3_bucket_public_access_block.html.markdown +++ b/website/docs/r/s3_bucket_public_access_block.html.markdown @@ -12,6 +12,8 @@ Manages S3 bucket-level Public Access Block configuration. For more information -> This resource cannot be used with S3 directory buckets. +~> Setting `skip_destroy` to `true` means that the AWS Provider will not destroy a public access block, even when running `terraform destroy`. The configuration is thus an intentional dangling resource that is not managed by Terraform and will remain in-place in your AWS account. + ## Example Usage ```terraform @@ -36,7 +38,7 @@ This resource supports the following arguments: * `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). * `bucket` - (Required) S3 Bucket to which this Public Access Block configuration should be applied. * `block_public_acls` - (Optional) Whether Amazon S3 should block public ACLs for this bucket. Defaults to `false`. Enabling this setting does not affect existing policies or ACLs. When set to `true` causes the following behavior: - * PUT Bucket acl and PUT Object acl calls will fail if the specified ACL allows public access. + * PUT Bucket ACL and PUT Object ACL calls will fail if the specified ACL allows public access. * PUT Object calls will fail if the request includes an object ACL. * `block_public_policy` - (Optional) Whether Amazon S3 should block public bucket policies for this bucket. Defaults to `false`. Enabling this setting does not affect the existing bucket policy. When set to `true` causes Amazon S3 to: * Reject calls to PUT Bucket policy if the specified bucket policy allows public access. @@ -44,6 +46,7 @@ This resource supports the following arguments: * Ignore public ACLs on this bucket and any objects that it contains. * `restrict_public_buckets` - (Optional) Whether Amazon S3 should restrict public bucket policies for this bucket. Defaults to `false`. Enabling this setting does not affect the previously stored bucket policy, except that public and cross-account access within the public bucket policy, including non-public delegation to specific accounts, is blocked. When set to `true`: * Only the bucket owner and AWS Services can access this buckets if it has a public policy. +* `skip_destroy` - (Optional) Whether to retain the public access block upon destruction. If set to `true`, the resource is simply removed from state instead. This may be desirable in certain scenarios to prevent the removal of a public access block before deletion of the associated bucket. ## Attribute Reference diff --git a/website/docs/r/s3_object.html.markdown b/website/docs/r/s3_object.html.markdown index 2f6c142307db..4ebb570f43eb 100644 --- a/website/docs/r/s3_object.html.markdown +++ b/website/docs/r/s3_object.html.markdown @@ -167,7 +167,6 @@ The following arguments are required: The following arguments are optional: -* `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). * `acl` - (Optional) [Canned ACL](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl) to apply. Valid values are `private`, `public-read`, `public-read-write`, `aws-exec-read`, `authenticated-read`, `bucket-owner-read`, and `bucket-owner-full-control`. * `bucket_key_enabled` - (Optional) Whether or not to use [Amazon S3 Bucket Keys](https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-key.html) for SSE-KMS. * `cache_control` - (Optional) Caching behavior along the request/reply chain Read [w3c cache_control](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9) for further details. @@ -186,10 +185,11 @@ The following arguments are optional: * `object_lock_mode` - (Optional) Object lock [retention mode](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock-overview.html#object-lock-retention-modes) that you want to apply to this object. Valid values are `GOVERNANCE` and `COMPLIANCE`. * `object_lock_retain_until_date` - (Optional) Date and time, in [RFC3339 format](https://tools.ietf.org/html/rfc3339#section-5.8), when this object's object lock will [expire](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock-overview.html#object-lock-retention-periods). * `override_provider` - (Optional) Override provider-level configuration options. See [Override Provider](#override-provider) below for more details. -* `server_side_encryption` - (Optional) Server-side encryption of the object in S3. Valid values are "`AES256`" and "`aws:kms`". +* `server_side_encryption` - (Optional) Server-side encryption of the object in S3. Valid values are `"AES256"`, `"aws:kms"`, `"aws:kms:dsse"`, and `"aws:fsx"`. * `source_hash` - (Optional) Triggers updates like `etag` but useful to address `etag` encryption limitations. Set using `filemd5("path/to/source")` (Terraform 0.11.12 or later). (The value is only stored in state and not saved by AWS.) * `source` - (Optional, conflicts with `content` and `content_base64`) Path to a file that will be read and uploaded as raw bytes for the object content. * `storage_class` - (Optional) [Storage Class](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html#AmazonS3-PutObject-request-header-StorageClass) for the object. Defaults to "`STANDARD`". +* `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). * `tags` - (Optional) Map of tags to assign to the object. 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. * `website_redirect` - (Optional) Target URL for [website redirect](http://docs.aws.amazon.com/AmazonS3/latest/dev/how-to-page-redirect.html). diff --git a/website/docs/r/s3tables_table_bucket.html.markdown b/website/docs/r/s3tables_table_bucket.html.markdown index b2aeae573af3..e58a2b6aa233 100644 --- a/website/docs/r/s3tables_table_bucket.html.markdown +++ b/website/docs/r/s3tables_table_bucket.html.markdown @@ -31,11 +31,12 @@ The following arguments are required: The following arguments are optional: -* `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). * `encryption_configuration` - (Optional) A single table bucket encryption configuration object. [See `encryption_configuration` below](#encryption_configuration). +* `force_destroy` - (Optional, Default:`false`) Whether all tables and namespaces within the table bucket should be deleted *when the table bucket is destroyed* so that the table bucket can be destroyed without error. These tables and namespaces are *not* recoverable. This only deletes tables and namespaces when the table bucket is destroyed, *not* when setting this parameter to `true`. Once this parameter is set to `true`, there must be a successful `terraform apply` run before a destroy is required to update this value in the resource state. Without a successful `terraform apply` after this parameter is set, this flag will have no effect. If setting this field in the same operation that would require replacing the table bucket or destroying the table bucket, this flag will not work. Additionally when importing a table bucket, a successful `terraform apply` is required to set this value in state before it will take effect on a destroy operation. * `maintenance_configuration` - (Optional) A single table bucket maintenance configuration object. [See `maintenance_configuration` below](#maintenance_configuration). +* `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). ### `encryption_configuration` diff --git a/website/docs/r/secretsmanager_secret_version.html.markdown b/website/docs/r/secretsmanager_secret_version.html.markdown index 6919d7331a54..17fb9a21dbe1 100644 --- a/website/docs/r/secretsmanager_secret_version.html.markdown +++ b/website/docs/r/secretsmanager_secret_version.html.markdown @@ -81,6 +81,34 @@ This resource exports the following attributes in addition to the arguments abov ## Import +In Terraform v1.12.0 and later, the [`import` block](https://developer.hashicorp.com/terraform/language/import) can be used with the `identity` attribute. For example: + +```terraform +import { + to = aws_secretsmanager_secret_version.example + identity = { + secret_id = "arn:aws:secretsmanager:us-east-1:123456789012:secret:example-123456" + version_id = "xxxxx-xxxxxxx-xxxxxxx-xxxxx" + } +} + +resource "aws_secretsmanager_secret_version" "example" { + ### Configuration omitted for brevity ### +} +``` + +### Identity Schema + +#### Required + +* `secret_id` - (String) ID of the secret. +* `version_id` - (String) ID of the secret version. + +#### Optional + +- `account_id` (String) AWS Account where this resource is managed. +- `region` (String) Region where this resource is managed. + In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import `aws_secretsmanager_secret_version` using the secret ID and version ID. For example: ```terraform diff --git a/website/docs/r/securityhub_standards_subscription.html.markdown b/website/docs/r/securityhub_standards_subscription.html.markdown index abea85bc7379..497bc4bdb212 100644 --- a/website/docs/r/securityhub_standards_subscription.html.markdown +++ b/website/docs/r/securityhub_standards_subscription.html.markdown @@ -45,7 +45,9 @@ Currently available standards (remember to replace `${var.partition}` and `${var | CIS AWS Foundations Benchmark v1.4.0 | `arn:${var.partition}:securityhub:${var.region}::standards/cis-aws-foundations-benchmark/v/1.4.0` | | CIS AWS Foundations Benchmark v3.0.0 | `arn:${var.partition}:securityhub:${var.region}::standards/cis-aws-foundations-benchmark/v/3.0.0` | | NIST SP 800-53 Rev. 5 | `arn:${var.partition}:securityhub:${var.region}::standards/nist-800-53/v/5.0.0` | -| PCI DSS | `arn:${var.partition}:securityhub:${var.region}::standards/pci-dss/v/3.2.1` | +| NIST SP 800-171 Rev. 2 | `arn:${var.partition}:securityhub:${var.region}::standards/nist-800-171/v/2.0.0` | +| PCI DSS v3.2.1 | `arn:${var.partition}:securityhub:${var.region}::standards/pci-dss/v/3.2.1` | +| PCI DSS v4.0.1 | `arn:${var.partition}:securityhub:${var.region}::standards/pci-dss/v/4.0.1` | ## Attribute Reference diff --git a/website/docs/r/securitylake_subscriber.html.markdown b/website/docs/r/securitylake_subscriber.html.markdown index d8c5990670b7..1683668256bc 100644 --- a/website/docs/r/securitylake_subscriber.html.markdown +++ b/website/docs/r/securitylake_subscriber.html.markdown @@ -14,6 +14,8 @@ Terraform resource for managing an AWS Security Lake Subscriber. ## Example Usage +### Basic Usage + ```terraform resource "aws_securitylake_subscriber" "example" { subscriber_name = "example-name" @@ -34,6 +36,36 @@ resource "aws_securitylake_subscriber" "example" { } ``` +### Multiple Log Sources + +```terraform +resource "aws_securitylake_subscriber" "example" { + subscriber_name = "example-name" + access_type = "S3" + + source { + aws_log_source_resource { + source_name = "SH_FINDINGS" + source_version = "2.0" + } + } + + source { + aws_log_source_resource { + source_name = "ROUTE53" + source_version = "2.0" + } + } + + subscriber_identity { + external_id = "example" + principal = "1234567890" + } + + depends_on = [aws_securitylake_data_lake.example] +} +``` + ## Argument Reference This resource supports the following arguments: @@ -64,8 +96,8 @@ The `subscriber_identity` block supports the following arguments: The `aws_log_source_resource` block supports the following arguments: -* `source_name` - (Required) Provides data expiration details of Amazon Security Lake object. -* `source_version` - (Optional) Provides data storage transition details of Amazon Security Lake object. +* `source_name` - (Required) The name for a AWS source. This must be a Regionally unique value. Valid values: `ROUTE53`, `VPC_FLOW`, `SH_FINDINGS`, `CLOUD_TRAIL_MGMT`, `LAMBDA_EXECUTION`, `S3_DATA`, `EKS_AUDIT` and `WAF`. +* `source_version` - (Optional) The version for a AWS source. This must be a Regionally unique value. ### `custom_log_source_resource` Block diff --git a/website/docs/r/sesv2_configuration_set_event_destination.html.markdown b/website/docs/r/sesv2_configuration_set_event_destination.html.markdown index 3b84931b8570..310ec564cd00 100644 --- a/website/docs/r/sesv2_configuration_set_event_destination.html.markdown +++ b/website/docs/r/sesv2_configuration_set_event_destination.html.markdown @@ -143,7 +143,7 @@ The `event_destination` configuration block supports the following arguments: * `matching_event_types` - (Required) - An array that specifies which events the Amazon SES API v2 should send to the destinations. Valid values: `SEND`, `REJECT`, `BOUNCE`, `COMPLAINT`, `DELIVERY`, `OPEN`, `CLICK`, `RENDERING_FAILURE`, `DELIVERY_DELAY`, `SUBSCRIPTION`. * `cloud_watch_destination` - (Optional) An object that defines an Amazon CloudWatch destination for email events. See [`cloud_watch_destination` Block](#cloud_watch_destination-block) for details. * `enabled` - (Optional) When the event destination is enabled, the specified event types are sent to the destinations. Default: `false`. -* `event_bridge_configuration` - (Optional) An object that defines an Amazon EventBridge destination for email events. You can use Amazon EventBridge to send notifications when certain email events occur. See [`event_bridge_configuration` Block](#event_bridge_configuration-block) for details. +* `event_bridge_destination` - (Optional) An object that defines an Amazon EventBridge destination for email events. You can use Amazon EventBridge to send notifications when certain email events occur. See [`event_bridge_destination` Block](#event_bridge_destination-block) for details. * `kinesis_firehose_destination` - (Optional) An object that defines an Amazon Kinesis Data Firehose destination for email events. See [`kinesis_firehose_destination` Block](#kinesis_firehose_destination-block) for details. * `pinpoint_destination` - (Optional) An object that defines an Amazon Pinpoint project destination for email events. See [`pinpoint_destination` Block](#pinpoint_destination-block) for details. * `sns_destination` - (Optional) An object that defines an Amazon SNS destination for email events. See [`sns_destination` Block](#sns_destination-block) for details. @@ -162,9 +162,9 @@ The `dimension_configuration` configuration block supports the following argumen * `dimension_name` - (Required) The name of an Amazon CloudWatch dimension associated with an email sending metric. * `dimension_value_source` - (Required) The location where the Amazon SES API v2 finds the value of a dimension to publish to Amazon CloudWatch. Valid values: `MESSAGE_TAG`, `EMAIL_HEADER`, `LINK_TAG`. -### `event_bridge_configuration` Block +### `event_bridge_destination` Block -The `event_bridge_configuration` configuration block supports the following arguments: +The `event_bridge_destination` configuration block supports the following arguments: * `event_bus_arn` - (Required) The Amazon Resource Name (ARN) of the Amazon EventBridge bus to publish email events to. Only the default bus is supported. diff --git a/website/docs/r/sesv2_email_identity.html.markdown b/website/docs/r/sesv2_email_identity.html.markdown index 02f4adeb463c..290d565509f2 100644 --- a/website/docs/r/sesv2_email_identity.html.markdown +++ b/website/docs/r/sesv2_email_identity.html.markdown @@ -92,6 +92,7 @@ This resource exports the following attributes in addition to the arguments abov * `tokens` - If you used Easy DKIM to configure DKIM authentication for the domain, then this object contains a set of unique strings that you use to create a set of CNAME records that you add to the DNS configuration for your domain. When Amazon SES detects these records in the DNS configuration for your domain, the DKIM authentication process is complete. If you configured DKIM authentication for the domain by providing your own public-private key pair, then this object contains the selector for the public key. * `identity_type` - The email identity type. Valid values: `EMAIL_ADDRESS`, `DOMAIN`. * `tags_all` - Map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block). +* `verification_status` - The verification status of the identity. The status can be one of the following: `PENDING`, `SUCCESS`, `FAILED`, `TEMPORARY_FAILURE`, and `NOT_STARTED`. * `verified_for_sending_status` - Specifies whether or not the identity is verified. ## Import diff --git a/website/docs/r/sesv2_email_identity_policy.html.markdown b/website/docs/r/sesv2_email_identity_policy.html.markdown index 9ca457d961f3..5b1d5c718ea0 100644 --- a/website/docs/r/sesv2_email_identity_policy.html.markdown +++ b/website/docs/r/sesv2_email_identity_policy.html.markdown @@ -63,7 +63,7 @@ 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 SESv2 (Simple Email V2) Email Identity Policy using the `id` (`email_identity|policy_name`). For example: +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import SESv2 (Simple Email V2) Email Identity Policy using the `email_identity` and `policy_name` separated by `|`. For example: ```terraform import { @@ -72,7 +72,7 @@ import { } ``` -Using `terraform import`, import SESv2 (Simple Email V2) Email Identity Policy using the `example_id_arg`. For example: +Using `terraform import`, import SESv2 (Simple Email V2) Email Identity Policy using the `email_identity` and `policy_name` separated by `|`. For example: ```console % terraform import aws_sesv2_email_identity_policy.example example_email_identity|example_policy_name diff --git a/website/docs/r/signer_signing_profile.html.markdown b/website/docs/r/signer_signing_profile.html.markdown index 00c1341ff5c5..11aaebd88c61 100644 --- a/website/docs/r/signer_signing_profile.html.markdown +++ b/website/docs/r/signer_signing_profile.html.markdown @@ -43,6 +43,7 @@ This resource supports the following arguments: * `name_prefix` - (Optional, Forces new resource) A signing profile name prefix. Terraform will generate a unique suffix. Conflicts with `name`. * `signature_validity_period` - (Optional, Forces new resource) The validity period for a signing job. See [`signature_validity_period` Block](#signature_validity_period-block) below for details. * `signing_material` - (Optional, Forces new resource) The AWS Certificate Manager certificate that will be used to sign code with the new signing profile. See [`signing_material` Block](#signing_material-block) below for details. +* `signing_parameters` - (Optional, Forces new resource) Map of key-value pairs for signing. These can include any information that you want to use during signing. * `tags` - (Optional) A list of tags associated with the signing profile. 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. ### `signature_validity_period` Block diff --git a/website/docs/r/spot_instance_request.html.markdown b/website/docs/r/spot_instance_request.html.markdown index 7a806200654b..5d1ba5c41118 100644 --- a/website/docs/r/spot_instance_request.html.markdown +++ b/website/docs/r/spot_instance_request.html.markdown @@ -25,8 +25,8 @@ price availability or by a user. ~> **NOTE:** Because their behavior depends on the live status of the spot market, Spot Instance Requests have a unique lifecycle that makes them behave -differently than other Terraform resources. Most importantly: there is __no -guarantee__ that a Spot Instance exists to fulfill the request at any given +differently than other Terraform resources. Most importantly: there is **no +guarantee** that a Spot Instance exists to fulfill the request at any given point in time. See the [AWS Spot Instance documentation](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-spot-instances.html) for more information. @@ -54,7 +54,9 @@ resource "aws_spot_instance_request" "cheap_worker" { This resource supports the following arguments: * `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). + Spot Instance Requests support all the same arguments as [`aws_instance`](instance.html), with the addition of: + * `spot_price` - (Optional; Default: On-demand price) The maximum price to request on the spot market. * `wait_for_fulfillment` - (Optional; Default: false) If set, Terraform will wait for the Spot Request to be fulfilled, and will throw an error if the @@ -73,9 +75,9 @@ Spot Instance Requests support all the same arguments as [`aws_instance`](instan This resource exports the following attributes in addition to the arguments above: * `id` - The Spot Instance Request ID. +* `tags_all` - A map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). -These attributes are exported, but they are expected to change over time and so -should only be used for informational purposes, not for resource dependencies: +The following attributes are exported, but they are expected to change over time and so should only be used for informational purposes, not for resource dependencies: * `spot_bid_status` - The current [bid status](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-bid-status.html) @@ -92,7 +94,6 @@ should only be used for informational purposes, not for resource dependencies: used inside the Amazon EC2, and only available if you've enabled DNS hostnames for your VPC * `private_ip` - The private IP address assigned to the instance -* `tags_all` - A map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). ## Timeouts diff --git a/website/docs/r/sqs_queue.html.markdown b/website/docs/r/sqs_queue.html.markdown index 3ed744e70025..c147586af4b9 100644 --- a/website/docs/r/sqs_queue.html.markdown +++ b/website/docs/r/sqs_queue.html.markdown @@ -112,7 +112,7 @@ This resource supports the following arguments: * `fifo_throughput_limit` - (Optional) Specifies whether the FIFO queue throughput quota applies to the entire queue or per message group. Valid values are `perQueue` (default) and `perMessageGroupId`. * `kms_data_key_reuse_period_seconds` - (Optional) Length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling AWS KMS again. An integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). The default is 300 (5 minutes). * `kms_master_key_id` - (Optional) ID of an AWS-managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see [Key Terms](http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms). -* `max_message_size` - (Optional) Limit of how many bytes a message can contain before Amazon SQS rejects it. An integer from 1024 bytes (1 KiB) up to 262144 bytes (256 KiB). The default for this attribute is 262144 (256 KiB). +* `max_message_size` - (Optional) Limit of how many bytes a message can contain before Amazon SQS rejects it. An integer from 1024 bytes (1 KiB) up to 1048576 bytes (1024 KiB). The default for this attribute is 262144 (256 KiB). * `message_retention_seconds` - (Optional) Number of seconds Amazon SQS retains a message. Integer representing seconds, from 60 (1 minute) to 1209600 (14 days). The default for this attribute is 345600 (4 days). * `name` - (Optional) Name of the queue. Queue names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 80 characters long. For a FIFO (first-in-first-out) queue, the name must end with the `.fifo` suffix. If omitted, Terraform will assign a random, unique name. Conflicts with `name_prefix`. * `name_prefix` - (Optional) Creates a unique name beginning with the specified prefix. Conflicts with `name`. diff --git a/website/docs/r/ssm_association.html.markdown b/website/docs/r/ssm_association.html.markdown index a2836c812317..ba9d7cda965a 100644 --- a/website/docs/r/ssm_association.html.markdown +++ b/website/docs/r/ssm_association.html.markdown @@ -81,7 +81,7 @@ resource "aws_ssm_association" "example" { ### Create an association with multiple instances with their instance ids -``` +```terraform # Removed EC2 provisioning dependencies for brevity resource "aws_ssm_association" "system_update" { @@ -164,13 +164,13 @@ resource "aws_instance" "web_server_2" { ### Create an association with multiple instances with their values matching their tags -``` +```terraform # SSM Association for Webbased Servers resource "aws_ssm_association" "database_association" { name = aws_ssm_document.system_update.name # Use the name of the document as the association name targets { key = "tag:Role" - values = ["WebServer","Database"] + values = ["WebServer", "Database"] } parameters = { @@ -182,7 +182,7 @@ resource "aws_ssm_association" "database_association" { # EC2 Instance 1 - Web Server with "ServerType" tag resource "aws_instance" "web_server" { ami = data.aws_ami.amazon_linux.id - instance_type = var.instance_type + instance_type = "t3.micro" subnet_id = data.aws_subnet.default.id vpc_security_group_ids = [aws_security_group.ec2_sg.id] iam_instance_profile = aws_iam_instance_profile.ec2_ssm_profile.name @@ -214,7 +214,7 @@ resource "aws_instance" "web_server" { # EC2 Instance 2 - Database Server with "Role" tag resource "aws_instance" "database_server" { ami = data.aws_ami.amazon_linux.id - instance_type = var.instance_type + instance_type = "t3.micro" subnet_id = data.aws_subnet.default.id vpc_security_group_ids = [aws_security_group.ec2_sg.id] iam_instance_profile = aws_iam_instance_profile.ec2_ssm_profile.name @@ -286,11 +286,37 @@ This resource exports the following attributes in addition to the arguments abov ## Import +In Terraform v1.12.0 and later, the [`import` block](https://developer.hashicorp.com/terraform/language/import) can be used with the `identity` attribute. For example: + +```terraform +import { + to = aws_ssm_association.example + identity = { + association_id = "10abcdef-0abc-1234-5678-90abcdef123456" + } +} + +resource "aws_ssm_association" "example" { + ### Configuration omitted for brevity ### +} +``` + +### Identity Schema + +#### Required + +* `association_id` - (String) ID of the SSM association. + +#### Optional + +- `account_id` (String) AWS Account where this resource is managed. +- `region` (String) Region where this resource is managed. + In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import SSM associations using the `association_id`. For example: ```terraform import { - to = aws_ssm_association.test-association + to = aws_ssm_association.example id = "10abcdef-0abc-1234-5678-90abcdef123456" } ``` @@ -298,5 +324,5 @@ import { Using `terraform import`, import SSM associations using the `association_id`. For example: ```console -% terraform import aws_ssm_association.test-association 10abcdef-0abc-1234-5678-90abcdef123456 +% terraform import aws_ssm_association.example 10abcdef-0abc-1234-5678-90abcdef123456 ``` diff --git a/website/docs/r/ssm_document.html.markdown b/website/docs/r/ssm_document.html.markdown index d0b6ecf61cd4..bdd2ec686630 100644 --- a/website/docs/r/ssm_document.html.markdown +++ b/website/docs/r/ssm_document.html.markdown @@ -132,6 +132,32 @@ The `parameter` configuration block provides the following attributes: ## Import +In Terraform v1.12.0 and later, the [`import` block](https://developer.hashicorp.com/terraform/language/import) can be used with the `identity` attribute. For example: + +```terraform +import { + to = aws_ssm_document.example + identity = { + name = "example" + } +} + +resource "aws_ssm_document" "example" { + ### Configuration omitted for brevity ### +} +``` + +### Identity Schema + +#### Required + +* `name` - (String) Name of the SSM document. + +#### Optional + +- `account_id` (String) AWS Account where this resource is managed. +- `region` (String) Region where this resource is managed. + In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import SSM Documents using the name. For example: ```terraform diff --git a/website/docs/r/ssm_maintenance_window.html.markdown b/website/docs/r/ssm_maintenance_window.html.markdown index 06697e3fbd09..99ce381c2af6 100644 --- a/website/docs/r/ssm_maintenance_window.html.markdown +++ b/website/docs/r/ssm_maintenance_window.html.markdown @@ -48,11 +48,37 @@ This resource exports the following attributes in addition to the arguments abov ## Import +In Terraform v1.12.0 and later, the [`import` block](https://developer.hashicorp.com/terraform/language/import) can be used with the `identity` attribute. For example: + +```terraform +import { + to = aws_ssm_maintenance_window.example + identity = { + id = "mw-0123456789" + } +} + +resource "aws_ssm_maintenance_window" "example" { + ### Configuration omitted for brevity ### +} +``` + +### Identity Schema + +#### Required + +* `id` - (String) ID of the maintenance window. + +#### Optional + +- `account_id` (String) AWS Account where this resource is managed. +- `region` (String) Region where this resource is managed. + In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import SSM Maintenance Windows using the maintenance window `id`. For example: ```terraform import { - to = aws_ssm_maintenance_window.imported-window + to = aws_ssm_maintenance_window.example id = "mw-0123456789" } ``` @@ -60,5 +86,5 @@ import { Using `terraform import`, import SSM Maintenance Windows using the maintenance window `id`. For example: ```console -% terraform import aws_ssm_maintenance_window.imported-window mw-0123456789 +% terraform import aws_ssm_maintenance_window.example mw-0123456789 ``` diff --git a/website/docs/r/ssm_maintenance_window_target.html.markdown b/website/docs/r/ssm_maintenance_window_target.html.markdown index 988df4649728..db2ca8af7962 100644 --- a/website/docs/r/ssm_maintenance_window_target.html.markdown +++ b/website/docs/r/ssm_maintenance_window_target.html.markdown @@ -79,6 +79,34 @@ This resource exports the following attributes in addition to the arguments abov ## Import +In Terraform v1.12.0 and later, the [`import` block](https://developer.hashicorp.com/terraform/language/import) can be used with the `identity` attribute. For example: + +```terraform +import { + to = aws_ssm_maintenance_window_target.example + identity = { + window_id = "mw-0c50858d01EXAMPLE" + id = "23639a0b-ddbc-4bca-9e72-78d96EXAMPLE" + } +} + +resource "aws_ssm_maintenance_window_target" "example" { + ### Configuration omitted for brevity ### +} +``` + +### Identity Schema + +#### Required + +* `window_id` - (String) ID of the maintenance window. +* `id` - (String) ID of the maintenance window target. + +#### Optional + +- `account_id` (String) AWS Account where this resource is managed. +- `region` (String) Region where this resource is managed. + In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import SSM Maintenance Window targets using `WINDOW_ID/WINDOW_TARGET_ID`. For example: ```terraform diff --git a/website/docs/r/ssm_maintenance_window_task.html.markdown b/website/docs/r/ssm_maintenance_window_task.html.markdown index 5bce6e9c79ab..4a81183163ac 100644 --- a/website/docs/r/ssm_maintenance_window_task.html.markdown +++ b/website/docs/r/ssm_maintenance_window_task.html.markdown @@ -209,11 +209,39 @@ This resource exports the following attributes in addition to the arguments abov ## Import +In Terraform v1.12.0 and later, the [`import` block](https://developer.hashicorp.com/terraform/language/import) can be used with the `identity` attribute. For example: + +```terraform +import { + to = aws_ssm_maintenance_window_task.example + identity = { + window_id = "mw-0c50858d01EXAMPLE" + id = "4f7ca192-7e9a-40fe-9192-5cb15EXAMPLE" + } +} + +resource "aws_ssm_maintenance_window_task" "example" { + ### Configuration omitted for brevity ### +} +``` + +### Identity Schema + +#### Required + +* `window_id` - (String) ID of the maintenance window. +* `id` - (String) ID of the maintenance window task. + +#### Optional + +- `account_id` (String) AWS Account where this resource is managed. +- `region` (String) Region where this resource is managed. + In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import AWS Maintenance Window Task using the `window_id` and `window_task_id` separated by `/`. For example: ```terraform import { - to = aws_ssm_maintenance_window_task.task + to = aws_ssm_maintenance_window_task.example id = "/" } ``` @@ -221,5 +249,5 @@ import { Using `terraform import`, import AWS Maintenance Window Task using the `window_id` and `window_task_id` separated by `/`. For example: ```console -% terraform import aws_ssm_maintenance_window_task.task / +% terraform import aws_ssm_maintenance_window_task.example / ``` diff --git a/website/docs/r/ssm_parameter.html.markdown b/website/docs/r/ssm_parameter.html.markdown index 788cc7dcb976..2cdb22aa4a43 100644 --- a/website/docs/r/ssm_parameter.html.markdown +++ b/website/docs/r/ssm_parameter.html.markdown @@ -92,11 +92,37 @@ This resource exports the following attributes in addition to the arguments abov ## Import +In Terraform v1.12.0 and later, the [`import` block](https://developer.hashicorp.com/terraform/language/import) can be used with the `identity` attribute. For example: + +```terraform +import { + to = aws_ssm_parameter.example + identity = { + name = "/my_path/my_paramname" + } +} + +resource "aws_ssm_parameter" "example" { + ### Configuration omitted for brevity ### +} +``` + +### Identity Schema + +#### Required + +* `name` - (String) Name of the parameter. + +#### Optional + +- `account_id` (String) AWS Account where this resource is managed. +- `region` (String) Region where this resource is managed. + In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import SSM Parameters using the parameter store `name`. For example: ```terraform import { - to = aws_ssm_parameter.my_param + to = aws_ssm_parameter.example id = "/my_path/my_paramname" } ``` @@ -104,5 +130,5 @@ import { Using `terraform import`, import SSM Parameters using the parameter store `name`. For example: ```console -% terraform import aws_ssm_parameter.my_param /my_path/my_paramname +% terraform import aws_ssm_parameter.example /my_path/my_paramname ``` diff --git a/website/docs/r/ssm_patch_baseline.html.markdown b/website/docs/r/ssm_patch_baseline.html.markdown index 78cb3bec2fa1..e2cc256485a0 100644 --- a/website/docs/r/ssm_patch_baseline.html.markdown +++ b/website/docs/r/ssm_patch_baseline.html.markdown @@ -169,6 +169,7 @@ The following arguments are optional: * `approved_patches_compliance_level` - (Optional) Compliance level for approved patches. This means that if an approved patch is reported as missing, this is the severity of the compliance violation. Valid values are `CRITICAL`, `HIGH`, `MEDIUM`, `LOW`, `INFORMATIONAL`, `UNSPECIFIED`. The default value is `UNSPECIFIED`. * `approved_patches_enable_non_security` - (Optional) Whether the list of approved patches includes non-security updates that should be applied to the instances. Applies to Linux instances only. * `approved_patches` - (Optional) List of explicitly approved patches for the baseline. Cannot be specified with `approval_rule`. +* `available_security_updates_compliance_status` - (Optional) Indicates the compliance status of managed nodes for which security-related patches are available but were not approved. Supported for Windows Server managed nodes only. Valid values are `COMPLIANT`, `NON_COMPLIANT`. * `description` - (Optional) Description of the patch baseline. * `global_filter` - (Optional) Set of global filters used to exclude patches from the baseline. Up to 4 global filters can be specified using Key/Value pairs. Valid Keys are `PRODUCT`, `CLASSIFICATION`, `MSRC_SEVERITY`, and `PATCH_ID`. * `operating_system` - (Optional) Operating system the patch baseline applies to. Valid values are `ALMA_LINUX`, `AMAZON_LINUX`, `AMAZON_LINUX_2`, `AMAZON_LINUX_2022`, `AMAZON_LINUX_2023`, `CENTOS`, `DEBIAN`, `MACOS`, `ORACLE_LINUX`, `RASPBIAN`, `REDHAT_ENTERPRISE_LINUX`, `ROCKY_LINUX`, `SUSE`, `UBUNTU`, and `WINDOWS`. The default value is `WINDOWS`. @@ -206,6 +207,32 @@ This resource exports the following attributes in addition to the arguments abov ## Import +In Terraform v1.12.0 and later, the [`import` block](https://developer.hashicorp.com/terraform/language/import) can be used with the `identity` attribute. For example: + +```terraform +import { + to = aws_ssm_patch_baseline.example + identity = { + id = "pb-12345678" + } +} + +resource "aws_ssm_patch_baseline" "example" { + ### Configuration omitted for brevity ### +} +``` + +### Identity Schema + +#### Required + +* `id` - (String) ID of the patch baseline. + +#### Optional + +- `account_id` (String) AWS Account where this resource is managed. +- `region` (String) Region where this resource is managed. + In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import SSM Patch Baselines using their baseline ID. For example: ```terraform diff --git a/website/docs/r/ssm_service_setting.html.markdown b/website/docs/r/ssm_service_setting.html.markdown index 1e8b0ad9dd45..798f4e5ad8a4 100644 --- a/website/docs/r/ssm_service_setting.html.markdown +++ b/website/docs/r/ssm_service_setting.html.markdown @@ -24,7 +24,7 @@ resource "aws_ssm_service_setting" "test_setting" { This resource supports the following arguments: * `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). -* `setting_id` - (Required) ID of the service setting. +* `setting_id` - (Required) ID of the service setting. Valid values are shown in the [AWS documentation](https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_GetServiceSetting.html#API_GetServiceSetting_RequestSyntax). * `setting_value` - (Required) Value of the service setting. ## Attribute Reference diff --git a/website/docs/r/synthetics_canary.html.markdown b/website/docs/r/synthetics_canary.html.markdown index 659ce7b50a4e..ebb1c6c5cb0a 100644 --- a/website/docs/r/synthetics_canary.html.markdown +++ b/website/docs/r/synthetics_canary.html.markdown @@ -36,7 +36,7 @@ The following arguments are required: * `artifact_s3_location` - (Required) Location in Amazon S3 where Synthetics stores artifacts from the test runs of this canary. * `execution_role_arn` - (Required) ARN of the IAM role to be used to run the canary. see [AWS Docs](https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_CreateCanary.html#API_CreateCanary_RequestSyntax) for permissions needs for IAM Role. * `handler` - (Required) Entry point to use for the source code when running the canary. This value must end with the string `.handler` . -* `name` - (Required) Name for this canary. Has a maximum length of 21 characters. Valid characters are lowercase alphanumeric, hyphen, or underscore. +* `name` - (Required) Name for this canary. Has a maximum length of 255 characters. Valid characters are lowercase alphanumeric, hyphen, or underscore. * `runtime_version` - (Required) Runtime version to use for the canary. Versions change often so consult the [Amazon CloudWatch documentation](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Library.html) for the latest valid versions. Values include `syn-python-selenium-1.0`, `syn-nodejs-puppeteer-3.0`, `syn-nodejs-2.2`, `syn-nodejs-2.1`, `syn-nodejs-2.0`, and `syn-1.0`. * `schedule` - (Required) Configuration block providing how often the canary is to run and when these test runs are to stop. Detailed below. @@ -76,6 +76,7 @@ The following arguments are optional: * `memory_in_mb` - (Optional) Maximum amount of memory available to the canary while it is running, in MB. The value you specify must be a multiple of 64. * `active_tracing` - (Optional) Whether this canary is to use active AWS X-Ray tracing when it runs. You can enable active tracing only for canaries that use version syn-nodejs-2.0 or later for their canary runtime. * `environment_variables` - (Optional) Map of environment variables that are accessible from the canary during execution. Please see [AWS Docs](https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html#configuration-envvars-runtime) for variables reserved for Lambda. +* `ephemeral_storage` - (Optional) Amount of ephemeral storage (in MB) allocated for the canary run during execution. Defaults to 1024. ### vpc_config @@ -83,6 +84,7 @@ If this canary tests an endpoint in a VPC, this structure contains information a * `subnet_ids` - (Required) IDs of the subnets where this canary is to run. * `security_group_ids` - (Required) IDs of the security groups for this canary. +* `ipv6_allowed_for_dual_stack` - (Optional) If `true`, allow outbound IPv6 traffic on VPC canaries that are connected to dual-stack subnets. The default is `false`. ## Attribute Reference diff --git a/website/docs/r/timestreaminfluxdb_db_cluster.html.markdown b/website/docs/r/timestreaminfluxdb_db_cluster.html.markdown new file mode 100644 index 000000000000..e7bdb8e8678a --- /dev/null +++ b/website/docs/r/timestreaminfluxdb_db_cluster.html.markdown @@ -0,0 +1,265 @@ +--- +subcategory: "Timestream for InfluxDB" +layout: "aws" +page_title: "AWS: aws_timestreaminfluxdb_db_cluster" +description: |- + Terraform resource for managing an Amazon Timestream for InfluxDB read-replica cluster. +--- + +# Resource: aws_timestreaminfluxdb_db_cluster + +Terraform resource for managing an Amazon Timestream for InfluxDB read-replica cluster. + +~> **NOTE:** This resource requires a subscription to [Timestream for InfluxDB Read Replicas (Add-On) on the AWS Marketplace](https://aws.amazon.com/marketplace/pp/prodview-lftzfxtb5xlv4?applicationId=AWS-Marketplace-Console&ref_=beagle&sr=0-2). + +## Example Usage + +### Basic Usage + +```terraform +resource "aws_timestreaminfluxdb_db_cluster" "example" { + allocated_storage = 20 + bucket = "example-bucket-name" + db_instance_type = "db.influx.medium" + failover_mode = "AUTOMATIC" + username = "admin" + password = "example-password" + port = 8086 + organization = "organization" + vpc_subnet_ids = [aws_subnet.example_1.id, aws_subnet.example_2.id] + vpc_security_group_ids = [aws_security_group.example.id] + name = "example-db-cluster" +} +``` + +### Usage with Prerequisite Resources + +All Timestream for InfluxDB clusters require a VPC, at least two subnets, and a security group. The following example shows how these prerequisite resources can be created and used with `aws_timestreaminfluxdb_db_cluster`. + +```terraform +resource "aws_vpc" "example" { + cidr_block = "10.0.0.0/16" +} + +resource "aws_subnet" "example_1" { + vpc_id = aws_vpc.example.id + cidr_block = "10.0.1.0/24" +} + +resource "aws_subnet" "example_2" { + vpc_id = aws_vpc.example.id + cidr_block = "10.0.2.0/24" +} + +resource "aws_security_group" "example" { + name = "example" + vpc_id = aws_vpc.example.id +} + +resource "aws_timestreaminfluxdb_db_cluster" "example" { + allocated_storage = 20 + bucket = "example-bucket-name" + db_instance_type = "db.influx.medium" + username = "admin" + password = "example-password" + organization = "organization" + vpc_subnet_ids = [aws_subnet.example_1.id, aws_subnet.example_2.id] + vpc_security_group_ids = [aws_security_group.example.id] + name = "example-db-cluster" +} +``` + +### Usage with Public Internet Access Enabled + +The following configuration shows how to define the necessary resources and arguments to allow public internet access on your Timestream for InfluxDB read-replica cluster's primary endpoint (simply referred to as "endpoint") and read endpoint on port `8086`. After applying this configuration, the cluster's InfluxDB UI can be accessed by visiting your cluster's primary endpoint at port `8086`. + +```terraform +resource "aws_vpc" "example" { + cidr_block = "10.0.0.0/16" +} + +resource "aws_subnet" "example_1" { + vpc_id = aws_vpc.example.id + cidr_block = "10.0.1.0/24" +} + +resource "aws_subnet" "example_2" { + vpc_id = aws_vpc.example.id + cidr_block = "10.0.2.0/24" +} + +resource "aws_security_group" "example" { + name = "example" + vpc_id = aws_vpc.example.id +} + +resource "aws_internet_gateway" "example" { + vpc_id = aws_vpc.example.id + + tags = { + Name = "example" + } +} + +resource "aws_route" "test_route" { + route_table_id = aws_vpc.example.main_route_table_id + destination_cidr_block = "0.0.0.0/0" + gateway_id = aws_internet_gateway.example.id +} + +resource "aws_route_table_association" "test_route_table_association" { + subnet_id = aws_subnet.test_subnet.id + route_table_id = aws_vpc.example.main_route_table_id +} + +resource "aws_vpc_security_group_ingress_rule" "example" { + security_group_id = aws_security_group.example.id + referenced_security_group_id = aws_security_group.example.id + ip_protocol = -1 +} + +resource "aws_vpc_security_group_ingress_rule" "example" { + security_group_id = aws_security_group.example.id + cidr_ipv4 = "0.0.0.0/0" + ip_protocol = "tcp" + from_port = 8086 + to_port = 8086 +} + +resource "aws_timestreaminfluxdb_db_cluster" "example" { + allocated_storage = 20 + bucket = "example-bucket-name" + db_instance_type = "db.influx.medium" + username = "admin" + password = "example-password" + organization = "organization" + vpc_subnet_ids = [aws_subnet.example_1.id, aws_subnet.example_2.id] + vpc_security_group_ids = [aws_security_group.example.id] + name = "example-db-cluster" + publicly_accessible = true # False by default +} +``` + +### Usage with S3 Log Delivery Enabled + +You can use an S3 bucket to store logs generated by your Timestream for InfluxDB cluster. The following example shows what resources and arguments are required to configure an S3 bucket for logging, including the IAM policy that needs to be set in order to allow Timestream for InfluxDB to place logs in your S3 bucket. The configuration of the required VPC, security group, and subnets have been left out of the example for brevity. + +```terraform +resource "aws_s3_bucket" "example" { + bucket = "example-s3-bucket" + force_destroy = true +} + +data "aws_iam_policy_document" "example" { + statement { + actions = ["s3:PutObject"] + principals { + type = "Service" + identifiers = ["timestream-influxdb.amazonaws.com"] + } + resources = [ + "${aws_s3_bucket.example.arn}/*" + ] + } +} + +resource "aws_s3_bucket_policy" "example" { + bucket = aws_s3_bucket.example.id + policy = data.aws_iam_policy_document.example.json +} + +resource "aws_timestreaminfluxdb_db_cluster" "example" { + allocated_storage = 20 + bucket = "example-bucket-name" + db_instance_type = "db.influx.medium" + username = "admin" + password = "example-password" + organization = "organization" + vpc_subnet_ids = [aws_subnet.example_1.id, aws_subnet.example_2.id] + vpc_security_group_ids = [aws_security_group.example.id] + name = "example-db-cluster" + + log_delivery_configuration { + s3_configuration { + bucket_name = aws_s3_bucket.example.bucket + enabled = true + } + } +} +``` + +## Argument Reference + +The following arguments are required: + +* `allocated_storage` - (Required) Amount of storage in GiB (gibibytes). The minimum value is `20`, the maximum value is `16384`. The argument `db_storage_type` places restrictions on this argument's minimum value. The following is a list of `db_storage_type` values and the corresponding minimum value for `allocated_storage`: `"InfluxIOIncludedT1": `20`, `"InfluxIOIncludedT2" and `"InfluxIOIncludedT3": `400`. +* `bucket` - (Required) Name of the initial InfluxDB bucket. All InfluxDB data is stored in a bucket. A bucket combines the concept of a database and a retention period (the duration of time that each data point persists). A bucket belongs to an organization. Along with `organization`, `username`, and `password`, this argument will be stored in the secret referred to by the `influx_auth_parameters_secret_arn` attribute. +* `db_instance_type` - (Required) Timestream for InfluxDB DB instance type to run InfluxDB on. Valid options are: `"db.influx.medium"`, `"db.influx.large"`, `"db.influx.xlarge"`, `"db.influx.2xlarge"`, `"db.influx.4xlarge"`, `"db.influx.8xlarge"`, `"db.influx.12xlarge"`, and `"db.influx.16xlarge"`. This argument is updatable. +* `name` - (Required) Name that uniquely identifies the DB cluster when interacting with the Amazon Timestream for InfluxDB API and CLI commands. This name will also be a prefix included in the endpoint. Cluster names must be unique per customer and per region. The argument must start with a letter, cannot contain consecutive hyphens (`-`) and cannot end with a hyphen. +* `password` - (Required) Password of the initial admin user created in InfluxDB. This password will allow you to access the InfluxDB UI to perform various administrative tasks and also use the InfluxDB CLI to create an operator token. Along with `bucket`, `username`, and `organization`, this argument will be stored in the secret referred to by the `influx_auth_parameters_secret_arn` attribute. +* `organization` - (Required) Name of the initial organization for the initial admin user in InfluxDB. An InfluxDB organization is a workspace for a group of users. Along with `bucket`, `username`, and `password`, this argument will be stored in the secret referred to by the `influx_auth_parameters_secret_arn` attribute. +* `username` - (Required) Username of the initial admin user created in InfluxDB. Must start with a letter and can't end with a hyphen or contain two consecutive hyphens. This username will allow you to access the InfluxDB UI to perform various administrative tasks and also use the InfluxDB CLI to create an operator token. Along with `bucket`, `organization`, and `password`, this argument will be stored in the secret referred to by the `influx_auth_parameters_secret_arn` attribute. +* `vpc_security_group_ids` - (Required) List of VPC security group IDs to associate with the cluster. +* `vpc_subnet_ids` - (Required) List of VPC subnet IDs to associate with the cluster. Provide at least two VPC subnet IDs in different availability zones when deploying with a Multi-AZ standby. + +The following arguments are optional: + +* `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). +* `db_parameter_group_identifier` - (Optional) ID of the DB parameter group assigned to your cluster. This argument is updatable. If added to an existing Timestream for InfluxDB cluster or given a new value, will cause an in-place update to the cluster. However, if a cluster already has a value for `db_parameter_group_identifier`, removing `db_parameter_group_identifier` will cause the cluster to be destroyed and recreated. +* `db_storage_type` - (Default `"InfluxIOIncludedT1"`) Timestream for InfluxDB DB storage type to read and write InfluxDB data. You can choose between 3 different types of provisioned Influx IOPS included storage according to your workloads requirements: Influx IO Included 3000 IOPS, Influx IO Included 12000 IOPS, Influx IO Included 16000 IOPS. Valid options are: `"InfluxIOIncludedT1"`, `"InfluxIOIncludedT2"`, and `"InfluxIOIncludedT3"`. If you use `"InfluxIOIncludedT2" or "InfluxIOIncludedT3", the minimum value for `allocated_storage` is 400. +* `deployment_type` - (Default `"MULTI_NODE_READ_REPLICAS"`) Specifies the type of cluster to create. Valid options are: `"MULTI_NODE_READ_REPLICAS"`. +* `failover_mode` - (Default `"AUTOMATIC"`) Specifies the behavior of failure recovery when the primary node of the cluster fails. Valid options are: `"AUTOMATIC"` and `"NO_FAILOVER"`. +* `log_delivery_configuration` - (Optional) Configuration for sending InfluxDB engine logs to a specified S3 bucket. This argument is updatable. +* `network_type` - (Optional) Specifies whether the network type of the Timestream for InfluxDB cluster is IPV4, which can communicate over IPv4 protocol only, or DUAL, which can communicate over both IPv4 and IPv6 protocols. +* `port` - (Default `8086`) The port on which the cluster accepts connections. Valid values: `1024`-`65535`. Cannot be `2375`-`2376`, `7788`-`7799`, `8090`, or `51678`-`51680`. This argument is updatable. +* `publicly_accessible` - (Default `false`) Configures the DB cluster with a public IP to facilitate access. Other resources, such as a VPC, a subnet, an internet gateway, and a route table with routes, are also required to enabled public access, in addition to this argument. See "[Usage with Public Internet Access Enabled](#usage-with-public-internet-access-enabled)" for an example configuration with all required resources for public internet access. +* `tags` - (Optional) Map of tags assigned to the resource. If configured with a provider [`default_tags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. + +### Nested Fields + +#### `log_delivery_configuration` + +* `s3_configuration` - (Required) Configuration for S3 bucket log delivery. + +#### `s3_configuration` + +* `bucket_name` - (Required) Name of the S3 bucket to deliver logs to. +* `enabled` - (Required) Indicates whether log delivery to the S3 bucket is enabled. + +**Note**: The following arguments do updates in-place: `db_parameter_group_identifier`, `log_delivery_configuration`, `port`, `db_instance_type`, `failover_mode`, and `tags`. Changes to any other argument after a cluster has been deployed will cause destruction and re-creation of the cluster. Additionally, when `db_parameter_group_identifier` is added to a cluster or modified, the cluster will be updated in-place but if `db_parameter_group_identifier` is removed from a cluster, the cluster will be destroyed and re-created. + +## Attribute Reference + +This resource exports the following attributes in addition to the arguments above: + +* `arn` - ARN of the Timestream for InfluxDB cluster. +* `endpoint` - Endpoint used to connect to InfluxDB. The default InfluxDB port is 8086. +* `id` - ID of the Timestream for InfluxDB cluster. +* `influx_auth_parameters_secret_arn` - ARN of the AWS Secrets Manager secret containing the initial InfluxDB authorization parameters. The secret value is a JSON formatted key-value pair holding InfluxDB authorization values: organization, bucket, username, and password. +* `reader_endpoint` - The endpoint used to connect to the Timestream for InfluxDB cluster for read-only operations. +* `tags_all` - Map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). + +## Timeouts + +[Configuration options](https://developer.hashicorp.com/terraform/language/resources/syntax#operation-timeouts): + +* `create` - (Default `30m`) +* `update` - (Default `30m`) +* `delete` - (Default `30m`) + +## Import + +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import Timestream for InfluxDB cluster using its identifier. For example: + +```terraform +import { + to = aws_timestreaminfluxdb_db_cluster.example + id = "12345abcde" +} +``` + +Using `terraform import`, import Timestream for InfluxDB cluster using its identifier. For example: + +```console +% terraform import aws_timestreaminfluxdb_db_cluster.example 12345abcde +``` diff --git a/website/docs/r/timestreaminfluxdb_db_instance.html.markdown b/website/docs/r/timestreaminfluxdb_db_instance.html.markdown index 99a481fc9023..33af36c9201f 100644 --- a/website/docs/r/timestreaminfluxdb_db_instance.html.markdown +++ b/website/docs/r/timestreaminfluxdb_db_instance.html.markdown @@ -253,7 +253,7 @@ This resource exports the following attributes in addition to the arguments abov * `availability_zone` - Availability Zone in which the DB instance resides. * `endpoint` - Endpoint used to connect to InfluxDB. The default InfluxDB port is 8086. * `id` - ID of the Timestream for InfluxDB instance. -* `influx_auth_parameters_secret_arn` - ARN of the AWS Secrets Manager secret containing the initial InfluxDB authorization parameters. The secret value is a JSON formatted key-value pair holding InfluxDB authorization values: organization, bucket, username, and password. This secret will be read by the `aws_timestreaminfluxdb_db_instance` resource in order to support importing: deleting the secret or secret values can cause errors. +* `influx_auth_parameters_secret_arn` - ARN of the AWS Secrets Manager secret containing the initial InfluxDB authorization parameters. The secret value is a JSON formatted key-value pair holding InfluxDB authorization values: organization, bucket, username, and password. * `secondary_availability_zone` - Availability Zone in which the standby instance is located when deploying with a MultiAZ standby instance. * `tags_all` - Map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). diff --git a/website/docs/r/transcribe_vocabulary.html.markdown b/website/docs/r/transcribe_vocabulary.html.markdown index 16c70e9aa70b..54c1f8529623 100644 --- a/website/docs/r/transcribe_vocabulary.html.markdown +++ b/website/docs/r/transcribe_vocabulary.html.markdown @@ -47,7 +47,6 @@ resource "aws_transcribe_vocabulary" "example" { The following arguments are required: * `language_code` - (Required) The language code you selected for your vocabulary. -* `vocabulary_file_uri` - (Required) The Amazon S3 location (URI) of the text file that contains your custom vocabulary. * `vocabulary_name` - (Required) The name of the Vocabulary. The following arguments are optional: diff --git a/website/docs/r/verifiedpermissions_policy_store.html.markdown b/website/docs/r/verifiedpermissions_policy_store.html.markdown index 93268d8dba6d..ac60a82dd4de 100644 --- a/website/docs/r/verifiedpermissions_policy_store.html.markdown +++ b/website/docs/r/verifiedpermissions_policy_store.html.markdown @@ -32,6 +32,7 @@ The following arguments are required: The following arguments are optional: * `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). +* `deletion_protection` - (Optional) Specifies whether the policy store can be deleted. If enabled, the policy store can't be deleted. Valid Values: `ENABLED`, `DISABLED`. Default value: `DISABLED`. * `description` - (Optional) A description of the Policy Store. * `tags` - (Optional) Key-value mapping of resource tags. If configured with a provider [`default_tags` configuration block](/docs/providers/aws/index.html#default_tags-configuration-block) present, tags with matching keys will overwrite those defined at the provider-level. diff --git a/website/docs/r/vpc_endpoint.html.markdown b/website/docs/r/vpc_endpoint.html.markdown index 6fc7df75c681..e1170df389fa 100644 --- a/website/docs/r/vpc_endpoint.html.markdown +++ b/website/docs/r/vpc_endpoint.html.markdown @@ -186,7 +186,7 @@ If no security groups are specified, the VPC's [default security group](https:// * `ipv4` - (Optional) The IPv4 address to assign to the endpoint network interface in the subnet. You must provide an IPv4 address if the VPC endpoint supports IPv4. * `ipv6` - (Optional) The IPv6 address to assign to the endpoint network interface in the subnet. You must provide an IPv6 address if the VPC endpoint supports IPv6. -* `subnet` - (Optional) The ID of the subnet. Must have a corresponding subnet in the `subnet_ids` argument. +* `subnet_id` - (Optional) The ID of the subnet. Must have a corresponding subnet in the `subnet_ids` argument. ## Timeouts diff --git a/website/docs/r/vpc_ipam.html.markdown b/website/docs/r/vpc_ipam.html.markdown index 72f754d6ff10..b0cd4ea9a675 100644 --- a/website/docs/r/vpc_ipam.html.markdown +++ b/website/docs/r/vpc_ipam.html.markdown @@ -63,6 +63,7 @@ This resource supports the following arguments: * `cascade` - (Optional) Enables you to quickly delete an IPAM, private scopes, pools in private scopes, and any allocations in the pools in private scopes. * `description` - (Optional) A description for the IPAM. * `enable_private_gua` - (Optional) Enable this option to use your own GUA ranges as private IPv6 addresses. Default: `false`. +* `metered_account` - (Optional) AWS account that is charged for active IP addresses managed in IPAM. Valid values are `ipam-owner` (default) and `resource-owner`. * `operating_regions` - (Required) Determines which locales can be chosen when you create pools. Locale is the Region where you want to make an IPAM pool available for allocations. You can only create pools with locales that match the operating Regions of the IPAM. You can only create VPCs from a pool whose locale matches the VPC's Region. You specify a region using the [region_name](#operating_regions) parameter. You **must** set your provider block region as an operating_region. * `tier` - (Optional) specifies the IPAM tier. Valid options include `free` and `advanced`. Default is `advanced`. * `tags` - (Optional) A 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. diff --git a/website/docs/r/wafv2_regex_pattern_set.html.markdown b/website/docs/r/wafv2_regex_pattern_set.html.markdown index 8921d27f5dae..71c2b55a2c9f 100644 --- a/website/docs/r/wafv2_regex_pattern_set.html.markdown +++ b/website/docs/r/wafv2_regex_pattern_set.html.markdown @@ -42,7 +42,7 @@ This resource supports the following arguments: * `name_prefix` - (Optional) Creates a unique name beginning with the specified prefix. Conflicts with `name`. * `description` - (Optional) A friendly description of the regular expression pattern set. * `scope` - (Required) Specifies whether this is for an AWS CloudFront distribution or for a regional application. Valid values are `CLOUDFRONT` or `REGIONAL`. To work with CloudFront, you must also specify the region `us-east-1` (N. Virginia) on the AWS provider. -* `regular_expression` - (Optional) One or more blocks of regular expression patterns that you want AWS WAF to search for, such as `B[a@]dB[o0]t`. See [Regular Expression](#regular-expression) below for details. A maximum of 10 `regular_expression` blocks may be specified. +* `regular_expression` - (Optional) One or more blocks of regular expression patterns that you want AWS WAF to search for, such as `B[a@]dB[o0]t`. See [Regular Expression](#regular-expression) below for details. * `tags` - (Optional) An array of key:value pairs to associate with 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. ### Regular Expression diff --git a/website/docs/r/wafv2_rule_group.html.markdown b/website/docs/r/wafv2_rule_group.html.markdown index d55f35695add..6fc2a75a3f66 100644 --- a/website/docs/r/wafv2_rule_group.html.markdown +++ b/website/docs/r/wafv2_rule_group.html.markdown @@ -312,6 +312,48 @@ resource "aws_wafv2_rule_group" "example" { } ``` +### Using rules_json + +```terraform +resource "aws_wafv2_rule_group" "example" { + name = "example-rule-group" + scope = "REGIONAL" + capacity = 100 + + rules_json = jsonencode([{ + Name = "rule-1" + Priority = 1 + Action = { + Count = {} + } + Statement = { + ByteMatchStatement = { + SearchString = "badbot" + FieldToMatch = { + UriPath = {} + } + TextTransformations = [{ + Priority = 1 + Type = "NONE" + }] + PositionalConstraint = "CONTAINS" + } + } + VisibilityConfig = { + CloudwatchMetricsEnabled = false + MetricName = "friendly-rule-metric-name" + SampledRequestsEnabled = false + } + }]) + + visibility_config { + cloudwatch_metrics_enabled = false + metric_name = "friendly-metric-name" + sampled_requests_enabled = false + } +} +``` + ## Argument Reference This resource supports the following arguments: @@ -323,6 +365,7 @@ This resource supports the following arguments: * `name` - (Required, Forces new resource) A friendly name of the rule group. * `name_prefix` - (Optional) Creates a unique name beginning with the specified prefix. Conflicts with `name`. * `rule` - (Optional) The rule blocks used to identify the web requests that you want to `allow`, `block`, or `count`. See [Rules](#rules) below for details. +* `rules_json` - (Optional) Raw JSON string to allow more than three nested statements. Conflicts with `rule` attribute. This is for advanced use cases where more than 3 levels of nested statements are required. **There is no drift detection at this time**. If you use this attribute instead of `rule`, you will be foregoing drift detection. Additionally, importing an existing rule group into a configuration with `rules_json` set will result in a one time in-place update as the remote rule configuration is initially written to the `rule` attribute. See the AWS [documentation](https://docs.aws.amazon.com/waf/latest/APIReference/API_CreateRuleGroup.html) for the JSON structure. * `scope` - (Required, Forces new resource) Specifies whether this is for an AWS CloudFront distribution or for a regional application. Valid values are `CLOUDFRONT` or `REGIONAL`. To work with CloudFront, you must also specify the region `us-east-1` (N. Virginia) on the AWS provider. * `tags` - (Optional) An array of key:value pairs to associate with 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. * `visibility_config` - (Required) Defines and enables Amazon CloudWatch metrics and web request sample collection. See [Visibility Configuration](#visibility-configuration) below for details. diff --git a/website/docs/r/wafv2_web_acl.html.markdown b/website/docs/r/wafv2_web_acl.html.markdown index 2b20cae12baf..5e04af1894ca 100644 --- a/website/docs/r/wafv2_web_acl.html.markdown +++ b/website/docs/r/wafv2_web_acl.html.markdown @@ -12,6 +12,8 @@ Creates a WAFv2 Web ACL resource. ~> **Note** In `field_to_match` blocks, _e.g._, in `byte_match_statement`, the `body` block includes an optional argument `oversize_handling`. AWS indicates this argument will be required starting February 2023. To avoid configurations breaking when that change happens, treat the `oversize_handling` argument as **required** as soon as possible. +!> **Warning:** If you use the `aws_wafv2_web_acl_rule_group_association` resource to associate rule groups with this Web ACL, you must add `lifecycle { ignore_changes = [rule] }` to this resource to prevent configuration drift. The association resource modifies the Web ACL's rules outside of this resource's direct management. + ## Example Usage This resource is based on `aws_wafv2_rule_group`, check the documentation of the `aws_wafv2_rule_group` resource to see examples of the various available statements. @@ -1120,6 +1122,7 @@ Aggregate the request counts using one or more web request components as the agg The `custom_key` block supports the following arguments: +* `asn` - (Optional) Use an Autonomous System Number (ASN) derived from the request's originating or forwarded IP address as an aggregate key. See [RateLimit `asn`](#ratelimit-asn-block) below for details. * `cookie` - (Optional) Use the value of a cookie in the request as an aggregate key. See [RateLimit `cookie`](#ratelimit-cookie-block) below for details. * `forwarded_ip` - (Optional) Use the first IP address in an HTTP header as an aggregate key. See [`forwarded_ip`](#ratelimit-forwarded_ip-block) below for details. * `http_method` - (Optional) Use the request's HTTP method as an aggregate key. See [RateLimit `http_method`](#ratelimit-http_method-block) below for details. @@ -1132,6 +1135,12 @@ The `custom_key` block supports the following arguments: * `query_string` - (Optional) Use the request's query string as an aggregate key. See [RateLimit `query_string`](#ratelimit-query_string-block) below for details. * `uri_path` - (Optional) Use the request's URI path as an aggregate key. See [RateLimit `uri_path`](#ratelimit-uri_path-block) below for details. +### RateLimit `asn` Block + +Use an Autonomous System Number (ASN) derived from the request's originating or forwarded IP address as an aggregate key. Each distinct ASN contributes to the aggregation instance. + +The `asn` block is configured as an empty block `{}`. + ### RateLimit `cookie` Block Use the value of a cookie in the request as an aggregate key. Each distinct value in the cookie contributes to the aggregation instance. If you use a single cookie as your custom key, then each value fully defines an aggregation instance. diff --git a/website/docs/r/wafv2_web_acl_rule_group_association.html.markdown b/website/docs/r/wafv2_web_acl_rule_group_association.html.markdown new file mode 100644 index 000000000000..81e2a614ede9 --- /dev/null +++ b/website/docs/r/wafv2_web_acl_rule_group_association.html.markdown @@ -0,0 +1,504 @@ +--- +subcategory: "WAF" +layout: "aws" +page_title: "AWS: aws_wafv2_web_acl_rule_group_association" +description: |- + Associates a WAFv2 Rule Group with a Web ACL by adding a rule that references the Rule Group. +--- + +# Resource: aws_wafv2_web_acl_rule_group_association + +Associates a WAFv2 Rule Group (custom or managed) with a Web ACL by adding a rule that references the Rule Group. Use this resource to apply the rules defined in a Rule Group to a Web ACL without duplicating rule definitions. + +This resource supports both: + +- **Custom Rule Groups**: User-created rule groups that you manage within your AWS account +- **Managed Rule Groups**: Pre-configured rule groups provided by AWS or third-party vendors + +!> **Warning:** Verify the rule names in your `rule_action_override`s carefully. With managed rule groups, WAF silently ignores any override that uses an invalid rule name. With customer-owned rule groups, invalid rule names in your overrides will cause web ACL updates to fail. An invalid rule name is any name that doesn't exactly match the case-sensitive name of an existing rule in the rule group. + +!> **Warning:** Using this resource will cause the associated Web ACL resource to show configuration drift in the `rule` argument unless you add `lifecycle { ignore_changes = [rule] }` to the Web ACL resource configuration. This is because this resource modifies the Web ACL's rules outside of the Web ACL resource's direct management. + +~> **Note:** This resource creates a rule within the Web ACL that references the entire Rule Group. The rule group's individual rules are evaluated as a unit when requests are processed by the Web ACL. + +## Example Usage + +### Custom Rule Group - Basic Usage + +```terraform +resource "aws_wafv2_rule_group" "example" { + name = "example-rule-group" + scope = "REGIONAL" + capacity = 10 + + rule { + name = "block-suspicious-requests" + priority = 1 + + action { + block {} + } + + statement { + geo_match_statement { + country_codes = ["CN", "RU"] + } + } + + visibility_config { + cloudwatch_metrics_enabled = true + metric_name = "block-suspicious-requests" + sampled_requests_enabled = true + } + } + + visibility_config { + cloudwatch_metrics_enabled = true + metric_name = "example-rule-group" + sampled_requests_enabled = true + } +} + +resource "aws_wafv2_web_acl" "example" { + name = "example-web-acl" + scope = "REGIONAL" + + default_action { + allow {} + } + + visibility_config { + cloudwatch_metrics_enabled = true + metric_name = "example-web-acl" + sampled_requests_enabled = true + } + + lifecycle { + ignore_changes = [rule] + } +} + +resource "aws_wafv2_web_acl_rule_group_association" "example" { + rule_name = "example-rule-group-rule" + priority = 100 + web_acl_arn = aws_wafv2_web_acl.example.arn + + rule_group_reference { + arn = aws_wafv2_rule_group.example.arn + } +} +``` + +### Managed Rule Group - Basic Usage + +```terraform +resource "aws_wafv2_web_acl" "example" { + name = "example-web-acl" + scope = "REGIONAL" + + default_action { + allow {} + } + + visibility_config { + cloudwatch_metrics_enabled = true + metric_name = "example-web-acl" + sampled_requests_enabled = true + } + + lifecycle { + ignore_changes = [rule] + } +} + +resource "aws_wafv2_web_acl_rule_group_association" "managed_example" { + rule_name = "aws-common-rule-set" + priority = 50 + web_acl_arn = aws_wafv2_web_acl.example.arn + + managed_rule_group { + name = "AWSManagedRulesCommonRuleSet" + vendor_name = "AWS" + } +} +``` + +### Managed Rule Group - With Version + +```terraform +resource "aws_wafv2_web_acl_rule_group_association" "managed_versioned" { + rule_name = "aws-common-rule-set-versioned" + priority = 60 + web_acl_arn = aws_wafv2_web_acl.example.arn + + managed_rule_group { + name = "AWSManagedRulesCommonRuleSet" + vendor_name = "AWS" + version = "Version_1.0" + } +} +``` + +### Managed Rule Group - With Rule Action Overrides + +```terraform +resource "aws_wafv2_web_acl_rule_group_association" "managed_with_overrides" { + rule_name = "aws-common-rule-set-with-overrides" + priority = 70 + web_acl_arn = aws_wafv2_web_acl.example.arn + + managed_rule_group { + name = "AWSManagedRulesCommonRuleSet" + vendor_name = "AWS" + + # Override specific rules within the managed rule group + rule_action_override { + name = "GenericRFI_BODY" + action_to_use { + count { + custom_request_handling { + insert_header { + name = "X-RFI-Override" + value = "counted" + } + } + } + } + } + + rule_action_override { + name = "SizeRestrictions_BODY" + action_to_use { + captcha {} + } + } + } +} +``` + +### Custom Rule Group - With Override Action + +```terraform +resource "aws_wafv2_web_acl_rule_group_association" "example" { + rule_name = "example-rule-group-rule" + priority = 100 + web_acl_arn = aws_wafv2_web_acl.example.arn + override_action = "count" + + rule_group_reference { + arn = aws_wafv2_rule_group.example.arn + } +} +``` + +### Custom Rule Group - With Rule Action Overrides + +```terraform +resource "aws_wafv2_rule_group" "example" { + name = "example-rule-group" + scope = "REGIONAL" + capacity = 10 + + rule { + name = "geo-block-rule" + priority = 1 + + action { + block {} + } + + statement { + geo_match_statement { + country_codes = ["CN", "RU"] + } + } + + visibility_config { + cloudwatch_metrics_enabled = true + metric_name = "geo-block-rule" + sampled_requests_enabled = true + } + } + + rule { + name = "rate-limit-rule" + priority = 2 + + action { + block {} + } + + statement { + rate_based_statement { + limit = 1000 + aggregate_key_type = "IP" + } + } + + visibility_config { + cloudwatch_metrics_enabled = true + metric_name = "rate-limit-rule" + sampled_requests_enabled = true + } + } + + visibility_config { + cloudwatch_metrics_enabled = true + metric_name = "example-rule-group" + sampled_requests_enabled = true + } +} + +resource "aws_wafv2_web_acl" "example" { + name = "example-web-acl" + scope = "REGIONAL" + + default_action { + allow {} + } + + visibility_config { + cloudwatch_metrics_enabled = true + metric_name = "example-web-acl" + sampled_requests_enabled = true + } + + lifecycle { + ignore_changes = [rule] + } +} + +resource "aws_wafv2_web_acl_rule_group_association" "example" { + rule_name = "example-rule-group-rule" + priority = 100 + web_acl_arn = aws_wafv2_web_acl.example.arn + + rule_group_reference { + arn = aws_wafv2_rule_group.example.arn + + # Override specific rules within the rule group + rule_action_override { + name = "geo-block-rule" + action_to_use { + count { + custom_request_handling { + insert_header { + name = "X-Geo-Block-Override" + value = "counted" + } + } + } + } + } + + rule_action_override { + name = "rate-limit-rule" + action_to_use { + captcha { + custom_request_handling { + insert_header { + name = "X-Rate-Limit-Override" + value = "captcha-required" + } + } + } + } + } + } +} +``` + +### Custom Rule Group - CloudFront Web ACL + +```terraform +resource "aws_wafv2_rule_group" "cloudfront_example" { + name = "cloudfront-rule-group" + scope = "CLOUDFRONT" + capacity = 10 + + rule { + name = "rate-limit" + priority = 1 + + action { + block {} + } + + statement { + rate_based_statement { + limit = 2000 + aggregate_key_type = "IP" + } + } + + visibility_config { + cloudwatch_metrics_enabled = true + metric_name = "rate-limit" + sampled_requests_enabled = true + } + } + + visibility_config { + cloudwatch_metrics_enabled = true + metric_name = "cloudfront-rule-group" + sampled_requests_enabled = true + } +} + +resource "aws_wafv2_web_acl" "cloudfront_example" { + name = "cloudfront-web-acl" + scope = "CLOUDFRONT" + + default_action { + allow {} + } + + visibility_config { + cloudwatch_metrics_enabled = true + metric_name = "cloudfront-web-acl" + sampled_requests_enabled = true + } + + lifecycle { + ignore_changes = [rule] + } +} + +resource "aws_wafv2_web_acl_rule_group_association" "cloudfront_example" { + rule_name = "cloudfront-rule-group-rule" + priority = 50 + web_acl_arn = aws_wafv2_web_acl.cloudfront_example.arn + + rule_group_reference { + arn = aws_wafv2_rule_group.cloudfront_example.arn + } +} +``` + +## Argument Reference + +The following arguments are required: + +* `rule_name` - (Required) Name of the rule to create in the Web ACL that references the rule group. Must be between 1 and 128 characters. +* `priority` - (Required) Priority of the rule within the Web ACL. Rules are evaluated in order of priority, with lower numbers evaluated first. +* `web_acl_arn` - (Required) ARN of the Web ACL to associate the Rule Group with. + +The following arguments are optional: + +* `managed_rule_group` - (Optional) Managed Rule Group configuration. One of `rule_group_reference` or `managed_rule_group` is required. Conflicts with `rule_group_reference`. [See below](#managed_rule_group). +* `override_action` - (Optional) Override action for the rule group. Valid values are `none` and `count`. Defaults to `none`. When set to `count`, the actions defined in the rule group rules are overridden to count matches instead of blocking or allowing requests. +* `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). +* `rule_group_reference` - (Optional) Custom Rule Group reference configuration. One of `rule_group_reference` or `managed_rule_group` is required. Conflicts with `managed_rule_group`. [See below](#rule_group_reference). + +### rule_group_reference + +* `arn` - (Required) ARN of the Rule Group to associate with the Web ACL. +* `rule_action_override` - (Optional) Override actions for specific rules within the rule group. [See below](#rule_action_override). + +### managed_rule_group + +* `name` - (Required) Name of the managed rule group. +* `vendor_name` - (Required) Name of the managed rule group vendor. For AWS managed rule groups, this is `AWS`. +* `version` - (Optional) Version of the managed rule group. If not specified, the default version is used. +* `rule_action_override` - (Optional) Override actions for specific rules within the rule group. [See below](#rule_action_override). + +### rule_action_override + +* `name` - (Required) Name of the rule to override within the rule group. Verify the name carefully. With managed rule groups, WAF silently ignores any override that uses an invalid rule name. With customer-owned rule groups, invalid rule names in your overrides will cause web ACL updates to fail. An invalid rule name is any name that doesn't exactly match the case-sensitive name of an existing rule in the rule group. +* `action_to_use` - (Required) Action to use instead of the rule's original action. [See below](#action_to_use). + +### action_to_use + +Exactly one of the following action blocks must be specified: + +* `allow` - (Optional) Allow the request. [See below](#allow). +* `block` - (Optional) Block the request. [See below](#block). +* `captcha` - (Optional) Require CAPTCHA verification. [See below](#captcha). +* `challenge` - (Optional) Require challenge verification. [See below](#challenge). +* `count` - (Optional) Count the request without taking action. [See below](#count). + +### allow + +* `custom_request_handling` - (Optional) Custom handling for allowed requests. [See below](#custom_request_handling). + +### block + +* `custom_response` - (Optional) Custom response for blocked requests. [See below](#custom_response). + +### captcha + +* `custom_request_handling` - (Optional) Custom handling for CAPTCHA requests. [See below](#custom_request_handling). + +### challenge + +* `custom_request_handling` - (Optional) Custom handling for challenge requests. [See below](#custom_request_handling). + +### count + +* `custom_request_handling` - (Optional) Custom handling for counted requests. [See below](#custom_request_handling). + +### custom_request_handling + +* `insert_header` - (Required) Headers to insert into the request. [See below](#insert_header). + +### custom_response + +* `custom_response_body_key` - (Optional) Key of a custom response body to use. +* `response_code` - (Required) HTTP response code to return (200-599). +* `response_header` - (Optional) Headers to include in the response. [See below](#response_header). + +### insert_header + +* `name` - (Required) Name of the header to insert. +* `value` - (Required) Value of the header to insert. + +### response_header + +* `name` - (Required) Name of the response header. +* `value` - (Required) Value of the response header. + +## Attribute Reference + +This resource exports the following attributes in addition to the arguments above: + +None. + +## Timeouts + +[Configuration options](https://developer.hashicorp.com/terraform/language/resources/syntax#operation-timeouts): + +* `create` - (Default `30m`) +* `update` - (Default `30m`) +* `delete` - (Default `30m`) + +## Import + +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import WAFv2 web ACL custom rule group associations using `WebACLARN,RuleGroupARN,RuleName`. For example: + +```terraform +import { + to = aws_wafv2_web_acl_rule_group_association.example + id = "arn:aws:wafv2:us-east-1:123456789012:regional/webacl/example-web-acl/12345678-1234-1234-1234-123456789012,arn:aws:wafv2:us-east-1:123456789012:regional/rulegroup/example-rule-group/87654321-4321-4321-4321-210987654321,example-rule-group-rule" +} +``` + +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import WAFv2 web ACL managed rule group associations using `WebACLARN,VendorName:RuleGroupName[:Version],RuleName`. For example: + +```terraform +import { + to = aws_wafv2_web_acl_rule_group_association.managed_example + id = "arn:aws:wafv2:us-east-1:123456789012:regional/webacl/example-web-acl/12345678-1234-1234-1234-123456789012,AWS:AWSManagedRulesCommonRuleSet,aws-common-rule-set" +} +``` + +Using `terraform import`, import WAFv2 web ACL custom rule group associations using `WebACLARN,RuleGroupARN,RuleName`. For example: + +```console +% terraform import aws_wafv2_web_acl_rule_group_association.example "arn:aws:wafv2:us-east-1:123456789012:regional/webacl/example-web-acl/12345678-1234-1234-1234-123456789012,arn:aws:wafv2:us-east-1:123456789012:regional/rulegroup/example-rule-group/87654321-4321-4321-4321-210987654321,example-rule-group-rule" +``` + +Using `terraform import`, import WAFv2 web ACL managed rule group associations using `WebACLARN,VendorName:RuleGroupName[:Version],RuleName`. For example: + +```console +% terraform import aws_wafv2_web_acl_rule_group_association.managed_example "arn:aws:wafv2:us-east-1:123456789012:regional/webacl/example-web-acl/12345678-1234-1234-1234-123456789012,AWS:AWSManagedRulesCommonRuleSet,aws-common-rule-set" +``` diff --git a/website/docs/r/workspacesweb_browser_settings_association.html.markdown b/website/docs/r/workspacesweb_browser_settings_association.html.markdown new file mode 100644 index 000000000000..dd677ea79d4a --- /dev/null +++ b/website/docs/r/workspacesweb_browser_settings_association.html.markdown @@ -0,0 +1,68 @@ +--- +subcategory: "WorkSpaces Web" +layout: "aws" +page_title: "AWS: aws_workspacesweb_browser_settings_association" +description: |- + Terraform resource for managing an AWS WorkSpaces Web Browser Settings Association. +--- + +# Resource: aws_workspacesweb_browser_settings_association + +Terraform resource for managing an AWS WorkSpaces Web Browser Settings Association. + +## Example Usage + +### Basic Usage + +```terraform +resource "aws_workspacesweb_portal" "example" { + display_name = "example" +} + +resource "aws_workspacesweb_browser_settings" "example" { + browser_policy = jsonencode({ + chromePolicies = { + DefaultDownloadDirectory = { + value = "/home/as2-streaming-user/MyFiles/TemporaryFiles1" + } + } + }) +} + +resource "aws_workspacesweb_browser_settings_association" "example" { + browser_settings_arn = aws_workspacesweb_browser_settings.example.browser_settings_arn + portal_arn = aws_workspacesweb_portal.example.portal_arn +} +``` + +## Argument Reference + +The following arguments are required: + +* `browser_settings_arn` - (Required) ARN of the browser settings to associate with the portal. Forces replacement if changed. +* `portal_arn` - (Required) ARN of the portal to associate with the browser settings. Forces replacement if changed. + +The following arguments are optional: + +* `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). + +## 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 WorkSpaces Web Browser Settings Association using the `browser_settings_arn,portal_arn`. For example: + +```terraform +import { + to = aws_workspacesweb_browser_settings_association.example + id = "arn:aws:workspaces-web:us-west-2:123456789012:browserSettings/browser_settings-id-12345678,arn:aws:workspaces-web:us-west-2:123456789012:portal/portal-id-12345678" +} +``` + +Using `terraform import`, import WorkSpaces Web Browser Settings Association using the `browser_settings_arn,portal_arn`. For example: + +```console +% terraform import aws_workspacesweb_browser_settings_association.example arn:aws:workspaces-web:us-west-2:123456789012:browserSettings/browser_settings-id-12345678,arn:aws:workspaces-web:us-west-2:123456789012:portal/portal-id-12345678 +``` diff --git a/website/docs/r/workspacesweb_data_protection_settings_association.html.markdown b/website/docs/r/workspacesweb_data_protection_settings_association.html.markdown new file mode 100644 index 000000000000..ac99b95741c8 --- /dev/null +++ b/website/docs/r/workspacesweb_data_protection_settings_association.html.markdown @@ -0,0 +1,56 @@ +--- +subcategory: "WorkSpaces Web" +layout: "aws" +page_title: "AWS: aws_workspacesweb_data_protection_settings_association" +description: |- + Terraform resource for managing an AWS WorkSpaces Web Data Protection Settings Association. +--- + +# Resource: aws_workspacesweb_data_protection_settings_association + +Terraform resource for managing an AWS WorkSpaces Web Data Protection Settings Association. + +## Example Usage + +### Basic Usage + +```terraform +resource "aws_workspacesweb_portal" "example" { + display_name = "example" +} + +resource "aws_workspacesweb_data_protection_settings" "example" { + display_name = "example" +} + +resource "aws_workspacesweb_data_protection_settings_association" "example" { + data_protection_settings_arn = aws_workspacesweb_data_protection_settings.example.data_protection_settings_arn + portal_arn = aws_workspacesweb_portal.example.portal_arn +} +``` + +## Argument Reference + +The following arguments are required: + +* `data_protection_settings_arn` - (Required) ARN of the data protection settings to associate with the portal. Forces replacement if changed. +* `portal_arn` - (Required) ARN of the portal to associate with the data protection settings. Forces replacement if changed. + +The following arguments are optional: + +* `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). + +## 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 WorkSpaces Web Data Protection Settings Association using the `data_protection_settings_arn,portal_arn`. For example: + +```terraform +import { + to = aws_workspacesweb_data_protection_settings_association.example + id = "arn:aws:workspaces-web:us-west-2:123456789012:dataProtectionSettings/data_protection_settings-id-12345678,arn:aws:workspaces-web:us-west-2:123456789012:portal/portal-id-12345678" +} +``` diff --git a/website/docs/r/workspacesweb_identity_provider.html.markdown b/website/docs/r/workspacesweb_identity_provider.html.markdown new file mode 100644 index 000000000000..a5a986db914b --- /dev/null +++ b/website/docs/r/workspacesweb_identity_provider.html.markdown @@ -0,0 +1,122 @@ +--- +subcategory: "WorkSpaces Web" +layout: "aws" +page_title: "AWS: aws_workspacesweb_identity_provider" +description: |- + Terraform resource for managing an AWS WorkSpaces Web Identity Provider. +--- + +# Resource: aws_workspacesweb_identity_provider + +Terraform resource for managing an AWS WorkSpaces Web Identity Provider. + +## Example Usage + +### Basic Usage with SAML + +```terraform +resource "aws_workspacesweb_portal" "example" { + display_name = "example" +} + +resource "aws_workspacesweb_identity_provider" "example" { + identity_provider_name = "example-saml" + identity_provider_type = "SAML" + portal_arn = aws_workspacesweb_portal.example.portal_arn + + identity_provider_details = { + MetadataURL = "https://example.com/metadata" + } +} +``` + +### OIDC Identity Provider + +```terraform +resource "aws_workspacesweb_portal" "test" { + display_name = "test" +} + +resource "aws_workspacesweb_identity_provider" "test" { + identity_provider_name = "test-updated" + identity_provider_type = "OIDC" + portal_arn = aws_workspacesweb_portal.test.portal_arn + + identity_provider_details = { + client_id = "test-client-id" + client_secret = "test-client-secret" + oidc_issuer = "https://accounts.google.com" + attributes_request_method = "POST" + authorize_scopes = "openid, email" + } +} +``` + +## Argument Reference + +The following arguments are required: + +* `identity_provider_details` - (Required) Identity provider details. The following list describes the provider detail keys for each identity provider type: + * For Google and Login with Amazon: + * `client_id` + * `client_secret` + * `authorize_scopes` + * For Facebook: + * `client_id` + * `client_secret` + * `authorize_scopes` + * `api_version` + * For Sign in with Apple: + * `client_id` + * `team_id` + * `key_id` + * `private_key` + * `authorize_scopes` + * For OIDC providers: + * `client_id` + * `client_secret` + * `attributes_request_method` + * `oidc_issuer` + * `authorize_scopes` + * `authorize_url` if not available from discovery URL specified by `oidc_issuer` key + * `token_url` if not available from discovery URL specified by `oidc_issuer` key + * `attributes_url` if not available from discovery URL specified by `oidc_issuer` key + * `jwks_uri` if not available from discovery URL specified by `oidc_issuer` key + * For SAML providers: + * `MetadataFile` OR `MetadataURL` + * `IDPSignout` (boolean) optional + * `IDPInit` (boolean) optional + * `RequestSigningAlgorithm` (string) optional - Only accepts rsa-sha256 + * `EncryptedResponses` (boolean) optional +* `identity_provider_name` - (Required) Identity provider name. +* `identity_provider_type` - (Required) Identity provider type. Valid values: `SAML`, `Facebook`, `Google`, `LoginWithAmazon`, `SignInWithApple`, `OIDC`. +* `portal_arn` - (Required) ARN of the web portal. Forces replacement if changed. + +The following arguments are optional: + +* `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). +* `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. + +## Attribute Reference + +This resource exports the following attributes in addition to the arguments above: + +* `identity_provider_arn` - ARN of the identity provider. +* `tags_all` - Map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). + +## Import + +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import WorkSpaces Web Identity Provider using the `identity_provider_arn`. For example: + +```terraform +import { + to = aws_workspacesweb_identity_provider.example + id = "arn:aws:workspaces-web:us-west-2:123456789012:identityprovider/abcdef12345678/12345678-1234-1234-1234-123456789012" +} +``` + +Using `terraform import`, import WorkSpaces Web Identity Provider using the `identity_provider_arn`. For example: + +```console +% terraform import aws_workspacesweb_identity_provider.example arn:aws:workspaces-web:us-west-2:123456789012:identityprovider/abcdef12345678/12345678-1234-1234-1234-123456789012 +``` diff --git a/website/docs/r/workspacesweb_ip_access_settings_association.html.markdown b/website/docs/r/workspacesweb_ip_access_settings_association.html.markdown new file mode 100644 index 000000000000..acbcb0d2b8df --- /dev/null +++ b/website/docs/r/workspacesweb_ip_access_settings_association.html.markdown @@ -0,0 +1,60 @@ +--- +subcategory: "WorkSpaces Web" +layout: "aws" +page_title: "AWS: aws_workspacesweb_ip_access_settings_association" +description: |- + Terraform resource for managing an AWS WorkSpaces Web IP Access Settings Association. +--- + +# Resource: aws_workspacesweb_ip_access_settings_association + +Terraform resource for managing an AWS WorkSpaces Web IP Access Settings Association. + +## Example Usage + +### Basic Usage + +```terraform +resource "aws_workspacesweb_portal" "example" { + display_name = "example" +} + +resource "aws_workspacesweb_ip_access_settings" "example" { + display_name = "example" + + ip_rule { + ip_range = "10.0.0.0/16" + } +} + +resource "aws_workspacesweb_ip_access_settings_association" "example" { + ip_access_settings_arn = aws_workspacesweb_ip_access_settings.example.ip_access_settings_arn + portal_arn = aws_workspacesweb_portal.example.portal_arn +} +``` + +## Argument Reference + +The following arguments are required: + +* `ip_access_settings_arn` - (Required) ARN of the IP access settings to associate with the portal. Forces replacement if changed. +* `portal_arn` - (Required) ARN of the portal to associate with the IP access settings. Forces replacement if changed. + +The following arguments are optional: + +* `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). + +## 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 WorkSpaces Web IP Access Settings Association using the `ip_access_settings_arn,portal_arn`. For example: + +```terraform +import { + to = aws_workspacesweb_ip_access_settings_association.example + id = "arn:aws:workspaces-web:us-west-2:123456789012:ipAccessSettings/ip_access_settings-id-12345678,arn:aws:workspaces-web:us-west-2:123456789012:portal/portal-id-12345678" +} +``` diff --git a/website/docs/r/workspacesweb_network_settings_association.html.markdown b/website/docs/r/workspacesweb_network_settings_association.html.markdown new file mode 100644 index 000000000000..e90a65c1f2c5 --- /dev/null +++ b/website/docs/r/workspacesweb_network_settings_association.html.markdown @@ -0,0 +1,98 @@ +--- +subcategory: "WorkSpaces Web" +layout: "aws" +page_title: "AWS: aws_workspacesweb_network_settings_association" +description: |- + Terraform resource for managing an AWS WorkSpaces Web Network Settings Association. +--- + +# Resource: aws_workspacesweb_network_settings_association + +Terraform resource for managing an AWS WorkSpaces Web Network Settings Association. + +## Example Usage + +### Basic Usage + +```terraform +data "aws_availability_zones" "available" { + state = "available" + + filter { + name = "opt-in-status" + values = ["opt-in-not-required"] + } +} + +resource "aws_vpc" "example" { + cidr_block = "10.0.0.0/16" + + tags = { + Name = "example" + } +} + +resource "aws_subnet" "example" { + count = 2 + + vpc_id = aws_vpc.example.id + cidr_block = cidrsubnet(aws_vpc.example.cidr_block, 8, count.index) + availability_zone = data.aws_availability_zones.available.names[count.index] + + tags = { + Name = "example" + } +} + +resource "aws_security_group" "example" { + count = 2 + + vpc_id = aws_vpc.example.id + name = "example-${count.index}" + + tags = { + Name = "example" + } +} + +resource "aws_workspacesweb_portal" "example" { + display_name = "example" +} + +resource "aws_workspacesweb_network_settings" "example" { + vpc_id = aws_vpc.example.id + subnet_ids = [aws_subnet.example[0].id, aws_subnet.example[1].id] + security_group_ids = [aws_security_group.example[0].id, aws_security_group.example[1].id] +} + +resource "aws_workspacesweb_network_settings_association" "example" { + network_settings_arn = aws_workspacesweb_network_settings.example.network_settings_arn + portal_arn = aws_workspacesweb_portal.example.portal_arn +} +``` + +## Argument Reference + +The following arguments are required: + +* `network_settings_arn` - (Required) ARN of the network settings to associate with the portal. Forces replacement if changed. +* `portal_arn` - (Required) ARN of the portal to associate with the network settings. Forces replacement if changed. + +The following arguments are optional: + +* `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). + +## 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 WorkSpaces Web Network Settings Association using the `network_settings_arn,portal_arn`. For example: + +```terraform +import { + to = aws_workspacesweb_network_settings_association.example + id = "arn:aws:workspaces-web:us-west-2:123456789012:networkSettings/network_settings-id-12345678,arn:aws:workspaces-web:us-west-2:123456789012:portal/portal-id-12345678" +} +``` diff --git a/website/docs/r/workspacesweb_portal.html.markdown b/website/docs/r/workspacesweb_portal.html.markdown new file mode 100644 index 000000000000..62302cbdd205 --- /dev/null +++ b/website/docs/r/workspacesweb_portal.html.markdown @@ -0,0 +1,112 @@ +--- +subcategory: "WorkSpaces Web" +layout: "aws" +page_title: "AWS: aws_workspacesweb_portal" +description: |- + Terraform resource for managing an AWS WorkSpaces Web Portal. +--- + +# Resource: aws_workspacesweb_portal + +Terraform resource for managing an AWS WorkSpaces Web Portal. + +## Example Usage + +### Basic Usage + +```terraform +resource "aws_workspacesweb_portal" "example" { + display_name = "example-portal" + instance_type = "standard.regular" +} +``` + +### Complete Usage + +```terraform +resource "aws_kms_key" "example" { + description = "KMS key for WorkSpaces Web Portal" + deletion_window_in_days = 7 +} + +resource "aws_workspacesweb_portal" "example" { + display_name = "example-portal" + instance_type = "standard.large" + authentication_type = "IAM_Identity_Center" + customer_managed_key = aws_kms_key.example.arn + max_concurrent_sessions = 10 + + additional_encryption_context = { + Environment = "Production" + } + + tags = { + Name = "example-portal" + } + + timeouts { + create = "10m" + update = "10m" + delete = "10m" + } +} +``` + +## Argument Reference + +The following arguments are optional: + +* `additional_encryption_context` - (Optional) Additional encryption context for the customer managed key. Forces replacement if changed. +* `authentication_type` - (Optional) Authentication type for the portal. Valid values: `Standard`, `IAM_Identity_Center`. +* `browser_settings_arn` - (Optional) ARN of the browser settings to use for the portal. +* `customer_managed_key` - (Optional) ARN of the customer managed key. Forces replacement if changed. +* `display_name` - (Optional) Display name of the portal. +* `instance_type` - (Optional) Instance type for the portal. Valid values: `standard.regular`, `standard.large`. +* `max_concurrent_sessions` - (Optional) Maximum number of concurrent sessions for the portal. +* `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). +* `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. + +## Attribute Reference + +This resource exports the following attributes in addition to the arguments above: + +* `browser_type` - Browser type of the portal. +* `creation_date` - Creation date of the portal. +* `data_protection_settings_arn` - ARN of the data protection settings associated with the portal. +* `ip_access_settings_arn` - ARN of the IP access settings associated with the portal. +* `network_settings_arn` - ARN of the network settings associated with the portal. +* `portal_arn` - ARN of the portal. +* `portal_endpoint` - Endpoint URL of the portal. +* `portal_status` - Status of the portal. +* `renderer_type` - Renderer type of the portal. +* `session_logger_arn` - ARN of the session logger associated with the portal. +* `status_reason` - Reason for the current status of the portal. +* `tags_all` - Map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). +* `trust_store_arn` - ARN of the trust store associated with the portal. +* `user_access_logging_settings_arn` - ARN of the user access logging settings associated with the portal. +* `user_settings_arn` - ARN of the user settings associated with the portal. + +## Timeouts + +[Configuration options](https://developer.hashicorp.com/terraform/language/resources/syntax#operation-timeouts): + +* `create` - (Default `5m`) +* `update` - (Default `5m`) +* `delete` - (Default `5m`) + +## Import + +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import WorkSpaces Web Portal using the `portal_arn`. For example: + +```terraform +import { + to = aws_workspacesweb_portal.example + id = "arn:aws:workspaces-web:us-west-2:123456789012:portal/abcdef12345678" +} +``` + +Using `terraform import`, import WorkSpaces Web Portal using the `portal_arn`. For example: + +```console +% terraform import aws_workspacesweb_portal.example arn:aws:workspaces-web:us-west-2:123456789012:portal/abcdef12345678 +``` diff --git a/website/docs/r/workspacesweb_session_logger.html.markdown b/website/docs/r/workspacesweb_session_logger.html.markdown new file mode 100644 index 000000000000..b083572c2e9f --- /dev/null +++ b/website/docs/r/workspacesweb_session_logger.html.markdown @@ -0,0 +1,214 @@ +--- +subcategory: "WorkSpaces Web" +layout: "aws" +page_title: "AWS: aws_workspacesweb_session_logger" +description: |- + Terraform resource for managing an AWS WorkSpaces Web Session Logger. +--- + +# Resource: aws_workspacesweb_session_logger + +Terraform resource for managing an AWS WorkSpaces Web Session Logger. + +## Example Usage + +### Basic Usage + +```terraform +resource "aws_s3_bucket" "example" { + bucket = "example-session-logs" +} + +data "aws_iam_policy_document" "example" { + statement { + effect = "Allow" + principals { + type = "Service" + identifiers = ["workspaces-web.amazonaws.com"] + } + actions = [ + "s3:PutObject" + ] + resources = ["${aws_s3_bucket.example.arn}/*"] + } +} + +resource "aws_s3_bucket_policy" "example" { + bucket = aws_s3_bucket.example.id + policy = data.aws_iam_policy_document.example.json +} + +resource "aws_workspacesweb_session_logger" "example" { + display_name = "example-session-logger" + + event_filter { + all {} + } + + log_configuration { + s3 { + bucket = aws_s3_bucket.example.id + folder_structure = "Flat" + log_file_format = "Json" + } + } + + depends_on = [aws_s3_bucket_policy.example] +} +``` + +### Complete Configuration with KMS Encryption + +```terraform +resource "aws_s3_bucket" "example" { + bucket = "example-session-logs" + force_destroy = true +} + +data "aws_iam_policy_document" "example" { + statement { + effect = "Allow" + principals { + type = "Service" + identifiers = ["workspaces-web.amazonaws.com"] + } + actions = [ + "s3:PutObject" + ] + resources = [ + aws_s3_bucket.example.arn, + "${aws_s3_bucket.example.arn}/*" + ] + } +} + +resource "aws_s3_bucket_policy" "example" { + bucket = aws_s3_bucket.example.id + policy = data.aws_iam_policy_document.example.json +} + +data "aws_partition" "current" {} + +data "aws_caller_identity" "current" {} + +data "aws_iam_policy_document" "kms_key_policy" { + statement { + principals { + type = "AWS" + identifiers = ["arn:${data.aws_partition.current.partition}:iam::${data.aws_caller_identity.current.account_id}:root"] + } + actions = ["kms:*"] + resources = ["*"] + } + + statement { + principals { + type = "Service" + identifiers = ["workspaces-web.amazonaws.com"] + } + actions = [ + "kms:Encrypt", + "kms:GenerateDataKey*", + "kms:ReEncrypt*", + "kms:Decrypt" + ] + resources = ["*"] + } +} + +resource "aws_kms_key" "example" { + description = "KMS key for WorkSpaces Web Session Logger" + policy = data.aws_iam_policy_document.kms_key_policy.json +} + +resource "aws_workspacesweb_session_logger" "example" { + display_name = "example-session-logger" + customer_managed_key = aws_kms_key.example.arn + additional_encryption_context = { + Environment = "Production" + Application = "WorkSpacesWeb" + } + + event_filter { + include = ["SessionStart", "SessionEnd"] + } + + log_configuration { + s3 { + bucket = aws_s3_bucket.example.id + bucket_owner = data.aws_caller_identity.current.account_id + folder_structure = "NestedByDate" + key_prefix = "workspaces-web-logs/" + log_file_format = "JsonLines" + } + } + + tags = { + Name = "example-session-logger" + Environment = "Production" + } + + depends_on = [aws_s3_bucket_policy.example, aws_kms_key.example] +} +``` + +## Argument Reference + +The following arguments are required: + +* `event_filter` - (Required) Event filter that determines which events are logged. See [Event Filter](#event-filter) below. +* `log_configuration` - (Required) Configuration block for specifying where logs are delivered. See [Log Configuration](#log-configuration) below. + +The following arguments are optional: + +* `additional_encryption_context` - (Optional) Map of additional encryption context key-value pairs. +* `customer_managed_key` - (Optional) ARN of the customer managed KMS key used to encrypt sensitive information. +* `display_name` - (Optional) Human-readable display name for the session logger resource. Forces replacement if changed. +* `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). +* `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. + +### Log Configuration + +* `s3` - (Required) Configuration block for S3 log delivery. See [S3 Configuration](#s3-configuration) below. + +### Event Filter + +Exactly one of the following must be specified: + +* `all` - (Optional) Block that specifies to monitor all events. Set to `{}` to monitor all events. +* `include` - (Optional) List of specific events to monitor. Valid values include session events like `SessionStart`, `SessionEnd`, etc. + +### S3 Configuration + +* `bucket` - (Required) S3 bucket name where logs are delivered. +* `folder_structure` - (Required) Folder structure that defines the organizational structure for log files in S3. Valid values: `FlatStructure`, `DateBasedStructure`. +* `log_file_format` - (Required) Format of the log file written to S3. Valid values: `Json`, `Parquet`. +* `bucket_owner` - (Optional) Expected bucket owner of the target S3 bucket. +* `key_prefix` - (Optional) S3 path prefix that determines where log files are stored. + +## Attribute Reference + +This resource exports the following attributes in addition to the arguments above: + +* `associated_portal_arns` - List of ARNs of the web portals associated with the session logger. +* `session_logger_arn` - ARN of the session logger. +* `tags_all` - Map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). + +~> **Note:** The `additional_encryption_context` and `customer_managed_key` attributes are computed when not specified and will be populated with values from the AWS API response. + +## Import + +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import WorkSpaces Web Session Logger using the `session_logger_arn`. For example: + +```terraform +import { + to = aws_workspacesweb_session_logger.example + id = "arn:aws:workspaces-web:us-west-2:123456789012:sessionLogger/session_logger-id-12345678" +} +``` + +Using `terraform import`, import WorkSpaces Web Session Logger using the `session_logger_arn`. For example: + +```console +% terraform import aws_workspacesweb_session_logger.example arn:aws:workspaces-web:us-west-2:123456789012:sessionLogger/session_logger-id-12345678 +``` diff --git a/website/docs/r/workspacesweb_session_logger_association.html.markdown b/website/docs/r/workspacesweb_session_logger_association.html.markdown new file mode 100644 index 000000000000..8d6ac70a268c --- /dev/null +++ b/website/docs/r/workspacesweb_session_logger_association.html.markdown @@ -0,0 +1,102 @@ +--- +subcategory: "WorkSpaces Web" +layout: "aws" +page_title: "AWS: aws_workspacesweb_session_logger_association" +description: |- + Terraform resource for managing an AWS WorkSpaces Web Session Logger Association. +--- + +# Resource: aws_workspacesweb_session_logger_association + +Terraform resource for managing an AWS WorkSpaces Web Session Logger Association. + +## Example Usage + +### Basic Usage + +```terraform +resource "aws_workspacesweb_portal" "example" { + display_name = "example" +} + +resource "aws_s3_bucket" "example" { + bucket = "example-session-logs" + force_destroy = true +} + +data "aws_iam_policy_document" "example" { + statement { + effect = "Allow" + principals { + type = "Service" + identifiers = ["workspaces-web.amazonaws.com"] + } + actions = [ + "s3:PutObject" + ] + resources = [ + "${aws_s3_bucket.example.arn}/*" + ] + } +} + +resource "aws_s3_bucket_policy" "example" { + bucket = aws_s3_bucket.example.id + policy = data.aws_iam_policy_document.example.json +} + +resource "aws_workspacesweb_session_logger" "example" { + display_name = "example" + + event_filter { + all = {} + } + + log_configuration { + s3 { + bucket = aws_s3_bucket.example.id + folder_structure = "Flat" + log_file_format = "Json" + } + } + + depends_on = [aws_s3_bucket_policy.example] +} + +resource "aws_workspacesweb_session_logger_association" "example" { + portal_arn = aws_workspacesweb_portal.example.portal_arn + session_logger_arn = aws_workspacesweb_session_logger.example.session_logger_arn +} +``` + +## Argument Reference + +The following arguments are required: + +* `portal_arn` - (Required) ARN of the web portal. +* `session_logger_arn` - (Required) ARN of the session logger. + +The following arguments are optional: + +* `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). + +## 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 WorkSpaces Web Session Logger Association using the `session_logger_arn,portal_arn`. For example: + +```terraform +import { + to = aws_workspacesweb_session_logger_association.example + id = "arn:aws:workspaces-web:us-west-2:123456789012:sessionLogger/session_logger-id-12345678,arn:aws:workspaces-web:us-west-2:123456789012:portal/portal-id-12345678" +} +``` + +Using `terraform import`, import WorkSpaces Web Session Logger Association using the `session_logger_arn,portal_arn`. For example: + +```console +% terraform import aws_workspacesweb_session_logger_association.example arn:aws:workspaces-web:us-west-2:123456789012:sessionLogger/session_logger-id-12345678,arn:aws:workspaces-web:us-west-2:123456789012:portal/portal-id-12345678 +``` diff --git a/website/docs/r/workspacesweb_trust_store.html.markdown b/website/docs/r/workspacesweb_trust_store.html.markdown new file mode 100644 index 000000000000..38a8e5f54a87 --- /dev/null +++ b/website/docs/r/workspacesweb_trust_store.html.markdown @@ -0,0 +1,86 @@ +--- +subcategory: "WorkSpaces Web" +layout: "aws" +page_title: "AWS: aws_workspacesweb_trust_store" +description: |- + Terraform resource for managing an AWS WorkSpaces Web Trust Store. +--- + +# Resource: aws_workspacesweb_trust_store + +Terraform resource for managing an AWS WorkSpaces Web Trust Store. + +## Example Usage + +### Basic Usage + +```terraform +resource "aws_workspacesweb_trust_store" "example" { + certificate { + body = file("certificate.pem") + } +} +``` + +### Multiple Certificates + +```terraform +resource "aws_workspacesweb_trust_store" "example" { + certificate { + body = file("certificate1.pem") + } + + certificate { + body = file("certificate2.pem") + } + + tags = { + Name = "example-trust-store" + } +} +``` + +## Argument Reference + +The following arguments are optional: + +* `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). +* `certificate` - (Optional) Set of certificates to include in the trust store. See [Certificate](#certificate) below. +* `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. + +### Certificate + +* `body` - (Required) Certificate body in PEM format. + +## Attribute Reference + +This resource exports the following attributes in addition to the arguments above: + +* `associated_portal_arns` - List of ARNs of the web portals associated with the trust store. +* `trust_store_arn` - ARN of the trust store. +* `tags_all` - Map of tags assigned to the resource, including those inherited from the provider [`default_tags` configuration block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#default_tags-configuration-block). + +The `certificate` block exports the following additional attributes: + +* `issuer` - Certificate issuer. +* `not_valid_after` - Date and time when the certificate expires in RFC3339 format. +* `not_valid_before` - Date and time when the certificate becomes valid in RFC3339 format. +* `subject` - Certificate subject. +* `thumbprint` - Certificate thumbprint. + +## Import + +In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import WorkSpaces Web Trust Store using the `trust_store_arn`. For example: + +```terraform +import { + to = aws_workspacesweb_trust_store.example + id = "arn:aws:workspaces-web:us-west-2:123456789012:trustStore/trust_store-id-12345678" +} +``` + +Using `terraform import`, import WorkSpaces Web Trust Store using the `trust_store_arn`. For example: + +```console +% terraform import aws_workspacesweb_trust_store.example arn:aws:workspaces-web:us-west-2:123456789012:trustStore/trust_store-id-12345678 +``` diff --git a/website/docs/r/workspacesweb_trust_store_association.html.markdown b/website/docs/r/workspacesweb_trust_store_association.html.markdown new file mode 100644 index 000000000000..93536311fa8a --- /dev/null +++ b/website/docs/r/workspacesweb_trust_store_association.html.markdown @@ -0,0 +1,62 @@ +--- +subcategory: "WorkSpaces Web" +layout: "aws" +page_title: "AWS: aws_workspacesweb_trust_store_association" +description: |- + Terraform resource for managing an AWS WorkSpaces Web Trust Store Association. +--- + +# Resource: aws_workspacesweb_trust_store_association + +Terraform resource for managing an AWS WorkSpaces Web Trust Store Association. + +## Example Usage + +### Basic Usage + +```terraform +resource "aws_workspacesweb_portal" "example" { + display_name = "example" +} + +resource "aws_workspacesweb_trust_store" "example" { + certificate_list = [base64encode(file("certificate.pem"))] +} + +resource "aws_workspacesweb_trust_store_association" "example" { + trust_store_arn = aws_workspacesweb_trust_store.example.trust_store_arn + portal_arn = aws_workspacesweb_portal.example.portal_arn +} +``` + +## Argument Reference + +The following arguments are required: + +* `trust_store_arn` - (Required) ARN of the trust store to associate with the portal. Forces replacement if changed. +* `portal_arn` - (Required) ARN of the portal to associate with the trust store. Forces replacement if changed. + +The following arguments are optional: + +* `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). + +## 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 WorkSpaces Web Trust Store Association using the `trust_store_arn,portal_arn`. For example: + +```terraform +import { + to = aws_workspacesweb_trust_store_association.example + id = "arn:aws:workspaces-web:us-west-2:123456789012:trustStore/trust_store-id-12345678,arn:aws:workspaces-web:us-west-2:123456789012:portal/portal-id-12345678" +} +``` + +Using `terraform import`, import WorkSpaces Web Trust Store Association using the `trust_store_arn,portal_arn`. For example: + +```console +% terraform import aws_workspacesweb_trust_store_association.example arn:aws:workspaces-web:us-west-2:123456789012:trustStore/trust_store-id-12345678,arn:aws:workspaces-web:us-west-2:123456789012:portal/portal-id-12345678 +``` diff --git a/website/docs/r/workspacesweb_user_access_logging_settings_association.html.markdown b/website/docs/r/workspacesweb_user_access_logging_settings_association.html.markdown new file mode 100644 index 000000000000..4dbaa27c57b3 --- /dev/null +++ b/website/docs/r/workspacesweb_user_access_logging_settings_association.html.markdown @@ -0,0 +1,61 @@ +--- +subcategory: "WorkSpaces Web" +layout: "aws" +page_title: "AWS: aws_workspacesweb_user_access_logging_settings_association" +description: |- + Terraform resource for managing an AWS WorkSpaces Web User Access Logging Settings Association. +--- + +# Resource: aws_workspacesweb_user_access_logging_settings_association + +Terraform resource for managing an AWS WorkSpaces Web User Access Logging Settings Association. + +## Example Usage + +### Basic Usage + +```terraform +resource "aws_workspacesweb_portal" "example" { + display_name = "example" +} + +resource "aws_kinesis_stream" "example" { + name = "amazon-workspaces-web-example" + shard_count = 1 +} + +resource "aws_workspacesweb_user_access_logging_settings" "example" { + kinesis_stream_arn = aws_kinesis_stream.example.arn +} + +resource "aws_workspacesweb_user_access_logging_settings_association" "example" { + user_access_logging_settings_arn = aws_workspacesweb_user_access_logging_settings.example.user_access_logging_settings_arn + portal_arn = aws_workspacesweb_portal.example.portal_arn +} +``` + +## Argument Reference + +The following arguments are required: + +* `user_access_logging_settings_arn` - (Required) ARN of the user access logging settings to associate with the portal. Forces replacement if changed. +* `portal_arn` - (Required) ARN of the portal to associate with the user access logging settings. Forces replacement if changed. + +The following arguments are optional: + +* `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). + +## 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 WorkSpaces Web User Access Logging Settings Association using the `user_access_logging_settings_arn,portal_arn`. For example: + +```terraform +import { + to = aws_workspacesweb_user_access_logging_settings_association.example + id = "arn:aws:workspaces-web:us-west-2:123456789012:userAccessLoggingSettings/user_access_logging_settings-id-12345678,arn:aws:workspaces-web:us-west-2:123456789012:portal/portal-id-12345678" +} +``` diff --git a/website/docs/r/workspacesweb_user_settings_association.html.markdown b/website/docs/r/workspacesweb_user_settings_association.html.markdown new file mode 100644 index 000000000000..1f403cf2ecb1 --- /dev/null +++ b/website/docs/r/workspacesweb_user_settings_association.html.markdown @@ -0,0 +1,60 @@ +--- +subcategory: "WorkSpaces Web" +layout: "aws" +page_title: "AWS: aws_workspacesweb_user_settings_association" +description: |- + Terraform resource for managing an AWS WorkSpaces Web User Settings Association. +--- + +# Resource: aws_workspacesweb_user_settings_association + +Terraform resource for managing an AWS WorkSpaces Web User Settings Association. + +## Example Usage + +### Basic Usage + +```terraform +resource "aws_workspacesweb_portal" "example" { + display_name = "example" +} + +resource "aws_workspacesweb_user_settings" "example" { + copy_allowed = "Enabled" + download_allowed = "Enabled" + paste_allowed = "Enabled" + print_allowed = "Enabled" + upload_allowed = "Enabled" +} + +resource "aws_workspacesweb_user_settings_association" "example" { + user_settings_arn = aws_workspacesweb_user_settings.example.user_settings_arn + portal_arn = aws_workspacesweb_portal.example.portal_arn +} +``` + +## Argument Reference + +The following arguments are required: + +* `user_settings_arn` - (Required) ARN of the user settings to associate with the portal. Forces replacement if changed. +* `portal_arn` - (Required) ARN of the portal to associate with the user settings. Forces replacement if changed. + +The following arguments are optional: + +* `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). + +## 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 WorkSpaces Web User Settings Association using the `user_settings_arn,portal_arn`. For example: + +```terraform +import { + to = aws_workspacesweb_user_settings_association.example + id = "arn:aws:workspaces-web:us-west-2:123456789012:userSettings/user_settings-id-12345678,arn:aws:workspaces-web:us-west-2:123456789012:portal/portal-id-12345678" +} +```