Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Additional CloudFormation resource schemas #161

Merged
merged 5 commits into from
Sep 16, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions docs/data-sources/acmpca_permission.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "awscc_acmpca_permission Data Source - terraform-provider-awscc"
subcategory: ""
description: |-
Data Source schema for AWS::ACMPCA::Permission
---

# awscc_acmpca_permission (Data Source)

Data Source schema for AWS::ACMPCA::Permission



<!-- schema generated by tfplugindocs -->
## Schema

### Required

- **id** (String) Uniquely identifies the resource.

### Read-Only

- **actions** (List of String) The actions that the specified AWS service principal can use. Actions IssueCertificate, GetCertificate and ListPermissions must be provided.
- **certificate_authority_arn** (String) The Amazon Resource Name (ARN) of the Private Certificate Authority that grants the permission.
- **principal** (String) The AWS service or identity that receives the permission. At this time, the only valid principal is acm.amazonaws.com.
- **source_account** (String) The ID of the calling account.


26 changes: 26 additions & 0 deletions docs/data-sources/apigateway_account.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "awscc_apigateway_account Data Source - terraform-provider-awscc"
subcategory: ""
description: |-
Data Source schema for AWS::ApiGateway::Account
---

# awscc_apigateway_account (Data Source)

Data Source schema for AWS::ApiGateway::Account



<!-- schema generated by tfplugindocs -->
## Schema

### Required

- **id** (String) Uniquely identifies the resource.

### Read-Only

- **cloudwatch_role_arn** (String) The Amazon Resource Name (ARN) of an IAM role that has write access to CloudWatch Logs in your account.


77 changes: 77 additions & 0 deletions docs/data-sources/apigateway_usage_plan.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "awscc_apigateway_usage_plan Data Source - terraform-provider-awscc"
subcategory: ""
description: |-
Data Source schema for AWS::ApiGateway::UsagePlan
---

# awscc_apigateway_usage_plan (Data Source)

Data Source schema for AWS::ApiGateway::UsagePlan



<!-- schema generated by tfplugindocs -->
## Schema

### Required

- **id** (String) Uniquely identifies the resource.

### Read-Only

