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 #1134 from hashicorp/f-08-09-2023-schema-updates
08/09/2023 CloudFormation schema refresh
- Loading branch information
Showing
270 changed files
with
18,079 additions
and
801 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,94 @@ | ||
--- | ||
# generated by https://github.com/hashicorp/terraform-plugin-docs | ||
page_title: "awscc_cloudwatch_alarm Data Source - terraform-provider-awscc" | ||
subcategory: "" | ||
description: |- | ||
Data Source schema for AWS::CloudWatch::Alarm | ||
--- | ||
|
||
# awscc_cloudwatch_alarm (Data Source) | ||
|
||
Data Source schema for AWS::CloudWatch::Alarm | ||
|
||
|
||
|
||
<!-- schema generated by tfplugindocs --> | ||
## Schema | ||
|
||
### Required | ||
|
||
- `id` (String) Uniquely identifies the resource. | ||
|
||
### Read-Only | ||
|
||
- `actions_enabled` (Boolean) Indicates whether actions should be executed during any changes to the alarm state. The default is TRUE. | ||
- `alarm_actions` (List of String) The list of actions to execute when this alarm transitions into an ALARM state from any other state. | ||
- `alarm_description` (String) The description of the alarm. | ||
- `alarm_name` (String) The name of the alarm. | ||
- `arn` (String) Amazon Resource Name is a unique name for each resource. | ||
- `comparison_operator` (String) The arithmetic operation to use when comparing the specified statistic and threshold. | ||
- `datapoints_to_alarm` (Number) The number of datapoints that must be breaching to trigger the alarm. | ||
- `dimensions` (Attributes List) The dimensions for the metric associated with the alarm. For an alarm based on a math expression, you can't specify Dimensions. Instead, you use Metrics. (see [below for nested schema](#nestedatt--dimensions)) | ||
- `evaluate_low_sample_count_percentile` (String) Used only for alarms based on percentiles. | ||
- `evaluation_periods` (Number) The number of periods over which data is compared to the specified threshold. | ||
- `extended_statistic` (String) The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100. | ||
- `insufficient_data_actions` (List of String) The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. | ||
- `metric_name` (String) The name of the metric associated with the alarm. | ||
- `metrics` (Attributes List) An array that enables you to create an alarm based on the result of a metric math expression. (see [below for nested schema](#nestedatt--metrics)) | ||
- `namespace` (String) The namespace of the metric associated with the alarm. | ||
- `ok_actions` (List of String) The actions to execute when this alarm transitions to the OK state from any other state. | ||
- `period` (Number) The period in seconds, over which the statistic is applied. | ||
- `statistic` (String) The statistic for the metric associated with the alarm, other than percentile. | ||
- `threshold` (Number) In an alarm based on an anomaly detection model, this is the ID of the ANOMALY_DETECTION_BAND function used as the threshold for the alarm. | ||
- `threshold_metric_id` (String) In an alarm based on an anomaly detection model, this is the ID of the ANOMALY_DETECTION_BAND function used as the threshold for the alarm. | ||
- `treat_missing_data` (String) Sets how this alarm is to handle missing data points. Valid values are breaching, notBreaching, ignore, and missing. | ||
- `unit` (String) The unit of the metric associated with the alarm. | ||
|
||
<a id="nestedatt--dimensions"></a> | ||
### Nested Schema for `dimensions` | ||
|
||
Read-Only: | ||
|
||
- `name` (String) The name of the dimension. | ||
- `value` (String) The value for the dimension. | ||
|
||
|
||
<a id="nestedatt--metrics"></a> | ||
### Nested Schema for `metrics` | ||
|
||
Read-Only: | ||
|
||
- `account_id` (String) The ID of the account where the metrics are located, if this is a cross-account alarm. | ||
- `expression` (String) The math expression to be performed on the returned data. | ||
- `id` (String) A short name used to tie this object to the results in the response. | ||
- `label` (String) A human-readable label for this metric or expression. | ||
- `metric_stat` (Attributes) The metric to be returned, along with statistics, period, and units. (see [below for nested schema](#nestedatt--metrics--metric_stat)) | ||
- `period` (Number) The period in seconds, over which the statistic is applied. | ||
- `return_data` (Boolean) This option indicates whether to return the timestamps and raw data values of this metric. | ||
|
||
<a id="nestedatt--metrics--metric_stat"></a> | ||
### Nested Schema for `metrics.metric_stat` | ||
|
||
Read-Only: | ||
|
||
- `metric` (Attributes) The metric to return, including the metric name, namespace, and dimensions. (see [below for nested schema](#nestedatt--metrics--metric_stat--metric)) | ||
- `period` (Number) The granularity, in seconds, of the returned data points. | ||
- `stat` (String) The statistic to return. | ||
- `unit` (String) The unit to use for the returned data points. | ||
|
||
<a id="nestedatt--metrics--metric_stat--metric"></a> | ||
### Nested Schema for `metrics.metric_stat.metric` | ||
|
||
Read-Only: | ||
|
||
- `dimensions` (Attributes List) The dimensions for the metric. (see [below for nested schema](#nestedatt--metrics--metric_stat--metric--dimensions)) | ||
- `metric_name` (String) The name of the metric. | ||
- `namespace` (String) The namespace of the metric. | ||
|
||
<a id="nestedatt--metrics--metric_stat--metric--dimensions"></a> | ||
### Nested Schema for `metrics.metric_stat.metric.namespace` | ||
|
||
Read-Only: | ||
|
||
- `name` (String) The name of the dimension. | ||
- `value` (String) The value for the dimension. |
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_cloudwatch_alarms Data Source - terraform-provider-awscc" | ||
subcategory: "" | ||
description: |- | ||
Plural Data Source schema for AWS::CloudWatch::Alarm | ||
--- | ||
|
||
# awscc_cloudwatch_alarms (Data Source) | ||
|
||
Plural Data Source schema for AWS::CloudWatch::Alarm | ||
|
||
|
||
|
||
<!-- 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,89 @@ | ||
--- | ||
# generated by https://github.com/hashicorp/terraform-plugin-docs | ||
page_title: "awscc_config_config_rule Data Source - terraform-provider-awscc" | ||
subcategory: "" | ||
description: |- | ||
Data Source schema for AWS::Config::ConfigRule | ||
--- | ||
|
||
# awscc_config_config_rule (Data Source) | ||
|
||
Data Source schema for AWS::Config::ConfigRule | ||
|
||
|
||
|
||
<!-- schema generated by tfplugindocs --> | ||
## Schema | ||
|
||
### Required | ||
|
||
- `id` (String) Uniquely identifies the resource. | ||
|
||
### Read-Only | ||
|
||
- `arn` (String) ARN generated for the AWS Config rule | ||
- `compliance` (Attributes) Compliance details of the Config rule (see [below for nested schema](#nestedatt--compliance)) | ||
- `config_rule_id` (String) ID of the config rule | ||
- `config_rule_name` (String) Name for the AWS Config rule | ||
- `description` (String) Description provided for the AWS Config rule | ||
- `evaluation_modes` (Attributes List) List of EvaluationModeConfiguration objects (see [below for nested schema](#nestedatt--evaluation_modes)) | ||
- `input_parameters` (String) JSON string passed the Lambda function | ||
- `maximum_execution_frequency` (String) Maximum frequency at which the rule has to be evaluated | ||
- `scope` (Attributes) Scope to constrain which resources can trigger the AWS Config rule (see [below for nested schema](#nestedatt--scope)) | ||
- `source` (Attributes) Source of events for the AWS Config rule (see [below for nested schema](#nestedatt--source)) | ||
|
||
<a id="nestedatt--compliance"></a> | ||
### Nested Schema for `compliance` | ||
|
||
Read-Only: | ||
|
||
- `type` (String) Compliance type determined by the Config rule | ||
|
||
|
||
<a id="nestedatt--evaluation_modes"></a> | ||
### Nested Schema for `evaluation_modes` | ||
|
||
Read-Only: | ||
|
||
- `mode` (String) Mode of evaluation of AWS Config rule | ||
|
||
|
||
<a id="nestedatt--scope"></a> | ||
### Nested Schema for `scope` | ||
|
||
Read-Only: | ||
|
||
- `compliance_resource_id` (String) ID of the only one resource which we want to trigger the rule | ||
- `compliance_resource_types` (List of String) Resource types of resources which we want to trigger the rule | ||
- `tag_key` (String) Tag key applied only to resources which we want to trigger the rule | ||
- `tag_value` (String) Tag value applied only to resources which we want to trigger the rule | ||
|
||
|
||
<a id="nestedatt--source"></a> | ||
### Nested Schema for `source` | ||
|
||
Read-Only: | ||
|
||
- `custom_policy_details` (Attributes) Custom policy details when rule is custom owned (see [below for nested schema](#nestedatt--source--custom_policy_details)) | ||
- `owner` (String) Owner of the config rule | ||
- `source_details` (Attributes List) List of message types that can trigger the rule (see [below for nested schema](#nestedatt--source--source_details)) | ||
- `source_identifier` (String) Identifier for the source of events | ||
|
||
<a id="nestedatt--source--custom_policy_details"></a> | ||
### Nested Schema for `source.custom_policy_details` | ||
|
||
Read-Only: | ||
|
||
- `enable_debug_log_delivery` (Boolean) Logging toggle for custom policy rule | ||
- `policy_runtime` (String) Runtime system for custom policy rule | ||
- `policy_text` (String) Policy definition containing logic for custom policy rule | ||
|
||
|
||
<a id="nestedatt--source--source_details"></a> | ||
### Nested Schema for `source.source_details` | ||
|
||
Read-Only: | ||
|
||
- `event_source` (String) Source of event that can trigger the rule | ||
- `maximum_execution_frequency` (String) Frequency at which the rule has to be evaluated | ||
- `message_type` (String) Notification type that can trigger the rule |
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_config_config_rules Data Source - terraform-provider-awscc" | ||
subcategory: "" | ||
description: |- | ||
Plural Data Source schema for AWS::Config::ConfigRule | ||
--- | ||
|
||
# awscc_config_config_rules (Data Source) | ||
|
||
Plural Data Source schema for AWS::Config::ConfigRule | ||
|
||
|
||
|
||
<!-- 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,38 @@ | ||
--- | ||
# generated by https://github.com/hashicorp/terraform-plugin-docs | ||
page_title: "awscc_connect_traffic_distribution_group Data Source - terraform-provider-awscc" | ||
subcategory: "" | ||
description: |- | ||
Data Source schema for AWS::Connect::TrafficDistributionGroup | ||
--- | ||
|
||
# awscc_connect_traffic_distribution_group (Data Source) | ||
|
||
Data Source schema for AWS::Connect::TrafficDistributionGroup | ||
|
||
|
||
|
||
<!-- schema generated by tfplugindocs --> | ||
## Schema | ||
|
||
### Required | ||
|
||
- `id` (String) Uniquely identifies the resource. | ||
|
||
### Read-Only | ||
|
||
- `description` (String) A description for the traffic distribution group. | ||
- `instance_arn` (String) The identifier of the Amazon Connect instance that has been replicated. | ||
- `is_default` (Boolean) If this is the default traffic distribution group. | ||
- `name` (String) The name for the traffic distribution group. | ||
- `status` (String) The status of the traffic distribution group. | ||
- `tags` (Attributes Set) One or more tags. (see [below for nested schema](#nestedatt--tags)) | ||
- `traffic_distribution_group_arn` (String) The identifier of the traffic distribution group. | ||
|
||
<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 1 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,49 @@ | ||
--- | ||
# generated by https://github.com/hashicorp/terraform-plugin-docs | ||
page_title: "awscc_datasync_location_azure_blob Data Source - terraform-provider-awscc" | ||
subcategory: "" | ||
description: |- | ||
Data Source schema for AWS::DataSync::LocationAzureBlob | ||
--- | ||
|
||
# awscc_datasync_location_azure_blob (Data Source) | ||
|
||
Data Source schema for AWS::DataSync::LocationAzureBlob | ||
|
||
|
||
|
||
<!-- schema generated by tfplugindocs --> | ||
## Schema | ||
|
||
### Required | ||
|
||
- `id` (String) Uniquely identifies the resource. | ||
|
||
### Read-Only | ||
|
||
- `agent_arns` (List of String) The Amazon Resource Names (ARNs) of agents to use for an Azure Blob Location. | ||
- `azure_access_tier` (String) Specifies an access tier for the objects you're transferring into your Azure Blob Storage container. | ||
- `azure_blob_authentication_type` (String) The specific authentication type that you want DataSync to use to access your Azure Blob Container. | ||
- `azure_blob_container_url` (String) The URL of the Azure Blob container that was described. | ||
- `azure_blob_sas_configuration` (Attributes) Specifies the shared access signature (SAS) that DataSync uses to access your Azure Blob Storage container. (see [below for nested schema](#nestedatt--azure_blob_sas_configuration)) | ||
- `azure_blob_type` (String) Specifies a blob type for the objects you're transferring into your Azure Blob Storage container. | ||
- `location_arn` (String) The Amazon Resource Name (ARN) of the Azure Blob Location that is created. | ||
- `location_uri` (String) The URL of the Azure Blob Location that was described. | ||
- `subdirectory` (String) The subdirectory in the Azure Blob Container that is used to read data from the Azure Blob Source Location. | ||
- `tags` (Attributes Set) An array of key-value pairs to apply to this resource. (see [below for nested schema](#nestedatt--tags)) | ||
|
||
<a id="nestedatt--azure_blob_sas_configuration"></a> | ||
### Nested Schema for `azure_blob_sas_configuration` | ||
|
||
Read-Only: | ||
|
||
- `azure_blob_sas_token` (String) Specifies the shared access signature (SAS) token, which indicates the permissions DataSync needs to access your Azure Blob Storage container. | ||
|
||
|
||
<a id="nestedatt--tags"></a> | ||
### Nested Schema for `tags` | ||
|
||
Read-Only: | ||
|
||
- `key` (String) The key for an AWS resource tag. | ||
- `value` (String) The value for an AWS resource tag. |
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_datasync_location_azure_blobs Data Source - terraform-provider-awscc" | ||
subcategory: "" | ||
description: |- | ||
Plural Data Source schema for AWS::DataSync::LocationAzureBlob | ||
--- | ||
|
||
# awscc_datasync_location_azure_blobs (Data Source) | ||
|
||
Plural Data Source schema for AWS::DataSync::LocationAzureBlob | ||
|
||
|
||
|
||
<!-- schema generated by tfplugindocs --> | ||
## Schema | ||
|
||
### Read-Only | ||
|
||
- `id` (String) Uniquely identifies the data source. | ||
- `ids` (Set of String) Set of Resource Identifiers. |
Oops, something went wrong.