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 Jan 29, 2025
1 parent 61cf4e4 commit 2e0abd2
Show file tree
Hide file tree
Showing 22 changed files with 188 additions and 32 deletions.
10 changes: 10 additions & 0 deletions docs/data-sources/aps_scraper.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ Data Source schema for AWS::APS::Scraper
- `arn` (String) Scraper ARN.
- `destination` (Attributes) Scraper metrics destination (see [below for nested schema](#nestedatt--destination))
- `role_arn` (String) IAM role ARN for the scraper.
- `role_configuration` (Attributes) Role configuration (see [below for nested schema](#nestedatt--role_configuration))
- `scrape_configuration` (Attributes) Scraper configuration (see [below for nested schema](#nestedatt--scrape_configuration))
- `scraper_id` (String) Required to identify a specific scraper.
- `source` (Attributes) Scraper metrics source (see [below for nested schema](#nestedatt--source))
Expand All @@ -46,6 +47,15 @@ Read-Only:



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

Read-Only:

- `source_role_arn` (String) IAM Role in source account
- `target_role_arn` (String) IAM Role in the target account


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

Expand Down
28 changes: 28 additions & 0 deletions docs/data-sources/batch_job_definition.md
Original file line number Diff line number Diff line change
Expand Up @@ -547,6 +547,7 @@ Read-Only:
- `mount_path` (String)
- `name` (String)
- `read_only` (Boolean)
- `sub_path` (String)



Expand Down Expand Up @@ -612,6 +613,7 @@ Read-Only:
- `mount_path` (String)
- `name` (String)
- `read_only` (Boolean)
- `sub_path` (String)



Expand All @@ -620,7 +622,9 @@ Read-Only:

Read-Only:

- `annotations` (Map of String)
- `labels` (Map of String)
- `namespace` (String)


<a id="nestedatt--eks_properties--pod_properties--volumes"></a>
Expand All @@ -631,6 +635,7 @@ Read-Only:
- `empty_dir` (Attributes) (see [below for nested schema](#nestedatt--eks_properties--pod_properties--volumes--empty_dir))
- `host_path` (Attributes) (see [below for nested schema](#nestedatt--eks_properties--pod_properties--volumes--host_path))
- `name` (String)
- `persistent_volume_claim` (Attributes) (see [below for nested schema](#nestedatt--eks_properties--pod_properties--volumes--persistent_volume_claim))
- `secret` (Attributes) (see [below for nested schema](#nestedatt--eks_properties--pod_properties--volumes--secret))

<a id="nestedatt--eks_properties--pod_properties--volumes--empty_dir"></a>
Expand All @@ -650,6 +655,15 @@ Read-Only:
- `path` (String)


<a id="nestedatt--eks_properties--pod_properties--volumes--persistent_volume_claim"></a>
### Nested Schema for `eks_properties.pod_properties.volumes.persistent_volume_claim`

Read-Only:

- `claim_name` (String)
- `read_only` (Boolean)


<a id="nestedatt--eks_properties--pod_properties--volumes--secret"></a>
### Nested Schema for `eks_properties.pod_properties.volumes.secret`

Expand Down Expand Up @@ -1148,6 +1162,7 @@ Read-Only:
- `mount_path` (String)
- `name` (String)
- `read_only` (Boolean)
- `sub_path` (String)



Expand Down Expand Up @@ -1213,6 +1228,7 @@ Read-Only:
- `mount_path` (String)
- `name` (String)
- `read_only` (Boolean)
- `sub_path` (String)



Expand All @@ -1221,7 +1237,9 @@ Read-Only:

Read-Only:

- `annotations` (Map of String)
- `labels` (Map of String)
- `namespace` (String)


<a id="nestedatt--node_properties--node_range_properties--eks_properties--pod_properties--volumes"></a>
Expand All @@ -1232,6 +1250,7 @@ Read-Only:
- `empty_dir` (Attributes) (see [below for nested schema](#nestedatt--node_properties--node_range_properties--eks_properties--pod_properties--volumes--empty_dir))
- `host_path` (Attributes) (see [below for nested schema](#nestedatt--node_properties--node_range_properties--eks_properties--pod_properties--volumes--host_path))
- `name` (String)
- `persistent_volume_claim` (Attributes) (see [below for nested schema](#nestedatt--node_properties--node_range_properties--eks_properties--pod_properties--volumes--persistent_volume_claim))
- `secret` (Attributes) (see [below for nested schema](#nestedatt--node_properties--node_range_properties--eks_properties--pod_properties--volumes--secret))

<a id="nestedatt--node_properties--node_range_properties--eks_properties--pod_properties--volumes--empty_dir"></a>
Expand All @@ -1251,6 +1270,15 @@ Read-Only:
- `path` (String)


<a id="nestedatt--node_properties--node_range_properties--eks_properties--pod_properties--volumes--persistent_volume_claim"></a>
### Nested Schema for `node_properties.node_range_properties.eks_properties.pod_properties.volumes.persistent_volume_claim`

Read-Only:

- `claim_name` (String)
- `read_only` (Boolean)


<a id="nestedatt--node_properties--node_range_properties--eks_properties--pod_properties--volumes--secret"></a>
### Nested Schema for `node_properties.node_range_properties.eks_properties.pod_properties.volumes.secret`

Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/cloudformation_public_type_version.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Data Source schema for AWS::CloudFormation::PublicTypeVersion
- `log_delivery_bucket` (String) A url to the S3 bucket where logs for the testType run will be available
- `public_type_arn` (String) The Amazon Resource Number (ARN) assigned to the public extension upon publication
- `public_version_number` (String) The version number of a public third-party extension
- `publisher_id` (String) The publisher id assigned by CloudFormation for publishing in this region.
- `publisher_id` (String) The reserved publisher id for this type, or the publisher id assigned by CloudFormation for publishing in this region.
- `type` (String) The kind of extension
- `type_name` (String) The name of the type being registered.

Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/cloudformation_publisher.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,6 @@ Data Source schema for AWS::CloudFormation::Publisher
- `accept_terms_and_conditions` (Boolean) Whether you accept the terms and conditions for publishing extensions in the CloudFormation registry. You must accept the terms and conditions in order to publish public extensions to the CloudFormation registry. The terms and conditions can be found at https://cloudformation-registry-documents.s3.amazonaws.com/Terms_and_Conditions_for_AWS_CloudFormation_Registry_Publishers.pdf
- `connection_arn` (String) If you are using a Bitbucket or GitHub account for identity verification, the Amazon Resource Name (ARN) for your connection to that account.
- `identity_provider` (String) The type of account used as the identity provider when registering this publisher with CloudFormation.
- `publisher_id` (String) The publisher id assigned by CloudFormation for publishing in this region.
- `publisher_id` (String) The reserved publisher id for this type, or the publisher id assigned by CloudFormation for publishing in this region.
- `publisher_profile` (String) The URL to the publisher's profile with the identity provider.
- `publisher_status` (String) Whether the publisher is verified.
2 changes: 1 addition & 1 deletion docs/data-sources/cloudformation_type_activation.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Data Source schema for AWS::CloudFormation::TypeActivation
- `logging_config` (Attributes) Specifies logging configuration information for a type. (see [below for nested schema](#nestedatt--logging_config))
- `major_version` (String) The Major Version of the type you want to enable
- `public_type_arn` (String) The Amazon Resource Number (ARN) assigned to the public extension upon publication
- `publisher_id` (String) The publisher id assigned by CloudFormation for publishing in this region.
- `publisher_id` (String) The reserved publisher id for this type, or the publisher id assigned by CloudFormation for publishing in this region.
- `type` (String) The kind of extension
- `type_name` (String) The name of the type being registered.

Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/dynamodb_table.md
Original file line number Diff line number Diff line change
Expand Up @@ -279,7 +279,7 @@ Read-Only:
Read-Only:

- `point_in_time_recovery_enabled` (Boolean) Indicates whether point in time recovery is enabled (true) or disabled (false) on the table.
- `recovery_period_in_days` (Number)
- `recovery_period_in_days` (Number) The number of preceding days for which continuous backups are taken and maintained. Your table data is only recoverable to any point-in-time from within the configured recovery period. This parameter is optional. If no value is provided, the value will default to 35.


<a id="nestedatt--provisioned_throughput"></a>
Expand Down
5 changes: 2 additions & 3 deletions docs/data-sources/ecs_service.md
Original file line number Diff line number Diff line change
Expand Up @@ -179,9 +179,9 @@ Read-Only:
Read-Only:

- `assign_public_ip` (String) Whether the task's elastic network interface receives a public IP address. The default value is ``ENABLED``.
- `security_groups` (List of String) The IDs of the security groups associated with the task or service. If you don't specify a security group, the default security group for the VPC is used. There's a limit of 5 security groups that can be specified per ``awsvpcConfiguration``.
- `security_groups` (List of String) The IDs of the security groups associated with the task or service. If you don't specify a security group, the default security group for the VPC is used. There's a limit of 5 security groups that can be specified.
All specified security groups must be from the same VPC.
- `subnets` (List of String) The IDs of the subnets associated with the task or service. There's a limit of 16 subnets that can be specified per ``awsvpcConfiguration``.
- `subnets` (List of String) The IDs of the subnets associated with the task or service. There's a limit of 16 subnets that can be specified.
All specified subnets must be from the same VPC.


Expand Down Expand Up @@ -378,7 +378,6 @@ Read-Only:
- `tag_specifications` (Attributes List) The tags to apply to the volume. Amazon ECS applies service-managed tags by default. This parameter maps 1:1 with the ``TagSpecifications.N`` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference*. (see [below for nested schema](#nestedatt--volume_configurations--managed_ebs_volume--tag_specifications))
- `throughput` (Number) The throughput to provision for a volume, in MiB/s, with a maximum of 1,000 MiB/s. This parameter maps 1:1 with the ``Throughput`` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference*.
This parameter is only supported for the ``gp3`` volume type.
- `volume_initialization_rate` (Number)
- `volume_type` (String) The volume type. This parameter maps 1:1 with the ``VolumeType`` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference*. For more information, see [Amazon EBS volume types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-volume-types.html) in the *Amazon EC2 User Guide*.
The following are the supported volume types.
+ General Purpose SSD: ``gp2``|``gp3``
Expand Down
1 change: 1 addition & 0 deletions docs/data-sources/iotfleetwise_state_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ Data Source schema for AWS::IoTFleetWise::StateTemplate
- `metadata_extra_dimensions` (List of String)
- `name` (String)
- `signal_catalog_arn` (String)
- `state_template_id` (String)
- `state_template_properties` (List of String)
- `tags` (Attributes Set) (see [below for nested schema](#nestedatt--tags))

Expand Down
36 changes: 36 additions & 0 deletions docs/data-sources/iotfleetwise_vehicle.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,44 @@ Data Source schema for AWS::IoTFleetWise::Vehicle
- `last_modification_time` (String)
- `model_manifest_arn` (String)
- `name` (String)
- `state_templates` (Attributes Set) (see [below for nested schema](#nestedatt--state_templates))
- `tags` (Attributes Set) (see [below for nested schema](#nestedatt--tags))

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

Read-Only:

- `identifier` (String)
- `state_template_update_strategy` (Attributes) (see [below for nested schema](#nestedatt--state_templates--state_template_update_strategy))

<a id="nestedatt--state_templates--state_template_update_strategy"></a>
### Nested Schema for `state_templates.state_template_update_strategy`

Read-Only:

- `on_change` (String)
- `periodic` (Attributes) (see [below for nested schema](#nestedatt--state_templates--state_template_update_strategy--periodic))

<a id="nestedatt--state_templates--state_template_update_strategy--periodic"></a>
### Nested Schema for `state_templates.state_template_update_strategy.periodic`

Read-Only:

- `state_template_update_rate` (Attributes) (see [below for nested schema](#nestedatt--state_templates--state_template_update_strategy--periodic--state_template_update_rate))

<a id="nestedatt--state_templates--state_template_update_strategy--periodic--state_template_update_rate"></a>
### Nested Schema for `state_templates.state_template_update_strategy.periodic.state_template_update_rate`

Read-Only:

- `unit` (String)
- `value` (Number)





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

Expand Down
12 changes: 3 additions & 9 deletions docs/data-sources/iotsitewise_gateway.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ Data Source schema for AWS::IoTSiteWise::Gateway
- `gateway_id` (String) The ID of the gateway device.
- `gateway_name` (String) A unique, friendly name for the gateway.
- `gateway_platform` (Attributes) The gateway's platform. You can only specify one platform in a gateway. (see [below for nested schema](#nestedatt--gateway_platform))
- `gateway_version` (String) The version of the gateway you want to create.
- `tags` (Attributes List) A list of key-value pairs that contain metadata for the gateway. (see [below for nested schema](#nestedatt--tags))

<a id="nestedatt--gateway_capability_summaries"></a>
Expand All @@ -41,23 +42,16 @@ Read-Only:

Read-Only:

- `greengrass` (Attributes) A gateway that runs on AWS IoT Greengrass V1. (see [below for nested schema](#nestedatt--gateway_platform--greengrass))
- `greengrass` (String) A gateway that runs on AWS IoT Greengrass V1.
- `greengrass_v2` (Attributes) A gateway that runs on AWS IoT Greengrass V2. (see [below for nested schema](#nestedatt--gateway_platform--greengrass_v2))
- `siemens_ie` (Attributes) A gateway that runs on Siemens Industrial Edge. (see [below for nested schema](#nestedatt--gateway_platform--siemens_ie))

<a id="nestedatt--gateway_platform--greengrass"></a>
### Nested Schema for `gateway_platform.greengrass`

Read-Only:

- `group_arn` (String) The ARN of the Greengrass group.


<a id="nestedatt--gateway_platform--greengrass_v2"></a>
### Nested Schema for `gateway_platform.greengrass_v2`

Read-Only:

- `core_device_operating_system` (String) The operating system of the core device in AWS IoT Greengrass V2.
- `core_device_thing_name` (String) The name of the CoreDevice in GreenGrass V2.


Expand Down
10 changes: 10 additions & 0 deletions docs/data-sources/kinesisfirehose_delivery_stream.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ Data Source schema for AWS::KinesisFirehose::DeliveryStream
- `delivery_stream_encryption_configuration_input` (Attributes) (see [below for nested schema](#nestedatt--delivery_stream_encryption_configuration_input))
- `delivery_stream_name` (String)
- `delivery_stream_type` (String)
- `direct_put_source_configuration` (Attributes) (see [below for nested schema](#nestedatt--direct_put_source_configuration))
- `elasticsearch_destination_configuration` (Attributes) (see [below for nested schema](#nestedatt--elasticsearch_destination_configuration))
- `extended_s3_destination_configuration` (Attributes) (see [below for nested schema](#nestedatt--extended_s3_destination_configuration))
- `http_endpoint_destination_configuration` (Attributes) (see [below for nested schema](#nestedatt--http_endpoint_destination_configuration))
Expand Down Expand Up @@ -398,6 +399,14 @@ Read-Only:
- `key_type` (String)


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

Read-Only:

- `throughput_hint_in_m_bs` (Number)


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

Expand Down Expand Up @@ -966,6 +975,7 @@ Read-Only:

Read-Only:

- `append_only` (Boolean)
- `buffering_hints` (Attributes) (see [below for nested schema](#nestedatt--iceberg_destination_configuration--buffering_hints))
- `catalog_configuration` (Attributes) (see [below for nested schema](#nestedatt--iceberg_destination_configuration--catalog_configuration))
- `cloudwatch_logging_options` (Attributes) (see [below for nested schema](#nestedatt--iceberg_destination_configuration--cloudwatch_logging_options))
Expand Down
10 changes: 10 additions & 0 deletions docs/resources/aps_scraper.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ Resource Type definition for AWS::APS::Scraper
### Optional

- `alias` (String) Scraper alias.
- `role_configuration` (Attributes) Role configuration (see [below for nested schema](#nestedatt--role_configuration))
- `tags` (Attributes Set) An array of key-value pairs to apply to this resource. (see [below for nested schema](#nestedatt--tags))

### Read-Only
Expand Down Expand Up @@ -75,6 +76,15 @@ Optional:



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

Optional:

- `source_role_arn` (String) IAM Role in source account
- `target_role_arn` (String) IAM Role in the target account


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

Expand Down
Loading

0 comments on commit 2e0abd2

Please sign in to comment.