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 #1324 from hashicorp/f-11-15-2023-schema-updates
11/15/2023 CloudFormation schema refresh
- Loading branch information
Showing
174 changed files
with
18,584 additions
and
2,603 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
145 changes: 145 additions & 0 deletions
145
docs/data-sources/applicationautoscaling_scaling_policy.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,145 @@ | ||
--- | ||
# generated by https://github.com/hashicorp/terraform-plugin-docs | ||
page_title: "awscc_applicationautoscaling_scaling_policy Data Source - terraform-provider-awscc" | ||
subcategory: "" | ||
description: |- | ||
Data Source schema for AWS::ApplicationAutoScaling::ScalingPolicy | ||
--- | ||
|
||
# awscc_applicationautoscaling_scaling_policy (Data Source) | ||
|
||
Data Source schema for AWS::ApplicationAutoScaling::ScalingPolicy | ||
|
||
|
||
|
||
<!-- schema generated by tfplugindocs --> | ||
## Schema | ||
|
||
### Required | ||
|
||
- `id` (String) Uniquely identifies the resource. | ||
|
||
### Read-Only | ||
|
||
- `arn` (String) ARN is a read only property for the resource. | ||
- `policy_name` (String) The name of the scaling policy. | ||
|
||
Updates to the name of a target tracking scaling policy are not supported, unless you also update the metric used for scaling. To change only a target tracking scaling policy's name, first delete the policy by removing the existing AWS::ApplicationAutoScaling::ScalingPolicy resource from the template and updating the stack. Then, recreate the resource with the same settings and a different name. | ||
- `policy_type` (String) The scaling policy type. | ||
|
||
The following policy types are supported: | ||
|
||
TargetTrackingScaling Not supported for Amazon EMR | ||
|
||
StepScaling Not supported for DynamoDB, Amazon Comprehend, Lambda, Amazon Keyspaces, Amazon MSK, Amazon ElastiCache, or Neptune. | ||
- `resource_id` (String) The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier. | ||
- `scalable_dimension` (String) The scalable dimension. This string consists of the service namespace, resource type, and scaling property. | ||
- `scaling_target_id` (String) The CloudFormation-generated ID of an Application Auto Scaling scalable target. For more information about the ID, see the Return Value section of the AWS::ApplicationAutoScaling::ScalableTarget resource. | ||
- `service_namespace` (String) The namespace of the AWS service that provides the resource, or a custom-resource. | ||
- `step_scaling_policy_configuration` (Attributes) A step scaling policy. (see [below for nested schema](#nestedatt--step_scaling_policy_configuration)) | ||
- `target_tracking_scaling_policy_configuration` (Attributes) A target tracking scaling policy. (see [below for nested schema](#nestedatt--target_tracking_scaling_policy_configuration)) | ||
|
||
<a id="nestedatt--step_scaling_policy_configuration"></a> | ||
### Nested Schema for `step_scaling_policy_configuration` | ||
|
||
Read-Only: | ||
|
||
- `adjustment_type` (String) Specifies how the ScalingAdjustment value in a StepAdjustment is interpreted. | ||
- `cooldown` (Number) The amount of time, in seconds, to wait for a previous scaling activity to take effect. | ||
- `metric_aggregation_type` (String) The aggregation type for the CloudWatch metrics. Valid values are Minimum, Maximum, and Average. If the aggregation type is null, the value is treated as Average | ||
- `min_adjustment_magnitude` (Number) The minimum value to scale by when the adjustment type is PercentChangeInCapacity. | ||
- `step_adjustments` (Attributes Set) A set of adjustments that enable you to scale based on the size of the alarm breach. (see [below for nested schema](#nestedatt--step_scaling_policy_configuration--step_adjustments)) | ||
|
||
<a id="nestedatt--step_scaling_policy_configuration--step_adjustments"></a> | ||
### Nested Schema for `step_scaling_policy_configuration.step_adjustments` | ||
|
||
Read-Only: | ||
|
||
- `metric_interval_lower_bound` (Number) The lower bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the lower bound is inclusive (the metric must be greater than or equal to the threshold plus the lower bound). Otherwise, it is exclusive (the metric must be greater than the threshold plus the lower bound). A null value indicates negative infinity. | ||
- `metric_interval_upper_bound` (Number) The upper bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the upper bound is exclusive (the metric must be less than the threshold plus the upper bound). Otherwise, it is inclusive (the metric must be less than or equal to the threshold plus the upper bound). A null value indicates positive infinity. | ||
- `scaling_adjustment` (Number) The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity. For exact capacity, you must specify a positive value. | ||
|
||
|
||
|
||
<a id="nestedatt--target_tracking_scaling_policy_configuration"></a> | ||
### Nested Schema for `target_tracking_scaling_policy_configuration` | ||
|
||
Read-Only: | ||
|
||
- `customized_metric_specification` (Attributes) A customized metric. You can specify either a predefined metric or a customized metric. (see [below for nested schema](#nestedatt--target_tracking_scaling_policy_configuration--customized_metric_specification)) | ||
- `disable_scale_in` (Boolean) Indicates whether scale in by the target tracking scaling policy is disabled. If the value is true, scale in is disabled and the target tracking scaling policy won't remove capacity from the scalable target. Otherwise, scale in is enabled and the target tracking scaling policy can remove capacity from the scalable target. The default value is false. | ||
- `predefined_metric_specification` (Attributes) A predefined metric. You can specify either a predefined metric or a customized metric. (see [below for nested schema](#nestedatt--target_tracking_scaling_policy_configuration--predefined_metric_specification)) | ||
- `scale_in_cooldown` (Number) The amount of time, in seconds, after a scale-in activity completes before another scale-in activity can start. | ||
- `scale_out_cooldown` (Number) The amount of time, in seconds, to wait for a previous scale-out activity to take effect. | ||
- `target_value` (Number) The target value for the metric. Although this property accepts numbers of type Double, it won't accept values that are either too small or too large. Values must be in the range of -2^360 to 2^360. The value must be a valid number based on the choice of metric. For example, if the metric is CPU utilization, then the target value is a percent value that represents how much of the CPU can be used before scaling out. | ||
|
||
<a id="nestedatt--target_tracking_scaling_policy_configuration--customized_metric_specification"></a> | ||
### Nested Schema for `target_tracking_scaling_policy_configuration.customized_metric_specification` | ||
|
||
Read-Only: | ||
|
||
- `dimensions` (Attributes List) The dimensions of the metric. (see [below for nested schema](#nestedatt--target_tracking_scaling_policy_configuration--customized_metric_specification--dimensions)) | ||
- `metric_name` (String) The name of the metric. To get the exact metric name, namespace, and dimensions, inspect the Metric object that is returned by a call to ListMetrics. | ||
- `metrics` (Attributes List) The metrics to include in the target tracking scaling policy, as a metric data query. This can include both raw metric and metric math expressions. (see [below for nested schema](#nestedatt--target_tracking_scaling_policy_configuration--customized_metric_specification--metrics)) | ||
- `namespace` (String) The namespace of the metric. | ||
- `statistic` (String) The statistic of the metric. | ||
- `unit` (String) The unit of the metric. For a complete list of the units that CloudWatch supports, see the MetricDatum data type in the Amazon CloudWatch API Reference. | ||
|
||
<a id="nestedatt--target_tracking_scaling_policy_configuration--customized_metric_specification--dimensions"></a> | ||
### Nested Schema for `target_tracking_scaling_policy_configuration.customized_metric_specification.dimensions` | ||
|
||
Read-Only: | ||
|
||
- `name` (String) The name of the dimension. | ||
- `value` (String) The value of the dimension. | ||
|
||
|
||
<a id="nestedatt--target_tracking_scaling_policy_configuration--customized_metric_specification--metrics"></a> | ||
### Nested Schema for `target_tracking_scaling_policy_configuration.customized_metric_specification.metrics` | ||
|
||
Read-Only: | ||
|
||
- `expression` (String) The math expression to perform on the returned data, if this object is performing a math expression. | ||
- `id` (String) A short name that identifies the object's results in the response. | ||
- `label` (String) A human-readable label for this metric or expression. This is especially useful if this is a math expression, so that you know what the value represents. | ||
- `metric_stat` (Attributes) Information about the metric data to return. (see [below for nested schema](#nestedatt--target_tracking_scaling_policy_configuration--customized_metric_specification--metrics--metric_stat)) | ||
- `return_data` (Boolean) Indicates whether to return the timestamps and raw data values of this metric. | ||
|
||
<a id="nestedatt--target_tracking_scaling_policy_configuration--customized_metric_specification--metrics--metric_stat"></a> | ||
### Nested Schema for `target_tracking_scaling_policy_configuration.customized_metric_specification.metrics.return_data` | ||
|
||
Read-Only: | ||
|
||
- `metric` (Attributes) The CloudWatch metric to return, including the metric name, namespace, and dimensions. (see [below for nested schema](#nestedatt--target_tracking_scaling_policy_configuration--customized_metric_specification--metrics--return_data--metric)) | ||
- `stat` (String) The statistic to return. It can include any CloudWatch statistic or extended statistic. | ||
- `unit` (String) The unit to use for the returned data points. | ||
|
||
<a id="nestedatt--target_tracking_scaling_policy_configuration--customized_metric_specification--metrics--return_data--metric"></a> | ||
### Nested Schema for `target_tracking_scaling_policy_configuration.customized_metric_specification.metrics.return_data.metric` | ||
|
||
Read-Only: | ||
|
||
- `dimensions` (Attributes List) The dimensions for the metric. (see [below for nested schema](#nestedatt--target_tracking_scaling_policy_configuration--customized_metric_specification--metrics--return_data--metric--dimensions)) | ||
- `metric_name` (String) The name of the metric. | ||
- `namespace` (String) The namespace of the metric. | ||
|
||
<a id="nestedatt--target_tracking_scaling_policy_configuration--customized_metric_specification--metrics--return_data--metric--dimensions"></a> | ||
### Nested Schema for `target_tracking_scaling_policy_configuration.customized_metric_specification.metrics.return_data.metric.namespace` | ||
|
||
Read-Only: | ||
|
||
- `name` (String) The name of the dimension. | ||
- `value` (String) The value of the dimension. | ||
|
||
|
||
|
||
|
||
|
||
|
||
<a id="nestedatt--target_tracking_scaling_policy_configuration--predefined_metric_specification"></a> | ||
### Nested Schema for `target_tracking_scaling_policy_configuration.predefined_metric_specification` | ||
|
||
Read-Only: | ||
|
||
- `predefined_metric_type` (String) The metric type. The ALBRequestCountPerTarget metric type applies only to Spot Fleets and ECS services. | ||
- `resource_label` (String) Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is ALBRequestCountPerTarget and there is a target group attached to the Spot Fleet or ECS service. |
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,32 @@ | ||
--- | ||
# generated by https://github.com/hashicorp/terraform-plugin-docs | ||
page_title: "awscc_ec2_security_group_egress Data Source - terraform-provider-awscc" | ||
subcategory: "" | ||
description: |- | ||
Data Source schema for AWS::EC2::SecurityGroupEgress | ||
--- | ||
|
||
# awscc_ec2_security_group_egress (Data Source) | ||
|
||
Data Source schema for AWS::EC2::SecurityGroupEgress | ||
|
||
|
||
|
||
<!-- schema generated by tfplugindocs --> | ||
## Schema | ||
|
||
### Required | ||
|
||
- `id` (String) Uniquely identifies the resource. | ||
|
||
### Read-Only | ||
|
||
- `cidr_ip` (String) The IPv4 ranges | ||
- `cidr_ipv_6` (String) [VPC only] The IPv6 ranges | ||
- `description` (String) Resource Type definition for an egress (outbound) security group rule. | ||
- `destination_prefix_list_id` (String) [EC2-VPC only] The ID of a prefix list. | ||
- `destination_security_group_id` (String) You must specify a destination security group (DestinationPrefixListId or DestinationSecurityGroupId) or a CIDR range (CidrIp or CidrIpv6). | ||
- `from_port` (Number) The start of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes. | ||
- `group_id` (String) The ID of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID. | ||
- `ip_protocol` (String) [VPC only] Use -1 to specify all protocols. When authorizing security group rules, specifying -1 or a protocol number other than tcp, udp, icmp, or icmpv6 allows traffic on all ports, regardless of any port range you specify. For tcp, udp, and icmp, you must specify a port range. For icmpv6, the port range is optional; if you omit the port range, traffic for all types and codes is allowed. | ||
- `to_port` (Number) The end of port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. A value of -1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all codes. |
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_ec2_security_group_egresses Data Source - terraform-provider-awscc" | ||
subcategory: "" | ||
description: |- | ||
Plural Data Source schema for AWS::EC2::SecurityGroupEgress | ||
--- | ||
|
||
# awscc_ec2_security_group_egresses (Data Source) | ||
|
||
Plural Data Source schema for AWS::EC2::SecurityGroupEgress | ||
|
||
|
||
|
||
<!-- 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
Oops, something went wrong.