Skip to content

Commit

Permalink
Merge pull request #1307 from hashicorp/f-11-08-2023-schema-updates
Browse files Browse the repository at this point in the history
11/08/2023 CloudFormation schema refresh
  • Loading branch information
ewbankkit authored Nov 9, 2023
2 parents b7b4f86 + d664477 commit e863e75
Show file tree
Hide file tree
Showing 218 changed files with 18,048 additions and 1,742 deletions.
22 changes: 22 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,27 @@
## 0.64.0 (Unreleased)

FEATURES:

* **New Data Source:** `awscc_appconfig_configuration_profile`
* **New Data Source:** `awscc_cognito_user_pool_user_to_group_attachment`
* **New Data Source:** `awscc_ec2_vpc_gateway_attachment`
* **New Data Source:** `awscc_ec2_vpc_gateway_attachments`
* **New Data Source:** `awscc_events_rule`
* **New Data Source:** `awscc_events_rules`
* **New Data Source:** `awscc_iam_user`
* **New Data Source:** `awscc_iam_users`
* **New Data Source:** `awscc_medialive_multiplex`
* **New Data Source:** `awscc_medialive_multiplexes`
* **New Data Source:** `awscc_medialive_multiplexprogram`
* **New Data Source:** `awscc_route53resolver_firewall_domain_lists`
* **New Resource:** `awscc_appconfig_configuration_profile`
* **New Resource:** `awscc_cognito_user_pool_user_to_group_attachment`
* **New Resource:** `awscc_ec2_vpc_gateway_attachment`
* **New Resource:** `awscc_events_rule`
* **New Resource:** `awscc_iam_user`
* **New Resource:** `awscc_medialive_multiplex`
* **New Resource:** `awscc_medialive_multiplexprogram`

BREAKING CHANGES:

* resource/awscc_apigatewayv2_api: `body` attribute's type has changed from `Map of String` to `String` and must be valid JSON
Expand Down
23 changes: 12 additions & 11 deletions docs/data-sources/apigateway_api_key.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,23 +21,24 @@ Data Source schema for AWS::ApiGateway::ApiKey

### Read-Only

