-
Notifications
You must be signed in to change notification settings - Fork 1
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 #134 from stackql/feature/doc-updates
updated awscc
- Loading branch information
Showing
158 changed files
with
11,877 additions
and
10 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
103 changes: 103 additions & 0 deletions
103
docs/awscc-docs/providers/awscc/ec2/capacity_reservation/index.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,103 @@ | ||
--- | ||
title: capacity_reservation | ||
hide_title: false | ||
hide_table_of_contents: false | ||
keywords: | ||
- capacity_reservation | ||
- ec2 | ||
- aws | ||
- stackql | ||
- infrastructure-as-code | ||
- configuration-as-data | ||
- cloud inventory | ||
description: Query, deploy and manage AWS resources using SQL | ||
custom_edit_url: null | ||
image: /img/providers/aws/stackql-aws-provider-featured-image.png | ||
--- | ||
Gets an individual <code>capacity_reservation</code> resource | ||
|
||
## Overview | ||
<table><tbody> | ||
<tr><td><b>Name</b></td><td><code>capacity_reservation</code></td></tr> | ||
<tr><td><b>Type</b></td><td>Resource</td></tr> | ||
<tr><td><b>Description</b></td><td>capacity_reservation</td></tr> | ||
<tr><td><b>Id</b></td><td><code>awscc.ec2.capacity_reservation</code></td></tr> | ||
</tbody></table> | ||
|
||
## Fields | ||
<table><tbody> | ||
<tr><th>Name</th><th>Datatype</th><th>Description</th></tr> | ||
<tr><td><code>tenancy</code></td><td><code>string</code></td><td></td></tr> | ||
<tr><td><code>end_date_type</code></td><td><code>string</code></td><td></td></tr> | ||
<tr><td><code>tag_specifications</code></td><td><code>array</code></td><td></td></tr> | ||
<tr><td><code>availability_zone</code></td><td><code>string</code></td><td></td></tr> | ||
<tr><td><code>total_instance_count</code></td><td><code>integer</code></td><td></td></tr> | ||
<tr><td><code>end_date</code></td><td><code>string</code></td><td></td></tr> | ||
<tr><td><code>ebs_optimized</code></td><td><code>boolean</code></td><td></td></tr> | ||
<tr><td><code>out_post_arn</code></td><td><code>string</code></td><td></td></tr> | ||
<tr><td><code>instance_count</code></td><td><code>integer</code></td><td></td></tr> | ||
<tr><td><code>placement_group_arn</code></td><td><code>string</code></td><td></td></tr> | ||
<tr><td><code>available_instance_count</code></td><td><code>integer</code></td><td></td></tr> | ||
<tr><td><code>instance_platform</code></td><td><code>string</code></td><td></td></tr> | ||
<tr><td><code>id</code></td><td><code>string</code></td><td></td></tr> | ||
<tr><td><code>instance_type</code></td><td><code>string</code></td><td></td></tr> | ||
<tr><td><code>ephemeral_storage</code></td><td><code>boolean</code></td><td></td></tr> | ||
<tr><td><code>instance_match_criteria</code></td><td><code>string</code></td><td></td></tr> | ||
<tr><td><code>region</code></td><td><code>string</code></td><td>AWS region.</td></tr> | ||
|
||
</tbody></table> | ||
|
||
## Methods | ||
Currently only <code>SELECT</code> is supported for this resource resource. | ||
|
||
## Example | ||
```sql | ||
SELECT | ||
region, | ||
tenancy, | ||
end_date_type, | ||
tag_specifications, | ||
availability_zone, | ||
total_instance_count, | ||
end_date, | ||
ebs_optimized, | ||
out_post_arn, | ||
instance_count, | ||
placement_group_arn, | ||
available_instance_count, | ||
instance_platform, | ||
id, | ||
instance_type, | ||
ephemeral_storage, | ||
instance_match_criteria | ||
FROM awscc.ec2.capacity_reservation | ||
WHERE data__Identifier = '<Id>'; | ||
``` | ||
|
||
## Permissions | ||
|
||
To operate on the <code>capacity_reservation</code> resource, the following permissions are required: | ||
|
||
### Delete | ||
```json | ||
ec2:CreateCapacityReservation, | ||
ec2:DescribeCapacityReservations, | ||
ec2:CancelCapacityReservation, | ||
ec2:DeleteTags | ||
``` | ||
|
||
### Read | ||
```json | ||
ec2:DescribeCapacityReservations | ||
``` | ||
|
||
### Update | ||
```json | ||
ec2:ModifyCapacityReservation, | ||
ec2:CreateCapacityReservation, | ||
ec2:DescribeCapacityReservations, | ||
ec2:CancelCapacityReservation, | ||
ec2:CreateTags, | ||
ec2:DeleteTags | ||
``` | ||
|
101 changes: 101 additions & 0 deletions
101
docs/awscc-docs/providers/awscc/ec2/capacity_reservation_fleet/index.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,101 @@ | ||
--- | ||
title: capacity_reservation_fleet | ||
hide_title: false | ||
hide_table_of_contents: false | ||
keywords: | ||
- capacity_reservation_fleet | ||
- ec2 | ||
- aws | ||
- stackql | ||
- infrastructure-as-code | ||
- configuration-as-data | ||
- cloud inventory | ||
description: Query, deploy and manage AWS resources using SQL | ||
custom_edit_url: null | ||
image: /img/providers/aws/stackql-aws-provider-featured-image.png | ||
--- | ||
Gets an individual <code>capacity_reservation_fleet</code> resource | ||
|
||
## Overview | ||
<table><tbody> | ||
<tr><td><b>Name</b></td><td><code>capacity_reservation_fleet</code></td></tr> | ||
<tr><td><b>Type</b></td><td>Resource</td></tr> | ||
<tr><td><b>Description</b></td><td>capacity_reservation_fleet</td></tr> | ||
<tr><td><b>Id</b></td><td><code>awscc.ec2.capacity_reservation_fleet</code></td></tr> | ||
</tbody></table> | ||
|
||
## Fields | ||
<table><tbody> | ||
<tr><th>Name</th><th>Datatype</th><th>Description</th></tr> | ||
<tr><td><code>allocation_strategy</code></td><td><code>string</code></td><td></td></tr> | ||
<tr><td><code>tag_specifications</code></td><td><code>array</code></td><td></td></tr> | ||
<tr><td><code>instance_type_specifications</code></td><td><code>array</code></td><td></td></tr> | ||
<tr><td><code>total_target_capacity</code></td><td><code>integer</code></td><td></td></tr> | ||
<tr><td><code>end_date</code></td><td><code>string</code></td><td></td></tr> | ||
<tr><td><code>instance_match_criteria</code></td><td><code>string</code></td><td></td></tr> | ||
<tr><td><code>capacity_reservation_fleet_id</code></td><td><code>string</code></td><td></td></tr> | ||
<tr><td><code>tenancy</code></td><td><code>string</code></td><td></td></tr> | ||
<tr><td><code>remove_end_date</code></td><td><code>boolean</code></td><td></td></tr> | ||
<tr><td><code>no_remove_end_date</code></td><td><code>boolean</code></td><td></td></tr> | ||
<tr><td><code>region</code></td><td><code>string</code></td><td>AWS region.</td></tr> | ||
|
||
</tbody></table> | ||
|
||
## Methods | ||
Currently only <code>SELECT</code> is supported for this resource resource. | ||
|
||
## Example | ||
```sql | ||
SELECT | ||
region, | ||
allocation_strategy, | ||
tag_specifications, | ||
instance_type_specifications, | ||
total_target_capacity, | ||
end_date, | ||
instance_match_criteria, | ||
capacity_reservation_fleet_id, | ||
tenancy, | ||
remove_end_date, | ||
no_remove_end_date | ||
FROM awscc.ec2.capacity_reservation_fleet | ||
WHERE data__Identifier = '<CapacityReservationFleetId>'; | ||
``` | ||
|
||
## Permissions | ||
|
||
To operate on the <code>capacity_reservation_fleet</code> resource, the following permissions are required: | ||
|
||
### Delete | ||
```json | ||
ec2:CreateCapacityReservationFleet, | ||
ec2:ModifyCapacityReservationFleet, | ||
ec2:DescribeCapacityReservationFleets, | ||
ec2:CancelCapacityReservationFleets, | ||
ec2:CreateCapacityReservation, | ||
ec2:DescribeCapacityReservations, | ||
ec2:CancelCapacityReservation, | ||
ec2:DeleteTags | ||
``` | ||
|
||
### Read | ||
```json | ||
ec2:DescribeCapacityReservationFleets, | ||
ec2:DescribeInstances, | ||
ec2:DescribeCapacityReservations | ||
``` | ||
|
||
### Update | ||
```json | ||
ec2:CreateCapacityReservationFleet, | ||
ec2:ModifyCapacityReservationFleet, | ||
ec2:DescribeCapacityReservationFleets, | ||
ec2:CancelCapacityReservationFleets, | ||
ec2:CreateCapacityReservation, | ||
ec2:ModifyCapacityReservation, | ||
ec2:DescribeCapacityReservations, | ||
ec2:CancelCapacityReservation, | ||
ec2:DescribeInstances, | ||
ec2:DeleteTags | ||
``` | ||
|
71 changes: 71 additions & 0 deletions
71
docs/awscc-docs/providers/awscc/ec2/capacity_reservation_fleets/index.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,71 @@ | ||
--- | ||
title: capacity_reservation_fleets | ||
hide_title: false | ||
hide_table_of_contents: false | ||
keywords: | ||
- capacity_reservation_fleets | ||
- ec2 | ||
- aws | ||
- stackql | ||
- infrastructure-as-code | ||
- configuration-as-data | ||
- cloud inventory | ||
description: Query, deploy and manage AWS resources using SQL | ||
custom_edit_url: null | ||
image: /img/providers/aws/stackql-aws-provider-featured-image.png | ||
--- | ||
Retrieves a list of <code>capacity_reservation_fleets</code> in a region | ||
|
||
## Overview | ||
<table><tbody> | ||
<tr><td><b>Name</b></td><td><code>capacity_reservation_fleets</code></td></tr> | ||
<tr><td><b>Type</b></td><td>Resource</td></tr> | ||
<tr><td><b>Description</b></td><td>capacity_reservation_fleets</td></tr> | ||
<tr><td><b>Id</b></td><td><code>awscc.ec2.capacity_reservation_fleets</code></td></tr> | ||
</tbody></table> | ||
|
||
## Fields | ||
<table><tbody> | ||
<tr><th>Name</th><th>Datatype</th><th>Description</th></tr> | ||
<tr><td><code>capacity_reservation_fleet_id</code></td><td><code>string</code></td><td></td></tr> | ||
<tr><td><code>region</code></td><td><code>string</code></td><td>AWS region.</td></tr> | ||
|
||
</tbody></table> | ||
|
||
## Methods | ||
Currently only <code>SELECT</code> is supported for this resource resource. | ||
|
||
## Example | ||
```sql | ||
SELECT | ||
region, | ||
capacity_reservation_fleet_id | ||
FROM awscc.ec2.capacity_reservation_fleets | ||
WHERE region = 'us-east-1' | ||
``` | ||
|
||
## Permissions | ||
|
||
To operate on the <code>capacity_reservation_fleets</code> resource, the following permissions are required: | ||
|
||
### Create | ||
```json | ||
ec2:CreateCapacityReservationFleet, | ||
ec2:ModifyCapacityReservationFleet, | ||
ec2:DescribeCapacityReservationFleets, | ||
ec2:CancelCapacityReservationFleets, | ||
ec2:CreateCapacityReservation, | ||
ec2:DescribeCapacityReservations, | ||
ec2:CancelCapacityReservation, | ||
ec2:DescribeInstances, | ||
ec2:CreateTags, | ||
iam:CreateServiceLinkedRole | ||
``` | ||
|
||
### List | ||
```json | ||
ec2:DescribeCapacityReservationFleets, | ||
ec2:DescribeCapacityReservations, | ||
ec2:DescribeInstances | ||
``` | ||
|
63 changes: 63 additions & 0 deletions
63
docs/awscc-docs/providers/awscc/ec2/capacity_reservations/index.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,63 @@ | ||
--- | ||
title: capacity_reservations | ||
hide_title: false | ||
hide_table_of_contents: false | ||
keywords: | ||
- capacity_reservations | ||
- ec2 | ||
- aws | ||
- stackql | ||
- infrastructure-as-code | ||
- configuration-as-data | ||
- cloud inventory | ||
description: Query, deploy and manage AWS resources using SQL | ||
custom_edit_url: null | ||
image: /img/providers/aws/stackql-aws-provider-featured-image.png | ||
--- | ||
Retrieves a list of <code>capacity_reservations</code> in a region | ||
|
||
## Overview | ||
<table><tbody> | ||
<tr><td><b>Name</b></td><td><code>capacity_reservations</code></td></tr> | ||
<tr><td><b>Type</b></td><td>Resource</td></tr> | ||
<tr><td><b>Description</b></td><td>capacity_reservations</td></tr> | ||
<tr><td><b>Id</b></td><td><code>awscc.ec2.capacity_reservations</code></td></tr> | ||
</tbody></table> | ||
|
||
## Fields | ||
<table><tbody> | ||
<tr><th>Name</th><th>Datatype</th><th>Description</th></tr> | ||
<tr><td><code>id</code></td><td><code>string</code></td><td></td></tr> | ||
<tr><td><code>region</code></td><td><code>string</code></td><td>AWS region.</td></tr> | ||
|
||
</tbody></table> | ||
|
||
## Methods | ||
Currently only <code>SELECT</code> is supported for this resource resource. | ||
|
||
## Example | ||
```sql | ||
SELECT | ||
region, | ||
id | ||
FROM awscc.ec2.capacity_reservations | ||
WHERE region = 'us-east-1' | ||
``` | ||
|
||
## Permissions | ||
|
||
To operate on the <code>capacity_reservations</code> resource, the following permissions are required: | ||
|
||
### Create | ||
```json | ||
ec2:CreateCapacityReservation, | ||
ec2:DescribeCapacityReservations, | ||
ec2:CancelCapacityReservation, | ||
ec2:CreateTags | ||
``` | ||
|
||
### List | ||
```json | ||
ec2:DescribeCapacityReservations | ||
``` | ||
|
Oops, something went wrong.