Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

11-08-2024 Schema Updates #2096

Merged
merged 6 commits into from
Nov 8, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,23 @@
## 1.20.0 (Unreleased)

* **New Data Source:** `awscc_appsync_channel_namespace`
* **New Data Source:** `awscc_bedrock_application_inference_profile`
* **New Data Source:** `awscc_bedrock_application_inference_profiles`
* **New Data Source:** `awscc_ec2_security_group_vpc_association`
* **New Data Source:** `awscc_ec2_security_group_vpc_associations`
* **New Data Source:** `awscc_rds_db_shard_group`
* **New Data Source:** `awscc_rds_db_shard_groups`
* **New Data Source:** `awscc_wisdom_ai_agent`
* **New Data Source:** `awscc_wisdom_ai_agent_version`
* **New Data Source:** `awscc_wisdom_ai_prompt_version`
* **New Resource:** `awscc_appsync_channel_namespace`
* **New Resource:** `awscc_bedrock_application_inference_profile`
* **New Resource:** `awscc_ec2_security_group_vpc_association`
* **New Resource:** `awscc_rds_db_shard_group`
* **New Resource:** `awscc_wisdom_ai_agent`
* **New Resource:** `awscc_wisdom_ai_agent_version`
* **New Resource:** `awscc_wisdom_ai_prompt_version`

## 1.19.0 (October 31, 2024)

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

- `account_id` (String)
- `cloudwatch_role_arn` (String) The ARN of an Amazon CloudWatch role for the current Account.
- `cloudwatch_role_arn` (String)
18 changes: 9 additions & 9 deletions docs/data-sources/apigateway_api_key.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,23 +22,23 @@ Data Source schema for AWS::ApiGateway::ApiKey
### Read-Only