- `api_key_id` (String) A Unique Key ID which identifies the API Key. Generated by the Create API and returned by the Read and List APIs
- `customer_id` (String) An AWS Marketplace customer identifier to use when integrating with the AWS SaaS Marketplace.
- `description` (String) A description of the purpose of the API key.
- `enabled` (Boolean) Indicates whether the API key can be used by clients.
- `generate_distinct_id` (Boolean) Specifies whether the key identifier is distinct from the created API key value. This parameter is deprecated and should not be used.
- `name` (String) A name for the API key. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the API key name.
- `stage_keys` (Attributes List) A list of stages to associate with this API key. (see [below for nested schema](#nestedatt--stage_keys))
- `tags` (Attributes List) An array of arbitrary tags (key-value pairs) to associate with the API key. (see [below for nested schema](#nestedatt--tags))
- `value` (String) The value of the API key. Must be at least 20 characters long.
- `api_key_id` (String)
- `customer_id` (String) An MKT customer identifier, when integrating with the AWS SaaS Marketplace.
- `description` (String) The description of the ApiKey.
- `enabled` (Boolean) Specifies whether the ApiKey can be used by callers.
- `generate_distinct_id` (Boolean) Specifies whether (``true``) or not (``false``) the key identifier is distinct from the created API key value. This parameter is deprecated and should not be used.
- `name` (String) A name for the API key. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the API key name. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html).
If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
- `stage_keys` (Attributes List) DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key. (see [below for nested schema](#nestedatt--stage_keys))
- `tags` (Attributes List) The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with ``aws:``. The tag value can be up to 256 characters. (see [below for nested schema](#nestedatt--tags))
- `value` (String) Specifies a value of the API key.

<a id="nestedatt--stage_keys"></a>
### Nested Schema for `stage_keys`

Read-Only:

- `rest_api_id` (String) The ID of a RestApi resource that includes the stage with which you want to associate the API key.
- `stage_name` (String) The name of the stage with which to associate the API key. The stage must be included in the RestApi resource that you specified in the RestApiId property.
- `rest_api_id` (String) The string identifier of the associated RestApi.
- `stage_name` (String) The stage name associated with the stage key.


<a id="nestedatt--tags"></a>
Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/apigateway_client_certificate.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Data Source schema for AWS::ApiGateway::ClientCertificate

### Read-Only

- `client_certificate_id` (String) The Primary Identifier of the Client Certficate, generated by a Create API Call
- `client_certificate_id` (String)
- `description` (String) The description of the client certificate.
- `tags` (Attributes List) The collection of tags. Each tag element is associated with a given resource. (see [below for nested schema](#nestedatt--tags))

Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/apigateway_deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Data Source schema for AWS::ApiGateway::Deployment
### Read-Only

- `deployment_canary_settings` (Attributes) The input configuration for a canary deployment. (see [below for nested schema](#nestedatt--deployment_canary_settings))
- `deployment_id` (String) Primary Id for this resource
- `deployment_id` (String)
- `description` (String) The description for the Deployment resource to create.
- `rest_api_id` (String) The string identifier of the associated RestApi.
- `stage_description` (Attributes) The description of the Stage resource for the Deployment resource to create. To specify a stage description, you must also provide a stage name. (see [below for nested schema](#nestedatt--stage_description))
Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/apigateway_documentation_part.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Data Source schema for AWS::ApiGateway::DocumentationPart

### Read-Only

- `documentation_part_id` (String) The identifier of the documentation Part.
- `documentation_part_id` (String)
- `location` (Attributes) The location of the targeted API entity of the to-be-created documentation part. (see [below for nested schema](#nestedatt--location))
- `properties` (String) The new documentation content map of the targeted API entity. Enclosed key-value pairs are API-specific, but only OpenAPI-compliant key-value pairs can be exported and, hence, published.
- `rest_api_id` (String) The string identifier of the associated RestApi.
Expand Down
10 changes: 5 additions & 5 deletions docs/data-sources/apigateway_request_validator.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ Data Source schema for AWS::ApiGateway::RequestValidator

### Read-Only

- `name` (String) Name of the request validator.
- `request_validator_id` (String) ID of the request validator.
- `rest_api_id` (String) The identifier of the targeted API entity.
- `validate_request_body` (Boolean) Indicates whether to validate the request body according to the configured schema for the targeted API and method.
- `validate_request_parameters` (Boolean) Indicates whether to validate request parameters.
- `name` (String) The name of this RequestValidator
- `request_validator_id` (String)
- `rest_api_id` (String) The string identifier of the associated RestApi.
- `validate_request_body` (Boolean) A Boolean flag to indicate whether to validate a request body according to the configured Model schema.
- `validate_request_parameters` (Boolean) A Boolean flag to indicate whether to validate request parameters (``true``) or not (``false``).
2 changes: 1 addition & 1 deletion docs/data-sources/apigateway_resource.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,5 +23,5 @@ Data Source schema for AWS::ApiGateway::Resource

- `parent_id` (String) The parent resource's identifier.
- `path_part` (String) The last path segment for this resource.
- `resource_id` (String) A unique primary identifier for a Resource
- `resource_id` (String)
- `rest_api_id` (String) The string identifier of the associated RestApi.
32 changes: 16 additions & 16 deletions docs/data-sources/apigateway_usage_plan.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,29 +21,29 @@ Data Source schema for AWS::ApiGateway::UsagePlan

### Read-Only

- `api_stages` (Attributes List) The API stages to associate with this usage plan. (see [below for nested schema](#nestedatt--api_stages))
- `description` (String) A description of the usage plan.
- `quota` (Attributes) Configures the number of requests that users can make within a given interval. (see [below for nested schema](#nestedatt--quota))
- `tags` (Attributes List) An array of arbitrary tags (key-value pairs) to associate with the usage plan. (see [below for nested schema](#nestedatt--tags))
- `throttle` (Attributes) Configures the overall request rate (average requests per second) and burst capacity. (see [below for nested schema](#nestedatt--throttle))
- `usage_plan_name` (String) A name for the usage plan.
- `api_stages` (Attributes List) The associated API stages of a usage plan. (see [below for nested schema](#nestedatt--api_stages))
- `description` (String) The description of a usage plan.
- `quota` (Attributes) The target maximum number of permitted requests per a given unit time interval. (see [below for nested schema](#nestedatt--quota))
- `tags` (Attributes List) The collection of tags. Each tag element is associated with a given resource. (see [below for nested schema](#nestedatt--tags))
- `throttle` (Attributes) A map containing method level throttling information for API stage in a usage plan. (see [below for nested schema](#nestedatt--throttle))
- `usage_plan_name` (String) The name of a usage plan.

<a id="nestedatt--api_stages"></a>
### Nested Schema for `api_stages`

Read-Only:

- `api_id` (String) The ID of an API that is in the specified Stage property that you want to associate with the usage plan.
- `stage` (String) The name of the stage to associate with the usage plan.
- `throttle` (Attributes Map) Map containing method-level throttling information for an API stage in a usage plan. The key for the map is the path and method for which to configure custom throttling, for example, '/pets/GET'. Duplicates are not allowed. (see [below for nested schema](#nestedatt--api_stages--throttle))
- `api_id` (String) API Id of the associated API stage in a usage plan.
- `stage` (String) API stage name of the associated API stage in a usage plan.
- `throttle` (Attributes Map) Map containing method level throttling information for API stage in a usage plan. (see [below for nested schema](#nestedatt--api_stages--throttle))

<a id="nestedatt--api_stages--throttle"></a>
### Nested Schema for `api_stages.throttle`

Read-Only:

- `burst_limit` (Number) The maximum API request rate limit over a time ranging from one to a few seconds. The maximum API request rate limit depends on whether the underlying token bucket is at its full capacity.
- `rate_limit` (Number) The API request steady-state rate limit (average requests per second over an extended period of time).
- `burst_limit` (Number) The API target request burst rate limit. This allows more requests through for a period of time than the target rate limit.
- `rate_limit` (Number) The API target request rate limit.



Expand All @@ -52,9 +52,9 @@ Read-Only:

Read-Only:

- `limit` (Number) The maximum number of requests that users can make within the specified time period.
- `offset` (Number) For the initial time period, the number of requests to subtract from the specified limit. When you first implement a usage plan, the plan might start in the middle of the week or month. With this property, you can decrease the limit for this initial time period.
- `period` (String) The time period for which the maximum limit of requests applies, such as DAY or WEEK. For valid values, see the period property for the UsagePlan resource in the Amazon API Gateway REST API Reference.
- `limit` (Number) The target maximum number of requests that can be made in a given time period.
- `offset` (Number) The number of requests subtracted from the given limit in the initial time period.
- `period` (String) The time period in which the limit applies. Valid values are "DAY", "WEEK" or "MONTH".


<a id="nestedatt--tags"></a>
Expand All @@ -71,5 +71,5 @@ Read-Only:

Read-Only:

- `burst_limit` (Number) The maximum API request rate limit over a time ranging from one to a few seconds. The maximum API request rate limit depends on whether the underlying token bucket is at its full capacity.
- `rate_limit` (Number) The API request steady-state rate limit (average requests per second over an extended period of time).
- `burst_limit` (Number) The API target request burst rate limit. This allows more requests through for a period of time than the target rate limit.
- `rate_limit` (Number) The API target request rate limit.
2 changes: 1 addition & 1 deletion docs/data-sources/appconfig_application.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,5 +31,5 @@ Data Source schema for AWS::AppConfig::Application

Read-Only:

- `key` (String) The key-value string map. The valid character set is [a-zA-Z1-9+-=._:/]. The tag key can be up to 128 characters and must not start with aws:.
- `key` (String) The key-value string map. The valid character set is [a-zA-Z1-9 +-=._:/-]. The tag key can be up to 128 characters and must not start with aws:.
- `value` (String) The tag value can be up to 256 characters.
51 changes: 51 additions & 0 deletions docs/data-sources/appconfig_configuration_profile.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "awscc_appconfig_configuration_profile Data Source - terraform-provider-awscc"
subcategory: ""
description: |-
Data Source schema for AWS::AppConfig::ConfigurationProfile
---

# awscc_appconfig_configuration_profile (Data Source)

Data Source schema for AWS::AppConfig::ConfigurationProfile



<!-- schema generated by tfplugindocs -->
## Schema

### Required

- `id` (String) Uniquely identifies the resource.

### Read-Only

- `application_id` (String) The application ID.
- `configuration_profile_id` (String) The configuration profile ID
- `description` (String) A description of the configuration profile.
- `kms_key_arn` (String) The Amazon Resource Name of the AWS Key Management Service key to encrypt new configuration data versions in the AWS AppConfig hosted configuration store. This attribute is only used for hosted configuration types. To encrypt data managed in other configuration stores, see the documentation for how to specify an AWS KMS key for that particular service.
- `kms_key_identifier` (String) The AWS Key Management Service key identifier (key ID, key alias, or key ARN) provided when the resource was created or updated.
- `location_uri` (String) A 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.
- `name` (String) A name for the configuration profile.
- `retrieval_role_arn` (String) The ARN of an IAM role with permission to access the configuration at the specified LocationUri.
- `tags` (Attributes List) Metadata to assign to the configuration profile. Tags help organize and categorize your AWS AppConfig resources. Each tag consists of a key and an optional value, both of which you define. (see [below for nested schema](#nestedatt--tags))
- `type` (String) The type of configurations contained in the profile. When calling this API, enter one of the following values for Type: AWS.AppConfig.FeatureFlags, AWS.Freeform
- `validators` (Attributes List) A list of methods for validating the configuration. (see [below for nested schema](#nestedatt--validators))

<a id="nestedatt--tags"></a>
### Nested Schema for `tags`

Read-Only:

- `key` (String) The key-value string map. The tag key can be up to 128 characters and must not start with aws:.
- `value` (String) The tag value can be up to 256 characters.


<a id="nestedatt--validators"></a>
### Nested Schema for `validators`

Read-Only:

- `content` (String) Either the JSON Schema content or the Amazon Resource Name (ARN) of an Lambda function.
- `type` (String) AWS AppConfig supports validators of type JSON_SCHEMA and LAMBDA.
1 change: 1 addition & 0 deletions docs/data-sources/apprunner_service.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@ Read-Only:

- `egress_configuration` (Attributes) Network egress configuration (see [below for nested schema](#nestedatt--network_configuration--egress_configuration))
- `ingress_configuration` (Attributes) Network ingress configuration (see [below for nested schema](#nestedatt--network_configuration--ingress_configuration))
- `ip_address_type` (String) App Runner service endpoint IP address type

<a id="nestedatt--network_configuration--egress_configuration"></a>
### Nested Schema for `network_configuration.egress_configuration`
Expand Down
26 changes: 26 additions & 0 deletions docs/data-sources/cognito_user_pool_user_to_group_attachment.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "awscc_cognito_user_pool_user_to_group_attachment Data Source - terraform-provider-awscc"
subcategory: ""
description: |-
Data Source schema for AWS::Cognito::UserPoolUserToGroupAttachment
---

# awscc_cognito_user_pool_user_to_group_attachment (Data Source)

Data Source schema for AWS::Cognito::UserPoolUserToGroupAttachment



<!-- schema generated by tfplugindocs -->
## Schema

### Required

- `id` (String) Uniquely identifies the resource.

### Read-Only

- `group_name` (String)
- `user_pool_id` (String)
- `username` (String)
1 change: 1 addition & 0 deletions docs/data-sources/ec2_ipam.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ Data Source schema for AWS::EC2::IPAM
- `resource_discovery_association_count` (Number) The count of resource discoveries associated with this IPAM.
- `scope_count` (Number) The number of scopes that currently exist in this IPAM.
- `tags` (Attributes Set) An array of key-value pairs to apply to this resource. (see [below for nested schema](#nestedatt--tags))
- `tier` (String) The tier of the IPAM.

<a id="nestedatt--operating_regions"></a>
### Nested Schema for `operating_regions`
Expand Down
2 changes: 2 additions & 0 deletions docs/data-sources/ec2_subnet.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,11 @@ Data Source schema for AWS::EC2::Subnet
- `availability_zone_id` (String)
- `cidr_block` (String)
- `enable_dns_64` (Boolean)
- `ipv_4_netmask_length` (Number) The netmask length of the IPv4 CIDR you want to allocate to this subnet from an Amazon VPC IP Address Manager (IPAM) pool
- `ipv_6_cidr_block` (String)
- `ipv_6_cidr_blocks` (List of String)
- `ipv_6_native` (Boolean)
- `ipv_6_netmask_length` (Number) The netmask length of the IPv6 CIDR you want to allocate to this subnet from an Amazon VPC IP Address Manager (IPAM) pool
- `map_public_ip_on_launch` (Boolean)
- `network_acl_association_id` (String)
- `outpost_arn` (String)
Expand Down
27 changes: 27 additions & 0 deletions docs/data-sources/ec2_vpc_gateway_attachment.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "awscc_ec2_vpc_gateway_attachment Data Source - terraform-provider-awscc"
subcategory: ""
description: |-
Data Source schema for AWS::EC2::VPCGatewayAttachment
---

# awscc_ec2_vpc_gateway_attachment (Data Source)

Data Source schema for AWS::EC2::VPCGatewayAttachment



<!-- schema generated by tfplugindocs -->
## Schema

### Required

- `id` (String) Uniquely identifies the resource.

### Read-Only

- `attachment_type` (String) Used to identify if this resource is an Internet Gateway or Vpn Gateway Attachment
- `internet_gateway_id` (String) The ID of the internet gateway. You must specify either InternetGatewayId or VpnGatewayId, but not both.
- `vpc_id` (String) The ID of the VPC.
- `vpn_gateway_id` (String) The ID of the virtual private gateway. You must specify either InternetGatewayId or VpnGatewayId, but not both.
21 changes: 21 additions & 0 deletions docs/data-sources/ec2_vpc_gateway_attachments.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "awscc_ec2_vpc_gateway_attachments Data Source - terraform-provider-awscc"
subcategory: ""
description: |-
Plural Data Source schema for AWS::EC2::VPCGatewayAttachment
---

# awscc_ec2_vpc_gateway_attachments (Data Source)

Plural Data Source schema for AWS::EC2::VPCGatewayAttachment



<!-- schema generated by tfplugindocs -->
## Schema

### Read-Only

- `id` (String) Uniquely identifies the data source.
- `ids` (Set of String) Set of Resource Identifiers.
Loading

0 comments on commit e863e75

Please sign in to comment.