- **api_stages** (Attributes List) The API stages to associate with this usage plan. (see [below for nested schema](#nestedatt--api_stages))
- **description** (String) A description of the usage plan.
- **quota** (Attributes) (see [below for nested schema](#nestedatt--quota))
- **tags** (Attributes List) An array of arbitrary tags (key-value pairs) to associate with the usage plan. (see [below for nested schema](#nestedatt--tags))
- **throttle** (Attributes) (see [below for nested schema](#nestedatt--throttle))
- **usage_plan_name** (String) A name for the usage plan.

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

Read-Only:

- **api_id** (String) The ID of an API that is in the specified Stage property that you want to associate with the usage plan.
- **stage** (String) The name of the stage to associate with the usage plan.
- **throttle** (Attributes Map) Map containing method-level throttling information for an API stage in a usage plan. The key for the map is the path and method for which to configure custom throttling, for example, '/pets/GET'. Duplicates are not allowed. (see [below for nested schema](#nestedatt--api_stages--throttle))

<a id="nestedatt--api_stages--throttle"></a>
### Nested Schema for `api_stages.throttle`

Read-Only:

- **burst_limit** (Number) The maximum API request rate limit over a time ranging from one to a few seconds. The maximum API request rate limit depends on whether the underlying token bucket is at its full capacity.
- **rate_limit** (Number) The API request steady-state rate limit (average requests per second over an extended period of time).



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

Read-Only:

- **limit** (Number) The maximum number of requests that users can make within the specified time period.
- **offset** (Number) For the initial time period, the number of requests to subtract from the specified limit. When you first implement a usage plan, the plan might start in the middle of the week or month. With this property, you can decrease the limit for this initial time period.
- **period** (String) The time period for which the maximum limit of requests applies, such as DAY or WEEK. For valid values, see the period property for the UsagePlan resource in the Amazon API Gateway REST API Reference.


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

Read-Only:

- **key** (String) The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- **value** (String) The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.


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

Read-Only:

- **burst_limit** (Number) The maximum API request rate limit over a time ranging from one to a few seconds. The maximum API request rate limit depends on whether the underlying token bucket is at its full capacity.
- **rate_limit** (Number) The API request steady-state rate limit (average requests per second over an extended period of time).


Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "awscc_groundstation_configs Data Source - terraform-provider-awscc"
page_title: "awscc_apigateway_usage_plans Data Source - terraform-provider-awscc"
subcategory: ""
description: |-
Plural Data Source schema for AWS::GroundStation::Config
Plural Data Source schema for AWS::ApiGateway::UsagePlan
---

# awscc_groundstation_configs (Data Source)
# awscc_apigateway_usage_plans (Data Source)

Plural Data Source schema for AWS::GroundStation::Config
Plural Data Source schema for AWS::ApiGateway::UsagePlan



Expand Down
38 changes: 38 additions & 0 deletions docs/data-sources/aps_workspace.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "awscc_aps_workspace Data Source - terraform-provider-awscc"
subcategory: ""
description: |-
Data Source schema for AWS::APS::Workspace
---

# awscc_aps_workspace (Data Source)

Data Source schema for AWS::APS::Workspace



<!-- schema generated by tfplugindocs -->
## Schema

### Required

- **id** (String) Uniquely identifies the resource.

### Read-Only

- **alias** (String) AMP Workspace alias.
- **arn** (String) Workspace arn.
- **prometheus_endpoint** (String) AMP Workspace prometheus endpoint
- **tags** (Attributes Set) An array of key-value pairs to apply to this resource. (see [below for nested schema](#nestedatt--tags))
- **workspace_id** (String) Required to identify a specific APS Workspace.

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

Read-Only:

- **key** (String) The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- **value** (String) The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.


Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "awscc_opsworkscm_servers Data Source - terraform-provider-awscc"
page_title: "awscc_aps_workspaces Data Source - terraform-provider-awscc"
subcategory: ""
description: |-
Plural Data Source schema for AWS::OpsWorksCM::Server
Plural Data Source schema for AWS::APS::Workspace
---

# awscc_opsworkscm_servers (Data Source)
# awscc_aps_workspaces (Data Source)

Plural Data Source schema for AWS::OpsWorksCM::Server
Plural Data Source schema for AWS::APS::Workspace



Expand Down
23 changes: 23 additions & 0 deletions docs/data-sources/cloudformation_stack_sets.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "awscc_cloudformation_stack_sets Data Source - terraform-provider-awscc"
subcategory: ""
description: |-
Plural Data Source schema for AWS::CloudFormation::StackSet
---

# awscc_cloudformation_stack_sets (Data Source)

Plural Data Source schema for AWS::CloudFormation::StackSet



<!-- schema generated by tfplugindocs -->
## Schema

### Read-Only

- **id** (String) Uniquely identifies the data source.
- **ids** (Set of String) Set of Resource Identifiers.


37 changes: 37 additions & 0 deletions docs/data-sources/config_aggregation_authorization.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "awscc_config_aggregation_authorization Data Source - terraform-provider-awscc"
subcategory: ""
description: |-
Data Source schema for AWS::Config::AggregationAuthorization
---

# awscc_config_aggregation_authorization (Data Source)

Data Source schema for AWS::Config::AggregationAuthorization



<!-- schema generated by tfplugindocs -->
## Schema

### Required

- **id** (String) Uniquely identifies the resource.

### Read-Only

- **aggregation_authorization_arn** (String) The ARN of the AggregationAuthorization.
- **authorized_account_id** (String) The 12-digit account ID of the account authorized to aggregate data.
- **authorized_aws_region** (String) The region authorized to collect aggregated data.
- **tags** (Attributes List) The tags for the AggregationAuthorization. (see [below for nested schema](#nestedatt--tags))

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

Read-Only:

- **key** (String) The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
- **value** (String) The value for the tag. You can specify a value that is 1 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.


23 changes: 23 additions & 0 deletions docs/data-sources/config_aggregation_authorizations.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "awscc_config_aggregation_authorizations Data Source - terraform-provider-awscc"
subcategory: ""
description: |-
Plural Data Source schema for AWS::Config::AggregationAuthorization
---

# awscc_config_aggregation_authorizations (Data Source)

Plural Data Source schema for AWS::Config::AggregationAuthorization



<!-- schema generated by tfplugindocs -->
## Schema

### Read-Only

- **id** (String) Uniquely identifies the data source.
- **ids** (Set of String) Set of Resource Identifiers.


50 changes: 50 additions & 0 deletions docs/data-sources/ec2_transit_gateway_vpc_attachment.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "awscc_ec2_transit_gateway_vpc_attachment Data Source - terraform-provider-awscc"
subcategory: ""
description: |-
Data Source schema for AWS::EC2::TransitGatewayVpcAttachment
---

# awscc_ec2_transit_gateway_vpc_attachment (Data Source)

Data Source schema for AWS::EC2::TransitGatewayVpcAttachment



<!-- schema generated by tfplugindocs -->
## Schema

### Required

- **id** (String) Uniquely identifies the resource.

### Read-Only

- **add_subnet_ids** (List of String)
- **options** (Attributes) The options for the transit gateway vpc attachment. (see [below for nested schema](#nestedatt--options))
- **remove_subnet_ids** (List of String)
- **subnet_ids** (List of String)
- **tags** (Attributes List) (see [below for nested schema](#nestedatt--tags))
- **transit_gateway_id** (String)
- **vpc_id** (String)

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

Read-Only:

- **appliance_mode_support** (String) Indicates whether to enable Ipv6 Support for Vpc Attachment. Valid Values: enable | disable
- **dns_support** (String) Indicates whether to enable DNS Support for Vpc Attachment. Valid Values: enable | disable
- **ipv_6_support** (String) Indicates whether to enable Ipv6 Support for Vpc Attachment. Valid Values: enable | disable


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

Read-Only:

- **key** (String)
- **value** (String)


23 changes: 23 additions & 0 deletions docs/data-sources/ec2_transit_gateway_vpc_attachments.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "awscc_ec2_transit_gateway_vpc_attachments Data Source - terraform-provider-awscc"
subcategory: ""
description: |-
Plural Data Source schema for AWS::EC2::TransitGatewayVpcAttachment
---

# awscc_ec2_transit_gateway_vpc_attachments (Data Source)

Plural Data Source schema for AWS::EC2::TransitGatewayVpcAttachment



<!-- schema generated by tfplugindocs -->
## Schema

### Read-Only

- **id** (String) Uniquely identifies the data source.
- **ids** (Set of String) Set of Resource Identifiers.


Loading