- `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.
- `customer_id` (String)
- `description` (String)
- `enabled` (Boolean)
- `generate_distinct_id` (Boolean)
- `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.
- `stage_keys` (Attributes List) (see [below for nested schema](#nestedatt--stage_keys))
- `tags` (Attributes List) (see [below for nested schema](#nestedatt--tags))
- `value` (String)

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

Read-Only:

- `rest_api_id` (String) The string identifier of the associated RestApi.
- `stage_name` (String) The stage name associated with the stage key.
- `rest_api_id` (String)
- `stage_name` (String)


<a id="nestedatt--tags"></a>
Expand Down
20 changes: 10 additions & 10 deletions docs/data-sources/apigateway_authorizer.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,14 @@ Data Source schema for AWS::ApiGateway::Authorizer

### Read-Only

- `auth_type` (String) Optional customer-defined field, used in OpenAPI imports and exports without functional impact.
- `authorizer_credentials` (String) Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.
- `auth_type` (String)
- `authorizer_credentials` (String)
- `authorizer_id` (String)
- `authorizer_result_ttl_in_seconds` (Number) The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.
- `authorizer_uri` (String) Specifies the authorizer's Uniform Resource Identifier (URI). For ``TOKEN`` or ``REQUEST`` authorizers, this must be a well-formed Lambda function URI, for example, ``arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations``. In general, the URI has this form ``arn:aws:apigateway:{region}:lambda:path/{service_api}``, where ``{region}`` is the same as the region hosting the Lambda function, ``path`` indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial ``/``. For Lambda functions, this is usually of the form ``/2015-03-31/functions/[FunctionARN]/invocations``.
- `identity_source` (String) The identity source for which authorization is requested. For a ``TOKEN`` or ``COGNITO_USER_POOLS`` authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is ``Auth``, the header mapping expression is ``method.request.header.Auth``. For the ``REQUEST`` authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an ``Auth`` header, a ``Name`` query string parameter are defined as identity sources, this value is ``method.request.header.Auth, method.request.querystring.Name``. These parameters will be used to derive the authorization caching key and to perform runtime validation of the ``REQUEST`` authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.
- `identity_validation_expression` (String) A validation expression for the incoming identity token. For ``TOKEN`` authorizers, this value is a regular expression. For ``COGNITO_USER_POOLS`` authorizers, API Gateway will match the ``aud`` field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the ``REQUEST`` authorizer.
- `name` (String) The name of the authorizer.
- `provider_ar_ns` (Set of String) A list of the Amazon Cognito user pool ARNs for the ``COGNITO_USER_POOLS`` authorizer. Each element is of this format: ``arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}``. For a ``TOKEN`` or ``REQUEST`` authorizer, this is not defined.
- `rest_api_id` (String) The string identifier of the associated RestApi.
- `type` (String) The authorizer type. Valid values are ``TOKEN`` for a Lambda function using a single authorization token submitted in a custom header, ``REQUEST`` for a Lambda function using incoming request parameters, and ``COGNITO_USER_POOLS`` for using an Amazon Cognito user pool.
- `authorizer_result_ttl_in_seconds` (Number)
- `authorizer_uri` (String)
- `identity_source` (String)
- `identity_validation_expression` (String)
- `name` (String)
- `provider_ar_ns` (Set of String)
- `rest_api_id` (String)
- `type` (String)
8 changes: 4 additions & 4 deletions docs/data-sources/apigateway_base_path_mapping.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Data Source schema for AWS::ApiGateway::BasePathMapping

### Read-Only

- `base_path` (String) The base path name that callers of the API must provide as part of the URL after the domain name.
- `domain_name` (String) The domain name of the BasePathMapping resource to be described.
- `rest_api_id` (String) The string identifier of the associated RestApi.
- `stage` (String) The name of the associated stage.
- `base_path` (String)
- `domain_name` (String)
- `rest_api_id` (String)
- `stage` (String)
4 changes: 2 additions & 2 deletions docs/data-sources/apigateway_client_certificate.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@ Data Source schema for AWS::ApiGateway::ClientCertificate
### Read-Only

- `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))
- `description` (String)
- `tags` (Attributes List) (see [below for nested schema](#nestedatt--tags))

<a id="nestedatt--tags"></a>
### Nested Schema for `tags`
Expand Down
42 changes: 21 additions & 21 deletions docs/data-sources/apigateway_deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,21 +21,21 @@ 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_canary_settings` (Attributes) The ``DeploymentCanarySettings`` property type specifies settings for the canary deployment. (see [below for nested schema](#nestedatt--deployment_canary_settings))
- `deployment_id` (String)
- `description` (String) The description for the Deployment resource to create.
- `rest_api_id` (String) The string identifier of the associated RestApi.
- `description` (String)
- `rest_api_id` (String)
- `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))
- `stage_name` (String) The name of the Stage resource for the Deployment resource to create.
- `stage_name` (String)

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

Read-Only:

- `percent_traffic` (Number) The percentage (0.0-100.0) of traffic routed to the canary deployment.
- `stage_variable_overrides` (Map of String) A 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) A Boolean flag to indicate whether the canary release deployment uses the stage cache or not.
- `percent_traffic` (Number)
- `stage_variable_overrides` (Map of String)
- `use_stage_cache` (Boolean)


<a id="nestedatt--stage_description"></a>
Expand All @@ -44,7 +44,7 @@ Read-Only:
Read-Only:

- `access_log_setting` (Attributes) Specifies settings for logging access in this stage. (see [below for nested schema](#nestedatt--stage_description--access_log_setting))
- `cache_cluster_enabled` (Boolean) Specifies whether a cache cluster is enabled for the stage.
- `cache_cluster_enabled` (Boolean)
- `cache_cluster_size` (String) The size of the stage's cache cluster. For more information, see [cacheClusterSize](https://docs.aws.amazon.com/apigateway/latest/api/API_CreateStage.html#apigw-CreateStage-request-cacheClusterSize) in the *API Gateway API Reference*.
- `cache_data_encrypted` (Boolean) Indicates whether the cached responses are encrypted.
- `cache_ttl_in_seconds` (Number) The time-to-live (TTL) period, in seconds, that specifies how long API Gateway caches responses.
Expand All @@ -69,35 +69,35 @@ Read-Only:

Read-Only:

- `destination_arn` (String) The Amazon Resource Name (ARN) of the CloudWatch Logs log group or Kinesis Data Firehose delivery stream to receive access logs. If you specify a Kinesis Data Firehose delivery stream, the stream name must begin with ``amazon-apigateway-``.
- `format` (String) A single line format of the access logs of data, as specified by selected $context variables. The format must include at least ``$context.requestId``.
- `destination_arn` (String)
- `format` (String)


<a id="nestedatt--stage_description--canary_setting"></a>
### Nested Schema for `stage_description.canary_setting`

Read-Only:

- `percent_traffic` (Number) The percent (0-100) of traffic diverted to a canary deployment.
- `stage_variable_overrides` (Map of String) Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values.
- `use_stage_cache` (Boolean) A Boolean flag to indicate whether the canary deployment uses the stage cache or not.
- `percent_traffic` (Number)
- `stage_variable_overrides` (Map of String)
- `use_stage_cache` (Boolean)


<a id="nestedatt--stage_description--method_settings"></a>
### Nested Schema for `stage_description.method_settings`

Read-Only:

- `cache_data_encrypted` (Boolean) Specifies whether the cached responses are encrypted.
- `cache_ttl_in_seconds` (Number) Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response will be cached.
- `caching_enabled` (Boolean) Specifies whether responses should be cached and returned for requests. A cache cluster must be enabled on the stage for responses to be cached.
- `data_trace_enabled` (Boolean) Specifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon CloudWatch Logs. This can be useful to troubleshoot APIs, but can result in logging sensitive data. We recommend that you don't enable this option for production APIs.
- `cache_data_encrypted` (Boolean)
- `cache_ttl_in_seconds` (Number)
- `caching_enabled` (Boolean)
- `data_trace_enabled` (Boolean)
- `http_method` (String) The HTTP method.
- `logging_level` (String) Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs. Valid values are ``OFF``, ``ERROR``, and ``INFO``. Choose ``ERROR`` to write only error-level entries to CloudWatch Logs, or choose ``INFO`` to include all ``ERROR`` events as well as extra informational events.
- `metrics_enabled` (Boolean) Specifies whether Amazon CloudWatch metrics are enabled for this method.
- `logging_level` (String)
- `metrics_enabled` (Boolean)
- `resource_path` (String) The resource path for this method. Forward slashes (``/``) are encoded as ``~1`` and the initial slash must include a forward slash. For example, the path value ``/resource/subresource`` must be encoded as ``/~1resource~1subresource``. To specify the root path, use only a slash (``/``).
- `throttling_burst_limit` (Number) Specifies the throttling burst limit.
- `throttling_rate_limit` (Number) Specifies the throttling rate limit.
- `throttling_burst_limit` (Number)
- `throttling_rate_limit` (Number)


<a id="nestedatt--stage_description--tags"></a>
Expand Down
17 changes: 9 additions & 8 deletions docs/data-sources/apigateway_documentation_part.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,17 +22,18 @@ Data Source schema for AWS::ApiGateway::DocumentationPart
### Read-Only

- `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.
- `location` (Attributes) The ``Location`` property specifies the location of the Amazon API Gateway API entity that the documentation applies to. ``Location`` is a property of the [AWS::ApiGateway::DocumentationPart](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationpart.html) resource.
For more information about each property, including constraints and valid values, see [DocumentationPart](https://docs.aws.amazon.com/apigateway/latest/api/API_DocumentationPartLocation.html) in the *Amazon API Gateway REST API Reference*. (see [below for nested schema](#nestedatt--location))
- `properties` (String)
- `rest_api_id` (String)

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

Read-Only:

- `method` (String) The HTTP verb of a method. It is a valid field for the API entity types of ``METHOD``, ``PATH_PARAMETER``, ``QUERY_PARAMETER``, ``REQUEST_HEADER``, ``REQUEST_BODY``, ``RESPONSE``, ``RESPONSE_HEADER``, and ``RESPONSE_BODY``. The default value is ``*`` for any method. When an applicable child entity inherits the content of an entity of the same type with more general specifications of the other ``location`` attributes, the child entity's ``method`` attribute must match that of the parent entity exactly.
- `name` (String) The name of the targeted API entity. It is a valid and required field for the API entity types of ``AUTHORIZER``, ``MODEL``, ``PATH_PARAMETER``, ``QUERY_PARAMETER``, ``REQUEST_HEADER``, ``REQUEST_BODY`` and ``RESPONSE_HEADER``. It is an invalid field for any other entity type.
- `path` (String) The URL path of the target. It is a valid field for the API entity types of ``RESOURCE``, ``METHOD``, ``PATH_PARAMETER``, ``QUERY_PARAMETER``, ``REQUEST_HEADER``, ``REQUEST_BODY``, ``RESPONSE``, ``RESPONSE_HEADER``, and ``RESPONSE_BODY``. The default value is ``/`` for the root resource. When an applicable child entity inherits the content of another entity of the same type with more general specifications of the other ``location`` attributes, the child entity's ``path`` attribute must match that of the parent entity as a prefix.
- `status_code` (String) The HTTP status code of a response. It is a valid field for the API entity types of ``RESPONSE``, ``RESPONSE_HEADER``, and ``RESPONSE_BODY``. The default value is ``*`` for any status code. When an applicable child entity inherits the content of an entity of the same type with more general specifications of the other ``location`` attributes, the child entity's ``statusCode`` attribute must match that of the parent entity exactly.
- `type` (String) The type of API entity to which the documentation content applies. Valid values are ``API``, ``AUTHORIZER``, ``MODEL``, ``RESOURCE``, ``METHOD``, ``PATH_PARAMETER``, ``QUERY_PARAMETER``, ``REQUEST_HEADER``, ``REQUEST_BODY``, ``RESPONSE``, ``RESPONSE_HEADER``, and ``RESPONSE_BODY``. Content inheritance does not apply to any entity of the ``API``, ``AUTHORIZER``, ``METHOD``, ``MODEL``, ``REQUEST_BODY``, or ``RESOURCE`` type.
- `method` (String)
- `name` (String)
- `path` (String)
- `status_code` (String)
- `type` (String)
6 changes: 3 additions & 3 deletions docs/data-sources/apigateway_documentation_version.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,6 @@ Data Source schema for AWS::ApiGateway::DocumentationVersion

### Read-Only

- `description` (String) A description about the new documentation snapshot.
- `documentation_version` (String) The version identifier of the to-be-updated documentation version.
- `rest_api_id` (String) The string identifier of the associated RestApi.
- `description` (String)
- `documentation_version` (String)
- `rest_api_id` (String)
10 changes: 5 additions & 5 deletions docs/data-sources/apigateway_gateway_response.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@ Data Source schema for AWS::ApiGateway::GatewayResponse
### Read-Only

- `gateway_response_id` (String)
- `response_parameters` (Map of String) Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.
- `response_templates` (Map of String) Response templates of the GatewayResponse as a string-to-string map of key-value pairs.
- `response_type` (String) The response type of the associated GatewayResponse.
- `rest_api_id` (String) The string identifier of the associated RestApi.
- `status_code` (String) The HTTP status code for this GatewayResponse.
- `response_parameters` (Map of String)
- `response_templates` (Map of String)
- `response_type` (String)
- `rest_api_id` (String)
- `status_code` (String)
Loading
Loading