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 #2077 from hashicorp/f-10-24-2024-schema-updates
10-24-2024 Schema Updates
- Loading branch information
Showing
202 changed files
with
15,708 additions
and
1,453 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
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,150 @@ | ||
--- | ||
# generated by https://github.com/hashicorp/terraform-plugin-docs | ||
page_title: "awscc_appsync_graph_ql_api Data Source - terraform-provider-awscc" | ||
subcategory: "" | ||
description: |- | ||
Data Source schema for AWS::AppSync::GraphQLApi | ||
--- | ||
|
||
# awscc_appsync_graph_ql_api (Data Source) | ||
|
||
Data Source schema for AWS::AppSync::GraphQLApi | ||
|
||
|
||
|
||
<!-- schema generated by tfplugindocs --> | ||
## Schema | ||
|
||
### Required | ||
|
||
- `id` (String) Uniquely identifies the resource. | ||
|
||
### Read-Only | ||
|
||
- `additional_authentication_providers` (Attributes List) A list of additional authentication providers for the GraphqlApi API. (see [below for nested schema](#nestedatt--additional_authentication_providers)) | ||
- `api_id` (String) Unique AWS AppSync GraphQL API identifier. | ||
- `api_type` (String) The value that indicates whether the GraphQL API is a standard API (GRAPHQL) or merged API (MERGED). | ||
- `arn` (String) The Amazon Resource Name (ARN) of the API key | ||
- `authentication_type` (String) Security configuration for your GraphQL API | ||
- `enhanced_metrics_config` (Attributes) Enables and controls the enhanced metrics feature. Enhanced metrics emit granular data on API usage and performance such as AppSync request and error counts, latency, and cache hits/misses. All enhanced metric data is sent to your CloudWatch account, and you can configure the types of data that will be sent. (see [below for nested schema](#nestedatt--enhanced_metrics_config)) | ||
- `environment_variables` (Map of String) A map containing the list of resources with their properties and environment variables. | ||
- `graph_ql_dns` (String) The fully qualified domain name (FQDN) of the endpoint URL of your GraphQL API. | ||
- `graph_ql_endpoint_arn` (String) The GraphQL endpoint ARN. | ||
- `graph_ql_url` (String) The Endpoint URL of your GraphQL API. | ||
- `introspection_config` (String) Sets the value of the GraphQL API to enable (ENABLED) or disable (DISABLED) introspection. If no value is provided, the introspection configuration will be set to ENABLED by default. This field will produce an error if the operation attempts to use the introspection feature while this field is disabled. | ||
- `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--lambda_authorizer_config)) | ||
- `log_config` (Attributes) The Amazon CloudWatch Logs configuration. (see [below for nested schema](#nestedatt--log_config)) | ||
- `merged_api_execution_role_arn` (String) The AWS Identity and Access Management service role ARN for a merged API. | ||
- `name` (String) The API name | ||
- `open_id_connect_config` (Attributes) The OpenID Connect configuration. (see [below for nested schema](#nestedatt--open_id_connect_config)) | ||
- `owner_contact` (String) The owner contact information for an API resource. | ||
- `query_depth_limit` (Number) The maximum depth a query can have in a single request. Depth refers to the amount of nested levels allowed in the body of query. | ||
- `realtime_dns` (String) The fully qualified domain name (FQDN) of the real-time endpoint URL of your GraphQL API. | ||
- `realtime_url` (String) The GraphQL API real-time endpoint URL. | ||
- `resolver_count_limit` (Number) The maximum number of resolvers that can be invoked in a single request. | ||
- `tags` (Attributes List) An arbitrary set of tags (key-value pairs) for this GraphQL API. (see [below for nested schema](#nestedatt--tags)) | ||
- `user_pool_config` (Attributes) Optional authorization configuration for using Amazon Cognito user pools with your GraphQL endpoint. (see [below for nested schema](#nestedatt--user_pool_config)) | ||
- `visibility` (String) Sets the scope of the GraphQL API to public (GLOBAL) or private (PRIVATE). By default, the scope is set to Global if no value is provided. | ||
- `xray_enabled` (Boolean) A flag indicating whether to use AWS X-Ray tracing for this GraphqlApi. | ||
|
||
<a id="nestedatt--additional_authentication_providers"></a> | ||
### Nested Schema for `additional_authentication_providers` | ||
|
||
Read-Only: | ||
|
||
- `authentication_type` (String) The authentication type for API key, AWS Identity and Access Management, OIDC, Amazon Cognito user pools, or AWS Lambda. | ||
- `lambda_authorizer_config` (Attributes) (see [below for nested schema](#nestedatt--additional_authentication_providers--lambda_authorizer_config)) | ||
- `open_id_connect_config` (Attributes) (see [below for nested schema](#nestedatt--additional_authentication_providers--open_id_connect_config)) | ||
- `user_pool_config` (Attributes) (see [below for nested schema](#nestedatt--additional_authentication_providers--user_pool_config)) | ||
|
||
<a id="nestedatt--additional_authentication_providers--lambda_authorizer_config"></a> | ||
### Nested Schema for `additional_authentication_providers.lambda_authorizer_config` | ||
|
||
Read-Only: | ||
|
||
- `authorizer_result_ttl_in_seconds` (Number) The number of seconds a response should be cached for. | ||
- `authorizer_uri` (String) The ARN of the Lambda function to be called for authorization. | ||
- `identity_validation_expression` (String) A regular expression for validation of tokens before the Lambda function is called. | ||
|
||
|
||
<a id="nestedatt--additional_authentication_providers--open_id_connect_config"></a> | ||
### Nested Schema for `additional_authentication_providers.open_id_connect_config` | ||
|
||
Read-Only: | ||
|
||
- `auth_ttl` (Number) The number of milliseconds that a token is valid after being authenticated. | ||
- `client_id` (String) The client identifier of the Relying party at the OpenID identity provider. | ||
- `iat_ttl` (Number) The number of milliseconds that a token is valid after it's issued to a user. | ||
- `issuer` (String) The issuer for the OIDC configuration. | ||
|
||
|
||
<a id="nestedatt--additional_authentication_providers--user_pool_config"></a> | ||
### Nested Schema for `additional_authentication_providers.user_pool_config` | ||
|
||
Read-Only: | ||
|
||
- `app_id_client_regex` (String) A regular expression for validating the incoming Amazon Cognito user pool app client ID. | ||
- `aws_region` (String) The AWS Region in which the user pool was created. | ||
- `user_pool_id` (String) The user pool ID | ||
|
||
|
||
|
||
<a id="nestedatt--enhanced_metrics_config"></a> | ||
### Nested Schema for `enhanced_metrics_config` | ||
|
||
Read-Only: | ||
|
||
- `data_source_level_metrics_behavior` (String) Controls how data source metrics will be emitted to CloudWatch. Data source metrics include: | ||
- `operation_level_metrics_config` (String) Controls how operation metrics will be emitted to CloudWatch. Operation metrics include: | ||
- `resolver_level_metrics_behavior` (String) Controls how resolver metrics will be emitted to CloudWatch. Resolver metrics include: | ||
|
||
|
||
<a id="nestedatt--lambda_authorizer_config"></a> | ||
### Nested Schema for `lambda_authorizer_config` | ||
|
||
Read-Only: | ||
|
||
- `authorizer_result_ttl_in_seconds` (Number) The number of seconds a response should be cached for. | ||
- `authorizer_uri` (String) The ARN of the Lambda function to be called for authorization. | ||
- `identity_validation_expression` (String) A regular expression for validation of tokens before the Lambda function is called. | ||
|
||
|
||
<a id="nestedatt--log_config"></a> | ||
### Nested Schema for `log_config` | ||
|
||
Read-Only: | ||
|
||
- `cloudwatch_logs_role_arn` (String) The service role that AWS AppSync will assume to publish to Amazon CloudWatch Logs in your account. | ||
- `exclude_verbose_content` (Boolean) Set to TRUE to exclude sections that contain information such as headers, context, and evaluated mapping templates, regardless of logging level. | ||
- `field_log_level` (String) The field logging level. Values can be NONE, ERROR, INFO, DEBUG, or ALL. | ||
|
||
|
||
<a id="nestedatt--open_id_connect_config"></a> | ||
### Nested Schema for `open_id_connect_config` | ||
|
||
Read-Only: | ||
|
||
- `auth_ttl` (Number) The number of milliseconds that a token is valid after being authenticated. | ||
- `client_id` (String) The client identifier of the Relying party at the OpenID identity provider. | ||
- `iat_ttl` (Number) The number of milliseconds that a token is valid after it's issued to a user. | ||
- `issuer` (String) The issuer for the OIDC configuration. | ||
|
||
|
||
<a id="nestedatt--tags"></a> | ||
### Nested Schema for `tags` | ||
|
||
Read-Only: | ||
|
||
- `key` (String) | ||
- `value` (String) | ||
|
||
|
||
<a id="nestedatt--user_pool_config"></a> | ||
### Nested Schema for `user_pool_config` | ||
|
||
Read-Only: | ||
|
||
- `app_id_client_regex` (String) A regular expression for validating the incoming Amazon Cognito user pool app client ID. | ||
- `aws_region` (String) The AWS Region in which the user pool was created. | ||
- `default_action` (String) The action that you want your GraphQL API to take when a request that uses Amazon Cognito user pool authentication doesn't match the Amazon Cognito user pool configuration. | ||
- `user_pool_id` (String) The user pool ID. |
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_graph_ql_apis Data Source - terraform-provider-awscc" | ||
subcategory: "" | ||
description: |- | ||
Plural Data Source schema for AWS::AppSync::GraphQLApi | ||
--- | ||
|
||
# awscc_appsync_graph_ql_apis (Data Source) | ||
|
||
Plural Data Source schema for AWS::AppSync::GraphQLApi | ||
|
||
|
||
|
||
<!-- 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
41 changes: 41 additions & 0 deletions
41
docs/data-sources/backup_logically_air_gapped_backup_vault.md
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,41 @@ | ||
--- | ||
# generated by https://github.com/hashicorp/terraform-plugin-docs | ||
page_title: "awscc_backup_logically_air_gapped_backup_vault Data Source - terraform-provider-awscc" | ||
subcategory: "" | ||
description: |- | ||
Data Source schema for AWS::Backup::LogicallyAirGappedBackupVault | ||
--- | ||
|
||
# awscc_backup_logically_air_gapped_backup_vault (Data Source) | ||
|
||
Data Source schema for AWS::Backup::LogicallyAirGappedBackupVault | ||
|
||
|
||
|
||
<!-- schema generated by tfplugindocs --> | ||
## Schema | ||
|
||
### Required | ||
|
||
- `id` (String) Uniquely identifies the resource. | ||
|
||
### Read-Only | ||
|
||
- `access_policy` (String) | ||
- `backup_vault_arn` (String) | ||
- `backup_vault_name` (String) | ||
- `backup_vault_tags` (Map of String) | ||
- `encryption_key_arn` (String) | ||
- `max_retention_days` (Number) | ||
- `min_retention_days` (Number) | ||
- `notifications` (Attributes) (see [below for nested schema](#nestedatt--notifications)) | ||
- `vault_state` (String) | ||
- `vault_type` (String) | ||
|
||
<a id="nestedatt--notifications"></a> | ||
### Nested Schema for `notifications` | ||
|
||
Read-Only: | ||
|
||
- `backup_vault_events` (List of String) | ||
- `sns_topic_arn` (String) |
21 changes: 21 additions & 0 deletions
21
docs/data-sources/backup_logically_air_gapped_backup_vaults.md
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_backup_logically_air_gapped_backup_vaults Data Source - terraform-provider-awscc" | ||
subcategory: "" | ||
description: |- | ||
Plural Data Source schema for AWS::Backup::LogicallyAirGappedBackupVault | ||
--- | ||
|
||
# awscc_backup_logically_air_gapped_backup_vaults (Data Source) | ||
|
||
Plural Data Source schema for AWS::Backup::LogicallyAirGappedBackupVault | ||
|
||
|
||
|
||
<!-- 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,29 @@ | ||
--- | ||
# generated by https://github.com/hashicorp/terraform-plugin-docs | ||
page_title: "awscc_cognito_user_pool_identity_provider Data Source - terraform-provider-awscc" | ||
subcategory: "" | ||
description: |- | ||
Data Source schema for AWS::Cognito::UserPoolIdentityProvider | ||
--- | ||
|
||
# awscc_cognito_user_pool_identity_provider (Data Source) | ||
|
||
Data Source schema for AWS::Cognito::UserPoolIdentityProvider | ||
|
||
|
||
|
||
<!-- schema generated by tfplugindocs --> | ||
## Schema | ||
|
||
### Required | ||
|
||
- `id` (String) Uniquely identifies the resource. | ||
|
||
### Read-Only | ||
|
||
- `attribute_mapping` (Map of String) | ||
- `idp_identifiers` (List of String) | ||
- `provider_details` (Map of String) | ||
- `provider_name` (String) | ||
- `provider_type` (String) | ||
- `user_pool_id` (String) |
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.