generated from hashicorp/terraform-provider-scaffolding
-
Notifications
You must be signed in to change notification settings - Fork 121
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #2085 from hashicorp/f-10-30-2024-schema-updates
10-30-2024 Schema Updates
- Loading branch information
Showing
146 changed files
with
13,477 additions
and
1,278 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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_appconfig_deployment_strategies Data Source - terraform-provider-awscc" | ||
| subcategory: "" | ||
| description: |- | ||
| Plural Data Source schema for AWS::AppConfig::DeploymentStrategy | ||
| --- | ||
|
|
||
| # awscc_appconfig_deployment_strategies (Data Source) | ||
|
|
||
| Plural Data Source schema for AWS::AppConfig::DeploymentStrategy | ||
|
|
||
|
|
||
|
|
||
| <!-- schema generated by tfplugindocs --> | ||
| ## Schema | ||
|
|
||
| ### Read-Only | ||
|
|
||
| - `id` (String) Uniquely identifies the data source. | ||
| - `ids` (Set of String) Set of Resource Identifiers. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| --- | ||
| # generated by https://github.com/hashicorp/terraform-plugin-docs | ||
| page_title: "awscc_appconfig_deployment_strategy Data Source - terraform-provider-awscc" | ||
| subcategory: "" | ||
| description: |- | ||
| Data Source schema for AWS::AppConfig::DeploymentStrategy | ||
| --- | ||
|
|
||
| # awscc_appconfig_deployment_strategy (Data Source) | ||
|
|
||
| Data Source schema for AWS::AppConfig::DeploymentStrategy | ||
|
|
||
|
|
||
|
|
||
| <!-- schema generated by tfplugindocs --> | ||
| ## Schema | ||
|
|
||
| ### Required | ||
|
|
||
| - `id` (String) Uniquely identifies the resource. | ||
|
|
||
| ### Read-Only | ||
|
|
||
| - `deployment_duration_in_minutes` (Number) Total amount of time for a deployment to last. | ||
| - `deployment_strategy_id` (String) The deployment strategy ID. | ||
| - `description` (String) A description of the deployment strategy. | ||
| - `final_bake_time_in_minutes` (Number) Specifies the amount of time AWS AppConfig monitors for Amazon CloudWatch alarms after the configuration has been deployed to 100% of its targets, before considering the deployment to be complete. If an alarm is triggered during this time, AWS AppConfig rolls back the deployment. You must configure permissions for AWS AppConfig to roll back based on CloudWatch alarms. For more information, see Configuring permissions for rollback based on Amazon CloudWatch alarms in the AWS AppConfig User Guide. | ||
| - `growth_factor` (Number) The percentage of targets to receive a deployed configuration during each interval. | ||
| - `growth_type` (String) The algorithm used to define how percentage grows over time. AWS AppConfig supports the following growth types: | ||
|
|
||
| Linear: For this type, AWS AppConfig processes the deployment by dividing the total number of targets by the value specified for Step percentage. For example, a linear deployment that uses a Step percentage of 10 deploys the configuration to 10 percent of the hosts. After those deployments are complete, the system deploys the configuration to the next 10 percent. This continues until 100% of the targets have successfully received the configuration. | ||
|
|
||
| Exponential: For this type, AWS AppConfig processes the deployment exponentially using the following formula: G*(2^N). In this formula, G is the growth factor specified by the user and N is the number of steps until the configuration is deployed to all targets. For example, if you specify a growth factor of 2, then the system rolls out the configuration as follows: | ||
|
|
||
| 2*(2^0) | ||
|
|
||
| 2*(2^1) | ||
|
|
||
| 2*(2^2) | ||
|
|
||
| Expressed numerically, the deployment rolls out as follows: 2% of the targets, 4% of the targets, 8% of the targets, and continues until the configuration has been deployed to all targets. | ||
| - `name` (String) A name for the deployment strategy. | ||
| - `replicate_to` (String) Save the deployment strategy to a Systems Manager (SSM) document. | ||
| - `tags` (Attributes Set) Assigns metadata to an AWS AppConfig resource. Tags help organize and categorize your AWS AppConfig resources. Each tag consists of a key and an optional value, both of which you define. You can specify a maximum of 50 tags for a resource. (see [below for nested schema](#nestedatt--tags)) | ||
|
|
||
| <a id="nestedatt--tags"></a> | ||
| ### Nested Schema for `tags` | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `key` (String) The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. | ||
| - `value` (String) The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,125 @@ | ||
| --- | ||
| # generated by https://github.com/hashicorp/terraform-plugin-docs | ||
| page_title: "awscc_appsync_api Data Source - terraform-provider-awscc" | ||
| subcategory: "" | ||
| description: |- | ||
| Data Source schema for AWS::AppSync::Api | ||
| --- | ||
|
|
||
| # awscc_appsync_api (Data Source) | ||
|
|
||
| Data Source schema for AWS::AppSync::Api | ||
|
|
||
|
|
||
|
|
||
| <!-- schema generated by tfplugindocs --> | ||
| ## Schema | ||
|
|
||
| ### Required | ||
|
|
||
| - `id` (String) Uniquely identifies the resource. | ||
|
|
||
| ### Read-Only | ||
|
|
||
| - `api_arn` (String) The Amazon Resource Name (ARN) of the AppSync Api | ||
| - `api_id` (String) The unique identifier for the AppSync Api generated by the service | ||
| - `dns` (Map of String) A map of DNS names for the AppSync API. | ||
| - `event_config` (Attributes) The configuration for an Event Api (see [below for nested schema](#nestedatt--event_config)) | ||
| - `name` (String) The name of the AppSync API. | ||
| - `owner_contact` (String) The owner contact information for an API resource. | ||
| - `tags` (Attributes Set) An arbitrary set of tags (key-value pairs) for this AppSync API. (see [below for nested schema](#nestedatt--tags)) | ||
|
|
||
| <a id="nestedatt--event_config"></a> | ||
| ### Nested Schema for `event_config` | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `auth_providers` (Attributes List) A list of auth providers for the AppSync API. (see [below for nested schema](#nestedatt--event_config--auth_providers)) | ||
| - `connection_auth_modes` (Attributes List) A list of auth modes for the AppSync API. (see [below for nested schema](#nestedatt--event_config--connection_auth_modes)) | ||
| - `default_publish_auth_modes` (Attributes List) A list of auth modes for the AppSync API. (see [below for nested schema](#nestedatt--event_config--default_publish_auth_modes)) | ||
| - `default_subscribe_auth_modes` (Attributes List) A list of auth modes for the AppSync API. (see [below for nested schema](#nestedatt--event_config--default_subscribe_auth_modes)) | ||
| - `log_config` (Attributes) The log config for the AppSync API. (see [below for nested schema](#nestedatt--event_config--log_config)) | ||
|
|
||
| <a id="nestedatt--event_config--auth_providers"></a> | ||
| ### Nested Schema for `event_config.auth_providers` | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `auth_type` (String) Security configuration for your AppSync API. | ||
| - `cognito_config` (Attributes) Optional authorization configuration for using Amazon Cognito user pools with your API endpoint. (see [below for nested schema](#nestedatt--event_config--auth_providers--cognito_config)) | ||
| - `lambda_authorizer_config` (Attributes) A LambdaAuthorizerConfig holds configuration on how to authorize AWS AppSync API access when using the AWS_LAMBDA authorizer mode. Be aware that an AWS AppSync API may have only one Lambda authorizer configured at a time. (see [below for nested schema](#nestedatt--event_config--auth_providers--lambda_authorizer_config)) | ||
| - `open_id_connect_config` (Attributes) The OpenID Connect configuration. (see [below for nested schema](#nestedatt--event_config--auth_providers--open_id_connect_config)) | ||
|
|
||
| <a id="nestedatt--event_config--auth_providers--cognito_config"></a> | ||
| ### Nested Schema for `event_config.auth_providers.cognito_config` | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `app_id_client_regex` (String) | ||
| - `aws_region` (String) | ||
| - `user_pool_id` (String) | ||
|
|
||
|
|
||
| <a id="nestedatt--event_config--auth_providers--lambda_authorizer_config"></a> | ||
| ### Nested Schema for `event_config.auth_providers.lambda_authorizer_config` | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `authorizer_result_ttl_in_seconds` (Number) | ||
| - `authorizer_uri` (String) | ||
| - `identity_validation_expression` (String) | ||
|
|
||
|
|
||
| <a id="nestedatt--event_config--auth_providers--open_id_connect_config"></a> | ||
| ### Nested Schema for `event_config.auth_providers.open_id_connect_config` | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `auth_ttl` (Number) | ||
| - `client_id` (String) | ||
| - `iat_ttl` (Number) | ||
| - `issuer` (String) | ||
|
|
||
|
|
||
|
|
||
| <a id="nestedatt--event_config--connection_auth_modes"></a> | ||
| ### Nested Schema for `event_config.connection_auth_modes` | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `auth_type` (String) Security configuration for your AppSync API. | ||
|
|
||
|
|
||
| <a id="nestedatt--event_config--default_publish_auth_modes"></a> | ||
| ### Nested Schema for `event_config.default_publish_auth_modes` | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `auth_type` (String) Security configuration for your AppSync API. | ||
|
|
||
|
|
||
| <a id="nestedatt--event_config--default_subscribe_auth_modes"></a> | ||
| ### Nested Schema for `event_config.default_subscribe_auth_modes` | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `auth_type` (String) Security configuration for your AppSync API. | ||
|
|
||
|
|
||
| <a id="nestedatt--event_config--log_config"></a> | ||
| ### Nested Schema for `event_config.log_config` | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `cloudwatch_logs_role_arn` (String) | ||
| - `log_level` (String) Logging level for the AppSync API. | ||
|
|
||
|
|
||
|
|
||
| <a id="nestedatt--tags"></a> | ||
| ### Nested Schema for `tags` | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `key` (String) A string used to identify this tag. You can specify a maximum of 128 characters for a tag key. | ||
| - `value` (String) A string containing the value for this tag. You can specify a maximum of 256 characters for a tag value. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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_appsync_apis Data Source - terraform-provider-awscc" | ||
| subcategory: "" | ||
| description: |- | ||
| Plural Data Source schema for AWS::AppSync::Api | ||
| --- | ||
|
|
||
| # awscc_appsync_apis (Data Source) | ||
|
|
||
| Plural Data Source schema for AWS::AppSync::Api | ||
|
|
||
|
|
||
|
|
||
| <!-- schema generated by tfplugindocs --> | ||
| ## Schema | ||
|
|
||
| ### Read-Only | ||
|
|
||
| - `id` (String) Uniquely identifies the data source. | ||
| - `ids` (Set of String) Set of Resource Identifiers. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.