Skip to content

Commit

Permalink
Run 'make docs-all'.
Browse files Browse the repository at this point in the history
  • Loading branch information
johnsonaj committed Dec 18, 2024
1 parent 570a9a5 commit 0c966ef
Show file tree
Hide file tree
Showing 25 changed files with 588 additions and 37 deletions.
12 changes: 7 additions & 5 deletions docs/data-sources/autoscaling_auto_scaling_group.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ Data Source schema for AWS::AutoScaling::AutoScalingGroup
- `auto_scaling_group_name` (String) The name of the Auto Scaling group. This name must be unique per Region per account.
The name can contain any ASCII character 33 to 126 including most punctuation characters, digits, and upper and lowercased letters.
You cannot use a colon (:) in the name.
- `availability_zone_distribution` (Attributes) (see [below for nested schema](#nestedatt--availability_zone_distribution))
- `availability_zone_impairment_policy` (Attributes) (see [below for nested schema](#nestedatt--availability_zone_impairment_policy))
- `availability_zone_distribution` (Attributes) The instance capacity distribution across Availability Zones. (see [below for nested schema](#nestedatt--availability_zone_distribution))
- `availability_zone_impairment_policy` (Attributes) The Availability Zone impairment policy. (see [below for nested schema](#nestedatt--availability_zone_impairment_policy))
- `availability_zones` (List of String) A list of Availability Zones where instances in the Auto Scaling group can be created. Used for launching into the default VPC subnet in each Availability Zone when not using the ``VPCZoneIdentifier`` property, or for attaching a network interface when an existing network interface ID is specified in a launch template.
- `capacity_rebalance` (Boolean) Indicates whether Capacity Rebalancing is enabled. Otherwise, Capacity Rebalancing is disabled. When you turn on Capacity Rebalancing, Amazon EC2 Auto Scaling attempts to launch a Spot Instance whenever Amazon EC2 notifies that a Spot Instance is at an elevated risk of interruption. After launching a new instance, it then terminates an old instance. For more information, see [Use Capacity Rebalancing to handle Amazon EC2 Spot Interruptions](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-capacity-rebalancing.html) in the in the *Amazon EC2 Auto Scaling User Guide*.
- `capacity_reservation_specification` (Attributes) (see [below for nested schema](#nestedatt--capacity_reservation_specification))
Expand Down Expand Up @@ -89,16 +89,18 @@ Data Source schema for AWS::AutoScaling::AutoScalingGroup

Read-Only:

- `capacity_distribution_strategy` (String)
- `capacity_distribution_strategy` (String) If launches fail in an Availability Zone, the following strategies are available. The default is ``balanced-best-effort``.
+ ``balanced-only`` - If launches fail in an Availability Zone, Auto Scaling will continue to attempt to launch in the unhealthy zone to preserve a balanced distribution.
+ ``balanced-best-effort`` - If launches fail in an Availability Zone, Auto Scaling will attempt to launch in another healthy Availability Zone instead.


<a id="nestedatt--availability_zone_impairment_policy"></a>
### Nested Schema for `availability_zone_impairment_policy`

Read-Only:

- `impaired_zone_health_check_behavior` (String)
- `zonal_shift_enabled` (Boolean)
- `impaired_zone_health_check_behavior` (String) Specifies the health check behavior for the impaired Availability Zone in an active zonal shift. If you select ``Replace unhealthy``, instances that appear unhealthy will be replaced in all Availability Zones. If you select ``Ignore unhealthy``, instances will not be replaced in the Availability Zone with the active zonal shift. For more information, see [Auto Scaling group zonal shift](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-zonal-shift.html) in the *Amazon EC2 Auto Scaling User Guide*.
- `zonal_shift_enabled` (Boolean) If ``true``, enable zonal shift for your Auto Scaling group.


<a id="nestedatt--capacity_reservation_specification"></a>
Expand Down
4 changes: 4 additions & 0 deletions docs/data-sources/databrew_dataset.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ Data Source schema for AWS::DataBrew::Dataset
- `input` (Attributes) Input (see [below for nested schema](#nestedatt--input))
- `name` (String) Dataset name
- `path_options` (Attributes) PathOptions (see [below for nested schema](#nestedatt--path_options))
- `source` (String) Source type of the dataset
- `tags` (Attributes List) (see [below for nested schema](#nestedatt--tags))

<a id="nestedatt--format_options"></a>
Expand Down Expand Up @@ -91,6 +92,7 @@ Read-Only:
Read-Only:

- `bucket` (String)
- `bucket_owner` (String) Bucket owner
- `key` (String)


Expand All @@ -111,6 +113,7 @@ Read-Only:
Read-Only:

- `bucket` (String)
- `bucket_owner` (String) Bucket owner
- `key` (String)


Expand All @@ -129,6 +132,7 @@ Read-Only:
Read-Only:

- `bucket` (String)
- `bucket_owner` (String) Bucket owner
- `key` (String)


Expand Down
25 changes: 25 additions & 0 deletions docs/data-sources/ec2_ec2_fleet.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,7 @@ Read-Only:
- `allowed_instance_types` (List of String)
- `bare_metal` (String)
- `baseline_ebs_bandwidth_mbps` (Attributes) (see [below for nested schema](#nestedatt--launch_template_configs--overrides--instance_requirements--baseline_ebs_bandwidth_mbps))
- `baseline_performance_factors` (Attributes) (see [below for nested schema](#nestedatt--launch_template_configs--overrides--instance_requirements--baseline_performance_factors))
- `burstable_performance` (String)
- `cpu_manufacturers` (List of String)
- `excluded_instance_types` (List of String)
Expand Down Expand Up @@ -124,6 +125,30 @@ Read-Only:
- `min` (Number)


<a id="nestedatt--launch_template_configs--overrides--instance_requirements--baseline_performance_factors"></a>
### Nested Schema for `launch_template_configs.overrides.instance_requirements.baseline_performance_factors`

Read-Only:

- `cpu` (Attributes) (see [below for nested schema](#nestedatt--launch_template_configs--overrides--instance_requirements--baseline_performance_factors--cpu))

<a id="nestedatt--launch_template_configs--overrides--instance_requirements--baseline_performance_factors--cpu"></a>
### Nested Schema for `launch_template_configs.overrides.instance_requirements.baseline_performance_factors.cpu`

Read-Only:

- `references` (Attributes List) (see [below for nested schema](#nestedatt--launch_template_configs--overrides--instance_requirements--baseline_performance_factors--cpu--references))

<a id="nestedatt--launch_template_configs--overrides--instance_requirements--baseline_performance_factors--cpu--references"></a>
### Nested Schema for `launch_template_configs.overrides.instance_requirements.baseline_performance_factors.cpu.references`

Read-Only:

- `instance_family` (String)




<a id="nestedatt--launch_template_configs--overrides--instance_requirements--memory_gi_b_per_v_cpu"></a>
### Nested Schema for `launch_template_configs.overrides.instance_requirements.memory_gi_b_per_v_cpu`

Expand Down
50 changes: 50 additions & 0 deletions docs/data-sources/ec2_spot_fleet.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,7 @@ Read-Only:
- `allowed_instance_types` (List of String)
- `bare_metal` (String)
- `baseline_ebs_bandwidth_mbps` (Attributes) (see [below for nested schema](#nestedatt--spot_fleet_request_config_data--launch_specifications--instance_requirements--baseline_ebs_bandwidth_mbps))
- `baseline_performance_factors` (Attributes) (see [below for nested schema](#nestedatt--spot_fleet_request_config_data--launch_specifications--instance_requirements--baseline_performance_factors))
- `burstable_performance` (String)
- `cpu_manufacturers` (List of String)
- `excluded_instance_types` (List of String)
Expand Down Expand Up @@ -166,6 +167,30 @@ Read-Only:
- `min` (Number)


<a id="nestedatt--spot_fleet_request_config_data--launch_specifications--instance_requirements--baseline_performance_factors"></a>
### Nested Schema for `spot_fleet_request_config_data.launch_specifications.instance_requirements.baseline_performance_factors`

Read-Only:

- `cpu` (Attributes) (see [below for nested schema](#nestedatt--spot_fleet_request_config_data--launch_specifications--instance_requirements--baseline_performance_factors--cpu))

<a id="nestedatt--spot_fleet_request_config_data--launch_specifications--instance_requirements--baseline_performance_factors--cpu"></a>
### Nested Schema for `spot_fleet_request_config_data.launch_specifications.instance_requirements.baseline_performance_factors.cpu`

Read-Only:

- `references` (Attributes List) (see [below for nested schema](#nestedatt--spot_fleet_request_config_data--launch_specifications--instance_requirements--baseline_performance_factors--cpu--references))

<a id="nestedatt--spot_fleet_request_config_data--launch_specifications--instance_requirements--baseline_performance_factors--cpu--references"></a>
### Nested Schema for `spot_fleet_request_config_data.launch_specifications.instance_requirements.baseline_performance_factors.cpu.references`

Read-Only:

- `instance_family` (String)




<a id="nestedatt--spot_fleet_request_config_data--launch_specifications--instance_requirements--memory_gi_b_per_v_cpu"></a>
### Nested Schema for `spot_fleet_request_config_data.launch_specifications.instance_requirements.memory_gi_b_per_v_cpu`

Expand Down Expand Up @@ -345,6 +370,7 @@ Read-Only:
- `allowed_instance_types` (List of String)
- `bare_metal` (String)
- `baseline_ebs_bandwidth_mbps` (Attributes) (see [below for nested schema](#nestedatt--spot_fleet_request_config_data--launch_template_configs--overrides--instance_requirements--baseline_ebs_bandwidth_mbps))
- `baseline_performance_factors` (Attributes) (see [below for nested schema](#nestedatt--spot_fleet_request_config_data--launch_template_configs--overrides--instance_requirements--baseline_performance_factors))
- `burstable_performance` (String)
- `cpu_manufacturers` (List of String)
- `excluded_instance_types` (List of String)
Expand Down Expand Up @@ -389,6 +415,30 @@ Read-Only:
- `min` (Number)


<a id="nestedatt--spot_fleet_request_config_data--launch_template_configs--overrides--instance_requirements--baseline_performance_factors"></a>
### Nested Schema for `spot_fleet_request_config_data.launch_template_configs.overrides.instance_requirements.baseline_performance_factors`

Read-Only:

- `cpu` (Attributes) (see [below for nested schema](#nestedatt--spot_fleet_request_config_data--launch_template_configs--overrides--instance_requirements--baseline_performance_factors--cpu))

<a id="nestedatt--spot_fleet_request_config_data--launch_template_configs--overrides--instance_requirements--baseline_performance_factors--cpu"></a>
### Nested Schema for `spot_fleet_request_config_data.launch_template_configs.overrides.instance_requirements.baseline_performance_factors.cpu`

Read-Only:

- `references` (Attributes List) (see [below for nested schema](#nestedatt--spot_fleet_request_config_data--launch_template_configs--overrides--instance_requirements--baseline_performance_factors--cpu--references))

<a id="nestedatt--spot_fleet_request_config_data--launch_template_configs--overrides--instance_requirements--baseline_performance_factors--cpu--references"></a>
### Nested Schema for `spot_fleet_request_config_data.launch_template_configs.overrides.instance_requirements.baseline_performance_factors.cpu.references`

Read-Only:

- `instance_family` (String)




<a id="nestedatt--spot_fleet_request_config_data--launch_template_configs--overrides--instance_requirements--memory_gi_b_per_v_cpu"></a>
### Nested Schema for `spot_fleet_request_config_data.launch_template_configs.overrides.instance_requirements.memory_gi_b_per_v_cpu`

Expand Down
12 changes: 12 additions & 0 deletions docs/data-sources/ec2_vpc_endpoint.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ Data Source schema for AWS::EC2::VPCEndpoint

- `creation_timestamp` (String)
- `dns_entries` (List of String)
- `dns_options` (Attributes) (see [below for nested schema](#nestedatt--dns_options))
- `ip_address_type` (String)
- `network_interface_ids` (List of String)
- `policy_document` (String) An endpoint policy, which controls access to the service from the VPC. The default endpoint policy allows full access to the service. Endpoint policies are supported only for gateway and interface endpoints.
For CloudFormation templates in YAML, you can provide the policy in JSON or YAML format. For example, if you have a JSON policy, you can convert it to YAML before including it in the YAML template, and CFNlong converts the policy to JSON format before calling the API actions for privatelink. Alternatively, you can include the JSON directly in the YAML, as shown in the following ``Properties`` section:
Expand All @@ -31,11 +33,21 @@ Data Source schema for AWS::EC2::VPCEndpoint
To use a private hosted zone, you must set the following VPC attributes to ``true``: ``enableDnsHostnames`` and ``enableDnsSupport``.
This property is supported only for interface endpoints.
Default: ``false``
- `resource_configuration_arn` (String)
- `route_table_ids` (Set of String) The IDs of the route tables. Routing is supported only for gateway endpoints.
- `security_group_ids` (Set of String) The IDs of the security groups to associate with the endpoint network interfaces. If this parameter is not specified, we use the default security group for the VPC. Security groups are supported only for interface endpoints.
- `service_name` (String) The name of the endpoint service.
- `service_network_arn` (String)
- `subnet_ids` (Set of String) The IDs of the subnets in which to create endpoint network interfaces. You must specify this property for an interface endpoint or a Gateway Load Balancer endpoint. You can't specify this property for a gateway endpoint. For a Gateway Load Balancer endpoint, you can specify only one subnet.
- `vpc_endpoint_id` (String)
- `vpc_endpoint_type` (String) The type of endpoint.
Default: Gateway
- `vpc_id` (String) The ID of the VPC.

<a id="nestedatt--dns_options"></a>
### Nested Schema for `dns_options`

Read-Only:

- `dns_record_ip_type` (String)
- `private_dns_only_for_inbound_resolver_endpoint` (String)
13 changes: 3 additions & 10 deletions docs/data-sources/lambda_function.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,13 +38,7 @@ Data Source schema for AWS::Lambda::Function
If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
- `handler` (String) The name of the method within your code that Lambda calls to run your function. Handler is required if the deployment package is a .zip file archive. The format includes the file name. It can also include namespaces and other qualifiers, depending on the runtime. For more information, see [Lambda programming model](https://docs.aws.amazon.com/lambda/latest/dg/foundation-progmodel.html).
- `image_config` (Attributes) Configuration values that override the container image Dockerfile settings. For more information, see [Container image settings](https://docs.aws.amazon.com/lambda/latest/dg/images-create.html#images-parms). (see [below for nested schema](#nestedatt--image_config))
- `kms_key_arn` (String) The ARN of the KMSlong (KMS) customer managed key that's used to encrypt the following resources:
+ The function's [environment variables](https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html#configuration-envvars-encryption).
+ The function's [Lambda SnapStart](https://docs.aws.amazon.com/lambda/latest/dg/snapstart-security.html) snapshots.
+ When used with ``SourceKMSKeyArn``, the unzipped version of the .zip deployment package that's used for function invocations. For more information, see [Specifying a customer managed key for Lambda](https://docs.aws.amazon.com/lambda/latest/dg/encrypt-zip-package.html#enable-zip-custom-encryption).
+ The optimized version of the container image that's used for function invocations. Note that this is not the same key that's used to protect your container image in the Amazon Elastic Container Registry (Amazon ECR). For more information, see [Function lifecycle](https://docs.aws.amazon.com/lambda/latest/dg/images-create.html#images-lifecycle).

If you don't provide a customer managed key, Lambda uses an [owned key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-owned-cmk) or an [](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk).
- `kms_key_arn` (String) The ARN of the KMSlong (KMS) customer managed key that's used to encrypt your function's [environment variables](https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html#configuration-envvars-encryption). When [SnapStart](https://docs.aws.amazon.com/lambda/latest/dg/snapstart-security.html) is activated, LAM also uses this key is to encrypt your function's snapshot. If you deploy your function using a container image, LAM also uses this key to encrypt your function when it's deployed. Note that this is not the same key that's used to protect your container image in the ECRlong (ECR). If you don't provide a customer managed key, LAM uses a default service key.
- `layers` (List of String) A list of [function layers](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html) to add to the function's execution environment. Specify each layer by its ARN, including the version.
- `logging_config` (Attributes) The function's Amazon CloudWatch Logs configuration settings. (see [below for nested schema](#nestedatt--logging_config))
- `memory_size` (Number) The amount of [memory available to the function](https://docs.aws.amazon.com/lambda/latest/dg/configuration-function-common.html#configuration-memory-console) at runtime. Increasing the function memory also increases its CPU allocation. The default value is 128 MB. The value can be any multiple of 1 MB. Note that new AWS accounts have reduced concurrency and memory quotas. AWS raises these quotas automatically based on your usage. You can also request a quota increase.
Expand Down Expand Up @@ -75,10 +69,9 @@ Read-Only:
- `s3_bucket` (String) An Amazon S3 bucket in the same AWS-Region as your function. The bucket can be in a different AWS-account.
- `s3_key` (String) The Amazon S3 key of the deployment package.
- `s3_object_version` (String) For versioned objects, the version of the deployment package object to use.
- `source_kms_key_arn` (String) The ARN of the KMSlong (KMS) customer managed key that's used to encrypt your function's .zip deployment package. If you don't provide a customer managed key, Lambda uses an [owned key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-owned-cmk).
- `source_kms_key_arn` (String)
- `zip_file` (String) (Node.js and Python) The source code of your Lambda function. If you include your function source inline with this parameter, CFN places it in a file named ``index`` and zips it to create a [deployment package](https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-package.html). This zip file cannot exceed 4MB. For the ``Handler`` property, the first part of the handler identifier must be ``index``. For example, ``index.handler``.
When you specify source code inline for a Node.js function, the ``index`` file that CFN creates uses the extension ``.js``. This means that LAM treats the file as a CommonJS module. ES modules aren't supported for inline functions.
For JSON, you must escape quotes and special characters such as newline (``\n``) with a backslash.
For JSON, you must escape quotes and special characters such as newline (``\n``) with a backslash.
If you specify a function that interacts with an AWS CloudFormation custom resource, you don't have to write your own functions to send responses to the custom resource that invoked the function. AWS CloudFormation provides a response module ([cfn-response](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cfn-lambda-function-code-cfnresponsemodule.html)) that simplifies sending responses. See [Using Lambda with CloudFormation](https://docs.aws.amazon.com/lambda/latest/dg/services-cloudformation.html) for details.


Expand Down
Loading

0 comments on commit 0c966ef

Please sign in to comment.