diff --git a/website/source/docs/providers/aws/r/autoscaling_group.html.markdown b/website/source/docs/providers/aws/r/autoscaling_group.html.markdown index eb4fd97d0..db8d98cfa 100644 --- a/website/source/docs/providers/aws/r/autoscaling_group.html.markdown +++ b/website/source/docs/providers/aws/r/autoscaling_group.html.markdown @@ -114,7 +114,6 @@ The following attributes are exported: ~> **NOTE:** When using `ELB` as the health_check_type, `health_check_grace_period` is required. - ## Waiting for Capacity A newly-created ASG is initially empty and begins to scale to `min_size` (or diff --git a/website/source/docs/providers/aws/r/cloudfront_distribution.html.markdown b/website/source/docs/providers/aws/r/cloudfront_distribution.html.markdown index c7eb13e2e..8bfa53c7d 100644 --- a/website/source/docs/providers/aws/r/cloudfront_distribution.html.markdown +++ b/website/source/docs/providers/aws/r/cloudfront_distribution.html.markdown @@ -88,113 +88,264 @@ of several sub-resources - these resources are laid out below. ### Top-Level Arguments -* `aliases` (Optional) - Extra CNAMEs (alternate domain names), if any, for this distribution. -* `cache_behavior` (Optional) - A [cache behavior](#cache_behavior) resource for this distribution (multiples allowed). -* `comment` (Optional) - Any comments you want to include about the distribution. -* `custom_error_response` (Optional) - One or more [custom error response](#custom_error_response) elements (multiples allowed). -* `default_cache_behavior` (Required) - The [default cache behavior](#default_cache_behavior) for this distribution (maximum one). -* `default_root_object` (Optional) - The object that you want CloudFront to return (for example, index.html) when an end user requests the root URL. -* `enabled` (Required) - Whether the distribution is enabled to accept end user requests for content. -* `logging_config` (Optional) - The [logging configuration](#logging_config) that controls how logs are written to your distribution (maximum one). -* `origin` (Required) - One or more [origins](#origin) for this distribution (multiples allowed). -* `price_class` (Optional) - The price class for this distribution. One of `PriceClass_All`, `PriceClass_200`, `PriceClass_100` -* `restrictions` (Required) - The [restriction configuration](#restrictions) for this distribution (maximum one). -* `viewer_certificate` (Required) - The [SSL configuration](#viewer_certificate) for this distribution (maximum one). -* `web_acl_id` (Optional) - If you're using AWS WAF to filter CloudFront requests, the Id of the AWS WAF web ACL that is associated with the distribution. -* `retain_on_delete` (Optional) - Disables the distribution instead of deleting it when destroying the resource through Terraform. If this is set, the distribution needs to be deleted manually afterwards. Default: `false`. + * `aliases` (Optional) - Extra CNAMEs (alternate domain names), if any, for + this distribution. -#### `cache_behavior` Arguments + * `cache_behavior` (Optional) - A [cache behavior](#cache-behavior-arguments) + resource for this distribution (multiples allowed). -* `allowed_methods` (Required) - Controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. -* `cached_methods` (Required) - Controls whether CloudFront caches the response to requests using the specified HTTP methods. -* `compress` (Optional) - Whether you want CloudFront to automatically compress content for web requests that include `Accept-Encoding: gzip` in the request header (default: `false`). -* `default_ttl` (Required) - The default amount of time (in seconds) that an object is in a CloudFront cache before CloudFront forwards another request in the absence of an `Cache-Control max-age` or `Expires` header. -* `forwarded_values` (Required) - The [forwarded values configuration](#forwarded_values) that specifies how CloudFront handles query strings, cookies and headers (maximum one). -* `max_ttl` (Required) - The maximum amount of time (in seconds) that an object is in a CloudFront cache before CloudFront forwards another request to your origin to determine whether the object has been updated. Only effective in the presence of `Cache-Control max-age`, `Cache-Control s-maxage`, and `Expires` headers. -* `min_ttl` (Required) - The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated. -* `path_pattern` (Required) - The pattern (for example, `images/*.jpg)` that specifies which requests you want this cache behavior to apply to. -* `smooth_streaming` (Optional) - Indicates whether you want to distribute media files in Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. -* `target_origin_id` (Required) - The value of ID for the origin that you want CloudFront to route requests to when a request matches the path pattern either for a cache behavior or for the default cache behavior. -* `trusted_signers` (Optional) - The AWS accounts, if any, that you want to allow to create signed URLs for private content. -* `viewer_protocol_policy` (Required) - Use this element to specify the protocol that users can use to access the files in the origin specified by TargetOriginId when a request matches the path pattern in PathPattern. One of `allow-all`, `https-only`, or `redirect-to-https`. + * `comment` (Optional) - Any comments you want to include about the + distribution. -##### `forwarded_values` Arguments + * `custom_error_response` (Optional) - One or more [custom error + response](#custom-error-response-arguments) elements (multiples allowed). -* `cookies` (Optional) - The [forwarded values cookies](#cookies) that specifies how CloudFront handles cookies (maximum one). -* `headers` (Optional) - Specifies the Headers, if any, that you want CloudFront to vary upon for this cache behavior. Specify `*` to include all headers. -* `query_string` (Required) - Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior. + * `default_cache_behavior` (Required) - The [default cache + behavior](#default-cache-behavior-arguments) for this distribution (maximum + one). -##### `cookies` Arguments + * `default_root_object` (Optional) - The object that you want CloudFront to + return (for example, index.html) when an end user requests the root URL. -* `forward` (Required) - Specifies whether you want CloudFront to forward cookies to the origin that is associated with this cache behavior. You can specify `all`, `none` or `whitelist`. -* `whitelisted_names` (Optional) - If you have specified `whitelist` to `forward`, the whitelisted cookies that you want CloudFront to forward to your origin. + * `enabled` (Required) - Whether the distribution is enabled to accept end + user requests for content. -#### `custom_error_response` Arguments + * `logging_config` (Optional) - The [logging + configuration](#logging-config-arguments) that controls how logs are written + to your distribution (maximum one). -* `error_caching_min_ttl` (Optional) - The minimum amount of time you want HTTP error codes to stay in CloudFront caches before CloudFront queries your origin to see whether the object has been updated. -* `error_code` (Required) - The 4xx or 5xx HTTP status code that you want to customize. -* `response_code` (Optional) - The HTTP status code that you want CloudFront to return with the custom error page to the viewer. -* `response_page_path` (Optional) - The path of the custom error page (for example, `/custom_404.html`). + * `origin` (Required) - One or more [origins](#origin-arguments) for this + distribution (multiples allowed). -#### `default_cache_behavior` Arguments + * `price_class` (Optional) - The price class for this distribution. One of + `PriceClass_All`, `PriceClass_200`, `PriceClass_100` -The arguments for `default_cache_behavior` are the same as for [`cache_behavior`](#cache_behavior), except for the `path_pattern` argument is not required. + * `restrictions` (Required) - The [restriction + configuration](#restrictions-arguments) for this distribution (maximum one). -#### `logging_config` Arguments + * `viewer_certificate` (Required) - The [SSL + configuration](#viewer-certificate-arguments) for this distribution (maximum + one). -* `bucket` (Required) - The Amazon S3 bucket to store the access logs in, for example, `myawslogbucket.s3.amazonaws.com`. -* `include_cookies` (Optional) - Specifies whether you want CloudFront to include cookies in access logs (default: `false`). -* `prefix` (Optional) - An optional string that you want CloudFront to prefix to the access log filenames for this distribution, for example, `myprefix/`. + * `web_acl_id` (Optional) - If you're using AWS WAF to filter CloudFront + requests, the Id of the AWS WAF web ACL that is associated with the + distribution. -#### `origin` Arguments + * `retain_on_delete` (Optional) - Disables the distribution instead of + deleting it when destroying the resource through Terraform. If this is set, + the distribution needs to be deleted manually afterwards. Default: `false`. -* `custom_origin_config` - The [CloudFront custom origin](#custom_origin_config) configuration information. If an S3 origin is required, use `s3_origin_config` instead. -* `domain_name` (Required) - The DNS domain name of either the S3 bucket, or web site of your custom origin. -* `custom_header` (Optional) - One or more sub-resources with `name` and `value` parameters that specify header data that will be sent to the origin (multiples allowed). -* `origin_id` (Required) - A unique identifier for the origin. -* `origin_path` (Optional) - An optional element that causes CloudFront to request your content from a directory in your Amazon S3 bucket or your custom origin. -* `s3_origin_config` - The [CloudFront S3 origin](#s3_origin_config) configuration information. If a custom origin is required, use `custom_origin_config` instead. +#### Cache Behavior Arguments -##### `custom_origin_config` Arguments + * `allowed_methods` (Required) - Controls which HTTP methods CloudFront + processes and forwards to your Amazon S3 bucket or your custom origin. -* `http_port` (Required) - The HTTP port the custom origin listens on. -* `https_port` (Required) - The HTTPS port the custom origin listens on. -* `origin_protocol_policy` (Required) - The origin protocol policy to apply to your origin. One of `http-only`, `https-only`, or `match-viewer`. -* `origin_ssl_protocols` (Required) - The SSL/TLS protocols that you want CloudFront to use when communicating with your origin over HTTPS. A list of one or more of `SSLv3`, `TLSv1`, `TLSv1.1`, and `TLSv1.2`. + * `cached_methods` (Required) - Controls whether CloudFront caches the + response to requests using the specified HTTP methods. -##### `s3_origin_config` Arguments + * `compress` (Optional) - Whether you want CloudFront to automatically + compress content for web requests that include `Accept-Encoding: gzip` in + the request header (default: `false`). -* `origin_access_identity` (Optional) - The [CloudFront origin access identity][5] to associate with the origin. + * `default_ttl` (Required) - The default amount of time (in seconds) that an + object is in a CloudFront cache before CloudFront forwards another request + in the absence of an `Cache-Control max-age` or `Expires` header. -#### `restrictions` Arguments + * `forwarded_values` (Required) - The [forwarded values + configuration](#forwarded-values-arguments) that specifies how CloudFront + handles query strings, cookies and headers (maximum one). -The `restrictions` sub-resource takes another single sub-resource named `geo_restriction` (see the example for usage). + * `max_ttl` (Required) - The maximum amount of time (in seconds) that an + object is in a CloudFront cache before CloudFront forwards another request + to your origin to determine whether the object has been updated. Only + effective in the presence of `Cache-Control max-age`, `Cache-Control + s-maxage`, and `Expires` headers. + + * `min_ttl` (Required) - The minimum amount of time that you want objects to + stay in CloudFront caches before CloudFront queries your origin to see + whether the object has been updated. + + * `path_pattern` (Required) - The pattern (for example, `images/*.jpg)` that + specifies which requests you want this cache behavior to apply to. + + * `smooth_streaming` (Optional) - Indicates whether you want to distribute + media files in Microsoft Smooth Streaming format using the origin that is + associated with this cache behavior. + + * `target_origin_id` (Required) - The value of ID for the origin that you want + CloudFront to route requests to when a request matches the path pattern + either for a cache behavior or for the default cache behavior. + + * `trusted_signers` (Optional) - The AWS accounts, if any, that you want to + allow to create signed URLs for private content. + + * `viewer_protocol_policy` (Required) - Use this element to specify the + protocol that users can use to access the files in the origin specified by + TargetOriginId when a request matches the path pattern in PathPattern. One + of `allow-all`, `https-only`, or `redirect-to-https`. + +##### Forwarded Values Arguments + + * `cookies` (Optional) - The [forwarded values cookies](#cookies-arguments) + that specifies how CloudFront handles cookies (maximum one). + + * `headers` (Optional) - Specifies the Headers, if any, that you want + CloudFront to vary upon for this cache behavior. Specify `*` to include all + headers. + + * `query_string` (Required) - Indicates whether you want CloudFront to forward + query strings to the origin that is associated with this cache behavior. + +##### Cookies Arguments + + * `forward` (Required) - Specifies whether you want CloudFront to forward + cookies to the origin that is associated with this cache behavior. You can + specify `all`, `none` or `whitelist`. + + * `whitelisted_names` (Optional) - If you have specified `whitelist` to + `forward`, the whitelisted cookies that you want CloudFront to forward to + your origin. + +#### Custom Error Response Arguments + + * `error_caching_min_ttl` (Optional) - The minimum amount of time you want + HTTP error codes to stay in CloudFront caches before CloudFront queries your + origin to see whether the object has been updated. + + * `error_code` (Required) - The 4xx or 5xx HTTP status code that you want to + customize. + + * `response_code` (Optional) - The HTTP status code that you want CloudFront + to return with the custom error page to the viewer. + + * `response_page_path` (Optional) - The path of the custom error page (for + example, `/custom_404.html`). + +#### Default Cache Behavior Arguments + +The arguments for `default_cache_behavior` are the same as for +[`cache_behavior`](#cache-behavior-arguments), except for the `path_pattern` +argument is not required. + +#### Logging Config Arguments + + * `bucket` (Required) - The Amazon S3 bucket to store the access logs in, for + example, `myawslogbucket.s3.amazonaws.com`. + + * `include_cookies` (Optional) - Specifies whether you want CloudFront to + include cookies in access logs (default: `false`). + + * `prefix` (Optional) - An optional string that you want CloudFront to prefix + to the access log filenames for this distribution, for example, `myprefix/`. + +#### Origin Arguments + + * `custom_origin_config` - The [CloudFront custom + origin](#custom-origin-config-arguments) configuration information. If an S3 + origin is required, use `s3_origin_config` instead. + + * `domain_name` (Required) - The DNS domain name of either the S3 bucket, or + web site of your custom origin. + + * `custom_header` (Optional) - One or more sub-resources with `name` and + `value` parameters that specify header data that will be sent to the origin + (multiples allowed). + + * `origin_id` (Required) - A unique identifier for the origin. + + * `origin_path` (Optional) - An optional element that causes CloudFront to + request your content from a directory in your Amazon S3 bucket or your + custom origin. + + * `s3_origin_config` - The [CloudFront S3 origin](#s3-origin-config-arguments) + configuration information. If a custom origin is required, use + `custom_origin_config` instead. + +##### Custom Origin Config Arguments + + * `http_port` (Required) - The HTTP port the custom origin listens on. + + * `https_port` (Required) - The HTTPS port the custom origin listens on. + + * `origin_protocol_policy` (Required) - The origin protocol policy to apply to + your origin. One of `http-only`, `https-only`, or `match-viewer`. + + * `origin_ssl_protocols` (Required) - The SSL/TLS protocols that you want + CloudFront to use when communicating with your origin over HTTPS. A list of + one or more of `SSLv3`, `TLSv1`, `TLSv1.1`, and `TLSv1.2`. + +##### S3 Origin Config Arguments + +* `origin_access_identity` (Optional) - The [CloudFront origin access + identity][5] to associate with the origin. + +#### Restrictions Arguments + +The `restrictions` sub-resource takes another single sub-resource named +`geo_restriction` (see the example for usage). The arguments of `geo_restriction` are: -* `locations` (Optional) - The [ISO 3166-1-alpha-2 codes][4] for which you want CloudFront either to distribute your content (`whitelist`) or not distribute your content (`blacklist`). -* `restriction_type` (Required) - The method that you want to use to restrict distribution of your content by country: `none`, `whitelist`, or `blacklist`. + * `locations` (Optional) - The [ISO 3166-1-alpha-2 codes][4] for which you + want CloudFront either to distribute your content (`whitelist`) or not + distribute your content (`blacklist`). -#### `viewer_certificate` Arguments + * `restriction_type` (Required) - The method that you want to use to restrict + distribution of your content by country: `none`, `whitelist`, or + `blacklist`. -* `acm_certificate_arn` - The ARN of the [AWS Certificate Manager][6] certificate that you wish to use with this distribution. Specify this, `cloudfront_default_certificate`, or `iam_certificate_id`. -* `cloudfront_default_certificate` - `true` if you want viewers to use HTTPS to request your objects and you're using the CloudFront domain name for your distribution. Specify this, `acm_certificate_arn`, or `iam_certificate_id`. -* `iam_certificate_id` - The IAM certificate identifier of the custom viewer certificate for this distribution if you are using a custom domain. Specify this, `acm_certificate_arn`, or `cloudfront_default_certificate`. -* `minimum_protocol_version` - The minimum version of the SSL protocol that you want CloudFront to use for HTTPS connections. One of `SSLv3` or `TLSv1`. Default: `SSLv3`. **NOTE**: If you are using a custom certificate (specified with `acm_certificate_arn` or `iam_certificate_id`), and have specified `sni-only` in `ssl_support_method`, `TLSv1` must be specified. -* `ssl_support_method`: Specifies how you want CloudFront to serve HTTPS requests. One of `vip` or `sni-only`. Required if you specify `acm_certificate_arn` or `iam_certificate_id`. **NOTE:** `vip` causes CloudFront to use a dedicated IP address and may incur extra charges. +#### Viewer Certificate Arguments + + * `acm_certificate_arn` - The ARN of the [AWS Certificate Manager][6] + certificate that you wish to use with this distribution. Specify this, + `cloudfront_default_certificate`, or `iam_certificate_id`. + + * `cloudfront_default_certificate` - `true` if you want viewers to use HTTPS + to request your objects and you're using the CloudFront domain name for your + distribution. Specify this, `acm_certificate_arn`, or `iam_certificate_id`. + + * `iam_certificate_id` - The IAM certificate identifier of the custom viewer + certificate for this distribution if you are using a custom domain. Specify + this, `acm_certificate_arn`, or `cloudfront_default_certificate`. + + * `minimum_protocol_version` - The minimum version of the SSL protocol that + you want CloudFront to use for HTTPS connections. One of `SSLv3` or `TLSv1`. + Default: `SSLv3`. **NOTE**: If you are using a custom certificate (specified + with `acm_certificate_arn` or `iam_certificate_id`), and have specified + `sni-only` in `ssl_support_method`, `TLSv1` must be specified. + + * `ssl_support_method`: Specifies how you want CloudFront to serve HTTPS + requests. One of `vip` or `sni-only`. Required if you specify + `acm_certificate_arn` or `iam_certificate_id`. **NOTE:** `vip` causes + CloudFront to use a dedicated IP address and may incur extra charges. ## Attribute Reference The following attributes are exported: -* `id` - The identifier for the distribution. For example: `EDFDVBD632BHDS5`. -* `caller_reference` - Internal value used by CloudFront to allow future updates to the distribution configuration. -* `status` - The current status of the distribution. `Deployed` if the distribution's information is fully propagated throughout the Amazon CloudFront system. -* `active_trusted_signers` - The key pair IDs that CloudFront is aware of for each trusted signer, if the distribution is set up to serve private content with signed URLs. -* `domain_name` - The domain name corresponding to the distribution. For example: `d604721fxaaqy9.cloudfront.net`. -* `last_modified_time` - The date and time the distribution was last modified. -* `in_progress_validation_batches` - The number of invalidation batches currently in progress. -* `etag` - The current version of the distribution's information. For example: `E2QWRUHAPOMQZL`. + * `id` - The identifier for the distribution. For example: `EDFDVBD632BHDS5`. + + * `caller_reference` - Internal value used by CloudFront to allow future + updates to the distribution configuration. + + * `status` - The current status of the distribution. `Deployed` if the + distribution's information is fully propagated throughout the Amazon + CloudFront system. + + * `active_trusted_signers` - The key pair IDs that CloudFront is aware of for + each trusted signer, if the distribution is set up to serve private content + with signed URLs. + + * `domain_name` - The domain name corresponding to the distribution. For + example: `d604721fxaaqy9.cloudfront.net`. + + * `last_modified_time` - The date and time the distribution was last modified. + + * `in_progress_validation_batches` - The number of invalidation batches + currently in progress. + + * `etag` - The current version of the distribution's information. For example: + `E2QWRUHAPOMQZL`. [1]: http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Introduction.html diff --git a/website/source/docs/providers/aws/r/elastic_beanstalk_configuration_template.html.markdown b/website/source/docs/providers/aws/r/elastic_beanstalk_configuration_template.html.markdown index a493f58ff..4f2fcc993 100644 --- a/website/source/docs/providers/aws/r/elastic_beanstalk_configuration_template.html.markdown +++ b/website/source/docs/providers/aws/r/elastic_beanstalk_configuration_template.html.markdown @@ -43,7 +43,6 @@ The following arguments are supported: off of. Example stacks can be found in the [Amazon API documentation][1] - ## Option Settings The `setting` field supports the following format: diff --git a/website/source/docs/providers/aws/r/elastic_beanstalk_environment.html.markdown b/website/source/docs/providers/aws/r/elastic_beanstalk_environment.html.markdown index 02450823f..2c7523870 100644 --- a/website/source/docs/providers/aws/r/elastic_beanstalk_environment.html.markdown +++ b/website/source/docs/providers/aws/r/elastic_beanstalk_environment.html.markdown @@ -60,7 +60,6 @@ this time the Elastic Beanstalk API does not provide a programatic way of changing these tags after initial application - ## Option Settings Some options can be stack-specific, check [AWS Docs](http://docs.aws.amazon.com/elasticbeanstalk/latest/dg/command-options-general.html) diff --git a/website/source/docs/providers/aws/r/instance.html.markdown b/website/source/docs/providers/aws/r/instance.html.markdown index d67b49ff3..c93e66c53 100644 --- a/website/source/docs/providers/aws/r/instance.html.markdown +++ b/website/source/docs/providers/aws/r/instance.html.markdown @@ -69,7 +69,6 @@ instances. See [Shutdown Behavior](https://docs.aws.amazon.com/AWSEC2/latest/Use "Instance Store") volumes on the instance. See [Block Devices](#block-devices) below for details. - ## Block devices Each of the `*_block_device` attributes controls a portion of the AWS diff --git a/website/source/docs/providers/aws/r/launch_configuration.html.markdown b/website/source/docs/providers/aws/r/launch_configuration.html.markdown index d32a1c806..dfe85aa18 100644 --- a/website/source/docs/providers/aws/r/launch_configuration.html.markdown +++ b/website/source/docs/providers/aws/r/launch_configuration.html.markdown @@ -109,7 +109,6 @@ The following arguments are supported: `"default"` or `"dedicated"`, see [AWS's Create Launch Configuration](http://docs.aws.amazon.com/AutoScaling/latest/APIReference/API_CreateLaunchConfiguration.html) for more details - ## Block devices Each of the `*_block_device` attributes controls a portion of the AWS diff --git a/website/source/docs/providers/aws/r/opsworks_instance.html.markdown b/website/source/docs/providers/aws/r/opsworks_instance.html.markdown index 149939cfc..cfb14bd13 100644 --- a/website/source/docs/providers/aws/r/opsworks_instance.html.markdown +++ b/website/source/docs/providers/aws/r/opsworks_instance.html.markdown @@ -57,7 +57,6 @@ The following arguments are supported: "Instance Store") volumes on the instance. See [Block Devices](#block-devices) below for details. - ## Block devices Each of the `*_block_device` attributes controls a portion of the AWS